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