dab40273be357e251039dbdbd5094b60f4cd7054
[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.3 2003/11/10 06:08:34 dillon Exp $
27 .Dd April 18, 1999
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 kernel
160 .Pq Dq /boot/kernel/kernel
161 .It Va loader_conf_files
162 .Pq Do /boot/loader.conf /boot/loader.conf.local Dc
163 .It Va splash_bmp_load
164 .Pq Dq NO
165 If set to
166 .Dq YES ,
167 will load the splash screen module, making it possible to display a bmp image
168 on the screen while booting.
169 .It Va splash_pcx_load
170 .Pq Dq NO
171 If set to
172 .Dq YES ,
173 will load the splash screen module, making it possible to display a pcx image
174 on the screen while booting.
175 .It Va userconfig_script_load
176 .Pq Dq NO
177 If set to
178 .Dq YES ,
179 will load the userconfig data.
180 .It Va vesa_load
181 .Pq Dq NO
182 If set to
183 .Dq YES ,
184 the vesa module will be loaded, enabling bitmaps above VGA resolution to
185 be displayed.
186 .El
187 .Sh FILES
188 .Bl -tag -width /boot/defaults/loader.conf -compact
189 .It Pa /boot/defaults/loader.conf
190 default settings -- do not change this file.
191 .It Pa /boot/loader.4th
192 defines the commands used by loader to read and process
193 .Nm .
194 .It Pa /boot/loader.conf
195 user defined settings.
196 .It Pa /boot/loader.conf.local
197 machine-specific settings for sites with a common loader.conf.
198 .It Pa /boot/loader.rc
199 contains the instructions to automatically process
200 .Nm .
201 .El
202 .Sh SEE ALSO
203 .Xr boot 8 ,
204 .Xr loader 8 ,
205 .Xr loader.4th 8
206 .Sh HISTORY
207 The file
208 .Nm
209 first appeared in
210 .Fx 3.2 .
211 .Sh AUTHORS
212 This manual page was written by
213 .An Daniel C. Sobral Aq dcs@FreeBSD.org .