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. 217Create a sparse file for 218.Sy ffs . 219This is the same as the preferred 220.Fl Z 221flag. 222.It Fl R Ar roundup-size 223Round the image up to 224.Ar roundup-size . 225.Ar roundup-size 226should be a multiple of the file system block size. 227This option only applies to the 228.Sy ffs 229file system type. 230.It Fl S Ar sector-size 231Set the file system sector size to 232.Ar sector-size . 233.\" XXX: next line also true for cd9660? 234Defaults to 512. 235.It Fl s Ar image-size 236Set the size of the file system image to 237.Ar image-size . 238This is equivalent to setting both the minimum 239.Fl ( M ) 240and the maximum 241.Fl ( m ) 242sizes to the same value. 243For 244.Sy ffs 245and 246.Sy msdos 247the 248.Ar image-size 249does not include the 250.Ar offset . 251.Ar offset 252is not included in that size. 253.It Fl T Ar timestamp 254Specify a timestamp to be set for all filesystem files and directories 255created so that repeatable builds are possible. 256The 257.Ar timestamp 258can be a 259.Pa pathname , 260where the timestamps are derived from that file, or an integer 261value interpreted as the number of seconds from the Epoch. 262Timestamps in a 263.Xr mtree 5 264specfile (specified with 265.Fl F ) 266are used even if a default timestamp is specified. 267However, the timestamps in an mtree manifest are ignored 268if a default timestamp is specified. 269.It Fl t Ar fs-type 270Create an 271.Ar fs-type 272file system image. 273The following file system types are supported: 274.Bl -tag -width cd9660 -offset indent 275.It Sy ffs 276BSD fast file system (default). 277.It Sy cd9660 278ISO 9660 file system. 279.It Sy msdos 280FAT12, FAT16, or FAT32 file system. 281.It Sy zfs 282ZFS pool containing one or more file systems. 283.El 284.It Fl x 285Exclude file system nodes not explicitly listed in the specfile. 286.It Fl Z 287Create a sparse file for 288.Sy ffs . 289This is useful for virtual machine images. 290.El 291.Pp 292Where sizes are specified, a decimal number of bytes is expected. 293Two or more numbers may be separated by an 294.Dq x 295to indicate a product. 296Each number may have one of the following optional suffixes: 297.Bl -tag -width 3n -offset indent -compact 298.It b 299Block; multiply by 512 300.It k 301Kibi; multiply by 1024 (1 KiB) 302.It m 303Mebi; multiply by 1048576 (1 MiB) 304.It g 305Gibi; multiply by 1073741824 (1 GiB) 306.It t 307Tebi; multiply by 1099511627776 (1 TiB) 308.It w 309Word; multiply by the number of bytes in an integer 310.El 311.\" 312.\" 313.Ss FFS-specific options 314.Sy ffs 315images have ffs-specific optional parameters that may be provided. 316Each of the options consists of a keyword, an equal sign 317.Pq Ql = , 318and a value. 319The following keywords are supported: 320.Pp 321.Bl -tag -width optimization -offset indent -compact 322.It Sy avgfilesize 323Expected average file size. 324.It Sy avgfpdir 325Expected number of files per directory. 326.It Sy bsize 327Block size. 328.It Sy density 329Bytes per inode. If unset, will allocate the minimum number of inodes to 330represent the filesystem if no free space has been requested (free blocks 331or minimum size set); otherwise the larger of the newfs defaults or what 332is required by the free inode parameters if set. 333.It Sy fsize 334Fragment size. 335.It Sy label 336Label name of the image. 337.It Sy maxbpg 338Maximum blocks per file in a cylinder group. 339.It Sy minfree 340Minimum % free. 341.It Sy optimization 342Optimization preference; one of 343.Ql space 344or 345.Ql time . 346.It Sy extent 347Maximum extent size. 348.It Sy maxbpcg 349Maximum total number of blocks in a cylinder group. 350.It Sy version 351UFS version. 3521 for FFS (default), 2 for UFS2. 353.It Sy softupdates 3540 for disable (default), 1 for enable 355.El 356.Ss CD9660-specific options 357.Sy cd9660 358images have ISO9660-specific optional parameters that may be 359provided. 360The arguments consist of a keyword and, optionally, an equal sign 361.Pq Ql = , 362and a value. 363The following keywords are supported: 364.Pp 365.Bl -tag -width omit-trailing-period -offset indent -compact 366.It Sy allow-deep-trees 367Allow the directory structure to exceed the maximum specified in 368the spec. 369.It Sy allow-illegal-chars 370Allow illegal characters in filenames. 371This option is not implemented. 372.It Sy allow-lowercase 373Allow lowercase characters in filenames. 374This option is not implemented. 375.It Sy allow-max-name 376Allow 37 instead of 33 characters for filenames by omitting the 377version id. 378.It Sy allow-multidot 379Allow multiple dots in a filename. 380.It Sy applicationid 381Application ID of the image. 382.It Sy bootimagedir 383Boot image directory. 384This option is not implemented. 385.It Sy chrp-boot 386Write an MBR partition table to the image to allow older CHRP hardware to 387boot. 388.It Sy boot-load-segment 389Set load segment for the boot image. 390.It Sy bootimage 391Filename of a boot image in the format 392.Dq sysid;filename , 393where 394.Dq sysid 395is one of 396.Ql efi , 397.Ql i386 , 398.Ql mac68k , 399.Ql macppc , 400or 401.Ql powerpc . 402.It Sy generic-bootimage 403Load a generic boot image into the first 32K of the cd9660 image. 404.It Sy hard-disk-boot 405Boot image is a hard disk image. 406.It Sy isolevel 407An integer representing the ISO 9660 interchange level where 408.Dq level 409is either 410.Ql 1 411or 412.Ql 2 . 413.Dq level 414.Ql 3 415is not implemented. 416.It Sy keep-bad-images 417Do not discard images whose write was aborted due to an error. 418For debugging purposes. 419.It Sy label 420Label name of the image. 421.It Sy no-boot 422Boot image is not bootable. 423.It Sy no-emul-boot 424Boot image is a 425.Dq no emulation 426ElTorito image. 427.It Sy no-trailing-padding 428Do not pad the image (apparently Linux needs the padding). 429.It Sy omit-trailing-period 430Omit trailing periods in filenames. 431.It Sy platformid 432Set platform ID of section header entry of the boot image. 433.It Sy preparer 434Preparer ID of the image. 435.It Sy publisher 436Publisher ID of the image. 437.It Sy rockridge 438Use RockRidge extensions (for longer filenames, etc.). 439.It Sy verbose 440Turns on verbose output. 441.It Sy volumeid 442Volume set identifier of the image. 443.El 444.Ss msdos-specific options 445.Sy msdos 446images have MS-DOS-specific optional parameters that may be 447provided. 448The arguments consist of a keyword, an equal sign 449.Pq Ql = , 450and a value. 451The following keywords are supported (see 452.Xr newfs_msdos 8 453for more details): 454.Pp 455.Bl -tag -width omit-trailing-period -offset indent -compact 456.It Cm backup_sector 457Location of the backup boot sector. 458.It Cm block_size 459Block size. 460.It Cm bootstrap 461Bootstrap file. 462.It Cm bytes_per_sector 463Bytes per sector. 464.It Cm create_size 465Create file size. 466.It Cm directory_entries 467Directory entries. 468.It Cm drive_heads 469Drive heads. 470.It Cm fat_type 471FAT type (12, 16, or 32). 472.It Cm floppy 473Preset drive parameters for standard format floppy disks 474(160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880). 475.It Cm hidden_sectors 476Hidden sectors. 477.It Cm info_sector 478Location of the info sector. 479.It Cm media_descriptor 480Media descriptor. 481.It Cm num_FAT 482Number of FATs. 483.It Cm OEM_string 484OEM string. 485.It Cm offset 486Offset in device. 487This option will be ignored if 488.Fl O 489is set to a positive number. 490.It Cm reserved_sectors 491Reserved sectors. 492.It Cm sectors_per_cluster 493Sectors per cluster. 494.It Cm sectors_per_fat 495Sectors per FAT. 496.It Cm sectors_per_track 497Sectors per track. 498.It Cm size 499File System size. 500.It Cm volume_id 501Volume ID. 502.It Cm volume_label 503Volume Label. 504.El 505.Ss zfs-specific options 506The image created by 507.Nm 508contains a ZFS pool with a single vdev of type 509.Ql disk . 510The root dataset is always created implicitly and contains the entire input 511directory tree unless additional datasets are specified using the options 512described below. 513.Pp 514To keep images reproducible, the pool GUID and other random identifiers will 515always be the same across runs of 516.Nm . 517This means that when a pool is first imported, its GUID should be reset 518using 519.Xr zpool-reguid 8 520to avoid conflicting with other pools also generated by 521.Nm ; 522otherwise, it will not be possible to import other pools. 523This can be configured from 524.Pa /etc/rc.conf 525using the 526.Va zpool_reguid 527variable. 528.Pp 529The arguments consist of a keyword, an equal sign 530.Pq Ql = , 531and a value. 532The following keywords are supported: 533.Pp 534.Bl -tag -width omit-trailing-period -offset indent -compact 535.It ashift 536The base-2 logarithm of the minimum block size. 537Typical values are 9 (512B blocks) and 12 (4KB blocks). 538The default value is 12. 539.It bootfs 540The name of the bootable dataset for the pool. 541Specifying this option causes the 542.Ql bootfs 543property to be set in the created pool. 544.It mssize 545The size of metaslabs in the created pool. 546By default, 547.Nm 548allocates large (up to 512MB) metaslabs with the expectation that 549the image will be auto-expanded upon first use. 550This option allows the default heuristic to be overridden. 551.It verify-txgs 552Prompt OpenZFS to verify pool metadata during import. 553This is disabled by default as it may significantly increase import times. 554.It poolname 555The name of the ZFS pool. 556This option must be specified. 557.It rootpath 558An implicit path prefix added to dataset mountpoints. 559By default it is 560.Pa /<poolname> . 561For creating bootable pools, the 562.Va rootpath 563should be set to 564.Pa / . 565At least one dataset must have a mountpoint equal to 566.Va rootpath . 567.It fs 568Create an additional dataset. 569This option may be specified multiple times. 570The argument value must be of the form 571.Ar <dataset>[;<prop1=v1>[;<prop2=v2>[;...]]] , 572where 573.Ar dataset 574is the name of the dataset and must belong to the pool's namespace. 575For example, with a pool name of 576.Ql test 577all dataset names must be prefixed by 578.Ql test/ . 579A dataset must exist at each level of the pool's namespace. 580For example, to create 581.Ql test/foo/bar , 582.Ql test/foo 583must be created as well. 584.Pp 585The dataset mountpoints determine how the datasets are populated with 586files from the staged directory tree. 587Conceptually, all datasets are mounted before any are populated with files. 588The root of the staged directory tree is mapped to 589.Va rootpath . 590.Pp 591Dataset properties, as described in 592.Xr zfsprops 7 , 593may be specified following the dataset name. 594The following properties may be set for a dataset: 595.Pp 596.Bl -tag -compact -offset indent 597.It atime 598.It canmount 599.It exec 600.It mountpoint 601.It setuid 602.El 603.El 604.Sh SEE ALSO 605.Xr mtree 5 , 606.Xr rc.conf 5 , 607.Xr zfsconcepts 7 , 608.Xr zfsprops 7 , 609.Xr zpoolprops 7 , 610.Xr mtree 8 , 611.Xr newfs 8 , 612.Xr zpool-reguid 8 613.Sh HISTORY 614The 615.Nm 616utility appeared in 617.Nx 1.6 . 618It was ported to 619.Fx 620and first appeared in 621.Fx 8.0 . 622.Sh AUTHORS 623.An Luke Mewburn 624.Aq Mt lukem@NetBSD.org 625(original program), 626.An Daniel Watt , 627.An Walter Deignan , 628.An Ryan Gabrys , 629.An Alan Perez-Rathke , 630.An Ram Vedam 631(cd9660 support), 632.An Christos Zoulas 633(msdos support), 634.An Mark Johnston 635(zfs support). 636