1 .\" $NetBSD: makefs.8,v 1.33 2011/05/22 21:51:39 christos Exp $
3 .\" Copyright (c) 2001-2003 Wasabi Systems, Inc.
4 .\" All rights reserved.
6 .\" Written by Luke Mewburn for Wasabi Systems, Inc.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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.
43 .Nd create a file system image from a directory tree or a mtree manifest
48 .Op Fl b Ar free-blocks
49 .Op Fl d Ar debug-mask
50 .Op Fl F Ar mtree-specfile
51 .Op Fl f Ar free-files
52 .Op Fl M Ar minimum-size
53 .Op Fl m Ar maximum-size
54 .Op Fl N Ar userdb-dir
56 .Op Fl o Ar fs-options
57 .Op Fl R Ar roundup-size
58 .Op Fl S Ar sector-size
59 .Op Fl s Ar image-size
63 .Ar directory | manifest
64 .Op Ar extra-directory ...
68 creates a file system image into
70 from the directory tree
72 or from the mtree manifest
74 If any optional directory trees are passed in the
76 arguments, then the directory tree of each argument will be merged
83 No special devices or privileges are required to perform this task.
85 The options are as follows:
88 Set the byte order of the image to
101 Some file systems may have a fixed byte order; in those cases this
102 argument will be ignored.
103 .It Fl b Ar free-blocks
104 Ensure that a minimum of
106 free blocks exist in the image.
109 suffix may be provided to indicate that
111 indicates a percentage of the calculated image size.
113 Treat duplicate paths in an mtree manifest as warnings not error.
114 .It Fl d Ar debug-mask
115 Enable various levels of debugging, depending upon which bits are
119 .It Fl F Ar mtree-specfile
120 .Em This is almost certainly not the option you are looking for.
121 To create an image from a list of files in an mtree format manifest,
122 specify it as the last argument on the command line, not as a the
132 This option has no effect when the image is created from a mtree manifest
133 rather than a directory.
135 If a specfile entry exists in the underlying file system, its
136 permissions and modification time will be used unless specifically
137 overridden by the specfile.
138 An error will be raised if the type of entry in the specfile
139 conflicts with that of an existing entry.
141 In the opposite case (where a specfile entry does not have an entry
142 in the underlying file system) the following occurs:
143 If the specfile entry is marked
145 the specfile entry is ignored.
146 Otherwise, the entry will be created in the image, and it is
147 necessary to specify at least the following parameters in the
160 (in the case of symbolic links).
163 is not provided, the current time will be used.
166 is not provided, the current file flags will be used.
167 Missing regular file entries will be created as zero-length files.
168 .It Fl f Ar free-files
169 Ensure that a minimum of
171 free files (inodes) exist in the image.
174 suffix may be provided to indicate that
176 indicates a percentage of the calculated image size.
177 .It Fl M Ar minimum-size
178 Set the minimum size of the file system image to
180 .It Fl m Ar maximum-size
181 Set the maximum size of the file system image to
183 An error will be raised if the target file system needs to be larger
184 than this to accommodate the provided directory tree.
185 .It Fl N Ar userdb-dir
186 Use the user database text file
188 and group database text file
192 rather than using the results from the system's
196 (and related) library calls.
198 Instead of creating the filesystem at the beginning of the file, start
204 .It Fl o Ar fs-options
205 Set file system specific options.
207 is a comma separated list of options.
208 Valid file system specific options are detailed below.
214 .It Fl R Ar roundup-size
215 Round the image up to
218 should be a multiple of the file system block size.
219 This option only applies to the
222 .It Fl S Ar sector-size
223 Set the file system sector size to
225 .\" XXX: next line also true for cd9660?
227 .It Fl s Ar image-size
228 Set the size of the file system image to
230 This is equivalent to setting both the minimum
234 sizes to the same value.
244 is not included in that size.
245 .It Fl T Ar timestamp
246 Specify a timestamp to be set for all filesystem files and directories
247 created so that repeatable builds are possible.
252 where the timestamps are derived from that file, or an integer
253 value interpreted as the number of seconds from the Epoch.
254 Note that timestamps specified in an
256 spec file, override the default timestamp.
261 The following file system types are supported:
262 .Bl -tag -width cd9660 -offset indent
264 BSD fast file system (default).
266 ISO 9660 file system.
268 FAT12, FAT16, or FAT32 file system.
271 Exclude file system nodes not explicitly listed in the specfile.
273 Create a sparse file for
275 This is useful for virtual machine images.
278 Where sizes are specified, a decimal number of bytes is expected.
279 Two or more numbers may be separated by an
281 to indicate a product.
282 Each number may have one of the following optional suffixes:
283 .Bl -tag -width 3n -offset indent -compact
285 Block; multiply by 512
287 Kibi; multiply by 1024 (1 KiB)
289 Mebi; multiply by 1048576 (1 MiB)
291 Gibi; multiply by 1073741824 (1 GiB)
293 Tebi; multiply by 1099511627776 (1 TiB)
295 Word; multiply by the number of bytes in an integer
299 .Ss FFS-specific options
301 images have ffs-specific optional parameters that may be provided.
302 Each of the options consists of a keyword, an equal sign
305 The following keywords are supported:
307 .Bl -tag -width optimization -offset indent -compact
309 Expected average file size.
311 Expected number of files per directory.
319 Label name of the image.
321 Maximum blocks per file in a cylinder group.
325 Optimization preference; one of
332 Maximum total number of blocks in a cylinder group.
335 1 for FFS (default), 2 for UFS2.
337 0 for disable (default), 1 for enable
339 .Ss CD9660-specific options
341 images have ISO9660-specific optional parameters that may be
343 The arguments consist of a keyword and, optionally, an equal sign
346 The following keywords are supported:
348 .Bl -tag -width omit-trailing-period -offset indent -compact
349 .It Sy allow-deep-trees
350 Allow the directory structure to exceed the maximum specified in
352 .It Sy allow-illegal-chars
353 Allow illegal characters in filenames.
354 This option is not implemented.
355 .It Sy allow-lowercase
356 Allow lowercase characters in filenames.
357 This option is not implemented.
358 .It Sy allow-max-name
359 Allow 37 instead of 33 characters for filenames by omitting the
361 .It Sy allow-multidot
362 Allow multiple dots in a filename.
364 Application ID of the image.
372 Boot image directory.
373 This option is not implemented.
375 Write an MBR partition table to the image to allow older CHRP hardware to
377 .It Sy boot-load-segment
378 Set load segment for the boot image.
380 Filename of a boot image in the format
390 .It Sy generic-bootimage
391 Load a generic boot image into the first 32K of the cd9660 image.
392 .It Sy hard-disk-boot
393 Boot image is a hard disk image.
395 An integer representing the ISO 9660 interchange level where
404 .It Sy keep-bad-images
405 Do not discard images whose write was aborted due to an error.
406 For debugging purposes.
408 Label name of the image.
410 Boot image is not bootable.
415 .It Sy no-trailing-padding
416 Do not pad the image (apparently Linux needs the padding).
417 .It Sy omit-trailing-period
418 Omit trailing periods in filenames.
420 Set platform ID of section header entry of the boot image.
422 Preparer ID of the image.
424 Publisher ID of the image.
426 Use RockRidge extensions (for longer filenames, etc.).
428 Turns on verbose output.
430 Volume set identifier of the image.
432 .Ss msdos-specific options
434 images have MS-DOS-specific optional parameters that may be
436 The arguments consist of a keyword, an equal sign
439 The following keywords are supported (see
443 .Bl -tag -width omit-trailing-period -offset indent -compact
445 Location of the backup boot sector.
450 .It Cm bytes_per_sector
454 .It Cm directory_entries
459 FAT type (12, 16, or 32).
461 Preset drive parameters for standard format floppy disks
462 (160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880).
463 .It Cm hidden_sectors
466 Location of the info sector.
467 .It Cm media_descriptor
475 This option will be ignored if
477 is set to a positive number.
478 .It Cm reserved_sectors
480 .It Cm sectors_per_cluster
482 .It Cm sectors_per_fat
484 .It Cm sectors_per_track
504 and first appeared in
508 .Aq Mt lukem@NetBSD.org
513 .An Alan Perez-Rathke ,