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 October 6, 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 module_blacklist
 151 Blacklist of modules.
 152 Modules specified in the blacklist may not be loaded automatically with a
 153 .Ar *_load
 154 directive, but they may be loaded directly at the
 155 .Xr loader 8
 156 prompt.
 157 Blacklisted modules may still be loaded indirectly as dependencies of other
 158 modules.
 159 .It Ar *_load
 160 If set to
 161 .Dq YES ,
 162 that module will be loaded.
 163 If no name is defined (see below), the
 164 module's name is taken to be the same as the prefix.
 165 .It Ar *_name
 166 Defines the name of the module.
 167 .It Ar *_type
 168 Defines the module's type.
 169 If none is given, it defaults to a kld module.
 170 .It Ar *_flags
 171 Flags and parameters to be passed to the module.
 172 .It Ar *_before
 173 Commands to be executed before the module is loaded.
 174 Use of this setting
 175 should be avoided.
 176 .It Ar *_after
 177 Commands to be executed after the module is loaded.
 178 Use of this setting
 179 should be avoided.
 180 .It Ar *_error
 181 Commands to be executed if the loading of a module fails.
 182 Except for the
 183 special value
 184 .Dq abort ,
 185 which aborts the bootstrap process, use of this setting should be avoided.
 186 .El
 187 .Pp
 188 .Em WARNING:
 189 developers should never use these suffixes for any kernel environment
 190 variables (tunables) or conflicts will result.
 191 .Sh DEFAULT SETTINGS
 192 Most of
 193 .Nm Ns 's
 194 default settings can be ignored.
 195 The few of them which are important
 196 or useful are:
 197 .Bl -tag -width bootfile -offset indent
 198 .It Va bitmap_load
 199 .Pq Dq NO
 200 If set to
 201 .Dq YES ,
 202 a bitmap will be loaded to be displayed on screen while booting.
 203 .It Va bitmap_name
 204 .Pq Dq Pa /boot/splash.bmp
 205 Name of the bitmap to be loaded.
 206 Any other name can be used.
 207 .It Va comconsole_speed
 208 .Dq ( 9600
 209 or the value of the
 210 .Va BOOT_COMCONSOLE_SPEED
 211 variable when
 212 .Xr loader 8
 213 was compiled).
 214 Sets the speed of the serial console.
 215 If the previous boot loader stage specified that a serial console
 216 is in use then the default speed is determined from the current
 217 serial port speed setting.
 218 .It Va console
 219 .Pq Dq vidconsole
 220 .Dq comconsole
 221 selects serial console,
 222 .Dq vidconsole
 223 selects the video console,
 224 .Dq nullconsole
 225 selects a mute console
 226 (useful for systems with neither a video console nor a serial port), and
 227 .Dq spinconsole
 228 selects the video console which prevents any input and hides all output
 229 replacing it with
 230 .Dq spinning
 231 character (useful for embedded products and such).
 232 .It Va efi_max_resolution
 233 Specify the maximum desired resolution for the EFI console.
 234 The following values are accepted:
 235 .Bl -column "WidthxHeight"
 236 .It Sy Value Ta Sy Resolution
 237 .It 480p Ta 640x480
 238 .It 720p Ta 1280x720
 239 .It 1080p Ta 1920x1080
 240 .It 2160p Ta 3840x2160
 241 .It 4k Ta 3840x2160
 242 .It 5k Ta 5120x2880
 243 .It Va Width Ns x Ns Va Height Ta Va Width Ns x Ns Va Height
 244 .El
 245 .It Va kernel
 246 .Pq Dq kernel
 247 .It Va kernels
 248 .Pq Dq kernel kernel.old
 249 Space or comma separated list of kernels to present in the boot menu.
 250 .It Va loader_conf_files
 251 .Pq Dq Pa /boot/loader.conf /boot/loader.conf.local
 252 .It Va splash_bmp_load
 253 .Pq Dq NO
 254 If set to
 255 .Dq YES ,
 256 will load the splash screen module, making it possible to display a bmp image
 257 on the screen while booting.
 258 .It Va splash_pcx_load
 259 .Pq Dq NO
 260 If set to
 261 .Dq YES ,
 262 will load the splash screen module, making it possible to display a pcx image
 263 on the screen while booting.
 264 .It Va vesa_load
 265 .Pq Dq NO
 266 If set to
 267 .Dq YES ,
 268 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 269 be displayed.
 270 .It Va beastie_disable
 271 If set to
 272 .Dq YES ,
 273 the beastie boot menu will be skipped.
 274 .It Va loader_logo Pq Dq Li orbbw
 275 Selects a desired logo in the beastie boot menu.
 276 Possible values are:
 277 .Dq Li orbbw ,
 278 .Dq Li orb ,
 279 .Dq Li fbsdbw ,
 280 .Dq Li beastiebw ,
 281 .Dq Li beastie ,
 282 and
 283 .Dq Li none .
 284 .It Va loader_color
 285 If set to
 286 .Dq NO ,
 287 the beastie boot menu will be displayed without ANSI coloring.
 288 .It Va entropy_cache_load
 289 .Pq Dq YES
 290 If set to
 291 .Dq NO ,
 292 the very early
 293 boot-time entropy file
 294 will not be loaded.
 295 See the entropy entries in
 296 .Xr rc.conf 5 .
 297 .It Va entropy_cache_name
 298 .Pq Dq /boot/entropy
 299 The name of the very early
 300 boot-time entropy cache file.
 301 .It Va cpu_microcode_load
 302 .Pq Dq NO
 303 If set to
 304 .Dq YES ,
 305 the microcode update file specified by
 306 .Va cpu_microcode_name
 307 will be loaded and applied very early during boot.
 308 This provides functionality similar to
 309 .Xr cpucontrol 8
 310 but ensures that CPU features enabled by microcode updates can be
 311 used by the kernel.
 312 The update will be re-applied automatically when resuming from an
 313 ACPI sleep state.
 314 If the update file contains updates for multiple processor models,
 315 the kernel will search for and extract a matching update.
 316 Currently this setting is supported only on Intel
 317 .Dv i386
 318 and
 319 .Dv amd64
 320 processors.
 321 It has no effect on other processor types.
 322 .It Va cpu_microcode_name
 323 A path to a microcode update file.
 324 .El
 325 .Sh OTHER SETTINGS
 326 Other settings that may be used in
 327 .Nm
 328 that have no default value:
 329 .Bl -tag -width bootfile -offset indent
 330 .It Va fdt_overlays
 331 Specifies a comma-delimited list of FDT overlays to apply.
 332 .Pa /boot/dtb/overlays
 333 is created by default for overlays to be placed in.
 334 .It Va kernels_autodetect
 335 If set to
 336 .Dq YES ,
 337 attempt to auto-detect kernels installed in
 338 .Pa /boot .
 339 This is an option specific to the Lua-based loader.
 340 It is not available in the default Forth-based loader.
 341 .El
 342 .Sh FILES
 343 .Bl -tag -width /boot/defaults/loader.conf -compact
 344 .It Pa /boot/defaults/loader.conf
 345 default settings -- do not change this file.
 346 .It Pa /boot/loader.conf
 347 user defined settings.
 348 .It Pa /boot/loader.conf.local
 349 machine-specific settings for sites with a common loader.conf.
 350 .El
 351 .Sh SEE ALSO
 352 .Xr rc.conf 5 ,
 353 .Xr boot 8 ,
 354 .Xr cpucontrol 8 ,
 355 .Xr loader 8 ,
 356 .Xr loader.4th 8
 357 .Sh HISTORY
 358 The file
 359 .Nm
 360 first appeared in
 361 .Fx 3.2 .
 362 .Sh AUTHORS
 363 This manual page was written by
 364 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
 365 .Sh BUGS
 366 The
 367 .Xr loader 8
 368 stops reading
 369 .Nm
 370 when it encounters a syntax error, so any options which are vital for
 371 booting a particular system (i.e.\&
 372 .Dq Va hw.ata.ata_dma Ns "=0" )
 373 should precede any experimental additions to
 374 .Nm .