summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/misc/include.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/misc/include.xml')
-rw-r--r--docs-xml/smbdotconf/misc/include.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/include.xml b/docs-xml/smbdotconf/misc/include.xml
new file mode 100644
index 0000000..cbda1ed
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/include.xml
@@ -0,0 +1,31 @@
+<samba:parameter name="include"
+ context="S"
+ type="string"
+ generated_function="0"
+ handler="handle_include"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>
+ This allows you to include one config file inside another. The file is included literally, as though typed
+ in place.
+ </para>
+
+ <para>
+ It takes the standard substitutions, except <parameter moreinfo="none">%u</parameter>,
+ <parameter moreinfo="none">%P</parameter> and <parameter moreinfo="none">%S</parameter>.
+ </para>
+
+ <para>
+ The parameter <parameter>include = registry</parameter> has
+ a special meaning: It does <emphasis>not</emphasis> include
+ a file named <emphasis>registry</emphasis> from the current working
+ directory, but instead reads the global configuration options
+ from the registry. See the section on registry-based
+ configuration for details. Note that this option
+ automatically activates registry shares.
+ </para>
+</description>
+
+<value type="default"></value>
+<value type="example">/usr/local/samba/lib/admin_smb.conf</value>
+</samba:parameter>