diff options
-rw-r--r-- | man/Makefile.am | 2 | ||||
-rw-r--r-- | man/defrag.f2fs.8 | 74 | ||||
-rw-r--r-- | man/dump.f2fs.8 | 68 | ||||
-rw-r--r-- | man/fsck.f2fs.8 | 67 | ||||
-rw-r--r-- | man/mkfs.f2fs.8 | 5 |
5 files changed, 214 insertions, 2 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 477d654..256f3c3 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,3 +1,3 @@ ## Makefile.am -dist_man_MANS = mkfs.f2fs.8 +dist_man_MANS = mkfs.f2fs.8 fsck.f2fs.8 dump.f2fs.8 defrag.f2fs.8 diff --git a/man/defrag.f2fs.8 b/man/defrag.f2fs.8 new file mode 100644 index 0000000..e18e69f --- /dev/null +++ b/man/defrag.f2fs.8 @@ -0,0 +1,74 @@ +.\" Copyright (c) 2015 Jaegeuk Kim <jaegeuk@kernel.org> +.\" +.TH DEFRAG.F2FS 8 +.SH NAME +defrag.f2fs \- relocate blocks in a given area to the specified region +.SH SYNOPSIS +.B defrag.f2fs +[ +.B \-s +.I start block address +] +[ +.B \-l +.I number of blocks +] +[ +.B \-t +.I target block address +] +[ +.B \-i +.I direction +] +[ +.B \-d +.I debugging-level +] +.I device +.SH DESCRIPTION +.B defrag.f2fs +is used to move specified number of blocks starting from a given block address +to the target block address with a direction. +\fIdevice\fP is the special file corresponding to the device (e.g. +\fI/dev/sdXX\fP). + +For example, +# defrag.f2fs -s 0x4000 -l 0x100 -t 0x10000 -i /dev/sdb1 + +This moves blocks between 0x4000 and 0x4100 to the left-hand area of 0x10000. + +.PP +The exit code returned by +.B defrag.f2fs +is 0 on success and -1 on failure. +.SH OPTIONS +.TP +.BI \-s " start block address" +Specify the starting block address. +.TP +.BI \-l " number of blocks" +Specifiy the number of blocks to move. +.TP +.BI \-t " target block address" +Specify the destination block address. +.TP +.BI \-i " direction" +Set the direction to left. If it is not set, the direction becomes right +by default. +.TP +.BI \-d " debug-level" +Specify the level of debugging options. +The default number is 0, which shows basic debugging messages. +.TP +.SH AUTHOR +This version of +.B defrag.f2fs +has been written by Jaegeuk Kim <jaegeuk@kernel.org>. +.SH AVAILABILITY +.B defrag.f2fs +is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. +.SH SEE ALSO +.BR mkfs.f2fs(8), +.BR dump.f2fs(8), +.BR fsck.f2fs(8). diff --git a/man/dump.f2fs.8 b/man/dump.f2fs.8 new file mode 100644 index 0000000..ca5f511 --- /dev/null +++ b/man/dump.f2fs.8 @@ -0,0 +1,68 @@ +.\" Copyright (c) 2013 Samsung Electronics Co., Ltd. +.\" +.TH DUMP.F2FS 8 +.SH NAME +dump.f2fs \- retrieve directory and file entries from an F2FS-formated image +.SH SYNOPSIS +.B dump.f2fs +[ +.B \-i +.I inode number +] +[ +.B \-s +.I SIT range +] +[ +.B \-a +.I SSA range +] +[ +.B \-b +.I block address +] +[ +.B \-d +.I debugging-level +] +.I device +.SH DESCRIPTION +.B dump.f2fs +is used to retrieve f2fs metadata (usually in a disk partition). +\fIdevice\fP is the special file corresponding to the device (e.g. +\fI/dev/sdXX\fP). + +Currently, it can retrieve 1) a file given its inode number, 2) SIT entries into +a file, 3) SSA entries into a file, 4) reverse information from the given block +address. +.PP +The exit code returned by +.B dump.f2fs +is 0 on success and -1 on failure. +.SH OPTIONS +.TP +.BI \-i " inode number" +Specify an inode number to dump out. +.TP +.BI \-s " SIT range" +Specify a range presented by segment numbers to dump SIT entries. +.TP +.BI \-a " SSA range" +Specify a range presented by segment numbers to dump SSA entries. +.TP +.BI \-b " block address" +Specify a block address to retrieve its metadata information. +.TP +.BI \-d " debug-level" +Specify the level of debugging options. +The default number is 0, which shows basic debugging messages. +.TP +.SH AUTHOR +Initial checking code was written by Byoung Geun Kim <bgbg.kim@samsung.com>. +.SH AVAILABILITY +.B dump.f2fs +is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. +.SH SEE ALSO +.BR mkfs.f2fs(8), +.BR fsck.f2fs(8), +.BR defrag.f2fs(8). diff --git a/man/fsck.f2fs.8 b/man/fsck.f2fs.8 new file mode 100644 index 0000000..0ffe6e1 --- /dev/null +++ b/man/fsck.f2fs.8 @@ -0,0 +1,67 @@ +.\" Copyright (c) 2013 Samsung Electronics Co., Ltd. +.\" +.TH FSCK.F2FS 8 +.SH NAME +fsck.f2fs \- check a Linux F2FS file system +.SH SYNOPSIS +.B fsck.f2fs +[ +.B \-a +.I enable auto fix +] +[ +.B \-f +.I enable force fix +] +[ +.B \-p +.I enable preen mode +] +[ +.B \-t +.I show stored directory tree +] +[ +.B \-d +.I debugging-level +] +.I device +.SH DESCRIPTION +.B fsck.f2fs +is used to check an f2fs file system (usually in a disk partition). +\fIdevice\fP is the special file corresponding to the device (e.g. +\fI/dev/sdXX\fP). +.PP +The exit code returned by +.B fsck.f2fs +is 0 on success and -1 on failure. +.SH OPTIONS +.TP +.BI \-a " enable auto fix" +Enable to run file system check only if a bug was reported by the F2FS kernel +module. It is disabled by default. +.TP +.BI \-f " enable force fix" +Enable to fix all the inconsistency in the partition. +.TP +.BI \-p " enable preen mode" +Same as "-a" to support general fsck convention. +.TP +.BI \-t " show stored directory tree" +Enable to show every directory entries in the partition. +.TP +.BI \-d " debug-level" +Specify the level of debugging options. +The default number is 0, which shows basic debugging messages. +.TP +.SH AUTHOR +Initial checking code was written by Byoung Geun Kim <bgbg.kim@samsung.com>. +Jaegeuk Kim <jaegeuk@kernel.org> reworked most parts of the codes to support +fixing any corrupted images. +.SH AVAILABILITY +.B fsck.f2fs +is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. +.SH SEE ALSO +.BR mkfs.f2fs(8), +.BR dump.f2fs(8), +.BR defrag.f2fs(8). diff --git a/man/mkfs.f2fs.8 b/man/mkfs.f2fs.8 index 29e0173..068c4c1 100644 --- a/man/mkfs.f2fs.8 +++ b/man/mkfs.f2fs.8 @@ -89,4 +89,7 @@ has been written by Jaegeuk Kim <jaegeuk.kim@samsung.com>. .B mkfs.f2fs is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. .SH SEE ALSO -.BR mkfs (8). +.BR mkfs (8), +.BR fsck.f2fs(8), +.BR dump.f2fs(8), +.BR defrag.f2fs(8). |