| Jaegeuk Kim | e69e437 | 2013-01-25 17:20:16 +0900 | [diff] [blame] | 1 | .\" Copyright (c) 2012 Samsung Electronics Co., Ltd. |
| 2 | .\" http://www.samsung.com/ |
| 3 | .\" Written by Jaegeuk Kim <jaegeuk.kim@samsung.com> |
| Jaegeuk Kim | 036d45e | 2012-10-26 21:56:34 +0900 | [diff] [blame] | 4 | .\" |
| Jaegeuk Kim | e69e437 | 2013-01-25 17:20:16 +0900 | [diff] [blame] | 5 | .TH MKFS.F2FS 8 "January 2013" "f2fs-tools version 1.2.0" |
| Jaegeuk Kim | 036d45e | 2012-10-26 21:56:34 +0900 | [diff] [blame] | 6 | .SH NAME |
| 7 | mkfs.f2fs \- create an F2FS file system |
| 8 | .SH SYNOPSIS |
| 9 | .B mkfs.f2fs |
| 10 | [ |
| 11 | .B \-a |
| 12 | .I heap-based-allocation |
| 13 | ] |
| 14 | [ |
| 15 | .B \-l |
| 16 | .I volume-label |
| 17 | ] |
| 18 | [ |
| 19 | .B \-o |
| 20 | .I overprovision-ratio-percentage |
| 21 | ] |
| 22 | [ |
| 23 | .B \-s |
| 24 | .I log-based-#-of-segments-per-section |
| 25 | ] |
| 26 | [ |
| 27 | .B \-z |
| 28 | .I #-of-sections-per-zone |
| 29 | ] |
| Jaegeuk Kim | e69e437 | 2013-01-25 17:20:16 +0900 | [diff] [blame] | 30 | [ |
| 31 | .B \-e |
| 32 | .I extenstion-list |
| 33 | ] |
| 34 | [ |
| 35 | .B \-d |
| 36 | .I debugging-level |
| 37 | ] |
| Jaegeuk Kim | 036d45e | 2012-10-26 21:56:34 +0900 | [diff] [blame] | 38 | .I device |
| 39 | .SH DESCRIPTION |
| 40 | .B mkfs.f2fs |
| 41 | is used to create a f2fs file system (usually in a disk partition). |
| 42 | \fIdevice\fP is the special file corresponding to the device (e.g. |
| 43 | \fI/dev/sdXX\fP). |
| 44 | .PP |
| 45 | The exit code returned by |
| 46 | .B mkfs.f2fs |
| 47 | is 0 on success and 1 on failure. |
| 48 | .SH OPTIONS |
| 49 | .TP |
| 50 | .BI \-a " heap-based-allocation" |
| 51 | Specify 1 or 0 to enable/disable heap based block allocation policy. |
| 52 | If the value is equal to 1, each of active log areas are initially |
| 53 | assigned separately according to the whole volume size. |
| 54 | The default value is 1. |
| 55 | .TP |
| 56 | .BI \-l " volume-label" |
| 57 | Specify the volume label to the partition mounted as F2FS. |
| 58 | .TP |
| 59 | .BI \-o " overprovision-ratio-percentage" |
| 60 | Specify the percentage over the volume size for overprovision area. This area |
| 61 | is hidden to users, and utilized by F2FS cleaner. The default percentage is 5%. |
| 62 | .TP |
| 63 | .BI \-s " log-based-#-of-segments-per-section" |
| 64 | Specify the log-based number of segments per section. A section consists of |
| 65 | multiple consecutive segments, and is the unit of garbage collection. |
| 66 | The default number is 0, which means one segment is assigned to a section. |
| 67 | .TP |
| 68 | .BI \-z " #-of-sections-per-zone" |
| 69 | Specify the number of sections per zone. A zone consists of multiple sections. |
| 70 | F2FS allocates segments for active logs with separated zones as much as possible. |
| 71 | The default number is 1, which means a zone consists of one section. |
| Jaegeuk Kim | e69e437 | 2013-01-25 17:20:16 +0900 | [diff] [blame] | 72 | .TP |
| 73 | .BI \-e " extension-list" |
| 74 | Specify a file extension list in order f2fs to treat them as cold files. |
| 75 | The data of files having those extensions will be stored to the cold log. |
| 76 | The default list includes most of multimedia file extensions such as jpg, gif, |
| 77 | mpeg, mkv, and so on. |
| 78 | .TP |
| 79 | .BI \-d " debug-level" |
| 80 | Specify the level of debugging options. |
| 81 | The default number is 0, which shows basic debugging messages. |
| 82 | .TP |
| Jaegeuk Kim | 036d45e | 2012-10-26 21:56:34 +0900 | [diff] [blame] | 83 | .SH AUTHOR |
| 84 | This version of |
| 85 | .B mkfs.f2fs |
| 86 | has been written by Jaegeuk Kim <jaegeuk.kim@samsung.com>. |
| 87 | .SH AVAILABILITY |
| 88 | .B mkfs.f2fs |
| Jaegeuk Kim | e69e437 | 2013-01-25 17:20:16 +0900 | [diff] [blame] | 89 | is available from git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git. |
| Jaegeuk Kim | 036d45e | 2012-10-26 21:56:34 +0900 | [diff] [blame] | 90 | .SH SEE ALSO |
| 91 | .BR mkfs (8). |