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