docs/docbook/manpages/nmbd.8.xml

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