sys/boot/common/help.common

   1 ################################################################################
   2 # Thelp DDisplay command help
   3
   4         help [topic [subtopic]]
   5         ?
   6
   7         The help command displays help on commands and their usage.
   8
   9         In command help, a term enclosed with <...> indicates a value as
  10         described by the term.  A term enclosed with [...] is optional,
  11         and may not be required by all forms of the command.
  12
  13         Some commands may not be availalble.  Use the '?' command to list
  14         most available commands.
  15
  16 ################################################################################
  17 # Tautoboot DBoot after a delay
  18
  19         autoboot [<delay> [<prompt>]]
  20
  21         Displays <prompt> or a default prompt, and counts down <delay> seconds
  22         before attempting to boot.  If <delay> is not specified, the default
  23         value is 10.
  24
  25 ################################################################################
  26 # Tboot DBoot immediately
  27
  28         boot [<kernelname>] [-<arg> ...]
  29
  30         Boot the system.  If arguments are specified, they are added to the
  31         arguments for the kernel.  If <kernelname> is specified, and a kernel
  32         has not already been loaded, it will be booted instead of the default
  33         kernel.
  34
  35 ################################################################################
  36 # Techo DEcho arguments
  37
  38         echo [-n] [<message>]
  39
  40         Emits <message>, with no trailing newline if -n is specified.  This is
  41         most useful in conjunction with scripts and the '@' line prefix.
  42
  43         Variables are substituted by prefixing them with $, eg.
  44
  45                 echo Current device is $currdev
  46
  47         will print the current device.
  48
  49 ################################################################################
  50 # Tload DLoad a kernel or module
  51
  52         load [-t <type>] <filename>
  53
  54         Loads the module contained in <filename> into memory.  If no other
  55         modules are loaded, <filename> must be a kernel or the command will
  56         fail.
  57
  58         If -t is specified, the module is loaded as raw data of <type>, for
  59         later use by the kernel or other modules.  <type> may be any string.
  60
  61 ################################################################################
  62 # Tls DList files
  63
  64         ls [-l] [<path>]
  65
  66         Displays a listing of files in the directory <path>, or the root
  67         directory of the current device if <path> is not specified.
  68
  69         The -l argument displays file sizes as well; the process of obtaining
  70         file sizes on some media may be very slow.
  71
  72 ################################################################################
  73 # Tlsdev DList devices
  74
  75         lsdev [-v]
  76
  77         List all of the devices from which it may be possible to load modules.
  78         If -v is specified, print more details.
  79
  80 ################################################################################
  81 # Tlsmod DList modules
  82
  83         lsmod [-v]
  84
  85         List loaded modules. If [-v] is specified, print more details.
  86
  87 ################################################################################
  88 # Tmore DPage files
  89
  90         more <filename> [<filename> ...]
  91
  92         Show contents of text files. When displaying the contents of more,
  93         than one file, if the user elects to quit displaying a file, the
  94         remaining files will not be shown.
  95
  96 ################################################################################
  97 # Tpnpscan DScan for PnP devices
  98
  99         pnpscan [-v]
 100
 101         Scan for Plug-and-Play devices.  This command is normally automatically
 102         run as part of the boot process, in order to dynamically load modules
 103         required for system operation.
 104
 105         If the -v argument is specified, details on the devices found will
 106         be printed.
 107
 108 ################################################################################
 109 # Tset DSet a variable
 110
 111         set <variable name>
 112         set <variable name>=<value>
 113
 114         The set command is used to set variables.
 115
 116 ################################################################################
 117 # Tset Sautoboot_delay DSet the default autoboot delay
 118
 119         set autoboot_delay=<value>
 120
 121         Sets the default delay for the autoboot command to <value> seconds.
 122
 123 ################################################################################
 124 # Tset Sbootfile DSet the default boot file set
 125
 126         set bootfile=<filename>[,<filename>...]
 127
 128         The default search path for bootable kernels is /kernel,/kernel.old.
 129         It may be overridden by setting the bootfile variable to a
 130         semicolon-separated list of paths, which will be searched for in turn.
 131
 132 ################################################################################
 133 # Tset Sboot_askname DPrompt for root device
 134
 135         set boot_askname
 136
 137         Instructs the kernel to prompt the user for the name of the root device
 138         when the kernel is booted.
 139
 140 ################################################################################
 141 # Tset Sboot_ddb DDrop to the kernel debugger (DDB)
 142
 143         set boot_ddb
 144
 145         Instructs the kernel to start in the DDB debugger, rather than
 146         proceeding to initialise when booted.
 147
 148 ################################################################################
 149 # Tset Sboot_gdb DSelect gdb-remote mode
 150
 151         set boot_gdb
 152
 153         Selects gdb-remote mode for the kernel debugger by default.
 154
 155 ################################################################################
 156 # Tset Sboot_single DStart system in single-user mode
 157
 158         set boot_single
 159
 160         Prevents the kernel from initiating a multi-user startup, single-user
 161         mode will be entered when the kernel has finished device probes.
 162
 163 ################################################################################
 164 # Tset Sboot_verbose DVerbose boot messages
 165
 166         set boot_verbose
 167
 168         Setting this variable causes extra debugging information to be printed
 169         by the kernel during the boot phase.
 170
 171 ################################################################################
 172 # Tset Sconsole DSet the current console
 173
 174         set console[=<value>]
 175
 176         Sets the current console.  If <value> is omitted, a list of valid
 177         consoles will be displayed.
 178
 179 ################################################################################
 180 # Tset Scurrdev DSet the current device
 181
 182         set currdev=<device>
 183
 184         Selects the default device.  Syntax for devices is odd.
 185
 186 ################################################################################
 187 # Tset Sinit_path DSet the list of init candidates
 188
 189         set init_path=<path>[:<path>...]
 190
 191         Sets the list of binaries which the kernel will try to run as initial
 192         process.
 193
 194
 195 ################################################################################
 196 # Tset Smodule_path DSet the module search path
 197
 198         set module_path=<path>[:<path>...]
 199
 200         Sets the list of directories which will be searched in for modules
 201         named in a load command or implicitly required by a dependancy.
 202
 203 ################################################################################
 204 # Tset Sprompt DSet the command prompt
 205
 206         set prompt=<value>
 207
 208         The command prompt is displayed when the loader is waiting for input.
 209         Variable substitution is performed on the prompt.  The default
 210         prompt can be set with:
 211
 212                 set prompt=\$currdev>
 213
 214 ################################################################################
 215 # Tset Srootdev DSet the root filesystem
 216
 217         set rootdev=<path>
 218
 219         By default the value of $currdev is used to set the root filesystem
 220         when the kernel is booted.  This can be overridden by setting
 221         $rootdev explicitly.
 222
 223 ################################################################################
 224 # Tset Stunables DSet kernel tunable values
 225
 226         Various kernel tunable parameters can be overriden by specifying new
 227         values in the environment.
 228
 229         set kern.ipc.nmbclusters=<value>        NMBCLUSTERS
 230
 231                 Set the number of mbuf clusters to be allocated.  The value
 232                 cannot be set below the default determined when the kernel
 233                 was compiled.
 234
 235         set kern.vm.kmem.size=<value>           VM_KMEM_SIZE
 236
 237                 Sets the size of kernel memory (bytes).  This overrides
 238                 completely the value determined when the kernel was
 239                 compiled.
 240
 241         set machdep.pccard.pcic_irq=<value>
 242
 243                 Overrides the IRQ normally assigned to a PCCARD controller.
 244                 Typically the first available interrupt will be allocated,
 245                 which may conflict with other hardware.  If this value is
 246                 set to 0, an interrupt will not be assigned and the
 247                 controller will operate in polled mode only.
 248
 249         set machdep.bios.pnp=disable
 250
 251                 Disable the use of the PnP BIOS (i386 only)
 252
 253         set machdep.bios.pci=disable
 254
 255                 Disable the use of the PCI BIOS (i386 only)
 256
 257         set net.inet.tcp.tcbhashsize=<value>    TCBHASHSIZE
 258
 259                 Overrides the compile-time set value of TCBHASHSIZE or
 260                 the preset default of 512.  Must be a power of 2.
 261
 262         set hw.physmem=<value>                  MAXMEM (i386 only)
 263
 264                 Limits the amount of physical memory space available to
 265                 the system to <value> bytes.  <value> may have a k, M or G
 266                 suffix to indicate kilobytes, megabytes and gigabytes
 267                 respectively.  Note that the current i386 architecture
 268                 limits this value to 4GB.
 269
 270                 On systems where memory cannot be accurately probed,
 271                 this option provides a hint as to the actual size of
 272                 system memory (which will be tested before use).
 273
 274 ################################################################################
 275 # Tshow DShow the values of variables
 276
 277         show [<variable>]
 278
 279         Displays the value of <variable>, or all variables if not specified.
 280         Multiple paths can be separated with a semicolon.
 281
 282 ################################################################################
 283 # Tinclude DRead commands from a script file
 284
 285         include <filename> [<filename> ...]
 286
 287         The entire contents of <filename> are read into memory before executing
 288         commands, so it is safe to source a file from removable media.
 289
 290 ################################################################################
 291 # Tread DRead input from the terminal
 292
 293         read [-t <value>] [-p <prompt>] [<variable name>]
 294
 295         The read command reads a line of input from the terminal.  If the
 296         -t argument is specified, it will return nothing if no input has been
 297         received after <value> seconds.  (Any keypress will cancel the
 298         timeout).
 299
 300         If -p is specified, <prompt> is printed before reading input. No
 301         newline is emitted after the prompt.
 302
 303         If a variable name is supplied, the variable is set to the value read,
 304         less any terminating newline.
 305
 306 ################################################################################
 307 # Tunload DRemove all modules from memory
 308
 309         unload
 310
 311         This command removes any kernel and all loaded modules from memory.
 312
 313 ################################################################################
 314 # Tunset DUnset a variable
 315
 316         unset <variable name>
 317
 318         If allowed, the named variable's value is discarded and the variable
 319         is removed.
 320
 321 ################################################################################