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 . 117This option is intended for source debugging. 118.Ar debug-mask 119is a bit map defined in the header file 120.Ar makefs.h . 121See the source for usage, and look for defines starting with 122.Ar DEBUG_ . 123.It Fl F Ar mtree-specfile 124.Em This is almost certainly not the option you are looking for. 125To create an image from a list of files in an mtree format manifest, 126specify it as the last argument on the command line, not as a the 127argument to 128.Fl F . 129.Pp 130Use 131.Ar mtree-specfile 132as an 133.Xr mtree 8 134.Sq specfile 135specification. 136This option has no effect when the image is created from a mtree manifest 137rather than a directory. 138.Pp 139If a specfile entry exists in the underlying file system, its 140permissions and modification time will be used unless specifically 141overridden by the specfile. 142An error will be raised if the type of entry in the specfile 143conflicts with that of an existing entry. 144.Pp 145In the opposite case (where a specfile entry does not have an entry 146in the underlying file system) the following occurs: 147If the specfile entry is marked 148.Sy optional , 149the specfile entry is ignored. 150Otherwise, the entry will be created in the image, and it is 151necessary to specify at least the following parameters in the 152specfile: 153.Sy type , 154.Sy mode , 155.Sy gname , 156or 157.Sy gid , 158and 159.Sy uname 160or 161.Sy uid , 162and 163.Sy link 164(in the case of symbolic links). 165If 166.Sy time 167is not provided, the current time will be used. 168If 169.Sy flags 170is not provided, the current file flags will be used. 171Missing regular file entries will be created as zero-length files. 172.It Fl f Ar free-files 173Ensure that a minimum of 174.Ar free-files 175free files (inodes) exist in the image. 176An optional 177.Ql % 178suffix may be provided to indicate that 179.Ar free-files 180indicates a percentage of the calculated image size. 181.It Fl M Ar minimum-size 182Set the minimum size of the file system image to 183.Ar minimum-size . 184.It Fl m Ar maximum-size 185Set the maximum size of the file system image to 186.Ar maximum-size . 187An error will be raised if the target file system needs to be larger 188than this to accommodate the provided directory tree. 189.It Fl N Ar userdb-dir 190Use the user database text file 191.Pa master.passwd 192and group database text file 193.Pa group 194from 195.Ar userdb-dir , 196rather than using the results from the system's 197.Xr getpwnam 3 198and 199.Xr getgrnam 3 200(and related) library calls. 201.It Fl O Ar offset 202Instead of creating the filesystem at the beginning of the file, start 203at offset. 204Valid only for 205.Sy ffs 206and 207.Sy msdos . 208.It Fl o Ar fs-options 209Set file system specific options. 210.Ar fs-options 211is a comma separated list of options. 212Valid file system specific options are detailed below. 213.It Fl p 214Deprecated. 215See the 216.Fl Z 217flag. 218.It Fl R Ar roundup-size 219Round the image up to 220.Ar roundup-size . 221.Ar roundup-size 222should be a multiple of the file system block size. 223This option only applies to the 224.Sy ffs 225file system type. 226.It Fl S Ar sector-size 227Set the file system sector size to 228.Ar sector-size . 229.\" XXX: next line also true for cd9660? 230Defaults to 512. 231.It Fl s Ar image-size 232Set the size of the file system image to 233.Ar image-size . 234This is equivalent to setting both the minimum 235.Fl ( M ) 236and the maximum 237.Fl ( m ) 238sizes to the same value. 239For 240.Sy ffs 241and 242.Sy msdos 243the 244.Ar image-size 245does not include the 246.Ar offset . 247.Ar offset 248is not included in that size. 249.It Fl T Ar timestamp 250Specify a timestamp to be set for all filesystem files and directories 251created so that repeatable builds are possible. 252The 253.Ar timestamp 254can be a 255.Pa pathname , 256where the timestamps are derived from that file, or an integer 257value interpreted as the number of seconds from the Epoch. 258Note that timestamps specified in an 259.Xr mtree 5 260spec file, override the default timestamp. 261.It Fl t Ar fs-type 262Create an 263.Ar fs-type 264file system image. 265The following file system types are supported: 266.Bl -tag -width cd9660 -offset indent 267.It Sy ffs 268BSD fast file system (default). 269.It Sy cd9660 270ISO 9660 file system. 271.It Sy msdos 272FAT12, FAT16, or FAT32 file system. 273.It Sy zfs 274ZFS pool containing one or more file systems. 275.El 276.It Fl x 277Exclude file system nodes not explicitly listed in the specfile. 278.It Fl Z 279Create a sparse file for 280.Sy ffs . 281This is useful for virtual machine images. 282.El 283.Pp 284Where sizes are specified, a decimal number of bytes is expected. 285Two or more numbers may be separated by an 286.Dq x 287to indicate a product. 288Each number may have one of the following optional suffixes: 289.Bl -tag -width 3n -offset indent -compact 290.It b 291Block; multiply by 512 292.It k 293Kibi; multiply by 1024 (1 KiB) 294.It m 295Mebi; multiply by 1048576 (1 MiB) 296.It g 297Gibi; multiply by 1073741824 (1 GiB) 298.It t 299Tebi; multiply by 1099511627776 (1 TiB) 300.It w 301Word; multiply by the number of bytes in an integer 302.El 303.\" 304.\" 305.Ss FFS-specific options 306.Sy ffs 307images have ffs-specific optional parameters that may be provided. 308Each of the options consists of a keyword, an equal sign 309.Pq Ql = , 310and a value. 311The following keywords are supported: 312.Pp 313.Bl -tag -width optimization -offset indent -compact 314.It Sy avgfilesize 315Expected average file size. 316.It Sy avgfpdir 317Expected number of files per directory. 318.It Sy bsize 319Block size. 320.It Sy density 321Bytes per inode. If unset, will allocate the minimum number of inodes to 322represent the filesystem if no free space has been requested (free blocks 323or minimum size set); otherwise the larger of the newfs defaults or what 324is required by the free inode parameters if set. 325.It Sy fsize 326Fragment size. 327.It Sy label 328Label name of the image. 329.It Sy maxbpg 330Maximum blocks per file in a cylinder group. 331.It Sy minfree 332Minimum % free. 333.It Sy optimization 334Optimization preference; one of 335.Ql space 336or 337.Ql time . 338.It Sy extent 339Maximum extent size. 340.It Sy maxbpcg 341Maximum total number of blocks in a cylinder group. 342.It Sy version 343UFS version. 3441 for FFS (default), 2 for UFS2. 345.It Sy softupdates 3460 for disable (default), 1 for enable 347.El 348.Ss CD9660-specific options 349.Sy cd9660 350images have ISO9660-specific optional parameters that may be 351provided. 352The arguments consist of a keyword and, optionally, an equal sign 353.Pq Ql = , 354and a value. 355The following keywords are supported: 356.Pp 357.Bl -tag -width omit-trailing-period -offset indent -compact 358.It Sy allow-deep-trees 359Allow the directory structure to exceed the maximum specified in 360the spec. 361.It Sy allow-illegal-chars 362Allow illegal characters in filenames. 363This option is not implemented. 364.It Sy allow-lowercase 365Allow lowercase characters in filenames. 366This option is not implemented. 367.It Sy allow-max-name 368Allow 37 instead of 33 characters for filenames by omitting the 369version id. 370.It Sy allow-multidot 371Allow multiple dots in a filename. 372.It Sy applicationid 373Application ID of the image. 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