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