xref: /freebsd-src/sys/contrib/openzfs/man/man8/zfs-share.8 (revision 7877fdebeeb35fad1cbbafce22598b1bdf97c786)
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.\"
22eda14cbcSMatt Macy.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
23eda14cbcSMatt Macy.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
24eda14cbcSMatt Macy.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
25eda14cbcSMatt Macy.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
26eda14cbcSMatt Macy.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
27eda14cbcSMatt Macy.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
28eda14cbcSMatt Macy.\" Copyright (c) 2014 Integros [integros.com]
29eda14cbcSMatt Macy.\" Copyright 2019 Richard Laager. All rights reserved.
30eda14cbcSMatt Macy.\" Copyright 2018 Nexenta Systems, Inc.
31eda14cbcSMatt Macy.\" Copyright 2019 Joyent, Inc.
32eda14cbcSMatt Macy.\"
33eda14cbcSMatt Macy.Dd June 30, 2019
34eda14cbcSMatt Macy.Dt ZFS-SHARE 8
35eda14cbcSMatt Macy.Os
36eda14cbcSMatt Macy.Sh NAME
37*7877fdebSMatt Macy.Nm zfs-share
38eda14cbcSMatt Macy.Nd Shares and unshares available ZFS filesystems.
39eda14cbcSMatt Macy.Sh SYNOPSIS
40*7877fdebSMatt Macy.Nm zfs
41eda14cbcSMatt Macy.Cm share
42eda14cbcSMatt Macy.Fl a | Ar filesystem
43*7877fdebSMatt Macy.Nm zfs
44eda14cbcSMatt Macy.Cm unshare
45eda14cbcSMatt Macy.Fl a | Ar filesystem Ns | Ns Ar mountpoint
46eda14cbcSMatt Macy.Sh DESCRIPTION
47eda14cbcSMatt Macy.Bl -tag -width ""
48eda14cbcSMatt Macy.It Xo
49*7877fdebSMatt Macy.Nm zfs
50eda14cbcSMatt Macy.Cm share
51eda14cbcSMatt Macy.Fl a | Ar filesystem
52eda14cbcSMatt Macy.Xc
53eda14cbcSMatt MacyShares available ZFS file systems.
54eda14cbcSMatt Macy.Bl -tag -width "-a"
55eda14cbcSMatt Macy.It Fl a
56eda14cbcSMatt MacyShare all available ZFS file systems.
57eda14cbcSMatt MacyInvoked automatically as part of the boot process.
58eda14cbcSMatt Macy.It Ar filesystem
59eda14cbcSMatt MacyShare the specified filesystem according to the
60eda14cbcSMatt Macy.Sy sharenfs
61eda14cbcSMatt Macyand
62eda14cbcSMatt Macy.Sy sharesmb
63eda14cbcSMatt Macyproperties.
64eda14cbcSMatt MacyFile systems are shared when the
65eda14cbcSMatt Macy.Sy sharenfs
66eda14cbcSMatt Macyor
67eda14cbcSMatt Macy.Sy sharesmb
68eda14cbcSMatt Macyproperty is set.
69eda14cbcSMatt Macy.El
70eda14cbcSMatt Macy.It Xo
71*7877fdebSMatt Macy.Nm zfs
72eda14cbcSMatt Macy.Cm unshare
73eda14cbcSMatt Macy.Fl a | Ar filesystem Ns | Ns Ar mountpoint
74eda14cbcSMatt Macy.Xc
75eda14cbcSMatt MacyUnshares currently shared ZFS file systems.
76eda14cbcSMatt Macy.Bl -tag -width "-a"
77eda14cbcSMatt Macy.It Fl a
78eda14cbcSMatt MacyUnshare all available ZFS file systems.
79eda14cbcSMatt MacyInvoked automatically as part of the shutdown process.
80eda14cbcSMatt Macy.It Ar filesystem Ns | Ns Ar mountpoint
81eda14cbcSMatt MacyUnshare the specified filesystem.
82eda14cbcSMatt MacyThe command can also be given a path to a ZFS file system shared on the system.
83eda14cbcSMatt Macy.El
84eda14cbcSMatt Macy.El
85eda14cbcSMatt Macy.Sh SEE ALSO
86eda14cbcSMatt Macy.Xr exports 5 ,
87eda14cbcSMatt Macy.Xr smb.conf 5 ,
88eda14cbcSMatt Macy.Xr zfsprops 8
89