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