sys/boot/common/zfsloader.8

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