xref: /freebsd/sys/contrib/openzfs/man/man8/mount.zfs.8 (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 https://opensource.org/licenses/CDDL-1.0.
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 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
22.\"
23.Dd May 24, 2021
24.Dt MOUNT.ZFS 8
25.Os
26.
27.Sh NAME
28.Nm mount.zfs
29.Nd mount ZFS filesystem
30.Sh SYNOPSIS
31.Nm
32.Op Fl sfnvh
33.Op Fl o Ar options
34.Ar dataset
35.Ar mountpoint
36.
37.Sh DESCRIPTION
38The
39.Nm
40helper is used by
41.Xr mount 8
42to mount filesystem snapshots and
43.Sy mountpoint= Ns Ar legacy
44ZFS filesystems, as well as by
45.Xr zfs 8
46when the
47.Sy ZFS_MOUNT_HELPER
48environment variable is not set.
49Users should should invoke either
50.Xr mount 8
51or
52.Xr zfs 8
53in most cases.
54.Pp
55.Ar options
56are handled according to the
57.Em Temporary Mount Point Properties
58section in
59.Xr zfsprops 7 ,
60except for those described below.
61.Pp
62If
63.Pa /etc/mtab
64is a regular file and
65.Fl n
66was not specified, it will be updated via libmount.
67.
68.Sh OPTIONS
69.Bl -tag -width "-o xa"
70.It Fl s
71Ignore unknown (sloppy) mount options.
72.It Fl f
73Do everything except actually executing the system call.
74.It Fl n
75Never update
76.Pa /etc/mtab .
77.It Fl v
78Print resolved mount options and parser state.
79.It Fl h
80Print the usage message.
81.It Fl o Ar zfsutil
82This private flag indicates that
83.Xr mount 8
84is being called by the
85.Xr zfs 8
86command.
87.El
88.
89.Sh SEE ALSO
90.Xr fstab 5 ,
91.Xr mount 8 ,
92.Xr zfs-mount 8
93