usr.sbin/makefs/makefs.8

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