Add description of parameter "config backend" to the man pages.
authorMichael Adam <obnox@samba.org>
Fri, 18 Jan 2008 10:31:00 +0000 (10:31 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:42 +0000 (08:47 -0500)
I originally forgot to do "svn add".

Michael

docs/smbdotconf/base/configbackend.xml [new file with mode: 0644]

diff --git a/docs/smbdotconf/base/configbackend.xml b/docs/smbdotconf/base/configbackend.xml
new file mode 100644 (file)
index 0000000..f9da134
--- /dev/null
@@ -0,0 +1,26 @@
+<samba:parameter name="config backend"
+                 context="G"
+                                type="enum"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+       <para>
+               This controls the backend for storing the configuration.
+               Possible values are <emphasis>file</emphasis> (the default)
+               and <emphasis>registry</emphasis>.
+               When <smbconfoption name="config backend">registry</smbconfoption>
+                is encountered while loading <emphasis>smb.conf</emphasis>,
+               the configuration read so far is dropped and the global
+               options are read from registry instead. So this triggers a
+               registry only configuration. Share definitions are not read
+               immediately but instead <parameter>registry
+               shares</parameter> is set to <emphasis>yes</emphasis>.
+       </para>
+       <para>
+               Note: This option can not be set inside the registry
+               configuration itself.
+       </para>
+</description>
+<value type="default">file</value>
+<value type="example">registry</value>
+</samba:parameter>