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 August 5, 2022 37.Dt MAKEFS 8 38.Os 39.Sh NAME 40.Nm makefs 41.Nd create a file system image from a directory tree or a mtree manifest 42.Sh SYNOPSIS 43.Nm 44.Op Fl DxZ 45.Op Fl B Ar endian 46.Op Fl b Ar free-blocks 47.Op Fl d Ar debug-mask 48.Op Fl F Ar mtree-specfile 49.Op Fl f Ar free-files 50.Op Fl M Ar minimum-size 51.Op Fl m Ar maximum-size 52.Op Fl N Ar userdb-dir 53.Op Fl O Ar offset 54.Op Fl o Ar fs-options 55.Op Fl R Ar roundup-size 56.Op Fl S Ar sector-size 57.Op Fl s Ar image-size 58.Op Fl T Ar timestamp 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 118.Em This is almost certainly not the option you are looking for. 119To create an image from a list of files in an mtree format manifest, 120specify it as the last argument on the command line, not as a the 121argument to 122.Fl F . 123.Pp 124Use 125.Ar mtree-specfile 126as an 127.Xr mtree 8 128.Sq specfile 129specification. 130This option has no effect when the image is created from a mtree manifest 131rather than a directory. 132.Pp 133If a specfile entry exists in the underlying file system, its 134permissions and modification time will be used unless specifically 135overridden by the specfile. 136An error will be raised if the type of entry in the specfile 137conflicts with that of an existing entry. 138.Pp 139In the opposite case (where a specfile entry does not have an entry 140in the underlying file system) the following occurs: 141If the specfile entry is marked 142.Sy optional , 143the specfile entry is ignored. 144Otherwise, the entry will be created in the image, and it is 145necessary to specify at least the following parameters in the 146specfile: 147.Sy type , 148.Sy mode , 149.Sy gname , 150or 151.Sy gid , 152and 153.Sy uname 154or 155.Sy uid , 156and 157.Sy link 158(in the case of symbolic links). 159If 160.Sy time 161is not provided, the current time will be used. 162If 163.Sy flags 164is not provided, the current file flags will be used. 165Missing regular file entries will be created as zero-length files. 166.It Fl f Ar free-files 167Ensure that a minimum of 168.Ar free-files 169free files (inodes) exist in the image. 170An optional 171.Ql % 172suffix may be provided to indicate that 173.Ar free-files 174indicates a percentage of the calculated image size. 175.It Fl M Ar minimum-size 176Set the minimum size of the file system image to 177.Ar minimum-size . 178.It Fl m Ar maximum-size 179Set the maximum size of the file system image to 180.Ar maximum-size . 181An error will be raised if the target file system needs to be larger 182than this to accommodate the provided directory tree. 183.It Fl N Ar userdb-dir 184Use the user database text file 185.Pa master.passwd 186and group database text file 187.Pa group 188from 189.Ar userdb-dir , 190rather than using the results from the system's 191.Xr getpwnam 3 192and 193.Xr getgrnam 3 194(and related) library calls. 195.It Fl O Ar offset 196Instead of creating the filesystem at the beginning of the file, start 197at offset. 198Valid only for 199.Sy ffs 200and 201.Sy msdos . 202.It Fl o Ar fs-options 203Set file system specific options. 204.Ar fs-options 205is a comma separated list of options. 206Valid file system specific options are detailed below. 207.It Fl p 208Deprecated. 209See the 210.Fl Z 211flag. 212.It Fl R Ar roundup-size 213Round the image up to 214.Ar roundup-size . 215.Ar roundup-size 216should be a multiple of the file system block size. 217This option only applies to the 218.Sy ffs 219file system type. 220.It Fl S Ar sector-size 221Set the file system sector size to 222.Ar sector-size . 223.\" XXX: next line also true for cd9660? 224Defaults to 512. 225.It Fl s Ar image-size 226Set the size of the file system image to 227.Ar image-size . 228This is equivalent to setting both the minimum 229.Fl ( M ) 230and the maximum 231.Fl ( m ) 232sizes to the same value. 233For 234.Sy ffs 235and 236.Sy msdos 237the 238.Ar image-size 239does not include the 240.Ar offset . 241.Ar offset 242is not included in that size. 243.It Fl T Ar timestamp 244Specify a timestamp to be set for all filesystem files and directories 245created so that repeatable builds are possible. 246The 247.Ar timestamp 248can be a 249.Pa pathname , 250where the timestamps are derived from that file, or an integer 251value interpreted as the number of seconds from the Epoch. 252Note that timestamps specified in an 253.Xr mtree 5 254spec file, override the default timestamp. 255.It Fl t Ar fs-type 256Create an 257.Ar fs-type 258file system image. 259The following file system types are supported: 260.Bl -tag -width cd9660 -offset indent 261.It Sy ffs 262BSD fast file system (default). 263.It Sy cd9660 264ISO 9660 file system. 265.It Sy msdos 266FAT12, FAT16, or FAT32 file system. 267.It Sy zfs 268ZFS pool containing one or more file systems. 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.Ss zfs-specific options 498Note: ZFS support is currently considered experimental. 499Do not use it for anything critical. 500.Pp 501The image created by 502.Nm 503contains a ZFS pool with a single vdev of type 504.Ql disk . 505The root dataset is always created implicitly and contains the entire input 506directory tree unless additional datasets are specified using the options 507described below. 508.Pp 509The arguments consist of a keyword, an equal sign 510.Pq Ql = , 511and a value. 512The following keywords are supported: 513.Pp 514.Bl -tag -width omit-trailing-period -offset indent -compact 515.It ashift 516The base-2 logarithm of the minimum block size. 517Typical values are 9 (512B blocks) and 12 (4KB blocks). 518The default value is 12. 519.It bootfs 520The name of the bootable dataset for the pool. 521Specifying this option causes the 522.Ql bootfs 523property to be set in the created pool. 524.It mssize 525The size of metaslabs in the created pool. 526By default, 527.Nm 528allocates large (up to 512MB) metaslabs with the expectation that 529the image will be auto-expanded upon first use. 530This option allows the default heuristic to be overridden. 531.It poolname 532The name of the ZFS pool. 533This option must be specified. 534.It rootpath 535An implicit path prefix added to dataset mountpoints. 536By default it is 537.Pa /<poolname> . 538For creating bootable pools, the 539.Va rootpath 540should be set to 541.Pa / . 542At least one dataset must have a mountpoint equal to 543.Va rootpath . 544.It fs 545Create an additional dataset. 546This option may be specified multiple times. 547The argument value must be of the form 548.Ar <dataset>[;<prop1=v1>[;<prop2=v2>[;...]]] , 549where 550.Ar dataset 551is the name of the dataset and must belong to the pool's namespace. 552For example, with a pool name of 553.Ql test 554all dataset names must be prefixed by 555.Ql test/ . 556A dataset must exist at each level of the pool's namespace. 557For example, to create 558.Ql test/foo/bar , 559.Ql test/foo 560must be created as well. 561.Pp 562The dataset mountpoints determine how the datasets are populated with 563files from the staged directory tree. 564Conceptually, all datasets are mounted before any are populated with files. 565The root of the staged directory tree is mapped to 566.Va rootpath . 567.Pp 568Dataset properties, as described in 569.Xr zfsprops 8 , 570may be specified following the dataset name. 571The following properties may be set for a dataset: 572.Pp 573.Bl -tag -compact -offset indent 574.It atime 575.It canmount 576.It exec 577.It mountpoint 578.It setuid 579.El 580.El 581.Sh SEE ALSO 582.Xr mtree 5 , 583.Xr mtree 8 , 584.Xr newfs 8 , 585.Xr zfsconcepts 8 , 586.Xr zfsprops 8 , 587.Xr zpoolprops 8 588.Sh HISTORY 589The 590.Nm 591utility appeared in 592.Nx 1.6 . 593It was ported to 594.Fx 595and first appeared in 596.Fx 8.0 . 597.Sh AUTHORS 598.An Luke Mewburn 599.Aq Mt lukem@NetBSD.org 600(original program), 601.An Daniel Watt , 602.An Walter Deignan , 603.An Ryan Gabrys , 604.An Alan Perez-Rathke , 605.An Ram Vedam 606(cd9660 support), 607.An Christos Zoulas 608(msdos support), 609.An Mark Johnston 610(zfs support). 611