docs/manpages-3/smbd.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="smbd.8">
   4
   5 <refmeta>
   6         <refentrytitle>smbd</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbd</refname>
  13         <refpurpose>server to provide SMB/CIFS services to clients</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>smbd</command>
  19                 <arg choice="opt">-D</arg>
  20                 <arg choice="opt">-F</arg>
  21                 <arg choice="opt">-S</arg>
  22                 <arg choice="opt">-i</arg>
  23                 <arg choice="opt">-h</arg>
  24                 <arg choice="opt">-V</arg>
  25                 <arg choice="opt">-b</arg>
  26                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  27                 <arg choice="opt">-l &lt;log directory&gt;</arg>
  28                 <arg choice="opt">-p &lt;port number(s)&gt;</arg>
  29                 <arg choice="opt">-P &lt;profiling level&gt;</arg>
  30                 <arg choice="opt">-O &lt;socket option&gt;</arg>
  31                 <arg choice="opt">-s &lt;configuration file&gt;</arg>
  32         </cmdsynopsis>
  33 </refsynopsisdiv>
  34
  35 <refsect1>
  36         <title>DESCRIPTION</title>
  37         <para>This program is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  38         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  39
  40         <para><command>smbd</command> is the server daemon that
  41         provides filesharing and printing services to Windows clients.
  42         The server provides filespace and printer services to
  43         clients using the SMB (or CIFS) protocol. This is compatible
  44         with the LanManager protocol, and can service LanManager
  45         clients.  These include MSCLIENT 3.0 for DOS, Windows for
  46         Workgroups, Windows 95/98/ME, Windows NT, Windows 2000,
  47         OS/2, DAVE for Macintosh, and smbfs for Linux.</para>
  48
  49         <para>An extensive description of the services that the
  50         server can provide is given in the man page for the
  51         configuration file controlling the attributes of those
  52         services (see <citerefentry><refentrytitle>smb.conf</refentrytitle>
  53         <manvolnum>5</manvolnum></citerefentry>.  This man page will not describe the
  54         services, but will concentrate on the administrative aspects
  55         of running the server.</para>
  56
  57         <para>Please note that there are significant security
  58         implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle>
  59         <manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before
  60         proceeding with installation.</para>
  61
  62         <para>A session is created whenever a client requests one.
  63         Each client gets a copy of the server for each session. This
  64         copy then services all connections made by the client during
  65         that session. When all connections from its client are closed,
  66         the copy of the server for that client terminates.</para>
  67
  68         <para>The configuration file, and any files that it includes,
  69         are automatically reloaded every minute, if they change.  You
  70         can force a reload by sending a SIGHUP to the server.  Reloading
  71         the configuration file will not affect connections to any service
  72         that is already established.  Either the user will have to
  73         disconnect from the service, or <command>smbd</command> killed and restarted.</para>
  74 </refsect1>
  75
  76 <refsect1>
  77         <title>OPTIONS</title>
  78
  79         <variablelist>
  80                 <varlistentry>
  81                 <term>-D</term>
  82                 <listitem><para>If specified, this parameter causes
  83                 the server to operate as a daemon. That is, it detaches
  84                 itself and runs in the background, fielding requests
  85                 on the appropriate port. Operating the server as a
  86                 daemon is the recommended way of running <command>smbd</command> for
  87                 servers that provide more than casual use file and
  88                 print services.  This switch is assumed if <command>smbd
  89                 </command> is executed on the command line of a shell.
  90                 </para></listitem>
  91                 </varlistentry>
  92
  93                 <varlistentry>
  94                 <term>-F</term>
  95                 <listitem><para>If specified, this parameter causes
  96                 the main <command>smbd</command> process to not daemonize,
  97                 i.e. double-fork and disassociate with the terminal.
  98                 Child processes are still created as normal to service
  99                 each connection request, but the main process does not
 100                 exit. This operation mode is suitable for running
 101                 <command>smbd</command> under process supervisors such
 102                 as <command>supervise</command> and <command>svscan</command>
 103                 from Daniel J. Bernstein's <command>daemontools</command>
 104                 package, or the AIX process monitor.
 105                 </para></listitem>
 106                 </varlistentry>
 107
 108                 <varlistentry>
 109                 <term>-S</term>
 110                 <listitem><para>If specified, this parameter causes
 111                 <command>smbd</command> to log to standard output rather
 112                 than a file.</para></listitem>
 113                 </varlistentry>
 114
 115                 <varlistentry>
 116                 <term>-i</term>
 117                 <listitem><para>If this parameter is specified it causes the
 118                 server to run "interactively", not as a daemon, even if the
 119                 server is executed on the command line of a shell. Setting this
 120                 parameter negates the implicit deamon mode when run from the
 121                 command line. <command>smbd</command> also logs to standard
 122                 output, as if the <command>-S</command> parameter had been
 123                 given.
 124                 </para></listitem>
 125                 </varlistentry>
 126
 127                 &popt.common.samba;
 128                 &stdarg.help;
 129
 130                 <varlistentry>
 131                 <term>-b</term>
 132                 <listitem><para>Prints information about how
 133                 Samba was built.</para></listitem>
 134                 </varlistentry>
 135
 136                 <varlistentry>
 137                 <term>-p|--port&lt;port number(s)&gt;</term>
 138                 <listitem><para><replaceable>port number(s)</replaceable> is a
 139                 space or comma-separated list of TCP ports smbd should listen on.
 140                 The default value is taken from the <smbconfoption name="ports"/> parameter in &smb.conf;</para>
 141
 142                 <para>The default ports are 139 (used for SMB over NetBIOS over TCP)
 143                         and port 445 (used for plain SMB over TCP).
 144                 </para></listitem>
 145                 </varlistentry>
 146
 147                 <varlistentry>
 148                 <term>-P|--profiling-level&lt;profiling level&gt;</term>
 149                 <listitem><para><replaceable>profiling level</replaceable> is a
 150                 number specifying the level of profiling data to be collected.
 151                 0 turns off profiling, 1 turns on counter profiling only,
 152                 2 turns on complete profiling, and 3 resets all profiling data.
 153                 </para></listitem>
 154                 </varlistentry>
 155         </variablelist>
 156 </refsect1>
 157
 158 <refsect1>
 159         <title>FILES</title>
 160
 161         <variablelist>
 162                 <varlistentry>
 163                 <term><filename>/etc/inetd.conf</filename></term>
 164                 <listitem><para>If the server is to be run by the
 165                 <command>inetd</command> meta-daemon, this file
 166                 must contain suitable startup information for the
 167                 meta-daemon.
 168                 </para></listitem>
 169                 </varlistentry>
 170
 171                 <varlistentry>
 172                 <term><filename>/etc/rc</filename></term>
 173                 <listitem><para>or whatever initialization script your
 174                 system uses).</para>
 175
 176                 <para>If running the server as a daemon at startup,
 177                 this file will need to contain an appropriate startup
 178                 sequence for the server. </para></listitem>
 179                 </varlistentry>
 180
 181                 <varlistentry>
 182                 <term><filename>/etc/services</filename></term>
 183                 <listitem><para>If running the server via the
 184                 meta-daemon <command>inetd</command>, this file
 185                 must contain a mapping of service name (e.g., netbios-ssn)
 186                 to service port (e.g., 139) and protocol type (e.g., tcp).
 187                 </para></listitem>
 188                 </varlistentry>
 189
 190                 <varlistentry>
 191                 <term><filename>/usr/local/samba/lib/smb.conf</filename></term>
 192                 <listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
 193                 <manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems
 194                 install this file are <filename>/usr/samba/lib/smb.conf</filename>
 195                 and <filename>/etc/samba/smb.conf</filename>.</para>
 196
 197                 <para>This file describes all the services the server
 198                 is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
 199                 <manvolnum>5</manvolnum></citerefentry> for more information.</para>
 200                 </listitem>
 201                 </varlistentry>
 202         </variablelist>
 203 </refsect1>
 204
 205 <refsect1>
 206         <title>LIMITATIONS</title>
 207         <para>On some systems <command>smbd</command> cannot change uid back
 208         to root after a setuid() call.  Such systems are called
 209         trapdoor uid systems. If you have such a system,
 210         you will be unable to connect from a client (such as a PC) as
 211         two different users at once. Attempts to connect the
 212         second user will result in access denied or
 213         similar.</para>
 214 </refsect1>
 215
 216 <refsect1>
 217         <title>ENVIRONMENT VARIABLES</title>
 218
 219         <variablelist>
 220                 <varlistentry>
 221                 <term><envar>PRINTER</envar></term>
 222                 <listitem><para>If no printer name is specified to
 223                 printable services, most systems will use the value of
 224                 this variable (or <constant>lp</constant> if this variable is
 225                 not defined) as the name of the printer to use. This
 226                 is not specific to the server, however.</para></listitem>
 227                 </varlistentry>
 228         </variablelist>
 229 </refsect1>
 230
 231
 232 <refsect1>
 233         <title>PAM INTERACTION</title>
 234         <para>Samba uses PAM for authentication (when presented with a plaintext
 235         password), for account checking (is this account disabled?) and for
 236         session management.  The degree too which samba supports PAM is restricted
 237         by the limitations of the SMB protocol and the <smbconfoption name="obey pam restrictions"/> <citerefentry><refentrytitle>smb.conf</refentrytitle>
 238         <manvolnum>5</manvolnum></citerefentry> paramater.  When this is set, the following restrictions apply:
 239         </para>
 240
 241         <itemizedlist>
 242         <listitem><para><emphasis>Account Validation</emphasis>:  All accesses to a
 243         samba server are checked
 244         against PAM to see if the account is vaild, not disabled and is permitted to
 245         login at this time.  This also applies to encrypted logins.
 246         </para></listitem>
 247
 248         <listitem><para><emphasis>Session Management</emphasis>:  When not using share
 249         level secuirty, users must pass PAM's session checks before access
 250         is granted.  Note however, that this is bypassed in share level secuirty.
 251         Note also that some older pam configuration files may need a line
 252         added for session support.
 253         </para></listitem>
 254         </itemizedlist>
 255 </refsect1>
 256
 257 <refsect1>
 258         <title>VERSION</title>
 259
 260         <para>This man page is correct for version 3.0 of
 261         the Samba suite.</para>
 262 </refsect1>
 263
 264 <refsect1>
 265         <title>DIAGNOSTICS</title>
 266
 267         <para>Most diagnostics issued by the server are logged
 268         in a specified log file. The log file name is specified
 269         at compile time, but may be overridden on the command line.</para>
 270
 271         <para>The number and nature of diagnostics available depends
 272         on the debug level used by the server. If you have problems, set
 273         the debug level to 3 and peruse the log files.</para>
 274
 275         <para>Most messages are reasonably self-explanatory. Unfortunately,
 276         at the time this man page was created, there are too many diagnostics
 277         available in the source code to warrant describing each and every
 278         diagnostic. At this stage your best bet is still to grep the
 279         source code and inspect the conditions that gave rise to the
 280         diagnostics you are seeing.</para>
 281 </refsect1>
 282
 283 <refsect1>
 284         <title>TDB FILES</title>
 285
 286         <para>Samba stores it's data in several TDB (Trivial Database) files, usually located in <filename>/var/lib/samba</filename>.</para>
 287
 288         <para>
 289         (*) information persistent across restarts (but not
 290         necessarily important to backup).
 291         </para>
 292
 293 <variablelist>
 294 <varlistentry><term>account_policy.tdb*</term>
 295 <listitem>
 296 <para>NT account policy settings such as pw expiration, etc...</para>
 297 </listitem>
 298 </varlistentry>
 299
 300 <varlistentry><term>brlock.tdb</term>
 301 <listitem><para>byte range locks</para></listitem>
 302 </varlistentry>
 303
 304 <varlistentry><term>browse.dat</term>
 305 <listitem><para>browse lists</para></listitem>
 306 </varlistentry>
 307
 308 <varlistentry><term>connections.tdb</term>
 309 <listitem><para>share connections (used to enforce max connections, etc...)</para></listitem>
 310 </varlistentry>
 311
 312 <varlistentry><term>gencache.tdb</term>
 313 <listitem><para>generic caching db</para></listitem>
 314 </varlistentry>
 315
 316 <varlistentry><term>group_mapping.tdb*</term>
 317 <listitem><para>group mapping information</para></listitem>
 318 </varlistentry>
 319
 320 <varlistentry><term>locking.tdb</term>
 321 <listitem><para>share modes &amp; oplocks</para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry><term>login_cache.tdb*</term>
 325 <listitem><para>bad pw attempts</para></listitem>
 326 </varlistentry>
 327
 328 <varlistentry><term>messages.tdb</term>
 329 <listitem><para>Samba messaging system</para></listitem>
 330 </varlistentry>
 331
 332 <varlistentry><term>netsamlogon_cache.tdb*</term>
 333 <listitem><para>cache of user net_info_3 struct from net_samlogon() request (as a domain member)</para></listitem>
 334 </varlistentry>
 335
 336 <varlistentry><term>ntdrivers.tdb*</term>
 337 <listitem><para>installed printer drivers</para></listitem>
 338 </varlistentry>
 339
 340 <varlistentry><term>ntforms.tdb*</term>
 341 <listitem><para>installed printer forms</para></listitem>
 342 </varlistentry>
 343
 344 <varlistentry><term>ntprinters.tdb*</term>
 345 <listitem><para>installed printer information</para></listitem>
 346 </varlistentry>
 347
 348 <varlistentry><term>printing/</term>
 349 <listitem><para>directory containing tdb per print queue of cached lpq output</para></listitem>
 350 </varlistentry>
 351
 352 <varlistentry><term>registry.tdb</term>
 353 <listitem><para>Windows registry skeleton (connect via regedit.exe)</para></listitem>
 354 </varlistentry>
 355
 356 <varlistentry><term>sessionid.tdb</term>
 357 <listitem><para>session information (e.g. support for 'utmp = yes')</para></listitem>
 358 </varlistentry>
 359
 360 <varlistentry><term>share_info.tdb*</term>
 361 <listitem><para>share acls</para></listitem>
 362 </varlistentry>
 363
 364 <varlistentry><term>winbindd_cache.tdb</term>
 365 <listitem><para>winbindd's cache of user lists, etc...</para></listitem>
 366 </varlistentry>
 367
 368 <varlistentry><term>winbindd_idmap.tdb*</term>
 369 <listitem><para>winbindd's local idmap db</para></listitem>
 370 </varlistentry>
 371
 372 <varlistentry><term>wins.dat*</term>
 373 <listitem><para>wins database when 'wins support = yes'</para></listitem>
 374 </varlistentry>
 375
 376 </variablelist>
 377
 378 </refsect1>
 379
 380 <refsect1>
 381         <title>SIGNALS</title>
 382
 383         <para>Sending the <command>smbd</command> a SIGHUP will cause it to
 384         reload its <filename>smb.conf</filename> configuration
 385         file within a short period of time.</para>
 386
 387         <para>To shut down a user's <command>smbd</command> process it is recommended
 388         that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis>
 389         be used, except as a last resort, as this may leave the shared
 390         memory area in an inconsistent state. The safe way to terminate
 391         an <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for
 392         it to die on its own.</para>
 393
 394         <para>The debug log level of <command>smbd</command> may be raised
 395         or lowered using <citerefentry><refentrytitle>smbcontrol</refentrytitle>
 396         <manvolnum>1</manvolnum></citerefentry> program (SIGUSR[1|2] signals are no longer
 397         used since Samba 2.2). This is to allow transient problems to be diagnosed,
 398         whilst still running at a normally low log level.</para>
 399
 400         <para>Note that as the signal handlers send a debug write,
 401         they are not re-entrant in <command>smbd</command>. This you should wait until
 402         <command>smbd</command> is in a state of waiting for an incoming SMB before
 403         issuing them. It is possible to make the signal handlers safe
 404         by un-blocking the signals before the select call and re-blocking
 405         them after, however this would affect performance.</para>
 406 </refsect1>
 407
 408 <refsect1>
 409         <title>SEE ALSO</title>
 410         <para><citerefentry><refentrytitle>hosts_access</refentrytitle>
 411         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>inetd</refentrytitle>
 412         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle>
 413         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 414         <manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
 415         <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
 416         <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle>
 417         <manvolnum>1</manvolnum></citerefentry>, and the
 418         Internet RFC's  <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
 419         In addition the CIFS (formerly SMB) specification is available
 420         as a link from the Web page <ulink noescape="1" url="http://samba.org/cifs/">
 421         http://samba.org/cifs/</ulink>.</para>
 422 </refsect1>
 423
 424 <refsect1>
 425         <title>AUTHOR</title>
 426
 427         <para>The original Samba software and related utilities
 428         were created by Andrew Tridgell. Samba is now developed
 429         by the Samba Team as an Open Source project similar
 430         to the way the Linux kernel is developed.</para>
 431
 432         <para>The original Samba man pages were written by Karl Auer.
 433         The man page sources were converted to YODL format (another
 434         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 435         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 436         release by Jeremy Allison.  The conversion to DocBook for
 437         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 438         Samba 3.0 was done by Alexander Bokovoy.</para>
 439 </refsect1>
 440
 441 </refentry>