trying to get HEAD building again. If you want the code
[gd/samba-autobuild/.git] / docs / htmldocs / smbd.8.html
index 2ae976c3e8a957c854f95fce441885c44d057e2c..5b71bd7196010306ec355c2d191b1b3dbfed19ab 100644 (file)
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbd.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbd &#8212; server to provide SMB/CIFS services to clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbd</tt>  [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d &lt;debug level&gt;] [-l &lt;log directory&gt;] [-p &lt;port number&gt;] [-O &lt;socket option&gt;] [-s &lt;configuration file&gt;]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This program is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>smbd</b> is the server daemon that 
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbd</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbd.8"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbd &#8212; server to provide SMB/CIFS services to clients</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbd</tt>  [-D] [-F] [-S] [-i] [-h] [-V] [-b] [-d &lt;debug level&gt;] [-l &lt;log directory&gt;] [-p &lt;port number&gt;] [-O &lt;socket option&gt;] [-s &lt;configuration file&gt;]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This program is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbd</b> is the server daemon that 
        provides filesharing and printing services to Windows clients. 
        The server provides filespace and printer services to
        clients using the SMB (or CIFS) protocol. This is compatible 
@@ -8,10 +8,10 @@
        OS/2, DAVE for Macintosh, and smbfs for Linux.</p><p>An extensive description of the services that the 
        server can provide is given in the man page for the 
        configuration file controlling the attributes of those 
-       services (see <a href="smb.conf.5.html">smb.conf(5)</a>.  This man page will not describe the 
+       services (see <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>.  This man page will not describe the 
        services, but will concentrate on the administrative aspects 
        of running the server.</p><p>Please note that there are significant security 
-       implications to running this server, and the <a href="smb.conf.5.html">smb.conf(5)</a> manual page should be regarded as mandatory reading before 
+       implications to running this server, and the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> manual page should be regarded as mandatory reading before 
        proceeding with installation.</p><p>A session is created whenever a client requests one. 
        Each client gets a copy of the server for each session. This 
        copy then services all connections made by the client during 
        can force a reload by sending a SIGHUP to the server.  Reloading 
        the configuration file will not affect connections to any service 
        that is already established.  Either the user will have to 
-       disconnect from the service, or <b>smbd</b> killed and restarted.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes 
+       disconnect from the service, or <b class="command">smbd</b> killed and restarted.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-D</span></dt><dd><p>If specified, this parameter causes 
                the server to operate as a daemon. That is, it detaches 
                itself and runs in the background, fielding requests 
                on the appropriate port. Operating the server as a
-               daemon is the recommended way of running <b>smbd</b> for 
+               daemon is the recommended way of running <b class="command">smbd</b> for 
                servers that provide more than casual use file and 
-               print services.  This switch is assumed if <b>smbd
+               print services.  This switch is assumed if <b class="command">smbd
                </b> is executed on the command line of a shell.
                </p></dd><dt><span class="term">-F</span></dt><dd><p>If specified, this parameter causes
-               the main <b>smbd</b> process to not daemonize,
+               the main <b class="command">smbd</b> process to not daemonize,
                i.e. double-fork and disassociate with the terminal.
                Child processes are still created as normal to service
                each connection request, but the main process does not
                exit. This operation mode is suitable for running
-               <b>smbd</b> under process supervisors such
-               as <b>supervise</b> and <b>svscan</b>
-               from Daniel J. Bernstein's <b>daemontools</b>
+               <b class="command">smbd</b> under process supervisors such
+               as <b class="command">supervise</b> and <b class="command">svscan</b>
+               from Daniel J. Bernstein's <b class="command">daemontools</b>
                package, or the AIX process monitor.
                </p></dd><dt><span class="term">-S</span></dt><dd><p>If specified, this parameter causes
-               <b>smbd</b> to log to standard output rather
+               <b class="command">smbd</b> to log to standard output rather
                than a file.</p></dd><dt><span class="term">-i</span></dt><dd><p>If this parameter is specified it causes the
                server to run &quot;interactively&quot;, not as a daemon, even if the
                server is executed on the command line of a shell. Setting this
                parameter negates the implicit deamon mode when run from the
-               command line. <b>smbd</b> also logs to standard
-               output, as if the <b>-S</b> parameter had been
+               command line. <b class="command">smbd</b> also logs to standard
+               output, as if the <b class="command">-S</b> parameter had been
                given.
                </p></dd><dt><span class="term">-V</span></dt><dd><p>Prints the version number for 
-<b>smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
+<b class="command">smbd</b>.</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
 configuration details required by the server.  The 
 information in this file includes server-specific
 information such as what printcap file to use, as well 
 as descriptions of all the services that the server is 
-to provide. See <a href="smb.conf.5.html" target="_top"><tt>
+to provide. See <a href="smb.conf.5.html" target="_top"><tt class="filename">
 smb.conf(5)</tt></a> for more information.
 The default configuration file name is determined at 
-compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer 
+compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 
 from 0 to 10.  The default value if this parameter is 
 not specified is zero.</p><p>The higher this value, the more detail will be 
 logged to the log files about the activities of the 
@@ -71,23 +71,23 @@ use only by developers and generate HUGE amounts of log
 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
 override the <a href="smb.conf.5.html#loglevel" target="_top">log
 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
-<tt>smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
-<tt>&quot;.client&quot;</tt> will be appended. The log file is
+<tt class="filename">smb.conf(5)</tt></a> file.</p></dd><dt><span class="term">-l|--logfile=logbasename</span></dt><dd><p>File name for log/debug files. The extension
+<tt class="constant">&quot;.client&quot;</tt> will be appended. The log file is
 never removed by the client.
 </p></dd><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
 </p></dd><dt><span class="term">-b</span></dt><dd><p>Prints information about how 
                Samba was built.</p></dd><dt><span class="term">-l &lt;log directory&gt;</span></dt><dd><p>If specified,
-               <i><tt>log directory</tt></i> 
+               <i class="replaceable"><tt>log directory</tt></i> 
                specifies a log directory into which the &quot;log.smbd&quot; log
                file will be created for informational and debug 
                messages from the running server. The log 
                file generated is never removed by the server although 
-               its size may be controlled by the <a href="smb.conf.5.html#maxlogsize" target="_top"><i><tt>max log size</tt></i></a>
-               option in the <a href="smb.conf.5.html">smb.conf(5)</a> file. <span class="emphasis"><em>Beware:</em></span>
-               If the directory specified does not exist, <b>smbd</b>
+               its size may be controlled by the <a href="smb.conf.5.html#maxlogsize" target="_top"><i class="parameter"><tt>max log size</tt></i></a>
+               option in the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file. <span class="emphasis"><em>Beware:</em></span>
+               If the directory specified does not exist, <b class="command">smbd</b>
                will log to the default debug log location defined at compile time.
                </p><p>The default log directory is specified at
-               compile time.</p></dd><dt><span class="term">-p &lt;port number&gt;</span></dt><dd><p><i><tt>port number</tt></i> is a positive integer 
+               compile time.</p></dd><dt><span class="term">-p &lt;port number&gt;</span></dt><dd><p><i class="replaceable"><tt>port number</tt></i> is a positive integer 
                value.  The default value if this parameter is not 
                specified is 139.</p><p>This number is the port number that will be 
                used when making connections to the server from client 
@@ -101,38 +101,38 @@ never removed by the client.
                than 139, you will require port redirection services 
                on port 139, details of which are outlined in rfc1002.txt 
                section 4.3.5.</p><p>This parameter is not normally specified except 
-               in the above situation.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt>/etc/inetd.conf</tt></span></dt><dd><p>If the server is to be run by the 
-               <b>inetd</b> meta-daemon, this file 
+               in the above situation.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><tt class="filename">/etc/inetd.conf</tt></span></dt><dd><p>If the server is to be run by the 
+               <b class="command">inetd</b> meta-daemon, this file 
                must contain suitable startup information for the 
                meta-daemon. See the <a href="install.html" target="_top">&quot;How to Install and Test SAMBA&quot;</a>
                document for details.
-               </p></dd><dt><span class="term"><tt>/etc/rc</tt></span></dt><dd><p>or whatever initialization script your 
+               </p></dd><dt><span class="term"><tt class="filename">/etc/rc</tt></span></dt><dd><p>or whatever initialization script your 
                system uses).</p><p>If running the server as a daemon at startup, 
                this file will need to contain an appropriate startup 
                sequence for the server. See the <a href="install.html" target="_top">&quot;How to Install and Test SAMBA&quot;</a>
-               document for details.</p></dd><dt><span class="term"><tt>/etc/services</tt></span></dt><dd><p>If running the server via the 
-               meta-daemon <b>inetd</b>, this file 
+               document for details.</p></dd><dt><span class="term"><tt class="filename">/etc/services</tt></span></dt><dd><p>If running the server via the 
+               meta-daemon <b class="command">inetd</b>, this file 
                must contain a mapping of service name (e.g., netbios-ssn) 
                to service port (e.g., 139) and protocol type (e.g., tcp). 
                See the <a href="install.html" target="_top">&quot;How to Install and Test SAMBA&quot;</a>
-               document for details.</p></dd><dt><span class="term"><tt>/usr/local/samba/lib/smb.conf</tt></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html">smb.conf(5)</a> server configuration file. Other common places that systems 
-               install this file are <tt>/usr/samba/lib/smb.conf</tt> 
-               and <tt>/etc/samba/smb.conf</tt>.</p><p>This file describes all the services the server 
-               is to make available to clients. See <a href="smb.conf.5.html">smb.conf(5)</a> for more information.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>LIMITATIONS</h2><p>On some systems <b>smbd</b> cannot change uid back 
+               document for details.</p></dd><dt><span class="term"><tt class="filename">/usr/local/samba/lib/smb.conf</tt></span></dt><dd><p>This is the default location of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> server configuration file. Other common places that systems 
+               install this file are <tt class="filename">/usr/samba/lib/smb.conf</tt> 
+               and <tt class="filename">/etc/samba/smb.conf</tt>.</p><p>This file describes all the services the server 
+               is to make available to clients. See <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> for more information.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>LIMITATIONS</h2><p>On some systems <b class="command">smbd</b> cannot change uid back 
        to root after a setuid() call.  Such systems are called 
        trapdoor uid systems. If you have such a system, 
        you will be unable to connect from a client (such as a PC) as 
        two different users at once. Attempts to connect the
        second user will result in access denied or 
-       similar.</p></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><div class="variablelist"><dl><dt><span class="term"><tt>PRINTER</tt></span></dt><dd><p>If no printer name is specified to 
+       similar.</p></div><div class="refsect1" lang="en"><h2>ENVIRONMENT VARIABLES</h2><div class="variablelist"><dl><dt><span class="term"><tt class="envar">PRINTER</tt></span></dt><dd><p>If no printer name is specified to 
                printable services, most systems will use the value of 
-               this variable (or <tt>lp</tt> if this variable is 
+               this variable (or <tt class="constant">lp</tt> if this variable is 
                not defined) as the name of the printer to use. This 
                is not specific to the server, however.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>PAM INTERACTION</h2><p>Samba uses PAM for authentication (when presented with a plaintext 
        password), for account checking (is this account disabled?) and for
        session management.  The degree too which samba supports PAM is restricted
-       by the limitations of the SMB protocol and the <a href="smb.conf.5.html#OBEYPAMRESRICTIONS" target="_top"><i><tt>obey 
-       pam restricions</tt></i></a> <a href="smb.conf.5.html">smb.conf(5)</a> paramater.  When this is set, the following restrictions apply:
+       by the limitations of the SMB protocol and the <a href="smb.conf.5.html#OBEYPAMRESRICTIONS" target="_top"><i class="parameter"><tt>obey 
+       pam restricions</tt></i></a> <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> paramater.  When this is set, the following restrictions apply:
        </p><div class="itemizedlist"><ul type="disc"><li><p><span class="emphasis"><em>Account Validation</em></span>:  All accesses to a 
        samba server are checked 
        against PAM to see if the account is vaild, not disabled and is permitted to 
@@ -152,23 +152,23 @@ never removed by the client.
        available in the source code to warrant describing each and every 
        diagnostic. At this stage your best bet is still to grep the 
        source code and inspect the conditions that gave rise to the 
-       diagnostics you are seeing.</p></div><div class="refsect1" lang="en"><h2>SIGNALS</h2><p>Sending the <b>smbd</b> a SIGHUP will cause it to 
-       reload its <tt>smb.conf</tt> configuration 
-       file within a short period of time.</p><p>To shut down a user's <b>smbd</b> process it is recommended 
-       that <b>SIGKILL (-9)</b> <span class="emphasis"><em>NOT</em></span> 
+       diagnostics you are seeing.</p></div><div class="refsect1" lang="en"><h2>SIGNALS</h2><p>Sending the <b class="command">smbd</b> a SIGHUP will cause it to 
+       reload its <tt class="filename">smb.conf</tt> configuration 
+       file within a short period of time.</p><p>To shut down a user's <b class="command">smbd</b> process it is recommended 
+       that <b class="command">SIGKILL (-9)</b> <span class="emphasis"><em>NOT</em></span> 
        be used, except as a last resort, as this may leave the shared
        memory area in an inconsistent state. The safe way to terminate 
-       an <b>smbd</b> is to send it a SIGTERM (-15) signal and wait for 
-       it to die on its own.</p><p>The debug log level of <b>smbd</b> may be raised
-       or lowered using <a href="smbcontrol.1.html">smbcontrol(1)</a> program (SIGUSR[1|2] signals are no longer 
+       an <b class="command">smbd</b> is to send it a SIGTERM (-15) signal and wait for 
+       it to die on its own.</p><p>The debug log level of <b class="command">smbd</b> may be raised
+       or lowered using <a href="smbcontrol.1.html"><span class="citerefentry"><span class="refentrytitle">smbcontrol</span>(1)</span></a> program (SIGUSR[1|2] signals are no longer 
        used since Samba 2.2). This is to allow transient problems to be diagnosed, 
        whilst still running at a normally low log level.</p><p>Note that as the signal handlers send a debug write, 
-       they are not re-entrant in <b>smbd</b>. This you should wait until 
-       <b>smbd</b> is in a state of waiting for an incoming SMB before 
+       they are not re-entrant in <b class="command">smbd</b>. This you should wait until 
+       <b class="command">smbd</b> is in a state of waiting for an incoming SMB before 
        issuing them. It is possible to make the signal handlers safe 
        by un-blocking the signals before the select call and re-blocking 
-       them after, however this would affect performance.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="hosts_access.5.html">hosts_access(5)</a>, <a href="inetd.8.html">inetd(8)</a>, <a href="nmbd.8.html">nmbd(8)</a>, <a href="smb.conf.5.html">smb.conf(5)</a>, <a href="smbclient.1.html">smbclient(1)</a>, <a href="testparm.1.html">testparm(1)</a>, <a href="testprns.1.html">testprns(1)</a>, and the 
-       Internet RFC's  <tt>rfc1001.txt</tt>, <tt>rfc1002.txt</tt>. 
+       them after, however this would affect performance.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="hosts_access.5.html"><span class="citerefentry"><span class="refentrytitle">hosts_access</span>(5)</span></a>, <a href="inetd.8.html"><span class="citerefentry"><span class="refentrytitle">inetd</span>(8)</span></a>, <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>, and the 
+       Internet RFC's  <tt class="filename">rfc1001.txt</tt>, <tt class="filename">rfc1002.txt</tt>. 
        In addition the CIFS (formerly SMB) specification is available 
        as a link from the Web page <a href="http://samba.org/cifs/" target="_top"> 
        http://samba.org/cifs/</a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities