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.7 2005/12/10 00:22:28 swildner Exp $
  27 .Dd May 29, 2005
  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 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. 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 loader_conf_files
  99 Defines additional configuration files to be processed right after the
 100 present file.
 101 .It Ar kernel
 102 Name of the kernel to be loaded. If no kernel name is set, no additional
 103 modules will be loaded.
 104 .It Ar kernel_options
 105 Flags to be passed to the kernel.
 106 .It Ar password
 107 Provides a password to be required by check-password before execution is
 108 allowed to continue.
 109 .It Ar verbose_loading
 110 If set to
 111 .Dq YES ,
 112 module names will be displayed as they are loaded.
 113 .It Ar *_load
 114 If set to
 115 .Dq YES ,
 116 that module will be loaded. If no name is defined (see below), the
 117 module's name is taken to be the same as the prefix.
 118 .It Ar *_name
 119 Defines the name of the module.
 120 .It Ar *_type
 121 Defines the module's type. If none is given, it defaults to a kld module.
 122 .It Ar *_flags
 123 Flags and parameters to be passed to the module.
 124 .It Ar *_before
 125 Commands to be executed before the module is loaded. Use of this setting
 126 should be avoided.
 127 .It Ar *_after
 128 Commands to be executed after the module is loaded. Use of this setting
 129 should be avoided.
 130 .It Ar *_error
 131 Commands to be executed if the loading of a module fails. Except for the
 132 special value
 133 .Dq abort ,
 134 which aborts the bootstrap process, use of this setting should be avoided.
 135 .El
 136 .Sh DEFAULT SETTINGS
 137 Most of
 138 .Nm Ns 's
 139 default settings can be ignored. The few of them which are important
 140 or useful are:
 141 .Bl -tag -width bootfile -offset indent
 142 .It Va bitmap_load
 143 .Pq Dq NO
 144 If set to
 145 .Dq YES ,
 146 a bitmap will be loaded to be displayed on screen while booting.
 147 .It Va bitmap_name
 148 .Pq Dq /boot/splash.bmp
 149 Name of the bitmap to be loaded. Any other name can be used.
 150 .It Va console
 151 .Pq Dq vidconsole
 152 .Dq comconsole
 153 selects serial console,
 154 .Dq vidconsole
 155 selects the video console, and
 156 .Dq nullconsole
 157 selects a mute console
 158 (useful for systems with neither a video console nor a serial port).
 159 .It Va fred_disable
 160 .Pq Dq NO
 161 Shows a monochrome version of Fred, the official
 162 .Dx
 163 mascot, when the
 164 boot menu appears. To make his life a bit more colorful, consider setting
 165 .Pa loader_color
 166 to
 167 .Dq YES .
 168 .It Va kernel
 169 .Pq Dq /kernel
 170 .It Va loader_color
 171 .Pq Dq NO
 172 If set to
 173 .Dq YES ,
 174 you'll meet Fred, the official
 175 .Dx
 176 mascot, in technicolor when the
 177 boot menu appears (remember to set
 178 .Pa fred_disable
 179 to
 180 .Dq NO
 181 for this to work.)
 182 .It Va loader_conf_files
 183 .Pq Do /boot/loader.conf /boot/loader.conf.local Dc
 184 .It Va splash_bmp_load
 185 .Pq Dq NO
 186 If set to
 187 .Dq YES ,
 188 will load the splash screen module, making it possible to display a bmp image
 189 on the screen while booting.
 190 .It Va splash_pcx_load
 191 .Pq Dq NO
 192 If set to
 193 .Dq YES ,
 194 will load the splash screen module, making it possible to display a pcx image
 195 on the screen while booting.
 196 .It Va userconfig_script_load
 197 .Pq Dq NO
 198 If set to
 199 .Dq YES ,
 200 will load the userconfig data.
 201 .It Va vesa_load
 202 .Pq Dq NO
 203 If set to
 204 .Dq YES ,
 205 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 206 be displayed.
 207 .El
 208 .Sh FILES
 209 .Bl -tag -width /boot/defaults/loader.conf -compact
 210 .It Pa /boot/defaults/loader.conf
 211 default settings -- do not change this file.
 212 .It Pa /boot/loader.4th
 213 defines the commands used by loader to read and process
 214 .Nm .
 215 .It Pa /boot/loader.conf
 216 user defined settings.
 217 .It Pa /boot/loader.conf.local
 218 machine-specific settings for sites with a common loader.conf.
 219 .It Pa /boot/loader.rc
 220 contains the instructions to automatically process
 221 .Nm .
 222 .El
 223 .Sh SEE ALSO
 224 .Xr boot 8 ,
 225 .Xr loader 8 ,
 226 .Xr loader.4th 8
 227 .Sh HISTORY
 228 The file
 229 .Nm
 230 first appeared in
 231 .Fx 3.2 .
 232 .Sh AUTHORS
 233 This manual page was written by
 234 .An Daniel C. Sobral Aq dcs@FreeBSD.org .