docs/manpages/nmbd.8

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "NMBD" "8" "04 March 2003" "" ""
   7 .SH NAME
   8 nmbd \- NetBIOS name server to provide NetBIOS  over IP naming services to clients
   9 .SH SYNOPSIS
  10
  11 \fBnmbd\fR [ \fB-D\fR ] [ \fB-F\fR ] [ \fB-S\fR ] [ \fB-a\fR ] [ \fB-i\fR ] [ \fB-o\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-H <lmhosts file>\fR ] [ \fB-l <log directory>\fR ] [ \fB-n <primary netbios name>\fR ] [ \fB-p <port number>\fR ] [ \fB-s <configuration file>\fR ]
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 This program is part of the Samba suite.
  16 .PP
  17 \fBnmbd\fR is a server that understands
  18 and can reply to NetBIOS over IP name service requests, like
  19 those produced by SMB/CIFS clients such as Windows 95/98/ME,
  20 Windows NT, Windows 2000, Windows XP and LanManager clients. It also
  21 participates in the browsing protocols which make up the
  22 Windows "Network Neighborhood" view.
  23 .PP
  24 SMB/CIFS clients, when they start up, may wish to
  25 locate an SMB/CIFS server. That is, they wish to know what
  26 IP number a specified host is using.
  27 .PP
  28 Amongst other services, \fBnmbd\fR will
  29 listen for such requests, and if its own NetBIOS name is
  30 specified it will respond with the IP number of the host it
  31 is running on.  Its "own NetBIOS name" is by
  32 default the primary DNS name of the host it is running on,
  33 but this can be overridden with the \fB-n\fR
  34 option (see OPTIONS below). Thus \fBnmbd\fR will
  35 reply to broadcast queries for its own name(s). Additional
  36 names for \fBnmbd\fR to respond on can be set
  37 via parameters in the \fI smb.conf(5)\fR configuration file.
  38 .PP
  39 \fBnmbd\fR can also be used as a WINS
  40 (Windows Internet Name Server) server. What this basically means
  41 is that it will act as a WINS database server, creating a
  42 database from name registration requests that it receives and
  43 replying to queries from clients for these names.
  44 .PP
  45 In addition, \fBnmbd\fR can act as a WINS
  46 proxy, relaying broadcast queries from clients that do
  47 not understand how to talk the WINS protocol to a WINS
  48 server.
  49 .SH "OPTIONS"
  50 .TP
  51 \fB-D\fR
  52 If specified, this parameter causes
  53 \fBnmbd\fR to operate as a daemon. That is,
  54 it detaches itself and runs in the background, fielding
  55 requests on the appropriate port. By default, \fBnmbd\fR
  56 will operate as a daemon if launched from a command shell.
  57 nmbd can also be operated from the \fBinetd\fR
  58 meta-daemon, although this is not recommended.
  59 .TP
  60 \fB-F\fR
  61 If specified, this parameter causes
  62 the main \fBnmbd\fR process to not daemonize,
  63 i.e. double-fork and disassociate with the terminal.
  64 Child processes are still created as normal to service
  65 each connection request, but the main process does not
  66 exit. This operation mode is suitable for running
  67 \fBnmbd\fR under process supervisors such
  68 as \fBsupervise\fR and \fBsvscan\fR
  69 from Daniel J. Bernstein's \fBdaemontools\fR
  70 package, or the AIX process monitor.
  71 .TP
  72 \fB-S\fR
  73 If specified, this parameter causes
  74 \fBnmbd\fR to log to standard output rather
  75 than a file.
  76 .TP
  77 \fB-a\fR
  78 If this parameter is specified, each new
  79 connection will append log messages to the log file.
  80 This is the default.
  81 .TP
  82 \fB-i\fR
  83 If this parameter is specified it causes the
  84 server to run "interactively", not as a daemon, even if the
  85 server is executed on the command line of a shell. Setting this
  86 parameter negates the implicit daemon mode when run from the
  87 command line. \fBnmbd\fR also logs to standard
  88 output, as if the \fB-S\fR parameter had been
  89 given.
  90 .TP
  91 \fB-o\fR
  92 If this parameter is specified, the
  93 log files will be overwritten when opened.  By default,
  94 \fBsmbd\fR will append entries to the log
  95 files.
  96 .TP
  97 \fB-h\fR
  98 Prints the help information (usage)
  99 for \fBnmbd\fR.
 100 .TP
 101 \fB-H <filename>\fR
 102 NetBIOS lmhosts file.  The lmhosts
 103 file is a list of NetBIOS names to IP addresses that
 104 is loaded by the nmbd server and used via the name
 105 resolution mechanism   name resolve order described in  \fIsmb.conf(5)\fR
 106 to resolve any NetBIOS name queries needed by the server. Note
 107 that the contents of this file are \fBNOT\fR
 108 used by \fBnmbd\fR to answer any name queries.
 109 Adding a line to this file affects name NetBIOS resolution
 110 from this host \fBONLY\fR.
 111
 112 The default path to this file is compiled into
 113 Samba as part of the build process. Common defaults
 114 are \fI/usr/local/samba/lib/lmhosts\fR,
 115 \fI/usr/samba/lib/lmhosts\fR or
 116 \fI/etc/lmhosts\fR. See the
 117 \fIlmhosts(5)\fR
 118 man page for details on the contents of this file.
 119 .TP
 120 \fB-V\fR
 121 Prints the version number for
 122 \fBnmbd\fR.
 123 .TP
 124 \fB-d <debug level>\fR
 125 debuglevel is an integer
 126 from 0 to 10.  The default value if this parameter is
 127 not specified is zero.
 128
 129 The higher this value, the more detail will
 130 be logged to the log files about the activities of the
 131 server. At level 0, only critical errors and serious
 132 warnings will be logged. Level 1 is a reasonable level for
 133 day to day running - it generates a small amount of
 134 information about operations carried out.
 135
 136 Levels above 1 will generate considerable amounts
 137 of log data, and should only be used when investigating
 138 a problem. Levels above 3 are designed for use only by developers
 139 and generate HUGE amounts of log data, most of which is extremely
 140 cryptic.
 141
 142 Note that specifying this parameter here will override
 143 the log level
 144 parameter in the \fI  smb.conf(5)\fR file.
 145 .TP
 146 \fB-l <log directory>\fR
 147 The -l parameter specifies a directory
 148 into which the "log.nmbd" log file will be created
 149 for operational data from the running \fBnmbd\fR
 150 server. The default log directory is compiled into Samba
 151 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
 152 \fI/var/log/log.nmb\fR.  \fBBeware:\fR
 153 If the directory specified does not exist, \fBnmbd\fR
 154 will log to the default debug log location defined at compile time.
 155 .TP
 156 \fB-n <primary NetBIOS name>\fR
 157 This option allows you to override
 158 the NetBIOS name that Samba uses for itself. This is identical
 159 to setting the   NetBIOS name parameter in the
 160 \fIsmb.conf\fR file.  However, a command
 161 line setting will take precedence over settings in
 162 \fIsmb.conf\fR.
 163 .TP
 164 \fB-p <UDP port number>\fR
 165 UDP port number is a positive integer value.
 166 This option changes the default UDP port number (normally 137)
 167 that \fBnmbd\fR responds to name queries on. Don't
 168 use this option unless you are an expert, in which case you
 169 won't need help!
 170 .TP
 171 \fB-s <configuration file>\fR
 172 The default configuration file name
 173 is set at build time, typically as \fI  /usr/local/samba/lib/smb.conf\fR, but
 174 this may be changed when Samba is autoconfigured.
 175
 176 The file specified contains the configuration details
 177 required by the server. See   \fIsmb.conf(5)\fR for more information.
 178 .SH "FILES"
 179 .TP
 180 \fB\fI/etc/inetd.conf\fB\fR
 181 If the server is to be run by the
 182 \fBinetd\fR meta-daemon, this file
 183 must contain suitable startup information for the
 184 meta-daemon. See the UNIX_INSTALL.html document
 185 for details.
 186 .TP
 187 \fB\fI/etc/rc\fB\fR
 188 or whatever initialization script your
 189 system uses).
 190
 191 If running the server as a daemon at startup,
 192 this file will need to contain an appropriate startup
 193 sequence for the server. See the UNIX_INSTALL.html document
 194 for details.
 195 .TP
 196 \fB\fI/etc/services\fB\fR
 197 If running the server via the
 198 meta-daemon \fBinetd\fR, this file
 199 must contain a mapping of service name (e.g., netbios-ssn)
 200 to service port (e.g., 139) and protocol type (e.g., tcp).
 201 See the UNIX_INSTALL.html
 202 document for details.
 203 .TP
 204 \fB\fI/usr/local/samba/lib/smb.conf\fB\fR
 205 This is the default location of the
 206 \fIsmb.conf\fR
 207 server configuration file. Other common places that systems
 208 install this file are \fI/usr/samba/lib/smb.conf\fR
 209 and \fI/etc/smb.conf\fR.
 210
 211 When run as a WINS server (see the
 212 wins support
 213 parameter in the \fIsmb.conf(5)\fR man page),
 214 \fBnmbd\fR
 215 will store the WINS database in the file \fIwins.dat\fR
 216 in the \fIvar/locks\fR directory configured under
 217 wherever Samba was configured to install itself.
 218
 219 If \fBnmbd\fR is acting as a \fB  browse master\fR (see the local master
 220 parameter in the \fIsmb.conf(5)\fR man page,
 221 \fBnmbd\fR
 222 will store the browsing database in the file \fIbrowse.dat
 223 \fR in the \fIvar/locks\fR directory
 224 configured under wherever Samba was configured to install itself.
 225 .SH "SIGNALS"
 226 .PP
 227 To shut down an \fBnmbd\fR process it is recommended
 228 that SIGKILL (-9) \fBNOT\fR be used, except as a last
 229 resort, as this may leave the name database in an inconsistent state.
 230 The correct way to terminate \fBnmbd\fR is to send it
 231 a SIGTERM (-15) signal and wait for it to die on its own.
 232 .PP
 233 \fBnmbd\fR will accept SIGHUP, which will cause
 234 it to dump out its namelists into the file \fInamelist.debug
 235 \fR in the \fI/usr/local/samba/var/locks\fR
 236 directory (or the \fIvar/locks\fR directory configured
 237 under wherever Samba was configured to install itself). This will also
 238 cause \fBnmbd\fR to dump out its server database in
 239 the \fIlog.nmb\fR file.
 240 .PP
 241 The debug log level of nmbd may be raised or lowered using
 242 \fBsmbcontrol(1)\fR
 243  (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
 244 to allow transient problems to be diagnosed, whilst still running
 245 at a normally low log level.
 246 .SH "VERSION"
 247 .PP
 248 This man page is correct for version 3.0 of
 249 the Samba suite.
 250 .SH "SEE ALSO"
 251 .PP
 252 \fBinetd(8)\fR, \fBsmbd(8)\fR
 253 \fIsmb.conf(5)\fR
 254  \fBsmbclient(1)
 255 \fR and the Internet RFC's
 256 \fIrfc1001.txt\fR, \fIrfc1002.txt\fR.
 257 In addition the CIFS (formerly SMB) specification is available
 258 as a link from the Web page
 259 http://samba.org/cifs/ <URL:http://samba.org/cifs/>.
 260 .SH "AUTHOR"
 261 .PP
 262 The original Samba software and related utilities
 263 were created by Andrew Tridgell. Samba is now developed
 264 by the Samba Team as an Open Source project similar
 265 to the way the Linux kernel is developed.
 266 .PP
 267 The original Samba man pages were written by Karl Auer.
 268 The man page sources were converted to YODL format (another
 269 excellent piece of Open Source software, available at
 270 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 271 release by Jeremy Allison.  The conversion to DocBook for
 272 Samba 2.2 was done by Gerald Carter