source: branches/samba-3.3.x/docs/manpages/nmblookup.1@ 285

Last change on this file since 285 was 285, checked in by Herwig Bauernfeind, 16 years ago

Update 3.3 branch to 3.3.6

File size: 11.5 KB
Line 
1.\" Title: nmblookup
2.\" Author: [see the "AUTHOR" section]
3.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4.\" Date: 06/23/2009
5.\" Manual: User Commands
6.\" Source: Samba 3.3
7.\" Language: English
8.\"
9.TH "NMBLOOKUP" "1" "06/23/2009" "Samba 3\&.3" "User Commands"
10.\" -----------------------------------------------------------------
11.\" * (re)Define some macros
12.\" -----------------------------------------------------------------
13.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14.\" toupper - uppercase a string (locale-aware)
15.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16.de toupper
17.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18\\$*
19.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20..
21.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22.\" SH-xref - format a cross-reference to an SH section
23.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24.de SH-xref
25.ie n \{\
26.\}
27.toupper \\$*
28.el \{\
29\\$*
30.\}
31..
32.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33.\" SH - level-one heading that works better for non-TTY output
34.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35.de1 SH
36.\" put an extra blank line of space above the head in non-TTY output
37.if t \{\
38.sp 1
39.\}
40.sp \\n[PD]u
41.nr an-level 1
42.set-an-margin
43.nr an-prevailing-indent \\n[IN]
44.fi
45.in \\n[an-margin]u
46.ti 0
47.HTML-TAG ".NH \\n[an-level]"
48.it 1 an-trap
49.nr an-no-space-flag 1
50.nr an-break-flag 1
51\." make the size of the head bigger
52.ps +3
53.ft B
54.ne (2v + 1u)
55.ie n \{\
56.\" if n (TTY output), use uppercase
57.toupper \\$*
58.\}
59.el \{\
60.nr an-break-flag 0
61.\" if not n (not TTY), use normal case (not uppercase)
62\\$1
63.in \\n[an-margin]u
64.ti 0
65.\" if not n (not TTY), put a border/line under subheading
66.sp -.6
67\l'\n(.lu'
68.\}
69..
70.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71.\" SS - level-two heading that works better for non-TTY output
72.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73.de1 SS
74.sp \\n[PD]u
75.nr an-level 1
76.set-an-margin
77.nr an-prevailing-indent \\n[IN]
78.fi
79.in \\n[IN]u
80.ti \\n[SN]u
81.it 1 an-trap
82.nr an-no-space-flag 1
83.nr an-break-flag 1
84.ps \\n[PS-SS]u
85\." make the size of the head bigger
86.ps +2
87.ft B
88.ne (2v + 1u)
89.if \\n[.$] \&\\$*
90..
91.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92.\" BB/BE - put background/screen (filled box) around block of text
93.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94.de BB
95.if t \{\
96.sp -.5
97.br
98.in +2n
99.ll -2n
100.gcolor red
101.di BX
102.\}
103..
104.de EB
105.if t \{\
106.if "\\$2"adjust-for-leading-newline" \{\
107.sp -1
108.\}
109.br
110.di
111.in
112.ll
113.gcolor
114.nr BW \\n(.lu-\\n(.i
115.nr BH \\n(dn+.5v
116.ne \\n(BHu+.5v
117.ie "\\$2"adjust-for-leading-newline" \{\
118\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119.\}
120.el \{\
121\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122.\}
123.in 0
124.sp -.5v
125.nf
126.BX
127.in
128.sp .5v
129.fi
130.\}
131..
132.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133.\" BM/EM - put colored marker in margin next to block of text
134.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135.de BM
136.if t \{\
137.br
138.ll -2n
139.gcolor red
140.di BX
141.\}
142..
143.de EM
144.if t \{\
145.br
146.di
147.ll
148.gcolor
149.nr BH \\n(dn
150.ne \\n(BHu
151\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152.in 0
153.nf
154.BX
155.in
156.fi
157.\}
158..
159.\" -----------------------------------------------------------------
160.\" * set default formatting
161.\" -----------------------------------------------------------------
162.\" disable hyphenation
163.nh
164.\" disable justification (adjust text to left margin only)
165.ad l
166.\" -----------------------------------------------------------------
167.\" * MAIN CONTENT STARTS HERE *
168.\" -----------------------------------------------------------------
169.SH "Name"
170nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names
171.SH "Synopsis"
172.fam C
173.HP \w'\ 'u
174\FCnmblookup\F[] [\-M] [\-R] [\-S] [\-r] [\-A] [\-h] [\-B\ <broadcast\ address>] [\-U\ <unicast\ address>] [\-d\ <debug\ level>] [\-s\ <smb\ config\ file>] [\-i\ <NetBIOS\ scope>] [\-T] [\-f] {name}
175.fam
176.SH "DESCRIPTION"
177.PP
178This tool is part of the
179\fBsamba\fR(7)
180suite\&.
181.PP
182\FCnmblookup\F[]
183is 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\&.
184.SH "OPTIONS"
185.PP
186\-M
187.RS 4
188Searches for a master browser by looking up the NetBIOS name
189\fIname\fR
190with a type of
191\fB0x1d\fR\&. If
192\fI name\fR
193is "\-" then it does a lookup on the special name
194\fB__MSBROWSE__\fR\&. Please note that in order to use the name "\-", you need to make sure "\-" isn\'t parsed as an argument, e\&.g\&. use :
195\fBnmblookup \-M \-\- \-\fR\&.
196.RE
197.PP
198\-R
199.RS 4
200Set 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\&.
201.RE
202.PP
203\-S
204.RS 4
205Once 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\&.
206.RE
207.PP
208\-r
209.RS 4
210Try 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
211\fBnmbd\fR(8)
212daemon is running on this machine it also binds to this port\&.
213.RE
214.PP
215\-A
216.RS 4
217Interpret
218\fIname\fR
219as an IP Address and do a node status query on this address\&.
220.RE
221.PP
222\-n <primary NetBIOS name>
223.RS 4
224This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the
225\m[blue]\fBnetbios name\fR\m[]
226parameter in the
227\FCsmb\&.conf\F[]
228file\&. However, a command line setting will take precedence over settings in
229\FCsmb\&.conf\F[]\&.
230.RE
231.PP
232\-i <scope>
233.RS 4
234This specifies a NetBIOS scope that
235\FCnmblookup\F[]
236will 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
237\fIvery\fR
238rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.
239.RE
240.PP
241\-W|\-\-workgroup=domain
242.RS 4
243Set the SMB domain of the username\&. This overrides the default domain which is the domain defined in smb\&.conf\&. If the domain specified is the same as the servers NetBIOS name, it causes the client to log on using the servers local SAM (as opposed to the Domain SAM)\&.
244.RE
245.PP
246\-O socket options
247.RS 4
248TCP socket options to set on the client socket\&. See the socket options parameter in the
249\FCsmb\&.conf\F[]
250manual page for the list of valid options\&.
251.RE
252.PP
253\-h|\-\-help
254.RS 4
255Print a summary of command line options\&.
256.RE
257.PP
258\-B <broadcast address>
259.RS 4
260Send 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
261\fIinterfaces\fR
262parameter of the
263\fBsmb.conf\fR(5)
264file\&.
265.RE
266.PP
267\-U <unicast address>
268.RS 4
269Do a unicast query to the specified address or host
270\fIunicast address\fR\&. This option (along with the
271\fI\-R\fR
272option) is needed to query a WINS server\&.
273.RE
274.PP
275\-d|\-\-debuglevel=level
276.RS 4
277\fIlevel\fR
278is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
279.sp
280The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
281.sp
282Levels 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 log data, most of which is extremely cryptic\&.
283.sp
284Note that specifying this parameter here will override the
285\m[blue]\fBlog level\fR\m[]
286parameter in the
287\FCsmb\&.conf\F[]
288file\&.
289.RE
290.PP
291\-V
292.RS 4
293Prints the program version number\&.
294.RE
295.PP
296\-s <configuration file>
297.RS 4
298The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See
299\FCsmb\&.conf\F[]
300for more information\&. The default configuration file name is determined at compile time\&.
301.RE
302.PP
303\-l|\-\-log\-basename=logdirectory
304.RS 4
305Base directory name for log/debug files\&. The extension
306\fB"\&.progname"\fR
307will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
308.RE
309.PP
310\-T
311.RS 4
312This 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
313.sp
314\fIIP address \&.\&.\&.\&. NetBIOS name\fR
315.sp
316pair that is the normal output\&.
317.RE
318.PP
319\-f
320.RS 4
321Show which flags apply to the name that has been looked up\&. Possible answers are zero or more of: Response, Authoritative, Truncated, Recursion_Desired, Recursion_Available, Broadcast\&.
322.RE
323.PP
324name
325.RS 4
326This 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 \'#<type>\' to the name\&. This name may also be \'*\', which will return all registered names within a broadcast area\&.
327.RE
328.SH "EXAMPLES"
329.PP
330\FCnmblookup\F[]
331can be used to query a WINS server (in the same way
332\FCnslookup\F[]
333is used to query DNS servers)\&. To query a WINS server,
334\FCnmblookup\F[]
335must be called like this:
336.PP
337\FCnmblookup \-U server \-R \'name\'\F[]
338.PP
339For example, running :
340.PP
341\FCnmblookup \-U samba\&.org \-R \'IRIX#1B\'\F[]
342.PP
343would query the WINS server samba\&.org for the domain master browser (1B name type) for the IRIX workgroup\&.
344.SH "VERSION"
345.PP
346This man page is correct for version 3 of the Samba suite\&.
347.SH "SEE ALSO"
348.PP
349\fBnmbd\fR(8),
350\fBsamba\fR(7), and
351\fBsmb.conf\fR(5)\&.
352.SH "AUTHOR"
353.PP
354The 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\&.
355.PP
356The 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
357ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
Note: See TracBrowser for help on using the repository browser.