From: Michael Adam <obnox@samba.org>
Date: Fri, 18 Jan 2008 10:31:00 +0000 (+0000)
Subject: Add description of parameter "config backend" to the man pages.
X-Git-Tag: samba-3.3.0pre1~1530
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=93dd2b899163d1c384b825eef445a25f07c8e3a5;p=thirdparty%2Fsamba.git

Add description of parameter "config backend" to the man pages.

I originally forgot to do "svn add".

Michael
---

diff --git a/docs/smbdotconf/base/configbackend.xml b/docs/smbdotconf/base/configbackend.xml
new file mode 100644
index 00000000000..f9da1345557
--- /dev/null
+++ b/docs/smbdotconf/base/configbackend.xml
@@ -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>