xref: /NextBSD/sys/boot/common/zfsloader.8 (revision 65145fa4c81da358fcbc3b650156dab705dfa34e)
1.\" Copyright (c) 2014 Andriy Gapon <avg@FreeBSD.org>
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$
26.\"
27.Dd September 15, 2014
28.Dt ZFSLOADER 8
29.Os
30.Sh NAME
31.Nm zfsloader
32.Nd kernel bootstrapping final stage
33.Sh DESCRIPTION
34.Nm
35is an extended variant of
36.Xr loader 8
37with added support for booting from ZFS.
38This document describes only differences from
39.Xr loader 8 .
40.Sh ZFS FEATURES
41.Nm
42supports the following format for specifying ZFS filesystems which
43can be used wherever
44.Xr loader 8
45refers to a device specification:
46.Pp
47.Ar zfs:pool/filesystem:
48.Pp
49where
50.Pa pool/filesystem
51is a ZFS filesystem name as described in
52.Xr zfs 8 .
53.Pp
54If
55.Pa /etc/fstab
56does not have an entry for the root filesystem and
57.Va vfs.root.mountfrom
58is not set, but
59.Va currdev
60refers to a ZFS filesystem, then
61.Nm
62will instruct kernel to use that filesystem as the root filesystem.
63.Sh ZFS COMMAND EXTENSIONS
64.Bl -tag -width Ds -compact
65.It Ic lsdev Op Fl v
66Lists ZFS pools in addition to disks and partitions.
67Adding
68.Fl v
69shows more ZFS pool details in a format that resembles
70.Nm zpool Cm status
71output.
72.Pp
73.It Ic lszfs Ar filesystem
74A ZFS extended command that can be used to explore the ZFS filesystem
75hierarchy in a pool.
76Lists the immediate children of the
77.Ar filesystem .
78The filesystem hierarchy is rooted at a filesystem with the same name
79as the pool.
80.El
81.Sh FILES
82.Bl -tag -width /boot/zfsloader -compact
83.It Pa /boot/zfsloader
84.Nm
85itself.
86.El
87.Sh EXAMPLES
88Set the default device used for loading a kernel from a ZFS filesystem:
89.Bd -literal -offset indent
90set currdev=zfs:tank/ROOT/knowngood:
91.Ed
92.Sh SEE ALSO
93.Xr gptzfsboot 8 ,
94.Xr loader 8 ,
95.Xr zfs 8 ,
96.Xr zfsboot 8 ,
97.Xr zfsloader 8 ,
98.Xr zpool 8
99.Sh HISTORY
100The
101.Nm
102first appeared in
103.Fx 7.3 .
104.Sh AUTHORS
105This manual page was written by
106.An Andriy Gapon Aq avg@FreeBSD.org .
107