This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[samba.git] / docs / docbook / smbdotconf / base / path.xml
1 <samba:parameter name="path"
2                  context="S"
3                  basic="1" advanced="1" share="1" print="1" developer="1"
4                  xmlns:samba="http://samba.org/common">
5 <listitem>
6         <para>This parameter specifies a directory to which 
7         the user of the service is to be given access. In the case of 
8         printable services, this is where print data will spool prior to 
9         being submitted to the host for printing.</para>
10
11         <para>For a printable service offering guest access, the service 
12         should be readonly and the path should be world-writeable and 
13         have the sticky bit set. This is not mandatory of course, but 
14         you probably won't get the results you expect if you do 
15         otherwise.</para>
16
17         <para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path 
18         will be replaced with the UNIX username that the client is using 
19         on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter> 
20         will be replaced by the NetBIOS name of the machine they are 
21         connecting from. These replacements are very useful for setting 
22         up pseudo home directories for users.</para>
23
24         <para>Note that this path will be based on <link linkend="ROOTDIR">
25         <parameter moreinfo="none">root dir</parameter></link> if one was specified.</para>
26
27         <para>Default: <emphasis>none</emphasis></para>
28
29         <para>Example: <command moreinfo="none">path = /home/fred</command></para>
30 </listitem>
31 </samba:parameter>