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