1 .\" $NetBSD: makefs.8,v 1.32 2009/01/20 20:47:25 bjh21 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
55 .Op Fl o Ar fs-options
56 .Op Fl R Ar roundup-size
57 .Op Fl S Ar sector-size
58 .Op Fl s Ar image-size
61 .Ar directory | manifest
62 .Op Ar extra-directory ...
66 creates a file system image into
68 from the directory tree
70 or from the mtree manifest
72 If any optional directory trees are passed in the
74 arguments, then the directory tree of each argument will be merged
81 No special devices or privileges are required to perform this task.
83 The options are as follows:
86 Set the byte order of the image to
99 Some file systems may have a fixed byte order; in those cases this
100 argument will be ignored.
101 .It Fl b Ar free-blocks
102 Ensure that a minimum of
104 free blocks exist in the image.
107 suffix may be provided to indicate that
109 indicates a percentage of the calculated image size.
111 Treat duplicate paths in an mtree manifest as warnings not error.
112 .It Fl d Ar debug-mask
113 Enable various levels of debugging, depending upon which bits are
117 .It Fl F Ar mtree-specfile
118 .Em This is almost certainly not the option you are looking for.
119 To create an image from a list of files in an mtree format manifest,
120 specify it as the last argument on the commandline, not as a the
130 This option has no effect when the image is created from a mtree manifest
131 rather than a directory.
133 If a specfile entry exists in the underlying file system, its
134 permissions and modification time will be used unless specifically
135 overridden by the specfile.
136 An error will be raised if the type of entry in the specfile
137 conflicts with that of an existing entry.
139 In the opposite case (where a specfile entry does not have an entry
140 in the underlying file system) the following occurs:
141 If the specfile entry is marked
143 the specfile entry is ignored.
144 Otherwise, the entry will be created in the image, and it is
145 necessary to specify at least the following parameters in the
158 (in the case of symbolic links).
161 isn't provided, the current time will be used.
164 isn't provided, the current file flags will be used.
165 Missing regular file entries will be created as zero-length files.
166 .It Fl f Ar free-files
167 Ensure that a minimum of
169 free files (inodes) exist in the image.
172 suffix may be provided to indicate that
174 indicates a percentage of the calculated image size.
175 .It Fl M Ar minimum-size
176 Set the minimum size of the file system image to
178 .It Fl m Ar maximum-size
179 Set the maximum size of the file system image to
181 An error will be raised if the target file system needs to be larger
182 than this to accommodate the provided directory tree.
183 .It Fl N Ar userdb-dir
184 Use the user database text file
186 and group database text file
190 rather than using the results from the system's
194 (and related) library calls.
195 .It Fl o Ar fs-options
196 Set file system specific options.
198 is a comma separated list of options.
199 Valid file system specific options are detailed below.
205 .It Fl R Ar roundup-size
206 Round the image up to
209 should be a multiple of the file system block size.
210 This option only applies to the
213 .It Fl S Ar sector-size
214 Set the file system sector size to
216 .\" XXX: next line also true for cd9660?
218 .It Fl s Ar image-size
219 Set the size of the file system image to
225 The following file system types are supported:
226 .Bl -tag -width cd9660 -offset indent
228 BSD fast file system (default).
230 ISO 9660 file system.
233 Exclude file system nodes not explicitly listed in the specfile.
235 Create a sparse file for
237 This is useful for virtual machine images.
240 Where sizes are specified, a decimal number of bytes is expected.
241 Two or more numbers may be separated by an
243 to indicate a product.
244 Each number may have one of the following optional suffixes:
245 .Bl -tag -width 3n -offset indent -compact
247 Block; multiply by 512
249 Kibi; multiply by 1024 (1 KiB)
251 Mebi; multiply by 1048576 (1 MiB)
253 Gibi; multiply by 1073741824 (1 GiB)
255 Tebi; multiply by 1099511627776 (1 TiB)
257 Word; multiply by the number of bytes in an integer
261 .Ss FFS-specific options
263 images have ffs-specific optional parameters that may be provided.
264 Each of the options consists of a keyword, an equal sign
267 The following keywords are supported:
269 .Bl -tag -width optimization -offset indent -compact
271 Expected average file size.
273 Expected number of files per directory.
281 Label name of the image.
283 Maximum blocks per file in a cylinder group.
287 Optimization preference; one of
294 Maximum total number of blocks in a cylinder group.
297 1 for FFS (default), 2 for UFS2.
299 .Ss CD9660-specific options
301 images have ISO9660-specific optional parameters that may be
303 The arguments consist of a keyword and, optionally, an equal sign
306 The following keywords are supported:
308 .Bl -tag -width omit-trailing-period -offset indent -compact
309 .It Sy allow-deep-trees
310 Allow the directory structure to exceed the maximum specified in
312 .It Sy allow-illegal-chars
313 Allow illegal characters in filenames. This option is not implemented.
314 .It Sy allow-lowercase
315 Allow lowercase characters in filenames. This option is not implemented.
316 .It Sy allow-max-name
317 Allow 37 instead of 33 characters for filenames by omitting the
319 .It Sy allow-multidot
320 Allow multiple dots in a filename.
322 Application ID of the image.
330 Boot image directory. This option is not implemented.
332 Write an MBR partition table to the image to allow older CHRP hardware to
334 .It Sy boot-load-segment
335 Set load segment for the boot image.
337 Filename of a boot image in the format
347 .It Sy generic-bootimage
348 Load a generic boot image into the first 32K of the cd9660 image.
349 .It Sy hard-disk-boot
350 Boot image is a hard disk image.
352 An integer representing the ISO 9660 interchange level where
361 .It Sy keep-bad-images
362 Do not discard images whose write was aborted due to an error.
363 For debugging purposes.
365 Label name of the image.
367 Boot image is not bootable.
372 .It Sy no-trailing-padding
373 Do not pad the image (apparently Linux needs the padding).
374 .It Sy omit-trailing-period
375 Omit trailing periods in filenames.
377 Preparer ID of the image.
379 Publisher ID of the image.
381 Use RockRidge extensions (for longer filenames, etc.).
383 Turns on verbose output.
385 Volume set identifier of the image.
397 .An Luke Mewburn Aq Mt lukem@NetBSD.org
402 .An Alan Perez-Rathke ,