|
From: Richard R. <fl...@us...> - 2005-11-06 21:26:31
|
Changes by: flatcap Update of /cvsroot/linux-ntfs/ntfsprogs/ntfsprogs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv5019 Modified Files: mkntfs.8.in Log Message: document new options Index: mkntfs.8.in =================================================================== RCS file: /cvsroot/linux-ntfs/ntfsprogs/ntfsprogs/mkntfs.8.in,v retrieving revision 1.13 retrieving revision 1.14 diff -u -p -r1.13 -r1.14 --- mkntfs.8.in 12 Jul 2005 16:18:12 -0000 1.13 +++ mkntfs.8.in 6 Nov 2005 21:26:23 -0000 1.14 @@ -1,5 +1,6 @@ .\" -*- nroff -*- .\" Copyright (c) 2001,2002 Anton Altaparmakov. All Rights Reserved. +.\" Copyright (c) 2005 Richard Russon. All Rights Reserved. .\" This file may be copied under the terms of the GNU Public License. .\" Adapted from e2fsprogs-1.19/misc/mke2fs.8.in by Theodore Ts'o. .\" @@ -9,70 +10,84 @@ mkntfs \- create an NTFS 1.2 (Windows NT .SH SYNOPSIS .B mkntfs [ -.B \-s -.I sector-size +.I options ] +.B device [ -.B \-p -.I part-start-sect +.I number-of-sectors +] +.P +.B mkntfs +[ +.B \-C +] +[ +.B \-c +.I cluster-size +] +[ +.B \-F +] +[ +.B \-f ] [ .B \-H .I heads ] [ -.B \-S -.I sectors-per-track +.B \-h ] [ -.B \-c -.I cluster-size +.B \-I ] [ .B \-L .I volume-label ] [ -.B \-z -.I mft-zone-multiplier +.B \-l ] [ -.B \-f -| -.B \-Q +.B \-n ] [ -.B -n +.B \-p +.I part-start-sect ] [ -.B \-q +.B \-Q ] [ -.B \-v +.B \-q ] [ -.B \-vv +.B \-S +.I sectors-per-track ] [ -.B \-C +.B \-s +.I sector-size ] [ -.B \-F +.B \-T ] [ -.B \-T +.B \-V ] [ -.B \-I +.B \-v ] [ -.B \-V +.B \-w +.I ntfs-version ] [ -.B \-l +.B \-z +.I mft-zone-multiplier ] [ -.B \-h +.B \-\-debug ] .I device [ @@ -90,8 +105,115 @@ is the number of blocks on the device. .B mkntfs automagically figures the file system size. .SH OPTIONS +Below is a summary of all the options that +.B mkntfs +accepts. Nearly all options have two equivalent names. The short name is preceded by +.BR \- +and the long name is preceded by +.BR \-\- . +Any single letter options, that don't take an argument, can be combined into a +single command, e.g. +.BR \-fv +is equivalent to +.BR "\-f \-v" . +Long named options can be abbreviated to any unique prefix of their name. +.TP + +.BR +.SS Basic options +.BR + +.B \-f +.br +.ns +.TP +.B \-\-fast +.br +.ns +.TP +.B \-Q +.br +.ns +.TP +.B \-\-quick +Perform quick (fast) format. This will skip both zeroing of the volume and bad sector +checking. +.TP + +.BI \-L " STRING" +.br +.ns +.TP +.BI \-\-label " STRING" +Set the volume label for the filesystem. +.TP + +.B \-C +.br +.ns +.TP +.B \-\-enable-compression +Enable compression on the volume. +.TP + +.BI \-c " BYTES" +.br +.ns +.TP +.BI \-\-cluster-size " BYTES" +Specify the size of clusters in bytes. Valid cluster size values are powers of +two, with at least 256, and at most 65536 bytes per cluster. If omitted, +.B mkntfs +determines the +.I cluster-size +from the volume size. The value is determined as follows: +.TS +lB lB lB +l l r. +Volume size Default cluster size +0 - 512MB 512 bytes +512MB - 1GB 1024 bytes +1GB - 2GB 2048 bytes +2GB + 4096 bytes +.TE +Note that the default cluster size is set to be at least equal to the sector +size as a cluster cannot be smaller than a sector. Also, note that values +greater than 4096 have the side effect that compression is disabled on the +volume (due to limitations in the NTFS compression algorithm currently in use +by Windows). +.TP + +.B \-I +.br +.ns +.TP +.B \-\-disable-indexing +Disable content indexing on the volume. (This is only meaningful on +Windows 2000 and later. Windows NT 4.0 and earlier ignore this as they do +not implement content indexing at all.) +.TP + +.B \-n +.br +.ns +.TP +.B \-\-no-action +Causes +.B mkntfs +to not actually create a filesystem, but display what it would do if it were +to create a filesystem. All steps of the format are carried out except the +actual writing to the device. .TP -.BI \-s " sector-size" + +.BR +.SS Advanced options +.BR + +.BI \-s " BYTES" +.br +.ns +.TP +.BI \-\-sector-size " BYTES" Specify the size of sectors in bytes. Valid sector size values are 256, 512, 1024, 2048 and 4096 bytes per sector. If omitted, .B mkntfs @@ -99,7 +221,12 @@ attempts to determine the .I sector-size automatically and if that fails a default of 512 bytes per sector is used. .TP -.BI \-p " part-start-sect" + +.BI \-p " SECTOR" +.br +.ns +.TP +.BI \-\-partition-start " SECTOR Specify the partition start sector. The maximum is 4294967295 (2^32-1). If omitted, .B mkntfs @@ -109,7 +236,12 @@ automatically and if that fails a defaul .I part-start-sect is required for Windows to be able to boot from the created volume. .TP -.BI \-H " heads" + +.BI \-H " NUM" +.br +.ns +.TP +.BI \-\-heads " NUM" Specify the number of heads. The maximum is 65535 (0xffff). If omitted, .B mkntfs attempts to determine the number of @@ -118,7 +250,12 @@ automatically and if that fails a defaul .I heads is required for Windows to be able to boot from the created volume. .TP -.BI \-S " sectors-per-track" + +.BI \-S " NUM" +.br +.ns +.TP +.BI \-\-sectors-per-track " NUM" Specify the number of sectors per track. The maximum is 65535 (0xffff). If omitted, .B mkntfs @@ -128,33 +265,12 @@ automatically and if that fails a defaul .I sectors-per-track is required for Windows to be able to boot from the created volume. .TP -.BI \-c " cluster-size" -Specify the size of clusters in bytes. Valid cluster size values are powers of -two, with at least 256, and at most 65536 bytes per cluster. If omitted, -.B mkntfs -determines the -.I cluster-size -from the volume size. The value is determined as follows: -.TS -lB lB lB -l l r. -Volume size Default cluster size -0 - 512MB 512 bytes -512MB - 1GB 1024 bytes -1GB - 2GB 2048 bytes -2GB + 4096 bytes -.TE -Note that the default cluster size is set to be at least equal to the sector -size as a cluster cannot be smaller than a sector. Also, note that values -greater than 4096 have the side effect that compression is disabled on the -volume (due to limitations in the NTFS compression algorithm currently in use -by Windows). -.TP -.BI \-L " volume-label" -Set the volume label for the filesystem. +.BI \-z " NUM" +.br +.ns .TP -.BI \-z " mft-zone-multiplier" +.BI \-\-mft-zone-multiplier " NUM" Set the MFT zone multiplier, which determines the size of the MFT zone to use on the volume. The MFT zone is the area at the beginning of the volume reserved for the master file table (MFT), which stores the on disk inodes (MFT records). @@ -176,69 +292,101 @@ multiplier (% of volume size) 4 50.0% .TE .TP -.B \-f -Same as -.BR \-Q . + +.B \-T +.br +.ns .TP -.B \-Q -Perform quick format. This will skip both zeroing of the volume and bad sector -checking. +.B \-\-zero-time +Fake the time to be 00:00:00 UTC, Jan 1, 1970 instead of the current system +time. This is only really useful for debugging purposes. .TP -.B \-n -Causes + +.B \-w STRING +.br +.ns +.TP +.B \-\-ntfs-version STRING +Select the version of NTFS you wish to use. This can be one of "1.2", "3.0", or "3.1". +.TP + +.B \-F +.br +.ns +.TP +.B \-\-force +Force .B mkntfs -to not actually create a filesystem, but display what it would do if it were -to create a filesystem. All steps of the format are carried out except the -actual writing to the device. +to run, even if the specified +.I device +is not a block special device, or appears to be mounted. .TP + +.BR +.SS Output options +.BR + .B \-q +.br +.ns +.TP +.B \-\-quiet Quiet execution; only errors are written to stderr, no output to stdout occurs at all. Useful if .B mkntfs is run in a script. .TP + .B \-v +.br +.ns +.TP +.B \-\-verbose Verbose execution. .TP -.B \-vv + +.B \-\-debug Really verbose execution; includes the verbose output from the .B \-v option as well as additional output useful for debugging .B mkntfs. .TP -.B \-C -Enable compression on the volume. -.TP -.B \-F -Force -.B mkntfs -to run, even if the specified -.I device -is not a block special device, or appears to be mounted. -.TP -.B \-T -Fake the time to be 00:00:00 UTC, Jan 1, 1970 instead of the current system -time. This is only really useful for debugging purposes. -.TP -.B \-I -Disable content indexing on the volume. (This is only meaningful on -Windows 2000 and later. Windows NT 4.0 and earlier ignore this as they do -not implement content indexing at all.) -.TP + +.BR +.SS Help options +.BR + .B \-V +.br +.ns +.TP +.B \-\-version Print the version number of .B mkntfs and exit. .TP + .B \-l +.br +.ns +.TP +.B \-\-license Print the licensing information of .B mkntfs and exit. .TP + .B \-h +.br +.ns +.TP +.B \-\-help Print the usage information of .B mkntfs and exit. +.TP +.BR + .SH BUGS .B mkntfs writes the backup boot sector to the last sector of the block @@ -275,4 +423,3 @@ and rpm) and pre-compiled binary (i386 r .SH SEE ALSO .BR badblocks (8), .BR ntfsprogs (8) - |
