svn commit: r50688 - head/en_US.ISO8859-1/books/handbook/zfs

[Sevan Janiyan]

Author: sevan
Date: Fri Aug 18 19:31:46 2017
New Revision: 50688
URL: https://svnweb.freebsd.org/changeset/doc/50688

Log:
  Add get/set share properties subsection to handbook's ZFS chapter.
  
  PR:		211022
  Submitted by:	Dan Bright <freebsd AT zaziork DOT com>
  Reviewed by:	allanjude
  Approved by:	bcr (mentor)
  Differential Revision:	https://reviews.freebsd.org/D12009

Modified:
  head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml

Modified: head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Fri Aug 18 17:58:17 2017	(r50687)
+++ head/en_US.ISO8859-1/books/handbook/zfs/chapter.xml	Fri Aug 18 19:31:46 2017	(r50688)
@@ -1881,6 +1881,38 @@ NAME    PROPERTY           VALUE              SOURCE
 tank    custom:costcenter  -                  -
 &prompt.root; <userinput>zfs get all <replaceable>tank</replaceable> | grep <replaceable>custom</replaceable>:<replaceable>costcenter</replaceable></userinput>
 &prompt.root;</screen>
+
+    <sect3 xml:id="zfs-zfs-set-share">
+      <title>Getting and Setting Share Properties</title>
+
+      <para>Two commonly used and useful dataset properties are the
+      <acronym>NFS</acronym> and <acronym>SMB</acronym> share options.
+      Setting these define if and how <acronym>ZFS</acronym> datasets
+      may be shared on the network.  At present, only setting sharing
+      via <acronym>NFS</acronym> is supported on &os;.  To get the
+      current status of a share, enter:</para>
+
+      <screen>&prompt.root; <userinput>zfs get sharenfs <replaceable>mypool/usr/home</replaceable></userinput>
+	NAME             PROPERTY  VALUE    SOURCE
+	mypool/usr/home  sharenfs  on       local
+
+	&prompt.root; <userinput>zfs get sharesmb <replaceable>mypool/usr/home</replaceable></userinput>
+
+	NAME             PROPERTY  VALUE    SOURCE
+	mypool/usr/home  sharesmb  off      local</screen>
+
+      <para>To enable sharing of a dataset, enter:</para>
+
+      <screen>&prompt.root; <userinput> zfs set sharenfs=on <replaceable>mypool/usr/home</replaceable></userinput></screen>
+
+      <para>It is also possible to set additional options for sharing
+      datasets through <acronym>NFS</acronym>, such as
+      <option>-alldirs</option>, <option>-maproot</option> and
+      <option>-network</option>.  To set additional options to a
+      dataset shared through NFS, enter:</para>
+
+      <screen>&prompt.root; <userinput> zfs set sharenfs="-alldirs,-maproot=<replaceable>root</replaceable>,-network=<replaceable>192.168.1.0/24</replaceable> <replaceable>mypool/usr/home</replaceable></userinput></screen>
+      </sect3>
     </sect2>
 
     <sect2 xml:id="zfs-zfs-snapshot">