usr.sbin/bsdinstall/bsdinstall.8

   1 .\"-
   2 .\" Copyright (c) 2011 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 .\"    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.
  13 .\"
  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.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 11, 2011
  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
  40 is used for installation of new systems, both for system setup from
  41 installation media (e.g. CD-ROMs) and for use on live systems to prepare
  42 VM images and jails.
  43 .Pp
  44 Much like
  45 .Xr make 1 , Nm
  46 takes a target and possible parameters of the target as arguments. If
  47 invoked with no arguments, it will invoke the
  48 .Cm auto
  49 target, which provides a standard interactive installation, invoking the
  50 others in sequence. To perform a scripted installation, these subtargets
  51 can be invoked separately by an installation script.
  52 .Sh TARGETS
  53 Most of the following targets are only useful for scripting the installer.
  54 For interactive use, most users will be interested only in the
  55 .Cm auto
  56 and
  57 .Cm jail
  58 targets.
  59 .Bl -tag -width ".Cm jail Ar destination"
  60 .It Cm auto
  61 Run the standard interactive installation, including disk partitioning.
  62 .It Cm jail Ar destination
  63 Sets up a new chroot system at
  64 .Pa destination ,
  65 suitable for use with
  66 .Xr jail 8 .
  67 Behavior is generally similar to
  68 .Cm auto ,
  69 except that disk partitioning and network setup are skipped and a kernel is
  70 not installed into the new system.
  71 .It Cm keymap
  72 If the current controlling TTY is a
  73 .Xr syscons 4
  74 console, asks the user to set the current keymap, and saves the result to the
  75 new system's
  76 .Pa rc.conf .
  77 .It Cm hostname
  78 Prompts the user for a host name for the new system and saves the result to the
  79 new system's
  80 .Pa rc.conf .
  81 If
  82 .Ev BSDINSTALL_CONFIGCURRENT
  83 is set, also sets the host name of the current system.
  84 .It Cm netconfig
  85 Interactively configures network interfaces (first invoking
  86 .Cm wlanconfig
  87 on wireless interfaces), saving the result to the new system's
  88 .Pa rc.conf
  89 and
  90 .Pa resolv.conf .
  91 If
  92 .Ev BSDINSTALL_CONFIGCURRENT
  93 is set, also configures the network interfaces of the current system to match.
  94 .It Cm autopart
  95 Provides the installer's interactive guided disk partitioner for single-disk
  96 installations. Partitions disks, runs
  97 .Xr newfs 8 ,
  98 and writes the new system's
  99 .Pa fstab .
 100 .It Cm partedit
 101 Provides the installer's interactive manual disk partitioner, with support
 102 for multi disk setups, non-UFS file systems, and manual selection of
 103 partition schemes. Partitions disks, runs
 104 .Xr newfs 8 ,
 105 and writes the new system's
 106 .Pa fstab .
 107 .It Cm mount
 108 Mounts the file systems previously configured by
 109 .Cm autopart
 110 or
 111 .Cm partedit
 112 under
 113 .Ev BSDINSTALL_CHROOT .
 114 .It Cm distfetch
 115 Fetches the distributions in
 116 .Ev DISTRIBUTIONS
 117 to
 118 .Ev BSDINSTALL_DISTDIR
 119 from
 120 .Ev BSDINSTALL_DISTSITE .
 121 .It Cm checksum
 122 Verifies the checksums of the distributions listed in
 123 .Ev DISTRIBUTIONS
 124 against the distribution manifest.
 125 .It Cm distextract
 126 Extracts the distributions listed in
 127 .Ev DISTRIBUTIONS
 128 into
 129 .Ev BSDINSTALL_CHROOT .
 130 .It Cm rootpass
 131 Interactively invokes
 132 .Xr passwd 1
 133 in the new system to set the root user's password.
 134 .It Cm adduser
 135 Interactively invokes
 136 .Xr adduser 8
 137 in the new system.
 138 .It Cm time
 139 Interactively sets the time, date, and time zone of the new system.
 140 .It Cm services
 141 Queries the user for the system daemons to begin at system startup,
 142 writing the result into the new system's
 143 .Pa rc.conf .
 144 .It Cm config
 145 Installs the configuration files destined for the new system (e.g. rc.conf
 146 fragments generated by
 147 .Cm netconfig ,
 148 etc.) onto the new system.
 149 .El
 150 .Sh ENVIRONMENT VARIABLES
 151 The following environment variables control various aspects of the installation
 152 process. Many are used internally during installation and have reasonable
 153 default values for most installation scenarios. Others are set by various
 154 interactive user prompts, and can be usefully overridden when making scripted
 155 or customized installers.
 156 .Bl -tag -width ".Ev BSDINSTALL_DISTDIR"
 157 .It Ev DISTRIBUTIONS
 158 The set of distributions to install (e.g. "base kernel ports"). Default: none
 159 .It Ev BSDINSTALL_DISTDIR
 160 The directory in which the distribution files can be found (or to which they
 161 should be downloaded). Default:
 162 .Pa /usr/freebsd-dist
 163 .It Ev BSDINSTALL_CHROOT
 164 The directory into which the distribution files should be unpacked and the
 165 directory at which the root file system of the new system should be mounted.
 166 Default:
 167 .Pa /mnt
 168 .It Ev BSDINSTALL_LOG
 169 Path to a log file for the installation. Default:
 170 .Pa /tmp/bsdinstall_log
 171 .It Ev BSDINSTALL_TMPETC
 172 Directory where files destined for the new system's
 173 .Pa /etc
 174 will be stored until the
 175 .Cm config
 176 target is executed. If this directory does not already exist, it will be
 177 created. Default:
 178 .Pa /tmp/bsdinstall_etc
 179 .El
 180 .Sh HISTORY
 181 This version of
 182 .Nm
 183 first appeared in
 184 .Fx 9.0 .
 185 .Sh AUTHORS
 186 .An -nosplit
 187 .An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org