| Jaegeuk Kim | 5c47dec | 2015-12-22 15:55:34 -0800 | [diff] [blame] | 1 | .\" Copyright (c) 2013 Samsung Electronics Co., Ltd. |
| 2 | .\" |
| 3 | .TH DUMP.F2FS 8 |
| 4 | .SH NAME |
| 5 | dump.f2fs \- retrieve directory and file entries from an F2FS-formated image |
| 6 | .SH SYNOPSIS |
| 7 | .B dump.f2fs |
| 8 | [ |
| 9 | .B \-i |
| 10 | .I inode number |
| 11 | ] |
| 12 | [ |
| 13 | .B \-s |
| 14 | .I SIT range |
| 15 | ] |
| 16 | [ |
| 17 | .B \-a |
| 18 | .I SSA range |
| 19 | ] |
| 20 | [ |
| 21 | .B \-b |
| 22 | .I block address |
| 23 | ] |
| 24 | [ |
| 25 | .B \-d |
| 26 | .I debugging-level |
| 27 | ] |
| 28 | .I device |
| 29 | .SH DESCRIPTION |
| 30 | .B dump.f2fs |
| 31 | is used to retrieve f2fs metadata (usually in a disk partition). |
| 32 | \fIdevice\fP is the special file corresponding to the device (e.g. |
| 33 | \fI/dev/sdXX\fP). |
| 34 | |
| 35 | Currently, it can retrieve 1) a file given its inode number, 2) SIT entries into |
| 36 | a file, 3) SSA entries into a file, 4) reverse information from the given block |
| 37 | address. |
| 38 | .PP |
| 39 | The exit code returned by |
| 40 | .B dump.f2fs |
| 41 | is 0 on success and -1 on failure. |
| 42 | .SH OPTIONS |
| 43 | .TP |
| 44 | .BI \-i " inode number" |
| 45 | Specify an inode number to dump out. |
| 46 | .TP |
| 47 | .BI \-s " SIT range" |
| 48 | Specify a range presented by segment numbers to dump SIT entries. |
| 49 | .TP |
| 50 | .BI \-a " SSA range" |
| 51 | Specify a range presented by segment numbers to dump SSA entries. |
| 52 | .TP |
| 53 | .BI \-b " block address" |
| 54 | Specify a block address to retrieve its metadata information. |
| 55 | .TP |
| 56 | .BI \-d " debug-level" |
| 57 | Specify the level of debugging options. |
| 58 | The default number is 0, which shows basic debugging messages. |
| 59 | .TP |
| 60 | .SH AUTHOR |
| 61 | Initial checking code was written by Byoung Geun Kim <bgbg.kim@samsung.com>. |
| 62 | .SH AVAILABILITY |
| 63 | .B dump.f2fs |
| 64 | is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. |
| 65 | .SH SEE ALSO |
| 66 | .BR mkfs.f2fs(8), |
| 67 | .BR fsck.f2fs(8), |
| Jaegeuk Kim | 5874871 | 2015-12-08 16:05:09 -0800 | [diff] [blame] | 68 | .BR defrag.f2fs(8), |
| Jaegeuk Kim | de166ee | 2015-12-09 16:18:44 -0800 | [diff] [blame] | 69 | .BR resize.f2fs(8), |
| 70 | .BR sload.f2fs(8). |