d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0ab7c42e94
freebsd-nq/stand/man/loader.8

129 lines
4.0 KiB
Groff
Raw Normal View History

The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.\" Copyright (c) 1999 Daniel C. Sobral
.\" All rights reserved.
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
.\" Copyright (c) 2021 Warner Losh <imp@FreeBSD.org>
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
$Id$ -> $FreeBSD$
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.\"
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
.Dd September 29, 2021
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Dt LOADER 8
.Os
.Sh NAME
.Nm loader
Make corrections to allow for Alpha.
2000-05-18 12:44:50 +00:00
.Nd kernel bootstrapping final stage
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Sh DESCRIPTION
The program called
.Nm
Use Fx macro wherever possible.
2000-11-14 11:20:58 +00:00
is the final stage of
.Fx Ns 's
kernel bootstrapping process.
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
It is responsible for bringing the kernel, kernel modules and other files into
memory.
It creates a set of
.Xr sh 1
like environment variables that are passed to the kernel.
It executes boot scripts written in one of several interpreters.
Together with the scripts, it controls the booting process and
interaction with the user.
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Pp
It provides a scripting language that can be used to
automate tasks, do pre-configuration or assist in recovery
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
procedures.
This scripting language is roughly divided in
two main components.
The smaller one is a set of commands
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
designed for direct use by the casual user, called "builtin
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
commands" for historical reasons.
Fix a handful of typos and grammar bogons. No content changes. Translators can ignore this commit. MFC after: 2 weeks
2002-05-29 22:57:18 +00:00
The main drive behind these commands is user-friendliness.
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
The larger component is the scripting language built into
the boot loader.
.Fx
provides three different interpreters: Forth, Lua and Simple.
The Forth loader is based on an ANS Forth compatible
Forth interpreter based on FICL, by
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.An John Sadler .
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
The Lua loader is includes a full Lua interpreter from
.Pa https://www.lua.org/ .
The Simple loader only interprets a list of builtin commands
without any control structure.
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Pp
During initialization,
.Nm
will probe for a console and set the
.Va console
variable, or set it to serial console
Improved markup, fixes some spelling and grammar. Approved by: re (blanket)
2005-06-14 08:49:14 +00:00
.Pq Dq Li comconsole
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
if the previous boot stage used that.
- Add support to the loader for multiple consoles. - Teach the i386 and pc98 loaders to honor multiple console requests from their respective boot2 binaries so that the same console(s) are used in both boot2 and the loader. - Since the kernel doesn't support multiple consoles, whichever console is listed first is treated as the "primary" console and is passed to the kernel in the boot_howto flags. PR: kern/66425 Submitted by: Gavin Atkinson gavin at ury dot york dot ac dot uk MFC after: 1 week
2005-05-27 19:31:00 +00:00
If multiple consoles are selected, they will be listed separated by spaces.
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
Then, devices are probed,
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Va currdev
and
.Va loaddev
are set, and
.Va LINES
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
is set to 24.
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
Finally, an interpreter specific file will be executed.
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Sh BUILTIN COMMANDS
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
The commands common to all interpreters are described in the
.Xr loader_simp 8
.Dq BUILTIN COMMANDS
section.
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Ss BUILTIN ENVIRONMENT VARIABLES
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
The environment variables common to all interpreters are described in the
.Xr loader_simp 8
.Dq BUILTIN ENVIRONMENT VARIABLES
Whitespace-only changes: apply accepted line breaking style as a pre-cursor to other markup changes. Accepted in principle by the author.
2000-06-22 08:37:22 +00:00
section.
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Sh SEE ALSO
.Xr libstand 3 ,
.Xr loader.conf 5 ,
o Expand list of tunables documented in loader.8 to include kern.maxusers, since other related tunables were also documented here. Add a cross reference to tuning(7) for information on setting this value appropriately.
2001-12-07 18:05:24 +00:00
.Xr tuning 7 ,
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Xr boot 8 ,
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
.Xr btxld 8 ,
.Xr loader.efi 8 ,
.Xr loader_4th 8 ,
.Xr loader_lua 8 ,
.Xr loader_simp 8
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Sh HISTORY
The .Nm
2002-07-14 15:19:46 +00:00
The
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Nm
first appeared in
.Fx 3.1 .
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
The
.Nm
scripting language changed to Lua by default in
.Fx 12.0 .
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Sh AUTHORS
mdoc(7) police: do not split author names in the AUTHORS section.
2000-11-22 09:35:58 +00:00
.An -nosplit
The .Nm
2002-07-14 15:19:46 +00:00
The
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.Nm
was written by
mdoc(7) police: do not split author names in the AUTHORS section.
2000-11-22 09:35:58 +00:00
.An Michael Smith Aq msmith@FreeBSD.org .
.Pp
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
FICL was written by
The man page, version 0.1.
1999-03-15 08:52:23 +00:00
.An John Sadler Aq john_sadler@alum.mit.edu .
loader: create separate man pages for each of the loaders Create a man page per loader. Loader(8) will have information common to all of them, while loader_${INTERP}(8) will have information relevant to that specific loader. Rewrite loader(8) to give an overview and point to the appropriate man page. Rewrite each of the loader_${INTER}(8) man pages to contain only the relevant information to that loader. Put all the common commands, environment variables, etc in loader_simp(8) and refernce that from the loader_lua or loader_4th man pages. The loader_lua(8) could use more details about the Lua integration. Additional organization may be benefitial. Sponsored by: Netflix Differential Revision: https://reviews.freebsd.org/D31340
2021-09-29 15:21:17 +00:00
.Pp
.An Warner Losh Aq imp@FreeBSD.org
integrated Lua into the tree based on initial work done by Pedro Souza
for the 2014 Google Summer of Code.
Reference in New Issue Copy Permalink