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