summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/base/path.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/base/path.xml')
-rw-r--r--docs/smbdotconf/base/path.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/smbdotconf/base/path.xml b/docs/smbdotconf/base/path.xml
new file mode 100644
index 0000000000..ca99405878
--- /dev/null
+++ b/docs/smbdotconf/base/path.xml
@@ -0,0 +1,31 @@
+<samba:parameter name="path"
+ context="S"
+ basic="1" advanced="1" share="1" print="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<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 <link linkend="ROOTDIR">
+ <parameter moreinfo="none">root dir</parameter></link> if one was specified.</para>
+ </description>
+
+ <value type="default"></value>
+ <value type="example">/home/fred</value>
+</samba:parameter>