docs-xml/smbdotconf/base/path.xml

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