summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/misc/usersharetemplateshare.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/misc/usersharetemplateshare.xml')
-rw-r--r--docs-xml/smbdotconf/misc/usersharetemplateshare.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/usersharetemplateshare.xml b/docs-xml/smbdotconf/misc/usersharetemplateshare.xml
new file mode 100644
index 0000000..3a74dcb
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/usersharetemplateshare.xml
@@ -0,0 +1,23 @@
+<samba:parameter name="usershare template share"
+ context="G"
+ 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"></value>
+<value type="example">template_share</value>
+</samba:parameter>