bsdinstall(8): fix manpage issues
- Start new sentences on new lines. - Separate e.g. (more of an igor thing) with commas, and rewrite some examples not to be enclosed in parentheses. Reported by: igor, make manlint MFC after: 2 weeks Sponsored by: Dell EMC Isilon
This commit is contained in:
ngie
parent
356b3a6a26
commit
2b6f093ae4
@ -25,7 +25,7 @@
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd October 31, 2014
|
||||
.Dd May 23, 2017
|
||||
.Dt BSDINSTALL 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
@ -39,17 +39,18 @@
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
is used for installation of new systems, both for system setup from
|
||||
installation media (e.g. CD-ROMs) and for use on live systems to prepare
|
||||
installation media, e.g., CD-ROMs, and for use on live systems to prepare
|
||||
VM images and jails.
|
||||
.Pp
|
||||
Much like
|
||||
.Xr make 1 , Nm
|
||||
takes a target and possible parameters of the target as arguments. If
|
||||
invoked with no arguments, it will invoke the
|
||||
takes a target and possible parameters of the target as arguments.
|
||||
If invoked with no arguments, it will invoke the
|
||||
.Cm auto
|
||||
target, which provides a standard interactive installation, invoking the
|
||||
others in sequence. To perform a scripted installation, these subtargets
|
||||
can be invoked separately by an installation script.
|
||||
others in sequence.
|
||||
To perform a scripted installation,
|
||||
these subtargets can be invoked separately by an installation script.
|
||||
.Sh OPTIONS
|
||||
.Nm
|
||||
supports the following options, global to all targets:
|
||||
@ -115,7 +116,8 @@ If
|
||||
is set, also configures the network interfaces of the current system to match.
|
||||
.It Cm autopart
|
||||
Provides the installer's interactive guided disk partitioner for single-disk
|
||||
installations. Defaults to UFS.
|
||||
installations.
|
||||
Defaults to UFS.
|
||||
.It Cm zfsboot
|
||||
Provides an alternative ZFS-only automatic interactive disk partitioner.
|
||||
Creates a single
|
||||
@ -135,8 +137,8 @@ to encrypt the disk.
|
||||
Provides the installer's interactive manual disk partitioner with an interface
|
||||
identical to
|
||||
.Xr sade 8 .
|
||||
Supports multiple disks as well as UFS, ZFS, and FAT file systems. ZFS
|
||||
is set up with one pool and dataset per partition.
|
||||
Supports multiple disks as well as UFS, ZFS, and FAT file systems.
|
||||
ZFS is set up with one pool and dataset per partition.
|
||||
.It Cm scriptedpart Ar parameters
|
||||
Sets up disks like
|
||||
.Cm autopart
|
||||
@ -150,14 +152,16 @@ Each disk setup is specified by a three-part argument:
|
||||
.Op Ar scheme
|
||||
.Op Ar {partitions}
|
||||
.Pp
|
||||
Multiple disk setups are separated by semicolons. The
|
||||
Multiple disk setups are separated by semicolons.
|
||||
The
|
||||
.Ar disk
|
||||
argument specifies the disk on which to operate (which will be erased),
|
||||
while the
|
||||
.Ar scheme
|
||||
argument specifies the
|
||||
.Xr gpart 8
|
||||
partition scheme to apply to the disk. If
|
||||
partition scheme to apply to the disk.
|
||||
If
|
||||
.Ar scheme
|
||||
is unspecified,
|
||||
.Cm scriptedpart
|
||||
@ -167,7 +171,8 @@ The
|
||||
argument is also optional and specifies how to partition
|
||||
.Ar disk .
|
||||
It consists of a comma-separated list of partitions to create enclosed in
|
||||
curly braces. Each partition declaration takes the form
|
||||
curly braces.
|
||||
Each partition declaration takes the form
|
||||
.Pp
|
||||
.Ar size
|
||||
.Ar type
|
||||
@ -178,15 +183,17 @@ specifies the partition size to create in bytes (K, M, and G suffixes
|
||||
can be appended to specify kilobytes, megabytes, and gigabytes respectively),
|
||||
while the
|
||||
.Em auto
|
||||
keyword causes the partition to take all the remaining space on the disk. The
|
||||
keyword causes the partition to take all the remaining space on the disk.
|
||||
The
|
||||
.Ar type
|
||||
option chooses the
|
||||
.Xr gpart 8
|
||||
filesystem type (e.g. freebsd-ufs, freebsd-zfs, or freebsd-swap).
|
||||
filesystem type, e.g., freebsd-ufs, freebsd-zfs, or freebsd-swap.
|
||||
The optional
|
||||
.Ar mount point
|
||||
argument sets where the created partition is to be mounted in the installed
|
||||
system. As an example, a typical invocation looks like:
|
||||
system.
|
||||
As an example, a typical invocation looks like:
|
||||
.Pp
|
||||
bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
|
||||
.Pp
|
||||
@ -238,37 +245,43 @@ Reads a small amount of data from
|
||||
.Pa /dev/random
|
||||
and stores it in a file in the new system's root directory.
|
||||
.It Cm config
|
||||
Installs the configuration files destined for the new system (e.g. rc.conf
|
||||
Installs the configuration files destined for the new system, e.g.,
|
||||
.Xr rc.conf 5
|
||||
fragments generated by
|
||||
.Cm netconfig ,
|
||||
etc.) onto the new system.
|
||||
.El
|
||||
.Sh ENVIRONMENT VARIABLES
|
||||
The following environment variables control various aspects of the installation
|
||||
process. Many are used internally during installation and have reasonable
|
||||
default values for most installation scenarios. Others are set by various
|
||||
interactive user prompts, and can be usefully overridden when making scripted
|
||||
or customized installers.
|
||||
process.
|
||||
Many are used internally during installation and have reasonable default values
|
||||
for most installation scenarios.
|
||||
Others are set by various interactive user prompts, and can be usefully
|
||||
overridden when making scripted or customized installers.
|
||||
.Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
|
||||
.It Ev DISTRIBUTIONS
|
||||
The set of distributions to install (e.g. "base kernel ports"). Default: none
|
||||
The set of distributions to install, e.g., "base kernel ports".
|
||||
Default: none
|
||||
.It Ev BSDINSTALL_DISTDIR
|
||||
The directory in which the distribution files can be found (or to which they
|
||||
should be downloaded). Default:
|
||||
should be downloaded).
|
||||
Default:
|
||||
.Pa /usr/freebsd-dist
|
||||
.It Ev BSDINSTALL_DISTSITE
|
||||
URL from which the distribution files should be downloaded if they are not
|
||||
already present in the directory defined by
|
||||
.Ev BSDINSTALL_DISTDIR .
|
||||
This should be a full path to the files, including architecture and release
|
||||
names. Most targets (e.g.
|
||||
names.
|
||||
Most targets, e.g.,
|
||||
.Cm auto
|
||||
and
|
||||
.Cm jail )
|
||||
.Cm jail ,
|
||||
that prompt for a
|
||||
.Fx
|
||||
mirror will skip that step if this variable is already defined in the
|
||||
environment. Example:
|
||||
environment.
|
||||
Example:
|
||||
.Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
|
||||
.It Ev BSDINSTALL_CHROOT
|
||||
The directory into which the distribution files should be unpacked and the
|
||||
@ -276,23 +289,26 @@ directory at which the root file system of the new system should be mounted.
|
||||
Default:
|
||||
.Pa /mnt
|
||||
.It Ev BSDINSTALL_LOG
|
||||
Path to a log file for the installation. Default:
|
||||
Path to a log file for the installation.
|
||||
Default:
|
||||
.Pa /tmp/bsdinstall_log
|
||||
.It Ev BSDINSTALL_TMPETC
|
||||
Directory where files destined for the new system's
|
||||
.Pa /etc
|
||||
will be stored until the
|
||||
.Cm config
|
||||
target is executed. If this directory does not already exist, it will be
|
||||
created. Default:
|
||||
target is executed.
|
||||
If this directory does not already exist, it will be created.
|
||||
Default:
|
||||
.Pa /tmp/bsdinstall_etc
|
||||
.It Ev BSDINSTALL_TMPBOOT
|
||||
Directory where files destined for the new system's
|
||||
.Pa /boot
|
||||
will be stored until the
|
||||
.Cm config
|
||||
target is executed. If this directory does not already exist, it will be
|
||||
created. Default:
|
||||
target is executed.
|
||||
If this directory does not already exist, it will be created.
|
||||
Default:
|
||||
.Pa /tmp/bsdinstall_boot
|
||||
.El
|
||||
.Sh SCRIPTING
|
||||
@ -307,8 +323,9 @@ a shell script run under
|
||||
.Xr chroot 8
|
||||
in the newly installed system before
|
||||
.Nm
|
||||
exits. The two parts are separated by the usual script header (#!), which
|
||||
also sets the interpreter for the setup script.
|
||||
exits.
|
||||
The two parts are separated by the usual script header (#!), which also sets
|
||||
the interpreter for the setup script.
|
||||
.Pp
|
||||
A typical bsdinstall script looks like this:
|
||||
.Bd -literal -offset indent
|
||||
@ -326,19 +343,21 @@ On
|
||||
release media, such a script placed at
|
||||
.Pa /etc/installerconfig
|
||||
will be run at boot time and the system will be rebooted automatically after
|
||||
the installation has completed. This can be used for unattended network
|
||||
installation of new systems; see
|
||||
the installation has completed.
|
||||
This can be used for unattended network installation of new systems; see
|
||||
.Xr diskless 8
|
||||
for details.
|
||||
.Ss PREAMBLE
|
||||
The preamble consists of installer settings. These control global installation
|
||||
parameters (see
|
||||
The preamble consists of installer settings.
|
||||
These control global installation parameters (see
|
||||
.Sx ENVIRONMENT VARIABLES )
|
||||
as well as disk partitioning. The preamble is interpreted as a
|
||||
as well as disk partitioning.
|
||||
The preamble is interpreted as a
|
||||
.Xr sh 1
|
||||
script run at the very beginning of the install. If more complicated behavior
|
||||
than setting these variables is desired, arbitrary commands can be run here
|
||||
to extend the installer. In addition to the variables in
|
||||
script run at the very beginning of the install.
|
||||
If more complicated behavior than setting these variables is desired,
|
||||
arbitrary commands can be run here to extend the installer.
|
||||
In addition to the variables in
|
||||
.Sx ENVIRONMENT VARIABLES ,
|
||||
in particular
|
||||
.Ev DISTRIBUTIONS ,
|
||||
@ -358,13 +377,14 @@ instead of
|
||||
.Ev PARTITIONS .
|
||||
.Ss SETUP SCRIPT
|
||||
Following the preamble is an optional shell script, beginning with a #!
|
||||
declaration. This script will be run at the end of the installation process
|
||||
inside a
|
||||
declaration.
|
||||
This script will be run at the end of the installation process inside a
|
||||
.Xr chroot 8
|
||||
environment in the newly installed system and can be used to set up
|
||||
configuration files, install packages, etc. Note that newly configured
|
||||
system services (e.g. networking) have not been started in the installed
|
||||
system at this time and only installation host services are available.
|
||||
configuration files, install packages, etc.
|
||||
Note that newly configured system services, e.g., networking have not
|
||||
been started in the installed system at this time and only installation
|
||||
host services are available.
|
||||
.Sh HISTORY
|
||||
This version of
|
||||
.Nm
|
||||
|
||||
Loading…
Reference in New Issue
Block a user