1.\"-
2.\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org>
3.\" All rights reserved.
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 unchanged lines hidden (view full) ---
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.\" $FreeBSD: stable/10/usr.sbin/bsdinstall/bsdinstall.8 258421 2013-11-21 03:40:52Z dteske $
27.\"
28.Dd October 15, 2013
29.Dt BSDINSTALL 8
30.Os
31.Sh NAME
32.Nm bsdinstall
33.Nd system installer
34.Sh SYNOPSIS
35.Nm
36.Op Ar options
37.Op Ar target
38.Op Ar ...
39.Sh DESCRIPTION
40.Nm
41is used for installation of new systems, both for system setup from
42installation media (e.g. CD-ROMs) and for use on live systems to prepare
43VM images and jails.
44.Pp
45Much like
46.Xr make 1 , Nm
47takes a target and possible parameters of the target as arguments. If
48invoked with no arguments, it will invoke the
49.Cm auto
50target, which provides a standard interactive installation, invoking the
51others in sequence. To perform a scripted installation, these subtargets
52can be invoked separately by an installation script.
53.Sh OPTIONS
54.Nm
55supports the following options, global to all targets:
56.Bl -tag -width indent+
57.It Fl D Ar file
58Provide a path for the installation log file
59.Pq overrides Ev BSDINSTALL_LOG .
60See
61.Sx ENVIRONMENT VARIABLES
62for more information on
63.Ev BSDINSTALL_LOG .
64.El
65.Sh TARGETS
66Most of the following targets are only useful for scripting the installer.
67For interactive use, most users will be interested only in the
68.Cm auto ,
69.Cm jail ,
70and
71.Cm script
72targets.
--- 43 unchanged lines hidden (view full) ---
116.Ev BSDINSTALL_CONFIGCURRENT
117is set, also configures the network interfaces of the current system to match.
118.It Cm autopart
119Provides the installer's interactive guided disk partitioner for single-disk
120installations. Partitions disks, runs
121.Xr newfs 8 ,
122and writes the new system's
123.Pa fstab .
124.It Cm zfsboot
125Provides the installer's
126.Pq experimental
127interactive/scriptable ZFS partitioner for multi-disk installations.
128Creates a single
129.Ic zpool
130with datasets and writes to the new system's
131.Pa rc.conf ,
132.Pa loader.conf ,
133and
134.Pa fstab .
135Supports
136.Xr geli 8 ,
137.Xr gnop 8 ,
138and many other features.
139.It Cm partedit
140Provides the installer's interactive manual disk partitioner, with support
141for multi disk setups, non-UFS file systems, and manual selection of
142partition schemes. Partitions disks, runs
143.Xr newfs 8 ,
144and writes the new system's
145.Pa fstab .
146.It Cm scriptedpart Ar parameters
--- 191 unchanged lines hidden (view full) ---
338.Sx ENVIRONMENT VARIABLES ,
339in particular
340.Ev DISTRIBUTIONS ,
341the preamble can contain a variable
342.Ev PARTITIONS
343which is passed to the
344.Cm scriptedpart
345target to control disk setup.
346Alternatively,
347instead of
348.Ev PARTITIONS ,
349the preamble can contain the variable
350.Ev ZFSBOOT_DATASETS
351which is parsed by the
352.Pq experimental
353.Cm zfsboot
354target to control ZFS datasets/options of the boot pool setup.
355.Ss SETUP SCRIPT
356Following the preamble is an optional shell script, beginning with a #!
357declaration. This script will be run at the end of the installation process
358inside a
359.Xr chroot 8
360environment in the newly installed system and can be used to set up
361configuration files, install packages, etc. Note that newly configured
362system services (e.g. networking) have not been started in the installed
363system at this time and only installation host services are available.
364.Sh HISTORY
365This version of
366.Nm
367first appeared in
368.Fx 9.0 .
369.Sh AUTHORS
370.An -nosplit
371.An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org
2.\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org>
3.\" All rights reserved.
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 unchanged lines hidden (view full) ---
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.\" $FreeBSD: stable/10/usr.sbin/bsdinstall/bsdinstall.8 258421 2013-11-21 03:40:52Z dteske $
27.\"
28.Dd October 15, 2013
29.Dt BSDINSTALL 8
30.Os
31.Sh NAME
32.Nm bsdinstall
33.Nd system installer
34.Sh SYNOPSIS
35.Nm
36.Op Ar options
37.Op Ar target
38.Op Ar ...
39.Sh DESCRIPTION
40.Nm
41is used for installation of new systems, both for system setup from
42installation media (e.g. CD-ROMs) and for use on live systems to prepare
43VM images and jails.
44.Pp
45Much like
46.Xr make 1 , Nm
47takes a target and possible parameters of the target as arguments. If
48invoked with no arguments, it will invoke the
49.Cm auto
50target, which provides a standard interactive installation, invoking the
51others in sequence. To perform a scripted installation, these subtargets
52can be invoked separately by an installation script.
53.Sh OPTIONS
54.Nm
55supports the following options, global to all targets:
56.Bl -tag -width indent+
57.It Fl D Ar file
58Provide a path for the installation log file
59.Pq overrides Ev BSDINSTALL_LOG .
60See
61.Sx ENVIRONMENT VARIABLES
62for more information on
63.Ev BSDINSTALL_LOG .
64.El
65.Sh TARGETS
66Most of the following targets are only useful for scripting the installer.
67For interactive use, most users will be interested only in the
68.Cm auto ,
69.Cm jail ,
70and
71.Cm script
72targets.
--- 43 unchanged lines hidden (view full) ---
116.Ev BSDINSTALL_CONFIGCURRENT
117is set, also configures the network interfaces of the current system to match.
118.It Cm autopart
119Provides the installer's interactive guided disk partitioner for single-disk
120installations. Partitions disks, runs
121.Xr newfs 8 ,
122and writes the new system's
123.Pa fstab .
124.It Cm zfsboot
125Provides the installer's
126.Pq experimental
127interactive/scriptable ZFS partitioner for multi-disk installations.
128Creates a single
129.Ic zpool
130with datasets and writes to the new system's
131.Pa rc.conf ,
132.Pa loader.conf ,
133and
134.Pa fstab .
135Supports
136.Xr geli 8 ,
137.Xr gnop 8 ,
138and many other features.
139.It Cm partedit
140Provides the installer's interactive manual disk partitioner, with support
141for multi disk setups, non-UFS file systems, and manual selection of
142partition schemes. Partitions disks, runs
143.Xr newfs 8 ,
144and writes the new system's
145.Pa fstab .
146.It Cm scriptedpart Ar parameters
--- 191 unchanged lines hidden (view full) ---
338.Sx ENVIRONMENT VARIABLES ,
339in particular
340.Ev DISTRIBUTIONS ,
341the preamble can contain a variable
342.Ev PARTITIONS
343which is passed to the
344.Cm scriptedpart
345target to control disk setup.
346Alternatively,
347instead of
348.Ev PARTITIONS ,
349the preamble can contain the variable
350.Ev ZFSBOOT_DATASETS
351which is parsed by the
352.Pq experimental
353.Cm zfsboot
354target to control ZFS datasets/options of the boot pool setup.
355.Ss SETUP SCRIPT
356Following the preamble is an optional shell script, beginning with a #!
357declaration. This script will be run at the end of the installation process
358inside a
359.Xr chroot 8
360environment in the newly installed system and can be used to set up
361configuration files, install packages, etc. Note that newly configured
362system services (e.g. networking) have not been started in the installed
363system at this time and only installation host services are available.
364.Sh HISTORY
365This version of
366.Nm
367first appeared in
368.Fx 9.0 .
369.Sh AUTHORS
370.An -nosplit
371.An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org