<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="nmblookup">

<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>nmblookup</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 &lt;broadcast address&gt;</arg>
		<arg choice="opt">-U &lt;unicast address&gt;</arg>
		<arg choice="opt">-d &lt;debug level&gt;</arg>
		<arg choice="opt">-s &lt;smb config file&gt;</arg>
		<arg choice="opt">-i &lt;NetBIOS scope&gt;</arg>
		<arg choice="opt">-T</arg>
		<arg choice="req">name</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool 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 privilege 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 &lt;broadcast address&gt;</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 &lt;unicast address&gt;</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 &lt;debuglevel&gt;</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 &lt;smb.conf&gt;</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 &lt;scope&gt;</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 '#&lt;type&gt' 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>
