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