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
47 .Op Fl B Ar byte-order
48 .Op Fl b Ar free-blocks
49 .Op Fl d Ar debug-mask
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 S Ar sector-size
57 .Op Fl s Ar image-size
60 .Ar directory | manifest
61 .Op Ar extra-directory ...
65 creates a file system image into
67 from the directory tree
69 or from the mtree manifest
71 If optional directory tree
73 is passed, then the directory tree of each argument will be merged
80 No special devices or privileges are required to perform this task.
82 The options are as follows:
84 .It Fl B Ar byte-order
85 Set the byte order of the image to
98 Some file systems may have a fixed byte order; in those cases this
99 argument will be ignored.
100 .It Fl b Ar free-blocks
101 Ensure that a minimum of
103 free blocks exist in the image.
106 suffix may be provided to indicate that
108 indicates a percentage of the calculated image size.
109 .It Fl d Ar debug-mask
110 Enable various levels of debugging, depending upon which bits are
121 This option has no effect when the image is created from a mtree manifest
122 rather than a directory.
124 If a specfile entry exists in the underlying file system, its
125 permissions and modification time will be used unless specifically
126 overridden by the specfile.
127 An error will be raised if the type of entry in the specfile
128 conflicts with that of an existing entry.
130 In the opposite case (where a specfile entry does not have an entry
131 in the underlying file system) the following occurs:
132 If the specfile entry is marked
134 the specfile entry is ignored.
135 Otherwise, the entry will be created in the image, and it is
136 necessary to specify at least the following parameters in the
149 (in the case of symbolic links).
152 isn't provided, the current time will be used.
155 isn't provided, the current file flags will be used.
156 Missing regular file entries will be created as zero-length files.
157 .It Fl f Ar free-files
158 Ensure that a minimum of
160 free files (inodes) exist in the image.
163 suffix may be provided to indicate that
165 indicates a percentage of the calculated image size.
166 .It Fl M Ar minimum-size
167 Set the minimum size of the file system image to
169 .It Fl m Ar maximum-size
170 Set the maximum size of the file system image to
172 An error will be raised if the target file system needs to be larger
173 than this to accommodate the provided directory tree.
175 Use the user database text file
177 and group database text file
181 rather than using the results from the system's
185 (and related) library calls.
186 .It Fl o Ar fs-options
187 Set file system specific options.
189 is a comma separated list of options.
190 Valid file system specific options are detailed below.
192 Create the image as a sparse file.
193 .It Fl S Ar sector-size
194 Set the file system sector size to
196 .\" XXX: next line also true for cd9660?
198 .It Fl s Ar image-size
199 Set the size of the file system image to
205 The following file system types are supported:
206 .Bl -tag -width cd9660 -offset indent
208 BSD fast file system (default).
210 ISO 9660 file system.
213 Exclude file system nodes not explicitly listed in the specfile.
216 Where sizes are specified, a decimal number of bytes is expected.
217 Two or more numbers may be separated by an
219 to indicate a product.
220 Each number may have one of the following optional suffixes:
221 .Bl -tag -width 3n -offset indent -compact
223 Block; multiply by 512
225 Kibi; multiply by 1024 (1 KiB)
227 Mebi; multiply by 1048576 (1 MiB)
229 Gibi; multiply by 1073741824 (1 GiB)
231 Tebi; multiply by 1099511627776 (1 TiB)
233 Word; multiply by the number of bytes in an integer
237 .Ss FFS-specific options
239 images have ffs-specific optional parameters that may be provided.
240 Each of the options consists of a keyword, an equal sign
243 The following keywords are supported:
245 .Bl -tag -width optimization -offset indent -compact
247 Expected average file size.
249 Expected number of files per directory.
257 Label name of the image.
259 Maximum blocks per file in a cylinder group.
263 Optimization preference; one of
270 Maximum total number of blocks in a cylinder group.
273 1 for FFS (default), 2 for UFS2.
275 .Ss CD9660-specific options
277 images have ISO9660-specific optional parameters that may be
279 The arguments consist of a keyword and, optionally, an equal sign
282 The following keywords are supported:
284 .Bl -tag -width omit-trailing-period -offset indent -compact
285 .It Sy allow-deep-trees
286 Allow the directory structure to exceed the maximum specified in
288 .\" .It Sy allow-illegal-chars
290 .\" .It Sy allow-lowercase
292 .It Sy allow-max-name
293 Allow 37 instead of 33 characters for filenames by omitting the
295 .It Sy allow-multidot
296 Allow multiple dots in a filename.
298 Application ID of the image.
306 Write an MBR partition table to the image to allow older CHRP hardware to
308 .It Sy boot-load-segment
309 Set load segment for the boot image.
311 Filename of a boot image in the format
321 .It Sy generic-bootimage
322 Load a generic boot image into the first 32K of the cd9660 image.
323 .It Sy hard-disk-boot
324 Boot image is a hard disk image.
325 .It Sy keep-bad-images
326 Don't throw away images whose write was aborted due to an error.
327 For debugging purposes.
329 Label name of the image.
331 Boot image is not bootable.
336 .It Sy no-trailing-padding
337 Do not pad the image (apparently Linux needs the padding).
338 .\" .It Sy omit-trailing-period
341 Preparer ID of the image.
343 Publisher ID of the image.
345 Use RockRidge extensions (for longer filenames, etc.).
347 Volume set identifier of the image.
365 .An Alan Perez-Rathke ,