[mirror_zfs-debian.git] / man / man8 / mount.zfs.8

'\" t
.\"
.\" CDDL HEADER START
.\"
.\" The contents of this file are subject to the terms of the
.\" Common Development and Distribution License (the "License").
.\" You may not use this file except in compliance with the License.
.\"
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
.\" or http://www.opensolaris.org/os/licensing.
.\" See the License for the specific language governing permissions
.\" and limitations under the License.
.\"
.\" When distributing Covered Code, include this CDDL HEADER in each
.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
.\" If applicable, add the following below this CDDL HEADER, with the
.\" fields enclosed by brackets "[]" replaced with your own identifying
.\" information: Portions Copyright [yyyy] [name of copyright owner]
.\"
.\" CDDL HEADER END
.\"
.\"
.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
.\"
.TH mount.zfs 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands"

.SH NAME
mount.zfs \- mount a ZFS filesystem
.SH SYNOPSIS
.LP
.BI "mount.zfs [\-sfnvh] [\-o " options "]" " dataset mountpoint

.SH DESCRIPTION
.BR mount.zfs
is part of the zfsutils package for Linux. It is a helper program that
is usually invoked by the
.BR mount (8)
or
.BR zfs (8)
commands to mount a ZFS dataset.

All
.I options
are handled according to the FILESYSTEM INDEPENDENT MOUNT OPTIONS
section in the
.BR mount (8)
manual, except for those described below.

The
.I dataset
parameter is a ZFS filesystem name, as output by the
.B "zfs list -H -o name
command. This parameter never has a leading slash character and is
not a device name.

The
.I mountpoint
parameter is the path name of a directory.


.SH OPTIONS
.TP
.BI "\-s"
Ignore bad or sloppy mount options.
.TP
.BI "\-f"
Do a fake mount; do not perform the mount operation.
.TP
.BI "\-n"
Do not update the /etc/mtab file.
.TP
.BI "\-v"
Increase verbosity.
.TP
.BI "\-h"
Print the usage message.
.TP
.BI "\-o context"
This flag sets the SELinux context for all files in the filesytem
under that mountpoint.
.TP
.BI "\-o fscontext"
This flag sets the SELinux context for the filesytem being mounted.
.TP
.BI "\-o defcontext"
This flag sets the SELinux context for unlabeled files.
.TP
.BI "\-o rootcontext"
This flag sets the SELinux context for the root inode of the filesystem.
.TP
.BI "\-o legacy"
This private flag indicates that the
.I dataset
has an entry in the /etc/fstab file.
.TP
.BI "\-o noxattr"
This private flag disables extended attributes.
.TP
.BI "\-o xattr
This private flag enables directory-based extended attributes and, if
appropriate, adds a ZFS context to the selinux system policy.
.TP
.BI "\-o saxattr
This private flag enables system attributed-based extended attributes and, if
appropriate, adds a ZFS context to the selinux system policy.
.TP
.BI "\-o dirxattr
Equivalent to
.BR xattr .
.TP
.BI "\-o zfsutil"
This private flag indicates that
.BR mount (8)
is being called by the
.BR zfs (8)
command.

.SH NOTES
ZFS conventionally requires that the
.I mountpoint
be an empty directory, but the Linux implementation inconsistently
enforces the requirement.

The
.BR mount.zfs
helper does not mount the contents of zvols.

.SH FILES
.TP 18n
.I /etc/fstab
The static filesystem table.
.TP
.I /etc/mtab
The mounted filesystem table.
.SH "AUTHORS"
The primary author of
.BR mount.zfs
is Brian Behlendorf <behlendorf1@llnl.gov>.

This man page was written by Darik Horn <dajhorn@vanadac.com>.
.SH "SEE ALSO"
.BR fstab (5),
.BR mount (8),
.BR zfs (8)
Commit	Line	Data
cf2129e6 DH	1	'\" t
	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 http://www.opensolaris.org/os/licensing.
	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	.\"
	23	.\" Copyright 2013 Darik Horn <dajhorn@vanadac.com>. All rights reserved.
	24	.\"
	25	.TH mount.zfs 8 "2013 FEB 28" "ZFS on Linux" "System Administration Commands"
	26
	27	.SH NAME
	28	mount.zfs \- mount a ZFS filesystem
	29	.SH SYNOPSIS
	30	.LP
	31	.BI "mount.zfs [\-sfnvh] [\-o " options "]" " dataset mountpoint
	32
	33	.SH DESCRIPTION
	34	.BR mount.zfs
	35	is part of the zfsutils package for Linux. It is a helper program that
	36	is usually invoked by the
	37	.BR mount (8)
	38	or
	39	.BR zfs (8)
	40	commands to mount a ZFS dataset.
	41
	42	All
	43	.I options
	44	are handled according to the FILESYSTEM INDEPENDENT MOUNT OPTIONS
	45	section in the
	46	.BR mount (8)
	47	manual, except for those described below.
	48
	49	The
	50	.I dataset
	51	parameter is a ZFS filesystem name, as output by the
	52	.B "zfs list -H -o name
	53	command. This parameter never has a leading slash character and is
	54	not a device name.
	55
	56	The
	57	.I mountpoint
	58	parameter is the path name of a directory.
	59
	60
	61	.SH OPTIONS
	62	.TP
	63	.BI "\-s"
	64	Ignore bad or sloppy mount options.
65	.TP
66	.BI "\-f"
67	Do a fake mount; do not perform the mount operation.
68	.TP
69	.BI "\-n"
70	Do not update the /etc/mtab file.
71	.TP
72	.BI "\-v"
73	Increase verbosity.
74	.TP
75	.BI "\-h"
76	Print the usage message.
77	.TP
a08ee875 LG	78	.BI "\-o context"
	79	This flag sets the SELinux context for all files in the filesytem
	80	under that mountpoint.
	81	.TP
	82	.BI "\-o fscontext"
	83	This flag sets the SELinux context for the filesytem being mounted.
	84	.TP
	85	.BI "\-o defcontext"
e10b0808	86	This flag sets the SELinux context for unlabeled files.
a08ee875 LG	87	.TP
	88	.BI "\-o rootcontext"
	89	This flag sets the SELinux context for the root inode of the filesystem.
	90	.TP
cf2129e6 DH	91	.BI "\-o legacy"
	92	This private flag indicates that the
	93	.I dataset
	94	has an entry in the /etc/fstab file.
	95	.TP
	96	.BI "\-o noxattr"
	97	This private flag disables extended attributes.
	98	.TP
	99	.BI "\-o xattr
e10b0808 AX	100	This private flag enables directory-based extended attributes and, if
	101	appropriate, adds a ZFS context to the selinux system policy.
	102	.TP
	103	.BI "\-o saxattr
	104	This private flag enables system attributed-based extended attributes and, if
	105	appropriate, adds a ZFS context to the selinux system policy.
	106	.TP
	107	.BI "\-o dirxattr
	108	Equivalent to
	109	.BR xattr .
cf2129e6 DH	110	.TP
	111	.BI "\-o zfsutil"
	112	This private flag indicates that
	113	.BR mount (8)
	114	is being called by the
	115	.BR zfs (8)
	116	command.
	117
	118	.SH NOTES
	119	ZFS conventionally requires that the
	120	.I mountpoint
	121	be an empty directory, but the Linux implementation inconsistently
	122	enforces the requirement.
	123
	124	The
	125	.BR mount.zfs
	126	helper does not mount the contents of zvols.
	127
	128	.SH FILES
	129	.TP 18n
	130	.I /etc/fstab
	131	The static filesystem table.
	132	.TP
	133	.I /etc/mtab
	134	The mounted filesystem table.
	135	.SH "AUTHORS"
	136	The primary author of
	137	.BR mount.zfs
	138	is Brian Behlendorf <behlendorf1@llnl.gov>.
	139
	140	This man page was written by Darik Horn <dajhorn@vanadac.com>.
	141	.SH "SEE ALSO"
	142	.BR fstab (5),
	143	.BR mount (8),
	144	.BR zfs (8)