docs/manpages/nmbd.8

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