platform/external/ntfs-3g.git - Unnamed repository; edit this file 'description' to name the repository.

1 .\" Copyright (c) 2001\-2006 Anton Altaparmakov.
2 .\" Copyright (c) 2005 Richard Russon.
3 .\" Copyright (c) 2005\-2006 Szabolcs Szakacsits.
4 .\" This file may be copied under the terms of the GNU Public License.
5 .\"
6 .TH MKNTFS 8 "January 2006" "ntfs-3g @VERSION@"
7 .SH NAME
8 mkntfs \- create an NTFS file system
9 .SH SYNOPSIS
10 .B mkntfs
11 [\fIoptions\fR] \fIdevice \fR[\fInumber\-of\-sectors\fR]
12 .PP
13 .B mkntfs
14 [
15 .B \-C
16 ]
17 [
18 .B \-c
19 .I cluster\-size
20 ]
21 [
22 .B \-F
23 ]
24 [
25 .B \-f
26 ]
27 [
28 .B \-H
29 .I heads
30 ]
31 [
32 .B \-h
33 ]
34 [
35 .B \-I
36 ]
37 [
38 .B \-L
39 .I volume\-label
40 ]
41 [
42 .B \-l
43 ]
44 [
45 .B \-n
46 ]
47 [
48 .B \-p
49 .I part\-start\-sect
50 ]
51 [
52 .B \-Q
53 ]
54 [
55 .B \-q
56 ]
57 [
58 .B \-S
59 .I sectors\-per\-track
60 ]
61 [
62 .B \-s
63 .I sector\-size
64 ]
65 [
66 .B \-T
67 ]
68 [
69 .B \-U
70 ]
71 [
72 .B \-V
73 ]
74 [
75 .B \-v
76 ]
77 [
78 .B \-z
79 .I mft\-zone\-multiplier
80 ]
81 [
82 .B \-\-debug
83 ]
84 .I device
85 [
86 .I number\-of\-sectors
87 ]
88 .SH DESCRIPTION
89 .B mkntfs
90 is used to create an NTFS file system on a device (usually a disk partition)
91 or file.
92 .I device
93 is the special file corresponding to the device (e.g
94 .IR /dev/hdXX ).
95 .I number\-of\-sectors
96 is the number of sectors on the device. If omitted,
97 .B mkntfs
98 automagically figures the file system size.
99 .SH OPTIONS
100 Below is a summary of all the options that
101 .B mkntfs
102 accepts.  Nearly all options have two equivalent names.  The short name is
103 preceded by
104 .B \-
105 and the long name is preceded by
106 .BR \-\- .
107 Any single letter options, that don't take an argument, can be combined into a
108 single command, e.g.
109 .B \-fv
110 is equivalent to
111 .BR "\-f \-v" .
112 Long named options can be abbreviated to any unique prefix of their name.
113 .SS Basic options
114 .TP
115 \fB\-f\fR, \fB\-\-fast\fR, \fB\-Q\fR, \fB\-\-quick\fR
116 Perform quick (fast) format. This will skip both zeroing of the volume and bad
117 sector checking.
118 .TP
119 \fB\-L\fR, \fB\-\-label\fR STRING
120 Set the volume label for the filesystem.
121 .TP
122 \fB\-C\fR, \fB\-\-enable\-compression\fR
123 Enable compression on the volume.
124 .TP
125 \fB\-n\fR, \fB\-\-no\-action\fR
126 Causes
127 .B mkntfs
128 to not actually create a filesystem, but display what it would do if it were
129 to create a filesystem. All steps of the format are carried out except the
130 actual writing to the device.
131 .SS Advanced options
132 .TP
133 \fB\-c\fR, \fB\-\-cluster\-size\fR BYTES
134 Specify the size of clusters in bytes. Valid cluster size values are powers of
135 two, with at least 256, and at most 65536 bytes per cluster. If omitted,
136 .B mkntfs
137 uses 4096 bytes as the default cluster size.
138 .sp
139 Note that the default cluster size is set to be at least equal to the sector
140 size as a cluster cannot be smaller than a sector. Also, note that values
141 greater than 4096 have the side effect that compression is disabled on the
142 volume (due to limitations in the NTFS compression algorithm currently in use
143 by Windows).
144 .TP
145 \fB\-s\fR, \fB\-\-sector\-size\fR BYTES
146 Specify the size of sectors in bytes. Valid sector size values are 256, 512,
147 1024, 2048 and 4096 bytes per sector. If omitted,
148 .B mkntfs
149 attempts to determine the
150 .I sector\-size
151 automatically and if that fails a default of 512 bytes per sector is used.
152 .TP
153 \fB\-p\fR, \fB\-\-partition\-start\fR SECTOR
154 Specify the partition start sector. The maximum is 4294967295 (2^32\-1). If
155 omitted,
156 .B mkntfs
157 attempts to determine
158 .I part\-start\-sect
159 automatically and if that fails a default of 0 is used. Note that
160 .I part\-start\-sect
161 is required for Windows to be able to boot from the created volume.
162 .TP
163 \fB\-H\fR, \fB\-\-heads\fR NUM
164 Specify the number of heads. The maximum is 65535 (0xffff). If omitted,
165 .B mkntfs
166 attempts to determine the number of
167 .I heads
168 automatically and if that fails a default of 0 is used. Note that
169 .I heads
170 is required for Windows to be able to boot from the created volume.
171 .TP
172 \fB\-S\fR, \fB\-\-sectors\-per\-track\fR NUM
173 Specify the number of sectors per track. The maximum is 65535 (0xffff). If
174 omitted,
175 .B mkntfs
176 attempts to determine the number of
177 .I sectors\-per\-track
178 automatically and if that fails a default of 0 is used. Note that
179 .I sectors\-per\-track
180 is required for Windows to be able to boot from the created volume.
181 .TP
182 \fB\-z\fR, \fB\-\-mft\-zone\-multiplier\fR NUM
183 Set the MFT zone multiplier, which determines the size of the MFT zone to use
184 on the volume. The MFT zone is the area at the beginning of the volume reserved
185 for the master file table (MFT), which stores the on disk inodes (MFT records).
186 It is noteworthy that small files are stored entirely within the inode;
187 thus, if you expect to use the volume for storing large numbers of very small
188 files, it is useful to set the zone multiplier to a higher value. Note, that
189 the MFT zone is resized on the fly as required during operation of the NTFS
190 driver but choosing a good value will reduce fragmentation. Valid values
191 are 1, 2, 3 and 4. The values have the following meaning:
192 .TS
193 box;
194 lB lB
195 lB lB
196 c l.
197 MFT zone	MFT zone size
198 multiplier	(% of volume size)
199 1	12.5% (default)
200 2	25.0%
201 3	37.5%
202 4	50.0%
203 .TE
204 .sp
205 .TP
206 \fB\-T\fR, \fB\-\-zero\-time\fR
207 Fake the time to be 00:00:00 UTC, Jan 1, 1970 instead of the current system
208 time.  This is only really useful for debugging purposes.
209 .TP
210 \fB\-U\fR, \fB\-\-with\-uuid\fR
211 Generate a random volume UUID.
212 .TP
213 \fB\-I\fR, \fB\-\-no\-indexing\fR
214 Disable content indexing on the volume. (This is only meaningful on
215 Windows 2000 and later. Windows NT 4.0 and earlier ignore this as they do
216 not implement content indexing at all.)
217 .TP
218 \fB\-F\fR, \fB\-\-force\fR
219 Force
220 .B mkntfs
221 to run, even if the specified
222 .I device
223 is not a block special device, or appears to be mounted.
224 .SS Output options
225 .TP
226 \fB\-q\fR, \fB\-\-quiet\fR
227 Quiet execution; only errors are written to stderr, no output to stdout
228 occurs at all. Useful if
229 .B mkntfs
230 is run in a script.
231 .TP
232 \fB\-v\fR, \fB\-\-verbose\fR
233 Verbose execution.
234 .TP
235 \fB\-\-debug\fR
236 Really verbose execution; includes the verbose output from the
237 .B \-v
238 option as well as additional output useful for debugging
239 .B mkntfs.
240 .SS Help options
241 .TP
242 \fB\-V\fR, \fB\-\-version\fR
243 Print the version number of
244 .B mkntfs
245 and exit.
246 .TP
247 \fB\-l\fR, \fB\-\-license\fR
248 Print the licensing information of
249 .B mkntfs
250 and exit.
251 .TP
252 \fB\-h\fR, \fB\-\-help\fR
253 Show a list of options with a brief description of each one.
254 .SH KNOWN ISSUES
255 When applying chkdsk to a file system, it sometimes throws a warning
256 "Correcting errors in the uppercase file." The uppercase file is created
257 while formatting and it defines the mapping of lower case  characters to
258 upper case ones, as needed to sort file names in directories. The warning
259 means that the uppercase file defined on the file system is not the same as
260 the one used by the Windows OS on which chkdsk is running, and this may
261 happen because newer versions of Windows take into account new characters
262 defined by the Unicode consortium.
263 .P
264 Currently, mkntfs creates the uppercase table so that no warning is thrown
265 by Windows Vista, Windows 7 or Windows 8. A warning may be thrown by
266 other Windows versions, or if chkdsk is applied in succession on different
267 Windows versions.
268 .SH BUGS
269 If you find a bug please send an email describing the problem to the
270 development team:
271 .br
272 .nh
273 ntfs\-3g\-devel@lists.sf.net
274 .hy
275 .SH AUTHORS
276 .B mkntfs
277 was written by Anton Altaparmakov, Richard Russon, Erik Sornes and Szabolcs Szakacsits.
278 It was ported to ntfs-3g by Erik Larsson and Jean-Pierre Andre.
279 .SH AVAILABILITY
280 .B mkntfs
281 is part of the
282 .B ntfs-3g
283 package and is available from:
284 .br
285 .nh
286 http://www.tuxera.com/community/
287 .hy
288 .SH SEE ALSO
289 .BR badblocks (8),
290 .BR ntfsprogs (8)
291
1	.\" Copyright (c) 2001\-2006 Anton Altaparmakov.
2	.\" Copyright (c) 2005 Richard Russon.
3	.\" Copyright (c) 2005\-2006 Szabolcs Szakacsits.
4	.\" This file may be copied under the terms of the GNU Public License.
5	.\"
6	.TH MKNTFS 8 "January 2006" "ntfs-3g @VERSION@"
7	.SH NAME
8	mkntfs \- create an NTFS file system
9	.SH SYNOPSIS
10	.B mkntfs
11	[\fIoptions\fR] \fIdevice \fR[\fInumber\-of\-sectors\fR]
12	.PP
13	.B mkntfs
14	[
15	.B \-C
16	]
17	[
18	.B \-c
19	.I cluster\-size
20	]
21	[
22	.B \-F
23	]
24	[
25	.B \-f
26	]
27	[
28	.B \-H
29	.I heads
30	]
31	[
32	.B \-h
33	]
34	[
35	.B \-I
36	]
37	[
38	.B \-L
39	.I volume\-label
40	]
41	[
42	.B \-l
43	]
44	[
45	.B \-n
46	]
47	[
48	.B \-p
49	.I part\-start\-sect
50	]
51	[
52	.B \-Q
53	]
54	[
55	.B \-q
56	]
57	[
58	.B \-S
59	.I sectors\-per\-track
60	]
61	[
62	.B \-s
63	.I sector\-size
64	]
65	[
66	.B \-T
67	]
68	[
69	.B \-U
70	]
71	[
72	.B \-V
73	]
74	[
75	.B \-v
76	]
77	[
78	.B \-z
79	.I mft\-zone\-multiplier
80	]
81	[
82	.B \-\-debug
83	]
84	.I device
85	[
86	.I number\-of\-sectors
87	]
88	.SH DESCRIPTION
89	.B mkntfs
90	is used to create an NTFS file system on a device (usually a disk partition)
91	or file.
92	.I device
93	is the special file corresponding to the device (e.g
94	.IR /dev/hdXX ).
95	.I number\-of\-sectors
96	is the number of sectors on the device. If omitted,
97	.B mkntfs
98	automagically figures the file system size.
99	.SH OPTIONS
100	Below is a summary of all the options that
101	.B mkntfs
102	accepts. Nearly all options have two equivalent names. The short name is
103	preceded by
104	.B \-
105	and the long name is preceded by
106	.BR \-\- .
107	Any single letter options, that don't take an argument, can be combined into a
108	single command, e.g.
109	.B \-fv
110	is equivalent to
111	.BR "\-f \-v" .
112	Long named options can be abbreviated to any unique prefix of their name.
113	.SS Basic options
114	.TP
115	\fB\-f\fR, \fB\-\-fast\fR, \fB\-Q\fR, \fB\-\-quick\fR
116	Perform quick (fast) format. This will skip both zeroing of the volume and bad
117	sector checking.
118	.TP
119	\fB\-L\fR, \fB\-\-label\fR STRING
120	Set the volume label for the filesystem.
121	.TP
122	\fB\-C\fR, \fB\-\-enable\-compression\fR
123	Enable compression on the volume.
124	.TP
125	\fB\-n\fR, \fB\-\-no\-action\fR
126	Causes
127	.B mkntfs
128	to not actually create a filesystem, but display what it would do if it were
129	to create a filesystem. All steps of the format are carried out except the
130	actual writing to the device.
131	.SS Advanced options
132	.TP
133	\fB\-c\fR, \fB\-\-cluster\-size\fR BYTES
134	Specify the size of clusters in bytes. Valid cluster size values are powers of
135	two, with at least 256, and at most 65536 bytes per cluster. If omitted,
136	.B mkntfs
137	uses 4096 bytes as the default cluster size.
138	.sp
139	Note that the default cluster size is set to be at least equal to the sector
140	size as a cluster cannot be smaller than a sector. Also, note that values
141	greater than 4096 have the side effect that compression is disabled on the
142	volume (due to limitations in the NTFS compression algorithm currently in use
143	by Windows).
144	.TP
145	\fB\-s\fR, \fB\-\-sector\-size\fR BYTES
146	Specify the size of sectors in bytes. Valid sector size values are 256, 512,
147	1024, 2048 and 4096 bytes per sector. If omitted,
148	.B mkntfs
149	attempts to determine the
150	.I sector\-size
151	automatically and if that fails a default of 512 bytes per sector is used.
152	.TP
153	\fB\-p\fR, \fB\-\-partition\-start\fR SECTOR
154	Specify the partition start sector. The maximum is 4294967295 (2^32\-1). If
155	omitted,
156	.B mkntfs
157	attempts to determine
158	.I part\-start\-sect
159	automatically and if that fails a default of 0 is used. Note that
160	.I part\-start\-sect
161	is required for Windows to be able to boot from the created volume.
162	.TP
163	\fB\-H\fR, \fB\-\-heads\fR NUM
164	Specify the number of heads. The maximum is 65535 (0xffff). If omitted,
165	.B mkntfs
166	attempts to determine the number of
167	.I heads
168	automatically and if that fails a default of 0 is used. Note that
169	.I heads
170	is required for Windows to be able to boot from the created volume.
171	.TP
172	\fB\-S\fR, \fB\-\-sectors\-per\-track\fR NUM
173	Specify the number of sectors per track. The maximum is 65535 (0xffff). If
174	omitted,
175	.B mkntfs
176	attempts to determine the number of
177	.I sectors\-per\-track
178	automatically and if that fails a default of 0 is used. Note that
179	.I sectors\-per\-track
180	is required for Windows to be able to boot from the created volume.
181	.TP
182	\fB\-z\fR, \fB\-\-mft\-zone\-multiplier\fR NUM
183	Set the MFT zone multiplier, which determines the size of the MFT zone to use
184	on the volume. The MFT zone is the area at the beginning of the volume reserved
185	for the master file table (MFT), which stores the on disk inodes (MFT records).
186	It is noteworthy that small files are stored entirely within the inode;
187	thus, if you expect to use the volume for storing large numbers of very small
188	files, it is useful to set the zone multiplier to a higher value. Note, that
189	the MFT zone is resized on the fly as required during operation of the NTFS
190	driver but choosing a good value will reduce fragmentation. Valid values
191	are 1, 2, 3 and 4. The values have the following meaning:
192	.TS
193	box;
194	lB lB
195	lB lB
196	c l.
197	MFT zone MFT zone size
198	multiplier (% of volume size)
199	1 12.5% (default)
200	2 25.0%
201	3 37.5%
202	4 50.0%
203	.TE
204	.sp
205	.TP
206	\fB\-T\fR, \fB\-\-zero\-time\fR
207	Fake the time to be 00:00:00 UTC, Jan 1, 1970 instead of the current system
208	time. This is only really useful for debugging purposes.
209	.TP
210	\fB\-U\fR, \fB\-\-with\-uuid\fR
211	Generate a random volume UUID.
212	.TP
213	\fB\-I\fR, \fB\-\-no\-indexing\fR
214	Disable content indexing on the volume. (This is only meaningful on
215	Windows 2000 and later. Windows NT 4.0 and earlier ignore this as they do
216	not implement content indexing at all.)
217	.TP
218	\fB\-F\fR, \fB\-\-force\fR
219	Force
220	.B mkntfs
221	to run, even if the specified
222	.I device
223	is not a block special device, or appears to be mounted.
224	.SS Output options
225	.TP
226	\fB\-q\fR, \fB\-\-quiet\fR
227	Quiet execution; only errors are written to stderr, no output to stdout
228	occurs at all. Useful if
229	.B mkntfs
230	is run in a script.
231	.TP
232	\fB\-v\fR, \fB\-\-verbose\fR
233	Verbose execution.
234	.TP
235	\fB\-\-debug\fR
236	Really verbose execution; includes the verbose output from the
237	.B \-v
238	option as well as additional output useful for debugging
239	.B mkntfs.
240	.SS Help options
241	.TP
242	\fB\-V\fR, \fB\-\-version\fR
243	Print the version number of
244	.B mkntfs
245	and exit.
246	.TP
247	\fB\-l\fR, \fB\-\-license\fR
248	Print the licensing information of
249	.B mkntfs
250	and exit.
251	.TP
252	\fB\-h\fR, \fB\-\-help\fR
253	Show a list of options with a brief description of each one.
254	.SH KNOWN ISSUES
255	When applying chkdsk to a file system, it sometimes throws a warning
256	"Correcting errors in the uppercase file." The uppercase file is created
257	while formatting and it defines the mapping of lower case characters to
258	upper case ones, as needed to sort file names in directories. The warning
259	means that the uppercase file defined on the file system is not the same as
260	the one used by the Windows OS on which chkdsk is running, and this may
261	happen because newer versions of Windows take into account new characters
262	defined by the Unicode consortium.
263	.P
264	Currently, mkntfs creates the uppercase table so that no warning is thrown
265	by Windows Vista, Windows 7 or Windows 8. A warning may be thrown by
266	other Windows versions, or if chkdsk is applied in succession on different
267	Windows versions.
268	.SH BUGS
269	If you find a bug please send an email describing the problem to the
270	development team:
271	.br
272	.nh
273	ntfs\-3g\-devel@lists.sf.net
274	.hy
275	.SH AUTHORS
276	.B mkntfs
277	was written by Anton Altaparmakov, Richard Russon, Erik Sornes and Szabolcs Szakacsits.
278	It was ported to ntfs-3g by Erik Larsson and Jean-Pierre Andre.
279	.SH AVAILABILITY
280	.B mkntfs
281	is part of the
282	.B ntfs-3g
283	package and is available from:
284	.br
285	.nh
286	http://www.tuxera.com/community/
287	.hy
288	.SH SEE ALSO
289	.BR badblocks (8),
290	.BR ntfsprogs (8)
291