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.\" $FreeBSD$ 37.\" 38.Dd August 5, 2022 39.Dt MAKEFS 8 40.Os 41.Sh NAME 42.Nm makefs 43.Nd create a file system image from a directory tree or a mtree manifest 44.Sh SYNOPSIS 45.Nm 46.Op Fl DxZ 47.Op Fl B Ar endian 48.Op Fl b Ar free-blocks 49.Op Fl d Ar debug-mask 50.Op Fl F Ar mtree-specfile 51.Op Fl f Ar free-files 52.Op Fl M Ar minimum-size 53.Op Fl m Ar maximum-size 54.Op Fl N Ar userdb-dir 55.Op Fl O Ar offset 56.Op Fl o Ar fs-options 57.Op Fl R Ar roundup-size 58.Op Fl S Ar sector-size 59.Op Fl s Ar image-size 60.Op Fl T Ar timestamp 61.Op Fl t Ar fs-type 62.Ar image-file 63.Ar directory | manifest 64.Op Ar extra-directory ... 65.Sh DESCRIPTION 66The utility 67.Nm 68creates a file system image into 69.Ar image-file 70from the directory tree 71.Ar directory 72or from the mtree manifest 73.Ar manifest . 74If any optional directory trees are passed in the 75.Ar extra-directory 76arguments, then the directory tree of each argument will be merged 77into the 78.Ar directory 79or 80.Ar manifest 81first before creating 82.Ar image-file . 83No special devices or privileges are required to perform this task. 84.Pp 85The options are as follows: 86.Bl -tag -width flag 87.It Fl B Ar endian 88Set the byte order of the image to 89.Ar endian . 90Valid byte orders are 91.Ql 4321 , 92.Ql big , 93or 94.Ql be 95for big endian, and 96.Ql 1234 , 97.Ql little , 98or 99.Ql le 100for little endian. 101Some file systems may have a fixed byte order; in those cases this 102argument will be ignored. 103.It Fl b Ar free-blocks 104Ensure that a minimum of 105.Ar free-blocks 106free blocks exist in the image. 107An optional 108.Ql % 109suffix may be provided to indicate that 110.Ar free-blocks 111indicates a percentage of the calculated image size. 112.It Fl D 113Treat duplicate paths in an mtree manifest as warnings not error. 114.It Fl d Ar debug-mask 115Enable various levels of debugging, depending upon which bits are 116set in 117.Ar debug-mask . 118XXX: document these 119.It Fl F Ar mtree-specfile 120.Em This is almost certainly not the option you are looking for. 121To create an image from a list of files in an mtree format manifest, 122specify it as the last argument on the command line, not as a the 123argument to 124.Fl F . 125.Pp 126Use 127.Ar mtree-specfile 128as an 129.Xr mtree 8 130.Sq specfile 131specification. 132This option has no effect when the image is created from a mtree manifest 133rather than a directory. 134.Pp 135If a specfile entry exists in the underlying file system, its 136permissions and modification time will be used unless specifically 137overridden by the specfile. 138An error will be raised if the type of entry in the specfile 139conflicts with that of an existing entry. 140.Pp 141In the opposite case (where a specfile entry does not have an entry 142in the underlying file system) the following occurs: 143If the specfile entry is marked 144.Sy optional , 145the specfile entry is ignored. 146Otherwise, the entry will be created in the image, and it is 147necessary to specify at least the following parameters in the 148specfile: 149.Sy type , 150.Sy mode , 151.Sy gname , 152or 153.Sy gid , 154and 155.Sy uname 156or 157.Sy uid , 158and 159.Sy link 160(in the case of symbolic links). 161If 162.Sy time 163is not provided, the current time will be used. 164If 165.Sy flags 166is not provided, the current file flags will be used. 167Missing regular file entries will be created as zero-length files. 168.It Fl f Ar free-files 169Ensure that a minimum of 170.Ar free-files 171free files (inodes) exist in the image. 172An optional 173.Ql % 174suffix may be provided to indicate that 175.Ar free-files 176indicates a percentage of the calculated image size. 177.It Fl M Ar minimum-size 178Set the minimum size of the file system image to 179.Ar minimum-size . 180.It Fl m Ar maximum-size 181Set the maximum size of the file system image to 182.Ar maximum-size . 183An error will be raised if the target file system needs to be larger 184than this to accommodate the provided directory tree. 185.It Fl N Ar userdb-dir 186Use the user database text file 187.Pa master.passwd 188and group database text file 189.Pa group 190from 191.Ar userdb-dir , 192rather than using the results from the system's 193.Xr getpwnam 3 194and 195.Xr getgrnam 3 196(and related) library calls. 197.It Fl O Ar offset 198Instead of creating the filesystem at the beginning of the file, start 199at offset. 200Valid only for 201.Sy ffs 202and 203.Sy msdos . 204.It Fl o Ar fs-options 205Set file system specific options. 206.Ar fs-options 207is a comma separated list of options. 208Valid file system specific options are detailed below. 209.It Fl p 210Deprecated. 211See the 212.Fl Z 213flag. 214.It Fl R Ar roundup-size 215Round the image up to 216.Ar roundup-size . 217.Ar roundup-size 218should be a multiple of the file system block size. 219This option only applies to the 220.Sy ffs 221file system type. 222.It Fl S Ar sector-size 223Set the file system sector size to 224.Ar sector-size . 225.\" XXX: next line also true for cd9660? 226Defaults to 512. 227.It Fl s Ar image-size 228Set the size of the file system image to 229.Ar image-size . 230This is equivalent to setting both the minimum 231.Fl ( M ) 232and the maximum 233.Fl ( m ) 234sizes to the same value. 235For 236.Sy ffs 237and 238.Sy msdos 239the 240.Ar image-size 241does not include the 242.Ar offset . 243.Ar offset 244is not included in that size. 245.It Fl T Ar timestamp 246Specify a timestamp to be set for all filesystem files and directories 247created so that repeatable builds are possible. 248The 249.Ar timestamp 250can be a 251.Pa pathname , 252where the timestamps are derived from that file, or an integer 253value interpreted as the number of seconds from the Epoch. 254Note that timestamps specified in an 255.Xr mtree 5 256spec file, override the default timestamp. 257.It Fl t Ar fs-type 258Create an 259.Ar fs-type 260file system image. 261The following file system types are supported: 262.Bl -tag -width cd9660 -offset indent 263.It Sy ffs 264BSD fast file system (default). 265.It Sy cd9660 266ISO 9660 file system. 267.It Sy msdos 268FAT12, FAT16, or FAT32 file system. 269.It Sy zfs 270ZFS pool containing one or more file systems. 271.El 272.It Fl x 273Exclude file system nodes not explicitly listed in the specfile. 274.It Fl Z 275Create a sparse file for 276.Sy ffs . 277This is useful for virtual machine images. 278.El 279.Pp 280Where sizes are specified, a decimal number of bytes is expected. 281Two or more numbers may be separated by an 282.Dq x 283to indicate a product. 284Each number may have one of the following optional suffixes: 285.Bl -tag -width 3n -offset indent -compact 286.It b 287Block; multiply by 512 288.It k 289Kibi; multiply by 1024 (1 KiB) 290.It m 291Mebi; multiply by 1048576 (1 MiB) 292.It g 293Gibi; multiply by 1073741824 (1 GiB) 294.It t 295Tebi; multiply by 1099511627776 (1 TiB) 296.It w 297Word; multiply by the number of bytes in an integer 298.El 299.\" 300.\" 301.Ss FFS-specific options 302.Sy ffs 303images have ffs-specific optional parameters that may be provided. 304Each of the options consists of a keyword, an equal sign 305.Pq Ql = , 306and a value. 307The following keywords are supported: 308.Pp 309.Bl -tag -width optimization -offset indent -compact 310.It Sy avgfilesize 311Expected average file size. 312.It Sy avgfpdir 313Expected number of files per directory. 314.It Sy bsize 315Block size. 316.It Sy density 317Bytes per inode. If unset, will allocate the minimum number of inodes to 318represent the filesystem if no free space has been requested (free blocks 319or minimum size set); otherwise the larger of the newfs defaults or what 320is required by the free inode parameters if set. 321.It Sy fsize 322Fragment size. 323.It Sy label 324Label name of the image. 325.It Sy maxbpg 326Maximum blocks per file in a cylinder group. 327.It Sy minfree 328Minimum % free. 329.It Sy optimization 330Optimization preference; one of 331.Ql space 332or 333.Ql time . 334.It Sy extent 335Maximum extent size. 336.It Sy maxbpcg 337Maximum total number of blocks in a cylinder group. 338.It Sy version 339UFS version. 3401 for FFS (default), 2 for UFS2. 341.It Sy softupdates 3420 for disable (default), 1 for enable 343.El 344.Ss CD9660-specific options 345.Sy cd9660 346images have ISO9660-specific optional parameters that may be 347provided. 348The arguments consist of a keyword and, optionally, an equal sign 349.Pq Ql = , 350and a value. 351The following keywords are supported: 352.Pp 353.Bl -tag -width omit-trailing-period -offset indent -compact 354.It Sy allow-deep-trees 355Allow the directory structure to exceed the maximum specified in 356the spec. 357.It Sy allow-illegal-chars 358Allow illegal characters in filenames. 359This option is not implemented. 360.It Sy allow-lowercase 361Allow lowercase characters in filenames. 362This option is not implemented. 363.It Sy allow-max-name 364Allow 37 instead of 33 characters for filenames by omitting the 365version id. 366.It Sy allow-multidot 367Allow multiple dots in a filename. 368.It Sy applicationid 369Application ID of the image. 370.It Sy archimedes 371Use the 372.Ql ARCHIMEDES 373extension to encode 374.Tn RISC OS 375metadata. 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 8 , 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 mtree 8 , 586.Xr newfs 8 , 587.Xr zfsconcepts 8 , 588.Xr zfsprops 8 , 589.Xr zpoolprops 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