9668 loader: rename zfsloader to loader

Reviewed by: Andy Fiddaman <omnios@citrus-it.co.uk>
Reviewed by: Ryan Zezeski <rpz@joyent.com>
Approved by: Joshua M. Clulow <josh@sysmgr.org>

13 files changed, 75 insertions, 138 deletions

diff --git a/usr/src/man/man5/Makefile b/usr/src/man/man5/Makefile
index 481c84a64d..dfc6b26a92 100644
--- a/usr/src/man/man5/Makefile
+++ b/usr/src/man/man5/Makefile
@@ -144,8 +144,7 @@ i386_MANFILES=	brand.4th.5		\
 		menu.4th.5		\
 		menusets.4th.5		\
 		pxeboot.5		\
-		version.4th.5		\
-		zfsloader.5
+		version.4th.5
 
 MANLINKS=	ANSI.5		\
 		C++.5		\
diff --git a/usr/src/man/man5/beastie.4th.5 b/usr/src/man/man5/beastie.4th.5
index 52e78afa1a..0da1419eb3 100644
--- a/usr/src/man/man5/beastie.4th.5
+++ b/usr/src/man/man5/beastie.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt BEASTIE.4TH 5
 .Os
 .Sh NAME
@@ -115,9 +115,9 @@ The default is to not delay when loading the menu.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/beastie.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/brand.4th.5 b/usr/src/man/man5/brand.4th.5
index 467a3075b2..77d6b64492 100644
--- a/usr/src/man/man5/brand.4th.5
+++ b/usr/src/man/man5/brand.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt BRAND.4TH 5
 .Os
 .Sh NAME
@@ -93,9 +93,9 @@ Default is 1.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/brand.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/check-password.4th.5 b/usr/src/man/man5/check-password.4th.5
index 3446df9799..56e995c3be 100644
--- a/usr/src/man/man5/check-password.4th.5
+++ b/usr/src/man/man5/check-password.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt CHECK-PASSWORD.4TH 5
 .Os
 .Sh NAME
@@ -90,9 +90,9 @@ before the user is allowed to visit the boot menu.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/check-password.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/check-password.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/color.4th.5 b/usr/src/man/man5/color.4th.5
index 7031034d3d..c156fedd23 100644
--- a/usr/src/man/man5/color.4th.5
+++ b/usr/src/man/man5/color.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt COLOR.4TH 5
 .Os
 .Sh NAME
@@ -78,9 +78,9 @@ to return FALSE, indicating to many modules that color should not be used.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/color.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/delay.4th.5 b/usr/src/man/man5/delay.4th.5
index 4c6da7071d..1c1b897bcd 100644
--- a/usr/src/man/man5/delay.4th.5
+++ b/usr/src/man/man5/delay.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt DELAY.4TH 5
 .Os
 .Sh NAME
@@ -85,9 +85,9 @@ to print a continuous series of dots during the delay duration.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/delay.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/gptzfsboot.5 b/usr/src/man/man5/gptzfsboot.5
index e558ec7d4c..09892b1324 100644
--- a/usr/src/man/man5/gptzfsboot.5
+++ b/usr/src/man/man5/gptzfsboot.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 21, 2017
+.Dd July 20, 2018
 .Dt GPTZFSBOOT 5
 .Os
 .Sh NAME
@@ -77,14 +77,14 @@ If the
 .Cm bootfs
 property is not set, then the root filesystem of the pool is used as
 the default.
-.Xr zfsloader 5
+.Xr loader 5
 is loaded from the boot filesystem.
 If
 .Pa /boot/config
 is present in the boot filesystem, boot options are read from it.
 .Pp
 The ZFS GUIDs of the boot pool and boot file system are made available to
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .Ss USAGE
 Normally
 .Nm
@@ -95,7 +95,7 @@ interact with
 through a prompt.
 .Pp
 The filesystem specification and the path to
-.Xr zfsloader 5
+.Xr loader 5
 is specified as
 .Pp
 .Sm off
@@ -105,7 +105,7 @@ is specified as
 Both the filesystem and the path can be specified.
 If only a path is specified, then the default filesystem is used.
 If only a pool and filesystem are specified, then
-.Pa /boot/zfsloader
+.Pa /boot/loader
 is used as a path.
 .Pp
 Additionally, the
@@ -121,7 +121,7 @@ The output format for ZFS pools is similar to that of
 .Pp
 The configured or automatically determined ZFS boot filesystem is
 stored in the
-.Xr zfsloader 5
+.Xr loader 5
 .Cm loaddev
 variable, and also set as the initial value of the
 .Cm currdev
@@ -154,4 +154,4 @@ installboot /boot/pmbr /boot/gptzfsboot /dev/rdsk/c0t0d0s0
 .Xr installboot 1M ,
 .Xr zpool 1M ,
 .Xr loader 5 ,
-.Xr zfsloader 5
+.Xr loader 5
diff --git a/usr/src/man/man5/loader.4th.5 b/usr/src/man/man5/loader.4th.5
index 0e6dd01413..4197019a59 100644
--- a/usr/src/man/man5/loader.4th.5
+++ b/usr/src/man/man5/loader.4th.5
@@ -171,9 +171,9 @@ silently returns without error.
 .El
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/loader.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/loader.5 b/usr/src/man/man5/loader.5
index 74deff9a6b..0b0a2b123a 100644
--- a/usr/src/man/man5/loader.5
+++ b/usr/src/man/man5/loader.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 20, 2017
+.Dd July 24, 2018
 .Dt LOADER 5
 .Os
 .Sh NAME
@@ -38,7 +38,7 @@ The actual name for the stage depends on the platform.
 On IA32 (i386) architectures with BIOS firmware, it is a
 .Pa BTX
 client and named
-.Nm zfsloader .
+.Nm loader .
 It is linked statically to libstand and usually located in the directory
 .Pa /boot .
 .Pp
@@ -250,9 +250,13 @@ 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.
+In addition to disks and partitions, ZFS pools are also listed.
 If
 .Fl v
 is specified, more details are printed.
+For ZFS pools the output resembles
+.Nm zpool Cm status
+output.
 .Pp
 .It Ic lsmod Op Fl v
 Displays loaded modules.
@@ -260,6 +264,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
@@ -304,6 +316,19 @@ from the environment.
 .It Ic \&?
 Lists available commands.
 .El
+.Ss ZFS Features
+.Nm
+supports the following format for specifying ZFS filesystems which
+can be used wherever
+.Nm
+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 1M .
 .Ss Builtin Environment Variables
 The
 .Nm
@@ -733,7 +758,7 @@ Extra builtin-like words.
 .It Pa /boot/forth/support.4th
 .Pa loader.conf
 processing words.
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 .Nm
 itself.
 .El
@@ -751,6 +776,19 @@ load /platform/i86pc/kernel/amd64/unix
 load -t rootfs /platform/i86pc/amd64/boot_archive
 autoboot 5
 .Ed
+.Pp
+Set the default device used for loading a kernel from a ZFS filesystem:
+.Bd -literal -offset indent
+set currdev=zfs:rpool/ROOT/knowngood:
+.Ed
+.Sh NOTES
+Although setting the
+.Va currdev
+as shown in the example above is supported, it is advisable to use loader
+beadm command or boot environment menu instead.
+The reason is, the beadm or menu selection will also instruct loader to clean up
+the currently set configuration and load configuration from the new boot
+environment.
 .Sh SEE ALSO
 .Xr boot 1M ,
 .Xr btxld 1onbld ,
diff --git a/usr/src/man/man5/menu.4th.5 b/usr/src/man/man5/menu.4th.5
index 804fc54f6f..5cde905f4c 100644
--- a/usr/src/man/man5/menu.4th.5
+++ b/usr/src/man/man5/menu.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt MENU.4TH 5
 .Os
 .Sh NAME
@@ -273,9 +273,9 @@ above, use any number between 1 through 9.
 Sorry, double-digits are not currently supported.
 .Sh FILES
 .Bl -tag -width /boot/forth/loader.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/menu.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/menusets.4th.5 b/usr/src/man/man5/menusets.4th.5
index b2584e2030..14720a8d09 100644
--- a/usr/src/man/man5/menusets.4th.5
+++ b/usr/src/man/man5/menusets.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt MENUSETS.4TH 5
 .Os
 .Sh NAME
@@ -304,9 +304,9 @@ For all values of
 above, use any number between 1 and 65535.
 .Sh FILES
 .Bl -tag -width /boot/menu-commands.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/menu.4th
 Dynamic menu module.
 .It Pa /boot/forth/menu-commands.4th
diff --git a/usr/src/man/man5/version.4th.5 b/usr/src/man/man5/version.4th.5
index 556e04ab7a..3082e01bf7 100644
--- a/usr/src/man/man5/version.4th.5
+++ b/usr/src/man/man5/version.4th.5
@@ -22,7 +22,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Apr 22, 2017
+.Dd July 20, 2018
 .Dt VERSION.4TH 5
 .Os
 .Sh NAME
@@ -90,9 +90,9 @@ causes the version to be printed without color
 .El
 .Sh FILES
 .Bl -tag -width /boot/version.4th -compact
-.It Pa /boot/zfsloader
+.It Pa /boot/loader
 The
-.Xr zfsloader 5 .
+.Xr loader 5 .
 .It Pa /boot/forth/version.4th
 .Nm
 itself.
diff --git a/usr/src/man/man5/zfsloader.5 b/usr/src/man/man5/zfsloader.5
deleted file mode 100644
index ebfed4f0c2..0000000000
--- a/usr/src/man/man5/zfsloader.5
+++ /dev/null
@@ -1,100 +0,0 @@
-.\" Copyright (c) 2014 Andriy Gapon <avg@FreeBSD.org>
-.\" All rights reserved.
-.\"
-.\" 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.
-.\"
-.Dd Apr 20, 2017
-.Dt ZFSLOADER 5
-.Os
-.Sh NAME
-.Nm zfsloader
-.Nd kernel bootstrapping final stage
-.Sh DESCRIPTION
-.Nm
-is an extended variant of
-.Xr loader 5
-with added support for booting from ZFS.
-This document describes only differences from
-.Xr loader 5 .
-.Ss ZFS Features
-.Nm
-supports the following format for specifying ZFS filesystems which
-can be used wherever
-.Xr loader 5
-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 1M .
-.Pp
-If the variable
-.Va fstype
-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 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 FILES
-.Bl -tag -width /boot/zfsloader -compact
-.It Pa /boot/zfsloader
-.Nm
-itself.
-.El
-.Sh EXAMPLES
-Set the default device used for loading a kernel from a ZFS filesystem:
-.Bd -literal -offset indent
-set currdev=zfs:rpool/ROOT/knowngood:
-.Ed
-.Sh SEE ALSO
-.Xr zfs 1M ,
-.Xr zpool 1M ,
-.Xr gptzfsboot 5 ,
-.Xr loader 5
-.Sh NOTES
-Although setting the
-.Va currdev
-as shown in the example above is supported, it is advisable to use loader
-beadm command or boot environment menu instead.
-The reason is, the beadm or menu selection will also instruct loader to clean up
-the currently set configuration and load configuration from the new boot
-environment.