usr.sbin/bsdinstall/bsdinstall.8

   1 .\"-
   2 .\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org> All rights reserved.
   3 .\" Copyright (c) 2018 Roberto Fernandez Cueto <roberfern@gmail.com>
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  18 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  20 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  22 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  23 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .Dd November 18, 2023
  27 .Dt BSDINSTALL 8
  28 .Os
  29 .Sh NAME
  30 .Nm bsdinstall
  31 .Nd system installer
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Ar options
  35 .Op Ar target
  36 .Op Ar ...
  37 .Sh DESCRIPTION
  38 .Nm
  39 is used for installation of new systems, both for system setup from
  40 installation media, e.g., CD-ROMs, and for use on live systems to prepare
  41 VM images and jails.
  42 .Pp
  43 Much like
  44 .Xr make 1 , Nm
  45 takes a target and possible parameters of the target as arguments.
  46 If invoked with no arguments, it will invoke the
  47 .Cm auto
  48 target, which provides a standard interactive installation, invoking the
  49 others in sequence.
  50 To perform a scripted installation,
  51 these subtargets can be invoked separately by an installation script.
  52 .Sh OPTIONS
  53 .Nm
  54 supports the following options, global to all targets:
  55 .Bl -tag -width indent+
  56 .It Fl D Ar file
  57 Provide a path for the installation log file
  58 .Pq overrides Ev BSDINSTALL_LOG .
  59 See
  60 .Sx ENVIRONMENT VARIABLES
  61 for more information on
  62 .Ev BSDINSTALL_LOG .
  63 .El
  64 .Sh TARGETS
  65 Most of the following targets are only useful for scripting the installer.
  66 For interactive use, most users will be interested only in the
  67 .Cm auto ,
  68 .Cm jail ,
  69 and
  70 .Cm script
  71 targets.
  72 .Bl -tag -width "jail destination"
  73 .It Cm auto
  74 Run the standard interactive installation, including disk partitioning.
  75 .It Cm jail Ar destination
  76 Sets up a new chroot system at
  77 .Pa destination ,
  78 suitable for use with
  79 .Xr jail 8 .
  80 Behavior is generally similar to
  81 .Cm auto ,
  82 except that disk partitioning and network setup are skipped and a kernel is
  83 not installed into the new system.
  84 .It Cm script Ar script
  85 Runs the installation script at
  86 .Pa script .
  87 See
  88 .Sx SCRIPTING
  89 for more information on this target.
  90 .It Cm keymap
  91 If the current controlling TTY is a
  92 .Xr syscons 4
  93 or
  94 .Xr vt 4
  95 console, asks the user to set the current keymap, and saves the result to the
  96 new system's
  97 .Pa rc.conf .
  98 .It Cm hostname
  99 Prompts the user for a host name for the new system and saves the result to the
 100 new system's
 101 .Pa rc.conf .
 102 If
 103 .Ev BSDINSTALL_CONFIGCURRENT
 104 is set, also sets the host name of the current system.
 105 .It Cm netconfig
 106 Interactively configures network interfaces (first invoking
 107 .Cm wlanconfig
 108 on wireless interfaces), saving the result to the new system's
 109 .Pa rc.conf
 110 and
 111 .Pa resolv.conf .
 112 If
 113 .Ev BSDINSTALL_CONFIGCURRENT
 114 is set, also configures the network interfaces of the current system to match.
 115 .It Cm autopart
 116 Provides the installer's interactive guided disk partitioner for single-disk
 117 installations.
 118 Defaults to UFS.
 119 .It Cm bootconfig
 120 Detects an appropriate partition and installs UEFI boot loader files.
 121 .It Cm zfsboot
 122 Provides a ZFS-only automatic interactive disk partitioner.
 123 Creates a single
 124 .Ic zpool
 125 with separate datasets for
 126 .Pa /tmp ,
 127 .Pa /usr ,
 128 .Pa /usr/home ,
 129 .Pa /usr/ports ,
 130 .Pa /usr/src ,
 131 and
 132 .Pa /var .
 133 Optionally can set up
 134 .Xr geli 8
 135 to encrypt the disk.
 136 .It Cm partedit
 137 Provides the installer's interactive manual disk partitioner with an interface
 138 identical to
 139 .Xr sade 8 .
 140 Supports multiple disks as well as UFS, ZFS, and FAT file systems.
 141 ZFS is set up with one pool and dataset per partition.
 142 .It Cm scriptedpart Ar parameters
 143 Sets up disks like
 144 .Cm autopart
 145 and
 146 .Cm partedit ,
 147 but non-interactively according to the disk setup specified in
 148 .Ar parameters .
 149 Each disk setup is specified by a three-part argument:
 150 .Pp
 151 .Ar disk
 152 .Op Ar scheme
 153 .Op Ar {partitions}
 154 .Pp
 155 Multiple disk setups are separated by semicolons.
 156 The
 157 .Ar disk
 158 argument specifies the disk on which to operate (which will be erased),
 159 or the special value
 160 .Em DEFAULT ,
 161 which will result in either a selection window (as in
 162 .Cm autopart )
 163 for the destination disk or, if there is only one possible disk, will
 164 automatically select it.
 165 The
 166 .Ar scheme
 167 argument specifies the
 168 .Xr gpart 8
 169 partition scheme to apply to the disk.
 170 If
 171 .Ar scheme
 172 is unspecified,
 173 .Cm scriptedpart
 174 will apply the default bootable scheme on your platform.
 175 The
 176 .Ar partitions
 177 argument is also optional and specifies how to partition
 178 .Ar disk .
 179 It consists of a comma-separated list of partitions to create enclosed in
 180 curly braces.
 181 Each partition declaration takes the form
 182 .Pp
 183 .Ar size
 184 .Ar type
 185 .Op Ar mount point
 186 .Pp
 187 .Ar size
 188 specifies the partition size to create in bytes (K, M, and G suffixes
 189 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
 190 while the
 191 .Em auto
 192 keyword causes the partition to take all the remaining space on the disk.
 193 The
 194 .Ar type
 195 option chooses the
 196 .Xr gpart 8
 197 filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
 198 The optional
 199 .Ar mount point
 200 argument sets where the created partition is to be mounted in the installed
 201 system.
 202 As an example, a typical invocation looks like:
 203 .Pp
 204 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
 205 .Pp
 206 Note that the list of partitions should
 207 .Em not
 208 include boot partitions (e.g. EFI system partitions), which will be created automatically on whatever disk includes /.
 209 .Pp
 210 A shorter invocation to use the default partitioning (as
 211 .Cm autopart
 212 would have used) on the same disk:
 213 .Pp
 214 bsdinstall scriptedpart ada0
 215 .Pp
 216 or, even shorter:
 217 .Pp
 218 bsdinstall scriptedpart DEFAULT
 219 .It Cm mount
 220 Mounts the file systems previously configured by
 221 .Cm autopart ,
 222 .Cm partedit ,
 223 or
 224 .Cm scriptedpart
 225 under
 226 .Ev BSDINSTALL_CHROOT .
 227 .It Cm distfetch
 228 Fetches the distributions in
 229 .Ev DISTRIBUTIONS
 230 to
 231 .Ev BSDINSTALL_DISTDIR
 232 from
 233 .Ev BSDINSTALL_DISTSITE .
 234 .It Cm checksum
 235 Verifies the checksums of the distributions listed in
 236 .Ev DISTRIBUTIONS
 237 against the distribution manifest.
 238 .It Cm distextract
 239 Extracts the distributions listed in
 240 .Ev DISTRIBUTIONS
 241 into
 242 .Ev BSDINSTALL_CHROOT .
 243 .It Cm rootpass
 244 Interactively invokes
 245 .Xr passwd 1
 246 in the new system to set the root user's password.
 247 .It Cm adduser
 248 Interactively invokes
 249 .Xr adduser 8
 250 in the new system.
 251 .It Cm time
 252 Interactively sets the time, date, and time zone of the new system.
 253 .It Cm services
 254 Queries the user for the system daemons to begin at system startup,
 255 writing the result into the new system's
 256 .Pa rc.conf .
 257 .It Cm entropy
 258 Reads a small amount of data from
 259 .Pa /dev/random
 260 and stores it in a file in the new system's root directory.
 261 .It Cm config
 262 Installs the configuration files destined for the new system, e.g.,
 263 .Xr rc.conf 5
 264 fragments generated by
 265 .Cm netconfig ,
 266 etc.) onto the new system.
 267 .El
 268 .Sh ENVIRONMENT VARIABLES
 269 The following environment variables control various aspects of the installation
 270 process.
 271 Many are used internally during installation and have reasonable default values
 272 for most installation scenarios.
 273 Others are set by various interactive user prompts, and can be usefully
 274 overridden when making scripted or customized installers.
 275 .Bl -tag -width "BSDINSTALL_DISTSITE"
 276 .It Ev TMPDIR
 277 The directory to use for temporary files.
 278 Default:
 279 .Dq Pa /tmp
 280 .It Ev DISTRIBUTIONS
 281 The set of distributions to install, e.g., "base.txz kernel.txz ports.txz".
 282 Default: unset
 283 .It Ev PARTITIONS
 284 The partitioning of the disk onto which the system is being installed.
 285 See
 286 .Cm scriptedpart
 287 of
 288 the
 289 .Sx TARGETS
 290 section for format details. If this variable is unset, the installer will
 291 use the default partitioning as in
 292 .Cm autopart .
 293 Default: unset
 294 .It Ev BSDINSTALL_DISTDIR
 295 The directory in which the distribution files can be found (or to which they
 296 should be downloaded).
 297 Default:
 298 .Dq Pa /usr/freebsd-dist
 299 .It Ev BSDINSTALL_DISTSITE
 300 URL from which the distribution files should be downloaded if they are not
 301 already present in the directory defined by
 302 .Ev BSDINSTALL_DISTDIR .
 303 This should be a full path to the files, including architecture and release
 304 names.
 305 Most targets, e.g.,
 306 .Cm auto
 307 and
 308 .Cm jail ,
 309 that prompt for a
 310 .Fx
 311 mirror will skip that step if this variable is already defined in the
 312 environment.
 313 Example:
 314 .Pa https://download.freebsd.org/ftp/releases/powerpc/powerpc64/13.1-RELEASE/
 315 or
 316 .Pa http://ftp-archive.freebsd.org/pub/FreeBSD-Archive/old-releases/amd64/12.2-RELEASE/ .
 317 .It Ev BSDINSTALL_CHROOT
 318 The directory into which the distribution files should be unpacked and the
 319 directory at which the root file system of the new system should be mounted.
 320 Default:
 321 .Dq Pa /mnt
 322 .It Ev BSDINSTALL_LOG
 323 Path to a log file for the installation.
 324 Default:
 325 .Dq Pa $TMPDIR/bsdinstall_log
 326 .It Ev BSDINSTALL_SKIP_HARDENING
 327 If not empty, the
 328 .Cm auto
 329 target
 330 will not invoke the
 331 .Cm hardening
 332 target.
 333 .It Ev BSDINSTALL_SKIP_HOSTNAME
 334 If not empty, the
 335 .Cm auto
 336 target
 337 will not invoke the
 338 .Cm hostname
 339 target.
 340 .It Ev BSDINSTALL_SKIP_KEYMAP
 341 If not empty, the
 342 .Cm auto
 343 target
 344 will not invoke the
 345 .Cm keymap
 346 target.
 347 .It Ev BSDINSTALL_SKIP_MANUAL
 348 If not empty, the
 349 .Cm auto
 350 target will not offer to open a shell in the new system
 351 for final manual modifications.
 352 .It Ev BSDINSTALL_SKIP_SERVICES
 353 If not empty, the
 354 .Cm auto
 355 target
 356 will not invoke the
 357 .Cm services
 358 target.
 359 .It Ev BSDINSTALL_SKIP_TIME
 360 If not empty, the
 361 .Cm auto
 362 target
 363 will not invoke the
 364 .Cm time
 365 target.
 366 .It Ev BSDINSTALL_SKIP_USERS
 367 If not empty, the
 368 .Cm auto
 369 target
 370 will not invoke the
 371 .Cm adduser
 372 target.
 373 .It Ev BSDINSTALL_SKIP_FINALCONFIG
 374 If not empty, the
 375 .Cm auto
 376 target will not show the final configuration dialog,
 377 where earlier configuration choices can be revisited.
 378 .It Ev BSDINSTALL_TMPETC
 379 Directory where files destined for the new system's
 380 .Pa /etc
 381 will be stored until the
 382 .Cm config
 383 target is executed.
 384 If this directory does not already exist, it will be created.
 385 Default:
 386 .Dq Pa $TMPDIR/bsdinstall_etc
 387 .It Ev BSDINSTALL_TMPBOOT
 388 Directory where files destined for the new system's
 389 .Pa /boot
 390 will be stored until the
 391 .Cm config
 392 target is executed.
 393 If this directory does not already exist, it will be created.
 394 Default:
 395 .Dq Pa $TMPDIR/bsdinstall_boot
 396 .It Ev ZFSBOOT_POOL_NAME
 397 Name for the pool containing the base system.
 398 Default:
 399 .Dq zroot
 400 .It Ev ZFSBOOT_POOL_CREATE_OPTIONS
 401 Options to be used when creating the base system's pool.
 402 Each option must be followed by the -O flag to be taken into consideration
 403 or the pool will not be created due to errors using the command
 404 .Cm zpool .
 405 Default:
 406 .Dq Li "-O compress=lz4 -O atime=off"
 407 .It Ev ZFSBOOT_BEROOT_NAME
 408 Name for the boot environment parent dataset.
 409 This is a non-mountable dataset meant to be a parent dataset where different
 410 boot environment are going to be created.
 411 Default:
 412 .Dq ROOT
 413 .It Ev ZFSBOOT_BOOTFS_NAME
 414 Name for the primary boot environment, which will be the default boot
 415 environment for the system.
 416 Default:
 417 .Dq default
 418 .It Ev ZFSBOOT_VDEV_TYPE
 419 The type of pool to be created for the base system.
 420 This variable can take one of this values: stripe (No redundancy),
 421 mirror (n-Way mirroring), raid10 (RAID 1+0 - n x 2-Way Mirrors),
 422 raidz1 (RAID-Z1 - Single Redundancy RAID), raidz2 (RAID-Z2 - Double Redundancy RAID)
 423 or raidz3 (RAID-Z3 Triple Redundancy RAID).
 424 Default:
 425 .Dq stripe
 426 .It Ev ZFSBOOT_FORCE_4K_SECTORS
 427 Controls the minimum sector size of the pool.
 428 If this variable is not empty, the minimum sector size is 4K.
 429 If this variable is empty, the minimum sector size is 512.
 430 Note that the sector size of the pool will always be at least
 431 the sector size of the backing disks.
 432 Default:
 433 .Dq 1
 434 .It Ev ZFSBOOT_GELI_ENCRYPTION
 435 If this variable is not empty, it will use
 436 .Xr geli 8
 437 to encrypt the root pool, enabling automatically the
 438 .Ev ZFSBOOT_BOOT_POOL
 439 variable.
 440 Default:
 441 .Dq ""
 442 .It Ev ZFSBOOT_GELI_KEY_FILE
 443 Path to the
 444 .Xr geli 8
 445 keyfile used to encrypt the pool where the base system is stored.
 446 Default:
 447 .Dq Pa /boot/encryption.key
 448 .It Ev ZFSBOOT_BOOT_POOL
 449 If set a separated boot pool will be created for the kernel of the
 450 system and
 451 .Xr loader 8 .
 452 Default: unset
 453 .It Ev ZFSBOOT_BOOT_POOL_CREATE_OPTIONS
 454 Options to use when creating the boot pool, when enabled (See
 455 .Ev ZFSBOOT_BOOT_POOL ).
 456 Default: unset
 457 .It Ev ZFSBOOT_BOOT_POOL_NAME
 458 Name for the optional boot pool when it is enabled, (See
 459 .Ev ZFSBOOT_BOOT_POOL ).
 460 Default:
 461 .Dq bootpool
 462 .It Ev ZFSBOOT_BOOT_POOL_SIZE
 463 Size of the boot pool when it is enabled (See
 464 .Ev ZFSBOOT_BOOT_POOL ).
 465 Default:
 466 .Dq 2g
 467 .It Ev ZFSBOOT_DISKS
 468 Disks to be used for the base system, including the boot pool.
 469 This variable must only be used on a scripted installation.
 470 See
 471 .Sx SCRIPTING
 472 for more information.
 473 Default: unset
 474 .It Ev ZFSBOOT_SWAP_SIZE
 475 Size of the swap partition on each block device.
 476 This variable will be passed to
 477 .Xr gpart 8 ;
 478 which supports SI unit suffixes.
 479 Default:
 480 .Dq 2g
 481 .It Ev ZFSBOOT_SWAP_ENCRYPTION
 482 If set, enables the encryption of the swap partition using
 483 .Xr geli 8 .
 484 Default: ""
 485 .It Ev ZFSBOOT_SWAP_MIRROR
 486 If set, enables a swap mirroring using
 487 .Xr gmirror 8 .
 488 Default:
 489 unset
 490 .It Ev ZFSBOOT_DATASETS
 491 ZFS datasets to be created on the root zpool, it requires the
 492 following datasets:
 493 .Pa /tmp ,
 494 .Pa /var/tmp ,
 495 .Pa /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME .
 496 See
 497 .Sx ZFS DATASETS
 498 for more information about who to write this variable and to
 499 take a look into the default value of it.
 500 .It Ev ZFSBOOT_CONFIRM_LAYOUT
 501 If set and the installation is interactive, allow the user to confirm
 502 the layout before continuing with the installation.
 503 Default:
 504 .Dq 1
 505 .El
 506 .Sh SCRIPTING
 507 .Nm
 508 supports unattended, or minimally-attended, installations using scripting.
 509 This can be used with either modified physical installation media or with
 510 .Xr diskless 8
 511 installations over the network; information on preparing such media can be
 512 found in
 513 .Sx BUILDING AUTOMATIC INSTALL MEDIA
 514 .Pp
 515 Scripted installations follow an essentially identical path to interactive
 516 installations, though with some minor feature differences (for example,
 517 scripted installations do not support fetching of remote distribution files
 518 since scripted installations normally install the same files and the distributions
 519 can be added directly to the installation media).
 520 .Nm
 521 scripts consist of two parts: a
 522 .Em preamble
 523 and a
 524 .Em setup script .
 525 The preamble sets up the options for the installation (how to partition the
 526 disk[s], which distributions to install, etc.) and the optional second part is
 527 a shell script run under
 528 .Xr chroot 8
 529 in the newly installed system before
 530 .Nm
 531 exits.
 532 The two parts are separated by the usual script header (#!), which also sets
 533 the interpreter for the setup script.
 534 .Pp
 535 A typical bsdinstall script, using the default filesystem layout and the UFS
 536 filesystem, looks like this:
 537 .Bd -literal -offset indent
 538 PARTITIONS=DEFAULT
 539 DISTRIBUTIONS="kernel.txz base.txz"
 540
 541 #!/bin/sh
 542 sysrc ifconfig_DEFAULT=DHCP
 543 sysrc sshd_enable=YES
 544 pkg install puppet
 545 .Ed
 546 .Pp
 547 For a scripted installation involving a ZFS pool spanning multiple disks,
 548 the script instead looks like this:
 549 .Bd -literal -offset indent
 550 DISTRIBUTIONS="kernel.txz base.txz"
 551 export ZFSBOOT_VDEV_TYPE=stripe
 552 export ZFSBOOT_DISKS="ada0 ada1"
 553 export nonInteractive="YES"
 554
 555 #!/bin/sh
 556 echo "ifconfig_DEFAULT=DHCP" >> /etc/rc.conf
 557 echo "sshd_enable=YES" >> /etc/rc.conf
 558 pkg install puppet
 559 .Ed
 560 .Pp
 561 On
 562 .Fx
 563 release media, such a script placed at
 564 .Pa /etc/installerconfig
 565 will be run at boot time and the system will be rebooted automatically after
 566 the installation has completed.
 567 This can be used for unattended network installation of new systems; see
 568 .Xr diskless 8
 569 for details.
 570 .Ss PREAMBLE
 571 The preamble consists of installer settings.
 572 These control global installation parameters (see
 573 .Sx ENVIRONMENT VARIABLES )
 574 as well as disk partitioning.
 575 The preamble is interpreted as a
 576 .Xr sh 1
 577 script run at the very beginning of the install.
 578 If more complicated behavior than setting these variables is desired,
 579 arbitrary commands can be run here to extend the installer.
 580 In addition to the variables in
 581 .Sx ENVIRONMENT VARIABLES ,
 582 in particular
 583 .Ev DISTRIBUTIONS ,
 584 the preamble can contain a variable
 585 .Ev PARTITIONS
 586 which is passed to the
 587 .Cm scriptedpart
 588 target to control disk setup.
 589 .Pp
 590 Alternatively,
 591 to use
 592 .Cm zfsboot
 593 instead of
 594 .Cm partedit ,
 595 the preamble can contain the variable
 596 .Ev ZFSBOOT_DATASETS
 597 instead of
 598 .Ev PARTITIONS
 599 (see below).
 600 If using .Cm zfsboot, the variables
 601 .Ev ZFSBOOT_DISKS
 602 and
 603 .Ev ZFSBOOT_VDEV_TYPE
 604 must be set to create the pool of disks for the base system.
 605 Usually, for a mirrored booting disk, this two variables looks like this:
 606 .Bd -literal -offset indent
 607 ZFSBOOT_DISKS="ada0 ada1"
 608 ZFSBOOT_VDEV_TYPE=mirror
 609 .Ed
 610 .Pp
 611 Remember to export all the variables for the
 612 .Cm zfsboot
 613 command, otherwise installation will fail.
 614 .Ss SETUP SCRIPT
 615 Following the preamble is an optional shell script, beginning with a #!
 616 declaration.
 617 This script will be run at the end of the installation process inside a
 618 .Xr chroot 8
 619 environment in the newly installed system and can be used to set up
 620 configuration files, install packages, etc.
 621 Note that newly configured system services, e.g., networking have not
 622 been started in the installed system at this time and only installation
 623 host services are available.
 624 .Ss ZFS DATASETS
 625 If using
 626 .Cm zfsboot
 627 in an installation script, the
 628 .Cm zfsboot
 629 partitioning tool takes the
 630 .Ev ZFSBOOT_DATASETS
 631 variable to create the ZFS datasets on the base system.
 632 This variable definition can become large if the pool contains many datasets.
 633 The default value of the
 634 .Ev ZFSBOOT_DATASETS
 635 is:
 636 .Bd -literal -offset indent
 637 # DATASET       OPTIONS (comma or space separated; or both)
 638
 639 # Boot Environment [BE] root and default boot dataset
 640 /$ZFSBOOT_BEROOT_NAME                           mountpoint=none
 641 /$ZFSBOOT_BEROOT_NAME/$ZFSBOOT_BOOTFS_NAME      mountpoint=/
 642
 643 # Compress /tmp, allow exec but not setuid
 644 /tmp            mountpoint=/tmp,exec=on,setuid=off
 645
 646 # Do not mount /usr so that 'base' files go to the BEROOT
 647 /usr            mountpoint=/usr,canmount=off
 648
 649 # Home directories separated so they are common to all BEs
 650 /usr/home       # NB: /home is a symlink to /usr/home
 651
 652 # Ports tree
 653 /usr/ports      setuid=off
 654
 655 # Source tree (compressed)
 656 /usr/src
 657
 658 # Create /var and friends
 659 /var            mountpoint=/var,canmount=off
 660 /var/audit      exec=off,setuid=off
 661 /var/crash      exec=off,setuid=off
 662 /var/log        exec=off,setuid=off
 663 /var/mail       atime=on
 664 /var/tmp        setuid=off
 665 .Ed
 666 .Pp
 667 The first column is the name of the dataset to be created as part of the
 668 .Ev ZFSBOOT_POOL_NAME
 669 pool and the remainder of each line contains the options to be set on each dataset.
 670 If multiple options are given, they can be separated by either commas or whitespace;
 671 everything following a pound/hash character is ignored as a comment.
 672 .Ss BUILDING AUTOMATIC INSTALL MEDIA
 673 If building automatic install media, use tar to extract a release ISO:
 674 .Dl mkdir release-media
 675 .Dl tar xvf -C release-media FreeBSD-13.0-RELEASE-amd64-disc1.iso
 676 .Pp
 677 Then place a script as above in
 678 .Pa etc/installerconfig
 679 .Pp
 680 This directory can then be used directly as an NFS root for
 681 .Xr diskless 8
 682 installations or it can be rebuilt into an ISO image using the release scripts in
 683 .Pa /usr/src/release .
 684 For example, on amd64:
 685 .Dl sh /usr/src/release/amd64/mkisoimages.sh -b '13_0_RELEASE_AMD64_CD' output.iso release-media
 686 .Sh HISTORY
 687 This version of
 688 .Nm
 689 first appeared in
 690 .Fx 9.0 .
 691 .Sh AUTHORS
 692 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
 693 .An Devin Teske Aq Mt dteske@FreeBSD.org
 694 .An Allan Jude Aq Mt allanjude@FreeBSD.org