1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00
samba-mirror/docs-xml/smbdotconf/base/path.xml
Ralph Boehme f7619ac22b smbdotconf: mark "path" with substitution="1"
Signed-off-by: Ralph Boehme <slow@samba.org>
Reviewed-by: Stefan Metzmacher <metze@samba.org>
2019-11-27 10:25:33 +00:00

33 lines
1.3 KiB
XML

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