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" "05 November 2002" "" ""
   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-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-a\fR
  61 If this parameter is specified, each new
  62 connection will append log messages to the log file.
  63 This is the default.
  64 .TP
  65 \fB-i\fR
  66 If this parameter is specified it causes the
  67 server to run "interactively", not as a daemon, even if the
  68 server is executed on the command line of a shell. Setting this
  69 parameter negates the implicit daemon mode when run from the
  70 command line.
  71 .TP
  72 \fB-o\fR
  73 If this parameter is specified, the
  74 log files will be overwritten when opened.  By default,
  75 \fBsmbd\fR will append entries to the log
  76 files.
  77 .TP
  78 \fB-h\fR
  79 Prints the help information (usage)
  80 for \fBnmbd\fR.
  81 .TP
  82 \fB-H <filename>\fR
  83 NetBIOS lmhosts file.  The lmhosts
  84 file is a list of NetBIOS names to IP addresses that
  85 is loaded by the nmbd server and used via the name
  86 resolution mechanism   name resolve order described in  \fIsmb.conf(5)\fR
  87 to resolve any NetBIOS name queries needed by the server. Note
  88 that the contents of this file are \fBNOT\fR
  89 used by \fBnmbd\fR to answer any name queries.
  90 Adding a line to this file affects name NetBIOS resolution
  91 from this host \fBONLY\fR.
  92
  93 The default path to this file is compiled into
  94 Samba as part of the build process. Common defaults
  95 are \fI/usr/local/samba/lib/lmhosts\fR,
  96 \fI/usr/samba/lib/lmhosts\fR or
  97 \fI/etc/lmhosts\fR. See the
  98 \fIlmhosts(5)\fR
  99 man page for details on the contents of this file.
 100 .TP
 101 \fB-V\fR
 102 Prints the version number for
 103 \fBnmbd\fR.
 104 .TP
 105 \fB-d <debug level>\fR
 106 debuglevel is an integer
 107 from 0 to 10.  The default value if this parameter is
 108 not specified is zero.
 109
 110 The higher this value, the more detail will
 111 be logged to the log files about the activities of the
 112 server. At level 0, only critical errors and serious
 113 warnings will be logged. Level 1 is a reasonable level for
 114 day to day running - it generates a small amount of
 115 information about operations carried out.
 116
 117 Levels above 1 will generate considerable amounts
 118 of log data, and should only be used when investigating
 119 a problem. Levels above 3 are designed for use only by developers
 120 and generate HUGE amounts of log data, most of which is extremely
 121 cryptic.
 122
 123 Note that specifying this parameter here will override
 124 the log level
 125 parameter in the \fI  smb.conf(5)\fR file.
 126 .TP
 127 \fB-l <log directory>\fR
 128 The -l parameter specifies a directory
 129 into which the "log.nmbd" log file will be created
 130 for operational data from the running \fBnmbd\fR
 131 server. The default log directory is compiled into Samba
 132 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
 133 \fI/var/log/log.nmb\fR.  \fBBeware:\fR
 134 If the directory specified does not exist, \fBnmbd\fR
 135 will log to the default debug log location defined at compile time.
 136 .TP
 137 \fB-n <primary NetBIOS name>\fR
 138 This option allows you to override
 139 the NetBIOS name that Samba uses for itself. This is identical
 140 to setting the   NetBIOS name parameter in the
 141 \fIsmb.conf\fR file.  However, a command
 142 line setting will take precedence over settings in
 143 \fIsmb.conf\fR.
 144 .TP
 145 \fB-p <UDP port number>\fR
 146 UDP port number is a positive integer value.
 147 This option changes the default UDP port number (normally 137)
 148 that \fBnmbd\fR responds to name queries on. Don't
 149 use this option unless you are an expert, in which case you
 150 won't need help!
 151 .TP
 152 \fB-s <configuration file>\fR
 153 The default configuration file name
 154 is set at build time, typically as \fI  /usr/local/samba/lib/smb.conf\fR, but
 155 this may be changed when Samba is autoconfigured.
 156
 157 The file specified contains the configuration details
 158 required by the server. See   \fIsmb.conf(5)\fR for more information.
 159 .SH "FILES"
 160 .TP
 161 \fB\fI/etc/inetd.conf\fB\fR
 162 If the server is to be run by the
 163 \fBinetd\fR meta-daemon, this file
 164 must contain suitable startup information for the
 165 meta-daemon. See the UNIX_INSTALL.html document
 166 for details.
 167 .TP
 168 \fB\fI/etc/rc\fB\fR
 169 or whatever initialization script your
 170 system uses).
 171
 172 If running the server as a daemon at startup,
 173 this file will need to contain an appropriate startup
 174 sequence for the server. See the UNIX_INSTALL.html document
 175 for details.
 176 .TP
 177 \fB\fI/etc/services\fB\fR
 178 If running the server via the
 179 meta-daemon \fBinetd\fR, this file
 180 must contain a mapping of service name (e.g., netbios-ssn)
 181 to service port (e.g., 139) and protocol type (e.g., tcp).
 182 See the UNIX_INSTALL.html
 183 document for details.
 184 .TP
 185 \fB\fI/usr/local/samba/lib/smb.conf\fB\fR
 186 This is the default location of the
 187 \fIsmb.conf\fR
 188 server configuration file. Other common places that systems
 189 install this file are \fI/usr/samba/lib/smb.conf\fR
 190 and \fI/etc/smb.conf\fR.
 191
 192 When run as a WINS server (see the
 193 wins support
 194 parameter in the \fIsmb.conf(5)\fR man page),
 195 \fBnmbd\fR
 196 will store the WINS database in the file \fIwins.dat\fR
 197 in the \fIvar/locks\fR directory configured under
 198 wherever Samba was configured to install itself.
 199
 200 If \fBnmbd\fR is acting as a \fB  browse master\fR (see the local master
 201 parameter in the \fIsmb.conf(5)\fR man page,
 202 \fBnmbd\fR
 203 will store the browsing database in the file \fIbrowse.dat
 204 \fR in the \fIvar/locks\fR directory
 205 configured under wherever Samba was configured to install itself.
 206 .SH "SIGNALS"
 207 .PP
 208 To shut down an \fBnmbd\fR process it is recommended
 209 that SIGKILL (-9) \fBNOT\fR be used, except as a last
 210 resort, as this may leave the name database in an inconsistent state.
 211 The correct way to terminate \fBnmbd\fR is to send it
 212 a SIGTERM (-15) signal and wait for it to die on its own.
 213 .PP
 214 \fBnmbd\fR will accept SIGHUP, which will cause
 215 it to dump out its namelists into the file \fInamelist.debug
 216 \fR in the \fI/usr/local/samba/var/locks\fR
 217 directory (or the \fIvar/locks\fR directory configured
 218 under wherever Samba was configured to install itself). This will also
 219 cause \fBnmbd\fR to dump out its server database in
 220 the \fIlog.nmb\fR file.
 221 .PP
 222 The debug log level of nmbd may be raised or lowered using
 223 \fBsmbcontrol(1)\fR
 224  (SIGUSR[1|2] signals are no longer used in Samba 2.2). This is
 225 to allow transient problems to be diagnosed, whilst still running
 226 at a normally low log level.
 227 .SH "VERSION"
 228 .PP
 229 This man page is correct for version 3.0 of
 230 the Samba suite.
 231 .SH "SEE ALSO"
 232 .PP
 233 \fBinetd(8)\fR, \fBsmbd(8)\fR
 234 \fIsmb.conf(5)\fR
 235  \fBsmbclient(1)
 236 \fR and the Internet RFC's
 237 \fIrfc1001.txt\fR, \fIrfc1002.txt\fR.
 238 In addition the CIFS (formerly SMB) specification is available
 239 as a link from the Web page
 240 http://samba.org/cifs/ <URL:http://samba.org/cifs/>.
 241 .SH "AUTHOR"
 242 .PP
 243 The original Samba software and related utilities
 244 were created by Andrew Tridgell. Samba is now developed
 245 by the Samba Team as an Open Source project similar
 246 to the way the Linux kernel is developed.
 247 .PP
 248 The original Samba man pages were written by Karl Auer.
 249 The man page sources were converted to YODL format (another
 250 excellent piece of Open Source software, available at
 251 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 252 release by Jeremy Allison.  The conversion to DocBook for
 253 Samba 2.2 was done by Gerald Carter