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