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