Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 1 | .\" -*- nroff -*- |
| 2 | .\" Copyright 2006 by Theodore Ts'o. All Rights Reserved. |
| 3 | .\" This file may be copied under the terms of the GNU Public License. |
| 4 | .\" |
| 5 | .TH mke2fs.conf 5 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@" |
| 6 | .SH NAME |
| 7 | mke2fs.conf \- Configuration file for mke2fs |
| 8 | .SH DESCRIPTION |
| 9 | .I mke2fs.conf |
| 10 | is the configuration file for |
| 11 | .BR mke2fs (8). |
| 12 | It controls the default parameters used by |
| 13 | .BR mke2fs (8) |
| 14 | when it is creating ext2 or ext3 filesystems. |
| 15 | .PP |
| 16 | The |
| 17 | .I mke2fs.conf |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 18 | file uses an INI-style format. Stanzas, or top-level sections, are |
| 19 | delimited by square braces: [ ]. Within each section, each line |
| 20 | defines a relation, which assigns tags to values, or to a subsection, |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 21 | which contains further relations or subsections. |
| 22 | .\" Tags can be assigned multiple values |
| 23 | An example of the INI-style format used by this configuration file |
| 24 | follows below: |
| 25 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 26 | [section1] |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 27 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 28 | tag1 = value_a |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 29 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 30 | tag1 = value_b |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 31 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 32 | tag2 = value_c |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 33 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 34 | [section 2] |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 35 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 36 | tag3 = { |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 37 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 38 | subtag1 = subtag_value_a |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 39 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 40 | subtag1 = subtag_value_b |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 41 | .br |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 42 | subtag2 = subtag_value_c |
| 43 | .br |
| 44 | } |
| 45 | .br |
| 46 | tag1 = value_d |
| 47 | .br |
| 48 | tag2 = value_e |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 49 | .br |
| 50 | } |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 51 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 52 | Comments are delimited by a semicolon (';') or a hash ('#') character |
| 53 | at the beginning of the comment, and are terminated by the end of |
| 54 | line character. |
| 55 | .P |
| 56 | Tags and values must be quoted using double quotes if they contain |
| 57 | spaces. Within a quoted string, the standard backslash interpretations |
| 58 | apply: "\en" (for the newline character), |
| 59 | "\et" (for the tab character), "\eb" (for the backspace character), |
| 60 | and "\e\e" (for the backslash character). |
| 61 | .P |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame^] | 62 | The following stanzas are used in the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 63 | .I mke2fs.conf |
| 64 | file. They will be described in more detail in future sections of this |
| 65 | document. |
| 66 | .TP |
| 67 | .I [defaults] |
| 68 | Contains relations which define the default parameters |
| 69 | used by |
| 70 | .BR mke2fs (8). |
| 71 | In general, these defaults may be overridden by a definition in the |
| 72 | .B fs_types |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 73 | stanza, or by an command-line option provided by the user. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 74 | .TP |
| 75 | .I [fs_types] |
| 76 | Contains relations which define defaults that should be used for specific |
| 77 | filesystem types. The filesystem type can be specified explicitly using |
| 78 | the |
| 79 | .B -T |
| 80 | option to |
| 81 | .BR mke2fs (8). |
| 82 | If no filesystem type is specified, |
| 83 | .BR mke2fs (8) |
| 84 | will use the filesystem type |
| 85 | .I floppy |
| 86 | if the filesystem size is less than or equal to 3 megabytes. |
| 87 | If the filesystem size is greater than 3 but less than or equal to |
| 88 | 512 megabytes, |
| 89 | .BR mke2fs (8) |
| 90 | will use the filesystem |
| 91 | .IR small . |
| 92 | Otherwise, |
| 93 | .BR mke2fs (8) |
| 94 | will use the default filesystem type |
| 95 | .IR default . |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 96 | .SH THE [defaults] STANZA |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 97 | The following relations are defined in the |
| 98 | .I [defaults] |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 99 | stanza. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 100 | .TP |
| 101 | .I base_features |
| 102 | This relation specifies the filesystems features which are enabled in |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame^] | 103 | newly created filesystems. It may be overridden by the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 104 | .I base_features |
| 105 | relation found in the filesystem-type-specific subsection of |
| 106 | the |
| 107 | .I [fs_types] |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 108 | stanza. |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 109 | .TP |
| 110 | .I default_features |
| 111 | This relation specifies a set of features that should be added or |
| 112 | removed to the features listed in the |
| 113 | .I base_features |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame^] | 114 | relation. It may be overridden by the filesystem-specific |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 115 | .I default_features |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame^] | 116 | in the filesystem-type subsection of |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 117 | .IR [fs_types] , |
| 118 | and by the |
| 119 | .B -O |
| 120 | command-line option |
| 121 | to |
| 122 | .BR mke2fs (8). |
| 123 | .TP |
| 124 | .I blocksize |
| 125 | This relation specifies the default blocksize if the user does not |
| 126 | specify a blocksize on the command line, and the filesystem-type |
| 127 | specific section of the configuration file does not specify a blocksize. |
| 128 | .TP |
| 129 | .I inode_ratio |
| 130 | This relation specifies the default inode ratio if the user does not |
| 131 | specify one on the command line, and the filesystem-type |
| 132 | specific section of the configuration file does not specify a default |
| 133 | inode ratio. |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 134 | .SH THE [fs_types] STANZA |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 135 | Each tag in the |
| 136 | .I [fs_types] |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 137 | stanza names a filesystem type which can be specified via the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 138 | .B -T |
| 139 | option to |
| 140 | .BR mke2fs (8). |
| 141 | The value of the tag is a subsection where the relations in that |
| 142 | subsection define the defaults for that filesystem type. For |
| 143 | example: |
| 144 | .P |
| 145 | [fs_types] |
| 146 | .br |
| 147 | small = { |
| 148 | .br |
| 149 | blocksize = 1024 |
| 150 | .br |
| 151 | inode_ratio = 4096 |
| 152 | .br |
| 153 | } |
| 154 | .br |
| 155 | floppy = { |
| 156 | .br |
| 157 | blocksize = 1024 |
| 158 | .br |
| 159 | } |
| 160 | .P |
Theodore Ts'o | fac9525 | 2006-03-27 01:05:26 -0500 | [diff] [blame] | 161 | For each filesystem type, the following tags may be used in that |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 162 | fs_type's subsection: |
| 163 | .TP |
| 164 | .I base_features |
| 165 | This relation specifies the features which are enabled for this |
| 166 | filesystem type. |
| 167 | .TP |
| 168 | .I default_features |
| 169 | This relation specifies set of features which should be enabled or |
| 170 | disabled to the features listed in the |
| 171 | .I base_features |
Theodore Ts'o | 9447f38 | 2006-05-22 17:59:37 -0400 | [diff] [blame^] | 172 | relation. It may be overridden by the |
Theodore Ts'o | 9dc6ad1 | 2006-03-23 22:00:01 -0500 | [diff] [blame] | 173 | .B -O |
| 174 | command-line option to |
| 175 | .BR mke2fs (8). |
| 176 | .TP |
| 177 | .I blocksize |
| 178 | This relation specifies the default blocksize if the user does not |
| 179 | specify a blocksize on the command line. |
| 180 | .TP |
| 181 | .I inode_ratio |
| 182 | This relation specifies the default inode ratio if the user does not |
| 183 | specify one on the command line. |
| 184 | .SH FILES |
| 185 | .TP |
| 186 | .I /etc/mke2fs.conf |
| 187 | The configuration file for |
| 188 | .BR mke2fs (8). |
| 189 | .SH SEE ALSO |
| 190 | .BR mke2fs (8) |