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 256719 2013-10-18 07:42:50Z dteske $
27.\"
28.Dd October 6, 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 target
37.Op Ar ...
38.Sh DESCRIPTION
39.Nm
40is used for installation of new systems, both for system setup from
41installation media (e.g. CD-ROMs) and for use on live systems to prepare
42VM images and jails.
43.Pp
44Much like
45.Xr make 1 , Nm
46takes a target and possible parameters of the target as arguments. If
47invoked with no arguments, it will invoke the
48.Cm auto
49target, which provides a standard interactive installation, invoking the
50others in sequence. To perform a scripted installation, these subtargets
51can be invoked separately by an installation script.
52.Sh TARGETS
53Most of the following targets are only useful for scripting the installer.
54For interactive use, most users will be interested only in the
55.Cm auto ,
56.Cm jail ,
57and
58.Cm script
59targets.
--- 43 unchanged lines hidden (view full) ---
103.Ev BSDINSTALL_CONFIGCURRENT
104is set, also configures the network interfaces of the current system to match.
105.It Cm autopart
106Provides the installer's interactive guided disk partitioner for single-disk
107installations. Partitions disks, runs
108.Xr newfs 8 ,
109and writes the new system's
110.Pa fstab .
111.It Cm partedit
112Provides the installer's interactive manual disk partitioner, with support
113for multi disk setups, non-UFS file systems, and manual selection of
114partition schemes. Partitions disks, runs
115.Xr newfs 8 ,
116and writes the new system's
117.Pa fstab .
118.It Cm scriptedpart Ar parameters
--- 191 unchanged lines hidden (view full) ---
310.Sx ENVIRONMENT VARIABLES ,
311in particular
312.Ev DISTRIBUTIONS ,
313the preamble can contain a variable
314.Ev PARTITIONS
315which is passed to the
316.Cm scriptedpart
317target to control disk setup.
318.Ss SETUP SCRIPT
319Following the preamble is an optional shell script, beginning with a #!
320declaration. This script will be run at the end of the installation process
321inside a
322.Xr chroot 8
323environment in the newly installed system and can be used to set up
324configuration files, install packages, etc. Note that newly configured
325system services (e.g. networking) have not been started in the installed
326system at this time and only installation host services are available.
327.Sh HISTORY
328This version of
329.Nm
330first appeared in
331.Fx 9.0 .
332.Sh AUTHORS
333.An -nosplit
334.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 256719 2013-10-18 07:42:50Z dteske $
27.\"
28.Dd October 6, 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 target
37.Op Ar ...
38.Sh DESCRIPTION
39.Nm
40is used for installation of new systems, both for system setup from
41installation media (e.g. CD-ROMs) and for use on live systems to prepare
42VM images and jails.
43.Pp
44Much like
45.Xr make 1 , Nm
46takes a target and possible parameters of the target as arguments. If
47invoked with no arguments, it will invoke the
48.Cm auto
49target, which provides a standard interactive installation, invoking the
50others in sequence. To perform a scripted installation, these subtargets
51can be invoked separately by an installation script.
52.Sh TARGETS
53Most of the following targets are only useful for scripting the installer.
54For interactive use, most users will be interested only in the
55.Cm auto ,
56.Cm jail ,
57and
58.Cm script
59targets.
--- 43 unchanged lines hidden (view full) ---
103.Ev BSDINSTALL_CONFIGCURRENT
104is set, also configures the network interfaces of the current system to match.
105.It Cm autopart
106Provides the installer's interactive guided disk partitioner for single-disk
107installations. Partitions disks, runs
108.Xr newfs 8 ,
109and writes the new system's
110.Pa fstab .
111.It Cm partedit
112Provides the installer's interactive manual disk partitioner, with support
113for multi disk setups, non-UFS file systems, and manual selection of
114partition schemes. Partitions disks, runs
115.Xr newfs 8 ,
116and writes the new system's
117.Pa fstab .
118.It Cm scriptedpart Ar parameters
--- 191 unchanged lines hidden (view full) ---
310.Sx ENVIRONMENT VARIABLES ,
311in particular
312.Ev DISTRIBUTIONS ,
313the preamble can contain a variable
314.Ev PARTITIONS
315which is passed to the
316.Cm scriptedpart
317target to control disk setup.
318.Ss SETUP SCRIPT
319Following the preamble is an optional shell script, beginning with a #!
320declaration. This script will be run at the end of the installation process
321inside a
322.Xr chroot 8
323environment in the newly installed system and can be used to set up
324configuration files, install packages, etc. Note that newly configured
325system services (e.g. networking) have not been started in the installed
326system at this time and only installation host services are available.
327.Sh HISTORY
328This version of
329.Nm
330first appeared in
331.Fx 9.0 .
332.Sh AUTHORS
333.An -nosplit
334.An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org