path: root/docs/manpages/nmbd.8

.TH NMBD 8 "30 Jan 2001" "nmbd 2.2.0-alpha2"
.PP 
.SH "NAME" 
nmbd \- NetBIOS name server to provide NetBIOS over IP
naming services to clients
.PP 
.SH "SYNOPSIS" 
.PP 
\fBnmbd\fP [-D] [-a] [-o] [-h] [-V] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file]
.PP 
.SH "DESCRIPTION" 
.PP 
This program is part of the \fBSamba\fP suite\&.
.PP 
\fBnmbd\fP is a server that understands and can reply to NetBIOS over IP
name service requests, like those produced by SMBD/CIFS clients such
as Windows 95/98, Windows NT and LanManager clients\&. It also
participates in the browsing protocols which make up the Windows
"Network Neighborhood" view\&.
.PP 
SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
server\&. That is, they wish to know what IP number a specified host is
using\&.
.PP 
Amongst other services, \fBnmbd\fP will listen for such requests,
and if its own NetBIOS name is specified it will respond with the IP
number of the host it is running on\&.  Its "own NetBIOS name" is by
default the primary DNS name of the host it is running on, but this
can be overridden with the \fB-n\fP option (see OPTIONS below)\&. Thus
\fBnmbd\fP will reply to broadcast queries for its own name(s)\&. Additional
names for \fBnmbd\fP to respond on can be set via parameters in the
\fBsmb\&.conf(5)\fP configuration file\&.
.PP 
\fBnmbd\fP can also be used as a WINS (Windows Internet Name Server)
server\&. What this basically means is that it will act as a WINS
database server, creating a database from name registration requests
that it receives and replying to queries from clients for these names\&.
.PP 
In addition, \fBnmbd\fP can act as a WINS proxy, relaying broadcast queries
from clients that do not understand how to talk the WINS protocol to a
WIN server\&.
.PP 
.SH "OPTIONS" 
.PP 
.IP 
.IP "\fB-D\fP" 
If specified, this parameter causes \fBnmbd\fP to operate
as a daemon\&. That is, it detaches itself and runs in the background,
fielding requests on the appropriate port\&. By default, \fBnmbd\fP will
NOT operate as a daemon\&. nmbd can also be operated from the inetd
meta-daemon, although this is not recommended\&.
.IP 
.IP "\fB-a\fP" 
If this parameter is specified, each new connection will
append log messages to the log file\&.  This is the default\&.
.IP 
.IP "\fB-o\fP" 
If this parameter is specified, the log files will be
overwritten when opened\&.  By default, the log files will be appended
to\&.
.IP 
.IP "\fB-h\fP" 
Prints the help information (usage) for \fBnmbd\fP\&.
.IP 
.IP "\fB-V\fP" 
Prints the version number for \fBnmbd\fP\&.
.IP 
.IP "\fB-H filename\fP" 
NetBIOS lmhosts file\&.
.IP 
The lmhosts file is a list of NetBIOS names to IP addresses that is
loaded by the nmbd server and used via the name resolution mechanism
\fBname resolve order\fP described in 
\fBsmb\&.conf (5)\fP to resolve any
NetBIOS name queries needed by the server\&. Note that the contents of
this file are \fINOT\fP used by \fBnmbd\fP to answer any name queries\&. Adding
a line to this file affects name NetBIOS resolution from this host
\fIONLY\fP\&.
.IP 
The default path to this file is compiled into Samba as part of the
build process\&. Common defaults are \fI/usr/local/samba/lib/lmhosts\fP,
\fI/usr/samba/lib/lmhosts\fP or \fI/etc/lmhosts\fP\&. See the 
\fBlmhosts (5)\fP man page for details on the contents of this file\&.
.IP 
.IP "\fB-d debuglevel\fP" 
debuglevel is an integer from 0 to 10\&.
.IP 
The default value if this parameter is not specified is zero\&.
.IP 
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\&.
.IP 
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\&.
.IP 
Note that specifying this parameter here will override the \fBlog
level\fP parameter in the \fBsmb\&.conf
(5)\fP file\&.
.IP 
.IP "\fB-l logfile\fP" 
The \fB-l\fP parameter specifies a path and base
filename into which operational data from the running nmbd server will
be logged\&.  The actual log file name is generated by appending the
extension "\&.nmb" to the specified base name\&.  For example, if the name
specified was "log" then the file log\&.nmb would contain the debugging
data\&.
.IP 
The default log file path is compiled into Samba as part of the
build process\&. Common defaults are \fI/usr/local/samba/var/log\&.nmb\fP,
\fI/usr/samba/var/log\&.nmb\fP or \fI/var/log/log\&.nmb\fP\&.
.IP 
.IP "\fB-n primary NetBIOS name\fP" 
This option allows you to override
the NetBIOS name that Samba uses for itself\&. This is identical to
setting the \fBNetBIOS name\fP parameter
in the \fBsmb\&.conf\fP file
but will override the setting in the \fBsmb\&.conf\fP file\&.
.IP 
.IP "\fB-p UDP port number\fP" 
UDP port number is a positive integer value\&.
.IP 
This option changes the default UDP port number (normally 137) that
\fBnmbd\fP responds to name queries on\&. Don\'t use this option unless you are
an expert, in which case you won\'t need help!
.IP 
.IP "\fB-s configuration file\fP" 
The default configuration file name is
set at build time, typically as \fI/usr/local/samba/lib/smb\&.conf\fP, but
this may be changed when Samba is autoconfigured\&.
.IP 
The file specified contains the configuration details required by the
server\&. See \fBsmb\&.conf (5)\fP for more information\&.
.IP 
.PP 
.SH "FILES" 
.PP 
\fB/etc/inetd\&.conf\fP
.PP 
If the server is to be run by the inetd meta-daemon, this file must
contain suitable startup information for the meta-daemon\&.
.PP 
\fB/etc/rc\fP
.PP 
(or whatever initialization script your system uses)\&.
.PP 
If running the server as a daemon at startup, this file will need to
contain an appropriate startup sequence for the server\&.
.PP 
\fB/usr/local/samba/lib/smb\&.conf\fP
.PP 
This is the default location of the 
\fBsmb\&.conf\fP server configuration
file\&. Other common places that systems install this file are
\fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&.
.PP 
When run as a \fBWINS\fP server (see the \fBwins support\fP
parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
store the WINS database in the file \f(CWwins\&.dat\fP in the \f(CWvar/locks\fP directory
configured under wherever Samba was configured to install itself\&.
.PP 
If \fBnmbd\fP is acting as a \fBbrowse master\fP (see the \fBlocal master\fP
parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
store the browsing database in the file \f(CWbrowse\&.dat\fP in the \f(CWvar/locks\fP directory
configured under wherever Samba was configured to install itself\&.
.PP 
.SH "SIGNALS" 
.PP 
To shut down an \fBnmbd\fP process it is recommended that SIGKILL (-9)
\fINOT\fP be used, except as a last resort, as this may leave the name
database in an inconsistent state\&. The correct way to terminate
\fBnmbd\fP is to send it a SIGTERM (-15) signal and wait for it to die on
its own\&.
.PP 
\fBnmbd\fP will accept SIGHUP, which will cause it to dump out it\'s
namelists into the file \f(CWnamelist\&.debug\fP in the
\fI/usr/local/samba/var/locks\fP directory (or the \fIvar/locks\fP
directory configured under wherever Samba was configured to install
itself)\&. This will also cause \fBnmbd\fP to dump out it\'s server database in
the log\&.nmb file\&. In addition, the debug log level of nmbd may be raised
by sending it a SIGUSR1 (\f(CWkill -USR1 <nmbd-pid>\fP) and lowered by sending it a
SIGUSR2 (\f(CWkill -USR2 <nmbd-pid>\fP)\&. This is to allow transient
problems to be diagnosed, whilst still running at a normally low log
level\&.
.PP 
.SH "VERSION" 
.PP 
This man page is correct for version 2\&.0 of the Samba suite\&.
.PP 
.SH "SEE ALSO" 
.PP 
\fBinetd (8)\fP, \fBsmbd (8)\fP, \fBsmb\&.conf
(5)\fP, \fBsmbclient (1)\fP,
\fBtestparm (1)\fP, \fBtestprns
(1)\fP, and the Internet RFC\'s \fBrfc1001\&.txt\fP,
\fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) specification is
available as a link from the Web page :
http://samba\&.org/cifs/\&.
.PP 
.SH "AUTHOR" 
.PP 
The original Samba software and related utilities were created by
Andrew Tridgell samba@samba\&.org\&. Samba is now developed
by the Samba Team as an Open Source project similar to the way the
Linux kernel is developed\&.
.PP 
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
\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
and updated for the Samba2\&.0 release by Jeremy Allison\&.
samba@samba\&.org\&.
.PP 
See \fBsamba (7)\fP to find out how to get a full
list of contributors and details on how to submit bug reports,
comments etc\&.