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
27 .Dd September 30, 2004
32 .Nd loader.conf processing tools
34 The file that goes by the name of
36 is a set of commands designed to manipulate
43 and uses one of its commands to automatically read and process
47 Other commands exists to help the user specify alternate
52 by themselves are not enough for most uses.
54 examples below for the most common situations, and to
56 for additional commands.
58 Before using any of the commands provided in
63 .Dl include loader.4th
65 This line is present in the default
67 file, so it is not needed (and should not be re-issued) in a normal setup.
69 The commands provided by it are:
70 .Bl -tag -width disable-module_module -compact -offset indent
72 .It Ic boot Ar kernelname Op Cm ...
73 .It Ic boot Ar directory Op Cm ...
74 .It Ic boot Fl flag Cm ...
75 Boot as specified by the
79 Depending on the arguments passed, it can override boot flags and
80 either the kernel name or the search path for kernel and modules.
83 .It Ic boot-conf Ar kernelname Op Cm ...
84 .It Ic boot-conf Ar directory Op Cm ...
85 .It Ic boot-conf Fl flag Cm ...
88 described above, but instead of booting immediately, uses
94 .Pa /boot/defaults/loader.conf ,
97 files specified in it, and then proceeds to boot as specified in them.
99 is the command used in the default
101 file, and it uses the
105 so it can be stopped for further interaction with
109 Initialize the supporting library so commands can be used without
116 .Pa /boot/defaults/loader.conf
119 files specified in it.
120 Returns a flag on the stack to indicate
121 if any configuration file was successfully loaded.
123 .It Ic read-conf Ar filename
124 Reads and processes a
127 Does not proceed to boot.
129 .It Ic enable-module Ar module
130 Enables the loading of
133 .It Ic disable-module Ar module
134 Disables the loading of
137 .It Ic toggle-module Ar module
138 Toggles the loading of
142 .It Ic show-module Ar module
143 Shows the information gathered in the
145 files about the module
151 files to specify the action after a module loading fails.
156 files to specify the action after a module loading fails.
159 .Bl -tag -width /boot/loader.4th -compact
163 .It Pa /boot/loader.4th
166 .It Pa /boot/loader.rc
168 bootstrapping script.
169 .It Pa /boot/defaults/loader.conf
176 .Pa /boot/loader.rc :
178 .Bd -literal -offset indent -compact
179 include /boot/loader.4th
183 Load a different kernel with the standard configuration:
185 .Bd -literal -offset indent -compact
186 set kernel="kernel.old"
191 Read an additional configuration file and then proceed to boot:
193 .Bd -literal -offset indent -compact
195 read-conf /boot/special.conf
199 Disable the loading of the splash screen module and bitmap and then
202 .Bd -literal -offset indent -compact
204 disable-module splash_bmp
205 disable-module bitmap
214 set of commands first appeared in
219 set of commands was written by
220 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
222 A British espionage series.