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, \fBnmbd\fP 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 overridden with the \fB-n\fP option (see OPTIONS below)\&. Thus
  30 \fBnmbd\fP will reply to broadcast queries for its own name(s)\&. Additional
  31 names for \fBnmbd\fP to respond on can be set via parameters in the
  32 \fBsmb\&.conf(5)\fP configuration file\&.
  33 .PP
  34 \fBnmbd\fP 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, \fBnmbd\fP 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 \fBnmbd\fP 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, \fBnmbd\fP 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 \fBname resolve order\fP described in
  68 \fBsmb\&.conf (5)\fP to resolve any
  69 NetBIOS name queries needed by the server\&. Note that the contents of
  70 this file are \fINOT\fP used by \fBnmbd\fP to answer any name queries\&. Adding
  71 a line to this file affects name NetBIOS resolution from this host
  72 \fIONLY\fP\&.
  73 .IP
  74 The default path to this file is compiled into Samba as part of the
  75 build process\&. Common defaults are \fI/usr/local/samba/lib/lmhosts\fP,
  76 \fI/usr/samba/lib/lmhosts\fP or \fI/etc/lmhosts\fP\&. See the
  77 \fBlmhosts (5)\fP man page for details on the contents of this file\&.
  78 .IP
  79 .IP "\fB-d debuglevel\fP"
  80 debuglevel is an integer from 0 to 10\&.
  81 .IP
  82 The default value if this parameter is not specified is zero\&.
  83 .IP
  84 The higher this value, the more detail will be logged to the log files
  85 about the activities of the server\&. At level 0, only critical errors
  86 and serious warnings will be logged\&. Level 1 is a reasonable level for
  87 day to day running - it generates a small amount of information about
  88 operations carried out\&.
  89 .IP
  90 Levels above 1 will generate considerable amounts of log data, and
  91 should only be used when investigating a problem\&. Levels above 3 are
  92 designed for use only by developers and generate HUGE amounts of log
  93 data, most of which is extremely cryptic\&.
  94 .IP
  95 Note that specifying this parameter here will override the \fBlog
  96 level\fP parameter in the \fBsmb\&.conf
  97 (5)\fP file\&.
  98 .IP
  99 .IP "\fB-l logfile\fP"
 100 The \fB-l\fP parameter specifies a path and base
 101 filename into which operational data from the running nmbd server will
 102 be logged\&.  The actual log file name is generated by appending the
 103 extension "\&.nmb" to the specified base name\&.  For example, if the name
 104 specified was "log" then the file log\&.nmb would contain the debugging
 105 data\&.
 106 .IP
 107 The default log file path is compiled into Samba as part of the
 108 build process\&. Common defaults are \fI/usr/local/samba/var/log\&.nmb\fP,
 109 \fI/usr/samba/var/log\&.nmb\fP or \fI/var/log/log\&.nmb\fP\&.
 110 .IP
 111 .IP "\fB-n primary NetBIOS name\fP"
 112 This option allows you to override
 113 the NetBIOS name that Samba uses for itself\&. This is identical to
 114 setting the \fBNetBIOS name\fP parameter
 115 in the \fBsmb\&.conf\fP file
 116 but will override the setting in the \fBsmb\&.conf\fP file\&.
 117 .IP
 118 .IP "\fB-p UDP port number\fP"
 119 UDP port number is a positive integer value\&.
 120 .IP
 121 This option changes the default UDP port number (normally 137) that
 122 \fBnmbd\fP responds to name queries on\&. Don\'t use this option unless you are
 123 an expert, in which case you won\'t need help!
 124 .IP
 125 .IP "\fB-s configuration file\fP"
 126 The default configuration file name is
 127 set at build time, typically as \fI/usr/local/samba/lib/smb\&.conf\fP, but
 128 this may be changed when Samba is autoconfigured\&.
 129 .IP
 130 The file specified contains the configuration details required by the
 131 server\&. See \fBsmb\&.conf (5)\fP for more information\&.
 132 .IP
 133 .IP "\fB-i scope\fP"
 134 This specifies a NetBIOS scope that \fBnmbd\fP will use
 135 to communicate with when generating NetBIOS names\&. For details on the
 136 use of NetBIOS scopes, see rfc1001\&.txt and rfc1002\&.txt\&. NetBIOS scopes
 137 are \fIvery\fP rarely used, only set this parameter if you are the
 138 system administrator in charge of all the NetBIOS systems you
 139 communicate with\&.
 140 .IP
 141 .IP "\fB-h\fP"
 142 Prints the help information (usage) for \fBnmbd\fP\&.
 143 .IP
 144 .PP
 145 .SH "FILES"
 146 .PP
 147 \fB/etc/inetd\&.conf\fP
 148 .PP
 149 If the server is to be run by the inetd meta-daemon, this file must
 150 contain suitable startup information for the meta-daemon\&.
 151 .PP
 152 \fB/etc/rc\fP
 153 .PP
 154 (or whatever initialization script your system uses)\&.
 155 .PP
 156 If running the server as a daemon at startup, this file will need to
 157 contain an appropriate startup sequence for the server\&.
 158 .PP
 159 \fB/usr/local/samba/lib/smb\&.conf\fP
 160 .PP
 161 This is the default location of the
 162 \fBsmb\&.conf\fP server configuration
 163 file\&. Other common places that systems install this file are
 164 \fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&.
 165 .PP
 166 When run as a \fBWINS\fP server (see the \fBwins support\fP
 167 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
 168 store the WINS database in the file \f(CWwins\&.dat\fP in the \f(CWvar/locks\fP directory
 169 configured under wherever Samba was configured to install itself\&.
 170 .PP
 171 If \fBnmbd\fP is acting as a \fBbrowse master\fP (see the \fBlocal master\fP
 172 parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will
 173 store the browsing database in the file \f(CWbrowse\&.dat\fP in the \f(CWvar/locks\fP directory
 174 configured under wherever Samba was configured to install itself\&.
 175 .PP
 176 .SH "SIGNALS"
 177 .PP
 178 To shut down an \fBnmbd\fP process it is recommended that SIGKILL (-9)
 179 \fINOT\fP be used, except as a last resort, as this may leave the name
 180 database in an inconsistent state\&. The correct way to terminate
 181 \fBnmbd\fP is to send it a SIGTERM (-15) signal and wait for it to die on
 182 its own\&.
 183 .PP
 184 \fBnmbd\fP will accept SIGHUP, which will cause it to dump out it\'s
 185 namelists into the file \f(CWnamelist\&.debug\fP in the
 186 \fI/usr/local/samba/var/locks\fP directory (or the \fIvar/locks\fP
 187 directory configured under wherever Samba was configured to install
 188 itself)\&. This will also cause \fBnmbd\fP to dump out it\'s server database in
 189 the log\&.nmb file\&. In addition, the debug log level of nmbd may be raised
 190 by sending it a SIGUSR1 (\f(CWkill -USR1 <nmbd-pid>\fP) and lowered by sending it a
 191 SIGUSR2 (\f(CWkill -USR2 <nmbd-pid>\fP)\&. This is to allow transient
 192 problems to be diagnosed, whilst still running at a normally low log
 193 level\&.
 194 .PP
 195 .SH "VERSION"
 196 .PP
 197 This man page is correct for version 2\&.0 of the Samba suite\&.
 198 .PP
 199 .SH "SEE ALSO"
 200 .PP
 201 \fBinetd (8)\fP, \fBsmbd (8)\fP, \fBsmb\&.conf
 202 (5)\fP, \fBsmbclient (1)\fP,
 203 \fBtestparm (1)\fP, \fBtestprns
 204 (1)\fP, and the Internet RFC\'s \fBrfc1001\&.txt\fP,
 205 \fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) specification is
 206 available as a link from the Web page :
 207 http://samba\&.org/cifs/\&.
 208 .PP
 209 .SH "AUTHOR"
 210 .PP
 211 The original Samba software and related utilities were created by
 212 Andrew Tridgell \fIsamba-bugs@samba\&.org\fP\&. Samba is now developed
 213 by the Samba Team as an Open Source project similar to the way the
 214 Linux kernel is developed\&.
 215 .PP
 216 The original Samba man pages were written by Karl Auer\&. The man page
 217 sources were converted to YODL format (another excellent piece of Open
 218 Source software, available at
 219 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
 220 and updated for the Samba2\&.0 release by Jeremy Allison\&.
 221 \fIsamba-bugs@samba\&.org\fP\&.
 222 .PP
 223 See \fBsamba (7)\fP to find out how to get a full
 224 list of contributors and details on how to submit bug reports,
 225 comments etc\&.