summaryrefslogtreecommitdiff
path: root/docs/smbdotconf
diff options
context:
space:
mode:
authorMichael Adam <obnox@samba.org>2007-06-22 22:44:13 +0000
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:33 -0500
commit31e61423b9f7b708dcb79b7932b9c3d582988d5f (patch)
tree7824d001df4e748ed515bf147af1adee70f01b4e /docs/smbdotconf
parent1846e7c767fd20e904f30c7eb719c7d56f56553e (diff)
downloadsamba-31e61423b9f7b708dcb79b7932b9c3d582988d5f.tar.gz
samba-31e61423b9f7b708dcb79b7932b9c3d582988d5f.tar.bz2
samba-31e61423b9f7b708dcb79b7932b9c3d582988d5f.zip
Add an initial amount of documentation of registry based
configuration to smb.conf(5). This explains registry shares and registry global options and mentions "net conf". This will be in 3.0.26, but Jerry told me to commit this anyways. The plan is to branch the doc for 3.0.25b from r1126 (say). I could not check the result since I could not get the manpages built correctly on any system I tried. So the output needs to be checked - sorry, I will fix my environment later... Michael (This used to be commit 2195dc476f4946ff062b62cf29d1b330263507bc)
Diffstat (limited to 'docs/smbdotconf')
-rw-r--r--docs/smbdotconf/misc/include.xml12
-rw-r--r--docs/smbdotconf/misc/registryshares.xml16
2 files changed, 27 insertions, 1 deletions
diff --git a/docs/smbdotconf/misc/include.xml b/docs/smbdotconf/misc/include.xml
index 17ccea33c0..84e20dff89 100644
--- a/docs/smbdotconf/misc/include.xml
+++ b/docs/smbdotconf/misc/include.xml
@@ -1,6 +1,6 @@
<samba:parameter name="include"
context="G"
- type="string"
+ type="string"
hide="1"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
@@ -13,6 +13,16 @@
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 <term>registry</term> 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>
diff --git a/docs/smbdotconf/misc/registryshares.xml b/docs/smbdotconf/misc/registryshares.xml
new file mode 100644
index 0000000000..5557661998
--- /dev/null
+++ b/docs/smbdotconf/misc/registryshares.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="config file"
+ context="G"
+ type="bool"
+ advanced="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>
+ This turns on or off support for share definitions read from
+ registry. Shares in defined in <term>smb.conf</term> take
+ precedence over shares with the same name defined in
+ registry. See the section on registry-based configuration
+ for details.
+ </para>
+</description>
+<value type="example">/usr/local/samba/lib/smb.conf.%m</value>
+</samba:parameter>