1.\" $NetBSD: makefs.8,v 1.32 2009/01/20 20:47:25 bjh21 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 January 10, 2009 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 x 47.Op Fl B Ar byte-order 48.Op Fl b Ar free-blocks 49.Op Fl d Ar debug-mask 50.Op Fl F Ar 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 fs-options 56.Op Fl S Ar sector-size 57.Op Fl s Ar image-size 58.Op Fl t Ar fs-type 59.Ar image-file 60.Ar directory | manifest 61.Sh DESCRIPTION 62The utility 63.Nm 64creates a file system image into 65.Ar image-file 66from the directory tree 67.Ar directory 68or from the mtree manifest 69.Ar manifest . 70No special devices or privileges are required to perform this task. 71.Pp 72The options are as follows: 73.Bl -tag -width flag 74.It Fl B Ar byte-order 75Set the byte order of the image to 76.Ar byte-order . 77Valid byte orders are 78.Ql 4321 , 79.Ql big , 80or 81.Ql be 82for big endian, and 83.Ql 1234 , 84.Ql little , 85or 86.Ql le 87for little endian. 88Some file systems may have a fixed byte order; in those cases this 89argument will be ignored. 90.It Fl b Ar free-blocks 91Ensure that a minimum of 92.Ar free-blocks 93free blocks exist in the image. 94An optional 95.Ql % 96suffix may be provided to indicate that 97.Ar free-blocks 98indicates a percentage of the calculated image size. 99.It Fl d Ar debug-mask 100Enable various levels of debugging, depending upon which bits are 101set in 102.Ar debug-mask . 103XXX: document these 104.It Fl F Ar specfile 105Use 106.Ar specfile 107as an 108.Xr mtree 8 109.Sq specfile 110specification. 111This option has no effect when the image is created from a mtree manifest 112rather than a directory. 113.Pp 114If a specfile entry exists in the underlying file system, its 115permissions and modification time will be used unless specifically 116overridden by the specfile. 117An error will be raised if the type of entry in the specfile 118conflicts with that of an existing entry. 119.Pp 120In the opposite case (where a specfile entry does not have an entry 121in the underlying file system) the following occurs: 122If the specfile entry is marked 123.Sy optional , 124the specfile entry is ignored. 125Otherwise, the entry will be created in the image, and it is 126necessary to specify at least the following parameters in the 127specfile: 128.Sy type , 129.Sy mode , 130.Sy gname , 131or 132.Sy gid , 133and 134.Sy uname 135or 136.Sy uid , 137.Sy device 138(in the case of block or character devices), and 139.Sy link 140(in the case of symbolic links). 141If 142.Sy time 143isn't provided, the current time will be used. 144If 145.Sy flags 146isn't provided, the current file flags will be used. 147Missing regular file entries will be created as zero-length files. 148.It Fl f Ar free-files 149Ensure that a minimum of 150.Ar free-files 151free files (inodes) exist in the image. 152An optional 153.Ql % 154suffix may be provided to indicate that 155.Ar free-files 156indicates a percentage of the calculated image size. 157.It Fl M Ar minimum-size 158Set the minimum size of the file system image to 159.Ar minimum-size . 160.It Fl m Ar maximum-size 161Set the maximum size of the file system image to 162.Ar maximum-size . 163An error will be raised if the target file system needs to be larger 164than this to accommodate the provided directory tree. 165.It Fl N Ar dbdir 166Use the user database text file 167.Pa master.passwd 168and group database text file 169.Pa group 170from 171.Ar dbdir , 172rather than using the results from the system's 173.Xr getpwnam 3 174and 175.Xr getgrnam 3 176(and related) library calls. 177.It Fl o Ar fs-options 178Set file system specific options. 179.Ar fs-options 180is a comma separated list of options. 181Valid file system specific options are detailed below. 182.It Fl S Ar sector-size 183Set the file system sector size to 184.Ar sector-size . 185.\" XXX: next line also true for cd9660? 186Defaults to 512. 187.It Fl s Ar image-size 188Set the size of the file system image to 189.Ar image-size . 190.It Fl t Ar fs-type 191Create an 192.Ar fs-type 193file system image. 194The following file system types are supported: 195.Bl -tag -width cd9660 -offset indent 196.It Sy ffs 197BSD fast file system (default). 198.It Sy cd9660 199ISO 9660 file system. 200.El 201.It Fl x 202Exclude file system nodes not explicitly listed in the specfile. 203.El 204.Pp 205Where sizes are specified, a decimal number of bytes is expected. 206Two or more numbers may be separated by an 207.Dq x 208to indicate a product. 209Each number may have one of the following optional suffixes: 210.Bl -tag -width 3n -offset indent -compact 211.It b 212Block; multiply by 512 213.It k 214Kibi; multiply by 1024 (1 KiB) 215.It m 216Mebi; multiply by 1048576 (1 MiB) 217.It g 218Gibi; multiply by 1073741824 (1 GiB) 219.It t 220Tebi; multiply by 1099511627776 (1 TiB) 221.It w 222Word; multiply by the number of bytes in an integer 223.El 224.\" 225.\" 226.Ss FFS-specific options 227.Sy ffs 228images have ffs-specific optional parameters that may be provided. 229Each of the options consists of a keyword, an equal sign 230.Pq Ql = , 231and a value. 232The following keywords are supported: 233.Pp 234.Bl -tag -width optimization -offset indent -compact 235.It Sy avgfilesize 236Expected average file size. 237.It Sy avgfpdir 238Expected number of files per directory. 239.It Sy bsize 240Block size. 241.It Sy density 242Bytes per inode. 243.It Sy fsize 244Fragment size. 245.It Sy maxbpg 246Maximum blocks per file in a cylinder group. 247.It Sy minfree 248Minimum % free. 249.It Sy optimization 250Optimization preference; one of 251.Ql space 252or 253.Ql time . 254.It Sy extent 255Maximum extent size. 256.It Sy maxbpcg 257Maximum total number of blocks in a cylinder group. 258.It Sy version 259UFS version. 2601 for FFS (default), 2 for UFS2. 261.El 262.Ss CD9660-specific options 263.Sy cd9660 264images have ISO9660-specific optional parameters that may be 265provided. 266The arguments consist of a keyword and, optionally, an equal sign 267.Pq Ql = , 268and a value. 269The following keywords are supported: 270.Pp 271.Bl -tag -width omit-trailing-period -offset indent -compact 272.It Sy allow-deep-trees 273Allow the directory structure to exceed the maximum specified in 274the spec. 275.\" .It Sy allow-illegal-chars 276.\" Unknown 277.\" .It Sy allow-lowercase 278.\" Unknown 279.It Sy allow-max-name 280Allow 37 instead of 33 characters for filenames by omitting the 281version id. 282.It Sy allow-multidot 283Allow multiple dots in a filename. 284.It Sy applicationid 285Application ID of the image. 286.It Sy archimedes 287Use the 288.Ql ARCHIMEDES 289extension to encode 290.Tn RISC OS 291metadata. 292.It Sy chrp-boot 293Write an MBR partition table to the image to allow older CHRP hardware to 294boot. 295.It Sy boot-load-segment 296Set load segment for the boot image. 297.It Sy bootimage 298Filename of a boot image in the format 299.Dq sysid;filename , 300where 301.Dq sysid 302is one of 303.Ql i386 , 304.Ql mac68k , 305.Ql macppc , 306or 307.Ql powerpc . 308.It Sy generic-bootimage 309Load a generic boot image into the first 32K of the cd9660 image. 310.It Sy hard-disk-boot 311Boot image is a hard disk image. 312.It Sy keep-bad-images 313Don't throw away images whose write was aborted due to an error. 314For debugging purposes. 315.It Sy label 316Label name of the image. 317.It Sy no-boot 318Boot image is not bootable. 319.It Sy no-emul-boot 320Boot image is a 321.Dq no emulation 322ElTorito image. 323.It Sy no-trailing-padding 324Do not pad the image (apparently Linux needs the padding). 325.\" .It Sy omit-trailing-period 326.\" Unknown 327.It Sy preparer 328Preparer ID of the image. 329.It Sy publisher 330Publisher ID of the image. 331.It Sy rockridge 332Use RockRidge extensions (for longer filenames, etc.). 333.It Sy volumeid 334Volume set identifier of the image. 335.El 336.Sh SEE ALSO 337.Xr mtree 5 , 338.Xr mtree 8 , 339.Xr newfs 8 340.Sh HISTORY 341The 342.Nm 343utility appeared in 344.Nx 1.6 . 345.Sh AUTHORS 346.An Luke Mewburn 347.Aq lukem@NetBSD.org 348(original program) 349.An Daniel Watt , 350.An Walter Deignan , 351.An Ryan Gabrys , 352.An Alan Perez-Rathke , 353.An Ram Vedam 354(cd9660 support) 355