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