From: Jeremy Allison <jra@samba.org>
Date: Fri, 19 May 2006 01:22:17 +0000 (+0000)
Subject: Add usershare prefix allow/deny list docs.
X-Git-Tag: samba-4.0.0alpha6~801^2~1901
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9b6c6fc14e8181968d2b426ddc4995492d72fb50;p=thirdparty%2Fsamba.git

Add usershare prefix allow/deny list docs.
Jeremy.
(This used to be commit 13f6dba9d07ab294c413d5b36601a4919931c418)
---

diff --git a/docs/smbdotconf/misc/usershareprefixallowlist.xml b/docs/smbdotconf/misc/usershareprefixallowlist.xml
new file mode 100644
index 00000000000..bacc2e9530e
--- /dev/null
+++ b/docs/smbdotconf/misc/usershareprefixallowlist.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="usershare prefix allow list"
+	         context="G"
+		 basic="1" advanced="1"
+		 type="string"
+		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This parameter specifies a list of absolute pathnames
+	the root of which are allowed to be exported by user defined share definitions.
+	If the pathname exported doesn't start with one of the strings in this
+	list the user defined share will not be allowed. This allows the Samba
+	administrator to restrict the directories on the system that can be
+	exported by user defined shares.
+	</para>
+	<para>
+	If there is a "usershare prefix deny list" and also a
+	"usershare prefix allow list" the deny list is processed
+	first, followed by the allow list, thus leading to the most
+	restrictive interpretation.
+	</para>
+
+</description>
+<value type="default">NULL</value>
+<value type="example">/home /data /space</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/misc/usershareprefixdenylist.xml b/docs/smbdotconf/misc/usershareprefixdenylist.xml
new file mode 100644
index 00000000000..75d4ba9afc1
--- /dev/null
+++ b/docs/smbdotconf/misc/usershareprefixdenylist.xml
@@ -0,0 +1,25 @@
+<samba:parameter name="usershare prefix deny list"
+	         context="G"
+		 basic="1" advanced="1"
+		 type="string"
+		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This parameter specifies a list of absolute pathnames
+	the root of which are NOT allowed to be exported by user defined share definitions.
+	If the pathname exported starts with one of the strings in this
+	list the user defined share will not be allowed. Any pathname not
+	starting with one of these strings will be allowed to be exported
+	as a usershare. This allows the Samba administrator to restrict the
+	directories on the system that can be exported by user defined shares.
+	</para>
+	<para>
+	If there is a "usershare prefix deny list" and also a
+	"usershare prefix allow list" the deny list is processed
+	first, followed by the allow list, thus leading to the most
+	restrictive interpretation.
+	</para>
+
+</description>
+<value type="default">NULL</value>
+<value type="example">/etc /dev /private</value>
+</samba:parameter>