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: head/usr.sbin/makefs/makefs.8 331843 2018-03-31 15:04:41Z benno $ 37.\" 38.Dd May 28, 2022 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 commandline, 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 163isn't provided, the current time will be used. 164If 165.Sy flags 166isn't 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 . 230.It Fl T Ar timestamp 231Specify a timestamp to be set for all filesystem files and directories 232created so that repeatable builds are possible. 233The 234.Ar timestamp 235can be a 236.Pa pathname , 237where the timestamps are derived from that file, or an integer 238value interpreted as the number of seconds from the Epoch. 239Note that timestamps specified in an 240.Xr mtree 5 241spec file, override the default timestamp. 242.It Fl t Ar fs-type 243Create an 244.Ar fs-type 245file system image. 246The following file system types are supported: 247.Bl -tag -width cd9660 -offset indent 248.It Sy ffs 249BSD fast file system (default). 250.It Sy cd9660 251ISO 9660 file system. 252.It Sy msdos 253FAT12, FAT16, or FAT32 file system. 254.It Sy hammer2 255HAMMER2 file system. 256.El 257.It Fl x 258Exclude file system nodes not explicitly listed in the specfile. 259.It Fl Z 260Create a sparse file for 261.Sy ffs 262and 263.Sy hammer2 . 264This is useful for virtual machine images. 265.El 266.Pp 267Where sizes are specified, a decimal number of bytes is expected. 268Two or more numbers may be separated by an 269.Dq x 270to indicate a product. 271Each number may have one of the following optional suffixes: 272.Bl -tag -width 3n -offset indent -compact 273.It b 274Block; multiply by 512 275.It k 276Kibi; multiply by 1024 (1 KiB) 277.It m 278Mebi; multiply by 1048576 (1 MiB) 279.It g 280Gibi; multiply by 1073741824 (1 GiB) 281.It t 282Tebi; multiply by 1099511627776 (1 TiB) 283.It w 284Word; multiply by the number of bytes in an integer 285.El 286.\" 287.\" 288.Ss FFS-specific options 289.Sy ffs 290images have ffs-specific optional parameters that may be provided. 291Each of the options consists of a keyword, an equal sign 292.Pq Ql = , 293and a value. 294The following keywords are supported: 295.Pp 296.Bl -tag -width optimization -offset indent -compact 297.It Sy avgfilesize 298Expected average file size. 299.It Sy avgfpdir 300Expected number of files per directory. 301.It Sy bsize 302Block size. 303.It Sy density 304Bytes per inode. 305.It Sy fsize 306Fragment size. 307.It Sy label 308Label name of the image. 309.It Sy maxbpg 310Maximum blocks per file in a cylinder group. 311.It Sy minfree 312Minimum % free. 313.It Sy optimization 314Optimization preference; one of 315.Ql space 316or 317.Ql time . 318.\".It Sy extent 319.\"Maximum extent size. 320.It Sy maxbpcg 321Maximum total number of blocks in a cylinder group. 322.It Sy version 323UFS version. 3241 for FFS (default and the only supported value). 325.\", 2 for UFS2. 326.It Sy softupdates 3270 for disable (default), 1 for enable 328.El 329.Ss CD9660-specific options 330.Sy cd9660 331images have ISO9660-specific optional parameters that may be 332provided. 333The arguments consist of a keyword and, optionally, an equal sign 334.Pq Ql = , 335and a value. 336The following keywords are supported: 337.Pp 338.Bl -tag -width omit-trailing-period -offset indent -compact 339.It Sy allow-deep-trees 340Allow the directory structure to exceed the maximum specified in 341the spec. 342.It Sy allow-illegal-chars 343Allow illegal characters in filenames. This option is not implemented. 344.It Sy allow-lowercase 345Allow lowercase characters in filenames. This option is not implemented. 346.It Sy allow-max-name 347Allow 37 instead of 33 characters for filenames by omitting the 348version id. 349.It Sy allow-multidot 350Allow multiple dots in a filename. 351.It Sy applicationid 352Application ID of the image. 353.It Sy archimedes 354Use the 355.Ql ARCHIMEDES 356extension to encode 357.Tn RISC OS 358metadata. 359.It Sy bootimagedir 360Boot image directory. This option is not implemented. 361.It Sy chrp-boot 362Write an MBR partition table to the image to allow older CHRP hardware to 363boot. 364.It Sy boot-load-segment 365Set load segment for the boot image. 366.It Sy bootimage 367Filename of a boot image in the format 368.Dq sysid;filename , 369where 370.Dq sysid 371is one of 372.Ql i386 , 373.Ql mac68k , 374.Ql macppc , 375or 376.Ql powerpc . 377.It Sy generic-bootimage 378Load a generic boot image into the first 32K of the cd9660 image. 379.It Sy hard-disk-boot 380Boot image is a hard disk image. 381.It Sy isolevel 382An integer representing the ISO 9660 interchange level where 383.Dq level 384is either 385.Ql 1 386or 387.Ql 2 . 388.Dq level 389.Ql 3 390is not implemented. 391.It Sy keep-bad-images 392Do not discard images whose write was aborted due to an error. 393For debugging purposes. 394.It Sy label 395Label name of the image. 396.It Sy no-boot 397Boot image is not bootable. 398.It Sy no-emul-boot 399Boot image is a 400.Dq no emulation 401ElTorito image. 402.It Sy no-trailing-padding 403Do not pad the image (apparently Linux needs the padding). 404.It Sy omit-trailing-period 405Omit trailing periods in filenames. 406.It Sy platformid 407Set platform ID of section header entry of the boot image. 408.It Sy preparer 409Preparer ID of the image. 410.It Sy publisher 411Publisher ID of the image. 412.It Sy rockridge 413Use RockRidge extensions (for longer filenames, etc.). 414.It Sy verbose 415Turns on verbose output. 416.It Sy volumeid 417Volume set identifier of the image. 418.El 419.Ss msdos-specific options 420.Sy msdos 421images have MS-DOS-specific optional parameters that may be 422provided. 423The arguments consist of a keyword, an equal sign 424.Pq Ql = , 425and a value. 426The following keywords are supported (see 427.Xr newfs_msdos 8 428for more details): 429.Pp 430.Bl -tag -width omit-trailing-period -offset indent -compact 431.It Cm backup_sector 432Location of the backup boot sector. 433.It Cm block_size 434Block size. 435.It Cm bootstrap 436Bootstrap file. 437.It Cm bytes_per_sector 438Bytes per sector. 439.It Cm create_size 440Create file size. 441.It Cm directory_entries 442Directory entries. 443.It Cm drive_heads 444Drive heads. 445.It Cm fat_type 446FAT type (12, 16, or 32). 447.It Cm floppy 448Preset drive parameters for standard format floppy disks 449(160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880). 450.It Cm hidden_sectors 451Hidden sectors. 452.It Cm info_sector 453Location of the info sector. 454.It Cm media_descriptor 455Media descriptor. 456.It Cm num_FAT 457Number of FATs. 458.It Cm OEM_string 459OEM string. 460.It Cm offset 461Offset in device. 462This option will be ignored if 463.Fl O 464is set to a positive number. 465.It Cm reserved_sectors 466Reserved sectors. 467.It Cm sectors_per_cluster 468Sectors per cluster. 469.It Cm sectors_per_fat 470Sectors per FAT. 471.It Cm sectors_per_track 472Sectors per track. 473.It Cm size 474File System size. 475.It Cm volume_id 476Volume ID. 477.It Cm volume_label 478Volume Label. 479.El 480.Ss hammer2-specific options 481.Sy hammer2 482images have HAMMER2-specific optional parameters that may be 483provided. 484The arguments consist of a keyword and, optionally, an equal sign 485.Pq Ql = , 486and a value. 487The following keywords are supported: 488.Pp 489.Bl -tag -width omit-trailing-period -offset indent -compact 490.It Cm b 491Boot area size. 492See 493.Xr newfs_hammer2 8 494for details. 495.It Cm r 496Aux area size. 497See 498.Xr newfs_hammer2 8 499for details. 500.It Cm V 501File system version. 502See 503.Xr newfs_hammer2 8 504for details. 505.It Cm L 506PFS Label. 507See 508.Xr newfs_hammer2 8 509for details. 510Unlike 511.Xr newfs_hammer2 8 , 512always defaults to "DATA". 513.It Cm v 514Number of volume headers (1, 2, 3, or 4). 515Defaults to 4, and the image size will be at least 4 * 2 = 8 GiB. 516.It Cm m 517The PFS label to which to create file system contents. 518Defaults to "DATA". 519.It Cm d 520sysctl vfs.hammer2.debug compatible tunable for debug prints. 521Specify 0xffffffff to enable all debug prints. 522Defaults to 0. 523.El 524.Sh SEE ALSO 525.Xr mtree 5 , 526.Xr mtree 8 , 527.Xr newfs 8 528.Sh HISTORY 529The 530.Nm 531utility appeared in 532.Nx 1.6 . 533.Sh AUTHORS 534.An Luke Mewburn 535.Aq Mt lukem@NetBSD.org 536(original program), 537.An Daniel Watt , 538.An Walter Deignan , 539.An Ryan Gabrys , 540.An Alan Perez-Rathke , 541.An Ram Vedam 542(cd9660 support), 543.An Christos Zoulas 544(msdos support), 545.An Tomohiro Kusumi 546(hammer2 support). 547