docs-xml/smbdotconf/base/path.xml

   1 <samba:parameter name="path"
   2                  context="S"
   3                  type="string"
   4                  substitution="1"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <synonym>directory</synonym>
   7 <description>
   8         <para>This parameter specifies a directory to which
   9         the user of the service is to be given access. In the case of
  10         printable services, this is where print data will spool prior to
  11         being submitted to the host for printing.</para>
  12
  13         <para>For a printable service offering guest access, the service
  14         should be readonly and the path should be world-writeable and
  15         have the sticky bit set. This is not mandatory of course, but
  16         you probably won't get the results you expect if you do
  17         otherwise.</para>
  18
  19         <para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path
  20         will be replaced with the UNIX username that the client is using
  21         on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter>
  22         will be replaced by the NetBIOS name of the machine they are
  23         connecting from. These replacements are very useful for setting
  24         up pseudo home directories for users.</para>
  25
  26 <para>Note that this path will be based on <smbconfoption name="root dir"/>
  27          if one was specified.</para>
  28         </description>
  29
  30         <value type="default"></value>
  31         <value type="example">/home/fred</value>
  32 </samba:parameter>