This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[samba.git] / docs / manpages / nmbd.8
index 2f62b4f54933e6fce2ceefb93bdb50299d2ce52b..44a39c1730c2ab6b67a894ab521c3ae0f2c16669 100644 (file)
@@ -3,8 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "NMBD" "8" "17 April 2003" "" ""
-
+.TH "NMBD" "8" "04 March 2003" "" ""
 .SH NAME
 nmbd \- NetBIOS name server to provide NetBIOS  over IP naming services to clients
 .SH SYNOPSIS
@@ -13,7 +12,7 @@ nmbd \- NetBIOS name server to provide NetBIOS  over IP naming services to clien
 
 .SH "DESCRIPTION"
 .PP
-This program is part of the \fBSamba\fR(7) suite.
+This program is part of the Samba suite.
 .PP
 \fBnmbd\fR is a server that understands 
 and can reply to NetBIOS over IP name service requests, like 
@@ -35,7 +34,7 @@ but this can be overridden with the \fB-n\fR
 option (see OPTIONS below). Thus \fBnmbd\fR will 
 reply to broadcast queries for its own name(s). Additional
 names for \fBnmbd\fR to respond on can be set 
-via parameters in the \fBsmb.conf\fR(5) configuration file.
+via parameters in the \fI smb.conf(5)\fR configuration file.
 .PP
 \fBnmbd\fR can also be used as a WINS 
 (Windows Internet Name Server) server. What this basically means 
@@ -75,25 +74,36 @@ If specified, this parameter causes
 \fBnmbd\fR to log to standard output rather
 than a file.
 .TP
+\fB-a\fR
+If this parameter is specified, each new 
+connection will append log messages to the log file.  
+This is the default.
+.TP
 \fB-i\fR
 If this parameter is specified it causes the
 server to run "interactively", not as a daemon, even if the
 server is executed on the command line of a shell. Setting this
 parameter negates the implicit daemon mode when run from the
 command line. \fBnmbd\fR also logs to standard
-output, as if the -S parameter had been
+output, as if the \fB-S\fR parameter had been
 given. 
 .TP
-\fB-h|--help\fR
-Print a summary of command line options.
+\fB-o\fR
+If this parameter is specified, the 
+log files will be overwritten when opened.  By default, 
+\fBsmbd\fR will append entries to the log 
+files.
+.TP
+\fB-h\fR
+Prints the help information (usage) 
+for \fBnmbd\fR.
 .TP
 \fB-H <filename>\fR
 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 \fIname resolve
-order\fR described in \fBsmb.conf\fR(5) to resolve any 
-NetBIOS name queries needed by the server. Note 
+resolution mechanism   name resolve order described in  \fIsmb.conf(5)\fR
+to resolve any NetBIOS name queries needed by the server. Note 
 that the contents of this file are \fBNOT\fR 
 used by \fBnmbd\fR to answer any name queries. 
 Adding a line to this file affects name NetBIOS resolution 
@@ -103,48 +113,53 @@ 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\fR,
 \fI/usr/samba/lib/lmhosts\fR or
-\fI/etc/samba/lmhosts\fR. See the \fBlmhosts\fR(5) man page for details on the contents of this file.
+\fI/etc/lmhosts\fR. See the
+\fIlmhosts(5)\fR
+man page for details on the contents of this file.
 .TP
 \fB-V\fR
 Prints the version number for 
-\fBsmbd\fR.
+\fBnmbd\fR.
 .TP
-\fB-s <configuration file>\fR
-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 \fIsmb.conf(5)\fR for more information.
-The default configuration file name is determined at 
-compile time.
-.TP
-\fB-d|--debug=debuglevel\fR
-\fIdebuglevel\fR is an integer 
+\fB-d <debug level>\fR
+debuglevel is an integer 
 from 0 to 10.  The default value if this parameter is 
 not specified is zero.
 
-The higher this value, the more detail will be 
-logged to the log files about the activities of the 
+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.
 
-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.
+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.
 
-Note that specifying this parameter here will 
-override the log
-level file.
+Note that specifying this parameter here will override 
+the log level 
+parameter in the \fI  smb.conf(5)\fR file.
+.TP
+\fB-l <log directory>\fR
+The -l parameter specifies a directory 
+into which the "log.nmbd" log file will be created
+for operational data from the running \fBnmbd\fR
+server. The default log directory is compiled into Samba
+as part of the build process. Common defaults are \fI  /usr/local/samba/var/log.nmb\fR, \fI  /usr/samba/var/log.nmb\fR or
+\fI/var/log/log.nmb\fR.  \fBBeware:\fR
+If the directory specified does not exist, \fBnmbd\fR
+will log to the default debug log location defined at compile time.
 .TP
-\fB-l|--logfile=logbasename\fR
-File name for log/debug files. The extension
-".client" will be appended. The log file is
-never removed by the client.
+\fB-n <primary NetBIOS name>\fR
+This option allows you to override
+the NetBIOS name that Samba uses for itself. This is identical 
+to setting the   NetBIOS name parameter in the  
+\fIsmb.conf\fR file.  However, a command
+line setting will take precedence over settings in 
+\fIsmb.conf\fR.
 .TP
 \fB-p <UDP port number>\fR
 UDP port number is a positive integer value.
@@ -152,13 +167,21 @@ This option changes the default UDP port number (normally 137)
 that \fBnmbd\fR responds to name queries on. Don't
 use this option unless you are an expert, in which case you
 won't need help!
+.TP
+\fB-s <configuration file>\fR
+The default configuration file name
+is set at build time, typically as \fI  /usr/local/samba/lib/smb.conf\fR, but
+this may be changed when Samba is autoconfigured.
+
+The file specified contains the configuration details
+required by the server. See   \fIsmb.conf(5)\fR for more information.
 .SH "FILES"
 .TP
 \fB\fI/etc/inetd.conf\fB\fR
 If the server is to be run by the
 \fBinetd\fR meta-daemon, this file
 must contain suitable startup information for the
-meta-daemon. See the install document
+meta-daemon. See the UNIX_INSTALL.html document
 for details.
 .TP
 \fB\fI/etc/rc\fB\fR
@@ -167,7 +190,7 @@ system uses).
 
 If running the server as a daemon at startup,
 this file will need to contain an appropriate startup
-sequence for the server. See the "How to Install and Test SAMBA" document
+sequence for the server. See the UNIX_INSTALL.html document
 for details.
 .TP
 \fB\fI/etc/services\fB\fR
@@ -175,26 +198,27 @@ If running the server via the
 meta-daemon \fBinetd\fR, this file
 must contain a mapping of service name (e.g., netbios-ssn)
 to service port (e.g., 139) and protocol type (e.g., tcp).
-See the "How to Install and Test SAMBA"
+See the UNIX_INSTALL.html
 document for details.
 .TP
 \fB\fI/usr/local/samba/lib/smb.conf\fB\fR
-This is the default location of 
-the \fBsmb.conf\fR(5) server
-configuration file. Other common places that systems
+This is the default location of the
+\fIsmb.conf\fR
+server configuration file. Other common places that systems
 install this file are \fI/usr/samba/lib/smb.conf\fR
-and \fI/etc/samba/smb.conf\fR.
+and \fI/etc/smb.conf\fR.
 
 When run as a WINS server (see the
 wins support
-parameter in the \fBsmb.conf\fR(5) man page),
+parameter in the \fIsmb.conf(5)\fR man page),
 \fBnmbd\fR
 will store the WINS database in the file \fIwins.dat\fR
 in the \fIvar/locks\fR directory configured under
 wherever Samba was configured to install itself.
 
 If \fBnmbd\fR is acting as a \fB  browse master\fR (see the local master
-parameter in the \fBsmb.conf\fR(5) man page, \fBnmbd\fR
+parameter in the \fIsmb.conf(5)\fR man page,
+\fBnmbd\fR
 will store the browsing database in the file \fIbrowse.dat
 \fR in the \fIvar/locks\fR directory
 configured under wherever Samba was configured to install itself.
@@ -214,10 +238,10 @@ under wherever Samba was configured to install itself). This will also
 cause \fBnmbd\fR to dump out its server database in
 the \fIlog.nmb\fR file.
 .PP
-The debug log level of nmbd may be raised or lowered
-using \fBsmbcontrol\fR(1) (SIGUSR[1|2] signals
-are no longer used since Samba 2.2). This is to allow
-transient problems to be diagnosed, whilst still running 
+The debug log level of nmbd may be raised or lowered using
+\fBsmbcontrol(1)\fR
+ (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
+to allow transient problems to be diagnosed, whilst still running
 at a normally low log level.
 .SH "VERSION"
 .PP
@@ -225,8 +249,11 @@ This man page is correct for version 3.0 of
 the Samba suite.
 .SH "SEE ALSO"
 .PP
-\fBinetd\fR(8), \fBsmbd\fR(8), \fBsmb.conf\fR(5), \fBsmbclient\fR(1), \fBtestparm\fR(1), \fBtestprns\fR(1), and the Internet 
-RFC's \fIrfc1001.txt\fR, \fIrfc1002.txt\fR. 
+\fBinetd(8)\fR, \fBsmbd(8)\fR 
+\fIsmb.conf(5)\fR
+ \fBsmbclient(1)
+\fR and the Internet RFC's
+\fIrfc1001.txt\fR, \fIrfc1002.txt\fR. 
 In addition the CIFS (formerly SMB) specification is available 
 as a link from the Web page  
 http://samba.org/cifs/ <URL:http://samba.org/cifs/>.
@@ -239,7 +266,7 @@ 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  ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
+excellent piece of Open Source software, available at
+ftp://ftp.icce.rug.nl/pub/unix/ <URL: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.
+Samba 2.2 was done by Gerald Carter