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