docs/manpages/nmbd.8

   1 .TH "nmbd" "8" "23 Oct 1998" "Samba" "SAMBA"
   2 .PP
   3 .SH "NAME"
   4 nmbd \- NetBIOS name server to provide NetBIOS over IP
   5 naming services to clients
   6 .PP
   7 .SH "SYNOPSIS"
   8 .PP
   9 \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]
  10 .PP
  11 .SH "DESCRIPTION"
  12 .PP
  13 This program is part of the \fBSamba\fP suite\&.
  14 .PP
  15 \fBnmbd\fP is a server that understands and can reply to NetBIOS over IP
  16 name service requests, like those produced by SMBD/CIFS clients such
  17 as Windows 95/98, Windows NT and LanManager clients\&. It also
  18 participates in the browsing protocols which make up the Windows
  19 "Network Neighborhood" view\&.
  20 .PP
  21 SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
  22 server\&. That is, they wish to know what IP number a specified host is
  23 using\&.
  24 .PP
  25 Amongst other services, this program will listen for such requests,
  26 and if its own NetBIOS name is specified it will respond with the IP
  27 number of the host it is running on\&.  Its "own NetBIOS name" is by
  28 default the primary DNS name of the host it is running on, but this
  29 can be overriden with the \fB-n\fP option (see \fIOPTIONS\fP below)\&. Thus
  30 nmbd will reply to broadcast queries for its own name(s)\&. Additional
  31 names for nmbd to respond on can be set via parameters in the
  32 \fBsmb\&.conf (5)\fP configuration file\&.
  33 .PP
  34 nmbd can also be used as a WINS (Windows Internet Name Server)
  35 server\&. What this basically means is that it will act as a WINS
  36 database server, creating a database from name registration requests
  37 that it receives and replying to queries from clients for these names\&.
  38 .PP
  39 In addition, nmbd can act as a WINS proxy, relaying broadcast queries
  40 from clients that do not understand how to talk the WINS protocol to a
  41 WIN server\&.
  42 .PP
  43 .SH "OPTIONS"
  44 .PP
  45 .IP
  46 .IP "\fB-D\fP"
  47 If specified, this parameter causes the server to operate
  48 as a daemon\&. That is, it detaches itself and runs in the background,
  49 fielding requests on the appropriate port\&. By default, the server will
  50 NOT operate as a daemon\&. nmbd can also be operated from the inetd
  51 meta-daemon, although this is not recommended\&.
  52 .IP
  53 .IP "\fB-a\fP"
  54 If this parameter is specified, each new connection will
  55 append log messages to the log file\&.  This is the default\&.
  56 .IP
  57 .IP "\fB-o\fP"
  58 If this parameter is specified, the log files will be
  59 overwritten when opened\&.  By default, the log files will be appended
  60 to\&.
  61 .IP
  62 .IP "\fB-H filename\fP"
  63 NetBIOS lmhosts file\&.
  64 .IP
  65 The lmhosts file is a list of NetBIOS names to IP addresses that is
  66 loaded by the nmbd server and used via the name resolution mechanism
  67 \fIname resolve order\fP described in \fBsmbd\&.conf (5)\fP to resolve any
  68 NetBIOS name queries needed by the server\&. Note that the contents of
  69 this file are \fINOT\fP used by nmbd to answer any name queries, adding
  70 a line to this file affects name NetBIOS resolution from this host
  71 \fIONLY\fP\&.
  72 .IP
  73 The default path to this file is compiled into Samba as part of the
  74 build process\&. Common defaults are \fI/usr/local/samba/lib/lmhosts\fP,
  75 \fI/usr/samba/lib/lmhosts\fP or \fI/etc/lmhosts\fP\&. See the \fBlmhosts
  76 (5)\fP man page for details on the contents of this file\&.
  77 .IP
  78 .IP "\fB-d debuglevel\fP"
  79 debuglevel is an integer from 0 to 10\&.
  80 .IP
  81 The default value if this parameter is not specified is zero\&.
  82 .IP
  83 The higher this value, the more detail will be logged to the log files
  84 about the activities of the server\&. At level 0, only critical errors
  85 and serious warnings will be logged\&. Level 1 is a reasonable level for
  86 day to day running - it generates a small amount of information about
  87 operations carried out\&.
  88 .IP
  89 Levels above 1 will generate considerable amounts of log data, and
  90 should only be used when investigating a problem\&. Levels above 3 are
  91 designed for use only by developers and generate HUGE amounts of log
  92 data, most of which is extremely cryptic\&.
  93 .IP
  94 Note that specifying this parameter here will override the \fBlog
  95 level\fP parameter in the \fBsmb\&.conf
  96 (5)\fP file\&.
  97 .IP
  98 .IP "\fB-l logfile\fP"
  99 The \fB-l\fP parameter specifies a path and base
 100 filename into which operational data from the running nmbd server will
 101 be logged\&.  The actual log file name is generated by appending the
 102 extension "\&.nmb" to the specified base name\&.  For example, if the name
 103 specified was "log" then the file log\&.nmb would contain the debugging
 104 data\&.
 105 .IP
 106 The default log file path is is compiled into Samba as part of the
 107 build process\&. Common defaults are \fI/usr/local/samba/var/log\&.nmb\fP,
 108 \fI/usr/samba/var/log\&.nmb\fP or \fI/var/log/log\&.nmb\fP\&.
 109 .IP
 110 .IP "\fB-n primary NetBIOS name\fP"
 111 This option allows you to override
 112 the NetBIOS name that Samba uses for itself\&. This is identical to
 113 setting the \fBNetBIOS name\fP parameter
 114 in the \fBsmb\&.conf\fP file
 115 but will override the setting in the \fBsmb\&.conf\fP file\&.
 116 .IP
 117 .IP "\fB-p UDP port number\fP"
 118 UDP port number is a positive integer value\&.
 119 .IP
 120 This option changes the default UDP port number (normally 137) that
 121 nmbd responds to name queries on\&. Don\'t use this option unless you are
 122 an expert, in which case you won\'t need help!
 123 .IP
 124 .IP "\fB-s configuration file\fP"
 125 The default configuration file name is
 126 set at build time, typically as \fI/usr/local/samba/lib/smb\&.conf\fP, but
 127 this may be changed when Samba is autoconfigured\&.
 128 .IP
 129 The file specified contains the configuration details required by the
 130 server\&. See \fBsmb\&.conf (5)\fP for more information\&.
 131 .IP
 132 .IP "\fB-i scope\fP"
 133 This specifies a NetBIOS scope that the server will use
 134 to communicate with when generating NetBIOS names\&. For details on the
 135 use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes
 136 are \fIvery\fP rarely used, only set this parameter if you are the
 137 system administrator in charge of all the NetBIOS systems you
 138 communicate with\&.
 139 .IP
 140 .IP "\fB-h\fP"
 141 Prints the help information (usage) for nmbd\&.
 142 .IP
 143 .PP
 144 .SH "FILES"
 145 .PP
 146 \fB/etc/inetd\&.conf\fP
 147 .PP
 148 If the server is to be run by the inetd meta-daemon, this file must
 149 contain suitable startup information for the meta-daemon\&.
 150 .PP
 151 \fB/etc/rc\fP
 152 .PP
 153 (or whatever initialisation script your system uses)\&.
 154 .PP
 155 If running the server as a daemon at startup, this file will need to
 156 contain an appropriate startup sequence for the server\&.
 157 .PP
 158 \fB/usr/local/samba/lib/smb\&.conf\fP
 159 .PP
 160 This is the default location of the \fIsmb\&.conf\fP server configuration
 161 file\&. Other common places that systems install this file are
 162 \fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&.
 163 .PP
 164 When run as a \fBWINS\fP server (see the \fBwins support\fP
 165 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
 166 store the WINS database in the file \f(CWwins\&.dat\fP in the \f(CWvar/locks\fP directory
 167 configured under wherever Samba was configured to install itself\&.
 168 .PP
 169 If \fBnmbd\fP is acting as a \fBbrowse master\fP (see the \fBlocal master\fP
 170 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
 171 store the browsing database in the file \f(CWbrowse\&.dat\fP in the \f(CWvar/locks\fP directory
 172 configured under wherever Samba was configured to install itself\&.
 173 .PP
 174 .SH "SIGNALS"
 175 .PP
 176 To shut down an nmbd process it is recommended that SIGKILL (-9)
 177 \fINOT\fP be used, except as a last resort, as this may leave the name
 178 database in an inconsistant state\&. The correct way to terminate
 179 nmbd is to send it a SIGTERM (-15) signal and wait for it to die on
 180 its own\&.
 181 .PP
 182 nmbd will accept SIGHUP, which will cause it to dump out it\'s
 183 namelists into the file namelist\&.debug in the
 184 \fI/usr/local/samba/var/locks\fP directory (or the \fIvar/locks\fP
 185 directory configured under wherever Samba was configured to install
 186 itself)\&. This will also cause nmbd to dump out it\'s server database in
 187 the log\&.nmb file\&. In addition, the the debug log level of nmbd may be raised
 188 by sending it a SIGUSR1 (\f(CWkill -USR1 <nmbd-pid>\fP) and lowered by sending it a
 189 SIGUSR2 (\f(CWkill -USR2 <nmbd-pid>\fP)\&. This is to allow transient
 190 problems to be diagnosed, whilst still running at a normally low log
 191 level\&.
 192 .PP
 193 .SH "VERSION"
 194 .PP
 195 This man page is correct for version 2\&.0 of the Samba suite\&.
 196 .PP
 197 .SH "SEE ALSO"
 198 .PP
 199 \fBinetd (8)\fP, \fBsmbd (8)\fP, \fBsmb\&.conf
 200 (5)\fP, \fBsmbclient (1)\fP,
 201 \fBtestparm (1)\fP, \fBtestprns
 202 (1)\fP, and the Internet RFC\'s \fBrfc1001\&.txt\fP,
 203 \fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) specification is
 204 available as a link from the Web page :
 205 http://samba\&.anu\&.edu\&.au/cifs/\&.
 206 .PP
 207 .SH "AUTHOR"
 208 .PP
 209 The original Samba software and related utilities were created by
 210 Andrew Tridgell (samba-bugs@samba\&.anu\&.edu\&.au)\&. Samba is now developed
 211 by the Samba Team as an Open Source project similar to the way the
 212 Linux kernel is developed\&.
 213 .PP
 214 The original Samba man pages were written by Karl Auer\&. The man page
 215 sources were converted to YODL format (another excellent piece of Open
 216 Source software) and updated for the Samba2\&.0 release by Jeremy
 217 Allison, \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
 218 .PP
 219 See \fBsamba (7)\fP to find out how to get a full list of contributors
 220 and details on how to submit bug reports, comments etc\&.