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. If unset, will allocate the minimum number of inodes to 305represent the filesystem if no free space has been requested (free blocks 306or minimum size set); otherwise the larger of the newfs defaults or what 307is required by the free inode parameters if set. 308.It Sy fsize 309Fragment size. 310.It Sy label 311Label name of the image. 312.It Sy maxbpg 313Maximum blocks per file in a cylinder group. 314.It Sy minfree 315Minimum % free. 316.It Sy optimization 317Optimization preference; one of 318.Ql space 319or 320.Ql time . 321.\".It Sy extent 322.\"Maximum extent size. 323.It Sy maxbpcg 324Maximum total number of blocks in a cylinder group. 325.It Sy version 326UFS version. 3271 for FFS (default and the only supported value). 328.\", 2 for UFS2. 329.It Sy softupdates 3300 for disable (default), 1 for enable 331.El 332.Ss CD9660-specific options 333.Sy cd9660 334images have ISO9660-specific optional parameters that may be 335provided. 336The arguments consist of a keyword and, optionally, an equal sign 337.Pq Ql = , 338and a value. 339The following keywords are supported: 340.Pp 341.Bl -tag -width omit-trailing-period -offset indent -compact 342.It Sy allow-deep-trees 343Allow the directory structure to exceed the maximum specified in 344the spec. 345.It Sy allow-illegal-chars 346Allow illegal characters in filenames. This option is not implemented. 347.It Sy allow-lowercase 348Allow lowercase characters in filenames. This option is not implemented. 349.It Sy allow-max-name 350Allow 37 instead of 33 characters for filenames by omitting the 351version id. 352.It Sy allow-multidot 353Allow multiple dots in a filename. 354.It Sy applicationid 355Application ID of the image. 356.It Sy archimedes 357Use the 358.Ql ARCHIMEDES 359extension to encode 360.Tn RISC OS 361metadata. 362.It Sy bootimagedir 363Boot image directory. This option is not implemented. 364.It Sy chrp-boot 365Write an MBR partition table to the image to allow older CHRP hardware to 366boot. 367.It Sy boot-load-segment 368Set load segment for the boot image. 369.It Sy bootimage 370Filename of a boot image in the format 371.Dq sysid;filename , 372where 373.Dq sysid 374is one of 375.Ql i386 , 376.Ql mac68k , 377.Ql macppc , 378or 379.Ql powerpc . 380.It Sy generic-bootimage 381Load a generic boot image into the first 32K of the cd9660 image. 382.It Sy hard-disk-boot 383Boot image is a hard disk image. 384.It Sy isolevel 385An integer representing the ISO 9660 interchange level where 386.Dq level 387is either 388.Ql 1 389or 390.Ql 2 . 391.Dq level 392.Ql 3 393is not implemented. 394.It Sy keep-bad-images 395Do not discard images whose write was aborted due to an error. 396For debugging purposes. 397.It Sy label 398Label name of the image. 399.It Sy no-boot 400Boot image is not bootable. 401.It Sy no-emul-boot 402Boot image is a 403.Dq no emulation 404ElTorito image. 405.It Sy no-trailing-padding 406Do not pad the image (apparently Linux needs the padding). 407.It Sy omit-trailing-period 408Omit trailing periods in filenames. 409.It Sy platformid 410Set platform ID of section header entry of the boot image. 411.It Sy preparer 412Preparer ID of the image. 413.It Sy publisher 414Publisher ID of the image. 415.It Sy rockridge 416Use RockRidge extensions (for longer filenames, etc.). 417.It Sy verbose 418Turns on verbose output. 419.It Sy volumeid 420Volume set identifier of the image. 421.El 422.Ss msdos-specific options 423.Sy msdos 424images have MS-DOS-specific optional parameters that may be 425provided. 426The arguments consist of a keyword, an equal sign 427.Pq Ql = , 428and a value. 429The following keywords are supported (see 430.Xr newfs_msdos 8 431for more details): 432.Pp 433.Bl -tag -width omit-trailing-period -offset indent -compact 434.It Cm backup_sector 435Location of the backup boot sector. 436.It Cm block_size 437Block size. 438.It Cm bootstrap 439Bootstrap file. 440.It Cm bytes_per_sector 441Bytes per sector. 442.It Cm create_size 443Create file size. 444.It Cm directory_entries 445Directory entries. 446.It Cm drive_heads 447Drive heads. 448.It Cm fat_type 449FAT type (12, 16, or 32). 450.It Cm floppy 451Preset drive parameters for standard format floppy disks 452(160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880). 453.It Cm hidden_sectors 454Hidden sectors. 455.It Cm info_sector 456Location of the info sector. 457.It Cm media_descriptor 458Media descriptor. 459.It Cm num_FAT 460Number of FATs. 461.It Cm OEM_string 462OEM string. 463.It Cm offset 464Offset in device. 465This option will be ignored if 466.Fl O 467is set to a positive number. 468.It Cm reserved_sectors 469Reserved sectors. 470.It Cm sectors_per_cluster 471Sectors per cluster. 472.It Cm sectors_per_fat 473Sectors per FAT. 474.It Cm sectors_per_track 475Sectors per track. 476.It Cm size 477File System size. 478.It Cm volume_id 479Volume ID. 480.It Cm volume_label 481Volume Label. 482.El 483.Ss hammer2-specific options 484.Sy hammer2 485images have HAMMER2-specific optional parameters that may be 486provided. 487The arguments consist of a keyword, an equal sign 488.Pq Ql = , 489and a value. 490The following keywords are supported: 491.Pp 492.Bl -tag -width omit-trailing-period -offset indent -compact 493.It Cm b 494Boot area size. 495See 496.Xr newfs_hammer2 8 497for details. 498.It Cm r 499Aux area size. 500See 501.Xr newfs_hammer2 8 502for details. 503.It Cm V 504File system version. 505See 506.Xr newfs_hammer2 8 507for details. 508.It Cm L 509PFS Label. 510See 511.Xr newfs_hammer2 8 512for details. 513Unlike 514.Xr newfs_hammer2 8 , 515always defaults to "DATA". 516.It Cm v 517Number of volume headers (1, 2, 3, or 4). 518Defaults to 4, and the image size will be at least 4 * 2 = 8 GiB. 519.It Cm m 520The PFS label to which to create file system contents. 521Defaults to "DATA". 522.It Cm d 523sysctl vfs.hammer2.debug compatible tunable for debug prints. 524Specify 0xffffffff to enable all debug prints. 525Defaults to 0. 526.El 527.Sh SEE ALSO 528.Xr mtree 5 , 529.Xr mtree 8 , 530.Xr newfs 8 531.Sh HISTORY 532The 533.Nm 534utility appeared in 535.Nx 1.6 . 536.Sh AUTHORS 537.An Luke Mewburn 538.Aq Mt lukem@NetBSD.org 539(original program), 540.An Daniel Watt , 541.An Walter Deignan , 542.An Ryan Gabrys , 543.An Alan Perez-Rathke , 544.An Ram Vedam 545(cd9660 support), 546.An Christos Zoulas 547(msdos support), 548.An Tomohiro Kusumi 549(hammer2 support). 550