svn commit: samba-docs r956 - in trunk/smbdotconf/misc: .

[jra at samba.org]

Author: jra
Date: 2006-05-19 01:22:17 +0000 (Fri, 19 May 2006)
New Revision: 956

WebSVN: http://websvn.samba.org/cgi-bin/viewcvs.cgi?view=rev&root=samba-docs&rev=956

Log:
Add usershare prefix allow/deny list docs.
Jeremy.

Added:
   trunk/smbdotconf/misc/usershareprefixallowlist.xml
   trunk/smbdotconf/misc/usershareprefixdenylist.xml


Changeset:
Added: trunk/smbdotconf/misc/usershareprefixallowlist.xml
===================================================================
--- trunk/smbdotconf/misc/usershareprefixallowlist.xml	2006-05-19 00:35:25 UTC (rev 955)
+++ trunk/smbdotconf/misc/usershareprefixallowlist.xml	2006-05-19 01:22:17 UTC (rev 956)
@@ -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>

Added: trunk/smbdotconf/misc/usershareprefixdenylist.xml
===================================================================
--- trunk/smbdotconf/misc/usershareprefixdenylist.xml	2006-05-19 00:35:25 UTC (rev 955)
+++ trunk/smbdotconf/misc/usershareprefixdenylist.xml	2006-05-19 01:22:17 UTC (rev 956)
@@ -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>