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