sys/boot/common/help.common

   1 ################################################################################
   2 # Thelp DDisplay command help
   3
   4         help [topic [subtopic]]
   5         help index
   6         ?
   7
   8         The help command displays help on commands and their usage.
   9
  10         In command help, a term enclosed with <...> indicates a value as
  11         described by the term.  A term enclosed with [...] is optional,
  12         and may not be required by all forms of the command.
  13
  14         Some commands may not be available in `help'.  Use the `?' command
  15         to list most available commands.
  16
  17         To boot another kernel than the default in kernel/, change directory
  18         to the kernel directory, and execute `loadall' and `boot' commands.
  19         E.g. to do a verbose boot of kernel in kernel.XXX/:
  20
  21                 cd
  22                 cd kernel.XXX
  23                 loadall
  24                 boot -v
  25
  26         If needed, disable the ACPI driver with:
  27
  28                 unset acpi_load
  29                 set hint.acpi.0.disabled=1
  30
  31         If needed, disable the AHCI driver with:
  32
  33                 unset ahci_load
  34                 set hint.ahci.0.disabled=1
  35
  36         If needed, disable the EHCI driver with:
  37
  38                 unset ehci_load
  39                 set hint.ehci.0.disabled=1
  40
  41         For more information on ACPI, AHCI and EHCI use `help' on these topics.
  42
  43 ################################################################################
  44 # T<variable>=<value> DAssign value to variable
  45
  46         <variable>=<value>
  47
  48         Assign value to variable.  Value is always assigned to local variable
  49         <variable>.  If <variable> is in list of known kernel environment
  50         variables or is a kernel tunable, it is also assigned to the kernel
  51         environment variable of the given name.
  52         <variable> is unset if <value> is empty.
  53
  54         Two kinds of variables are maintained by this program (loader(8)):
  55         local variables, that is for loader(8) use only, and kernel
  56         environment variables, that kernel will have access to when it starts.
  57         The assignment described above, will assign to a local variable and,
  58         if it seems applicable, also snoop assignment to kernel environment
  59         variable.
  60
  61 ################################################################################
  62 # TAHCI DControl AHCI module behaviour
  63
  64         $ahci_load
  65
  66         The AHCI driver provides support for SATA controllers conforming to
  67         the Advanced Host Controller Interface specification.
  68
  69         The NATA driver provides support for some AHCI controllers, the AHCI
  70         driver is used if both NATA and AHCI drivers provides support for a
  71         controller.  If AHCI driver is disabled, NATA driver will be used.
  72
  73         If the ahci_load variable is set, the AHCI module will be loaded.
  74         The AHCI driver can be disabled with:
  75
  76                 unset ahci_load
  77                 set hint.ahci.0.disabled=1
  78
  79         A link speed of 1.5Gb/s can be enforced with:
  80
  81                 set hint.ahci.force150=1
  82
  83         To refrain from attempting to send some higher level ATA commands
  84         which some devices might not properly implement use:
  85
  86                 set hint.ahci.nofeatures=1
  87
  88         See ahci.4 man page (on booted system) for full description.
  89
  90 ################################################################################
  91 # Tautoboot DBoot after a delay
  92
  93         autoboot [<delay> [<prompt>]]
  94
  95         Displays <prompt> or a default prompt, and counts down <delay> seconds
  96         before attempting to boot.  If <delay> is not specified, the default
  97         value is 10.
  98
  99 ################################################################################
 100 # Tboot DBoot immediately
 101
 102         boot [-<flag> ...] [<kernelname>]
 103
 104         Boot the system.  If flags are specified, they are added to the
 105         arguments for the kernel.  If <kernelname> is specified, and a kernel
 106         has not already been loaded, it will be booted instead of the default
 107         kernel.  <flag> values include:
 108         -a  Same as `set boot_askname'
 109         -C  Same as `set boot_cdrom'
 110         -c  Same as `set boot_userconfig'
 111         -d  Same as `set boot_ddb'
 112         -g  Same as `set boot_gdb'
 113         -h  Same as `set boot_serial'
 114         -m  Mute the system console
 115         -p  Pause after each attached device during device probing phase
 116         -r  Use statically configured device for root file system
 117         -s  Same as `set boot_single'
 118         -V  Same as `set boot_vidcons'
 119         -v  Same as `set boot_verbose'
 120
 121         <flag>s can also be set via kernel_options variable.
 122         See also boot.8 man page (on booted system) for <flag> values.
 123
 124 ################################################################################
 125 # Techo DEcho arguments
 126
 127         echo [-n] [<message>]
 128
 129         Emits <message>, with no trailing newline if -n is specified.  This is
 130         most useful in conjunction with scripts and the '@' line prefix.
 131
 132         Variables are substituted by prefixing them with $, e.g.
 133
 134                 echo Current device is $currdev
 135
 136         will print the current device.
 137
 138 ################################################################################
 139 # TEHCI DControl EHCI module behaviour
 140
 141         $ehci_load
 142
 143         The EHCI driver provides support for the USB Enhanched Host Controller
 144         Interface, which is used by USB 2.0 controllers.
 145
 146         If the ehci_load variable is set, the EHCI module will be loaded.
 147         The EHCI driver can be disabled with:
 148
 149                 unset ehci_load
 150                 set hint.ehci.0.disabled=1
 151
 152         See ehci.4 man page (on booted system) for full description.
 153
 154 ################################################################################
 155 # Tload DLoad a kernel or module
 156
 157         load [-t <type>] <file> [<argument> ...]
 158
 159         Loads the module contained in <file> into memory.  If no other modules
 160         are loaded, <file> must be a kernel or the command will fail.
 161
 162         If -t is specified, the module is loaded as raw data of <type>, for
 163         later use by the kernel or other modules.  <type> may be any string.
 164
 165         Any arguments passed after the name of the file to be loaded will be
 166         passed as arguments to that file.
 167
 168 ################################################################################
 169 # Tls DList files
 170
 171         ls [-l] [<path>]
 172
 173         Displays a listing of files in the directory <path>, or the root
 174         directory of the current device if <path> is not specified.
 175
 176         The -l argument displays file sizes as well; the process of obtaining
 177         file sizes on some media may be very slow.
 178
 179 ################################################################################
 180 # Tlsdev DList all devices
 181
 182         lsdev [-v]
 183
 184         List all devices.  Disk slices and partitions from which it may be
 185         possible to load modules are marked with '*'.
 186         If -v is specified, print more details, like size and position of
 187         disk slices and partitions.
 188
 189 ################################################################################
 190 # Tlsmod DList modules
 191
 192         lsmod [-v]
 193
 194         List loaded modules.  If -v is specified, print more details.
 195
 196 ################################################################################
 197 # Tmore DPage files
 198
 199         more <file> ...
 200
 201         Show contents of text files.  When displaying the contents of more,
 202         than one file, if the user elects to quit displaying a file, the
 203         remaining files will not be shown.
 204
 205 ################################################################################
 206 # Tpnpscan DScan for PnP devices
 207
 208         pnpscan [-v]
 209
 210         Scan for Plug-and-Play devices.  This command is normally automatically
 211         run as part of the boot process, in order to dynamically load modules
 212         required for system operation.
 213
 214         If the -v argument is specified, details on the devices found will
 215         be printed.
 216
 217 ################################################################################
 218 # Tset DSet a kernel environment variable
 219
 220         set <env_variable>
 221         set <env_variable>=<value>
 222
 223         The set command is used to set kernel environment variables.
 224
 225         See also `<variable>=<value>' command for distinction on local and
 226         kernel environment variables.
 227
 228 ################################################################################
 229 # Tset Sautoboot_delay DSet the default autoboot delay
 230
 231         set autoboot_delay=<value>
 232
 233         Sets the default delay for the autoboot command to <value> seconds.
 234
 235 ################################################################################
 236 # Tset Sbootfile DSet the default boot file set
 237
 238         set bootfile=<file>[;<file>...]
 239
 240         Sets the default set of kernel boot filename(s).  It may be overridden
 241         by setting the bootfile variable to a semicolon-separated list of
 242         filenames, each of which will be searched for in the module_path
 243         directories.  The default bootfile set is "kernel".
 244
 245 ################################################################################
 246 # Tset Sboot_askname DPrompt for root device
 247
 248         set boot_askname
 249
 250         Instructs the kernel to prompt the user for the name of the root device
 251         when the kernel is booted.
 252
 253 ################################################################################
 254 # Tset Sboot_cdrom DBoot from CDROM
 255
 256         set boot_cdrom
 257
 258         Instructs the kernel to boot from CDROM when the kernel is booted.
 259
 260 ################################################################################
 261 # Tset Sboot_ddb DDrop to the kernel debugger (DDB)
 262
 263         set boot_ddb
 264
 265         Instructs the kernel to start in the DDB debugger, rather than
 266         proceeding to initialise when booted.
 267
 268 ################################################################################
 269 # Tset Sboot_gdb DSelect gdb-remote mode
 270
 271         set boot_gdb
 272
 273         Selects gdb-remote mode for the kernel debugger by default.
 274
 275 ################################################################################
 276 # Tset Sboot_single DStart system in single-user mode
 277
 278         set boot_single
 279
 280         Prevents the kernel from initiating a multi-user startup, single-user
 281         mode will be entered when the kernel has finished device probes.
 282
 283 ################################################################################
 284 # Tset Sboot_serial DUse serial console after boot
 285
 286         set boot_serial
 287
 288         Use serial console after boot.  See also `set console' command.
 289
 290 ################################################################################
 291 # Tset Sboot_verbose DVerbose boot messages
 292
 293         set boot_verbose
 294
 295         Setting this variable causes extra debugging information to be printed
 296         by the kernel especially during the boot phase.
 297
 298 ################################################################################
 299 # Tset Sboot_vidcons DUse video console after boot
 300
 301         set boot_vidcons
 302
 303         Use video console after boot.  See also `set console' command.
 304
 305 ################################################################################
 306 # Tset Skernel_options DKernel options
 307
 308         set kernel_options
 309
 310         Set kernel boot flags.  E.g.:
 311
 312                 set kernel_options="-v -a"
 313
 314         See also boot command; kernel_options sets default <flags>.
 315
 316 ################################################################################
 317 # Tset Sconsole DSet the current console
 318
 319         set console[=<value>]
 320
 321         Sets the current console.  <value> include `vidconsole', `comconsole'
 322         and `nullconsole'.  If <value> is omitted, a list of valid consoles
 323         will be displayed.
 324
 325 ################################################################################
 326 # Tset Scurrdev DSet the current device
 327
 328         set currdev=<device>
 329
 330         Selects the default device.  See `lsdev' for available devices.
 331
 332 ################################################################################
 333 # Tset Sinit_path DSet the list of init candidates
 334
 335         set init_path=<path>[:<path>...]
 336
 337         Sets the list of binaries which the kernel will try to run as initial
 338         process.
 339
 340
 341 ################################################################################
 342 # Tset Smodule_path DSet the module search path
 343
 344         set module_path=<path>[;<path>...]
 345
 346         Sets the list of directories which will be searched in for modules
 347         named in a load command or implicitly required by a dependency.  An
 348         Empty <path> specifies the current directory.  The default module_path
 349         is ";modules".
 350
 351 ################################################################################
 352 # Tset Sprompt DSet the command prompt
 353
 354         set prompt=<value>
 355
 356         The command prompt is displayed when the loader is waiting for input.
 357         Variable substitution is performed on the prompt.  The default value
 358         is "OK".
 359
 360 ################################################################################
 361 # Tset Srootdev DSet the root filesystem
 362
 363         set rootdev=<path>
 364
 365         By default the value of $currdev is used to set the root filesystem
 366         when the kernel is booted.  This can be overridden by setting
 367         $rootdev explicitly.
 368
 369 ################################################################################
 370 # Tset Stunables DSet kernel tunable values
 371
 372         Various kernel tunable parameters can be overridden by specifying new
 373         values in the environment.
 374
 375         set hw.pci.allow_unsupported_io_range=<value>
 376
 377                 Allow the PCI Bridge to pass through an unsupported
 378                 memory range assigned by the BIOS.
 379
 380                 value is 0 (default) or non-zero to enable.
 381
 382         set hw.pci.enable_io_modes=<value>
 383
 384                 Enable PCI resources which are left off by some BIOSes
 385                 or are not enabled correctly by the device driver.
 386
 387                 value is 1 (default), but this may cause problems with
 388                 some peripherals.  Set to 0 to disable.
 389
 390         set hw.physmem=<value>                  MAXMEM
 391
 392                 Limits the amount of physical memory space available to
 393                 the system to <value> bytes.  <value> may have a `k', `M' or
 394                 `G' suffix to indicate kilobytes, megabytes and gigabytes
 395                 respectively.  Note that the current i386 architecture
 396                 limits this value to 4GB.
 397
 398                 On systems where memory cannot be accurately probed,
 399                 this option provides a hint as to the actual size of
 400                 system memory (which will be tested before use).
 401
 402         set hw.syscons.sc_no_suspend_vtswitch=<value>
 403
 404                 Disable VT switching on suspend.
 405
 406                 value is 0 (default) or non-zero to enable.
 407
 408         set kern.emergence_intr_enable=<value>
 409
 410                 Setting this to 1 enables emergency interrupt polling.  All
 411                 interrupt handlers are executed periodically.  This mode is
 412                 very expensive and should only be used to get a system
 413                 accessible when interrupt routing is otherwise broken.  It
 414                 is primarily used by kernel developers to debug new systems.
 415
 416         set kern.emergence_intr_freq=<value>
 417
 418                 Set the polling rate for the emergency interrupt polling
 419                 code.  The default is 10 (hz) to dissuade causual use.  If
 420                 you are doing real work with emergency interrupt polling
 421                 mode enabled, it is recommended that you use a frequency
 422                 between 100hz and 300hz.
 423
 424         set kern.ipc.nmbclusters=<value>        NMBCLUSTERS
 425
 426                 Set the number of mbuf clusters to be allocated.  The value
 427                 cannot be set below the default determined when the kernel
 428                 was compiled.
 429
 430         set kern.vm.kmem.size=<value>
 431
 432                 Sets the size of kernel memory (bytes).  This overrides
 433                 the value determined when the kernel was compiled.
 434
 435         set machdep.disable_mtrrs=1
 436
 437                 Disable the use of i686 MTRRs (i386 only)
 438
 439         set net.inet.tcp.tcbhashsize=<value>    TCBHASHSIZE
 440
 441                 Overrides the compile-time set value of TCBHASHSIZE or
 442                 the preset default of 512.  Must be a power of 2.
 443
 444         set vfs.root.mountfrom=<value>
 445
 446                 Specify root file system.  <value> is a semicolon separated
 447                 list of file systems.  File system format is file system type
 448                 and disk store, separated by colon.  This variable needs to be
 449                 set when using boot-only partition, which is typically mounted
 450                 on root file system as /boot.
 451
 452                 One file system example:
 453                         hammer:da8se1a
 454
 455                 One file system HAMMER multi volume examples:
 456                         hammer:da8s1a:da9s1a
 457
 458                 Several file systems, boot list, example:
 459                         ufs:da0s1a;hammer:ad1s1d
 460
 461                 Each file system in the list will be tried in the order
 462                 specified until the mount succeeds.  If all fail, the
 463                 `mountroot>' prompt is displayed for manual entry.
 464
 465                 You may not specify devtab labels here but you can specify
 466                 paths available to devfs such as:
 467                         hammer:serno/L41JYE0G.s1d
 468
 469 ################################################################################
 470 # Tshow DShow values of kernel environment variable
 471
 472         show [<env_variable>]
 473
 474         Displays the value of <env_variable>, or all kernel environment
 475         variables if not specified.
 476
 477         See also `<variable>=<value>' command for distinction on local and
 478         kernel environment variables.
 479
 480 ################################################################################
 481 # Tinclude DExecute script file
 482
 483         include <file> ...
 484
 485         The entire contents of <file> are read into memory before executing
 486         commands, so it is safe to source a file from removable media.
 487
 488 ################################################################################
 489 # Toptinclude DExecute script file; ignore exit status
 490
 491         optinclude <file> ...
 492
 493         The entire contents of <file> are read into memory before executing
 494         commands, so it is safe to source a file from removable media.
 495         Return success and execute all commands even if some commands fail.
 496
 497 ################################################################################
 498 # Tcd DChange directory
 499
 500         cd [<directory>]
 501
 502         Change working directory to <directory>.  Default is $base.
 503
 504 ################################################################################
 505 # Toptcd DChange directory; ignore exit status
 506
 507         optcd [<directory>]
 508
 509         Change working directory to <directory>.  Default is $base.
 510         Return success even if changing directory fails.
 511
 512 ################################################################################
 513 # Tpwd DPrint working directory
 514
 515         pwd
 516
 517         Show working directory.
 518
 519 ################################################################################
 520 # Tlocal DList local variables
 521
 522         local [<local_variable> ...]
 523
 524         Display the value of given local variables, or all variables if not
 525         specified.
 526
 527         See also `<variable>=<value>' command for distinction on local and
 528         kernel environment variables.
 529
 530 ################################################################################
 531 # Tlunset DUnset local variable
 532
 533         lunset <local_variable>
 534
 535         Unset local variable: discard value and remove variable.
 536
 537         See also `<variable>=<value>' command for distinction on local and
 538         kernel environment variables.
 539
 540 ################################################################################
 541 # Tlunsetif DUnset local variables if envvar true
 542
 543         lunsetif <local_variable> <env_variable>
 544
 545         Unset <local_variable> if <env_variable> is true, i.e. set to 1 or YES.
 546
 547         See also `<variable>=<value>' command for distinction on local and
 548         kernel environment variables.
 549
 550 ################################################################################
 551 # Tloadall DLoad kernel + modules
 552
 553         loadall
 554
 555         Load kernel and all modules specified by MODULE_load variables.
 556
 557 ################################################################################
 558 # Tmenuclear DClear all menus
 559
 560         menuclear
 561
 562         Clear all menu bullets.
 563
 564 ################################################################################
 565 # Tmenuitem DAdd menu bullet
 566
 567         menuitem <key> <description text>
 568
 569         Start new menu bullet, when running menu system bullet is choosen by
 570         pressing <key>.  E.g.:
 571
 572                 menuitem a "Boot Backup kernel kernel.alt"
 573
 574 ################################################################################
 575 # Tmenuadd DAdd script line for menu bullet
 576
 577         menuadd <command line>
 578
 579         Add script line for current menu bullet.  E.g.:
 580
 581                 menuadd lunsetif acpi_load hint.acpi.0.disabled
 582
 583 ################################################################################
 584 # Tmenu DRun menu system
 585
 586         menu
 587
 588         Run menu system.
 589
 590 ################################################################################
 591 # Tread DRead input from the terminal
 592
 593         read [-t <value>] [-p <prompt>] [<env_variable>]
 594
 595         The read command reads a line of input from the terminal.  If the
 596         -t argument is specified, it will return nothing if no input has been
 597         received after <value> seconds.  (Any keypress will cancel the
 598         timeout).
 599
 600         If -p is specified, <prompt> is printed before reading input.  No
 601         newline is emitted after the prompt.
 602
 603         If a variable name is supplied, the variable is set to the value read,
 604         less any terminating newline.
 605
 606 ################################################################################
 607 # Tunload DRemove all modules from memory
 608
 609         unload
 610
 611         This command removes any kernel and all loaded modules from memory.
 612
 613 ################################################################################
 614 # Tunset DUnset a kernel environment variable
 615
 616         unset <env_variable>
 617
 618         If allowed, the named kernel environment variable's value is discarded
 619         and the variable is removed.
 620
 621         See also `<variable>=<value>' command for distinction on local and
 622         kernel environment variables.
 623
 624 ################################################################################