1 .\" Copyright (c) 1999 Daniel C. Sobral
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $FreeBSD: src/sys/boot/forth/loader.conf.5,v 1.18 2002/08/27 01:02:56 trhodes Exp $
31 .Nd system bootstrap configuration information
35 contains descriptive information on bootstrapping the system.
36 Through it you can specify the kernel to be booted,
37 parameters to be passed to it,
38 and additional kernel modules to be loaded;
39 and generally set all variables described in
44 must contain the following lines for
46 to be automatically processed:
48 .Dl include defaults/loader.conf
49 .Dl optinclude loader.conf
50 .Dl optinclude loader.conf.local
54 exists at installworld time, one with the above lines will be installed.
58 format was defined explicitly to resemble
62 some settings are treated in a special fashion.
63 Also, the behavior of some settings is defined by the setting's suffix;
64 the prefix identifies which module the setting controls.
66 The general parsing rules are:
69 Spaces and empty lines are ignored.
73 sign will mark the remainder of the line as a comment.
75 Only one setting can be present on each line.
78 All settings have the following format:
82 This assigns value to a local variable.
83 If variable is in a list of known kernel environment variables or
85 it is also assigned to the kernel environment variable of the given name.
87 The settings that receive special treatment are listed below.
88 Settings beginning with
90 below define the kernel modules to be loaded.
91 All such settings sharing a common
92 prefix refer to the same module.
93 .Bl -tag -width indent
95 Name of the kernel to be loaded.
96 If no kernel name is set, no additional
97 modules will be loaded.
99 Flags to be passed to the kernel (see
101 .It Ar verbose_loading
104 module names will be displayed as they are loaded.
105 .It Ao Ar module Ac Ns Ar _load
108 that kernel module will be loaded.
110 .Ao Ar module Ac Ns Ar _name
111 is defined (see below), the
112 module's name is taken to be
114 .It Ao Ar module Ac Ns Ar _name
115 Defines the name of the module.
116 .It Ao Ar module Ac Ns Ar _type
117 Defines the module's type.
118 If none is given, it defaults to a
121 .It Ao Ar module Ac Ns Ar _flags
122 Flags and parameters to be passed to the module.
123 .It Ao Ar module Ac Ns Ar _before
124 Commands to be executed before the module is loaded.
127 .It Ao Ar module Ac Ns Ar _after
128 Commands to be executed after the module is loaded.
131 .It Ao Ar module Ac Ns Ar _error
132 Commands to be executed if the loading of a module fails.
136 which aborts the bootstrap process, use of this setting should be avoided.
140 .Pa /boot/defaults/loader.conf
144 The few of them which are important
146 .Bl -tag -width indent
151 a bitmap will be loaded to be displayed on screen while booting.
154 Name of the bitmap to be loaded.
155 Any other name can be used.
160 to enable verbose booting.
164 selects serial console,
166 selects the video console, and
168 selects a mute console
169 (useful for systems with neither a video console nor a serial port).
172 Shows a monochrome version of Fred, the official
176 To make his life a bit more colorful, consider setting
182 Shows Fred on the left side of the menu rather than the right side.
189 you'll meet Fred, the official
191 mascot, in technicolor when the
192 boot menu appears (remember to set
197 .It Va splash_bmp_load
201 will load the splash screen module, making it possible to display a bmp image
202 on the screen while booting.
203 .It Va splash_pcx_load
207 will load the splash screen module, making it possible to display a pcx image
208 on the screen while booting.
209 .It Va userconfig_script_load
213 will load the userconfig data.
218 the vesa module will be loaded, enabling bitmaps above VGA resolution to
222 .Bl -tag -width ".Pa /boot/defaults/dloader.menu" -compact
223 .It Pa /boot/defaults/dloader.menu
224 default settings for menu setup -- do not change this file.
225 .It Pa /boot/defaults/loader.conf
226 default settings -- do not change this file.
227 .It Pa /boot/dloader.menu
228 defines the commands used by
231 .It Pa /boot/loader.conf
232 user defined settings.
233 .It Pa /boot/loader.conf.local
234 machine-specific settings for sites with a common loader.conf.
235 .It Pa /boot/dloader.rc
236 contains the instructions to automatically process.
247 This manual page was written by
248 .An Daniel C. Sobral Aq dcs@FreeBSD.org .