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