summaryrefslogtreecommitdiff
path: root/stand/man
diff options
context:
space:
mode:
authorEdward Tomasz Napierala <trasz@FreeBSD.org>2018-08-13 11:56:23 +0000
committerEdward Tomasz Napierala <trasz@FreeBSD.org>2018-08-13 11:56:23 +0000
commit684e907b179beef070e5ab319948399ef9dd5388 (patch)
tree42380b58082f3a417012319bfab8e62b961a4372 /stand/man
parent61a2188021fb307cedb3c5b349be23880d6fd053 (diff)
downloadsrc-test-684e907b179beef070e5ab319948399ef9dd5388.tar.gz
src-test-684e907b179beef070e5ab319948399ef9dd5388.zip
Move around text in loader(8), in particular stuff related to ZFS,
to restore the usual section order. MFC after: 2 weeks Sponsored by: DARPA, AFRL
Notes
Notes: svn path=/head/; revision=337707
Diffstat (limited to 'stand/man')
-rw-r--r--stand/man/loader.8112
1 files changed, 51 insertions, 61 deletions
diff --git a/stand/man/loader.8 b/stand/man/loader.8
index 5bd0724f11946..0b9a2a2fe1d76 100644
--- a/stand/man/loader.8
+++ b/stand/man/loader.8
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 7, 2018
+.Dd August 13, 2018
.Dt LOADER 8
.Os
.Sh NAME
@@ -244,10 +244,14 @@ If
is specified, file sizes will be shown too.
.Pp
.It Ic lsdev Op Fl v
-Lists all of the devices from which it may be possible to load modules.
+Lists all of the devices from which it may be possible to load modules,
+as well as ZFS pools.
If
.Fl v
-is specified, more details are printed.
+is specified, more details are printed, including ZFS pool information
+in a format that resembles
+.Nm zpool Cm status
+output.
.Pp
.It Ic lsmod Op Fl v
Displays loaded modules.
@@ -255,6 +259,14 @@ If
.Fl v
is specified, more details are shown.
.Pp
+.It Ic lszfs Ar filesystem
+A ZFS extended command that can be used to explore the ZFS filesystem
+hierarchy in a pool.
+Lists the immediate children of the
+.Ar filesystem .
+The filesystem hierarchy is rooted at a filesystem with the same name
+as the pool.
+.Pp
.It Ic more Ar file Op Ar
Display the files specified, with a pause at each
.Va LINES
@@ -666,6 +678,29 @@ Modifies
and
.Dv VM_KMEM_SIZE_MAX .
.El
+.Ss ZFS FEATURES
+.Nm
+supports the following format for specifying ZFS filesystems which
+can be used wherever
+.Xr loader 8
+refers to a device specification:
+.Pp
+.Ar zfs:pool/filesystem:
+.Pp
+where
+.Pa pool/filesystem
+is a ZFS filesystem name as described in
+.Xr zfs 8 .
+.Pp
+If
+.Pa /etc/fstab
+does not have an entry for the root filesystem and
+.Va vfs.root.mountfrom
+is not set, but
+.Va currdev
+refers to a ZFS filesystem, then
+.Nm
+will instruct kernel to use that filesystem as the root filesystem.
.Ss BUILTIN PARSER
When a builtin command is executed, the rest of the line is taken
by it as arguments, and it is processed by a special parser which
@@ -907,9 +942,8 @@ version at compile time.
.Nm
version.
.El
-.Ss SYSTEM DOCUMENTATION
.Sh FILES
-.Bl -tag -width /boot/defaults/loader.conf -compact
+.Bl -tag -width /usr/share/examples/bootforth/ -compact
.It Pa /boot/loader
.Nm
itself.
@@ -918,6 +952,8 @@ Additional
.Tn FICL
initialization.
.It Pa /boot/defaults/loader.conf
+.It Pa /boot/loader.4th
+Extra builtin-like words.
.It Pa /boot/loader.conf
.It Pa /boot/loader.conf.local
.Nm
@@ -930,6 +966,11 @@ bootstrapping script.
Loaded by
.Ic help .
Contains the help messages.
+.It Pa /boot/support.4th
+.Pa loader.conf
+processing words.
+.It Pa /usr/share/examples/bootforth/
+Assorted examples.
.El
.Sh EXAMPLES
Boot in single user mode:
@@ -955,16 +996,11 @@ set root_disk_unit=2
boot /boot/kernel/kernel
.Ed
.Pp
-See also:
-.Bl -tag -width /usr/share/examples/bootforth/X
-.It Pa /boot/loader.4th
-Extra builtin-like words.
-.It Pa /boot/support.4th
-.Pa loader.conf
-processing words.
-.It Pa /usr/share/examples/bootforth/
-Assorted examples.
-.El
+Set the default device used for loading a kernel from a ZFS filesystem:
+.Bd -literal -offset indent
+set currdev=zfs:tank/ROOT/knowngood:
+.Ed
+.Pp
.Sh ERRORS
The following values are thrown by
.Nm :
@@ -990,52 +1026,6 @@ executed.
.It -259
Unspecified error.
.El
-.Sh ZFS FEATURES
-.Nm
-supports the following format for specifying ZFS filesystems which
-can be used wherever
-.Xr loader 8
-refers to a device specification:
-.Pp
-.Ar zfs:pool/filesystem:
-.Pp
-where
-.Pa pool/filesystem
-is a ZFS filesystem name as described in
-.Xr zfs 8 .
-.Pp
-If
-.Pa /etc/fstab
-does not have an entry for the root filesystem and
-.Va vfs.root.mountfrom
-is not set, but
-.Va currdev
-refers to a ZFS filesystem, then
-.Nm
-will instruct kernel to use that filesystem as the root filesystem.
-.Sh ZFS COMMAND EXTENSIONS
-.Bl -tag -width Ds -compact
-.It Ic lsdev Op Fl v
-Lists ZFS pools in addition to disks and partitions.
-Adding
-.Fl v
-shows more ZFS pool details in a format that resembles
-.Nm zpool Cm status
-output.
-.Pp
-.It Ic lszfs Ar filesystem
-A ZFS extended command that can be used to explore the ZFS filesystem
-hierarchy in a pool.
-Lists the immediate children of the
-.Ar filesystem .
-The filesystem hierarchy is rooted at a filesystem with the same name
-as the pool.
-.El
-.Sh EXAMPLES
-Set the default device used for loading a kernel from a ZFS filesystem:
-.Bd -literal -offset indent
-set currdev=zfs:tank/ROOT/knowngood:
-.Ed
.Sh SEE ALSO
.Xr libstand 3 ,
.Xr loader.conf 5 ,