usr.sbin/makefs/makefs.8

   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 September 17, 2020
  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
  66 The utility
  67 .Nm
  68 creates a file system image into
  69 .Ar image-file
  70 from the directory tree
  71 .Ar directory
  72 or from the mtree manifest
  73 .Ar manifest .
  74 If any optional directory trees are passed in the
  75 .Ar extra-directory
  76 arguments, then the directory tree of each argument will be merged
  77 into the
  78 .Ar directory
  79 or
  80 .Ar manifest
  81 first before creating
  82 .Ar image-file .
  83 No special devices or privileges are required to perform this task.
  84 .Pp
  85 The options are as follows:
  86 .Bl -tag -width flag
  87 .It Fl B Ar endian
  88 Set the byte order of the image to
  89 .Ar endian .
  90 Valid byte orders are
  91 .Ql 4321 ,
  92 .Ql big ,
  93 or
  94 .Ql be
  95 for big endian, and
  96 .Ql 1234 ,
  97 .Ql little ,
  98 or
  99 .Ql le
 100 for little endian.
 101 Some file systems may have a fixed byte order; in those cases this
 102 argument will be ignored.
 103 .It Fl b Ar free-blocks
 104 Ensure that a minimum of
 105 .Ar free-blocks
 106 free blocks exist in the image.
 107 An optional
 108 .Ql %
 109 suffix may be provided to indicate that
 110 .Ar free-blocks
 111 indicates a percentage of the calculated image size.
 112 .It Fl D
 113 Treat duplicate paths in an mtree manifest as warnings not error.
 114 .It Fl d Ar debug-mask
 115 Enable various levels of debugging, depending upon which bits are
 116 set in
 117 .Ar debug-mask .
 118 XXX: document these
 119 .It Fl F Ar mtree-specfile
 120 .Em This is almost certainly not the option you are looking for.
 121 To create an image from a list of files in an mtree format manifest,
 122 specify it as the last argument on the command line, not as a the
 123 argument to
 124 .Fl F .
 125 .Pp
 126 Use
 127 .Ar mtree-specfile
 128 as an
 129 .Xr mtree 8
 130 .Sq specfile
 131 specification.
 132 This option has no effect when the image is created from a mtree manifest
 133 rather than a directory.
 134 .Pp
 135 If a specfile entry exists in the underlying file system, its
 136 permissions and modification time will be used unless specifically
 137 overridden by the specfile.
 138 An error will be raised if the type of entry in the specfile
 139 conflicts with that of an existing entry.
 140 .Pp
 141 In the opposite case (where a specfile entry does not have an entry
 142 in the underlying file system) the following occurs:
 143 If the specfile entry is marked
 144 .Sy optional ,
 145 the specfile entry is ignored.
 146 Otherwise, the entry will be created in the image, and it is
 147 necessary to specify at least the following parameters in the
 148 specfile:
 149 .Sy type ,
 150 .Sy mode ,
 151 .Sy gname ,
 152 or
 153 .Sy gid ,
 154 and
 155 .Sy uname
 156 or
 157 .Sy uid ,
 158 and
 159 .Sy link
 160 (in the case of symbolic links).
 161 If
 162 .Sy time
 163 is not provided, the current time will be used.
 164 If
 165 .Sy flags
 166 is not provided, the current file flags will be used.
 167 Missing regular file entries will be created as zero-length files.
 168 .It Fl f Ar free-files
 169 Ensure that a minimum of
 170 .Ar free-files
 171 free files (inodes) exist in the image.
 172 An optional
 173 .Ql %
 174 suffix may be provided to indicate that
 175 .Ar free-files
 176 indicates a percentage of the calculated image size.
 177 .It Fl M Ar minimum-size
 178 Set the minimum size of the file system image to
 179 .Ar minimum-size .
 180 .It Fl m Ar maximum-size
 181 Set the maximum size of the file system image to
 182 .Ar maximum-size .
 183 An error will be raised if the target file system needs to be larger
 184 than this to accommodate the provided directory tree.
 185 .It Fl N Ar userdb-dir
 186 Use the user database text file
 187 .Pa master.passwd
 188 and group database text file
 189 .Pa group
 190 from
 191 .Ar userdb-dir ,
 192 rather than using the results from the system's
 193 .Xr getpwnam 3
 194 and
 195 .Xr getgrnam 3
 196 (and related) library calls.
 197 .It Fl O Ar offset
 198 Instead of creating the filesystem at the beginning of the file, start
 199 at offset.
 200 Valid only for
 201 .Sy ffs
 202 and
 203 .Sy msdos .
 204 .It Fl o Ar fs-options
 205 Set file system specific options.
 206 .Ar fs-options
 207 is a comma separated list of options.
 208 Valid file system specific options are detailed below.
 209 .It Fl p
 210 Deprecated.
 211 See the
 212 .Fl Z
 213 flag.
 214 .It Fl R Ar roundup-size
 215 Round the image up to
 216 .Ar roundup-size .
 217 .Ar roundup-size
 218 should be a multiple of the file system block size.
 219 This option only applies to the
 220 .Sy ffs
 221 file system type.
 222 .It Fl S Ar sector-size
 223 Set the file system sector size to
 224 .Ar sector-size .
 225 .\" XXX: next line also true for cd9660?
 226 Defaults to 512.
 227 .It Fl s Ar image-size
 228 Set the size of the file system image to
 229 .Ar image-size .
 230 This is equivalent to setting both the minimum
 231 .Fl ( M )
 232 and the maximum
 233 .Fl ( m )
 234 sizes to the same value.
 235 For
 236 .Sy ffs
 237 and
 238 .Sy msdos
 239 the
 240 .Ar image-size
 241 does not include the
 242 .Ar offset .
 243 .Ar offset
 244 is not included in that size.
 245 .It Fl T Ar timestamp
 246 Specify a timestamp to be set for all filesystem files and directories
 247 created so that repeatable builds are possible.
 248 The
 249 .Ar timestamp
 250 can be a
 251 .Pa pathname ,
 252 where the timestamps are derived from that file, or an integer
 253 value interpreted as the number of seconds from the Epoch.
 254 Note that timestamps specified in an
 255 .Xr mtree 5
 256 spec file, override the default timestamp.
 257 .It Fl t Ar fs-type
 258 Create an
 259 .Ar fs-type
 260 file system image.
 261 The following file system types are supported:
 262 .Bl -tag -width cd9660 -offset indent
 263 .It Sy ffs
 264 BSD fast file system (default).
 265 .It Sy cd9660
 266 ISO 9660 file system.
 267 .It Sy msdos
 268 FAT12, FAT16, or FAT32 file system.
 269 .El
 270 .It Fl x
 271 Exclude file system nodes not explicitly listed in the specfile.
 272 .It Fl Z
 273 Create a sparse file for
 274 .Sy ffs .
 275 This is useful for virtual machine images.
 276 .El
 277 .Pp
 278 Where sizes are specified, a decimal number of bytes is expected.
 279 Two or more numbers may be separated by an
 280 .Dq x
 281 to indicate a product.
 282 Each number may have one of the following optional suffixes:
 283 .Bl -tag -width 3n -offset indent -compact
 284 .It b
 285 Block; multiply by 512
 286 .It k
 287 Kibi; multiply by 1024 (1 KiB)
 288 .It m
 289 Mebi; multiply by 1048576 (1 MiB)
 290 .It g
 291 Gibi; multiply by 1073741824 (1 GiB)
 292 .It t
 293 Tebi; multiply by 1099511627776 (1 TiB)
 294 .It w
 295 Word; multiply by the number of bytes in an integer
 296 .El
 297 .\"
 298 .\"
 299 .Ss FFS-specific options
 300 .Sy ffs
 301 images have ffs-specific optional parameters that may be provided.
 302 Each of the options consists of a keyword, an equal sign
 303 .Pq Ql = ,
 304 and a value.
 305 The following keywords are supported:
 306 .Pp
 307 .Bl -tag -width optimization -offset indent -compact
 308 .It Sy avgfilesize
 309 Expected average file size.
 310 .It Sy avgfpdir
 311 Expected number of files per directory.
 312 .It Sy bsize
 313 Block size.
 314 .It Sy density
 315 Bytes per inode. If unset, will allocate the minimum number of inodes to
 316 represent the filesystem if no free space has been requested (free blocks
 317 or minimum size set); otherwise the larger of the newfs defaults or what
 318 is required by the free inode parameters if set.
 319 .It Sy fsize
 320 Fragment size.
 321 .It Sy label
 322 Label name of the image.
 323 .It Sy maxbpg
 324 Maximum blocks per file in a cylinder group.
 325 .It Sy minfree
 326 Minimum % free.
 327 .It Sy optimization
 328 Optimization preference; one of
 329 .Ql space
 330 or
 331 .Ql time .
 332 .It Sy extent
 333 Maximum extent size.
 334 .It Sy maxbpcg
 335 Maximum total number of blocks in a cylinder group.
 336 .It Sy version
 337 UFS version.
 338 1 for FFS (default), 2 for UFS2.
 339 .It Sy softupdates
 340 0 for disable (default), 1 for enable
 341 .El
 342 .Ss CD9660-specific options
 343 .Sy cd9660
 344 images have ISO9660-specific optional parameters that may be
 345 provided.
 346 The arguments consist of a keyword and, optionally, an equal sign
 347 .Pq Ql = ,
 348 and a value.
 349 The following keywords are supported:
 350 .Pp
 351 .Bl -tag -width omit-trailing-period -offset indent -compact
 352 .It Sy allow-deep-trees
 353 Allow the directory structure to exceed the maximum specified in
 354 the spec.
 355 .It Sy allow-illegal-chars
 356 Allow illegal characters in filenames.
 357 This option is not implemented.
 358 .It Sy allow-lowercase
 359 Allow lowercase characters in filenames.
 360 This option is not implemented.
 361 .It Sy allow-max-name
 362 Allow 37 instead of 33 characters for filenames by omitting the
 363 version id.
 364 .It Sy allow-multidot
 365 Allow multiple dots in a filename.
 366 .It Sy applicationid
 367 Application ID of the image.
 368 .It Sy archimedes
 369 Use the
 370 .Ql ARCHIMEDES
 371 extension to encode
 372 .Tn RISC OS
 373 metadata.
 374 .It Sy bootimagedir
 375 Boot image directory.
 376 This option is not implemented.
 377 .It Sy chrp-boot
 378 Write an MBR partition table to the image to allow older CHRP hardware to
 379 boot.
 380 .It Sy boot-load-segment
 381 Set load segment for the boot image.
 382 .It Sy bootimage
 383 Filename of a boot image in the format
 384 .Dq sysid;filename ,
 385 where
 386 .Dq sysid
 387 is one of
 388 .Ql i386 ,
 389 .Ql mac68k ,
 390 .Ql macppc ,
 391 .Ql powerpc ,
 392 or
 393 .Ql efi .
 394 .It Sy generic-bootimage
 395 Load a generic boot image into the first 32K of the cd9660 image.
 396 .It Sy hard-disk-boot
 397 Boot image is a hard disk image.
 398 .It Sy isolevel
 399 An integer representing the ISO 9660 interchange level where
 400 .Dq level
 401 is either
 402 .Ql 1
 403 or
 404 .Ql 2 .
 405 .Dq level
 406 .Ql 3
 407 is not implemented.
 408 .It Sy keep-bad-images
 409 Do not discard images whose write was aborted due to an error.
 410 For debugging purposes.
 411 .It Sy label
 412 Label name of the image.
 413 .It Sy no-boot
 414 Boot image is not bootable.
 415 .It Sy no-emul-boot
 416 Boot image is a
 417 .Dq no emulation
 418 ElTorito image.
 419 .It Sy no-trailing-padding
 420 Do not pad the image (apparently Linux needs the padding).
 421 .It Sy omit-trailing-period
 422 Omit trailing periods in filenames.
 423 .It Sy platformid
 424 Set platform ID of section header entry of the boot image.
 425 .It Sy preparer
 426 Preparer ID of the image.
 427 .It Sy publisher
 428 Publisher ID of the image.
 429 .It Sy rockridge
 430 Use RockRidge extensions (for longer filenames, etc.).
 431 .It Sy verbose
 432 Turns on verbose output.
 433 .It Sy volumeid
 434 Volume set identifier of the image.
 435 .El
 436 .Ss msdos-specific options
 437 .Sy msdos
 438 images have MS-DOS-specific optional parameters that may be
 439 provided.
 440 The arguments consist of a keyword, an equal sign
 441 .Pq Ql = ,
 442 and a value.
 443 The following keywords are supported (see
 444 .Xr newfs_msdos 8
 445 for more details):
 446 .Pp
 447 .Bl -tag -width omit-trailing-period -offset indent -compact
 448 .It Cm backup_sector
 449 Location of the backup boot sector.
 450 .It Cm block_size
 451 Block size.
 452 .It Cm bootstrap
 453 Bootstrap file.
 454 .It Cm bytes_per_sector
 455 Bytes per sector.
 456 .It Cm create_size
 457 Create file size.
 458 .It Cm directory_entries
 459 Directory entries.
 460 .It Cm drive_heads
 461 Drive heads.
 462 .It Cm fat_type
 463 FAT type (12, 16, or 32).
 464 .It Cm floppy
 465 Preset drive parameters for standard format floppy disks
 466 (160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880).
 467 .It Cm hidden_sectors
 468 Hidden sectors.
 469 .It Cm info_sector
 470 Location of the info sector.
 471 .It Cm media_descriptor
 472 Media descriptor.
 473 .It Cm num_FAT
 474 Number of FATs.
 475 .It Cm OEM_string
 476 OEM string.
 477 .It Cm offset
 478 Offset in device.
 479 This option will be ignored if
 480 .Fl O
 481 is set to a positive number.
 482 .It Cm reserved_sectors
 483 Reserved sectors.
 484 .It Cm sectors_per_cluster
 485 Sectors per cluster.
 486 .It Cm sectors_per_fat
 487 Sectors per FAT.
 488 .It Cm sectors_per_track
 489 Sectors per track.
 490 .It Cm size
 491 File System size.
 492 .It Cm volume_id
 493 Volume ID.
 494 .It Cm volume_label
 495 Volume Label.
 496 .El
 497 .Sh SEE ALSO
 498 .Xr mtree 5 ,
 499 .Xr mtree 8 ,
 500 .Xr newfs 8
 501 .Sh HISTORY
 502 The
 503 .Nm
 504 utility appeared in
 505 .Nx 1.6 .
 506 It was ported to
 507 .Fx
 508 and first appeared in
 509 .Fx 8.0 .
 510 .Sh AUTHORS
 511 .An Luke Mewburn
 512 .Aq Mt lukem@NetBSD.org
 513 (original program),
 514 .An Daniel Watt ,
 515 .An Walter Deignan ,
 516 .An Ryan Gabrys ,
 517 .An Alan Perez-Rathke ,
 518 .An Ram Vedam
 519 (cd9660 support),
 520 .An Christos Zoulas
 521 (msdos support).