xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-unmount.8 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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.\"
22.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28.\" Copyright (c) 2014 Integros [integros.com]
29.\" Copyright 2019 Richard Laager. All rights reserved.
30.\" Copyright 2018 Nexenta Systems, Inc.
31.\" Copyright 2019 Joyent, Inc.
32.\"
33.Dd February 16, 2019
34.Dt ZFS-MOUNT 8
35.Os
36.Sh NAME
37.Nm zfs-mount
38.Nd Manage mount state of ZFS file systems.
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 | Ar filesystem
47.Nm zfs
48.Cm unmount
49.Op Fl fu
50.Fl a | Ar filesystem Ns | Ns Ar mountpoint
51.Sh DESCRIPTION
52.Bl -tag -width ""
53.It Xo
54.Nm zfs
55.Cm mount
56.Xc
57Displays all ZFS file systems currently mounted.
58.It Xo
59.Nm zfs
60.Cm mount
61.Op Fl Oflv
62.Op Fl o Ar options
63.Fl a | Ar filesystem
64.Xc
65Mount ZFS filesystem on a path described by its
66.Sy mountpoint
67property, if the path exists and is empty. If
68.Sy mountpoint
69is set to
70.Em legacy ,
71the filesystem should be instead mounted using
72.Xr mount 8 .
73.Bl -tag -width "-O"
74.It Fl O
75Perform an overlay mount. Allows mounting in non-empty
76.Sy mountpoint .
77See
78.Xr mount 8
79for more information.
80.It Fl a
81Mount all available ZFS file systems.
82Invoked automatically as part of the boot process if configured.
83.It Ar filesystem
84Mount the specified filesystem.
85.It Fl o Ar options
86An optional, comma-separated list of mount options to use temporarily for the
87duration of the mount.
88See the
89.Em Temporary Mount Point Properties
90section of
91.Xr zfsprops 8
92for details.
93.It Fl l
94Load keys for encrypted filesystems as they are being mounted. This is
95equivalent to executing
96.Nm zfs Cm load-key
97on each encryption root before mounting it. Note that if a filesystem has a
98.Sy keylocation
99of
100.Sy prompt
101this will cause the terminal to interactively block after asking for the key.
102.It Fl v
103Report mount progress.
104.It Fl f
105Attempt to force mounting of all filesystems, even those that couldn't normally be mounted (e.g. redacted datasets).
106.El
107.It Xo
108.Nm zfs
109.Cm unmount
110.Op Fl fu
111.Fl a | Ar filesystem Ns | Ns Ar mountpoint
112.Xc
113Unmounts currently mounted ZFS file systems.
114.Bl -tag -width "-a"
115.It Fl a
116Unmount all available ZFS file systems.
117Invoked automatically as part of the shutdown process.
118.It Fl f
119Forcefully unmount the file system, even if it is currently in use.
120This option is not supported on Linux.
121.It Fl u
122Unload keys for any encryption roots unmounted by this command.
123.It Ar filesystem Ns | Ns Ar mountpoint
124Unmount the specified filesystem.
125The command can also be given a path to a ZFS file system mount point on the
126system.
127.El
128.El
129