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