1 LOADER.4TH(5)         Standards, Environments, and Macros        LOADER.4TH(5)
   2 
   3 NAME
   4      loader.4th - loader.conf processing tools
   5 
   6 DESCRIPTION
   7      The file that goes by the name of loader.4th is a set of commands
   8      designed to manipulate loader.conf(4) files.  The default /boot/loader.rc
   9      includes loader.4th and uses one of its commands to automatically read
  10      and process the standard loader.conf(4) files.  Other commands exists to
  11      help the user specify alternate configurations.
  12 
  13      The commands of loader.4th by themselves are not enough for most uses.
  14      Please refer to the examples below for the most common situations, and to
  15      loader(5) for additional commands.
  16 
  17      Before using any of the commands provided in loader.4th, it must be
  18      included through the command:
  19 
  20            include loader.4th
  21 
  22      This line is present in the default /boot/loader.rc file, so it is not
  23      needed (and should not be re-issued) in a normal setup.
  24 
  25      The commands provided by it are:
  26            boot
  27            boot kernelname [...]
  28            boot directory [...]
  29            boot -flag ...         Boot as specified by the loader.conf(4)
  30                                   files read.
  31 
  32                                   Depending on the arguments passed, it can
  33                                   override boot flags and either the kernel
  34                                   name or the search path for kernel and
  35                                   modules.
  36 
  37            boot-conf
  38            boot-conf kernelname [...]
  39            boot-conf directory [...]
  40            boot-conf -flag ...    Works like boot described above, but instead
  41                                   of booting immediately, uses autoboot, so it
  42                                   can be stopped.
  43 
  44            start                  Reads /boot/defaults/loader.conf, all other
  45                                   loader.conf(4) files specified in it, then
  46                                   loads the desired kernel and modules (if not
  47                                   already loaded).  After which you can use
  48                                   the boot or autoboot commands or simply exit
  49                                   (provided autoboot_delay is not set to NO)
  50                                   to boot the system.  start is the command
  51                                   used in the default /boot/loader.rc file
  52                                   (see loader(5)).
  53 
  54            initialize             Initialize the support library so commands
  55                                   can be used without executing start first.
  56                                   Like start, it reads
  57                                   /boot/defaults/loader.conf and all other
  58                                   loader.conf(4) files specified in it (but
  59                                   does not load kernel or modules).  Returns a
  60                                   flag on the stack to indicate if any
  61                                   configuration files were successfully
  62                                   loaded.
  63 
  64            read-conf filename     Reads and processes a loader.conf(4) file.
  65                                   Does not proceed to boot.
  66 
  67            enable-module module   Enables the loading of module.
  68 
  69            disable-module module  Disables the loading of module.
  70 
  71            toggle-module module   Toggles the loading of module on and off.
  72 
  73            show-module module     Shows the information gathered in the
  74                                   loader.conf(4) files about the module
  75                                   module.
  76 
  77            show-module-options    Shows all modules defined in current
  78                                   loader.conf(4) configuration.
  79 
  80            retry                  Used inside loader.conf(4) files to specify
  81                                   the action after a module loading fails.
  82 
  83            ignore                 Used inside loader.conf(4) files to specify
  84                                   the action after a module loading fails.
  85            try-include file [file ...]
  86                                   Process script files if they exist.  Each
  87                                   file, in turn, is completely read into
  88                                   memory, and then each of its lines is passed
  89                                   to the command line interpreter.  If any
  90                                   error is returned by the interpreter, the
  91                                   try-include command aborts immediately,
  92                                   without reading any other files, and
  93                                   silently returns without error.
  94 
  95 FILES
  96      /boot/loader            The loader(5).
  97      /boot/forth/loader.4th  loader.4th itself.
  98      /boot/loader.rc         loader(5) bootstrapping script.
  99      /boot/defaults/loader.conf
 100                              File loaded by the start command.
 101 
 102 EXAMPLES
 103      Standard /boot/loader.rc:
 104 
 105            include /boot/forth/loader.4th
 106            start
 107 
 108      Read an additional configuration file and then proceed to boot:
 109 
 110            unload
 111            read-conf /boot/special.conf
 112            boot-conf
 113 
 114 SEE ALSO
 115      loader.conf(4), loader(5)
 116 
 117 illumos                         April 22, 2017                         illumos