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