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