release/src-rt-6.x.4708/router/tuxera/broadcom_arm/ntfs/docs/html/mkntfs.html

   1 <!-- Creator     : groff version 1.21 -->
   2 <!-- CreationDate: Mon Jul 14 01:50:26 2014 -->
   3 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   4 "http://www.w3.org/TR/html4/loose.dtd">
   5 <html>
   6 <head>
   7 <meta name="generator" content="groff -Thtml, see www.gnu.org">
   8 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   9 <meta name="Content-Style" content="text/css">
  10 <style type="text/css">
  11        p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
  12        pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
  13        table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
  14        h1      { text-align: center }
  15 </style>
  16 <title>MKNTFS</title>
  17
  18 </head>
  19 <body>
  20
  21 <h1 align="center">MKNTFS</h1>
  22
  23 <a href="#NAME">NAME</a><br>
  24 <a href="#SYNOPSIS">SYNOPSIS</a><br>
  25 <a href="#DESCRIPTION">DESCRIPTION</a><br>
  26 <a href="#OPTIONS">OPTIONS</a><br>
  27 <a href="#BUGS">BUGS</a><br>
  28 <a href="#AUTHORS">AUTHORS</a><br>
  29 <a href="#AVAILABILITY">AVAILABILITY</a><br>
  30
  31 <hr>
  32
  33
  34 <h2>NAME
  35 <a name="NAME"></a>
  36 </h2>
  37
  38
  39 <p style="margin-left:11%; margin-top: 1em">mkntfs &minus;
  40 create an NTFS file system on a device or file</p>
  41
  42 <h2>SYNOPSIS
  43 <a name="SYNOPSIS"></a>
  44 </h2>
  45
  46
  47 <p style="margin-left:11%; margin-top: 1em"><b>mkntfs</b>
  48 [<i>options</i>] <i>device</i>
  49 [<i>number&minus;of&minus;sectors</i>]</p>
  50
  51 <p style="margin-left:11%; margin-top: 1em"><b>mkntfs</b> [
  52 <b>&minus;C</b> ] [ <b>&minus;c</b>
  53 <i>cluster&minus;size</i> ] [ <b>&minus;F</b> ] [
  54 <b>&minus;H</b> <i>heads</i> ] [ <b>&minus;h</b> ] [
  55 <b>&minus;I</b> ] [ <b>&minus;L</b>
  56 <i>volume&minus;label</i> ] [ <b>&minus;l</b> ] [
  57 <b>&minus;n</b> ] [ <b>&minus;p</b>
  58 <i>part&minus;start&minus;sect</i> ] [ <b>&minus;q</b> ] [
  59 <b>&minus;S</b> <i>sectors&minus;per&minus;track</i> ] [
  60 <b>&minus;s</b> <i>sector&minus;size</i> ] [ <b>&minus;T</b>
  61 ] [ <b>&minus;U</b> ] [ <b>&minus;V</b> ] [ <b>&minus;v</b>
  62 ] [ <b>&minus;z</b> <i>mft&minus;zone&minus;multiplier</i> ]
  63 [ <b>&minus;&minus;debug</b> ] <i>device</i> [
  64 <i>number&minus;of&minus;sectors</i> ]</p>
  65
  66 <h2>DESCRIPTION
  67 <a name="DESCRIPTION"></a>
  68 </h2>
  69
  70
  71 <p style="margin-left:11%; margin-top: 1em"><b>mkntfs</b>
  72 is used to create an NTFS file system on a device (usually a
  73 disk partition) or file. <i>device</i> is the special file
  74 corresponding to the device (e.g <i>/dev/sdXX</i>).
  75 <i>number&minus;of&minus;sectors</i> is the number of blocks
  76 on the device. If omitted, <b>mkntfs</b> automagically
  77 figures the file system size.</p>
  78
  79 <h2>OPTIONS
  80 <a name="OPTIONS"></a>
  81 </h2>
  82
  83
  84 <p style="margin-left:11%; margin-top: 1em">Below is a
  85 summary of all the options that <b>mkntfs</b> accepts.
  86 Nearly all options have two equivalent names. The short name
  87 is preceded by <b>&minus;</b> and the long name is preceded
  88 by <b>&minus;&minus;</b>. Any single letter options, that
  89 don&rsquo;t take an argument, can be combined into a single
  90 command, e.g. <b>&minus;fv</b> is equivalent to <b>&minus;f
  91 &minus;v</b>. Long named options can be abbreviated to any
  92 unique prefix of their name.</p>
  93
  94 <p style="margin-left:11%; margin-top: 1em"><b>Basic
  95 options <br>
  96 &minus;L</b>, <b>&minus;&minus;label</b> STRING</p>
  97
  98 <p style="margin-left:22%;">Set the volume label for the
  99 filesystem.</p>
 100
 101 <p style="margin-left:11%;"><b>&minus;C</b>,
 102 <b>&minus;&minus;enable&minus;compression</b></p>
 103
 104 <p style="margin-left:22%;">Enable compression on the
 105 volume.</p>
 106
 107 <p style="margin-left:11%;"><b>&minus;I</b>,
 108 <b>&minus;&minus;no&minus;indexing</b></p>
 109
 110 <p style="margin-left:22%;">Disable content indexing on the
 111 volume. (This is only meaningful on Windows 2000 and later.
 112 Windows NT 4.0 and earlier ignore this as they do not
 113 implement content indexing at all.)</p>
 114
 115 <p style="margin-left:11%;"><b>&minus;n</b>,
 116 <b>&minus;&minus;no&minus;action</b></p>
 117
 118 <p style="margin-left:22%;">Causes <b>mkntfs</b> to not
 119 actually create a filesystem, but display what it would do
 120 if it were to create a filesystem. All steps of the format
 121 are carried out except the actual writing to the device.</p>
 122
 123 <p style="margin-left:11%; margin-top: 1em"><b>Advanced
 124 options <br>
 125 &minus;c</b>, <b>&minus;&minus;cluster&minus;size</b>
 126 BYTES</p>
 127
 128 <p style="margin-left:22%;">Specify the size of clusters in
 129 bytes. Valid cluster size values are powers of two, with at
 130 least 256, and at most 65536 bytes per cluster. If omitted,
 131 <b>mkntfs</b> uses 4096 bytes as the default cluster
 132 size.</p>
 133
 134 <p style="margin-left:22%; margin-top: 1em">Note that the
 135 default cluster size is set to be at least equal to the
 136 sector size as a cluster cannot be smaller than a sector.
 137 Also, note that values greater than 4096 have the side
 138 effect that compression is disabled on the volume (due to
 139 limitations in the NTFS compression algorithm currently in
 140 use by Windows).</p>
 141
 142 <p style="margin-left:11%;"><b>&minus;s</b>,
 143 <b>&minus;&minus;sector&minus;size</b> BYTES</p>
 144
 145 <p style="margin-left:22%;">Specify the size of sectors in
 146 bytes. Valid sector size values are 256, 512, 1024, 2048 and
 147 4096 bytes per sector. If omitted, <b>mkntfs</b> attempts to
 148 determine the <i>sector&minus;size</i> automatically and if
 149 that fails a default of 512 bytes per sector is used.</p>
 150
 151 <p style="margin-left:11%;"><b>&minus;p</b>,
 152 <b>&minus;&minus;partition&minus;start</b> SECTOR</p>
 153
 154 <p style="margin-left:22%;">Specify the partition start
 155 sector. The maximum is 4294967295 (2^32&minus;1). If
 156 omitted, <b>mkntfs</b> attempts to determine
 157 <i>part&minus;start&minus;sect</i> automatically and if that
 158 fails a default of 0 is used. Note that
 159 <i>part&minus;start&minus;sect</i> is required for Windows
 160 to be able to boot from the created volume.</p>
 161
 162 <p style="margin-left:11%;"><b>&minus;H</b>,
 163 <b>&minus;&minus;heads</b> NUM</p>
 164
 165 <p style="margin-left:22%;">Specify the number of heads.
 166 The maximum is 65535 (0xffff). If omitted, <b>mkntfs</b>
 167 attempts to determine the number of <i>heads</i>
 168 automatically and if that fails a default of 0 is used. Note
 169 that <i>heads</i> is required for Windows to be able to boot
 170 from the created volume.</p>
 171
 172 <p style="margin-left:11%;"><b>&minus;S</b>,
 173 <b>&minus;&minus;sectors&minus;per&minus;track</b> NUM</p>
 174
 175 <p style="margin-left:22%;">Specify the number of sectors
 176 per track. The maximum is 65535 (0xffff). If omitted,
 177 <b>mkntfs</b> attempts to determine the number of
 178 <i>sectors&minus;per&minus;track</i> automatically and if
 179 that fails a default of 0 is used. Note that
 180 <i>sectors&minus;per&minus;track</i> is required for Windows
 181 to be able to boot from the created volume.</p>
 182
 183 <p style="margin-left:11%;"><b>&minus;z</b>,
 184 <b>&minus;&minus;mft&minus;zone&minus;multiplier</b> NUM</p>
 185
 186 <p style="margin-left:22%;">Set the MFT zone multiplier,
 187 which determines the size of the MFT zone to use on the
 188 volume. The MFT zone is the area at the beginning of the
 189 volume reserved for the master file table (MFT), which
 190 stores the on disk inodes (MFT records). It is noteworthy
 191 that small files are stored entirely within the inode; thus,
 192 if you expect to use the volume for storing large numbers of
 193 very small files, it is useful to set the zone multiplier to
 194 a higher value. Note, that the MFT zone is resized on the
 195 fly as required during operation of the NTFS driver but
 196 choosing a good value will reduce fragmentation. Valid
 197 values are 1, 2, 3 and 4. The values have the following
 198 meaning:</p>
 199
 200 <table width="100%" border="0" rules="none" frame="void"
 201        cellspacing="0" cellpadding="0">
 202 <tr valign="top" align="left">
 203 <td width="8%"></td>
 204 <td width="7%"></td>
 205 <td width="8%">
 206 </td>
 207 <td width="8%"></td>
 208 <td width="69%">
 209 </td></tr>
 210 <tr valign="top" align="left">
 211 <td width="8%"></td>
 212 <td width="7%"></td>
 213 <td width="8%"></td>
 214 <td width="8%"></td>
 215 <td width="69%">
 216 </td></tr>
 217 <tr valign="top" align="left">
 218 <td width="8%"></td>
 219 <td width="7%"></td>
 220 <td width="8%"></td>
 221 <td width="8%">
 222 </td>
 223 <td width="69%">
 224 </td></tr>
 225 <tr valign="top" align="left">
 226 <td width="8%"></td>
 227 <td width="7%"></td>
 228 <td width="8%"></td>
 229 <td width="8%">
 230 </td>
 231 <td width="69%">
 232 </td></tr>
 233 <tr valign="top" align="left">
 234 <td width="8%"></td>
 235 <td width="7%"></td>
 236 <td width="8%"></td>
 237 <td width="8%">
 238 </td>
 239 <td width="69%">
 240 </td></tr>
 241 <tr valign="top" align="left">
 242 <td width="8%"></td>
 243 <td width="7%"></td>
 244 <td width="8%"></td>
 245 <td width="8%">
 246 </td>
 247 <td width="69%">
 248 </td></tr>
 249 </table>
 250
 251
 252 <p align="center"><img src="output/asus-router/tuxera-file-systems-3014.7.7.1-ac87u-bcm4709/../grohtml-109061.png" alt="Image output/asus-router/tuxera-file-systems-3014.7.7.1-ac87u-bcm4709/../grohtml-109061.png"></p>
 253
 254 <p style="margin-left:11%;"><b>&minus;T</b>,
 255 <b>&minus;&minus;zero&minus;time</b></p>
 256
 257 <p style="margin-left:22%;">Fake the time to be 00:00:00
 258 UTC, Jan 1, 1970 instead of the current system time. This is
 259 only really useful for debugging purposes.</p>
 260
 261 <p style="margin-left:11%;"><b>&minus;U</b>,
 262 <b>&minus;&minus;with&minus;uuid</b></p>
 263
 264 <p style="margin-left:22%;">Generate a random volume
 265 UUID.</p>
 266
 267 <p style="margin-left:11%;"><b>&minus;F</b>,
 268 <b>&minus;&minus;force</b></p>
 269
 270 <p style="margin-left:22%;">Force <b>mkntfs</b> to run,
 271 even if the specified <i>device</i> is not a block special
 272 device, or is entire device, or appears to be mounted.</p>
 273
 274 <p style="margin-left:11%; margin-top: 1em"><b>Output
 275 options <br>
 276 &minus;q</b>, <b>&minus;&minus;quiet</b></p>
 277
 278 <p style="margin-left:22%;">Quiet execution; only errors
 279 are written to stderr, no output to stdout occurs at all.
 280 Useful if <b>mkntfs</b> is run in a script.</p>
 281
 282 <p style="margin-left:11%;"><b>&minus;v</b>,
 283 <b>&minus;&minus;verbose</b></p>
 284
 285 <p style="margin-left:22%;">Verbose execution.</p>
 286
 287 <p style="margin-left:11%;"><b>&minus;&minus;debug</b></p>
 288
 289 <p style="margin-left:22%;">Really verbose execution;
 290 includes the verbose output from the <b>&minus;v</b> option
 291 as well as additional output useful for debugging
 292 <b>mkntfs.</b></p>
 293
 294 <p style="margin-left:11%; margin-top: 1em"><b>Help options
 295 <br>
 296 &minus;V</b>, <b>&minus;&minus;version</b></p>
 297
 298 <p style="margin-left:22%;">Print the version number of
 299 <b>mkntfs</b> and exit.</p>
 300
 301 <p style="margin-left:11%;"><b>&minus;h</b>,
 302 <b>&minus;&minus;help</b></p>
 303
 304 <p style="margin-left:22%;">Show a list of options with a
 305 brief description of each one.</p>
 306
 307 <h2>BUGS
 308 <a name="BUGS"></a>
 309 </h2>
 310
 311
 312 <p style="margin-left:11%; margin-top: 1em">If you find a
 313 bug please send an email describing the problem to
 314 ntfs-support@tuxera.com.</p>
 315
 316 <h2>AUTHORS
 317 <a name="AUTHORS"></a>
 318 </h2>
 319
 320
 321 <p style="margin-left:11%; margin-top: 1em"><b>mkntfs</b>
 322 was written by Anton Altaparmakov, Richard Russon, Szabolcs
 323 Szakacsits, Jean-Pierre Andre, Tuxera Inc. It was ported to
 324 ntfs-3g by Erik Larsson and Jean-Pierre Andre.</p>
 325
 326 <h2>AVAILABILITY
 327 <a name="AVAILABILITY"></a>
 328 </h2>
 329
 330
 331 <p style="margin-left:11%; margin-top: 1em"><b>mkntfs</b>
 332 is part of the <b>Tuxera NTFS</b> package.</p>
 333 <hr>
 334 </body>
 335 </html>