Rebuild docs
[Samba.git] / docs / manpages / nmblookup.1
blob2f160255939245c6ace71766dc80fcacd0f82253
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
20 .TH "NMBLOOKUP" 1 "" "" ""
21 .SH NAME
22 nmblookup \- NetBIOS over TCP/IP client used to lookup NetBIOS names
23 .SH "SYNOPSIS"
25 .nf
26 \fBnmblookup\fR [-M] [-R] [-S] [-r] [-A] [-h] [-B <broadcast address>] [-U <unicast
27           address>] [-d <debug level>] [-s <smb config file>] [-i <NetBIOS scope>]
28           [-T] [-f] {name}
29 .fi
31 .SH "DESCRIPTION"
33 .PP
34 This tool is part of the \fBSamba\fR(7) suite\&.
36 .PP
37 \fBnmblookup\fR is 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\&.
39 .SH "OPTIONS"
41 .TP
43 Searches for a master browser by looking up the NetBIOS name \fIname\fR with a type of \fB0x1d\fR\&. If \fI name\fR is "-" then it does a lookup on the special name \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 : \fBnmblookup -M -- -\fR\&.
46 .TP
48 Set 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\&.
51 .TP
53 Once 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\&.
56 .TP
58 Try 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 \fBnmbd\fR(8) daemon is running on this machine it also binds to this port\&.
61 .TP
63 Interpret \fIname\fR as an IP Address and do a node status query on this address\&.
66 .TP
67 -n <primary NetBIOS name>
68 This option allows you to override the NetBIOS name that Samba uses for itself\&. This is identical to setting the \fINetBIOS name\fR parameter in the \fBsmb.conf\fR(5) file\&. However, a command line setting will take precedence over settings in \fBsmb.conf\fR(5)\&.
71 .TP
72 -i <scope>
73 This specifies a NetBIOS scope that \fBnmblookup\fR will 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 \fBvery\fR rarely used, only set this parameter if you are the system administrator in charge of all the NetBIOS systems you communicate with\&.
76 .TP
77 -W|--workgroup=domain
78 Set 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)\&.
81 .TP
82 -O socket options
83 TCP socket options to set on the client socket\&. See the socket options parameter in the \fBsmb.conf\fR(5) manual page for the list of valid options\&.
86 .TP
87 -h|--help
88 Print a summary of command line options\&.
91 .TP
92 -B <broadcast address>
93 Send 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 \fIinterfaces\fR parameter of the \fBsmb.conf\fR(5) file\&.
96 .TP
97 -U <unicast address>
98 Do a unicast query to the specified address or host \fIunicast address\fR\&. This option (along with the \fI-R\fR option) is needed to query a WINS server\&.
103 Prints the version number for \fBsmbd\fR\&.
107 -s <configuration file>
108 The 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 \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
112 -d|--debug=debuglevel
113 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
116 The 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\&.
119 Levels 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\&.
122 Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
126 -l|--logfile=logbasename
127 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
132 This 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
135 \fBIP address \&.\&.\&.\&. NetBIOS name\fR
138 pair that is the normal output\&.
143 Show 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\&.
147 name
148 This 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\&.
151 .SH "EXAMPLES"
154 \fBnmblookup\fR can be used to query a WINS server (in the same way \fBnslookup\fR is used to query DNS servers)\&. To query a WINS server, \fBnmblookup\fR must be called like this:
157 \fBnmblookup -U server -R 'name'\fR
160 For example, running :
163 \fBnmblookup -U samba.org -R 'IRIX#1B'\fR
166 would query the WINS server samba\&.org for the domain master browser (1B name type) for the IRIX workgroup\&.
168 .SH "VERSION"
171 This man page is correct for version 3\&.0 of the Samba suite\&.
173 .SH "SEE ALSO"
176 \fBnmbd\fR(8), \fBsamba\fR(7), and \fBsmb.conf\fR(5)\&.
178 .SH "AUTHOR"
181 The 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\&.
184 The 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 ftp://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\&.