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