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