diff options
Diffstat (limited to 'docs/docbook/smbdotconf')
| -rw-r--r-- | docs/docbook/smbdotconf/wins/dnsproxy.xml | 38 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/wins/winshook.xml | 78 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/wins/winspartners.xml | 27 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/wins/winsproxy.xml | 20 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/wins/winsserver.xml | 57 | ||||
| -rw-r--r-- | docs/docbook/smbdotconf/wins/winssupport.xml | 25 |
6 files changed, 139 insertions, 106 deletions
diff --git a/docs/docbook/smbdotconf/wins/dnsproxy.xml b/docs/docbook/smbdotconf/wins/dnsproxy.xml index fd53ae7ded..45ec160c5a 100644 --- a/docs/docbook/smbdotconf/wins/dnsproxy.xml +++ b/docs/docbook/smbdotconf/wins/dnsproxy.xml @@ -1,21 +1,25 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="DNSPROXY"/>dns proxy (G)</term> - <listitem><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> +<samba:parameter name="dns proxy" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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>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> + <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> - <para>See also the parameter <link linkend="WINSSUPPORT"><parameter moreinfo="none"> - wins support</parameter></link>.</para> + <para>See also the parameter <link linkend="WINSSUPPORT"><parameter moreinfo="none"> + wins support</parameter></link>.</para> - <para>Default: <command moreinfo="none">dns proxy = yes</command></para></listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">dns proxy = yes</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winshook.xml b/docs/docbook/smbdotconf/wins/winshook.xml index e0c4a87c5b..e38e93f6b5 100644 --- a/docs/docbook/smbdotconf/wins/winshook.xml +++ b/docs/docbook/smbdotconf/wins/winshook.xml @@ -1,43 +1,57 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WINSHOOK"/>wins hook (G)</term> - <listitem><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> +<samba:parameter name="wins hook" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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>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> + <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 "add", "delete", or "refresh". In most cases the operation can - be ignored as the rest of the parameters provide sufficient - information. Note that "refresh" may sometimes be called when the - name has not previously been added, in that case it should be treated - as an add.</para></listitem> + <itemizedlist> + <listitem> + <para>The first argument is the operation and is + one of "add", "delete", or + "refresh". In most cases the operation + can be ignored as the rest of the parameters + provide sufficient information. Note that + "refresh" 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 + <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> + 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 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 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 + <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> + empty then the name should be deleted.</para> </listitem> - </samba:parameter> + </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> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winspartners.xml b/docs/docbook/smbdotconf/wins/winspartners.xml index 840435ae4e..9ec277ed2d 100644 --- a/docs/docbook/smbdotconf/wins/winspartners.xml +++ b/docs/docbook/smbdotconf/wins/winspartners.xml @@ -1,14 +1,17 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WINSPARTNERS"/>wins partners (G)</term> - <listitem><para>A space separated list of partners' IP addresses for - WINS replication. WINS partners are always defined as push/pull - partners as defining only one way WINS replication is unreliable. - WINS replication is currently experimental and unreliable between - samba servers. - </para> +<samba:parameter name="wins partner" + context="G" + advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <para>A space separated list of partners' IP addresses for + WINS replication. WINS partners are always defined as push/pull + partners as defining only one way WINS replication is unreliable. + WINS replication is currently experimental and unreliable between + samba servers. + </para> - <para>Default: <command moreinfo="none">wins partners = </command></para> + <para>Default: <command moreinfo="none">wins partners = </command></para> - <para>Example: <command moreinfo="none">wins partners = 192.168.0.1 172.16.1.2</command></para> - </listitem> - </samba:parameter> + <para>Example: <command moreinfo="none">wins partners = 192.168.0.1 172.16.1.2</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winsproxy.xml b/docs/docbook/smbdotconf/wins/winsproxy.xml index 31978d3b24..11f47e31c7 100644 --- a/docs/docbook/smbdotconf/wins/winsproxy.xml +++ b/docs/docbook/smbdotconf/wins/winsproxy.xml @@ -1,9 +1,13 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WINSPROXY"/>wins proxy (G)</term> - <listitem><para>This is a boolean that controls if <ulink url="nmbd.8.html">nmbd(8)</ulink> 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> +<samba:parameter name="wins proxy" + context="G" + advanced="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> - <para>Default: <command moreinfo="none">wins proxy = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">wins proxy = no</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winsserver.xml b/docs/docbook/smbdotconf/wins/winsserver.xml index ebdb3016c7..12ee635acd 100644 --- a/docs/docbook/smbdotconf/wins/winsserver.xml +++ b/docs/docbook/smbdotconf/wins/winsserver.xml @@ -1,32 +1,37 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WINSSERVER"/>wins server (G)</term> - <listitem><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> +<samba:parameter name="wins server" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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>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 - seperated from the ip address by a colon. - </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 + seperated 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> + <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 documentation file <ulink url="improved-browsing.html">Browsing</ulink> in the samba howto collection.</para> + <para>See the documentation file <ulink url="improved-browsing.html">Browsing</ulink> in the samba howto collection.</para> - <para>Default: <emphasis>not enabled</emphasis></para> - <para>Example: <command>wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61</command></para> - <para>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. - </para> + <para>Default: <emphasis>not enabled</emphasis></para> - <para>Example: <command>wins server = 192.9.200.1 192.168.2.61</command></para> - </listitem> - </samba:parameter> + <para>Example: <command>wins server = mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61</command></para> + + <para>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. + </para> + + <para>Example: <command>wins server = 192.9.200.1 192.168.2.61</command></para> +</listitem> +</samba:parameter> diff --git a/docs/docbook/smbdotconf/wins/winssupport.xml b/docs/docbook/smbdotconf/wins/winssupport.xml index 5ad886a9b1..eef59e708f 100644 --- a/docs/docbook/smbdotconf/wins/winssupport.xml +++ b/docs/docbook/smbdotconf/wins/winssupport.xml @@ -1,12 +1,15 @@ -<samba:parameter xmlns:samba="http://samba.org/common"> - <term><anchor id="WINSSUPPORT"/>wins support (G)</term> - <listitem><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> +<samba:parameter name="wins support" + context="G" + basic="1" advanced="1" wizard="1" developer="1" + xmlns:samba="http://samba.org/common"> +<listitem> + <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> - <para>Default: <command moreinfo="none">wins support = no</command></para> - </listitem> - </samba:parameter> + <para>Default: <command moreinfo="none">wins support = no</command></para> +</listitem> +</samba:parameter> |