docs/htmldocs/nmbd.8.html

   1
   2
   3
   4
   5
   6 <html><head><title>nmbd</title>
   7
   8 <link rev="made" href="mailto:samba-bugs@samba.org">
   9 </head>
  10 <body>
  11
  12 <hr>
  13
  14 <h1>nmbd</h1>
  15 <h2>Samba</h2>
  16 <h2>23 Oct 1998</h2>
  17
  18
  19
  20
  21 <p><br><a name="NAME"></a>
  22 <h2>NAME</h2>
  23     nmbd - NetBIOS name server to provide NetBIOS over IP
  24 naming services to clients
  25 <p><br><a name="SYNOPSIS"></a>
  26 <h2>SYNOPSIS</h2>
  27
  28 <p><br><strong>nmbd</strong> [<a href="nmbd.8.html#minusD">-D</a>] [<a href="nmbd.8.html#minuso">-o</a>] [<a href="nmbd.8.html#minusa">-a</a>] [<a href="nmbd.8.html#minusH">-H lmhosts file</a>] [<a href="nmbd.8.html#minusd">-d debuglevel</a>] [<a href="nmbd.8.html#minusl">-l log file basename</a>] [<a href="nmbd.8.html#minusn">-n primary NetBIOS name</a>] [<a href="nmbd.8.html#minusp">-p port number</a>] [<a href="nmbd.8.html#minuss">-s configuration file</a>] [<a href="nmbd.8.html#minusi">-i NetBIOS scope</a>] [<a href="nmbd.8.html#minush">-h</a>]
  29 <p><br><a name="DESCRIPTION"></a>
  30 <h2>DESCRIPTION</h2>
  31
  32 <p><br>This program is part of the <strong>Samba</strong> suite.
  33 <p><br><strong>nmbd</strong> is a server that understands and can reply to NetBIOS over IP
  34 name service requests, like those produced by SMBD/CIFS clients such
  35 as Windows 95/98, Windows NT and LanManager clients. It also
  36 participates in the browsing protocols which make up the Windows
  37 "Network Neighborhood" view.
  38 <p><br>SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS
  39 server. That is, they wish to know what IP number a specified host is
  40 using.
  41 <p><br>Amongst other services, <strong>nmbd</strong> will listen for such requests,
  42 and if its own NetBIOS name is specified it will respond with the IP
  43 number of the host it is running on.  Its "own NetBIOS name" is by
  44 default the primary DNS name of the host it is running on, but this
  45 can be overridden with the <strong>-n</strong> option (see <a href="nmbd.8.html#OPTIONS">OPTIONS</a> below). Thus
  46 <strong>nmbd</strong> will reply to broadcast queries for its own name(s). Additional
  47 names for <strong>nmbd</strong> to respond on can be set via parameters in the
  48 <a href="smb.conf.5.html"><strong>smb.conf(5)</strong></a> configuration file.
  49 <p><br><strong>nmbd</strong> can also be used as a WINS (Windows Internet Name Server)
  50 server. What this basically means is that it will act as a WINS
  51 database server, creating a database from name registration requests
  52 that it receives and replying to queries from clients for these names.
  53 <p><br>In addition, <strong>nmbd</strong> can act as a WINS proxy, relaying broadcast queries
  54 from clients that do not understand how to talk the WINS protocol to a
  55 WIN server.
  56 <p><br><a name="OPTIONS"></a>
  57 <h2>OPTIONS</h2>
  58
  59 <p><br><ul>
  60 <p><br><a name="minusD"></a>
  61 <li><strong><strong>-D</strong></strong> If specified, this parameter causes <strong>nmbd</strong> to operate
  62 as a daemon. That is, it detaches itself and runs in the background,
  63 fielding requests on the appropriate port. By default, <strong>nmbd</strong> will
  64 NOT operate as a daemon. nmbd can also be operated from the inetd
  65 meta-daemon, although this is not recommended.
  66 <p><br><a name="minusa"></a>
  67 <li><strong><strong>-a</strong></strong> If this parameter is specified, each new connection will
  68 append log messages to the log file.  This is the default.
  69 <p><br><a name="minuso"></a>
  70 <li><strong><strong>-o</strong></strong> If this parameter is specified, the log files will be
  71 overwritten when opened.  By default, the log files will be appended
  72 to.
  73 <p><br><a name="minusH"></a>
  74 <li><strong><strong>-H filename</strong></strong> NetBIOS lmhosts file.
  75 <p><br>The lmhosts file is a list of NetBIOS names to IP addresses that is
  76 loaded by the nmbd server and used via the name resolution mechanism
  77 <a href="smb.conf.5.html#nameresolveorder"><strong>name resolve order</strong></a> described in
  78 <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> to resolve any
  79 NetBIOS name queries needed by the server. Note that the contents of
  80 this file are <em>NOT</em> used by <strong>nmbd</strong> to answer any name queries. Adding
  81 a line to this file affects name NetBIOS resolution from this host
  82 <em>ONLY</em>.
  83 <p><br>The default path to this file is compiled into Samba as part of the
  84 build process. Common defaults are <em>/usr/local/samba/lib/lmhosts</em>,
  85 <em>/usr/samba/lib/lmhosts</em> or <em>/etc/lmhosts</em>. See the
  86 <a href="lmhosts.5.html"><strong>lmhosts (5)</strong></a> man page for details on the contents of this file.
  87 <p><br><a name="minusd"></a>
  88 <li><strong><strong>-d debuglevel</strong></strong> debuglevel is an integer from 0 to 10.
  89 <p><br>The default value if this parameter is not specified is zero.
  90 <p><br>The higher this value, the more detail will be logged to the log files
  91 about the activities of the server. At level 0, only critical errors
  92 and serious warnings will be logged. Level 1 is a reasonable level for
  93 day to day running - it generates a small amount of information about
  94 operations carried out.
  95 <p><br>Levels above 1 will generate considerable amounts of log data, and
  96 should only be used when investigating a problem. Levels above 3 are
  97 designed for use only by developers and generate HUGE amounts of log
  98 data, most of which is extremely cryptic.
  99 <p><br>Note that specifying this parameter here will override the <a href="smb.conf.5.html#loglevel"><strong>log
 100 level</strong></a> parameter in the <a href="smb.conf.5.html"><strong>smb.conf
 101 (5)</strong></a> file.
 102 <p><br><a name="minusl"></a>
 103 <li><strong><strong>-l logfile</strong></strong> The <strong>-l</strong> parameter specifies a path and base
 104 filename into which operational data from the running nmbd server will
 105 be logged.  The actual log file name is generated by appending the
 106 extension ".nmb" to the specified base name.  For example, if the name
 107 specified was "log" then the file log.nmb would contain the debugging
 108 data.
 109 <p><br>The default log file path is compiled into Samba as part of the
 110 build process. Common defaults are <em>/usr/local/samba/var/log.nmb</em>,
 111 <em>/usr/samba/var/log.nmb</em> or <em>/var/log/log.nmb</em>.
 112 <p><br><a name="minusn"></a>
 113 <li><strong><strong>-n primary NetBIOS name</strong></strong> This option allows you to override
 114 the NetBIOS name that Samba uses for itself. This is identical to
 115 setting the <a href="smb.conf.5.html#netbiosname"><strong>NetBIOS name</strong></a> parameter
 116 in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file
 117 but will override the setting in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file.
 118 <p><br><a name="minusp"></a>
 119 <li><strong><strong>-p UDP port number</strong></strong> UDP port number is a positive integer value.
 120 <p><br>This option changes the default UDP port number (normally 137) that
 121 <strong>nmbd</strong> responds to name queries on. Don't use this option unless you are
 122 an expert, in which case you won't need help!
 123 <p><br><a name="minuss"></a>
 124 <li><strong><strong>-s configuration file</strong></strong> The default configuration file name is
 125 set at build time, typically as <em>/usr/local/samba/lib/smb.conf</em>, but
 126 this may be changed when Samba is autoconfigured.
 127 <p><br>The file specified contains the configuration details required by the
 128 server. See <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> for more information.
 129 <p><br><a name="minusi"></a>
 130 <li><strong><strong>-i scope</strong></strong> This specifies a NetBIOS scope that <strong>nmbd</strong> will use
 131 to communicate with when generating NetBIOS names. For details on the
 132 use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes
 133 are <em>very</em> rarely used, only set this parameter if you are the
 134 system administrator in charge of all the NetBIOS systems you
 135 communicate with.
 136 <p><br><a name="minush"></a>
 137 <li><strong><strong>-h</strong></strong> Prints the help information (usage) for <strong>nmbd</strong>.
 138 <p><br></ul>
 139 <p><br><a name="FILES"></a>
 140 <h2>FILES</h2>
 141
 142 <p><br><strong>/etc/inetd.conf</strong>
 143 <p><br>If the server is to be run by the inetd meta-daemon, this file must
 144 contain suitable startup information for the meta-daemon.
 145 <p><br><strong>/etc/rc</strong>
 146 <p><br>(or whatever initialization script your system uses).
 147 <p><br>If running the server as a daemon at startup, this file will need to
 148 contain an appropriate startup sequence for the server.
 149 <p><br><strong>/usr/local/samba/lib/smb.conf</strong>
 150 <p><br>This is the default location of the
 151 <a href="smb.conf.5.html"><strong>smb.conf</strong></a> server configuration
 152 file. Other common places that systems install this file are
 153 <em>/usr/samba/lib/smb.conf</em> and <em>/etc/smb.conf</em>.
 154 <p><br>When run as a <strong>WINS</strong> server (see the <a href="smb.conf.5.html#winssupport"><strong>wins support</strong></a>
 155 parameter in the <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> man page), <strong>nmbd</strong> will
 156 store the WINS database in the file <code>wins.dat</code> in the <code>var/locks</code> directory
 157 configured under wherever Samba was configured to install itself.
 158 <p><br>If <strong>nmbd</strong> is acting as a <strong>browse master</strong> (see the <a href="smb.conf.5.html#localmaster"><strong>local master</strong></a>
 159 parameter in the <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> man page), <strong>nmbd</strong> will
 160 store the browsing database in the file <code>browse.dat</code> in the <code>var/locks</code> directory
 161 configured under wherever Samba was configured to install itself.
 162 <p><br><a name="SIGNALS"></a>
 163 <h2>SIGNALS</h2>
 164
 165 <p><br>To shut down an <strong>nmbd</strong> process it is recommended that SIGKILL (-9)
 166 <em>NOT</em> be used, except as a last resort, as this may leave the name
 167 database in an inconsistent state. The correct way to terminate
 168 <strong>nmbd</strong> is to send it a SIGTERM (-15) signal and wait for it to die on
 169 its own.
 170 <p><br><strong>nmbd</strong> will accept SIGHUP, which will cause it to dump out it's
 171 namelists into the file <code>namelist.debug</code> in the
 172 <em>/usr/local/samba/var/locks</em> directory (or the <em>var/locks</em>
 173 directory configured under wherever Samba was configured to install
 174 itself). This will also cause <strong>nmbd</strong> to dump out it's server database in
 175 the log.nmb file. In addition, the debug log level of nmbd may be raised
 176 by sending it a SIGUSR1 (<code>kill -USR1 &lt;nmbd-pid&gt;</code>) and lowered by sending it a
 177 SIGUSR2 (<code>kill -USR2 &lt;nmbd-pid&gt;</code>). This is to allow transient
 178 problems to be diagnosed, whilst still running at a normally low log
 179 level.
 180 <p><br><a name="VERSION"></a>
 181 <h2>VERSION</h2>
 182
 183 <p><br>This man page is correct for version 2.0 of the Samba suite.
 184 <p><br><a name="SEEALSO"></a>
 185 <h2>SEE ALSO</h2>
 186
 187 <p><br><strong>inetd (8)</strong>, <a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="smb.conf.5.html"><strong>smb.conf
 188 (5)</strong></a>, <a href="smbclient.1.html"><strong>smbclient (1)</strong></a>,
 189 <a href="testparm.1.html"><strong>testparm (1)</strong></a>, <a href="testprns.1.html"><strong>testprns
 190 (1)</strong></a>, and the Internet RFC's <strong>rfc1001.txt</strong>,
 191 <strong>rfc1002.txt</strong>. In addition the CIFS (formerly SMB) specification is
 192 available as a link from the Web page :
 193 <a href="http://samba.org/cifs/">http://samba.org/cifs/</a>.
 194 <p><br><a name="AUTHOR"></a>
 195 <h2>AUTHOR</h2>
 196
 197 <p><br>The original Samba software and related utilities were created by
 198 Andrew Tridgell <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>. Samba is now developed
 199 by the Samba Team as an Open Source project similar to the way the
 200 Linux kernel is developed.
 201 <p><br>The original Samba man pages were written by Karl Auer. The man page
 202 sources were converted to YODL format (another excellent piece of Open
 203 Source software, available at
 204 <a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>)
 205 and updated for the Samba2.0 release by Jeremy Allison.
 206 <a href="mailto:samba-bugs@samba.org"><em>samba-bugs@samba.org</em></a>.
 207 <p><br>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full
 208 list of contributors and details on how to submit bug reports,
 209 comments etc.
 210 </body>
 211 </html>