summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf/browse
diff options
context:
space:
mode:
authorGerald W. Carter <jerry@samba.org>2008-04-22 10:09:40 -0500
committerGerald W. Carter <jerry@samba.org>2008-04-23 08:47:48 -0500
commit8f8a9f01909ba29e2b781310baeeaaddc3f15f0d (patch)
tree90c6b720ad3a7bc815245c0ef28820424f89d658 /docs-xml/smbdotconf/browse
parent197238246389c40edc60c6630d18d6913086e630 (diff)
downloadsamba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.gz
samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.tar.bz2
samba-8f8a9f01909ba29e2b781310baeeaaddc3f15f0d.zip
Moving docs tree to docs-xml to make room for generated docs in the release tarball.
(This used to be commit 9f672c26d63955f613088489c6efbdc08b5b2d14)
Diffstat (limited to 'docs-xml/smbdotconf/browse')
-rw-r--r--docs-xml/smbdotconf/browse/administrative_share.xml16
-rw-r--r--docs-xml/smbdotconf/browse/browseable.xml11
-rw-r--r--docs-xml/smbdotconf/browse/browselist.xml15
-rw-r--r--docs-xml/smbdotconf/browse/domainmaster.xml42
-rw-r--r--docs-xml/smbdotconf/browse/enhancedbrowsing.xml28
-rw-r--r--docs-xml/smbdotconf/browse/lmannounce.xml26
-rw-r--r--docs-xml/smbdotconf/browse/lminterval.xml18
-rw-r--r--docs-xml/smbdotconf/browse/localmaster.xml21
-rw-r--r--docs-xml/smbdotconf/browse/oslevel.xml26
-rw-r--r--docs-xml/smbdotconf/browse/preferredmaster.xml29
10 files changed, 232 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/browse/administrative_share.xml b/docs-xml/smbdotconf/browse/administrative_share.xml
new file mode 100644
index 0000000000..95db5f1c85
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/administrative_share.xml
@@ -0,0 +1,16 @@
+<samba:parameter name="administrative share"
+ context="S"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>If this parameter is set to <constant>yes</constant> for
+ a share, then the share will be an administrative share. The Administrative
+ Shares are the default network shares created by all Windows NT-based
+ operating systems. These are shares like C$, D$ or ADMIN$. The type of these
+ shares is STYPE_DISKTREE_HIDDEN.</para>
+
+ <para>See the section below on <smbconfoption name="security"/> for more
+ information about this option.</para>
+</description>
+<value type="default">no</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/browse/browseable.xml b/docs-xml/smbdotconf/browse/browseable.xml
new file mode 100644
index 0000000000..e58e1912e2
--- /dev/null
+++ b/docs-xml/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://www.samba.org/samba/DTD/samba-doc">
+<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-xml/smbdotconf/browse/browselist.xml b/docs-xml/smbdotconf/browse/browselist.xml
new file mode 100644
index 0000000000..dd858b7faf
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/browselist.xml
@@ -0,0 +1,15 @@
+<samba:parameter name="browse list"
+ context="G"
+ type="boolean"
+ advanced="1" developer="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<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-xml/smbdotconf/browse/domainmaster.xml b/docs-xml/smbdotconf/browse/domainmaster.xml
new file mode 100644
index 0000000000..eee53d6646
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/domainmaster.xml
@@ -0,0 +1,42 @@
+<samba:parameter name="domain master"
+ type="boolean"
+ context="G"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<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
+ <smbconfoption name="workgroup"/>. Local master browsers in the same <smbconfoption name="workgroup"/> 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 <smbconfoption
+ name="workgroup"/> specific special NetBIOS name that identifies them as domain master browsers for that
+ <smbconfoption name="workgroup"/> 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 <smbconfoption name="workgroup"/> before a Windows NT PDC is able to do so then cross
+ subnet browsing will behave strangely and may fail.
+ </para>
+
+ <para>
+ If <smbconfoption name="domain logons">yes</smbconfoption>, then the default behavior is to enable the
+ <smbconfoption name="domain master"/> parameter. If <smbconfoption name="domain logons"/> is not enabled (the
+ default setting), then neither will <smbconfoption name="domain master"/> be enabled by default.
+ </para>
+
+ <para>
+ When <smbconfoption name="domain logons">Yes</smbconfoption> the default setting for this parameter is
+ Yes, with the result that Samba will be a PDC. If <smbconfoption name="domain master">No</smbconfoption>,
+ Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
+ </para>
+
+</description>
+<value type="default">auto</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/browse/enhancedbrowsing.xml b/docs-xml/smbdotconf/browse/enhancedbrowsing.xml
new file mode 100644
index 0000000000..13f2cd6446
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/enhancedbrowsing.xml
@@ -0,0 +1,28 @@
+<samba:parameter name="enhanced browsing"
+ context="G"
+ advanced="1" developer="1"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<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-xml/smbdotconf/browse/lmannounce.xml b/docs-xml/smbdotconf/browse/lmannounce.xml
new file mode 100644
index 0000000000..92365d8e50
--- /dev/null
+++ b/docs-xml/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://www.samba.org/samba/DTD/samba-doc">
+<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
+ <smbconfoption name="lm interval"/>. 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
+ <smbconfoption name="lm interval"/>.</para>
+</description>
+
+<related>lm interval</related>
+<value type="default">auto</value>
+<value type="example">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/browse/lminterval.xml b/docs-xml/smbdotconf/browse/lminterval.xml
new file mode 100644
index 0000000000..4f38165147
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/lminterval.xml
@@ -0,0 +1,18 @@
+<samba:parameter name="lm interval"
+ context="G"
+ advanced="1" developer="1"
+ type="integer"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+ <para>If Samba is set to produce Lanman announce
+ broadcasts needed by OS/2 clients (see the
+ <smbconfoption name="lm announce"/> 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 <smbconfoption name="lm announce"/>
+ parameter.</para>
+</description>
+<related>lm announce</related>
+<value type="default">60</value>
+<value type="example">120</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/browse/localmaster.xml b/docs-xml/smbdotconf/browse/localmaster.xml
new file mode 100644
index 0000000000..47c7e561a1
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/localmaster.xml
@@ -0,0 +1,21 @@
+<samba:parameter name="local master"
+ context="G"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<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-xml/smbdotconf/browse/oslevel.xml b/docs-xml/smbdotconf/browse/oslevel.xml
new file mode 100644
index 0000000000..7556a83051
--- /dev/null
+++ b/docs-xml/smbdotconf/browse/oslevel.xml
@@ -0,0 +1,26 @@
+<samba:parameter name="os level"
+ context="G"
+ type="integer"
+ basic="1" advanced="1" developer="1"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<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 <smbconfoption
+ name="workgroup"/> 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. This parameter is largely auto-configured in the Samba-3
+ release series and it is seldom necessary to manually override the default setting. Please refer to
+ chapter 9 of the Samba-3 HOWTO document for further information regarding the use of this parameter.
+ <emphasis>Note:</emphasis> The maximum value for this parameter is 255. If you use higher values, counting
+ will start at 0!
+ </para>
+</description>
+<value type="default">20</value>
+<value type="example">65</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/browse/preferredmaster.xml b/docs-xml/smbdotconf/browse/preferredmaster.xml
new file mode 100644
index 0000000000..edddae8ce7
--- /dev/null
+++ b/docs-xml/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://www.samba.org/samba/DTD/samba-doc">
+<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 <smbconfoption name="domain master">yes</smbconfoption>, 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>