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