docs/docbook/manpages/nmbd.8.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2 <!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
   3 ]>
   4 <refentry id="nmbd.8">
   5
   6 <refmeta>
   7         <refentrytitle>nmbd</refentrytitle>
   8         <manvolnum>8</manvolnum>
   9 </refmeta>
  10
  11
  12 <refnamediv>
  13         <refname>nmbd</refname>
  14         <refpurpose>NetBIOS name server to provide NetBIOS
  15         over IP naming services to clients</refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19         <cmdsynopsis>
  20                 <command>nmbd</command>
  21                 <arg choice="opt">-D</arg>
  22                 <arg choice="opt">-F</arg>
  23                 <arg choice="opt">-S</arg>
  24                 <arg choice="opt">-a</arg>
  25                 <arg choice="opt">-i</arg>
  26                 <arg choice="opt">-o</arg>
  27                 <arg choice="opt">-h</arg>
  28                 <arg choice="opt">-V</arg>
  29                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  30                 <arg choice="opt">-H &lt;lmhosts file&gt;</arg>
  31                 <arg choice="opt">-l &lt;log directory&gt;</arg>
  32                 <arg choice="opt">-n &lt;primary netbios name&gt;</arg>
  33                 <arg choice="opt">-p &lt;port number&gt;</arg>
  34                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  35         </cmdsynopsis>
  36 </refsynopsisdiv>
  37
  38 <refsect1>
  39         <title>DESCRIPTION</title>
  40         <para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
  41         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  42
  43         <para><command>nmbd</command> is a server that understands
  44         and can reply to NetBIOS over IP name service requests, like
  45         those produced by SMB/CIFS clients such as Windows 95/98/ME,
  46         Windows NT, Windows 2000, Windows XP and LanManager clients. It also
  47         participates in the browsing protocols which make up the
  48         Windows "Network Neighborhood" view.</para>
  49
  50         <para>SMB/CIFS clients, when they start up, may wish to
  51         locate an SMB/CIFS server. That is, they wish to know what
  52         IP number a specified host is using.</para>
  53
  54         <para>Amongst other services, <command>nmbd</command> will
  55         listen for such requests, and if its own NetBIOS name is
  56         specified it will respond with the IP number of the host it
  57         is running on.  Its "own NetBIOS name" is by
  58         default the primary DNS name of the host it is running on,
  59         but this can be overridden with the <emphasis>-n</emphasis>
  60         option (see OPTIONS below). Thus <command>nmbd</command> will
  61         reply to broadcast queries for its own name(s). Additional
  62         names for <command>nmbd</command> to respond on can be set
  63         via parameters in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
  64         <manvolnum>5</manvolnum></citerefentry> configuration file.</para>
  65
  66         <para><command>nmbd</command> can also be used as a WINS
  67         (Windows Internet Name Server) server. What this basically means
  68         is that it will act as a WINS database server, creating a
  69         database from name registration requests that it receives and
  70         replying to queries from clients for these names.</para>
  71
  72         <para>In addition, <command>nmbd</command> can act as a WINS
  73         proxy, relaying broadcast queries from clients that do
  74         not understand how to talk the WINS protocol to a WINS
  75         server.</para>
  76 </refsect1>
  77
  78 <refsect1>
  79         <title>OPTIONS</title>
  80
  81         <variablelist>
  82                 <varlistentry>
  83                 <term>-D</term>
  84                 <listitem><para>If specified, this parameter causes
  85                 <command>nmbd</command> to operate as a daemon. That is,
  86                 it detaches itself and runs in the background, fielding
  87                 requests on the appropriate port. By default, <command>nmbd</command>
  88                 will operate as a daemon if launched from a command shell.
  89                 nmbd can also be operated from the <command>inetd</command>
  90                 meta-daemon, although this is not recommended.
  91                 </para></listitem>
  92                 </varlistentry>
  93
  94                 <varlistentry>
  95                 <term>-F</term>
  96                 <listitem><para>If specified, this parameter causes
  97                 the main <command>nmbd</command> process to not daemonize,
  98                 i.e. double-fork and disassociate with the terminal.
  99                 Child processes are still created as normal to service
 100                 each connection request, but the main process does not
 101                 exit. This operation mode is suitable for running
 102                 <command>nmbd</command> under process supervisors such
 103                 as <command>supervise</command> and <command>svscan</command>
 104                 from Daniel J. Bernstein's <command>daemontools</command>
 105                 package, or the AIX process monitor.
 106                 </para></listitem>
 107                 </varlistentry>
 108
 109                 <varlistentry>
 110                 <term>-S</term>
 111                 <listitem><para>If specified, this parameter causes
 112                 <command>nmbd</command> to log to standard output rather
 113                 than a file.</para></listitem>
 114                 </varlistentry>
 115
 116                 <varlistentry>
 117                 <term>-i</term>
 118                 <listitem><para>If this parameter is specified it causes the
 119                 server to run "interactively", not as a daemon, even if the
 120                 server is executed on the command line of a shell. Setting this
 121                 parameter negates the implicit daemon mode when run from the
 122                 command line. <command>nmbd</command> also logs to standard
 123                 output, as if the <constant>-S</constant> parameter had been
 124                 given. </para></listitem>
 125                 </varlistentry>
 126
 127                 &stdarg.help;
 128
 129                 <varlistentry>
 130                 <term>-H &lt;filename&gt;</term>
 131                 <listitem><para>NetBIOS lmhosts file.  The lmhosts
 132                 file is a list of NetBIOS names to IP addresses that
 133                 is loaded by the nmbd server and used via the name
 134                 resolution mechanism <ulink url="smb.conf.5.html#nameresolveorder"><parameter>name resolve
 135                 order</parameter></ulink> described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
 136                 <manvolnum>5</manvolnum></citerefentry> to resolve any
 137                 NetBIOS name queries needed by the server. Note
 138                 that the contents of this file are <emphasis>NOT</emphasis>
 139                 used by <command>nmbd</command> to answer any name queries.
 140                 Adding a line to this file affects name NetBIOS resolution
 141                 from this host <emphasis>ONLY</emphasis>.</para>
 142
 143                 <para>The default path to this file is compiled into
 144                 Samba as part of the build process. Common defaults
 145                 are <filename>/usr/local/samba/lib/lmhosts</filename>,
 146                 <filename>/usr/samba/lib/lmhosts</filename> or
 147                 <filename>/etc/samba/lmhosts</filename>. See the <citerefentry><refentrytitle>lmhosts</refentrytitle>
 148         <manvolnum>5</manvolnum></citerefentry> man page for details on the contents of this file.</para></listitem>
 149                 </varlistentry>
 150
 151                 &popt.common.samba;
 152
 153                 <varlistentry>
 154                 <term>-p &lt;UDP port number&gt;</term>
 155                 <listitem><para>UDP port number is a positive integer value.
 156                 This option changes the default UDP port number (normally 137)
 157                 that <command>nmbd</command> responds to name queries on. Don't
 158                 use this option unless you are an expert, in which case you
 159                 won't need help!</para></listitem>
 160                 </varlistentry>
 161
 162         </variablelist>
 163 </refsect1>
 164
 165 <refsect1>
 166         <title>FILES</title>
 167
 168         <variablelist>
 169                 <varlistentry>
 170                 <term><filename>/etc/inetd.conf</filename></term>
 171                 <listitem><para>If the server is to be run by the
 172                 <command>inetd</command> meta-daemon, this file
 173                 must contain suitable startup information for the
 174                 meta-daemon. See the <ulink
 175                 url="install.html">install</ulink> document
 176                 for details.
 177                 </para></listitem>
 178                 </varlistentry>
 179
 180                 <varlistentry>
 181                 <term><filename>/etc/rc</filename></term>
 182                 <listitem><para>or whatever initialization script your
 183                 system uses).</para>
 184
 185                 <para>If running the server as a daemon at startup,
 186                 this file will need to contain an appropriate startup
 187                 sequence for the server. See the <ulink
 188                 url="install.html">"How to Install and Test SAMBA"</ulink> document
 189                 for details.</para></listitem>
 190                 </varlistentry>
 191
 192                 <varlistentry>
 193                 <term><filename>/etc/services</filename></term>
 194                 <listitem><para>If running the server via the
 195                 meta-daemon <command>inetd</command>, this file
 196                 must contain a mapping of service name (e.g., netbios-ssn)
 197                 to service port (e.g., 139) and protocol type (e.g., tcp).
 198                 See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink>
 199                 document for details.</para></listitem>
 200                 </varlistentry>
 201
 202                 <varlistentry>
 203                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 204                 <listitem><para>This is the default location of
 205                 the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 206                 <manvolnum>5</manvolnum></citerefentry> server
 207                 configuration file. Other common places that systems
 208                 install this file are <filename>/usr/samba/lib/smb.conf</filename>
 209                 and <filename>/etc/samba/smb.conf</filename>.</para>
 210
 211                 <para>When run as a WINS server (see the
 212                 <ulink url="smb.conf.5.html#WINSSUPPORT"><constant>wins support</constant></ulink>
 213                 parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 214                 <manvolnum>5</manvolnum></citerefentry> man page),
 215                 <command>nmbd</command>
 216                 will store the WINS database in the file <filename>wins.dat</filename>
 217                 in the <filename>var/locks</filename> directory configured under
 218                 wherever Samba was configured to install itself.</para>
 219
 220                 <para>If <command>nmbd</command> is acting as a <emphasis>
 221                 browse master</emphasis> (see the <ulink
 222                 url="smb.conf.5.html#LOCALMASTER"><constant>local master</constant></ulink>
 223                 parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 224         <manvolnum>5</manvolnum></citerefentry> man page, <command>nmbd</command>
 225                 will store the browsing database in the file <filename>browse.dat
 226                 </filename> in the <filename>var/locks</filename> directory
 227                 configured under wherever Samba was configured to install itself.
 228                 </para></listitem>
 229                 </varlistentry>
 230         </variablelist>
 231 </refsect1>
 232
 233 <refsect1>
 234         <title>SIGNALS</title>
 235
 236         <para>To shut down an <command>nmbd</command> process it is recommended
 237         that SIGKILL (-9) <emphasis>NOT</emphasis> be used, except as a last
 238         resort, as this may leave the name database in an inconsistent state.
 239         The correct way to terminate <command>nmbd</command> is to send it
 240         a SIGTERM (-15) signal and wait for it to die on its own.</para>
 241
 242         <para><command>nmbd</command> will accept SIGHUP, which will cause
 243         it to dump out its namelists into the file <filename>namelist.debug
 244         </filename> in the <filename>/usr/local/samba/var/locks</filename>
 245         directory (or the <filename>var/locks</filename> directory configured
 246         under wherever Samba was configured to install itself). This will also
 247         cause <command>nmbd</command> to dump out its server database in
 248         the <filename>log.nmb</filename> file.</para>
 249
 250         <para>The debug log level of nmbd may be raised or lowered
 251         using <citerefentry><refentrytitle>smbcontrol</refentrytitle>
 252         <manvolnum>1</manvolnum></citerefentry> (SIGUSR[1|2] signals
 253         are no longer used since Samba 2.2). This is to allow
 254         transient problems to be diagnosed, whilst still running
 255         at a normally low log level.</para>
 256 </refsect1>
 257
 258
 259 <refsect1>
 260         <title>VERSION</title>
 261
 262         <para>This man page is correct for version 3.0 of
 263         the Samba suite.</para>
 264 </refsect1>
 265
 266 <refsect1>
 267         <title>SEE ALSO</title>
 268         <para>
 269         <citerefentry><refentrytitle>inetd</refentrytitle>
 270         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle>
 271         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 272         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
 273         <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
 274         <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle>
 275         <manvolnum>1</manvolnum></citerefentry>, and the Internet
 276         RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
 277         In addition the CIFS (formerly SMB) specification is available
 278         as a link from the Web page <ulink url="http://samba.org/cifs/">
 279         http://samba.org/cifs/</ulink>.</para>
 280 </refsect1>
 281
 282 <refsect1>
 283         <title>AUTHOR</title>
 284
 285         <para>The original Samba software and related utilities
 286         were created by Andrew Tridgell. Samba is now developed
 287         by the Samba Team as an Open Source project similar
 288         to the way the Linux kernel is developed.</para>
 289
 290         <para>The original Samba man pages were written by Karl Auer.
 291         The man page sources were converted to YODL format (another
 292         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 293         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 294         release by Jeremy Allison.  The conversion to DocBook for
 295         Samba 2.2 was done by Gerald Carter. The conversion to DocBook
 296         XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
 297 </refsect1>
 298
 299 </refentry>