xref: /freebsd/sys/contrib/openzfs/man/man8/mount.zfs.8 (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1.\" SPDX-License-Identifier: CDDL-1.0
2.\"
3.\" CDDL HEADER START
4.\"
5.\" The contents of this file are subject to the terms of the
6.\" Common Development and Distribution License (the "License").
7.\" You may not use this file except in compliance with the License.
8.\"
9.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10.\" or https://opensource.org/licenses/CDDL-1.0.
11.\" See the License for the specific language governing permissions
12.\" and limitations under the License.
13.\"
14.\" When distributing Covered Code, include this CDDL HEADER in each
15.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16.\" If applicable, add the following below this CDDL HEADER, with the
17.\" fields enclosed by brackets "[]" replaced with your own identifying
18.\" information: Portions Copyright [yyyy] [name of copyright owner]
19.\"
20.\" CDDL HEADER END
21.\"
22.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
23.\"
24.Dd May 24, 2021
25.Dt MOUNT.ZFS 8
26.Os
27.
28.Sh NAME
29.Nm mount.zfs
30.Nd mount ZFS filesystem
31.Sh SYNOPSIS
32.Nm
33.Op Fl sfnvh
34.Op Fl o Ar options
35.Ar dataset
36.Ar mountpoint
37.
38.Sh DESCRIPTION
39The
40.Nm
41helper is used by
42.Xr mount 8
43to mount filesystem snapshots and
44.Sy mountpoint= Ns Ar legacy
45ZFS filesystems, as well as by
46.Xr zfs 8
47when the
48.Sy ZFS_MOUNT_HELPER
49environment variable is not set.
50Users should should invoke either
51.Xr mount 8
52or
53.Xr zfs 8
54in most cases.
55.Pp
56.Ar options
57are handled according to the
58.Em Temporary Mount Point Properties
59section in
60.Xr zfsprops 7 ,
61except for those described below.
62.Pp
63If
64.Pa /etc/mtab
65is a regular file and
66.Fl n
67was not specified, it will be updated via libmount.
68.
69.Sh OPTIONS
70.Bl -tag -width "-o xa"
71.It Fl s
72Ignore unknown (sloppy) mount options.
73.It Fl f
74Do everything except actually executing the system call.
75.It Fl n
76Never update
77.Pa /etc/mtab .
78.It Fl v
79Print resolved mount options and parser state.
80.It Fl h
81Print the usage message.
82.It Fl o Ar zfsutil
83This private flag indicates that
84.Xr mount 8
85is being called by the
86.Xr zfs 8
87command.
88.El
89.
90.Sh SEE ALSO
91.Xr fstab 5 ,
92.Xr mount 8 ,
93.Xr zfs-mount 8
94