Moving docs tree to docs-xml to make room for generated docs in the release tarball.

(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)

5 files changed, 145 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/wins/dnsproxy.xml b/docs-xml/smbdotconf/wins/dnsproxy.xml
new file mode 100644
index 0000000000..018c7d93a7
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/dnsproxy.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="dns proxy"
+                 context="G"
+				 type="boolean"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>Specifies that <citerefentry><refentrytitle>nmbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> when acting as a WINS server and 
+	finding that a NetBIOS name has not been registered, should treat the 
+	NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server 
+	for that name on behalf of the name-querying client.</para>
+
+	<para>Note that the maximum length for a NetBIOS name is 15 
+	characters, so the DNS name (or DNS alias) can likewise only be 
+	15 characters, maximum.</para>
+
+	<para><command moreinfo="none">nmbd</command> spawns a second copy of itself to do the
+	DNS name lookup requests, as doing a name lookup is a blocking 
+	action.</para>
+</description>
+
+<related>wins support</related>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winshook.xml b/docs-xml/smbdotconf/wins/winshook.xml
new file mode 100644
index 0000000000..9e41fbd7c8
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winshook.xml
@@ -0,0 +1,58 @@
+<samba:parameter name="wins hook"
+                 context="G"
+				 type="string"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>When Samba is running as a WINS server this 
+	allows you to call an external program for all changes to the 
+	WINS database. The primary use for this option is to allow the 
+	dynamic update of external name resolution databases such as 
+	dynamic DNS.</para>
+
+	<para>The wins hook parameter specifies the name of a script 
+	or executable that will be called as follows:</para>
+
+	<para><command moreinfo="none">wins_hook operation name nametype ttl IP_list</command></para>
+
+	<itemizedlist>
+		<listitem>
+			<para>The first argument is the operation and is
+			one  of &quot;add&quot;, &quot;delete&quot;, or
+			&quot;refresh&quot;. In most cases the operation
+			can  be ignored as the rest of the parameters
+			provide sufficient  information. Note that
+			&quot;refresh&quot; may sometimes be called when
+			the  name has not previously been added, in that
+			case it should be treated  as an add.</para>
+		</listitem>
+
+		<listitem>
+			<para>The second argument is the NetBIOS name. If the 
+			name is not a legal name then the wins hook is not called. 
+			Legal names contain only  letters, digits, hyphens, underscores 
+			and periods.</para>
+		</listitem>
+
+		<listitem>
+			<para>The third argument is the NetBIOS name 
+			type as a 2 digit hexadecimal number. </para>
+		</listitem>
+
+		<listitem>
+			<para>The fourth argument is the TTL (time to live) 
+			for the name in seconds.</para>
+		</listitem>
+			
+		<listitem>
+			<para>The fifth and subsequent arguments are the IP 
+			addresses currently registered for that name. If this list is 
+			empty then the name should be deleted.</para>
+		</listitem>
+	</itemizedlist>
+
+	<para>An example script that calls the BIND dynamic DNS update 
+	program <command moreinfo="none">nsupdate</command> is provided in the examples 
+	directory of the Samba source code. </para>
+</description>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsproxy.xml b/docs-xml/smbdotconf/wins/winsproxy.xml
new file mode 100644
index 0000000000..8f98687dba
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsproxy.xml
@@ -0,0 +1,13 @@
+<samba:parameter name="wins proxy"
+                 context="G"
+				 type="boolean"
+                 advanced="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is a boolean that controls if <citerefentry><refentrytitle>nmbd</refentrytitle>                                 
+	<manvolnum>8</manvolnum></citerefentry> will respond to broadcast name 
+	queries on behalf of  other hosts. You may need to set this 
+	to <constant>yes</constant> for some older clients.</para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsserver.xml b/docs-xml/smbdotconf/wins/winsserver.xml
new file mode 100644
index 0000000000..afced35f50
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsserver.xml
@@ -0,0 +1,34 @@
+<samba:parameter name="wins server"
+                 context="G"
+				 type="boolean"
+                 basic="1" advanced="1" wizard="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This specifies the IP address (or DNS name: IP 
+	address for preference) of the WINS server that <citerefentry><refentrytitle>nmbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> should register with. If you have a WINS server on 
+	your network then you should set this to the WINS server's IP.</para>
+
+	<para>You should point this at your WINS server if you have a
+	multi-subnetted network.</para>
+
+	<para>If you want to work in multiple namespaces, you can 
+	give every wins server a 'tag'. For each tag, only one 
+	(working) server will be queried for a name. The tag should be 
+	separated from the ip address by a colon.
+	</para>
+
+	<note><para>You need to set up Samba to point 
+	to a WINS server if you have multiple subnets and wish cross-subnet 
+	browsing to work correctly.</para></note>
+	<para>See the chapter in the Samba3-HOWTO on Network Browsing.</para>
+</description>
+
+<value type="default"></value>
+<value type="example">mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61
+	<comment>For this example when querying a certain name, 192.19.200.1 will 
+	be asked first and if that doesn't respond 192.168.2.61. If either 
+	of those doesn't know the name 192.168.3.199 will be queried.</comment></value>
+
+<value type="example">192.9.200.1 192.168.2.61</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winssupport.xml b/docs-xml/smbdotconf/wins/winssupport.xml
new file mode 100644
index 0000000000..b4f89528ec
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winssupport.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="wins support"
+	type="boolean"
+                 context="G"
+                 basic="1" advanced="1" wizard="1" developer="1"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <description>
+	<para>This boolean controls if the <citerefentry><refentrytitle>nmbd</refentrytitle>
+	<manvolnum>8</manvolnum></citerefentry> process in Samba will act as a WINS server. You should 
+	not set this to <constant>yes</constant> unless you have a multi-subnetted network and 
+	you wish a particular <command moreinfo="none">nmbd</command> to be your WINS server. 
+	Note that you should <emphasis>NEVER</emphasis> set this to <constant>yes</constant>
+	on more than one machine in your network.</para>
+
+</description>
+<value type="default">no</value>
+</samba:parameter>