Annotation of src/usr.sbin/makefs/makefs.8, Revision 1.65
1.65 ! reinoud 1: .\" $NetBSD: makefs.8,v 1.64 2019/11/06 21:04:22 christos Exp $
1.1 lukem 2: .\"
1.9 lukem 3: .\" Copyright (c) 2001-2003 Wasabi Systems, Inc.
1.1 lukem 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: .\"
1.64 christos 36: .Dd November 6, 2019
1.1 lukem 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
1.8 wiz 43: .Nm
1.45 christos 44: .Op Fl rxZ
1.36 wiz 45: .Op Fl B Ar endian
1.17 wiz 46: .Op Fl b Ar free-blocks
1.1 lukem 47: .Op Fl d Ar debug-mask
1.36 wiz 48: .Op Fl F Ar mtree-specfile
1.17 wiz 49: .Op Fl f Ar free-files
1.1 lukem 50: .Op Fl M Ar minimum-size
51: .Op Fl m Ar maximum-size
1.17 wiz 52: .Op Fl N Ar userdb-dir
1.44 christos 53: .Op Fl O Ar offset
1.17 wiz 54: .Op Fl o Ar fs-options
55: .Op Fl S Ar sector-size
1.1 lukem 56: .Op Fl s Ar image-size
1.54 christos 57: .Op Fl T Ar timestamp
1.17 wiz 58: .Op Fl t Ar fs-type
1.1 lukem 59: .Ar image-file
60: .Ar directory
1.38 christos 61: .Op Ar extra-directory ...
1.1 lukem 62: .Sh DESCRIPTION
63: The utility
64: .Nm
65: creates a file system image into
66: .Ar image-file
67: from the directory tree
68: .Ar directory .
1.38 christos 69: If any optional directory trees are passed in the
70: .Ar extra-directory
71: arguments, then the directory tree of each argument will be merged
72: into the
73: .Ar directory
74: first before creating
75: .Ar image-file .
1.1 lukem 76: No special devices or privileges are required to perform this task.
77: .Pp
78: The options are as follows:
79: .Bl -tag -width flag
1.36 wiz 80: .It Fl B Ar endian
1.1 lukem 81: Set the byte order of the image to
1.36 wiz 82: .Ar endian .
1.1 lukem 83: Valid byte orders are
1.9 lukem 84: .Ql 4321 ,
1.17 wiz 85: .Ql big ,
1.1 lukem 86: or
87: .Ql be
88: for big endian, and
1.9 lukem 89: .Ql 1234 ,
1.17 wiz 90: .Ql little ,
1.1 lukem 91: or
92: .Ql le
93: for little endian.
94: Some file systems may have a fixed byte order; in those cases this
95: argument will be ignored.
96: .It Fl b Ar free-blocks
97: Ensure that a minimum of
98: .Ar free-blocks
99: free blocks exist in the image.
100: An optional
101: .Ql %
102: suffix may be provided to indicate that
103: .Ar free-blocks
1.14 lukem 104: indicates a percentage of the calculated image size.
1.17 wiz 105: .It Fl d Ar debug-mask
106: Enable various levels of debugging, depending upon which bits are
107: set in
108: .Ar debug-mask .
109: XXX: document these
1.36 wiz 110: .It Fl F Ar mtree-specfile
1.1 lukem 111: Use
1.36 wiz 112: .Ar mtree-specfile
1.1 lukem 113: as an
114: .Xr mtree 8
115: .Sq specfile
116: specification.
117: .Pp
1.17 wiz 118: If a specfile entry exists in the underlying file system, its
119: permissions and modification time will be used unless specifically
120: overridden by the specfile.
121: An error will be raised if the type of entry in the specfile
122: conflicts with that of an existing entry.
1.1 lukem 123: .Pp
1.17 wiz 124: In the opposite case (where a specfile entry does not have an entry
125: in the underlying file system) the following occurs:
1.6 lukem 126: If the specfile entry is marked
127: .Sy optional ,
128: the specfile entry is ignored.
1.17 wiz 129: Otherwise, the entry will be created in the image, and it is
130: necessary to specify at least the following parameters in the
131: specfile:
1.1 lukem 132: .Sy type ,
133: .Sy mode ,
1.17 wiz 134: .Sy gname ,
1.1 lukem 135: or
136: .Sy gid ,
137: and
138: .Sy uname
139: or
140: .Sy uid ,
141: .Sy device
142: (in the case of block or character devices), and
143: .Sy link
144: (in the case of symbolic links).
145: If
146: .Sy time
147: isn't provided, the current time will be used.
148: If
149: .Sy flags
150: isn't provided, the current file flags will be used.
1.6 lukem 151: Missing regular file entries will be created as zero-length files.
1.17 wiz 152: .It Fl f Ar free-files
153: Ensure that a minimum of
154: .Ar free-files
155: free files (inodes) exist in the image.
156: An optional
157: .Ql %
158: suffix may be provided to indicate that
159: .Ar free-files
160: indicates a percentage of the calculated image size.
161: .It Fl M Ar minimum-size
162: Set the minimum size of the file system image to
163: .Ar minimum-size .
164: .It Fl m Ar maximum-size
165: Set the maximum size of the file system image to
166: .Ar maximum-size .
167: An error will be raised if the target file system needs to be larger
168: than this to accommodate the provided directory tree.
1.36 wiz 169: .It Fl N Ar userdb-dir
1.5 lukem 170: Use the user database text file
171: .Pa master.passwd
172: and group database text file
173: .Pa group
174: from
1.36 wiz 175: .Ar userdb-dir ,
1.5 lukem 176: rather than using the results from the system's
177: .Xr getpwnam 3
178: and
179: .Xr getgrnam 3
180: (and related) library calls.
1.44 christos 181: .It Fl O Ar offset
1.55 wiz 182: Instead of creating the file system at the beginning of the file, start
1.44 christos 183: at offset.
184: Valid only for
185: .Sy ffs
186: and
187: .Sy msdos .
1.17 wiz 188: .It Fl o Ar fs-options
189: Set file system specific options.
190: .Ar fs-options
191: is a comma separated list of options.
192: Valid file system specific options are detailed below.
1.47 wiz 193: .It Fl r
194: When merging multiple directories replace duplicate files with the last found.
1.17 wiz 195: .It Fl S Ar sector-size
196: Set the file system sector size to
197: .Ar sector-size .
198: .\" XXX: next line also true for cd9660?
199: Defaults to 512.
200: .It Fl s Ar image-size
201: Set the size of the file system image to
202: .Ar image-size .
1.62 christos 203: This is equivalent of setting both the minimum
1.64 christos 204: .Fl ( M )
205: and the maximum
1.62 christos 206: .Fl ( m )
207: sizes to
1.63 wiz 208: .Ar image-size .
209: For
1.62 christos 210: .Sy ffs
211: and
212: .Sy msdos
213: the
214: .Ar offset
215: is not included on that size.
1.54 christos 216: .It Fl T Ar timestamp
1.55 wiz 217: Specify a timestamp to be set for all file system files and directories
1.54 christos 218: created so that repeatable builds are possible.
219: The
220: .Ar timestamp
221: can be a
222: .Pa pathname ,
223: where the timestamps are derived from that file, a parseable date
224: for
225: .Xr parsedate 3
226: (this option is not yet available in the tools build), or an integer
227: value interpreted as the number of seconds from the Epoch.
228: Note that timestamps specified in an
229: .Xr mtree 5
230: spec file, override the default timestamp.
1.61 wiz 231: When this option is enabled, file systems that regularly use
1.59 christos 232: .Xr localtime 3
1.60 christos 233: to convert times to the native format (such as udf and cd9660), use
1.59 christos 234: .Xr gmtime 3
1.60 christos 235: instead with the specified timestamps so that they are immune to
236: timezone changes and get consistent timestamps.
1.17 wiz 237: .It Fl t Ar fs-type
238: Create an
239: .Ar fs-type
240: file system image.
241: The following file system types are supported:
242: .Bl -tag -width cd9660 -offset indent
243: .It Sy cd9660
244: ISO 9660 file system.
1.39 ttoth 245: .It Sy chfs
246: Chip flash file system.
1.56 wiz 247: .It Sy ffs
248: BSD fast file system (default).
1.42 christos 249: .It Sy msdos
250: FAT12, FAT16, or FAT32 file system.
1.56 wiz 251: .It Sy udf
252: ISO/Ecma UDF file system.
1.34 uch 253: .It Sy v7fs
254: 7th Edition(V7) file system.
1.17 wiz 255: .El
256: .It Fl x
1.24 jschauma 257: Exclude file system nodes not explicitly listed in the specfile.
1.41 sjg 258: .It Fl Z
259: Create a sparse file for
260: .Sy ffs .
261: This is useful for virtual machine images.
1.1 lukem 262: .El
263: .Pp
1.3 lukem 264: Where sizes are specified, a decimal number of bytes is expected.
265: Two or more numbers may be separated by an
1.56 wiz 266: .Sq x
1.3 lukem 267: to indicate a product.
1.13 wiz 268: Each number may have one of the following optional suffixes:
1.1 lukem 269: .Bl -tag -width 3n -offset indent -compact
270: .It b
1.3 lukem 271: Block; multiply by 512
1.1 lukem 272: .It k
1.28 lukem 273: Kibi; multiply by 1024 (1 KiB)
1.1 lukem 274: .It m
1.28 lukem 275: Mebi; multiply by 1048576 (1 MiB)
1.1 lukem 276: .It g
1.28 lukem 277: Gibi; multiply by 1073741824 (1 GiB)
1.3 lukem 278: .It t
1.28 lukem 279: Tebi; multiply by 1099511627776 (1 TiB)
1.3 lukem 280: .It w
281: Word; multiply by the number of bytes in an integer
1.1 lukem 282: .El
283: .\"
284: .\"
285: .Ss FFS-specific options
286: .Sy ffs
287: images have ffs-specific optional parameters that may be provided.
1.17 wiz 288: Each of the options consists of a keyword, an equal sign
1.1 lukem 289: .Pq Ql = ,
290: and a value.
291: The following keywords are supported:
292: .Pp
293: .Bl -tag -width optimization -offset indent -compact
294: .It Sy avgfilesize
1.27 uebayasi 295: Expected average file size.
1.1 lukem 296: .It Sy avgfpdir
1.27 uebayasi 297: Expected number of files per directory.
1.1 lukem 298: .It Sy bsize
1.27 uebayasi 299: Block size.
1.1 lukem 300: .It Sy density
1.27 uebayasi 301: Bytes per inode.
1.56 wiz 302: .It Sy extent
303: Maximum extent size.
1.1 lukem 304: .It Sy fsize
1.27 uebayasi 305: Fragment size.
1.37 christos 306: .It Sy label
307: Label name of the image.
1.56 wiz 308: .It Sy maxbpcg
309: Maximum total number of blocks in a cylinder group.
1.1 lukem 310: .It Sy maxbpg
1.27 uebayasi 311: Maximum blocks per file in a cylinder group.
1.1 lukem 312: .It Sy minfree
1.27 uebayasi 313: Minimum % free.
1.1 lukem 314: .It Sy optimization
315: Optimization preference; one of
316: .Ql space
317: or
318: .Ql time .
1.12 fvdl 319: .It Sy version
1.26 uebayasi 320: UFS version.
1.27 uebayasi 321: 1 for FFS (default), 2 for UFS2.
1.1 lukem 322: .El
1.15 fvdl 323: .Ss CD9660-specific options
324: .Sy cd9660
1.17 wiz 325: images have ISO9660-specific optional parameters that may be
326: provided.
327: The arguments consist of a keyword and, optionally, an equal sign
1.15 fvdl 328: .Pq Ql = ,
329: and a value.
330: The following keywords are supported:
331: .Pp
332: .Bl -tag -width omit-trailing-period -offset indent -compact
333: .It Sy allow-deep-trees
1.17 wiz 334: Allow the directory structure to exceed the maximum specified in
335: the spec.
1.16 fvdl 336: .\" .It Sy allow-illegal-chars
337: .\" Unknown
338: .\" .It Sy allow-lowercase
339: .\" Unknown
1.15 fvdl 340: .It Sy allow-max-name
1.17 wiz 341: Allow 37 instead of 33 characters for filenames by omitting the
1.56 wiz 342: version ID.
1.15 fvdl 343: .It Sy allow-multidot
1.16 fvdl 344: Allow multiple dots in a filename.
1.15 fvdl 345: .It Sy applicationid
1.17 wiz 346: Application ID of the image.
1.31 bjh21 347: .It Sy archimedes
348: Use the
349: .Ql ARCHIMEDES
350: extension to encode
351: .Tn RISC OS
352: metadata.
1.15 fvdl 353: .It Sy boot-load-segment
1.16 fvdl 354: Set load segment for the boot image.
1.15 fvdl 355: .It Sy bootimage
1.17 wiz 356: Filename of a boot image in the format
357: .Dq sysid;filename ,
358: where
359: .Dq sysid
360: is one of
1.18 dyoung 361: .Ql i386 ,
1.19 dyoung 362: .Ql mac68k ,
1.18 dyoung 363: .Ql macppc ,
1.15 fvdl 364: or
1.18 dyoung 365: .Ql powerpc .
1.56 wiz 366: .It Sy chrp-boot
367: Write an MBR partition table to the image to allow older CHRP hardware to
368: boot.
1.30 skrll 369: .It Sy generic-bootimage
370: Load a generic boot image into the first 32K of the cd9660 image.
1.15 fvdl 371: .It Sy hard-disk-boot
1.16 fvdl 372: Boot image is a hard disk image.
1.15 fvdl 373: .It Sy keep-bad-images
1.17 wiz 374: Don't throw away images whose write was aborted due to an error.
375: For debugging purposes.
1.15 fvdl 376: .It Sy label
1.17 wiz 377: Label name of the image.
1.15 fvdl 378: .It Sy no-boot
1.16 fvdl 379: Boot image is not bootable.
1.15 fvdl 380: .It Sy no-emul-boot
1.17 wiz 381: Boot image is a
382: .Dq no emulation
383: ElTorito image.
1.15 fvdl 384: .It Sy no-trailing-padding
1.16 fvdl 385: Do not pad the image (apparently Linux needs the padding).
386: .\" .It Sy omit-trailing-period
387: .\" Unknown
1.58 nonaka 388: .It Sy platformid
389: Set platform ID of section header entry of the boot image.
1.15 fvdl 390: .It Sy preparer
1.17 wiz 391: Preparer ID of the image.
1.15 fvdl 392: .It Sy publisher
1.17 wiz 393: Publisher ID of the image.
1.15 fvdl 394: .It Sy rockridge
1.17 wiz 395: Use RockRidge extensions (for longer filenames, etc.).
1.15 fvdl 396: .It Sy volumeid
1.17 wiz 397: Volume set identifier of the image.
1.15 fvdl 398: .El
1.39 ttoth 399: .Ss CHFS-specific options
400: .Sy chfs
401: images have chfs-specific optional parameters that may be provided.
402: Each of the options consists of a keyword, an equal sign
403: .Pq Ql = ,
404: and a value.
405: The following keywords are supported:
406: .Pp
407: .Bl -tag -width optimization -offset indent -compact
408: .It Sy pagesize
409: Pagesize.
410: .It Sy erasesize
411: Erase block size of the media.
412: .It Sy mediatype
1.40 wiz 413: Type of the media.
414: NOR: 0 or NAND: 1.
1.39 ttoth 415: .El
1.42 christos 416: .Ss msdos-specific options
1.57 wiz 417: .Sy msdos
418: images have MS-DOS-specific optional parameters that may be
419: provided.
420: The arguments consist of a keyword, an equal sign
421: .Pq Ql = ,
422: and a value.
423: The following keywords are supported (see
1.42 christos 424: .Xr newfs_msdos 8
1.57 wiz 425: for more details):
426: .Pp
427: .Bl -tag -width omit-trailing-period -offset indent -compact
428: .It Cm backup_sector
429: Location of the backup boot sector.
430: .It Cm block_size
431: Block size.
432: .It Cm bootstrap
433: Bootstrap file.
434: .It Cm bytes_per_sector
435: Bytes per sector.
436: .It Cm create_size
437: Create file size.
438: .It Cm directory_entries
439: Directory entries.
440: .It Cm drive_heads
441: Drive heads.
442: .It Cm fat_type
443: FAT type (12, 16, or 32).
444: .It Cm floppy
445: Preset drive parameters for standard format floppy disks
446: (160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880).
447: .It Cm hidden_sectors
448: Hidden sectors.
449: .It Cm info_sector
450: Location of the info sector.
451: .It Cm media_descriptor
452: Media descriptor.
453: .It Cm num_FAT
454: Number of FATs.
455: .It Cm OEM_string
456: OEM string.
457: .It Cm offset
458: Offset in device.
459: .It Cm reserved_sectors
460: Reserved sectors.
461: .It Cm sectors_per_cluster
462: Sectors per cluster.
463: .It Cm sectors_per_fat
464: Sectors per FAT.
465: .It Cm sectors_per_track
466: Sectors per track.
467: .It Cm size
468: File System size.
469: .It Cm volume_id
470: Volume ID.
471: .It Cm volume_label
472: Volume Label.
473: .El
1.34 uch 474: .Ss V7FS-specific options
475: The following keywords are supported:
476: .Pp
477: .Bl -tag -width optimization -offset indent -compact
478: .It Sy pdp
479: PDP endian.
480: .It Sy progress
481: Display a progress meter for the file system construction and file
1.35 wiz 482: population.
1.34 uch 483: .El
1.46 reinoud 484: .Ss UDF-specific options
485: .Sy udf
1.47 wiz 486: images have udf-specific optional parameters that may be provided.
1.46 reinoud 487: Each of the options consists of a keyword, an equal sign
488: .Pq Ql = ,
489: and a value.
490: The following keywords are supported:
1.51 reinoud 491: .Pp
1.65 ! reinoud 492: .Bl -tag -width optimization -offset indent -compact
1.47 wiz 493: .It Sy disctype
494: This can have the following values:
1.51 reinoud 495: .Bl -tag -width cdromXdvdromXbdromXXX -compact
1.49 reinoud 496: .It Sy cdrom , Sy dvdrom , Sy bdrom
1.46 reinoud 497: create a read-only fs
1.47 wiz 498: .It Sy dvdram , Sy bdre , Sy disk
499: create a rewritable fs without sparing for defective sectors
1.49 reinoud 500: .It Sy cdr , Sy dvdr , Sy bdr
1.46 reinoud 501: create a rewritable fs on once recordable media using a VAT
1.47 wiz 502: .It Sy cdrw , Sy dvdrw
1.46 reinoud 503: create a rewritable fs with sparing for defective sectors
1.47 wiz 504: .El
1.49 reinoud 505: When an optical media is selected here, the sectorsize and the default disc
1.50 wiz 506: size is assumed unless given explicitly.
1.51 reinoud 507: For rom images the disc size is the minimum needed.
508: .It Sy loglabel
509: Set the logical volume label of the disc to the specified argument.
510: .It Sy discid
1.53 wiz 511: Set the physical volume label of the disc to the specified argument.
512: Prepend the physical volume label with a volumeset label separated
513: with a ':' if wanted.
514: For strict conformance and interchange, don't set the volumeset label
1.51 reinoud 515: manually unless it has an unique hex number in the first 8 character
516: positions.
1.52 reinoud 517: .It Sy minver
1.53 wiz 518: Set the minimum UDF version to be used.
519: Choose UDF version numbers from 0x102, 0x150, 0x200, and 0x201.
520: Versions 0x250 and 0x260 are currently not supported
1.52 reinoud 521: in
522: .Nm .
1.53 wiz 523: .El
1.1 lukem 524: .Sh SEE ALSO
1.29 wiz 525: .Xr strsuftoll 3 ,
1.23 wiz 526: .Xr installboot 8 ,
1.1 lukem 527: .Xr mtree 8 ,
1.23 wiz 528: .Xr newfs 8
1.1 lukem 529: .Sh HISTORY
530: The
531: .Nm
532: utility appeared in
533: .Nx 1.6 .
1.4 wiz 534: .Sh AUTHORS
1.7 grant 535: .An Luke Mewburn
1.15 fvdl 536: .Aq lukem@NetBSD.org
1.36 wiz 537: (original program),
1.17 wiz 538: .An Daniel Watt ,
539: .An Walter Deignan ,
540: .An Ryan Gabrys ,
541: .An Alan Perez-Rathke ,
542: .An Ram Vedam
1.34 uch 543: (cd9660 support),
544: .An UCHIYAMA Yasushi
1.39 ttoth 545: (v7fs support),
546: .An Tamas Toth
1.56 wiz 547: (chfs support),
1.43 christos 548: .An Christos Zoulas
1.56 wiz 549: (msdos support),
1.48 reinoud 550: .An Reinoud Zandijk
551: (udf support).
CVSweb <webmaster@jp.NetBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to makefs.8 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / usr.sbin / makefs