xref: /freebsd/sys/contrib/openzfs/man/man8/mount.zfs.8 (revision 271171e0d97b88ba2a7c3bf750c9672b484c1c13)
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
9*271171e0SMartin Matuska.\" or https://opensource.org/licenses/CDDL-1.0.
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.\"
2316038816SMartin Matuska.Dd May 24, 2021
2416038816SMartin Matuska.Dt MOUNT.ZFS 8
2516038816SMartin Matuska.Os
2616038816SMartin Matuska.
2716038816SMartin Matuska.Sh NAME
2816038816SMartin Matuska.Nm mount.zfs
2916038816SMartin Matuska.Nd mount ZFS filesystem
3016038816SMartin Matuska.Sh SYNOPSIS
3116038816SMartin Matuska.Nm
3216038816SMartin Matuska.Op Fl sfnvh
3316038816SMartin Matuska.Op Fl o Ar options
3416038816SMartin Matuska.Ar dataset
3516038816SMartin Matuska.Ar mountpoint
3616038816SMartin Matuska.
3716038816SMartin Matuska.Sh DESCRIPTION
3816038816SMartin MatuskaThe
3916038816SMartin Matuska.Nm
4016038816SMartin Matuskahelper is used by
4116038816SMartin Matuska.Xr mount 8
4216038816SMartin Matuskato mount filesystem snapshots and
4316038816SMartin Matuska.Sy mountpoint= Ns Ar legacy
4416038816SMartin MatuskaZFS filesystems, as well as by
4516038816SMartin Matuska.Xr zfs 8
4616038816SMartin Matuskawhen the
4716038816SMartin Matuska.Sy ZFS_MOUNT_HELPER
4816038816SMartin Matuskaenvironment variable is not set.
4916038816SMartin MatuskaUsers should should invoke either
5016038816SMartin Matuska.Xr mount 8
51eda14cbcSMatt Macyor
5216038816SMartin Matuska.Xr zfs 8
5316038816SMartin Matuskain most cases.
5416038816SMartin Matuska.Pp
5516038816SMartin Matuska.Ar options
5616038816SMartin Matuskaare handled according to the
5716038816SMartin Matuska.Em Temporary Mount Point Properties
5816038816SMartin Matuskasection in
593ff01b23SMartin Matuska.Xr zfsprops 7 ,
6016038816SMartin Matuskaexcept for those described below.
6116038816SMartin Matuska.Pp
6216038816SMartin MatuskaIf
6316038816SMartin Matuska.Pa /etc/mtab
6416038816SMartin Matuskais a regular file and
6516038816SMartin Matuska.Fl n
6616038816SMartin Matuskawas not specified, it will be updated via libmount.
6716038816SMartin Matuska.
6816038816SMartin Matuska.Sh OPTIONS
6916038816SMartin Matuska.Bl -tag -width "-o xa"
7016038816SMartin Matuska.It Fl s
7116038816SMartin MatuskaIgnore unknown (sloppy) mount options.
7216038816SMartin Matuska.It Fl f
7316038816SMartin MatuskaDo everything except actually executing the system call.
7416038816SMartin Matuska.It Fl n
7516038816SMartin MatuskaNever update
7616038816SMartin Matuska.Pa /etc/mtab .
7716038816SMartin Matuska.It Fl v
7816038816SMartin MatuskaPrint resolved mount options and parser state.
7916038816SMartin Matuska.It Fl h
80eda14cbcSMatt MacyPrint the usage message.
8116038816SMartin Matuska.It Fl o Ar zfsutil
82eda14cbcSMatt MacyThis private flag indicates that
8316038816SMartin Matuska.Xr mount 8
84eda14cbcSMatt Macyis being called by the
8516038816SMartin Matuska.Xr zfs 8
86eda14cbcSMatt Macycommand.
8716038816SMartin Matuska.El
8816038816SMartin Matuska.
8916038816SMartin Matuska.Sh SEE ALSO
9016038816SMartin Matuska.Xr fstab 5 ,
9116038816SMartin Matuska.Xr mount 8 ,
9216038816SMartin Matuska.Xr zfs-mount 8
93