docs/docbook/manpages/nmblookup.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
   3 ]>
   4 <refentry id="nmblookup">
   5
   6 <refmeta>
   7         <refentrytitle>nmblookup</refentrytitle>
   8         <manvolnum>1</manvolnum>
   9 </refmeta>
  10
  11
  12 <refnamediv>
  13         <refname>nmblookup</refname>
  14         <refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS
  15         names</refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19         <cmdsynopsis>
  20                 <command>nmblookup</command>
  21                 <arg choice="opt">-M</arg>
  22                 <arg choice="opt">-R</arg>
  23                 <arg choice="opt">-S</arg>
  24                 <arg choice="opt">-r</arg>
  25                 <arg choice="opt">-A</arg>
  26                 <arg choice="opt">-h</arg>
  27                 <arg choice="opt">-B &lt;broadcast address&gt;</arg>
  28                 <arg choice="opt">-U &lt;unicast address&gt;</arg>
  29                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  30                 <arg choice="opt">-s &lt;smb config file&gt;</arg>
  31                 <arg choice="opt">-i &lt;NetBIOS scope&gt;</arg>
  32                 <arg choice="opt">-T</arg>
  33                 <arg choice="opt">-f</arg>
  34                 <arg choice="req">name</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40
  41         <para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  42         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  43
  44         <para><command>nmblookup</command> is used to query NetBIOS names
  45         and map them to IP addresses in a network using NetBIOS over TCP/IP
  46         queries. The options allow the name queries to be directed at a
  47         particular IP broadcast area or to a particular machine. All queries
  48         are done over UDP.</para>
  49 </refsect1>
  50
  51 <refsect1>
  52         <title>OPTIONS</title>
  53
  54         <variablelist>
  55                 <varlistentry>
  56                 <term>-M</term>
  57                 <listitem><para>Searches for a master browser by looking
  58                 up the  NetBIOS name <replaceable>name</replaceable> with a
  59                 type of <constant>0x1d</constant>. If <replaceable>
  60                 name</replaceable> is "-" then it does a lookup on the special name
  61                 <constant>__MSBROWSE__</constant>. Please note that in order to
  62                 use the name "-", you need to make sure "-" isn't parsed as an
  63                 argument, e.g. use :
  64                 <userinput>nmblookup -M -- -</userinput>.</para></listitem>
  65                 </varlistentry>
  66
  67                 <varlistentry>
  68                 <term>-R</term>
  69                 <listitem><para>Set the recursion desired bit in the packet
  70                 to do a recursive lookup. This is used when sending a name
  71                 query to a machine running a WINS server and the user wishes
  72                 to query the names in the WINS server.  If this bit is unset
  73                 the normal (broadcast responding) NetBIOS processing code
  74                 on a machine is used instead. See RFC1001, RFC1002 for details.
  75                 </para></listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term>-S</term>
  80                 <listitem><para>Once the name query has returned an IP
  81                 address then do a node status query as well. A node status
  82                 query returns the NetBIOS names registered by a host.
  83                 </para></listitem>
  84                 </varlistentry>
  85
  86
  87                 <varlistentry>
  88                 <term>-r</term>
  89                 <listitem><para>Try and bind to UDP port 137 to send and receive UDP
  90                 datagrams. The reason for this option is a bug in Windows 95
  91                 where it ignores the source port of the requesting packet
  92                 and only replies to UDP port 137. Unfortunately, on most UNIX
  93                 systems root privilege is needed to bind to this port, and
  94                 in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle>
  95                 <manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port.
  96                 </para></listitem>
  97                 </varlistentry>
  98
  99
 100                 <varlistentry>
 101                 <term>-A</term>
 102                 <listitem><para>Interpret <replaceable>name</replaceable> as
 103                 an IP Address and do a node status query on this address.</para>
 104                 </listitem>
 105                 </varlistentry>
 106
 107
 108
 109                 &popt.common.connection;
 110                 &stdarg.help;
 111
 112                 <varlistentry>
 113                 <term>-B &lt;broadcast address&gt;</term>
 114                 <listitem><para>Send the query to the given broadcast address. Without
 115                 this option the default behavior of nmblookup is to send the
 116                 query to the broadcast address of the network interfaces as
 117                 either auto-detected or defined in the <ulink
 118                 url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter>
 119                 </ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 120         <manvolnum>5</manvolnum></citerefentry> file.
 121                 </para></listitem>
 122                 </varlistentry>
 123
 124
 125
 126                 <varlistentry>
 127                 <term>-U &lt;unicast address&gt;</term>
 128                 <listitem><para>Do a unicast query to the specified address or
 129                 host <replaceable>unicast address</replaceable>. This option
 130                 (along with the <parameter>-R</parameter> option) is needed to
 131                 query a WINS server.</para></listitem>
 132                 </varlistentry>
 133
 134
 135                 &popt.common.samba;
 136
 137                 <varlistentry>
 138                 <term>-T</term>
 139                 <listitem><para>This causes any IP addresses found in the
 140                 lookup to be looked up via a reverse DNS lookup into a
 141                 DNS name, and printed out before each</para>
 142
 143                 <para><emphasis>IP address .... NetBIOS name</emphasis></para>
 144
 145                 <para> pair that is the normal output.</para></listitem>
 146                 </varlistentry>
 147
 148                 <varlistentry>
 149                 <term>-f</term>
 150                 <listitem><para>
 151                 Show which flags apply to the name that has been looked up. Possible
 152                 answers are zero or more of: Response, Authoritative,
 153                 Truncated, Recursion_Desired, Recursion_Available, Broadcast.
 154                 </para></listitem>
 155                 </varlistentry>
 156
 157
 158                 <varlistentry>
 159                 <term>name</term>
 160                 <listitem><para>This is the NetBIOS name being queried. Depending
 161                 upon the previous options this may be a NetBIOS name or IP address.
 162                 If a NetBIOS name then the different name types may be specified
 163                 by appending '#&lt;type&gt;' to the name. This name may also be
 164                 '*', which will return all registered names within a broadcast
 165                 area.</para></listitem>
 166                 </varlistentry>
 167         </variablelist>
 168 </refsect1>
 169
 170
 171 <refsect1>
 172         <title>EXAMPLES</title>
 173
 174                 <para><command>nmblookup</command> can be used to query
 175                 a WINS server (in the same way <command>nslookup</command> is
 176                 used to query DNS servers). To query a WINS server, <command>nmblookup</command>
 177                 must be called like this:</para>
 178
 179                 <para><command>nmblookup -U server -R 'name'</command></para>
 180
 181                 <para>For example, running :</para>
 182
 183                 <para><command>nmblookup -U samba.org -R 'IRIX#1B'</command></para>
 184
 185                 <para>would query the WINS server samba.org for the domain
 186                 master browser (1B name type) for the IRIX workgroup.</para>
 187 </refsect1>
 188
 189 <refsect1>
 190         <title>VERSION</title>
 191
 192         <para>This man page is correct for version 3.0 of
 193         the Samba suite.</para>
 194 </refsect1>
 195
 196 <refsect1>
 197         <title>SEE ALSO</title>
 198         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 199         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
 200         <manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle>
 201         <manvolnum>5</manvolnum></citerefentry>.</para>
 202 </refsect1>
 203
 204 <refsect1>
 205         <title>AUTHOR</title>
 206
 207         <para>The original Samba software and related utilities
 208         were created by Andrew Tridgell. Samba is now developed
 209         by the Samba Team as an Open Source project similar
 210         to the way the Linux kernel is developed.</para>
 211
 212         <para>The original Samba man pages were written by Karl Auer.
 213         The man page sources were converted to YODL format (another
 214         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 215         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 216         release by Jeremy Allison.  The conversion to DocBook for
 217         Samba 2.2 was done by Gerald Carter. The conversion to DocBook
 218         XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
 219 </refsect1>
 220
 221 </refentry>