share/man/man5/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: src/sys/boot/forth/loader.conf.5,v 1.18 2002/08/27 01:02:56 trhodes Exp $
  26 .\" $DragonFly: src/sys/boot/forth/loader.conf.5,v 1.13 2008/09/15 21:23:44 thomas Exp $
  27 .Dd September 6, 2008
  28 .Dt LOADER.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm loader.conf
  32 .Nd system bootstrap configuration information
  33 .Sh DESCRIPTION
  34 The file
  35 .Nm
  36 contains descriptive information on bootstrapping the system.
  37 Through
  38 it you can specify the kernel to be booted, parameters to be passed to
  39 it, and additional modules to be loaded; and generally set all variables
  40 described in
  41 .Xr loader 8 .
  42 .Pp
  43 A file
  44 .Pa loader.rc
  45 must contain the following two lines for
  46 .Nm
  47 to be automatically processed:
  48 .Pp
  49 .Dl include loader.4th
  50 .Dl start
  51 .Pp
  52 If no
  53 .Pa /boot/loader.rc
  54 exists at installworld time, one with the above lines will be installed.
  55 .Sh SYNTAX
  56 Though
  57 .Nm Ns 's
  58 format was defined explicitly to resemble
  59 .Xr rc.conf 5 ,
  60 and can be sourced by
  61 .Xr sh 1 ,
  62 some settings are treated in a special fashion.
  63 Also, the
  64 behavior of some settings is defined by the setting's suffix;
  65 the prefix identifies which module the setting controls.
  66 .Pp
  67 The general parsing rules are:
  68 .Bl -bullet
  69 .It
  70 Spaces and empty lines are ignored.
  71 .It
  72 A
  73 .Ql #
  74 sign will mark the remainder of the line as a comment.
  75 .It
  76 Only one setting can be present on each line.
  77 .El
  78 .Pp
  79 All settings have the following format:
  80 .Pp
  81 .Dl variable="value"
  82 .Pp
  83 Unless it belongs to one of the classes of settings that receive special
  84 treatment, a setting will set the value of a
  85 .Xr loader 8
  86 environment variable.
  87 The settings that receive special
  88 treatment are listed below.
  89 Settings beginning with
  90 .Aq Ar module
  91 below define the modules to be loaded.
  92 All such settings sharing a common
  93 prefix refer to the same module.
  94 .Bl -tag -width Ar
  95 .It Ar exec
  96 Immediately executes a
  97 .Xr loader 8
  98 command.
  99 This type of setting cannot be processed by programs other
 100 than
 101 .Xr loader 8 ,
 102 so its use should be avoided.
 103 Multiple instances of it will be processed
 104 independently.
 105 .It Ar loader_conf_files
 106 Defines additional configuration files to be processed right after the
 107 present file.
 108 .It Ar kernel
 109 Name of the kernel to be loaded.
 110 If no kernel name is set, no additional
 111 modules will be loaded.
 112 .It Ar kernel_options
 113 Flags to be passed to the kernel (see
 114 .Xr boot 8 ) .
 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 Ao Ar module Ac Ns Ar _load
 123 If set to
 124 .Dq YES ,
 125 that module will be loaded.
 126 If no
 127 .Ao Ar module Ac Ns Ar _name
 128 is defined (see below), the
 129 module's name is taken to be
 130 .Aq Ar module .
 131 .It Ao Ar module Ac Ns Ar _name
 132 Defines the name of the module.
 133 .It Ao Ar module Ac Ns Ar _type
 134 Defines the module's type.
 135 If none is given, it defaults to a kld module.
 136 .It Ao Ar module Ac Ns Ar _flags
 137 Flags and parameters to be passed to the module.
 138 .It Ao Ar module Ac Ns Ar _before
 139 Commands to be executed before the module is loaded.
 140 Use of this setting
 141 should be avoided.
 142 .It Ao Ar module Ac Ns Ar _after
 143 Commands to be executed after the module is loaded.
 144 Use of this setting
 145 should be avoided.
 146 .It Ao Ar module Ac Ns Ar _error
 147 Commands to be executed if the loading of a module fails.
 148 Except for the
 149 special value
 150 .Dq abort ,
 151 which aborts the bootstrap process, use of this setting should be avoided.
 152 .El
 153 .Sh DEFAULT SETTINGS
 154 Most of
 155 .Nm Ns 's
 156 default settings can be ignored.
 157 The few of them which are important
 158 or useful are:
 159 .Bl -tag -width bootfile -offset indent
 160 .It Va bitmap_load
 161 .Pq Dq NO
 162 If set to
 163 .Dq YES ,
 164 a bitmap will be loaded to be displayed on screen while booting.
 165 .It Va bitmap_name
 166 .Pq Dq splash.bmp
 167 Name of the bitmap to be loaded.
 168 Any other name can be used.
 169 .It Va console
 170 .Pq Dq vidconsole
 171 .Dq comconsole
 172 selects serial console,
 173 .Dq vidconsole
 174 selects the video console, and
 175 .Dq nullconsole
 176 selects a mute console
 177 (useful for systems with neither a video console nor a serial port).
 178 .It Va fred_disable
 179 .Pq Dq NO
 180 Shows a monochrome version of Fred, the official
 181 .Dx
 182 mascot, when the
 183 boot menu appears.
 184 To make his life a bit more colorful, consider setting
 185 .Pa loader_color
 186 to
 187 .Dq YES .
 188 .It Va fred_on_left
 189 .Pq Dq NO
 190 Shows Fred on the left side of the menu rather than the right side.
 191 .It Va kernel
 192 .Pq Dq kernel
 193 .It Va loader_color
 194 .Pq Dq NO
 195 If set to
 196 .Dq YES ,
 197 you'll meet Fred, the official
 198 .Dx
 199 mascot, in technicolor when the
 200 boot menu appears (remember to set
 201 .Pa fred_disable
 202 to
 203 .Dq NO
 204 for this to work.)
 205 .It Va loader_conf_files
 206 .Pq Do loader.conf loader.conf.local Dc
 207 .It Va splash_bmp_load
 208 .Pq Dq NO
 209 If set to
 210 .Dq YES ,
 211 will load the splash screen module, making it possible to display a bmp image
 212 on the screen while booting.
 213 .It Va splash_pcx_load
 214 .Pq Dq NO
 215 If set to
 216 .Dq YES ,
 217 will load the splash screen module, making it possible to display a pcx image
 218 on the screen while booting.
 219 .It Va userconfig_script_load
 220 .Pq Dq NO
 221 If set to
 222 .Dq YES ,
 223 will load the userconfig data.
 224 .It Va vesa_load
 225 .Pq Dq NO
 226 If set to
 227 .Dq YES ,
 228 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 229 be displayed.
 230 .El
 231 .Sh FILES
 232 .Bl -tag -width /boot/defaults/loader.conf -compact
 233 .It Pa /boot/defaults/loader.conf
 234 default settings -- do not change this file.
 235 .It Pa /boot/loader.4th
 236 defines the commands used by loader to read and process
 237 .Nm .
 238 .It Pa /boot/loader.conf
 239 user defined settings.
 240 .It Pa /boot/loader.conf.local
 241 machine-specific settings for sites with a common loader.conf.
 242 .It Pa /boot/loader.rc
 243 contains the instructions to automatically process
 244 .Nm .
 245 .El
 246 .Sh SEE ALSO
 247 .Xr boot 8 ,
 248 .Xr loader 8
 249 .Sh HISTORY
 250 The file
 251 .Nm
 252 first appeared in
 253 .Fx 3.2 .
 254 .Sh AUTHORS
 255 This manual page was written by
 256 .An Daniel C. Sobral Aq dcs@FreeBSD.org .