sys/boot/forth/loader.conf.5

   1 .\" Copyright (c) 1999 Daniel C. Sobral
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd July 20, 2011
  27 .Dt LOADER.CONF 5
  28 .Os
  29 .Sh NAME
  30 .Nm loader.conf
  31 .Nd "system bootstrap configuration information"
  32 .Sh DESCRIPTION
  33 The file
  34 .Nm
  35 contains descriptive information on bootstrapping the system.
  36 Through
  37 it you can specify the kernel to be booted, parameters to be passed to
  38 it, and additional modules to be loaded; and generally set all variables
  39 described in
  40 .Xr loader 8 .
  41 .Pp
  42 The file
  43 .Pa /boot/loader.rc
  44 must contain the following two lines for
  45 .Nm
  46 to be automatically processed:
  47 .Pp
  48 .Dl include /boot/loader.4th
  49 .Dl start
  50 .Pp
  51 If no
  52 .Pa /boot/loader.rc
  53 exists at installworld time, one with the above lines will be installed.
  54 .Sh SYNTAX
  55 Though
  56 .Nm Ns 's
  57 format was defined explicitly to resemble
  58 .Xr rc.conf 5 ,
  59 and can be sourced by
  60 .Xr sh 1 ,
  61 some settings are treated in a special fashion.
  62 Also, the
  63 behavior of some settings is defined by the setting's suffix;
  64 the prefix identifies which module the setting controls.
  65 .Pp
  66 The general parsing rules are:
  67 .Bl -bullet
  68 .It
  69 Spaces and empty lines are ignored.
  70 .It
  71 A # sign will mark the remainder of the line as a comment.
  72 .It
  73 Only one setting can be present on each line.
  74 .El
  75 .Pp
  76 All settings have the following format:
  77 .Pp
  78 .Dl variable="value"
  79 .Pp
  80 Unless it belongs to one of the classes of settings that receive special
  81 treatment, a setting will set the value of a
  82 .Xr loader 8
  83 environment variable.
  84 The settings that receive special
  85 treatment are listed below.
  86 Settings beginning with
  87 .Qq *
  88 below define the modules to be loaded and
  89 may have any prefix; the prefix identifies a module.
  90 All such settings sharing a common
  91 prefix refer to the same module.
  92 .Bl -tag -width Ar
  93 .It Ar exec
  94 Immediately executes a
  95 .Xr loader 8
  96 command.
  97 This type of setting cannot be processed by programs other
  98 than
  99 .Xr loader 8 ,
 100 so its use should be avoided.
 101 Multiple instances of it will be processed
 102 independently.
 103 .It Ar loader_conf_files
 104 Defines additional configuration files to be processed right after the
 105 present file.
 106 .It Ar kernel
 107 Name of the kernel to be loaded.
 108 If no kernel name is set, no additional
 109 modules will be loaded.
 110 The name must be a subdirectory of
 111 .Pa /boot
 112 that contains a kernel.
 113 .It Ar kernel_options
 114 Flags to be passed to the kernel.
 115 .It Ar password
 116 Provides a password to be required by check-password before execution is
 117 allowed to continue.
 118 .It Ar verbose_loading
 119 If set to
 120 .Dq YES ,
 121 module names will be displayed as they are loaded.
 122 .It Ar *_load
 123 If set to
 124 .Dq YES ,
 125 that module will be loaded.
 126 If no name is defined (see below), the
 127 module's name is taken to be the same as the prefix.
 128 .It Ar *_name
 129 Defines the name of the module.
 130 .It Ar *_type
 131 Defines the module's type.
 132 If none is given, it defaults to a kld module.
 133 .It Ar *_flags
 134 Flags and parameters to be passed to the module.
 135 .It Ar *_before
 136 Commands to be executed before the module is loaded.
 137 Use of this setting
 138 should be avoided.
 139 .It Ar *_after
 140 Commands to be executed after the module is loaded.
 141 Use of this setting
 142 should be avoided.
 143 .It Ar *_error
 144 Commands to be executed if the loading of a module fails.
 145 Except for the
 146 special value
 147 .Dq abort ,
 148 which aborts the bootstrap process, use of this setting should be avoided.
 149 .El
 150 .Pp
 151 .Em WARNING:
 152 developers should never use these suffixes for any kernel environment
 153 variables (tunables) or conflicts will result.
 154 .Sh DEFAULT SETTINGS
 155 Most of
 156 .Nm Ns 's
 157 default settings can be ignored.
 158 The few of them which are important
 159 or useful are:
 160 .Bl -tag -width bootfile -offset indent
 161 .It Va bitmap_load
 162 .Pq Dq NO
 163 If set to
 164 .Dq YES ,
 165 a bitmap will be loaded to be displayed on screen while booting.
 166 .It Va bitmap_name
 167 .Pq Dq Pa /boot/splash.bmp
 168 Name of the bitmap to be loaded.
 169 Any other name can be used.
 170 .It Va comconsole_speed
 171 .Dq ( 9600
 172 or the value of the
 173 .Va BOOT_COMCONSOLE_SPEED
 174 variable when
 175 .Xr loader 8
 176 was compiled).
 177 Sets the speed of the serial console.
 178 If the previous boot loader stage specified that a serial console
 179 is in use then the default speed is determined from the current
 180 serial port speed setting.
 181 .It Va console
 182 .Pq Dq vidconsole
 183 .Dq comconsole
 184 selects serial console,
 185 .Dq vidconsole
 186 selects the video console,
 187 .Dq nullconsole
 188 selects a mute console
 189 (useful for systems with neither a video console nor a serial port), and
 190 .Dq spinconsole
 191 selects the video console which prevents any input and hides all output
 192 replacing it with
 193 .Dq spinning
 194 character (useful for embedded products and such).
 195 .It Va kernel
 196 .Pq Dq kernel
 197 .It Va loader_conf_files
 198 .Pq Dq Pa /boot/loader.conf /boot/loader.conf.local
 199 .It Va splash_bmp_load
 200 .Pq Dq NO
 201 If set to
 202 .Dq YES ,
 203 will load the splash screen module, making it possible to display a bmp image
 204 on the screen while booting.
 205 .It Va splash_pcx_load
 206 .Pq Dq NO
 207 If set to
 208 .Dq YES ,
 209 will load the splash screen module, making it possible to display a pcx image
 210 on the screen while booting.
 211 .It Va vesa_load
 212 .Pq Dq NO
 213 If set to
 214 .Dq YES ,
 215 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 216 be displayed.
 217 .It Va beastie_disable
 218 If set to
 219 .Dq YES ,
 220 the beastie boot menu will be skipped.
 221 .It Va loader_logo Pq Dq Li orbbw
 222 Selects a desired logo in the beastie boot menu.
 223 Possible values are:
 224 .Dq Li orbbw ,
 225 .Dq Li orb ,
 226 .Dq Li fbsdbw ,
 227 .Dq Li beastiebw ,
 228 .Dq Li beastie ,
 229 and
 230 .Dq Li none .
 231 .It Va loader_color
 232 If set to
 233 .Dq YES ,
 234 the beastie boot menu will be displayed using ANSI coloring where possible.
 235 .El
 236 .Sh FILES
 237 .Bl -tag -width /boot/defaults/loader.conf -compact
 238 .It Pa /boot/defaults/loader.conf
 239 default settings -- do not change this file.
 240 .It Pa /boot/loader.4th
 241 defines the commands used by loader to read and process
 242 .Nm .
 243 .It Pa /boot/loader.conf
 244 user defined settings.
 245 .It Pa /boot/loader.conf.local
 246 machine-specific settings for sites with a common loader.conf.
 247 .It Pa /boot/loader.rc
 248 contains the instructions to automatically process
 249 .Nm .
 250 .El
 251 .Sh SEE ALSO
 252 .Xr boot 8 ,
 253 .Xr loader 8 ,
 254 .Xr loader.4th 8
 255 .Sh HISTORY
 256 The file
 257 .Nm
 258 first appeared in
 259 .Fx 3.2 .
 260 .Sh AUTHORS
 261 This manual page was written by
 262 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
 263 .Sh BUGS
 264 The
 265 .Xr loader 8
 266 stops reading
 267 .Nm
 268 when it encounters a syntax error, so any options which are vital for
 269 booting a particular system (i.e.\&
 270 .Dq Va hw.ata.ata_dma Ns "=0" )
 271 should precede any experimental additions to
 272 .Nm .