diff options
| -rw-r--r-- | docs/htmldocs/nmbd.8.html | 888 | ||||
| -rw-r--r-- | docs/htmldocs/smbd.8.html | 1347 | ||||
| -rw-r--r-- | docs/manpages/nmbd.8 | 459 | ||||
| -rw-r--r-- | docs/manpages/smbd.8 | 876 |
4 files changed, 2347 insertions, 1223 deletions
diff --git a/docs/htmldocs/nmbd.8.html b/docs/htmldocs/nmbd.8.html index 12f8178cfa3..41021bddb33 100644 --- a/docs/htmldocs/nmbd.8.html +++ b/docs/htmldocs/nmbd.8.html @@ -1,206 +1,682 @@ - - - - - - -<html><head><title>nmbd</title> - -<link rev="made" href="mailto:samba@samba.org"> -</head> -<body> - -<hr> - -<h1>nmbd</h1> -<h2>Samba</h2> -<h2>23 Oct 1998</h2> - - - -<p><a name="NAME"></a> -<h2>NAME</h2> - nmbd - NetBIOS name server to provide NetBIOS over IP -naming services to clients -<p><a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> - -<p><strong>nmbd</strong> [<a href="nmbd.8.html#minusD">-D</a>] [<a href="nmbd.8.html#minusa">-a</a>] [<a href="nmbd.8.html#minuso">-o</a>] [<a href="nmbd.8.html#minush">-h</a>] [<a href="nmbd.8.html#minusV">-V</a>] [<a href="nmbd.8.html#minusH">-H lmhosts file</a>] [<a href="nmbd.8.html#minusd">-d debuglevel</a>] [<a href="nmbd.8.html#minusl">-l log file basename</a>] [<a href="nmbd.8.html#minusn">-n primary NetBIOS name</a>] [<a href="nmbd.8.html#minusp">-p port number</a>] [<a href="nmbd.8.html#minuss">-s configuration file</a>] -<p><a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> - -<p>This program is part of the <strong>Samba</strong> suite. -<p><strong>nmbd</strong> is a server that understands and can reply to NetBIOS over IP -name service requests, like those produced by SMBD/CIFS clients such -as Windows 95/98, Windows NT and LanManager clients. It also -participates in the browsing protocols which make up the Windows -"Network Neighborhood" view. -<p>SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS -server. That is, they wish to know what IP number a specified host is -using. -<p>Amongst other services, <strong>nmbd</strong> will listen for such requests, -and if its own NetBIOS name is specified it will respond with the IP -number of the host it is running on. Its "own NetBIOS name" is by -default the primary DNS name of the host it is running on, but this -can be overridden with the <strong>-n</strong> option (see <a href="nmbd.8.html#OPTIONS">OPTIONS</a> below). Thus -<strong>nmbd</strong> will reply to broadcast queries for its own name(s). Additional -names for <strong>nmbd</strong> to respond on can be set via parameters in the -<a href="smb.conf.5.html"><strong>smb.conf(5)</strong></a> configuration file. -<p><strong>nmbd</strong> can also be used as a WINS (Windows Internet Name Server) -server. What this basically means is that it will act as a WINS -database server, creating a database from name registration requests -that it receives and replying to queries from clients for these names. -<p>In addition, <strong>nmbd</strong> can act as a WINS proxy, relaying broadcast queries -from clients that do not understand how to talk the WINS protocol to a -WIN server. -<p><a name="OPTIONS"></a> -<h2>OPTIONS</h2> - -<p><dl> -<p><a name="minusD"></a> -<p></p><dt><strong><strong>-D</strong></strong><dd> If specified, this parameter causes <strong>nmbd</strong> to operate -as a daemon. That is, it detaches itself and runs in the background, -fielding requests on the appropriate port. By default, <strong>nmbd</strong> will -NOT operate as a daemon. nmbd can also be operated from the inetd -meta-daemon, although this is not recommended. -<p><a name="minusa"></a> -<p></p><dt><strong><strong>-a</strong></strong><dd> If this parameter is specified, each new connection will -append log messages to the log file. This is the default. -<p><a name="minuso"></a> -<p></p><dt><strong><strong>-o</strong></strong><dd> If this parameter is specified, the log files will be -overwritten when opened. By default, the log files will be appended -to. -<p><a name="minush"></a> -<p></p><dt><strong><strong>-h</strong></strong><dd> Prints the help information (usage) for <strong>nmbd</strong>. -<p><a name="minusV"></a> -<p></p><dt><strong><strong>-V</strong></strong><dd> Prints the version number for <strong>nmbd</strong>. -<p><a name="minusH"></a> -<p></p><dt><strong><strong>-H filename</strong></strong><dd> NetBIOS lmhosts file. -<p>The lmhosts file is a list of NetBIOS names to IP addresses that is -loaded by the nmbd server and used via the name resolution mechanism -<a href="smb.conf.5.html#nameresolveorder"><strong>name resolve order</strong></a> described in -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> to resolve any -NetBIOS name queries needed by the server. Note that the contents of -this file are <em>NOT</em> used by <strong>nmbd</strong> to answer any name queries. Adding -a line to this file affects name NetBIOS resolution from this host -<em>ONLY</em>. -<p>The default path to this file is compiled into Samba as part of the -build process. Common defaults are <em>/usr/local/samba/lib/lmhosts</em>, -<em>/usr/samba/lib/lmhosts</em> or <em>/etc/lmhosts</em>. See the -<a href="lmhosts.5.html"><strong>lmhosts (5)</strong></a> man page for details on the contents of this file. -<p><a name="minusd"></a> -<p></p><dt><strong><strong>-d debuglevel</strong></strong><dd> debuglevel is an integer from 0 to 10. -<p>The default value if this parameter is not specified is zero. -<p>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. -<p>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. -<p>Note that specifying this parameter here will override the <a href="smb.conf.5.html#loglevel"><strong>log -level</strong></a> parameter in the <a href="smb.conf.5.html"><strong>smb.conf -(5)</strong></a> file. -<p><a name="minusl"></a> -<p></p><dt><strong><strong>-l logfile</strong></strong><dd> The <strong>-l</strong> parameter specifies a path and base -filename into which operational data from the running nmbd server will -be logged. The actual log file name is generated by appending the -extension ".nmb" to the specified base name. For example, if the name -specified was "log" then the file log.nmb would contain the debugging -data. -<p>The default log file path is compiled into Samba as part of the -build process. Common defaults are <em>/usr/local/samba/var/log.nmb</em>, -<em>/usr/samba/var/log.nmb</em> or <em>/var/log/log.nmb</em>. -<p><a name="minusn"></a> -<p></p><dt><strong><strong>-n primary NetBIOS name</strong></strong><dd> This option allows you to override -the NetBIOS name that Samba uses for itself. This is identical to -setting the <a href="smb.conf.5.html#netbiosname"><strong>NetBIOS name</strong></a> parameter -in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file -but will override the setting in the <a href="smb.conf.5.html"><strong>smb.conf</strong></a> file. -<p><a name="minusp"></a> -<p></p><dt><strong><strong>-p UDP port number</strong></strong><dd> UDP port number is a positive integer value. -<p>This option changes the default UDP port number (normally 137) that -<strong>nmbd</strong> responds to name queries on. Don't use this option unless you are -an expert, in which case you won't need help! -<p><a name="minuss"></a> -<p></p><dt><strong><strong>-s configuration file</strong></strong><dd> The default configuration file name is -set at build time, typically as <em>/usr/local/samba/lib/smb.conf</em>, but -this may be changed when Samba is autoconfigured. -<p>The file specified contains the configuration details required by the -server. See <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> for more information. -<p></dl> -<p><a name="FILES"></a> -<h2>FILES</h2> - -<p><strong>/etc/inetd.conf</strong> -<p>If the server is to be run by the inetd meta-daemon, this file must -contain suitable startup information for the meta-daemon. -<p><strong>/etc/rc</strong> -<p>(or whatever initialization script your system uses). -<p>If running the server as a daemon at startup, this file will need to -contain an appropriate startup sequence for the server. -<p><strong>/usr/local/samba/lib/smb.conf</strong> -<p>This is the default location of the -<a href="smb.conf.5.html"><strong>smb.conf</strong></a> server configuration -file. Other common places that systems install this file are -<em>/usr/samba/lib/smb.conf</em> and <em>/etc/smb.conf</em>. -<p>When run as a <strong>WINS</strong> server (see the <a href="smb.conf.5.html#winssupport"><strong>wins support</strong></a> -parameter in the <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> man page), <strong>nmbd</strong> will -store the WINS database in the file <code>wins.dat</code> in the <code>var/locks</code> directory -configured under wherever Samba was configured to install itself. -<p>If <strong>nmbd</strong> is acting as a <strong>browse master</strong> (see the <a href="smb.conf.5.html#localmaster"><strong>local master</strong></a> -parameter in the <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> man page), <strong>nmbd</strong> will -store the browsing database in the file <code>browse.dat</code> in the <code>var/locks</code> directory -configured under wherever Samba was configured to install itself. -<p><a name="SIGNALS"></a> -<h2>SIGNALS</h2> - -<p>To shut down an <strong>nmbd</strong> process it is recommended that SIGKILL (-9) -<em>NOT</em> be used, except as a last resort, as this may leave the name -database in an inconsistent state. The correct way to terminate -<strong>nmbd</strong> is to send it a SIGTERM (-15) signal and wait for it to die on -its own. -<p><strong>nmbd</strong> will accept SIGHUP, which will cause it to dump out it's -namelists into the file <code>namelist.debug</code> in the -<em>/usr/local/samba/var/locks</em> directory (or the <em>var/locks</em> -directory configured under wherever Samba was configured to install -itself). This will also cause <strong>nmbd</strong> to dump out it's server database in -the log.nmb file. In addition, the debug log level of nmbd may be raised -by sending it a SIGUSR1 (<code>kill -USR1 <nmbd-pid></code>) and lowered by sending it a -SIGUSR2 (<code>kill -USR2 <nmbd-pid></code>). This is to allow transient -problems to be diagnosed, whilst still running at a normally low log -level. -<p><a name="VERSION"></a> -<h2>VERSION</h2> - -<p>This man page is correct for version 2.0 of the Samba suite. -<p><a name="SEEALSO"></a> -<h2>SEE ALSO</h2> - -<p><strong>inetd (8)</strong>, <a href="smbd.8.html"><strong>smbd (8)</strong></a>, <a href="smb.conf.5.html"><strong>smb.conf -(5)</strong></a>, <a href="smbclient.1.html"><strong>smbclient (1)</strong></a>, -<a href="testparm.1.html"><strong>testparm (1)</strong></a>, <a href="testprns.1.html"><strong>testprns -(1)</strong></a>, and the Internet RFC's <strong>rfc1001.txt</strong>, -<strong>rfc1002.txt</strong>. In addition the CIFS (formerly SMB) specification is -available as a link from the Web page : -<a href="http://samba.org/cifs/">http://samba.org/cifs/</a>. -<p><a name="AUTHOR"></a> -<h2>AUTHOR</h2> - -<p>The original Samba software and related utilities were created by -Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed. -<p>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 -<a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>) -and updated for the Samba2.0 release by Jeremy Allison. -<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. -<p>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc. -</body> -</html> +<HTML +><HEAD +><TITLE +>nmbd</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="NMBD" +>nmbd</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>nmbd -- NetBIOS name server to provide NetBIOS + over IP naming services to clients</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>smbd</B +> [-D] [-a] [-o] [-P] [-h] [-V] [-d <debug level>] [-H <lmhosts file>] [-l <log file>] [-n <primary netbios name>] [-p <port number>] [-s <configuration file>]</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN23" +></A +><H2 +>DESCRIPTION</H2 +><P +>This program is part of the Samba suite.</P +><P +><B +CLASS="COMMAND" +>nmbd</B +> is a server that understands + and can reply to NetBIOS over IP name service requests, like + those produced by SMBD/CIFS clients such as Windows 95/98/ME, + Windows NT, Windows 2000, and LanManager clients. It also + participates in the browsing protocols which make up the + Windows "Network Neighborhood" view.</P +><P +>SMB/CIFS clients, when they start up, may wish to + locate an SMB/CIFS server. That is, they wish to know what + IP number a specified host is using.</P +><P +>Amongst other services, <B +CLASS="COMMAND" +>nmbd</B +> will + listen for such requests, and if its own NetBIOS name is + specified it will respond with the IP number of the host it + is running on. Its "own NetBIOS name" is by + default the primary DNS name of the host it is running on, + but this can be overridden with the <I +CLASS="EMPHASIS" +>-n</I +> + option (see OPTIONS below). Thus <B +CLASS="COMMAND" +>nmbd</B +> will + reply to broadcast queries for its own name(s). Additional + names for <B +CLASS="COMMAND" +>nmbd</B +> to respond on can be set + via parameters in the <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +> smb.conf(5)</TT +></A +> configuration file.</P +><P +><B +CLASS="COMMAND" +>nmbd</B +> can also be used as a WINS + (Windows Internet Name Server) server. What this basically means + is that it will act as a WINS database server, creating a + database from name registration requests that it receives and + replying to queries from clients for these names.</P +><P +>In addition, <B +CLASS="COMMAND" +>nmbd</B +> can act as a WINS + proxy, relaying broadcast queries from clients that do + not understand how to talk the WINS protocol to a WIN + server.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN40" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>-D</DT +><DD +><P +>If specified, this parameter causes + <B +CLASS="COMMAND" +>nmbd</B +> to operate as a daemon. That is, + it detaches itself and runs in the background, fielding + requests on the appropriate port. By default, <B +CLASS="COMMAND" +>nmbd</B +> + will operate as a daemon if launched from a command shell. + nmbd can also be operated from the <B +CLASS="COMMAND" +>inetd</B +> + meta-daemon, although this is not recommended. + </P +></DD +><DT +>-a</DT +><DD +><P +>If this parameter is specified, each new + connection will append log messages to the log file. + This is the default.</P +></DD +><DT +>-o</DT +><DD +><P +>If this parameter is specified, the + log files will be overwritten when opened. By default, + <B +CLASS="COMMAND" +>smbd</B +> will append entries to the log + files.</P +></DD +><DT +>-h</DT +><DD +><P +>Prints the help information (usage) + for <B +CLASS="COMMAND" +>nmbd</B +>.</P +></DD +><DT +>-H <filename></DT +><DD +><P +>NetBIOS lmhosts file. The lmhosts + file is a list of NetBIOS names to IP addresses that + is loaded by the nmbd server and used via the name + resolution mechanism <A +HREF="smb.conf.5.html#nameresolveorder" +TARGET="_top" +> name resolve order</A +> described in <A +HREF="smb.conf.5.html" +TARGET="_top" +> <TT +CLASS="FILENAME" +>smb.conf(5)</TT +></A +> + to resolve any NetBIOS name queries needed by the server. Note + that the contents of this file are <I +CLASS="EMPHASIS" +>NOT</I +> + used by <B +CLASS="COMMAND" +>nmbd</B +> to answer any name queries. + Adding a line to this file affects name NetBIOS resolution + from this host <I +CLASS="EMPHASIS" +>ONLY</I +>.</P +><P +>The default path to this file is compiled into + Samba as part of the build process. Common defaults + are <TT +CLASS="FILENAME" +>/usr/local/samba/lib/lmhosts</TT +>, + <TT +CLASS="FILENAME" +>/usr/samba/lib/lmhosts</TT +> or + <TT +CLASS="FILENAME" +>/etc/lmhosts</TT +>. See the <A +HREF="lmhosts.5.html" +TARGET="_top" +> <TT +CLASS="FILENAME" +>lmhosts(5)</TT +></A +> man page for details on the + contents of this file.</P +></DD +><DT +>-V</DT +><DD +><P +>Prints the version number for + <B +CLASS="COMMAND" +>nmbd</B +>.</P +></DD +><DT +>-d <debug level></DT +><DD +><P +>debuglevel 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 + 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.</P +><P +>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.</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 +CLASS="FILENAME" +> smb.conf</TT +></A +> file.</P +></DD +><DT +>-l <log file></DT +><DD +><P +>The -l parameter specifies a path + and base filename into which operational data from + the running <B +CLASS="COMMAND" +>nmbd</B +> server will + be logged. The actual log file name is generated by + appending the extension ".nmb" to the specified base + name. For example, if the name specified was "log" + then the file log.nmb would contain the debugging data.</P +><P +>The default log file path is compiled into Samba as + part of the build process. Common defaults are <TT +CLASS="FILENAME" +> /usr/local/samba/var/log.nmb</TT +>, <TT +CLASS="FILENAME" +> /usr/samba/var/log.nmb</TT +> or + <TT +CLASS="FILENAME" +>/var/log/log.nmb</TT +>.</P +></DD +><DT +>-n <primary NetBIOS name></DT +><DD +><P +>This option allows you to override + the NetBIOS name that Samba uses for itself. This is identical + to setting the <A +HREF="smb.conf.5.html#netbiosname" +TARGET="_top" +> NetBIOS name</A +> parameter in the <A +HREF="smb.conf.5.html" +TARGET="_top" +> + <TT +CLASS="FILENAME" +>smb.conf</TT +></A +> file. However, a command + line setting will take precedence over settings in + <TT +CLASS="FILENAME" +>smb.conf</TT +>.</P +></DD +><DT +>-p <UDP port number></DT +><DD +><P +>UDP port number is a positive integer value. + This option changes the default UDP port number (normally 137) + that <B +CLASS="COMMAND" +>nmbd</B +> responds to name queries on. Don't + use this option unless you are an expert, in which case you + won't need help!</P +></DD +><DT +>-s <configuration file></DT +><DD +><P +>The default configuration file name + is set at build time, typically as <TT +CLASS="FILENAME" +> /usr/local/samba/lib/smb.conf</TT +>, but + this may be changed when Samba is autoconfigured.</P +><P +>The file specified contains the configuration details + required by the server. See <A +HREF="smb.conf.5.html" +TARGET="_top" +> + <TT +CLASS="FILENAME" +>smb.conf(5)</TT +></A +> for more information. + </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN125" +></A +><H2 +>FILES</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><TT +CLASS="FILENAME" +>/etc/inetd.conf</TT +></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 section INSTALLATION below. + </P +></DD +><DT +><TT +CLASS="FILENAME" +>/etc/rc</TT +></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 section INSTALLATION + below.</P +></DD +><DT +><TT +CLASS="FILENAME" +>/etc/services</TT +></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 section INSTALLATION below.</P +></DD +><DT +><TT +CLASS="FILENAME" +>/usr/local/samba/lib/smb.conf</TT +></DT +><DD +><P +>This is the default location of the + <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf</TT +></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/smb.conf</TT +>.</P +><P +>When run as a WINS server (see the + <A +HREF="smb.conf.5.html#winssupport" +TARGET="_top" +>wins support</A +> + parameter in the <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +> smb.conf(5)</TT +></A +> man page), <B +CLASS="COMMAND" +>nmbd</B +> + will store the WINS database in the file <TT +CLASS="FILENAME" +>wins.dat</TT +> + in the <TT +CLASS="FILENAME" +>var/locks</TT +> directory configured under + wherever Samba was configured to install itself.</P +><P +>If <B +CLASS="COMMAND" +>nmbd</B +> is acting as a <I +CLASS="EMPHASIS" +> browse master</I +> (see the <A +HREF="smb.conf.5.html#localmaster" +TARGET="_top" +>local master</A +> + parameter in the <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +> smb.conf(5)</TT +></A +> man page), <B +CLASS="COMMAND" +>nmbd</B +> + will store the browsing database in the file <TT +CLASS="FILENAME" +>browse.dat + </TT +> in the <TT +CLASS="FILENAME" +>var/locks</TT +> directory + configured under wherever Samba was configured to install itself. + </P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN171" +></A +><H2 +>SIGNALS</H2 +><P +>To shut down an <B +CLASS="COMMAND" +>nmbd</B +> process it is recommended + that SIGKILL (-9) <I +CLASS="EMPHASIS" +>NOT</I +> be used, except as a last + resort, as this may leave the name database in an inconsistent state. + The correct way to terminate <B +CLASS="COMMAND" +>nmbd</B +> is to send it + a SIGTERM (-15) signal and wait for it to die on its own.</P +><P +><B +CLASS="COMMAND" +>nmbd</B +> will accept SIGHUP, which will cause + it to dump out it's namelists into the file <TT +CLASS="FILENAME" +>namelist.debug + </TT +> in the <TT +CLASS="FILENAME" +>/usr/local/samba/var/locks</TT +> + directory (or the <TT +CLASS="FILENAME" +>var/locks</TT +> directory configured + under wherever Samba was configured to install itself). This will also + cause <B +CLASS="COMMAND" +>nmbd</B +> to dump out it's server database in + the <TT +CLASS="FILENAME" +>log.nmb</TT +> file. In addition, the debug log level + of nmbd may be raised by sending it a SIGUSR1 (<B +CLASS="COMMAND" +>kill -USR1 + <nmbd-pid></B +>) and lowered by sending it a + SIGUSR2 (<B +CLASS="COMMAND" +>kill -USR2 <nmbd-pid></B +>). This is to + allow transient problems to be diagnosed, whilst still running at a + normally low log level.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN186" +></A +><H2 +>VERSION</H2 +><P +>This man page is correct for version 2.2 of + the Samba suite.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN189" +></A +><H2 +>SEE ALSO</H2 +><P +><B +CLASS="COMMAND" +>inetd(8)</B +>, <A +HREF="smbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbd(8)</B +></A +>, + <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5)</TT +> + </A +>, <A +HREF="smbclient.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbclient(1) + </B +></A +>, <A +HREF="testparm.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +> testparm(1)</B +></A +>, <A +HREF="testprns.1.html" +TARGET="_top" +> <B +CLASS="COMMAND" +>testprns(1)</B +></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" +><A +NAME="AEN206" +></A +><H2 +>AUTHOR</H2 +><P +>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.</P +><P +>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 + <A +HREF="ftp://ftp.icce.rug.nl/pub/unix/" +TARGET="_top" +> ftp://ftp.icce.rug.nl/pub/unix/</A +>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</P +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/htmldocs/smbd.8.html b/docs/htmldocs/smbd.8.html index 766de0853f0..be5c02dd724 100644 --- a/docs/htmldocs/smbd.8.html +++ b/docs/htmldocs/smbd.8.html @@ -1,378 +1,971 @@ +<HTML +><HEAD +><TITLE +>smbd</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><H1 +><A +NAME="SMBD" +>smbd</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN5" +></A +><H2 +>Name</H2 +>smbd -- server to provide SMB/CIFS services to clients</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN8" +></A +><H2 +>Synopsis</H2 +><P +><B +CLASS="COMMAND" +>smbd</B +> [-D] [-a] [-o] [-P] [-h] [-V] [-d <debug level>] [-l <log file>] [-p <port number>] [-O <socket option>] [-s <configuration file>]</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN22" +></A +><H2 +>DESCRIPTION</H2 +><P +>This program is part of the Samba 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 + 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.</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" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5) + </TT +></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" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5)</TT +></A +> + manpage 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 + that session. When all connections from its client are closed, + the copy of the server for that client terminates.</P +><P +>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 smbd killed and restarted.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN35" +></A +><H2 +>OPTIONS</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>-D</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 smbd for + servers that provide more than casual use file and + print services. This switch is assumed is <B +CLASS="COMMAND" +>smbd + </B +> is executed on the command line of a shell. + </P +></DD +><DT +>-a</DT +><DD +><P +>If this parameter is specified, each new + connection will append log messages to the log file. + This is the default.</P +></DD +><DT +>-o</DT +><DD +><P +>If this parameter is specified, the + log files will be overwritten when opened. By default, + <B +CLASS="COMMAND" +>smbd</B +> will append entries to the log + files.</P +></DD +><DT +>-P</DT +><DD +><P +>Passive option. Causes smbd not to + send any network traffic out. Used for debugging by + the developers only.</P +></DD +><DT +>-h</DT +><DD +><P +>Prints the help information (usage) + for <B +CLASS="COMMAND" +>smbd</B +>.</P +></DD +><DT +>-v</DT +><DD +><P +>Prints the version number for + <B +CLASS="COMMAND" +>smbd</B +>.</P +></DD +><DT +>-d <debug level></DT +><DD +><P +>debuglevel 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 + 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.</P +><P +>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.</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 +CLASS="FILENAME" +>smb.conf(5)</TT +></A +> file.</P +></DD +><DT +>-l <log file></DT +><DD +><P +>If specified, <I +CLASS="EMPHASIS" +>log file</I +> + specifies a log filename into which informational and debug + messages from the running server will be logged. 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" +>max log size</A +> + option in the <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +> smb.conf(5)</TT +></A +> file. The default log + file name is specified at compile time.</P +></DD +><DT +>-O <socket options></DT +><DD +><P +>See the <A +HREF="smb.conf.5.html#socketoptions" +TARGET="_top" +>socket options</A +> + parameter in the <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5) + </TT +></A +> file for details.</P +></DD +><DT +>-p <port number></DT +><DD +><P +>port number 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 + 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.</P +><P +>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.</P +><P +>This parameter is not normally specified except + in the above situation.</P +></DD +><DT +>-s <configuration file></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 +CLASS="FILENAME" +> smb.conf(5)</TT +></A +> for more information. + The default configuration file name is determined at + compile time.</P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN104" +></A +><H2 +>FILES</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +><TT +CLASS="FILENAME" +>/etc/inetd.conf</TT +></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 section INSTALLATION below. + </P +></DD +><DT +><TT +CLASS="FILENAME" +>/etc/rc</TT +></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 section INSTALLATION + below.</P +></DD +><DT +><TT +CLASS="FILENAME" +>/etc/services</TT +></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 section INSTALLATION below.</P +></DD +><DT +><TT +CLASS="FILENAME" +>/usr/local/samba/lib/smb.conf</TT +></DT +><DD +><P +>This is the default location of the + <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf</TT +></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/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" +TARGET="_top" +> <TT +CLASS="FILENAME" +>smb.conf(5)</TT +></A +> for more information.</P +></DD +></DL +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN137" +></A +><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" +><A +NAME="AEN141" +></A +><H2 +>ENVIRONMENTVARIABLES</H2 +><P +></P +><DIV +CLASS="VARIABLELIST" +><DL +><DT +>PRINTER</DT +><DD +><P +>If no printer name is specified to + printable services, most systems will use the value of + this variable (or "lp" 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" +><A +NAME="AEN148" +></A +><H2 +>INSTALLATION</H2 +><P +>The location of the server and its support files + is a matter for individual system administrators. The following + are thus suggestions only.</P +><P +>It is recommended that the server software be installed + under the <TT +CLASS="FILENAME" +>/usr/local/samba/</TT +> hierarchy, + in a directory readable by all, writeable only by root. The server + program itself should be executable by all, as users may wish to + run the server themselves (in which case it will of course run + with their privileges). The server should NOT be setuid. On some + systems it may be worthwhile to make smbd setgid to an empty group. + This is because some systems may have a security hole where daemon + processes that become a user can be attached to with a debugger. + Making the smbd file setgid to an empty group may prevent + this hole from being exploited. This security hole and the suggested + fix has only been confirmed on old versions (pre-kernel 2.0) of Linux + at the time this was written. It is possible that this hole only + exists in Linux, as testing on other systems has thus far shown them + to be immune.</P +><P +>The server log files should be put in a directory readable and + writeable only by root, as the log files may contain sensitive + information.</P +><P +>The configuration file should be placed in a directory + readable and writeable only by root, as the configuration file + controls security for the services offered by the server. The + configuration file can be made readable by all if desired, but + this is not necessary for correct operation of the server and is + not recommended. A sample configuration file <TT +CLASS="FILENAME" +>smb.conf.sample + </TT +> is supplied with the source to the server - this may + be renamed to <TT +CLASS="FILENAME" +>smb.conf</TT +> and modified to suit + your needs.</P +><P +>The remaining notes will assume the following:</P +><P +></P +><UL +><LI +><P +><B +CLASS="COMMAND" +>smbd</B +> (the server program) + installed in <TT +CLASS="FILENAME" +>/usr/local/samba/bin</TT +></P +></LI +><LI +><P +><TT +CLASS="FILENAME" +>smb.conf</TT +> (the configuration + file) installed in <TT +CLASS="FILENAME" +>/usr/local/samba/lib</TT +></P +></LI +><LI +><P +>log files stored in <TT +CLASS="FILENAME" +>/var/adm/smblogs + </TT +></P +></LI +></UL +><P +>The server may be run either as a daemon by users + or at startup, or it may be run from a meta-daemon such as + <B +CLASS="COMMAND" +>inetd</B +> upon request. If run as a daemon, + the server will always be ready, so starting sessions will be + faster. If run from a meta-daemon some memory will be saved and + utilities such as the tcpd TCP-wrapper may be used for extra + security. For serious use as file server it is recommended + that <B +CLASS="COMMAND" +>smbd</B +> be run as a daemon.</P +><P +>When you've decided, continue with either</P +><P +></P +><UL +><LI +><P +>RUNNING THE SERVER AS A DAEMON or</P +></LI +><LI +><P +>RUNNING THE SERVER ON REQUEST.</P +></LI +></UL +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN179" +></A +><H2 +>RUNNING THE SERVER AS A DAEMON</H2 +><P +>To run the server as a daemon from the command + line, simply put the <I +CLASS="EMPHASIS" +>-D</I +> option on the + command line. There is no need to place an ampersand at + the end of the command line - the <I +CLASS="EMPHASIS" +>-D</I +> + option causes the server to detach itself from the tty + anyway.</P +><P +>Any user can run the server as a daemon (execute + permissions permitting, of course). This is useful for + testing purposes, and may even be useful as a temporary + substitute for something like ftp. When run this way, however, + the server will only have the privileges of the user who ran + it.</P +><P +>To ensure that the server is run as a daemon whenever + the machine is started, and to ensure that it runs as root + so that it can serve multiple clients, you will need to modify + the system startup files. Wherever appropriate (for example, in + <TT +CLASS="FILENAME" +>/etc/rc</TT +>), insert the following line, + substituting port number, log file location, configuration file + location and debug level as desired:</P +><P +><B +CLASS="COMMAND" +>/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log + -s /usr/local/samba/lib/smb.conf</B +></P +><P +>(The above should appear in your initialization script + as a single line. Depending on your terminal characteristics, + it may not appear that way in this man page. If the above appears + as more than one line, please treat any newlines or indentation + as a single space or TAB character.)</P +><P +>If the options used at compile time are appropriate for + your system, all parameters except <I +CLASS="EMPHASIS" +>-D</I +> may + be omitted. See the section OPTIONS above.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN192" +></A +><H2 +>RUNNING THE SERVER ON REQUEST</H2 +><P +>If your system uses a meta-daemon such as <B +CLASS="COMMAND" +>inetd + </B +>, you can arrange to have the smbd server started + whenever a process attempts to connect to it. This requires several + changes to the startup files on the host machine. If you are + experimenting as an ordinary user rather than as root, you will + need the assistance of your system administrator to modify the + system files.</P +><P +>You will probably want to set up the NetBIOS name server + <A +HREF="nmbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>nmbd</B +></A +> at + the same time as <B +CLASS="COMMAND" +>smbd</B +>. To do this refer to the + man page for <A +HREF="nmbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>nmbd(8)</B +> + </A +>.</P +><P +>First, ensure that a port is configured in the file + <TT +CLASS="FILENAME" +>/etc/services</TT +>. The well-known port 139 + should be used if possible, though any port may be used.</P +><P +>Ensure that a line similar to the following is in + <TT +CLASS="FILENAME" +>/etc/services</TT +>:</P +><P +><B +CLASS="COMMAND" +>netbios-ssn 139/tcp</B +></P +><P +>Note for NIS/YP users - you may need to rebuild the + NIS service maps rather than alter your local <TT +CLASS="FILENAME" +>/etc/services + </TT +> file.</P +><P +>Next, put a suitable line in the file <TT +CLASS="FILENAME" +>/etc/inetd.conf + </TT +> (in the unlikely event that you are using a meta-daemon + other than inetd, you are on your own). Note that the first item + in this line matches the service name in <TT +CLASS="FILENAME" +>/etc/services + </TT +>. Substitute appropriate values for your system + in this line (see <B +CLASS="COMMAND" +>inetd(8)</B +>):</P +><P +><B +CLASS="COMMAND" +>netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd + -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf</B +></P +><P +>(The above should appear in <TT +CLASS="FILENAME" +>/etc/inetd.conf</TT +> + as a single line. Depending on your terminal characteristics, it may + not appear that way in this man page. If the above appears as more + than one line, please treat any newlines or indentation as a single + space or TAB character.)</P +><P +>Note that there is no need to specify a port number here, + even if you are using a non-standard port number.</P +><P +>Lastly, edit the configuration file to provide suitable + services. To start with, the following two services should be + all you need:</P +><PRE +CLASS="SCREEN" +> <TT +CLASS="COMPUTEROUTPUT" +> [homes] + writeable = yes - - - - - -<html><head><title>smbd (8)</title> - -<link rev="made" href="mailto:samba@samba.org"> -</head> -<body> - -<hr> - -<h1>smbd (8)</h1> -<h2>Samba</h2> -<h2>23 Oct 1998</h2> - - - -<p><a name="NAME"></a> -<h2>NAME</h2> - smbd - server to provide SMB/CIFS services to clients -<p><a name="SYNOPSIS"></a> -<h2>SYNOPSIS</h2> - -<p><strong>smbd</strong> [<a href="smbd.8.html#minusD">-D</a>] [<a href="smbd.8.html#minusa">-a</a>] [<a href="smbd.8.html#minuso">-o</a>] [<a href="smbd.8.html#minusP">-P</a>] [<a href="smbd.8.html#minush">-h</a>] [<a href="smbd.8.html#minusV">-V</a>] [<a href="smbd.8.html#minusd">-d debuglevel</a>] [<a href="smbd.8.html#minusl">-l log file</a>] [<a href="smbd.8.html#minusp">-p port number</a>] [<a href="smbd.8.html#minusO">-O socket options</a>] [<a href="smbd.8.html#minuss">-s configuration file</a>] -<p><a name="DESCRIPTION"></a> -<h2>DESCRIPTION</h2> - -<p>This program is part of the <strong>Samba</strong> suite. -<p><strong>smbd</strong> 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, -Windows NT, OS/2, DAVE for Macintosh, and smbfs for Linux. -<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"><strong>smb.conf (5)</strong></a>. This man page -will not describe the services, but will concentrate on the -administrative aspects of running the server. -<p>Please note that there are significant security implications to -running this server, and the -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> manpage should be -regarded as mandatory reading before proceeding with installation. -<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 that session. When all -connections from its client are closed, the copy of the server for -that client terminates. -<p>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 smbd killed and restarted. -<p><a name="OPTIONS"></a> -<h2>OPTIONS</h2> - -<p><dl> -<p><a name="minusD"></a> -<p></p><dt><strong><strong>-D</strong></strong><dd> 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 smbd for servers that provide -more than casual use file and print services. -<p>By default, the server will NOT operate as a daemon. -<p><a name="minusa"></a> -<p></p><dt><strong><strong>-a</strong></strong><dd> If this parameter is specified, each new connection will -append log messages to the log file. This is the default. -<p><a name="minuso"></a> -<p></p><dt><strong><strong>-o</strong></strong><dd> If this parameter is specified, the log files will be -overwritten when opened. By default, the log files will be appended -to. -<p><a name="minusP"></a> -<p></p><dt><strong><strong>-P</strong></strong><dd> Passive option. Causes smbd not to send any network traffic -out. Used for debugging by the developers only. -<p><a name="minush"></a> -<p></p><dt><strong><strong>-h</strong></strong><dd> Prints the help information (usage) for <strong>smbd</strong>. -<p><a name="minusV"></a> -<p></p><dt><strong><strong>-V</strong></strong><dd> Prints the version number for <strong>smbd</strong>. -<p><a name="minusd"></a> -<p></p><dt><strong><strong>-d debuglevel</strong></strong><dd> debuglevel is an integer from 0 to 10. -<p>The default value if this parameter is not specified is zero. -<p>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. -<p>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. -<p>Note that specifying this parameter here will override the <a href="smb.conf.5.html#loglevel"><strong>log -level</strong></a> parameter in the <a href="smb.conf.5.html"><strong>smb.conf -(5)</strong></a> file. -<p><a name="minusl"></a> -<p></p><dt><strong><strong>-l log file</strong></strong><dd> If specified, <em>log file</em> specifies -a log filename into which informational and debug messages from the -running server will be logged. 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"><strong>max -log size</strong></a> option in the <a href="smb.conf.5.html"><strong>smb.conf -(5)</strong></a> file. The default log file name is specified -at compile time. -<p><a name="minusO"></a> -<p></p><dt><strong><strong>-O socket options</strong></strong><dd> See the <a href="smb.conf.5.html#socketoptions"><strong>socket -options</strong></a> parameter in the -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> file for details. -<p><a name="minusp"></a> -<p></p><dt><strong><strong>-p port number</strong></strong><dd> port number is a positive integer value. The -default value if this parameter is not specified is 139. -<p>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. -<p>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. -<p>This parameter is not normally specified except in the above -situation. -<p><a name="minuss"></a> -<p></p><dt><strong><strong>-s configuration file</strong></strong><dd> -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 <strong>smb.conf -(5)</strong> for more information. -The default configuration file name is determined at compile time. -<p></dl> -<p><a name="FILES"></a> -<h2>FILES</h2> - -<p><strong>/etc/inetd.conf</strong> -<p>If the server is to be run by the inetd meta-daemon, this file must -contain suitable startup information for the meta-daemon. See the -section <a href="smbd.8.html#INSTALLATION">INSTALLATION</a> below. -<p><strong>/etc/rc</strong> -<p>(or whatever initialization script your system uses). -<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 -section <a href="smbd.8.html#INSTALLATION">INSTALLATION</a> below. -<p><strong>/etc/services</strong> -<p>If running the server via the meta-daemon inetd, 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 section -<a href="smbd.8.html#INSTALLATION">INSTALLATION</a> below. -<p><strong>/usr/local/samba/lib/smb.conf</strong> -<p>This is the default location of the <em>smb.conf</em> server configuration -file. Other common places that systems install this file are -<em>/usr/samba/lib/smb.conf</em> and <em>/etc/smb.conf</em>. -<p>This file describes all the services the server is to make available -to clients. See <a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a> for more information. -<p><a name="LIMITATIONS"></a> -<h2>LIMITATIONS</h2> - -<p>On some systems <strong>smbd</strong> 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><a name="ENVIRONMENTVARIABLES"></a> -<h2>ENVIRONMENT VARIABLES</h2> - -<p><strong>PRINTER</strong> -<p>If no printer name is specified to printable services, most systems -will use the value of this variable (or "lp" if this variable is not -defined) as the name of the printer to use. This is not specific to -the server, however. -<p><a name="INSTALLATION"></a> -<h2>INSTALLATION</h2> - -<p>The location of the server and its support files is a matter for -individual system administrators. The following are thus suggestions -only. -<p>It is recommended that the server software be installed under the -/usr/local/samba hierarchy, in a directory readable by all, writeable -only by root. The server program itself should be executable by all, -as users may wish to run the server themselves (in which case it will -of course run with their privileges). The server should NOT be -setuid. On some systems it may be worthwhile to make smbd setgid to an -empty group. This is because some systems may have a security hole -where daemon processes that become a user can be attached to with a -debugger. Making the smbd file setgid to an empty group may prevent -this hole from being exploited. This security hole and the suggested -fix has only been confirmed on old versions (pre-kernel 2.0) of Linux -at the time this was written. It is possible that this hole only -exists in Linux, as testing on other systems has thus far shown them -to be immune. -<p>The server log files should be put in a directory readable and -writeable only by root, as the log files may contain sensitive -information. -<p>The configuration file should be placed in a directory readable and -writeable only by root, as the configuration file controls security for -the services offered by the server. The configuration file can be made -readable by all if desired, but this is not necessary for correct -operation of the server and is not recommended. A sample configuration -file "smb.conf.sample" is supplied with the source to the server - -this may be renamed to "smb.conf" and modified to suit your needs. -<p>The remaining notes will assume the following: -<p><dl> -<p><li > <strong>smbd</strong> (the server program) installed in /usr/local/samba/bin -<p><li > <strong>smb.conf</strong> (the configuration file) installed in /usr/local/samba/lib -<p><li > log files stored in /var/adm/smblogs -<p></dl> -<p>The server may be run either as a daemon by users or at startup, or it -may be run from a meta-daemon such as inetd upon request. If run as a -daemon, the server will always be ready, so starting sessions will be -faster. If run from a meta-daemon some memory will be saved and -utilities such as the tcpd TCP-wrapper may be used for extra security. -For serious use as file server it is recommended that <strong>smbd</strong> be run -as a daemon. -<p>When you've decided, continue with either -<a href="smbd.8.html#RUNNINGTHESERVERASADAEMON">RUNNING THE SERVER AS A DAEMON</a> or -<a href="smbd.8.html#RUNNINGTHESERVERONREQUEST">RUNNING THE SERVER ON REQUEST</a>. -<p><a name="RUNNINGTHESERVERASADAEMON"></a> -<h2>RUNNING THE SERVER AS A DAEMON</h2> - -<p>To run the server as a daemon from the command line, simply put the -<a href="smbd.8.html#minusD"><strong>-D</strong></a> option on the command line. There is no need to place an -ampersand at the end of the command line - the <a href="smbd.8.html#minusD"><strong>-D</strong></a> option causes -the server to detach itself from the tty anyway. -<p>Any user can run the server as a daemon (execute permissions -permitting, of course). This is useful for testing purposes, and may -even be useful as a temporary substitute for something like ftp. When -run this way, however, the server will only have the privileges of the -user who ran it. -<p>To ensure that the server is run as a daemon whenever the machine is -started, and to ensure that it runs as root so that it can serve -multiple clients, you will need to modify the system startup -files. Wherever appropriate (for example, in /etc/rc), insert the -following line, substituting port number, log file location, -configuration file location and debug level as desired: -<p><code>/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb.conf</code> -<p>(The above should appear in your initialization script as a single line. -Depending on your terminal characteristics, it may not appear that way in -this man page. If the above appears as more than one line, please treat any -newlines or indentation as a single space or TAB character.) -<p>If the options used at compile time are appropriate for your system, -all parameters except <a href="smbd.8.html#minusD"><strong>-D</strong></a> may be -omitted. See the section <a href="smbd.8.html#OPTIONS">OPTIONS</a> above. -<p><a name="RUNNINGTHESERVERONREQUEST"></a> -<h2>RUNNING THE SERVER ON REQUEST</h2> - -<p>If your system uses a meta-daemon such as <strong>inetd</strong>, you can arrange to -have the smbd server started whenever a process attempts to connect to -it. This requires several changes to the startup files on the host -machine. If you are experimenting as an ordinary user rather than as -root, you will need the assistance of your system administrator to -modify the system files. -<p>You will probably want to set up the NetBIOS name server <a href="nmbd.8.html"><strong>nmbd</strong></a> at -the same time as <strong>smbd</strong>. To do this refer to the man page for -<a href="nmbd.8.html"><strong>nmbd (8)</strong></a>. -<p>First, ensure that a port is configured in the file <code>/etc/services</code>. The -well-known port 139 should be used if possible, though any port may be -used. -<p>Ensure that a line similar to the following is in <code>/etc/services</code>: -<p><code>netbios-ssn 139/tcp</code> -<p>Note for NIS/YP users - you may need to rebuild the NIS service maps -rather than alter your local <code>/etc/services file</code>. -<p>Next, put a suitable line in the file <code>/etc/inetd.conf</code> (in the unlikely -event that you are using a meta-daemon other than inetd, you are on -your own). Note that the first item in this line matches the service -name in <code>/etc/services</code>. Substitute appropriate values for your system -in this line (see <strong>inetd (8)</strong>): -<p><code>netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf</code> -<p>(The above should appear in <code>/etc/inetd.conf</code> as a single -line. Depending on your terminal characteristics, it may not appear -that way in this man page. If the above appears as more than one -line, please treat any newlines or indentation as a single space or -TAB character.) -<p>Note that there is no need to specify a port number here, even if you -are using a non-standard port number. -<p>Lastly, edit the configuration file to provide suitable services. To -start with, the following two services should be all you need: -<p><pre> - - -[homes] - writeable = yes - -[printers] - writeable = no - printable = yes - path = /tmp - public = yes - - -</pre> - -<p>This will allow you to connect to your home directory and print to any -printer supported by the host (user privileges permitting). -<p><a name="TESTINGTHEINSTALLATION"></a> -<h2>TESTING THE INSTALLATION</h2> - -<p>If running the server as a daemon, execute it before proceeding. If -using a meta-daemon, either restart the system or kill and restart the -meta-daemon. Some versions of inetd will reread their configuration -tables if they receive a HUP signal. -<p>If your machine's name is "fred" and your name is "mary", you should -now be able to connect to the service <code>\\fred\mary</code>. -<p>To properly test and experiment with the server, we recommend using -the smbclient program (see -<a href="smbclient.1.html"><strong>smbclient (1)</strong></a>) and also going through -the steps outlined in the file <em>DIAGNOSIS.txt</em> in the <em>docs/</em> -directory of your Samba installation. -<p><a name="VERSION"></a> -<h2>VERSION</h2> - -<p>This man page is correct for version 2.0 of the Samba suite. -<p><a name="DIAGNOSTICS"></a> -<h2>DIAGNOSTICS</h2> - -<p>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. -<p>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. -<p>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. -<p><a name="SIGNALS"></a> -<h2>SIGNALS</h2> - -<p>Sending the smbd a SIGHUP will cause it to re-load its smb.conf -configuration file within a short period of time. -<p>To shut down a users smbd process it is recommended that SIGKILL (-9) -<em>NOT</em> 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 -smbd is to send it a SIGTERM (-15) signal and wait for it to die on -its own. -<p>The debug log level of smbd may be raised -by sending it a SIGUSR1 <code>(kill -USR1 <smbd-pid>)</code> and lowered by -sending it a SIGUSR2 <code>(kill -USR2 <smbd-pid>)</code>. This is to allow -transient problems to be diagnosed, whilst still running at a normally -low log level. -<p>Note that as the signal handlers send a debug write, they are not -re-entrant in smbd. This you should wait until smbd 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><a name="SEEALSO"></a> -<h2>SEE ALSO</h2> - -<p><strong>hosts_access (5)</strong>, <strong>inetd (8)</strong>, <a href="nmbd.8.html"><strong>nmbd (8)</strong></a>, -<a href="smb.conf.5.html"><strong>smb.conf (5)</strong></a>, <a href="smbclient.1.html"><strong>smbclient -(1)</strong></a>, <a href="testparm.1.html"><strong>testparm (1)</strong></a>, -<a href="testprns.1.html"><strong>testprns (1)</strong></a>, and the Internet RFC's -<strong>rfc1001.txt</strong>, <strong>rfc1002.txt</strong>. In addition the CIFS (formerly SMB) -specification is available as a link from the Web page : -<a href="http://samba.org/cifs/">http://samba.org/cifs/</a>. -<p><a name="AUTHOR"></a> -<h2>AUTHOR</h2> - -<p>The original Samba software and related utilities were created by -Andrew Tridgell <a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed. -<p>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 -<a href="ftp://ftp.icce.rug.nl/pub/unix/"><strong>ftp://ftp.icce.rug.nl/pub/unix/</strong></a>) -and updated for the Samba2.0 release by Jeremy Allison. -<a href="mailto:samba@samba.org"><em>samba@samba.org</em></a>. -<p>See <a href="samba.7.html"><strong>samba (7)</strong></a> to find out how to get a full list of contributors -and details on how to submit bug reports, comments etc. -</body> -</html> + [printers] + writeable = no + printable = yes + path = /tmp + public = yes + </TT +> + </PRE +><P +>This will allow you to connect to your home directory + and print to any printer supported by the host (user privileges + permitting).</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN223" +></A +><H2 +>TESTING THE INSTALLATION</H2 +><P +>If running the server as a daemon, execute it before + proceeding. If using a meta-daemon, either restart the system + or kill and restart the meta-daemon. Some versions of + <B +CLASS="COMMAND" +>inetd</B +> will reread their configuration + tables if they receive a HUP signal.</P +><P +>If your machine's name is "fred" and your + name is "mary", you should now be able to connect + to the service <TT +CLASS="FILENAME" +>\\fred\mary</TT +>. + </P +><P +>To properly test and experiment with the server, we + recommend using the <B +CLASS="COMMAND" +>smbclient</B +> program (see + <A +HREF="smbclient.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbclient(1)</B +></A +>) + and also going through the steps outlined in the file + <TT +CLASS="FILENAME" +>DIAGNOSIS.txt</TT +> in the <TT +CLASS="FILENAME" +>docs/</TT +> + directory of your Samba installation.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN235" +></A +><H2 +>VERSION</H2 +><P +>This man page is correct for version 2.2 of + the Samba suite.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN238" +></A +><H2 +>DIAGNOSTICS</H2 +><P +>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.</P +><P +>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.</P +><P +>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.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN243" +></A +><H2 +>SIGNALS</H2 +><P +>Sending the smbd a SIGHUP will cause it to + re-load its <TT +CLASS="FILENAME" +>smb.conf</TT +> configuration + file within a short period of time.</P +><P +>To shut down a users smbd process it is recommended + that <B +CLASS="COMMAND" +>SIGKILL (-9)</B +> <I +CLASS="EMPHASIS" +>NOT</I +> + 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 smbd is to send it a SIGTERM (-15) signal and wait for + it to die on its own.</P +><P +>The debug log level of smbd may be raised by sending + it a SIGUSR1 (<B +CLASS="COMMAND" +>kill -USR1 <smbd-pid></B +>) + and lowered by sending it a SIGUSR2 (<B +CLASS="COMMAND" +>kill -USR2 <smbd-pid> + </B +>). 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 smbd. This you should wait until + smbd 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" +><A +NAME="AEN254" +></A +><H2 +>SEE ALSO</H2 +><P +>hosts_access(5), <B +CLASS="COMMAND" +>inetd(8)</B +>, + <A +HREF="nmbd.8.html" +TARGET="_top" +><B +CLASS="COMMAND" +>nmbd(8)</B +></A +>, + <A +HREF="smb.conf.5.html" +TARGET="_top" +><TT +CLASS="FILENAME" +>smb.conf(5)</TT +> + </A +>, <A +HREF="smbclient.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +>smbclient(1) + </B +></A +>, <A +HREF="testparm.1.html" +TARGET="_top" +><B +CLASS="COMMAND" +> testparm(1)</B +></A +>, <A +HREF="testprns.1.html" +TARGET="_top" +> <B +CLASS="COMMAND" +>testprns(1)</B +></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" +><A +NAME="AEN271" +></A +><H2 +>AUTHOR</H2 +><P +>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.</P +><P +>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 + <A +HREF="ftp://ftp.icce.rug.nl/pub/unix/" +TARGET="_top" +> ftp://ftp.icce.rug.nl/pub/unix/</A +>) and updated for the Samba 2.0 + release by Jeremy Allison. The conversion to DocBook for + Samba 2.2 was done by Gerald Carter</P +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/docs/manpages/nmbd.8 b/docs/manpages/nmbd.8 index 55930f6629a..fa5e4066837 100644 --- a/docs/manpages/nmbd.8 +++ b/docs/manpages/nmbd.8 @@ -1,220 +1,243 @@ -.TH "nmbd" "8" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" -nmbd \- NetBIOS name server to provide NetBIOS over IP -naming services to clients -.PP -.SH "SYNOPSIS" -.PP -\fBnmbd\fP [-D] [-a] [-o] [-h] [-V] [-H lmhosts file] [-d debuglevel] [-l log file basename] [-n primary NetBIOS name] [-p port number] [-s configuration file] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBnmbd\fP is a server that understands and can reply to NetBIOS over IP -name service requests, like those produced by SMBD/CIFS clients such -as Windows 95/98, Windows NT and LanManager clients\&. It also -participates in the browsing protocols which make up the Windows -"Network Neighborhood" view\&. -.PP -SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS -server\&. That is, they wish to know what IP number a specified host is -using\&. -.PP -Amongst other services, \fBnmbd\fP will listen for such requests, -and if its own NetBIOS name is specified it will respond with the IP -number of the host it is running on\&. Its "own NetBIOS name" is by -default the primary DNS name of the host it is running on, but this -can be overridden with the \fB-n\fP option (see OPTIONS below)\&. Thus -\fBnmbd\fP will reply to broadcast queries for its own name(s)\&. Additional -names for \fBnmbd\fP to respond on can be set via parameters in the -\fBsmb\&.conf(5)\fP configuration file\&. -.PP -\fBnmbd\fP can also be used as a WINS (Windows Internet Name Server) -server\&. What this basically means is that it will act as a WINS -database server, creating a database from name registration requests -that it receives and replying to queries from clients for these names\&. -.PP -In addition, \fBnmbd\fP can act as a WINS proxy, relaying broadcast queries -from clients that do not understand how to talk the WINS protocol to a -WIN server\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fB-D\fP" -If specified, this parameter causes \fBnmbd\fP to operate -as a daemon\&. That is, it detaches itself and runs in the background, -fielding requests on the appropriate port\&. By default, \fBnmbd\fP will -NOT operate as a daemon\&. nmbd can also be operated from the inetd -meta-daemon, although this is not recommended\&. -.IP -.IP "\fB-a\fP" -If this parameter is specified, each new connection will -append log messages to the log file\&. This is the default\&. -.IP -.IP "\fB-o\fP" -If this parameter is specified, the log files will be -overwritten when opened\&. By default, the log files will be appended -to\&. -.IP -.IP "\fB-h\fP" -Prints the help information (usage) for \fBnmbd\fP\&. -.IP -.IP "\fB-V\fP" -Prints the version number for \fBnmbd\fP\&. -.IP -.IP "\fB-H filename\fP" -NetBIOS lmhosts file\&. -.IP -The lmhosts file is a list of NetBIOS names to IP addresses that is -loaded by the nmbd server and used via the name resolution mechanism -\fBname resolve order\fP described in -\fBsmb\&.conf (5)\fP to resolve any -NetBIOS name queries needed by the server\&. Note that the contents of -this file are \fINOT\fP used by \fBnmbd\fP to answer any name queries\&. Adding -a line to this file affects name NetBIOS resolution from this host -\fIONLY\fP\&. -.IP -The default path to this file is compiled into Samba as part of the -build process\&. Common defaults are \fI/usr/local/samba/lib/lmhosts\fP, -\fI/usr/samba/lib/lmhosts\fP or \fI/etc/lmhosts\fP\&. See the -\fBlmhosts (5)\fP man page for details on the contents of this file\&. -.IP -.IP "\fB-d debuglevel\fP" -debuglevel is an integer from 0 to 10\&. -.IP -The default value if this parameter is not specified is zero\&. -.IP -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\&. -.IP -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\&. -.IP -Note that specifying this parameter here will override the \fBlog -level\fP parameter in the \fBsmb\&.conf -(5)\fP file\&. -.IP -.IP "\fB-l logfile\fP" -The \fB-l\fP parameter specifies a path and base -filename into which operational data from the running nmbd server will -be logged\&. The actual log file name is generated by appending the -extension "\&.nmb" to the specified base name\&. For example, if the name -specified was "log" then the file log\&.nmb would contain the debugging -data\&. -.IP -The default log file path is compiled into Samba as part of the -build process\&. Common defaults are \fI/usr/local/samba/var/log\&.nmb\fP, -\fI/usr/samba/var/log\&.nmb\fP or \fI/var/log/log\&.nmb\fP\&. -.IP -.IP "\fB-n primary NetBIOS name\fP" +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "NMBD" "8" "19 February 2001" "" "" +.SH NAME +nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients +.SH SYNOPSIS +.sp +\fBsmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-H <lmhosts file>\fR ] [ \fB-l <log file>\fR ] [ \fB-n <primary netbios name>\fR ] [ \fB-p <port number>\fR ] [ \fB-s <configuration file>\fR ] +.SH "DESCRIPTION" +.PP +This program is part of the Samba suite. +.PP +\fBnmbd\fR is a server that understands +and can reply to NetBIOS over IP name service requests, like +those produced by SMBD/CIFS clients such as Windows 95/98/ME, +Windows NT, Windows 2000, and LanManager clients. It also +participates in the browsing protocols which make up the +Windows |[[quot ]]|Network Neighborhood|[[quot ]]| view. +.PP +SMB/CIFS clients, when they start up, may wish to +locate an SMB/CIFS server. That is, they wish to know what +IP number a specified host is using. +.PP +Amongst other services, \fBnmbd\fR will +listen for such requests, and if its own NetBIOS name is +specified it will respond with the IP number of the host it +is running on. Its |[[quot ]]|own NetBIOS name|[[quot ]]| is by +default the primary DNS name of the host it is running on, +but this can be overridden with the \fB-n\fR +option (see OPTIONS below). Thus \fBnmbd\fR will +reply to broadcast queries for its own name(s). Additional +names for \fBnmbd\fR to respond on can be set +via parameters in the \fI smb.conf(5)\fR <URL:smb.conf.5.html> configuration file. +.PP +\fBnmbd\fR can also be used as a WINS +(Windows Internet Name Server) server. What this basically means +is that it will act as a WINS database server, creating a +database from name registration requests that it receives and +replying to queries from clients for these names. +.PP +In addition, \fBnmbd\fR can act as a WINS +proxy, relaying broadcast queries from clients that do +not understand how to talk the WINS protocol to a WIN +server. +.SH "OPTIONS" +.TP +\fB-D\fR +If specified, this parameter causes +\fBnmbd\fR to operate as a daemon. That is, +it detaches itself and runs in the background, fielding +requests on the appropriate port. By default, \fBnmbd\fR +will operate as a daemon if launched from a command shell. +nmbd can also be operated from the \fBinetd\fR +meta-daemon, although this is not recommended. +.TP +\fB-a\fR +If this parameter is specified, each new +connection will append log messages to the log file. +This is the default. +.TP +\fB-o\fR +If this parameter is specified, the +log files will be overwritten when opened. By default, +\fBsmbd\fR will append entries to the log +files. +.TP +\fB-h\fR +Prints the help information (usage) +for \fBnmbd\fR. +.TP +\fB-H <filename>\fR +NetBIOS lmhosts file. The lmhosts +file is a list of NetBIOS names to IP addresses that +is loaded by the nmbd server and used via the name +resolution mechanism name resolve order <URL:smb.conf.5.html#nameresolveorder> described in \fIsmb.conf(5)\fR <URL:smb.conf.5.html> +to resolve any NetBIOS name queries needed by the server. Note +that the contents of this file are \fBNOT\fR +used by \fBnmbd\fR to answer any name queries. +Adding a line to this file affects name NetBIOS resolution +from this host \fBONLY\fR. + +The default path to this file is compiled into +Samba as part of the build process. Common defaults +are \fI/usr/local/samba/lib/lmhosts\fR, +\fI/usr/samba/lib/lmhosts\fR or +\fI/etc/lmhosts\fR. See the \fIlmhosts(5)\fR <URL:lmhosts.5.html> man page for details on the +contents of this file. +.TP +\fB-V\fR +Prints the version number for +\fBnmbd\fR. +.TP +\fB-d <debug level>\fR +debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero. + +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. + +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. + +Note that specifying this parameter here will override +the log level <URL:smb.conf.5.html#loglevel> +parameter in the \fI smb.conf\fR <URL:smb.conf.5.html> file. +.TP +\fB-l <log file>\fR +The -l parameter specifies a path +and base filename into which operational data from +the running \fBnmbd\fR server will +be logged. The actual log file name is generated by +appending the extension |[[quot ]]|.nmb|[[quot ]]| to the specified base +name. For example, if the name specified was |[[quot ]]|log|[[quot ]]| +then the file log.nmb would contain the debugging data. + +The default log file path is compiled into Samba as +part of the build process. Common defaults are \fI /usr/local/samba/var/log.nmb\fR, \fI /usr/samba/var/log.nmb\fR or +\fI/var/log/log.nmb\fR. +.TP +\fB-n <primary NetBIOS name>\fR This option allows you to override -the NetBIOS name that Samba uses for itself\&. This is identical to -setting the \fBNetBIOS name\fP parameter -in the \fBsmb\&.conf\fP file -but will override the setting in the \fBsmb\&.conf\fP file\&. -.IP -.IP "\fB-p UDP port number\fP" -UDP port number is a positive integer value\&. -.IP -This option changes the default UDP port number (normally 137) that -\fBnmbd\fP responds to name queries on\&. Don\'t use this option unless you are -an expert, in which case you won\'t need help! -.IP -.IP "\fB-s configuration file\fP" -The default configuration file name is -set at build time, typically as \fI/usr/local/samba/lib/smb\&.conf\fP, but -this may be changed when Samba is autoconfigured\&. -.IP -The file specified contains the configuration details required by the -server\&. See \fBsmb\&.conf (5)\fP for more information\&. -.IP -.PP -.SH "FILES" -.PP -\fB/etc/inetd\&.conf\fP -.PP -If the server is to be run by the inetd meta-daemon, this file must -contain suitable startup information for the meta-daemon\&. -.PP -\fB/etc/rc\fP -.PP -(or whatever initialization script your system uses)\&. -.PP -If running the server as a daemon at startup, this file will need to -contain an appropriate startup sequence for the server\&. -.PP -\fB/usr/local/samba/lib/smb\&.conf\fP -.PP +the NetBIOS name that Samba uses for itself. This is identical +to setting the NetBIOS name <URL:smb.conf.5.html#netbiosname> parameter in the +\fIsmb.conf\fR <URL:smb.conf.5.html> file. However, a command +line setting will take precedence over settings in +\fIsmb.conf\fR. +.TP +\fB-p <UDP port number>\fR +UDP port number is a positive integer value. +This option changes the default UDP port number (normally 137) +that \fBnmbd\fR responds to name queries on. Don't +use this option unless you are an expert, in which case you +won't need help! +.TP +\fB-s <configuration file>\fR +The default configuration file name +is set at build time, typically as \fI /usr/local/samba/lib/smb.conf\fR, but +this may be changed when Samba is autoconfigured. + +The file specified contains the configuration details +required by the server. See +\fIsmb.conf(5)\fR <URL:smb.conf.5.html> for more information. +.SH "FILES" +.TP +\fB\fI/etc/inetd.conf\fB\fR +If the server is to be run by the +\fBinetd\fR meta-daemon, this file +must contain suitable startup information for the +meta-daemon. See the section INSTALLATION below. +.TP +\fB\fI/etc/rc\fB\fR +or whatever initialization script your +system uses). + +If running the server as a daemon at startup, +this file will need to contain an appropriate startup +sequence for the server. See the section INSTALLATION +below. +.TP +\fB\fI/etc/services\fB\fR +If running the server via the +meta-daemon \fBinetd\fR, 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 section INSTALLATION below. +.TP +\fB\fI/usr/local/samba/lib/smb.conf\fB\fR This is the default location of the -\fBsmb\&.conf\fP server configuration -file\&. Other common places that systems install this file are -\fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&. -.PP -When run as a \fBWINS\fP server (see the \fBwins support\fP -parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will -store the WINS database in the file \f(CWwins\&.dat\fP in the \f(CWvar/locks\fP directory -configured under wherever Samba was configured to install itself\&. -.PP -If \fBnmbd\fP is acting as a \fBbrowse master\fP (see the \fBlocal master\fP -parameter in the \fBsmb\&.conf (5)\fP man page), \fBnmbd\fP will -store the browsing database in the file \f(CWbrowse\&.dat\fP in the \f(CWvar/locks\fP directory -configured under wherever Samba was configured to install itself\&. -.PP -.SH "SIGNALS" -.PP -To shut down an \fBnmbd\fP process it is recommended that SIGKILL (-9) -\fINOT\fP be used, except as a last resort, as this may leave the name -database in an inconsistent state\&. The correct way to terminate -\fBnmbd\fP is to send it a SIGTERM (-15) signal and wait for it to die on -its own\&. -.PP -\fBnmbd\fP will accept SIGHUP, which will cause it to dump out it\'s -namelists into the file \f(CWnamelist\&.debug\fP in the -\fI/usr/local/samba/var/locks\fP directory (or the \fIvar/locks\fP -directory configured under wherever Samba was configured to install -itself)\&. This will also cause \fBnmbd\fP to dump out it\'s server database in -the log\&.nmb file\&. In addition, the debug log level of nmbd may be raised -by sending it a SIGUSR1 (\f(CWkill -USR1 <nmbd-pid>\fP) and lowered by sending it a -SIGUSR2 (\f(CWkill -USR2 <nmbd-pid>\fP)\&. This is to allow transient -problems to be diagnosed, whilst still running at a normally low log -level\&. -.PP -.SH "VERSION" -.PP -This man page is correct for version 2\&.0 of the Samba suite\&. -.PP -.SH "SEE ALSO" -.PP -\fBinetd (8)\fP, \fBsmbd (8)\fP, \fBsmb\&.conf -(5)\fP, \fBsmbclient (1)\fP, -\fBtestparm (1)\fP, \fBtestprns -(1)\fP, and the Internet RFC\'s \fBrfc1001\&.txt\fP, -\fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) specification is -available as a link from the Web page : -http://samba\&.org/cifs/\&. -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed\&. -.PP -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 -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full -list of contributors and details on how to submit bug reports, -comments etc\&. +\fIsmb.conf\fR <URL:smb.conf.5.html> +server configuration file. Other common places that systems +install this file are \fI/usr/samba/lib/smb.conf\fR +and \fI/etc/smb.conf\fR. + +When run as a WINS server (see the +wins support <URL:smb.conf.5.html#winssupport> +parameter in the \fI smb.conf(5)\fR <URL:smb.conf.5.html> man page), \fBnmbd\fR +will store the WINS database in the file \fIwins.dat\fR +in the \fIvar/locks\fR directory configured under +wherever Samba was configured to install itself. + +If \fBnmbd\fR is acting as a \fB browse master\fR (see the local master <URL:smb.conf.5.html#localmaster> +parameter in the \fI smb.conf(5)\fR <URL:smb.conf.5.html> man page), \fBnmbd\fR +will store the browsing database in the file \fIbrowse.dat +\fRin the \fIvar/locks\fR directory +configured under wherever Samba was configured to install itself. +.SH "SIGNALS" +.PP +To shut down an \fBnmbd\fR process it is recommended +that SIGKILL (-9) \fBNOT\fR be used, except as a last +resort, as this may leave the name database in an inconsistent state. +The correct way to terminate \fBnmbd\fR is to send it +a SIGTERM (-15) signal and wait for it to die on its own. +.PP +\fBnmbd\fR will accept SIGHUP, which will cause +it to dump out it's namelists into the file \fInamelist.debug +\fRin the \fI/usr/local/samba/var/locks\fR +directory (or the \fIvar/locks\fR directory configured +under wherever Samba was configured to install itself). This will also +cause \fBnmbd\fR to dump out it's server database in +the \fIlog.nmb\fR file. In addition, the debug log level +of nmbd may be raised by sending it a SIGUSR1 (\fBkill -USR1 +<nmbd-pid>\fR) and lowered by sending it a +SIGUSR2 (\fBkill -USR2 <nmbd-pid>\fR). This is to +allow transient problems to be diagnosed, whilst still running at a +normally low log level. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "SEE ALSO" +.PP +\fBinetd(8)\fR, \fBsmbd(8)\fR <URL:smbd.8.html>, +\fIsmb.conf(5)\fR + <URL:smb.conf.5.html>, \fBsmbclient(1) +\fR <URL:smbclient.1.html>, \fB testparm(1)\fR <URL:testparm.1.html>, \fBtestprns(1)\fR <URL:testprns.1.html>, and the Internet RFC's +\fIrfc1001.txt\fR, \fIrfc1002.txt\fR. +In addition the CIFS (formerly SMB) specification is available +as a link from the Web page +http://samba.org/cifs/ <URL:http://samba.org/cifs/>. +.SH "AUTHOR" +.PP +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. +.PP +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 +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for +Samba 2.2 was done by Gerald Carter diff --git a/docs/manpages/smbd.8 b/docs/manpages/smbd.8 index 5ee6cd53082..ea09dee84ff 100644 --- a/docs/manpages/smbd.8 +++ b/docs/manpages/smbd.8 @@ -1,430 +1,462 @@ -.TH "smbd " "8" "23 Oct 1998" "Samba" "SAMBA" -.PP -.SH "NAME" +.\" This manpage has been automatically generated by docbook2man-spec +.\" from a DocBook document. docbook2man-spec can be found at: +.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "SMBD" "8" "19 February 2001" "" "" +.SH NAME smbd \- server to provide SMB/CIFS services to clients -.PP -.SH "SYNOPSIS" -.PP -\fBsmbd\fP [-D] [-a] [-o] [-P] [-h] [-V] [-d debuglevel] [-l log file] [-p port number] [-O socket options] [-s configuration file] -.PP -.SH "DESCRIPTION" -.PP -This program is part of the \fBSamba\fP suite\&. -.PP -\fBsmbd\fP 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, -Windows NT, OS/2, DAVE for Macintosh, and smbfs for Linux\&. -.PP -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 -\fBsmb\&.conf (5)\fP\&. This man page -will not describe the services, but will concentrate on the -administrative aspects of running the server\&. -.PP -Please note that there are significant security implications to -running this server, and the -\fBsmb\&.conf (5)\fP manpage should be -regarded as mandatory reading before proceeding with installation\&. -.PP -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\&. -.PP -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 smbd killed and restarted\&. -.PP -.SH "OPTIONS" -.PP -.IP -.IP "\fB-D\fP" -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 smbd for servers that provide -more than casual use file and print services\&. -.IP -By default, the server will NOT operate as a daemon\&. -.IP -.IP "\fB-a\fP" -If this parameter is specified, each new connection will -append log messages to the log file\&. This is the default\&. -.IP -.IP "\fB-o\fP" -If this parameter is specified, the log files will be -overwritten when opened\&. By default, the log files will be appended -to\&. -.IP -.IP "\fB-P\fP" -Passive option\&. Causes smbd not to send any network traffic -out\&. Used for debugging by the developers only\&. -.IP -.IP "\fB-h\fP" -Prints the help information (usage) for \fBsmbd\fP\&. -.IP -.IP "\fB-V\fP" -Prints the version number for \fBsmbd\fP\&. -.IP -.IP "\fB-d debuglevel\fP" -debuglevel is an integer from 0 to 10\&. -.IP -The default value if this parameter is not specified is zero\&. -.IP -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\&. -.IP -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\&. -.IP -Note that specifying this parameter here will override the \fBlog -level\fP parameter in the \fBsmb\&.conf -(5)\fP file\&. -.IP -.IP "\fB-l log file\fP" -If specified, \fIlog file\fP specifies -a log filename into which informational and debug messages from the -running server will be logged\&. The log file generated is never removed -by the server although its size may be controlled by the \fBmax -log size\fP option in the \fBsmb\&.conf -(5)\fP file\&. The default log file name is specified -at compile time\&. -.IP -.IP "\fB-O socket options\fP" -See the \fBsocket -options\fP parameter in the -\fBsmb\&.conf (5)\fP file for details\&. -.IP -.IP "\fB-p port number\fP" -port number is a positive integer value\&. The -default value if this parameter is not specified is 139\&. -.IP -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\&. -.IP -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\&. -.IP -This parameter is not normally specified except in the above -situation\&. -.IP -.IP "\fB-s configuration file\fP" -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 \fBsmb\&.conf -(5)\fP for more information\&. -The default configuration file name is determined at compile time\&. -.IP -.PP -.SH "FILES" -.PP -\fB/etc/inetd\&.conf\fP -.PP -If the server is to be run by the inetd meta-daemon, this file must -contain suitable startup information for the meta-daemon\&. See the -section INSTALLATION below\&. -.PP -\fB/etc/rc\fP -.PP -(or whatever initialization script your system uses)\&. -.PP -If running the server as a daemon at startup, this file will need to -contain an appropriate startup sequence for the server\&. See the -section INSTALLATION below\&. -.PP -\fB/etc/services\fP -.PP -If running the server via the meta-daemon inetd, 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 section -INSTALLATION below\&. -.PP -\fB/usr/local/samba/lib/smb\&.conf\fP -.PP -This is the default location of the \fIsmb\&.conf\fP server configuration -file\&. Other common places that systems install this file are -\fI/usr/samba/lib/smb\&.conf\fP and \fI/etc/smb\&.conf\fP\&. -.PP -This file describes all the services the server is to make available -to clients\&. See \fBsmb\&.conf (5)\fP for more information\&. -.PP -.SH "LIMITATIONS" -.PP -On some systems \fBsmbd\fP 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\&. -.PP -.SH "ENVIRONMENT VARIABLES" -.PP -\fBPRINTER\fP -.PP -If no printer name is specified to printable services, most systems -will use the value of this variable (or "lp" if this variable is not -defined) as the name of the printer to use\&. This is not specific to -the server, however\&. -.PP -.SH "INSTALLATION" -.PP -The location of the server and its support files is a matter for -individual system administrators\&. The following are thus suggestions -only\&. -.PP -It is recommended that the server software be installed under the -/usr/local/samba hierarchy, in a directory readable by all, writeable -only by root\&. The server program itself should be executable by all, -as users may wish to run the server themselves (in which case it will -of course run with their privileges)\&. The server should NOT be -setuid\&. On some systems it may be worthwhile to make smbd setgid to an -empty group\&. This is because some systems may have a security hole -where daemon processes that become a user can be attached to with a -debugger\&. Making the smbd file setgid to an empty group may prevent -this hole from being exploited\&. This security hole and the suggested -fix has only been confirmed on old versions (pre-kernel 2\&.0) of Linux -at the time this was written\&. It is possible that this hole only -exists in Linux, as testing on other systems has thus far shown them -to be immune\&. -.PP -The server log files should be put in a directory readable and -writeable only by root, as the log files may contain sensitive -information\&. -.PP -The configuration file should be placed in a directory readable and -writeable only by root, as the configuration file controls security for -the services offered by the server\&. The configuration file can be made -readable by all if desired, but this is not necessary for correct -operation of the server and is not recommended\&. A sample configuration -file "smb\&.conf\&.sample" is supplied with the source to the server - -this may be renamed to "smb\&.conf" and modified to suit your needs\&. -.PP -The remaining notes will assume the following: -.PP -.IP -.IP o -\fBsmbd\fP (the server program) installed in /usr/local/samba/bin -.IP -.IP o -\fBsmb\&.conf\fP (the configuration file) installed in /usr/local/samba/lib -.IP -.IP o -log files stored in /var/adm/smblogs -.IP -.PP -The server may be run either as a daemon by users or at startup, or it -may be run from a meta-daemon such as inetd upon request\&. If run as a -daemon, the server will always be ready, so starting sessions will be -faster\&. If run from a meta-daemon some memory will be saved and -utilities such as the tcpd TCP-wrapper may be used for extra security\&. -For serious use as file server it is recommended that \fBsmbd\fP be run -as a daemon\&. -.PP -When you\'ve decided, continue with either -RUNNING THE SERVER AS A DAEMON or -RUNNING THE SERVER ON REQUEST\&. -.PP -.SH "RUNNING THE SERVER AS A DAEMON" -.PP -To run the server as a daemon from the command line, simply put the -\fB-D\fP option on the command line\&. There is no need to place an -ampersand at the end of the command line - the \fB-D\fP option causes -the server to detach itself from the tty anyway\&. -.PP -Any user can run the server as a daemon (execute permissions -permitting, of course)\&. This is useful for testing purposes, and may -even be useful as a temporary substitute for something like ftp\&. When -run this way, however, the server will only have the privileges of the -user who ran it\&. -.PP -To ensure that the server is run as a daemon whenever the machine is -started, and to ensure that it runs as root so that it can serve -multiple clients, you will need to modify the system startup -files\&. Wherever appropriate (for example, in /etc/rc), insert the -following line, substituting port number, log file location, -configuration file location and debug level as desired: -.PP -\f(CW/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log -s /usr/local/samba/lib/smb\&.conf\fP -.PP -(The above should appear in your initialization script as a single line\&. -Depending on your terminal characteristics, it may not appear that way in -this man page\&. If the above appears as more than one line, please treat any -newlines or indentation as a single space or TAB character\&.) -.PP -If the options used at compile time are appropriate for your system, -all parameters except \fB-D\fP may be -omitted\&. See the section OPTIONS above\&. -.PP -.SH "RUNNING THE SERVER ON REQUEST" -.PP -If your system uses a meta-daemon such as \fBinetd\fP, you can arrange to -have the smbd server started whenever a process attempts to connect to -it\&. This requires several changes to the startup files on the host -machine\&. If you are experimenting as an ordinary user rather than as -root, you will need the assistance of your system administrator to -modify the system files\&. -.PP -You will probably want to set up the NetBIOS name server \fBnmbd\fP at -the same time as \fBsmbd\fP\&. To do this refer to the man page for -\fBnmbd (8)\fP\&. -.PP -First, ensure that a port is configured in the file \f(CW/etc/services\fP\&. The -well-known port 139 should be used if possible, though any port may be -used\&. -.PP -Ensure that a line similar to the following is in \f(CW/etc/services\fP: -.PP -\f(CWnetbios-ssn 139/tcp\fP -.PP -Note for NIS/YP users - you may need to rebuild the NIS service maps -rather than alter your local \f(CW/etc/services file\fP\&. -.PP -Next, put a suitable line in the file \f(CW/etc/inetd\&.conf\fP (in the unlikely -event that you are using a meta-daemon other than inetd, you are on -your own)\&. Note that the first item in this line matches the service -name in \f(CW/etc/services\fP\&. Substitute appropriate values for your system -in this line (see \fBinetd (8)\fP): -.PP -\f(CWnetbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd -d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb\&.conf\fP -.PP -(The above should appear in \f(CW/etc/inetd\&.conf\fP as a single -line\&. Depending on your terminal characteristics, it may not appear -that way in this man page\&. If the above appears as more than one -line, please treat any newlines or indentation as a single space or -TAB character\&.) -.PP -Note that there is no need to specify a port number here, even if you -are using a non-standard port number\&. -.PP -Lastly, edit the configuration file to provide suitable services\&. To -start with, the following two services should be all you need: -.PP +.SH SYNOPSIS +.sp +\fBsmbd\fR [ \fB-D\fR ] [ \fB-a\fR ] [ \fB-o\fR ] [ \fB-P\fR ] [ \fB-h\fR ] [ \fB-V\fR ] [ \fB-d <debug level>\fR ] [ \fB-l <log file>\fR ] [ \fB-p <port number>\fR ] [ \fB-O <socket option>\fR ] [ \fB-s <configuration file>\fR ] +.SH "DESCRIPTION" +.PP +This program is part of the Samba suite. +.PP +\fBsmbd\fR 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. +.PP +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 \fIsmb.conf(5) +\fR <URL:smb.conf.5.html>. This man page will not describe the +services, but will concentrate on the administrative aspects +of running the server. +.PP +Please note that there are significant security +implications to running this server, and the \fIsmb.conf(5)\fR <URL:smb.conf.5.html> +manpage should be regarded as mandatory reading before +proceeding with installation. +.PP +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. +.PP +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 smbd killed and restarted. +.SH "OPTIONS" +.TP +\fB-D\fR +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 smbd for +servers that provide more than casual use file and +print services. This switch is assumed is \fBsmbd +\fRis executed on the command line of a shell. +.TP +\fB-a\fR +If this parameter is specified, each new +connection will append log messages to the log file. +This is the default. +.TP +\fB-o\fR +If this parameter is specified, the +log files will be overwritten when opened. By default, +\fBsmbd\fR will append entries to the log +files. +.TP +\fB-P\fR +Passive option. Causes smbd not to +send any network traffic out. Used for debugging by +the developers only. +.TP +\fB-h\fR +Prints the help information (usage) +for \fBsmbd\fR. +.TP +\fB-v\fR +Prints the version number for +\fBsmbd\fR. +.TP +\fB-d <debug level>\fR +debuglevel is an integer +from 0 to 10. The default value if this parameter is +not specified is zero. + +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. -.nf - +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. +Note that specifying this parameter here will +override the log +level <URL:smb.conf.5.html#loglevel> parameter in the \fIsmb.conf(5)\fR <URL:smb.conf.5.html> file. +.TP +\fB-l <log file>\fR +If specified, \fBlog file\fR +specifies a log filename into which informational and debug +messages from the running server will be logged. The log +file generated is never removed by the server although +its size may be controlled by the max log size <URL:smb.conf.5.html#maxlogsize> +option in the \fI smb.conf(5)\fR <URL:smb.conf.5.html> file. The default log +file name is specified at compile time. +.TP +\fB-O <socket options>\fR +See the socket options <URL:smb.conf.5.html#socketoptions> +parameter in the \fIsmb.conf(5) +\fR <URL:smb.conf.5.html> file for details. +.TP +\fB-p <port number>\fR +port number is a positive integer +value. The default value if this parameter is not +specified is 139. -[homes] - writeable = yes +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. -[printers] - writeable = no - printable = yes - path = /tmp - public = yes +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. +This parameter is not normally specified except +in the above situation. +.TP +\fB-s <configuration file>\fR +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 \fI smb.conf(5)\fR <URL:smb.conf.5.html> for more information. +The default configuration file name is determined at +compile time. +.SH "FILES" +.TP +\fB\fI/etc/inetd.conf\fB\fR +If the server is to be run by the +\fBinetd\fR meta-daemon, this file +must contain suitable startup information for the +meta-daemon. See the section INSTALLATION below. +.TP +\fB\fI/etc/rc\fB\fR +or whatever initialization script your +system uses). -.fi - +If running the server as a daemon at startup, +this file will need to contain an appropriate startup +sequence for the server. See the section INSTALLATION +below. +.TP +\fB\fI/etc/services\fB\fR +If running the server via the +meta-daemon \fBinetd\fR, 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 section INSTALLATION below. +.TP +\fB\fI/usr/local/samba/lib/smb.conf\fB\fR +This is the default location of the +\fIsmb.conf\fR <URL:smb.conf.5.html> +server configuration file. Other common places that systems +install this file are \fI/usr/samba/lib/smb.conf\fR +and \fI/etc/smb.conf\fR. + +This file describes all the services the server +is to make available to clients. See \fIsmb.conf(5)\fR <URL:smb.conf.5.html> for more information. +.SH "LIMITATIONS" +.PP +On some systems \fBsmbd\fR cannot change uid back +to root after a setuid() call. Such systems are called +|[[quot ]]|trapdoor|[[quot ]]| 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 |[[quot ]]|access denied|[[quot ]]| or +similar. +.SH "ENVIRONMENTVARIABLES" +.TP +\fBPRINTER\fR +If no printer name is specified to +printable services, most systems will use the value of +this variable (or |[[quot ]]|lp|[[quot ]]| if this variable is +not defined) as the name of the printer to use. This +is not specific to the server, however. +.SH "INSTALLATION" +.PP +The location of the server and its support files +is a matter for individual system administrators. The following +are thus suggestions only. +.PP +It is recommended that the server software be installed +under the \fI/usr/local/samba/\fR hierarchy, +in a directory readable by all, writeable only by root. The server +program itself should be executable by all, as users may wish to +run the server themselves (in which case it will of course run +with their privileges). The server should NOT be setuid. On some +systems it may be worthwhile to make smbd setgid to an empty group. +This is because some systems may have a security hole where daemon +processes that become a user can be attached to with a debugger. +Making the smbd file setgid to an empty group may prevent +this hole from being exploited. This security hole and the suggested +fix has only been confirmed on old versions (pre-kernel 2.0) of Linux +at the time this was written. It is possible that this hole only +exists in Linux, as testing on other systems has thus far shown them +to be immune. +.PP +The server log files should be put in a directory readable and +writeable only by root, as the log files may contain sensitive +information. +.PP +The configuration file should be placed in a directory +readable and writeable only by root, as the configuration file +controls security for the services offered by the server. The +configuration file can be made readable by all if desired, but +this is not necessary for correct operation of the server and is +not recommended. A sample configuration file \fIsmb.conf.sample +\fRis supplied with the source to the server - this may +be renamed to \fIsmb.conf\fR and modified to suit +your needs. +.PP +The remaining notes will assume the following: +.TP 0.2i +\(bu +\fBsmbd\fR (the server program) +installed in \fI/usr/local/samba/bin\fR +.TP 0.2i +\(bu +\fIsmb.conf\fR (the configuration +file) installed in \fI/usr/local/samba/lib\fR +.TP 0.2i +\(bu +log files stored in \fI/var/adm/smblogs +\fR.PP +The server may be run either as a daemon by users +or at startup, or it may be run from a meta-daemon such as +\fBinetd\fR upon request. If run as a daemon, +the server will always be ready, so starting sessions will be +faster. If run from a meta-daemon some memory will be saved and +utilities such as the tcpd TCP-wrapper may be used for extra +security. For serious use as file server it is recommended +that \fBsmbd\fR be run as a daemon. +.PP +.PP +When you've decided, continue with either +.PP +.TP 0.2i +\(bu +RUNNING THE SERVER AS A DAEMON or +.TP 0.2i +\(bu +RUNNING THE SERVER ON REQUEST. +.SH "RUNNING THE SERVER AS A DAEMON" +.PP +To run the server as a daemon from the command +line, simply put the \fB-D\fR option on the +command line. There is no need to place an ampersand at +the end of the command line - the \fB-D\fR +option causes the server to detach itself from the tty +anyway. +.PP +Any user can run the server as a daemon (execute +permissions permitting, of course). This is useful for +testing purposes, and may even be useful as a temporary +substitute for something like ftp. When run this way, however, +the server will only have the privileges of the user who ran +it. +.PP +To ensure that the server is run as a daemon whenever +the machine is started, and to ensure that it runs as root +so that it can serve multiple clients, you will need to modify +the system startup files. Wherever appropriate (for example, in +\fI/etc/rc\fR), insert the following line, +substituting port number, log file location, configuration file +location and debug level as desired: +.PP +\fB/usr/local/samba/bin/smbd -D -l /var/adm/smblogs/log +-s /usr/local/samba/lib/smb.conf\fR +.PP +(The above should appear in your initialization script +as a single line. Depending on your terminal characteristics, +it may not appear that way in this man page. If the above appears +as more than one line, please treat any newlines or indentation +as a single space or TAB character.) +.PP +If the options used at compile time are appropriate for +your system, all parameters except \fB-D\fR may +be omitted. See the section OPTIONS above. +.SH "RUNNING THE SERVER ON REQUEST" +.PP +If your system uses a meta-daemon such as \fBinetd +\fR, you can arrange to have the smbd server started +whenever a process attempts to connect to it. This requires several +changes to the startup files on the host machine. If you are +experimenting as an ordinary user rather than as root, you will +need the assistance of your system administrator to modify the +system files. +.PP +You will probably want to set up the NetBIOS name server +\fBnmbd\fR <URL:nmbd.8.html> at +the same time as \fBsmbd\fR. To do this refer to the +man page for \fBnmbd(8)\fR + <URL:nmbd.8.html>. +.PP +First, ensure that a port is configured in the file +\fI/etc/services\fR. The well-known port 139 +should be used if possible, though any port may be used. +.PP +Ensure that a line similar to the following is in +\fI/etc/services\fR: +.PP +\fBnetbios-ssn 139/tcp\fR +.PP +Note for NIS/YP users - you may need to rebuild the +NIS service maps rather than alter your local \fI/etc/services +\fRfile. +.PP +Next, put a suitable line in the file \fI/etc/inetd.conf +\fR(in the unlikely event that you are using a meta-daemon +other than inetd, you are on your own). Note that the first item +in this line matches the service name in \fI/etc/services +\fR\&. Substitute appropriate values for your system +in this line (see \fBinetd(8)\fR): +.PP +\fBnetbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd +-d1 -l/var/adm/smblogs/log -s/usr/local/samba/lib/smb.conf\fR +.PP +(The above should appear in \fI/etc/inetd.conf\fR +as a single line. Depending on your terminal characteristics, it may +not appear that way in this man page. If the above appears as more +than one line, please treat any newlines or indentation as a single +space or TAB character.) +.PP +Note that there is no need to specify a port number here, +even if you are using a non-standard port number. +.PP +Lastly, edit the configuration file to provide suitable +services. To start with, the following two services should be +all you need: +.sp +.nf + [homes] + writeable = yes -.PP -This will allow you to connect to your home directory and print to any -printer supported by the host (user privileges permitting)\&. -.PP -.SH "TESTING THE INSTALLATION" -.PP -If running the server as a daemon, execute it before proceeding\&. If -using a meta-daemon, either restart the system or kill and restart the -meta-daemon\&. Some versions of inetd will reread their configuration -tables if they receive a HUP signal\&. -.PP -If your machine\'s name is "fred" and your name is "mary", you should -now be able to connect to the service \f(CW\e\efred\emary\fP\&. -.PP -To properly test and experiment with the server, we recommend using -the smbclient program (see -\fBsmbclient (1)\fP) and also going through -the steps outlined in the file \fIDIAGNOSIS\&.txt\fP in the \fIdocs/\fP -directory of your Samba installation\&. -.PP -.SH "VERSION" -.PP -This man page is correct for version 2\&.0 of the Samba suite\&. -.PP -.SH "DIAGNOSTICS" -.PP -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\&. -.PP -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\&. -.PP -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\&. -.PP -.SH "SIGNALS" -.PP -Sending the smbd a SIGHUP will cause it to re-load its smb\&.conf -configuration file within a short period of time\&. -.PP -To shut down a users smbd process it is recommended that SIGKILL (-9) -\fINOT\fP 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 -smbd is to send it a SIGTERM (-15) signal and wait for it to die on -its own\&. -.PP -The debug log level of smbd may be raised -by sending it a SIGUSR1 \f(CW(kill -USR1 <smbd-pid>)\fP and lowered by -sending it a SIGUSR2 \f(CW(kill -USR2 <smbd-pid>)\fP\&. This is to allow -transient problems to be diagnosed, whilst still running at a normally -low log level\&. -.PP -Note that as the signal handlers send a debug write, they are not -re-entrant in smbd\&. This you should wait until smbd 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\&. -.PP -.SH "SEE ALSO" -.PP -\fBhosts_access (5)\fP, \fBinetd (8)\fP, \fBnmbd (8)\fP, -\fBsmb\&.conf (5)\fP, \fBsmbclient -(1)\fP, \fBtestparm (1)\fP, -\fBtestprns (1)\fP, and the Internet RFC\'s -\fBrfc1001\&.txt\fP, \fBrfc1002\&.txt\fP\&. In addition the CIFS (formerly SMB) -specification is available as a link from the Web page : -http://samba\&.org/cifs/\&. -.PP -.SH "AUTHOR" -.PP -The original Samba software and related utilities were created by -Andrew Tridgell samba@samba\&.org\&. Samba is now developed -by the Samba Team as an Open Source project similar to the way the -Linux kernel is developed\&. -.PP -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 -\fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP) -and updated for the Samba2\&.0 release by Jeremy Allison\&. -samba@samba\&.org\&. -.PP -See \fBsamba (7)\fP to find out how to get a full list of contributors -and details on how to submit bug reports, comments etc\&. + [printers] + writeable = no + printable = yes + path = /tmp + public = yes + + +.sp +.fi +.PP +This will allow you to connect to your home directory +and print to any printer supported by the host (user privileges +permitting). +.SH "TESTING THE INSTALLATION" +.PP +If running the server as a daemon, execute it before +proceeding. If using a meta-daemon, either restart the system +or kill and restart the meta-daemon. Some versions of +\fBinetd\fR will reread their configuration +tables if they receive a HUP signal. +.PP +If your machine's name is |[[quot ]]|fred|[[quot ]]| and your +name is |[[quot ]]|mary|[[quot ]]|, you should now be able to connect +to the service \fI|[[bsol ]]||[[bsol ]]|fred|[[bsol ]]|mary\fR. +.PP +To properly test and experiment with the server, we +recommend using the \fBsmbclient\fR program (see +\fBsmbclient(1)\fR <URL:smbclient.1.html>) +and also going through the steps outlined in the file +\fIDIAGNOSIS.txt\fR in the \fIdocs/\fR +directory of your Samba installation. +.SH "VERSION" +.PP +This man page is correct for version 2.2 of +the Samba suite. +.SH "DIAGNOSTICS" +.PP +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. +.PP +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. +.PP +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. +.SH "SIGNALS" +.PP +Sending the smbd a SIGHUP will cause it to +re-load its \fIsmb.conf\fR configuration +file within a short period of time. +.PP +To shut down a users smbd process it is recommended +that \fBSIGKILL (-9)\fR \fBNOT\fR +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 smbd is to send it a SIGTERM (-15) signal and wait for +it to die on its own. +.PP +The debug log level of smbd may be raised by sending +it a SIGUSR1 (\fBkill -USR1 <smbd-pid>\fR) +and lowered by sending it a SIGUSR2 (\fBkill -USR2 <smbd-pid> +\fR). This is to allow transient problems to be diagnosed, +whilst still running at a normally low log level. +.PP +Note that as the signal handlers send a debug write, +they are not re-entrant in smbd. This you should wait until +smbd 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. +.SH "SEE ALSO" +.PP +hosts_access(5), \fBinetd(8)\fR, +\fBnmbd(8)\fR <URL:nmbd.8.html>, +\fIsmb.conf(5)\fR + <URL:smb.conf.5.html>, \fBsmbclient(1) +\fR <URL:smbclient.1.html>, \fB testparm(1)\fR <URL:testparm.1.html>, \fBtestprns(1)\fR <URL:testprns.1.html>, and the Internet RFC's +\fIrfc1001.txt\fR, \fIrfc1002.txt\fR. +In addition the CIFS (formerly SMB) specification is available +as a link from the Web page +http://samba.org/cifs/ <URL:http://samba.org/cifs/>. +.SH "AUTHOR" +.PP +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. +.PP +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 +ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 +release by Jeremy Allison. The conversion to DocBook for +Samba 2.2 was done by Gerald Carter |