summaryrefslogtreecommitdiff
path: root/docs/htmldocs/manpages/smb.conf.5.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/htmldocs/manpages/smb.conf.5.html')
-rw-r--r--docs/htmldocs/manpages/smb.conf.5.html2918
1 files changed, 2024 insertions, 894 deletions
diff --git a/docs/htmldocs/manpages/smb.conf.5.html b/docs/htmldocs/manpages/smb.conf.5.html
index bd1675c385..929328eab2 100644
--- a/docs/htmldocs/manpages/smb.conf.5.html
+++ b/docs/htmldocs/manpages/smb.conf.5.html
@@ -1,7 +1,7 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smb.conf</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smb.conf.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smb.conf &#8212; The configuration file for the Samba suite</p></div><div class="refsect1" lang="en"><a name="id267380"></a><h2>SYNOPSIS</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smb.conf</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smb.conf.5"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smb.conf &#8212; The configuration file for the Samba suite</p></div><div class="refsect1" lang="en"><a name="id2544106"></a><h2>SYNOPSIS</h2><p>
The <code class="filename">smb.conf</code> file is a configuration file for the Samba suite. <code class="filename">smb.conf</code> contains runtime configuration information for the Samba programs. The
<code class="filename">smb.conf</code> file is designed to be configured and administered by the
- <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> program. The
+ <a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> program. The
complete description of the file format and possible parameters held within are here for reference purposes.
</p></div><div class="refsect1" lang="en"><a name="FILEFORMATSECT"></a><h2>FILE FORMAT</h2><p>
The file consists of sections and parameters. A section begins with the name of the section in square brackets
@@ -26,7 +26,7 @@
The values following the equals sign in parameters are all either a string (no quotes needed) or a boolean,
which may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, but is preserved
in string values. Some items such as create masks are numeric.
- </p></div><div class="refsect1" lang="en"><a name="id299256"></a><h2>SECTION DESCRIPTIONS</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2507245"></a><h2>SECTION DESCRIPTIONS</h2><p>
Each section in the configuration file (except for the [global] section) describes a shared resource (known as
a &#8220;<span class="quote">share</span>&#8221;). The section name is the name of the shared resource and the parameters within the
section define the shares attributes.
@@ -55,8 +55,8 @@
The following sample section defines a file space share. The user has write access to the path <code class="filename">/home/bar</code>. The share is accessed via the share name <code class="literal">foo</code>:
</p><pre class="programlisting">
<em class="parameter"><code>[foo]</code></em>
- <a class="indexterm" name="id266776"></a>path = /home/bar
- <a class="indexterm" name="id266783"></a>read only = no
+ <a class="link" href="smb.conf.5.html#PATH">path = /home/bar</a>
+ <a class="link" href="smb.conf.5.html#READONLY">read only = no</a>
</pre><p>
</p><p>
The following sample section defines a printable share. The share is read-only, but printable. That is,
@@ -64,12 +64,12 @@
ok</em></span> parameter means access will be permitted as the default guest user (specified elsewhere):
</p><pre class="programlisting">
<em class="parameter"><code>[aprinter]</code></em>
- <a class="indexterm" name="id266810"></a>path = /usr/spool/public
- <a class="indexterm" name="id266818"></a>read only = yes
- <a class="indexterm" name="id266825"></a>printable = yes
- <a class="indexterm" name="id266832"></a>guest ok = yes
+ <a class="link" href="smb.conf.5.html#PATH">path = /usr/spool/public</a>
+ <a class="link" href="smb.conf.5.html#READONLY">read only = yes</a>
+ <a class="link" href="smb.conf.5.html#PRINTABLE">printable = yes</a>
+ <a class="link" href="smb.conf.5.html#GUESTOK">guest ok = yes</a>
</pre><p>
- </p></div><div class="refsect1" lang="en"><a name="id266842"></a><h2>SPECIAL SECTIONS</h2><div class="refsect2" lang="en"><a name="id266848"></a><h3>The [global] section</h3><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2506263"></a><h2>SPECIAL SECTIONS</h2><div class="refsect2" lang="en"><a name="id2506269"></a><h3>The [global] section</h3><p>
Parameters in this section apply to the server as a whole, or are defaults for sections that do not
specifically define certain items. See the notes under PARAMETERS for more information.
</p></div><div class="refsect2" lang="en"><a name="HOMESECT"></a><h3>The [homes] section</h3><p>
@@ -105,7 +105,7 @@
than others. The following is a typical and suitable [homes] section:
</p><pre class="programlisting">
<em class="parameter"><code>[homes]</code></em>
-<a class="indexterm" name="id266965"></a>read only = no
+<a class="link" href="smb.conf.5.html#READONLY">read only = no</a>
</pre><p>
</p><p>
An important point is that if guest access is specified in the [homes] section, all home directories will be
@@ -137,9 +137,9 @@
it. A typical [printers] entry looks like this:
</p><pre class="programlisting">
<em class="parameter"><code>[printers]</code></em>
-<a class="indexterm" name="id307925"></a>path = /usr/spool/public
-<a class="indexterm" name="id307932"></a>guest ok = yes
-<a class="indexterm" name="id307939"></a>printable = yes
+<a class="link" href="smb.conf.5.html#PATH">path = /usr/spool/public</a>
+<a class="link" href="smb.conf.5.html#GUESTOK">guest ok = yes</a>
+<a class="link" href="smb.conf.5.html#PRINTABLE">printable = yes</a>
</pre><p>
</p><p>
All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned.
@@ -160,7 +160,7 @@ alias|alias|alias|alias...
On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
<code class="literal">printcap name = lpstat</code> to automatically obtain a list of printers. See the
<code class="literal">printcap name</code> option for more details.
- </p></div></div></div><div class="refsect1" lang="en"><a name="id307997"></a><h2>USERSHARES</h2><p>Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete
+ </p></div></div></div><div class="refsect1" lang="en"><a name="id2506592"></a><h2>USERSHARES</h2><p>Starting with Samba version 3.0.23 the capability for non-root users to add, modify, and delete
their own share definitions has been added. This capability is called <span class="emphasis"><em>usershares</em></span> and
is controlled by a set of parameters in the [global] section of the smb.conf.
The relevant parameters are :
@@ -178,13 +178,13 @@ chmod 1770 /usr/local/samba/lib/usershares
</pre><p>Then add the parameters
</p><pre class="programlisting">
- <a class="indexterm" name="id308127"></a>usershare path = /usr/local/samba/lib/usershares
- <a class="indexterm" name="id308134"></a>usershare max shares = 10 # (or the desired number of shares)
+ <a class="link" href="smb.conf.5.html#USERSHAREPATH">usershare path = /usr/local/samba/lib/usershares</a>
+ <a class="link" href="smb.conf.5.html#USERSHAREMAXSHARES">usershare max shares = 10</a> # (or the desired number of shares)
</pre><p>
to the global
section of your <code class="filename">smb.conf</code>. Members of the group foo may then manipulate the user defined shares
- using the following commands.</p><div class="variablelist"><dl><dt><span class="term">net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</span></dt><dd><p>To create or modify (overwrite) a user defined share.</p></dd><dt><span class="term">net usershare delete sharename</span></dt><dd><p>To delete a user defined share.</p></dd><dt><span class="term">net usershare list wildcard-sharename</span></dt><dd><p>To list user defined shares.</p></dd><dt><span class="term">net usershare info wildcard-sharename</span></dt><dd><p>To print information about user defined shares.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id308201"></a><h2>PARAMETERS</h2><p>Parameters define the specific attributes of sections.</p><p>
+ using the following commands.</p><div class="variablelist"><dl><dt><span class="term">net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</span></dt><dd><p>To create or modify (overwrite) a user defined share.</p></dd><dt><span class="term">net usershare delete sharename</span></dt><dd><p>To delete a user defined share.</p></dd><dt><span class="term">net usershare list wildcard-sharename</span></dt><dd><p>To list user defined shares.</p></dd><dt><span class="term">net usershare info wildcard-sharename</span></dt><dd><p>To print information about user defined shares.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2553528"></a><h2>PARAMETERS</h2><p>Parameters define the specific attributes of sections.</p><p>
Some parameters are specific to the [global] section (e.g., <span class="emphasis"><em>security</em></span>). Some parameters
are usable in all sections (e.g., <span class="emphasis"><em>create mask</em></span>). All others are permissible only in normal
sections. For the purposes of the following descriptions the [homes] and [printers] sections will be
@@ -196,7 +196,7 @@ chmod 1770 /usr/local/samba/lib/usershares
Parameters are arranged here in alphabetical order - this may not create best bedfellows, but at least you can
find them! Where there are synonyms, the preferred synonym is described, others refer to the preferred
synonym.
- </p></div><div class="refsect1" lang="en"><a name="id308242"></a><h2>VARIABLE SUBSTITUTIONS</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2553576"></a><h2>VARIABLE SUBSTITUTIONS</h2><p>
Many of the strings that are settable in the config file can take substitutions. For example the option
&#8220;<span class="quote">path = /tmp/%u</span>&#8221; is interpreted as &#8220;<span class="quote">path = /tmp/john</span>&#8221; if the user connected with the
username john.
@@ -214,14 +214,19 @@ chmod 1770 /usr/local/samba/lib/usershares
</p></dd><dt><span class="term">%M</span></dt><dd><p>the Internet name of the client machine.
</p></dd><dt><span class="term">%R</span></dt><dd><p>the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS,
LANMAN1, LANMAN2 or NT1.</p></dd><dt><span class="term">%d</span></dt><dd><p>the process id of the current server
- process.</p></dd><dt><span class="term">%a</span></dt><dd><p>the architecture of the remote
- machine. It currently recognizes Samba (<code class="constant">Samba</code>),
- the Linux CIFS file system (<code class="constant">CIFSFS</code>), OS/2, (<code class="constant">OS2</code>),
- Windows for Workgroups (<code class="constant">WfWg</code>), Windows 9x/ME
- (<code class="constant">Win95</code>), Windows NT (<code class="constant">WinNT</code>),
- Windows 2000 (<code class="constant">Win2K</code>), Windows XP (<code class="constant">WinXP</code>),
- and Windows 2003 (<code class="constant">Win2K3</code>). Anything else will be known as
- <code class="constant">UNKNOWN</code>.</p></dd><dt><span class="term">%I</span></dt><dd><p>the IP address of the client machine.</p></dd><dt><span class="term">%i</span></dt><dd><p>the local IP address to which a client connected.</p></dd><dt><span class="term">%T</span></dt><dd><p>the current date and time.</p></dd><dt><span class="term">%D</span></dt><dd><p>name of the domain or workgroup of the current user.</p></dd><dt><span class="term">%w</span></dt><dd><p>the winbind separator.</p></dd><dt><span class="term">%$(<em class="replaceable"><code>envvar</code></em>)</span></dt><dd><p>the value of the environment variable
+ process.</p></dd><dt><span class="term">%a</span></dt><dd><p>
+ The architecture of the remote
+ machine. It currently recognizes Samba (<code class="constant">Samba</code>),
+ the Linux CIFS file system (<code class="constant">CIFSFS</code>), OS/2, (<code class="constant">OS2</code>),
+ Windows for Workgroups (<code class="constant">WfWg</code>), Windows 9x/ME
+ (<code class="constant">Win95</code>), Windows NT (<code class="constant">WinNT</code>),
+ Windows 2000 (<code class="constant">Win2K</code>),
+ Windows XP (<code class="constant">WinXP</code>),
+ Windows XP 64-bit(<code class="constant">WinXP64</code>),
+ Windows 2003 including
+ 2003R2 (<code class="constant">Win2K3</code>), and Windows
+ Vista (<code class="constant">Vista</code>). Anything else will be known as
+ <code class="constant">UNKNOWN</code>.</p></dd><dt><span class="term">%I</span></dt><dd><p>the IP address of the client machine.</p></dd><dt><span class="term">%i</span></dt><dd><p>the local IP address to which a client connected.</p></dd><dt><span class="term">%T</span></dt><dd><p>the current date and time.</p></dd><dt><span class="term">%D</span></dt><dd><p>name of the domain or workgroup of the current user.</p></dd><dt><span class="term">%w</span></dt><dd><p>the winbind separator.</p></dd><dt><span class="term">%$(<em class="replaceable"><code>envvar</code></em>)</span></dt><dd><p>the value of the environment variable
<em class="replaceable"><code>envar</code></em>.</p></dd></dl></div><p>
The following substitutes apply only to some configuration options (only those that are
used when a connection has been established):
@@ -253,8 +258,8 @@ chmod 1770 /usr/local/samba/lib/usershares
</p></dd><dt><span class="term">default case = upper/lower</span></dt><dd><p>
controls what the default case is for new filenames (ie. files that don't currently exist in the filesystem).
Default <span class="emphasis"><em>lower</em></span>. IMPORTANT NOTE: This option will be used to modify the case of
- <span class="emphasis"><em>all</em></span> incoming client filenames, not just new filenames if the options <a class="indexterm" name="id308683"></a>case sensitive = yes, <a class="indexterm" name="id308690"></a>preserve case = No,
- <a class="indexterm" name="id308697"></a>short preserve case = No are set. This change is needed as part of the
+ <span class="emphasis"><em>all</em></span> incoming client filenames, not just new filenames if the options <a class="link" href="smb.conf.5.html#CASESENSITIVE">case sensitive = yes</a>, <a class="link" href="smb.conf.5.html#PRESERVECASE">preserve case = No</a>,
+ <a class="link" href="smb.conf.5.html#SHORTPRESERVECASE">short preserve case = No</a> are set. This change is needed as part of the
optimisations for directories containing large numbers of files.
</p></dd><dt><span class="term">preserve case = yes/no</span></dt><dd><p>
controls whether new files (ie. files that don't currently exist in the filesystem) are created with the case
@@ -300,59 +305,74 @@ chmod 1770 /usr/local/samba/lib/usershares
</p></li><li><p>
If the service is a guest service, a connection is made as the username given in the <code class="literal">guest account
=</code> for the service, irrespective of the supplied password.
- </p></li></ol></div></div><div class="refsect1" lang="en"><a name="id308893"></a><h2>REGISTRY-BASED CONFIGURATION</h2><p>
+ </p></li></ol></div></div><div class="refsect1" lang="en"><a name="id2554319"></a><h2>REGISTRY-BASED CONFIGURATION</h2><p>
Starting with Samba version 3.2.0, the capability to
store Samba configuration in the registry is available.
+ The configuration is stored in the registry key
+ <span class="emphasis"><em><code class="literal">HKLM\Software\Samba\smbconf</code></em></span>.
There are two levels of registry configuration:
</p><div class="orderedlist"><ol type="1"><li><p>Share definitions stored in registry are used.
This is triggered by setting the global
- parameter <em class="parameter"><code>registry shares</code></em> to &#8220;<span class="quote">yes</span>&#8221;
- in <span class="emphasis"><em>smb.conf</em></span>.
- </p><p>Note: Shares defined in <span class="emphasis"><em>smb.conf</em></span>
- always take priority over
- shares of the same name defined in registry.
- </p></li><li><p>Global <span class="emphasis"><em>smb.conf</em></span> options stored in
- registry are used. This is triggered by the
- parameter <a class="indexterm" name="id308946"></a>config backend = registry in
- the [global] section of <span class="emphasis"><em>smb.conf</em></span>.
- This removes everything that has been read from config files
+ parameter <em class="parameter"><code>registry shares</code></em>
+ to &#8220;<span class="quote">yes</span>&#8221; in <span class="emphasis"><em>smb.conf</em></span>.
+ </p><p>The registry shares are loaded not at startup but
+ on demand at runtime by <span class="emphasis"><em>smbd</em></span>.
+ Shares defined in <span class="emphasis"><em>smb.conf</em></span> take
+ priority over shares of the same name defined in
+ registry.</p></li><li><p>Global <span class="emphasis"><em>smb.conf</em></span>
+ options stored in registry are used. This can be activated
+ in two different ways:</p><p>Firstly, a registry only configuration is triggered
+ by setting
+ <a class="link" href="smb.conf.5.html#CONFIGBACKEND">config backend = registry</a>
+ in the [global] section of <span class="emphasis"><em>smb.conf</em></span>.
+ This resets everything that has been read from config files
to this point and reads the content of the global configuration
section from the registry.
- Activation of global registry options automatically
- activates registry shares. In this case, no share definitions
- from smb.conf are read: This is a registry only configuration
- with the advantage that share definitions are not read
- in a bulk at startup time but on demand when a share is
- accessed.
- </p></li></ol></div><p>
- Caveat: To make registry-based configurations foolproof at least to a
- certain extent, the use
- of <em class="parameter"><code>lock directory</code></em>,
- <em class="parameter"><code>config backend</code></em>, and
- <em class="parameter"><code>include</code></em> inside the registry
- configuration has been disabled. Especially, by changing the
+ This is the recommended method of using registry based
+ configuration.</p><p>Secondly, a mixed configuration can be activated
+ by a special new meaning of the parameter
+ <a class="link" href="smb.conf.5.html#INCLUDE">include = registry</a>
+ in the [global] section of <span class="emphasis"><em>smb.conf</em></span>.
+ This reads the global options from registry with the same
+ priorities as for an include of a text file.
+ This may be especially useful in cases where an initial
+ configuration is needed to access the registry.</p><p>Activation of global registry options automatically
+ activates registry shares. So in the registry only case,
+ shares are loaded on demand only.</p></li></ol></div><p>
+ Note: To make registry-based configurations foolproof
+ at least to a certain extent, the use
+ of <em class="parameter"><code>lock directory</code></em> and
+ <em class="parameter"><code>config backend</code></em>
+ inside the registry configuration has been disabled:
+ Especially by changing the
<em class="parameter"><code>lock directory</code></em> inside the registry
configuration, one would create a broken setup where the daemons
do not see the configuration they loaded once it is active.
</p><p>
The registry configuration can be accessed with
- tools like <span class="emphasis"><em>regedit</em></span> or <span class="emphasis"><em>net rpc
+ tools like <span class="emphasis"><em>regedit</em></span> or <span class="emphasis"><em>net (rpc)
registry</em></span> in the key
- <span class="emphasis"><em>HKLM\Software\Samba\smbconf</em></span>.
+ <span class="emphasis"><em><code class="literal">HKLM\Software\Samba\smbconf</code></em></span>.
More conveniently, the <span class="emphasis"><em>conf</em></span> subcommand of the
- <a href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> utility
+ <a class="citerefentry" href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> utility
offers a dedicated interface to read and write the
registry based configuration locally, i.e. directly
accessing the database file, circumventing the
server.
- </p></div><div class="refsect1" lang="en"><a name="id309022"></a><h2>EXPLANATION OF EACH PARAMETER</h2><div class="variablelist"><dl><dt><span class="term"><a name="ABORTSHUTDOWNSCRIPT"></a>abort shutdown script (G)</span></dt><dd><p>This a full path name to a script called by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that
- should stop a shutdown procedure issued by the <a class="indexterm" name="id309062"></a>shutdown script.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>,
+ </p></div><div class="refsect1" lang="en"><a name="id2554512"></a><h2>EXPLANATION OF EACH PARAMETER</h2><div class="section" lang="en"><div class="titlepage"></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2554525"></a>
+
+abort shutdown script (G)
+</h3></div></div></div><a class="indexterm" name="id2554526"></a><a name="ABORTSHUTDOWNSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This a full path name to a script called by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that
+ should stop a shutdown procedure issued by the <a class="link" href="smb.conf.5.html#SHUTDOWNSCRIPT">shutdown script</a>.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>,
right, this command will be run as user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">""</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>abort shutdown script</code></em> = <code class="literal">/sbin/shutdown -c</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ACLCHECKPERMISSIONS"></a>acl check permissions (S)</span></dt><dd><p>This boolean parameter controls what <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>does on receiving a protocol request of "open for delete"
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2554614"></a>
+
+acl check permissions (S)
+</h3></div></div></div><a class="indexterm" name="id2554615"></a><a name="ACLCHECKPERMISSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls what <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>does on receiving a protocol request of "open for delete"
from a Windows client. If a Windows client doesn't have permissions to delete a file then they
expect this to be denied at open time. POSIX systems normally only detect restrictions on delete by
actually attempting to delete the file or directory. As Windows clients can (and do) "back out" a
@@ -372,7 +392,10 @@ chmod 1770 /usr/local/samba/lib/usershares
with slightly different semantics was introduced in 3.0.20. That older version is not documented here.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl check permissions</code></em> = <code class="literal">True</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ACLCOMPATIBILITY"></a>acl compatibility (S)</span></dt><dd><p>This parameter specifies what OS ACL semantics should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2506118"></a>
+
+acl compatibility (S)
+</h3></div></div></div><a class="indexterm" name="id2506119"></a><a name="ACLCOMPATIBILITY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies what OS ACL semantics should
be compatible with. Possible values are <span class="emphasis"><em>winnt</em></span> for Windows NT 4,
<span class="emphasis"><em>win2k</em></span> for Windows 2000 and above and <span class="emphasis"><em>auto</em></span>.
If you specify <span class="emphasis"><em>auto</em></span>, the value for this parameter
@@ -381,7 +404,10 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>acl compatibility</code></em> = <code class="literal">win2k</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ACLGROUPCONTROL"></a>acl group control (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2506195"></a>
+
+acl group control (S)
+</h3></div></div></div><a class="indexterm" name="id2506196"></a><a name="ACLGROUPCONTROL"></a><div class="variablelist"><dl><dt></dt><dd><p>
In a POSIX filesystem, only the owner of a file or directory and the superuser can modify the permissions
and ACLs on a file. If this parameter is set, then Samba overrides this restriction, and also allows the
<span class="emphasis"><em>primary group owner</em></span> of a file or directory to modify the permissions and ACLs
@@ -394,11 +420,11 @@ chmod 1770 /usr/local/samba/lib/usershares
or directory, easing managability.
</p><p>
This parameter allows Samba to also permit delegation of the control over a point in the exported
- directory hierarchy in much the same was as Windows. This allows all members of a UNIX group to
+ directory hierarchy in much the same way as Windows. This allows all members of a UNIX group to
control the permissions on a file or directory they have group ownership on.
</p><p>
- This parameter is best used with the <a class="indexterm" name="id309290"></a>inherit owner option and also
- on on a share containing directories with the UNIX <span class="emphasis"><em>setgid bit</em></span> bit set
+ This parameter is best used with the <a class="link" href="smb.conf.5.html#INHERITOWNER">inherit owner</a> option and also
+ on on a share containing directories with the UNIX <span class="emphasis"><em>setgid bit</em></span> set
on them, which causes new files and directories created within it to inherit the group
ownership from the containing directory.
</p><p>
@@ -406,16 +432,22 @@ chmod 1770 /usr/local/samba/lib/usershares
implemented by the <em class="parameter"><code>dos filemode</code></em> option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl group control</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ACLMAPFULLCONTROL"></a>acl map full control (S)</span></dt><dd><p>
- This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555014"></a>
+
+acl map full control (S)
+</h3></div></div></div><a class="indexterm" name="id2555015"></a><a name="ACLMAPFULLCONTROL"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>maps a POSIX ACE entry of "rwx" (read/write/execute), the maximum
allowed POSIX permission set, into a Windows ACL of "FULL CONTROL". If this parameter is set to true any POSIX
ACE entry of "rwx" will be returned in a Windows ACL as "FULL CONTROL", is this parameter is set to false any
POSIX ACE entry of "rwx" will be returned as the specific Windows ACL bits representing read, write and
execute.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>acl map full control</code></em> = <code class="literal">True</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDGROUPSCRIPT"></a>add group script (G)</span></dt><dd><p>
- This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a new group is requested. It
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555070"></a>
+
+add group script (G)
+</h3></div></div></div><a class="indexterm" name="id2555071"></a><a name="ADDGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a new group is requested. It
will expand any <em class="parameter"><code>%g</code></em> to the group name passed. This script is only useful
for installations using the Windows NT domain administration tools. The script is free to create a group with
an arbitrary name to circumvent unix group name restrictions. In that case the script must print the numeric
@@ -424,28 +456,36 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add group script</code></em> = <code class="literal">/usr/sbin/groupadd %g</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDMACHINESCRIPT"></a>add machine script (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555152"></a>
+
+add machine script (G)
+</h3></div></div></div><a class="indexterm" name="id2555153"></a><a name="ADDMACHINESCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run by
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a machine is
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a machine is
added to Samba's domain and a Unix account matching the machine's name appended with a "$" does not
already exist.
- </p><p>This option is very similar to the <a class="indexterm" name="id309488"></a>add user script, and likewise uses the %u
+ </p><p>This option is very similar to the <a class="link" href="smb.conf.5.html#ADDUSERSCRIPT">add user script</a>, and likewise uses the %u
substitution for the account name. Do not use the %m
substitution. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add machine script</code></em> = <code class="literal">/usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDPORTCOMMAND"></a>add port command (G)</span></dt><dd><p>Samba 3.0.23 introduces support for adding printer ports
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555239"></a>
+
+add port command (G)
+</h3></div></div></div><a class="indexterm" name="id2555240"></a><a name="ADDPORTCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>Samba 3.0.23 introduced support for adding printer ports
remotely using the Windows "Add Standard TCP/IP Port Wizard".
This option defines an external program to be executed when
smbd receives a request to add a new Port to the system.
- he script is passed two parameters:
- </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>port name</code></em></p></li><li><p><em class="parameter"><code>device URI</code></em></p></li></ul></div><p>The deviceURI is in the for of socket://&lt;hostname&gt;[:&lt;portnumber&gt;]
+ The script is passed two parameters:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>port name</code></em></p></li><li><p><em class="parameter"><code>device URI</code></em></p></li></ul></div><p>The deviceURI is in the for of socket://&lt;hostname&gt;[:&lt;portnumber&gt;]
or lpd://&lt;hostname&gt;/&lt;queuename&gt;.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add port command</code></em> = <code class="literal">/etc/samba/scripts/addport.sh</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDPRINTERCOMMAND"></a>add printer command (G)</span></dt><dd><p>With the introduction of MS-RPC based printing
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555330"></a>
+
+add printer command (G)
+</h3></div></div></div><a class="indexterm" name="id2555331"></a><a name="ADDPRINTERCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printing
support for Windows NT/2000 clients in Samba 2.2, The MS Add
Printer Wizard (APW) icon is now also available in the
"Printers..." folder displayed a share listing. The APW
@@ -456,7 +496,7 @@ chmod 1770 /usr/local/samba/lib/usershares
will perform the necessary operations for adding the printer
to the print system and to add the appropriate service definition
to the <code class="filename">smb.conf</code> file in order that it can be
- shared by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>The <em class="parameter"><code>addprinter command</code></em> is
+ shared by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>The <em class="parameter"><code>addprinter command</code></em> is
automatically invoked with the following parameter (in
order):</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>printer name</code></em></p></li><li><p><em class="parameter"><code>share name</code></em></p></li><li><p><em class="parameter"><code>port name</code></em></p></li><li><p><em class="parameter"><code>driver name</code></em></p></li><li><p><em class="parameter"><code>location</code></em></p></li><li><p><em class="parameter"><code>Windows 9x driver location</code></em></p></li></ul></div><p>All parameters are filled in from the PRINTER_INFO_2 structure sent
by the Windows NT/2000 client with one exception. The "Windows 9x
@@ -474,7 +514,10 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add printer command</code></em> = <code class="literal">/usr/bin/addprinter</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDSHARECOMMAND"></a>add share command (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555528"></a>
+
+add share command (G)
+</h3></div></div></div><a class="indexterm" name="id2555530"></a><a name="ADDSHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>add share command</code></em> is used to define an external program
or script which will add a new service definition to <code class="filename">smb.conf</code>. In order
@@ -496,14 +539,17 @@ chmod 1770 /usr/local/samba/lib/usershares
Number of maximum simultaneous connections to this
share.
</p></li></ul></div><p>
- This parameter is only used for add file shares. To add printer shares, see the <a class="indexterm" name="id309946"></a>addprinter command.
+ This parameter is only used for add file shares. To add printer shares, see the <a class="link" href="smb.conf.5.html#ADDPRINTERCOMMAND">addprinter command</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add share command</code></em> = <code class="literal">/usr/local/bin/addshare</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDUSERSCRIPT"></a>add user script (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555732"></a>
+
+add user script (G)
+</h3></div></div></div><a class="indexterm" name="id2555733"></a><a name="ADDUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the full pathname to a script that will be run <span class="emphasis"><em>AS ROOT</em></span> by
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
under special circumstances described below.
</p><p>
Normally, a Samba server requires that UNIX users are created for all users accessing
@@ -512,17 +558,17 @@ chmod 1770 /usr/local/samba/lib/usershares
NT PDC is an onerous task. This option allows smbd to create the required UNIX users
<span class="emphasis"><em>ON DEMAND</em></span> when a user accesses the Samba server.
</p><p>
- In order to use this option, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must <span class="emphasis"><em>NOT</em></span> be set to
- <a class="indexterm" name="id310044"></a>security = share and <a class="indexterm" name="id310052"></a>add user script
+ In order to use this option, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must <span class="emphasis"><em>NOT</em></span> be set to
+ <a class="link" href="smb.conf.5.html#SECURITY">security = share</a> and <a class="link" href="smb.conf.5.html#ADDUSERSCRIPT">add user script</a>
must be set to a full pathname for a script that will create a UNIX user given one argument of
<em class="parameter"><code>%u</code></em>, which expands into the UNIX user name to create.
</p><p>
When the Windows user attempts to access the Samba server, at login (session setup in
- the SMB protocol) time, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> contacts the <a class="indexterm" name="id310078"></a>password server
+ the SMB protocol) time, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> contacts the <a class="link" href="smb.conf.5.html#PASSWORDSERVER">password server</a>
and attempts to authenticate the given user with the given password. If the authentication
succeeds then <code class="literal">smbd</code> attempts to find a UNIX user in the UNIX
password database to map the Windows user into. If this lookup fails, and
- <a class="indexterm" name="id310093"></a>add user script is set then <code class="literal">smbd</code> will
+ <a class="link" href="smb.conf.5.html#ADDUSERSCRIPT">add user script</a> is set then <code class="literal">smbd</code> will
call the specified script <span class="emphasis"><em>AS ROOT</em></span>, expanding any
<em class="parameter"><code>%u</code></em> argument to be the user name to create.
</p><p>
@@ -530,15 +576,18 @@ chmod 1770 /usr/local/samba/lib/usershares
continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
match existing Windows NT accounts.
</p><p>
- See also <a class="indexterm" name="id310130"></a>security, <a class="indexterm" name="id310137"></a>password server,
- <a class="indexterm" name="id310144"></a>delete user script.
+ See also <a class="link" href="smb.conf.5.html#SECURITY">security</a>, <a class="link" href="smb.conf.5.html#PASSWORDSERVER">password server</a>,
+ <a class="link" href="smb.conf.5.html#DELETEUSERSCRIPT">delete user script</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user script</code></em> = <code class="literal">/usr/local/samba/bin/add_user %u</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADDUSERTOGROUPSCRIPT"></a>add user to group script (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2555977"></a>
+
+add user to group script (G)
+</h3></div></div></div><a class="indexterm" name="id2555978"></a><a name="ADDUSERTOGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
Full path to the script that will be called when a user is added to a group using the Windows NT domain administration
- tools. It will be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
+ tools. It will be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
<span class="emphasis"><em>AS ROOT</em></span>. Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and
any <em class="parameter"><code>%u</code></em> will be replaced with the user name.
</p><p>
@@ -548,23 +597,42 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>add user to group script</code></em> = <code class="literal">/usr/sbin/adduser %u %g</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ADMINUSERS"></a>admin users (S)</span></dt><dd><p>This is a list of users who will be granted
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556071"></a>
+
+administrative share (S)
+</h3></div></div></div><a class="indexterm" name="id2556072"></a><a name="ADMINISTRATIVESHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is set to <code class="constant">yes</code> for
+ a share, then the share will be an administrative share. The Administrative
+ Shares are the default network shares created by all Windows NT-based
+ operating systems. These are shares like C$, D$ or ADMIN$. The type of these
+ shares is STYPE_DISKTREE_HIDDEN.</p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY">security</a> for more
+ information about this option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>administrative share</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556138"></a>
+
+admin users (S)
+</h3></div></div></div><a class="indexterm" name="id2556139"></a><a name="ADMINUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of users who will be granted
administrative privileges on the share. This means that they
will do all file operations as the super-user (root).</p><p>You should use this option very carefully, as any user in
this list will be able to do anything they like on the share,
- irrespective of file permissions.</p><p>This parameter will not work with the <a class="indexterm" name="id310304"></a>security = share in
+ irrespective of file permissions.</p><p>This parameter will not work with the <a class="link" href="smb.conf.5.html#SECURITY">security = share</a> in
Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>admin users</code></em> = <code class="literal">jason</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AFSSHARE"></a>afs share (S)</span></dt><dd><p>This parameter controls whether special AFS features are enabled
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556218"></a>
+
+afs share (S)
+</h3></div></div></div><a class="indexterm" name="id2556219"></a><a name="AFSSHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether special AFS features are enabled
for this share. If enabled, it assumes that the directory exported via
the <em class="parameter"><code>path</code></em> parameter is a local AFS import. The
special AFS features include the attempt to hand-craft an AFS token
if you enabled --with-fake-kaserver in configure.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>afs share</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AFSUSERNAMEMAP"></a>afs username map (G)</span></dt><dd><p>If you are using the fake kaserver AFS feature, you might
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556268"></a>
+
+afs username map (G)
+</h3></div></div></div><a class="indexterm" name="id2556270"></a><a name="AFSUSERNAMEMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>If you are using the fake kaserver AFS feature, you might
want to hand-craft the usernames you are creating tokens for.
For example this is necessary if you have users from several domain
in your AFS Protection Database. One possible scheme to code users
@@ -574,39 +642,38 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>afs username map</code></em> = <code class="literal">%u@afs.samba.org</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AIOREADSIZE"></a>aio read size (S)</span></dt><dd><p>If Samba has been built with asynchronous I/O support and this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556336"></a>
+
+aio read size (S)
+</h3></div></div></div><a class="indexterm" name="id2556337"></a><a name="AIOREADSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba has been built with asynchronous I/O support and this
integer parameter is set to non-zero value,
Samba will read from file asynchronously when size of request is bigger
than this value. Note that it happens only for non-chained and non-chaining
reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support
- only up to 10 outstanding asynchronous requests, read and write combined.</p>
-
- write cache size
- aio write size
-
-<p>Default: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">0</code>
+ only up to 10 outstanding asynchronous requests, read and write combined.</p><p>Related command: <a class="link" href="smb.conf.5.html#WRITECACHESIZE">write cache size</a></p><p>Related command: <a class="link" href="smb.conf.5.html#AIOWRITESIZE">aio write size</a></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio read size</code></em> = <code class="literal">16384
# Use asynchronous I/O for reads bigger than 16KB
request size</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AIOWRITESIZE"></a>aio write size (S)</span></dt><dd><p>If Samba has been built with asynchronous I/O support and this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556436"></a>
+
+aio write size (S)
+</h3></div></div></div><a class="indexterm" name="id2556437"></a><a name="AIOWRITESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba has been built with asynchronous I/O support and this
integer parameter is set to non-zero value,
Samba will write to file asynchronously when size of request is bigger
than this value. Note that it happens only for non-chained and non-chaining
reads and when not using write cache.</p><p>Current implementation of asynchronous I/O in Samba 3.0 does support
- only up to 10 outstanding asynchronous requests, read and write combined.</p>
-
- write cache size
- aio read size
-
-<p>Default: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">0</code>
+ only up to 10 outstanding asynchronous requests, read and write combined.</p><p>Related command: <a class="link" href="smb.conf.5.html#WRITECACHESIZE">write cache size</a></p><p>Related command: <a class="link" href="smb.conf.5.html#AIOREADSIZE">aio read size</a></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>aio write size</code></em> = <code class="literal">16384
# Use asynchronous I/O for writes bigger than 16KB
request size</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ALGORITHMICRIDBASE"></a>algorithmic rid base (G)</span></dt><dd><p>This determines how Samba will use its
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556533"></a>
+
+algorithmic rid base (G)
+</h3></div></div></div><a class="indexterm" name="id2556534"></a><a name="ALGORITHMICRIDBASE"></a><div class="variablelist"><dl><dt></dt><dd><p>This determines how Samba will use its
algorithmic mapping from uids/gid to the RIDs needed to construct
NT Security Identifiers.
</p><p>Setting this option to a larger value could be useful to sites
@@ -621,7 +688,10 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>algorithmic rid base</code></em> = <code class="literal">100000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ALLOCATIONROUNDUPSIZE"></a>allocation roundup size (S)</span></dt><dd><p>This parameter allows an administrator to tune the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556610"></a>
+
+allocation roundup size (S)
+</h3></div></div></div><a class="indexterm" name="id2556611"></a><a name="ALLOCATIONROUNDUPSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows an administrator to tune the
allocation size reported to Windows clients. The default
size of 1Mb generally results in improved Windows client
performance. However, rounding the allocation size may cause
@@ -633,8 +703,11 @@ chmod 1770 /usr/local/samba/lib/usershares
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>allocation roundup size</code></em> = <code class="literal">0
# (to disable roundups)</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ALLOWTRUSTEDDOMAINS"></a>allow trusted domains (G)</span></dt><dd><p>
- This option only takes effect when the <a class="indexterm" name="id310731"></a>security option is set to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556681"></a>
+
+allow trusted domains (G)
+</h3></div></div></div><a class="indexterm" name="id2556682"></a><a name="ALLOWTRUSTEDDOMAINS"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This option only takes effect when the <a class="link" href="smb.conf.5.html#SECURITY">security</a> option is set to
<code class="constant">server</code>, <code class="constant">domain</code> or <code class="constant">ads</code>.
If it is set to no, then attempts to connect to a resource from
a domain or workgroup other than the one which smbd is running
@@ -648,7 +721,10 @@ chmod 1770 /usr/local/samba/lib/usershares
Samba server even if they do not have an account in DOMA. This
can make implementing a security boundary difficult.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>allow trusted domains</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ANNOUNCEAS"></a>announce as (G)</span></dt><dd><p>This specifies what type of server <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will announce itself as, to a network neighborhood browse
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556759"></a>
+
+announce as (G)
+</h3></div></div></div><a class="indexterm" name="id2556760"></a><a name="ANNOUNCEAS"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies what type of server <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will announce itself as, to a network neighborhood browse
list. By default this is set to Windows NT. The valid options
are : "NT Server" (which can also be written as "NT"),
"NT Workstation", "Win95" or "WfW" meaning Windows NT Server,
@@ -660,16 +736,22 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce as</code></em> = <code class="literal">Win95</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ANNOUNCEVERSION"></a>announce version (G)</span></dt><dd><p>This specifies the major and minor version numbers
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556834"></a>
+
+announce version (G)
+</h3></div></div></div><a class="indexterm" name="id2556835"></a><a name="ANNOUNCEVERSION"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies the major and minor version numbers
that nmbd will use when announcing itself as a server. The default
is 4.9. Do not change this parameter unless you have a specific
need to set a Samba server to be a downlevel server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">4.9</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>announce version</code></em> = <code class="literal">2.0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AUTHMETHODS"></a>auth methods (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2556896"></a>
+
+auth methods (G)
+</h3></div></div></div><a class="indexterm" name="id2556897"></a><a name="AUTHMETHODS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows the administrator to chose what authentication methods <code class="literal">smbd</code>
- will use when authenticating a user. This option defaults to sensible values based on <a class="indexterm" name="id310928"></a>security.
+ will use when authenticating a user. This option defaults to sensible values based on <a class="link" href="smb.conf.5.html#SECURITY">security</a>.
This should be considered a developer option and used only in rare circumstances. In the majority (if not all)
of production servers, the default setting should be adequate.
</p><p>
@@ -688,43 +770,49 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>auth methods</code></em> = <code class="literal">guest sam winbind</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AVAILABLE"></a>available (S)</span></dt><dd><p>This parameter lets you "turn off" a service. If
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557012"></a>
+
+available (S)
+</h3></div></div></div><a class="indexterm" name="id2557013"></a><a name="AVAILABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter lets you "turn off" a service. If
<em class="parameter"><code>available = no</code></em>, then <span class="emphasis"><em>ALL</em></span>
attempts to connect to the service will fail. Such failures are
logged.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>available</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="BINDINTERFACESONLY"></a>bind interfaces only (G)</span></dt><dd><p>This global parameter allows the Samba admin
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557064"></a>
+
+bind interfaces only (G)
+</h3></div></div></div><a class="indexterm" name="id2557065"></a><a name="BINDINTERFACESONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This global parameter allows the Samba admin
to limit what interfaces on a machine will serve SMB requests. It
- affects file service <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and name service <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> in a slightly different ways.</p><p>
+ affects file service <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and name service <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> in a slightly different ways.</p><p>
For name service it causes <code class="literal">nmbd</code> to bind to ports 137 and 138 on the
- interfaces listed in the <a class="indexterm" name="id311097"></a>interfaces parameter. <code class="literal">nmbd</code>
+ interfaces listed in the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> parameter. <code class="literal">nmbd</code>
also binds to the "all addresses" interface (0.0.0.0) on ports 137 and 138 for the purposes of
reading broadcast messages. If this option is not set then <code class="literal">nmbd</code> will
- service name requests on all of these sockets. If <a class="indexterm" name="id311118"></a>bind interfaces only is set then
+ service name requests on all of these sockets. If <a class="link" href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</a> is set then
<code class="literal">nmbd</code> will check the source address of any packets coming in on the
broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the
- <a class="indexterm" name="id311132"></a>interfaces parameter list. As unicast packets are received on the other sockets it
+ <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> parameter list. As unicast packets are received on the other sockets it
allows <code class="literal">nmbd</code> to refuse to serve names to machines that send packets that
- arrive through any interfaces not listed in the <a class="indexterm" name="id311147"></a>interfaces list. IP Source address
+ arrive through any interfaces not listed in the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> list. IP Source address
spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
<code class="literal">nmbd</code>.
</p><p>
- For file service it causes <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to bind only to the interface list given in the <a class="indexterm" name="id311172"></a>interfaces parameter. This restricts the networks that <code class="literal">smbd</code> will
+ For file service it causes <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to bind only to the interface list given in the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> parameter. This restricts the networks that <code class="literal">smbd</code> will
serve to packets coming in those interfaces. Note that you should not use this parameter for machines that
are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with
non-permanent interfaces.
</p><p>
- If <a class="indexterm" name="id311191"></a>bind interfaces only is set then unless the network address
- <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="indexterm" name="id311202"></a>interfaces parameter list
- <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> and
- <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> may not work as
+ If <a class="link" href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</a> is set then unless the network address
+ <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> parameter list
+ <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> and
+ <a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a> may not work as
expected due to the reasons covered below.
</p><p>
To change a users SMB password, the <code class="literal">smbpasswd</code> by default connects to the
<span class="emphasis"><em>localhost - 127.0.0.1</em></span> address as an SMB client to issue the password change request. If
- <a class="indexterm" name="id311240"></a>bind interfaces only is set then unless the network address
- <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="indexterm" name="id311251"></a>interfaces parameter list then <code class="literal"> smbpasswd</code> will fail to connect in it's default mode. <code class="literal">smbpasswd</code> can be forced to use the primary IP interface of the local host by using
- its <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> <em class="parameter"><code>-r <em class="replaceable"><code>remote machine</code></em></code></em> parameter, with <em class="replaceable"><code>remote
+ <a class="link" href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</a> is set then unless the network address
+ <span class="emphasis"><em>127.0.0.1</em></span> is added to the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a> parameter list then <code class="literal"> smbpasswd</code> will fail to connect in it's default mode. <code class="literal">smbpasswd</code> can be forced to use the primary IP interface of the local host by using
+ its <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> <em class="parameter"><code>-r <em class="replaceable"><code>remote machine</code></em></code></em> parameter, with <em class="replaceable"><code>remote
machine</code></em> set to the IP name of the primary interface of the local host.
</p><p>
The <code class="literal">swat</code> status page tries to connect with <code class="literal">smbd</code> and <code class="literal">nmbd</code> at the address
@@ -734,8 +822,11 @@ chmod 1770 /usr/local/samba/lib/usershares
from starting/stopping/restarting <code class="literal">smbd</code> and <code class="literal">nmbd</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>bind interfaces only</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="BLOCKINGLOCKS"></a>blocking locks (S)</span></dt><dd><p>This parameter controls the behavior
- of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when given a request by a client
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557442"></a>
+
+blocking locks (S)
+</h3></div></div></div><a class="indexterm" name="id2557443"></a><a name="BLOCKINGLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls the behavior
+ of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when given a request by a client
to obtain a byte range lock on a region of an open file, and the
request has a time limit associated with it.</p><p>If this parameter is set and the lock range requested
cannot be immediately satisfied, samba will internally
@@ -745,7 +836,10 @@ chmod 1770 /usr/local/samba/lib/usershares
will fail the lock request immediately if the lock range
cannot be obtained.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>blocking locks</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="BLOCKSIZE"></a>block size (S)</span></dt><dd><p>This parameter controls the behavior of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when reporting disk free
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557510"></a>
+
+block size (S)
+</h3></div></div></div><a class="indexterm" name="id2557511"></a><a name="BLOCKSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls the behavior of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when reporting disk free
sizes. By default, this reports a disk block size of 1024 bytes.
</p><p>Changing this parameter may have some effect on the
efficiency of client writes, this is not yet confirmed. This
@@ -759,21 +853,36 @@ chmod 1770 /usr/local/samba/lib/usershares
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>block size</code></em> = <code class="literal">4096</code>
</em></span>
-</p></dd><dt><span class="term"><a name="BROWSABLE"></a>browsable</span></dt><dd><p>This parameter is a synonym for browseable.</p></dd><dt><span class="term"><a name="BROWSEABLE"></a>browseable (S)</span></dt><dd><p>This controls whether this share is seen in
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557593"></a><a name="BROWSABLE"></a>browsable</h3></div></div></div><a class="indexterm" name="id2557594"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#BROWSEABLE">browseable</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557623"></a>
+
+browseable (S)
+</h3></div></div></div><a class="indexterm" name="id2557624"></a><a name="BROWSEABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether this share is seen in
the list of available shares in a net view and in the browse list.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browseable</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="BROWSELIST"></a>browse list (G)</span></dt><dd><p>This controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will serve a browse list to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557665"></a>
+
+browse list (G)
+</h3></div></div></div><a class="indexterm" name="id2557666"></a><a name="BROWSELIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will serve a browse list to
a client doing a <code class="literal">NetServerEnum</code> call. Normally
set to <code class="constant">yes</code>. You should never need to change
this.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>browse list</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CASESIGNAMES"></a>casesignames</span></dt><dd><p>This parameter is a synonym for case sensitive.</p></dd><dt><span class="term"><a name="CASESENSITIVE"></a>case sensitive (S)</span></dt><dd><p>See the discussion in the section <a class="indexterm" name="id311661"></a>name mangling.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>case sensitive</code></em> = <code class="literal">no</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557725"></a><a name="CASESIGNAMES"></a>casesignames</h3></div></div></div><a class="indexterm" name="id2557726"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#CASESENSITIVE">case sensitive</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557756"></a>
+
+case sensitive (S)
+</h3></div></div></div><a class="indexterm" name="id2557757"></a><a name="CASESENSITIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>See the discussion in the section <a class="link" href="smb.conf.5.html#NAMEMANGLING">name mangling</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>case sensitive</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CHANGENOTIFY"></a>change notify (S)</span></dt><dd><p>This parameter specifies whether Samba should reply
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557810"></a>
+
+change notify (S)
+</h3></div></div></div><a class="indexterm" name="id2557811"></a><a name="CHANGENOTIFY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should reply
to a client's file change notify requests.
</p><p>You should never need to change this parameter</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>change notify</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CHANGESHARECOMMAND"></a>change share command (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2557856"></a>
+
+change share command (G)
+</h3></div></div></div><a class="indexterm" name="id2557857"></a><a name="CHANGESHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>change share command</code></em> is used to define an external
program or script which will modify an existing service definition in <code class="filename">smb.conf</code>. In order to successfully execute the <em class="parameter"><code>change
@@ -804,18 +913,21 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>change share command</code></em> = <code class="literal">/usr/local/bin/addshare</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CHECKPASSWORDSCRIPT"></a>check password script (G)</span></dt><dd><p>The name of a program that can be used to check password
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558052"></a>
+
+check password script (G)
+</h3></div></div></div><a class="indexterm" name="id2558053"></a><a name="CHECKPASSWORDSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>The name of a program that can be used to check password
complexity. The password is sent to the program's standrad input.</p><p>The program must return 0 on good password any other value otherwise.
In case the password is considered weak (the program do not return 0) the
user will be notified and the password change will fail.</p><p>Note: In the example directory there is a sample program called crackcheck
- that uses cracklib to checkpassword quality</p>.
-
-
-<p>Default: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">Disabled</code>
+ that uses cracklib to checkpassword quality.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">Disabled</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>check password script</code></em> = <code class="literal">check password script = /usr/local/sbin/crackcheck</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTLANMANAUTH"></a>client lanman auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> and other samba client
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558126"></a>
+
+client lanman auth (G)
+</h3></div></div></div><a class="indexterm" name="id2558127"></a><a name="CLIENTLANMANAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> and other samba client
tools will attempt to authenticate itself to servers using the
weaker LANMAN password hash. If disabled, only server which support NT
password hashes (e.g. Windows NT/2000, Samba, etc... but not
@@ -826,8 +938,11 @@ connected using a root account (i.e. uid == 0).
auth</code> parameter is enabled, then only NTLMv2 logins will be
attempted.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client lanman auth</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTLDAPSASLWRAPPING"></a>client ldap sasl wrapping (G)</span></dt><dd><p>
- The <a class="indexterm" name="id312072"></a>client ldap sasl wrapping defines whether
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558208"></a>
+
+client ldap sasl wrapping (G)
+</h3></div></div></div><a class="indexterm" name="id2558209"></a><a name="CLIENTLDAPSASLWRAPPING"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ The <a class="link" href="smb.conf.5.html#CLIENTLDAPSASLWRAPPING">client ldap sasl wrapping</a> defines whether
ldap traffic will be signed or signed and encrypted (sealed).
Possible values are <span class="emphasis"><em>plain</em></span>, <span class="emphasis"><em>sign</em></span>
and <span class="emphasis"><em>seal</em></span>.
@@ -839,7 +954,8 @@ connected using a root account (i.e. uid == 0).
This option is needed in the case of Domain Controllers enforcing
the usage of signed LDAP connections (e.g. Windows 2000 SP3 or higher).
LDAP sign and seal can be controlled with the registry key
- "HKLM\System\CurrentControlSet\Services\NTDS\Parameters\LDAPServerIntegrity"
+ "<code class="literal">HKLM\System\CurrentControlSet\Services\</code>
+ <code class="literal">NTDS\Parameters\LDAPServerIntegrity</code>"
on the Windows server side.
</p><p>
Depending on the used KRB5 library (MIT and older Heimdal versions)
@@ -853,7 +969,10 @@ connected using a root account (i.e. uid == 0).
<span class="emphasis"><em>seal</em></span>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ldap sasl wrapping</code></em> = <code class="literal">plain</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTNTLMV2AUTH"></a>client ntlmv2 auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> will attempt to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558337"></a>
+
+client ntlmv2 auth (G)
+</h3></div></div></div><a class="indexterm" name="id2558338"></a><a name="CLIENTNTLMV2AUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbclient.8.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(8)</span></a> will attempt to
authenticate itself to servers using the NTLMv2 encrypted password
response.</p><p>If enabled, only an NTLMv2 and LMv2 response (both much more
secure than earlier versions) will be sent. Many servers
@@ -865,20 +984,29 @@ connected using a root account (i.e. uid == 0).
those following 'best practice' security polices) only allow NTLMv2
responses, and not the weaker LM or NTLM.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client ntlmv2 auth</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTPLAINTEXTAUTH"></a>client plaintext auth (G)</span></dt><dd><p>Specifies whether a client should send a plaintext
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558431"></a>
+
+client plaintext auth (G)
+</h3></div></div></div><a class="indexterm" name="id2558432"></a><a name="CLIENTPLAINTEXTAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies whether a client should send a plaintext
password if the server does not support encrypted passwords.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client plaintext auth</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTSCHANNEL"></a>client schannel (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558475"></a>
+
+client schannel (G)
+</h3></div></div></div><a class="indexterm" name="id2558476"></a><a name="CLIENTSCHANNEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the client offers or even demands the use of the netlogon schannel.
- <a class="indexterm" name="id312298"></a>client schannel = no does not offer the schannel,
- <a class="indexterm" name="id312306"></a>client schannel = auto offers the schannel but does not
- enforce it, and <a class="indexterm" name="id312313"></a>client schannel = yes denies access
+ <a class="link" href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = no</a> does not offer the schannel,
+ <a class="link" href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = auto</a> offers the schannel but does not
+ enforce it, and <a class="link" href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = yes</a> denies access
if the server is not able to speak netlogon schannel.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>client schannel</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTSIGNING"></a>client signing (G)</span></dt><dd><p>This controls whether the client offers or requires
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558572"></a>
+
+client signing (G)
+</h3></div></div></div><a class="indexterm" name="id2558573"></a><a name="CLIENTSIGNING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether the client offers or requires
the server it talks to to use SMB signing. Possible values
are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span>
and <span class="emphasis"><em>disabled</em></span>.
@@ -887,26 +1015,57 @@ connected using a root account (i.e. uid == 0).
to disabled, SMB signing is not offered either.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client signing</code></em> = <code class="literal">auto</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CLIENTUSESPNEGO"></a>client use spnego (G)</span></dt><dd><p> This variable controls whether Samba clients will try
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558634"></a>
+
+client use spnego (G)
+</h3></div></div></div><a class="indexterm" name="id2558635"></a><a name="CLIENTUSESPNEGO"></a><div class="variablelist"><dl><dt></dt><dd><p> This variable controls whether Samba clients will try
to use Simple and Protected NEGOciation (as specified by rfc2478) with
supporting servers (including WindowsXP, Windows2000 and Samba
3.0) to agree upon an authentication
mechanism. This enables Kerberos authentication in particular.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>client use spnego</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="COMMENT"></a>comment (S)</span></dt><dd><p>This is a text field that is seen next to a share
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558680"></a>
+
+cluster addresses (G)
+</h3></div></div></div><a class="indexterm" name="id2558681"></a><a name="CLUSTERADDRESSES"></a><div class="variablelist"><dl><dt></dt><dd><p>With this parameter you can add additional addresses
+ nmbd will register with a WINS server. These addresses are not
+ necessarily present on all nodes simultaneously, but they will
+ be registered with the WINS server so that clients can contact
+ any of the nodes.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cluster addresses</code></em> = <code class="literal"></code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cluster addresses</code></em> = <code class="literal">10.0.0.1 10.0.0.2 10.0.0.3</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558742"></a>
+
+clustering (G)
+</h3></div></div></div><a class="indexterm" name="id2558743"></a><a name="CLUSTERING"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should contact
+ ctdb for accessing its tdb files and use ctdb as a backend
+ for its messaging backend.
+ </p><p>Set this parameter to <code class="literal">yes</code> only if
+ you have a cluster setup with ctdb running.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>clustering</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558795"></a>
+
+comment (S)
+</h3></div></div></div><a class="indexterm" name="id2558796"></a><a name="COMMENT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a text field that is seen next to a share
when a client does a queries the server, either via the network
neighborhood or via <code class="literal">net view</code> to list what shares
are available.</p><p>If you want to set the string that is displayed next to the
- machine name then see the <a class="indexterm" name="id312483"></a>server string parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">
+ machine name then see the <a class="link" href="smb.conf.5.html#SERVERSTRING">server string</a> parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">
# No comment</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>comment</code></em> = <code class="literal">Fred's Files</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CONFIGBACKEND"></a>config backend (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558879"></a>
+
+config backend (G)
+</h3></div></div></div><a class="indexterm" name="id2558880"></a><a name="CONFIGBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls the backend for storing the configuration.
Possible values are <span class="emphasis"><em>file</em></span> (the default)
and <span class="emphasis"><em>registry</em></span>.
- When <a class="indexterm" name="id312554"></a>config backend = registry
+ When <a class="link" href="smb.conf.5.html#CONFIGBACKEND">config backend = registry</a>
is encountered while loading <span class="emphasis"><em>smb.conf</em></span>,
the configuration read so far is dropped and the global
options are read from registry instead. So this triggers a
@@ -920,7 +1079,10 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config backend</code></em> = <code class="literal">registry</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CONFIGFILE"></a>config file (G)</span></dt><dd><p>This allows you to override the config file
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2558979"></a>
+
+config file (G)
+</h3></div></div></div><a class="indexterm" name="id2558980"></a><a name="CONFIGFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>This allows you to override the config file
to use, instead of the default (usually <code class="filename">smb.conf</code>).
There is a chicken and egg problem here as this option is set
in the config file!</p><p>For this reason, if the name of the config file has changed
@@ -930,7 +1092,10 @@ connected using a root account (i.e. uid == 0).
(allowing you to special case the config files of just a few
clients).</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>config file</code></em> = <code class="literal">/usr/local/samba/lib/smb.conf.%m</code>
</em></span>
-</p></dd><dt><span class="term"><a name="COPY"></a>copy (S)</span></dt><dd><p>This parameter allows you to "clone" service
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559049"></a>
+
+copy (S)
+</h3></div></div></div><a class="indexterm" name="id2559050"></a><a name="COPY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows you to "clone" service
entries. The specified service is simply duplicated under the
current service's name. Any parameters specified in the current
section will override those in the section being copied.</p><p>This feature lets you set up a 'template' service and
@@ -940,7 +1105,10 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>copy</code></em> = <code class="literal">otherservice</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CREATEMODE"></a>create mode</span></dt><dd><p>This parameter is a synonym for create mask.</p></dd><dt><span class="term"><a name="CREATEMASK"></a>create mask (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559116"></a><a name="CREATEMODE"></a>create mode</h3></div></div></div><a class="indexterm" name="id2559117"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#CREATEMASK">create mask</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559146"></a>
+
+create mask (S)
+</h3></div></div></div><a class="indexterm" name="id2559147"></a><a name="CREATEMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>
When a file is created, the necessary permissions are calculated according to the mapping from DOS modes to
UNIX permissions, and the resulting UNIX mode is then bit-wise 'AND'ed with this parameter. This parameter may
be thought of as a bit-wise MASK for the UNIX modes of a file. Any bit <span class="emphasis"><em>not</em></span> set here will
@@ -950,31 +1118,48 @@ connected using a root account (i.e. uid == 0).
write and execute bits from the UNIX modes.
</p><p>
Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the
- <a class="indexterm" name="id312806"></a>force create mode parameter which is set to 000 by default.
+ <a class="link" href="smb.conf.5.html#FORCECREATEMODE">force create mode</a> parameter which is set to 000 by default.
</p><p>
- This parameter does not affect directory masks. See the parameter <a class="indexterm" name="id312818"></a>directory mask
+ This parameter does not affect directory masks. See the parameter <a class="link" href="smb.conf.5.html#DIRECTORYMASK">directory mask</a>
for details.
</p><p>
Note that this parameter does not apply to permissions set by Windows NT/2000 ACL editors. If the
- administrator wishes to enforce a mask on access control lists also, they need to set the <a class="indexterm" name="id312830"></a>security mask.
+ administrator wishes to enforce a mask on access control lists also, they need to set the <a class="link" href="smb.conf.5.html#SECURITYMASK">security mask</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0744</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>create mask</code></em> = <code class="literal">0775</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CSCPOLICY"></a>csc policy (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559284"></a>
+
+csc policy (S)
+</h3></div></div></div><a class="indexterm" name="id2559285"></a><a name="CSCPOLICY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This stands for <span class="emphasis"><em>client-side caching policy</em></span>, and specifies how clients capable of offline
caching will cache the files in the share. The valid values are: manual, documents, programs, disable.
</p><p>
These values correspond to those used on Windows servers.
</p><p>
For example, shares containing roaming profiles can have offline caching disabled using
- <a class="indexterm" name="id312906"></a>csc policy = disable.
+ <a class="link" href="smb.conf.5.html#CSCPOLICY">csc policy = disable</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">manual</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>csc policy</code></em> = <code class="literal">programs</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CUPSOPTIONS"></a>cups options (S)</span></dt><dd><p>
- This parameter is only applicable if <a class="indexterm" name="id312969"></a>printing is
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559369"></a><a name="DEFAULT"></a>default</h3></div></div></div><a class="indexterm" name="id2559370"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#CTDBDSOCKET">ctdbd socket</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559400"></a>
+
+ctdbd socket (G)
+</h3></div></div></div><a class="indexterm" name="id2559402"></a><a name="CTDBDSOCKET"></a><div class="variablelist"><dl><dt></dt><dd><p>If you set <code class="literal">clustering=yes</code>,
+ you need to tell Samba where ctdbd listens on its unix domain
+ socket. The default path as of ctdb 1.0 is /tmp/ctdb.socket which
+ you have to explicitly set for Samba in smb.conf.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ctdbd socket</code></em> = <code class="literal"></code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ctdbd socket</code></em> = <code class="literal">/tmp/ctdb.socket</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559466"></a>
+
+cups options (S)
+</h3></div></div></div><a class="indexterm" name="id2559468"></a><a name="CUPSOPTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING">printing</a> is
set to <code class="constant">cups</code>. Its value is a free form string of options
passed directly to the cups library.
</p><p>
@@ -982,6 +1167,9 @@ connected using a root account (i.e. uid == 0).
in the CUPS "Software Users' Manual"). You can also pass any printer
specific option (as listed in "lpoptions -d printername -l")
valid for the target queue.
+ Multiple parameters should be space-delimited name/value pairs according to
+ the PAPI text option ABNF specification. Collection values
+ ("name={a=... b=... c=...}") are stored with the curley brackets intact.
</p><p>
You should set this parameter to <code class="constant">raw</code> if your CUPS server
<code class="filename">error_log</code> file contains messages such as
@@ -990,10 +1178,13 @@ connected using a root account (i.e. uid == 0).
system wide raw printing in <code class="filename">/etc/cups/mime.{convs,types}</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">""</code>
</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">"raw,media=a4,job-sheets=secret,secret"</code>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups options</code></em> = <code class="literal">"raw media=a4"</code>
</em></span>
-</p></dd><dt><span class="term"><a name="CUPSSERVER"></a>cups server (G)</span></dt><dd><p>
- This parameter is only applicable if <a class="indexterm" name="id313063"></a>printing is set to <code class="constant">cups</code>.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559584"></a>
+
+cups server (G)
+</h3></div></div></div><a class="indexterm" name="id2559585"></a><a name="CUPSSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING">printing</a> is set to <code class="constant">cups</code>.
</p><p>
If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is
necessary if you have virtual samba servers that connect to different CUPS daemons.
@@ -1006,7 +1197,10 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>cups server</code></em> = <code class="literal">mycupsserver:1631</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEADTIME"></a>deadtime (G)</span></dt><dd><p>The value of the parameter (a decimal integer)
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559692"></a>
+
+deadtime (G)
+</h3></div></div></div><a class="indexterm" name="id2559693"></a><a name="DEADTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a decimal integer)
represents the number of minutes of inactivity before a connection
is considered dead, and it is disconnected. The deadtime only takes
effect if the number of open files is zero.</p><p>This is useful to stop a server's resources being
@@ -1018,46 +1212,78 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deadtime</code></em> = <code class="literal">15</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEBUGHIRESTIMESTAMP"></a>debug hires timestamp (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559774"></a>
+
+debug class (G)
+</h3></div></div></div><a class="indexterm" name="id2559775"></a><a name="DEBUGCLASS"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ With this boolean parameter enabled, the debug class (DBGC_CLASS)
+ will be displayed in the debug header.
+ </p><p>
+ For more information about currently available debug classes, see
+ section about <a class="link" href="smb.conf.5.html#LOGLEVEL">log level</a>.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug class</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559832"></a>
+
+debug hires timestamp (G)
+</h3></div></div></div><a class="indexterm" name="id2559833"></a><a name="DEBUGHIRESTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
Sometimes the timestamps in the log messages are needed with a resolution of higher that seconds, this
boolean parameter adds microsecond resolution to the timestamp message header when turned on.
</p><p>
- Note that the parameter <a class="indexterm" name="id313240"></a>debug timestamp must be on for this to have an effect.
+ Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug hires timestamp</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEBUGPID"></a>debug pid (G)</span></dt><dd><p>
- When using only one log file for more then one forked <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>-process there may be hard to follow which process outputs which
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559894"></a>
+
+debug pid (G)
+</h3></div></div></div><a class="indexterm" name="id2559895"></a><a name="DEBUGPID"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ When using only one log file for more then one forked <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>-process there may be hard to follow which process outputs which
message. This boolean parameter is adds the process-id to the timestamp message headers in the
logfile when turned on.
</p><p>
- Note that the parameter <a class="indexterm" name="id313298"></a>debug timestamp must be on for this to have an effect.
+ Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug pid</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEBUGPREFIXTIMESTAMP"></a>debug prefix timestamp (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2559962"></a>
+
+debug prefix timestamp (G)
+</h3></div></div></div><a class="indexterm" name="id2559964"></a><a name="DEBUGPREFIXTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
With this option enabled, the timestamp message header is prefixed to the debug message without the
- filename and function information that is included with the <a class="indexterm" name="id313346"></a>debug timestamp
+ filename and function information that is included with the <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</a>
parameter. This gives timestamps to the messages without adding an additional line.
</p><p>
- Note that this parameter overrides the <a class="indexterm" name="id313357"></a>debug timestamp parameter.
+ Note that this parameter overrides the <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</a> parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug prefix timestamp</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="TIMESTAMPLOGS"></a>timestamp logs</span></dt><dd><p>This parameter is a synonym for debug timestamp.</p></dd><dt><span class="term"><a name="DEBUGTIMESTAMP"></a>debug timestamp (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560036"></a><a name="TIMESTAMPLOGS"></a>timestamp logs</h3></div></div></div><a class="indexterm" name="id2560037"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DEBUGTIMESTAMP">debug timestamp</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560067"></a>
+
+debug timestamp (G)
+</h3></div></div></div><a class="indexterm" name="id2560068"></a><a name="DEBUGTIMESTAMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba debug log messages are timestamped by default. If you are running at a high
- <a class="indexterm" name="id313424"></a>debug level these timestamps can be distracting. This
+ <a class="link" href="smb.conf.5.html#DEBUGLEVEL">debug level</a> these timestamps can be distracting. This
boolean parameter allows timestamping to be turned off.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug timestamp</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEBUGUID"></a>debug uid (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560122"></a>
+
+debug uid (G)
+</h3></div></div></div><a class="indexterm" name="id2560124"></a><a name="DEBUGUID"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba is sometimes run as root and sometime run as the connected user, this boolean parameter inserts the
current euid, egid, uid and gid to the timestamp message headers in the log file if turned on.
</p><p>
- Note that the parameter <a class="indexterm" name="id313475"></a>debug timestamp must be on for this to have an effect.
+ Note that the parameter <a class="link" href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</a> must be on for this to have an effect.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>debug uid</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEFAULTCASE"></a>default case (S)</span></dt><dd><p>See the section on <a class="indexterm" name="id313521"></a>name mangling.
- Also note the <a class="indexterm" name="id313528"></a>short preserve case parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default case</code></em> = <code class="literal">lower</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560182"></a>
+
+default case (S)
+</h3></div></div></div><a class="indexterm" name="id2560183"></a><a name="DEFAULTCASE"></a><div class="variablelist"><dl><dt></dt><dd><p>See the section on <a class="link" href="smb.conf.5.html#NAMEMANGLING">name mangling</a>.
+ Also note the <a class="link" href="smb.conf.5.html#SHORTPRESERVECASE">short preserve case</a> parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default case</code></em> = <code class="literal">lower</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEFAULTDEVMODE"></a>default devmode (S)</span></dt><dd><p>This parameter is only applicable to <a class="indexterm" name="id313574"></a>printable services.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560246"></a>
+
+default devmode (S)
+</h3></div></div></div><a class="indexterm" name="id2560247"></a><a name="DEFAULTDEVMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only applicable to <a class="link" href="smb.conf.5.html#PRINTABLE">printable</a> services.
When smbd is serving Printer Drivers to Windows NT/2k/XP clients, each printer on the Samba
server has a Device Mode which defines things such as paper size and
orientation and duplex settings. The device mode can only correctly be
@@ -1077,16 +1303,19 @@ connected using a root account (i.e. uid == 0).
do this all the time, setting <code class="literal">default devmode = yes</code>
will instruct smbd to generate a default one.
</p><p>For more information on Windows NT/2k printing and Device Modes,
- see the <a href="http://msdn.microsoft.com/" target="_top">MSDN documentation</a>.
+ see the <a class="ulink" href="http://msdn.microsoft.com/" target="_top">MSDN documentation</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>default devmode</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEFAULT"></a>default</span></dt><dd><p>This parameter is a synonym for default service.</p></dd><dt><span class="term"><a name="DEFAULTSERVICE"></a>default service (G)</span></dt><dd><p>This parameter specifies the name of a service
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560343"></a><a name="DEFAULT"></a>default</h3></div></div></div><a class="indexterm" name="id2560344"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DEFAULTSERVICE">default service</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560379"></a>
+
+default service (G)
+</h3></div></div></div><a class="indexterm" name="id2560380"></a><a name="DEFAULTSERVICE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the name of a service
which will be connected to if the service actually requested cannot
be found. Note that the square brackets are <span class="emphasis"><em>NOT</em></span>
given in the parameter value (see example below).</p><p>There is no default value for this parameter. If this
parameter is not given, attempting to connect to a nonexistent
service results in an error.</p><p>
- Typically the default service would be a <a class="indexterm" name="id313686"></a>guest ok, <a class="indexterm" name="id313693"></a>read-only service.</p><p>Also note that the apparent service name will be changed to equal
+ Typically the default service would be a <a class="link" href="smb.conf.5.html#GUESTOK">guest ok</a>, <a class="link" href="smb.conf.5.html#READ-ONLY">read-only</a> service.</p><p>Also note that the apparent service name will be changed to equal
that of the requested service, this is very useful as it allows you to use macros like <em class="parameter"><code>%S</code></em> to make a wildcard service.
</p><p>Note also that any "_" characters in the name of the service
used in the default service will get mapped to a "/". This allows for
@@ -1094,7 +1323,10 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>default service</code></em> = <code class="literal">pub</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEFERSHARINGVIOLATIONS"></a>defer sharing violations (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560492"></a>
+
+defer sharing violations (G)
+</h3></div></div></div><a class="indexterm" name="id2560494"></a><a name="DEFERSHARINGVIOLATIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
Windows allows specifying how a file will be shared with
other processes when it is opened. Sharing violations occur when
a file is opened by a different process using options that violate
@@ -1107,23 +1339,29 @@ connected using a root account (i.e. uid == 0).
designed to enable Samba to more correctly emulate Windows.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>defer sharing violations</code></em> = <code class="literal">True</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEGROUPSCRIPT"></a>delete group script (G)</span></dt><dd><p>This is the full pathname to a script that will
- be run <span class="emphasis"><em>AS ROOT</em></span> <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a group is requested to be deleted.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560551"></a>
+
+delete group script (G)
+</h3></div></div></div><a class="indexterm" name="id2560552"></a><a name="DELETEGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the full pathname to a script that will
+ be run <span class="emphasis"><em>AS ROOT</em></span> <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when a group is requested to be deleted.
It will expand any <em class="parameter"><code>%g</code></em> to the group name passed.
This script is only useful for installations using the Windows NT domain administration tools.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete group script</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEPRINTERCOMMAND"></a>deleteprinter command (G)</span></dt><dd><p>With the introduction of MS-RPC based printer
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560612"></a>
+
+deleteprinter command (G)
+</h3></div></div></div><a class="indexterm" name="id2560614"></a><a name="DELETEPRINTERCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printer
support for Windows NT/2000 clients in Samba 2.2, it is now
possible to delete printer at run time by issuing the
DeletePrinter() RPC call.</p><p>For a Samba host this means that the printer must be
physically deleted from underlying printing system. The
- <a class="indexterm" name="id313883"></a>deleteprinter command defines a script to be run which
+ <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</a> defines a script to be run which
will perform the necessary operations for removing the printer
from the print system and from <code class="filename">smb.conf</code>.
- </p><p>The <a class="indexterm" name="id313900"></a>deleteprinter command is
- automatically called with only one parameter: <a class="indexterm" name="id313908"></a>printer name.
- </p><p>Once the <a class="indexterm" name="id313918"></a>deleteprinter command has
+ </p><p>The <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</a> is
+ automatically called with only one parameter: <a class="link" href="smb.conf.5.html#PRINTERNAME">printer name</a>.
+ </p><p>Once the <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</a> has
been executed, <code class="literal">smbd</code> will reparse the <code class="filename">
smb.conf</code> to associated printer no longer exists.
If the sharename is still valid, then <code class="literal">smbd
@@ -1131,12 +1369,18 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>deleteprinter command</code></em> = <code class="literal">/usr/bin/removeprinter</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEREADONLY"></a>delete readonly (S)</span></dt><dd><p>This parameter allows readonly files to be deleted.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560764"></a>
+
+delete readonly (S)
+</h3></div></div></div><a class="indexterm" name="id2560765"></a><a name="DELETEREADONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows readonly files to be deleted.
This is not normal DOS semantics, but is allowed by UNIX.</p><p>This option may be useful for running applications such
as rcs, where UNIX file ownership prevents changing file
permissions, and DOS semantics prevent deletion of a read only file.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete readonly</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETESHARECOMMAND"></a>delete share command (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560813"></a>
+
+delete share command (G)
+</h3></div></div></div><a class="indexterm" name="id2560814"></a><a name="DELETESHARECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <em class="parameter"><code>delete share command</code></em> is used to define an external
program or script which will remove an existing service definition from
@@ -1155,22 +1399,28 @@ connected using a root account (i.e. uid == 0).
the existing service.
</p></li></ul></div><p>
This parameter is only used to remove file shares. To delete printer shares,
- see the <a class="indexterm" name="id314137"></a>deleteprinter command.
+ see the <a class="link" href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete share command</code></em> = <code class="literal">/usr/local/bin/delshare</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEUSERFROMGROUPSCRIPT"></a>delete user from group script (G)</span></dt><dd><p>Full path to the script that will be called when
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2560984"></a>
+
+delete user from group script (G)
+</h3></div></div></div><a class="indexterm" name="id2560985"></a><a name="DELETEUSERFROMGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>Full path to the script that will be called when
a user is removed from a group using the Windows NT domain administration
- tools. It will be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> <span class="emphasis"><em>AS ROOT</em></span>.
+ tools. It will be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> <span class="emphasis"><em>AS ROOT</em></span>.
Any <em class="parameter"><code>%g</code></em> will be replaced with the group name and
any <em class="parameter"><code>%u</code></em> will be replaced with the user name.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user from group script</code></em> = <code class="literal">/usr/sbin/deluser %u %g</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEUSERSCRIPT"></a>delete user script (G)</span></dt><dd><p>This is the full pathname to a script that will
- be run by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when managing users
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561070"></a>
+
+delete user script (G)
+</h3></div></div></div><a class="indexterm" name="id2561071"></a><a name="DELETEUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the full pathname to a script that will
+ be run by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when managing users
with remote RPC (NT) tools.
</p><p>This script is called when a remote client removes a user
from the server, normally using 'User Manager for Domains' or
@@ -1178,9 +1428,12 @@ connected using a root account (i.e. uid == 0).
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>delete user script</code></em> = <code class="literal">/usr/local/samba/bin/del_user %u</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DELETEVETOFILES"></a>delete veto files (S)</span></dt><dd><p>This option is used when Samba is attempting to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561152"></a>
+
+delete veto files (S)
+</h3></div></div></div><a class="indexterm" name="id2561153"></a><a name="DELETEVETOFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used when Samba is attempting to
delete a directory that contains one or more vetoed directories
- (see the <a class="indexterm" name="id314355"></a>veto files
+ (see the <a class="link" href="smb.conf.5.html#VETOFILES">veto files</a>
option). If this option is set to <code class="constant">no</code> (the default) then if a vetoed
directory contains any non-vetoed files or directories then the
directory delete will fail. This is usually what you want.</p><p>If this option is set to <code class="constant">yes</code>, then Samba
@@ -1188,11 +1441,14 @@ connected using a root account (i.e. uid == 0).
the vetoed directory. This can be useful for integration with file
serving systems such as NetAtalk which create meta-files within
directories you might normally veto DOS/Windows users from seeing
- (e.g. <code class="filename">.AppleDouble</code>)</p><p>Setting <a class="indexterm" name="id314386"></a>delete veto files = yes allows these
+ (e.g. <code class="filename">.AppleDouble</code>)</p><p>Setting <a class="link" href="smb.conf.5.html#DELETEVETOFILES">delete veto files = yes</a> allows these
directories to be transparently deleted when the parent directory
is deleted (so long as the user has permissions to do so).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>delete veto files</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DFREECACHETIME"></a>dfree cache time (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561250"></a>
+
+dfree cache time (S)
+</h3></div></div></div><a class="indexterm" name="id2561251"></a><a name="DFREECACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <em class="parameter"><code>dfree cache time</code></em> should only be used on systems where a problem
occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may occur
with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore" at the
@@ -1200,12 +1456,15 @@ connected using a root account (i.e. uid == 0).
</p><p>
This is a new parameter introduced in Samba version 3.0.21. It specifies in seconds the time that smbd will
cache the output of a disk free query. If set to zero (the default) no caching is done. This allows a heavily
- loaded server to prevent rapid spawning of <a class="indexterm" name="id314446"></a>dfree command scripts increasing the load.
+ loaded server to prevent rapid spawning of <a class="link" href="smb.conf.5.html#DFREECOMMAND">dfree command</a> scripts increasing the load.
</p><p>
By default this parameter is zero, meaning no caching will be done.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree cache time</code></em> = <code class="literal">dfree cache time = 60</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DFREECOMMAND"></a>dfree command (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561332"></a>
+
+dfree command (S)
+</h3></div></div></div><a class="indexterm" name="id2561333"></a><a name="DFREECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The <em class="parameter"><code>dfree command</code></em> setting should only be used on systems where a
problem occurs with the internal disk space calculations. This has been known to happen with Ultrix, but may
occur with other operating systems. The symptom that was seen was an error of "Abort Retry Ignore"
@@ -1216,7 +1475,7 @@ connected using a root account (i.e. uid == 0).
function.
</p><p>
In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the
- parameter <a class="indexterm" name="id314518"></a>dfree cache time was added to allow the output of this script to be cached
+ parameter <a class="link" href="smb.conf.5.html#DFREECACHETIME">dfree cache time</a> was added to allow the output of this script to be cached
for systems under heavy load.
</p><p>
The external program will be passed a single parameter indicating a directory in the filesystem being queried.
@@ -1243,7 +1502,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
By default internal routines for determining the disk capacity and remaining space will be used.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dfree command</code></em> = <code class="literal">/usr/local/samba/bin/dfree</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DIRECTORYMODE"></a>directory mode</span></dt><dd><p>This parameter is a synonym for directory mask.</p></dd><dt><span class="term"><a name="DIRECTORYMASK"></a>directory mask (S)</span></dt><dd><p>This parameter is the octal modes which are
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561464"></a><a name="DIRECTORYMODE"></a>directory mode</h3></div></div></div><a class="indexterm" name="id2561465"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#DIRECTORYMASK">directory mask</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561496"></a>
+
+directory mask (S)
+</h3></div></div></div><a class="indexterm" name="id2561497"></a><a name="DIRECTORYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is the octal modes which are
used when converting DOS modes to UNIX modes when creating UNIX
directories.</p><p>When a directory is created, the necessary permissions are
calculated according to the mapping from DOS modes to UNIX permissions,
@@ -1254,19 +1516,22 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
created.</p><p>The default value of this parameter removes the 'group'
and 'other' write bits from the UNIX mode, allowing only the
user who owns the directory to modify it.</p><p>Following this Samba will bit-wise 'OR' the UNIX mode
- created from this parameter with the value of the <a class="indexterm" name="id314651"></a>force directory mode parameter.
+ created from this parameter with the value of the <a class="link" href="smb.conf.5.html#FORCEDIRECTORYMODE">force directory mode</a> parameter.
This parameter is set to 000 by default (i.e. no extra mode bits are added).</p><p>Note that this parameter does not apply to permissions
set by Windows NT/2000 ACL editors. If the administrator wishes to enforce
- a mask on access control lists also, they need to set the <a class="indexterm" name="id314664"></a>directory security mask.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0755</code>
+ a mask on access control lists also, they need to set the <a class="link" href="smb.conf.5.html#DIRECTORYSECURITYMASK">directory security mask</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0755</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory mask</code></em> = <code class="literal">0775</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DIRECTORYSECURITYMASK"></a>directory security mask (S)</span></dt><dd><p>This parameter controls what UNIX permission bits
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561613"></a>
+
+directory security mask (S)
+</h3></div></div></div><a class="indexterm" name="id2561614"></a><a name="DIRECTORYSECURITYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls what UNIX permission bits
will be set when a Windows NT client is manipulating the UNIX
permission on a directory using the native NT security dialog
box.</p><p>
This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
- any bits not in this mask. Make sure not to mix up this parameter with <a class="indexterm" name="id314734"></a>force directory security mode, which works similar like this one but uses logical OR instead of AND.
+ any bits not in this mask. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#FORCEDIRECTORYSECURITYMODE">force directory security mode</a>, which works similar like this one but uses logical OR instead of AND.
Essentially, zero bits in this mask are a set of bits that will always be set to zero.
</p><p>
Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
@@ -1281,13 +1546,19 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>directory security mask</code></em> = <code class="literal">0700</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DISABLENETBIOS"></a>disable netbios (G)</span></dt><dd><p>Enabling this parameter will disable netbios support
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561723"></a>
+
+disable netbios (G)
+</h3></div></div></div><a class="indexterm" name="id2561724"></a><a name="DISABLENETBIOS"></a><div class="variablelist"><dl><dt></dt><dd><p>Enabling this parameter will disable netbios support
in Samba. Netbios is the only available form of browsing in
all windows versions except for 2000 and XP. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Clients that only support netbios won't be able to
see your samba server when netbios support is disabled.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable netbios</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DISABLESPOOLSS"></a>disable spoolss (G)</span></dt><dd><p>Enabling this parameter will disable Samba's support
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561773"></a>
+
+disable spoolss (G)
+</h3></div></div></div><a class="indexterm" name="id2561774"></a><a name="DISABLESPOOLSS"></a><div class="variablelist"><dl><dt></dt><dd><p>Enabling this parameter will disable Samba's support
for the SPOOLSS set of MS-RPC's and will yield identical behavior
as Samba 2.0.x. Windows NT/2000 clients will downgrade to using
Lanman style printing commands. Windows 9x/ME will be unaffected by
@@ -1299,16 +1570,22 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
<span class="emphasis"><em>Be very careful about enabling this parameter.</em></span>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>disable spoolss</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DISPLAYCHARSET"></a>display charset (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561828"></a>
+
+display charset (G)
+</h3></div></div></div><a class="indexterm" name="id2561830"></a><a name="DISPLAYCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>
Specifies the charset that samba will use to print messages to stdout and stderr.
The default value is "LOCALE", which means automatically set, depending on the
current locale. The value should generally be the same as the value of the parameter
- <a class="indexterm" name="id314912"></a>unix charset.
+ <a class="link" href="smb.conf.5.html#UNIXCHARSET">unix charset</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">"LOCALE" or "ASCII" (depending on the system)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>display charset</code></em> = <code class="literal">UTF8</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DMAPISUPPORT"></a>dmapi support (S)</span></dt><dd><p>This parameter specifies whether Samba should use DMAPI to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561904"></a>
+
+dmapi support (S)
+</h3></div></div></div><a class="indexterm" name="id2561905"></a><a name="DMAPISUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should use DMAPI to
determine whether a file is offline or not. This would typically
be used in conjunction with a hierarchical storage system that
automatically migrates files to tape.
@@ -1323,7 +1600,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</p><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dmapi support</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DNSPROXY"></a>dns proxy (G)</span></dt><dd><p>Specifies that <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> when acting as a WINS server and
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2561967"></a>
+
+dns proxy (G)
+</h3></div></div></div><a class="indexterm" name="id2561968"></a><a name="DNSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies that <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> when acting as a WINS server and
finding that a NetBIOS name has not been registered, should treat the
NetBIOS name word-for-word as a DNS name and do a lookup with the DNS server
for that name on behalf of the name-querying client.</p><p>Note that the maximum length for a NetBIOS name is 15
@@ -1332,43 +1612,52 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
DNS name lookup requests, as doing a name lookup is a blocking
action.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dns proxy</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DOMAINLOGONS"></a>domain logons (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562036"></a>
+
+domain logons (G)
+</h3></div></div></div><a class="indexterm" name="id2562037"></a><a name="DOMAINLOGONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
If set to <code class="constant">yes</code>, the Samba server will
provide the netlogon service for Windows 9X network logons for the
- <a class="indexterm" name="id315094"></a>workgroup it is in.
+ <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> it is in.
This will also cause the Samba server to act as a domain
controller for NT4 style domain services. For more details on
setting up this feature see the Domain Control chapter of the
Samba HOWTO Collection.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain logons</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DOMAINMASTER"></a>domain master (G)</span></dt><dd><p>
- Tell <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to enable
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562097"></a>
+
+domain master (G)
+</h3></div></div></div><a class="indexterm" name="id2562098"></a><a name="DOMAINMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ Tell <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to enable
WAN-wide browse list collation. Setting this option causes <code class="literal">nmbd</code> to claim a
special domain specific NetBIOS name that identifies it as a domain master browser for its given
- <a class="indexterm" name="id315156"></a>workgroup. Local master browsers in the same <a class="indexterm" name="id315164"></a>workgroup on
+ <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a>. Local master browsers in the same <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> on
broadcast-isolated subnets will give this <code class="literal">nmbd</code> their local browse lists,
- and then ask <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> for a
+ and then ask <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> for a
complete copy of the browse list for the whole wide area network. Browser clients will then contact their
local master browser, and will receive the domain-wide browse list, instead of just the list for their
broadcast-isolated subnet.
</p><p>
- Note that Windows NT Primary Domain Controllers expect to be able to claim this <a class="indexterm" name="id315191"></a>workgroup specific special NetBIOS name that identifies them as domain master browsers for that
- <a class="indexterm" name="id315199"></a>workgroup by default (i.e. there is no way to prevent a Windows NT PDC from attempting
+ Note that Windows NT Primary Domain Controllers expect to be able to claim this <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> specific special NetBIOS name that identifies them as domain master browsers for that
+ <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> by default (i.e. there is no way to prevent a Windows NT PDC from attempting
to do this). This means that if this parameter is set and <code class="literal">nmbd</code> claims the
- special name for a <a class="indexterm" name="id315213"></a>workgroup before a Windows NT PDC is able to do so then cross
+ special name for a <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> before a Windows NT PDC is able to do so then cross
subnet browsing will behave strangely and may fail.
</p><p>
- If <a class="indexterm" name="id315225"></a>domain logons = yes, then the default behavior is to enable the
- <a class="indexterm" name="id315232"></a>domain master parameter. If <a class="indexterm" name="id315239"></a>domain logons is not enabled (the
- default setting), then neither will <a class="indexterm" name="id315247"></a>domain master be enabled by default.
+ If <a class="link" href="smb.conf.5.html#DOMAINLOGONS">domain logons = yes</a>, then the default behavior is to enable the
+ <a class="link" href="smb.conf.5.html#DOMAINMASTER">domain master</a> parameter. If <a class="link" href="smb.conf.5.html#DOMAINLOGONS">domain logons</a> is not enabled (the
+ default setting), then neither will <a class="link" href="smb.conf.5.html#DOMAINMASTER">domain master</a> be enabled by default.
</p><p>
- When <a class="indexterm" name="id315257"></a>domain logons = Yes the default setting for this parameter is
- Yes, with the result that Samba will be a PDC. If <a class="indexterm" name="id315265"></a>domain master = No,
+ When <a class="link" href="smb.conf.5.html#DOMAINLOGONS">domain logons = Yes</a> the default setting for this parameter is
+ Yes, with the result that Samba will be a PDC. If <a class="link" href="smb.conf.5.html#DOMAINMASTER">domain master = No</a>,
Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>domain master</code></em> = <code class="literal">auto</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DONTDESCEND"></a>dont descend (S)</span></dt><dd><p>There are certain directories on some systems
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562328"></a>
+
+dont descend (S)
+</h3></div></div></div><a class="indexterm" name="id2562329"></a><a name="DONTDESCEND"></a><div class="variablelist"><dl><dt></dt><dd><p>There are certain directories on some systems
(e.g., the <code class="filename">/proc</code> tree under Linux) that are either not
of interest to clients or are infinitely deep (recursive). This
parameter allows you to specify a comma-delimited list of directories
@@ -1379,12 +1668,18 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>dont descend</code></em> = <code class="literal">/proc,/dev</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DOSCHARSET"></a>dos charset (G)</span></dt><dd><p>DOS SMB clients assume the server has
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562413"></a>
+
+dos charset (G)
+</h3></div></div></div><a class="indexterm" name="id2562414"></a><a name="DOSCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>DOS SMB clients assume the server has
the same charset as they do. This option specifies which
charset Samba should talk to DOS clients.
</p><p>The default depends on which charsets you have installed.
Samba tries to use charset 850 but falls back to ASCII in
- case it is not available. Run <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> to check the default on your system.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="DOSFILEMODE"></a>dos filemode (S)</span></dt><dd><p> The default behavior in Samba is to provide
+ case it is not available. Run <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> to check the default on your system.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562457"></a>
+
+dos filemode (S)
+</h3></div></div></div><a class="indexterm" name="id2562458"></a><a name="DOSFILEMODE"></a><div class="variablelist"><dl><dt></dt><dd><p> The default behavior in Samba is to provide
UNIX-like behavior where only the owner of a file/directory is
able to change the permissions on it. However, this behavior
is often confusing to DOS/Windows users. Enabling this parameter
@@ -1394,11 +1689,14 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
change permissions if the group is only granted read access.
Ownership of the file/directory may also be changed.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filemode</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DOSFILETIMERESOLUTION"></a>dos filetime resolution (S)</span></dt><dd><p>Under the DOS and Windows FAT filesystem, the finest
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562507"></a>
+
+dos filetime resolution (S)
+</h3></div></div></div><a class="indexterm" name="id2562508"></a><a name="DOSFILETIMERESOLUTION"></a><div class="variablelist"><dl><dt></dt><dd><p>Under the DOS and Windows FAT filesystem, the finest
granularity on time resolution is two seconds. Setting this parameter
for a share causes Samba to round the reported time down to the
nearest two second boundary when a query call that requires one second
- resolution is made to <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>This option is mainly used as a compatibility option for Visual
+ resolution is made to <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>.</p><p>This option is mainly used as a compatibility option for Visual
C++ when used against Samba shares. If oplocks are enabled on a
share, Visual C++ uses two different time reading calls to check if a
file has changed since it was last read. One of these calls uses a
@@ -1409,13 +1707,16 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
this option causes the two timestamps to match, and Visual C++ is
happy.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetime resolution</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DOSFILETIMES"></a>dos filetimes (S)</span></dt><dd><p>Under DOS and Windows, if a user can write to a
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562580"></a>
+
+dos filetimes (S)
+</h3></div></div></div><a class="indexterm" name="id2562581"></a><a name="DOSFILETIMES"></a><div class="variablelist"><dl><dt></dt><dd><p>Under DOS and Windows, if a user can write to a
file they can change the timestamp on it. Under POSIX semantics,
only the owner of the file or root may change the timestamp. By
default, Samba runs with POSIX semantics and refuses to change the
timestamp on a file if the user <code class="literal">smbd</code> is acting
on behalf of is not the file owner. Setting this option to <code class="constant">
- yes</code> allows DOS semantics and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will change the file
+ yes</code> allows DOS semantics and <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will change the file
timestamp as DOS requires. Due to changes in Microsoft Office 2000 and beyond,
the default for this parameter has been changed from "no" to "yes" in Samba 3.0.14
and above. Microsoft Excel will display dialog box warnings about the file being
@@ -1423,14 +1724,20 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
shared between users.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>dos filetimes</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="EASUPPORT"></a>ea support (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow clients to attempt to store OS/2 style Extended
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562651"></a>
+
+ea support (S)
+</h3></div></div></div><a class="indexterm" name="id2562652"></a><a name="EASUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow clients to attempt to store OS/2 style Extended
attributes on a share. In order to enable this parameter the underlying filesystem exported by
the share must support extended attributes (such as provided on XFS and EXT3 on Linux, with the
correct kernel patches). On Linux the filesystem must have been mounted with the mount
option user_xattr in order for extended attributes to work, also
extended attributes must be compiled into the Linux kernel.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ea support</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ENABLEASUSUPPORT"></a>enable asu support (G)</span></dt><dd><p>Hosts running the "Advanced Server for Unix (ASU)" product
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562708"></a>
+
+enable asu support (G)
+</h3></div></div></div><a class="indexterm" name="id2562709"></a><a name="ENABLEASUSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>Hosts running the "Advanced Server for Unix (ASU)" product
require some special accomodations such as creating a builting [ADMIN$]
share that only supports IPC connections. The has been the default
behavior in smbd for many years. However, certain Microsoft applications
@@ -1438,7 +1745,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
an [ADMIN$} file share. Disabling this parameter allows for creating
an [ADMIN$] file share in smb.conf.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable asu support</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ENABLEPRIVILEGES"></a>enable privileges (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562757"></a>
+
+enable privileges (G)
+</h3></div></div></div><a class="indexterm" name="id2562758"></a><a name="ENABLEPRIVILEGES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
<code class="literal">net rpc rights</code> or one of the Windows user and group manager tools. This parameter is
enabled by default. It can be disabled to prevent members of the Domain Admins group from being able to
@@ -1451,7 +1761,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
Please read the extended description provided in the Samba HOWTO documentation.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enable privileges</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ENCRYPTPASSWORDS"></a>encrypt passwords (G)</span></dt><dd><p>This boolean controls whether encrypted passwords
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562823"></a>
+
+encrypt passwords (G)
+</h3></div></div></div><a class="indexterm" name="id2562824"></a><a name="ENCRYPTPASSWORDS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean controls whether encrypted passwords
will be negotiated with the client. Note that Windows NT 4.0 SP3 and
above and also Windows 98 will by default expect encrypted passwords
unless a registry entry is changed. To use encrypted passwords in
@@ -1468,13 +1781,16 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
is no longer maintained in Microsoft Windows products. If you want to use
plain text passwords you must set this parameter to no.
</p><p>In order for encrypted passwords to work correctly
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must either
- have access to a local <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file (see the <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> program for information on how to set up
- and maintain this file), or set the <a class="indexterm" name="id315792"></a>security = [server|domain|ads] parameter which
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> must either
+ have access to a local <a class="citerefentry" href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a> file (see the <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a> program for information on how to set up
+ and maintain this file), or set the <a class="link" href="smb.conf.5.html#SECURITY">security = [server|domain|ads]</a> parameter which
causes <code class="literal">smbd</code> to authenticate against another
server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>encrypt passwords</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ENHANCEDBROWSING"></a>enhanced browsing (G)</span></dt><dd><p>This option enables a couple of enhancements to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2562935"></a>
+
+enhanced browsing (G)
+</h3></div></div></div><a class="indexterm" name="id2562936"></a><a name="ENHANCEDBROWSING"></a><div class="variablelist"><dl><dt></dt><dd><p>This option enables a couple of enhancements to
cross-subnet browse propagation that have been added in Samba
but which are not standard in Microsoft implementations.
</p><p>The first enhancement to browse propagation consists of a regular
@@ -1487,7 +1803,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
to stay around forever which can be annoying.</p><p>In general you should leave this option enabled as it makes
cross-subnet browse propagation much more reliable.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>enhanced browsing</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ENUMPORTSCOMMAND"></a>enumports command (G)</span></dt><dd><p>The concept of a "port" is fairly foreign
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563001"></a>
+
+enumports command (G)
+</h3></div></div></div><a class="indexterm" name="id2563002"></a><a name="ENUMPORTSCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The concept of a "port" is fairly foreign
to UNIX hosts. Under Windows NT/2000 print servers, a port
is associated with a port monitor and generally takes the form of
a local port (i.e. LPT1:, COM1:, FILE:) or a remote port
@@ -1504,7 +1823,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>enumports command</code></em> = <code class="literal">/usr/bin/listports</code>
</em></span>
-</p></dd><dt><span class="term"><a name="EVENTLOGLIST"></a>eventlog list (G)</span></dt><dd><p>This option defines a list of log names that Samba will
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563090"></a>
+
+eventlog list (G)
+</h3></div></div></div><a class="indexterm" name="id2563091"></a><a name="EVENTLOGLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This option defines a list of log names that Samba will
report to the Microsoft EventViewer utility. The listed
eventlogs will be associated with tdb file on disk in the
<code class="filename">$(lockdir)/eventlog</code>.
@@ -1517,7 +1839,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>eventlog list</code></em> = <code class="literal">Security Application Syslog Apache</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FAKEDIRECTORYCREATETIMES"></a>fake directory create times (S)</span></dt><dd><p>NTFS and Windows VFAT file systems keep a create
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563170"></a>
+
+fake directory create times (S)
+</h3></div></div></div><a class="indexterm" name="id2563171"></a><a name="FAKEDIRECTORYCREATETIMES"></a><div class="variablelist"><dl><dt></dt><dd><p>NTFS and Windows VFAT file systems keep a create
time for all files and directories. This is not the same as the
ctime - status change time - that Unix keeps, so Samba by default
reports the earliest of the various times Unix does keep. Setting
@@ -1539,14 +1864,17 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
ensures directories always predate their contents and an NMAKE build
will proceed as expected.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake directory create times</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FAKEOPLOCKS"></a>fake oplocks (S)</span></dt><dd><p>Oplocks are the way that SMB clients get permission
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563249"></a>
+
+fake oplocks (S)
+</h3></div></div></div><a class="indexterm" name="id2563250"></a><a name="FAKEOPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>Oplocks are the way that SMB clients get permission
from a server to locally cache file operations. If a server grants
an oplock (opportunistic lock) then the client is free to assume
that it is the only one accessing the file and it will aggressively
cache file data. With some oplock types the client may even cache
file open/close operations. This can give enormous performance benefits.
- </p><p>When you set <code class="literal">fake oplocks = yes</code>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will
- always grant oplock requests no matter how many clients are using the file.</p><p>It is generally much better to use the real <a class="indexterm" name="id316132"></a>oplocks support rather
+ </p><p>When you set <code class="literal">fake oplocks = yes</code>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will
+ always grant oplock requests no matter how many clients are using the file.</p><p>It is generally much better to use the real <a class="link" href="smb.conf.5.html#OPLOCKS">oplocks</a> support rather
than this parameter.</p><p>If you enable this option on all read-only shares or
shares that you know will only be accessed from one client at a
time such as physically read-only media like CDROMs, you will see
@@ -1555,8 +1883,11 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
files read-write at the same time you can get data corruption. Use
this option carefully!</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>fake oplocks</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FOLLOWSYMLINKS"></a>follow symlinks (S)</span></dt><dd><p>
- This parameter allows the Samba administrator to stop <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> from following symbolic links in a particular share. Setting this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563342"></a>
+
+follow symlinks (S)
+</h3></div></div></div><a class="indexterm" name="id2563343"></a><a name="FOLLOWSYMLINKS"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter allows the Samba administrator to stop <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> from following symbolic links in a particular share. Setting this
parameter to <code class="constant">no</code> prevents any file or directory that is a symbolic link from being
followed (the user will get an error). This option is very useful to stop users from adding a symbolic
link to <code class="filename">/etc/passwd</code> in their home directory for instance. However
@@ -1565,7 +1896,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
This option is enabled (i.e. <code class="literal">smbd</code> will follow symbolic links) by default.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>follow symlinks</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCECREATEMODE"></a>force create mode (S)</span></dt><dd><p>This parameter specifies a set of UNIX mode bit
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563417"></a>
+
+force create mode (S)
+</h3></div></div></div><a class="indexterm" name="id2563418"></a><a name="FORCECREATEMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a set of UNIX mode bit
permissions that will <span class="emphasis"><em>always</em></span> be set on a
file created by Samba. This is done by bitwise 'OR'ing these bits onto
the mode bits of a file that is being created or having its
@@ -1578,7 +1912,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force create mode</code></em> = <code class="literal">0755</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCEDIRECTORYMODE"></a>force directory mode (S)</span></dt><dd><p>This parameter specifies a set of UNIX mode bit
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563498"></a>
+
+force directory mode (S)
+</h3></div></div></div><a class="indexterm" name="id2563499"></a><a name="FORCEDIRECTORYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a set of UNIX mode bit
permissions that will <span class="emphasis"><em>always</em></span> be set on a directory
created by Samba. This is done by bitwise 'OR'ing these bits onto the
mode bits of a directory that is being created. The default for this
@@ -1591,12 +1928,15 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory mode</code></em> = <code class="literal">0755</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCEDIRECTORYSECURITYMODE"></a>force directory security mode (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563579"></a>
+
+force directory security mode (S)
+</h3></div></div></div><a class="indexterm" name="id2563580"></a><a name="FORCEDIRECTORYSECURITYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating
the UNIX permission on a directory using the native NT security dialog box.
</p><p>
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this
- mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="indexterm" name="id316406"></a>directory security mask, which works in a similar manner to this one, but uses a logical AND instead
+ mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#DIRECTORYSECURITYMASK">directory security mask</a>, which works in a similar manner to this one, but uses a logical AND instead
of an OR.
</p><p>
Essentially, this mask may be treated as a set of bits that, when modifying security on a directory,
@@ -1612,7 +1952,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force directory security mode</code></em> = <code class="literal">700</code>
</em></span>
-</p></dd><dt><span class="term"><a name="GROUP"></a>group</span></dt><dd><p>This parameter is a synonym for force group.</p></dd><dt><span class="term"><a name="FORCEGROUP"></a>force group (S)</span></dt><dd><p>This specifies a UNIX group name that will be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563683"></a><a name="GROUP"></a>group</h3></div></div></div><a class="indexterm" name="id2563684"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#FORCEGROUP">force group</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563714"></a>
+
+force group (S)
+</h3></div></div></div><a class="indexterm" name="id2563715"></a><a name="FORCEGROUP"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies a UNIX group name that will be
assigned as the default primary group for all users connecting
to this service. This is useful for sharing files by ensuring
that all access to files on service will use the named group for
@@ -1630,13 +1973,16 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
that only users who are already in group sys will have their default
primary group assigned to sys when accessing this Samba share. All
other users will retain their ordinary primary group.</p><p>
- If the <a class="indexterm" name="id266502"></a>force user parameter is also set the group specified in
+ If the <a class="link" href="smb.conf.5.html#FORCEUSER">force user</a> parameter is also set the group specified in
<em class="parameter"><code>force group</code></em> will override the primary group
set in <em class="parameter"><code>force user</code></em>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force group</code></em> = <code class="literal">agroup</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCEPRINTERNAME"></a>force printername (S)</span></dt><dd><p>When printing from Windows NT (or later),
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563829"></a>
+
+force printername (S)
+</h3></div></div></div><a class="indexterm" name="id2563830"></a><a name="FORCEPRINTERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>When printing from Windows NT (or later),
each printer in <code class="filename">smb.conf</code> has two
associated names which can be used by the client. The first
is the sharename (or shortname) defined in smb.conf. This
@@ -1659,12 +2005,15 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
not be able to delete printer connections from their local Printers
folder.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force printername</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCESECURITYMODE"></a>force security mode (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2563921"></a>
+
+force security mode (S)
+</h3></div></div></div><a class="indexterm" name="id2563922"></a><a name="FORCESECURITYMODE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls what UNIX permission bits can be modified when a Windows NT client is manipulating
the UNIX permission on a file using the native NT security dialog box.
</p><p>
This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this
- mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="indexterm" name="id316754"></a>security mask, which works similar like this one but uses logical AND instead of OR.
+ mask that the user may have modified to be on. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#SECURITYMASK">security mask</a>, which works similar like this one but uses logical AND instead of OR.
</p><p>
Essentially, one bits in this mask may be treated as a set of bits that, when modifying security on a file,
the user has always set to be on.
@@ -1679,7 +2028,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force security mode</code></em> = <code class="literal">700</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCEUNKNOWNACLUSER"></a>force unknown acl user (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564022"></a>
+
+force unknown acl user (S)
+</h3></div></div></div><a class="indexterm" name="id2564023"></a><a name="FORCEUNKNOWNACLUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>
If this parameter is set, a Windows NT ACL that contains an unknown SID (security descriptor, or
representation of a user or group id) as the owner or group owner of the file will be silently
mapped into the current UNIX uid or gid of the currently connected user.
@@ -1693,7 +2045,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>force unknown acl user</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FORCEUSER"></a>force user (S)</span></dt><dd><p>This specifies a UNIX user name that will be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564085"></a>
+
+force user (S)
+</h3></div></div></div><a class="indexterm" name="id2564086"></a><a name="FORCEUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies a UNIX user name that will be
assigned as the default user for all users connecting to this service.
This is useful for sharing files. You should also use it carefully
as using it incorrectly can cause security problems.</p><p>This user name only gets used once a connection is established.
@@ -1707,9 +2062,12 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>force user</code></em> = <code class="literal">auser</code>
</em></span>
-</p></dd><dt><span class="term"><a name="FSTYPE"></a>fstype (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564161"></a>
+
+fstype (S)
+</h3></div></div></div><a class="indexterm" name="id2564162"></a><a name="FSTYPE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter allows the administrator to configure the string that specifies the type of filesystem a share
- is using that is reported by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
+ is using that is reported by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
when a client queries the filesystem type for a share. The default type is <code class="constant">NTFS</code> for compatibility
with Windows NT but this can be changed to other strings such as <code class="constant">Samba</code> or <code class="constant">FAT</code>
if required.
@@ -1717,7 +2075,10 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>fstype</code></em> = <code class="literal">Samba</code>
</em></span>
-</p></dd><dt><span class="term"><a name="GETQUOTACOMMAND"></a>get quota command (G)</span></dt><dd><p>The <code class="literal">get quota command</code> should only be used
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564242"></a>
+
+get quota command (G)
+</h3></div></div></div><a class="indexterm" name="id2564243"></a><a name="GETQUOTACOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The <code class="literal">get quota command</code> should only be used
whenever there is no operating system API available from the OS that
samba can use.</p><p>This option is only available with <code class="literal">./configure --with-sys-quotas</code>.
Or on linux when <code class="literal">./configure --with-quotas</code> was used and a working quota api
@@ -1729,13 +2090,19 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>get quota command</code></em> = <code class="literal">/usr/local/sbin/query_quota</code>
</em></span>
-</p></dd><dt><span class="term"><a name="GETWDCACHE"></a>getwd cache (G)</span></dt><dd><p>This is a tuning option. When this is enabled a
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564429"></a>
+
+getwd cache (G)
+</h3></div></div></div><a class="indexterm" name="id2564430"></a><a name="GETWDCACHE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a tuning option. When this is enabled a
caching algorithm will be used to reduce the time taken for getwd()
calls. This can have a significant impact on performance, especially
- when the <a class="indexterm" name="id317205"></a>wide smbconfoptions parameter is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>getwd cache</code></em> = <code class="literal">yes</code>
+ when the <a class="link" href="smb.conf.5.html#WIDESMBCONFOPTIONS">wide smbconfoptions</a> parameter is set to <code class="constant">no</code>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>getwd cache</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="GUESTACCOUNT"></a>guest account (G)</span></dt><dd><p>This is a username which will be used for access
- to services which are specified as <a class="indexterm" name="id317254"></a>guest ok (see below). Whatever privileges this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564489"></a>
+
+guest account (G)
+</h3></div></div></div><a class="indexterm" name="id2564490"></a><a name="GUESTACCOUNT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a username which will be used for access
+ to services which are specified as <a class="link" href="smb.conf.5.html#GUESTOK">guest ok</a> (see below). Whatever privileges this
user has will be available to any client connecting to the guest service.
This user must exist in the password file, but does not require
a valid login. The user account "ftp" is often a good choice
@@ -1752,22 +2119,34 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>guest account</code></em> = <code class="literal">ftp</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PUBLIC"></a>public</span></dt><dd><p>This parameter is a synonym for guest ok.</p></dd><dt><span class="term"><a name="GUESTOK"></a>guest ok (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code> for
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564597"></a><a name="PUBLIC"></a>public</h3></div></div></div><a class="indexterm" name="id2564598"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#GUESTOK">guest ok</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564627"></a>
+
+guest ok (S)
+</h3></div></div></div><a class="indexterm" name="id2564628"></a><a name="GUESTOK"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code> for
a service, then no password is required to connect to the service.
- Privileges will be those of the <a class="indexterm" name="id317373"></a>guest account.</p><p>This paramater nullifies the benifits of setting
- <a class="indexterm" name="id317384"></a>restrict anonymous = 2
- </p><p>See the section below on <a class="indexterm" name="id317394"></a>security for more information about this option.
+ Privileges will be those of the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>.</p><p>This paramater nullifies the benifits of setting
+ <a class="link" href="smb.conf.5.html#RESTRICTANONYMOUS">restrict anonymous = 2</a>
+ </p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY">security</a> for more information about this option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest ok</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ONLYGUEST"></a>only guest</span></dt><dd><p>This parameter is a synonym for guest only.</p></dd><dt><span class="term"><a name="GUESTONLY"></a>guest only (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code> for
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564715"></a><a name="ONLYGUEST"></a>only guest</h3></div></div></div><a class="indexterm" name="id2564716"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#GUESTONLY">guest only</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564746"></a>
+
+guest only (S)
+</h3></div></div></div><a class="indexterm" name="id2564747"></a><a name="GUESTONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code> for
a service, then only guest connections to the service are permitted.
- This parameter will have no effect if <a class="indexterm" name="id317465"></a>guest ok is not set for the service.</p><p>See the section below on <a class="indexterm" name="id317476"></a>security for more information about this option.
+ This parameter will have no effect if <a class="link" href="smb.conf.5.html#GUESTOK">guest ok</a> is not set for the service.</p><p>See the section below on <a class="link" href="smb.conf.5.html#SECURITY">security</a> for more information about this option.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>guest only</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HIDEDOTFILES"></a>hide dot files (S)</span></dt><dd><p>This is a boolean parameter that controls whether
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564819"></a>
+
+hide dot files (S)
+</h3></div></div></div><a class="indexterm" name="id2564820"></a><a name="HIDEDOTFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean parameter that controls whether
files starting with a dot appear as hidden files.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide dot files</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HIDEFILES"></a>hide files (S)</span></dt><dd><p>This is a list of files or directories that are not
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564861"></a>
+
+hide files (S)
+</h3></div></div></div><a class="indexterm" name="id2564862"></a><a name="HIDEFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of files or directories that are not
visible but are accessible. The DOS 'hidden' attribute is applied
to any files or directories that match.</p><p>Each entry in the list must be separated by a '/',
which allows spaces to be included in the entry. '*'
@@ -1778,7 +2157,7 @@ df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
as it will be forced to check all files and directories for a match
as they are scanned.</p><p>
The example shown above is based on files that the Macintosh
- SMB client (DAVE) available from <a href="http://www.thursby.com" target="_top">
+ SMB client (DAVE) available from <a class="ulink" href="http://www.thursby.com" target="_top">
Thursby</a> creates for internal use, and also still hides
all files beginning with a dot.
</p><p>
@@ -1789,21 +2168,33 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide files</code></em> = <code class="literal">
# no file are hidden</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HIDESPECIALFILES"></a>hide special files (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564950"></a>
+
+hide special files (S)
+</h3></div></div></div><a class="indexterm" name="id2564951"></a><a name="HIDESPECIALFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter prevents clients from seeing special files such as sockets, devices and
fifo's in directory listings.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide special files</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HIDEUNREADABLE"></a>hide unreadable (S)</span></dt><dd><p>This parameter prevents clients from seeing the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2564992"></a>
+
+hide unreadable (S)
+</h3></div></div></div><a class="indexterm" name="id2564993"></a><a name="HIDEUNREADABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter prevents clients from seeing the
existance of files that cannot be read. Defaults to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unreadable</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HIDEUNWRITEABLEFILES"></a>hide unwriteable files (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565035"></a>
+
+hide unwriteable files (S)
+</h3></div></div></div><a class="indexterm" name="id2565036"></a><a name="HIDEUNWRITEABLEFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter prevents clients from seeing the existance of files that cannot be written to.
Defaults to off. Note that unwriteable directories are shown as usual.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hide unwriteable files</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HOMEDIRMAP"></a>homedir map (G)</span></dt><dd><p>
- If <a class="indexterm" name="id317755"></a>nis homedir is <code class="constant">yes</code>, and <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> is also acting as a Win95/98 <em class="parameter"><code>logon server</code></em>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565079"></a>
+
+homedir map (G)
+</h3></div></div></div><a class="indexterm" name="id2565080"></a><a name="HOMEDIRMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ If <a class="link" href="smb.conf.5.html#NISHOMEDIR">nis homedir</a> is <code class="constant">yes</code>, and <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> is also acting as a Win95/98 <em class="parameter"><code>logon server</code></em>
then this parameter specifies the NIS (or YP) map from which the server for the user's home directory should be extracted.
At present, only the Sun auto.home map format is understood. The form of the map is:
</p><pre class="programlisting">
@@ -1817,15 +2208,21 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>homedir map</code></em> = <code class="literal">amd.homedir</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HOSTMSDFS"></a>host msdfs (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565192"></a>
+
+host msdfs (G)
+</h3></div></div></div><a class="indexterm" name="id2565193"></a><a name="HOSTMSDFS"></a><div class="variablelist"><dl><dt></dt><dd><p>
If set to <code class="constant">yes</code>, Samba will act as a Dfs server, and allow Dfs-aware clients to browse
Dfs trees hosted on the server.
</p><p>
- See also the <a class="indexterm" name="id317862"></a>msdfs root share level parameter. For more information on
+ See also the <a class="link" href="smb.conf.5.html#MSDFSROOT">msdfs root</a> share level parameter. For more information on
setting up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>host msdfs</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="HOSTNAMELOOKUPS"></a>hostname lookups (G)</span></dt><dd><p>Specifies whether samba should use (expensive)
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565256"></a>
+
+hostname lookups (G)
+</h3></div></div></div><a class="indexterm" name="id2565257"></a><a name="HOSTNAMELOOKUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies whether samba should use (expensive)
hostname lookups or use the ip addresses instead. An example place
where hostname lookups are currently used is when checking
the <code class="literal">hosts deny</code> and <code class="literal">hosts allow</code>.
@@ -1833,7 +2230,10 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hostname lookups</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ALLOWHOSTS"></a>allow hosts</span></dt><dd><p>This parameter is a synonym for hosts allow.</p></dd><dt><span class="term"><a name="HOSTSALLOW"></a>hosts allow (S)</span></dt><dd><p>A synonym for this parameter is <a class="indexterm" name="id317998"></a>allow hosts.</p><p>This parameter is a comma, space, or tab delimited
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565329"></a><a name="ALLOWHOSTS"></a>allow hosts</h3></div></div></div><a class="indexterm" name="id2565330"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#HOSTSALLOW">hosts allow</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565360"></a>
+
+hosts allow (S)
+</h3></div></div></div><a class="indexterm" name="id2565361"></a><a name="HOSTSALLOW"></a><div class="variablelist"><dl><dt></dt><dd><p>A synonym for this parameter is <a class="link" href="smb.conf.5.html#ALLOWHOSTS">allow hosts</a>.</p><p>This parameter is a comma, space, or tab delimited
set of hosts which are permitted to access a service.</p><p>If specified in the [global] section then it will
apply to all services, regardless of whether the individual
service has a different setting.</p><p>You can specify the hosts by name or IP number. For
@@ -1843,67 +2243,85 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
page <code class="filename">hosts_access(5)</code>. Note that this man
page may not be present on your system, so a brief description will
be given here also.</p><p>Note that the localhost address 127.0.0.1 will always
- be allowed access unless specifically denied by a <a class="indexterm" name="id318036"></a>hosts deny option.</p><p>You can also specify hosts by network/netmask pairs and
+ be allowed access unless specifically denied by a <a class="link" href="smb.conf.5.html#HOSTSDENY">hosts deny</a> option.</p><p>You can also specify hosts by network/netmask pairs and
by netgroup names if your system supports netgroups. The
<span class="emphasis"><em>EXCEPT</em></span> keyword can also be used to limit a
wildcard list. The following examples may provide some help:</p><p>Example 1: allow all IPs in 150.203.*.*; except one</p><p><code class="literal">hosts allow = 150.203. EXCEPT 150.203.6.66</code></p><p>Example 2: allow hosts that match the given network/netmask</p><p><code class="literal">hosts allow = 150.203.15.0/255.255.255.0</code></p><p>Example 3: allow a couple of hosts</p><p><code class="literal">hosts allow = lapland, arvidsjaur</code></p><p>Example 4: allow only hosts in NIS netgroup "foonet", but
- deny access from one particular host</p><p><code class="literal">hosts allow = @foonet</code></p><p><code class="literal">hosts deny = pirate</code></p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that access still requires suitable user-level passwords.</p></div><p>See <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> for a way of testing your host access
+ deny access from one particular host</p><p><code class="literal">hosts allow = @foonet</code></p><p><code class="literal">hosts deny = pirate</code></p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that access still requires suitable user-level passwords.</p></div><p>See <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> for a way of testing your host access
to see if it does what you expect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal">
# none (i.e., all hosts permitted access)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts allow</code></em> = <code class="literal">150.203.5. myhost.mynet.edu.au</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DENYHOSTS"></a>deny hosts</span></dt><dd><p>This parameter is a synonym for hosts deny.</p></dd><dt><span class="term"><a name="HOSTSDENY"></a>hosts deny (S)</span></dt><dd><p>The opposite of <em class="parameter"><code>hosts allow</code></em>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565562"></a><a name="DENYHOSTS"></a>deny hosts</h3></div></div></div><a class="indexterm" name="id2565563"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#HOSTSDENY">hosts deny</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565592"></a>
+
+hosts deny (S)
+</h3></div></div></div><a class="indexterm" name="id2565593"></a><a name="HOSTSDENY"></a><div class="variablelist"><dl><dt></dt><dd><p>The opposite of <em class="parameter"><code>hosts allow</code></em>
- hosts listed here are <span class="emphasis"><em>NOT</em></span> permitted access to
services unless the specific services have their own lists to override
this one. Where the lists conflict, the <em class="parameter"><code>allow</code></em>
list takes precedence.</p><p>
In the event that it is necessary to deny all by default, use the keyword
ALL (or the netmask <code class="literal">0.0.0.0/0</code>) and then explicitly specify
- to the <a class="indexterm" name="id318224"></a>hosts allow = hosts allow parameter those hosts
+ to the <a class="link" href="smb.conf.5.html#HOSTSALLOW">hosts allow = hosts allow</a> parameter those hosts
that should be permitted access.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal">
# none (i.e., no hosts specifically excluded)</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>hosts deny</code></em> = <code class="literal">150.203.4. badhost.mynet.edu.au</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IDMAPALLOCBACKEND"></a>idmap alloc backend (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565694"></a>
+
+idmap alloc backend (G)
+</h3></div></div></div><a class="indexterm" name="id2565695"></a><a name="IDMAPALLOCBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap alloc backend provides a plugin interface for Winbind to use
when allocating Unix uids/gids for Windows SIDs. This option is
- to be used in conjunction with the <a class="indexterm" name="id318289"></a>idmap domains
+ to be used in conjunction with the <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a>
parameter and refers to the name of the idmap module which will provide
the id allocation functionality. Please refer to the man page
for each idmap plugin to determine whether or not the module implements
- the allocation feature. The most common plugins are the tdb (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>)
- and ldap (<a href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>) libraries.
- </p><p>Also refer to the <a class="indexterm" name="id318318"></a>idmap alloc config option.
+ the allocation feature. The most common plugins are the tdb (<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>)
+ and ldap (<a class="citerefentry" href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>) libraries.
+ </p><p>Also refer to the <a class="link" href="smb.conf.5.html#IDMAPALLOCCONFIG">idmap alloc config</a> option.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap alloc backend</code></em> = <code class="literal">tdb</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IDMAPALLOCCONFIG"></a>idmap alloc config (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565791"></a>
+
+idmap alloc config (G)
+</h3></div></div></div><a class="indexterm" name="id2565792"></a><a name="IDMAPALLOCCONFIG"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap alloc config prefix provides a means of managing settings
- for the backend defined by the <a class="indexterm" name="id318368"></a>idmap alloc backend
+ for the backend defined by the <a class="link" href="smb.conf.5.html#IDMAPALLOCBACKEND">idmap alloc backend</a>
parameter. Refer to the man page for each idmap plugin regarding
specific configuration details.
- </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="IDMAPBACKEND"></a>idmap backend (G)</span></dt><dd><p>
+ </p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565836"></a>
+
+idmap backend (G)
+</h3></div></div></div><a class="indexterm" name="id2565837"></a><a name="IDMAPBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap backend provides a plugin interface for Winbind to use
varying backends to store SID/uid/gid mapping tables. This
option is mutually exclusive with the newer and more flexible
- <a class="indexterm" name="id318404"></a>idmap domains parameter. The main difference
+ <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a> parameter. The main difference
between the "idmap backend" and the "idmap domains"
is that the former only allows on backend for all domains while the
latter supports configuring backends on a per domain basis.
- </p><p>Examples of SID/uid/gid backends include tdb (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>),
- ldap (<a href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>), rid (<a href="idmap_rid.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_rid</span>(8)</span></a>),
- and ad (<a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>).
+ </p><p>Examples of SID/uid/gid backends include tdb (<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>),
+ ldap (<a class="citerefentry" href="idmap_ldap.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ldap</span>(8)</span></a>), rid (<a class="citerefentry" href="idmap_rid.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_rid</span>(8)</span></a>),
+ and ad (<a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a>).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap backend</code></em> = <code class="literal">tdb</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IDMAPCACHETIME"></a>idmap cache time (G)</span></dt><dd><p>This parameter specifies the number of seconds that Winbind's
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565931"></a>
+
+idmap cache time (G)
+</h3></div></div></div><a class="indexterm" name="id2565932"></a><a name="IDMAPCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of seconds that Winbind's
idmap interface will cache positive SID/uid/gid query results.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap cache time</code></em> = <code class="literal">900</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IDMAPCONFIG"></a>idmap config (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2565974"></a>
+
+idmap config (G)
+</h3></div></div></div><a class="indexterm" name="id2565975"></a><a name="IDMAPCONFIG"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap config prefix provides a means of managing each domain
- defined by the <a class="indexterm" name="id318526"></a>idmap domains option using Samba's
+ defined by the <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a> option using Samba's
parameteric option support. The idmap config prefix should be
followed by the name of the domain, a colon, and a setting specific to
the chosen backend. There are three options available for all domains:
@@ -1917,11 +2335,11 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
domain SID).
</p></dd><dt><span class="term">readonly = [yes|no]</span></dt><dd><p>
Mark the domain as readonly which means that no attempts to
- allocate a uid or gid (by the <a class="indexterm" name="id318573"></a>idmap alloc backend) for any user or group in that domain
+ allocate a uid or gid (by the <a class="link" href="smb.conf.5.html#IDMAPALLOCBACKEND">idmap alloc backend</a>) for any user or group in that domain
will be attempted.
</p></dd></dl></div><p>
- The following example illustrates how to configure the <a href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a>
- for the CORP domain and the <a href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a> backend for all other domains. The
+ The following example illustrates how to configure the <a class="citerefentry" href="idmap_ad.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_ad</span>(8)</span></a>
+ for the CORP domain and the <a class="citerefentry" href="idmap_tdb.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_tdb</span>(8)</span></a> backend for all other domains. The
TRUSTEDDOMAINS string is simply a key used to reference the "idmap
config" settings and does not represent the actual name of a domain.
</p><pre class="programlisting">
@@ -1933,52 +2351,78 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
idmap config TRUSTEDDOMAINS:backend = tdb
idmap config TRUSTEDDOMAINS:default = yes
idmap config TRUSTEDDOMAINS:range = 1000 - 9999
- </pre><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="IDMAPDOMAINS"></a>idmap domains (G)</span></dt><dd><p>
+ </pre><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566108"></a>
+
+idmap domains (G)
+</h3></div></div></div><a class="indexterm" name="id2566110"></a><a name="IDMAPDOMAINS"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap domains option defines a list of Windows domains which will each
have a separately configured backend for managing Winbind's SID/uid/gid
- tables. This parameter is mutually exclusive with the older <a class="indexterm" name="id318641"></a>idmap backend option.
+ tables. This parameter is mutually exclusive with the older <a class="link" href="smb.conf.5.html#IDMAPBACKEND">idmap backend</a> option.
</p><p>
Values consist of the short domain name for Winbind's primary or collection
of trusted domains. You may also use an arbitrary string to represent a catchall
domain backend for any domain not explicitly listed.
</p><p>
- Refer to the <a class="indexterm" name="id318656"></a>idmap config for details about
+ Refer to the <a class="link" href="smb.conf.5.html#IDMAPCONFIG">idmap config</a> for details about
managing the SID/uid/gid backend for each domain.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap domains</code></em> = <code class="literal">default AD CORP</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDGID"></a>winbind gid</span></dt><dd><p>This parameter is a synonym for idmap gid.</p></dd><dt><span class="term"><a name="IDMAPGID"></a>idmap gid (G)</span></dt><dd><p>The idmap gid parameter specifies the range of group ids
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566193"></a><a name="WINBINDGID"></a>winbind gid</h3></div></div></div><a class="indexterm" name="id2566194"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#IDMAPGID">idmap gid</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566224"></a>
+
+idmap gid (G)
+</h3></div></div></div><a class="indexterm" name="id2566225"></a><a name="IDMAPGID"></a><div class="variablelist"><dl><dt></dt><dd><p>The idmap gid parameter specifies the range of group ids
that are allocated for the purpose of mapping UNX groups to NT group
SIDs. This range of group ids should have no
existing local or NIS groups within it as strange conflicts can
- occur otherwise.</p><p>See also the <a class="indexterm" name="id318734"></a>idmap backend, <a class="indexterm" name="id318741"></a>idmap domains, and <a class="indexterm" name="id318748"></a>idmap config options.
+ occur otherwise.</p><p>See also the <a class="link" href="smb.conf.5.html#IDMAPBACKEND">idmap backend</a>, <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a>, and <a class="link" href="smb.conf.5.html#IDMAPCONFIG">idmap config</a> options.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap gid</code></em> = <code class="literal">10000-20000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IDMAPNEGATIVECACHETIME"></a>idmap negative cache time (G)</span></dt><dd><p>This parameter specifies the number of seconds that Winbind's
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566322"></a>
+
+idmap negative cache time (G)
+</h3></div></div></div><a class="indexterm" name="id2566323"></a><a name="IDMAPNEGATIVECACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of seconds that Winbind's
idmap interface will cache negative SID/uid/gid query results.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap negative cache time</code></em> = <code class="literal">120</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDUID"></a>winbind uid</span></dt><dd><p>This parameter is a synonym for idmap uid.</p></dd><dt><span class="term"><a name="IDMAPUID"></a>idmap uid (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566365"></a><a name="WINBINDUID"></a>winbind uid</h3></div></div></div><a class="indexterm" name="id2566366"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#IDMAPUID">idmap uid</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566396"></a>
+
+idmap uid (G)
+</h3></div></div></div><a class="indexterm" name="id2566397"></a><a name="IDMAPUID"></a><div class="variablelist"><dl><dt></dt><dd><p>
The idmap uid parameter specifies the range of user ids that are
allocated for use in mapping UNIX users to NT user SIDs. This
range of ids should have no existing local
- or NIS users within it as strange conflicts can occur otherwise.</p><p>See also the <a class="indexterm" name="id318876"></a>idmap backend, <a class="indexterm" name="id318883"></a>idmap domains, and <a class="indexterm" name="id318890"></a>idmap config options.
+ or NIS users within it as strange conflicts can occur otherwise.</p><p>See also the <a class="link" href="smb.conf.5.html#IDMAPBACKEND">idmap backend</a>, <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a>, and <a class="link" href="smb.conf.5.html#IDMAPCONFIG">idmap config</a> options.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>idmap uid</code></em> = <code class="literal">10000-20000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INCLUDE"></a>include (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566493"></a>
+
+include (G)
+</h3></div></div></div><a class="indexterm" name="id2566494"></a><a name="INCLUDE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This allows you to include one config file inside another. The file is included literally, as though typed
in place.
</p><p>
It takes the standard substitutions, except <em class="parameter"><code>%u</code></em>,
<em class="parameter"><code>%P</code></em> and <em class="parameter"><code>%S</code></em>.
+ </p><p>
+ The parameter <em class="parameter"><code>include = registry</code></em> has
+ a special meaning: It does <span class="emphasis"><em>not</em></span> include
+ a file named <span class="emphasis"><em>registry</em></span> from the current working
+ directory, but instead reads the global configuration options
+ from the registry. See the section on registry-based
+ configuration for details. Note that this option
+ automatically activates registry shares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>include</code></em> = <code class="literal">/usr/local/samba/lib/admin_smb.conf</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INHERITACLS"></a>inherit acls (S)</span></dt><dd><p>This parameter can be used to ensure that if default acls
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566594"></a>
+
+inherit acls (S)
+</h3></div></div></div><a class="indexterm" name="id2566595"></a><a name="INHERITACLS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter can be used to ensure that if default acls
exist on parent directories, they are always honored when creating a
new file or subdirectory in these parent directories. The default
behavior is to use the unix mode specified when creating the directory.
@@ -1986,7 +2430,10 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
default directory acls are propagated.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit acls</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INHERITOWNER"></a>inherit owner (S)</span></dt><dd><p>The ownership of new files and directories
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566641"></a>
+
+inherit owner (S)
+</h3></div></div></div><a class="indexterm" name="id2566642"></a><a name="INHERITOWNER"></a><div class="variablelist"><dl><dt></dt><dd><p>The ownership of new files and directories
is normally governed by effective uid of the connected user.
This option allows the Samba administrator to specify that
the ownership for new files and directories should be controlled
@@ -1995,19 +2442,25 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
delete them and to ensure that newly create files in a user's
roaming profile directory are actually owner by the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit owner</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INHERITPERMISSIONS"></a>inherit permissions (S)</span></dt><dd><p>
- The permissions on new files and directories are normally governed by <a class="indexterm" name="id319114"></a>create mask,
- <a class="indexterm" name="id319121"></a>directory mask, <a class="indexterm" name="id319128"></a>force create mode and <a class="indexterm" name="id319135"></a>force directory mode but the boolean inherit permissions parameter overrides this.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566694"></a>
+
+inherit permissions (S)
+</h3></div></div></div><a class="indexterm" name="id2566695"></a><a name="INHERITPERMISSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ The permissions on new files and directories are normally governed by <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a>,
+ <a class="link" href="smb.conf.5.html#DIRECTORYMASK">directory mask</a>, <a class="link" href="smb.conf.5.html#FORCECREATEMODE">force create mode</a> and <a class="link" href="smb.conf.5.html#FORCEDIRECTORYMODE">force directory mode</a> but the boolean inherit permissions parameter overrides this.
</p><p>New directories inherit the mode of the parent directory,
including bits such as setgid.</p><p>
New files inherit their read/write bits from the parent directory. Their execute bits continue to be
- determined by <a class="indexterm" name="id319151"></a>map archive, <a class="indexterm" name="id319158"></a>map hidden and <a class="indexterm" name="id319166"></a>map system as usual.
+ determined by <a class="link" href="smb.conf.5.html#MAPARCHIVE">map archive</a>, <a class="link" href="smb.conf.5.html#MAPHIDDEN">map hidden</a> and <a class="link" href="smb.conf.5.html#MAPSYSTEM">map system</a> as usual.
</p><p>Note that the setuid bit is <span class="emphasis"><em>never</em></span> set via
inheritance (the code explicitly prohibits this).</p><p>This can be particularly useful on large systems with
many users, perhaps several thousand, to allow a single [homes]
share to be used flexibly by each user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>inherit permissions</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INTERFACES"></a>interfaces (G)</span></dt><dd><p>This option allows you to override the default
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566842"></a>
+
+interfaces (G)
+</h3></div></div></div><a class="indexterm" name="id2566843"></a><a name="INTERFACES"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to override the default
network interfaces list that Samba will use for browsing, name
registration and other NBT traffic. By default Samba will query
the kernel for the list of all active interfaces and use any
@@ -2031,7 +2484,10 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>interfaces</code></em> = <code class="literal">eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="INVALIDUSERS"></a>invalid users (S)</span></dt><dd><p>This is a list of users that should not be allowed
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2566958"></a>
+
+invalid users (S)
+</h3></div></div></div><a class="indexterm" name="id2566959"></a><a name="INVALIDUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of users that should not be allowed
to login to this service. This is really a <span class="emphasis"><em>paranoid</em></span>
check to absolutely ensure an improper setting does not breach
your security.</p><p>A name starting with a '@' is interpreted as an NIS
@@ -2051,8 +2507,11 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>invalid users</code></em> = <code class="literal">root fred admin @wheel</code>
</em></span>
-</p></dd><dt><span class="term"><a name="IPRINTSERVER"></a>iprint server (G)</span></dt><dd><p>
- This parameter is only applicable if <a class="indexterm" name="id319425"></a>printing is set to <code class="constant">iprint</code>.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567071"></a>
+
+iprint server (G)
+</h3></div></div></div><a class="indexterm" name="id2567072"></a><a name="IPRINTSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter is only applicable if <a class="link" href="smb.conf.5.html#PRINTING">printing</a> is set to <code class="constant">iprint</code>.
</p><p>
If set, this option overrides the ServerName option in the CUPS <code class="filename">client.conf</code>. This is
necessary if you have virtual samba servers that connect to different CUPS daemons.
@@ -2060,34 +2519,46 @@ hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>iprint server</code></em> = <code class="literal">MYCUPSSERVER</code>
</em></span>
-</p></dd><dt><span class="term"><a name="KEEPALIVE"></a>keepalive (G)</span></dt><dd><p>The value of the parameter (an integer) represents
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567158"></a>
+
+keepalive (G)
+</h3></div></div></div><a class="indexterm" name="id2567159"></a><a name="KEEPALIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (an integer) represents
the number of seconds between <em class="parameter"><code>keepalive</code></em>
packets. If this parameter is zero, no keepalive packets will be
sent. Keepalive packets, if sent, allow the server to tell whether
a client is still present and responding.</p><p>Keepalives should, in general, not be needed if the socket
- has the SO_KEEPALIVE attribute set on it by default. (see <a class="indexterm" name="id319514"></a>socket options).
+ has the SO_KEEPALIVE attribute set on it by default. (see <a class="link" href="smb.conf.5.html#SOCKETOPTIONS">socket options</a>).
Basically you should only use this option if you strike difficulties.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">300</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>keepalive</code></em> = <code class="literal">600</code>
</em></span>
-</p></dd><dt><span class="term"><a name="KERNELCHANGENOTIFY"></a>kernel change notify (S)</span></dt><dd><p>This parameter specifies whether Samba should ask the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567245"></a>
+
+kernel change notify (S)
+</h3></div></div></div><a class="indexterm" name="id2567246"></a><a name="KERNELCHANGENOTIFY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether Samba should ask the
kernel for change notifications in directories so that
SMB clients can refresh whenever the data on the server changes.
</p><p>This parameter is only used when your kernel supports
change notification to user programs using the inotify interface.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel change notify</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="KERNELOPLOCKS"></a>kernel oplocks (G)</span></dt><dd><p>For UNIXes that support kernel based <a class="indexterm" name="id319620"></a>oplocks
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567294"></a>
+
+kernel oplocks (G)
+</h3></div></div></div><a class="indexterm" name="id2567296"></a><a name="KERNELOPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>For UNIXes that support kernel based <a class="link" href="smb.conf.5.html#OPLOCKS">oplocks</a>
(currently only IRIX and the Linux 2.4 kernel), this parameter
allows the use of them to be turned on or off.</p><p>Kernel oplocks support allows Samba <em class="parameter"><code>oplocks
</code></em> to be broken whenever a local UNIX process or NFS operation
- accesses a file that <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has oplocked. This allows complete
+ accesses a file that <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has oplocked. This allows complete
data consistency between SMB/CIFS, NFS and local file access (and is
a <span class="emphasis"><em>very</em></span> cool feature :-).</p><p>This parameter defaults to <code class="constant">on</code>, but is translated
to a no-op on systems that no not have the necessary kernel support.
You should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>kernel oplocks</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LANMANAUTH"></a>lanman auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567382"></a>
+
+lanman auth (G)
+</h3></div></div></div><a class="indexterm" name="id2567383"></a><a name="LANMANAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
authenticate users or permit password changes
using the LANMAN password hash. If disabled, only clients which support NT
password hashes (e.g. Windows NT/2000 clients, smbclient, but not
@@ -2104,8 +2575,11 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
permited. Not all clients support NTLMv2, and most will require
special configuration to use it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lanman auth</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LARGEREADWRITE"></a>large readwrite (G)</span></dt><dd><p>This parameter determines whether or not
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> supports the new 64k
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567475"></a>
+
+large readwrite (G)
+</h3></div></div></div><a class="indexterm" name="id2567476"></a><a name="LARGEREADWRITE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> supports the new 64k
streaming read and write varient SMB requests introduced with
Windows 2000. Note that due to Windows 2000 client redirector bugs
this requires Samba to be running on a 64-bit capable operating
@@ -2113,54 +2587,107 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
performance by 10% with Windows 2000 clients. Defaults to on. Not as
tested as some other Samba code paths.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>large readwrite</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPADMINDN"></a>ldap admin dn (G)</span></dt><dd><p>
- The <a class="indexterm" name="id319828"></a>ldap admin dn defines the Distinguished Name (DN) name used by Samba to contact
- the ldap server when retreiving user account information. The <a class="indexterm" name="id319836"></a>ldap admin dn is used
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567531"></a>
+
+ldap admin dn (G)
+</h3></div></div></div><a class="indexterm" name="id2567532"></a><a name="LDAPADMINDN"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ The <a class="link" href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</a> defines the Distinguished Name (DN) name used by Samba to contact
+ the ldap server when retreiving user account information. The <a class="link" href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</a> is used
in conjunction with the admin dn password stored in the <code class="filename">private/secrets.tdb</code>
- file. See the <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>
+ file. See the <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>
man page for more information on how to accomplish this.
</p><p>
- The <a class="indexterm" name="id319862"></a>ldap admin dn requires a fully specified DN. The <a class="indexterm" name="id319869"></a>ldap suffix is not appended to the <a class="indexterm" name="id319876"></a>ldap admin dn.
- </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="LDAPDELETEDN"></a>ldap delete dn (G)</span></dt><dd><p> This parameter specifies whether a delete
+ The <a class="link" href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</a> requires a fully specified DN. The <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> is not appended to the <a class="link" href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</a>.
+ </p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567640"></a>
+
+ldap debug level (G)
+</h3></div></div></div><a class="indexterm" name="id2567641"></a><a name="LDAPDEBUGLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter controls the debug level of the LDAP library
+ calls. In the case of OpenLDAP, it is the same
+ bit-field as understood by the server and documented in the
+ <a class="citerefentry" href="slapd.conf.5.html"><span class="citerefentry"><span class="refentrytitle">slapd.conf</span>(5)</span></a>
+ manpage.
+ A typical useful value will be
+ <span class="emphasis"><em>1</em></span> for tracing function calls.
+ </p><p>
+ The debug ouput from the LDAP libraries appears with the
+ prefix [LDAP] in Samba's logging output.
+ The level at which LDAP logging is printed is controlled by the
+ parameter <em class="parameter"><code>ldap debug threshold</code></em>.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap debug level</code></em> = <code class="literal">0</code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap debug level</code></em> = <code class="literal">1</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567727"></a>
+
+ldap debug threshold (G)
+</h3></div></div></div><a class="indexterm" name="id2567728"></a><a name="LDAPDEBUGTHRESHOLD"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter controls the Samba debug level at which
+ the ldap library debug output is
+ printed in the Samba logs. See the description of
+ <em class="parameter"><code>ldap debug level</code></em> for details.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap debug threshold</code></em> = <code class="literal">10</code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap debug threshold</code></em> = <code class="literal">5</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567794"></a>
+
+ldap delete dn (G)
+</h3></div></div></div><a class="indexterm" name="id2567795"></a><a name="LDAPDELETEDN"></a><div class="variablelist"><dl><dt></dt><dd><p> This parameter specifies whether a delete
operation in the ldapsam deletes the complete entry or only the attributes
specific to Samba.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap delete dn</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPGROUPSUFFIX"></a>ldap group suffix (G)</span></dt><dd><p>This parameter specifies the suffix that is
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567838"></a>
+
+ldap group suffix (G)
+</h3></div></div></div><a class="indexterm" name="id2567839"></a><a name="LDAPGROUPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the suffix that is
used for groups when these are added to the LDAP directory.
- If this parameter is unset, the value of <a class="indexterm" name="id319950"></a>ldap suffix will be used instead. The suffix string is pre-pended to the
- <a class="indexterm" name="id319957"></a>ldap suffix string so use a partial DN.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal"></code>
+ If this parameter is unset, the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> will be used instead. The suffix string is pre-pended to the
+ <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> string so use a partial DN.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap group suffix</code></em> = <code class="literal">ou=Groups</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPIDMAPSUFFIX"></a>ldap idmap suffix (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2567921"></a>
+
+ldap idmap suffix (G)
+</h3></div></div></div><a class="indexterm" name="id2567922"></a><a name="LDAPIDMAPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameters specifies the suffix that is used when storing idmap mappings. If this parameter
- is unset, the value of <a class="indexterm" name="id320020"></a>ldap suffix will be used instead. The suffix
- string is pre-pended to the <a class="indexterm" name="id320027"></a>ldap suffix string so use a partial DN.
+ is unset, the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> will be used instead. The suffix
+ string is pre-pended to the <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap idmap suffix</code></em> = <code class="literal">ou=Idmap</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPMACHINESUFFIX"></a>ldap machine suffix (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568004"></a>
+
+ldap machine suffix (G)
+</h3></div></div></div><a class="indexterm" name="id2568005"></a><a name="LDAPMACHINESUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
It specifies where machines should be added to the ldap tree. If this parameter is unset, the value of
- <a class="indexterm" name="id320089"></a>ldap suffix will be used instead. The suffix string is pre-pended to the
- <a class="indexterm" name="id320097"></a>ldap suffix string so use a partial DN.
+ <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> will be used instead. The suffix string is pre-pended to the
+ <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap machine suffix</code></em> = <code class="literal">ou=Computers</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPPASSWDSYNC"></a>ldap passwd sync (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568085"></a>
+
+ldap passwd sync (G)
+</h3></div></div></div><a class="indexterm" name="id2568086"></a><a name="LDAPPASSWDSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option is used to define whether or not Samba should sync the LDAP password with the NT
and LM hashes for normal accounts (NOT for workstation, server or domain trusts) on a password
change via SAMBA.
</p><p>
- The <a class="indexterm" name="id320164"></a>ldap passwd sync can be set to one of three values:
+ The <a class="link" href="smb.conf.5.html#LDAPPASSWDSYNC">ldap passwd sync</a> can be set to one of three values:
</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>Yes</code></em> = Try
to update the LDAP, NT and LM passwords and update the pwdLastSet time.</p></li><li><p><em class="parameter"><code>No</code></em> = Update NT and
LM passwords and update the pwdLastSet time.</p></li><li><p><em class="parameter"><code>Only</code></em> = Only update
the LDAP password and let the LDAP server do the rest.</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap passwd sync</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPREPLICATIONSLEEP"></a>ldap replication sleep (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568186"></a>
+
+ldap replication sleep (G)
+</h3></div></div></div><a class="indexterm" name="id2568187"></a><a name="LDAPREPLICATIONSLEEP"></a><div class="variablelist"><dl><dt></dt><dd><p>
When Samba is asked to write to a read-only LDAP replica, we are redirected to talk to the read-write master server.
This server then replicates our changes back to the 'local' server, however the replication might take some seconds,
especially over slow links. Certain client activities, particularly domain joins, can become confused by the 'success'
@@ -2173,7 +2700,10 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
The value is specified in milliseconds, the maximum value is 5000 (5 seconds).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap replication sleep</code></em> = <code class="literal">1000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPSAM:EDITPOSIX"></a>ldapsam:editposix (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568249"></a>
+
+ldapsam:editposix (G)
+</h3></div></div></div><a class="indexterm" name="id2568250"></a><a name="LDAPSAM:EDITPOSIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
Editposix is an option that leverages ldapsam:trusted to make it simpler to manage a domain controller
eliminating the need to set up custom scripts to add and manage the posix users and groups. This option
will instead directly manipulate the ldap tree to create, remove and modify user and group entries.
@@ -2186,8 +2716,8 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
provision</code>. To run this command the ldap server must be running, Winindd must be running and
the smb.conf ldap options must be properly configured.
- The typical ldap setup used with the <a class="indexterm" name="id320317"></a>ldapsam:trusted = yes option
- is usually sufficient to use <a class="indexterm" name="id320325"></a>ldapsam:editposix = yes as well.
+ The typical ldap setup used with the <a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</a> option
+ is usually sufficient to use <a class="link" href="smb.conf.5.html#LDAPSAM:EDITPOSIX">ldapsam:editposix = yes</a> as well.
</p><p>
An example configuration can be the following:
@@ -2252,7 +2782,10 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:editposix</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPSAM:TRUSTED"></a>ldapsam:trusted (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568376"></a>
+
+ldapsam:trusted (G)
+</h3></div></div></div><a class="indexterm" name="id2568377"></a><a name="LDAPSAM:TRUSTED"></a><div class="variablelist"><dl><dt></dt><dd><p>
By default, Samba as a Domain Controller with an LDAP backend needs to use the Unix-style NSS subsystem to
access user and group information. Due to the way Unix stores user information in /etc/passwd and /etc/group
this inevitably leads to inefficiencies. One important question a user needs to know is the list of groups he
@@ -2260,54 +2793,69 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
counterparts in LDAP. UNIX has optimized functions to enumerate group membership. Sadly, other functions that
are used to deal with user and group attributes lack such optimization.
</p><p>
- To make Samba scale well in large environments, the <a class="indexterm" name="id320404"></a>ldapsam:trusted = yes
+ To make Samba scale well in large environments, the <a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</a>
option assumes that the complete user and group database that is relevant to Samba is stored in LDAP with the
standard posixAccount/posixGroup attributes. It further assumes that the Samba auxiliary object classes are
stored together with the POSIX data in the same LDAP object. If these assumptions are met,
- <a class="indexterm" name="id320414"></a>ldapsam:trusted = yes can be activated and Samba can bypass the
+ <a class="link" href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</a> can be activated and Samba can bypass the
NSS system to query user group memberships. Optimized LDAP queries can greatly speed up domain logon and
administration tasks. Depending on the size of the LDAP database a factor of 100 or more for common queries
is easily achieved.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldapsam:trusted</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPSSL"></a>ldap ssl (G)</span></dt><dd><p>This option is used to define whether or not Samba should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568475"></a>
+
+ldap ssl (G)
+</h3></div></div></div><a class="indexterm" name="id2568476"></a><a name="LDAPSSL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used to define whether or not Samba should
use SSL when connecting to the ldap server
This is <span class="emphasis"><em>NOT</em></span> related to
Samba's previous SSL support which was enabled by specifying the
<code class="literal">--with-ssl</code> option to the <code class="filename">configure</code>
- script.</p><p>The <a class="indexterm" name="id320482"></a>ldap ssl can be set to one of three values:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>Off</code></em> = Never
+ script.</p><p>The <a class="link" href="smb.conf.5.html#LDAPSSL">ldap ssl</a> can be set to one of three values:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>Off</code></em> = Never
use SSL when querying the directory.</p></li><li><p><em class="parameter"><code>Start_tls</code></em> = Use
the LDAPv3 StartTLS extended operation (RFC2830) for
communicating with the directory server.</p></li><li><p><em class="parameter"><code>On</code></em> = Use SSL
on the ldaps port when contacting the <em class="parameter"><code>ldap server</code></em>. Only available when the
backwards-compatiblity <code class="literal">--with-ldapsam</code> option is specified
- to configure. See <a class="indexterm" name="id320538"></a>passdb backend</p>.
+ to configure. See <a class="link" href="smb.conf.5.html#PASSDBBACKEND">passdb backend</a></p>.
</li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap ssl</code></em> = <code class="literal">start_tls</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPSUFFIX"></a>ldap suffix (G)</span></dt><dd><p>Specifies the base for all ldap suffixes and for storing the sambaDomain object.</p><p>
- The ldap suffix will be appended to the values specified for the <a class="indexterm" name="id320590"></a>ldap user suffix,
- <a class="indexterm" name="id320597"></a>ldap group suffix, <a class="indexterm" name="id320604"></a>ldap machine suffix, and the
- <a class="indexterm" name="id320612"></a>ldap idmap suffix. Each of these should be given only a DN relative to the
- <a class="indexterm" name="id320619"></a>ldap suffix.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568614"></a>
+
+ldap suffix (G)
+</h3></div></div></div><a class="indexterm" name="id2568615"></a><a name="LDAPSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the base for all ldap suffixes and for storing the sambaDomain object.</p><p>
+ The ldap suffix will be appended to the values specified for the <a class="link" href="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</a>,
+ <a class="link" href="smb.conf.5.html#LDAPGROUPSUFFIX">ldap group suffix</a>, <a class="link" href="smb.conf.5.html#LDAPMACHINESUFFIX">ldap machine suffix</a>, and the
+ <a class="link" href="smb.conf.5.html#LDAPIDMAPSUFFIX">ldap idmap suffix</a>. Each of these should be given only a DN relative to the
+ <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap suffix</code></em> = <code class="literal">dc=samba,dc=org</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPTIMEOUT"></a>ldap timeout (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568737"></a>
+
+ldap timeout (G)
+</h3></div></div></div><a class="indexterm" name="id2568738"></a><a name="LDAPTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
When Samba connects to an ldap server that servermay be down or unreachable. To prevent Samba from hanging whilst
waiting for the connection this parameter specifies in seconds how long Samba should wait before failing the
connect. The default is to only wait fifteen seconds for the ldap server to respond to the connect request.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap timeout</code></em> = <code class="literal">15</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LDAPUSERSUFFIX"></a>ldap user suffix (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568783"></a>
+
+ldap user suffix (G)
+</h3></div></div></div><a class="indexterm" name="id2568784"></a><a name="LDAPUSERSUFFIX"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies where users are added to the tree. If this parameter is unset,
- the value of <a class="indexterm" name="id320721"></a>ldap suffix will be used instead. The suffix
- string is pre-pended to the <a class="indexterm" name="id320729"></a>ldap suffix string so use a partial DN.
+ the value of <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> will be used instead. The suffix
+ string is pre-pended to the <a class="link" href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</a> string so use a partial DN.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>ldap user suffix</code></em> = <code class="literal">ou=people</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LEVEL2OPLOCKS"></a>level2 oplocks (S)</span></dt><dd><p>This parameter controls whether Samba supports
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568865"></a>
+
+level2 oplocks (S)
+</h3></div></div></div><a class="indexterm" name="id2568866"></a><a name="LEVEL2OPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether Samba supports
level2 (read-only) oplocks on a share.</p><p>Level2, or read-only oplocks allow Windows NT clients
that have an oplock on a file to downgrade from a read-write oplock
to a read-only oplock once a second client opens the file (instead
@@ -2321,13 +2869,16 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
or waited for) and told to break their oplocks to "none" and
delete any read-ahead caches.</p><p>It is recommended that this parameter be turned on to
speed access to shared executables.</p><p>For more discussions on level2 oplocks see the CIFS spec.</p><p>
- Currently, if <a class="indexterm" name="id320816"></a>kernel oplocks are supported then
+ Currently, if <a class="link" href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks</a> are supported then
level2 oplocks are not granted (even if this parameter is set to
- <code class="constant">yes</code>). Note also, the <a class="indexterm" name="id320827"></a>oplocks
+ <code class="constant">yes</code>). Note also, the <a class="link" href="smb.conf.5.html#OPLOCKS">oplocks</a>
parameter must be set to <code class="constant">yes</code> on this share in order for
this parameter to have any effect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>level2 oplocks</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LMANNOUNCE"></a>lm announce (G)</span></dt><dd><p>This parameter determines if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will produce Lanman announce
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2568972"></a>
+
+lm announce (G)
+</h3></div></div></div><a class="indexterm" name="id2568973"></a><a name="LMANNOUNCE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will produce Lanman announce
broadcasts that are needed by OS/2 clients in order for them to see
the Samba server in their browse list. This parameter can have three
values, <code class="constant">yes</code>, <code class="constant">no</code>, or
@@ -2335,30 +2886,39 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
If set to <code class="constant">no</code> Samba will never produce these
broadcasts. If set to <code class="constant">yes</code> Samba will produce
Lanman announce broadcasts at a frequency set by the parameter
- <a class="indexterm" name="id320908"></a>lm interval. If set to <code class="constant">auto</code>
+ <a class="link" href="smb.conf.5.html#LMINTERVAL">lm interval</a>. If set to <code class="constant">auto</code>
Samba will not send Lanman announce broadcasts by default but will
listen for them. If it hears such a broadcast on the wire it will
then start sending them at a frequency set by the parameter
- <a class="indexterm" name="id320920"></a>lm interval.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">auto</code>
+ <a class="link" href="smb.conf.5.html#LMINTERVAL">lm interval</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">auto</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm announce</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LMINTERVAL"></a>lm interval (G)</span></dt><dd><p>If Samba is set to produce Lanman announce
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569094"></a>
+
+lm interval (G)
+</h3></div></div></div><a class="indexterm" name="id2569095"></a><a name="LMINTERVAL"></a><div class="variablelist"><dl><dt></dt><dd><p>If Samba is set to produce Lanman announce
broadcasts needed by OS/2 clients (see the
- <a class="indexterm" name="id320983"></a>lm announce parameter) then this
+ <a class="link" href="smb.conf.5.html#LMANNOUNCE">lm announce</a> parameter) then this
parameter defines the frequency in seconds with which they will be
made. If this is set to zero then no Lanman announcements will be
- made despite the setting of the <a class="indexterm" name="id320992"></a>lm announce
+ made despite the setting of the <a class="link" href="smb.conf.5.html#LMANNOUNCE">lm announce</a>
parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">60</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lm interval</code></em> = <code class="literal">120</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOADPRINTERS"></a>load printers (G)</span></dt><dd><p>A boolean variable that controls whether all
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569179"></a>
+
+load printers (G)
+</h3></div></div></div><a class="indexterm" name="id2569180"></a><a name="LOADPRINTERS"></a><div class="variablelist"><dl><dt></dt><dd><p>A boolean variable that controls whether all
printers in the printcap will be loaded for browsing by default.
- See the <a class="indexterm" name="id321055"></a>printers section for
+ See the <a class="link" href="smb.conf.5.html#PRINTERS">printers</a> section for
more details.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>load printers</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOCALMASTER"></a>local master (G)</span></dt><dd><p>This option allows <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to try and become a local master browser
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569234"></a>
+
+local master (G)
+</h3></div></div></div><a class="indexterm" name="id2569235"></a><a name="LOCALMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to try and become a local master browser
on a subnet. If set to <code class="constant">no</code> then <code class="literal">
nmbd</code> will not attempt to become a local master browser
on a subnet and will also lose in all browsing elections. By
@@ -2368,9 +2928,12 @@ Basically you should only use this option if you strike difficulties.</p><p>Defa
will <span class="emphasis"><em>participate</em></span> in elections for local master browser.</p><p>Setting this value to <code class="constant">no</code> will cause <code class="literal">nmbd</code> <span class="emphasis"><em>never</em></span> to become a local
master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>local master</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOCKDIR"></a>lock dir</span></dt><dd><p>This parameter is a synonym for lock directory.</p></dd><dt><span class="term"><a name="LOCKDIRECTORY"></a>lock directory (G)</span></dt><dd><p>This option specifies the directory where lock
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569335"></a><a name="LOCKDIR"></a>lock dir</h3></div></div></div><a class="indexterm" name="id2569336"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#LOCKDIRECTORY">lock directory</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569366"></a>
+
+lock directory (G)
+</h3></div></div></div><a class="indexterm" name="id2569367"></a><a name="LOCKDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the directory where lock
files will be placed. The lock files are used to implement the
- <a class="indexterm" name="id321217"></a>max connections option.
+ <a class="link" href="smb.conf.5.html#MAXCONNECTIONS">max connections</a> option.
</p><p>
Note: This option can not be set inside registry
configurations.
@@ -2378,7 +2941,10 @@ master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter">
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lock directory</code></em> = <code class="literal">/var/run/samba/locks</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOCKING"></a>locking (S)</span></dt><dd><p>This controls whether or not locking will be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569445"></a>
+
+locking (S)
+</h3></div></div></div><a class="indexterm" name="id2569446"></a><a name="LOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether or not locking will be
performed by the server in response to lock requests from the
client.</p><p>If <code class="literal">locking = no</code>, all lock and unlock
requests will appear to succeed and all lock queries will report
@@ -2388,37 +2954,54 @@ master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter">
CDROM drives), although setting this parameter of <code class="constant">no</code>
is not really recommended even in this case.</p><p>Be careful about disabling locking either globally or in a
specific service, as lack of locking may result in data corruption.
- You should never need to set this parameter.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="LOCKSPINCOUNT"></a>lock spin count (G)</span></dt><dd><p>This parameter has been made inoperative in Samba 3.0.24.
+ You should never need to set this parameter.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569521"></a>
+
+lock spin count (G)
+</h3></div></div></div><a class="indexterm" name="id2569522"></a><a name="LOCKSPINCOUNT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter has been made inoperative in Samba 3.0.24.
The functionality it contolled is now controlled by the parameter
- <a class="indexterm" name="id321351"></a>lock spin time.
+ <a class="link" href="smb.conf.5.html#LOCKSPINTIME">lock spin time</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin count</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOCKSPINTIME"></a>lock spin time (G)</span></dt><dd><p>The time in microseconds that smbd should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569577"></a>
+
+lock spin time (G)
+</h3></div></div></div><a class="indexterm" name="id2569578"></a><a name="LOCKSPINTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>The time in microseconds that smbd should
keep waiting to see if a failed lock request can
be granted. This parameter has changed in default
value from Samba 3.0.23 from 10 to 200. The associated
- <a class="indexterm" name="id321399"></a>lock spin count parameter is
+ <a class="link" href="smb.conf.5.html#LOCKSPINCOUNT">lock spin count</a> parameter is
no longer used in Samba 3.0.24. You should not need
to change the value of this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lock spin time</code></em> = <code class="literal">200</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOGFILE"></a>log file (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569635"></a>
+
+log file (G)
+</h3></div></div></div><a class="indexterm" name="id2569636"></a><a name="LOGFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to override the name of the Samba log file (also known as the debug file).
</p><p>
This option takes the standard substitutions, allowing you to have separate log files for each user or machine.
</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log file</code></em> = <code class="literal">/usr/local/samba/var/log.%m</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DEBUGLEVEL"></a>debuglevel</span></dt><dd><p>This parameter is a synonym for log level.</p></dd><dt><span class="term"><a name="LOGLEVEL"></a>log level (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569687"></a><a name="DEBUGLEVEL"></a>debuglevel</h3></div></div></div><a class="indexterm" name="id2569688"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#LOGLEVEL">log level</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569717"></a>
+
+log level (G)
+</h3></div></div></div><a class="indexterm" name="id2569718"></a><a name="LOGLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
The value of the parameter (a astring) allows the debug level (logging level) to be specified in the
- <code class="filename">smb.conf</code> file. This parameter has been extended since the 2.2.x
- series, now it allow to specify the debug level for multiple debug classes. This is to give greater
- flexibility in the configuration of the system.
- </p><p>
- The default will be the log level specified on the command line or level zero if none was specified.
- </p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">3 passdb:5 auth:10 winbind:2</code>
+ <code class="filename">smb.conf</code> file.
+ </p><p>This parameter has been extended since the 2.2.x
+ series, now it allows to specify the debug level for multiple
+ debug classes. This is to give greater flexibility in the configuration
+ of the system. The following debug classes are currently implemented:
+ </p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>all</code></em></p></li><li><p><em class="parameter"><code>tdb</code></em></p></li><li><p><em class="parameter"><code>printdrivers</code></em></p></li><li><p><em class="parameter"><code>lanman</code></em></p></li><li><p><em class="parameter"><code>smb</code></em></p></li><li><p><em class="parameter"><code>rpc_parse</code></em></p></li><li><p><em class="parameter"><code>rpc_srv</code></em></p></li><li><p><em class="parameter"><code>rpc_cli</code></em></p></li><li><p><em class="parameter"><code>passdb</code></em></p></li><li><p><em class="parameter"><code>sam</code></em></p></li><li><p><em class="parameter"><code>auth</code></em></p></li><li><p><em class="parameter"><code>winbind</code></em></p></li><li><p><em class="parameter"><code>vfs</code></em></p></li><li><p><em class="parameter"><code>idmap</code></em></p></li><li><p><em class="parameter"><code>quota</code></em></p></li><li><p><em class="parameter"><code>acls</code></em></p></li><li><p><em class="parameter"><code>locking</code></em></p></li><li><p><em class="parameter"><code>msdfs</code></em></p></li><li><p><em class="parameter"><code>dmapi</code></em></p></li><li><p><em class="parameter"><code>registry</code></em></p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOGONDRIVE"></a>logon drive (G)</span></dt><dd><p>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>log level</code></em> = <code class="literal">3 passdb:5 auth:10 winbind:2</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2569950"></a>
+
+logon drive (G)
+</h3></div></div></div><a class="indexterm" name="id2569951"></a><a name="LOGONDRIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the local path to which the home directory will be
- connected (see <a class="indexterm" name="id321570"></a>logon home) and is only used by NT
+ connected (see <a class="link" href="smb.conf.5.html#LOGONHOME">logon home</a>) and is only used by NT
Workstations.
</p><p>
Note that this option is only useful if Samba is set up as a logon server.
@@ -2426,7 +3009,10 @@ master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter">
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon drive</code></em> = <code class="literal">h:</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOGONHOME"></a>logon home (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570024"></a>
+
+logon home (G)
+</h3></div></div></div><a class="indexterm" name="id2570025"></a><a name="LOGONHOME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC.
It allows you to do
</p><p>
@@ -2445,23 +3031,26 @@ master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter">
in a NetUserGetInfo request. Win9X clients truncate the info to \\server\share when a user does
<code class="literal">net use /home</code> but use the whole string when dealing with profiles.
</p><p>
- Note that in prior versions of Samba, the <a class="indexterm" name="id321687"></a>logon path was returned rather than
+ Note that in prior versions of Samba, the <a class="link" href="smb.conf.5.html#LOGONPATH">logon path</a> was returned rather than
<em class="parameter"><code>logon home</code></em>. This broke <code class="literal">net use /home</code>
but allowed profiles outside the home directory. The current implementation is correct, and can be used for
profiles if you use the above trick.
</p><p>
- Disable this feature by setting <a class="indexterm" name="id321711"></a>logon home = "" - using the empty string.
+ Disable this feature by setting <a class="link" href="smb.conf.5.html#LOGONHOME">logon home = ""</a> - using the empty string.
</p><p>
This option is only useful if Samba is set up as a logon server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\%N\%U</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon home</code></em> = <code class="literal">\\remote_smb_server\%U</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOGONPATH"></a>logon path (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570189"></a>
+
+logon path (G)
+</h3></div></div></div><a class="indexterm" name="id2570190"></a><a name="LOGONPATH"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the directory where roaming profiles (Desktop, NTuser.dat, etc) are
stored. Contrary to previous versions of these manual pages, it has nothing to do with Win 9X roaming
profiles. To find out how to handle roaming profiles for Win 9X system, see the
- <a class="indexterm" name="id321780"></a>logon home parameter.
+ <a class="link" href="smb.conf.5.html#LOGONHOME">logon home</a> parameter.
</p><p>
This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
machine. It also specifies the directory from which the "Application Data", <code class="filename">desktop</code>, <code class="filename">start menu</code>, <code class="filename">network neighborhood</code>, <code class="filename">programs</code> and other
@@ -2490,7 +3079,7 @@ master browser.</p><p>Default: <span class="emphasis"><em><em class="parameter">
provided system tool).
</p></div><p>Note that this option is only useful if Samba is set up as a domain controller.</p><p>
Disable the use of roaming profiles by setting the value of this parameter to the empty string. For
- example, <a class="indexterm" name="id321857"></a>logon path = "". Take note that even if the default setting
+ example, <a class="link" href="smb.conf.5.html#LOGONPATH">logon path = ""</a>. Take note that even if the default setting
in the smb.conf file is the empty string, any value specified in the user account settings in the passdb
backend will over-ride the effect of setting this parameter to null. Disabling of all roaming profile use
requires that the user account settings must also be blank.
@@ -2501,13 +3090,16 @@ logon path = \\PROFILESERVER\PROFILE\%U
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>logon path</code></em> = <code class="literal">\\%N\%U\profile</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LOGONSCRIPT"></a>logon script (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570357"></a>
+
+logon script (G)
+</h3></div></div></div><a class="indexterm" name="id2570358"></a><a name="LOGONSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the batch file (<code class="filename">.bat</code>) or NT command file
(<code class="filename">.cmd</code>) to be downloaded and run on a machine when a user successfully logs in. The file
must contain the DOS style CR/LF line endings. Using a DOS-style editor to create the file is recommended.
</p><p>
The script must be a relative path to the <em class="parameter"><code>[netlogon]</code></em> service. If the [netlogon]
- service specifies a <a class="indexterm" name="id321939"></a>path of <code class="filename">/usr/local/samba/netlogon</code>, and <a class="indexterm" name="id321952"></a>logon script = STARTUP.BAT, then the file that will be downloaded is:
+ service specifies a <a class="link" href="smb.conf.5.html#PATH">path</a> of <code class="filename">/usr/local/samba/netlogon</code>, and <a class="link" href="smb.conf.5.html#LOGONSCRIPT">logon script = STARTUP.BAT</a>, then the file that will be downloaded is:
</p><pre class="programlisting">
/usr/local/samba/netlogon/STARTUP.BAT
</pre><p>
@@ -2532,7 +3124,10 @@ logon path = \\PROFILESERVER\PROFILE\%U
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>logon script</code></em> = <code class="literal">scripts\%U.bat</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LPPAUSECOMMAND"></a>lppause command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570527"></a>
+
+lppause command (S)
+</h3></div></div></div><a class="indexterm" name="id2570528"></a><a name="LPPAUSECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to stop printing or spooling
a specific print job.</p><p>This command should be a program or script which takes
a printer name and job number to pause the print job. One way
@@ -2547,7 +3142,7 @@ logon path = \\PROFILESERVER\PROFILE\%U
will have the SPOOLED or PRINTING status.</p><p>Note that it is good practice to include the absolute path
in the lppause command as the PATH may not be available to the server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal">
# Currently no default value is given to
- this string, unless the value of the <a class="indexterm" name="id322120"></a>printing
+ this string, unless the value of the <a class="link" href="smb.conf.5.html#PRINTING">printing</a>
parameter is <code class="constant">SYSV</code>, in which case the default is :
<code class="literal">lp -i %p-%j -H hold</code> or if the value of the
<em class="parameter"><code>printing</code></em> parameter is
@@ -2556,7 +3151,10 @@ logon path = \\PROFILESERVER\PROFILE\%U
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lppause command</code></em> = <code class="literal">/usr/bin/lpalt %p-%j -p0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LPQCACHETIME"></a>lpq cache time (G)</span></dt><dd><p>This controls how long lpq info will be cached
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570675"></a>
+
+lpq cache time (G)
+</h3></div></div></div><a class="indexterm" name="id2570676"></a><a name="LPQCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls how long lpq info will be cached
for to prevent the <code class="literal">lpq</code> command being called too
often. A separate cache is kept for each variation of the <code class="literal">
lpq</code> command used by the system, so if you use different
@@ -2569,7 +3167,10 @@ logon path = \\PROFILESERVER\PROFILE\%U
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq cache time</code></em> = <code class="literal">10</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LPQCOMMAND"></a>lpq command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570794"></a>
+
+lpq command (S)
+</h3></div></div></div><a class="indexterm" name="id2570795"></a><a name="LPQCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to obtain <code class="literal">lpq
</code>-style printer status information.</p><p>This command should be a program or script which
takes a printer name as its only parameter and outputs printer
@@ -2591,20 +3192,26 @@ logon path = \\PROFILESERVER\PROFILE\%U
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpq command</code></em> = <code class="literal">/usr/bin/lpq -P%p</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LPRESUMECOMMAND"></a>lpresume command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2570920"></a>
+
+lpresume command (S)
+</h3></div></div></div><a class="indexterm" name="id2570921"></a><a name="LPRESUMECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to restart or continue
printing or spooling a specific print job.</p><p>This command should be a program or script which takes
a printer name and job number to resume the print job. See
- also the <a class="indexterm" name="id322423"></a>lppause command parameter.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
+ also the <a class="link" href="smb.conf.5.html#LPPAUSECOMMAND">lppause command</a> parameter.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with
the job number (an integer).</p><p>Note that it is good practice to include the absolute path
in the <em class="parameter"><code>lpresume command</code></em> as the PATH may not
- be available to the server.</p><p>See also the <a class="indexterm" name="id322460"></a>printing parameter.</p><p>Default: Currently no default value is given
+ be available to the server.</p><p>See also the <a class="link" href="smb.conf.5.html#PRINTING">printing</a> parameter.</p><p>Default: Currently no default value is given
to this string, unless the value of the <em class="parameter"><code>printing</code></em>
- parameter is <code class="constant">SYSV</code>, in which case the default is :</p><p><code class="literal">lp -i %p-%j -H resume</code></p><p>or if the value of the <em class="parameter"><code>printing</code></em> parameter
- is <code class="constant">SOFTQ</code>, then the default is:</p><p><code class="literal">qstat -s -j%j -r</code></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lpresume command</code></em> = <code class="literal">lpresume command = /usr/bin/lpalt %p-%j -p2</code>
+ parameter is <code class="constant">SYSV</code>, in which case the default is:</p><p><code class="literal">lp -i %p-%j -H resume</code></p><p>or if the value of the <em class="parameter"><code>printing</code></em> parameter
+ is <code class="constant">SOFTQ</code>, then the default is:</p><p><code class="literal">qstat -s -j%j -r</code></p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>lpresume command</code></em> = <code class="literal">/usr/bin/lpalt %p-%j -p2</code>
</em></span>
-</p></dd><dt><span class="term"><a name="LPRMCOMMAND"></a>lprm command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571073"></a>
+
+lprm command (S)
+</h3></div></div></div><a class="indexterm" name="id2571074"></a><a name="LPRMCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to delete a print job.</p><p>This command should be a program or script which takes
a printer name and job number, and deletes the print job.</p><p>If a <em class="parameter"><code>%p</code></em> is given then the printer name
is put in its place. A <em class="parameter"><code>%j</code></em> is replaced with
@@ -2621,32 +3228,41 @@ lprm command = /usr/bin/cancel %p-%j
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>lprm command</code></em> = <code class="literal"> determined by printing parameter</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MACHINEPASSWORDTIMEOUT"></a>machine password timeout (G)</span></dt><dd><p>
- If a Samba server is a member of a Windows NT Domain (see the <a class="indexterm" name="id322626"></a>security = domain parameter) then periodically a running smbd process will try and change
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571160"></a>
+
+machine password timeout (G)
+</h3></div></div></div><a class="indexterm" name="id2571161"></a><a name="MACHINEPASSWORDTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ If a Samba server is a member of a Windows NT Domain (see the <a class="link" href="smb.conf.5.html#SECURITY">security = domain</a> parameter) then periodically a running smbd process will try and change
the MACHINE ACCOUNT PASSWORD stored in the TDB called <code class="filename">private/secrets.tdb
</code>. This parameter specifies how often this password will be changed, in seconds. The default is one
week (expressed in seconds), the same as a Windows NT Domain member server.
</p><p>
- See also <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>,
- and the <a class="indexterm" name="id322653"></a>security = domain parameter.
+ See also <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>,
+ and the <a class="link" href="smb.conf.5.html#SECURITY">security = domain</a> parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>machine password timeout</code></em> = <code class="literal">604800</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAGICOUTPUT"></a>magic output (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571247"></a>
+
+magic output (S)
+</h3></div></div></div><a class="indexterm" name="id2571248"></a><a name="MAGICOUTPUT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the name of a file which will contain output created by a magic script (see the
- <a class="indexterm" name="id322699"></a>magic script parameter below).
+ <a class="link" href="smb.conf.5.html#MAGICSCRIPT">magic script</a> parameter below).
</p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>If two clients use the same <em class="parameter"><code>magic script
</code></em> in the same directory the output file content is undefined.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal">&lt;magic script name&gt;.out</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic output</code></em> = <code class="literal">myfile.txt</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAGICSCRIPT"></a>magic script (S)</span></dt><dd><p>This parameter specifies the name of a file which,
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571331"></a>
+
+magic script (S)
+</h3></div></div></div><a class="indexterm" name="id2571332"></a><a name="MAGICSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the name of a file which,
if opened, will be executed by the server when the file is closed.
This allows a UNIX script to be sent to the Samba host and
executed on behalf of the connected user.</p><p>Scripts executed in this way will be deleted upon
completion assuming that the user has the appropriate level
of privilege and the file permissions allow the deletion.</p><p>If the script generates output, output will be sent to
- the file specified by the <a class="indexterm" name="id322784"></a>magic output
+ the file specified by the <a class="link" href="smb.conf.5.html#MAGICOUTPUT">magic output</a>
parameter (see above).</p><p>Note that some shells are unable to interpret scripts
containing CR/LF instead of CR as
the end-of-line marker. Magic scripts must be executable
@@ -2656,30 +3272,12 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>magic script</code></em> = <code class="literal">user.csh</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MANGLEDMAP"></a>mangled map (S)</span></dt><dd><p>
- This is for those who want to directly map UNIX file names which cannot be represented on
- Windows/DOS. The mangling of names is not always what is needed. In particular you may have
- documents with file extensions that differ between DOS and UNIX.
- For example, under UNIX it is common to use <code class="filename">.html</code>
- for HTML files, whereas under Windows/DOS <code class="filename">.htm</code>
- is more commonly used.
- </p><p>
- So to map <code class="filename">html</code> to <code class="filename">htm</code>
- you would use:
- </p><p>
- <a class="indexterm" name="id322898"></a>mangled map = (*.html *.htm).
- </p><p>
- One very useful case is to remove the annoying <code class="filename">;1</code> off
- the ends of filenames on some CDROMs (only visible under some UNIXes). To do this use a map of
- (*;1 *;).
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangled map</code></em> = <code class="literal">
-# no mangled map</code>
-</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangled map</code></em> = <code class="literal">(*;1 *;)</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="MANGLEDNAMES"></a>mangled names (S)</span></dt><dd><p>This controls whether non-DOS names under UNIX
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571437"></a>
+
+mangled names (S)
+</h3></div></div></div><a class="indexterm" name="id2571438"></a><a name="MANGLEDNAMES"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether non-DOS names under UNIX
should be mapped to DOS-compatible names ("mangled") and made visible,
- or whether non-DOS names should simply be ignored.</p><p>See the section on <a class="indexterm" name="id322975"></a>name mangling for
+ or whether non-DOS names should simply be ignored.</p><p>See the section on <a class="link" href="smb.conf.5.html#NAMEMANGLING">name mangling</a> for
details on how to control the mangling process.</p><p>If mangling is used then the mangling algorithm is as follows:</p><div class="itemizedlist"><ul type="disc"><li><p>The first (up to) five alphanumeric characters
before the rightmost dot of the filename are preserved, forced
to upper case, and appear as the first (up to) five characters
@@ -2689,7 +3287,7 @@ lprm command = /usr/bin/cancel %p-%j
extension). The final extension is included in the hash calculation
only if it contains any upper case characters or is longer than three
characters.</p><p>Note that the character to use may be specified using
- the <a class="indexterm" name="id323009"></a>mangling char
+ the <a class="link" href="smb.conf.5.html#MANGLINGCHAR">mangling char</a>
option, if you don't like '~'.</p></li><li><p>Files whose UNIX name begins with a dot will be
presented as DOS hidden files. The mangled name will be created as
for other filenames, but with the leading dot removed and "___" as
@@ -2702,7 +3300,10 @@ lprm command = /usr/bin/cancel %p-%j
from Windows/DOS and will retain the same basename. Mangled names
do not change between sessions.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangled names</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MANGLEPREFIX"></a>mangle prefix (G)</span></dt><dd><p> controls the number of prefix
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571574"></a>
+
+mangle prefix (G)
+</h3></div></div></div><a class="indexterm" name="id2571575"></a><a name="MANGLEPREFIX"></a><div class="variablelist"><dl><dt></dt><dd><p> controls the number of prefix
characters from the original name used when generating
the mangled names. A larger value will give a weaker
hash and therefore more name collisions. The minimum
@@ -2712,14 +3313,20 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangle prefix</code></em> = <code class="literal">4</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MANGLINGCHAR"></a>mangling char (S)</span></dt><dd><p>This controls what character is used as
- the <span class="emphasis"><em>magic</em></span> character in <a class="indexterm" name="id323146"></a>name mangling. The
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571640"></a>
+
+mangling char (S)
+</h3></div></div></div><a class="indexterm" name="id2571641"></a><a name="MANGLINGCHAR"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what character is used as
+ the <span class="emphasis"><em>magic</em></span> character in <a class="link" href="smb.conf.5.html#NAMEMANGLING">name mangling</a>. The
default is a '~' but this may interfere with some software. Use this option to set
it to whatever you prefer. This is effective only when mangling method is hash.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">~</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling char</code></em> = <code class="literal">^</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MANGLINGMETHOD"></a>mangling method (G)</span></dt><dd><p> controls the algorithm used for the generating
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571718"></a>
+
+mangling method (G)
+</h3></div></div></div><a class="indexterm" name="id2571719"></a><a name="MANGLINGMETHOD"></a><div class="variablelist"><dl><dt></dt><dd><p> controls the algorithm used for the generating
the mangled names. Can take two different values, "hash" and
"hash2". "hash" is the algorithm that was used
used in Samba for many years and was the default in Samba 2.2.x "hash2" is
@@ -2730,7 +3337,10 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>mangling method</code></em> = <code class="literal">hash</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAPACLINHERIT"></a>map acl inherit (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map the 'inherit' and 'protected'
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571784"></a>
+
+map acl inherit (S)
+</h3></div></div></div><a class="indexterm" name="id2571785"></a><a name="MAPACLINHERIT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map the 'inherit' and 'protected'
access control entry flags stored in Windows ACLs into an extended attribute
called user.SAMBA_PAI. This parameter only takes effect if Samba is being run
on a platform that supports extended attributes (Linux and IRIX so far) and
@@ -2738,7 +3348,10 @@ lprm command = /usr/bin/cancel %p-%j
POSIX ACL mapping code.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map acl inherit</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAPARCHIVE"></a>map archive (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571841"></a>
+
+map archive (S)
+</h3></div></div></div><a class="indexterm" name="id2571842"></a><a name="MAPARCHIVE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the DOS archive attribute
should be mapped to the UNIX owner execute bit. The DOS archive bit
is set when a file has been modified since its last backup. One
@@ -2746,23 +3359,29 @@ lprm command = /usr/bin/cancel %p-%j
any file it touches from becoming executable under UNIX. This can
be quite annoying for shared source code, documents, etc...
</p><p>
- Note that this requires the <a class="indexterm" name="id323326"></a>create mask parameter to be set such that owner
+ Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a> parameter to be set such that owner
execute bit is not masked out (i.e. it must include 100). See the parameter
- <a class="indexterm" name="id323334"></a>create mask for details.
+ <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a> for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map archive</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAPHIDDEN"></a>map hidden (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571923"></a>
+
+map hidden (S)
+</h3></div></div></div><a class="indexterm" name="id2571924"></a><a name="MAPHIDDEN"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether DOS style hidden files should be mapped to the UNIX world execute bit.
</p><p>
- Note that this requires the <a class="indexterm" name="id323384"></a>create mask to be set such that the world execute
- bit is not masked out (i.e. it must include 001). See the parameter <a class="indexterm" name="id323392"></a>create mask
+ Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a> to be set such that the world execute
+ bit is not masked out (i.e. it must include 001). See the parameter <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a>
for details.
- </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="MAPREADONLY"></a>map read only (S)</span></dt><dd><p>
+ </p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2571981"></a>
+
+map read only (S)
+</h3></div></div></div><a class="indexterm" name="id2571982"></a><a name="MAPREADONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls how the DOS read only attribute should be mapped from a UNIX filesystem.
</p><p>
- This parameter can take three different values, which tell <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> how to display the read only attribute on files, where either
- <a class="indexterm" name="id323437"></a>store dos attributes is set to <code class="constant">No</code>, or no extended attribute is
- present. If <a class="indexterm" name="id323448"></a>store dos attributes is set to <code class="constant">yes</code> then this
+ This parameter can take three different values, which tell <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> how to display the read only attribute on files, where either
+ <a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</a> is set to <code class="constant">No</code>, or no extended attribute is
+ present. If <a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</a> is set to <code class="constant">yes</code> then this
parameter is <span class="emphasis"><em>ignored</em></span>. This is a new parameter introduced in Samba version 3.0.21.
</p><p>The three settings are :</p><div class="itemizedlist"><ul type="disc"><li><p>
<code class="constant">Yes</code> - The read only DOS attribute is mapped to the inverse of the user
@@ -2770,35 +3389,41 @@ lprm command = /usr/bin/cancel %p-%j
read only attribute is reported as being set on the file.
</p></li><li><p>
<code class="constant">Permissions</code> - The read only DOS attribute is mapped to the effective permissions of
- the connecting user, as evaluated by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> by reading the unix permissions and POSIX ACL (if present).
+ the connecting user, as evaluated by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> by reading the unix permissions and POSIX ACL (if present).
If the connecting user does not have permission to modify the file, the read only attribute
is reported as being set on the file.
</p></li><li><p>
<code class="constant">No</code> - The read only DOS attribute is unaffected by permissions, and can only be set by
- the <a class="indexterm" name="id323505"></a>store dos attributes method. This may be useful for exporting mounted CDs.
+ the <a class="link" href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</a> method. This may be useful for exporting mounted CDs.
</p></li></ul></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>map read only</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAPSYSTEM"></a>map system (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572134"></a>
+
+map system (S)
+</h3></div></div></div><a class="indexterm" name="id2572135"></a><a name="MAPSYSTEM"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether DOS style system files should be mapped to the UNIX group execute bit.
</p><p>
- Note that this requires the <a class="indexterm" name="id323556"></a>create mask to be set such that the group
+ Note that this requires the <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a> to be set such that the group
execute bit is not masked out (i.e. it must include 010). See the parameter
- <a class="indexterm" name="id323564"></a>create mask for details.
+ <a class="link" href="smb.conf.5.html#CREATEMASK">create mask</a> for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>map system</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAPTOGUEST"></a>map to guest (G)</span></dt><dd><p>This parameter is only useful in <a class="indexterm" name="id323609"></a>SECURITY =
- security modes other than <em class="parameter"><code>security = share</code></em>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572203"></a>
+
+map to guest (G)
+</h3></div></div></div><a class="indexterm" name="id2572204"></a><a name="MAPTOGUEST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only useful in <a class="link" href="smb.conf.5.html#SECURITY">SECURITY =
+ security</a> modes other than <em class="parameter"><code>security = share</code></em>
and <em class="parameter"><code>security = server</code></em>
- i.e. <code class="constant">user</code>, and <code class="constant">domain</code>.</p><p>This parameter can take four different values, which tell
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> what to do with user
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> what to do with user
login requests that don't match a valid UNIX user in some way.</p><p>The four settings are :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">Never</code> - Means user login
requests with an invalid password are rejected. This is the
default.</p></li><li><p><code class="constant">Bad User</code> - Means user
logins with an invalid password are rejected, unless the username
does not exist, in which case it is treated as a guest login and
- mapped into the <a class="indexterm" name="id323673"></a>guest account.</p></li><li><p><code class="constant">Bad Password</code> - Means user logins
+ mapped into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>.</p></li><li><p><code class="constant">Bad Password</code> - Means user logins
with an invalid password are treated as a guest login and mapped
- into the <a class="indexterm" name="id323690"></a>guest account. Note that
+ into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>. Note that
this can cause problems as it means that any user incorrectly typing
their password will be silently logged on as "guest" - and
will not know the reason they cannot access files they think
@@ -2828,15 +3453,21 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>map to guest</code></em> = <code class="literal">Bad User</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXCONNECTIONS"></a>max connections (S)</span></dt><dd><p>This option allows the number of simultaneous connections to a service to be limited.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572442"></a>
+
+max connections (S)
+</h3></div></div></div><a class="indexterm" name="id2572444"></a><a name="MAXCONNECTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows the number of simultaneous connections to a service to be limited.
If <em class="parameter"><code>max connections</code></em> is greater than 0 then connections
will be refused if this number of connections to the service are already open. A value
of zero mean an unlimited number of connections may be made.</p><p>Record lock files are used to implement this feature. The lock files will be stored in
- the directory specified by the <a class="indexterm" name="id323827"></a>lock directory option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">0</code>
+ the directory specified by the <a class="link" href="smb.conf.5.html#LOCKDIRECTORY">lock directory</a> option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max connections</code></em> = <code class="literal">10</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXDISKSIZE"></a>max disk size (G)</span></dt><dd><p>This option allows you to put an upper limit
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572528"></a>
+
+max disk size (G)
+</h3></div></div></div><a class="indexterm" name="id2572530"></a><a name="MAXDISKSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to put an upper limit
on the apparent size of disks. If you set this option to 100
then all shares will appear to be not larger than 100 MB in
size.</p><p>Note that this option does not limit the amount of
@@ -2850,7 +3481,10 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max disk size</code></em> = <code class="literal">1000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXLOGSIZE"></a>max log size (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572620"></a>
+
+max log size (G)
+</h3></div></div></div><a class="indexterm" name="id2572621"></a><a name="MAXLOGSIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option (an integer in kilobytes) specifies the max size the log file should grow to.
Samba periodically checks the size and if it is exceeded it will rename the file, adding
a <code class="filename">.old</code> extension.
@@ -2859,26 +3493,38 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max log size</code></em> = <code class="literal">1000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXMUX"></a>max mux (G)</span></dt><dd><p>This option controls the maximum number of
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572692"></a>
+
+max mux (G)
+</h3></div></div></div><a class="indexterm" name="id2572693"></a><a name="MAXMUX"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum number of
outstanding simultaneous SMB operations that Samba tells the client
it will allow. You should never need to set this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max mux</code></em> = <code class="literal">50</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXOPENFILES"></a>max open files (G)</span></dt><dd><p>This parameter limits the maximum number of
- open files that one <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> file
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572735"></a>
+
+max open files (G)
+</h3></div></div></div><a class="indexterm" name="id2572736"></a><a name="MAXOPENFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of
+ open files that one <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> file
serving process may have open for a client at any one time. The
default for this parameter is set very high (10,000) as Samba uses
only one bit per unopened file.</p><p>The limit of the number of open files is usually set
by the UNIX per-process file descriptor limit rather than
this parameter so you should never need to touch this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max open files</code></em> = <code class="literal">10000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXPRINTJOBS"></a>max print jobs (S)</span></dt><dd><p>This parameter limits the maximum number of
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572795"></a>
+
+max print jobs (S)
+</h3></div></div></div><a class="indexterm" name="id2572796"></a><a name="MAXPRINTJOBS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of
jobs allowable in a Samba printer queue at any given moment.
- If this number is exceeded, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will remote "Out of Space" to the client.
+ If this number is exceeded, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will remote "Out of Space" to the client.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">1000</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max print jobs</code></em> = <code class="literal">5000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PROTOCOL"></a>protocol</span></dt><dd><p>This parameter is a synonym for max protocol.</p></dd><dt><span class="term"><a name="MAXPROTOCOL"></a>max protocol (G)</span></dt><dd><p>The value of the parameter (a string) is the highest
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572865"></a><a name="PROTOCOL"></a>protocol</h3></div></div></div><a class="indexterm" name="id2572866"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#MAXPROTOCOL">max protocol</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2572896"></a>
+
+max protocol (G)
+</h3></div></div></div><a class="indexterm" name="id2572898"></a><a name="MAXPROTOCOL"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a string) is the highest
protocol level that will be supported by the server.</p><p>Possible values are :</p><div class="itemizedlist"><ul type="disc"><li><p><code class="constant">CORE</code>: Earliest version. No
concept of user names.</p></li><li><p><code class="constant">COREPLUS</code>: Slight improvements on
CORE for efficiency.</p></li><li><p><code class="constant">LANMAN1</code>: First <span class="emphasis"><em>
@@ -2890,7 +3536,10 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max protocol</code></em> = <code class="literal">LANMAN1</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXREPORTEDPRINTJOBS"></a>max reported print jobs (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573021"></a>
+
+max reported print jobs (S)
+</h3></div></div></div><a class="indexterm" name="id2573022"></a><a name="MAXREPORTEDPRINTJOBS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter limits the maximum number of jobs displayed in a port monitor for
Samba printer queue at any given moment. If this number is exceeded, the excess
jobs will not be shown. A value of zero means there is no limit on the number of
@@ -2899,15 +3548,21 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max reported print jobs</code></em> = <code class="literal">1000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXSMBDPROCESSES"></a>max smbd processes (G)</span></dt><dd><p>This parameter limits the maximum number of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes concurrently running on a system and is intended
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573085"></a>
+
+max smbd processes (G)
+</h3></div></div></div><a class="indexterm" name="id2573086"></a><a name="MAXSMBDPROCESSES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the maximum number of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> processes concurrently running on a system and is intended
as a stopgap to prevent degrading service to clients in the event that the server has insufficient
resources to handle more than this number of connections. Remember that under normal operating
- conditions, each user will have an <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> associated with him or her to handle connections to all
+ conditions, each user will have an <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> associated with him or her to handle connections to all
shares from a given host.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max smbd processes</code></em> = <code class="literal">1000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXSTATCACHESIZE"></a>max stat cache size (G)</span></dt><dd><p>This parameter limits the size in memory of any
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573166"></a>
+
+max stat cache size (G)
+</h3></div></div></div><a class="indexterm" name="id2573168"></a><a name="MAXSTATCACHESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter limits the size in memory of any
<em class="parameter"><code>stat cache</code></em> being used
to speed up case insensitive name mappings. This parameter is
the number of kilobyte (1024) units the stat cache can use.
@@ -2917,18 +3572,27 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max stat cache size</code></em> = <code class="literal">100</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXTTL"></a>max ttl (G)</span></dt><dd><p>This option tells <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> what the default 'time to live'
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573240"></a>
+
+max ttl (G)
+</h3></div></div></div><a class="indexterm" name="id2573242"></a><a name="MAXTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> what the default 'time to live'
of NetBIOS names should be (in seconds) when <code class="literal">nmbd</code> is
requesting a name using either a broadcast packet or from a WINS server. You should
never need to change this parameter. The default is 3 days.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max ttl</code></em> = <code class="literal">259200</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXWINSTTL"></a>max wins ttl (G)</span></dt><dd><p>This option tells <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when acting as a WINS server
- (<a class="indexterm" name="id324595"></a>wins support = yes) what the maximum
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573299"></a>
+
+max wins ttl (G)
+</h3></div></div></div><a class="indexterm" name="id2573300"></a><a name="MAXWINSTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when acting as a WINS server
+ (<a class="link" href="smb.conf.5.html#WINSSUPPORT">wins support = yes</a>) what the maximum
'time to live' of NetBIOS names that <code class="literal">nmbd</code>
will grant will be (in seconds). You should never need to change this
parameter. The default is 6 days (518400 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>max wins ttl</code></em> = <code class="literal">518400</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MAXXMIT"></a>max xmit (G)</span></dt><dd><p>This option controls the maximum packet size
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573370"></a>
+
+max xmit (G)
+</h3></div></div></div><a class="indexterm" name="id2573371"></a><a name="MAXXMIT"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum packet size
that will be negotiated by Samba. The default is 16644, which
matches the behavior of Windows 2000. A value below 2048 is likely to cause problems.
You should never need to change this parameter from its default value.
@@ -2936,7 +3600,10 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>max xmit</code></em> = <code class="literal">8192</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MESSAGECOMMAND"></a>message command (G)</span></dt><dd><p>This specifies what command to run when the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573433"></a>
+
+message command (G)
+</h3></div></div></div><a class="indexterm" name="id2573434"></a><a name="MESSAGECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies what command to run when the
server receives a WinPopup style message.</p><p>This would normally be a command that would
deliver the message somehow. How this is to be done is
up to your imagination.</p><p>An example is:
@@ -2975,26 +3642,35 @@ lprm command = /usr/bin/cancel %p-%j
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>message command</code></em> = <code class="literal">csh -c 'xedit %s; rm %s' &amp;</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MINPRINTSPACE"></a>min print space (S)</span></dt><dd><p>This sets the minimum amount of free disk
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573643"></a>
+
+min print space (S)
+</h3></div></div></div><a class="indexterm" name="id2573644"></a><a name="MINPRINTSPACE"></a><div class="variablelist"><dl><dt></dt><dd><p>This sets the minimum amount of free disk
space that must be available before a user will be able to spool
a print job. It is specified in kilobytes. The default is 0, which
means a user can always spool a print job.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min print space</code></em> = <code class="literal">2000</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MINPROTOCOL"></a>min protocol (G)</span></dt><dd><p>The value of the parameter (a string) is the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573705"></a>
+
+min protocol (G)
+</h3></div></div></div><a class="indexterm" name="id2573706"></a><a name="MINPROTOCOL"></a><div class="variablelist"><dl><dt></dt><dd><p>The value of the parameter (a string) is the
lowest SMB protocol dialect than Samba will support. Please refer
- to the <a class="indexterm" name="id324954"></a>max protocol
+ to the <a class="link" href="smb.conf.5.html#MAXPROTOCOL">max protocol</a>
parameter for a list of valid protocol names and a brief description
of each. You may also wish to refer to the C source code in
<code class="filename">source/smbd/negprot.c</code> for a listing of known protocol
dialects supported by clients.</p><p>If you are viewing this parameter as a security measure, you should
- also refer to the <a class="indexterm" name="id324973"></a>lanman auth parameter. Otherwise, you should never need
+ also refer to the <a class="link" href="smb.conf.5.html#LANMANAUTH">lanman auth</a> parameter. Otherwise, you should never need
to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">CORE</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>min protocol</code></em> = <code class="literal">NT1</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MINRECEIVEFILESIZE"></a>min receivefile size (G)</span></dt><dd><p>This option changes the behavior of <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when processing SMBwriteX calls. Any incoming
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573803"></a>
+
+min receivefile size (G)
+</h3></div></div></div><a class="indexterm" name="id2573804"></a><a name="MINRECEIVEFILESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option changes the behavior of <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> when processing SMBwriteX calls. Any incoming
SMBwriteX call on a non-signed SMB/CIFS connection greater than this value will not be processed in the normal way but will
be passed to any underlying kernel recvfile or splice system call (if there is no such
call Samba will emulate in user space). This allows zero-copy writes directly from network
@@ -3003,21 +3679,30 @@ but user testing is recommended. If set to zero Samba processes SMBwriteX calls
normal way. To enable POSIX large write support (SMB/CIFS writes up to 16Mb) this option must be
nonzero. The maximum value is 128k. Values greater than 128k will be silently set to 128k.</p><p>Note this option will have NO EFFECT if set on a SMB signed connection.</p><p>The default is zero, which diables this option.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min receivefile size</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MINWINSTTL"></a>min wins ttl (G)</span></dt><dd><p>This option tells <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>
- when acting as a WINS server (<a class="indexterm" name="id325104"></a>wins support = yes) what the minimum 'time to live'
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573872"></a>
+
+min wins ttl (G)
+</h3></div></div></div><a class="indexterm" name="id2573873"></a><a name="MINWINSTTL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option tells <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>
+ when acting as a WINS server (<a class="link" href="smb.conf.5.html#WINSSUPPORT">wins support = yes</a>) what the minimum 'time to live'
of NetBIOS names that <code class="literal">nmbd</code> will grant will be (in
seconds). You should never need to change this parameter. The default
is 6 hours (21600 seconds).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>min wins ttl</code></em> = <code class="literal">21600</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MSDFSPROXY"></a>msdfs proxy (S)</span></dt><dd><p>This parameter indicates that the share is a
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2573942"></a>
+
+msdfs proxy (S)
+</h3></div></div></div><a class="indexterm" name="id2573944"></a><a name="MSDFSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter indicates that the share is a
stand-in for another CIFS share whose location is specified by
the value of the parameter. When clients attempt to connect to
this share, they are redirected to the proxied share using
the SMB-Dfs protocol.</p><p>Only Dfs roots can act as proxy shares. Take a look at the
- <a class="indexterm" name="id325163"></a>msdfs root and <a class="indexterm" name="id325170"></a>host msdfs
+ <a class="link" href="smb.conf.5.html#MSDFSROOT">msdfs root</a> and <a class="link" href="smb.conf.5.html#HOSTMSDFS">host msdfs</a>
options to find out how to set up a Dfs root share.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>msdfs proxy</code></em> = <code class="literal">\otherserver\someshare</code>
</em></span>
-</p></dd><dt><span class="term"><a name="MSDFSROOT"></a>msdfs root (S)</span></dt><dd><p>If set to <code class="constant">yes</code>, Samba treats the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574021"></a>
+
+msdfs root (S)
+</h3></div></div></div><a class="indexterm" name="id2574022"></a><a name="MSDFSROOT"></a><div class="variablelist"><dl><dt></dt><dd><p>If set to <code class="constant">yes</code>, Samba treats the
share as a Dfs root and allows clients to browse the
distributed file system tree rooted at the share directory.
Dfs links are specified in the share directory by symbolic
@@ -3025,14 +3710,20 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
and so on. For more information on setting up a Dfs tree on
Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>msdfs root</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NAMECACHETIMEOUT"></a>name cache timeout (G)</span></dt><dd><p>Specifies the number of seconds it takes before
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574076"></a>
+
+name cache timeout (G)
+</h3></div></div></div><a class="indexterm" name="id2574077"></a><a name="NAMECACHETIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the number of seconds it takes before
entries in samba's hostname resolve cache time out. If
the timeout is set to 0. the caching is disabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">660</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name cache timeout</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NAMERESOLVEORDER"></a>name resolve order (G)</span></dt><dd><p>This option is used by the programs in the Samba
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574137"></a>
+
+name resolve order (G)
+</h3></div></div></div><a class="indexterm" name="id2574138"></a><a name="NAMERESOLVEORDER"></a><div class="variablelist"><dl><dt></dt><dd><p>This option is used by the programs in the Samba
suite to determine what naming services to use and in what order
to resolve host names to IP addresses. Its main purpose to is to
control how netbios name resolution is performed. The option takes a space
@@ -3050,9 +3741,9 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
useful for active directory domains and results in a DNS query for the SRV RR entry matching
_ldap._tcp.domain.
</p></li><li><p><code class="constant">wins</code> : Query a name with
- the IP address listed in the <a class="indexterm" name="id325382"></a>WINSSERVER parameter. If no WINS server has
+ the IP address listed in the <a class="link" href="smb.conf.5.html#WINSSERVER">WINSSERVER</a> parameter. If no WINS server has
been specified this method will be ignored.</p></li><li><p><code class="constant">bcast</code> : Do a broadcast on
- each of the known local interfaces listed in the <a class="indexterm" name="id325399"></a>interfaces
+ each of the known local interfaces listed in the <a class="link" href="smb.conf.5.html#INTERFACES">interfaces</a>
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.</p></li></ul></div><p>The example below will cause the local lmhosts file to be examined
@@ -3063,7 +3754,10 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>name resolve order</code></em> = <code class="literal">lmhosts bcast host</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NETBIOSALIASES"></a>netbios aliases (G)</span></dt><dd><p>This is a list of NetBIOS names that nmbd will
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574338"></a>
+
+netbios aliases (G)
+</h3></div></div></div><a class="indexterm" name="id2574339"></a><a name="NETBIOSALIASES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of NetBIOS names that nmbd will
advertise as additional names by which the Samba server is known. This allows one machine
to appear in browse lists under multiple names. If a machine is acting as a browse server
or logon server none of these names will be advertised as either browse server or logon
@@ -3073,7 +3767,10 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios aliases</code></em> = <code class="literal">TEST TEST1 TEST2</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NETBIOSNAME"></a>netbios name (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574404"></a>
+
+netbios name (G)
+</h3></div></div></div><a class="indexterm" name="id2574405"></a><a name="NETBIOSNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This sets the NetBIOS name by which a Samba server is known. By default it is the same as the first component
of the host's DNS name. If a machine is a browse server or logon server this name (or the first component of
the hosts DNS name) will be the name that these services are advertised under.
@@ -3086,11 +3783,17 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>netbios name</code></em> = <code class="literal">MYNAME</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NETBIOSSCOPE"></a>netbios scope (G)</span></dt><dd><p>This sets the NetBIOS scope that Samba will
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574486"></a>
+
+netbios scope (G)
+</h3></div></div></div><a class="indexterm" name="id2574487"></a><a name="NETBIOSSCOPE"></a><div class="variablelist"><dl><dt></dt><dd><p>This sets the NetBIOS scope that Samba will
operate under. This should not be set unless every machine
on your LAN also sets this value.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>netbios scope</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="NISHOMEDIR"></a>nis homedir (G)</span></dt><dd><p>Get the home share server from a NIS map. For
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574529"></a>
+
+nis homedir (G)
+</h3></div></div></div><a class="indexterm" name="id2574530"></a><a name="NISHOMEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>Get the home share server from a NIS map. For
UNIX systems that use an automounter, the user's home directory
will often be mounted on a workstation on demand from a remote
server. </p><p>When the Samba logon server is not the actual home directory
@@ -3104,19 +3807,25 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
it will be mounted on the Samba client directly from the directory
server. When Samba is returning the home share to the client, it
will consult the NIS map specified in
- <a class="indexterm" name="id325685"></a>homedir map and return the server
+ <a class="link" href="smb.conf.5.html#HOMEDIRMAP">homedir map</a> and return the server
listed there.</p><p>Note that for this option to work there must be a working
NIS system and the Samba server with this option must also
be a logon server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nis homedir</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NTACLSUPPORT"></a>nt acl support (S)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574609"></a>
+
+nt acl support (S)
+</h3></div></div></div><a class="indexterm" name="id2574610"></a><a name="NTACLSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to map
UNIX permissions into Windows NT access control lists. The UNIX
permissions considered are the the traditional UNIX owner and
group permissions, as well as POSIX ACLs set on any files or
directories. This parameter was formally a global parameter in
releases prior to 2.2.2.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt acl support</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NTLMAUTH"></a>ntlm auth (G)</span></dt><dd><p>This parameter determines whether or not <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574664"></a>
+
+ntlm auth (G)
+</h3></div></div></div><a class="indexterm" name="id2574665"></a><a name="NTLMAUTH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines whether or not <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will attempt to
authenticate users using the NTLM encrypted password response.
If disabled, either the lanman password hash or an NTLMv2 response
will need to be sent by the client.</p><p>If this option, and <code class="literal">lanman
@@ -3124,44 +3833,62 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
permited. Not all clients support NTLMv2, and most will require
special configuration to us it.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>ntlm auth</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NTPIPESUPPORT"></a>nt pipe support (G)</span></dt><dd><p>This boolean parameter controls whether
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow Windows NT
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574728"></a>
+
+nt pipe support (G)
+</h3></div></div></div><a class="indexterm" name="id2574729"></a><a name="NTPIPESUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will allow Windows NT
clients to connect to the NT SMB specific <code class="constant">IPC$</code>
pipes. This is a developer debugging option and can be left
alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt pipe support</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NTSTATUSSUPPORT"></a>nt status support (G)</span></dt><dd><p>This boolean parameter controls whether <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will negotiate NT specific status
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574784"></a>
+
+nt status support (G)
+</h3></div></div></div><a class="indexterm" name="id2574785"></a><a name="NTSTATUSSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will negotiate NT specific status
support with Windows NT/2k/XP clients. This is a developer debugging option and should be left alone.
If this option is set to <code class="constant">no</code> then Samba offers
exactly the same DOS error codes that versions prior to Samba 2.2.3
reported.</p><p>You should not need to ever disable this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>nt status support</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="NULLPASSWORDS"></a>null passwords (G)</span></dt><dd><p>Allow or disallow client access to accounts that have null passwords. </p><p>See also <a href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>null passwords</code></em> = <code class="literal">no</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574845"></a>
+
+null passwords (G)
+</h3></div></div></div><a class="indexterm" name="id2574846"></a><a name="NULLPASSWORDS"></a><div class="variablelist"><dl><dt></dt><dd><p>Allow or disallow client access to accounts that have null passwords. </p><p>See also <a class="citerefentry" href="smbpasswd.5.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(5)</span></a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>null passwords</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="OBEYPAMRESTRICTIONS"></a>obey pam restrictions (G)</span></dt><dd><p>When Samba 3.0 is configured to enable PAM support
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574898"></a>
+
+obey pam restrictions (G)
+</h3></div></div></div><a class="indexterm" name="id2574899"></a><a name="OBEYPAMRESTRICTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>When Samba 3.0 is configured to enable PAM support
(i.e. --with-pam), this parameter will control whether or not Samba
should obey PAM's account and session management directives. The
default behavior is to use PAM for clear text authentication only
and to ignore any account or session management. Note that Samba
- always ignores PAM for authentication in the case of <a class="indexterm" name="id326002"></a>encrypt passwords = yes. The reason
+ always ignores PAM for authentication in the case of <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = yes</a>. The reason
is that PAM modules cannot support the challenge/response
authentication mechanism needed in the presence of SMB password encryption.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>obey pam restrictions</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ONLYUSER"></a>only user (S)</span></dt><dd><p>This is a boolean option that controls whether
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2574962"></a>
+
+only user (S)
+</h3></div></div></div><a class="indexterm" name="id2574963"></a><a name="ONLYUSER"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean option that controls whether
connections with usernames not in the <em class="parameter"><code>user</code></em>
list will be allowed. By default this option is disabled so that a
client can supply a username to be used by the server. Enabling
this parameter will force the server to only use the login
names from the <em class="parameter"><code>user</code></em> list and is only really
- useful in <a class="indexterm" name="id326064"></a>security = share level security.</p><p>Note that this also means Samba won't try to deduce
+ useful in <a class="link" href="smb.conf.5.html#SECURITY">security = share</a> level security.</p><p>Note that this also means Samba won't try to deduce
usernames from the service name. This can be annoying for
the [homes] section. To get around this you could use <code class="literal">user =
%S</code> which means your <em class="parameter"><code>user</code></em> list
will be just the service name, which for home directories is the
name of the user.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>only user</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="OPLOCKBREAKWAITTIME"></a>oplock break wait time (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575051"></a>
+
+oplock break wait time (G)
+</h3></div></div></div><a class="indexterm" name="id2575052"></a><a name="OPLOCKBREAKWAITTIME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a tuning parameter added due to bugs in both Windows 9x and WinNT. If Samba responds to a client too
quickly when that client issues an SMB that can cause an oplock break request, then the network client can
fail and not respond to the break request. This tuning parameter (which is set in milliseconds) is the amount
@@ -3170,11 +3897,14 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock break wait time</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="OPLOCKCONTENTIONLIMIT"></a>oplock contention limit (S)</span></dt><dd><p>
- This is a <span class="emphasis"><em>very</em></span> advanced <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> tuning option to improve the efficiency of the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575106"></a>
+
+oplock contention limit (S)
+</h3></div></div></div><a class="indexterm" name="id2575107"></a><a name="OPLOCKCONTENTIONLIMIT"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This is a <span class="emphasis"><em>very</em></span> advanced <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> tuning option to improve the efficiency of the
granting of oplocks under multiple client contention for the same file.
</p><p>
- In brief it specifies a number, which causes <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>not to grant an oplock even when requested if the
+ In brief it specifies a number, which causes <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>not to grant an oplock even when requested if the
approximate number of clients contending for an oplock on the same file goes over this
limit. This causes <code class="literal">smbd</code> to behave in a similar
way to Windows NT.
@@ -3182,7 +3912,10 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplock contention limit</code></em> = <code class="literal">2</code>
</em></span>
-</p></dd><dt><span class="term"><a name="OPLOCKS"></a>oplocks (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575188"></a>
+
+oplocks (S)
+</h3></div></div></div><a class="indexterm" name="id2575190"></a><a name="OPLOCKS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean option tells <code class="literal">smbd</code> whether to
issue oplocks (opportunistic locks) to file open requests on this
share. The oplock code can dramatically (approx. 30% or more) improve
@@ -3194,14 +3927,17 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
<code class="filename">docs/</code> directory.
</p><p>
Oplocks may be selectively turned off on certain files with a share. See
- the <a class="indexterm" name="id326275"></a>veto oplock files parameter. On some systems
+ the <a class="link" href="smb.conf.5.html#VETOOPLOCKFILES">veto oplock files</a> parameter. On some systems
oplocks are recognized by the underlying operating system. This
allows data synchronization between all access to oplocked files,
whether it be via Samba or NFS or a local UNIX process. See the
- <a class="indexterm" name="id326284"></a>kernel oplocks parameter for details.
+ <a class="link" href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks</a> parameter for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>oplocks</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="OS2DRIVERMAP"></a>os2 driver map (G)</span></dt><dd><p>The parameter is used to define the absolute
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575287"></a>
+
+os2 driver map (G)
+</h3></div></div></div><a class="indexterm" name="id2575288"></a><a name="OS2DRIVERMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>The parameter is used to define the absolute
path to a file containing a mapping of Windows NT printer driver
names to OS/2 printer driver names. The format is:</p><p>&lt;nt driver name&gt; = &lt;os2 driver name&gt;.&lt;device name&gt;</p><p>For example, a valid entry using the HP LaserJet 5
printer driver would appear as <code class="literal">HP LaserJet 5L = LASERJET.HP
@@ -3211,9 +3947,12 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>os2 driver map</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="OSLEVEL"></a>os level (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575354"></a>
+
+os level (G)
+</h3></div></div></div><a class="indexterm" name="id2575355"></a><a name="OSLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This integer value controls what level Samba advertises itself as for browse elections. The value of this
- parameter determines whether <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> has a chance of becoming a local master browser for the <a class="indexterm" name="id326397"></a>workgroup in the local broadcast area.
+ parameter determines whether <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> has a chance of becoming a local master browser for the <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> in the local broadcast area.
</p><p><span class="emphasis"><em>
Note:</em></span> By default, Samba will win a local master browsing election over all Microsoft operating
systems except a Windows NT 4.0/2000 Domain Controller. This means that a misconfigured Samba host can
@@ -3226,22 +3965,31 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>os level</code></em> = <code class="literal">65</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PAMPASSWORDCHANGE"></a>pam password change (G)</span></dt><dd><p>With the addition of better PAM support in Samba 2.2,
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575453"></a>
+
+pam password change (G)
+</h3></div></div></div><a class="indexterm" name="id2575454"></a><a name="PAMPASSWORDCHANGE"></a><div class="variablelist"><dl><dt></dt><dd><p>With the addition of better PAM support in Samba 2.2,
this parameter, it is possible to use PAM's password change control
flag for Samba. If enabled, then PAM will be used for password
changes when requested by an SMB client instead of the program listed in
- <a class="indexterm" name="id326476"></a>passwd program.
+ <a class="link" href="smb.conf.5.html#PASSWDPROGRAM">passwd program</a>.
It should be possible to enable this without changing your
- <a class="indexterm" name="id326484"></a>passwd chat parameter for most setups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pam password change</code></em> = <code class="literal">no</code>
+ <a class="link" href="smb.conf.5.html#PASSWDCHAT">passwd chat</a> parameter for most setups.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pam password change</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PANICACTION"></a>panic action (G)</span></dt><dd><p>This is a Samba developer option that allows a
- system command to be called when either <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> or <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> crashes. This is usually used to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575525"></a>
+
+panic action (G)
+</h3></div></div></div><a class="indexterm" name="id2575526"></a><a name="PANICACTION"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a Samba developer option that allows a
+ system command to be called when either <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> or <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> crashes. This is usually used to
draw attention to the fact that a problem occurred.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>panic action</code></em> = <code class="literal">"/bin/sleep 90000"</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PARANOIDSERVERSECURITY"></a>paranoid server security (G)</span></dt><dd><p>Some version of NT 4.x allow non-guest
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575601"></a>
+
+paranoid server security (G)
+</h3></div></div></div><a class="indexterm" name="id2575602"></a><a name="PARANOIDSERVERSECURITY"></a><div class="variablelist"><dl><dt></dt><dd><p>Some version of NT 4.x allow non-guest
users with a bad passowrd. When this option is enabled, samba will not
use a broken NT 4.x server as password server, but instead complain
to the logs and exit.
@@ -3249,23 +3997,26 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
this check, which involves deliberatly attempting a
bad logon to the remote server.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>paranoid server security</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSDBBACKEND"></a>passdb backend (G)</span></dt><dd><p>This option allows the administrator to chose which backend
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575652"></a>
+
+passdb backend (G)
+</h3></div></div></div><a class="indexterm" name="id2575653"></a><a name="PASSDBBACKEND"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows the administrator to chose which backend
will be used for storing user and possibly group information. This allows
- you to swap between dfferent storage mechanisms without recompile. </p><p>The parameter value is divided into two parts, the backend's name, and a 'location'
+ you to swap between different storage mechanisms without recompile. </p><p>The parameter value is divided into two parts, the backend's name, and a 'location'
string that has meaning only to that particular backed. These are separated
by a : character.</p><p>Available backends can include:
</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">smbpasswd</code> - The default smbpasswd
backend. Takes a path to the smbpasswd file as an optional argument.
</p></li><li><p><code class="literal">tdbsam</code> - The TDB based password storage
backend. Takes a path to the TDB as an optional argument (defaults to passdb.tdb
- in the <a class="indexterm" name="id326681"></a>private dir directory.</p></li><li><p><code class="literal">ldapsam</code> - The LDAP based passdb
+ in the <a class="link" href="smb.conf.5.html#PRIVATEDIR">private dir</a> directory.</p></li><li><p><code class="literal">ldapsam</code> - The LDAP based passdb
backend. Takes an LDAP URL as an optional argument (defaults to
<code class="literal">ldap://localhost</code>)</p><p>LDAP connections should be secured where possible. This may be done using either
- Start-TLS (see <a class="indexterm" name="id326710"></a>ldap ssl) or by
+ Start-TLS (see <a class="link" href="smb.conf.5.html#LDAPSSL">ldap ssl</a>) or by
specifying <em class="parameter"><code>ldaps://</code></em> in
- the URL argument. </p><p>Multiple servers may also be specified in double-quotes, if your
- LDAP libraries supports the LDAP URL notation.
- (OpenLDAP does).
+ the URL argument. </p><p>Multiple servers may also be specified in double-quotes.
+ Whether multiple servers are supported or not and the exact
+ syntax depends on the LDAP library you use.
</p></li></ul></div><p>
</p>
@@ -3273,34 +4024,68 @@ nonzero. The maximum value is 128k. Values greater than 128k will be silently se
<pre class="programlisting">
passdb backend = tdbsam:/etc/samba/private/passdb.tdb
-or
+or multi server LDAP URL with OpenLDAP library:
passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
+
+or multi server LDAP URL with Netscape based LDAP library:
+
+passdb backend = ldapsam:"ldap://ldap-1.example.com ldap-2.example.com"
</pre><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb backend</code></em> = <code class="literal">smbpasswd</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSDBEXPANDEXPLICIT"></a>passdb expand explicit (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575808"></a>
+
+passdb expand explicit (G)
+</h3></div></div></div><a class="indexterm" name="id2575809"></a><a name="PASSDBEXPANDEXPLICIT"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter controls whether Samba substitutes %-macros in the passdb fields if they are explicitly set. We
used to expand macros here, but this turned out to be a bug because the Windows client can expand a variable
%G_osver% in which %G would have been substituted by the user's primary group.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passdb expand explicit</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSWDCHAT"></a>passwd chat (G)</span></dt><dd><p>This string controls the <span class="emphasis"><em>"chat"</em></span>
- conversation that takes places between <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and the local password changing
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575854"></a>
+
+passwd chat debug (G)
+</h3></div></div></div><a class="indexterm" name="id2575855"></a><a name="PASSWDCHATDEBUG"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean specifies if the passwd chat script
+ parameter is run in <span class="emphasis"><em>debug</em></span> mode. In this mode the
+ strings passed to and received from the passwd chat are printed
+ in the <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log with a
+ <a class="link" href="smb.conf.5.html#DEBUGLEVEL">debug level</a>
+ of 100. This is a dangerous option as it will allow plaintext passwords
+ to be seen in the <code class="literal">smbd</code> log. It is available to help
+ Samba admins debug their <em class="parameter"><code>passwd chat</code></em> scripts
+ when calling the <em class="parameter"><code>passwd program</code></em> and should
+ be turned off after this has been done. This option has no effect if the
+ <a class="link" href="smb.conf.5.html#PAMPASSWORDCHANGE">pam password change</a>
+ parameter is set. This parameter is off by default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat debug</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2575957"></a>
+
+passwd chat timeout (G)
+</h3></div></div></div><a class="indexterm" name="id2575958"></a><a name="PASSWDCHATTIMEOUT"></a><div class="variablelist"><dl><dt></dt><dd><p>This integer specifies the number of seconds smbd will wait for an initial
+ answer from a passwd chat script being run. Once the initial answer is received
+ the subsequent answers must be received in one tenth of this time. The default it
+ two seconds.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat timeout</code></em> = <code class="literal">2</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576002"></a>
+
+passwd chat (G)
+</h3></div></div></div><a class="indexterm" name="id2576003"></a><a name="PASSWDCHAT"></a><div class="variablelist"><dl><dt></dt><dd><p>This string controls the <span class="emphasis"><em>"chat"</em></span>
+ conversation that takes places between <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> and the local password changing
program to change the user's password. The string describes a
- sequence of response-receive pairs that <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> uses to determine what to send to the
- <a class="indexterm" name="id326839"></a>passwd program and what to expect back. If the expected output is not
+ sequence of response-receive pairs that <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> uses to determine what to send to the
+ <a class="link" href="smb.conf.5.html#PASSWDPROGRAM">passwd program</a> and what to expect back. If the expected output is not
received then the password is not changed.</p><p>This chat sequence is often quite site specific, depending
on what local methods are used for password control (such as NIS
- etc).</p><p>Note that this parameter only is only used if the <a class="indexterm" name="id326855"></a>unix password sync parameter is set to <code class="constant">yes</code>. This sequence is
+ etc).</p><p>Note that this parameter only is only used if the <a class="link" href="smb.conf.5.html#UNIXPASSWORDSYNC">unix password sync</a> parameter is set to <code class="constant">yes</code>. This sequence is
then called <span class="emphasis"><em>AS ROOT</em></span> when the SMB password in the
smbpasswd file is being changed, without access to the old password
cleartext. This means that root must be able to reset the user's password without
knowing the text of the previous password. In the presence of
- NIS/YP, this means that the <a class="indexterm" name="id326872"></a>passwd program must
+ NIS/YP, this means that the <a class="link" href="smb.conf.5.html#PASSWDPROGRAM">passwd program</a> must
be executed on the NIS master.
</p><p>The string can contain the macro <em class="parameter"><code>%n</code></em> which is substituted
for the new password. The old passsword (<em class="parameter"><code>%o</code></em>) is only available when
- <a class="indexterm" name="id326895"></a>encrypt passwords has been disabled.
+ <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</a> has been disabled.
The chat sequence can also contain the standard macros
\n, \r, \t and \s to give line-feed, carriage-return, tab
and space. The chat sequence string can also contain
@@ -3308,32 +4093,17 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
be used to collect strings with spaces in them into a single
string.</p><p>If the send string in any part of the chat sequence is a full
stop ".", then no string is sent. Similarly, if the
- expect string is a full stop then no string is expected.</p><p>If the <a class="indexterm" name="id326913"></a>pam password change parameter is set to <code class="constant">yes</code>, the
+ expect string is a full stop then no string is expected.</p><p>If the <a class="link" href="smb.conf.5.html#PAMPASSWORDCHANGE">pam password change</a> parameter is set to <code class="constant">yes</code>, the
chat pairs may be matched in any order, and success is determined by the PAM result, not any particular
output. The \n macro is ignored for PAM conversions.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">*new*password* %n\n*new*password* %n\n *changed*</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd chat</code></em> = <code class="literal">"*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSWDCHATDEBUG"></a>passwd chat debug (G)</span></dt><dd><p>This boolean specifies if the passwd chat script
- parameter is run in <span class="emphasis"><em>debug</em></span> mode. In this mode the
- strings passed to and received from the passwd chat are printed
- in the <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> log with a
- <a class="indexterm" name="id326995"></a>debug level
- of 100. This is a dangerous option as it will allow plaintext passwords
- to be seen in the <code class="literal">smbd</code> log. It is available to help
- Samba admins debug their <em class="parameter"><code>passwd chat</code></em> scripts
- when calling the <em class="parameter"><code>passwd program</code></em> and should
- be turned off after this has been done. This option has no effect if the
- <a class="indexterm" name="id327022"></a>pam password change
- parameter is set. This parameter is off by default.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat debug</code></em> = <code class="literal">no</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="PASSWDCHATTIMEOUT"></a>passwd chat timeout (G)</span></dt><dd><p>This integer specifies the number of seconds smbd will wait for an initial
- answer from a passwd chat script being run. Once the initial answer is received
- the subsequent answers must be received in one tenth of this time. The default it
- two seconds.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>passwd chat timeout</code></em> = <code class="literal">2</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="PASSWDPROGRAM"></a>passwd program (G)</span></dt><dd><p>The name of a program that can be used to set
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576207"></a>
+
+passwd program (G)
+</h3></div></div></div><a class="indexterm" name="id2576208"></a><a name="PASSWDPROGRAM"></a><div class="variablelist"><dl><dt></dt><dd><p>The name of a program that can be used to set
UNIX user passwords. Any occurrences of <em class="parameter"><code>%u</code></em>
will be replaced with the user name. The user name is checked for
existence before calling the password changing program.</p><p>Also note that many passwd programs insist in <span class="emphasis"><em>reasonable
@@ -3354,7 +4124,10 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>passwd program</code></em> = <code class="literal">/bin/passwd %u</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSWORDLEVEL"></a>password level (G)</span></dt><dd><p>Some client/server combinations have difficulty
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576342"></a>
+
+password level (G)
+</h3></div></div></div><a class="indexterm" name="id2576343"></a><a name="PASSWORDLEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>Some client/server combinations have difficulty
with mixed-case passwords. One offending client is Windows for
Workgroups, which for some reason forces passwords to upper
case when using the LANMAN1 protocol, but leaves them alone when
@@ -3372,11 +4145,14 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
process a new connection.</p><p>A value of zero will cause only two attempts to be
made - the password as is and the password in all-lower case.</p><p>This parameter is used only when using plain-text passwords. It is
not at all used when encrypted passwords as in use (that is the default
- since samba-3.0.0). Use this only when <a class="indexterm" name="id327287"></a>encrypt passwords = No.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">0</code>
+ since samba-3.0.0). Use this only when <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = No</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password level</code></em> = <code class="literal">4</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PASSWORDSERVER"></a>password server (G)</span></dt><dd><p>By specifying the name of another SMB server
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576479"></a>
+
+password server (G)
+</h3></div></div></div><a class="indexterm" name="id2576480"></a><a name="PASSWORDSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>By specifying the name of another SMB server
or Active Directory domain controller with this option,
and using <code class="literal">security = [ads|domain|server]</code>
it is possible to get Samba to
@@ -3388,7 +4164,7 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
Samba will use the standard LDAP port of tcp/389. Note that port numbers
have no effect on password servers for Windows NT 4.0 domains or netbios
connections.</p><p>If parameter is a name, it is looked up using the
- parameter <a class="indexterm" name="id327369"></a>name resolve order and so may resolved
+ parameter <a class="link" href="smb.conf.5.html#NAMERESOLVEORDER">name resolve order</a> and so may resolved
by any method and order described in that parameter.</p><p>The password server must be a machine capable of using
the "LM1.2X002" or the "NT LM 0.12" protocol, and it must be in
user level security mode.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Using a password server means your UNIX box (running
@@ -3438,7 +4214,10 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>password server</code></em> = <code class="literal">*</code>
</em></span>
-</p></dd><dt><span class="term"><a name="DIRECTORY"></a>directory</span></dt><dd><p>This parameter is a synonym for path.</p></dd><dt><span class="term"><a name="PATH"></a>path (S)</span></dt><dd><p>This parameter specifies a directory to which
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576802"></a><a name="DIRECTORY"></a>directory</h3></div></div></div><a class="indexterm" name="id2576803"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PATH">path</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576832"></a>
+
+path (S)
+</h3></div></div></div><a class="indexterm" name="id2576833"></a><a name="PATH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a directory to which
the user of the service is to be given access. In the case of
printable services, this is where print data will spool prior to
being submitted to the host for printing.</p><p>For a printable service offering guest access, the service
@@ -3450,26 +4229,35 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
on this connection. Any occurrences of <em class="parameter"><code>%m</code></em>
will be replaced by the NetBIOS name of the machine they are
connecting from. These replacements are very useful for setting
- up pseudo home directories for users.</p><p>Note that this path will be based on <a class="indexterm" name="id327672"></a>root dir
+ up pseudo home directories for users.</p><p>Note that this path will be based on <a class="link" href="smb.conf.5.html#ROOTDIR">root dir</a>
if one was specified.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>path</code></em> = <code class="literal">/home/fred</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PIDDIRECTORY"></a>pid directory (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576936"></a>
+
+pid directory (G)
+</h3></div></div></div><a class="indexterm" name="id2576937"></a><a name="PIDDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option specifies the directory where pid files will be placed.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">${prefix}/var/locks</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>pid directory</code></em> = <code class="literal">pid directory = /var/run/</code>
</em></span>
-</p></dd><dt><span class="term"><a name="POSIXLOCKING"></a>posix locking (S)</span></dt><dd><p>
- The <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2576996"></a>
+
+posix locking (S)
+</h3></div></div></div><a class="indexterm" name="id2576997"></a><a name="POSIXLOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ The <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>
daemon maintains an database of file locks obtained by SMB clients. The default behavior is
to map this internal database to POSIX locks. This means that file locks obtained by SMB clients are
consistent with those seen by POSIX compliant applications accessing the files via a non-SMB
method (e.g. NFS or local file access). You should never need to disable this parameter.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>posix locking</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="POSTEXEC"></a>postexec (S)</span></dt><dd><p>This option specifies a command to be run
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577051"></a>
+
+postexec (S)
+</h3></div></div></div><a class="indexterm" name="id2577052"></a><a name="POSTEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies a command to be run
whenever the service is disconnected. It takes the usual
substitutions. The command may be run as the root on some
systems.</p><p>An interesting example may be to unmount server
@@ -3477,29 +4265,38 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>postexec</code></em> = <code class="literal">echo \"%u disconnected from %S from %m (%I)\" &gt;&gt; /tmp/log</code>
</em></span>
-</p></dd><dt><span class="term"><a name="EXEC"></a>exec</span></dt><dd><p>This parameter is a synonym for preexec.</p></dd><dt><span class="term"><a name="PREEXEC"></a>preexec (S)</span></dt><dd><p>This option specifies a command to be run whenever
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577124"></a>
+
+preexec close (S)
+</h3></div></div></div><a class="indexterm" name="id2577125"></a><a name="PREEXECCLOSE"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This boolean option controls whether a non-zero return code from <a class="link" href="smb.conf.5.html#PREEXEC">preexec</a>
+ should close the service being connected to.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec close</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577178"></a><a name="EXEC"></a>exec</h3></div></div></div><a class="indexterm" name="id2577179"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PREEXEC">preexec</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577208"></a>
+
+preexec (S)
+</h3></div></div></div><a class="indexterm" name="id2577209"></a><a name="PREEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies a command to be run whenever
the service is connected to. It takes the usual substitutions.</p><p>An interesting example is to send the users a welcome
message every time they log in. Maybe a message of the day? Here
is an example:</p><p>
<code class="literal">preexec = csh -c 'echo \"Welcome to %S!\" |
/usr/local/samba/bin/smbclient -M %m -I %I' &amp; </code>
</p><p>Of course, this could get annoying after a while :-)</p><p>
- See also <a class="indexterm" name="id327950"></a>preexec close and <a class="indexterm" name="id327957"></a>postexec.
+ See also <a class="link" href="smb.conf.5.html#PREEXECCLOSE">preexec close</a> and <a class="link" href="smb.conf.5.html#POSTEXEC">postexec</a>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preexec</code></em> = <code class="literal">echo \"%u connected to %S from %m (%I)\" &gt;&gt; /tmp/log</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PREEXECCLOSE"></a>preexec close (S)</span></dt><dd><p>
- This boolean option controls whether a non-zero return code from <a class="indexterm" name="id328019"></a>preexec
- should close the service being connected to.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preexec close</code></em> = <code class="literal">no</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="PREFEREDMASTER"></a>prefered master</span></dt><dd><p>This parameter is a synonym for preferred master.</p></dd><dt><span class="term"><a name="PREFERREDMASTER"></a>preferred master (G)</span></dt><dd><p>
- This boolean parameter controls if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> is a preferred master browser for its workgroup.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577316"></a><a name="PREFEREDMASTER"></a>prefered master</h3></div></div></div><a class="indexterm" name="id2577318"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PREFERREDMASTER">preferred master</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577348"></a>
+
+preferred master (G)
+</h3></div></div></div><a class="indexterm" name="id2577350"></a><a name="PREFERREDMASTER"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This boolean parameter controls if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> is a preferred master browser for its workgroup.
</p><p>
If this is set to <code class="constant">yes</code>, on startup, <code class="literal">nmbd</code> will force
an election, and it will have a slight advantage in winning the election. It is recommended that this
- parameter is used in conjunction with <a class="indexterm" name="id328108"></a>domain master = yes, so that
+ parameter is used in conjunction with <a class="link" href="smb.conf.5.html#DOMAINMASTER">domain master = yes</a>, so that
<code class="literal">nmbd</code> can guarantee becoming a domain master.
</p><p>
Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT)
@@ -3508,38 +4305,53 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
capabilities.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preferred master</code></em> = <code class="literal">auto</code>
</em></span>
-</p></dd><dt><span class="term"><a name="AUTOSERVICES"></a>auto services</span></dt><dd><p>This parameter is a synonym for preload.</p></dd><dt><span class="term"><a name="PRELOAD"></a>preload (G)</span></dt><dd><p>This is a list of services that you want to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577441"></a>
+
+preload modules (G)
+</h3></div></div></div><a class="indexterm" name="id2577442"></a><a name="PRELOADMODULES"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of paths to modules that should
+ be loaded into smbd before a client connects. This improves
+ the speed of smbd when reacting to new connections somewhat. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal"></code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal">/usr/lib/samba/passdb/mysql.so</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577502"></a><a name="AUTOSERVICES"></a>auto services</h3></div></div></div><a class="indexterm" name="id2577503"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRELOAD">preload</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577534"></a>
+
+preload (G)
+</h3></div></div></div><a class="indexterm" name="id2577535"></a><a name="PRELOAD"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a list of services that you want to be
automatically added to the browse lists. This is most useful
for homes and printers services that would otherwise not be
visible.</p><p>
Note that if you just want all printers in your
- printcap file loaded then the <a class="indexterm" name="id328193"></a>load printers
+ printcap file loaded then the <a class="link" href="smb.conf.5.html#LOADPRINTERS">load printers</a>
option is easier.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload</code></em> = <code class="literal">fred lp colorlp</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRELOADMODULES"></a>preload modules (G)</span></dt><dd><p>This is a list of paths to modules that should
- be loaded into smbd before a client connects. This improves
- the speed of smbd when reacting to new connections somewhat. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal"></code>
-</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>preload modules</code></em> = <code class="literal">/usr/lib/samba/passdb/mysql.so</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="PRESERVECASE"></a>preserve case (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577612"></a>
+
+preserve case (S)
+</h3></div></div></div><a class="indexterm" name="id2577613"></a><a name="PRESERVECASE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls if new filenames are created with the case that the client passes, or if
- they are forced to be the <a class="indexterm" name="id328311"></a>default case.
+ they are forced to be the <a class="link" href="smb.conf.5.html#DEFAULTCASE">default case</a>.
</p><p>
- See the section on <a href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a> for a fuller discussion.
+ See the section on <a class="link" href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a> for a fuller discussion.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>preserve case</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTOK"></a>print ok</span></dt><dd><p>This parameter is a synonym for printable.</p></dd><dt><span class="term"><a name="PRINTABLE"></a>printable (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code>, then
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577678"></a><a name="PRINTOK"></a>print ok</h3></div></div></div><a class="indexterm" name="id2577679"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTABLE">printable</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577708"></a>
+
+printable (S)
+</h3></div></div></div><a class="indexterm" name="id2577709"></a><a name="PRINTABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code>, then
clients may open, write to and submit spool files on the directory
specified for the service. </p><p>Note that a printable service will ALWAYS allow writing
to the service path (user privileges permitting) via the spooling
- of print data. The <a class="indexterm" name="id328500"></a>read only parameter controls only non-printing access to
+ of print data. The <a class="link" href="smb.conf.5.html#READONLY">read only</a> parameter controls only non-printing access to
the resource.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printable</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTCAPCACHETIME"></a>printcap cache time (G)</span></dt><dd><p>This option specifies the number of seconds before the printing
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577771"></a>
+
+printcap cache time (G)
+</h3></div></div></div><a class="indexterm" name="id2577772"></a><a name="PRINTCAPCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the number of seconds before the printing
subsystem is again asked for the known printers. If the value
is greater than 60 the initial waiting time is set to 60 seconds
to allow an earlier first rescan of the printing subsystem.
@@ -3549,12 +4361,15 @@ passdb backend = ldapsam:"ldap://ldap-1.example.com ldap://ldap-2.example.com"
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap cache time</code></em> = <code class="literal">600</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTCAP"></a>printcap</span></dt><dd><p>This parameter is a synonym for printcap name.</p></dd><dt><span class="term"><a name="PRINTCAPNAME"></a>printcap name (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577839"></a><a name="PRINTCAP"></a>printcap</h3></div></div></div><a class="indexterm" name="id2577840"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTCAPNAME">printcap name</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2577871"></a>
+
+printcap name (S)
+</h3></div></div></div><a class="indexterm" name="id2577872"></a><a name="PRINTCAPNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter may be used to override the compiled-in default printcap name used by the server (usually
- <code class="filename"> /etc/printcap</code>). See the discussion of the <a href="#PRINTERSSECT" title="The [printers] section">[printers]</a> section above for reasons why you might want to do this.
+ <code class="filename"> /etc/printcap</code>). See the discussion of the <a class="link" href="#PRINTERSSECT" title="The [printers] section">[printers]</a> section above for reasons why you might want to do this.
</p><p>
To use the CUPS printing interface set <code class="literal">printcap name = cups </code>. This should
- be supplemented by an addtional setting <a class="indexterm" name="id328654"></a>printing = cups in the [global]
+ be supplemented by an addtional setting <a class="link" href="smb.conf.5.html#PRINTING">printing = cups</a> in the [global]
section. <code class="literal">printcap name = cups</code> will use the "dummy" printcap
created by CUPS, as specified in your CUPS configuration file.
</p><p>
@@ -3584,7 +4399,10 @@ print5|My Printer 5
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printcap name</code></em> = <code class="literal">/etc/myprintcap</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTCOMMAND"></a>print command (S)</span></dt><dd><p>After a print job has finished spooling to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578055"></a>
+
+print command (S)
+</h3></div></div></div><a class="indexterm" name="id2578056"></a><a name="PRINTCOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>After a print job has finished spooling to
a service, this command will be used via a <code class="literal">system()</code>
call to process the spool file. Typically the command specified will
submit the spool file to the host's printing subsystem, but there
@@ -3607,17 +4425,17 @@ print5|My Printer 5
printable service nor a global print command, spool files will
be created but not processed and (most importantly) not removed.</p><p>Note that printing may fail on some UNIXes from the
<code class="constant">nobody</code> account. If this happens then create
- an alternative guest account that can print and set the <a class="indexterm" name="id328877"></a>guest account
+ an alternative guest account that can print and set the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>
in the [global] section.</p><p>You can form quite complex print commands by realizing
that they are just passed to a shell. For example the following
will log a print job, print the file, then remove it. Note that
';' is the usual separator for command in shell scripts.</p><p><code class="literal">print command = echo Printing %s &gt;&gt;
/tmp/print.log; lpr -P %p %s; rm %s</code></p><p>You may have to vary this command considerably depending
on how you normally print files on your system. The default for
- the parameter varies depending on the setting of the <a class="indexterm" name="id328903"></a>printing
+ the parameter varies depending on the setting of the <a class="link" href="smb.conf.5.html#PRINTING">printing</a>
parameter.</p><p>Default: For <code class="literal">printing = BSD, AIX, QNX, LPRNG
or PLP :</code></p><p><code class="literal">print command = lpr -r -P%p %s</code></p><p>For <code class="literal">printing = SYSV or HPUX :</code></p><p><code class="literal">print command = lp -c -d%p %s; rm %s</code></p><p>For <code class="literal">printing = SOFTQ :</code></p><p><code class="literal">print command = lp -d%p -s %s; rm %s</code></p><p>For printing = CUPS : If SAMBA is compiled against
- libcups, then <a class="indexterm" name="id328959"></a>printcap = cups
+ libcups, then <a class="link" href="smb.conf.5.html#PRINTCAP">printcap = cups</a>
uses the CUPS API to
submit jobs, etc. Otherwise it maps to the System V
commands with the -oraw option for printing, i.e. it
@@ -3626,7 +4444,10 @@ print5|My Printer 5
and if SAMBA is compiled against libcups, any manually
set print command will be ignored.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>print command</code></em> = <code class="literal">/usr/local/samba/bin/myprintscript %p %s</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTERADMIN"></a>printer admin (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578325"></a>
+
+printer admin (S)
+</h3></div></div></div><a class="indexterm" name="id2578326"></a><a name="PRINTERADMIN"></a><div class="variablelist"><dl><dt></dt><dd><p>
This lists users who can do anything to printers
via the remote administration interfaces offered
by MS-RPC (usually using a NT workstation).
@@ -3642,20 +4463,26 @@ print5|My Printer 5
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer admin</code></em> = <code class="literal">admin, @staff</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTER"></a>printer</span></dt><dd><p>This parameter is a synonym for printer name.</p></dd><dt><span class="term"><a name="PRINTERNAME"></a>printer name (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578395"></a><a name="PRINTER"></a>printer</h3></div></div></div><a class="indexterm" name="id2578396"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#PRINTERNAME">printer name</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578425"></a>
+
+printer name (S)
+</h3></div></div></div><a class="indexterm" name="id2578426"></a><a name="PRINTERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter specifies the name of the printer to which print jobs spooled through a printable service
will be sent.
</p><p>
If specified in the [global] section, the printer name given will be used for any printable service that
does not have its own printer name specified.
</p><p>
- The default value of the <a class="indexterm" name="id329116"></a>printer name may be <code class="literal">lp</code> on many
+ The default value of the <a class="link" href="smb.conf.5.html#PRINTERNAME">printer name</a> may be <code class="literal">lp</code> on many
systems.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">none</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printer name</code></em> = <code class="literal">laserwriter</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRINTING"></a>printing (S)</span></dt><dd><p>This parameters controls how printer status information is
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578512"></a>
+
+printing (S)
+</h3></div></div></div><a class="indexterm" name="id2578514"></a><a name="PRINTING"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameters controls how printer status information is
interpreted on your system. It also affects the default values for
the <em class="parameter"><code>print command</code></em>, <em class="parameter"><code>lpq command</code></em>, <em class="parameter"><code>lppause command </code></em>, <em class="parameter"><code>lpresume command</code></em>, and <em class="parameter"><code>lprm command</code></em> if specified in the
[global] section.</p><p>Currently nine printing styles are supported. They are
@@ -3664,23 +4491,32 @@ print5|My Printer 5
<code class="constant">SYSV</code>, <code class="constant">HPUX</code>,
<code class="constant">QNX</code>, <code class="constant">SOFTQ</code>,
and <code class="constant">CUPS</code>.</p><p>To see what the defaults are for the other print
- commands when using the various options use the <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> program.</p><p>This option can be set on a per printer basis. Please be
+ commands when using the various options use the <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a> program.</p><p>This option can be set on a per printer basis. Please be
aware however, that you must place any of the various printing
commands (e.g. print command, lpq command, etc...) after defining
the value for the <em class="parameter"><code>printing</code></em> option since it will
- reset the printing commands to default values.</p><p>See also the discussion in the <a href="#PRINTERSSECT" title="The [printers] section">
- [printers]</a> section.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="PRINTJOBUSERNAME"></a>printjob username (S)</span></dt><dd><p>This parameter specifies which user information will be
+ reset the printing commands to default values.</p><p>See also the discussion in the <a class="link" href="#PRINTERSSECT" title="The [printers] section">
+ [printers]</a> section.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578648"></a>
+
+printjob username (S)
+</h3></div></div></div><a class="indexterm" name="id2578649"></a><a name="PRINTJOBUSERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies which user information will be
passed to the printing system. Usually, the username is sent,
but in some cases, e.g. the domain prefix is useful, too.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%U</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>printjob username</code></em> = <code class="literal">%D\%U</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PRIVATEDIR"></a>private dir (G)</span></dt><dd><p>This parameters defines the directory
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578709"></a>
+
+private dir (G)
+</h3></div></div></div><a class="indexterm" name="id2578710"></a><a name="PRIVATEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameters defines the directory
smbd will use for storing such files as <code class="filename">smbpasswd</code>
and <code class="filename">secrets.tdb</code>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>private dir</code></em> = <code class="literal">${prefix}/private</code>
</em></span>
-</p></dd><dt><span class="term"><a name="PROFILEACLS"></a>profile acls (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578763"></a>
+
+profile acls (S)
+</h3></div></div></div><a class="indexterm" name="id2578764"></a><a name="PROFILEACLS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter was added to fix the problems that people have been
having with storing user profiles on Samba shares from Windows 2000 or
Windows XP clients. New versions of Windows 2000 or Windows XP service
@@ -3708,7 +4544,10 @@ print5|My Printer 5
tree to the owning user.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>profile acls</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="QUEUEPAUSECOMMAND"></a>queuepause command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578836"></a>
+
+queuepause command (S)
+</h3></div></div></div><a class="indexterm" name="id2578837"></a><a name="QUEUEPAUSECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to pause the printer queue.</p><p>This command should be a program or script which takes
a printer name as its only parameter and stops the printer queue,
such that no longer jobs are submitted to the printer.</p><p>This command is not supported by Windows for Workgroups,
@@ -3719,10 +4558,13 @@ print5|My Printer 5
path in the command as the PATH may not be available to the
server.</p><p><span class="emphasis"><em>No default</em></span></p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queuepause command</code></em> = <code class="literal">disable %p</code>
</em></span>
-</p></dd><dt><span class="term"><a name="QUEUERESUMECOMMAND"></a>queueresume command (S)</span></dt><dd><p>This parameter specifies the command to be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2578912"></a>
+
+queueresume command (S)
+</h3></div></div></div><a class="indexterm" name="id2578913"></a><a name="QUEUERESUMECOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the command to be
executed on the server host in order to resume the printer queue. It
is the command to undo the behavior that is caused by the
- previous parameter (<a class="indexterm" name="id329545"></a>queuepause command).</p><p>This command should be a program or script which takes
+ previous parameter (<a class="link" href="smb.conf.5.html#QUEUEPAUSECOMMAND">queuepause command</a>).</p><p>This command should be a program or script which takes
a printer name as its only parameter and resumes the printer queue,
such that queued jobs are resubmitted to the printer.</p><p>This command is not supported by Windows for Workgroups,
but can be issued from the Printers window under Windows 95
@@ -3734,23 +4576,32 @@ print5|My Printer 5
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>queueresume command</code></em> = <code class="literal">enable %p</code>
</em></span>
-</p></dd><dt><span class="term"><a name="READLIST"></a>read list (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579014"></a>
+
+read list (S)
+</h3></div></div></div><a class="indexterm" name="id2579015"></a><a name="READLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that are given read-only access to a service. If the connecting user is in this list
- then they will not be given write access, no matter what the <a class="indexterm" name="id329631"></a>read only option is set
- to. The list can include group names using the syntax described in the <a class="indexterm" name="id329639"></a>invalid users
+ then they will not be given write access, no matter what the <a class="link" href="smb.conf.5.html#READONLY">read only</a> option is set
+ to. The list can include group names using the syntax described in the <a class="link" href="smb.conf.5.html#INVALIDUSERS">invalid users</a>
parameter.
- </p><p>This parameter will not work with the <a class="indexterm" name="id329650"></a>security = share in
+ </p><p>This parameter will not work with the <a class="link" href="smb.conf.5.html#SECURITY">security = share</a> in
Samba 3.0. This is by design.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>read list</code></em> = <code class="literal">mary, @students</code>
</em></span>
-</p></dd><dt><span class="term"><a name="READONLY"></a>read only (S)</span></dt><dd><p>An inverted synonym is <a class="indexterm" name="id329711"></a>writeable.</p><p>If this parameter is <code class="constant">yes</code>, then users
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579114"></a>
+
+read only (S)
+</h3></div></div></div><a class="indexterm" name="id2579115"></a><a name="READONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>An inverted synonym is <a class="link" href="smb.conf.5.html#WRITEABLE">writeable</a>.</p><p>If this parameter is <code class="constant">yes</code>, then users
of a service may not create or modify files in the service's
directory.</p><p>Note that a printable service (<code class="literal">printable = yes</code>)
will <span class="emphasis"><em>ALWAYS</em></span> allow writing to the directory
(user privileges permitting), but only via spooling operations.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read only</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="READRAW"></a>read raw (G)</span></dt><dd><p>This parameter controls whether or not the server
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579190"></a>
+
+read raw (G)
+</h3></div></div></div><a class="indexterm" name="id2579192"></a><a name="READRAW"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not the server
will support the raw read SMB requests when transferring data
to clients.</p><p>If enabled, raw reads allow reads of 65535 bytes in
one packet. This typically provides a major performance benefit.
@@ -3759,14 +4610,20 @@ print5|My Printer 5
sizes, and for these clients you may need to disable raw reads.</p><p>In general this parameter should be viewed as a system tuning
tool and left severely alone.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>read raw</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="REALM"></a>realm (G)</span></dt><dd><p>This option specifies the kerberos realm to use. The realm is
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579251"></a>
+
+realm (G)
+</h3></div></div></div><a class="indexterm" name="id2579252"></a><a name="REALM"></a><div class="variablelist"><dl><dt></dt><dd><p>This option specifies the kerberos realm to use. The realm is
used as the ADS equivalent of the NT4 <code class="literal">domain</code>. It
is usually set to the DNS name of the kerberos server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>realm</code></em> = <code class="literal">mysambabox.mycompany.com</code>
</em></span>
-</p></dd><dt><span class="term"><a name="REGISTRYSHARES"></a>registry shares (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579316"></a>
+
+registry shares (G)
+</h3></div></div></div><a class="indexterm" name="id2579317"></a><a name="REGISTRYSHARES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This turns on or off support for share definitions read from
registry. Shares defined in <span class="emphasis"><em>smb.conf</em></span> take
precedence over shares with the same name defined in
@@ -3775,14 +4632,17 @@ print5|My Printer 5
</p><p>
Note that this parameter defaults to <span class="emphasis"><em>no</em></span>,
but it is set to <span class="emphasis"><em>yes</em></span> when
- <em class="parameter"><code>config bakend</code></em> is set
+ <em class="parameter"><code>config backend</code></em> is set
to <span class="emphasis"><em>registry</em></span>.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">no</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>registry shares</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="REMOTEANNOUNCE"></a>remote announce (G)</span></dt><dd><p>
- This option allows you to setup <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>to periodically announce itself
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579402"></a>
+
+remote announce (G)
+</h3></div></div></div><a class="indexterm" name="id2579403"></a><a name="REMOTEANNOUNCE"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This option allows you to setup <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>to periodically announce itself
to arbitrary IP addresses with an arbitrary workgroup name.
</p><p>
This is useful if you want your Samba server to appear in a remote workgroup for
@@ -3795,7 +4655,7 @@ print5|My Printer 5
</pre><p>
the above line would cause <code class="literal">nmbd</code> to announce itself
to the two given IP addresses using the given workgroup names. If you leave out the
- workgroup name then the one given in the <a class="indexterm" name="id330010"></a>workgroup parameter
+ workgroup name then the one given in the <a class="link" href="smb.conf.5.html#WORKGROUP">workgroup</a> parameter
is used instead.
</p><p>
The IP addresses you choose would normally be the broadcast addresses of the remote
@@ -3805,8 +4665,11 @@ print5|My Printer 5
See the chapter on Network Browsing in the Samba-HOWTO book.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote announce</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="REMOTEBROWSESYNC"></a>remote browse sync (G)</span></dt><dd><p>
- This option allows you to setup <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to periodically request
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579507"></a>
+
+remote browse sync (G)
+</h3></div></div></div><a class="indexterm" name="id2579508"></a><a name="REMOTEBROWSESYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This option allows you to setup <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> to periodically request
synchronization of browse lists with the master browser of a Samba
server that is on a remote segment. This option will allow you to
gain browse lists for multiple workgroups across routed networks. This
@@ -3832,13 +4695,16 @@ print5|My Printer 5
that the remote machine is available, is listening, nor that it
is in fact the browse master on its segment.
</p><p>
- The <a class="indexterm" name="id330111"></a>remote browse sync may be used on networks
+ The <a class="link" href="smb.conf.5.html#REMOTEBROWSESYNC">remote browse sync</a> may be used on networks
where there is no WINS server, and may be used on disjoint networks where
each network has its own WINS server.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>remote browse sync</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="RENAMEUSERSCRIPT"></a>rename user script (G)</span></dt><dd><p>
- This is the full pathname to a script that will be run as root by <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> under special circumstances described below.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579619"></a>
+
+rename user script (G)
+</h3></div></div></div><a class="indexterm" name="id2579620"></a><a name="RENAMEUSERSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This is the full pathname to a script that will be run as root by <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> under special circumstances described below.
</p><p>
When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager
for Domains), this script will be run to rename the POSIX user. Two variables, <code class="literal">%uold</code> and
@@ -3855,7 +4721,10 @@ print5|My Printer 5
needs to change for other applications using the same directory.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>rename user script</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="RESETONZEROVC"></a>reset on zero vc (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579709"></a>
+
+reset on zero vc (G)
+</h3></div></div></div><a class="indexterm" name="id2579710"></a><a name="RESETONZEROVC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean option controls whether an incoming session setup
should kill other connections coming from the same IP. This matches
the default Windows 2003 behaviour.
@@ -3874,7 +4743,10 @@ print5|My Printer 5
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>reset on zero vc</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="RESTRICTANONYMOUS"></a>restrict anonymous (G)</span></dt><dd><p>The setting of this parameter determines whether user and
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579762"></a>
+
+restrict anonymous (G)
+</h3></div></div></div><a class="indexterm" name="id2579763"></a><a name="RESTRICTANONYMOUS"></a><div class="variablelist"><dl><dt></dt><dd><p>The setting of this parameter determines whether user and
group list information is returned for an anonymous connection.
and mirrors the effects of the
</p><pre class="programlisting">
@@ -3894,17 +4766,20 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
means.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
The security advantage of using restrict anonymous = 2 is removed
- by setting <a class="indexterm" name="id330306"></a>guest ok = yes on any share.
+ by setting <a class="link" href="smb.conf.5.html#GUESTOK">guest ok = yes</a> on any share.
</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>restrict anonymous</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ROOT"></a>root</span></dt><dd><p>This parameter is a synonym for root directory.</p></dd><dt><span class="term"><a name="ROOTDIR"></a>root dir</span></dt><dd><p>This parameter is a synonym for root directory.</p></dd><dt><span class="term"><a name="ROOTDIRECTORY"></a>root directory (G)</span></dt><dd><p>The server will <code class="literal">chroot()</code> (i.e.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579846"></a><a name="ROOT"></a>root</h3></div></div></div><a class="indexterm" name="id2579847"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#ROOTDIRECTORY">root directory</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579878"></a><a name="ROOTDIR"></a>root dir</h3></div></div></div><a class="indexterm" name="id2579879"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#ROOTDIRECTORY">root directory</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2579909"></a>
+
+root directory (G)
+</h3></div></div></div><a class="indexterm" name="id2579910"></a><a name="ROOTDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>The server will <code class="literal">chroot()</code> (i.e.
Change its root directory) to this directory on startup. This is
not strictly necessary for secure operation. Even without it the
server will deny access to files not in one of the service entries.
It may also check for, and deny access to, soft links to other
parts of the filesystem, or attempts to use ".." in file names
to access other directories (depending on the setting of the
- <a class="indexterm" name="id330408"></a>wide smbconfoptions parameter).
+ <a class="link" href="smb.conf.5.html#WIDESMBCONFOPTIONS">wide smbconfoptions</a> parameter).
</p><p>Adding a <em class="parameter"><code>root directory</code></em> entry other
than "/" adds an extra level of security, but at a price. It
absolutely ensures that no access is given to files not in the
@@ -3920,25 +4795,59 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>root directory</code></em> = <code class="literal">/homes/smb</code>
</em></span>
-</p></dd><dt><span class="term"><a name="ROOTPOSTEXEC"></a>root postexec (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2580033"></a>
+
+root postexec (S)
+</h3></div></div></div><a class="indexterm" name="id2580034"></a><a name="ROOTPOSTEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the same as the <em class="parameter"><code>postexec</code></em>
parameter except that the command is run as root. This is useful for
unmounting filesystems (such as CDROMs) after a connection is closed.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root postexec</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="ROOTPREEXEC"></a>root preexec (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2580081"></a>
+
+root preexec close (S)
+</h3></div></div></div><a class="indexterm" name="id2580082"></a><a name="ROOTPREEXECCLOSE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is the same as the <em class="parameter"><code>preexec close
+ </code></em> parameter except that the command is run as root.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec close</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2580130"></a>
+
+root preexec (S)
+</h3></div></div></div><a class="indexterm" name="id2580131"></a><a name="ROOTPREEXEC"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is the same as the <em class="parameter"><code>preexec</code></em>
parameter except that the command is run as root. This is useful for
mounting filesystems (such as CDROMs) when a connection is opened.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec</code></em> = <code class="literal"></code>
</em></span>
-</p></dd><dt><span class="term"><a name="ROOTPREEXECCLOSE"></a>root preexec close (S)</span></dt><dd><p>This is the same as the <em class="parameter"><code>preexec close
- </code></em> parameter except that the command is run as root.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>root preexec close</code></em> = <code class="literal">no</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2580178"></a>
+
+security mask (S)
+</h3></div></div></div><a class="indexterm" name="id2580179"></a><a name="SECURITYMASK"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the
+ UNIX permission on a file using the native NT security dialog box.
+ </p><p>
+ This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
+ any bits not in this mask. Make sure not to mix up this parameter with <a class="link" href="smb.conf.5.html#FORCESECURITYMODE">force security mode</a>, which works in a manner similar to this one but uses a logical OR instead of an AND.
+ </p><p>
+ Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
+ file permissions regardless of the previous status of this bits on the file.
+ </p><p>
+ If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file.
+ </p><p><span class="emphasis"><em>
+ Note</em></span> that users who can access the Samba server through other means can easily bypass this
+ restriction, so it is primarily useful for standalone "appliance" systems. Administrators of
+ most normal systems will probably want to leave it set to <code class="constant">0777</code>.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0777</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SECURITY"></a>security (G)</span></dt><dd><p>This option affects how clients respond to
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0770</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2580285"></a>
+
+security (G)
+</h3></div></div></div><a class="indexterm" name="id2580286"></a><a name="SECURITY"></a><div class="variablelist"><dl><dt></dt><dd><p>This option affects how clients respond to
Samba and is one of the most important settings in the <code class="filename">
smb.conf</code> file.</p><p>The option sets the "security mode bit" in replies to
- protocol negotiations with <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to turn share level security on or off. Clients decide
+ protocol negotiations with <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> to turn share level security on or off. Clients decide
based on this bit whether (and how) to transfer user and password
information to the server.</p><p>The default is <code class="literal">security = user</code>, as this is
the most common setting needed when talking to Windows 98 and
@@ -3959,9 +4868,9 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
want to mainly setup shares without a password (guest shares). This
is commonly used for a shared printer server. It is more difficult
to setup guest shares with <code class="literal">security = user</code>, see
- the <a class="indexterm" name="id330741"></a>map to guestparameter for details.</p><p>It is possible to use <code class="literal">smbd</code> in a <span class="emphasis"><em>
+ the <a class="link" href="smb.conf.5.html#MAPTOGUEST">map to guest</a>parameter for details.</p><p>It is possible to use <code class="literal">smbd</code> in a <span class="emphasis"><em>
hybrid mode</em></span> where it is offers both user and share
- level security under different <a class="indexterm" name="id330762"></a>NetBIOS aliases. </p><p>The different settings will now be explained.</p><p><a name="SECURITYEQUALSSHARE"></a><span class="emphasis"><em>SECURITY = SHARE</em></span></p><p>When clients connect to a share level security server they
+ level security under different <a class="link" href="smb.conf.5.html#NETBIOSALIASES">NetBIOS aliases</a>. </p><p>The different settings will now be explained.</p><p><a name="SECURITYEQUALSSHARE"></a><span class="emphasis"><em>SECURITY = SHARE</em></span></p><p>When clients connect to a share level security server they
need not log onto the server with a valid username and password before
attempting to connect to a shared resource (although modern clients
such as Windows 95/98 and Windows NT will send a logon request with
@@ -3974,10 +4883,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
in share level security, <code class="literal">smbd</code> uses several
techniques to determine the correct UNIX user to use on behalf
of the client.</p><p>A list of possible UNIX usernames to match with the given
- client password is constructed using the following methods :</p><div class="itemizedlist"><ul type="disc"><li><p>If the <a class="indexterm" name="id330838"></a>guest only parameter is set, then all the other
- stages are missed and only the <a class="indexterm" name="id330845"></a>guest account username is checked.
+ client password is constructed using the following methods :</p><div class="itemizedlist"><ul type="disc"><li><p>If the <a class="link" href="smb.conf.5.html#GUESTONLY">guest only</a> parameter is set, then all the other
+ stages are missed and only the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a> username is checked.
</p></li><li><p>Is a username is sent with the share connection
- request, then this username (after mapping - see <a class="indexterm" name="id330860"></a>username map),
+ request, then this username (after mapping - see <a class="link" href="smb.conf.5.html#USERNAMEMAP">username map</a>),
is added as a potential username.
</p></li><li><p>If the client did a previous <span class="emphasis"><em>logon
</em></span> request (the SessionSetup SMB call) then the
@@ -3986,7 +4895,7 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
added as a potential username.
</p></li><li><p>The NetBIOS name of the client is added to
the list as a potential username.
- </p></li><li><p>Any users on the <a class="indexterm" name="id330900"></a>user list are added as potential usernames.
+ </p></li><li><p>Any users on the <a class="link" href="smb.conf.5.html#USER">user</a> list are added as potential usernames.
</p></li></ul></div><p>If the <em class="parameter"><code>guest only</code></em> parameter is
not set, then this list is then tried with the supplied password.
The first user for whom the password matches will be used as the
@@ -3995,20 +4904,20 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
as available to the <em class="parameter"><code>guest account</code></em>, then this
guest user will be used, otherwise access is denied.</p><p>Note that it can be <span class="emphasis"><em>very</em></span> confusing
in share-level security as to which UNIX username will eventually
- be used in granting access.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
+ be used in granting access.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSUSER"></a><span class="emphasis"><em>SECURITY = USER</em></span></p><p>This is the default security setting in Samba 3.0.
With user-level security a client must first "log-on" with a
- valid username and password (which can be mapped using the <a class="indexterm" name="id330969"></a>username map
- parameter). Encrypted passwords (see the <a class="indexterm" name="id330977"></a>encrypted passwords parameter) can also
- be used in this security mode. Parameters such as <a class="indexterm" name="id330985"></a>user and <a class="indexterm" name="id330992"></a>guest only if set are then applied and
+ valid username and password (which can be mapped using the <a class="link" href="smb.conf.5.html#USERNAMEMAP">username map</a>
+ parameter). Encrypted passwords (see the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</a> parameter) can also
+ be used in this security mode. Parameters such as <a class="link" href="smb.conf.5.html#USER">user</a> and <a class="link" href="smb.conf.5.html#GUESTONLY">guest only</a> if set are then applied and
may change the UNIX user to use on this connection, but only after
the user has been successfully authenticated.</p><p><span class="emphasis"><em>Note</em></span> that the name of the resource being
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
- the server to automatically map unknown users into the <a class="indexterm" name="id331011"></a>guest account.
- See the <a class="indexterm" name="id331019"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSDOMAIN"></a><span class="emphasis"><em>SECURITY = DOMAIN</em></span></p><p>This mode will only work correctly if <a href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> has been used to add this
- machine into a Windows NT Domain. It expects the <a class="indexterm" name="id331057"></a>encrypted passwords
+ the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>.
+ See the <a class="link" href="smb.conf.5.html#MAPTOGUEST">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p><a name="SECURITYEQUALSDOMAIN"></a><span class="emphasis"><em>SECURITY = DOMAIN</em></span></p><p>This mode will only work correctly if <a class="citerefentry" href="net.8.html"><span class="citerefentry"><span class="refentrytitle">net</span>(8)</span></a> has been used to add this
+ machine into a Windows NT Domain. It expects the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</a>
parameter to be set to <code class="constant">yes</code>. In this
mode Samba will try to validate the username/password by passing
it to a Windows NT Primary or Backup Domain Controller, in exactly
@@ -4022,13 +4931,13 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
- the server to automatically map unknown users into the <a class="indexterm" name="id331107"></a>guest account.
- See the <a class="indexterm" name="id331114"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
- NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="indexterm" name="id331135"></a>password server parameter and
- the <a class="indexterm" name="id331142"></a>encrypted passwords parameter.</p><p><a name="SECURITYEQUALSSERVER"></a><span class="emphasis"><em>SECURITY = SERVER</em></span></p><p>
+ the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>.
+ See the <a class="link" href="smb.conf.5.html#MAPTOGUEST">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
+ NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="link" href="smb.conf.5.html#PASSWORDSERVER">password server</a> parameter and
+ the <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</a> parameter.</p><p><a name="SECURITYEQUALSSERVER"></a><span class="emphasis"><em>SECURITY = SERVER</em></span></p><p>
In this mode Samba will try to validate the username/password by passing it to another SMB server, such as an
NT box. If this fails it will revert to <code class="literal">security = user</code>. It expects the
- <a class="indexterm" name="id331169"></a>encrypted passwords parameter to be set to <code class="constant">yes</code>, unless the remote
+ <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</a> parameter to be set to <code class="constant">yes</code>, unless the remote
server does not support them. However note that if encrypted passwords have been negotiated then Samba cannot
revert back to checking the UNIX password file, it must have a valid <code class="filename">smbpasswd</code> file to check users against. See the chapter about the User Database in
the Samba HOWTO Collection for details on how to set this up.
@@ -4048,10 +4957,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
requested is <span class="emphasis"><em>not</em></span> sent to the server until after
the server has successfully authenticated the client. This is why
guest shares don't work in user level security without allowing
- the server to automatically map unknown users into the <a class="indexterm" name="id331226"></a>guest account.
- See the <a class="indexterm" name="id331234"></a>map to guest parameter for details on doing this.</p><p>See also the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
- NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="indexterm" name="id331255"></a>password server parameter and the
- <a class="indexterm" name="id331262"></a>encrypted passwords parameter.</p><p><a name="SECURITYEQUALSADS"></a><span class="emphasis"><em>SECURITY = ADS</em></span></p><p>In this mode, Samba will act as a domain member in an ADS realm. To operate
+ the server to automatically map unknown users into the <a class="link" href="smb.conf.5.html#GUESTACCOUNT">guest account</a>.
+ See the <a class="link" href="smb.conf.5.html#MAPTOGUEST">map to guest</a> parameter for details on doing this.</p><p>See also the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">
+ NOTE ABOUT USERNAME/PASSWORD VALIDATION</a>.</p><p>See also the <a class="link" href="smb.conf.5.html#PASSWORDSERVER">password server</a> parameter and the
+ <a class="link" href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</a> parameter.</p><p><a name="SECURITYEQUALSADS"></a><span class="emphasis"><em>SECURITY = ADS</em></span></p><p>In this mode, Samba will act as a domain member in an ADS realm. To operate
in this mode, the machine running Samba will need to have Kerberos installed
and configured and Samba will need to be joined to the ADS realm using the
net utility. </p><p>Note that this mode does NOT make Samba operate as a Active Directory Domain
@@ -4059,28 +4968,12 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security</code></em> = <code class="literal">DOMAIN</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SECURITYMASK"></a>security mask (S)</span></dt><dd><p>
- This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the
- UNIX permission on a file using the native NT security dialog box.
- </p><p>
- This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
- any bits not in this mask. Make sure not to mix up this parameter with <a class="indexterm" name="id331354"></a>force security mode, which works in a manner similar to this one but uses a logical OR instead of an AND.
- </p><p>
- Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
- file permissions regardless of the previous status of this bits on the file.
- </p><p>
- If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file.
- </p><p><span class="emphasis"><em>
- Note</em></span> that users who can access the Samba server through other means can easily bypass this
- restriction, so it is primarily useful for standalone "appliance" systems. Administrators of
- most normal systems will probably want to leave it set to <code class="constant">0777</code>.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0777</code>
-</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>security mask</code></em> = <code class="literal">0770</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="SERVERSCHANNEL"></a>server schannel (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581163"></a>
+
+server schannel (G)
+</h3></div></div></div><a class="indexterm" name="id2581164"></a><a name="SERVERSCHANNEL"></a><div class="variablelist"><dl><dt></dt><dd><p>
This controls whether the server offers or even demands the use of the netlogon schannel.
- <a class="indexterm" name="id331438"></a>server schannel = no does not offer the schannel, <a class="indexterm" name="id331446"></a>server schannel = auto offers the schannel but does not enforce it, and <a class="indexterm" name="id331453"></a>server schannel = yes denies access if the client is not able to speak netlogon schannel.
+ <a class="link" href="smb.conf.5.html#SERVERSCHANNEL">server schannel = no</a> does not offer the schannel, <a class="link" href="smb.conf.5.html#SERVERSCHANNEL">server schannel = auto</a> offers the schannel but does not enforce it, and <a class="link" href="smb.conf.5.html#SERVERSCHANNEL">server schannel = yes</a> denies access if the client is not able to speak netlogon schannel.
This is only the case for Windows NT4 before SP4.
</p><p>
Please note that with this set to <code class="literal">no</code> you will have to apply the WindowsXP
@@ -4089,7 +4982,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server schannel</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SERVERSIGNING"></a>server signing (G)</span></dt><dd><p>This controls whether the server offers or requires
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581279"></a>
+
+server signing (G)
+</h3></div></div></div><a class="indexterm" name="id2581280"></a><a name="SERVERSIGNING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls whether the server offers or requires
the client it talks to to use SMB signing. Possible values
are <span class="emphasis"><em>auto</em></span>, <span class="emphasis"><em>mandatory</em></span>
and <span class="emphasis"><em>disabled</em></span>.
@@ -4097,7 +4993,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
When set to mandatory, SMB signing is required and if set
to disabled, SMB signing is not offered either.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>server signing</code></em> = <code class="literal">Disabled</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SERVERSTRING"></a>server string (G)</span></dt><dd><p>This controls what string will show up in the printer comment box in print
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581340"></a>
+
+server string (G)
+</h3></div></div></div><a class="indexterm" name="id2581341"></a><a name="SERVERSTRING"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what string will show up in the printer comment box in print
manager and next to the IPC connection in <code class="literal">net view</code>. It
can be any string that you wish to show to your users.</p><p>It also sets what will appear in browse lists next
to the machine name.</p><p>A <em class="parameter"><code>%v</code></em> will be replaced with the Samba
@@ -4106,7 +5005,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>server string</code></em> = <code class="literal">University of GNUs Samba Server</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SETDIRECTORY"></a>set directory (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581431"></a>
+
+set directory (S)
+</h3></div></div></div><a class="indexterm" name="id2581432"></a><a name="SETDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
If <code class="literal">set directory = no</code>, then users of the
service may not use the setdir command to change directory.
</p><p>
@@ -4115,7 +5017,10 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
for details.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set directory</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SETPRIMARYGROUPSCRIPT"></a>set primary group script (G)</span></dt><dd><p>Thanks to the Posix subsystem in NT a Windows User has a
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581492"></a>
+
+set primary group script (G)
+</h3></div></div></div><a class="indexterm" name="id2581493"></a><a name="SETPRIMARYGROUPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>Thanks to the Posix subsystem in NT a Windows User has a
primary group in addition to the auxiliary groups. This script
sets the primary group in the unix userdatase when an
administrator sets the primary group from the windows user
@@ -4127,18 +5032,23 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set primary group script</code></em> = <code class="literal">/usr/sbin/usermod -g '%g' '%u'</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SETQUOTACOMMAND"></a>set quota command (G)</span></dt><dd><p>The <code class="literal">set quota command</code> should only be used
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581574"></a>
+
+set quota command (G)
+</h3></div></div></div><a class="indexterm" name="id2581575"></a><a name="SETQUOTACOMMAND"></a><div class="variablelist"><dl><dt></dt><dd><p>The <code class="literal">set quota command</code> should only be used
whenever there is no operating system API available from the OS that
samba can use.</p><p>This option is only available if Samba was configured with the argument <code class="literal">--with-sys-quotas</code> or
on linux when <code class="literal">./configure --with-quotas</code> was used and a working quota api
was found in the system. Most packages are configured with these options already.</p><p>This parameter should specify the path to a script that
can set quota for the specified arguments.</p><p>The specified script should take the following arguments:</p><div class="itemizedlist"><ul type="disc"><li><p>1 - quota type
- </p><div class="itemizedlist"><ul type="circle"><li><p>1 - user quotas</p></li><li><p>2 - user default quotas (uid = -1)</p></li><li><p>3 - group quotas</p></li><li><p>4 - group default quotas (gid = -1)</p></li></ul></div><p>
- </p></li><li><p>2 - id (uid for user, gid for group, -1 if N/A)</p></li><li><p>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</p></li><li><p>4 - block softlimit</p></li><li><p>5 - block hardlimit</p></li><li><p>6 - inode softlimit</p></li><li><p>7 - inode hardlimit</p></li><li><p>8(optional) - block size, defaults to 1024</p></li></ul></div><p>The script should output at least one line of data on success. And nothing on failure.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal"></code>
+ </p><div class="itemizedlist"><ul type="circle"><li><p>1 - user quotas</p></li><li><p>2 - user default quotas (uid = -1)</p></li><li><p>3 - group quotas</p></li><li><p>4 - group default quotas (gid = -1)</p></li></ul></div></li><li><p>2 - id (uid for user, gid for group, -1 if N/A)</p></li><li><p>3 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</p></li><li><p>4 - block softlimit</p></li><li><p>5 - block hardlimit</p></li><li><p>6 - inode softlimit</p></li><li><p>7 - inode hardlimit</p></li><li><p>8(optional) - block size, defaults to 1024</p></li></ul></div><p>The script should output at least one line of data on success. And nothing on failure.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>set quota command</code></em> = <code class="literal">/usr/local/sbin/set_quota</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SHAREMODES"></a>share modes (S)</span></dt><dd><p>This enables or disables the honoring of
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581736"></a>
+
+share modes (S)
+</h3></div></div></div><a class="indexterm" name="id2581738"></a><a name="SHAREMODES"></a><div class="variablelist"><dl><dt></dt><dd><p>This enables or disables the honoring of
the <em class="parameter"><code>share modes</code></em> during a file open. These
modes are used by clients to gain exclusive read or write access
to a file.</p><p>These open modes are not directly supported by UNIX, so
@@ -4151,14 +5061,20 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
by default.</p><p>You should <span class="emphasis"><em>NEVER</em></span> turn this parameter
off as many Windows applications will break if you do so.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>share modes</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SHORTPRESERVECASE"></a>short preserve case (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581830"></a>
+
+short preserve case (S)
+</h3></div></div></div><a class="indexterm" name="id2581831"></a><a name="SHORTPRESERVECASE"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter controls if new files which conform to 8.3 syntax, that is all in upper case and of
- suitable length, are created upper case, or if they are forced to be the <a class="indexterm" name="id332044"></a>default case.
- This option can be use with <a class="indexterm" name="id332051"></a>preserve case = yes to permit long filenames
+ suitable length, are created upper case, or if they are forced to be the <a class="link" href="smb.conf.5.html#DEFAULTCASE">default case</a>.
+ This option can be use with <a class="link" href="smb.conf.5.html#PRESERVECASE">preserve case = yes</a> to permit long filenames
to retain their case, while short names are lowered.
- </p><p>See the section on <a href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>short preserve case</code></em> = <code class="literal">yes</code>
+ </p><p>See the section on <a class="link" href="#NAMEMANGLINGSECT" title="NAME MANGLING">NAME MANGLING</a>.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>short preserve case</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SHOWADDPRINTERWIZARD"></a>show add printer wizard (G)</span></dt><dd><p>With the introduction of MS-RPC based printing support
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581910"></a>
+
+show add printer wizard (G)
+</h3></div></div></div><a class="indexterm" name="id2581911"></a><a name="SHOWADDPRINTERWIZARD"></a><div class="variablelist"><dl><dt></dt><dd><p>With the introduction of MS-RPC based printing support
for Windows NT/2000 client in Samba 2.2, a "Printers..." folder will
appear on Samba hosts in the share listing. Normally this folder will
contain an icon for the MS Add Printer Wizard (APW). However, it is
@@ -4176,8 +5092,11 @@ HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This does not prevent the same user from having
administrative privilege on an individual printer.</p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>show add printer wizard</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SHUTDOWNSCRIPT"></a>shutdown script (G)</span></dt><dd><p>This a full path name to a script called by
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2581994"></a>
+
+shutdown script (G)
+</h3></div></div></div><a class="indexterm" name="id2581995"></a><a name="SHUTDOWNSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This a full path name to a script called by
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> that should
start a shutdown procedure.</p><p>If the connected user posseses the <code class="constant">SeRemoteShutdownPrivilege</code>,
right, this command will be run as user.</p><p>The %z %t %r %f variables are expanded as follows:</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>%z</code></em> will be substituted with the
shutdown message sent to the server.</p></li><li><p><em class="parameter"><code>%t</code></em> will be substituted with the
@@ -4201,7 +5120,10 @@ let "time++"
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>shutdown script</code></em> = <code class="literal">/usr/local/samba/sbin/shutdown %m %t %r %f</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SMBENCRYPT"></a>smb encrypt (S)</span></dt><dd><p>This is a new feature introduced with Samba 3.2 and above. It is an
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582147"></a>
+
+smb encrypt (S)
+</h3></div></div></div><a class="indexterm" name="id2582148"></a><a name="SMBENCRYPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a new feature introduced with Samba 3.2 and above. It is an
extension to the SMB/CIFS protocol negotiated as part of the UNIX extensions.
SMB encryption uses the GSSAPI (SSPI on Windows) ability to encrypt
and sign every request/response in a SMB protocol stream. When
@@ -4224,13 +5146,16 @@ let "time++"
style read/writes allowed) as well as the overhead of encrypting
and signing all the data.
</p><p>If SMB encryption is selected, Windows style SMB signing (see
- the <a class="indexterm" name="id332354"></a>server signing option) is no longer necessary,
+ the <a class="link" href="smb.conf.5.html#SERVERSIGNING">server signing</a> option) is no longer necessary,
as the GSSAPI flags use select both signing and sealing of the data.
</p><p>When set to auto, SMB encryption is offered, but not enforced.
When set to mandatory, SMB encryption is required and if set
to disabled, SMB encryption can not be negotiated.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb encrypt</code></em> = <code class="literal">auto</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SMBPASSWDFILE"></a>smb passwd file (G)</span></dt><dd><p>This option sets the path to the encrypted smbpasswd file. By
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582253"></a>
+
+smb passwd file (G)
+</h3></div></div></div><a class="indexterm" name="id2582254"></a><a name="SMBPASSWDFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>This option sets the path to the encrypted smbpasswd file. By
default the path to the smbpasswd file is compiled into Samba.</p><p>
An example of use is:
</p><pre class="programlisting">
@@ -4238,9 +5163,15 @@ smb passwd file = /etc/samba/smbpasswd
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb passwd file</code></em> = <code class="literal">${prefix}/private/smbpasswd</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SMBPORTS"></a>smb ports (G)</span></dt><dd><p>Specifies which ports the server should listen on for SMB traffic.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb ports</code></em> = <code class="literal">445 139</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582307"></a>
+
+smb ports (G)
+</h3></div></div></div><a class="indexterm" name="id2582308"></a><a name="SMBPORTS"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies which ports the server should listen on for SMB traffic.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>smb ports</code></em> = <code class="literal">445 139</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SOCKETADDRESS"></a>socket address (G)</span></dt><dd><p>This option allows you to control what
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582349"></a>
+
+socket address (G)
+</h3></div></div></div><a class="indexterm" name="id2582350"></a><a name="SOCKETADDRESS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to control what
address Samba will listen for connections on. This is used to
support multiple virtual interfaces on the one server, each
with a different configuration.</p><p>By default Samba will accept connections on any
@@ -4248,7 +5179,10 @@ smb passwd file = /etc/samba/smbpasswd
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket address</code></em> = <code class="literal">192.168.2.20</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SOCKETOPTIONS"></a>socket options (G)</span></dt><dd><p>This option allows you to set socket options
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582414"></a>
+
+socket options (G)
+</h3></div></div></div><a class="indexterm" name="id2582415"></a><a name="SOCKETOPTIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option allows you to set socket options
to be used when talking with the client.</p><p>Socket options are controls on the networking layer
of the operating systems which allow the connection to be
tuned.</p><p>This option will typically be used to tune your Samba server
@@ -4261,7 +5195,7 @@ smb passwd file = /etc/samba/smbpasswd
"Unknown socket option" when you supply an option. This means you
either incorrectly typed it or you need to add an include file
to includes.h for your OS. If the latter is the case please
- send the patch to <a href="mailto:samba-technical@samba.org" target="_top">
+ send the patch to <a class="ulink" href="mailto:samba-technical@samba.org" target="_top">
samba-technical@samba.org</a>.</p><p>Any of the supported socket options may be combined
in any way you like, as long as your OS allows it.</p><p>This is the list of socket options currently settable
using this option:</p><div class="itemizedlist"><ul type="disc"><li><p>SO_KEEPALIVE</p></li><li><p>SO_REUSEADDR</p></li><li><p>SO_BROADCAST</p></li><li><p>TCP_NODELAY</p></li><li><p>IPTOS_LOWDELAY</p></li><li><p>IPTOS_THROUGHPUT</p></li><li><p>SO_SNDBUF *</p></li><li><p>SO_RCVBUF *</p></li><li><p>SO_SNDLOWAT *</p></li><li><p>SO_RCVLOWAT *</p></li></ul></div><p>Those marked with a <span class="emphasis"><em>'*'</em></span> take an integer
@@ -4276,23 +5210,32 @@ smb passwd file = /etc/samba/smbpasswd
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>socket options</code></em> = <code class="literal">IPTOS_LOWDELAY</code>
</em></span>
-</p></dd><dt><span class="term"><a name="STATCACHE"></a>stat cache (G)</span></dt><dd><p>This parameter determines if <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will use a cache in order to
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582624"></a>
+
+stat cache (G)
+</h3></div></div></div><a class="indexterm" name="id2582625"></a><a name="STATCACHE"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> will use a cache in order to
speed up case insensitive name mappings. You should never need
to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>stat cache</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="STOREDOSATTRIBUTES"></a>store dos attributes (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582675"></a>
+
+store dos attributes (S)
+</h3></div></div></div><a class="indexterm" name="id2582676"></a><a name="STOREDOSATTRIBUTES"></a><div class="variablelist"><dl><dt></dt><dd><p>
If this parameter is set Samba attempts to first read DOS attributes (SYSTEM, HIDDEN, ARCHIVE or
READ-ONLY) from a filesystem extended attribute, before mapping DOS attributes to UNIX permission bits (such
- as occurs with <a class="indexterm" name="id332794"></a>map hidden and <a class="indexterm" name="id332801"></a>map readonly). When set, DOS
+ as occurs with <a class="link" href="smb.conf.5.html#MAPHIDDEN">map hidden</a> and <a class="link" href="smb.conf.5.html#MAPREADONLY">map readonly</a>). When set, DOS
attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or
- directory. For no other mapping to occur as a fall-back, the parameters <a class="indexterm" name="id332810"></a>map hidden,
- <a class="indexterm" name="id332817"></a>map system, <a class="indexterm" name="id332824"></a>map archive and <a class="indexterm" name="id332831"></a>map readonly must be set to off. This parameter writes the DOS attributes as a string into the extended
+ directory. For no other mapping to occur as a fall-back, the parameters <a class="link" href="smb.conf.5.html#MAPHIDDEN">map hidden</a>,
+ <a class="link" href="smb.conf.5.html#MAPSYSTEM">map system</a>, <a class="link" href="smb.conf.5.html#MAPARCHIVE">map archive</a> and <a class="link" href="smb.conf.5.html#MAPREADONLY">map readonly</a> must be set to off. This parameter writes the DOS attributes as a string into the extended
attribute named "user.DOSATTRIB". This extended attribute is explicitly hidden from smbd clients requesting an
EA list. On Linux the filesystem must have been mounted with the mount option user_xattr in order for
extended attributes to work, also extended attributes must be compiled into the Linux kernel.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>store dos attributes</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="STRICTALLOCATE"></a>strict allocate (S)</span></dt><dd><p>This is a boolean that controls the handling of
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582797"></a>
+
+strict allocate (S)
+</h3></div></div></div><a class="indexterm" name="id2582798"></a><a name="STRICTALLOCATE"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean that controls the handling of
disk space allocation in the server. When this is set to <code class="constant">yes</code>
the server will change from UNIX behaviour of not committing real
disk storage blocks when a file is extended to the Windows behaviour
@@ -4304,7 +5247,10 @@ smb passwd file = /etc/samba/smbpasswd
out of quota messages on systems that are restricting the disk quota
of users.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict allocate</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="STRICTLOCKING"></a>strict locking (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582867"></a>
+
+strict locking (S)
+</h3></div></div></div><a class="indexterm" name="id2582868"></a><a name="STRICTLOCKING"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is an enumerated type that controls the handling of file locking in the server. When this is set to <code class="constant">yes</code>,
the server will check every read and write access for file locks, and deny access if locks exist. This can be slow on
some systems.
@@ -4320,21 +5266,27 @@ smb passwd file = /etc/samba/smbpasswd
<code class="literal">strict locking = no</code> is acceptable.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict locking</code></em> = <code class="literal">Auto</code>
</em></span>
-</p></dd><dt><span class="term"><a name="STRICTSYNC"></a>strict sync (S)</span></dt><dd><p>Many Windows applications (including the Windows 98 explorer
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2582946"></a>
+
+strict sync (S)
+</h3></div></div></div><a class="indexterm" name="id2582947"></a><a name="STRICTSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>Many Windows applications (including the Windows 98 explorer
shell) seem to confuse flushing buffer contents to disk with doing
a sync to disk. Under UNIX, a sync call forces the process to be
suspended until the kernel has ensured that all outstanding data in
kernel disk buffers has been safely stored onto stable storage.
This is very slow and should only be done rarely. Setting this
parameter to <code class="constant">no</code> (the default) means that
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> ignores the Windows
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> ignores the Windows
applications requests for a sync call. There is only a possibility
of losing data if the operating system itself that Samba is running
on crashes, so there is little danger in this default setting. In
addition, this fixes many performance problems that people have
reported with the new Windows98 explorer shell file copies.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>strict sync</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SVCCTLLIST"></a>svcctl list (G)</span></dt><dd><p>This option defines a list of init scripts that smbd
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583011"></a>
+
+svcctl list (G)
+</h3></div></div></div><a class="indexterm" name="id2583012"></a><a name="SVCCTLLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This option defines a list of init scripts that smbd
will use for starting and stopping Unix services via the Win32
ServiceControl API. This allows Windows administrators to
utilize the MS Management Console plug-ins to manage a
@@ -4347,7 +5299,10 @@ smb passwd file = /etc/samba/smbpasswd
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>svcctl list</code></em> = <code class="literal">cups postfix portmap httpd</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SYNCALWAYS"></a>sync always (S)</span></dt><dd><p>This is a boolean parameter that controls
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583096"></a>
+
+sync always (S)
+</h3></div></div></div><a class="indexterm" name="id2583098"></a><a name="SYNCALWAYS"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean parameter that controls
whether writes will always be written to stable storage before
the write call returns. If this is <code class="constant">no</code> then the server will be
guided by the client's request in each write call (clients can
@@ -4358,7 +5313,19 @@ smb passwd file = /etc/samba/smbpasswd
<code class="constant">yes</code> in order for this parameter to have
any affect.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>sync always</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SYSLOG"></a>syslog (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583167"></a>
+
+syslog only (G)
+</h3></div></div></div><a class="indexterm" name="id2583168"></a><a name="SYSLOGONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ If this parameter is set then Samba debug messages are logged into the system
+ syslog only, and not to the debug log files. There still will be some
+ logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog only</code></em> = <code class="literal">no</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583214"></a>
+
+syslog (G)
+</h3></div></div></div><a class="indexterm" name="id2583215"></a><a name="SYSLOG"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter maps how Samba debug messages are logged onto the system syslog logging levels.
Samba debug level zero maps onto syslog <code class="constant">LOG_ERR</code>, debug level one maps onto
<code class="constant">LOG_WARNING</code>, debug level two maps onto <code class="constant">LOG_NOTICE</code>,
@@ -4369,33 +5336,42 @@ smb passwd file = /etc/samba/smbpasswd
logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog</code></em> = <code class="literal">1</code>
</em></span>
-</p></dd><dt><span class="term"><a name="SYSLOGONLY"></a>syslog only (G)</span></dt><dd><p>
- If this parameter is set then Samba debug messages are logged into the system
- syslog only, and not to the debug log files. There still will be some
- logging to log.[sn]mbd even if <span class="emphasis"><em>syslog only</em></span> is enabled.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>syslog only</code></em> = <code class="literal">no</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="TEMPLATEHOMEDIR"></a>template homedir (G)</span></dt><dd><p>When filling out the user information for a Windows NT
- user, the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583285"></a>
+
+template homedir (G)
+</h3></div></div></div><a class="indexterm" name="id2583286"></a><a name="TEMPLATEHOMEDIR"></a><div class="variablelist"><dl><dt></dt><dd><p>When filling out the user information for a Windows NT
+ user, the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
parameter to fill in the home directory for that user. If the
string <em class="parameter"><code>%D</code></em> is present it
is substituted with the user's Windows NT domain name. If the
string <em class="parameter"><code>%U</code></em> is present it
is substituted with the user's Windows NT user name.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>template homedir</code></em> = <code class="literal">/home/%D/%U</code>
</em></span>
-</p></dd><dt><span class="term"><a name="TEMPLATESHELL"></a>template shell (G)</span></dt><dd><p>When filling out the user information for a Windows NT
- user, the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
- parameter to fill in the login shell for that user.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="TIMEOFFSET"></a>time offset (G)</span></dt><dd><p>This parameter is a setting in minutes to add
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583350"></a>
+
+template shell (G)
+</h3></div></div></div><a class="indexterm" name="id2583352"></a><a name="TEMPLATESHELL"></a><div class="variablelist"><dl><dt></dt><dd><p>When filling out the user information for a Windows NT
+ user, the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon uses this
+ parameter to fill in the login shell for that user.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583390"></a>
+
+time offset (G)
+</h3></div></div></div><a class="indexterm" name="id2583391"></a><a name="TIMEOFFSET"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a setting in minutes to add
to the normal GMT to local time conversion. This is useful if
you are serving a lot of PCs that have incorrect daylight
saving time handling.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">0</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>time offset</code></em> = <code class="literal">60</code>
</em></span>
-</p></dd><dt><span class="term"><a name="TIMESERVER"></a>time server (G)</span></dt><dd><p>This parameter determines if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> advertises itself as a time server to Windows
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583449"></a>
+
+time server (G)
+</h3></div></div></div><a class="indexterm" name="id2583450"></a><a name="TIMESERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter determines if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> advertises itself as a time server to Windows
clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>time server</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="UNIXCHARSET"></a>unix charset (G)</span></dt><dd><p>Specifies the charset the unix machine
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583500"></a>
+
+unix charset (G)
+</h3></div></div></div><a class="indexterm" name="id2583501"></a><a name="UNIXCHARSET"></a><div class="variablelist"><dl><dt></dt><dd><p>Specifies the charset the unix machine
Samba runs on uses. Samba needs to know this in order to be able to
convert text to the charsets other SMB clients use.
</p><p>This is also the charset Samba will use when specifying arguments
@@ -4404,14 +5380,20 @@ clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>t
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>unix charset</code></em> = <code class="literal">ASCII</code>
</em></span>
-</p></dd><dt><span class="term"><a name="UNIXEXTENSIONS"></a>unix extensions (G)</span></dt><dd><p>This boolean parameter controls whether Samba
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583566"></a>
+
+unix extensions (G)
+</h3></div></div></div><a class="indexterm" name="id2583567"></a><a name="UNIXEXTENSIONS"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether Samba
implments the CIFS UNIX extensions, as defined by HP.
These extensions enable Samba to better serve UNIX CIFS clients
by supporting features such as symbolic links, hard links, etc...
These extensions require a similarly enabled client, and are of
no current use to Windows clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix extensions</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="UNIXPASSWORDSYNC"></a>unix password sync (G)</span></dt><dd><p>This boolean parameter controls whether Samba
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583613"></a>
+
+unix password sync (G)
+</h3></div></div></div><a class="indexterm" name="id2583614"></a><a name="UNIXPASSWORDSYNC"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean parameter controls whether Samba
attempts to synchronize the UNIX password with the SMB password
when the encrypted SMB password in the smbpasswd file is changed.
If this is set to <code class="constant">yes</code> the program specified in the <em class="parameter"><code>passwd
@@ -4420,7 +5402,10 @@ clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>t
old UNIX password (as the SMB password change code has no
access to the old password cleartext, only the new).</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>unix password sync</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="UPDATEENCRYPTED"></a>update encrypted (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583674"></a>
+
+update encrypted (G)
+</h3></div></div></div><a class="indexterm" name="id2583675"></a><a name="UPDATEENCRYPTED"></a><div class="variablelist"><dl><dt></dt><dd><p>
This boolean parameter allows a user logging on with a plaintext password to have their encrypted (hashed)
password in the smbpasswd file to be updated automatically as they log on. This option allows a site to
migrate from plaintext password authentication (users authenticate with plaintext password over the
@@ -4430,15 +5415,18 @@ clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>t
passwords to be made over a longer period. Once all users have encrypted representations of their passwords
in the smbpasswd file this parameter should be set to <code class="constant">no</code>.
</p><p>
- In order for this parameter to be operative the <a class="indexterm" name="id333687"></a>encrypt passwords parameter must
- be set to <code class="constant">no</code>. The default value of <a class="indexterm" name="id333698"></a>encrypt passwords = Yes. Note: This must be set to <code class="constant">no</code> for this <a class="indexterm" name="id333709"></a>update encrypted to work.
+ In order for this parameter to be operative the <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</a> parameter must
+ be set to <code class="constant">no</code>. The default value of <a class="link" href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = Yes</a>. Note: This must be set to <code class="constant">no</code> for this <a class="link" href="smb.conf.5.html#UPDATEENCRYPTED">update encrypted</a> to work.
</p><p>
Note that even when this parameter is set a user authenticating to <code class="literal">smbd</code>
must still enter a valid password in order to connect correctly, and to update their hashed (smbpasswd)
passwords.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>update encrypted</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USECLIENTDRIVER"></a>use client driver (S)</span></dt><dd><p>This parameter applies only to Windows NT/2000
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583806"></a>
+
+use client driver (S)
+</h3></div></div></div><a class="indexterm" name="id2583807"></a><a name="USECLIENTDRIVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter applies only to Windows NT/2000
clients. It has no effect on Windows 95/98/ME clients. When
serving a printer to Windows NT/2000 clients without first installing
a valid printer driver on the Samba host, the client will be required
@@ -4463,7 +5451,10 @@ clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>t
on a print share which has valid print driver installed on the Samba
server.</em></span></p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use client driver</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USEKERBEROSKEYTAB"></a>use kerberos keytab (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583887"></a>
+
+use kerberos keytab (G)
+</h3></div></div></div><a class="indexterm" name="id2583888"></a><a name="USEKERBEROSKEYTAB"></a><div class="variablelist"><dl><dt></dt><dd><p>
Specifies whether Samba should attempt to maintain service principals in the systems
keytab file for <code class="constant">host/FQDN</code> and <code class="constant">cifs/FQDN</code>.
</p><p>
@@ -4475,7 +5466,10 @@ default_keytab_name = FILE:/etc/krb5.keytab
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use kerberos keytab</code></em> = <code class="literal">False</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USEMMAP"></a>use mmap (G)</span></dt><dd><p>This global parameter determines if the tdb internals of Samba can
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2583955"></a>
+
+use mmap (G)
+</h3></div></div></div><a class="indexterm" name="id2583956"></a><a name="USEMMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>This global parameter determines if the tdb internals of Samba can
depend on mmap working correctly on the running system. Samba requires a coherent
mmap/read-write system memory cache. Currently only HPUX does not have such a
coherent cache, and so this parameter is set to <code class="constant">no</code> by
@@ -4484,45 +5478,10 @@ default_keytab_name = FILE:/etc/krb5.keytab
the tdb internal code.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use mmap</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USER"></a>user</span></dt><dd><p>This parameter is a synonym for username.</p></dd><dt><span class="term"><a name="USERS"></a>users</span></dt><dd><p>This parameter is a synonym for username.</p></dd><dt><span class="term"><a name="USERNAME"></a>username (S)</span></dt><dd><p>Multiple users may be specified in a comma-delimited
- list, in which case the supplied password will be tested against
- each username in turn (left to right).</p><p>The <em class="parameter"><code>username</code></em> line is needed only when
- the PC is unable to supply its own username. This is the case
- for the COREPLUS protocol or where your users have different WfWg
- usernames to UNIX usernames. In both these cases you may also be
- better using the \\server\share%user syntax instead.</p><p>The <em class="parameter"><code>username</code></em> line is not a great
- solution in many cases as it means Samba will try to validate
- the supplied password against each of the usernames in the
- <em class="parameter"><code>username</code></em> line in turn. This is slow and
- a bad idea for lots of users in case of duplicate passwords.
- You may get timeouts or security breaches using this parameter
- unwisely.</p><p>Samba relies on the underlying UNIX security. This
- parameter does not restrict who can login, it just offers hints
- to the Samba server as to what usernames might correspond to the
- supplied password. Users can login as whoever they please and
- they will be able to do no more damage than if they started a
- telnet session. The daemon runs as the user that they log in as,
- so they cannot do anything that user cannot do.</p><p>To restrict a service to a particular set of users you
- can use the <a class="indexterm" name="id334024"></a>valid users parameter.</p><p>If any of the usernames begin with a '@' then the name
- will be looked up first in the NIS netgroups list (if Samba
- is compiled with netgroup support), followed by a lookup in
- the UNIX groups database and will expand to a list of all users
- in the group of that name.</p><p>If any of the usernames begin with a '+' then the name
- will be looked up only in the UNIX groups database and will
- expand to a list of all users in the group of that name.</p><p>If any of the usernames begin with a '&amp;' then the name
- will be looked up only in the NIS netgroups database (if Samba
- is compiled with netgroup support) and will expand to a list
- of all users in the netgroup group of that name.</p><p>Note that searching though a groups database can take
- quite some time, and some clients may time out during the
- search.</p><p>See the section <a href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT
- USERNAME/PASSWORD VALIDATION</a> for more information on how
- this parameter determines access to the services.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">
-# The guest account if a guest service,
- else &lt;empty string&gt;.</code>
-</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">fred, mary, jack, jane, @users, @pcgroup</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="USERNAMELEVEL"></a>username level (G)</span></dt><dd><p>This option helps Samba to try and 'guess' at
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584008"></a>
+
+username level (G)
+</h3></div></div></div><a class="indexterm" name="id2584009"></a><a name="USERNAMELEVEL"></a><div class="variablelist"><dl><dt></dt><dd><p>This option helps Samba to try and 'guess' at
the real UNIX username, as many DOS clients send an all-uppercase
username. By default Samba tries all lowercase, followed by the
username with the first letter capitalized, and fails if the
@@ -4537,7 +5496,24 @@ default_keytab_name = FILE:/etc/krb5.keytab
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username level</code></em> = <code class="literal">5</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERNAMEMAP"></a>username map (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584089"></a>
+
+username map script (G)
+</h3></div></div></div><a class="indexterm" name="id2584090"></a><a name="USERNAMEMAPSCRIPT"></a><div class="variablelist"><dl><dt></dt><dd><p>This script is a mutually exclusive alternative to the
+ <a class="link" href="smb.conf.5.html#USERNAMEMAP">username map</a> parameter. This parameter
+ specifies and external program or script that must accept a single
+ command line option (the username transmitted in the authentication
+ request) and return a line line on standard output (the name to which
+ the account should mapped). In this way, it is possible to store
+ username map tables in an LDAP or NIS directory services.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal"></code>
+</em></span>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal">/etc/samba/scripts/mapusers.sh</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584166"></a>
+
+username map (G)
+</h3></div></div></div><a class="indexterm" name="id2584167"></a><a name="USERNAMEMAP"></a><div class="variablelist"><dl><dt></dt><dd><p>
This option allows you to specify a file containing a mapping of usernames from the clients to the server.
This can be used for several purposes. The most common is to map usernames that users use on DOS or Windows
machines to those that the UNIX box uses. The other is to map multiple users to a single username so that they
@@ -4546,7 +5522,7 @@ default_keytab_name = FILE:/etc/krb5.keytab
Please note that for user or share mode security, the username map is applied prior to validating the user
credentials. Domain member servers (domain or ads) apply the username map after the user has been
successfully authenticated by the domain controller and require fully qualified enties in the map table (e.g.
- biddle = DOMAIN\foo).
+ biddle = <code class="literal">DOMAIN\foo</code>).
</p><p>
The map file is parsed line by line. Each line should contain a single UNIX username on the left then a '='
followed by a list of usernames on the right. The list of usernames on the right may contain names of the form
@@ -4593,14 +5569,15 @@ guest = *
Note that the remapping is applied to all occurrences of usernames. Thus if you connect to \\server\fred and
<code class="constant">fred</code> is remapped to <code class="constant">mary</code> then you will actually be connecting to
\\server\mary and will need to supply a password suitable for <code class="constant">mary</code> not
- <code class="constant">fred</code>. The only exception to this is the username passed to the <a class="indexterm" name="id334332"></a>password server (if you have one). The password server will receive whatever username the client
+ <code class="constant">fred</code>. The only exception to this is the username passed to the <a class="link" href="smb.conf.5.html#PASSWORDSERVER">password server</a> (if you have one). The password server will receive whatever username the client
supplies without modification.
</p><p>
Also note that no reverse mapping is done. The main effect this has is with printing. Users who have been
mapped may have trouble deleting print jobs as PrintManager under WfWg will think they don't own the print
job.
</p><p>
- Samba versions prior to 3.0.8 would only support reading the fully qualified username (e.g.: DOMAIN\user) from
+ Samba versions prior to 3.0.8 would only support reading the fully qualified username
+ (e.g.: <code class="literal">DOMAIN\user</code>) from
the username map when performing a kerberos login from a client. However, when looking up a map entry for a
user authenticated by NTLM[SSP], only the login name would be used for matches. This resulted in inconsistent
behavior sometimes even on the same server.
@@ -4611,7 +5588,7 @@ guest = *
the connection.
</p><p>
When relying upon a external domain controller for validating authentication requests, smbd will apply the username map
- to the fully qualified username (i.e. DOMAIN\user) only after the user has been successfully authenticated.
+ to the fully qualified username (i.e. <code class="literal">DOMAIN\user</code>) only after the user has been successfully authenticated.
</p><p>
An example of use is:
</p><pre class="programlisting">
@@ -4620,30 +5597,69 @@ username map = /usr/local/samba/lib/users.map
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map</code></em> = <code class="literal">
# no username map</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERNAMEMAPSCRIPT"></a>username map script (G)</span></dt><dd><p>This script is a mutually exclusive alternative to the
- <a class="indexterm" name="id334414"></a>username map parameter. This parameter
- specifies and external program or script that must accept a single
- command line option (the username transmitted in the authentication
- request) and return a line line on standard output (the name to which
- the account should mapped). In this way, it is possible to store
- username map tables in an LDAP or NIS directory services.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal"></code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584451"></a><a name="USER"></a>user</h3></div></div></div><a class="indexterm" name="id2584452"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#USERNAME">username</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584482"></a><a name="USERS"></a>users</h3></div></div></div><a class="indexterm" name="id2584483"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#USERNAME">username</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584513"></a>
+
+username (S)
+</h3></div></div></div><a class="indexterm" name="id2584514"></a><a name="USERNAME"></a><div class="variablelist"><dl><dt></dt><dd><p>Multiple users may be specified in a comma-delimited
+ list, in which case the supplied password will be tested against
+ each username in turn (left to right).</p><p>The <em class="parameter"><code>username</code></em> line is needed only when
+ the PC is unable to supply its own username. This is the case
+ for the COREPLUS protocol or where your users have different WfWg
+ usernames to UNIX usernames. In both these cases you may also be
+ better using the \\server\share%user syntax instead.</p><p>The <em class="parameter"><code>username</code></em> line is not a great
+ solution in many cases as it means Samba will try to validate
+ the supplied password against each of the usernames in the
+ <em class="parameter"><code>username</code></em> line in turn. This is slow and
+ a bad idea for lots of users in case of duplicate passwords.
+ You may get timeouts or security breaches using this parameter
+ unwisely.</p><p>Samba relies on the underlying UNIX security. This
+ parameter does not restrict who can login, it just offers hints
+ to the Samba server as to what usernames might correspond to the
+ supplied password. Users can login as whoever they please and
+ they will be able to do no more damage than if they started a
+ telnet session. The daemon runs as the user that they log in as,
+ so they cannot do anything that user cannot do.</p><p>To restrict a service to a particular set of users you
+ can use the <a class="link" href="smb.conf.5.html#VALIDUSERS">valid users</a> parameter.</p><p>If any of the usernames begin with a '@' then the name
+ will be looked up first in the NIS netgroups list (if Samba
+ is compiled with netgroup support), followed by a lookup in
+ the UNIX groups database and will expand to a list of all users
+ in the group of that name.</p><p>If any of the usernames begin with a '+' then the name
+ will be looked up only in the UNIX groups database and will
+ expand to a list of all users in the group of that name.</p><p>If any of the usernames begin with a '&amp;' then the name
+ will be looked up only in the NIS netgroups database (if Samba
+ is compiled with netgroup support) and will expand to a list
+ of all users in the netgroup group of that name.</p><p>Note that searching though a groups database can take
+ quite some time, and some clients may time out during the
+ search.</p><p>See the section <a class="link" href="#VALIDATIONSECT" title="NOTE ABOUT USERNAME/PASSWORD VALIDATION">NOTE ABOUT
+ USERNAME/PASSWORD VALIDATION</a> for more information on how
+ this parameter determines access to the services.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">
+# The guest account if a guest service,
+ else &lt;empty string&gt;.</code>
</em></span>
-</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username map script</code></em> = <code class="literal">/etc/samba/scripts/mapusers.sh</code>
+</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>username</code></em> = <code class="literal">fred, mary, jack, jane, @users, @pcgroup</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREALLOWGUESTS"></a>usershare allow guests (G)</span></dt><dd><p>This parameter controls whether user defined shares are allowed
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584683"></a>
+
+usershare allow guests (G)
+</h3></div></div></div><a class="indexterm" name="id2584684"></a><a name="USERSHAREALLOWGUESTS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether user defined shares are allowed
to be accessed by non-authenticated users or not. It is the equivalent
of allowing people who can create a share the option of setting
<em class="parameter"><code>guest ok = yes</code></em> in a share
definition. Due to the security sensitive nature of this the default
is set to off.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare allow guests</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREMAXSHARES"></a>usershare max shares (G)</span></dt><dd><p>This parameter specifies the number of user defined shares
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584736"></a>
+
+usershare max shares (G)
+</h3></div></div></div><a class="indexterm" name="id2584737"></a><a name="USERSHAREMAXSHARES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of user defined shares
that are allowed to be created by users belonging to the group owning the
usershare directory. If set to zero (the default) user defined shares are ignored.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare max shares</code></em> = <code class="literal">0</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREOWNERONLY"></a>usershare owner only (G)</span></dt><dd><p>This parameter controls whether the pathname exported by
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584781"></a>
+
+usershare owner only (G)
+</h3></div></div></div><a class="indexterm" name="id2584782"></a><a name="USERSHAREOWNERONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether the pathname exported by
a user defined shares must be owned by the user creating the
user defined share or not. If set to True (the default) then
smbd checks that the directory path being shared is owned by
@@ -4653,7 +5669,10 @@ username map = /usr/local/samba/lib/users.map
regardless of who owns it.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare owner only</code></em> = <code class="literal">True</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREPATH"></a>usershare path (G)</span></dt><dd><p>This parameter specifies the absolute path of the directory on the
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584831"></a>
+
+usershare path (G)
+</h3></div></div></div><a class="indexterm" name="id2584832"></a><a name="USERSHAREPATH"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the absolute path of the directory on the
filesystem used to store the user defined share definition files.
This directory must be owned by root, and have no access for
other, and be writable only by the group owner. In addition the
@@ -4674,7 +5693,10 @@ username map = /usr/local/samba/lib/users.map
In this case, only members of the group "power_users" can create user defined shares.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>usershare path</code></em> = <code class="literal">NULL</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREPREFIXALLOWLIST"></a>usershare prefix allow list (G)</span></dt><dd><p>This parameter specifies a list of absolute pathnames
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584911"></a>
+
+usershare prefix allow list (G)
+</h3></div></div></div><a class="indexterm" name="id2584912"></a><a name="USERSHAREPREFIXALLOWLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a list of absolute pathnames
the root of which are allowed to be exported by user defined share definitions.
If the pathname exported doesn't start with one of the strings in this
list the user defined share will not be allowed. This allows the Samba
@@ -4689,7 +5711,10 @@ username map = /usr/local/samba/lib/users.map
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix allow list</code></em> = <code class="literal">/home /data /space</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHAREPREFIXDENYLIST"></a>usershare prefix deny list (G)</span></dt><dd><p>This parameter specifies a list of absolute pathnames
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2584984"></a>
+
+usershare prefix deny list (G)
+</h3></div></div></div><a class="indexterm" name="id2584985"></a><a name="USERSHAREPREFIXDENYLIST"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies a list of absolute pathnames
the root of which are NOT allowed to be exported by user defined share definitions.
If the pathname exported starts with one of the strings in this
list the user defined share will not be allowed. Any pathname not
@@ -4705,7 +5730,10 @@ username map = /usr/local/samba/lib/users.map
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare prefix deny list</code></em> = <code class="literal">/etc /dev /private</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USERSHARETEMPLATESHARE"></a>usershare template share (G)</span></dt><dd><p>User defined shares only have limited possible parameters
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585059"></a>
+
+usershare template share (G)
+</h3></div></div></div><a class="indexterm" name="id2585060"></a><a name="USERSHARETEMPLATESHARE"></a><div class="variablelist"><dl><dt></dt><dd><p>User defined shares only have limited possible parameters
such as path, guest ok etc. This parameter allows usershares to
"cloned" from an existing share. If "usershare template share"
is set to the name of an existing share, then all usershares
@@ -4720,7 +5748,10 @@ username map = /usr/local/samba/lib/users.map
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>usershare template share</code></em> = <code class="literal">template_share</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USESENDFILE"></a>use sendfile (S)</span></dt><dd><p>If this parameter is <code class="constant">yes</code>, and the <code class="constant">sendfile()</code>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585131"></a>
+
+use sendfile (S)
+</h3></div></div></div><a class="indexterm" name="id2585132"></a><a name="USESENDFILE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this parameter is <code class="constant">yes</code>, and the <code class="constant">sendfile()</code>
system call is supported by the underlying operating system, then some SMB read calls
(mainly ReadAndX and ReadRaw) will use the more efficient sendfile system call for files that
are exclusively oplocked. This may make more efficient use of the system CPU's
@@ -4729,7 +5760,10 @@ username map = /usr/local/samba/lib/users.map
Windows 9x (using sendfile from Linux will cause these clients to fail).
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use sendfile</code></em> = <code class="literal">false</code>
</em></span>
-</p></dd><dt><span class="term"><a name="USESPNEGO"></a>use spnego (G)</span></dt><dd><p>This variable controls controls whether samba will try
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585188"></a>
+
+use spnego (G)
+</h3></div></div></div><a class="indexterm" name="id2585190"></a><a name="USESPNEGO"></a><div class="variablelist"><dl><dt></dt><dd><p>This variable controls controls whether samba will try
to use Simple and Protected NEGOciation (as specified by rfc2478) with
WindowsXP and Windows2000 clients to agree upon an authentication mechanism.
</p><p>
@@ -4737,19 +5771,10 @@ username map = /usr/local/samba/lib/users.map
implementation, there is no reason this should ever be
disabled.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>use spnego</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="UTMP"></a>utmp (G)</span></dt><dd><p>
- This boolean parameter is only available if Samba has been configured and compiled
- with the option <code class="literal">--with-utmp</code>. If set to
- <code class="constant">yes</code> then Samba will attempt to add utmp or utmpx records
- (depending on the UNIX system) whenever a connection is made to a Samba server.
- Sites may use this to record the user connecting to a Samba share.
- </p><p>
- Due to the requirements of the utmp record, we are required to create a unique
- identifier for the incoming user. Enabling this option creates an n^2 algorithm
- to find this number. This may impede performance on large installations.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp</code></em> = <code class="literal">no</code>
-</em></span>
-</p></dd><dt><span class="term"><a name="UTMPDIRECTORY"></a>utmp directory (G)</span></dt><dd><p>This parameter is only available if Samba has
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585238"></a>
+
+utmp directory (G)
+</h3></div></div></div><a class="indexterm" name="id2585239"></a><a name="UTMPDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is only available if Samba has
been configured and compiled with the option <code class="literal">
--with-utmp</code>. It specifies a directory pathname that is
used to store the utmp or utmpx files (depending on the UNIX system) that
@@ -4761,16 +5786,25 @@ username map = /usr/local/samba/lib/users.map
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>utmp directory</code></em> = <code class="literal">/var/run/utmp</code>
</em></span>
-</p></dd><dt><span class="term"><a name="-VALID"></a>-valid (S)</span></dt><dd><p> This parameter indicates whether a share is
- valid and thus can be used. When this parameter is set to false,
- the share will be in no way visible nor accessible.
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585316"></a>
+
+utmp (G)
+</h3></div></div></div><a class="indexterm" name="id2585317"></a><a name="UTMP"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This boolean parameter is only available if Samba has been configured and compiled
+ with the option <code class="literal">--with-utmp</code>. If set to
+ <code class="constant">yes</code> then Samba will attempt to add utmp or utmpx records
+ (depending on the UNIX system) whenever a connection is made to a Samba server.
+ Sites may use this to record the user connecting to a Samba share.
</p><p>
- This option should not be
- used by regular users but might be of help to developers.
- Samba uses this option internally to mark shares as deleted.
- </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>-valid</code></em> = <code class="literal">yes</code>
+ Due to the requirements of the utmp record, we are required to create a unique
+ identifier for the incoming user. Enabling this option creates an n^2 algorithm
+ to find this number. This may impede performance on large installations.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>utmp</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="VALIDUSERS"></a>valid users (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585379"></a>
+
+valid users (S)
+</h3></div></div></div><a class="indexterm" name="id2585380"></a><a name="VALIDUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that should be allowed to login to this service. Names starting with
'@', '+' and '&amp;' are interpreted using the same rules as described in the
<em class="parameter"><code>invalid users</code></em> parameter.
@@ -4786,7 +5820,22 @@ username map = /usr/local/samba/lib/users.map
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>valid users</code></em> = <code class="literal">greg, @pcusers</code>
</em></span>
-</p></dd><dt><span class="term"><a name="VETOFILES"></a>veto files (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585470"></a>
+
+-valid (S)
+</h3></div></div></div><a class="indexterm" name="id2585471"></a><a name="-VALID"></a><div class="variablelist"><dl><dt></dt><dd><p> This parameter indicates whether a share is
+ valid and thus can be used. When this parameter is set to false,
+ the share will be in no way visible nor accessible.
+ </p><p>
+ This option should not be
+ used by regular users but might be of help to developers.
+ Samba uses this option internally to mark shares as deleted.
+ </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>-valid</code></em> = <code class="literal">yes</code>
+</em></span>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585519"></a>
+
+veto files (S)
+</h3></div></div></div><a class="indexterm" name="id2585520"></a><a name="VETOFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of files and directories that are neither visible nor accessible. Each entry in
the list must be separated by a '/', which allows spaces to be included in the entry. '*' and '?'
can be used to specify multiple files or directories as in DOS wildcards.
@@ -4794,11 +5843,11 @@ username map = /usr/local/samba/lib/users.map
Each entry must be a unix path, not a DOS path and must <span class="emphasis"><em>not</em></span> include the
unix directory separator '/'.
</p><p>
- Note that the <a class="indexterm" name="id335230"></a>case sensitive option is applicable in vetoing files.
+ Note that the <a class="link" href="smb.conf.5.html#CASESENSITIVE">case sensitive</a> option is applicable in vetoing files.
</p><p>
One feature of the veto files parameter that it is important to be aware of is Samba's behaviour when
trying to delete a directory. If a directory that is to be deleted contains nothing but veto files this
- deletion will <span class="emphasis"><em>fail</em></span> unless you also set the <a class="indexterm" name="id335247"></a>delete veto files
+ deletion will <span class="emphasis"><em>fail</em></span> unless you also set the <a class="link" href="smb.conf.5.html#DELETEVETOFILES">delete veto files</a>
parameter to <em class="parameter"><code>yes</code></em>.
</p><p>
Setting this parameter will affect the performance of Samba, as it will be forced to check all files
@@ -4817,12 +5866,15 @@ veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
</pre><p>
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto files</code></em> = <code class="literal">No files or directories are vetoed.</code>
</em></span>
-</p></dd><dt><span class="term"><a name="VETOOPLOCKFILES"></a>veto oplock files (S)</span></dt><dd><p>
- This parameter is only valid when the <a class="indexterm" name="id335315"></a>oplocks
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585638"></a>
+
+veto oplock files (S)
+</h3></div></div></div><a class="indexterm" name="id2585639"></a><a name="VETOOPLOCKFILES"></a><div class="variablelist"><dl><dt></dt><dd><p>
+ This parameter is only valid when the <a class="link" href="smb.conf.5.html#OPLOCKS">oplocks</a>
parameter is turned on for a share. It allows the Samba administrator
to selectively turn off the granting of oplocks on selected files that
match a wildcarded list, similar to the wildcarded list used in the
- <a class="indexterm" name="id335324"></a>veto files parameter.
+ <a class="link" href="smb.conf.5.html#VETOFILES">veto files</a> parameter.
</p><p>
You might want to do this on files that you know will be heavily contended
for by clients. A good example of this is in the NetBench SMB benchmark
@@ -4838,19 +5890,28 @@ veto oplock files = /.*SEM/
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>veto oplock files</code></em> = <code class="literal">
# No files are vetoed for oplock grants</code>
</em></span>
-</p></dd><dt><span class="term"><a name="VFSOBJECT"></a>vfs object</span></dt><dd><p>This parameter is a synonym for vfs objects.</p></dd><dt><span class="term"><a name="VFSOBJECTS"></a>vfs objects (S)</span></dt><dd><p>This parameter specifies the backend names which
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585731"></a><a name="VFSOBJECT"></a>vfs object</h3></div></div></div><a class="indexterm" name="id2585732"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#VFSOBJECTS">vfs objects</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585762"></a>
+
+vfs objects (S)
+</h3></div></div></div><a class="indexterm" name="id2585763"></a><a name="VFSOBJECTS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the backend names which
are used for Samba VFS I/O operations. By default, normal
disk I/O operations are used but these can be overloaded
with one or more VFS objects. </p><p>Default: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>vfs objects</code></em> = <code class="literal">extd_audit recycle</code>
</em></span>
-</p></dd><dt><span class="term"><a name="VOLUME"></a>volume (S)</span></dt><dd><p>This allows you to override the volume label
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585822"></a>
+
+volume (S)
+</h3></div></div></div><a class="indexterm" name="id2585823"></a><a name="VOLUME"></a><div class="variablelist"><dl><dt></dt><dd><p>This allows you to override the volume label
returned for a share. Useful for CDROMs with installation programs
that insist on a particular volume label.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>volume</code></em> = <code class="literal">
# the name of the share</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WIDELINKS"></a>wide links (S)</span></dt><dd><p>This parameter controls whether or not links
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585866"></a>
+
+wide links (S)
+</h3></div></div></div><a class="indexterm" name="id2585867"></a><a name="WIDELINKS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not links
in the UNIX file system may be followed by the server. Links
that point to areas within the directory tree exported by the
server are always allowed; this parameter controls access only
@@ -4858,15 +5919,21 @@ veto oplock files = /.*SEM/
effect on your server performance due to the extra system calls
that Samba has to do in order to perform the link checks.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wide links</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDCACHETIME"></a>winbind cache time (G)</span></dt><dd><p>This parameter specifies the number of
- seconds the <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon will cache
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585918"></a>
+
+winbind cache time (G)
+</h3></div></div></div><a class="indexterm" name="id2585919"></a><a name="WINBINDCACHETIME"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies the number of
+ seconds the <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon will cache
user and group information before querying a Windows NT server
again.</p><p>
This does not apply to authentication requests, these are always
- evaluated in real time unless the <a class="indexterm" name="id335568"></a>winbind offline logon option has been enabled.
+ evaluated in real time unless the <a class="link" href="smb.conf.5.html#WINBINDOFFLINELOGON">winbind offline logon</a> option has been enabled.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind cache time</code></em> = <code class="literal">300</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDENUMGROUPS"></a>winbind enum groups (G)</span></dt><dd><p>On large installations using <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be necessary to suppress
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2585989"></a>
+
+winbind enum groups (G)
+</h3></div></div></div><a class="indexterm" name="id2585990"></a><a name="WINBINDENUMGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>On large installations using <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be necessary to suppress
the enumeration of groups through the <code class="literal">setgrent()</code>,
<code class="literal">getgrent()</code> and
<code class="literal">endgrent()</code> group of system calls. If
@@ -4874,7 +5941,10 @@ veto oplock files = /.*SEM/
<code class="constant">no</code>, calls to the <code class="literal">getgrent()</code> system
call will not return any data. </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Turning off group enumeration may cause some programs to behave oddly. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum groups</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDENUMUSERS"></a>winbind enum users (G)</span></dt><dd><p>On large installations using <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586080"></a>
+
+winbind enum users (G)
+</h3></div></div></div><a class="indexterm" name="id2586081"></a><a name="WINBINDENUMUSERS"></a><div class="variablelist"><dl><dt></dt><dd><p>On large installations using <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> it may be
necessary to suppress the enumeration of users through the <code class="literal">setpwent()</code>,
<code class="literal">getpwent()</code> and
<code class="literal">endpwent()</code> group of system calls. If
@@ -4886,10 +5956,13 @@ veto oplock files = /.*SEM/
full user list when searching for matching
usernames. </p></div><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind enum users</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDEXPANDGROUPS"></a>winbind expand groups (G)</span></dt><dd><p>This option controls the maximum depth that winbindd
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586173"></a>
+
+winbind expand groups (G)
+</h3></div></div></div><a class="indexterm" name="id2586174"></a><a name="WINBINDEXPANDGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>This option controls the maximum depth that winbindd
will traverse when flattening nested group memberships
of Windows domain groups. This is different from the
- <a class="indexterm" name="id335788"></a>winbind nested groups option
+ <a class="link" href="smb.conf.5.html#WINBINDNESTEDGROUPS">winbind nested groups</a> option
which implements the Windows NT4 model of local group
nesting. The "winbind expand groups"
parameter specifically applies to the membership of
@@ -4898,7 +5971,10 @@ veto oplock files = /.*SEM/
must perform the group unrolling and will be unable to answer
incoming NSS or authentication requests during this time.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind expand groups</code></em> = <code class="literal">1</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDNESTEDGROUPS"></a>winbind nested groups (G)</span></dt><dd><p>If set to yes, this parameter activates the support for nested
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586242"></a>
+
+winbind nested groups (G)
+</h3></div></div></div><a class="indexterm" name="id2586243"></a><a name="WINBINDNESTEDGROUPS"></a><div class="variablelist"><dl><dt></dt><dd><p>If set to yes, this parameter activates the support for nested
groups. Nested groups are also called local groups or
aliases. They work like their counterparts in Windows: Nested
groups are defined locally on any machine (they are shared
@@ -4906,7 +5982,10 @@ veto oplock files = /.*SEM/
global groups from any trusted SAM. To be able to use nested
groups, you need to run nss_winbind.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind nested groups</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDNORMALIZENAMES"></a>winbind normalize names (G)</span></dt><dd><p>This parameter controls whether winbindd will replace
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586291"></a>
+
+winbind normalize names (G)
+</h3></div></div></div><a class="indexterm" name="id2586292"></a><a name="WINBINDNORMALIZENAMES"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether winbindd will replace
whitespace in user and group names with an underscore (_) character.
For example, whether the name "Space Kadet" should be
replaced with the string "space_kadet".
@@ -4918,14 +5997,17 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind normalize names</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDNSSINFO"></a>winbind nss info (G)</span></dt><dd><p>This parameter is designed to control how Winbind retrieves Name
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586358"></a>
+
+winbind nss info (G)
+</h3></div></div></div><a class="indexterm" name="id2586359"></a><a name="WINBINDNSSINFO"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control how Winbind retrieves Name
Service Information to construct a user's home directory and login shell.
Currently the following settings are available:
</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>template</code></em>
- The default, using the parameters of <em class="parameter"><code>template
shell</code></em> and <em class="parameter"><code>template homedir</code></em>)
- </p></li><li><p><em class="parameter"><code>sfu</code></em>
+ </p></li><li><p><em class="parameter"><code>&lt;sfu | rfc2307 &gt;</code></em>
- When Samba is running in security = ads and your Active Directory
Domain Controller does support the Microsoft "Services for Unix" (SFU)
LDAP schema, winbind can retrieve the login shell and the home
@@ -4940,7 +6022,10 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind nss info</code></em> = <code class="literal">template sfu</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDOFFLINELOGON"></a>winbind offline logon (G)</span></dt><dd><p>This parameter is designed to control whether Winbind should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586478"></a>
+
+winbind offline logon (G)
+</h3></div></div></div><a class="indexterm" name="id2586479"></a><a name="WINBINDOFFLINELOGON"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control whether Winbind should
allow to login with the <em class="parameter"><code>pam_winbind</code></em>
module using Cached Credentials. If enabled, winbindd will store user credentials
from successful logins encrypted in a local cache.
@@ -4948,20 +6033,29 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind offline logon</code></em> = <code class="literal">true</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDREFRESHTICKETS"></a>winbind refresh tickets (G)</span></dt><dd><p>This parameter is designed to control whether Winbind should refresh Kerberos Tickets
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586547"></a>
+
+winbind refresh tickets (G)
+</h3></div></div></div><a class="indexterm" name="id2586548"></a><a name="WINBINDREFRESHTICKETS"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is designed to control whether Winbind should refresh Kerberos Tickets
retrieved using the <em class="parameter"><code>pam_winbind</code></em> module.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">false</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind refresh tickets</code></em> = <code class="literal">true</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDRPCONLY"></a>winbind rpc only (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586614"></a>
+
+winbind rpc only (G)
+</h3></div></div></div><a class="indexterm" name="id2586615"></a><a name="WINBINDRPCONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
Setting this parameter to <code class="literal">yes</code> forces
winbindd to use RPC instead of LDAP to retrieve information from Domain
Controllers.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind rpc only</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDSEPARATOR"></a>winbind separator (G)</span></dt><dd><p>This parameter allows an admin to define the character
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586662"></a>
+
+winbind separator (G)
+</h3></div></div></div><a class="indexterm" name="id2586663"></a><a name="WINBINDSEPARATOR"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter allows an admin to define the character
used when listing a username of the form of <em class="replaceable"><code>DOMAIN
</code></em>\<em class="replaceable"><code>user</code></em>. This parameter
is only applicable when using the <code class="filename">pam_winbind.so</code>
@@ -4972,7 +6066,10 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind separator</code></em> = <code class="literal">+</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDTRUSTEDDOMAINSONLY"></a>winbind trusted domains only (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586750"></a>
+
+winbind trusted domains only (G)
+</h3></div></div></div><a class="indexterm" name="id2586751"></a><a name="WINBINDTRUSTEDDOMAINSONLY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is designed to allow Samba servers that are members
of a Samba controlled domain to use UNIX accounts distributed via NIS,
rsync, or LDAP as the uid's for winbindd users in the hosts primary domain.
@@ -4980,12 +6077,15 @@ veto oplock files = /.*SEM/
the account user1 in /etc/passwd instead of allocating a new uid for him or her.
</p><p>
This parameter is now deprecated in favor of the newer idmap_nss backend.
- Refer to the <a class="indexterm" name="id336317"></a>idmap domains smb.conf option and
- the <a href="idmap_nss.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_nss</span>(8)</span></a> man page for more information.
+ Refer to the <a class="link" href="smb.conf.5.html#IDMAPDOMAINS">idmap domains</a> smb.conf option and
+ the <a class="citerefentry" href="idmap_nss.8.html"><span class="citerefentry"><span class="refentrytitle">idmap_nss</span>(8)</span></a> man page for more information.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>winbind trusted domains only</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINBINDUSEDEFAULTDOMAIN"></a>winbind use default domain (G)</span></dt><dd><p>This parameter specifies whether the
- <a href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon should operate on users
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586828"></a>
+
+winbind use default domain (G)
+</h3></div></div></div><a class="indexterm" name="id2586829"></a><a name="WINBINDUSEDEFAULTDOMAIN"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter specifies whether the
+ <a class="citerefentry" href="winbindd.8.html"><span class="citerefentry"><span class="refentrytitle">winbindd</span>(8)</span></a> daemon should operate on users
without domain component in their username. Users without a domain
component are treated as is part of the winbindd server's own
domain. While this does not benifit Windows users, it makes SSH, FTP and
@@ -4994,7 +6094,10 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>winbind use default domain</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINSHOOK"></a>wins hook (G)</span></dt><dd><p>When Samba is running as a WINS server this
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2586901"></a>
+
+wins hook (G)
+</h3></div></div></div><a class="indexterm" name="id2586902"></a><a name="WINSHOOK"></a><div class="variablelist"><dl><dt></dt><dd><p>When Samba is running as a WINS server this
allows you to call an external program for all changes to the
WINS database. The primary use for this option is to allow the
dynamic update of external name resolution databases such as
@@ -5015,12 +6118,18 @@ veto oplock files = /.*SEM/
addresses currently registered for that name. If this list is
empty then the name should be deleted.</p></li></ul></div><p>An example script that calls the BIND dynamic DNS update
program <code class="literal">nsupdate</code> is provided in the examples
- directory of the Samba source code. </p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="WINSPROXY"></a>wins proxy (G)</span></dt><dd><p>This is a boolean that controls if <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will respond to broadcast name
+ directory of the Samba source code. </p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587007"></a>
+
+wins proxy (G)
+</h3></div></div></div><a class="indexterm" name="id2587008"></a><a name="WINSPROXY"></a><div class="variablelist"><dl><dt></dt><dd><p>This is a boolean that controls if <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> will respond to broadcast name
queries on behalf of other hosts. You may need to set this
to <code class="constant">yes</code> for some older clients.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins proxy</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINSSERVER"></a>wins server (G)</span></dt><dd><p>This specifies the IP address (or DNS name: IP
- address for preference) of the WINS server that <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> should register with. If you have a WINS server on
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587062"></a>
+
+wins server (G)
+</h3></div></div></div><a class="indexterm" name="id2587063"></a><a name="WINSSERVER"></a><div class="variablelist"><dl><dt></dt><dd><p>This specifies the IP address (or DNS name: IP
+ address for preference) of the WINS server that <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> should register with. If you have a WINS server on
your network then you should set this to the WINS server's IP.</p><p>You should point this at your WINS server if you have a
multi-subnetted network.</p><p>If you want to work in multiple namespaces, you can
give every wins server a 'tag'. For each tag, only one
@@ -5038,21 +6147,33 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wins server</code></em> = <code class="literal">192.9.200.1 192.168.2.61</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WINSSUPPORT"></a>wins support (G)</span></dt><dd><p>This boolean controls if the <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> process in Samba will act as a WINS server. You should
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587172"></a>
+
+wins support (G)
+</h3></div></div></div><a class="indexterm" name="id2587173"></a><a name="WINSSUPPORT"></a><div class="variablelist"><dl><dt></dt><dd><p>This boolean controls if the <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a> process in Samba will act as a WINS server. You should
not set this to <code class="constant">yes</code> unless you have a multi-subnetted network and
you wish a particular <code class="literal">nmbd</code> to be your WINS server.
Note that you should <span class="emphasis"><em>NEVER</em></span> set this to <code class="constant">yes</code>
on more than one machine in your network.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>wins support</code></em> = <code class="literal">no</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WORKGROUP"></a>workgroup (G)</span></dt><dd><p>This controls what workgroup your server will
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587242"></a>
+
+workgroup (G)
+</h3></div></div></div><a class="indexterm" name="id2587243"></a><a name="WORKGROUP"></a><div class="variablelist"><dl><dt></dt><dd><p>This controls what workgroup your server will
appear to be in when queried by clients. Note that this parameter
also controls the Domain name used with
- the <a class="indexterm" name="id336750"></a>security = domain
+ the <a class="link" href="smb.conf.5.html#SECURITY">security = domain</a>
setting.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">WORKGROUP</code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>workgroup</code></em> = <code class="literal">MYGROUP</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WRITABLE"></a>writable</span></dt><dd><p>This parameter is a synonym for writeable.</p></dd><dt><span class="term"><a name="WRITEABLE"></a>writeable (S)</span></dt><dd><p>Inverted synonym for <a class="indexterm" name="id336834"></a>read only.</p><p><span class="emphasis"><em>No default</em></span></p></dd><dt><span class="term"><a name="WRITECACHESIZE"></a>write cache size (S)</span></dt><dd><p>If this integer parameter is set to non-zero value,
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587314"></a><a name="WRITABLE"></a>writable</h3></div></div></div><a class="indexterm" name="id2587315"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter is a synonym for <a class="link" href="#WRITEABLE">writeable</a>.</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587344"></a>
+
+writeable (S)
+</h3></div></div></div><a class="indexterm" name="id2587345"></a><a name="WRITEABLE"></a><div class="variablelist"><dl><dt></dt><dd><p>Inverted synonym for <a class="link" href="smb.conf.5.html#READONLY">read only</a>.</p><p><span class="emphasis"><em>No default</em></span></p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587383"></a>
+
+write cache size (S)
+</h3></div></div></div><a class="indexterm" name="id2587384"></a><a name="WRITECACHESIZE"></a><div class="variablelist"><dl><dt></dt><dd><p>If this integer parameter is set to non-zero value,
Samba will create an in-memory cache for each oplocked file
(it does <span class="emphasis"><em>not</em></span> do this for
non-oplocked files). All writes that the client does not request
@@ -5070,26 +6191,35 @@ veto oplock files = /.*SEM/
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write cache size</code></em> = <code class="literal">262144
# for a 256k cache size per file</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WRITELIST"></a>write list (S)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587473"></a>
+
+write list (S)
+</h3></div></div></div><a class="indexterm" name="id2587474"></a><a name="WRITELIST"></a><div class="variablelist"><dl><dt></dt><dd><p>
This is a list of users that are given read-write access to a service. If the
connecting user is in this list then they will be given write access, no matter
- what the <a class="indexterm" name="id336942"></a>read only option is set to. The list can
+ what the <a class="link" href="smb.conf.5.html#READONLY">read only</a> option is set to. The list can
include group names using the @group syntax.
</p><p>
Note that if a user is in both the read list and the write list then they will be
given write access.
</p><p>
By design, this parameter will not work with the
- <a class="indexterm" name="id336958"></a>security = share in Samba 3.0.
+ <a class="link" href="smb.conf.5.html#SECURITY">security = share</a> in Samba 3.0.
</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal"></code>
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>write list</code></em> = <code class="literal">admin, root, @staff</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WRITERAW"></a>write raw (G)</span></dt><dd><p>This parameter controls whether or not the server
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587566"></a>
+
+write raw (G)
+</h3></div></div></div><a class="indexterm" name="id2587567"></a><a name="WRITERAW"></a><div class="variablelist"><dl><dt></dt><dd><p>This parameter controls whether or not the server
will support raw write SMB's when transferring data from clients.
You should never need to change this parameter.</p><p>Default: <span class="emphasis"><em><em class="parameter"><code>write raw</code></em> = <code class="literal">yes</code>
</em></span>
-</p></dd><dt><span class="term"><a name="WTMPDIRECTORY"></a>wtmp directory (G)</span></dt><dd><p>
+</p></dd></dl></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2587610"></a>
+
+wtmp directory (G)
+</h3></div></div></div><a class="indexterm" name="id2587611"></a><a name="WTMPDIRECTORY"></a><div class="variablelist"><dl><dt></dt><dd><p>
This parameter is only available if Samba has been configured and compiled with the option <code class="literal">
--with-utmp</code>. It specifies a directory pathname that is used to store the wtmp or wtmpx files (depending on
the UNIX system) that record user connections to a Samba server. The difference with the utmp directory is the fact
@@ -5101,12 +6231,12 @@ veto oplock files = /.*SEM/
</em></span>
</p><p>Example: <span class="emphasis"><em><em class="parameter"><code>wtmp directory</code></em> = <code class="literal">/var/log/wtmp</code>
</em></span>
-</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id337116"></a><h2>WARNINGS</h2><p>
+</p></dd></dl></div></div></div></div><div class="refsect1" lang="en"><a name="id2587693"></a><h2>WARNINGS</h2><p>
Although the configuration file permits service names to contain spaces, your client software may not.
Spaces will be ignored in comparisons anyway, so it shouldn't be a problem - but be aware of the possibility.
</p><p>
On a similar note, many clients - especially DOS clients - limit service names to eight characters.
- <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has no such
+ <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a> has no such
limitation, but attempts to connect from such clients will fail if they truncate the service names. For this
reason you should probably keep your service names down to eight characters in length.
</p><p>
@@ -5114,13 +6244,13 @@ veto oplock files = /.*SEM/
for an administrator easy, but the various combinations of default attributes can be tricky. Take extreme
care when designing these sections. In particular, ensure that the permissions on spool directories are
correct.
- </p></div><div class="refsect1" lang="en"><a name="id337159"></a><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id337169"></a><h2>SEE ALSO</h2><p>
- <a href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, <a href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a>, <a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a>, <a href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id337249"></a><h2>AUTHOR</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2587743"></a><h2>VERSION</h2><p>This man page is correct for version 3 of the Samba suite.</p></div><div class="refsect1" lang="en"><a name="id2587754"></a><h2>SEE ALSO</h2><p>
+ <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a>, <a class="citerefentry" href="smbpasswd.8.html"><span class="citerefentry"><span class="refentrytitle">smbpasswd</span>(8)</span></a>, <a class="citerefentry" href="swat.8.html"><span class="citerefentry"><span class="refentrytitle">swat</span>(8)</span></a>, <a class="citerefentry" href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a class="citerefentry" href="nmbd.8.html"><span class="citerefentry"><span class="refentrytitle">nmbd</span>(8)</span></a>, <a class="citerefentry" href="smbclient.1.html"><span class="citerefentry"><span class="refentrytitle">smbclient</span>(1)</span></a>, <a class="citerefentry" href="nmblookup.1.html"><span class="citerefentry"><span class="refentrytitle">nmblookup</span>(1)</span></a>, <a class="citerefentry" href="testparm.1.html"><span class="citerefentry"><span class="refentrytitle">testparm</span>(1)</span></a>, <a class="citerefentry" href="testprns.1.html"><span class="citerefentry"><span class="refentrytitle">testprns</span>(1)</span></a>.</p></div><div class="refsect1" lang="en"><a name="id2587834"></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">
+ excellent piece of Open Source software, available at <a class="ulink" 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. The conversion to DocBook XML 4.2 for Samba 3.0 was done by
Alexander Bokovoy.