manual/e2fsprogs/original/man8/mke2fs.8

   1 .\" -*- nroff -*-
   2 .\" Copyright 1993, 1994, 1995 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 8 "May 2006" "E2fsprogs version 1.39"
   6 .SH NAME
   7 mke2fs \- create an ext2/ext3 filesystem
   8 .SH SYNOPSIS
   9 .B mke2fs
  10 [
  11 .B \-c
  12 |
  13 .B \-l
  14 .I filename
  15 ]
  16 [
  17 .B \-b
  18 .I block-size
  19 ]
  20 [
  21 .B \-f
  22 .I fragment-size
  23 ]
  24 [
  25 .B \-g
  26 .I blocks-per-group
  27 ]
  28 [
  29 .B \-i
  30 .I bytes-per-inode
  31 ]
  32 [
  33 .B \-j
  34 ]
  35 [
  36 .B \-J
  37 .I journal-options
  38 ]
  39 [
  40 .B \-N
  41 .I number-of-inodes
  42 ]
  43 [
  44 .B -n
  45 ]
  46 [
  47 .B \-m
  48 .I reserved-blocks-percentage
  49 ]
  50 [
  51 .B \-o
  52 .I creator-os
  53 ]
  54 [
  55 .B \-O
  56 .IR feature [,...]
  57 ]
  58 [
  59 .B \-q
  60 ]
  61 [
  62 .B \-r
  63 .I fs-revision-level
  64 ]
  65 [
  66 .B \-E
  67 .I extended-options
  68 ]
  69 [
  70 .B \-v
  71 ]
  72 [
  73 .B \-F
  74 ]
  75 [
  76 .B \-L
  77 .I volume-label
  78 ]
  79 [
  80 .B \-M
  81 .I last-mounted-directory
  82 ]
  83 [
  84 .B \-S
  85 ]
  86 [
  87 .B \-T
  88 .I filesystem-type
  89 ]
  90 [
  91 .B \-V
  92 ]
  93 .I device
  94 [
  95 .I blocks-count
  96 ]
  97 .sp
  98 .B "mke2fs \-O journal_dev"
  99 [
 100 .B \-b
 101 .I block-size
 102 ]
 103 .\" No external-journal specific journal options yet (size is ignored)
 104 .\" [
 105 .\" .B \-J
 106 .\" .I journal-options
 107 .\" ]
 108 [
 109 .B \-L
 110 .I volume-label
 111 ]
 112 [
 113 .B \-n
 114 ]
 115 [
 116 .B \-q
 117 ]
 118 [
 119 .B \-v
 120 ]
 121 .I external-journal
 122 [
 123 .I blocks-count
 124 ]
 125 .SH DESCRIPTION
 126 .B mke2fs
 127 is used to create an ext2/ext3 filesystem (usually in a disk partition).
 128 .I device
 129 is the special file corresponding to the device (e.g
 130 .IR /dev/hdXX ).
 131 .I blocks-count
 132 is the number of blocks on the device.  If omitted,
 133 .B mke2fs
 134 automagically figures the file system size.  If called as
 135 .B mkfs.ext3
 136 a journal is created as if the
 137 .B \-j
 138 option was specified.
 139 .SH OPTIONS
 140 .TP
 141 .BI \-b " block-size"
 142 Specify the size of blocks in bytes.  Valid block size vales are 1024,
 143 2048 and 4096 bytes per block.  If omitted,
 144 .B mke2fs
 145 block-size is heuristically determined by the file system size and
 146 the expected usage of the filesystem (see the
 147 .B \-T
 148 option).  If
 149 .I block-size
 150 is negative, then
 151 .B mke2fs
 152 will use heuristics to determine the
 153 appropriate block size, with the constraint that the block size will be
 154 at least
 155 .I block-size
 156 bytes.  This is useful for certain hardware devices which require that
 157 the blocksize be a multiple of 2k.
 158 .TP
 159 .B \-c
 160 Check the device for bad blocks before creating the file system.  If
 161 this option is specified twice, then a slower, read-write
 162 test is used instead of a fast read-only test.
 163 .TP
 164 .BI \-E " extended-options"
 165 Set extended options for the filesystem.  Extended options are comma
 166 separated, and may take an argument using the equals ('=') sign.  The
 167 .B -E
 168 option used to be
 169 .B -R
 170 in earlier versions of
 171 .BR mke2fs .
 172 The
 173 .B -R
 174 option is still accepted for backwards compatibility.   The
 175 following extended options are supported:
 176 .RS 1.2i
 177 .TP
 178 .BI stride= stripe-size
 179 Configure the filesystem for a RAID array with
 180 .I stripe-size
 181 filesystem blocks per stripe.
 182 .TP
 183 .BI resize= max-online-resize
 184 Reserve enough space so that the block group descriptor table can grow
 185 to support a filesystem that has max-online-resize blocks.
 186 .RE
 187 .TP
 188 .BI \-f " fragment-size"
 189 Specify the size of fragments in bytes.
 190 .TP
 191 .B \-F
 192 Force
 193 .B mke2fs
 194 to run, even if the specified device is not a
 195 block special device, or appears to be mounted.
 196 .TP
 197 .BI \-g " blocks-per-group"
 198 Specify the number of blocks in a block group.  There is generally no
 199 reason the user to ever set this parameter, as the default is optimal
 200 for the filesystem.  (For administrators who are creating
 201 filesystems on RAID arrays, it is preferable to use the
 202 .I stride
 203 RAID parameter as part of the
 204 .B \-R
 205 option rather than manipulating the number of blocks per group.)
 206 This option is generally used by developers who
 207 are developing test cases.
 208 .TP
 209 .BI \-i " bytes-per-inode"
 210 Specify the bytes/inode ratio.
 211 .B mke2fs
 212 creates an inode for every
 213 .I bytes-per-inode
 214 bytes of space on the disk.  The larger the
 215 .I bytes-per-inode
 216 ratio, the fewer inodes will be created.  This value generally shouldn't
 217 be smaller than the blocksize of the filesystem, since then too many
 218 inodes will be made.  Be warned that is not possible to expand the number
 219 of inodes on a filesystem after it is created, so be careful deciding the
 220 correct value for this parameter.
 221 .TP
 222 .B \-j
 223 Create the filesystem with an ext3 journal.  If the
 224 .B \-J
 225 option is not specified, the default journal parameters will be used to
 226 create an appropriately sized journal (given the size of the filesystem)
 227 stored within the filesystem.  Note that you must be using a kernel
 228 which has ext3 support in order to actually make use of the journal.
 229 .TP
 230 .BI \-J " journal-options"
 231 Create the ext3 journal using options specified on the command-line.
 232 Journal options are comma
 233 separated, and may take an argument using the equals ('=')  sign.
 234 The following journal options are supported:
 235 .RS 1.2i
 236 .TP
 237 .BI size= journal-size
 238 Create an internal journal (i.e., stored inside the filesystem) of size
 239 .I journal-size
 240 megabytes.
 241 The size of the journal must be at least 1024 filesystem blocks
 242 (i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.)
 243 and may be no more than 102,400 filesystem blocks.
 244 .TP
 245 .BI device= external-journal
 246 Attach the filesystem to the journal block device located on
 247 .IR external-journal .
 248 The external
 249 journal must already have been created using the command
 250 .IP
 251 .B mke2fs -O journal_dev
 252 .I external-journal
 253 .IP
 254 Note that
 255 .I external-journal
 256 must have been created with the
 257 same block size as the new filesystem.
 258 In addition, while there is support for attaching
 259 multiple filesystems to a single external journal,
 260 the Linux kernel and
 261 .BR e2fsck (8)
 262 do not currently support shared external journals yet.
 263 .IP
 264 Instead of specifying a device name directly,
 265 .I external-journal
 266 can also be specified by either
 267 .BI LABEL= label
 268 or
 269 .BI UUID= UUID
 270 to locate the external journal by either the volume label or UUID
 271 stored in the ext2 superblock at the start of the journal.  Use
 272 .BR dumpe2fs (8)
 273 to display a journal device's volume label and UUID.  See also the
 274 .B -L
 275 option of
 276 .BR tune2fs (8).
 277 .RE
 278 .IP
 279 Only one of the
 280 .BR size " or " device
 281 options can be given for a filesystem.
 282 .TP
 283 .BI \-l " filename"
 284 Read the bad blocks list from
 285 .IR filename .
 286 Note that the block numbers in the bad block list must be generated
 287 using the same block size as used by mke2fs.  As a result, the
 288 .B \-c
 289 option to
 290 .B mke2fs
 291 is a much simpler and less error-prone method of checking a disk for bad
 292 blocks before formatting it, as
 293 .B mke2fs
 294 will automatically pass the correct parameters to the
 295 .B badblocks
 296 program.
 297 .TP
 298 .BI \-L " new-volume-label"
 299 Set the volume label for the filesystem to
 300 .IR new-volume-label .
 301 The maximum length of the
 302 volume label is 16 bytes.
 303 .TP
 304 .BI \-m " reserved-blocks-percentage"
 305 Specify the percentage of the filesystem blocks reserved for
 306 the super-user.  This avoids fragmentation, and allows root-owned
 307 daemons, such as
 308 .BR syslogd (8),
 309 to continue to function correctly after non-privileged processes are
 310 prevented from writing to the filesystem.  The default percentage
 311 is 5%.
 312 .TP
 313 .B \-M
 314 Set the last mounted directory for the filesystem.  This might be useful
 315 for the sake of utilities that key off of the last mounted directory to
 316 determine where the filesystem should be mounted.
 317 .TP
 318 .B \-n
 319 causes mke2fs to not actually create a filesystem, but display what it
 320 would do if it were to create a filesystem.  This can be used to
 321 determine the location of the backup superblocks for a particular
 322 filesystem, so long as the mke2fs parameters that were passed when the
 323 filesystem was originally created are used again.  (With the
 324 .B \-n
 325 option added, of course!)
 326 .TP
 327 .BI \-N " number-of-inodes"
 328 overrides the default calculation of the number of inodes that should be
 329 reserved for the filesystem (which is based on the number of blocks and
 330 the
 331 .I bytes-per-inode
 332 ratio).  This allows the user to specify the number
 333 of desired inodes directly.
 334 .TP
 335 .BI \-o " creator-os"
 336 Manually override the default value of the "creator os" field of the
 337 filesystem.  Normally the creator field is set by default to the native OS
 338 of the
 339 .B mke2fs
 340 executable.
 341 .TP
 342 .B "\-O \fIfeature\fR[,...]"
 343 Create filesystem with given features (filesystem options), overriding
 344 the default filesystem options.  The default features which are
 345 enabled by default are specified by the
 346 .I base_features
 347 relation, either in the
 348 .I [libdefaults]
 349 section in the
 350 .B /etc/mke2fs.conf
 351 configuration file, or in the subsection of the
 352 .I [fs_types]
 353 section for the filesystem type as specified by the
 354 .B -T
 355 option.  The filesystem type-specific configuration setting found in
 356 the
 357 .I [fs_types]
 358 section will override the global default found in
 359 .IR [libdefaults] .
 360 .sp
 361 The filesystem feature set will be further edited
 362 using either the feature set specification specified by this option,
 363 or if this option is not specified, by the
 364 .I default_features
 365 relation for the filesystem type being created, or in the
 366 .I [libdefaults]
 367 section of the configuration file.
 368 .sp
 369 The filesystem feature set is comprised of a list of features, separated
 370 by commas, that are to be enabled.  To disable a feature, simply
 371 prefix the feature name with a  caret ('^') character.  The
 372 pseudo-filesystem feature "none" will clear all filesystem features.
 373 .RS 1.2i
 374 .TP
 375 .B dir_index
 376 Use hashed b-trees to speed up lookups in large directories.
 377 .TP
 378 .B filetype
 379 Store file type information in directory entries.
 380 .TP
 381 .B has_journal
 382 Create an ext3 journal (as if using the
 383 .B \-j
 384 option).
 385 .TP
 386 .B journal_dev
 387 Create an external ext3 journal on the given device
 388 instead of a regular ext2 filesystem.
 389 Note that
 390 .I external-journal
 391 must be created with the same
 392 block size as the filesystems that will be using it.
 393 .TP
 394 .B resize_inode
 395 Reserve space so the block group descriptor table may grow in the future.
 396 Useful for online resizing using
 397 .BR resize2fs .
 398 By default
 399 .B mke2fs
 400 will attempt to reserve enough space so that the
 401 filesystem may grow to 1024 times its initial size.  This can be changed
 402 using
 403 .B resize
 404 extended option.
 405 .TP
 406 .B sparse_super
 407 Create a filesystem with fewer superblock backup copies
 408 (saves space on large filesystems).
 409 .RE
 410 .TP
 411 .B \-q
 412 Quiet execution.  Useful if
 413 .B mke2fs
 414 is run in a script.
 415 .TP
 416 .BI \-r " revision"
 417 Set the filesystem revision for the new filesystem.  Note that 1.2
 418 kernels only support revision 0 filesystems.  The default is to
 419 create revision 1 filesystems.
 420 .TP
 421 .B \-S
 422 Write superblock and group descriptors only.  This is useful if all of
 423 the superblock and backup superblocks are corrupted, and a last-ditch
 424 recovery method is desired.  It causes
 425 .B mke2fs
 426 to reinitialize the
 427 superblock and group descriptors, while not touching the inode table
 428 and the block and inode bitmaps.  The
 429 .B e2fsck
 430 program should be run immediately after this option is used, and there
 431 is no guarantee that any data will be salvageable.  It is critical to
 432 specify the correct filesystem blocksize when using this option,
 433 or there is no chance of recovery.
 434 .\" .TP
 435 .\" .BI \-t " test"
 436 .\" Check the device for bad blocks before creating the file system
 437 .\" using the specified test.
 438 .TP
 439 .BI \-T " fs-type"
 440 Specify how the filesystem is going to be used, so that
 441 .B mke2fs
 442 can choose optimal filesystem parameters for that use.  The filesystem
 443 types that are can be supported are defined in the configuration file
 444 .BR /etc/mke2fs.conf (5).
 445 The default configuration file contains definitions for the filesystem
 446 types: small, floppy, news, largefile, and largefile4.
 447 .TP
 448 .B \-v
 449 Verbose execution.
 450 .TP
 451 .B \-V
 452 Print the version number of
 453 .B mke2fs
 454 and exit.
 455 .SH AUTHOR
 456 This version of
 457 .B mke2fs
 458 has been written by Theodore Ts'o <tytso@mit.edu>.
 459 .SH BUGS
 460 .B mke2fs
 461 accepts the
 462 .B \-f
 463 option but currently ignores it because the second
 464 extended file system does not support fragments yet.
 465 .br
 466 There may be other ones.  Please, report them to the author.
 467 .SH AVAILABILITY
 468 .B mke2fs
 469 is part of the e2fsprogs package and is available from
 470 http://e2fsprogs.sourceforge.net.
 471 .SH SEE ALSO
 472 .BR mke2fs.conf (5),
 473 .BR badblocks (8),
 474 .BR dumpe2fs (8),
 475 .BR e2fsck (8),
 476 .BR tune2fs (8)