1.\" $NetBSD: makefs.8,v 1.33 2011/05/22 21:51:39 christos 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 September 17, 2020 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 offset 56.Op Fl o Ar fs-options 57.Op Fl R Ar roundup-size 58.Op Fl S Ar sector-size 59.Op Fl s Ar image-size 60.Op Fl T Ar timestamp 61.Op Fl t Ar fs-type 62.Ar image-file 63.Ar directory | manifest 64.Op Ar extra-directory ... 65.Sh DESCRIPTION 66The utility 67.Nm 68creates a file system image into 69.Ar image-file 70from the directory tree 71.Ar directory 72or from the mtree manifest 73.Ar manifest . 74If any optional directory trees are passed in the 75.Ar extra-directory 76arguments, then the directory tree of each argument will be merged 77into the 78.Ar directory 79or 80.Ar manifest 81first before creating 82.Ar image-file . 83No special devices or privileges are required to perform this task. 84.Pp 85The options are as follows: 86.Bl -tag -width flag 87.It Fl B Ar endian 88Set the byte order of the image to 89.Ar endian . 90Valid byte orders are 91.Ql 4321 , 92.Ql big , 93or 94.Ql be 95for big endian, and 96.Ql 1234 , 97.Ql little , 98or 99.Ql le 100for little endian. 101Some file systems may have a fixed byte order; in those cases this 102argument will be ignored. 103.It Fl b Ar free-blocks 104Ensure that a minimum of 105.Ar free-blocks 106free blocks exist in the image. 107An optional 108.Ql % 109suffix may be provided to indicate that 110.Ar free-blocks 111indicates a percentage of the calculated image size. 112.It Fl D 113Treat duplicate paths in an mtree manifest as warnings not error. 114.It Fl d Ar debug-mask 115Enable various levels of debugging, depending upon which bits are 116set in 117.Ar debug-mask . 118XXX: document these 119.It Fl F Ar mtree-specfile 120.Em This is almost certainly not the option you are looking for. 121To create an image from a list of files in an mtree format manifest, 122specify it as the last argument on the command line, not as a the 123argument to 124.Fl F . 125.Pp 126Use 127.Ar mtree-specfile 128as an 129.Xr mtree 8 130.Sq specfile 131specification. 132This option has no effect when the image is created from a mtree manifest 133rather than a directory. 134.Pp 135If a specfile entry exists in the underlying file system, its 136permissions and modification time will be used unless specifically 137overridden by the specfile. 138An error will be raised if the type of entry in the specfile 139conflicts with that of an existing entry. 140.Pp 141In the opposite case (where a specfile entry does not have an entry 142in the underlying file system) the following occurs: 143If the specfile entry is marked 144.Sy optional , 145the specfile entry is ignored. 146Otherwise, the entry will be created in the image, and it is 147necessary to specify at least the following parameters in the 148specfile: 149.Sy type , 150.Sy mode , 151.Sy gname , 152or 153.Sy gid , 154and 155.Sy uname 156or 157.Sy uid , 158and 159.Sy link 160(in the case of symbolic links). 161If 162.Sy time 163is not provided, the current time will be used. 164If 165.Sy flags 166is not provided, the current file flags will be used. 167Missing regular file entries will be created as zero-length files. 168.It Fl f Ar free-files 169Ensure that a minimum of 170.Ar free-files 171free files (inodes) exist in the image. 172An optional 173.Ql % 174suffix may be provided to indicate that 175.Ar free-files 176indicates a percentage of the calculated image size. 177.It Fl M Ar minimum-size 178Set the minimum size of the file system image to 179.Ar minimum-size . 180.It Fl m Ar maximum-size 181Set the maximum size of the file system image to 182.Ar maximum-size . 183An error will be raised if the target file system needs to be larger 184than this to accommodate the provided directory tree. 185.It Fl N Ar userdb-dir 186Use the user database text file 187.Pa master.passwd 188and group database text file 189.Pa group 190from 191.Ar userdb-dir , 192rather than using the results from the system's 193.Xr getpwnam 3 194and 195.Xr getgrnam 3 196(and related) library calls. 197.It Fl O Ar offset 198Instead of creating the filesystem at the beginning of the file, start 199at offset. 200Valid only for 201.Sy ffs 202and 203.Sy msdos . 204.It Fl o Ar fs-options 205Set file system specific options. 206.Ar fs-options 207is a comma separated list of options. 208Valid file system specific options are detailed below. 209.It Fl p 210Deprecated. 211See the 212.Fl Z 213flag. 214.It Fl R Ar roundup-size 215Round the image up to 216.Ar roundup-size . 217.Ar roundup-size 218should be a multiple of the file system block size. 219This option only applies to the 220.Sy ffs 221file system type. 222.It Fl S Ar sector-size 223Set the file system sector size to 224.Ar sector-size . 225.\" XXX: next line also true for cd9660? 226Defaults to 512. 227.It Fl s Ar image-size 228Set the size of the file system image to 229.Ar image-size . 230This is equivalent to setting both the minimum 231.Fl ( M ) 232and the maximum 233.Fl ( m ) 234sizes to the same value. 235For 236.Sy ffs 237and 238.Sy msdos 239the 240.Ar image-size 241does not include the 242.Ar offset . 243.Ar offset 244is not included in that size. 245.It Fl T Ar timestamp 246Specify a timestamp to be set for all filesystem files and directories 247created so that repeatable builds are possible. 248The 249.Ar timestamp 250can be a 251.Pa pathname , 252where the timestamps are derived from that file, or an integer 253value interpreted as the number of seconds from the Epoch. 254Note that timestamps specified in an 255.Xr mtree 5 256spec file, override the default timestamp. 257.It Fl t Ar fs-type 258Create an 259.Ar fs-type 260file system image. 261The following file system types are supported: 262.Bl -tag -width cd9660 -offset indent 263.It Sy ffs 264BSD fast file system (default). 265.It Sy cd9660 266ISO 9660 file system. 267.It Sy msdos 268FAT12, FAT16, or FAT32 file system. 269.El 270.It Fl x 271Exclude file system nodes not explicitly listed in the specfile. 272.It Fl Z 273Create a sparse file for 274.Sy ffs . 275This is useful for virtual machine images. 276.El 277.Pp 278Where sizes are specified, a decimal number of bytes is expected. 279Two or more numbers may be separated by an 280.Dq x 281to indicate a product. 282Each number may have one of the following optional suffixes: 283.Bl -tag -width 3n -offset indent -compact 284.It b 285Block; multiply by 512 286.It k 287Kibi; multiply by 1024 (1 KiB) 288.It m 289Mebi; multiply by 1048576 (1 MiB) 290.It g 291Gibi; multiply by 1073741824 (1 GiB) 292.It t 293Tebi; multiply by 1099511627776 (1 TiB) 294.It w 295Word; multiply by the number of bytes in an integer 296.El 297.\" 298.\" 299.Ss FFS-specific options 300.Sy ffs 301images have ffs-specific optional parameters that may be provided. 302Each of the options consists of a keyword, an equal sign 303.Pq Ql = , 304and a value. 305The following keywords are supported: 306.Pp 307.Bl -tag -width optimization -offset indent -compact 308.It Sy avgfilesize 309Expected average file size. 310.It Sy avgfpdir 311Expected number of files per directory. 312.It Sy bsize 313Block size. 314.It Sy density 315Bytes per inode. If unset, will allocate the minimum number of inodes to 316represent the filesystem if no free space has been requested (free blocks 317or minimum size set); otherwise the larger of the newfs defaults or what 318is required by the free inode parameters if set. 319.It Sy fsize 320Fragment size. 321.It Sy label 322Label name of the image. 323.It Sy maxbpg 324Maximum blocks per file in a cylinder group. 325.It Sy minfree 326Minimum % free. 327.It Sy optimization 328Optimization preference; one of 329.Ql space 330or 331.Ql time . 332.It Sy extent 333Maximum extent size. 334.It Sy maxbpcg 335Maximum total number of blocks in a cylinder group. 336.It Sy version 337UFS version. 3381 for FFS (default), 2 for UFS2. 339.It Sy softupdates 3400 for disable (default), 1 for enable 341.El 342.Ss CD9660-specific options 343.Sy cd9660 344images have ISO9660-specific optional parameters that may be 345provided. 346The arguments consist of a keyword and, optionally, an equal sign 347.Pq Ql = , 348and a value. 349The following keywords are supported: 350.Pp 351.Bl -tag -width omit-trailing-period -offset indent -compact 352.It Sy allow-deep-trees 353Allow the directory structure to exceed the maximum specified in 354the spec. 355.It Sy allow-illegal-chars 356Allow illegal characters in filenames. 357This option is not implemented. 358.It Sy allow-lowercase 359Allow lowercase characters in filenames. 360This option is not implemented. 361.It Sy allow-max-name 362Allow 37 instead of 33 characters for filenames by omitting the 363version id. 364.It Sy allow-multidot 365Allow multiple dots in a filename. 366.It Sy applicationid 367Application ID of the image. 368.It Sy archimedes 369Use the 370.Ql ARCHIMEDES 371extension to encode 372.Tn RISC OS 373metadata. 374.It Sy bootimagedir 375Boot image directory. 376This option is not implemented. 377.It Sy chrp-boot 378Write an MBR partition table to the image to allow older CHRP hardware to 379boot. 380.It Sy boot-load-segment 381Set load segment for the boot image. 382.It Sy bootimage 383Filename of a boot image in the format 384.Dq sysid;filename , 385where 386.Dq sysid 387is one of 388.Ql efi , 389.Ql i386 , 390.Ql mac68k , 391.Ql macppc , 392or 393.Ql powerpc . 394.It Sy generic-bootimage 395Load a generic boot image into the first 32K of the cd9660 image. 396.It Sy hard-disk-boot 397Boot image is a hard disk image. 398.It Sy isolevel 399An integer representing the ISO 9660 interchange level where 400.Dq level 401is either 402.Ql 1 403or 404.Ql 2 . 405.Dq level 406.Ql 3 407is not implemented. 408.It Sy keep-bad-images 409Do not discard images whose write was aborted due to an error. 410For debugging purposes. 411.It Sy label 412Label name of the image. 413.It Sy no-boot 414Boot image is not bootable. 415.It Sy no-emul-boot 416Boot image is a 417.Dq no emulation 418ElTorito image. 419.It Sy no-trailing-padding 420Do not pad the image (apparently Linux needs the padding). 421.It Sy omit-trailing-period 422Omit trailing periods in filenames. 423.It Sy platformid 424Set platform ID of section header entry of the boot image. 425.It Sy preparer 426Preparer ID of the image. 427.It Sy publisher 428Publisher ID of the image. 429.It Sy rockridge 430Use RockRidge extensions (for longer filenames, etc.). 431.It Sy verbose 432Turns on verbose output. 433.It Sy volumeid 434Volume set identifier of the image. 435.El 436.Ss msdos-specific options 437.Sy msdos 438images have MS-DOS-specific optional parameters that may be 439provided. 440The arguments consist of a keyword, an equal sign 441.Pq Ql = , 442and a value. 443The following keywords are supported (see 444.Xr newfs_msdos 8 445for more details): 446.Pp 447.Bl -tag -width omit-trailing-period -offset indent -compact 448.It Cm backup_sector 449Location of the backup boot sector. 450.It Cm block_size 451Block size. 452.It Cm bootstrap 453Bootstrap file. 454.It Cm bytes_per_sector 455Bytes per sector. 456.It Cm create_size 457Create file size. 458.It Cm directory_entries 459Directory entries. 460.It Cm drive_heads 461Drive heads. 462.It Cm fat_type 463FAT type (12, 16, or 32). 464.It Cm floppy 465Preset drive parameters for standard format floppy disks 466(160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880). 467.It Cm hidden_sectors 468Hidden sectors. 469.It Cm info_sector 470Location of the info sector. 471.It Cm media_descriptor 472Media descriptor. 473.It Cm num_FAT 474Number of FATs. 475.It Cm OEM_string 476OEM string. 477.It Cm offset 478Offset in device. 479This option will be ignored if 480.Fl O 481is set to a positive number. 482.It Cm reserved_sectors 483Reserved sectors. 484.It Cm sectors_per_cluster 485Sectors per cluster. 486.It Cm sectors_per_fat 487Sectors per FAT. 488.It Cm sectors_per_track 489Sectors per track. 490.It Cm size 491File System size. 492.It Cm volume_id 493Volume ID. 494.It Cm volume_label 495Volume Label. 496.El 497.Sh SEE ALSO 498.Xr mtree 5 , 499.Xr mtree 8 , 500.Xr newfs 8 501.Sh HISTORY 502The 503.Nm 504utility appeared in 505.Nx 1.6 . 506It was ported to 507.Fx 508and first appeared in 509.Fx 8.0 . 510.Sh AUTHORS 511.An Luke Mewburn 512.Aq Mt lukem@NetBSD.org 513(original program), 514.An Daniel Watt , 515.An Walter Deignan , 516.An Ryan Gabrys , 517.An Alan Perez-Rathke , 518.An Ram Vedam 519(cd9660 support), 520.An Christos Zoulas 521(msdos support). 522