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: head/usr.sbin/makefs/makefs.8 331843 2018-03-31 15:04:41Z benno $
  37 .\"
  38 .Dd June 17, 2023
  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 commandline, 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 isn't provided, the current time will be used.
 164 If
 165 .Sy flags
 166 isn't 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 .It Fl T Ar timestamp
 231 Specify a timestamp to be set for all filesystem files and directories
 232 created so that repeatable builds are possible.
 233 The
 234 .Ar timestamp
 235 can be a
 236 .Pa pathname ,
 237 where the timestamps are derived from that file, or an integer
 238 value interpreted as the number of seconds from the Epoch.
 239 Note that timestamps specified in an
 240 .Xr mtree 5
 241 spec file, override the default timestamp.
 242 .It Fl t Ar fs-type
 243 Create an
 244 .Ar fs-type
 245 file system image.
 246 The following file system types are supported:
 247 .Bl -tag -width cd9660 -offset indent
 248 .It Sy ffs
 249 BSD fast file system (default).
 250 .It Sy cd9660
 251 ISO 9660 file system.
 252 .It Sy msdos
 253 FAT12, FAT16, or FAT32 file system.
 254 .It Sy hammer2
 255 HAMMER2 file system.
 256 .El
 257 .It Fl x
 258 Exclude file system nodes not explicitly listed in the specfile.
 259 .It Fl Z
 260 Create a sparse file for
 261 .Sy ffs
 262 and
 263 .Sy hammer2 .
 264 This is useful for virtual machine images.
 265 .El
 266 .Pp
 267 Where sizes are specified, a decimal number of bytes is expected.
 268 Two or more numbers may be separated by an
 269 .Dq x
 270 to indicate a product.
 271 Each number may have one of the following optional suffixes:
 272 .Bl -tag -width 3n -offset indent -compact
 273 .It b
 274 Block; multiply by 512
 275 .It k
 276 Kibi; multiply by 1024 (1 KiB)
 277 .It m
 278 Mebi; multiply by 1048576 (1 MiB)
 279 .It g
 280 Gibi; multiply by 1073741824 (1 GiB)
 281 .It t
 282 Tebi; multiply by 1099511627776 (1 TiB)
 283 .It w
 284 Word; multiply by the number of bytes in an integer
 285 .El
 286 .\"
 287 .\"
 288 .Ss FFS-specific options
 289 .Sy ffs
 290 images have ffs-specific optional parameters that may be provided.
 291 Each of the options consists of a keyword, an equal sign
 292 .Pq Ql = ,
 293 and a value.
 294 The following keywords are supported:
 295 .Pp
 296 .Bl -tag -width optimization -offset indent -compact
 297 .It Sy avgfilesize
 298 Expected average file size.
 299 .It Sy avgfpdir
 300 Expected number of files per directory.
 301 .It Sy bsize
 302 Block size.
 303 .It Sy density
 304 Bytes per inode. If unset, will allocate the minimum number of inodes to
 305 represent the filesystem if no free space has been requested (free blocks
 306 or minimum size set); otherwise the larger of the newfs defaults or what
 307 is required by the free inode parameters if set.
 308 .It Sy fsize
 309 Fragment size.
 310 .It Sy label
 311 Label name of the image.
 312 .It Sy maxbpg
 313 Maximum blocks per file in a cylinder group.
 314 .It Sy minfree
 315 Minimum % free.
 316 .It Sy optimization
 317 Optimization preference; one of
 318 .Ql space
 319 or
 320 .Ql time .
 321 .\".It Sy extent
 322 .\"Maximum extent size.
 323 .It Sy maxbpcg
 324 Maximum total number of blocks in a cylinder group.
 325 .It Sy version
 326 UFS version.
 327 1 for FFS (default and the only supported value).
 328 .\", 2 for UFS2.
 329 .It Sy softupdates
 330 0 for disable (default), 1 for enable
 331 .El
 332 .Ss CD9660-specific options
 333 .Sy cd9660
 334 images have ISO9660-specific optional parameters that may be
 335 provided.
 336 The arguments consist of a keyword and, optionally, an equal sign
 337 .Pq Ql = ,
 338 and a value.
 339 The following keywords are supported:
 340 .Pp
 341 .Bl -tag -width omit-trailing-period -offset indent -compact
 342 .It Sy allow-deep-trees
 343 Allow the directory structure to exceed the maximum specified in
 344 the spec.
 345 .It Sy allow-illegal-chars
 346 Allow illegal characters in filenames. This option is not implemented.
 347 .It Sy allow-lowercase
 348 Allow lowercase characters in filenames. This option is not implemented.
 349 .It Sy allow-max-name
 350 Allow 37 instead of 33 characters for filenames by omitting the
 351 version id.
 352 .It Sy allow-multidot
 353 Allow multiple dots in a filename.
 354 .It Sy applicationid
 355 Application ID of the image.
 356 .It Sy archimedes
 357 Use the
 358 .Ql ARCHIMEDES
 359 extension to encode
 360 .Tn RISC OS
 361 metadata.
 362 .It Sy bootimagedir
 363 Boot image directory. This option is not implemented.
 364 .It Sy chrp-boot
 365 Write an MBR partition table to the image to allow older CHRP hardware to
 366 boot.
 367 .It Sy boot-load-segment
 368 Set load segment for the boot image.
 369 .It Sy bootimage
 370 Filename of a boot image in the format
 371 .Dq sysid;filename ,
 372 where
 373 .Dq sysid
 374 is one of
 375 .Ql i386 ,
 376 .Ql mac68k ,
 377 .Ql macppc ,
 378 or
 379 .Ql powerpc .
 380 .It Sy generic-bootimage
 381 Load a generic boot image into the first 32K of the cd9660 image.
 382 .It Sy hard-disk-boot
 383 Boot image is a hard disk image.
 384 .It Sy isolevel
 385 An integer representing the ISO 9660 interchange level where
 386 .Dq level
 387 is either
 388 .Ql 1
 389 or
 390 .Ql 2 .
 391 .Dq level
 392 .Ql 3
 393 is not implemented.
 394 .It Sy keep-bad-images
 395 Do not discard images whose write was aborted due to an error.
 396 For debugging purposes.
 397 .It Sy label
 398 Label name of the image.
 399 .It Sy no-boot
 400 Boot image is not bootable.
 401 .It Sy no-emul-boot
 402 Boot image is a
 403 .Dq no emulation
 404 ElTorito image.
 405 .It Sy no-trailing-padding
 406 Do not pad the image (apparently Linux needs the padding).
 407 .It Sy omit-trailing-period
 408 Omit trailing periods in filenames.
 409 .It Sy platformid
 410 Set platform ID of section header entry of the boot image.
 411 .It Sy preparer
 412 Preparer ID of the image.
 413 .It Sy publisher
 414 Publisher ID of the image.
 415 .It Sy rockridge
 416 Use RockRidge extensions (for longer filenames, etc.).
 417 .It Sy verbose
 418 Turns on verbose output.
 419 .It Sy volumeid
 420 Volume set identifier of the image.
 421 .El
 422 .Ss msdos-specific options
 423 .Sy msdos
 424 images have MS-DOS-specific optional parameters that may be
 425 provided.
 426 The arguments consist of a keyword, an equal sign
 427 .Pq Ql = ,
 428 and a value.
 429 The following keywords are supported (see
 430 .Xr newfs_msdos 8
 431 for more details):
 432 .Pp
 433 .Bl -tag -width omit-trailing-period -offset indent -compact
 434 .It Cm backup_sector
 435 Location of the backup boot sector.
 436 .It Cm block_size
 437 Block size.
 438 .It Cm bootstrap
 439 Bootstrap file.
 440 .It Cm bytes_per_sector
 441 Bytes per sector.
 442 .It Cm create_size
 443 Create file size.
 444 .It Cm directory_entries
 445 Directory entries.
 446 .It Cm drive_heads
 447 Drive heads.
 448 .It Cm fat_type
 449 FAT type (12, 16, or 32).
 450 .It Cm floppy
 451 Preset drive parameters for standard format floppy disks
 452 (160, 180, 320, 360, 640, 720, 1200, 1232, 1440, or 2880).
 453 .It Cm hidden_sectors
 454 Hidden sectors.
 455 .It Cm info_sector
 456 Location of the info sector.
 457 .It Cm media_descriptor
 458 Media descriptor.
 459 .It Cm num_FAT
 460 Number of FATs.
 461 .It Cm OEM_string
 462 OEM string.
 463 .It Cm offset
 464 Offset in device.
 465 This option will be ignored if
 466 .Fl O
 467 is set to a positive number.
 468 .It Cm reserved_sectors
 469 Reserved sectors.
 470 .It Cm sectors_per_cluster
 471 Sectors per cluster.
 472 .It Cm sectors_per_fat
 473 Sectors per FAT.
 474 .It Cm sectors_per_track
 475 Sectors per track.
 476 .It Cm size
 477 File System size.
 478 .It Cm volume_id
 479 Volume ID.
 480 .It Cm volume_label
 481 Volume Label.
 482 .El
 483 .Ss hammer2-specific options
 484 .Sy hammer2
 485 images have HAMMER2-specific optional parameters that may be
 486 provided.
 487 The arguments consist of a keyword, an equal sign
 488 .Pq Ql = ,
 489 and a value.
 490 The following keywords are supported:
 491 .Pp
 492 Note that for offline operations,
 493 .Ar image-file
 494 must be a valid HAMMER2 image file or block device.
 495 .Ar directory
 496 is unused, but still needs to be either any valid path or `--'.
 497 Also see
 498 .Xr hammer2 8 .
 499 .Pp
 500 .Bl -tag -width omit-trailing-period -offset indent -compact
 501 .It Cm b
 502 Boot area size.
 503 See
 504 .Xr newfs_hammer2 8
 505 for details.
 506 .It Cm r
 507 Aux area size.
 508 See
 509 .Xr newfs_hammer2 8
 510 for details.
 511 .It Cm V
 512 File system version.
 513 See
 514 .Xr newfs_hammer2 8
 515 for details.
 516 Print file system version of
 517 .Ar image-file
 518 and exit if no argument is specified.
 519 .It Cm L
 520 PFS Label.
 521 See
 522 .Xr newfs_hammer2 8
 523 for details.
 524 Unlike
 525 .Xr newfs_hammer2 8 ,
 526 always defaults to "DATA".
 527 .It Cm v
 528 Number of volume headers (1, 2, 3, or 4).
 529 Defaults to 4, and the image size will be at least 4 * 2 = 8 GiB.
 530 .It Cm m
 531 The PFS label to which to create file system contents.
 532 Defaults to "DATA".
 533 .It Cm d
 534 sysctl vfs.hammer2.debug compatible tunable for debug prints.
 535 Specify 0xffffffff to enable all debug prints.
 536 Defaults to 0.
 537 .It Cm E
 538 Set emergency mode.
 539 .It Cm P
 540 Run offline PFS command and exit.
 541 This option takes PFS command name argument.
 542 Available PFS command names are
 543 .Ar get
 544 (alias
 545 .Ar list ) ,
 546 .Ar lookup ,
 547 .Ar create ,
 548 .Ar delete
 549 and
 550 .Ar snapshot .
 551 .Ar lookup ,
 552 .Ar create
 553 and
 554 .Ar delete
 555 take `:<pfs_name>' string after PFS command name.
 556 .Ar snapshot
 557 takes optional `:<pfs_name>' string after PFS command name.
 558 Use
 559 .Fl o
 560 m option to specify target PFS for
 561 .Ar snapshot .
 562 .It Cm I
 563 Run offline inode command and exit.
 564 This option takes inode command name argument.
 565 Available inode command names are
 566 .Ar get ,
 567 .Ar setcheck
 568 and
 569 .Ar setcomp .
 570 .Ar get
 571 takes `:<inode_path>' string after command name.
 572 .Ar setcheck
 573 takes `:<inode_path>:<check_algo>' string after command name.
 574 .Ar setcomp
 575 takes `:<inode_path>:<comp_algo>[:<comp_level>]' string after command name.
 576 .It Cm B
 577 Run offline bulkfree and exit.
 578 .It Cm D
 579 Run offline destroy and exit.
 580 This option takes file path or inode number argument.
 581 The file path argument must start with `/'.
 582 .It Cm G
 583 Run offline growfs and exit.
 584 By default expands to
 585 .Ar image-file
 586 file or device size, unless size is specified by
 587 .Fl s
 588 option.
 589 .El
 590 .Sh SEE ALSO
 591 .Xr mtree 5 ,
 592 .Xr mtree 8 ,
 593 .Xr newfs 8
 594 .Sh HISTORY
 595 The
 596 .Nm
 597 utility appeared in
 598 .Nx 1.6 .
 599 .Sh AUTHORS
 600 .An Luke Mewburn
 601 .Aq Mt lukem@NetBSD.org
 602 (original program),
 603 .An Daniel Watt ,
 604 .An Walter Deignan ,
 605 .An Ryan Gabrys ,
 606 .An Alan Perez-Rathke ,
 607 .An Ram Vedam
 608 (cd9660 support),
 609 .An Christos Zoulas
 610 (msdos support),
 611 .An Tomohiro Kusumi
 612 (hammer2 support).