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$
  26 .Dd April 18, 1999
  27 .Dt LOADER.CONF 5
  28 .Os
  29 .Sh NAME
  30 .Nm loader.conf
  31 .Nd system bootstrap configuration information
  32 .Pp
  33 .Nm loader.conf.local
  34 .Nd localized system bootstrap configuration information
  35 .Sh DESCRIPTION
  36 The file
  37 .Nm
  38 contains descriptive information on bootstrapping the system. Through
  39 it you can specify the kernel to be booted, parameters to be passed to
  40 it, additional modules to be loaded, and generally set all variables
  41 described in
  42 .Xr loader 8 .
  43 .Pp
  44 The file
  45 .Pa /boot/loader.rc
  46 must contain the following two lines for
  47 .Nm
  48 to be automatically processed:
  49 .Pp
  50 .Dl include /boot/loader.4th
  51 .Dl start
  52 .Pp
  53 If no
  54 .Pa /boot/loader.rc
  55 exists at installworld time, one with the above lines will be installed.
  56 .Sh SYNTAX
  57 Though
  58 .Nm loader.conf Ns No 's
  59 format was defined explicitly to resemble
  60 .Xr rc.conf 5 ,
  61 and can be sourced by
  62 .Xr sh 1 ,
  63 some settings are treated in a special fashion. Also, the
  64 behavior of some settings depends only on it's suffix.
  65 .Pp
  66 The general parsing rules are:
  67 .Bl -bullet
  68 .It
  69 Spaces and empty lines are ignored.
  70 .It
  71 A # sign will mark the remaining of the line as a comment.
  72 .It
  73 Only one setting can be present on each line.
  74 .El
  75 .Pp
  76 All settings have the following format:
  77 .Pp
  78 .Dl variable="value"
  79 .Pp
  80 Unless it belongs to one of the classes of settings that receive special
  81 treatment, a setting will set the value of a
  82 .Xr loader 8 's
  83 environment variable. The settings that receive special
  84 treatment are listed below. The ones beginning with a
  85 .Qq *
  86 define the modules to be loaded and
  87 may have any prefix. 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 it's 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 verbose_loading
 107 If set to
 108 .Dq YES ,
 109 the modules' names will be displayed as they are loaded.
 110 .It Ar *_load
 111 If set to
 112 .Dq YES ,
 113 that module will be loaded. If no name is defined (see below), the
 114 module's name is taken to be the same as the prefix.
 115 .It Ar *_name
 116 Defines the name of the module.
 117 .It Ar *_type
 118 Defines the module's type. If none is given, it defaults to a kld module.
 119 .It Ar *_flags
 120 Flags and parameters to be passed to the module.
 121 .It Ar *_before
 122 Commands to be executed before the module is loaded. Use of this setting
 123 should be avoided.
 124 .It Ar *_after
 125 Commands to be executed after the module is loaded. Use of this setting
 126 should be avoided.
 127 .It Ar *_error
 128 Commands to be executed if the loading of a module fails. Except for the
 129 special value
 130 .Dq abort ,
 131 which aborts the bootstrap process, use of this setting should be avoided.
 132 .El
 133 .Sh DEFAULT SETTINGS
 134 Most of
 135 .Nm loader.conf Ns No 's
 136 default settings can be ignored. The few of them which are important
 137 or useful are:
 138 .Bl -tag -width bootfile -offset indent
 139 .It Va bitmap_load
 140 .Pq Dq NO
 141 If set to
 142 .Dq YES ,
 143 a bitmap will be loaded to be displayed on screen while booting.
 144 .It Va bitmap_name
 145 .Pq Dq /boot/splash.bmp
 146 Name of the bitmap to be loaded. Any other name can be used.
 147 .It Va kernel
 148 .Pq Dq /kernel
 149 .It Va loader_conf_files
 150 .Pq Do /boot/loader.conf /boot/loader.conf.local Dc
 151 .It Va splash_bmp_load
 152 .Pq Dq NO
 153 If set to
 154 .Dq YES ,
 155 will load the splash screen module, making possible to display a bitmap
 156 on the screen while booting.
 157 .It Va userconfig_script_load
 158 .Pq Dq NO
 159 If set to
 160 .Dq YES ,
 161 will load the userconfig data.
 162 .It Va vesa_load
 163 .Pq Dq NO
 164 If set to
 165 .Dq YES ,
 166 the vesa module will be loaded, enabling bitmaps above VGA resolution to
 167 be displayed.
 168 .El
 169 .Sh FILES
 170 .Bl -tag -width /boot/defaults/loader.conf -compact
 171 .It Pa /boot/defaults/loader.conf
 172 default settings -- do not change this file.
 173 .It Pa /boot/loader.4th
 174 defines the commands used by loader to read and process
 175 .Nm loader.conf .
 176 .It Pa /boot/loader.conf
 177 user defined settings.
 178 .It Pa /boot/loader.conf.local
 179 machine-specific settings for sites with a common loader.conf.
 180 .It Pa /boot/loader.rc
 181 contains the instructions to automatically process
 182 .Nm loader.conf .
 183 .El
 184 .Sh SEE ALSO
 185 .Xr boot 8 ,
 186 .Xr loader 8 ,
 187 .Xr loader.4th 8 .
 188 .Sh HISTORY
 189 The file
 190 .Nm
 191 first appeared in
 192 .Fx 3.2 .
 193 .Sh AUTHORS
 194 This manual page was written by
 195 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
 196