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 August 6, 2013
  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 Protect boot menu with a password without interrupting
 117 .Ic autoboot
 118 process.
 119 The password should be in clear text format.
 120 If a password is set, boot menu will not appear until any key is pressed during
 121 countdown period specified by
 122 .Va autoboot_delay
 123 variable or
 124 .Ic autoboot
 125 process fails.
 126 In both cases user should provide specified password to be able to access boot
 127 menu.
 128 .It Ar bootlock_password
 129 Provides a password to be required by check-password before execution is
 130 allowed to continue.
 131 The password should be in clear text format.
 132 If a password is set, the user must provide specified password to boot.
 133 .It Ar verbose_loading
 134 If set to
 135 .Dq YES ,
 136 module names will be displayed as they are loaded.
 137 .It Ar *_load
 138 If set to
 139 .Dq YES ,
 140 that module will be loaded.
 141 If no name is defined (see below), the
 142 module's name is taken to be the same as the prefix.
 143 .It Ar *_name
 144 Defines the name of the module.
 145 .It Ar *_type
 146 Defines the module's type.
 147 If none is given, it defaults to a kld module.
 148 .It Ar *_flags
 149 Flags and parameters to be passed to the module.
 150 .It Ar *_before
 151 Commands to be executed before the module is loaded.
 152 Use of this setting
 153 should be avoided.
 154 .It Ar *_after
 155 Commands to be executed after the module is loaded.
 156 Use of this setting
 157 should be avoided.
 158 .It Ar *_error
 159 Commands to be executed if the loading of a module fails.
 160 Except for the
 161 special value
 162 .Dq abort ,
 163 which aborts the bootstrap process, use of this setting should be avoided.
 164 .El
 165 .Pp
 166 .Em WARNING:
 167 developers should never use these suffixes for any kernel environment
 168 variables (tunables) or conflicts will result.
 169 .Sh DEFAULT SETTINGS
 170 Most of
 171 .Nm Ns 's
 172 default settings can be ignored.
 173 The few of them which are important
 174 or useful are:
 175 .Bl -tag -width bootfile -offset indent
 176 .It Va bitmap_load
 177 .Pq Dq NO
 178 If set to
 179 .Dq YES ,
 180 a bitmap will be loaded to be displayed on screen while booting.
 181 .It Va bitmap_name
 182 .Pq Dq Pa /boot/splash.bmp
 183 Name of the bitmap to be loaded.
 184 Any other name can be used.
 185 .It Va comconsole_speed
 186 .Dq ( 9600
 187 or the value of the
 188 .Va BOOT_COMCONSOLE_SPEED
 189 variable when
 190 .Xr loader 8
 191 was compiled).
 192 Sets the speed of the serial console.
 193 If the previous boot loader stage specified that a serial console
 194 is in use then the default speed is determined from the current
 195 serial port speed setting.
 196 .It Va console
 197 .Pq Dq vidconsole
 198 .Dq comconsole
 199 selects serial console,
 200 .Dq vidconsole
 201 selects the video console,
 202 .Dq nullconsole
 203 selects a mute console
 204 (useful for systems with neither a video console nor a serial port), and
 205 .Dq spinconsole
 206 selects the video console which prevents any input and hides all output
 207 replacing it with
 208 .Dq spinning
 209 character (useful for embedded products and such).
 210 .It Va kernel
 211 .Pq Dq kernel
 212 .It Va loader_conf_files
 213 .Pq Dq Pa /boot/loader.conf /boot/loader.conf.local
 214 .It Va splash_bmp_load
 215 .Pq Dq NO
 216 If set to
 217 .Dq YES ,
 218 will load the splash screen module, making it possible to display a bmp image
 219 on the screen while booting.
 220 .It Va splash_pcx_load
 221 .Pq Dq NO
 222 If set to
 223 .Dq YES ,
 224 will load the splash screen module, making it possible to display a pcx image
 225 on the screen while booting.
 226 .It Va vesa_load
 227 .Pq Dq NO
 228 If set to
 229 .Dq YES ,
 230 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 231 be displayed.
 232 .It Va beastie_disable
 233 If set to
 234 .Dq YES ,
 235 the beastie boot menu will be skipped.
 236 .It Va loader_logo Pq Dq Li orbbw
 237 Selects a desired logo in the beastie boot menu.
 238 Possible values are:
 239 .Dq Li orbbw ,
 240 .Dq Li orb ,
 241 .Dq Li fbsdbw ,
 242 .Dq Li beastiebw ,
 243 .Dq Li beastie ,
 244 and
 245 .Dq Li none .
 246 .It Va loader_color
 247 If set to
 248 .Dq NO ,
 249 the beastie boot menu will be displayed without ANSI coloring.
 250 .El
 251 .Sh FILES
 252 .Bl -tag -width /boot/defaults/loader.conf -compact
 253 .It Pa /boot/defaults/loader.conf
 254 default settings -- do not change this file.
 255 .It Pa /boot/loader.4th
 256 defines the commands used by loader to read and process
 257 .Nm .
 258 .It Pa /boot/loader.conf
 259 user defined settings.
 260 .It Pa /boot/loader.conf.local
 261 machine-specific settings for sites with a common loader.conf.
 262 .It Pa /boot/loader.rc
 263 contains the instructions to automatically process
 264 .Nm .
 265 .El
 266 .Sh SEE ALSO
 267 .Xr boot 8 ,
 268 .Xr loader 8 ,
 269 .Xr loader.4th 8
 270 .Sh HISTORY
 271 The file
 272 .Nm
 273 first appeared in
 274 .Fx 3.2 .
 275 .Sh AUTHORS
 276 This manual page was written by
 277 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
 278 .Sh BUGS
 279 The
 280 .Xr loader 8
 281 stops reading
 282 .Nm
 283 when it encounters a syntax error, so any options which are vital for
 284 booting a particular system (i.e.\&
 285 .Dq Va hw.ata.ata_dma Ns "=0" )
 286 should precede any experimental additions to
 287 .Nm .