global change from samba.anu.edu.au to samba.org
[samba.git] / docs / yodldocs / nmbd.8.yo
index 6cd9a12522bc18ce02db4026988a4b26d202a11b..bf9a5f8b78cc4ccc945c7acb7f9ead269d42640b 100644 (file)
@@ -1,4 +1,4 @@
-mailto(samba-bugs@samba.anu.edu.au
+mailto(samba-bugs@samba.org
 
 manpage(nmbd)(8)(23 Oct 1998)(Samba)(SAMBA)
 
@@ -9,7 +9,7 @@ naming services to clients)
 label(SYNOPSIS)
 manpagesynopsis()
 
-bf(nmbd) [-D] [-o] [-a] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file] [-i NetBIOS scope] [-h]
+bf(nmbd) [link(-D)(minusD)] [link(-o)(minuso)] [link(-a)(minusa)] [link(-H lmhosts file)(minusH)] [link(-d debuglevel)(minusd)] [link(-l log file basename)(minusl)] [link(-n primary NetBIOS name)(minusn)] [link(-p port number)(minusp)] [link(-s configuration file)(minuss)] [link(-i NetBIOS scope)(minusi)] [link(-h)(minush)]
 
 label(DESCRIPTION)
 manpagedescription()
@@ -26,21 +26,21 @@ 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.
 
-Amongst other services, this program will listen for such requests,
+Amongst other services, bf(nmbd) 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 overriden with the bf(-n) option (see em(OPTIONS) below). Thus
-nmbd will reply to broadcast queries for its own name(s). Additional
-names for nmbd to respond on can be set via parameters in the
-bf(smb.conf (5)) configuration file.
+can be overridden with the bf(-n) option (see link(OPTIONS)(OPTIONS) below). Thus
+bf(nmbd) will reply to broadcast queries for its own name(s). Additional
+names for bf(nmbd) to respond on can be set via parameters in the
+url(bf(smb.conf(5)))(smb.conf.5.html) configuration file.
 
-nmbd can also be used as a WINS (Windows Internet Name Server)
+bf(nmbd) 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.
 
-In addition, nmbd can act as a WINS proxy, relaying broadcast queries
+In addition, bf(nmbd) 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.
 
@@ -49,34 +49,40 @@ manpageoptions()
 
 startdit()
 
-dit(bf(-D)) If specified, this parameter causes the server to operate
+label(minusD)
+dit(bf(-D)) If specified, this parameter causes bf(nmbd) to operate
 as a daemon. That is, it detaches itself and runs in the background,
-fielding requests on the appropriate port. By default, the server will
+fielding requests on the appropriate port. By default, bf(nmbd) will
 NOT operate as a daemon. nmbd can also be operated from the inetd
 meta-daemon, although this is not recommended.
 
+label(minusa)
 dit(bf(-a)) If this parameter is specified, each new connection will
 append log messages to the log file.  This is the default.
 
+label(minuso)
 dit(bf(-o)) If this parameter is specified, the log files will be
 overwritten when opened.  By default, the log files will be appended
 to.
 
+label(minusH)
 dit(bf(-H filename)) NetBIOS lmhosts file.
 
 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
-em(name resolve order) described in bf(smbd.conf (5)) to resolve any
+url(bf(name resolve order))(smb.conf.5.html#nameresolveorder) described in 
+url(bf(smb.conf (5)))(smb.conf.5.html) to resolve any
 NetBIOS name queries needed by the server. Note that the contents of
-this file are em(NOT) used by nmbd to answer any name queries, adding
+this file are em(NOT) used by bf(nmbd) to answer any name queries. Adding
 a line to this file affects name NetBIOS resolution from this host
 em(ONLY).
 
 The default path to this file is compiled into Samba as part of the
 build process. Common defaults are em(/usr/local/samba/lib/lmhosts),
-em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the bf(lmhosts
-(5)) man page for details on the contents of this file.
+em(/usr/samba/lib/lmhosts) or em(/etc/lmhosts). See the 
+url(bf(lmhosts (5)))(lmhosts.5.html) man page for details on the contents of this file.
 
+label(minusd)
 dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10.
 
 The default value if this parameter is not specified is zero.
@@ -92,6 +98,11 @@ 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.
 
+Note that specifying this parameter here will override the url(bf(log
+level))(smb.conf.5.html#loglevel) parameter in the url(bf(smb.conf
+(5)))(smb.conf.5.html) file.
+
+label(minusl)
 dit(bf(-l logfile)) The bf(-l) 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
@@ -99,36 +110,42 @@ 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.
 
-The default log file path is is compiled into Samba as part of the
+The default log file path is compiled into Samba as part of the
 build process. Common defaults are em(/usr/local/samba/var/log.nmb),
 em(/usr/samba/var/log.nmb) or em(/var/log/log.nmb).
 
+label(minusn)
 dit(bf(-n primary NetBIOS name)) This option allows you to override
 the NetBIOS name that Samba uses for itself. This is identical to
-setting the bf(NetBIOS name) parameter in the smb.conf file
-but will override the setting in the smb.conf file.
+setting the url(bf(NetBIOS name))(smb.conf.5.html#netbiosname) parameter
+in the url(bf(smb.conf))(smb.conf.5.html) file
+but will override the setting in the url(bf(smb.conf))(smb.conf.5.html) file.
 
+label(minusp)
 dit(bf(-p UDP port number)) UDP port number is a positive integer value.
 
 This option changes the default UDP port number (normally 137) that
-nmbd responds to name queries on. Don't use this option unless you are
+bf(nmbd) responds to name queries on. Don't use this option unless you are
 an expert, in which case you won't need help!
 
+label(minuss)
 dit(bf(-s configuration file)) The default configuration file name is
 set at build time, typically as em(/usr/local/samba/lib/smb.conf), but
 this may be changed when Samba is autoconfigured.
 
 The file specified contains the configuration details required by the
-server.  See bf(smb.conf (5)) for more information.
+server. See url(bf(smb.conf (5)))(smb.conf.5.html) for more information.
 
-dit(bf(-i scope)) This specifies a NetBIOS scope that the server will use
+label(minusi)
+dit(bf(-i scope)) This specifies a NetBIOS scope that bf(nmbd) 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 em(very) rarely used, only set this parameter if you are the
 system administrator in charge of all the NetBIOS systems you
 communicate with.
 
-dit(bf(-h)) Prints the help information (usage) for nmbd.
+label(minush)
+dit(bf(-h)) Prints the help information (usage) for bf(nmbd).
 
 endit()
 
@@ -142,28 +159,44 @@ contain suitable startup information for the meta-daemon.
 
 bf(/etc/rc)
 
-(or whatever initialisation script your system uses).
+(or whatever initialization script your system uses).
 
 If running the server as a daemon at startup, this file will need to
 contain an appropriate startup sequence for the server.
 
 bf(/usr/local/samba/lib/smb.conf)
 
-This is the default location of the em(smb.conf) server configuration
+This is the default location of the 
+url(bf(smb.conf))(smb.conf.5.html) server configuration
 file. Other common places that systems install this file are
 em(/usr/samba/lib/smb.conf) and em(/etc/smb.conf).
 
+When run as a bf(WINS) server (see the url(bf(wins support))(smb.conf.5.html#winssupport)
+parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
+store the WINS database in the file tt(wins.dat) in the tt(var/locks) directory
+configured under wherever Samba was configured to install itself.
+
+If bf(nmbd) is acting as a bf(browse master) (see the url(bf(local master))(smb.conf.5.html#localmaster)
+parameter in the url(bf(smb.conf (5)))(smb.conf.5.html) man page), bf(nmbd) will
+store the browsing database in the file tt(browse.dat) in the tt(var/locks) directory
+configured under wherever Samba was configured to install itself.
+
 label(SIGNALS)
 manpagesection(SIGNALS)
 
-nmbd will accept SIGHUP, which will cause it to dump out it's
-namelists into the file namelist.debug in the
+To shut down an bf(nmbd) process it is recommended that SIGKILL (-9)
+em(NOT) be used, except as a last resort, as this may leave the name
+database in an inconsistent state. The correct way to terminate
+bf(nmbd) is to send it a SIGTERM (-15) signal and wait for it to die on
+its own.
+
+bf(nmbd) will accept SIGHUP, which will cause it to dump out it's
+namelists into the file tt(namelist.debug) in the
 em(/usr/local/samba/var/locks) directory (or the em(var/locks)
 directory configured under wherever Samba was configured to install
-itself). This will also cause nmbd to dump out it's server database in
-the log.nmb file.  Also new in version 1.9.18 and above is the ability
-to raise the debug log level of nmbd by sending it a SIGUSR1 (tt(kill
--USR1 <nmbd-pid>)) and to lower the nmbd log level by sending it a
+itself). This will also cause bf(nmbd) 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 (tt(kill -USR1 <nmbd-pid>)) and lowered by sending it a
 SIGUSR2 (tt(kill -USR2 <nmbd-pid>)). This is to allow transient
 problems to be diagnosed, whilst still running at a normally low log
 level.
@@ -171,12 +204,7 @@ level.
 label(VERSION)
 manpagesection(VERSION)
 
-This man page is (mostly) correct for version 2.0 of the Samba suite,
-plus some of the recent patches to it. These notes will necessarily
-lag behind development of the software, so it is possible that your
-version of the server has extensions or parameter semantics that
-differ from or are not covered by this man page. Please notify these
-to the address below for rectification.
+This man page is correct for version 2.0 of the Samba suite.
 
 label(SEEALSO)
 manpageseealso()
@@ -187,20 +215,23 @@ url(bf(testparm (1)))(testparm.1.html), url(bf(testprns
 (1)))(testprns.1.html), and the Internet RFC's bf(rfc1001.txt),
 bf(rfc1002.txt). In addition the CIFS (formerly SMB) specification is
 available as a link from the Web page :
-url(http://samba.anu.edu.au/cifs/)(http://samba.anu.edu.au/cifs/).
+url(http://samba.org/cifs/)(http://samba.org/cifs/).
 
 label(AUTHOR)
 manpageauthor()
 
 The original Samba software and related utilities were created by
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Samba is now developed
+Andrew Tridgell email(samba-bugs@samba.org). Samba is now developed
 by the Samba Team as an Open Source project similar to the way the
 Linux kernel is developed.
 
 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) and updated for the Samba2.0 release by Jeremy
-Allison, email(samba-bugs@samba.anu.edu.au).
-
-See url(bf(samba (7)))(samba.7.html) to find out how to get a full list of contributors
-and details on how to submit bug reports, comments etc.
+Source software, available at
+url(bf(ftp://ftp.icce.rug.nl/pub/unix/))(ftp://ftp.icce.rug.nl/pub/unix/))
+and updated for the Samba2.0 release by Jeremy Allison.
+email(samba-bugs@samba.org).
+
+See url(bf(samba (7)))(samba.7.html) to find out how to get a full
+list of contributors and details on how to submit bug reports,
+comments etc.