sys/contrib/openzfs/man/man8/zfs-mount.8

   1 .\"
   2 .\" CDDL HEADER START
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\"
  21 .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
  22 .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
  23 .\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
  24 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
  25 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
  26 .\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
  27 .\" Copyright (c) 2014 Integros [integros.com]
  28 .\" Copyright 2019 Richard Laager. All rights reserved.
  29 .\" Copyright 2018 Nexenta Systems, Inc.
  30 .\" Copyright 2019 Joyent, Inc.
  31 .\"
  32 .Dd February 16, 2019
  33 .Dt ZFS-MOUNT 8
  34 .Os
  35 .
  36 .Sh NAME
  37 .Nm zfs-mount
  38 .Nd manage mount state of ZFS filesystems
  39 .Sh SYNOPSIS
  40 .Nm zfs
  41 .Cm mount
  42 .Nm zfs
  43 .Cm mount
  44 .Op Fl Oflv
  45 .Op Fl o Ar options
  46 .Fl a Ns | Ns Ar filesystem
  47 .Nm zfs
  48 .Cm unmount
  49 .Op Fl fu
  50 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
  51 .
  52 .Sh DESCRIPTION
  53 .Bl -tag -width ""
  54 .It Xo
  55 .Nm zfs
  56 .Cm mount
  57 .Xc
  58 Displays all ZFS file systems currently mounted.
  59 .It Xo
  60 .Nm zfs
  61 .Cm mount
  62 .Op Fl Oflv
  63 .Op Fl o Ar options
  64 .Fl a Ns | Ns Ar filesystem
  65 .Xc
  66 Mount ZFS filesystem on a path described by its
  67 .Sy mountpoint
  68 property, if the path exists and is empty.
  69 If
  70 .Sy mountpoint
  71 is set to
  72 .Em legacy ,
  73 the filesystem should be instead mounted using
  74 .Xr mount 8 .
  75 .Bl -tag -width "-O"
  76 .It Fl O
  77 Perform an overlay mount.
  78 Allows mounting in non-empty
  79 .Sy mountpoint .
  80 See
  81 .Xr mount 8
  82 for more information.
  83 .It Fl a
  84 Mount all available ZFS file systems.
  85 Invoked automatically as part of the boot process if configured.
  86 .It Ar filesystem
  87 Mount the specified filesystem.
  88 .It Fl o Ar options
  89 An optional, comma-separated list of mount options to use temporarily for the
  90 duration of the mount.
  91 See the
  92 .Em Temporary Mount Point Properties
  93 section of
  94 .Xr zfsprops 7
  95 for details.
  96 .It Fl l
  97 Load keys for encrypted filesystems as they are being mounted.
  98 This is equivalent to executing
  99 .Nm zfs Cm load-key
 100 on each encryption root before mounting it.
 101 Note that if a filesystem has
 102 .Sy keylocation Ns = Ns Sy prompt ,
 103 this will cause the terminal to interactively block after asking for the key.
 104 .It Fl v
 105 Report mount progress.
 106 .It Fl f
 107 Attempt to force mounting of all filesystems, even those that couldn't normally be mounted (e.g. redacted datasets).
 108 .El
 109 .It Xo
 110 .Nm zfs
 111 .Cm unmount
 112 .Op Fl fu
 113 .Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
 114 .Xc
 115 Unmounts currently mounted ZFS file systems.
 116 .Bl -tag -width "-a"
 117 .It Fl a
 118 Unmount all available ZFS file systems.
 119 Invoked automatically as part of the shutdown process.
 120 .It Fl f
 121 Forcefully unmount the file system, even if it is currently in use.
 122 This option is not supported on Linux.
 123 .It Fl u
 124 Unload keys for any encryption roots unmounted by this command.
 125 .It Ar filesystem Ns | Ns Ar mountpoint
 126 Unmount the specified filesystem.
 127 The command can also be given a path to a ZFS file system mount point on the
 128 system.
 129 .El
 130 .El