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: 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.11 2008/09/10 18:17:01 dillon 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. 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 A file
  43 .Pa loader.rc
  44 must contain the following two lines for
  45 .Nm
  46 to be automatically processed:
  47 .Pp
  48 .Dl include 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. Also, the
  62 behavior of some settings is defined by the setting's suffix;
  63 the prefix identifies which module the setting controls.
  64 .Pp
  65 The general parsing rules are:
  66 .Bl -bullet
  67 .It
  68 Spaces and empty lines are ignored.
  69 .It
  70 A # sign will mark the remainder of the line as a comment.
  71 .It
  72 Only one setting can be present on each line.
  73 .El
  74 .Pp
  75 All settings have the following format:
  76 .Pp
  77 .Dl variable="value"
  78 .Pp
  79 Unless it belongs to one of the classes of settings that receive special
  80 treatment, a setting will set the value of a
  81 .Xr loader 8
  82 environment variable. The settings that receive special
  83 treatment are listed below. Settings beginning with
  84 .Qq *
  85 below define the modules to be loaded and
  86 may have any prefix; the prefix identifies a module.
  87 All such settings sharing a common
  88 prefix refer to the same module.
  89 .Bl -tag -width Ar
  90 .It Ar exec
  91 Immediately executes a
  92 .Xr loader 8
  93 command. This type of setting cannot be processed by programs other
  94 than
  95 .Xr loader 8 ,
  96 so its use should be avoided. Multiple instances of it will be processed
  97 independently.
  98 .It Ar hw.usb.hack_defer_exploration=1
  99 The USB keyboard will sometimes not attach properly unless you set this
 100 kernel environment variable to 1.
 101 .It Ar vfs.root.mountfrom="hammer:da0s1d"
 102 When booting from a boot-only partition this variable tells the kernel
 103 where the root filesystem is.  The boot-only partition is then typically
 104 mounted under the root filesystem as /boot.  The assignment is an example
 105 of how to specify the filesystem and block device.
 106 .It Ar loader_conf_files
 107 Defines additional configuration files to be processed right after the
 108 present file.
 109 .It Ar kernel
 110 Name of the kernel to be loaded. 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 Ar *_load
 123 If set to
 124 .Dq YES ,
 125 that module will be loaded. If no name is defined (see below), the
 126 module's name is taken to be the same as the prefix.
 127 .It Ar *_name
 128 Defines the name of the module.
 129 .It Ar *_type
 130 Defines the module's type. If none is given, it defaults to a kld module.
 131 .It Ar *_flags
 132 Flags and parameters to be passed to the module.
 133 .It Ar *_before
 134 Commands to be executed before the module is loaded. Use of this setting
 135 should be avoided.
 136 .It Ar *_after
 137 Commands to be executed after the module is loaded. Use of this setting
 138 should be avoided.
 139 .It Ar *_error
 140 Commands to be executed if the loading of a module fails. Except for the
 141 special value
 142 .Dq abort ,
 143 which aborts the bootstrap process, use of this setting should be avoided.
 144 .El
 145 .Sh DEFAULT SETTINGS
 146 Most of
 147 .Nm Ns 's
 148 default settings can be ignored. The few of them which are important
 149 or useful are:
 150 .Bl -tag -width bootfile -offset indent
 151 .It Va bitmap_load
 152 .Pq Dq NO
 153 If set to
 154 .Dq YES ,
 155 a bitmap will be loaded to be displayed on screen while booting.
 156 .It Va bitmap_name
 157 .Pq Dq splash.bmp
 158 Name of the bitmap to be loaded. Any other name can be used.
 159 .It Va console
 160 .Pq Dq vidconsole
 161 .Dq comconsole
 162 selects serial console,
 163 .Dq vidconsole
 164 selects the video console, and
 165 .Dq nullconsole
 166 selects a mute console
 167 (useful for systems with neither a video console nor a serial port).
 168 .It Va fred_disable
 169 .Pq Dq NO
 170 Shows a monochrome version of Fred, the official
 171 .Dx
 172 mascot, when the
 173 boot menu appears. To make his life a bit more colorful, consider setting
 174 .Pa loader_color
 175 to
 176 .Dq YES .
 177 .It Va kernel
 178 .Pq Dq kernel
 179 .It Va loader_color
 180 .Pq Dq NO
 181 If set to
 182 .Dq YES ,
 183 you'll meet Fred, the official
 184 .Dx
 185 mascot, in technicolor when the
 186 boot menu appears (remember to set
 187 .Pa fred_disable
 188 to
 189 .Dq NO
 190 for this to work.)
 191 .It Va loader_conf_files
 192 .Pq Do loader.conf loader.conf.local Dc
 193 .It Va splash_bmp_load
 194 .Pq Dq NO
 195 If set to
 196 .Dq YES ,
 197 will load the splash screen module, making it possible to display a bmp image
 198 on the screen while booting.
 199 .It Va splash_pcx_load
 200 .Pq Dq NO
 201 If set to
 202 .Dq YES ,
 203 will load the splash screen module, making it possible to display a pcx image
 204 on the screen while booting.
 205 .It Va userconfig_script_load
 206 .Pq Dq NO
 207 If set to
 208 .Dq YES ,
 209 will load the userconfig data.
 210 .It Va vesa_load
 211 .Pq Dq NO
 212 If set to
 213 .Dq YES ,
 214 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 215 be displayed.
 216 .El
 217 .Sh FILES
 218 .Bl -tag -width /boot/defaults/loader.conf -compact
 219 .It Pa /boot/defaults/loader.conf
 220 default settings -- do not change this file.
 221 .It Pa /boot/loader.4th
 222 defines the commands used by loader to read and process
 223 .Nm .
 224 .It Pa /boot/loader.conf
 225 user defined settings.
 226 .It Pa /boot/loader.conf.local
 227 machine-specific settings for sites with a common loader.conf.
 228 .It Pa /boot/loader.rc
 229 contains the instructions to automatically process
 230 .Nm .
 231 .El
 232 .Sh SEE ALSO
 233 .Xr boot 8 ,
 234 .Xr loader 8 ,
 235 .Xr loader.4th 8
 236 .Sh HISTORY
 237 The file
 238 .Nm
 239 first appeared in
 240 .Fx 3.2 .
 241 .Sh AUTHORS
 242 This manual page was written by
 243 .An Daniel C. Sobral Aq dcs@FreeBSD.org .