docs:smbdotconf: add handler info to smbdotconf docs where missing
[sfrench/samba-autobuild/.git] / docs-xml / smbdotconf / misc / include.xml
1 <samba:parameter name="include"
2                  context="S"
3                  type="string"
4                  generated_function="0"
5                  handler="handle_include"
6                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
7 <description>
8         <para>
9         This allows you to include one config file inside another.  The file is included literally, as though typed 
10         in place.
11         </para>
12
13         <para>
14         It takes the standard substitutions, except <parameter moreinfo="none">%u</parameter>, 
15         <parameter moreinfo="none">%P</parameter> and <parameter moreinfo="none">%S</parameter>.
16         </para>
17
18         <para>
19         The parameter <parameter>include = registry</parameter> has
20         a special meaning: It does <emphasis>not</emphasis> include
21         a file named <emphasis>registry</emphasis> from the current working
22         directory, but instead reads the global configuration options
23         from the registry. See the section on registry-based
24         configuration for details. Note that this option
25         automatically activates registry shares.
26         </para>
27 </description>
28
29 <value type="default"></value>
30 <value type="example">/usr/local/samba/lib/admin_smb.conf</value>
31 </samba:parameter>