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