doc: document wins server's smb.conf parameters

this is from the WINS server, which was released earlier as samba4wins.

Signed-off-by: Bjoern Jacke <bjacke@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>

12 files changed, 171 insertions, 0 deletions

diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml b/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml
new file mode 100644
index 00000000000..e8d548ee7ad
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_prepend1bto1cqueries.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="nbtd:wins_prepend1Bto1Cqueries"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>Normally queries for 0x1C names (all logon servers for a domain)
+	will return the first address of the 0x1B names (domain master browser
+	and PDC) as first address in the result list. As many client only use
+	the first address in the list by default, all clients will use the same
+	server (the PDC). Windows servers have an option to disable this
+	behavior (since Windows 2000 Service Pack 2).
+	</para>
+</description>
+
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml
new file mode 100644
index 00000000000..25660625c33
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="nbtd:wins_wins_randomize1Clist"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>Normally queries for 0x1C names will return the addresses in the
+	same order as they're stored in the database, that means first all
+	addresses which have been directly registered at the local wins server
+	and then all addresses registered at other servers. Windows servers
+	have an option to change this behavior and randomize the returned
+	addresses. Set this parameter to "yes" and Samba will sort the
+	address list depending on the client address and the matching bits of
+	the addresses, the first address is randomized based on depending on
+	the "nbtd:wins_randomize1Clist_mask" parameter.
+	</para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml
new file mode 100644
index 00000000000..ea3978cf506
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/nbtd-wins_randomize1clist_mask.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="nbtd:wins_randomize1Clist_mask"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>If the "nbtd:wins_randomize1Clist" parameter is set to "yes",
+	then randomizing of the first returned address is based on the
+	specified netmask. If there are addresses which are in the same subnet
+	as the client address, the first returned address is randomly chosen
+	out them.  Otherwise the first returned address is randomly chosen out
+	of all addresses.
+	</para>
+</description>
+
+<value type="default">255.255.255.0</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsdb-localowner.xml b/docs-xml/smbdotconf/wins/winsdb-localowner.xml
new file mode 100644
index 00000000000..c5a674fd974
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsdb-localowner.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="winsdb:local_owner"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This specifies the address that is stored in the winsOwner attribute, of
+	locally registered winsRecord-objects.
+	The default is to use the ip-address of the first network interface.
+	</para>
+</description>
+
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/winsdb-nosync.xml b/docs-xml/smbdotconf/wins/winsdb-nosync.xml
new file mode 100644
index 00000000000..d66aa097570
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/winsdb-nosync.xml
@@ -0,0 +1,11 @@
+<samba:parameter name="winsdb:dbnosync"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This parameter disables fsync() after changes of the WINS database.
+	</para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml
new file mode 100644
index 00000000000..5b44993ea14
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-periodic_interval.xml
@@ -0,0 +1,14 @@
+<samba:parameter name="wreplsrv:periodic_interval"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This maximum interval in s between 2 periodically scheduled runs
+	where we check for wins.ldb changes and do push notifications to our
+	push partners. Also wins_config.ldb changes are checked in that
+	interval and partner configuration reloads are done.
+	</para>
+</description>
+
+<value type="default">15</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml b/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml
new file mode 100644
index 00000000000..9633150f7af
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-propagate_name_releases.xml
@@ -0,0 +1,23 @@
+<samba:parameter name="wreplsrv:propagate name releases"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>If this parameter is enabled, then
+	explicit (from the client) and implicit (via the scavenging) name releases
+	are propagated to the other servers directly, even if there are still other
+	addresses active, this applies to SPECIAL GROUP (2) and MULTIHOMED (3) entries.
+	Also the replication conflict merge algorithm for SPECIAL GROUP (2) entries
+	discards replica addresses where the address owner is the local server,
+	if the address was not stored locally before. The merge result is
+	propagated directly in case an address was discarded.
+	A Windows servers doesn't propagate name releases of SPECIAL GROUP (2)
+	and MULTIHOMED (3) entries directly, which means that Windows servers may
+	return different results to name queries for SPECIAL GROUP (2) and MULTIHOMED (3)
+	names. The option doesn't have much negative impact if Windows servers are
+	around, but be aware that they might return unexpected results.
+	</para>
+</description>
+
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml
new file mode 100644
index 00000000000..d05170e6d05
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-scavenging_interval.xml
@@ -0,0 +1,11 @@
+<samba:parameter name="wreplsrv:scavenging_interval"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is the interval in s between 2 scavenging runs which
+	clean up the WINS database and changes the states of expired name records.
+	Defaults to half of the value of wreplsrv:renew_interval.
+	</para>
+</description>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml
new file mode 100644
index 00000000000..23208545fcf
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_extra_timeout.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_extra_timeout"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is the time in s the server needs to be up till we'll remove
+	tombstone records from our database. Defaults to 3 days.
+	</para>
+</description>
+
+<value type="default">259200</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml
new file mode 100644
index 00000000000..ee7d7271dde
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_interval.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_interval"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is the interval in s till released records of the WINS
+	server become tombstone. Defaults to 6 days.
+	</para>
+</description>
+
+<value type="default">518400</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml
new file mode 100644
index 00000000000..b17def9af05
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-tombstone_timeout.xml
@@ -0,0 +1,12 @@
+<samba:parameter name="wreplsrv:tombstone_timeout"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is the interval in s till tombstone records are deleted from
+	the WINS database. Defaults to 1 day.
+	</para>
+</description>
+
+<value type="default">86400</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml b/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml
new file mode 100644
index 00000000000..1efd97bbaed
--- /dev/null
+++ b/docs-xml/smbdotconf/wins/wreplsrv-verify_interval.xml
@@ -0,0 +1,13 @@
+<samba:parameter name="wreplsrv:verify_interval"
+                 context="G"
+                 type="string"
+                 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>This is the interval in s till we verify active replica records
+	with the owning WINS server. Unfortunately not implemented yet.
+	Defaults to 24 days.
+	</para>
+</description>
+
+<value type="default">2073600</value>
+</samba:parameter>