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
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
62 .Ar directory | manifest
63 .Op Ar extra-directory ...
67 creates a file system image into
69 from the directory tree
71 or from the mtree manifest
73 If any optional directory trees are passed in the
75 arguments, then the directory tree of each argument will be merged
82 No special devices or privileges are required to perform this task.
84 The options are as follows:
87 Set the byte order of the image to
100 Some file systems may have a fixed byte order; in those cases this
101 argument will be ignored.
102 .It Fl b Ar free-blocks
103 Ensure that a minimum of
105 free blocks exist in the image.
108 suffix may be provided to indicate that
110 indicates a percentage of the calculated image size.
112 Treat duplicate paths in an mtree manifest as warnings not error.
113 .It Fl d Ar debug-mask
114 Enable various levels of debugging, depending upon which bits are
118 .It Fl F Ar mtree-specfile
119 .Em This is almost certainly not the option you are looking for.
120 To create an image from a list of files in an mtree format manifest,
121 specify it as the last argument on the commandline, not as a the
131 This option has no effect when the image is created from a mtree manifest
132 rather than a directory.
134 If a specfile entry exists in the underlying file system, its
135 permissions and modification time will be used unless specifically
136 overridden by the specfile.
137 An error will be raised if the type of entry in the specfile
138 conflicts with that of an existing entry.
140 In the opposite case (where a specfile entry does not have an entry
141 in the underlying file system) the following occurs:
142 If the specfile entry is marked
144 the specfile entry is ignored.
145 Otherwise, the entry will be created in the image, and it is
146 necessary to specify at least the following parameters in the
159 (in the case of symbolic links).
162 isn't provided, the current time will be used.
165 isn't provided, the current file flags will be used.
166 Missing regular file entries will be created as zero-length files.
167 .It Fl f Ar free-files
168 Ensure that a minimum of
170 free files (inodes) exist in the image.
173 suffix may be provided to indicate that
175 indicates a percentage of the calculated image size.
176 .It Fl M Ar minimum-size
177 Set the minimum size of the file system image to
179 .It Fl m Ar maximum-size
180 Set the maximum size of the file system image to
182 An error will be raised if the target file system needs to be larger
183 than this to accommodate the provided directory tree.
184 .It Fl N Ar userdb-dir
185 Use the user database text file
187 and group database text file
191 rather than using the results from the system's
195 (and related) library calls.
196 .It Fl o Ar fs-options
197 Set file system specific options.
199 is a comma separated list of options.
200 Valid file system specific options are detailed below.
206 .It Fl R Ar roundup-size
207 Round the image up to
210 should be a multiple of the file system block size.
211 This option only applies to the
214 .It Fl S Ar sector-size
215 Set the file system sector size to
217 .\" XXX: next line also true for cd9660?
219 .It Fl s Ar image-size
220 Set the size of the file system image to
222 .It Fl T Ar timestamp
223 Specify a timestamp to be set for all filesystem files and directories
224 created so that repeatable builds are possible.
229 where the timestamps are derived from that file, or an integer
230 value interpreted as the number of seconds from the Epoch.
231 Note that timestamps specified in an
233 spec file, override the default timestamp.
238 The following file system types are supported:
239 .Bl -tag -width cd9660 -offset indent
241 BSD fast file system (default).
243 ISO 9660 file system.
246 Exclude file system nodes not explicitly listed in the specfile.
248 Create a sparse file for
250 This is useful for virtual machine images.
253 Where sizes are specified, a decimal number of bytes is expected.
254 Two or more numbers may be separated by an
256 to indicate a product.
257 Each number may have one of the following optional suffixes:
258 .Bl -tag -width 3n -offset indent -compact
260 Block; multiply by 512
262 Kibi; multiply by 1024 (1 KiB)
264 Mebi; multiply by 1048576 (1 MiB)
266 Gibi; multiply by 1073741824 (1 GiB)
268 Tebi; multiply by 1099511627776 (1 TiB)
270 Word; multiply by the number of bytes in an integer
274 .Ss FFS-specific options
276 images have ffs-specific optional parameters that may be provided.
277 Each of the options consists of a keyword, an equal sign
280 The following keywords are supported:
282 .Bl -tag -width optimization -offset indent -compact
284 Expected average file size.
286 Expected number of files per directory.
294 Label name of the image.
296 Maximum blocks per file in a cylinder group.
300 Optimization preference; one of
307 Maximum total number of blocks in a cylinder group.
310 1 for FFS (default), 2 for UFS2.
312 .Ss CD9660-specific options
314 images have ISO9660-specific optional parameters that may be
316 The arguments consist of a keyword and, optionally, an equal sign
319 The following keywords are supported:
321 .Bl -tag -width omit-trailing-period -offset indent -compact
322 .It Sy allow-deep-trees
323 Allow the directory structure to exceed the maximum specified in
325 .It Sy allow-illegal-chars
326 Allow illegal characters in filenames. This option is not implemented.
327 .It Sy allow-lowercase
328 Allow lowercase characters in filenames. This option is not implemented.
329 .It Sy allow-max-name
330 Allow 37 instead of 33 characters for filenames by omitting the
332 .It Sy allow-multidot
333 Allow multiple dots in a filename.
335 Application ID of the image.
343 Boot image directory. This option is not implemented.
345 Write an MBR partition table to the image to allow older CHRP hardware to
347 .It Sy boot-load-segment
348 Set load segment for the boot image.
350 Filename of a boot image in the format
360 .It Sy generic-bootimage
361 Load a generic boot image into the first 32K of the cd9660 image.
362 .It Sy hard-disk-boot
363 Boot image is a hard disk image.
365 An integer representing the ISO 9660 interchange level where
374 .It Sy keep-bad-images
375 Do not discard images whose write was aborted due to an error.
376 For debugging purposes.
378 Label name of the image.
380 Boot image is not bootable.
385 .It Sy no-trailing-padding
386 Do not pad the image (apparently Linux needs the padding).
387 .It Sy omit-trailing-period
388 Omit trailing periods in filenames.
390 Set platform ID of section header entry of the boot image.
392 Preparer ID of the image.
394 Publisher ID of the image.
396 Use RockRidge extensions (for longer filenames, etc.).
398 Turns on verbose output.
400 Volume set identifier of the image.
413 .Aq Mt lukem@NetBSD.org
418 .An Alan Perez-Rathke ,