xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-share.8 (revision 77013d11e6483b970af25e13c9b892075742f7e5)
1.\"
2.\" CDDL HEADER START
3.\"
4.\" The contents of this file are subject to the terms of the
5.\" Common Development and Distribution License (the "License").
6.\" You may not use this file except in compliance with the License.
7.\"
8.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9.\" or http://www.opensolaris.org/os/licensing.
10.\" See the License for the specific language governing permissions
11.\" and limitations under the License.
12.\"
13.\" When distributing Covered Code, include this CDDL HEADER in each
14.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15.\" If applicable, add the following below this CDDL HEADER, with the
16.\" fields enclosed by brackets "[]" replaced with your own identifying
17.\" information: Portions Copyright [yyyy] [name of copyright owner]
18.\"
19.\" CDDL HEADER END
20.\"
21.\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved.
22.\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org>
23.\" Copyright (c) 2011, 2019 by Delphix. All rights reserved.
24.\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
26.\" Copyright (c) 2014 by Adam Stevko. All rights reserved.
27.\" Copyright (c) 2014 Integros [integros.com]
28.\" Copyright 2019 Richard Laager. All rights reserved.
29.\" Copyright 2018 Nexenta Systems, Inc.
30.\" Copyright 2019 Joyent, Inc.
31.\"
32.Dd June 30, 2019
33.Dt ZFS-SHARE 8
34.Os
35.
36.Sh NAME
37.Nm zfs-share
38.Nd share and unshare ZFS filesystems
39.Sh SYNOPSIS
40.Nm zfs
41.Cm share
42.Fl a Ns | Ns Ar filesystem
43.Nm zfs
44.Cm unshare
45.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
46.
47.Sh DESCRIPTION
48.Bl -tag -width ""
49.It Xo
50.Nm zfs
51.Cm share
52.Fl a Ns | Ns Ar filesystem
53.Xc
54Shares available ZFS file systems.
55.Bl -tag -width "-a"
56.It Fl a
57Share all available ZFS file systems.
58Invoked automatically as part of the boot process.
59.It Ar filesystem
60Share the specified filesystem according to the
61.Sy sharenfs
62and
63.Sy sharesmb
64properties.
65File systems are shared when the
66.Sy sharenfs
67or
68.Sy sharesmb
69property is set.
70.El
71.It Xo
72.Nm zfs
73.Cm unshare
74.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
75.Xc
76Unshares currently shared ZFS file systems.
77.Bl -tag -width "-a"
78.It Fl a
79Unshare all available ZFS file systems.
80Invoked automatically as part of the shutdown process.
81.It Ar filesystem Ns | Ns Ar mountpoint
82Unshare the specified filesystem.
83The command can also be given a path to a ZFS file system shared on the system.
84.El
85.El
86.
87.Sh SEE ALSO
88.Xr exports 5 ,
89.Xr smb.conf 5 ,
90.Xr zfsprops 7
91