From 1828146977497afc1a1d8062d9e0993508696b38 Mon Sep 17 00:00:00 2001
From: Jeremy Allison <jra@samba.org>
Date: Wed, 21 Jun 2006 21:32:09 +0000
Subject: Added final usershare parameter documentation. usershare template
 share. Jeremy. (This used to be commit
 1a9dcc845a0f2d8bfac9af44f04b0e95c483d0db)

---
 docs/smbdotconf/misc/usersharetemplateshare.xml | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 docs/smbdotconf/misc/usersharetemplateshare.xml

(limited to 'docs/smbdotconf/misc/usersharetemplateshare.xml')

diff --git a/docs/smbdotconf/misc/usersharetemplateshare.xml b/docs/smbdotconf/misc/usersharetemplateshare.xml
new file mode 100644
index 0000000000..efe2e81d22
--- /dev/null
+++ b/docs/smbdotconf/misc/usersharetemplateshare.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="usershare template share"
+	         context="G"
+		 basic="1" advanced="1"
+		 type="string"
+		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>User defined shares only have limited possible parameters
+	such as path, guest ok etc. This parameter allows usershares to
+	"cloned" from an existing share. If "usershare template share"
+	is set to the name of an existing share, then all usershares
+	created have their defaults set from the parameters set on this
+	share.
+	</para>
+	<para>
+	The target share may be set to be invalid for real file
+	sharing by setting the parameter "-valid = False" on the template
+	share definition. This causes it not to be seen as a real exported
+	share but to be able to be used as a template for usershares.
+	</para>
+
+</description>
+<value type="default">NULL</value>
+<value type="example">template_share</value>
+</samba:parameter>
-- 
cgit