docs-xml/smbdotconf/misc/usersharetemplateshare.xml

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