All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: head/sys/boot/forth/loader.4th.8 101824 2002-08-13 15:09:33Z ru $
.Dd April 25, 1999 .Dt LOADER.4TH 8 .Os .Sh NAME .Nm loader.4th .Nd loader.conf processing tools .Sh DESCRIPTION The file that goes by the name of .Nm is a set of commands designed to manipulate .Xr loader.conf 5 files. The default
a /boot/loader.rc includes .Nm and uses one of its commands to automatically read and process the standard .Xr loader.conf 5 files. Other commands exists to help the user specify alternate configurations.
p The commands of .Nm by themselves are not enough for most uses. Please refer to the examples below for the most common situations, and to .Xr loader 8 for additional commands.
p Before using any of the commands provided in .Nm , it must be included through the command:
p .Dl include loader.4th
p This line is present in the default
a /boot/loader.rc file, so it isn't needed (and should not be re-issued) in a normal setup.
p The commands provided by it are: l -tag -width disable-module_module -compact -offset indent t Ic boot t Ic boot Ar kernelname Op Cm ... t Ic boot Ar directory Op Cm ... t Ic boot Fl flag Cm ... Boot as specified by the .Xr loader.conf 5 files read.
p Depending on the arguments passed, it can override boot flags and either the kernel name or the search path for kernel and modules.
p t Ic boot-conf t Ic boot-conf Ar kernelname Op Cm ... t Ic boot-conf Ar directory Op Cm ... t Ic boot-conf Fl flag Cm ... Works like c boot described above, but instead of booting immediately, uses c autoboot , so it can be stopped.
p t Ic start Reads
a /boot/defaults/loader.conf , all other .Xr loader.conf 5 files specified in it, and then proceeds to boot as specified in them. This is the command used in the default
a /boot/loader.rc file, and it uses the
a autoboot command (see .Xr loader 8 ) , so it can be stopped for further interaction with .Xr loader 8 .
p t Ic initialize Initialize the supporting library so commands can be used without executing c start first. Like c start , reads
a /boot/defaults/loader.conf and all other .Xr loader.conf 5 files specified in it. Returns a flag on the stack to indicate if any configuration file was successfully loaded.
p t Ic read-conf Ar filename Reads and processes a .Xr loader.conf 5 file. Does not proceed to boot.
p t Ic enable-module Ar module Enables the loading of .Ar module .
p t Ic disable-module Ar module Disables the loading of .Ar module .
p t Ic toggle-module Ar module Toggles the loading of .Ar module on and off.
p t Ic show-module Ar module Shows the information gathered in the .Xr loader.conf 5 files about the module .Ar module .
p t Ic retry Used inside .Xr loader.conf 5 files to specify the action after a module loading fails.
p t Ic ignore Used inside .Xr loader.conf 5 files to specify the action after a module loading fails. .El .Sh FILES l -tag -width /boot/loader.4th -compact t Pa /boot/loader The .Xr loader 8 . t Pa /boot/loader.4th .Nm itself. t Pa /boot/loader.rc .Xr loader 8 bootstrapping script. t Pa /boot/defaults/loader.conf File loaded by the c start command. .El .Sh EXAMPLES Standard
p d -literal -offset indent -compact include /boot/loader.4th start .Ed
p Load a different kernel with the standard configuration:
p d -literal -offset indent -compact set kernel="/boot/kernel.old/kernel" unload boot-conf .Ed
p Read an additional configuration file and then proceed to boot:
p d -literal -offset indent -compact unload read-conf /boot/special.conf boot-conf .Ed
p Disable the loading of the splash screen module and bitmap and then proceed to boot:
p d -literal -offset indent -compact unload disable-module splash_bmp disable-module bitmap boot-conf .Ed .Sh SEE ALSO .Xr loader.conf 5 , .Xr loader 8 .Sh HISTORY The .Nm set of commands first appeared in .Fx 3.2 . .Sh AUTHORS The .Nm set of commands was written by .An Daniel C. Sobral Aq dcs@FreeBSD.org . .Sh BUGS A British espionage series.