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