20316ad3c666455ae163258efa0b310fef16d890
[samba.git] / docs / yodldocs / nmblookup.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(nmblookup)(1)(23 Oct 1998)(Samba)(SAMBA)
4
5 label(NAME)
6 manpagename(nmblookup)(NetBIOS over TCP/IP client used to lookup NetBIOS names)
7
8 label(SYNOPSIS)
9 manpagesynopsis() 
10
11 bf(nmblookup) [-M] [-R] [-S] [-r] [-A] [-h] [-B broadcast address] [-U unicast address] [-d debuglevel] [-s smb config file] [-i NetBIOS scope] name
12
13 label(DESCRIPTION)
14 manpagedescription()
15
16 This program is part of the bf(Samba) suite.
17
18 bf(nmblookup) is used to query NetBIOS names and map them to IP
19 addresses in a network using NetBIOS over TCP/IP queries. The options
20 allow the name queries to be directed at a particlar IP broadcast area
21 or to a particular machine. All queries are done over UDP.
22
23 label(OPTIONS)
24 manpageoptions()
25
26 startdit()
27
28 dit(bf(-M)) Searches for a master browser. This is done by doing a
29 broadcast lookup on the special name tt(__MSBROWSE__).
30
31 dit(bf(-R)) Set the recursion desired bit in the packet to do a
32 recursive lookup. This is used when sending a name query to a machine
33 running a WINS server and the user wishes to query the names in the
34 WINS server.  If this bit is unset the normal (broadcast responding)
35 NetBIOS processing code on a machine is used instead. See rfc1001,
36 rfc1002 for details.
37
38 dit(bf(-S)) Once the name query has returned an IP address then do a
39 node status query as well.
40
41 dit(bf(-r)) 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 privillage is
45 needed to bind to this port, and in addition, if the
46 url(bf(nmbd))(nmbd.8.html) daemon is running on this machine it also
47 binds to this port.
48
49 dit(bf(-A)) Interpret <name> as an IP Address and do a node status
50 query on this address.
51
52 dit(bf(-h)) Print a help (usage) message.
53
54 dit(bf(-B broadcast address)) Send the query to the given broadcast
55 address. Without this option the default behavior of nmblookup is to
56 send the query to the broadcast address of the primary network
57 interface as either auto-detected or defined in the 
58 url(bf(interfaces))(smb.conf.5.html#interfaces) parameter of the 
59 url(bf(smb.conf (5)))(smb.conf.5.html) file.
60
61 dit(bf(-U unicast address)) Do a unicast query to the specified
62 address or host tt("unicast address"). This option (along with the
63 bf(-R) option) is needed to query a WINS server.
64
65 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
66
67 The default value if this parameter is not specified is zero.
68
69 The higher this value, the more detail will be logged about the
70 activities of bf(nmblookup). At level 0, only critical errors and
71 serious warnings will be logged.
72
73 Levels above 1 will generate considerable amounts of log data, and
74 should only be used when investigating a problem. Levels above 3 are
75 designed for use only by developers and generate HUGE amounts of
76 data, most of which is extremely cryptic.
77
78 dit(bf(-i scope)) This specifies a NetBIOS scope that smbclient will use
79 to communicate with when generating NetBIOS names. For details on the
80 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
81 are em(very) rarely used, only set this parameter if you are the
82 system administrator in charge of all the NetBIOS systems you
83 communicate with.
84
85 dit(bf(name)) This is the NetBIOS name being queried. Depending upon
86 the previous options this may be a NetBIOS name or IP address. If a
87 NetBIOS name then the different name types may be specified by
88 appending tt(#<type>) to the name.
89
90 enddit()
91
92 label(EXAMPLES)
93 manpagesection(EXAMPLES)
94
95 bf(nmblookup) can be used to query a WINS server (in the same way .B
96 nslookup is used to query DNS servers). To query a WINS server,
97 nmblookup must be called like this:
98
99 tt(nmblookup -U server -R 'name')
100
101 For example, running :
102
103 tt(nmblookup -U samba.anu.edu.au -R IRIX#1B')
104
105 would query the WINS server samba.anu.edu.au for the domain master
106 browser (1B name type) for the IRIX workgroup.
107
108 label(VERSION)
109 manpagesection(VERSION)
110
111 This man page is correct for version 2.0 of the Samba suite.
112
113 label(SEEALSO)
114 manpageseealso()
115
116 url(bf(samba (7)))(samba.7.html), url(bf(nmbd (8)))(nmbd.8.html), url(bf(smb.conf (5)))(smb.conf.5.html)
117
118 label(AUTHOR)
119 manpageauthor()
120
121 The original Samba software and related utilities were created by
122 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
123 by the Samba Team as an Open Source project similar to the way the
124 Linux kernel is developed.
125
126 The original Samba man pages were written by Karl Auer. The man page
127 sources were converted to YODL format (another excellent piece of Open
128 Source software) and updated for the Samba2.0 release by Jeremy
129 Allison, email(samba-bugs@samba.anu.edu.au).
130
131 See url(bf(samba (7)))(samba.7.html) to find out how to get a full
132 list of contributors and details on how to submit bug reports,
133 comments etc.
134