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