stand/defaults/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 March 19, 2018
  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 .Sh SYNTAX
  43 Though
  44 .Nm Ns 's
  45 format was defined explicitly to resemble
  46 .Xr rc.conf 5 ,
  47 and can be sourced by
  48 .Xr sh 1 ,
  49 some settings are treated in a special fashion.
  50 Also, the
  51 behavior of some settings is defined by the setting's suffix;
  52 the prefix identifies which module the setting controls.
  53 .Pp
  54 The general parsing rules are:
  55 .Bl -bullet
  56 .It
  57 Spaces and empty lines are ignored.
  58 .It
  59 A # sign will mark the remainder of the line as a comment.
  60 .It
  61 Only one setting can be present on each line.
  62 .El
  63 .Pp
  64 All settings have the following format:
  65 .Pp
  66 .Dl variable="value"
  67 .Pp
  68 Unless it belongs to one of the classes of settings that receive special
  69 treatment, a setting will set the value of a
  70 .Xr loader 8
  71 environment variable.
  72 The settings that receive special
  73 treatment are listed below.
  74 Settings beginning with
  75 .Qq *
  76 below define the modules to be loaded and
  77 may have any prefix; the prefix identifies a module.
  78 All such settings sharing a common
  79 prefix refer to the same module.
  80 .Bl -tag -width Ar
  81 .It Ar exec
  82 Immediately executes a
  83 .Xr loader 8
  84 command.
  85 This type of setting cannot be processed by programs other
  86 than
  87 .Xr loader 8 ,
  88 so its use should be avoided.
  89 Multiple instances of it will be processed
  90 independently.
  91 .It Ar loader_conf_files
  92 Defines additional configuration files to be processed right after the
  93 present file.
  94 .It Ar kernel
  95 Name of the kernel to be loaded.
  96 If no kernel name is set, no additional
  97 modules will be loaded.
  98 The name must be a subdirectory of
  99 .Pa /boot
 100 that contains a kernel.
 101 .It Ar kernel_options
 102 Flags to be passed to the kernel.
 103 .It Ar vfs.root.mountfrom
 104 Specify the root partition to mount.
 105 For example:
 106 .Pp
 107 .Dl vfs.root.mountfrom="ufs:/dev/da0s1a"
 108 .Pp
 109 .Xr loader 8
 110 automatically calculates the value of this tunable from
 111 .Pa /etc/fstab
 112 from the partition the kernel was loaded from.
 113 The calculated value might be calculated incorrectly when
 114 .Pa /etc/fstab
 115 is not available during
 116 .Xr loader 8
 117 startup (as during diskless booting from NFS), or if a different
 118 device is desired by the user.
 119 The preferred value can be set in
 120 .Pa /loader.conf .
 121 .Pp
 122 The value can also be overridden from the
 123 .Xr loader 8
 124 command line.
 125 This is useful for system recovery when
 126 .Pa /etc/fstab
 127 is damaged, lost, or read from the wrong partition.
 128 .It Ar password
 129 Protect boot menu with a password without interrupting
 130 .Ic autoboot
 131 process.
 132 The password should be in clear text format.
 133 If a password is set, boot menu will not appear until any key is pressed during
 134 countdown period specified by
 135 .Va autoboot_delay
 136 variable or
 137 .Ic autoboot
 138 process fails.
 139 In both cases user should provide specified password to be able to access boot
 140 menu.
 141 .It Ar bootlock_password
 142 Provides a password to be required by check-password before execution is
 143 allowed to continue.
 144 The password should be in clear text format.
 145 If a password is set, the user must provide specified password to boot.
 146 .It Ar verbose_loading
 147 If set to
 148 .Dq YES ,
 149 module names will be displayed as they are loaded.
 150 .It Ar *_load
 151 If set to
 152 .Dq YES ,
 153 that module will be loaded.
 154 If no name is defined (see below), the
 155 module's name is taken to be the same as the prefix.
 156 .It Ar *_name
 157 Defines the name of the module.
 158 .It Ar *_type
 159 Defines the module's type.
 160 If none is given, it defaults to a kld module.
 161 .It Ar *_flags
 162 Flags and parameters to be passed to the module.
 163 .It Ar *_before
 164 Commands to be executed before the module is loaded.
 165 Use of this setting
 166 should be avoided.
 167 .It Ar *_after
 168 Commands to be executed after the module is loaded.
 169 Use of this setting
 170 should be avoided.
 171 .It Ar *_error
 172 Commands to be executed if the loading of a module fails.
 173 Except for the
 174 special value
 175 .Dq abort ,
 176 which aborts the bootstrap process, use of this setting should be avoided.
 177 .El
 178 .Pp
 179 .Em WARNING:
 180 developers should never use these suffixes for any kernel environment
 181 variables (tunables) or conflicts will result.
 182 .Sh DEFAULT SETTINGS
 183 Most of
 184 .Nm Ns 's
 185 default settings can be ignored.
 186 The few of them which are important
 187 or useful are:
 188 .Bl -tag -width bootfile -offset indent
 189 .It Va bitmap_load
 190 .Pq Dq NO
 191 If set to
 192 .Dq YES ,
 193 a bitmap will be loaded to be displayed on screen while booting.
 194 .It Va bitmap_name
 195 .Pq Dq Pa /boot/splash.bmp
 196 Name of the bitmap to be loaded.
 197 Any other name can be used.
 198 .It Va comconsole_speed
 199 .Dq ( 9600
 200 or the value of the
 201 .Va BOOT_COMCONSOLE_SPEED
 202 variable when
 203 .Xr loader 8
 204 was compiled).
 205 Sets the speed of the serial console.
 206 If the previous boot loader stage specified that a serial console
 207 is in use then the default speed is determined from the current
 208 serial port speed setting.
 209 .It Va console
 210 .Pq Dq vidconsole
 211 .Dq comconsole
 212 selects serial console,
 213 .Dq vidconsole
 214 selects the video console,
 215 .Dq nullconsole
 216 selects a mute console
 217 (useful for systems with neither a video console nor a serial port), and
 218 .Dq spinconsole
 219 selects the video console which prevents any input and hides all output
 220 replacing it with
 221 .Dq spinning
 222 character (useful for embedded products and such).
 223 .It Va kernel
 224 .Pq Dq kernel
 225 .It Va kernels
 226 .Pq Dq kernel kernel.old
 227 Space or comma separated list of kernels to present in the boot menu.
 228 .It Va loader_conf_files
 229 .Pq Dq Pa /boot/loader.conf /boot/loader.conf.local
 230 .It Va splash_bmp_load
 231 .Pq Dq NO
 232 If set to
 233 .Dq YES ,
 234 will load the splash screen module, making it possible to display a bmp image
 235 on the screen while booting.
 236 .It Va splash_pcx_load
 237 .Pq Dq NO
 238 If set to
 239 .Dq YES ,
 240 will load the splash screen module, making it possible to display a pcx image
 241 on the screen while booting.
 242 .It Va vesa_load
 243 .Pq Dq NO
 244 If set to
 245 .Dq YES ,
 246 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 247 be displayed.
 248 .It Va beastie_disable
 249 If set to
 250 .Dq YES ,
 251 the beastie boot menu will be skipped.
 252 .It Va loader_logo Pq Dq Li orbbw
 253 Selects a desired logo in the beastie boot menu.
 254 Possible values are:
 255 .Dq Li orbbw ,
 256 .Dq Li orb ,
 257 .Dq Li fbsdbw ,
 258 .Dq Li beastiebw ,
 259 .Dq Li beastie ,
 260 and
 261 .Dq Li none .
 262 .It Va loader_color
 263 If set to
 264 .Dq NO ,
 265 the beastie boot menu will be displayed without ANSI coloring.
 266 .It Va entropy_cache_load
 267 .Pq Dq YES
 268 If set to
 269 .Dq NO ,
 270 the very early
 271 boot-time entropy file
 272 will not be loaded.
 273 See the entropy entries in
 274 .Xr rc.conf 5 .
 275 .It Va entropy_cache_name
 276 .Pq Dq /boot/entropy
 277 The name of the very early
 278 boot-time entropy cache file.
 279 .El
 280 .Sh OTHER SETTINGS
 281 Other settings that may be used in
 282 .Nm
 283 that have no default value:
 284 .Bl -tag -width bootfile -offset indent
 285 .It Va fdt_overlays
 286 Specifies a comma-delimited list of FDT overlays to apply.
 287 .Pa /boot/dtb/overlays
 288 is created by default for overlays to be placed in.
 289 .It Va kernels_autodetect
 290 If set to
 291 .Dq YES ,
 292 attempt to auto-detect kernels installed in
 293 .Pa /boot .
 294 This is an option specific to the Lua-based loader.
 295 It is not available in the default Forth-based loader.
 296 .El
 297 .Sh FILES
 298 .Bl -tag -width /boot/defaults/loader.conf -compact
 299 .It Pa /boot/defaults/loader.conf
 300 default settings -- do not change this file.
 301 .It Pa /boot/loader.conf
 302 user defined settings.
 303 .It Pa /boot/loader.conf.local
 304 machine-specific settings for sites with a common loader.conf.
 305 .El
 306 .Sh SEE ALSO
 307 .Xr rc.conf 5 ,
 308 .Xr boot 8 ,
 309 .Xr loader 8 ,
 310 .Xr loader.4th 8
 311 .Sh HISTORY
 312 The file
 313 .Nm
 314 first appeared in
 315 .Fx 3.2 .
 316 .Sh AUTHORS
 317 This manual page was written by
 318 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
 319 .Sh BUGS
 320 The
 321 .Xr loader 8
 322 stops reading
 323 .Nm
 324 when it encounters a syntax error, so any options which are vital for
 325 booting a particular system (i.e.\&
 326 .Dq Va hw.ata.ata_dma Ns "=0" )
 327 should precede any experimental additions to
 328 .Nm .