initial commit
[freebsd-arm:freebsd-arm.git] / boot / forth / loader.4th.8
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$
26 .\"
27 .Dd September 30, 2004
28 .Dt LOADER.4TH 8
29 .Os
30 .Sh NAME
31 .Nm loader.4th
32 .Nd loader.conf processing tools
33 .Sh DESCRIPTION
34 The file that goes by the name of
35 .Nm
36 is a set of commands designed to manipulate
37 .Xr loader.conf 5
38 files.
39 The default
40 .Pa /boot/loader.rc
41 includes
42 .Nm
43 and uses one of its commands to automatically read and process
44 the standard
45 .Xr loader.conf 5
46 files.
47 Other commands exists to help the user specify alternate
48 configurations.
49 .Pp
50 The commands of
51 .Nm
52 by themselves are not enough for most uses.
53 Please refer to the
54 examples below for the most common situations, and to
55 .Xr loader 8
56 for additional commands.
57 .Pp
58 Before using any of the commands provided in
59 .Nm ,
60 it must be included
61 through the command:
62 .Pp
63 .Dl include loader.4th
64 .Pp
65 This line is present in the default
66 .Pa /boot/loader.rc
67 file, so it is not needed (and should not be re-issued) in a normal setup.
68 .Pp
69 The commands provided by it are:
70 .Bl -tag -width disable-module_module -compact -offset indent
71 .It Ic boot
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
76 .Xr loader.conf 5
77 files read.
78 .Pp
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.
81 .Pp
82 .It Ic boot-conf
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 ...
86 Works like
87 .Ic boot
88 described above, but instead of booting immediately, uses
89 .Ic autoboot ,
90 so it can be stopped.
91 .Pp
92 .It Ic start
93 Reads
94 .Pa /boot/defaults/loader.conf ,
95 all other
96 .Xr loader.conf 5
97 files specified in it, and then proceeds to boot as specified in them.
98 This
99 is the command used in the default
100 .Pa /boot/loader.rc
101 file, and it uses the
102 .Pa autoboot
103 command (see
104 .Xr loader 8 ) ,
105 so it can be stopped for further interaction with
106 .Xr loader 8 .
107 .Pp
108 .It Ic initialize
109 Initialize the supporting library so commands can be used without
110 executing
111 .Ic start
112 first.
113 Like
114 .Ic start ,
115 reads
116 .Pa /boot/defaults/loader.conf
117 and all other
118 .Xr loader.conf 5
119 files specified in it.
120 Returns a flag on the stack to indicate
121 if any configuration file was successfully loaded.
122 .Pp
123 .It Ic read-conf Ar filename
124 Reads and processes a
125 .Xr loader.conf 5
126 file.
127 Does not proceed to boot.
128 .Pp
129 .It Ic enable-module Ar module
130 Enables the loading of
131 .Ar module .
132 .Pp
133 .It Ic disable-module Ar module
134 Disables the loading of
135 .Ar module .
136 .Pp
137 .It Ic toggle-module Ar module
138 Toggles the loading of
139 .Ar module
140 on and off.
141 .Pp
142 .It Ic show-module Ar module
143 Shows the information gathered in the
144 .Xr loader.conf 5
145 files about the module
146 .Ar module .
147 .Pp
148 .It Ic retry
149 Used inside
150 .Xr loader.conf 5
151 files to specify the action after a module loading fails.
152 .Pp
153 .It Ic ignore
154 Used inside
155 .Xr loader.conf 5
156 files to specify the action after a module loading fails.
157 .El
158 .Sh FILES
159 .Bl -tag -width /boot/loader.4th -compact
160 .It Pa /boot/loader
161 The
162 .Xr loader 8 .
163 .It Pa /boot/loader.4th
164 .Nm
165 itself.
166 .It Pa /boot/loader.rc
167 .Xr loader 8
168 bootstrapping script.
169 .It Pa /boot/defaults/loader.conf
170 File loaded by the
171 .Ic start
172 command.
173 .El
174 .Sh EXAMPLES
175 Standard
176 .Pa /boot/loader.rc :
177 .Pp
178 .Bd -literal -offset indent -compact
179 include /boot/loader.4th
180 start
181 .Ed
182 .Pp
183 Load a different kernel with the standard configuration:
184 .Pp
185 .Bd -literal -offset indent -compact
186 set kernel="kernel.old"
187 unload
188 boot-conf
189 .Ed
190 .Pp
191 Read an additional configuration file and then proceed to boot:
192 .Pp
193 .Bd -literal -offset indent -compact
194 unload
195 read-conf /boot/special.conf
196 boot-conf
197 .Ed
198 .Pp
199 Disable the loading of the splash screen module and bitmap and then
200 proceed to boot:
201 .Pp
202 .Bd -literal -offset indent -compact
203 unload
204 disable-module splash_bmp
205 disable-module bitmap
206 boot-conf
207 .Ed
208 .Sh SEE ALSO
209 .Xr loader.conf 5 ,
210 .Xr loader 8
211 .Sh HISTORY
212 The
213 .Nm
214 set of commands first appeared in
215 .Fx 3.2 .
216 .Sh AUTHORS
217 The
218 .Nm
219 set of commands was written by
220 .An Daniel C. Sobral Aq dcs@FreeBSD.org .
221 .Sh BUGS
222 A British espionage series.