Next round of fixing all kinds of spelling mistakes.
[dragonfly.git] / sys / boot / common / loader.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/common/loader.8,v 1.57 2003/06/29 20:57:55 brueffer Exp $
26 .\" $DragonFly: src/sys/boot/common/loader.8,v 1.15 2007/05/17 08:19:02 swildner Exp $
27 .\"
28 .\" Note: The date here should be updated whenever a non-trivial
29 .\" change is made to the manual page.
30 .Dd May 11, 2006
31 .Dt LOADER 8
32 .Os
33 .Sh NAME
34 .Nm loader
35 .Nd kernel bootstrapping final stage
36 .Sh DESCRIPTION
37 The program called
38 .Nm
39 is the final stage of
40 .Dx Ns 's
41 kernel bootstrapping process.
42 On IA32 (i386) architectures, it is a
43 .Pa BTX
44 client.
45 It is linked statically to
46 .Xr libstand 3
47 and usually located in the directory
48 .Pa /boot .
49 .Pp
50 It provides a scripting language that can be used to
51 automate tasks, do pre-configuration or assist in recovery
52 procedures.
53 This scripting language is roughly divided in
54 two main components.
55 The smaller one is a set of commands
56 designed for direct use by the casual user, called "builtin
57 commands" for historical reasons.
58 The main drive behind these commands is user-friendliness.
59 The bigger component is an
60 .Tn ANS
61 Forth compatible Forth interpreter based on FICL, by
62 .An John Sadler .
63 .Pp
64 During initialization,
65 .Nm
66 will probe for a console and set the
67 .Va console
68 variable, or set it to serial console
69 .Pq Dq comconsole
70 if the previous boot stage used that.
71 Then, devices are probed,
72 .Va currdev
73 and
74 .Va loaddev
75 are set, and
76 .Va LINES
77 is set to 24.
78 Next,
79 .Tn FICL
80 is initialized, the builtin words are added to its vocabulary, and
81 .Pa /boot/boot.4th
82 is processed if it exists.
83 No disk switching is possible while that file is being read.
84 The inner interpreter
85 .Nm
86 will use with
87 .Tn FICL
88 is then set to
89 .Ic interpret ,
90 which is
91 .Tn FICL Ns 's
92 default.
93 After that,
94 .Pa /boot/loader.rc
95 is processed if available, and, failing that,
96 .Pa /boot/boot.conf
97 is read for historical reasons.
98 These files are processed through the
99 .Ic include
100 command, which reads all of them into memory before processing them,
101 making disk changes possible.
102 .Pp
103 At this point, if an
104 .Ic autoboot
105 has not been tried, and if
106 .Va autoboot_delay
107 is not set to
108 .Dq NO
109 (not case sensitive), then an
110 .Ic autoboot
111 will be tried.
112 If the system gets past this point,
113 .Va prompt
114 will be set and
115 .Nm
116 will engage interactive mode.
117 .Sh BUILTIN COMMANDS
118 In
119 .Nm ,
120 builtin commands take parameters from the command line.
121 Presently,
122 the only way to call them from a script is by using
123 .Pa evaluate
124 on a string.
125 If an error condition occurs, an exception will be generated,
126 which can be intercepted using
127 .Tn ANS
128 Forth exception handling
129 words.
130 If not intercepted, an error message will be displayed and
131 the interpreter's state will be reset, emptying the stack and restoring
132 interpreting mode.
133 .Pp
134 The builtin commands available are:
135 .Pp
136 .Bl -tag -width Ds -compact
137 .It Ic autoboot Op Ar seconds
138 Proceeds to bootstrap the system after a number of seconds, if not
139 interrupted by the user.
140 Displays a countdown prompt
141 warning the user the system is about to be booted,
142 unless interrupted by a key press.
143 The kernel will be loaded first if necessary.
144 Defaults to 10 seconds.
145 .Pp
146 .It Ic bcachestat
147 Displays statistics about disk cache usage.
148 For depuration only.
149 .Pp
150 .It Ic boot
151 .It Ic boot Ar kernelname Op Cm ...
152 .It Ic boot Fl flag Cm ...
153 Immediately proceeds to bootstrap the system, loading the kernel
154 if necessary.
155 Any flags or arguments are passed to the kernel, but they
156 must precede the kernel name, if a kernel name is provided.
157 .Pp
158 .Em WARNING :
159 The behavior of this builtin is changed if
160 .Xr loader.4th 8
161 is loaded.
162 .Pp
163 .It Ic echo Xo
164 .Op Fl n
165 .Op Aq message
166 .Xc
167 Displays text on the screen.
168 A new line will be printed unless
169 .Fl n
170 is specified.
171 .Pp
172 .It Ic heap
173 Displays memory usage statistics.
174 For debugging purposes only.
175 .Pp
176 .It Ic help Op topic Op subtopic
177 Shows help messages read from
178 .Pa /boot/loader.help .
179 The special topic
180 .Em index
181 will list the topics available.
182 .Pp
183 .It Ic include Ar file Op Ar
184 Process script files.
185 Each file, in turn, is completely read into memory,
186 and then each of its lines is passed to the command line interpreter.
187 If any error is returned by the interpreter, the include
188 command aborts immediately, without reading any other files, and
189 returns an error itself (see
190 .Sx ERRORS ) .
191 .Pp
192 .It Ic load Xo
193 .Op Fl t Ar type
194 .Ar file Cm ...
195 .Xc
196 Loads a kernel, kernel loadable module (kld), or file of opaque
197 contents tagged as being of the type
198 .Ar type .
199 Kernel and modules can be either in a.out or ELF format.
200 Any arguments passed after the name of the file to be loaded
201 will be passed as arguments to that file.
202 Currently, argument passing does not work for the kernel.
203 .Pp
204 .It Ic ls Xo
205 .Op Fl l
206 .Op Ar path
207 .Xc
208 Displays a listing of files in the directory
209 .Ar path ,
210 or the root directory if
211 .Ar path
212 is not specified.
213 If
214 .Fl l
215 is specified, file sizes will be shown too.
216 .Pp
217 .It Ic lsdev Op Fl v
218 Lists all of the devices from which it may be possible to load modules.
219 If
220 .Fl v
221 is specified, more details are printed.
222 .Pp
223 .It Ic lsmod Op Fl v
224 Displays loaded modules.
225 If
226 .Fl v
227 is specified, more details are shown.
228 .Pp
229 .It Ic more Ar file Op Ar
230 Display the files specified, with a pause at each
231 .Va LINES
232 displayed.
233 .Pp
234 .It Ic pnpscan Op Fl v
235 Scans for Plug-and-Play devices.
236 This is not functional at present.
237 .Pp
238 .It Ic read Xo
239 .Op Fl t Ar seconds
240 .Op Fl p Ar prompt
241 .Op Va variable
242 .Xc
243 Reads a line of input from the terminal, storing it in
244 .Va variable
245 if specified.
246 A timeout can be specified with
247 .Fl t ,
248 though it will be canceled at the first key pressed.
249 A prompt may also be displayed through the
250 .Fl p
251 flag.
252 .Pp
253 .It Ic reboot
254 Immediately reboots the system.
255 .Pp
256 .It Ic set Ar variable
257 .It Ic set Ar variable Ns = Ns Ar value
258 Set loader's environment variables.
259 .Pp
260 .It Ic show Op Va variable
261 Displays the specified variable's value, or all variables and their
262 values if
263 .Va variable
264 is not specified.
265 .Pp
266 .It Ic unload
267 Remove all modules from memory.
268 .Pp
269 .It Ic unset Va variable
270 Removes
271 .Va variable
272 from the environment.
273 .Pp
274 .It Ic \&?
275 Same as
276 .Dq help index .
277 .El
278 .Ss BUILTIN ENVIRONMENT VARIABLES
279 The
280 .Nm
281 has actually two different kinds of
282 .Sq environment
283 variables.
284 There are ANS Forth's
285 .Em environmental queries ,
286 and a separate space of environment variables used by builtins, which
287 are not directly available to Forth words.
288 It is the latter type that this section covers.
289 .Pp
290 Environment variables can be set and unset through the
291 .Ic set
292 and
293 .Ic unset
294 builtins, and can have their values interactively examined through the
295 use of the
296 .Ic show
297 builtin.
298 Their values can also be accessed as described in
299 .Sx BUILTIN PARSER .
300 .Pp
301 Notice that these environment variables are not inherited by any shell
302 after the system has been booted.
303 .Pp
304 A few variables are set automatically by
305 .Nm .
306 Others can affect the behavior of either
307 .Nm
308 or the kernel at boot.
309 Some options may require a value,
310 while others define behavior just by being set.
311 Both types of builtin variables are described below.
312 .Bl -tag -width bootfile
313 .It Va acpi_load
314 Unset this to disable automatic loading of the ACPI module.
315 .It Va autoboot_delay
316 Number of seconds
317 .Ic autoboot
318 will wait before booting.
319 If this variable is not defined,
320 .Ic autoboot
321 will default to 10 seconds.
322 .Pp
323 If set to
324 .Dq NO ,
325 no
326 .Ic autoboot
327 will be automatically attempted after processing
328 .Pa /boot/loader.rc ,
329 though explicit
330 .Ic autoboot Ns 's
331 will be processed normally, defaulting to 10 seconds delay.
332 .It Va boot_askname
333 Instructs the kernel to prompt the user for the name of the root device
334 when the kernel is booted.
335 .It Va boot_ddb
336 Instructs the kernel to start in the DDB debugger, rather than
337 proceeding to initialize when booted.
338 .It Va boot_gdb
339 Selects gdb-remote mode for the kernel debugger by default.
340 .It Va boot_single
341 Prevents the kernel from initiating a multi-user startup; instead single-user
342 mode will be entered when the kernel has finished device probing.
343 .It Va boot_userconfig
344 Requests that the kernel's interactive device configuration program
345 be run when the kernel is booted.
346 .It Va boot_verbose
347 Setting this variable causes extra debugging information to be printed
348 by the kernel during the boot phase.
349 .It Va bootfile
350 List of semicolon-separated search path for bootable kernels.
351 The default is
352 .Dq Li kernel;kernel.old .
353 .It Va console
354 Defines the current console.
355 .It Va currdev
356 Selects the default device.
357 Syntax for devices is odd.
358 .It Va init_path
359 Sets the list of binaries which the kernel will try to run as the initial
360 process.
361 The first matching binary is used.
362 The default list is
363 .Dq Li /sbin/init:/sbin/oinit:/sbin/init.bak:/stand/sysinstall .
364 .It Va interpret
365 Has the value
366 .Dq Li ok
367 if the Forth's current state is interpreting.
368 .It Va LINES
369 Define the number of lines on the screen, to be used by the pager.
370 .It Va module_path
371 Sets the list of directories which will be searched for modules
372 named in a load command or implicitly required by a dependency.
373 The default value for this variable is
374 .Dq Li /;/boot;/modules .
375 .It Va num_ide_disks
376 Sets the number of IDE disks as a workaround for some problems in
377 finding the root disk at boot.
378 This has been deprecated in favor of
379 .Va root_disk_unit .
380 .It Va prompt
381 Value of
382 .Nm Ns 's
383 prompt.
384 Defaults to
385 .Dq Li "${currdev}>" .
386 .It Va root_disk_unit
387 If the code which detects the disk unit number for the root disk is
388 confused, e.g. by a mix of SCSI and IDE disks, or IDE disks with
389 gaps in the sequence (e.g. no primary slave), the unit number can
390 be forced by setting this variable.
391 .It Va rootdev
392 By default the value of
393 .Va currdev
394 is used to set the root file system
395 when the kernel is booted.
396 This can be overridden by setting
397 .Va rootdev
398 explicitly.
399 .It Va dumpdev
400 The name of a device where the kernel can save a crash dump in case
401 of a panic.
402 This automatically sets the
403 .Va kern.dumpdev
404 .Xr sysctl 3
405 MIB variable.
406 .El
407 .Pp
408 Other variables are used to override kernel tunable parameters.
409 The following tunables are available:
410 .Bl -tag -width Va
411 .It Va hw.physmem
412 Limit the amount of physical memory the system will use.
413 By default the size is in bytes, but the
414 .Cm k , K , m , M , g
415 and
416 .Cm G
417 suffixes
418 are also accepted and indicate kilobytes, megabytes and gigabytes
419 respectively.
420 An invalid suffix will result in the variable being ignored by the
421 kernel.
422 .It Va kern.emergency_intr_enable
423 Setting this to 1 enables emergency interrupt polling.  All interrupt
424 handlers are executed periodically.  This mode is very expensive and should
425 only be used to get a system accessible when interrupt routing is
426 otherwise broken.  It is primarily used by kernel developers to debug new
427 systems.
428 .It Va kern.emergency_intr_freq
429 Set the polling rate for the emergency interrupt polling code.  The
430 default is 10 (hz) to dissuade casual use.  If you are doing real work
431 with emergency interrupt polling mode enabled, it is recommended
432 that you use a frequency between 100hz and 300hz.
433 .It Va kern.maxusers
434 Set the size of a number of statically allocated system tables; see
435 .Xr tuning 7
436 for a description of how to select an appropriate value for this
437 tunable.
438 When set, this tunable replaces the value declared in the kernel
439 compile-time configuration file.
440 .It Va kern.ipc.nmbclusters
441 Set the number of mbuf clusters to be allocated.
442 The value cannot be set below the default
443 determined when the kernel was compiled.
444 Modifies
445 .Va NMBCLUSTERS .
446 .It Va kern.ipc.nsfbufs
447 Set the number of
448 .Xr sendfile 2
449 buffers to be allocated.
450 Overrides
451 .Dv NSFBUFS .
452 .It Va kern.mmxopt
453 Toggles the mmx optimizations for the bcopy/copyin/copyout routines
454 .It Va kern.vm.kmem.size
455 Sets the size of kernel memory (bytes).
456 This overrides the value determined when the kernel was compiled.
457 .It Va kern.maxswzone
458 Limits the amount of KVM to be used to hold swap
459 meta information, which directly governs the
460 maximum amount of swap the system can support.
461 This value is specified in bytes of KVA space
462 and defaults to around 70MBytes.
463 Care should be taken
464 to not reduce this value such that the actual
465 amount of configured swap exceeds \(12 the
466 kernel-supported swap.
467 The default 70MB allows
468 the kernel to support a maximum of (approximately)
469 14GB of configured swap.
470 Only mess around with
471 this parameter if you need to greatly extend the
472 KVM reservation for other resources such as the
473 buffer cache or
474 .Va NMBCLUSTERS .
475 Modifies
476 .Va VM_SWZONE_SIZE_MAX .
477 .It Va kern.maxbcache
478 Limits the amount of KVM reserved for use by the
479 buffer cache, specified in bytes.
480 The default maximum is 200MB.
481 This parameter is used to
482 prevent the buffer cache from eating too much
483 KVM in large-memory machine configurations.
484 Only mess around with this parameter if you need to
485 greatly extend the KVM reservation for other resources
486 such as the swap zone or
487 .Va NMBCLUSTERS .
488 Note that
489 the NBUF parameter will override this limit.
490 Modifies
491 .Va VM_BCACHE_SIZE_MAX .
492 .It Va machdep.disable_mtrrs
493 Disable the use of i686 MTRRs (x86 only).
494 .It Va net.inet.tcp.tcbhashsize
495 Overrides the compile-time set value of
496 .Va TCBHASHSIZE
497 or the preset default of 512.
498 Must be a power of 2.
499 .El
500 .Ss BUILTIN PARSER
501 When a builtin command is executed, the rest of the line is taken
502 by it as arguments, and it is processed by a special parser which
503 is not used for regular Forth commands.
504 .Pp
505 This special parser applies the following rules to the parsed text:
506 .Pp
507 .Bl -enum
508 .It
509 All backslash characters are preprocessed.
510 .Bl -bullet
511 .It
512 \eb , \ef , \er , \en and \et are processed as in C.
513 .It
514 \es is converted to a space.
515 .It
516 \ev is converted to
517 .Tn ASCII
518 11.
519 .It
520 \ez is just skipped.
521 Useful for things like
522 .Dq \e0xf\ez\e0xf .
523 .It
524 \e0xN and \e0xNN are replaced by the hex N or NN.
525 .It
526 \eNNN is replaced by the octal NNN
527 .Tn ASCII
528 character.
529 .It
530 \e" , \e' and \e$ will escape these characters, preventing them from
531 receiving special treatment in Step 2, described below.
532 .It
533 \e\e will be replaced with a single \e .
534 .It
535 In any other occurrence, backslash will just be removed.
536 .El
537 .It
538 Every string between non-escaped quotes or double-quotes will be treated
539 as a single word for the purposes of the remaining steps.
540 .It
541 Replace any
542 .Li $VARIABLE
543 or
544 .Li ${VARIABLE}
545 with the value of the environment variable
546 .Va VARIABLE .
547 .It
548 Space-delimited arguments are passed to the called builtin command.
549 Spaces can also be escaped through the use of \e\e .
550 .El
551 .Pp
552 An exception to this parsing rule exists, and is described in
553 .Sx BUILTINS AND FORTH .
554 .Ss BUILTINS AND FORTH
555 All builtin words are state-smart, immediate words.
556 If interpreted, they behave exactly as described previously.
557 If they are compiled, though,
558 they extract their arguments from the stack instead of the command line.
559 .Pp
560 If compiled, the builtin words expect to find, at execution time, the
561 following parameters on the stack:
562 .D1 Ar addrN lenN ... addr2 len2 addr1 len1 N
563 where
564 .Ar addrX lenX
565 are strings which will compose the command line that will be parsed
566 into the builtin's arguments.
567 Internally, these strings are concatenated in from 1 to N,
568 with a space put between each one.
569 .Pp
570 If no arguments are passed, a 0
571 .Em must
572 be passed, even if the builtin accepts no arguments.
573 .Pp
574 While this behavior has benefits, it has its trade-offs.
575 If the execution token of a builtin is acquired (through
576 .Ic '
577 or
578 .Ic ['] ) ,
579 and then passed to
580 .Ic catch
581 or
582 .Ic execute ,
583 the builtin behavior will depend on the system state
584 .Bf Em
585 at the time
586 .Ic catch
587 or
588 .Ic execute
589 is processed
590 .Ef
591 \&! This is particularly annoying for programs that want or need to
592 handle exceptions.
593 In this case, the use of a proxy is recommended.
594 For example:
595 .Dl : (boot) boot ;
596 .Sh FICL
597 .Tn FICL
598 is a Forth interpreter written in C, in the form of a forth
599 virtual machine library that can be called by C functions and vice
600 versa.
601 .Pp
602 In
603 .Nm ,
604 each line read interactively is then fed to
605 .Tn FICL ,
606 which may call
607 .Nm
608 back to execute the builtin words.
609 The builtin
610 .Ic include
611 will also feed
612 .Tn FICL ,
613 one line at a time.
614 .Pp
615 The words available to
616 .Tn FICL
617 can be classified into four groups.
618 The
619 .Tn ANS
620 Forth standard words, extra
621 .Tn FICL
622 words, extra
623 .Dx
624 words, and the builtin commands;
625 the latter were already described.
626 The
627 .Tn ANS
628 Forth standard words are listed in the
629 .Sx STANDARDS
630 section.
631 The words falling in the two other groups are described in the
632 following subsections.
633 .Ss FICL EXTRA WORDS
634 .Bl -tag -width wid-set-super
635 .It Ic .env
636 .It Ic .ver
637 .It Ic -roll
638 .It Ic 2constant
639 .It Ic >name
640 .It Ic body>
641 .It Ic compare
642 This is the STRING word set's
643 .Ic compare .
644 .It Ic compile-only
645 .It Ic endif
646 .It Ic forget-wid
647 .It Ic parse-word
648 .It Ic sliteral
649 This is the STRING word set's
650 .Ic sliteral .
651 .It Ic wid-set-super
652 .It Ic w@
653 .It Ic w!
654 .It Ic x.
655 .It Ic empty
656 .It Ic cell-
657 .It Ic -rot
658 .El
659 .Ss FREEBSD EXTRA WORDS
660 .Bl -tag -width XXXXXXXX
661 .It Ic \&$ Pq --
662 Evaluates the remainder of the input buffer, after having printed it first.
663 .It Ic \&% Pq --
664 Evaluates the remainder of the input buffer under a
665 .Ic catch
666 exception guard.
667 .It Ic .#
668 Works like
669 .Ic .
670 but without outputting a trailing space.
671 .It Ic fclose Pq Ar fd --
672 Closes a file.
673 .It Ic fkey Pq Ar fd -- char
674 Reads a single character from a file.
675 .It Ic fload Pq Ar fd --
676 Processes a file
677 .Em fd .
678 .It Ic fopen Pq Ar addr len mode Li -- Ar fd
679 Opens a file.
680 Returns a file descriptor, or \-1 in case of failure.
681 The
682 .Ar mode
683 parameter selects whether the file is to be opened for read access, write
684 access, or both.
685 The constants
686 .Dv O_RDONLY , O_WRONLY ,
687 and
688 .Dv O_RDWR
689 are defined in
690 .Pa /boot/support.4th ,
691 indicating read only, write only, and read-write access, respectively.
692 .It Xo
693 .Ic fread
694 .Pq Ar fd addr len -- len'
695 .Xc
696 Tries to read
697 .Em len
698 bytes from file
699 .Em fd
700 into buffer
701 .Em addr .
702 Returns the actual number of bytes read, or -1 in case of error or end of
703 file.
704 .It Ic heap? Pq -- Ar cells
705 Return the space remaining in the dictionary heap, in cells.
706 This is not related to the heap used by dynamic memory allocation words.
707 .It Ic inb Pq Ar port -- char
708 Reads a byte from a port.
709 .It Ic key Pq -- Ar char
710 Reads a single character from the console.
711 .It Ic key? Pq -- Ar flag
712 Returns
713 .Ic true
714 if there is a character available to be read from the console.
715 .It Ic ms Pq Ar u --
716 Waits
717 .Em u
718 microseconds.
719 .It Ic outb Pq Ar port char --
720 Writes a byte to a port.
721 .It Ic seconds Pq -- Ar u
722 Returns the number of seconds since midnight.
723 .It Ic tib> Pq -- Ar addr len
724 Returns the remainder of the input buffer as a string on the stack.
725 .It Ic trace! Pq Ar flag --
726 Activates or deactivates tracing.
727 Does not work with
728 .Ic catch .
729 .El
730 .Ss FREEBSD DEFINED ENVIRONMENTAL QUERIES
731 .Bl -tag -width Ds
732 .It arch-i386
733 .Ic TRUE
734 if the architecture is IA32.
735 .It DragonFly_version
736 .Dx
737 version at compile time.
738 .It loader_version
739 .Nm
740 version.
741 .El
742 .Ss SYSTEM DOCUMENTATION
743 .Sh FILES
744 .Bl -tag -width /boot/defaults/loader.conf -compact
745 .It Pa /boot/loader
746 .Nm
747 itself.
748 .It Pa /boot/boot.4th
749 Additional
750 .Tn FICL
751 initialization.
752 .It Pa /boot/boot.conf
753 .Nm
754 bootstrapping script.
755 Deprecated.
756 .It Pa /boot/defaults/loader.conf
757 .It Pa /boot/loader.conf
758 .It Pa /boot/loader.conf.local
759 .Nm
760 configuration files, as described in
761 .Xr loader.conf 5 .
762 .It Pa /boot/loader.rc
763 .Nm
764 bootstrapping script.
765 .It Pa /boot/loader.help
766 Loaded by
767 .Ic help .
768 Contains the help messages.
769 .El
770 .Sh EXAMPLES
771 Boot in single user mode:
772 .Pp
773 .Dl boot -s
774 .Pp
775 Load kernel's user configuration file.
776 Notice that a kernel must be loaded before any other
777 .Ic load
778 command is attempted.
779 .Bd -literal -offset indent
780 load kernel
781 load -t userconfig_script /boot/kernel.conf
782 .Ed
783 .Pp
784 Load the kernel, a splash screen, and then autoboot in five seconds.
785 .Bd -literal -offset indent
786 load kernel
787 load splash_bmp
788 load -t splash_image_data /boot/chuckrulez.bmp
789 autoboot 5
790 .Ed
791 .Pp
792 Set the disk unit of the root device to 2, and then boot.
793 This would be needed in a system with two IDE disks,
794 with the second IDE disk hardwired to wd2 instead of wd1.
795 .Bd -literal -offset indent
796 set root_disk_unit=2
797 boot /kernel
798 .Ed
799 .Pp
800 See also:
801 .Bl -tag -width /usr/share/examples/bootforth/X
802 .It Pa /boot/loader.4th
803 Extra builtin-like words.
804 .It Pa /boot/support.4th
805 .Pa loader.conf
806 processing words.
807 .It Pa /usr/share/examples/bootforth/
808 Assorted examples.
809 .El
810 .Sh ERRORS
811 The following values are thrown by
812 .Nm :
813 .Bl -tag -width XXXXX -offset indent
814 .It 100
815 Any type of error in the processing of a builtin.
816 .It -1
817 .Ic Abort
818 executed.
819 .It -2
820 .Ic Abort"
821 executed.
822 .It -56
823 .Ic Quit
824 executed.
825 .It -256
826 Out of interpreting text.
827 .It -257
828 Need more text to succeed -- will finish on next run.
829 .It -258
830 .Ic Bye
831 executed.
832 .It -259
833 Unspecified error.
834 .El
835 .Sh SEE ALSO
836 .Xr libstand 3 ,
837 .Xr loader.conf 5 ,
838 .Xr tuning 7 ,
839 .Xr boot 8 ,
840 .Xr btxld 8
841 .Sh STANDARDS
842 For the purposes of ANS Forth compliance, loader is an
843 .Bf Em
844 ANS Forth System with Environmental Restrictions, Providing
845 .Ef
846 .Bf Li
847 .No .( ,
848 .No :noname ,
849 .No ?do ,
850 parse, pick, roll, refill, to, value, \e, false, true,
851 .No <> ,
852 .No 0<> ,
853 compile\&, , erase, nip, tuck
854 .Ef
855 .Em and
856 .Li marker
857 .Bf Em
858 from the Core Extensions word set, Providing the Exception Extensions
859 word set, Providing the Locals Extensions word set, Providing the
860 Memory-Allocation Extensions word set, Providing
861 .Ef
862 .Bf Li
863 \&.s,
864 bye, forget, see, words,
865 \&[if],
866 \&[else]
867 .Ef
868 .Em and
869 .Li [then]
870 .Bf Em
871 from the Programming-Tools extension word set, Providing the
872 Search-Order extensions word set.
873 .Ef
874 .Sh HISTORY
875 The
876 .Nm
877 first appeared in
878 .Fx 3.1 .
879 .Sh AUTHORS
880 .An -nosplit
881 The
882 .Nm
883 was written by
884 .An Michael Smith Aq msmith@FreeBSD.org .
885 .Pp
886 .Tn FICL
887 was written by
888 .An John Sadler Aq john_sadler@alum.mit.edu .
889 .Sh BUGS
890 The
891 .Ic expect
892 and
893 .Ic accept
894 words will read from the input buffer instead of the console.
895 The latter will be fixed, but the former will not.