Remove arch-alpha variable.
[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.8 2005/02/20 16:31:53 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 March 14, 1999
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 .Pp
278 .El
279 .Ss BUILTIN ENVIRONMENT VARIABLES
280 The
281 .Nm
282 has actually two different kinds of
283 .Sq environment
284 variables.
285 There are ANS Forth's
286 .Em environmental queries ,
287 and a separate space of environment variables used by builtins, which
288 are not directly available to Forth words.
289 It is the latter type that this section covers.
290 .Pp
291 Environment variables can be set and unset through the
292 .Ic set
293 and
294 .Ic unset
295 builtins, and can have their values interactively examined through the
296 use of the
297 .Ic show
298 builtin.
299 Their values can also be accessed as described in
300 .Sx BUILTIN PARSER .
301 .Pp
302 Notice that these environment variables are not inherited by any shell
303 after the system has been booted.
304 .Pp
305 A few variables are set automatically by
306 .Nm .
307 Others can affect the behavior of either
308 .Nm
309 or the kernel at boot.
310 Some options may require a value,
311 while others define behavior just by being set.
312 Both types of builtin variables are described below.
313 .Bl -tag -width bootfile
314 .It Va acpi_load
315 Unset this to disable automatic loading of the ACPI module.
316 See also
317 .Va hint.acpi.0.disabled
318 in
319 .Xr device.hints 5 .
320 .It Va autoboot_delay
321 Number of seconds
322 .Ic autoboot
323 will wait before booting.
324 If this variable is not defined,
325 .Ic autoboot
326 will default to 10 seconds.
327 .Pp
328 If set to
329 .Dq NO ,
330 no
331 .Ic autoboot
332 will be automatically attempted after processing
333 .Pa /boot/loader.rc ,
334 though explicit
335 .Ic autoboot Ns 's
336 will be processed normally, defaulting to 10 seconds delay.
337 .It Va boot_askname
338 Instructs the kernel to prompt the user for the name of the root device
339 when the kernel is booted.
340 .It Va boot_ddb
341 Instructs the kernel to start in the DDB debugger, rather than
342 proceeding to initialize when booted.
343 .It Va boot_gdb
344 Selects gdb-remote mode for the kernel debugger by default.
345 .It Va boot_single
346 Prevents the kernel from initiating a multi-user startup; instead single-user
347 mode will be entered when the kernel has finished device probing.
348 .It Va boot_userconfig
349 Requests that the kernel's interactive device configuration program
350 be run when the kernel is booted.
351 .It Va boot_verbose
352 Setting this variable causes extra debugging information to be printed
353 by the kernel during the boot phase.
354 .It Va bootfile
355 List of semicolon-separated search path for bootable kernels.
356 The default is
357 .Dq Li kernel;kernel.old .
358 .It Va console
359 Defines the current console.
360 .It Va currdev
361 Selects the default device.
362 Syntax for devices is odd.
363 .It Va init_path
364 Sets the list of binaries which the kernel will try to run as the initial
365 process.
366 The first matching binary is used.
367 The default list is
368 .Dq Li /sbin/init:/sbin/oinit:/sbin/init.bak:/stand/sysinstall .
369 .It Va interpret
370 Has the value
371 .Dq Li ok
372 if the Forth's current state is interpreting.
373 .It Va LINES
374 Define the number of lines on the screen, to be used by the pager.
375 .It Va module_path
376 Sets the list of directories which will be searched for modules
377 named in a load command or implicitly required by a dependency.
378 The default value for this variable is
379 .Dq Li /;/boot;/modules .
380 .It Va num_ide_disks
381 Sets the number of IDE disks as a workaround for some problems in
382 finding the root disk at boot.
383 This has been deprecated in favor of
384 .Va root_disk_unit .
385 .It Va prompt
386 Value of
387 .Nm Ns 's
388 prompt.
389 Defaults to
390 .Dq Li "${currdev}>" .
391 .It Va root_disk_unit
392 If the code which detects the disk unit number for the root disk is
393 confused, e.g. by a mix of SCSI and IDE disks, or IDE disks with
394 gaps in the sequence (e.g. no primary slave), the unit number can
395 be forced by setting this variable.
396 .It Va rootdev
397 By default the value of
398 .Va currdev
399 is used to set the root file system
400 when the kernel is booted.
401 This can be overridden by setting
402 .Va rootdev
403 explicitly.
404 .It Va dumpdev
405 The name of a device where the kernel can save a crash dump in case
406 of a panic.
407 This automatically sets the
408 .Va kern.dumpdev
409 .Xr sysctl 3
410 MIB variable.
411 .El
412 .Pp
413 Other variables are used to override kernel tunable parameters.
414 The following tunables are available:
415 .Bl -tag -width Va
416 .It Va hw.physmem
417 Limit the amount of physical memory the system will use.
418 By default the size is in bytes, but the
419 .Cm k , K , m , M , g
420 and
421 .Cm G
422 suffixes
423 are also accepted and indicate kilobytes, megabytes and gigabytes
424 respectively.
425 An invalid suffix will result in the variable being ignored by the
426 kernel.
427 .It Va hw.pci.enable_io_modes
428 Enable PCI resources which are left off by some BIOSes or are not
429 enabled correctly by the device driver.
430 Tunable value set to ON (1) by default, but this may cause problems
431 with some peripherals.
432 .It Va hw.pci.allow_unsupported_io_range
433 Allow the PCI bridge to pass through an unsupported memory range
434 assigned by the BIOS.
435 Tunable value set to OFF (0) by default.
436 .It Va kern.maxusers
437 Set the size of a number of statically allocated system tables; see
438 .Xr tuning 7
439 for a description of how to select an appropriate value for this
440 tunable.
441 When set, this tunable replaces the value declared in the kernel
442 compile-time configuration file.
443 .It Va kern.ipc.nmbclusters
444 Set the number of mbuf clusters to be allocated.
445 The value cannot be set below the default
446 determined when the kernel was compiled.
447 Modifies
448 .Va NMBCLUSTERS .
449 .It Va kern.ipc.nsfbufs
450 Set the number of
451 .Xr sendfile 2
452 buffers to be allocated.
453 Overrides
454 .Dv NSFBUFS .
455 .It Va kern.mmxopt
456 Toggles the mmx optimizations for the bcopy/copyin/copyout routines
457 .It Va kern.vm.kmem.size
458 Sets the size of kernel memory (bytes).
459 This overrides the value determined when the kernel was compiled.
460 Modifies
461 .Va VM_KMEM_SIZE .
462 .It Va kern.maxswzone
463 Limits the amount of KVM to be used to hold swap
464 meta information, which directly governs the
465 maximum amount of swap the system can support.
466 This value is specified in bytes of KVA space
467 and defaults to around 70MBytes.
468 Care should be taken
469 to not reduce this value such that the actual
470 amount of configured swap exceeds 1/2 the
471 kernel-supported swap.
472 The default 70MB allows
473 the kernel to support a maximum of (approximately)
474 14GB of configured swap.
475 Only mess around with
476 this parameter if you need to greatly extend the
477 KVM reservation for other resources such as the
478 buffer cache or
479 .Va NMBCLUSTERS .
480 Modifies
481 .Va VM_SWZONE_SIZE_MAX .
482 .It Va kern.maxbcache
483 Limits the amount of KVM reserved for use by the
484 buffer cache, specified in bytes.
485 The default maximum is 200MB.
486 This parameter is used to
487 prevent the buffer cache from eating too much
488 KVM in large-memory machine configurations.
489 Only mess around with this parameter if you need to
490 greatly extend the KVM reservation for other resources
491 such as the swap zone or
492 .Va NMBCLUSTERS .
493 Note that
494 the NBUF parameter will override this limit.
495 Modifies
496 .Va VM_BCACHE_SIZE_MAX .
497 .It Va machdep.disable_mtrrs
498 Disable the use of i686 MTRRs (x86 only).
499 .It Va net.inet.tcp.tcbhashsize
500 Overrides the compile-time set value of
501 .Va TCBHASHSIZE
502 or the preset default of 512.
503 Must be a power of 2.
504 .El
505 .Ss BUILTIN PARSER
506 When a builtin command is executed, the rest of the line is taken
507 by it as arguments, and it is processed by a special parser which
508 is not used for regular Forth commands.
509 .Pp
510 This special parser applies the following rules to the parsed text:
511 .Pp
512 .Bl -enum
513 .It
514 All backslash characters are preprocessed.
515 .Bl -bullet
516 .It
517 \eb , \ef , \er , \en and \et are processed as in C.
518 .It
519 \es is converted to a space.
520 .It
521 \ev is converted to
522 .Tn ASCII
523 11.
524 .It
525 \ez is just skipped.
526 Useful for things like
527 .Dq \e0xf\ez\e0xf .
528 .It
529 \e0xN and \e0xNN are replaced by the hex N or NN.
530 .It
531 \eNNN is replaced by the octal NNN
532 .Tn ASCII
533 character.
534 .It
535 \e" , \e' and \e$ will escape these characters, preventing them from
536 receiving special treatment in Step 2, described below.
537 .It
538 \e\e will be replaced with a single \e .
539 .It
540 In any other occurrence, backslash will just be removed.
541 .El
542 .It
543 Every string between non-escaped quotes or double-quotes will be treated
544 as a single word for the purposes of the remaining steps.
545 .It
546 Replace any
547 .Li $VARIABLE
548 or
549 .Li ${VARIABLE}
550 with the value of the environment variable
551 .Va VARIABLE .
552 .It
553 Space-delimited arguments are passed to the called builtin command.
554 Spaces can also be escaped through the use of \e\e .
555 .El
556 .Pp
557 An exception to this parsing rule exists, and is described in
558 .Sx BUILTINS AND FORTH .
559 .Ss BUILTINS AND FORTH
560 All builtin words are state-smart, immediate words.
561 If interpreted, they behave exactly as described previously.
562 If they are compiled, though,
563 they extract their arguments from the stack instead of the command line.
564 .Pp
565 If compiled, the builtin words expect to find, at execution time, the
566 following parameters on the stack:
567 .D1 Ar addrN lenN ... addr2 len2 addr1 len1 N
568 where
569 .Ar addrX lenX
570 are strings which will compose the command line that will be parsed
571 into the builtin's arguments.
572 Internally, these strings are concatenated in from 1 to N,
573 with a space put between each one.
574 .Pp
575 If no arguments are passed, a 0
576 .Em must
577 be passed, even if the builtin accepts no arguments.
578 .Pp
579 While this behavior has benefits, it has its trade-offs.
580 If the execution token of a builtin is acquired (through
581 .Ic '
582 or
583 .Ic ['] ) ,
584 and then passed to
585 .Ic catch
586 or
587 .Ic execute ,
588 the builtin behavior will depend on the system state
589 .Bf Em
590 at the time
591 .Ic catch
592 or
593 .Ic execute
594 is processed
595 .Ef
596 \&! This is particularly annoying for programs that want or need to
597 handle exceptions.
598 In this case, the use of a proxy is recommended.
599 For example:
600 .Dl : (boot) boot ;
601 .Sh FICL
602 .Tn FICL
603 is a Forth interpreter written in C, in the form of a forth
604 virtual machine library that can be called by C functions and vice
605 versa.
606 .Pp
607 In
608 .Nm ,
609 each line read interactively is then fed to
610 .Tn FICL ,
611 which may call
612 .Nm
613 back to execute the builtin words.
614 The builtin
615 .Ic include
616 will also feed
617 .Tn FICL ,
618 one line at a time.
619 .Pp
620 The words available to
621 .Tn FICL
622 can be classified into four groups.
623 The
624 .Tn ANS
625 Forth standard words, extra
626 .Tn FICL
627 words, extra
628 .Dx
629 words, and the builtin commands;
630 the latter were already described.
631 The
632 .Tn ANS
633 Forth standard words are listed in the
634 .Sx STANDARDS
635 section.
636 The words falling in the two other groups are described in the
637 following subsections.
638 .Ss FICL EXTRA WORDS
639 .Bl -tag -width wid-set-super
640 .It Ic .env
641 .It Ic .ver
642 .It Ic -roll
643 .It Ic 2constant
644 .It Ic >name
645 .It Ic body>
646 .It Ic compare
647 This is the STRING word set's
648 .Ic compare .
649 .It Ic compile-only
650 .It Ic endif
651 .It Ic forget-wid
652 .It Ic parse-word
653 .It Ic sliteral
654 This is the STRING word set's
655 .Ic sliteral .
656 .It Ic wid-set-super
657 .It Ic w@
658 .It Ic w!
659 .It Ic x.
660 .It Ic empty
661 .It Ic cell-
662 .It Ic -rot
663 .El
664 .Ss FREEBSD EXTRA WORDS
665 .Bl -tag -width XXXXXXXX
666 .It Ic \&$ Pq --
667 Evaluates the remainder of the input buffer, after having printed it first.
668 .It Ic \&% Pq --
669 Evaluates the remainder of the input buffer under a
670 .Ic catch
671 exception guard.
672 .It Ic .#
673 Works like
674 .Ic .
675 but without outputting a trailing space.
676 .It Ic fclose Pq Ar fd --
677 Closes a file.
678 .It Ic fkey Pq Ar fd -- char
679 Reads a single character from a file.
680 .It Ic fload Pq Ar fd --
681 Processes a file
682 .Em fd .
683 .It Ic fopen Pq Ar addr len mode Li -- Ar fd
684 Opens a file.
685 Returns a file descriptor, or \-1 in case of failure.
686 The
687 .Ar mode
688 parameter selects whether the file is to be opened for read access, write
689 access, or both.
690 The constants
691 .Dv O_RDONLY , O_WRONLY ,
692 and
693 .Dv O_RDWR
694 are defined in
695 .Pa /boot/support.4th ,
696 indicating read only, write only, and read-write access, respectively.
697 .It Xo
698 .Ic fread
699 .Pq Ar fd addr len -- len'
700 .Xc
701 Tries to read
702 .Em len
703 bytes from file
704 .Em fd
705 into buffer
706 .Em addr .
707 Returns the actual number of bytes read, or -1 in case of error or end of
708 file.
709 .It Ic heap? Pq -- Ar cells
710 Return the space remaining in the dictionary heap, in cells.
711 This is not related to the heap used by dynamic memory allocation words.
712 .It Ic inb Pq Ar port -- char
713 Reads a byte from a port.
714 .It Ic key Pq -- Ar char
715 Reads a single character from the console.
716 .It Ic key? Pq -- Ar flag
717 Returns
718 .Ic true
719 if there is a character available to be read from the console.
720 .It Ic ms Pq Ar u --
721 Waits
722 .Em u
723 microseconds.
724 .It Ic outb Pq Ar port char --
725 Writes a byte to a port.
726 .It Ic seconds Pq -- Ar u
727 Returns the number of seconds since midnight.
728 .It Ic tib> Pq -- Ar addr len
729 Returns the remainder of the input buffer as a string on the stack.
730 .It Ic trace! Pq Ar flag --
731 Activates or deactivates tracing.
732 Does not work with
733 .Ic catch .
734 .El
735 .Ss FREEBSD DEFINED ENVIRONMENTAL QUERIES
736 .Bl -tag -width Ds
737 .It arch-i386
738 .Ic TRUE
739 if the architecture is IA32.
740 .It DragonFly_version
741 .Dx
742 version at compile time.
743 .It loader_version
744 .Nm
745 version.
746 .El
747 .Ss SYSTEM DOCUMENTATION
748 .Sh FILES
749 .Bl -tag -width /boot/defaults/loader.conf -compact
750 .It Pa /boot/loader
751 .Nm
752 itself.
753 .It Pa /boot/boot.4th
754 Additional
755 .Tn FICL
756 initialization.
757 .It Pa /boot/boot.conf
758 .Nm
759 bootstrapping script.
760 Deprecated.
761 .It Pa /boot/defaults/loader.conf
762 .It Pa /boot/loader.conf
763 .It Pa /boot/loader.conf.local
764 .Nm
765 configuration files, as described in
766 .Xr loader.conf 5 .
767 .It Pa /boot/loader.rc
768 .Nm
769 bootstrapping script.
770 .It Pa /boot/loader.help
771 Loaded by
772 .Ic help .
773 Contains the help messages.
774 .El
775 .Sh EXAMPLES
776 Boot in single user mode:
777 .Pp
778 .Dl boot -s
779 .Pp
780 Load kernel's user configuration file.
781 Notice that a kernel must be loaded before any other
782 .Ic load
783 command is attempted.
784 .Bd -literal -offset indent
785 load kernel
786 load -t userconfig_script /boot/kernel.conf
787 .Ed
788 .Pp
789 Load the kernel, a splash screen, and then autoboot in five seconds.
790 .Bd -literal -offset indent
791 load kernel
792 load splash_bmp
793 load -t splash_image_data /boot/chuckrulez.bmp
794 autoboot 5
795 .Ed
796 .Pp
797 Set the disk unit of the root device to 2, and then boot.
798 This would be needed in a system with two IDE disks,
799 with the second IDE disk hardwired to wd2 instead of wd1.
800 .Bd -literal -offset indent
801 set root_disk_unit=2
802 boot /kernel
803 .Ed
804 .Pp
805 See also:
806 .Bl -tag -width /usr/share/examples/bootforth/X
807 .It Pa /boot/loader.4th
808 Extra builtin-like words.
809 .It Pa /boot/support.4th
810 .Pa loader.conf
811 processing words.
812 .It Pa /usr/share/examples/bootforth/
813 Assorted examples.
814 .El
815 .Sh ERRORS
816 The following values are thrown by
817 .Nm :
818 .Bl -tag -width XXXXX -offset indent
819 .It 100
820 Any type of error in the processing of a builtin.
821 .It -1
822 .Ic Abort
823 executed.
824 .It -2
825 .Ic Abort"
826 executed.
827 .It -56
828 .Ic Quit
829 executed.
830 .It -256
831 Out of interpreting text.
832 .It -257
833 Need more text to succeed -- will finish on next run.
834 .It -258
835 .Ic Bye
836 executed.
837 .It -259
838 Unspecified error.
839 .El
840 .Sh SEE ALSO
841 .Xr libstand 3 ,
842 .Xr loader.conf 5 ,
843 .Xr tuning 7 ,
844 .Xr boot 8 ,
845 .Xr btxld 8
846 .Sh STANDARDS
847 For the purposes of ANS Forth compliance, loader is an
848 .Bf Em
849 ANS Forth System with Environmental Restrictions, Providing
850 .Ef
851 .Bf Li
852 .No .( ,
853 .No :noname ,
854 .No ?do ,
855 parse, pick, roll, refill, to, value, \e, false, true,
856 .No <> ,
857 .No 0<> ,
858 compile\&, , erase, nip, tuck
859 .Ef
860 .Em and
861 .Li marker
862 .Bf Em
863 from the Core Extensions word set, Providing the Exception Extensions
864 word set, Providing the Locals Extensions word set, Providing the
865 Memory-Allocation Extensions word set, Providing
866 .Ef
867 .Bf Li
868 \&.s,
869 bye, forget, see, words,
870 \&[if],
871 \&[else]
872 .Ef
873 .Em and
874 .Li [then]
875 .Bf Em
876 from the Programming-Tools extension word set, Providing the
877 Search-Order extensions word set.
878 .Ef
879 .Sh HISTORY
880 The
881 .Nm
882 first appeared in
883 .Fx 3.1 .
884 .Sh AUTHORS
885 .An -nosplit
886 The
887 .Nm
888 was written by
889 .An Michael Smith Aq msmith@FreeBSD.org .
890 .Pp
891 .Tn FICL
892 was written by
893 .An John Sadler Aq john_sadler@alum.mit.edu .
894 .Sh BUGS
895 The
896 .Ic expect
897 and
898 .Ic accept
899 words will read from the input buffer instead of the console.
900 The latter will be fixed, but the former will not.