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