3a74dcb8f0f9e44e45bfe1b4f3602256c3549726
[samba.git] / docs-xml / smbdotconf / misc / usersharetemplateshare.xml
1 <samba:parameter name="usershare template share"
2                  context="G"
3                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>User defined shares only have limited possible parameters
7         such as path, guest ok, etc. This parameter allows usershares to
8         "cloned" from an existing share. If "usershare template share"
9         is set to the name of an existing share, then all usershares
10         created have their defaults set from the parameters set on this
11         share.
12         </para>
13         <para>
14         The target share may be set to be invalid for real file
15         sharing by setting the parameter "-valid = False" on the template
16         share definition. This causes it not to be seen as a real exported
17         share but to be able to be used as a template for usershares.
18         </para>
19
20 </description>
21 <value type="default"></value>
22 <value type="example">template_share</value>
23 </samba:parameter>