summaryrefslogtreecommitdiff
path: root/docs/smbdotconf/browse
diff options
context:
space:
mode:
Diffstat (limited to 'docs/smbdotconf/browse')
-rw-r--r--docs/smbdotconf/browse/browseable.xml11
-rw-r--r--docs/smbdotconf/browse/browselist.xml15
-rw-r--r--docs/smbdotconf/browse/domainmaster.xml39
-rw-r--r--docs/smbdotconf/browse/enhancedbrowsing.xml28
-rw-r--r--docs/smbdotconf/browse/lmannounce.xml26
-rw-r--r--docs/smbdotconf/browse/lminterval.xml18
-rw-r--r--docs/smbdotconf/browse/localmaster.xml21
-rw-r--r--docs/smbdotconf/browse/oslevel.xml24
-rw-r--r--docs/smbdotconf/browse/preferredmaster.xml29
9 files changed, 211 insertions, 0 deletions
diff --git a/docs/smbdotconf/browse/browseable.xml b/docs/smbdotconf/browse/browseable.xml
new file mode 100644
index 0000000000..47c628a928
--- /dev/null
+++ b/docs/smbdotconf/browse/browseable.xml
@@ -0,0 +1,11 @@
+<samba:parameter name="browseable" context="S" type="boolean"
+ basic="1" advanced="1" print="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<synonym>browsable</synonym>
+<description>
+ <para>This controls whether this share is seen in
+ the list of available shares in a net view and in the browse list.</para>
+
+</description>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/browselist.xml b/docs/smbdotconf/browse/browselist.xml
new file mode 100644
index 0000000000..8d9a754e16
--- /dev/null
+++ b/docs/smbdotconf/browse/browselist.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="browse list"
+ context="G"
+ type="boolean"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This controls whether <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> will serve a browse list to
+ a client doing a <command moreinfo="none">NetServerEnum</command> call. Normally
+ set to <constant>yes</constant>. You should never need to change
+ this.</para>
+
+</description>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/domainmaster.xml b/docs/smbdotconf/browse/domainmaster.xml
new file mode 100644
index 0000000000..db43220b98
--- /dev/null
+++ b/docs/smbdotconf/browse/domainmaster.xml
@@ -0,0 +1,39 @@
+<samba:parameter name="domain master"
+ type="boolean"
+ context="G"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>Tell <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> to enable WAN-wide browse list
+ collation. Setting this option causes <command moreinfo="none">nmbd</command> to
+ claim a special domain specific NetBIOS name that identifies
+ it as a domain master browser for its given <link linkend="WORKGROUP">
+ <parameter moreinfo="none">workgroup</parameter></link>. Local master browsers
+ in the same <parameter moreinfo="none">workgroup</parameter> on broadcast-isolated
+ subnets will give this <command moreinfo="none">nmbd</command> their local browse lists,
+ and then ask <citerefentry><refentrytitle>smbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> for a complete copy of the browse
+ list for the whole wide area network. Browser clients will then contact
+ their local master browser, and will receive the domain-wide browse list,
+ instead of just the list for their broadcast-isolated subnet.</para>
+
+ <para>Note that Windows NT Primary Domain Controllers expect to be
+ able to claim this <parameter moreinfo="none">workgroup</parameter> specific special
+ NetBIOS name that identifies them as domain master browsers for
+ that <parameter moreinfo="none">workgroup</parameter> by default (i.e. there is no
+ way to prevent a Windows NT PDC from attempting to do this). This
+ means that if this parameter is set and <command moreinfo="none">nmbd</command> claims
+ the special name for a <parameter moreinfo="none">workgroup</parameter> before a Windows
+ NT PDC is able to do so then cross subnet browsing will behave
+ strangely and may fail.</para>
+
+ <para>If <link linkend="DOMAINLOGONS"><command moreinfo="none">domain logons = yes</command>
+ </link>, then the default behavior is to enable the <parameter moreinfo="none">domain
+ master</parameter> parameter. If <parameter moreinfo="none">domain logons</parameter> is
+ not enabled (the default setting), then neither will <parameter moreinfo="none">domain
+ master</parameter> be enabled by default.</para>
+
+</description>
+<value type="default">auto</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/enhancedbrowsing.xml b/docs/smbdotconf/browse/enhancedbrowsing.xml
new file mode 100644
index 0000000000..ee5044a5c9
--- /dev/null
+++ b/docs/smbdotconf/browse/enhancedbrowsing.xml
@@ -0,0 +1,28 @@
+<samba:parameter name="enhanced browsing"
+ context="G"
+ advanced="1" developer="1"
+ type="boolean"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This option enables a couple of enhancements to
+ cross-subnet browse propagation that have been added in Samba
+ but which are not standard in Microsoft implementations.
+ </para>
+
+ <para>The first enhancement to browse propagation consists of a regular
+ wildcard query to a Samba WINS server for all Domain Master Browsers,
+ followed by a browse synchronization with each of the returned
+ DMBs. The second enhancement consists of a regular randomised browse
+ synchronization with all currently known DMBs.</para>
+
+ <para>You may wish to disable this option if you have a problem with empty
+ workgroups not disappearing from browse lists. Due to the restrictions
+ of the browse protocols these enhancements can cause a empty workgroup
+ to stay around forever which can be annoying.</para>
+
+ <para>In general you should leave this option enabled as it makes
+ cross-subnet browse propagation much more reliable.</para>
+
+</description>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/lmannounce.xml b/docs/smbdotconf/browse/lmannounce.xml
new file mode 100644
index 0000000000..bce73bfcd7
--- /dev/null
+++ b/docs/smbdotconf/browse/lmannounce.xml
@@ -0,0 +1,26 @@
+<samba:parameter name="lm announce"
+ context="G"
+ type="boolean-auto"
+ advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> will produce Lanman announce
+ broadcasts that are needed by OS/2 clients in order for them to see
+ the Samba server in their browse list. This parameter can have three
+ values, <constant>yes</constant>, <constant>no</constant>, or
+ <constant>auto</constant>. The default is <constant>auto</constant>.
+ If set to <constant>no</constant> Samba will never produce these
+ broadcasts. If set to <constant>yes</constant> Samba will produce
+ Lanman announce broadcasts at a frequency set by the parameter
+ <parameter moreinfo="none">lm interval</parameter>. If set to <constant>auto</constant>
+ Samba will not send Lanman announce broadcasts by default but will
+ listen for them. If it hears such a broadcast on the wire it will
+ then start sending them at a frequency set by the parameter
+ <parameter moreinfo="none">lm interval</parameter>.</para>
+</description>
+
+<related>lm interval</related>
+<value type="default">auto</value>
+<value type="example">yes</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/lminterval.xml b/docs/smbdotconf/browse/lminterval.xml
new file mode 100644
index 0000000000..be64011361
--- /dev/null
+++ b/docs/smbdotconf/browse/lminterval.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="lm interval"
+ context="G"
+ advanced="1" developer="1"
+ type="integer"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>If Samba is set to produce Lanman announce
+ broadcasts needed by OS/2 clients (see the <link linkend="LMANNOUNCE">
+ <parameter moreinfo="none">lm announce</parameter></link> parameter) then this
+ parameter defines the frequency in seconds with which they will be
+ made. If this is set to zero then no Lanman announcements will be
+ made despite the setting of the <parameter moreinfo="none">lm announce</parameter>
+ parameter.</para>
+</description>
+<related>lm announce</related>
+<value type="default">60</value>
+<value type="example">120</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/localmaster.xml b/docs/smbdotconf/browse/localmaster.xml
new file mode 100644
index 0000000000..3a525973ec
--- /dev/null
+++ b/docs/smbdotconf/browse/localmaster.xml
@@ -0,0 +1,21 @@
+<samba:parameter name="local master"
+ context="G"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This option allows <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> to try and become a local master browser
+ on a subnet. If set to <constant>no</constant> then <command moreinfo="none">
+ nmbd</command> will not attempt to become a local master browser
+ on a subnet and will also lose in all browsing elections. By
+ default this value is set to <constant>yes</constant>. Setting this value to
+ <constant>yes</constant> doesn't mean that Samba will <emphasis>become</emphasis> the
+ local master browser on a subnet, just that <command moreinfo="none">nmbd</command>
+ will <emphasis>participate</emphasis> in elections for local master browser.</para>
+
+ <para>Setting this value to <constant>no</constant> will cause <command
+ moreinfo="none">nmbd</command> <emphasis>never</emphasis> to become a local
+master browser.</para>
+</description>
+<value type="default">yes</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/oslevel.xml b/docs/smbdotconf/browse/oslevel.xml
new file mode 100644
index 0000000000..15ba8fb4f5
--- /dev/null
+++ b/docs/smbdotconf/browse/oslevel.xml
@@ -0,0 +1,24 @@
+<samba:parameter name="os level"
+ context="G"
+ type="integer"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<description>
+ <para>This integer value controls what level Samba
+ advertises itself as for browse elections. The value of this
+ parameter determines whether <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry>
+ has a chance of becoming a local master browser for the <parameter moreinfo="none">
+ WORKGROUP</parameter> in the local broadcast area.</para>
+
+ <para><emphasis>Note :</emphasis>By default, Samba will win
+ a local master browsing election over all Microsoft operating
+ systems except a Windows NT 4.0/2000 Domain Controller. This
+ means that a misconfigured Samba host can effectively isolate
+ a subnet for browsing purposes. See <filename moreinfo="none">BROWSING.txt
+ </filename> in the Samba <filename moreinfo="none">docs/</filename> directory
+ for details.</para>
+</description>
+<value type="default">20</value>
+<value type="example">65</value>
+</samba:parameter>
diff --git a/docs/smbdotconf/browse/preferredmaster.xml b/docs/smbdotconf/browse/preferredmaster.xml
new file mode 100644
index 0000000000..c6c2b668e2
--- /dev/null
+++ b/docs/smbdotconf/browse/preferredmaster.xml
@@ -0,0 +1,29 @@
+<samba:parameter name="preferred master"
+ context="G"
+ type="boolean-auto"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://samba.org/common">
+<synonym>prefered master</synonym>
+ <description>
+ <para>This boolean parameter controls if
+ <citerefentry><refentrytitle>nmbd</refentrytitle>
+ <manvolnum>8</manvolnum></citerefentry> is a preferred master
+ browser for its workgroup.</para>
+
+ <para>If this is set to <constant>yes</constant>, on startup, <command moreinfo="none">nmbd</command>
+ will force an election, and it will have a slight advantage in
+ winning the election. It is recommended that this parameter is
+ used in conjunction with <command moreinfo="none"><link linkend="DOMAINMASTER">
+ <parameter moreinfo="none">domain master</parameter></link> = yes</command>, so
+ that <command moreinfo="none">nmbd</command> can guarantee becoming a domain master.</para>
+
+ <para>Use this option with caution, because if there are several
+ hosts (whether Samba servers, Windows 95 or NT) that are
+ preferred master browsers on the same subnet, they will each
+ periodically and continuously attempt to become the local
+ master browser. This will result in unnecessary broadcast
+ traffic and reduced browsing capabilities.</para>
+</description>
+<related>os level</related>
+<value type="default">auto</value>
+</samba:parameter>