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