help.common revision 106842
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 Sets the default set of kernel boot filename(s). It may be overridden 129 by setting the bootfile variable to a semicolon-separated list of 130 filenames, each of which will be searched for in the module_path 131 directories. The default bootfile set is "kernel". 132 133################################################################################ 134# Tset Sboot_askname DPrompt for root device 135 136 set boot_askname 137 138 Instructs the kernel to prompt the user for the name of the root device 139 when the kernel is booted. 140 141################################################################################ 142# Tset Sboot_ddb DDrop to the kernel debugger (DDB) 143 144 set boot_ddb 145 146 Instructs the kernel to start in the DDB debugger, rather than 147 proceeding to initialise when booted. 148 149################################################################################ 150# Tset Sboot_gdb DSelect gdb-remote mode 151 152 set boot_gdb 153 154 Selects gdb-remote mode for the kernel debugger by default. 155 156################################################################################ 157# Tset Sboot_single DStart system in single-user mode 158 159 set boot_single 160 161 Prevents the kernel from initiating a multi-user startup, single-user 162 mode will be entered when the kernel has finished device probes. 163 164################################################################################ 165# Tset Sboot_verbose DVerbose boot messages 166 167 set boot_verbose 168 169 Setting this variable causes extra debugging information to be printed 170 by the kernel during the boot phase. 171 172################################################################################ 173# Tset Sconsole DSet the current console 174 175 set console[=<value>] 176 177 Sets the current console. If <value> is omitted, a list of valid 178 consoles will be displayed. 179 180################################################################################ 181# Tset Scurrdev DSet the current device 182 183 set currdev=<device> 184 185 Selects the default device. Syntax for devices is odd. 186 187################################################################################ 188# Tset Sinit_path DSet the list of init candidates 189 190 set init_path=<path>[:<path>...] 191 192 Sets the list of binaries which the kernel will try to run as initial 193 process. 194 195 196################################################################################ 197# Tset Smodule_path DSet the module search path 198 199 set module_path=<path>[;<path>...] 200 201 Sets the list of directories which will be searched in for modules 202 named in a load command or implicitly required by a dependancy. The 203 default module_path is "/boot/kernel;/boot/modules;/modules". 204 205################################################################################ 206# Tset Sprompt DSet the command prompt 207 208 set prompt=<value> 209 210 The command prompt is displayed when the loader is waiting for input. 211 Variable substitution is performed on the prompt. The default 212 prompt can be set with: 213 214 set prompt=\$currdev> 215 216################################################################################ 217# Tset Srootdev DSet the root filesystem 218 219 set rootdev=<path> 220 221 By default the value of $currdev is used to set the root filesystem 222 when the kernel is booted. This can be overridden by setting 223 $rootdev explicitly. 224 225################################################################################ 226# Tset Stunables DSet kernel tunable values 227 228 Various kernel tunable parameters can be overriden by specifying new 229 values in the environment. 230 231 set kern.ipc.nmbclusters=<value> NMBCLUSTERS 232 233 Set the number of mbuf clusters to be allocated. The value 234 cannot be set below the default determined when the kernel 235 was compiled. 236 237 set kern.vm.kmem.size=<value> VM_KMEM_SIZE 238 239 Sets the size of kernel memory (bytes). This overrides 240 completely the value determined when the kernel was 241 compiled. 242 243 set machdep.pccard.pcic_irq=<value> 244 245 Overrides the IRQ normally assigned to a PCCARD controller. 246 Typically the first available interrupt will be allocated, 247 which may conflict with other hardware. If this value is 248 set to 0, an interrupt will not be assigned and the 249 controller will operate in polled mode only. 250 251 set machdep.bios.pnp=disable 252 253 Disable the use of the PnP BIOS (i386 only) 254 255 set machdep.bios.pci=disable 256 257 Disable the use of the PCI BIOS (i386 only) 258 259 set machdep.disable_mtrrs=1 260 261 Disable the use of i686 MTRRs (i386 only) 262 263 set net.inet.tcp.tcbhashsize=<value> TCBHASHSIZE 264 265 Overrides the compile-time set value of TCBHASHSIZE or 266 the preset default of 512. Must be a power of 2. 267 268 set hw.physmem=<value> MAXMEM (i386 only) 269 270 Limits the amount of physical memory space available to 271 the system to <value> bytes. <value> may have a k, M or G 272 suffix to indicate kilobytes, megabytes and gigabytes 273 respectively. Note that the current i386 architecture 274 limits this value to 4GB. 275 276 On systems where memory cannot be accurately probed, 277 this option provides a hint as to the actual size of 278 system memory (which will be tested before use). 279 280################################################################################ 281# Tshow DShow the values of variables 282 283 show [<variable>] 284 285 Displays the value of <variable>, or all variables if not specified. 286 Multiple paths can be separated with a semicolon. 287 288################################################################################ 289# Tinclude DRead commands from a script file 290 291 include <filename> [<filename> ...] 292 293 The entire contents of <filename> are read into memory before executing 294 commands, so it is safe to source a file from removable media. 295 296################################################################################ 297# Tread DRead input from the terminal 298 299 read [-t <value>] [-p <prompt>] [<variable name>] 300 301 The read command reads a line of input from the terminal. If the 302 -t argument is specified, it will return nothing if no input has been 303 received after <value> seconds. (Any keypress will cancel the 304 timeout). 305 306 If -p is specified, <prompt> is printed before reading input. No 307 newline is emitted after the prompt. 308 309 If a variable name is supplied, the variable is set to the value read, 310 less any terminating newline. 311 312################################################################################ 313# Tunload DRemove all modules from memory 314 315 unload 316 317 This command removes any kernel and all loaded modules from memory. 318 319################################################################################ 320# Tunset DUnset a variable 321 322 unset <variable name> 323 324 If allowed, the named variable's value is discarded and the variable 325 is removed. 326 327################################################################################ 328