2 .\" Copyright (c) 2011-2013 Nathan Whitehorn <nwhitehorn@FreeBSD.org>
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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.
41 is used for installation of new systems, both for system setup from
42 installation media (e.g. CD-ROMs) and for use on live systems to prepare
47 takes a target and possible parameters of the target as arguments. If
48 invoked with no arguments, it will invoke the
50 target, which provides a standard interactive installation, invoking the
51 others in sequence. To perform a scripted installation, these subtargets
52 can be invoked separately by an installation script.
55 supports the following options, global to all targets:
56 .Bl -tag -width indent+
58 Provide a path for the installation log file
59 .Pq overrides Ev BSDINSTALL_LOG .
61 .Sx ENVIRONMENT VARIABLES
62 for more information on
66 Most of the following targets are only useful for scripting the installer.
67 For interactive use, most users will be interested only in the
73 .Bl -tag -width ".Cm jail Ar destination"
75 Run the standard interactive installation, including disk partitioning.
77 Reads a small amount of data from
79 and stores it in a file in the new system's root directory.
80 .It Cm jail Ar destination
81 Sets up a new chroot system at
85 Behavior is generally similar to
87 except that disk partitioning and network setup are skipped and a kernel is
88 not installed into the new system.
89 .It Cm script Ar script
90 Runs the installation script at
94 for more information on this target.
96 If the current controlling TTY is a
100 console, asks the user to set the current keymap, and saves the result to the
104 Prompts the user for a host name for the new system and saves the result to the
108 .Ev BSDINSTALL_CONFIGCURRENT
109 is set, also sets the host name of the current system.
111 Interactively configures network interfaces (first invoking
113 on wireless interfaces), saving the result to the new system's
118 .Ev BSDINSTALL_CONFIGCURRENT
119 is set, also configures the network interfaces of the current system to match.
121 Provides the installer's interactive guided disk partitioner for single-disk
122 installations. Partitions disks, runs
124 and writes the new system's
127 Provides the installer's
129 interactive/scriptable ZFS partitioner for multi-disk installations.
132 with datasets and writes to the new system's
140 and many other features.
142 Provides the installer's interactive manual disk partitioner, with support
143 for multi disk setups, non-UFS file systems, and manual selection of
144 partition schemes. Partitions disks, runs
146 and writes the new system's
148 .It Cm scriptedpart Ar parameters
153 but non-interactively according to the disk setup specified in
155 Each disk setup is specified by a three-part argument:
161 Multiple disk setups are separated by semicolons. The
163 argument specifies the disk on which to operate (which will be erased),
166 argument specifies the
168 partition scheme to apply to the disk. If
172 will apply the default bootable scheme on your platform.
175 argument is also optional and specifies how to partition
177 It consists of a comma-separated list of partitions to create enclosed in
178 curly braces. Each partition declaration takes the form
185 specifies the partition size to create in bytes (K, M, and G suffixes
186 can be appended to specify kilobytes, megabytes, and gigabytes respectively),
189 keyword causes the partition to take all the remaining space on the disk. The
193 filesystem type (e.g. freebsd-ufs or freebsd-swap).
196 argument sets where the created partition is to be mounted in the installed
197 system. As an example, a typical invocation looks like:
199 bsdinstall scriptedpart ada0 { 20G freebsd-ufs /, 4G freebsd-swap, 20G freebsd-ufs /var, auto freebsd-ufs /usr }
201 Mounts the file systems previously configured by
207 .Ev BSDINSTALL_CHROOT .
209 Fetches the distributions in
212 .Ev BSDINSTALL_DISTDIR
214 .Ev BSDINSTALL_DISTSITE .
216 Verifies the checksums of the distributions listed in
218 against the distribution manifest.
220 Extracts the distributions listed in
223 .Ev BSDINSTALL_CHROOT .
225 Interactively invokes
227 in the new system to set the root user's password.
229 Interactively invokes
233 Interactively sets the time, date, and time zone of the new system.
235 Queries the user for the system daemons to begin at system startup,
236 writing the result into the new system's
239 Installs the configuration files destined for the new system (e.g. rc.conf
240 fragments generated by
242 etc.) onto the new system.
244 .Sh ENVIRONMENT VARIABLES
245 The following environment variables control various aspects of the installation
246 process. Many are used internally during installation and have reasonable
247 default values for most installation scenarios. Others are set by various
248 interactive user prompts, and can be usefully overridden when making scripted
249 or customized installers.
250 .Bl -tag -width ".Ev BSDINSTALL_DISTSITE"
252 The set of distributions to install (e.g. "base kernel ports"). Default: none
253 .It Ev BSDINSTALL_DISTDIR
254 The directory in which the distribution files can be found (or to which they
255 should be downloaded). Default:
256 .Pa /usr/freebsd-dist
257 .It Ev BSDINSTALL_DISTSITE
258 URL from which the distribution files should be downloaded if they are not
259 already present in the directory defined by
260 .Ev BSDINSTALL_DISTDIR .
261 This should be a full path to the files, including architecture and release
262 names. Most targets (e.g.
268 mirror will skip that step if this variable is already defined in the
269 environment. Example:
270 .Pa ftp://ftp.freebsd.org/pub/FreeBSD/releases/powerpc/powerpc64/9.1-RELEASE
271 .It Ev BSDINSTALL_CHROOT
272 The directory into which the distribution files should be unpacked and the
273 directory at which the root file system of the new system should be mounted.
276 .It Ev BSDINSTALL_LOG
277 Path to a log file for the installation. Default:
278 .Pa /tmp/bsdinstall_log
279 .It Ev BSDINSTALL_TMPETC
280 Directory where files destined for the new system's
282 will be stored until the
284 target is executed. If this directory does not already exist, it will be
286 .Pa /tmp/bsdinstall_etc
287 .It Ev BSDINSTALL_TMPBOOT
288 Directory where files destined for the new system's
290 will be stored until the
292 target is executed. If this directory does not already exist, it will be
294 .Pa /tmp/bsdinstall_boot
298 scripts consist of two parts: a
302 The preamble sets up the options for the installation (how to partition the
303 disk[s], which distributions to install, etc.) and the optional second part is
304 a shell script run under
306 in the newly installed system before
308 exits. The two parts are separated by the usual script header (#!), which
309 also sets the interpreter for the setup script.
311 A typical bsdinstall script looks like this:
312 .Bd -literal -offset indent
314 DISTRIBUTIONS="kernel.txz base.txz"
317 echo "ifconfig_em0=DHCP" >> /etc/rc.conf
318 echo "sshd_enable=YES" >> /etc/rc.conf
324 release media, such a script placed at
325 .Pa /etc/installerconfig
326 will be run at boot time and the system will be rebooted automatically after
327 the installation has completed. This can be used for unattended network
328 installation of new systems; see
332 The preamble consists of installer settings. These control global installation
334 .Sx ENVIRONMENT VARIABLES )
335 as well as disk partitioning. The preamble is interpreted as a
337 script run at the very beginning of the install. If more complicated behavior
338 than setting these variables is desired, arbitrary commands can be run here
339 to extend the installer. In addition to the variables in
340 .Sx ENVIRONMENT VARIABLES ,
343 the preamble can contain a variable
345 which is passed to the
347 target to control disk setup.
351 the preamble can contain the variable
353 which is parsed by the
356 target to control ZFS datasets/options of the boot pool setup.
358 Following the preamble is an optional shell script, beginning with a #!
359 declaration. This script will be run at the end of the installation process
362 environment in the newly installed system and can be used to set up
363 configuration files, install packages, etc. Note that newly configured
364 system services (e.g. networking) have not been started in the installed
365 system at this time and only installation host services are available.
373 .An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org