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