diff options
author | Gerald Carter <jerry@samba.org> | 2001-02-22 16:13:52 +0000 |
---|---|---|
committer | Gerald Carter <jerry@samba.org> | 2001-02-22 16:13:52 +0000 |
commit | 4d93553a3fba1901721fafaf57e4e027c9ea6950 (patch) | |
tree | 958cfccbdfd5fceffdf783991a52b6e5f4a4cb15 /docs | |
parent | 50bc6a4e8a343861d25520accde45223acb7f81a (diff) | |
download | samba-4d93553a3fba1901721fafaf57e4e027c9ea6950.tar.gz samba-4d93553a3fba1901721fafaf57e4e027c9ea6950.tar.bz2 samba-4d93553a3fba1901721fafaf57e4e027c9ea6950.zip |
more converted docs
(This used to be commit a354ce7c859fbbd9b0173664b92471695f88ada7)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/docbook/manpages/nmblookup.1.sgml | 249 | ||||
-rw-r--r-- | docs/htmldocs/nmblookup.1.html | 549 | ||||
-rw-r--r-- | docs/manpages/nmblookup.1 | 306 |
3 files changed, 797 insertions, 307 deletions
diff --git a/docs/docbook/manpages/nmblookup.1.sgml b/docs/docbook/manpages/nmblookup.1.sgml new file mode 100644 index 0000000000..eebf7028d2 --- /dev/null +++ b/docs/docbook/manpages/nmblookup.1.sgml @@ -0,0 +1,249 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="findsmb"> + +<refmeta> + <refentrytitle>nmblookup</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>nmblookup</refname> + <refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS + names</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>findsmb</command> + <arg choice="opt">-M</arg> + <arg choice="opt">-R</arg> + <arg choice="opt">-S</arg> + <arg choice="opt">-r</arg> + <arg choice="opt">-A</arg> + <arg choice="opt">-h</arg> + <arg choice="opt">-B <broadcast address></arg> + <arg choice="opt">-U <unicast address></arg> + <arg choice="opt">-d <debug level></arg> + <arg choice="opt">-s <smb config file></arg> + <arg choice="opt">-i <NetBIOS scope></arg> + <arg choice="opt">-T</arg> + <arg choice="req">name</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This perl script is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> + + <para><command>nmblookup</command> is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.</para> +</refsect1> + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>-M</term> + <listitem><para>Searches for a master browser by looking + up the NetBIOS name <replaceable>name</replaceable> with a + type of <constant>0x1d</constant>. If <replaceable> + name</replaceable> is "-" then it does a lookup on the special name + <constant>__MSBROWSE__</constant>.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-R</term> + <listitem><para>Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See rfc1001, rfc1002 for details. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-S</term> + <listitem><para>Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-r</term> + <listitem><para>Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilage is needed to bind to this port, and + in addition, if the <ulink url="nmbd.8.html">nmbd(8)</ulink> + daemon is running on this machine it also binds to this port. + </para></listitem> + </varlistentry> + + + <varlistentry> + <term>-A</term> + <listitem><para>Interpret <replaceable>name</replaceable> as + an IP Address and do a node status query on this address.</para> + </listitem> + </varlistentry> + + + + <varlistentry> + <term>-h</term> + <listitem><para>Print a help (usage) message.</para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-B <broadcast address></term> + <listitem><para>Send the query to the given broadcast address. Without + this option the default behavior of nmblookup is to send the + query to the broadcast address of the network interfaces as + either auto-detected or defined in the <ulink + url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter> + </ulink> parameter of the <filename>smb.conf (5)</filename> file. + </para></listitem> + </varlistentry> + + + + <varlistentry> + <term>-U <unicast address></term> + <listitem><para>Do a unicast query to the specified address or + host <replaceable>unicast address</replaceable>. This option + (along with the <parameter>-R</parameter> option) is needed to + query a WINS server.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-d <debuglevel></term> + <listitem><para>debuglevel is an integer from 0 to 10.</para> + + <para>The default value if this parameter is not specified + is zero.</para> + + <para>The higher this value, the more detail will be logged + about the activities of <command>nmblookup</command>. At level + 0, only critical errors and serious warnings will be logged.</para> + + <para>Levels above 1 will generate considerable amounts of + log data, and should only be used when investigating a problem. + Levels above 3 are designed for use only by developers and + generate HUGE amounts of data, most of which is extremely cryptic.</para> + + <para>Note that specifying this parameter here will override + the <ulink url="smb.conf.5.html#LOGLEVEL"><parameter> + log level</parameter></ulink> parameter in the <filename> + smb.conf(5)</filename> file.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-s <smb.conf></term> + <listitem><para>This parameter specifies the pathname to + the Samba configuration file, <ulink url="smb.conf.5.html"> + smb.conf(5)</ulink>. This file controls all aspects of + the Samba setup on the machine.</para></listitem> + </varlistentry> + + <varlistentry> + <term>-i <scope></term> + <listitem><para>This specifies a NetBIOS scope that + <command>nmblookup</command> will use to communicate with when + generating NetBIOS names. For details on the use of NetBIOS + scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are + <emphasis>very</emphasis> rarely used, only set this parameter + if you are the system administrator in charge of all the + NetBIOS systems you communicate with.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>-T</term> + <listitem><para>This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each</para> + + <para><emphasis>IP address .... NetBIOS name</emphasis></para> + + <para> pair that is the normal output.</para></listitem> + </varlistentry> + + + <varlistentry> + <term>name</term> + <listitem><para>This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.</para></listitem> + </varlistentry> + </variablelist> +</refsect1> + + +<refsect1> + <title>EXAMPLES</title> + + <para><command>nmblookup</command> can be used to query + a WINS server (in the same way <command>nslookup</command> is + used to query DNS servers). To query a WINS server, + <command>nmblookup</command> must be called like this:</para> + + <para><command>nmblookup -U server -R 'name'</command></para> + + <para>For example, running :</para> + + <para><command>nmblookup -U samba.org -R IRIX#1B'</command></para> + + <para>would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.</para> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 2.2 of + the Samba suite.</para> +</refsect1> + +<refsect1> + <title>SEE ALSO</title> + <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>, + <ulink url="samba.7.html">samba(7)</ulink>, and <ulink + url="smb.conf.5.html">smb.conf(5)</ulink> + </para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</para> + + <para>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at + <ulink url="ftp://ftp.icce.rug.nl/pub/unix/"> + ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</para> +</refsect1> + +</refentry> diff --git a/docs/htmldocs/nmblookup.1.html b/docs/htmldocs/nmblookup.1.html index 57effe149d..c1c2396857 100644 --- a/docs/htmldocs/nmblookup.1.html +++ b/docs/htmldocs/nmblookup.1.html @@ -1,153 +1,396 @@ - - - - - - -<html><head><title>nmblookup (1)</title> - -<link rev="made" href="mailto:samba@samba.org"> -</head> -<body> - -<hr> - -<h1>nmblookup (1)</h1> -<h2>Samba</h2> -<h2>23 Oct 1998</h2> - - - -<p><a name="NAME"></a> -<h2>NAME</h2> - nmblookup - NetBIOS over TCP/IP client used to lookup NetBIOS names -<p><a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> - -<p><strong>nmblookup</strong> [<a href="nmblookup.1.html#minusM">-M</a>] [<a href="nmblookup.1.html#minusR">-R</a>] [<a href="nmblookup.1.html#minusS">-S</a>] [<a href="nmblookup.1.html#minusr">-r</a>] [<a href="nmblookup.1.html#minusA">-A</a>] [<a href="nmblookup.1.html#minush">-h</a>] [<a href="nmblookup.1.html#minusB">-B broadcast address</a>] [<a href="nmblookup.1.html#minusU">-U unicast address</a>] [<a href="nmblookup.1.html#minusd">-d debuglevel</a>] [<a href="nmblookup.1.html#minuss">-s smb config file</a>] [<a href="nmblookup.1.html#minusi">-i NetBIOS scope</a>] [<a href="nmblookup.1.html#minusT">-T</a>] <a href="nmblookup.1.html#name">name</a> -<p><a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> - -<p>This program is part of the <strong>Samba</strong> suite. -<p><strong>nmblookup</strong> is used to query NetBIOS names and map them to IP -addresses in a network using NetBIOS over TCP/IP queries. The options -allow the name queries to be directed at a particular IP broadcast area -or to a particular machine. All queries are done over UDP. -<p><a name="OPTIONS"></a> -<h2>OPTIONS</h2> - -<p><dl> -<p><a name="minusM"></a> -<p></p><dt><strong><strong>-M</strong></strong><dd> Searches for a master browser by looking up the -NetBIOS name <a href="nmblookup.1.html#name"><strong>name</strong></a> with a type of 0x1d. If <a href="nmblookup.1.html#name"><strong>name</strong></a> -is <code>"-"</code> then it does a lookup on the special name <code>__MSBROWSE__</code>. -<p><a name="minusR"></a> -<p></p><dt><strong><strong>-R</strong></strong><dd> Set the recursion desired bit in the packet to do a -recursive lookup. This is used when sending a name query to a machine -running a WINS server and the user wishes to query the names in the -WINS server. If this bit is unset the normal (broadcast responding) -NetBIOS processing code on a machine is used instead. See rfc1001, -rfc1002 for details. -<p><a name="minusS"></a> -<p></p><dt><strong><strong>-S</strong></strong><dd> Once the name query has returned an IP address then do a -node status query as well. A node status query returns the NetBIOS names -registered by a host. -<p><a name="minusr"></a> -<p></p><dt><strong><strong>-r</strong></strong><dd> Try and bind to UDP port 137 to send and receive UDP -datagrams. The reason for this option is a bug in Windows 95 where it -ignores the source port of the requesting packet and only replies to -UDP port 137. Unfortunately, on most UNIX systems root privilage is -needed to bind to this port, and in addition, if the -<a href="nmbd.8.html"><strong>nmbd</strong></a> daemon is running on this machine it also -binds to this port. -<p><a name="minusA"></a> -<p></p><dt><strong><strong>-A</strong></strong><dd> Interpret <name> as an IP Address and do a node status -query on this address. -<p><a name="minush"></a> -<p></p><dt><strong><strong>-h</strong></strong><dd> Print a help (usage) message. -<p><a name="minusB"></a> -<p></p><dt><strong><strong>-B broadcast address</strong></strong><dd> Send the query to the given broadcast -address. Without this option the default behavior of nmblookup is to -send the query to the broadcast address of the network -interfaces as either auto-detected or defined in the -<a href="smb.conf.5.html#interfaces"><strong>interfaces</strong></a> parameter of the -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> file. -<p><a name="minusU"></a> -<p></p><dt><strong><strong>-U unicast address</strong></strong><dd> Do a unicast query to the specified -address or host <code>"unicast address"</code>. This option (along with the -<a href="nmblookup.1.html#minusR"><strong>-R</strong></a> option) is needed to query a WINS server. -<p><a name="minusd"></a> -<p></p><dt><strong><strong>-d debuglevel</strong></strong><dd> debuglevel is an integer from 0 to 10. -<p>The default value if this parameter is not specified is zero. -<p>The higher this value, the more detail will be logged about the -activities of <strong>nmblookup</strong>. At level 0, only critical errors and -serious warnings will be logged. -<p>Levels above 1 will generate considerable amounts of log data, and -should only be used when investigating a problem. Levels above 3 are -designed for use only by developers and generate HUGE amounts of -data, most of which is extremely cryptic. -<p>Note that specifying this parameter here will override the <a href="smb.conf.5.html#loglevel"><strong>log -level</strong></a> parameter in the <a href="smb.conf.5.html"><strong>smb.conf -(5)</strong></a> file. -<p><a name="minuss"></a> -<p></p><dt><strong><strong>-s smb.conf</strong></strong><dd> This parameter specifies the pathname to the -Samba configuration file, <a href="smb.conf.5.html"><strong>smb.conf</strong></a>. -This file controls all aspects of -the Samba setup on the machine. -<p><a name="minusi"></a> -<p></p><dt><strong><strong>-i scope</strong></strong><dd> This specifies a NetBIOS scope that <strong>nmblookup</strong> will use -to communicate with when generating NetBIOS names. For details on the -use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes -are <em>very</em> rarely used, only set this parameter if you are the -system administrator in charge of all the NetBIOS systems you -communicate with. -<p><a name="minusT"></a> -<p></p><dt><strong><strong>-T</strong></strong><dd> This causes any IP addresses found in the lookup to be -looked up via a reverse DNS lookup into a DNS name, and printed out -before each <code>"IP address NetBIOS name"</code> pair that is the normal -output. -<p><a name="name"></a> -<p></p><dt><strong><strong>name</strong></strong><dd> This is the NetBIOS name being queried. Depending upon -the previous options this may be a NetBIOS name or IP address. If a -NetBIOS name then the different name types may be specified by -appending <code>#<type></code> to the name. This name may also be <code>"*"</code>, -which will return all registered names within a broadcast area. -<p></dl> -<p><a name="EXAMPLES"></a> -<h2>EXAMPLES</h2> - -<p><strong>nmblookup</strong> can be used to query a WINS server (in the same way -<strong>nslookup</strong> is used to query DNS servers). To query a WINS server, -<strong>nmblookup</strong> must be called like this: -<p><code>nmblookup -U server -R 'name'</code> -<p>For example, running : -<p><code>nmblookup -U samba.org -R IRIX#1B'</code> -<p>would query the WINS server samba.org for the domain master -browser (1B name type) for the IRIX workgroup. -<p><a name="VERSION"></a> -<h2>VERSION</h2> - -<p>This man page is correct for version 2.0 of the Samba suite. -<p><a name="SEEALSO"></a> -<h2>SEE ALSO</h2> - -<p><a href="samba.7.html"><strong>samba (7)</strong></a>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>, -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> -<p><a name="AUTHOR"></a> -<h2>AUTHOR</h2> - -<p>The original Samba software and related utilities were created by -Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed. -<p>The original Samba man pages were written by Karl Auer. The man page -sources were converted to YODL format (another excellent piece of Open -Source software, available at -<a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>) -and updated for the Samba2.0 release by Jeremy Allison. -<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. -<p>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc. -<p></body> -</html> +<HTML +><HEAD +><TITLE +>nmblookup</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="FINDSMB" +>nmblookup</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>nmblookup -- NetBIOS over TCP/IP client used to lookup NetBIOS + names</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>findsmb</B +> [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>] [-T] {name}</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN24" +></A +><H2 +>DESCRIPTION</H2 +><P +>This perl script is part of the <A +HREF="samba.7.html" +TARGET="_top" +> Samba</A +> suite.</P +><P +><B +CLASS="COMMAND" +>nmblookup</B +> is used to query NetBIOS names + and map them to IP addresses in a network using NetBIOS over TCP/IP + queries. The options allow the name queries to be directed at a + particular IP broadcast area or to a particular machine. All queries + are done over UDP.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN30" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>-M</DT +><DD +><P +>Searches for a master browser by looking + up the NetBIOS name <TT +CLASS="REPLACEABLE" +><I +>name</I +></TT +> with a + type of <TT +CLASS="CONSTANT" +>0x1d</TT +>. If <TT +CLASS="REPLACEABLE" +><I +> name</I +></TT +> is "-" then it does a lookup on the special name + <TT +CLASS="CONSTANT" +>__MSBROWSE__</TT +>.</P +></DD +><DT +>-R</DT +><DD +><P +>Set the recursion desired bit in the packet + to do a recursive lookup. This is used when sending a name + query to a machine running a WINS server and the user wishes + to query the names in the WINS server. If this bit is unset + the normal (broadcast responding) NetBIOS processing code + on a machine is used instead. See rfc1001, rfc1002 for details. + </P +></DD +><DT +>-S</DT +><DD +><P +>Once the name query has returned an IP + address then do a node status query as well. A node status + query returns the NetBIOS names registered by a host. + </P +></DD +><DT +>-r</DT +><DD +><P +>Try and bind to UDP port 137 to send and receive UDP + datagrams. The reason for this option is a bug in Windows 95 + where it ignores the source port of the requesting packet + and only replies to UDP port 137. Unfortunately, on most UNIX + systems root privilage is needed to bind to this port, and + in addition, if the <A +HREF="nmbd.8.html" +TARGET="_top" +>nmbd(8)</A +> + daemon is running on this machine it also binds to this port. + </P +></DD +><DT +>-A</DT +><DD +><P +>Interpret <TT +CLASS="REPLACEABLE" +><I +>name</I +></TT +> as + an IP Address and do a node status query on this address.</P +></DD +><DT +>-h</DT +><DD +><P +>Print a help (usage) message.</P +></DD +><DT +>-B <broadcast address></DT +><DD +><P +>Send the query to the given broadcast address. Without + this option the default behavior of nmblookup is to send the + query to the broadcast address of the network interfaces as + either auto-detected or defined in the <A +HREF="smb.conf.5.html#INTERFACES" +TARGET="_top" +><TT +CLASS="PARAMETER" +><I +>interfaces</I +></TT +> + </A +> parameter of the <TT +CLASS="FILENAME" +>smb.conf (5)</TT +> file. + </P +></DD +><DT +>-U <unicast address></DT +><DD +><P +>Do a unicast query to the specified address or + host <TT +CLASS="REPLACEABLE" +><I +>unicast address</I +></TT +>. This option + (along with the <TT +CLASS="PARAMETER" +><I +>-R</I +></TT +> option) is needed to + query a WINS server.</P +></DD +><DT +>-d <debuglevel></DT +><DD +><P +>debuglevel is an integer from 0 to 10.</P +><P +>The default value if this parameter is not specified + is zero.</P +><P +>The higher this value, the more detail will be logged + about the activities of <B +CLASS="COMMAND" +>nmblookup</B +>. At level + 0, only critical errors and serious warnings will be logged.</P +><P +>Levels above 1 will generate considerable amounts of + log data, and should only be used when investigating a problem. + Levels above 3 are designed for use only by developers and + generate HUGE amounts of data, most of which is extremely cryptic.</P +><P +>Note that specifying this parameter here will override + the <A +HREF="smb.conf.5.html#LOGLEVEL" +TARGET="_top" +><TT +CLASS="PARAMETER" +><I +> log level</I +></TT +></A +> parameter in the <TT +CLASS="FILENAME" +> smb.conf(5)</TT +> file.</P +></DD +><DT +>-s <smb.conf></DT +><DD +><P +>This parameter specifies the pathname to + the Samba configuration file, <A +HREF="smb.conf.5.html" +TARGET="_top" +> smb.conf(5)</A +>. This file controls all aspects of + the Samba setup on the machine.</P +></DD +><DT +>-i <scope></DT +><DD +><P +>This specifies a NetBIOS scope that + <B +CLASS="COMMAND" +>nmblookup</B +> will use to communicate with when + generating NetBIOS names. For details on the use of NetBIOS + scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are + <I +CLASS="EMPHASIS" +>very</I +> rarely used, only set this parameter + if you are the system administrator in charge of all the + NetBIOS systems you communicate with.</P +></DD +><DT +>-T</DT +><DD +><P +>This causes any IP addresses found in the + lookup to be looked up via a reverse DNS lookup into a + DNS name, and printed out before each</P +><P +><I +CLASS="EMPHASIS" +>IP address .... NetBIOS name</I +></P +><P +> pair that is the normal output.</P +></DD +><DT +>name</DT +><DD +><P +>This is the NetBIOS name being queried. Depending + upon the previous options this may be a NetBIOS name or IP address. + If a NetBIOS name then the different name types may be specified + by appending '#<type>' to the name. This name may also be + '*', which will return all registered names within a broadcast + area.</P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN110" +></A +><H2 +>EXAMPLES</H2 +><P +><B +CLASS="COMMAND" +>nmblookup</B +> can be used to query + a WINS server (in the same way <B +CLASS="COMMAND" +>nslookup</B +> is + used to query DNS servers). To query a WINS server, + <B +CLASS="COMMAND" +>nmblookup</B +> must be called like this:</P +><P +><B +CLASS="COMMAND" +>nmblookup -U server -R 'name'</B +></P +><P +>For example, running :</P +><P +><B +CLASS="COMMAND" +>nmblookup -U samba.org -R IRIX#1B'</B +></P +><P +>would query the WINS server samba.org for the domain + master browser (1B name type) for the IRIX workgroup.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN122" +></A +><H2 +>VERSION</H2 +><P +>This man page is correct for version 2.2 of + the Samba suite.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN125" +></A +><H2 +>SEE ALSO</H2 +><P +><A +HREF="nmbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>nmbd(8)</B +></A +>, + <A +HREF="samba.7.html" +TARGET="_top" +>samba(7)</A +>, and <A +HREF="smb.conf.5.html" +TARGET="_top" +>smb.conf(5)</A +> + </P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN132" +></A +><H2 +>AUTHOR</H2 +><P +>The original Samba software and related utilities + were created by Andrew Tridgell. Samba is now developed + by the Samba Team as an Open Source project similar + to the way the Linux kernel is developed.</P +><P +>The original Samba man pages were written by Karl Auer. + The man page sources were converted to YODL format (another + excellent piece of Open Source software, available at + <A +HREF="ftp://ftp.icce.rug.nl/pub/unix/" +TARGET="_top" +> ftp://ftp.icce.rug.nl/pub/unix/</A +>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</P +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/manpages/nmblookup.1 b/docs/manpages/nmblookup.1 index 3d1491e878..b264544409 100644 --- a/docs/manpages/nmblookup.1 +++ b/docs/manpages/nmblookup.1 @@ -1,156 +1,154 @@ -.TH "nmblookup " "1" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names -.PP -.SH "SYNOPSIS" -.PP -\fBnmblookup\fP [-M] [-R] [-S] [-r] [-A] [-h] [-B broadcast address] [-U unicast address] [-d debuglevel] [-s smb config file] [-i NetBIOS scope] [-T] name -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBnmblookup\fP is used to query NetBIOS names and map them to IP -addresses in a network using NetBIOS over TCP/IP queries\&. The options -allow the name queries to be directed at a particular IP broadcast area -or to a particular machine\&. All queries are done over UDP\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fB-M\fP" -Searches for a master browser by looking up the -NetBIOS name \fBname\fP with a type of 0x1d\&. If \fBname\fP -is \f(CW"-"\fP then it does a lookup on the special name \f(CW__MSBROWSE__\fP\&. -.IP -.IP "\fB-R\fP" -Set the recursion desired bit in the packet to do a -recursive lookup\&. This is used when sending a name query to a machine -running a WINS server and the user wishes to query the names in the -WINS server\&. If this bit is unset the normal (broadcast responding) -NetBIOS processing code on a machine is used instead\&. See rfc1001, -rfc1002 for details\&. -.IP -.IP "\fB-S\fP" -Once the name query has returned an IP address then do a -node status query as well\&. A node status query returns the NetBIOS names -registered by a host\&. -.IP -.IP "\fB-r\fP" +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "NMBLOOKUP" "1" "22 February 2001" "" "" +.SH NAME +nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names +.SH SYNOPSIS +.sp +\fBfindsmb\fR [ \fB-M\fR ] [ \fB-R\fR ] [ \fB-S\fR ] [ \fB-r\fR ] [ \fB-A\fR ] [ \fB-h\fR ] [ \fB-B <broadcast address>\fR ] [ \fB-U <unicast address>\fR ] [ \fB-d <debug level>\fR ] [ \fB-s <smb config file>\fR ] [ \fB-i <NetBIOS scope>\fR ] [ \fB-T\fR ] \fBname\fR +.SH "DESCRIPTION" +.PP +This perl script is part of the Samba <URL:samba.7.html> suite. +.PP +\fBnmblookup\fR is used to query NetBIOS names +and map them to IP addresses in a network using NetBIOS over TCP/IP +queries. The options allow the name queries to be directed at a +particular IP broadcast area or to a particular machine. All queries +are done over UDP. +.SH "OPTIONS" +.TP +\fB-M\fR +Searches for a master browser by looking +up the NetBIOS name \fIname\fR with a +type of 0x1d. If \fI name\fR is "-" then it does a lookup on the special name +__MSBROWSE__. +.TP +\fB-R\fR +Set the recursion desired bit in the packet +to do a recursive lookup. This is used when sending a name +query to a machine running a WINS server and the user wishes +to query the names in the WINS server. If this bit is unset +the normal (broadcast responding) NetBIOS processing code +on a machine is used instead. See rfc1001, rfc1002 for details. +.TP +\fB-S\fR +Once the name query has returned an IP +address then do a node status query as well. A node status +query returns the NetBIOS names registered by a host. +.TP +\fB-r\fR Try and bind to UDP port 137 to send and receive UDP -datagrams\&. The reason for this option is a bug in Windows 95 where it -ignores the source port of the requesting packet and only replies to -UDP port 137\&. Unfortunately, on most UNIX systems root privilage is -needed to bind to this port, and in addition, if the -\fBnmbd\fP daemon is running on this machine it also -binds to this port\&. -.IP -.IP "\fB-A\fP" -Interpret <name> as an IP Address and do a node status -query on this address\&. -.IP -.IP "\fB-h\fP" -Print a help (usage) message\&. -.IP -.IP "\fB-B broadcast address\fP" -Send the query to the given broadcast -address\&. Without this option the default behavior of nmblookup is to -send the query to the broadcast address of the network -interfaces as either auto-detected or defined in the -\fBinterfaces\fP parameter of the -\fBsmb\&.conf (5)\fP file\&. -.IP -.IP "\fB-U unicast address\fP" -Do a unicast query to the specified -address or host \f(CW"unicast address"\fP\&. This option (along with the -\fB-R\fP option) is needed to query a WINS server\&. -.IP -.IP "\fB-d debuglevel\fP" -debuglevel is an integer from 0 to 10\&. -.IP -The default value if this parameter is not specified is zero\&. -.IP -The higher this value, the more detail will be logged about the -activities of \fBnmblookup\fP\&. At level 0, only critical errors and -serious warnings will be logged\&. -.IP -Levels above 1 will generate considerable amounts of log data, and -should only be used when investigating a problem\&. Levels above 3 are -designed for use only by developers and generate HUGE amounts of -data, most of which is extremely cryptic\&. -.IP -Note that specifying this parameter here will override the \fBlog -level\fP parameter in the \fBsmb\&.conf -(5)\fP file\&. -.IP -.IP "\fB-s smb\&.conf\fP" -This parameter specifies the pathname to the -Samba configuration file, \fBsmb\&.conf\fP\&. -This file controls all aspects of -the Samba setup on the machine\&. -.IP -.IP "\fB-i scope\fP" -This specifies a NetBIOS scope that \fBnmblookup\fP will use -to communicate with when generating NetBIOS names\&. For details on the -use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes -are \fIvery\fP rarely used, only set this parameter if you are the -system administrator in charge of all the NetBIOS systems you -communicate with\&. -.IP -.IP "\fB-T\fP" -This causes any IP addresses found in the lookup to be -looked up via a reverse DNS lookup into a DNS name, and printed out -before each \f(CW"IP address NetBIOS name"\fP pair that is the normal -output\&. -.IP -.IP "\fBname\fP" -This is the NetBIOS name being queried\&. Depending upon -the previous options this may be a NetBIOS name or IP address\&. If a -NetBIOS name then the different name types may be specified by -appending \f(CW#<type>\fP to the name\&. This name may also be \f(CW"*"\fP, -which will return all registered names within a broadcast area\&. -.IP -.PP -.SH "EXAMPLES" -.PP -\fBnmblookup\fP can be used to query a WINS server (in the same way -\fBnslookup\fP is used to query DNS servers)\&. To query a WINS server, -\fBnmblookup\fP must be called like this: -.PP -\f(CWnmblookup -U server -R \'name\'\fP -.PP +datagrams. The reason for this option is a bug in Windows 95 +where it ignores the source port of the requesting packet +and only replies to UDP port 137. Unfortunately, on most UNIX +systems root privilage is needed to bind to this port, and +in addition, if the nmbd(8) <URL:nmbd.8.html> +daemon is running on this machine it also binds to this port. +.TP +\fB-A\fR +Interpret \fIname\fR as +an IP Address and do a node status query on this address. +.TP +\fB-h\fR +Print a help (usage) message. +.TP +\fB-B <broadcast address>\fR +Send the query to the given broadcast address. Without +this option the default behavior of nmblookup is to send the +query to the broadcast address of the network interfaces as +either auto-detected or defined in the \fIinterfaces\fR + <URL:smb.conf.5.html#INTERFACES> parameter of the \fIsmb.conf (5)\fR file. +.TP +\fB-U <unicast address>\fR +Do a unicast query to the specified address or +host \fIunicast address\fR. This option +(along with the \fI-R\fR option) is needed to +query a WINS server. +.TP +\fB-d <debuglevel>\fR +debuglevel is an integer from 0 to 10. + +The default value if this parameter is not specified +is zero. + +The higher this value, the more detail will be logged +about the activities of \fBnmblookup\fR. At level +0, only critical errors and serious warnings will be logged. + +Levels above 1 will generate considerable amounts of +log data, and should only be used when investigating a problem. +Levels above 3 are designed for use only by developers and +generate HUGE amounts of data, most of which is extremely cryptic. + +Note that specifying this parameter here will override +the \fI log level\fR <URL:smb.conf.5.html#LOGLEVEL> parameter in the \fI smb.conf(5)\fR file. +.TP +\fB-s <smb.conf>\fR +This parameter specifies the pathname to +the Samba configuration file, smb.conf(5) <URL:smb.conf.5.html>. This file controls all aspects of +the Samba setup on the machine. +.TP +\fB-i <scope>\fR +This specifies a NetBIOS scope that +\fBnmblookup\fR will use to communicate with when +generating NetBIOS names. For details on the use of NetBIOS +scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are +\fBvery\fR rarely used, only set this parameter +if you are the system administrator in charge of all the +NetBIOS systems you communicate with. +.TP +\fB-T\fR +This causes any IP addresses found in the +lookup to be looked up via a reverse DNS lookup into a +DNS name, and printed out before each + +\fBIP address .... NetBIOS name\fR + +pair that is the normal output. +.TP +\fBname\fR +This is the NetBIOS name being queried. Depending +upon the previous options this may be a NetBIOS name or IP address. +If a NetBIOS name then the different name types may be specified +by appending '#<type>' to the name. This name may also be +\&'*', which will return all registered names within a broadcast +area. +.SH "EXAMPLES" +.PP +\fBnmblookup\fR can be used to query +a WINS server (in the same way \fBnslookup\fR is +used to query DNS servers). To query a WINS server, +\fBnmblookup\fR must be called like this: +.PP +\fBnmblookup -U server -R 'name'\fR +.PP For example, running : -.PP -\f(CWnmblookup -U samba\&.org -R IRIX#1B\'\fP -.PP -would query the WINS server samba\&.org for the domain master -browser (1B name type) for the IRIX workgroup\&. -.PP -.SH "VERSION" -.PP -This man page is correct for version 2\&.0 of the Samba suite\&. -.PP -.SH "SEE ALSO" -.PP -\fBsamba (7)\fP, \fBnmbd (8)\fP, -\fBsmb\&.conf (5)\fP -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed\&. -.PP -The original Samba man pages were written by Karl Auer\&. The man page -sources were converted to YODL format (another excellent piece of Open -Source software, available at -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. -.PP +.PP +\fBnmblookup -U samba.org -R IRIX#1B'\fR +.PP +would query the WINS server samba.org for the domain +master browser (1B name type) for the IRIX workgroup. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fBnmbd(8)\fR <URL:nmbd.8.html>, +samba(7) <URL:samba.7.html>, and smb.conf(5) <URL:smb.conf.5.html> +.SH "AUTHOR" +.PP +The original Samba software and related utilities +were created by Andrew Tridgell. Samba is now developed +by the Samba Team as an Open Source project similar +to the way the Linux kernel is developed. +.PP +The original Samba man pages were written by Karl Auer. +The man page sources were converted to YODL format (another +excellent piece of Open Source software, available at +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for +Samba 2.2 was done by Gerald Carter |