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 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 optional directory tree
74 is passed, 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:
85 .It Fl B Ar byte-order
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
124 This option has no effect when the image is created from a mtree manifest
125 rather than a directory.
127 If a specfile entry exists in the underlying file system, its
128 permissions and modification time will be used unless specifically
129 overridden by the specfile.
130 An error will be raised if the type of entry in the specfile
131 conflicts with that of an existing entry.
133 In the opposite case (where a specfile entry does not have an entry
134 in the underlying file system) the following occurs:
135 If the specfile entry is marked
137 the specfile entry is ignored.
138 Otherwise, the entry will be created in the image, and it is
139 necessary to specify at least the following parameters in the
152 (in the case of symbolic links).
155 isn't provided, the current time will be used.
158 isn't provided, the current file flags will be used.
159 Missing regular file entries will be created as zero-length files.
160 .It Fl f Ar free-files
161 Ensure that a minimum of
163 free files (inodes) exist in the image.
166 suffix may be provided to indicate that
168 indicates a percentage of the calculated image size.
169 .It Fl M Ar minimum-size
170 Set the minimum size of the file system image to
172 .It Fl m Ar maximum-size
173 Set the maximum size of the file system image to
175 An error will be raised if the target file system needs to be larger
176 than this to accommodate the provided directory tree.
178 Use the user database text file
180 and group database text file
184 rather than using the results from the system's
188 (and related) library calls.
189 .It Fl o Ar fs-options
190 Set file system specific options.
192 is a comma separated list of options.
193 Valid file system specific options are detailed below.
199 .It Fl R Ar roundup-size
200 Round the image up to
203 should be a multiple of the file system block size.
204 This option only applies to the
207 .It Fl S Ar sector-size
208 Set the file system sector size to
210 .\" XXX: next line also true for cd9660?
212 .It Fl s Ar image-size
213 Set the size of the file system image to
219 The following file system types are supported:
220 .Bl -tag -width cd9660 -offset indent
222 BSD fast file system (default).
224 ISO 9660 file system.
227 Exclude file system nodes not explicitly listed in the specfile.
229 Create the image as a sparse file.
232 Where sizes are specified, a decimal number of bytes is expected.
233 Two or more numbers may be separated by an
235 to indicate a product.
236 Each number may have one of the following optional suffixes:
237 .Bl -tag -width 3n -offset indent -compact
239 Block; multiply by 512
241 Kibi; multiply by 1024 (1 KiB)
243 Mebi; multiply by 1048576 (1 MiB)
245 Gibi; multiply by 1073741824 (1 GiB)
247 Tebi; multiply by 1099511627776 (1 TiB)
249 Word; multiply by the number of bytes in an integer
253 .Ss FFS-specific options
255 images have ffs-specific optional parameters that may be provided.
256 Each of the options consists of a keyword, an equal sign
259 The following keywords are supported:
261 .Bl -tag -width optimization -offset indent -compact
263 Expected average file size.
265 Expected number of files per directory.
273 Label name of the image.
275 Maximum blocks per file in a cylinder group.
279 Optimization preference; one of
286 Maximum total number of blocks in a cylinder group.
289 1 for FFS (default), 2 for UFS2.
291 .Ss CD9660-specific options
293 images have ISO9660-specific optional parameters that may be
295 The arguments consist of a keyword and, optionally, an equal sign
298 The following keywords are supported:
300 .Bl -tag -width omit-trailing-period -offset indent -compact
301 .It Sy allow-deep-trees
302 Allow the directory structure to exceed the maximum specified in
304 .\" .It Sy allow-illegal-chars
306 .\" .It Sy allow-lowercase
308 .It Sy allow-max-name
309 Allow 37 instead of 33 characters for filenames by omitting the
311 .It Sy allow-multidot
312 Allow multiple dots in a filename.
314 Application ID of the image.
322 Write an MBR partition table to the image to allow older CHRP hardware to
324 .It Sy boot-load-segment
325 Set load segment for the boot image.
327 Filename of a boot image in the format
337 .It Sy generic-bootimage
338 Load a generic boot image into the first 32K of the cd9660 image.
339 .It Sy hard-disk-boot
340 Boot image is a hard disk image.
341 .It Sy keep-bad-images
342 Don't throw away images whose write was aborted due to an error.
343 For debugging purposes.
345 Label name of the image.
347 Boot image is not bootable.
352 .It Sy no-trailing-padding
353 Do not pad the image (apparently Linux needs the padding).
354 .\" .It Sy omit-trailing-period
357 Preparer ID of the image.
359 Publisher ID of the image.
361 Use RockRidge extensions (for longer filenames, etc.).
363 Volume set identifier of the image.
381 .An Alan Perez-Rathke ,