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