<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="smbd">

<refmeta>
	<refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>smbd</refname>
	<refpurpose>server to provide SMB/CIFS services to clients</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>smbd</command>
		<arg choice="opt">-D</arg>
		<arg choice="opt">-a</arg>
		<arg choice="opt">-i</arg>
		<arg choice="opt">-o</arg>
		<arg choice="opt">-P</arg>
		<arg choice="opt">-h</arg>
		<arg choice="opt">-V</arg>
		<arg choice="opt">-d &lt;debug level&gt;</arg>
		<arg choice="opt">-l &lt;log directory&gt;</arg>
		<arg choice="opt">-p &lt;port number&gt;</arg>
		<arg choice="opt">-O &lt;socket option&gt;</arg>
		<arg choice="opt">-s &lt;configuration file&gt;</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>
	<para>This program is part of the Samba suite.</para>

	<para><command>smbd</command> 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 
	with the LanManager protocol, and can service LanManager 
	clients.  These include MSCLIENT 3.0 for DOS, Windows for 
	Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, 
	OS/2, DAVE for Macintosh, and smbfs for Linux.</para>

	<para>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 <ulink url="smb.conf.5.html"><filename>smb.conf(5)
	</filename></ulink>.  This man page will not describe the 
	services, but will concentrate on the administrative aspects 
	of running the server.</para>

	<para>Please note that there are significant security 
	implications to running this server, and the <ulink
	url="smb.conf.5.html"><filename>smb.conf(5)</filename></ulink> 
	manpage should be regarded as mandatory reading before
	proceeding with installation.</para>

	<para>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 
	that session. When all connections from its client are closed, 
	the copy of the server for that client terminates.</para>

	<para>The configuration file, and any files that it includes, 
	are automatically reloaded every minute, if they change.  You 
	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 <command>smbd</command> killed and restarted.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>-D</term>
		<listitem><para>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 <command>smbd</command> for 
		servers that provide more than casual use file and 
		print services.  This switch is assumed if <command>smbd
		</command> is executed on the command line of a shell.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>-a</term>
		<listitem><para>If this parameter is specified, each new 
		connection will append log messages to the log file.  
		This is the default.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-i</term>
		<listitem><para>If this parameter is specified it causes the
		server to run "interactively", 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.
		</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-o</term>
		<listitem><para>If this parameter is specified, the 
		log files will be overwritten when opened.  By default, 
		<command>smbd</command> will append entries to the log 
		files.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-P</term>
		<listitem><para>Passive option. Causes <command>smbd</command> not to 
		send any network traffic out. Used for debugging by 
		the developers only.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-h</term>
		<listitem><para>Prints the help information (usage) 
		for <command>smbd</command>.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-v</term>
		<listitem><para>Prints the version number for 
		<command>smbd</command>.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-d &lt;debug level&gt;</term>
		<listitem><para><replaceable>debuglevel</replaceable> is an integer 
		from 0 to 10.  The default value if this parameter is 
		not specified is zero.</para>
		
		<para>The higher this value, the more detail will be 
		logged to the log files about the activities of the 
		server. At level 0, only critical errors and serious 
		warnings will be logged. Level 1 is a reasonable level for
		day to day running - it generates a small amount of
		information about operations carried out.</para>

		<para>Levels above 1 will generate considerable 
		amounts of log data, and should only be used when 
		investigating a problem. Levels above 3 are designed for 
		use only by developers and generate HUGE amounts of log
		data, most of which is extremely cryptic.</para>

		<para>Note that specifying this parameter here will 
		override the <ulink url="smb.conf.5.html#loglevel">log
		level</ulink> parameter in the <ulink url="smb.conf.5.html">
		<filename>smb.conf(5)</filename></ulink> file.</para>
		</listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-l &lt;log directory&gt;</term>
		<listitem><para>If specified,
		<replaceable>log directory</replaceable> 
		specifies a log directory into which the "log.smbd" 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 <ulink 
		url="smb.conf.5.html#maxlogsize">max log size</ulink>
		option in the <ulink url="smb.conf.5.html"><filename>
		smb.conf(5)</filename></ulink> file. <emphasis>Beware:</emphasis>
		If the directory specified does not exist, <command>smbd</command>
		will log to the default debug log location defined at compile time.
		</para>

		<para>The default log directory is specified at
		compile time.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-O &lt;socket options&gt;</term>
		<listitem><para>See the <ulink 
		url="smb.conf.5.html#socketoptions">socket options</ulink> 
		parameter in the <ulink url="smb.conf.5.html"><filename>smb.conf(5)
		</filename></ulink> file for details.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-p &lt;port number&gt;</term>
		<listitem><para><replaceable>port number</replaceable> is a positive integer
		value.  The default value if this parameter is not 
		specified is 139.</para>
		
		<para>This number is the port number that will be 
		used when making connections to the server from client 
		software. The standard (well-known) port number for the 
		SMB over TCP is 139, hence the default. If you wish to
		run the server as an ordinary user rather than
		as root, most systems will require you to use a port 
		number greater than 1024 - ask your system administrator 
		for help if you are in this situation.</para>
		
		<para>In order for the server to be useful by most 
		clients, should you configure it on a port other 
		than 139, you will require port redirection services 
		on port 139, details of which are outlined in rfc1002.txt 
		section 4.3.5.</para>
		
		<para>This parameter is not normally specified except 
		in the above situation.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>-s &lt;configuration file&gt;</term>
		<listitem><para>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 <ulink url="smb.conf.5.html"><filename>
		smb.conf(5)</filename></ulink> for more information.
		The default configuration file name is determined at
		compile time.</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>FILES</title>

	<variablelist>
		<varlistentry>
		<term><filename>/etc/inetd.conf</filename></term>
		<listitem><para>If the server is to be run by the
		<command>inetd</command> meta-daemon, this file 
		must contain suitable startup information for the 
		meta-daemon. See the <ulink url="UNIX_INSTALL.html">UNIX_INSTALL.html</ulink>
		document for details.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><filename>/etc/rc</filename></term>
		<listitem><para>or whatever initialization script your
		system uses).</para>

		<para>If running the server as a daemon at startup,
		this file will need to contain an appropriate startup
		sequence for the server. See the <ulink url="UNIX_INSTALL.html">UNIX_INSTALL.html</ulink>
		document for details.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><filename>/etc/services</filename></term>
		<listitem><para>If running the server via the
		meta-daemon <command>inetd</command>, 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 <ulink url="UNIX_INSTALL.html">UNIX_INSTALL.html</ulink>
		document for details.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term><filename>/usr/local/samba/lib/smb.conf</filename></term>
		<listitem><para>This is the default location of the
		<ulink url="smb.conf.5.html"><filename>smb.conf</filename></ulink>
		server configuration file. Other common places that systems
		install this file are <filename>/usr/samba/lib/smb.conf</filename>
		and <filename>/etc/smb.conf</filename>.</para>

		<para>This file describes all the services the server
		is to make available to clients. See <ulink url="smb.conf.5.html">
		<filename>smb.conf(5)</filename></ulink>  for more information.</para>
		</listitem>
		</varlistentry>
	</variablelist>
</refsect1>

<refsect1>
	<title>LIMITATIONS</title>
	<para>On some systems <command>smbd</command> 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.</para>
</refsect1>

<refsect1>
	<title>ENVIRONMENT VARIABLES</title>

	<variablelist>
		<varlistentry>
		<term><envar>PRINTER</envar></term>
		<listitem><para>If no printer name is specified to 
		printable services, most systems will use the value of 
		this variable (or <constant>lp</constant> if this variable is 
		not defined) as the name of the printer to use. This 
		is not specific to the server, however.</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>


<refsect1>
        <title>PAM INTERACTION</title>
	<para>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
	<ulink url="smb.conf.5.html#OBEYPAMRESRICTIONS">obey pam restricions</ulink>
	smb.conf paramater.  When this is set, the following restrictions apply:
	</para>

	<itemizedlist>
	<listitem><para><emphasis>Account Validation</emphasis>:  All acccesses to a 
	samba server are checked 
	against PAM to see if the account is vaild, not disabled and is permitted to 
	login at this time.  This also applies to encrypted logins.
	</para></listitem>

	<listitem><para><emphasis>Session Management</emphasis>:  When not using share 
	level secuirty, users must pass PAM's session checks before access
	is granted.  Note however, that this is bypassed in share level secuirty.  
	Note also that some older pam configuration files may need a line 
	added for session support. 
	</para></listitem>
	</itemizedlist>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 2.2 of
	the Samba suite.</para>
</refsect1>

<refsect1>
        <title>TROUBLESHOOTING</title>

        <para>
        One of the common causes of difficulty when installing Samba and SWAT
        is the existsnece of some type of firewall or port filtering software
        on the Samba server.  Make sure that the appropriate ports
        outlined in this man page are available on the server and are not currently
        being blocked by some type of security software such as iptables or
        "port sentry".  For more troubleshooting information, refer to the additional
        documentation included in the Samba distribution.
        </para>

	<para>Most diagnostics issued by the server are logged
	in a specified log file. The log file name is specified
	at compile time, but may be overridden on the command line.</para>

	<para>The number and nature of diagnostics available depends
	on the debug level used by the server. If you have problems, set
	the debug level to 3 and peruse the log files.</para>

	<para>Most messages are reasonably self-explanatory. Unfortunately,
	at the time this man page was created, there are too many diagnostics
	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.</para>
</refsect1>

<refsect1>
	<title>SIGNALS</title>

	<para>Sending the <command>smbd</command> a SIGHUP will cause it to
	reload its <filename>smb.conf</filename> configuration
	file within a short period of time.</para>

	<para>To shut down a user's <command>smbd</command> process it is recommended
	that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis>
	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 <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for
	it to die on its own.</para>

	<para>The debug log level of <command>smbd</command> may be raised
	or lowered using <ulink url="smbcontrol.1.html"><command>smbcontrol(1)
	</command></ulink> program (SIGUSR[1|2] signals are no longer used in
	Samba 2.2). This is to allow transient problems to be diagnosed,
	whilst still running at a normally low log level.</para>

	<para>Note that as the signal handlers send a debug write, 
	they are not re-entrant in <command>smbd</command>. This you should wait until 
	<command>smbd</command> 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.</para>
</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para>hosts_access(5), <command>inetd(8)</command>, 
	<ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>, 
	<ulink url="smb.conf.5.html"><filename>smb.conf(5)</filename>
	</ulink>, <ulink url="smbclient.1.html"><command>smbclient(1)
	</command></ulink>, <ulink url="testparm.1.html"><command>
	testparm(1)</command></ulink>, <ulink url="testprns.1.html">
	<command>testprns(1)</command></ulink>, and the Internet RFC's
	<filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>. 
	In addition the CIFS (formerly SMB) specification is available 
	as a link from the Web page <ulink url="http://samba.org/cifs/"> 
	http://samba.org/cifs/</ulink>.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</para>
	
	<para>The original Samba man pages were written by Karl Auer. 
	The man page sources were converted to YODL format (another 
	excellent piece of Open Source software, available at
	<ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
	ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
	release by Jeremy Allison.  The conversion to DocBook for 
	Samba 2.2 was done by Gerald Carter</para>
</refsect1>

</refentry>
