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