xref: /freebsd/sys/contrib/openzfs/man/man8/zfs-share.8 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
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 https://opensource.org/licenses/CDDL-1.0.
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 May 17, 2021
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.Op Fl l
43.Fl a Ns | Ns Ar filesystem
44.Nm zfs
45.Cm unshare
46.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
47.
48.Sh DESCRIPTION
49.Bl -tag -width ""
50.It Xo
51.Nm zfs
52.Cm share
53.Op Fl l
54.Fl a Ns | Ns Ar filesystem
55.Xc
56Shares available ZFS file systems.
57.Bl -tag -width "-a"
58.It Fl l
59Load keys for encrypted filesystems as they are being mounted.
60This is equivalent to executing
61.Nm zfs Cm load-key
62on each encryption root before mounting it.
63Note that if a filesystem has
64.Sy keylocation Ns = Ns Sy prompt ,
65this will cause the terminal to interactively block after asking for the key.
66.It Fl a
67Share all available ZFS file systems.
68Invoked automatically as part of the boot process.
69.It Ar filesystem
70Share the specified filesystem according to the
71.Sy sharenfs
72and
73.Sy sharesmb
74properties.
75File systems are shared when the
76.Sy sharenfs
77or
78.Sy sharesmb
79property is set.
80.El
81.It Xo
82.Nm zfs
83.Cm unshare
84.Fl a Ns | Ns Ar filesystem Ns | Ns Ar mountpoint
85.Xc
86Unshares currently shared ZFS file systems.
87.Bl -tag -width "-a"
88.It Fl a
89Unshare all available ZFS file systems.
90Invoked automatically as part of the shutdown process.
91.It Ar filesystem Ns | Ns Ar mountpoint
92Unshare the specified filesystem.
93The command can also be given a path to a ZFS file system shared on the system.
94.El
95.El
96.
97.Sh SEE ALSO
98.Xr exports 5 ,
99.Xr smb.conf 5 ,
100.Xr zfsprops 7
101