| blob | 92f8fb40db0b9548551e68ac6a0eda65682c1e8e |
1 .\" $NetBSD: makefs.8,v 1.53 2013/08/06 20:16:54 wiz Exp $
2 .\"
3 .\" Copyright (c) 2001-2003 Wasabi Systems, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Written by Luke Mewburn for Wasabi Systems, Inc.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed for the NetBSD Project by
19 .\" Wasabi Systems, Inc.
20 .\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
21 .\" or promote products derived from this software without specific prior
22 .\" written permission.
23 .\"
24 .\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
26 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
27 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
28 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 .\" POSSIBILITY OF SUCH DAMAGE.
35 .\"
36 .Dd August 6, 2013
37 .Dt MAKEFS 8
38 .Os
39 .Sh NAME
40 .Nm makefs
41 .Nd create a file system image from a directory tree
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl rxZ
45 .Op Fl B Ar endian
46 .Op Fl b Ar free-blocks
47 .Op Fl d Ar debug-mask
48 .Op Fl F Ar mtree-specfile
49 .Op Fl f Ar free-files
50 .Op Fl M Ar minimum-size
51 .Op Fl m Ar maximum-size
52 .Op Fl N Ar userdb-dir
53 .Op Fl O Ar offset
54 .Op Fl o Ar fs-options
55 .Op Fl S Ar sector-size
56 .Op Fl s Ar image-size
57 .Op Fl t Ar fs-type
58 .Ar image-file
59 .Ar directory
60 .Op Ar extra-directory ...
61 .Sh DESCRIPTION
62 The utility
63 .Nm
64 creates a file system image into
65 .Ar image-file
66 from the directory tree
67 .Ar directory .
68 If any optional directory trees are passed in the
69 .Ar extra-directory
70 arguments, then the directory tree of each argument will be merged
71 into the
72 .Ar directory
73 first before creating
74 .Ar image-file .
75 No special devices or privileges are required to perform this task.
76 .Pp
77 The options are as follows:
78 .Bl -tag -width flag
79 .It Fl B Ar endian
80 Set the byte order of the image to
81 .Ar endian .
82 Valid byte orders are
83 .Ql 4321 ,
84 .Ql big ,
85 or
86 .Ql be
87 for big endian, and
88 .Ql 1234 ,
89 .Ql little ,
90 or
91 .Ql le
92 for little endian.
93 Some file systems may have a fixed byte order; in those cases this
94 argument will be ignored.
95 .It Fl b Ar free-blocks
96 Ensure that a minimum of
97 .Ar free-blocks
98 free blocks exist in the image.
99 An optional
100 .Ql %
101 suffix may be provided to indicate that
102 .Ar free-blocks
103 indicates a percentage of the calculated image size.
104 .It Fl d Ar debug-mask
105 Enable various levels of debugging, depending upon which bits are
106 set in
107 .Ar debug-mask .
108 XXX: document these
109 .It Fl F Ar mtree-specfile
110 Use
111 .Ar mtree-specfile
112 as an
113 .Xr mtree 8
114 .Sq specfile
115 specification.
116 .Pp
117 If a specfile entry exists in the underlying file system, its
118 permissions and modification time will be used unless specifically
119 overridden by the specfile.
120 An error will be raised if the type of entry in the specfile
121 conflicts with that of an existing entry.
122 .Pp
123 In the opposite case (where a specfile entry does not have an entry
124 in the underlying file system) the following occurs:
125 If the specfile entry is marked
126 .Sy optional ,
127 the specfile entry is ignored.
128 Otherwise, the entry will be created in the image, and it is
129 necessary to specify at least the following parameters in the
130 specfile:
131 .Sy type ,
132 .Sy mode ,
133 .Sy gname ,
134 or
135 .Sy gid ,
136 and
137 .Sy uname
138 or
139 .Sy uid ,
140 .Sy device
141 (in the case of block or character devices), and
142 .Sy link
143 (in the case of symbolic links).
144 If
145 .Sy time
146 isn't provided, the current time will be used.
147 If
148 .Sy flags
149 isn't provided, the current file flags will be used.
150 Missing regular file entries will be created as zero-length files.
151 .It Fl f Ar free-files
152 Ensure that a minimum of
153 .Ar free-files
154 free files (inodes) exist in the image.
155 An optional
156 .Ql %
157 suffix may be provided to indicate that
158 .Ar free-files
159 indicates a percentage of the calculated image size.
160 .It Fl M Ar minimum-size
161 Set the minimum size of the file system image to
162 .Ar minimum-size .
163 .It Fl m Ar maximum-size
164 Set the maximum size of the file system image to
165 .Ar maximum-size .
166 An error will be raised if the target file system needs to be larger
167 than this to accommodate the provided directory tree.
168 .It Fl N Ar userdb-dir
169 Use the user database text file
170 .Pa master.passwd
171 and group database text file
172 .Pa group
173 from
174 .Ar userdb-dir ,
175 rather than using the results from the system's
176 .Xr getpwnam 3
177 and
178 .Xr getgrnam 3
179 (and related) library calls.
180 .It Fl O Ar offset
181 Instead of creating the filesystem at the beginning of the file, start
182 at offset.
183 Valid only for
184 .Sy ffs
185 and
186 .Sy msdos .
187 .It Fl o Ar fs-options
188 Set file system specific options.
189 .Ar fs-options
190 is a comma separated list of options.
191 Valid file system specific options are detailed below.
192 .It Fl r
193 When merging multiple directories replace duplicate files with the last found.
194 .It Fl S Ar sector-size
195 Set the file system sector size to
196 .Ar sector-size .
197 .\" XXX: next line also true for cd9660?
198 Defaults to 512.
199 .It Fl s Ar image-size
200 Set the size of the file system image to
201 .Ar image-size .
202 .It Fl t Ar fs-type
203 Create an
204 .Ar fs-type
205 file system image.
206 The following file system types are supported:
207 .Bl -tag -width cd9660 -offset indent
208 .It Sy ffs
209 BSD fast file system (default).
210 .It Sy cd9660
211 ISO 9660 file system.
212 .It Sy chfs
213 Chip flash file system.
214 .It Sy msdos
215 FAT12, FAT16, or FAT32 file system.
216 .It Sy v7fs
217 7th Edition(V7) file system.
218 .It Sy udf
219 ISO/Ecma UDF file system.
220 .El
221 .It Fl x
222 Exclude file system nodes not explicitly listed in the specfile.
223 .It Fl Z
224 Create a sparse file for
225 .Sy ffs .
226 This is useful for virtual machine images.
227 .El
228 .Pp
229 Where sizes are specified, a decimal number of bytes is expected.
230 Two or more numbers may be separated by an
231 .Dq x
232 to indicate a product.
233 Each number may have one of the following optional suffixes:
234 .Bl -tag -width 3n -offset indent -compact
235 .It b
236 Block; multiply by 512
237 .It k
238 Kibi; multiply by 1024 (1 KiB)
239 .It m
240 Mebi; multiply by 1048576 (1 MiB)
241 .It g
242 Gibi; multiply by 1073741824 (1 GiB)
243 .It t
244 Tebi; multiply by 1099511627776 (1 TiB)
245 .It w
246 Word; multiply by the number of bytes in an integer
247 .El
248 .\"
249 .\"
250 .Ss FFS-specific options
251 .Sy ffs
252 images have ffs-specific optional parameters that may be provided.
253 Each of the options consists of a keyword, an equal sign
254 .Pq Ql = ,
255 and a value.
256 The following keywords are supported:
257 .Pp
258 .Bl -tag -width optimization -offset indent -compact
259 .It Sy avgfilesize
260 Expected average file size.
261 .It Sy avgfpdir
262 Expected number of files per directory.
263 .It Sy bsize
264 Block size.
265 .It Sy density
266 Bytes per inode.
267 .It Sy fsize
268 Fragment size.
269 .It Sy label
270 Label name of the image.
271 .It Sy maxbpg
272 Maximum blocks per file in a cylinder group.
273 .It Sy minfree
274 Minimum % free.
275 .It Sy optimization
276 Optimization preference; one of
277 .Ql space
278 or
279 .Ql time .
280 .It Sy extent
281 Maximum extent size.
282 .It Sy maxbpcg
283 Maximum total number of blocks in a cylinder group.
284 .It Sy version
285 UFS version.
286 1 for FFS (default), 2 for UFS2.
287 .El
288 .Ss CD9660-specific options
289 .Sy cd9660
290 images have ISO9660-specific optional parameters that may be
291 provided.
292 The arguments consist of a keyword and, optionally, an equal sign
293 .Pq Ql = ,
294 and a value.
295 The following keywords are supported:
296 .Pp
297 .Bl -tag -width omit-trailing-period -offset indent -compact
298 .It Sy allow-deep-trees
299 Allow the directory structure to exceed the maximum specified in
300 the spec.
301 .\" .It Sy allow-illegal-chars
302 .\" Unknown
303 .\" .It Sy allow-lowercase
304 .\" Unknown
305 .It Sy allow-max-name
306 Allow 37 instead of 33 characters for filenames by omitting the
307 version id.
308 .It Sy allow-multidot
309 Allow multiple dots in a filename.
310 .It Sy applicationid
311 Application ID of the image.
312 .It Sy archimedes
313 Use the
314 .Ql ARCHIMEDES
315 extension to encode
316 .Tn RISC OS
317 metadata.
318 .It Sy chrp-boot
319 Write an MBR partition table to the image to allow older CHRP hardware to
320 boot.
321 .It Sy boot-load-segment
322 Set load segment for the boot image.
323 .It Sy bootimage
324 Filename of a boot image in the format
325 .Dq sysid;filename ,
326 where
327 .Dq sysid
328 is one of
329 .Ql i386 ,
330 .Ql mac68k ,
331 .Ql macppc ,
332 or
333 .Ql powerpc .
334 .It Sy generic-bootimage
335 Load a generic boot image into the first 32K of the cd9660 image.
336 .It Sy hard-disk-boot
337 Boot image is a hard disk image.
338 .It Sy keep-bad-images
339 Don't throw away images whose write was aborted due to an error.
340 For debugging purposes.
341 .It Sy label
342 Label name of the image.
343 .It Sy no-boot
344 Boot image is not bootable.
345 .It Sy no-emul-boot
346 Boot image is a
347 .Dq no emulation
348 ElTorito image.
349 .It Sy no-trailing-padding
350 Do not pad the image (apparently Linux needs the padding).
351 .\" .It Sy omit-trailing-period
352 .\" Unknown
353 .It Sy preparer
354 Preparer ID of the image.
355 .It Sy publisher
356 Publisher ID of the image.
357 .It Sy rockridge
358 Use RockRidge extensions (for longer filenames, etc.).
359 .It Sy volumeid
360 Volume set identifier of the image.
361 .El
362 .Ss CHFS-specific options
363 .Sy chfs
364 images have chfs-specific optional parameters that may be provided.
365 Each of the options consists of a keyword, an equal sign
366 .Pq Ql = ,
367 and a value.
368 The following keywords are supported:
369 .Pp
370 .Bl -tag -width optimization -offset indent -compact
371 .It Sy pagesize
372 Pagesize.
373 .It Sy erasesize
374 Erase block size of the media.
375 .It Sy mediatype
376 Type of the media.
377 NOR: 0 or NAND: 1.
378 .El
379 .Ss msdos-specific options
380 See
381 .Xr newfs_msdos 8
382 for fs specific options.
383 .Ss V7FS-specific options
384 The following keywords are supported:
385 .Pp
386 .Bl -tag -width optimization -offset indent -compact
387 .It Sy pdp
388 PDP endian.
389 .It Sy progress
390 Display a progress meter for the file system construction and file
391 population.
392 .El
393 .Ss UDF-specific options
394 .Sy udf
395 images have udf-specific optional parameters that may be provided.
396 Each of the options consists of a keyword, an equal sign
397 .Pq Ql = ,
398 and a value.
399 The following keywords are supported:
400 .Pp
401 .Bl -tag -width optimization -compact
402 .It Sy disctype
403 This can have the following values:
404 .Bl -tag -width cdromXdvdromXbdromXXX -compact
405 .It Sy cdrom , Sy dvdrom , Sy bdrom
406 create a read-only fs
407 .It Sy dvdram , Sy bdre , Sy disk
408 create a rewritable fs without sparing for defective sectors
409 .It Sy cdr , Sy dvdr , Sy bdr
410 create a rewritable fs on once recordable media using a VAT
411 .It Sy cdrw , Sy dvdrw
412 create a rewritable fs with sparing for defective sectors
413 .El
414 When an optical media is selected here, the sectorsize and the default disc
415 size is assumed unless given explicitly.
416 For rom images the disc size is the minimum needed.
417 .It Sy loglabel
418 Set the logical volume label of the disc to the specified argument.
419 .It Sy discid
420 Set the physical volume label of the disc to the specified argument.
421 Prepend the physical volume label with a volumeset label separated
422 with a ':' if wanted.
423 For strict conformance and interchange, don't set the volumeset label
424 manually unless it has an unique hex number in the first 8 character
425 positions.
426 .It Sy minver
427 Set the minimum UDF version to be used.
428 Choose UDF version numbers from 0x102, 0x150, 0x200, and 0x201.
429 Versions 0x250 and 0x260 are currently not supported
430 in
431 .Nm .
432 .El
433 .Sh SEE ALSO
434 .Xr strsuftoll 3 ,
435 .Xr installboot 8 ,
436 .Xr mtree 8 ,
437 .Xr newfs 8
438 .Sh HISTORY
439 The
440 .Nm
441 utility appeared in
442 .Nx 1.6 .
443 .Sh AUTHORS
444 .An Luke Mewburn
445 .Aq lukem@NetBSD.org
446 (original program),
447 .An Daniel Watt ,
448 .An Walter Deignan ,
449 .An Ryan Gabrys ,
450 .An Alan Perez-Rathke ,
451 .An Ram Vedam
452 (cd9660 support),
453 .An UCHIYAMA Yasushi
454 (v7fs support),
455 .An Tamas Toth
456 (chfs support).
457 .An Christos Zoulas
458 (msdos support).
459 .An Reinoud Zandijk
460 (udf support).