Merge Samba3 and Samba4 together
[amitay/samba.git] / docs-xml / smbdotconf / misc / defaultservice.xml
1 <samba:parameter name="default service"
2                  context="G"
3                  advanced="1" developer="1"
4                                  type="string"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <synonym>default</synonym>
7 <description>
8         <para>This parameter specifies the name of a service
9         which will be connected to if the service actually requested cannot
10         be found. Note that the square brackets are <emphasis>NOT</emphasis>
11         given in the parameter value (see example below).</para>
12
13         <para>There is no default value for this parameter. If this 
14         parameter is not given, attempting to connect to a nonexistent 
15         service results in an error.</para>
16
17         <para>
18         Typically the default service would be a <smbconfoption name="guest ok"/>, <smbconfoption
19         name="read-only"/> service.</para> <para>Also note that the apparent service name will be changed to equal
20         that of the requested service, this is very useful as it allows you to use macros like <parameter
21         moreinfo="none">%S</parameter> to make a wildcard service.
22         </para>
23
24         <para>Note also that any &quot;_&quot; characters in the name of the service 
25         used in the default service will get mapped to a &quot;/&quot;. This allows for
26         interesting things.</para>
27 </description>
28 <value type="default"></value>
29 <value type="example">pub</value>
30 </samba:parameter>