summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/misc/defaultservice.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/misc/defaultservice.xml')
-rw-r--r--docs/smbdotconf/misc/defaultservice.xml32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/smbdotconf/misc/defaultservice.xml b/docs/smbdotconf/misc/defaultservice.xml
new file mode 100644
index 0000000000..66d9710f82
--- /dev/null
+++ b/docs/smbdotconf/misc/defaultservice.xml
@@ -0,0 +1,32 @@
+<samba:parameter name="default service"
+ context="G"
+ advanced="1" developer="1"
+ type="string"
+ xmlns:samba="http://samba.org/common">
+<synonym>default</synonym>
+<description>
+ <para>This parameter specifies the name of a service
+ which will be connected to if the service actually requested cannot
+ be found. Note that the square brackets are <emphasis>NOT</emphasis>
+ given in the parameter value (see example below).</para>
+
+ <para>There is no default value for this parameter. If this
+ parameter is not given, attempting to connect to a nonexistent
+ service results in an error.</para>
+
+ <para>Typically the default service would be a <link linkend="GUESTOK">
+ <parameter moreinfo="none">guest ok</parameter></link>, <link linkend="READONLY">
+ <parameter moreinfo="none">read-only</parameter></link> service.</para>
+
+ <para>Also note that the apparent service name will be changed
+ to equal that of the requested service, this is very useful as it
+ allows you to use macros like <parameter moreinfo="none">%S</parameter> to make
+ a wildcard service.</para>
+
+ <para>Note also that any &quot;_&quot; characters in the name of the service
+ used in the default service will get mapped to a &quot;/&quot;. This allows for
+ interesting things.</para>
+</description>
+<value type="default"></value>
+<value type="example">pub</value>
+</samba:parameter>