First versions of the man pages auto-generated from the YODL

source.
Jeremy.
(This used to be commit 00241b15fa8ccd21e1b43726ea131a189c14074e)

1 files changed, 220 insertions, 256 deletions

diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8
index 0922982f00..57ded0c54b 100644
--- a/docs/manpages/nmbd.8
+++ b/docs/manpages/nmbd.8
@@ -1,256 +1,220 @@
-.TH NMBD 8 "09 Oct 1998" "nmbd 2.0.0-alpha11"
-.SH NAME
-nmbd \- provide netbios nameserver support to clients
-.SH SYNOPSIS
-.B nmbd
-[
-.B \-D
-] [
-.B \-H
-.I netbios hosts file
-] [
-.B \-d
-.I debuglevel
-] [
-.B \-l
-.I log basename
-] [
-.B \-n
-.I netbios name
-] [
-.B \-p
-.I port number
-] [
-.B \-s
-.I configuration file
-]
-.SH DESCRIPTION
-This program is part of the Samba suite.
-
-.B nmbd
-is a server that understands and can reply to netbios
-name service requests, like those produced by LanManager
-clients. It also controls browsing.
-
-LanManager clients, when they start up, may wish to locate a LanManager server.
-That is, they wish to know what IP number a specified host is using.
-
-This program simply listens for such requests, and if its own name is specified
-it will respond with the IP number of the host it is running on.
-Its "own name" is by default the name of the host it is running on,
-but this can be overriden with the
-.B \-n
-option (see "OPTIONS" below).
-
-.B nmbd 
-can also be used as a WINS (Windows Internet Name Server) server. 
-What this basically means is that it will respond to all name requests that 
-it receives that are not broadcasts, as long as it can resolve the name.
-Resolvable names include all names in the netbios hosts file (if any, see 
-.B \-H
-below), its own name, and any other names that it may have learned about
-from other browsers on the network.
-A change to previous versions is that nmbd will now no longer
-do this automatically by default.
-.SH OPTIONS
-.B \-B
-
-.RS 3
-This option is obsolete. Please use the "interfaces" option in smb.conf instead.
-.RE
-
-.B \-I
-
-.RS 3
-This option is obsolete. Please use the "interfaces" option in smb.conf instead.
-.RE
-
-.B \-D
-
-.RS 3
-If specified, this parameter causes the server 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 NOT operate as a daemon.
-.RE
-
-.B \-C comment string
-
-.RS 3
-This option is obsolete. Please use the "server string" option in smb.conf 
-instead.
-.RE
-
-.B \-G
-
-.RS 3
-This option is obsolete. Please use the "workgroup" option in smb.conf instead.
-.RE
-
-.B \-H
-.I netbios hosts file
-
-.RS 3
-It may be useful in some situations to be able to specify a list of
-netbios names for which the server should send a reply if queried.  
-This option allows you to specify a file containing such a list. 
-The syntax of the hosts file is similar to the standard /etc/hosts file
-format, but has some extensions.
-
-The file contains three columns. Lines beginning with a # are ignored
-as comments. The first column is an IP address, or a hostname. If it
-is a hostname then it is interpreted as the IP address returned by
-gethostbyname() when read. An IP address of 0.0.0.0 will be
-interpreted as the server's own IP address.
-
-The second column is a netbios name. This is the name that the server
-will respond to. It must be less than 20 characters long.
-
-The third column is optional, and is intended for flags. Currently the
-only flag supported is M, which means that this name is the default 
-netbios name for this machine. This has the same effect as specifying the
-.B \-n
-option to
-.BR nmbd .
-
-NOTE: The G and S flags are now obsolete and are replaced by the
-"interfaces" and "remote announce" options in smb.conf.
-
-The default hosts file name is set at compile time, typically as
-.I /etc/lmhosts,
-but this may be changed in the Samba Makefile.
-
-After startup the server waits for queries, and will answer queries for
-any name known to it. This includes all names in the netbios hosts file, 
-its own name, and any other names it may have learned about from other 
-browsers on the network.
-
-The primary intention of the
-.B \-H
-option is to allow a mapping from netbios names to internet domain names.
-
-.B Example:
-
-        # This is a sample netbios hosts file
-
-        # DO NOT USE THIS FILE AS-IS
-        # YOU MAY INCONVENIENCE THE OWNERS OF THESE IPs
-        # if you want to include a name with a space in it then 
-        # use double quotes.
-
-        # next add a netbios alias for a faraway host
-        arvidsjaur.anu.edu.au ARVIDSJAUR
-
-        # finally put in an IP for a hard to find host
-        130.45.3.213 FREDDY
-
-.RE
-.B \-N
-
-.RS 3
-This option is obsolete. Please use the "interfaces" option in smb.conf instead.
-.RE
-
-.B \-d
-.I debuglevel
-
-.RS 3
-This option sets the debug level. See
-.BR smb.conf (5).
-.RE
-
-.B \-l
-.I log file
-
-.RS 3
-The
-.I log file
-parameter specifies a path and base filename into which operational data 
-from the running 
-.B 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.
-
-The default log file is specified at compile time, typically as
-.I /var/log/log.nmb.
-.RE
-
-.B \-n
-.I netbios name
-
-.RS 3
-This option allows you to override the Netbios name that Samba uses for itself. 
-.RE
-
-.B \-a
-
-.RS 3
-If this parameter is specified, the log files will be appended to with each 
-new connection.  This is the default.
-.RE
-
-.B \-o
-
-.RS 3
-Overwrite existing log files instead of appending to them.  (This was the
-default until version 2.0.0.)
-.RE
-
-.B \-p
-.I port number
-.RS 3
-
-port number is a positive integer value.
-
-Don't use this option unless you are an expert, in which case you
-won't need help!
-.RE
-
-.B \-s
-.I configuration file
-
-.RS 3
-The default configuration file name is set at compile time, typically as
-.I /etc/smb.conf,
-but this may be changed in the Samba Makefile.
-
-The file specified contains the configuration details required by the server.
-See
-.BR smb.conf (5)
-for more information.
-.RE
-.SH SIGNALS
-
-In version 1.9.18 and above, nmbd will accept SIGHUP, which will cause it to dump out
-it's namelists into the file namelist.debug in the SAMBA/var/locks directory. 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 (kill -USR1 <nmbd-pid>) and to lower
-the nmbd log level by sending it a SIGUSR2 (kill -USR2 <nmbd-pid>). This
-is to allow transient problems to be diagnosed, whilst still running at
-a normally low log level.
-
-.SH VERSION
-
-This man page is (mostly) correct for version 1.9.16 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.
-.SH SEE ALSO
-.BR inetd (8),
-.BR smbd (8), 
-.BR smb.conf (5),
-.BR smbclient (1),
-.BR testparm (1), 
-.BR testprns (1)
-.SH CREDITS
-The original Samba software and related utilities were created by 
-Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
-of the Source for this project.
-
+.TH "nmbd" "8" "23 Oct 1998" "Samba" "SAMBA" 
+.PP 
+.SH "NAME" 
+nmbd \- NetBIOS name server to provide NetBIOS over IP
+naming services to clients
+.PP 
+.SH "SYNOPSIS" 
+.PP 
+\fBnmbd\fP [-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]
+.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, this program 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 \fB-n\fP option (see \fIOPTIONS\fP 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
+\fBsmb\&.conf (5)\fP configuration file\&.
+.PP 
+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\&.
+.PP 
+In addition, 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\&.
+.PP 
+.SH "OPTIONS" 
+.PP 
+.IP 
+.IP "\fB-D\fP" 
+If specified, this parameter causes the server 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
+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 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
+\fIname resolve order\fP described in \fBsmbd\&.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 nmbd 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 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
+nmbd 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 
+.IP "\fB-i scope\fP" 
+This specifies a NetBIOS scope that the server 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 \fIvery\fP rarely used, only set this parameter if you are the
+system administrator in charge of all the NetBIOS systems you
+communicate with\&.
+.IP 
+.IP "\fB-h\fP" 
+Prints the help information (usage) for nmbd\&.
+.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 initialisation 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 \fIsmb\&.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 nmbd 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 inconsistant state\&. The correct way to terminate
+nmbd is to send it a SIGTERM (-15) signal and wait for it to die on
+its own\&.
+.PP 
+nmbd will accept SIGHUP, which will cause it to dump out it\'s
+namelists into the file namelist\&.debug 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 nmbd to dump out it\'s server database in
+the log\&.nmb file\&. In addition, the 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\&.anu\&.edu\&.au/cifs/\&.
+.PP 
+.SH "AUTHOR" 
+.PP 
+The original Samba software and related utilities were created by
+Andrew Tridgell (samba-bugs@samba\&.anu\&.edu\&.au)\&. 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) and updated for the Samba2\&.0 release by Jeremy
+Allison, \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
+.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\&.