| blob | 0c1795d2f4f768808cda492473440115f3b2c727 |
1 .\" $NetBSD: makefs.8,v 1.31 2009/01/10 22:06:29 bjh21 Exp $
2 .\"
3 .\" Copyright (c) 2001-2003 Wasabi Systems, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Written by Luke Mewburn for Wasabi Systems, Inc.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
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.
23 .\"
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.
35 .\"
36 .Dd January 10, 2009
37 .Dt MAKEFS 8
38 .Os
39 .Sh NAME
40 .Nm makefs
41 .Nd create a file system image from a directory tree
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl x
45 .Op Fl B Ar byte-order
46 .Op Fl b Ar free-blocks
47 .Op Fl d Ar debug-mask
48 .Op Fl F Ar specfile
49 .Op Fl f Ar free-files
50 .Op Fl M Ar minimum-size
51 .Op Fl m Ar maximum-size
52 .Op Fl N Ar userdb-dir
53 .Op Fl o Ar fs-options
54 .Op Fl S Ar sector-size
55 .Op Fl s Ar image-size
56 .Op Fl t Ar fs-type
57 .Ar image-file
58 .Ar directory
59 .Sh DESCRIPTION
60 The utility
61 .Nm
62 creates a file system image into
63 .Ar image-file
64 from the directory tree
65 .Ar directory .
66 No special devices or privileges are required to perform this task.
67 .Pp
68 The options are as follows:
69 .Bl -tag -width flag
70 .It Fl B Ar byte-order
71 Set the byte order of the image to
72 .Ar byte-order .
73 Valid byte orders are
74 .Ql 4321 ,
75 .Ql big ,
76 or
77 .Ql be
78 for big endian, and
79 .Ql 1234 ,
80 .Ql little ,
81 or
82 .Ql le
83 for little endian.
84 Some file systems may have a fixed byte order; in those cases this
85 argument will be ignored.
86 .It Fl b Ar free-blocks
87 Ensure that a minimum of
88 .Ar free-blocks
89 free blocks exist in the image.
90 An optional
91 .Ql %
92 suffix may be provided to indicate that
93 .Ar free-blocks
94 indicates a percentage of the calculated image size.
95 .It Fl d Ar debug-mask
96 Enable various levels of debugging, depending upon which bits are
97 set in
98 .Ar debug-mask .
99 XXX: document these
100 .It Fl F Ar specfile
101 Use
102 .Ar specfile
103 as an
104 .Xr mtree 8
105 .Sq specfile
106 specification.
107 .Pp
108 If a specfile entry exists in the underlying file system, its
109 permissions and modification time will be used unless specifically
110 overridden by the specfile.
111 An error will be raised if the type of entry in the specfile
112 conflicts with that of an existing entry.
113 .Pp
114 In the opposite case (where a specfile entry does not have an entry
115 in the underlying file system) the following occurs:
116 If the specfile entry is marked
117 .Sy optional ,
118 the specfile entry is ignored.
119 Otherwise, the entry will be created in the image, and it is
120 necessary to specify at least the following parameters in the
121 specfile:
122 .Sy type ,
123 .Sy mode ,
124 .Sy gname ,
125 or
126 .Sy gid ,
127 and
128 .Sy uname
129 or
130 .Sy uid ,
131 .Sy device
132 (in the case of block or character devices), and
133 .Sy link
134 (in the case of symbolic links).
135 If
136 .Sy time
137 isn't provided, the current time will be used.
138 If
139 .Sy flags
140 isn't provided, the current file flags will be used.
141 Missing regular file entries will be created as zero-length files.
142 .It Fl f Ar free-files
143 Ensure that a minimum of
144 .Ar free-files
145 free files (inodes) exist in the image.
146 An optional
147 .Ql %
148 suffix may be provided to indicate that
149 .Ar free-files
150 indicates a percentage of the calculated image size.
151 .It Fl M Ar minimum-size
152 Set the minimum size of the file system image to
153 .Ar minimum-size .
154 .It Fl m Ar maximum-size
155 Set the maximum size of the file system image to
156 .Ar maximum-size .
157 An error will be raised if the target file system needs to be larger
158 than this to accommodate the provided directory tree.
159 .It Fl N Ar dbdir
160 Use the user database text file
161 .Pa master.passwd
162 and group database text file
163 .Pa group
164 from
165 .Ar dbdir ,
166 rather than using the results from the system's
167 .Xr getpwnam 3
168 and
169 .Xr getgrnam 3
170 (and related) library calls.
171 .It Fl o Ar fs-options
172 Set file system specific options.
173 .Ar fs-options
174 is a comma separated list of options.
175 Valid file system specific options are detailed below.
176 .It Fl S Ar sector-size
177 Set the file system sector size to
178 .Ar sector-size .
179 .\" XXX: next line also true for cd9660?
180 Defaults to 512.
181 .It Fl s Ar image-size
182 Set the size of the file system image to
183 .Ar image-size .
184 .It Fl t Ar fs-type
185 Create an
186 .Ar fs-type
187 file system image.
188 The following file system types are supported:
189 .Bl -tag -width cd9660 -offset indent
190 .It Sy ffs
191 BSD fast file system (default).
192 .It Sy cd9660
193 ISO 9660 file system.
194 .El
195 .It Fl x
196 Exclude file system nodes not explicitly listed in the specfile.
197 .El
198 .Pp
199 Where sizes are specified, a decimal number of bytes is expected.
200 Two or more numbers may be separated by an
201 .Dq x
202 to indicate a product.
203 Each number may have one of the following optional suffixes:
204 .Bl -tag -width 3n -offset indent -compact
205 .It b
206 Block; multiply by 512
207 .It k
208 Kibi; multiply by 1024 (1 KiB)
209 .It m
210 Mebi; multiply by 1048576 (1 MiB)
211 .It g
212 Gibi; multiply by 1073741824 (1 GiB)
213 .It t
214 Tebi; multiply by 1099511627776 (1 TiB)
215 .It w
216 Word; multiply by the number of bytes in an integer
217 .El
218 .\"
219 .\"
220 .Ss FFS-specific options
221 .Sy ffs
222 images have ffs-specific optional parameters that may be provided.
223 Each of the options consists of a keyword, an equal sign
224 .Pq Ql = ,
225 and a value.
226 The following keywords are supported:
227 .Pp
228 .Bl -tag -width optimization -offset indent -compact
229 .It Sy avgfilesize
230 Expected average file size.
231 .It Sy avgfpdir
232 Expected number of files per directory.
233 .It Sy bsize
234 Block size.
235 .It Sy density
236 Bytes per inode.
237 .It Sy fsize
238 Fragment size.
239 .It Sy maxbpg
240 Maximum blocks per file in a cylinder group.
241 .It Sy minfree
242 Minimum % free.
243 .It Sy optimization
244 Optimization preference; one of
245 .Ql space
246 or
247 .Ql time .
248 .It Sy extent
249 Maximum extent size.
250 .It Sy maxbpcg
251 Maximum total number of blocks in a cylinder group.
252 .It Sy version
253 UFS version.
254 1 for FFS (default), 2 for UFS2.
255 .El
256 .Ss CD9660-specific options
257 .Sy cd9660
258 images have ISO9660-specific optional parameters that may be
259 provided.
260 The arguments consist of a keyword and, optionally, an equal sign
261 .Pq Ql = ,
262 and a value.
263 The following keywords are supported:
264 .Pp
265 .Bl -tag -width omit-trailing-period -offset indent -compact
266 .It Sy allow-deep-trees
267 Allow the directory structure to exceed the maximum specified in
268 the spec.
269 .\" .It Sy allow-illegal-chars
270 .\" Unknown
271 .\" .It Sy allow-lowercase
272 .\" Unknown
273 .It Sy allow-max-name
274 Allow 37 instead of 33 characters for filenames by omitting the
275 version id.
276 .It Sy allow-multidot
277 Allow multiple dots in a filename.
278 .It Sy applicationid
279 Application ID of the image.
280 .It Sy archimedes
281 Use the
282 .Ql ARCHIMEDES
283 extension to encode
284 .Tn RISC OS
285 metadata.
286 .It Sy boot-load-segment
287 Set load segment for the boot image.
288 .It Sy bootimage
289 Filename of a boot image in the format
290 .Dq sysid;filename ,
291 where
292 .Dq sysid
293 is one of
294 .Ql i386 ,
295 .Ql mac68k ,
296 .Ql macppc ,
297 or
298 .Ql powerpc .
299 .It Sy generic-bootimage
300 Load a generic boot image into the first 32K of the cd9660 image.
301 .It Sy hard-disk-boot
302 Boot image is a hard disk image.
303 .It Sy keep-bad-images
304 Don't throw away images whose write was aborted due to an error.
305 For debugging purposes.
306 .It Sy label
307 Label name of the image.
308 .It Sy no-boot
309 Boot image is not bootable.
310 .It Sy no-emul-boot
311 Boot image is a
312 .Dq no emulation
313 ElTorito image.
314 .It Sy no-trailing-padding
315 Do not pad the image (apparently Linux needs the padding).
316 .\" .It Sy omit-trailing-period
317 .\" Unknown
318 .It Sy preparer
319 Preparer ID of the image.
320 .It Sy publisher
321 Publisher ID of the image.
322 .It Sy rockridge
323 Use RockRidge extensions (for longer filenames, etc.).
324 .It Sy volumeid
325 Volume set identifier of the image.
326 .El
327 .Sh SEE ALSO
328 .Xr strsuftoll 3 ,
329 .Xr installboot 8 ,
330 .Xr mtree 8 ,
331 .Xr newfs 8
332 .Sh HISTORY
333 The
334 .Nm
335 utility appeared in
336 .Nx 1.6 .
337 .Sh AUTHORS
338 .An Luke Mewburn
339 .Aq lukem@NetBSD.org
340 (original program)
341 .An Daniel Watt ,
342 .An Walter Deignan ,
343 .An Ryan Gabrys ,
344 .An Alan Perez-Rathke ,
345 .An Ram Vedam
346 (cd9660 support)