merge from 2.2
[samba.git] / docs / manpages / nmblookup.1
1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document.  docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "NMBLOOKUP" "1" "21 June 2001" "" ""
7 .SH NAME
8 nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS  names
9 .SH SYNOPSIS
10 .sp
11 \fBnmblookup\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
12 .SH "DESCRIPTION"
13 .PP
14 This tool is part of the  Sambasuite.
15 .PP
16 \fBnmblookup\fR is used to query NetBIOS names 
17 and map them to IP addresses in a network using NetBIOS over TCP/IP 
18 queries. The options allow the name queries to be directed at a 
19 particular IP broadcast area or to a particular machine. All queries 
20 are done over UDP.
21 .SH "OPTIONS"
22 .TP
23 \fB-M\fR
24 Searches for a master browser by looking 
25 up the NetBIOS name \fIname\fR with a 
26 type of 0x1d. If \fI name\fR is "-" then it does a lookup on the special name 
27 __MSBROWSE__.
28 .TP
29 \fB-R\fR
30 Set the recursion desired bit in the packet 
31 to do a recursive lookup. This is used when sending a name 
32 query to a machine running a WINS server and the user wishes 
33 to query the names in the WINS server. If this bit is unset 
34 the normal (broadcast responding) NetBIOS processing code 
35 on a machine is used instead. See rfc1001, rfc1002 for details.
36 .TP
37 \fB-S\fR
38 Once the name query has returned an IP 
39 address then do a node status query as well. A node status 
40 query returns the NetBIOS names registered by a host.
41 .TP
42 \fB-r\fR
43 Try and bind to UDP port 137 to send and receive UDP
44 datagrams. The reason for this option is a bug in Windows 95 
45 where it ignores the source port of the requesting packet 
46 and only replies to UDP port 137. Unfortunately, on most UNIX 
47 systems root privilage is needed to bind to this port, and 
48 in addition, if the nmbd(8)daemon is running on this machine it also binds to this port.
49 .TP
50 \fB-A\fR
51 Interpret \fIname\fR as 
52 an IP Address and do a node status query on this address.
53 .TP
54 \fB-h\fR
55 Print a help (usage) message.
56 .TP
57 \fB-B <broadcast address>\fR
58 Send the query to the given broadcast address. Without 
59 this option the default behavior of nmblookup is to send the 
60 query to the broadcast address of the network interfaces as 
61 either auto-detected or defined in the \fIinterfaces\fR
62 parameter of the \fIsmb.conf (5)\fR file.
63 .TP
64 \fB-U <unicast address>\fR
65 Do a unicast query to the specified address or 
66 host \fIunicast address\fR. This option 
67 (along with the \fI-R\fR option) is needed to 
68 query a WINS server.
69 .TP
70 \fB-d <debuglevel>\fR
71 debuglevel is an integer from 0 to 10.
72
73 The default value if this parameter is not specified 
74 is zero.
75
76 The higher this value, the more detail will be logged 
77 about the activities of \fBnmblookup\fR. At level 
78 0, only critical errors and serious warnings will be logged.
79
80 Levels above 1 will generate considerable amounts of 
81 log data, and should only be used when investigating a problem. 
82 Levels above 3 are designed for use only by developers and 
83 generate HUGE amounts of data, most of which is extremely cryptic.
84
85 Note that specifying this parameter here will override 
86 the \fI log level\fRparameter in the \fI smb.conf(5)\fR file.
87 .TP
88 \fB-s <smb.conf>\fR
89 This parameter specifies the pathname to 
90 the Samba configuration file,  smb.conf(5). This file controls all aspects of
91 the Samba setup on the machine.
92 .TP
93 \fB-i <scope>\fR
94 This specifies a NetBIOS scope that
95 \fBnmblookup\fR will use to communicate with when 
96 generating NetBIOS names. For details on the use of NetBIOS 
97 scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes are 
98 \fBvery\fR rarely used, only set this parameter 
99 if you are the system administrator in charge of all the 
100 NetBIOS systems you communicate with.
101 .TP
102 \fB-T\fR
103 This causes any IP addresses found in the 
104 lookup to be looked up via a reverse DNS lookup into a 
105 DNS name, and printed out before each
106
107 \fBIP address .... NetBIOS name\fR
108
109 pair that is the normal output.
110 .TP
111 \fBname\fR
112 This is the NetBIOS name being queried. Depending 
113 upon the previous options this may be a NetBIOS name or IP address. 
114 If a NetBIOS name then the different name types may be specified 
115 by appending '#<type>' to the name. This name may also be
116 \&'*', which will return all registered names within a broadcast 
117 area.
118 .SH "EXAMPLES"
119 .PP
120 \fBnmblookup\fR can be used to query 
121 a WINS server (in the same way \fBnslookup\fR is 
122 used to query DNS servers). To query a WINS server, 
123 \fBnmblookup\fR must be called like this:
124 .PP
125 \fBnmblookup -U server -R 'name'\fR
126 .PP
127 For example, running :
128 .PP
129 \fBnmblookup -U samba.org -R 'IRIX#1B'\fR
130 .PP
131 would query the WINS server samba.org for the domain 
132 master browser (1B name type) for the IRIX workgroup.
133 .SH "VERSION"
134 .PP
135 This man page is correct for version 2.2 of 
136 the Samba suite.
137 .SH "SEE ALSO"
138 .PP
139 \fBnmbd(8)\fR, 
140 samba(7).SH "AUTHOR"
141 .PP
142 The original Samba software and related utilities 
143 were created by Andrew Tridgell. Samba is now developed
144 by the Samba Team as an Open Source project similar 
145 to the way the Linux kernel is developed.
146 .PP
147 The original Samba man pages were written by Karl Auer. 
148 The man page sources were converted to YODL format (another 
149 excellent piece of Open Source software, available at
150 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
151 release by Jeremy Allison. The conversion to DocBook for 
152 Samba 2.2 was done by Gerald Carter