<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry xmlns:xi="http://www.w3.org/2003/XInclude" xmlns:samba="http://www.samba.org/samba/DTD/samba-doc" id="smb.conf.5">
	
<refmeta>
	<refentrytitle>smb.conf</refentrytitle>
	<manvolnum>5</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
	<refmiscinfo class="version">4.2</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>smb.conf</refname>
	<refpurpose>The configuration file for the Samba suite</refpurpose>
</refnamediv>

<refsect1>
	<title>SYNOPSIS</title>

	<para>
	The <filename moreinfo="none">smb.conf</filename> file is a configuration  file for the Samba suite. <filename moreinfo="none">smb.conf</filename> contains  runtime configuration information for the Samba programs. The
	complete description of the file format and possible parameters held within are here for reference purposes.
	</para>
</refsect1>

<refsect1 id="FILEFORMATSECT">
	<title>FILE FORMAT</title>

	<para>
	The file consists of sections and parameters. A section begins with the name of the section in square brackets
	and continues until the next section begins. Sections contain parameters of the form:
<programlisting>
<replaceable>name</replaceable> = <replaceable>value </replaceable>
</programlisting>
	</para>

	<para>
	The file is line-based - that is, each newline-terminated line represents either a comment, a section name or
	a parameter.
	</para>

	<para>Section and parameter names are not case sensitive.</para>

	<para>
	Only the first equals sign in a parameter is significant.  Whitespace before or after the first equals sign is
	discarded.  Leading, trailing and internal whitespace in section and parameter names is irrelevant. Leading
	and trailing whitespace in a parameter value is discarded. Internal whitespace within a parameter value is
	retained verbatim.
	</para>

	<para>
	Any line beginning with a semicolon (<quote>;</quote>) or a hash (<quote>#</quote>) 
	character is ignored, as are lines containing only whitespace.
	</para>

	<para>
	Any line ending in a <quote><literal>\</literal></quote> is continued on the next line in the customary UNIX fashion.
	</para>

	<para>
	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, 1/0 or true/false. Case is not significant in boolean values, but is preserved
	in string values. Some items such as create masks are numeric.
	</para>

</refsect1>

<refsect1>
	<title>SECTION DESCRIPTIONS</title>

	<para>
	Each section in the configuration file (except for the [global] section) describes a shared resource (known as
	a <quote>share</quote>). The section name is the name of the shared resource and the parameters within the
	section define the shares attributes.
	</para>

	<para>
	There are three special sections, [global], [homes] and [printers], which are described under
	 <emphasis>special sections</emphasis>. The following notes apply to ordinary section descriptions.
	</para>

	<para>
	A share consists of a directory to which access is being given plus a description of the access rights
	which are granted to the user of the service. Some housekeeping options are also specifiable.
	</para>
	
	<para>
	Sections are either file share services (used by the client as an extension of their native file systems)
	or printable services (used by the client to access print services on the host running the server).
	</para>
	
	<para>
	Sections may be designated <emphasis>guest</emphasis> services, in which case no password is required to
	access them. A specified UNIX <emphasis>guest account</emphasis> is used to define access privileges in this
	case.
	</para>

	<para>
	Sections other than guest services will require a password to access them. The client provides the
	username. As older clients only provide passwords and not usernames, you may specify a list of usernames to
	check against the password using the <literal>user =</literal> option in the share definition. For modern clients
	such as Windows 95/98/ME/NT/2000, this should not be necessary.
	</para> 

	<para>
	The access rights granted by the server are masked by the access rights granted to the specified or guest
	UNIX user by the host system. The server does not grant more access than the host system grants.
	</para>
	
	<para>
	The following sample section defines a file space share.  The user has write access to the path <filename moreinfo="none">/home/bar</filename>.  The share is accessed via the share name <literal>foo</literal>:
<programlisting>
	<parameter>[foo]</parameter>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PATH" xlink:href="smb.conf.5.html#PATH">path = /home/bar</link>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only = no</link>
</programlisting>
	</para>

	<para>
	The following sample section defines a printable share.  The share is read-only, but printable. That is,
	the only write access permitted is via calls to open, write to and close a spool file. The <emphasis>guest
	ok</emphasis> parameter means access will be permitted as the default guest user (specified elsewhere):
<programlisting>
	<parameter>[aprinter]</parameter>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PATH" xlink:href="smb.conf.5.html#PATH">path = /usr/spool/public</link>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only = yes</link>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTABLE" xlink:href="smb.conf.5.html#PRINTABLE">printable = yes</link>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok = yes</link>
</programlisting>
	</para>

</refsect1>

<refsect1>
	<title>SPECIAL SECTIONS</title>
	
	<refsect2>
		<title>The [global] section</title>
		
		<para>
		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.
		</para>
	</refsect2>
	
	<refsect2 id="HOMESECT">
		<title>The [homes] section</title>
		
		<para>
		If a section called [homes] is included in the configuration file, services connecting clients
		to their home directories can be created on the fly by the server.
		</para>

		<para>
		When the connection request is made, the existing sections are scanned. If a match is found, it is
		used. If no match is found, the requested section name is treated as a username and looked up in the local
		password file. If the name exists and the correct password has been given, a share is created by cloning the
		[homes] section.
		</para>
		
		<para>
		Some modifications are then made to the newly created share:
		</para>
		
		<itemizedlist>
			<listitem><para>
			The share name is changed from homes to the located username.
			</para></listitem>

			<listitem><para>
			If no path was given, the path is set to the user's home directory.
			</para></listitem>
		</itemizedlist>

		<para>
		If you decide to use a <emphasis>path =</emphasis> line in your [homes] section, it may be useful 
		to use the %S macro. For example:
<programlisting>
<userinput moreinfo="none">path = /data/pchome/%S</userinput>
</programlisting>
		is useful if you have different home directories for your PCs than for UNIX access.
		</para>

		<para>
		This is a fast and simple way to give a large number of clients access to their home directories with a minimum 
		of fuss.
		</para>

		<para>
		A similar process occurs if the requested section name is <quote>homes</quote>, except that the share
		name is not changed to that of the requesting user. This method of using the [homes] section works well if
		different users share a client PC.
		</para>
		
		<para>
		The [homes] section can specify all the parameters a normal service section can specify, though some make more sense 
		than others. The following is a typical and suitable [homes] section:
<programlisting>
<parameter>[homes]</parameter>
<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only = no</link>
</programlisting>
		</para>
	
		<para>
		An important point is that if guest access is specified in the [homes] section, all home directories will be 
		visible to all clients <emphasis>without a password</emphasis>.  In the very unlikely event that this is actually
		desirable, it is wise to also specify <emphasis>read only access</emphasis>.
		</para>

		<para>
		The <emphasis>browseable</emphasis> flag for auto home directories will be inherited from the global browseable 
		flag, not the [homes] browseable flag. This is useful as it means setting <emphasis>browseable = no</emphasis> in
		the [homes] section will hide the [homes] share but make any auto home directories visible.
		</para>
	</refsect2>

	<refsect2 id="PRINTERSSECT">
		<title>The [printers] section</title>
		
		<para>
		This section works like [homes], but for printers.
		</para>

		<para>
		If a [printers] section occurs in the configuration file, users are able to connect to any printer 
		specified in the local host's printcap file.
		</para>

		<para>
		When a connection request is made, the existing sections are scanned. If a match is found, it is used.
		If no match is found, but a [homes] section exists, it is used as described above. Otherwise, the requested
		section name is treated as a printer name and the appropriate printcap file is scanned to see if the requested
		section name is a valid printer share name. If a match is found, a new printer share is created by cloning the
		[printers] section.
		</para>

		<para>
		A few modifications are then made to the newly created share:
		</para>

		<itemizedlist>
			<listitem><para>The share name is set to the located printer name</para></listitem>

			<listitem><para>If no printer name was given, the printer name is set to the located printer name</para></listitem>

			<listitem><para>If the share does not permit guest access and no username was given, the username is set
				to the located printer name.</para></listitem>
		</itemizedlist>

		<para>
		The [printers] service MUST be printable - if you specify otherwise, the server will refuse 
		to load the configuration file.
		</para>
		
		<para>
		Typically the path specified is that of a world-writeable spool directory with the sticky bit set on 
		it. A typical [printers] entry looks like this:
<programlisting>
<parameter>[printers]</parameter>
<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PATH" xlink:href="smb.conf.5.html#PATH">path = /usr/spool/public</link>
<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok = yes</link>
<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTABLE" xlink:href="smb.conf.5.html#PRINTABLE">printable = yes</link>
</programlisting>
		</para>

		<para>
		All aliases given for a printer in the printcap file are legitimate printer names as far as the server is concerned. 
		If your printing subsystem doesn't work like that, you will have to set up a pseudo-printcap. This is a file
		consisting of one or more lines like this:
<programlisting>
alias|alias|alias|alias...    
</programlisting>
		</para>

		<para>
		Each alias should be an acceptable printer name for your printing subsystem. In the [global] section,
		specify the new file as your printcap.  The server will only recognize names found in your pseudo-printcap,
		which of course can contain whatever aliases you like. The same technique could be used simply to limit access
		to a subset of your local printers.
		</para>

		<para>
		An alias, by the way, is defined as any component of the first entry of a printcap record. Records are separated by newlines,
		components (if there are more than one) are separated by vertical bar symbols (<literal>|</literal>).
		</para>
		
		<note><para>
		On SYSV systems which use lpstat to determine what printers are defined on the system you may be able to use
		<literal>printcap name = lpstat</literal> to automatically obtain a list of printers. See the
		<literal>printcap name</literal> option for more details.
		</para></note>
	</refsect2>
</refsect1>

<refsect1>
	<title>USERSHARES</title>

	<para>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 <emphasis>usershares</emphasis> and
	is controlled by a set of parameters in the [global] section of the smb.conf.
	The relevant parameters are :
	</para>

	<variablelist>
		<varlistentry>
		<term>usershare allow guests</term>
		<listitem><para>Controls if usershares can permit guest access.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare max shares</term>
		<listitem><para>Maximum number of user defined shares allowed.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare owner only</term>
		<listitem><para>If set only directories owned by the sharing user can be shared.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare path</term>
		<listitem><para>Points to the directory containing the user defined share definitions.
		The filesystem permissions on this directory control who can create user defined shares.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare prefix allow list</term>
		<listitem><para>Comma-separated list of absolute pathnames restricting what directories
		can be shared. Only directories below the pathnames in this list are permitted.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare prefix deny list</term>
		<listitem><para>Comma-separated list of absolute pathnames restricting what directories
		can be shared. Directories below the pathnames in this list are prohibited.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>usershare template share</term>
		<listitem><para>Names a pre-existing share used as a template for creating new usershares.
		All other share parameters not specified in the user defined share definition
		are copied from this named share.</para></listitem>
		</varlistentry>
	</variablelist>

	<para>To allow members of the UNIX group <literal>foo</literal> to create user defined
	shares, create the directory to contain the share definitions as follows:
	</para>
	<para>Become root:</para>
<programlisting>
mkdir /usr/local/samba/lib/usershares
chgrp foo /usr/local/samba/lib/usershares
chmod 1770 /usr/local/samba/lib/usershares
</programlisting>
<para>Then add the parameters 

<programlisting>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERSHAREPATH" xlink:href="smb.conf.5.html#USERSHAREPATH">usershare path = /usr/local/samba/lib/usershares</link>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERSHAREMAXSHARES" xlink:href="smb.conf.5.html#USERSHAREMAXSHARES">usershare max shares = 10</link> # (or the desired number of shares)
</programlisting> 

	to the global
	section of your <filename>smb.conf</filename>. Members of the group foo may then manipulate the user defined shares
	using the following commands.</para>

	<variablelist>
		<varlistentry>
		<term>net usershare add sharename path [comment] [acl] [guest_ok=[y|n]]</term>
		<listitem><para>To create or modify (overwrite) a user defined share.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>net usershare delete sharename</term>
		<listitem><para>To delete a user defined share.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>net usershare list wildcard-sharename</term>
		<listitem><para>To list user defined shares.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>net usershare info wildcard-sharename</term>
		<listitem><para>To print information about user defined shares.</para></listitem>
		</varlistentry>
	</variablelist>
</refsect1>
	
<refsect1>
	<title>PARAMETERS</title>

	<para>Parameters define the specific attributes of sections.</para>

	<para>
	Some parameters are specific to the [global] section (e.g., <emphasis>security</emphasis>).  Some parameters
	are usable in all sections (e.g., <emphasis>create mask</emphasis>). All others are permissible only in normal
	sections. For the purposes of the following descriptions the [homes] and [printers] sections will be
	considered normal.  The letter <emphasis>G</emphasis> in parentheses indicates that a parameter is specific to
	the [global] section. The letter <emphasis>S</emphasis> indicates that a parameter can be specified in a
	service specific section. All <emphasis>S</emphasis> parameters can also be specified in the [global] section
	- in which case they will define the default behavior for all services.
	</para>

	<para>
	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.
	</para>
</refsect1>

<refsect1>
	<title>VARIABLE SUBSTITUTIONS</title>

	<para>
	Many of the strings that are settable in the config file can take substitutions. For example the option
	<quote>path = /tmp/%u</quote> is interpreted as <quote>path = /tmp/john</quote> if the user connected with the
	username john.
	</para>

	<para>
	These substitutions are mostly noted in the descriptions below, but there are some general substitutions
	which apply whenever they might be relevant. These are:
	</para>

	<variablelist>
		<varlistentry>
		<term>%U</term>
		<listitem><para>session username (the username that the client wanted, not
			necessarily the same as the one they got).</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%G</term>
		<listitem><para>primary group name of %U.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>%h</term>
		<listitem><para>the Internet hostname that Samba is running on.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>%m</term>
		<listitem><para>the NetBIOS name of the client machine (very useful).</para>

			<para>This parameter is not available when Samba listens on port 445, as clients no longer
			send this information. If you use this macro in an include statement on a domain that has
			a Samba domain controller be sure to set in the [global] section <parameter>smb ports =
			139</parameter>. This will cause Samba to not listen on port 445 and will permit include
			functionality to function as it did with Samba 2.x.
			</para></listitem>

		</varlistentry>
		
		<varlistentry>
		<term>%L</term>
		<listitem><para>the NetBIOS name of the server. This allows you to change your config based on what
			the client calls you. Your server can have a <quote>dual personality</quote>.
		</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%M</term>
		<listitem><para>the Internet name of the client machine.
		</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%R</term>
		<listitem><para>the selected protocol level after protocol negotiation. It can be one of
			CORE, COREPLUS, LANMAN1, LANMAN2, NT1,
			SMB2_02, SMB2_10, SMB2_22, SMB2_24,
			SMB3_00, SMB3_02, SMB3_10, SMB3_11
			or SMB2_FF.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>%d</term>
		<listitem><para>the process id of the current server
			process.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%a</term>
		<listitem><para>
		    The architecture of the remote
		    machine.  It currently recognizes Samba (<constant>Samba</constant>), 
		    the Linux CIFS file system (<constant>CIFSFS</constant>), OS/2, (<constant>OS2</constant>),
		    Mac OS X (<constant>OSX</constant>), Windows for Workgroups (<constant>WfWg</constant>), Windows 9x/ME 
		    (<constant>Win95</constant>), Windows NT (<constant>WinNT</constant>),
		    Windows 2000 (<constant>Win2K</constant>),
		    Windows XP (<constant>WinXP</constant>),
		    Windows XP 64-bit(<constant>WinXP64</constant>),
		    Windows 2003 including
		    2003R2 (<constant>Win2K3</constant>), and Windows
		    Vista (<constant>Vista</constant>).  Anything else will be known as 
		    <constant>UNKNOWN</constant>.</para> 
		</listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%I</term>
		<listitem><para>the IP address of the client machine.</para>
		<para>Before 4.0.0 it could contain IPv4 mapped IPv6 addresses,
			now it only contains IPv4 or IPv6 addresses.</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>%i</term>
		<listitem><para>the local IP address to which a client connected.</para>
		<para>Before 4.0.0 it could contain IPv4 mapped IPv6 addresses,
			now it only contains IPv4 or IPv6 addresses.</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>%T</term>
		<listitem><para>the current date and time.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>%D</term>
		<listitem><para>name of the domain or workgroup of the current user.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%w</term>
		<listitem><para>the winbind separator.</para></listitem>
		</varlistentry>
		
		<varlistentry>
		<term>%$(<replaceable>envvar</replaceable>)</term>
		<listitem><para>the value of the environment variable
		<replaceable>envar</replaceable>.</para></listitem>
		</varlistentry>
	</variablelist>

	<para>
	The following substitutes apply only to some configuration options (only those that are
	used when a connection has been established):
	</para>

	<variablelist>
		<varlistentry>
		<term>%S</term>
		<listitem><para>the name of the current service, if any.</para>
		</listitem>
		</varlistentry>
	
		<varlistentry>
		<term>%P</term>
		<listitem><para>the root directory of the current service, if any.</para></listitem>
		</varlistentry>
	
		<varlistentry>
		<term>%u</term>
		<listitem><para>username of the current service, if any.</para>
		</listitem>
		</varlistentry>
	
		<varlistentry>
		<term>%g</term>
		<listitem><para>primary group name of %u.</para></listitem>
		</varlistentry>
	
		<varlistentry>
		<term>%H</term>
		<listitem><para>the home directory of the user given by %u.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>%N</term>
		<listitem><para>
			the name of your NIS home directory server.  This is obtained from your NIS auto.map entry. 
			If you have not compiled Samba with the <emphasis>--with-automount</emphasis> option, this
			value will be the same as %L.</para></listitem>
		</varlistentry>
	
		<varlistentry>
		<term>%p</term>
		<listitem><para>
			the path of the service's home directory, obtained from your NIS auto.map entry. The NIS
			auto.map entry is split up as <literal>%N:%p</literal>.</para></listitem>
		</varlistentry>
	</variablelist>
	
	<para>
	There are some quite creative things that can be done with these substitutions and other
	<filename moreinfo="none">smb.conf</filename> options.
	</para>
</refsect1>

<refsect1 id="NAMEMANGLINGSECT">
	<title>NAME MANGLING</title>
	
	<para>
	Samba supports <literal>name mangling</literal> so that DOS and Windows clients can use files that don't
	conform to the 8.3 format. It can also be set to adjust the case of 8.3 format filenames.
	</para>

	<para>
	There are several options that control the way mangling is performed, and they are grouped here rather
	than listed separately. For the defaults look at the output of the testparm program.
	</para>

	<para>
	These options can be set separately for each service.
	</para>

	<para>
	The options are:
	</para>
	
	<variablelist>
	
	<varlistentry>
		<term>case sensitive = yes/no/auto</term>
		<listitem><para>
		controls whether filenames are case sensitive. If they aren't, Samba must do a filename search and match on
		passed names. The default setting of auto allows clients that support case sensitive filenames (Linux CIFSVFS
		and smbclient 3.0.5 and above currently) to tell the Samba server on a per-packet basis that they wish to
		access the file system in a case-sensitive manner (to support UNIX case sensitive semantics). No Windows or
		DOS system supports case-sensitive filename so setting this option to auto is that same as setting it to no
		for them. Default <emphasis>auto</emphasis>.
		</para></listitem>
		</varlistentry> 

		<varlistentry>
		<term>default case = upper/lower</term>
		<listitem><para>
		controls what the default case is for new filenames (ie. files that don't currently exist in the filesystem).
		Default <emphasis>lower</emphasis>.  IMPORTANT NOTE: As part of the optimizations for directories containing
		large numbers of files, the following special case applies. If the options
		<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CASESENSITIVE" xlink:href="smb.conf.5.html#CASESENSITIVE">case sensitive = yes</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRESERVECASE" xlink:href="smb.conf.5.html#PRESERVECASE">preserve case = No</link>, and
		<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SHORTPRESERVECASE" xlink:href="smb.conf.5.html#SHORTPRESERVECASE">short preserve case = No</link> are set, then the case of <emphasis>all</emphasis>
		incoming client filenames, not just new filenames, will be modified. See additional notes below.
		</para></listitem>
		</varlistentry> 
	
		<varlistentry>
		<term>preserve case = yes/no</term>
		<listitem><para>
		controls whether new files (ie. files that don't currently exist in the filesystem) are created with the case
		that the client passes, or if they are forced to be the <literal>default</literal> case. Default
		<emphasis>yes</emphasis>.
		</para></listitem>
		</varlistentry> 

		<varlistentry>
		<term>short preserve case = yes/no</term>
		<listitem><para>
		controls if new files (ie. files that don't currently exist in the filesystem) 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
		<literal>default</literal> case. This option can be used with <literal>preserve case = yes</literal> to permit
		long filenames to retain their case, while short names are lowercased. Default <emphasis>yes</emphasis>.
		</para></listitem>
		</varlistentry> 
	</variablelist>
	
	<para>
	By default, Samba 3.0 has the same semantics as a Windows NT server, in that it is case insensitive
	but case preserving. As a special case for directories with large numbers of files, if the case
	options are set as follows, "case sensitive = yes", "case preserve = no", "short preserve case = no"
	then the "default case" option will be applied and will modify all filenames sent from the client
	when accessing this share.
	</para>
	
</refsect1>

<refsect1>
	<title>REGISTRY-BASED CONFIGURATION</title>

	<para>
		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
		 <emphasis><literal>HKLM\Software\Samba\smbconf</literal></emphasis>.
		There are two levels of registry configuration:
	</para>

	<orderedlist continuation="restarts" inheritnum="ignore" numeration="arabic">
		<listitem><para>Share definitions stored in registry are used.
		This is triggered by setting the global 
		parameter <parameter>registry shares</parameter>
		to <quote>yes</quote> in <emphasis>smb.conf</emphasis>.
		</para>

		<para>The registry shares are loaded not at startup but
		on demand at runtime by <emphasis>smbd</emphasis>.
		Shares defined in <emphasis>smb.conf</emphasis> take
		priority over shares of the same name defined in
		registry.</para></listitem>

		<listitem>
		<para>Global <emphasis>smb.conf</emphasis>
		options stored in registry are used. This can be activated
		in two different ways:</para>

		<para>Firstly, a registry only configuration is triggered
		by setting
		<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CONFIGBACKEND" xlink:href="smb.conf.5.html#CONFIGBACKEND">config backend = registry</link>
		in the [global] section of <emphasis>smb.conf</emphasis>.
		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.
		This is the recommended method of using registry based
		configuration.</para>

		<para>Secondly, a mixed configuration can be activated
		by a special new meaning of the parameter
		<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INCLUDE" xlink:href="smb.conf.5.html#INCLUDE">include = registry</link>
		in the [global] section of <emphasis>smb.conf</emphasis>.
		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.</para>

		<para>Activation of global registry options automatically
		activates registry shares. So in the registry only case,
		shares are loaded on demand only.</para>
		</listitem>
	</orderedlist>

	<para>
		Note: To make registry-based configurations foolproof
		at least to a certain extent, the use
		of <parameter>lock directory</parameter> and
		 <parameter>config backend</parameter>
		inside the registry configuration has been disabled:
		Especially by changing the
		 <parameter>lock directory</parameter> inside the registry
		configuration, one would create a broken setup where the daemons
		do not see the configuration they loaded once it is active.
	</para>

	<para>
		The registry configuration can be accessed with
		tools like <emphasis>regedit</emphasis> or <emphasis>net (rpc)
		registry</emphasis> in the key
		 <emphasis><literal>HKLM\Software\Samba\smbconf</literal></emphasis>.

		More conveniently, the <emphasis>conf</emphasis> subcommand of the
		 <citerefentry><refentrytitle>net</refentrytitle>
		<manvolnum>8</manvolnum></citerefentry> utility
		offers a dedicated interface to read and write the
		registry based configuration locally, i.e. directly
		accessing the database file, circumventing the
		server.
	</para>

</refsect1>

<refsect1>
	<title>EXPLANATION OF EACH PARAMETER</title>
	
	
		<!-- The URI below is resolved to local generated version of parameters.all.xml //-->
		<!-- WAF build places it in bin/default/docs-xml/smbdotconf/parameters.all.xml //-->
		<!-- and we redirect there via use of XML_CATALOG_FILES, see docs-xml/build/catalog.xml.in //-->
		
	<section xml:base="file:///home/ubuntu/autobuild/b22271/samba/bin/default/docs-xml/smbdotconf/parameters.all.xml">
<section><indexterm significance="preferred"><primary>bind interfaces only</primary></indexterm><anchor id="BINDINTERFACESONLY"/><title>

bind interfaces only (G)
</title><variablelist><varlistentry><listitem>
        <para>This global parameter allows the Samba admin 
        to limit what interfaces on a machine will serve SMB requests. It 
        affects file service <citerefentry><refentrytitle>smbd</refentrytitle>
        <manvolnum>8</manvolnum></citerefentry> and name service <citerefentry><refentrytitle>nmbd</refentrytitle>
        <manvolnum>8</manvolnum></citerefentry> in a slightly different ways.</para>

	<para>
	For name service it causes <literal>nmbd</literal> to bind to ports 137 and 138 on the
	interfaces listed in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> parameter. <literal>nmbd</literal>
	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 <literal>nmbd</literal> will
	service name requests on all of these sockets. If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="BINDINTERFACESONLY" xlink:href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</link> is set then
	 <literal>nmbd</literal> 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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> parameter list.  As unicast packets are received on the other sockets it
	allows <literal>nmbd</literal> to refuse to serve names to machines that send packets that
	arrive through any interfaces not listed in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> list.  IP Source address
	spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
	 <literal>nmbd</literal>.
	</para>

	<para>
	For file service it causes <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> to bind only to the interface list given in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> parameter. This restricts the networks that <literal>smbd</literal> will
	serve, to packets coming in on 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.
	</para>

	<para>
	If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="BINDINTERFACESONLY" xlink:href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</link> is set and the network address
	 <emphasis>127.0.0.1</emphasis> is not added to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> parameter list
	 <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> may not
	 work as expected due to the reasons covered below.
	</para>

	<para>
	To change a users SMB password, the <literal>smbpasswd</literal> by default connects to the
	 <emphasis>localhost - 127.0.0.1</emphasis> address as an SMB client to issue the password change request. If
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="BINDINTERFACESONLY" xlink:href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only</link> is set then unless the network address
	 <emphasis>127.0.0.1</emphasis> is added to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> parameter list then <literal> smbpasswd</literal> will fail to connect in it's default mode.  <literal>smbpasswd</literal> can be forced to use the primary IP interface of the local host by using
	its <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>	<parameter moreinfo="none">-r <replaceable>remote machine</replaceable></parameter> parameter, with <replaceable>remote
	machine</replaceable> set to the IP name of the primary interface of the local host.
	</para>


<para>Default: <emphasis><parameter>bind interfaces only</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>comment</primary></indexterm><anchor id="COMMENT"/><title>

comment (S)
</title><variablelist><varlistentry><listitem>
    <para>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 <literal>net view</literal> to list what shares 
	are available.</para>

	<para>If you want to set the string that is displayed next to the 
		machine name then see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERSTRING" xlink:href="smb.conf.5.html#SERVERSTRING">server string</link> parameter.</para>


<para>Default: <emphasis><parameter>comment</parameter> = <literal>
# No comment</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>comment</parameter> = <literal>Fred's Files</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>config backend</primary></indexterm><anchor id="CONFIGBACKEND"/><title>

config backend (G)
</title><variablelist><varlistentry><listitem>
	<para>
		This controls the backend for storing the configuration.
		Possible values are <emphasis>file</emphasis> (the default)
		and <emphasis>registry</emphasis>.
		When <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CONFIGBACKEND" xlink:href="smb.conf.5.html#CONFIGBACKEND">config backend = registry</link>
		 is encountered while loading <emphasis>smb.conf</emphasis>,
		the configuration read so far is dropped and the global
		options are read from registry instead. So this triggers a
		registry only configuration. Share definitions are not read
		immediately but instead <parameter>registry
		shares</parameter> is set to <emphasis>yes</emphasis>.
	</para>
	<para>
		Note: This option can not be set inside the registry
		configuration itself.
	</para>

<para>Default: <emphasis><parameter>config backend</parameter> = <literal>file</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>config backend</parameter> = <literal>registry</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dos charset</primary></indexterm><anchor id="DOSCHARSET"/><title>

dos charset (G)
</title><variablelist><varlistentry><listitem>
        <para>DOS SMB clients assume the server has 
	the same charset as they do. This option specifies which 
	charset Samba should talk to DOS clients.
	</para>

	<para>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 <citerefentry><refentrytitle>testparm</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry> to check the default on your system.</para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enable core files</primary></indexterm><anchor id="ENABLECOREFILES"/><title>

enable core files (G)
</title><variablelist><varlistentry><listitem>
        <para>This parameter specifies whether core dumps should be written
	on internal exits. Normally set to <constant>yes</constant>.
	You should never need to change this.
	</para>

<para>Default: <emphasis><parameter>enable core files</parameter> = <literal>yes</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>enable core files</parameter> = <literal>no</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>interfaces</primary></indexterm><anchor id="INTERFACES"/><title>

interfaces (G)
</title><variablelist><varlistentry><listitem>
        <para>This option allows you to override the default 
	network interfaces list that Samba will use for browsing, name 
	registration and other NetBIOS over TCP/IP (NBT) traffic. By default Samba will query
	the kernel for the list of all active interfaces and use any 
	interfaces except 127.0.0.1 that are broadcast capable.</para>

	<para>The option takes a list of interface strings. Each string 
	can be in any of the following forms:</para>

	<itemizedlist>
		<listitem><para>a network interface name (such as eth0). 
		This may include shell-like wildcards so eth* will match 
		any interface starting with the substring "eth"</para></listitem>
			
		<listitem><para>an IP address. In this case the netmask is 
		determined from the list of interfaces obtained from the 
		kernel</para></listitem>
			
		<listitem><para>an IP/mask pair. </para></listitem>
			
		<listitem><para>a broadcast/mask pair.</para></listitem>
	</itemizedlist>

	<para>The "mask" parameters can either be a bit length (such 
	as 24 for a C class network) or a full netmask in dotted 
	decimal form.</para>

	<para>The "IP" parameters above can either be a full dotted 
	decimal IP address or a hostname which will be looked up via 
	the OS's normal hostname resolution mechanisms.</para>

	<para>
	By default Samba enables all active interfaces that are broadcast capable
	except the loopback adaptor (IP address 127.0.0.1).
	</para>
	
	<para>
	The example below configures three network interfaces corresponding 
	to the eth0 device and IP addresses 192.168.2.10 and 192.168.3.10. 
	The netmasks of the latter two interfaces would be set to 255.255.255.0.
	</para>


<para>Default: <emphasis><parameter>interfaces</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>interfaces</parameter> = <literal>eth0 192.168.2.10/24 192.168.3.10/255.255.255.0</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>multicast dns register</primary></indexterm><anchor id="MULTICASTDNSREGISTER"/><title>

multicast dns register (G)
</title><variablelist><varlistentry><listitem>
        <para>If compiled with proper support for it, Samba will
        announce itself with multicast DNS services like for example
        provided by the Avahi daemon.</para>

	<para>This parameter allows disabling Samba to register
	itself.</para>

<para>Default: <emphasis><parameter>multicast dns register</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>netbios aliases</primary></indexterm><anchor id="NETBIOSALIASES"/><title>

netbios aliases (G)
</title><variablelist><varlistentry><listitem>
        <para>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 
	servers, only the primary name of the machine will be advertised with these capabilities.
        </para>

<para>Default: <emphasis><parameter>netbios aliases</parameter> = <literal>
# empty string (no additional names)</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>netbios aliases</parameter> = <literal>TEST TEST1 TEST2</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>netbios name</primary></indexterm><anchor id="NETBIOSNAME"/><title>

netbios name (G)
</title><variablelist><varlistentry><listitem>
        <para>
		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.
		</para>

		<para>
		There is a bug in Samba that breaks operation of browsing and access to shares if the netbios name
		is set to the literal name <literal>PIPE</literal>. To avoid this problem, do not name your Samba
		server <literal>PIPE</literal>.
		</para>

<para>Default: <emphasis><parameter>netbios name</parameter> = <literal>
# machine DNS name</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>netbios name</parameter> = <literal>MYNAME</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>netbios scope</primary></indexterm><anchor id="NETBIOSSCOPE"/><title>

netbios scope (G)
</title><variablelist><varlistentry><listitem>
        <para>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.</para>

<para>Default: <emphasis><parameter>netbios scope</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>directory</primary><see>path</see></indexterm><title>

<anchor id="DIRECTORY"/>directory
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PATH">path</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>path</primary></indexterm><anchor id="PATH"/><title>

path (S)
</title><variablelist><varlistentry><listitem>
        <para>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.</para>

	<para>For a printable service offering guest access, the service 
	should be readonly and the path should be world-writeable and 
	have the sticky bit set. This is not mandatory of course, but 
	you probably won't get the results you expect if you do 
	otherwise.</para>

	<para>Any occurrences of <parameter moreinfo="none">%u</parameter> in the path 
	will be replaced with the UNIX username that the client is using 
	on this connection. Any occurrences of <parameter moreinfo="none">%m</parameter> 
	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.</para>

<para>Note that this path will be based on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ROOTDIR" xlink:href="smb.conf.5.html#ROOTDIR">root dir</link>
	 if one was specified.</para>
	
<para>Default: <emphasis><parameter>path</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>path</parameter> = <literal>/home/fred</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>realm</primary></indexterm><anchor id="REALM"/><title>

realm (G)
</title><variablelist><varlistentry><listitem>
        <para>This option specifies the kerberos realm to use. The realm is 
	used as the ADS equivalent of the NT4 <literal>domain</literal>. It
	is usually set to the DNS name of the kerberos server.
	</para>

<para>Default: <emphasis><parameter>realm</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>realm</parameter> = <literal>mysambabox.mycompany.com</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>server services</primary></indexterm><anchor id="SERVERSERVICES"/><title>

server services (G)
</title><variablelist><varlistentry><listitem>
	<para>This option contains the services that the Samba daemon will
		run.</para>

	<para>An entry in the <filename>smb.conf</filename> file can either
		override the previous value completely or entries can be removed from
		or added to it by prefixing them with <constant>+</constant> or
		<constant>-</constant>.  </para>

<para>Default: <emphasis><parameter>server services</parameter> = <literal>s3fs, rpc, nbt, wrepl, ldap, cldap, kdc, drepl, winbindd, ntp_signd, kcc, dnsupdate, dns</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server services</parameter> = <literal>-s3fs, +smb</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>server string</primary></indexterm><anchor id="SERVERSTRING"/><title>

server string (G)
</title><variablelist><varlistentry><listitem>
        <para>This controls what string will show up in the printer comment box in print 
        manager and next to the IPC connection in <literal>net view</literal>. It 
        can be any string that you wish to show to your users.</para>
		
	<para>It also sets what will appear in browse lists next 
	to the machine name.</para>

	<para>A <parameter moreinfo="none">%v</parameter> will be replaced with the Samba 
	version number.</para>

	<para>A <parameter moreinfo="none">%h</parameter> will be replaced with the 
		hostname.</para>

<para>Default: <emphasis><parameter>server string</parameter> = <literal>Samba %v</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server string</parameter> = <literal>University of GNUs Samba Server</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>share backend</primary></indexterm><anchor id="SHAREBACKEND"/><title>

share backend (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This option specifies the backend that will be used to access the configuration of
	file shares.
	</para>

	<para>Traditionally, Samba file shares have been configured in the
		<option>smb.conf</option> file and this is still the default.
	</para>

	<para>At the moment there are no other supported backends.</para>

<para>Default: <emphasis><parameter>share backend</parameter> = <literal>classic</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>unix charset</primary></indexterm><anchor id="UNIXCHARSET"/><title>

unix charset (G)
</title><variablelist><varlistentry><listitem>
        <para>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.
	</para>

	<para>This is also the charset Samba will use when specifying arguments 
		to scripts that it invokes.
	</para>

<para>Default: <emphasis><parameter>unix charset</parameter> = <literal>UTF-8</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>unix charset</parameter> = <literal>ASCII</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>workgroup</primary></indexterm><anchor id="WORKGROUP"/><title>

workgroup (G)
</title><variablelist><varlistentry><listitem>
        <para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security = domain</link>
		setting.</para>

<para>Default: <emphasis><parameter>workgroup</parameter> = <literal>WORKGROUP</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>workgroup</parameter> = <literal>MYGROUP</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>administrative share</primary></indexterm><anchor id="ADMINISTRATIVESHARE"/><title>

administrative share (S)
</title><variablelist><varlistentry><listitem>
    <para>If this parameter is set to <constant>yes</constant> 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.</para>

    <para>See the section below on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> for more 
      information about this option.</para>

<para>Default: <emphasis><parameter>administrative share</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>browsable</primary><see>browseable</see></indexterm><title>

<anchor id="BROWSABLE"/>browsable
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="BROWSEABLE">browseable</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>browseable</primary></indexterm><anchor id="BROWSEABLE"/><title>

browseable (S)
</title><variablelist><varlistentry><listitem>
	<para>This controls whether this share is seen in 
	the list of available shares in a net view and in the browse list.</para>


<para>Default: <emphasis><parameter>browseable</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>browse list</primary></indexterm><anchor id="BROWSELIST"/><title>

browse list (G)
</title><variablelist><varlistentry><listitem>
	<para>This controls whether <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> will serve a browse list to 
	a client doing a <literal>NetServerEnum</literal> call. Normally 
	set to <constant>yes</constant>. You should never need to change 
	this.</para>
		

<para>Default: <emphasis><parameter>browse list</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>domain master</primary></indexterm><anchor id="DOMAINMASTER"/><title>

domain master (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Tell <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> to enable
	WAN-wide browse list collation. Setting this option causes <literal>nmbd</literal> to claim a
	special domain specific NetBIOS name that identifies it as a domain master browser for its given
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link>. Local master browsers in the same <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> on
	broadcast-isolated subnets will give this <literal>nmbd</literal> their local browse lists,
	and then ask <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 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.
	</para>

	<para>
	Note that Windows NT Primary Domain Controllers expect to be able to claim this <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> specific special NetBIOS name that identifies them as domain master browsers for that
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> 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 <literal>nmbd</literal> claims the
	special name for a <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> before a Windows NT PDC is able to do so then cross
	subnet browsing will behave strangely and may fail.
	</para>
		
	<para>
	If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINLOGONS" xlink:href="smb.conf.5.html#DOMAINLOGONS">domain logons = yes</link>, then the default behavior is to enable the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINMASTER" xlink:href="smb.conf.5.html#DOMAINMASTER">domain master</link> parameter.  If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINLOGONS" xlink:href="smb.conf.5.html#DOMAINLOGONS">domain logons</link> is not enabled (the
	default setting), then neither will <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINMASTER" xlink:href="smb.conf.5.html#DOMAINMASTER">domain master</link> be enabled by default.
	</para>

	<para>
	When <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINLOGONS" xlink:href="smb.conf.5.html#DOMAINLOGONS">domain logons = Yes</link> the default setting for this parameter is
	Yes, with the result that Samba will be a PDC. If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINMASTER" xlink:href="smb.conf.5.html#DOMAINMASTER">domain master = No</link>,
	Samba will function as a BDC. In general, this parameter should be set to 'No' only on a BDC.
	</para>


<para>Default: <emphasis><parameter>domain master</parameter> = <literal>auto</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enhanced browsing</primary></indexterm><anchor id="ENHANCEDBROWSING"/><title>

enhanced browsing (G)
</title><variablelist><varlistentry><listitem>
	<para>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.  
	</para>

	<para>The first enhancement to browse propagation consists of a regular
	wildcard query to a Samba WINS server for all Domain Master Browsers,
	followed by a browse synchronization with each of the returned
	DMBs. The second enhancement consists of a regular randomised browse
	synchronization with all currently known DMBs.</para>

	<para>You may wish to disable this option if you have a problem with empty
	workgroups not disappearing from browse lists. Due to the restrictions
	of the browse protocols, these enhancements can cause a empty workgroup
	to stay around forever which can be annoying.</para>

	<para>In general you should leave this option enabled as it makes
	cross-subnet browse propagation much more reliable.</para>


<para>Default: <emphasis><parameter>enhanced browsing</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lm announce</primary></indexterm><anchor id="LMANNOUNCE"/><title>

lm announce (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> 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, <constant>yes</constant>, <constant>no</constant>, or
	<constant>auto</constant>. The default is <constant>auto</constant>.  
	If set to <constant>no</constant> Samba will never produce these 
	broadcasts. If set to <constant>yes</constant> Samba will produce 
	Lanman announce broadcasts at a frequency set by the parameter 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LMINTERVAL" xlink:href="smb.conf.5.html#LMINTERVAL">lm interval</link>. If set to <constant>auto</constant> 
	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 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LMINTERVAL" xlink:href="smb.conf.5.html#LMINTERVAL">lm interval</link>.</para>

<para>Default: <emphasis><parameter>lm announce</parameter> = <literal>auto</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lm announce</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lm interval</primary></indexterm><anchor id="LMINTERVAL"/><title>

lm interval (G)
</title><variablelist><varlistentry><listitem>
	<para>If Samba is set to produce Lanman announce 
	broadcasts needed by OS/2 clients (see the 
		<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LMANNOUNCE" xlink:href="smb.conf.5.html#LMANNOUNCE">lm announce</link> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LMANNOUNCE" xlink:href="smb.conf.5.html#LMANNOUNCE">lm announce</link> 
	parameter.</para>

<para>Default: <emphasis><parameter>lm interval</parameter> = <literal>60</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lm interval</parameter> = <literal>120</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>local master</primary></indexterm><anchor id="LOCALMASTER"/><title>

local master (G)
</title><variablelist><varlistentry><listitem>
	<para>This option allows <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> to try and become a local master browser 
	on a subnet. If set to <constant>no</constant> then <literal>
	nmbd</literal> will not attempt to become a local master browser 
	on a subnet and will also lose in all browsing elections. By
	default this value is set to <constant>yes</constant>. Setting this value to 
	<constant>yes</constant> doesn't mean that Samba will <emphasis>become</emphasis> the 
	local master browser on a subnet, just that <literal>nmbd</literal> 
	will <emphasis>participate</emphasis> in elections for local master browser.</para>

	<para>Setting this value to <constant>no</constant> will cause <literal>nmbd</literal> <emphasis>never</emphasis> to become a local 
master browser.</para>

<para>Default: <emphasis><parameter>local master</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>os level</primary></indexterm><anchor id="OSLEVEL"/><title>

os level (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This integer value controls what level Samba advertises itself as for browse elections. The value of this
	parameter determines whether <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> has a chance of becoming a local master browser for the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> in the local broadcast area.
</para>
		
	<para><emphasis>
	Note:</emphasis> 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
	effectively isolate a subnet for browsing purposes. This parameter is largely auto-configured in the Samba-3
	release series and it is seldom necessary to manually override the default setting. Please refer to
	the chapter on Network Browsing in the Samba-3 HOWTO document for further information regarding the use
	of this parameter.
	<emphasis>Note:</emphasis> The maximum value for this parameter is 255. If you use higher values, counting
	will start at 0!
	</para>

<para>Default: <emphasis><parameter>os level</parameter> = <literal>20</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>os level</parameter> = <literal>65</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>prefered master</primary><see>preferred master</see></indexterm><title>

<anchor id="PREFEREDMASTER"/>prefered master
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PREFERREDMASTER">preferred master</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>preferred master</primary></indexterm><anchor id="PREFERREDMASTER"/><title>

preferred master (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This boolean parameter controls if <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> is a preferred master browser  for its workgroup.
	</para>

	<para>
	If this is set to <constant>yes</constant>, on startup, <literal>nmbd</literal> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DOMAINMASTER" xlink:href="smb.conf.5.html#DOMAINMASTER">domain master = yes</link>, so that
	<literal>nmbd</literal> can guarantee becoming a domain master.
	</para>

	<para>
	Use this option with caution, because if there are several hosts (whether Samba servers, Windows 95 or NT)
	that are preferred  master browsers on the same subnet, they will each periodically  and continuously attempt
	to become the local master browser. This will result in unnecessary broadcast traffic and reduced browsing
	capabilities.
	</para>

<para>Default: <emphasis><parameter>preferred master</parameter> = <literal>auto</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allow dns updates</primary></indexterm><anchor id="ALLOWDNSUPDATES"/><title>

allow dns updates (G)
</title><variablelist><varlistentry><listitem>
	<para>This option determines what kind of updates to the DNS are allowed.
	</para>

	<para>DNS updates can either be disallowed completely by setting it to
		<constant>disabled</constant>, enabled over secure connections only by
		setting it to <constant>secure only</constant> or allowed in all cases
		by setting it to <constant>nonsecure</constant>.
	</para>

<para>Default: <emphasis><parameter>allow dns updates</parameter> = <literal>secure only</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>allow dns updates</parameter> = <literal>disabled</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dns forwarder</primary></indexterm><anchor id="DNSFORWARDER"/><title>

dns forwarder (G)
</title><variablelist><varlistentry><listitem>
	<para>This option specifies the DNS server that DNS requests will be 
		forwarded to if they can not be handled by Samba itself.
	</para>

	<para>The DNS forwarder is only used if the internal DNS server
		in Samba is used.
	</para>

<para>Default: <emphasis><parameter>dns forwarder</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>dns forwarder</parameter> = <literal>192.168.0.1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dns update command</primary></indexterm><anchor id="DNSUPDATECOMMAND"/><title>

dns update command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option sets the command that is called when there are
		DNS updates. It should update the local machines DNS names using
		TSIG-GSS.
	</para>

<para>Default: <emphasis><parameter>dns update command</parameter> = <literal>/home/ubuntu/autobuild/b22271/samba/source4/scripting/bin/samba_dnsupdate</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>dns update command</parameter> = <literal>/usr/local/sbin/dnsupdate</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>machine password timeout</primary></indexterm><anchor id="MACHINEPASSWORDTIMEOUT"/><title>

machine password timeout (G)
</title><variablelist><varlistentry><listitem>

	<para>
	If a Samba server is a member of a Windows NT Domain (see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security = domain</link> parameter) then periodically a running smbd process will try and change
	the MACHINE ACCOUNT PASSWORD stored in the TDB called <filename moreinfo="none">private/secrets.tdb
	</filename>.  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.
	</para>

	<para>
	See also <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>,
	and the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security = domain</link> parameter.
	</para>


<para>Default: <emphasis><parameter>machine password timeout</parameter> = <literal>604800</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nsupdate command</primary></indexterm><anchor id="NSUPDATECOMMAND"/><title>

nsupdate command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option sets the path to the <filename>nsupdate</filename>
		command which is used for GSS-TSIG dynamic DNS updates.
	</para>

<para>Default: <emphasis><parameter>nsupdate command</parameter> = <literal>/usr/bin/nsupdate -g</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>rndc command</primary></indexterm><anchor id="RNDCCOMMAND"/><title>

rndc command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option specifies the path to the name server control utility.
	</para>

	<para>The <filename>rndc</filename> utility should be a part of the
		bind installation.
	</para>

<para>Default: <emphasis><parameter>rndc command</parameter> = <literal>/usr/sbin/rndc</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>rndc command</parameter> = <literal>/usr/local/bind9/sbin/rndc</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>spn update command</primary></indexterm><anchor id="SPNUPDATECOMMAND"/><title>

spn update command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option sets the command that for updating
		servicePrincipalName names from <filename>spn_update_list</filename>.
	</para>

<para>Default: <emphasis><parameter>spn update command</parameter> = <literal>/home/ubuntu/autobuild/b22271/samba/source4/scripting/bin/samba_spnupdate</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>spn update command</parameter> = <literal>/usr/local/sbin/spnupdate</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>casesignames</primary><see>case sensitive</see></indexterm><title>

<anchor id="CASESIGNAMES"/>casesignames
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="CASESENSITIVE">case sensitive</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>case sensitive</primary></indexterm><anchor id="CASESENSITIVE"/><title>

case sensitive (S)
</title><variablelist><varlistentry><listitem>
	<para>See the discussion in the section <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NAMEMANGLING" xlink:href="smb.conf.5.html#NAMEMANGLING">name mangling</link>.</para>

<para>Default: <emphasis><parameter>case sensitive</parameter> = <literal>auto</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>default case</primary></indexterm><anchor id="DEFAULTCASE"/><title>

default case (S)
</title><variablelist><varlistentry><listitem>
	<para>See the section on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NAMEMANGLING" xlink:href="smb.conf.5.html#NAMEMANGLING">name mangling</link>.
	Also note the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SHORTPRESERVECASE" xlink:href="smb.conf.5.html#SHORTPRESERVECASE">short preserve case</link> parameter.</para>

<para>Default: <emphasis><parameter>default case</parameter> = <literal>lower</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete veto files</primary></indexterm><anchor id="DELETEVETOFILES"/><title>

delete veto files (S)
</title><variablelist><varlistentry><listitem>
	<para>This option is used when Samba is attempting to 
	delete a directory that contains one or more vetoed directories 
	(see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VETOFILES" xlink:href="smb.conf.5.html#VETOFILES">veto files</link>
	option).  If this option is set to <constant>no</constant> (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.</para>

	<para>If this option is set to <constant>yes</constant>, then Samba 
	will attempt to recursively delete any files and directories within 
	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. <filename moreinfo="none">.AppleDouble</filename>)</para>

	<para>Setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEVETOFILES" xlink:href="smb.conf.5.html#DELETEVETOFILES">delete veto files = yes</link> allows these 
	directories to be  transparently deleted when the parent directory 
	is deleted (so long as the user has permissions to do so).</para>

<para>Default: <emphasis><parameter>delete veto files</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hide dot files</primary></indexterm><anchor id="HIDEDOTFILES"/><title>

hide dot files (S)
</title><variablelist><varlistentry><listitem>
	<para>This is a boolean parameter that controls whether 
	files starting with a dot appear as hidden files.</para>

<para>Default: <emphasis><parameter>hide dot files</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hide files</primary></indexterm><anchor id="HIDEFILES"/><title>

hide files (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>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.</para>

	<para>Each entry must be a Unix path, not a DOS path and must 
	not include the Unix directory separator '/'.</para>

	<para>Note that the case sensitivity option is applicable 
	in hiding files.</para>
		
	<para>Setting this parameter will affect the performance of Samba, 
	as it will be forced to check all files and directories for a match 
	as they are scanned.</para>

	<para>
	The example shown above is based on files that the Macintosh 
	SMB client (DAVE) available from <ulink url="http://www.thursby.com"> 
	Thursby</ulink> creates for internal use, and also still hides 
	all files beginning with a dot.
	</para>

	<para>
	An example of us of this parameter is:
<programlisting>
hide files = /.*/DesktopFolderDB/TrashFor%m/resource.frk/
</programlisting>
	</para>

<para>Default: <emphasis><parameter>hide files</parameter> = <literal>
# no file are hidden</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hide special files</primary></indexterm><anchor id="HIDESPECIALFILES"/><title>

hide special files (S)
</title><variablelist><varlistentry><listitem>

	<para>
	This parameter prevents clients from seeing special files such as sockets, devices and
	fifo's in directory listings.
	</para>


<para>Default: <emphasis><parameter>hide special files</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hide unreadable</primary></indexterm><anchor id="HIDEUNREADABLE"/><title>

hide unreadable (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter prevents clients from seeing the
		existance of files that cannot be read. Defaults to off.</para>
	<para>Please note that enabling this can slow down listing large
	directories significantly. Samba has to evaluate the ACLs of all
	directory members, which can be a lot of effort.</para>

<para>Default: <emphasis><parameter>hide unreadable</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hide unwriteable files</primary></indexterm><anchor id="HIDEUNWRITEABLEFILES"/><title>

hide unwriteable files (S)
</title><variablelist><varlistentry><listitem>
    <para>
    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.
    </para>
    <para>Please note that enabling this can slow down listing large
    directories significantly. Samba has to evaluate the ACLs of all directory
    members, which can be a lot of effort.</para>

<para>Default: <emphasis><parameter>hide unwriteable files</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>mangled names</primary></indexterm><anchor id="MANGLEDNAMES"/><title>

mangled names (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>See the section on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NAMEMANGLING" xlink:href="smb.conf.5.html#NAMEMANGLING">name mangling</link> for 
	details on how to control the mangling process.</para>

	<para>If mangling is used then the mangling method is as follows:</para>

	<itemizedlist>
		<listitem>
			<para>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 
			of the mangled name.</para>
		</listitem>
		
		<listitem>
			<para>A tilde "~" is appended to the first part of the mangled
			name, followed by a two-character unique sequence, based on the
			original root name (i.e., the original filename minus its final
			extension). The final extension is included in the hash calculation
			only if it contains any upper case characters or is longer than three
			characters.</para>

			<para>Note that the character to use may be specified using 
				the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MANGLINGCHAR" xlink:href="smb.conf.5.html#MANGLINGCHAR">mangling char</link>
			option, if you don't like '~'.</para>
		</listitem>

		<listitem>
			<para>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 
			its extension regardless of actual original extension (that's three 
			underscores).</para>
		</listitem>
	</itemizedlist>

	<para>The two-digit hash value consists of upper case alphanumeric characters.</para>

	<para>This algorithm can cause name collisions only if files 
	in a directory share the same first five alphanumeric characters. 
	The probability of such a clash is 1/1300.</para>

	<para>The name mangling (if enabled) allows a file to be 
	copied between UNIX directories from Windows/DOS while retaining 
	the long UNIX filename. UNIX files can be renamed to a new extension 
	from Windows/DOS and will retain the same basename. Mangled names 
	do not change between sessions.</para>

<para>Default: <emphasis><parameter>mangled names</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>mangle prefix</primary></indexterm><anchor id="MANGLEPREFIX"/><title>

mangle prefix (G)
</title><variablelist><varlistentry><listitem>
	<para> 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
	value is 1 and the maximum value is 6.</para>

	<para>
	mangle prefix is effective only when mangling method is hash2.
	</para>

<para>Default: <emphasis><parameter>mangle prefix</parameter> = <literal>1</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>mangle prefix</parameter> = <literal>4</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>mangling char</primary></indexterm><anchor id="MANGLINGCHAR"/><title>

mangling char (S)
</title><variablelist><varlistentry><listitem>
	<para>This controls what character is used as 
	the <emphasis>magic</emphasis> character in <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NAMEMANGLING" xlink:href="smb.conf.5.html#NAMEMANGLING">name mangling</link>. 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.</para>

<para>Default: <emphasis><parameter>mangling char</parameter> = <literal>~</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>mangling char</parameter> = <literal>^</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>mangling method</primary></indexterm><anchor id="MANGLINGMETHOD"/><title>

mangling method (G)
</title><variablelist><varlistentry><listitem>
	<para> 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 in Samba for many years and was the default in Samba 2.2.x "hash2" is
        now the default and is newer and considered a better algorithm (generates less collisions) in
        the names. Many Win32 applications store the mangled names and so
	changing to algorithms must not be done lightly as these applications
        may break unless reinstalled.</para>

<para>Default: <emphasis><parameter>mangling method</parameter> = <literal>hash2</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>mangling method</parameter> = <literal>hash</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map archive</primary></indexterm><anchor id="MAPARCHIVE"/><title>

map archive (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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 
	motivation for this option is to keep Samba/your PC from making 
	any file it touches from becoming executable under UNIX.  This can 
	be quite annoying for shared source code, documents, etc...
	</para>

	<para>
	Note that this parameter will be ignored if the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link>
	parameter is set, as the DOS archive attribute will then be stored inside a UNIX extended
	attribute.
	</para>

	<para>
	Note that this requires the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link>	parameter to be set such that owner 
	execute bit is not masked out (i.e. it must include 100). See the parameter 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link> for details.
	</para>

<para>Default: <emphasis><parameter>map archive</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map hidden</primary></indexterm><anchor id="MAPHIDDEN"/><title>

map hidden (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This controls whether DOS style hidden files should be mapped to the UNIX world execute bit.
	</para>

	<para>
	Note that this parameter will be ignored if the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link>
	parameter is set, as the DOS hidden attribute will then be stored inside a UNIX extended
	attribute.
	</para>

	<para>
	Note that this requires the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link> to be set such that the world execute 
	bit is not masked out (i.e. it must include 001). See the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link> 
	for details.
	</para>


<para>Default: <emphasis><parameter>map hidden</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map readonly</primary></indexterm><anchor id="MAPREADONLY"/><title>

map readonly (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This controls how the DOS read only attribute should be mapped from a UNIX filesystem.
	</para>

	<para>
	This parameter can take three different values, which tell <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> how to display the read only attribute on files, where either
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link> is set to <constant>No</constant>, or no extended attribute is
	present. If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link> is set to <constant>yes</constant> then this
	parameter is <emphasis>ignored</emphasis>. This is a new parameter introduced in Samba version 3.0.21.
	</para>

    <para>The three settings are :</para>

    <itemizedlist>
		<listitem><para>
		<constant>Yes</constant> - The read only DOS attribute is mapped to the inverse of the user
		or owner write bit in the unix permission mode set. If the owner write bit is not set, the
		read only attribute is reported as being set on the file.
		If the read only DOS attribute is set, Samba sets the owner, group and
		others write bits to zero. Write bits set in an ACL are ignored by Samba.
		If the read only DOS attribute is unset, Samba simply sets the write bit of the
		owner to one.
		</para></listitem>

		<listitem><para>
		<constant>Permissions</constant> - The read only DOS attribute is mapped to the effective permissions of
		the connecting user, as evaluated by <citerefentry><refentrytitle>smbd</refentrytitle>
		<manvolnum>8</manvolnum></citerefentry> 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.
		</para></listitem>

		<listitem><para>
		<constant>No</constant> - The read only DOS attribute is unaffected by permissions, and can only be set by
		the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link> method. This may be useful for exporting mounted CDs.
		</para></listitem>
    </itemizedlist>

        <para>
        Note that this parameter will be ignored if the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link>
        parameter is set, as the DOS 'read-only' attribute will then be stored inside a UNIX extended
        attribute.
        </para>


<para>Default: <emphasis><parameter>map readonly</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map system</primary></indexterm><anchor id="MAPSYSTEM"/><title>

map system (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This controls whether DOS style system files should be mapped to the UNIX group execute bit.
	</para>

        <para>
        Note that this parameter will be ignored if the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="STOREDOSATTRIBUTES" xlink:href="smb.conf.5.html#STOREDOSATTRIBUTES">store dos attributes</link>
        parameter is set, as the DOS system attribute will then be stored inside a UNIX extended
        attribute.
        </para>

	<para>
	Note that this requires the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link>	to be set such that the group 
	execute bit is not masked out (i.e. it must include 010). See the parameter 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link> for details.
	</para>

<para>Default: <emphasis><parameter>map system</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max stat cache size</primary></indexterm><anchor id="MAXSTATCACHESIZE"/><title>

max stat cache size (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter limits the size in memory of any 
	  <parameter moreinfo="none">stat cache</parameter> being used
	  to speed up case insensitive name mappings. It represents
	  the number of kilobyte (1024) units the stat cache can use.
	  A value of zero, meaning unlimited, is not advisable due to
	  increased memory usage.  You should not need to change this
	  parameter.
	</para>

<para>Default: <emphasis><parameter>max stat cache size</parameter> = <literal>256</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max stat cache size</parameter> = <literal>100</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>preserve case</primary></indexterm><anchor id="PRESERVECASE"/><title>

preserve case (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This controls if new filenames are created with the case that the client passes, or if 
	they are forced to be the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEFAULTCASE" xlink:href="smb.conf.5.html#DEFAULTCASE">default case</link>.
	</para>
	
	<para>
	See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link> for a fuller discussion.
	</para>

<para>Default: <emphasis><parameter>preserve case</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>short preserve case</primary></indexterm><anchor id="SHORTPRESERVECASE"/><title>

short preserve case (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEFAULTCASE" xlink:href="smb.conf.5.html#DEFAULTCASE">default case</link>.
	This  option can be use with <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRESERVECASE" xlink:href="smb.conf.5.html#PRESERVECASE">preserve case = yes</link> to permit long filenames
	to retain their case, while short names are lowered.
	</para>
		
	<para>See the section on <link linkend="NAMEMANGLINGSECT">NAME MANGLING</link>.</para>

<para>Default: <emphasis><parameter>short preserve case</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>stat cache</primary></indexterm><anchor id="STATCACHE"/><title>

stat cache (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter determines if <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> will use a cache in order to 
	speed up case insensitive name mappings. You should never need 
	to change this parameter.</para>

<para>Default: <emphasis><parameter>stat cache</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>store dos attributes</primary></indexterm><anchor id="STOREDOSATTRIBUTES"/><title>

store dos attributes (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPHIDDEN" xlink:href="smb.conf.5.html#MAPHIDDEN">map hidden</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPREADONLY" xlink:href="smb.conf.5.html#MAPREADONLY">map readonly</link>).  When set, DOS
	attributes will be stored onto an extended attribute in the UNIX filesystem, associated with the file or
	directory.  When this parameter is set it will override the parameters <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPHIDDEN" xlink:href="smb.conf.5.html#MAPHIDDEN">map hidden</link>,
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPSYSTEM" xlink:href="smb.conf.5.html#MAPSYSTEM">map system</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPARCHIVE" xlink:href="smb.conf.5.html#MAPARCHIVE">map archive</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPREADONLY" xlink:href="smb.conf.5.html#MAPREADONLY">map  readonly</link> and they will behave as if they were 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.

	In Samba 3.5.0 and above the "user.DOSATTRIB" extended attribute has been extended to store
	the create time for a file as well as the DOS attributes. This is done in a backwards compatible
	way so files created by Samba 3.5.0 and above can still have the DOS attribute read from this
	extended attribute by earlier versions of Samba, but they will not be able to read the create
	time stored there. Storing the create time separately from the normal filesystem meta-data
	allows Samba to faithfully reproduce NTFS semantics on top of a POSIX filesystem.
	</para>

<para>Default: <emphasis><parameter>store dos attributes</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>veto files</primary></indexterm><anchor id="VETOFILES"/><title>

veto files (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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.
	</para>

	<para>
	Each entry must be a unix path, not a DOS path and must <emphasis>not</emphasis> include the  
	unix directory 	separator '/'.
	</para>

	<para>
	Note that the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CASESENSITIVE" xlink:href="smb.conf.5.html#CASESENSITIVE">case sensitive</link> option is applicable in vetoing files.
	</para>
		
	<para>
	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 <emphasis>fail</emphasis> unless you also set the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEVETOFILES" xlink:href="smb.conf.5.html#DELETEVETOFILES">delete veto files</link> 
	parameter to <parameter moreinfo="none">yes</parameter>.
	</para>

	<para>
	Setting this parameter will affect the performance of Samba, as it will be forced to check all files 
	and directories for a match as they are scanned.
	</para>

	<para>
	Examples of use include:
<programlisting>
; Veto any files containing the word Security,
; any ending in .tmp, and any directory containing the
; word root.
veto files = /*Security*/*.tmp/*root*/

; Veto the Apple specific files that a NetAtalk server
; creates.
veto files = /.AppleDouble/.bin/.AppleDesktop/Network Trash Folder/
</programlisting>
	</para>


<para>Default: <emphasis><parameter>veto files</parameter> = <literal>
# No files or directories are vetoed</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>veto oplock files</primary></indexterm><anchor id="VETOOPLOCKFILES"/><title>

veto oplock files (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter is only valid when the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="OPLOCKS" xlink:href="smb.conf.5.html#OPLOCKS">oplocks</link>
	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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VETOFILES" xlink:href="smb.conf.5.html#VETOFILES">veto files</link> parameter.
	</para>


	<para>
	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 
	program, which causes heavy client contention for files ending in 
	<filename moreinfo="none">.SEM</filename>. To cause Samba not to grant 
	oplocks on these files you would use the line (either in the [global] 
	section or in the section for the particular NetBench share.
	</para>

	<para>
	An example of use is:
<programlisting>
veto oplock files = /.*SEM/
</programlisting>
	</para>

<para>Default: <emphasis><parameter>veto oplock files</parameter> = <literal>
# No files are vetoed for oplock grants</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client ldap sasl wrapping</primary></indexterm><anchor id="CLIENTLDAPSASLWRAPPING"/><title>

client ldap sasl wrapping (G)
</title><variablelist><varlistentry><listitem>
	<para>
	The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTLDAPSASLWRAPPING" xlink:href="smb.conf.5.html#CLIENTLDAPSASLWRAPPING">client ldap sasl wrapping</link> defines whether
	ldap traffic will be signed or signed and encrypted (sealed). 
	Possible values are <emphasis>plain</emphasis>, <emphasis>sign</emphasis> 
	and <emphasis>seal</emphasis>. 	
	</para>

	<para>
	The values <emphasis>sign</emphasis> and <emphasis>seal</emphasis> are 
	only available if Samba has been compiled against a modern 
	OpenLDAP version (2.3.x or higher).
	</para>
	
	<para>
	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
	"<literal>HKLM\System\CurrentControlSet\Services\</literal>
	<literal>NTDS\Parameters\LDAPServerIntegrity</literal>"
	on the Windows server side.  
	</para>

	<para>
	Depending on the used KRB5 library (MIT and older Heimdal versions)
	it is possible that the message "integrity only" is not supported. 
	In this case, <emphasis>sign</emphasis> is just an alias for 
	<emphasis>seal</emphasis>.
	</para>

	<para>
	The default value is <emphasis>sign</emphasis>. That implies synchronizing the time
	with the KDC in the case of using <emphasis>Kerberos</emphasis>.
	</para>

<para>Default: <emphasis><parameter>client ldap sasl wrapping</parameter> = <literal>sign</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap admin dn</primary></indexterm><anchor id="LDAPADMINDN"/><title>

ldap admin dn (G)
</title><variablelist><varlistentry><listitem>

	 <para>
	The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPADMINDN" xlink:href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</link> defines the Distinguished  Name (DN) name used by Samba to contact
	the ldap server when retreiving  user account information. The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPADMINDN" xlink:href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</link> is used
	in conjunction with the admin dn password stored in the <filename moreinfo="none">private/secrets.tdb</filename>
	file.  See the <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
	man page for more information on how  to accomplish this.
	</para>

	<para>
	The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPADMINDN" xlink:href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</link> requires a fully specified DN. The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap  suffix</link> is not appended to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPADMINDN" xlink:href="smb.conf.5.html#LDAPADMINDN">ldap admin dn</link>.
	</para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap connection timeout</primary></indexterm><anchor id="LDAPCONNECTIONTIMEOUT"/><title>

ldap connection timeout (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter tells the LDAP library calls which timeout in seconds
	they should honor during initial connection establishments to LDAP servers.
	It is very useful in failover scenarios in particular. If one or more LDAP
	servers are not reachable at all, we do not have to wait until TCP
	timeouts are over. This feature must be supported by your LDAP library.
	</para>

	<para>
	This parameter is different from <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPTIMEOUT" xlink:href="smb.conf.5.html#LDAPTIMEOUT">ldap timeout</link>
	which affects operations on LDAP servers using an existing connection
	and not establishing an initial connection.
	</para>

<para>Default: <emphasis><parameter>ldap connection timeout</parameter> = <literal>2</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap delete dn</primary></indexterm><anchor id="LDAPDELETEDN"/><title>

ldap delete dn (G)
</title><variablelist><varlistentry><listitem>
	<para> This parameter specifies whether a delete
	operation in the ldapsam deletes the complete entry or only the attributes
	specific to Samba.
	</para>

<para>Default: <emphasis><parameter>ldap delete dn</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap deref</primary></indexterm><anchor id="LDAPDEREF"/><title>

ldap deref (G)
</title><variablelist><varlistentry><listitem>

	<para>This option controls whether Samba should tell the LDAP library
	to use a certain alias dereferencing method. The default is
	<emphasis>auto</emphasis>, which means that the default setting of the
	ldap client library will be kept. Other possible values are
	<emphasis>never</emphasis>, <emphasis>finding</emphasis>,
	<emphasis>searching</emphasis> and <emphasis>always</emphasis>. Grab
	your LDAP manual for more information.
	</para>


<para>Default: <emphasis><parameter>ldap deref</parameter> = <literal>auto</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap deref</parameter> = <literal>searching</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap follow referral</primary></indexterm><anchor id="LDAPFOLLOWREFERRAL"/><title>

ldap follow referral (G)
</title><variablelist><varlistentry><listitem>

	<para>This option controls whether to follow LDAP referrals or not when
	searching for entries in the LDAP database. Possible values are
	<emphasis>on</emphasis> to enable following referrals,
	<emphasis>off</emphasis> to disable this, and
	<emphasis>auto</emphasis>, to use the libldap default settings.
	libldap's choice of following referrals or not is set in
	/etc/openldap/ldap.conf with the REFERRALS parameter as documented in
	ldap.conf(5).</para>


<para>Default: <emphasis><parameter>ldap follow referral</parameter> = <literal>auto</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap follow referral</parameter> = <literal>off</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap group suffix</primary></indexterm><anchor id="LDAPGROUPSUFFIX"/><title>

ldap group suffix (G)
</title><variablelist><varlistentry><listitem>
	<para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> will be used instead.  The suffix string is pre-pended to the
        <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> string so use a partial DN.</para>


<para>Default: <emphasis><parameter>ldap group suffix</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap group suffix</parameter> = <literal>ou=Groups</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap idmap suffix</primary></indexterm><anchor id="LDAPIDMAPSUFFIX"/><title>

ldap idmap suffix (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameters specifies the suffix that is used when storing idmap mappings. If this parameter 
	is unset, the value of <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> will be used instead.  The suffix 
	string is pre-pended to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> string so use a partial DN.
	</para>

<para>Default: <emphasis><parameter>ldap idmap suffix</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap idmap suffix</parameter> = <literal>ou=Idmap</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap machine suffix</primary></indexterm><anchor id="LDAPMACHINESUFFIX"/><title>

ldap machine suffix (G)
</title><variablelist><varlistentry><listitem>
	<para>
	It specifies where machines should be added to the ldap tree.  If this parameter is unset, the value of
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> will be used instead.  The suffix string is pre-pended to the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> string so use a partial DN.
	</para>

<para>Default: <emphasis><parameter>ldap machine suffix</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap machine suffix</parameter> = <literal>ou=Computers</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap page size</primary></indexterm><anchor id="LDAPPAGESIZE"/><title>

ldap page size (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the number of entries per page.
	</para>

	<para>If the LDAP server supports paged results, clients can
	request	subsets of search results (pages) instead of the entire list.
	This parameter specifies the size of these pages.
	</para>

<para>Default: <emphasis><parameter>ldap page size</parameter> = <literal>1024</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap page size</parameter> = <literal>512</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap password sync</primary><see>ldap passwd sync</see></indexterm><title>

<anchor id="LDAPPASSWORDSYNC"/>ldap password sync
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="LDAPPASSWDSYNC">ldap passwd sync</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>ldap passwd sync</primary></indexterm><anchor id="LDAPPASSWDSYNC"/><title>

ldap passwd sync (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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.  
	</para>

	<para>
	The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPPASSWDSYNC" xlink:href="smb.conf.5.html#LDAPPASSWDSYNC">ldap passwd sync</link> can be set to one of three values: 
	</para>
	
	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">Yes</parameter>  =  Try 
			to update the LDAP, NT and LM passwords and update the pwdLastSet time.</para>
		</listitem>
			
		<listitem>
			<para><parameter moreinfo="none">No</parameter> = Update NT and 
			LM passwords and update the pwdLastSet time.</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">Only</parameter> = Only update 
			the LDAP password and let the LDAP server do the rest.</para>
		</listitem>
	</itemizedlist>		

<para>Default: <emphasis><parameter>ldap passwd sync</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap replication sleep</primary></indexterm><anchor id="LDAPREPLICATIONSLEEP"/><title>

ldap replication sleep (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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' 
	that does not immediately change the LDAP back-end's data.
	</para>
        
	<para>
	This option simply causes Samba to wait a short time, to allow the LDAP server to catch up.  If you have a particularly
	high-latency network, you may wish to time the LDAP replication with a network sniffer, and increase this value accordingly.  
	Be aware that no checking is performed that the data has actually replicated.
	</para>
	
        <para>
	The value is specified in milliseconds, the maximum value is 5000 (5 seconds).
	</para>

<para>Default: <emphasis><parameter>ldap replication sleep</parameter> = <literal>1000</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldapsam:editposix</primary></indexterm><anchor id="LDAPSAM:EDITPOSIX"/><title>

ldapsam:editposix (G)
</title><variablelist><varlistentry><listitem>

	<para>
	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.
	This option also requires a running winbindd as it is used to allocate new uids/gids on user/group
	creation. The allocation range must be therefore configured.
	</para>

	<para>
	To use this option, a basic ldap tree must be provided and the ldap suffix parameters must be properly
	configured. On virgin servers the default users and groups (Administrator, Guest, Domain Users,
	Domain Admins, Domain Guests) can be precreated with the command <literal>net sam
	provision</literal>. To run this command the ldap server must be running, Winbindd must be running and
	the smb.conf ldap options must be properly configured.

	The typical ldap setup used with the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSAM:TRUSTED" xlink:href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</link> option
	is usually sufficient to use <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSAM:EDITPOSIX" xlink:href="smb.conf.5.html#LDAPSAM:EDITPOSIX">ldapsam:editposix = yes</link> as well.
	</para>

	<para>
	An example configuration can be the following:

	<programlisting>
	encrypt passwords = true
	passdb backend = ldapsam

	ldapsam:trusted=yes
	ldapsam:editposix=yes

	ldap admin dn = cn=admin,dc=samba,dc=org
	ldap delete dn = yes
	ldap group suffix = ou=groups
	ldap idmap suffix = ou=idmap
	ldap machine suffix = ou=computers
	ldap user suffix = ou=users
	ldap suffix = dc=samba,dc=org

	idmap backend = ldap:"ldap://localhost"

	idmap uid = 5000-50000
	idmap gid = 5000-50000
	</programlisting>

	This configuration assumes a directory layout like described in the following ldif:

	<programlisting>
	dn: dc=samba,dc=org
	objectClass: top
	objectClass: dcObject
	objectClass: organization
	o: samba.org
	dc: samba

	dn: cn=admin,dc=samba,dc=org
	objectClass: simpleSecurityObject
	objectClass: organizationalRole
	cn: admin
	description: LDAP administrator
	userPassword: secret

	dn: ou=users,dc=samba,dc=org
	objectClass: top
	objectClass: organizationalUnit
	ou: users

	dn: ou=groups,dc=samba,dc=org
	objectClass: top
	objectClass: organizationalUnit
	ou: groups

	dn: ou=idmap,dc=samba,dc=org
	objectClass: top
	objectClass: organizationalUnit
	ou: idmap

	dn: ou=computers,dc=samba,dc=org
	objectClass: top
	objectClass: organizationalUnit
	ou: computers
	</programlisting>
	</para>


<para>Default: <emphasis><parameter>ldapsam:editposix</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldapsam:trusted</primary></indexterm><anchor id="LDAPSAM:TRUSTED"/><title>

ldapsam:trusted (G)
</title><variablelist><varlistentry><listitem>

	<para>
	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
	is member of. The plain UNIX model involves a complete enumeration of the file /etc/group and its NSS
	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.
	</para>

	<para>
	To make Samba scale well in large environments, the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSAM:TRUSTED" xlink:href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</link>
	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, 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSAM:TRUSTED" xlink:href="smb.conf.5.html#LDAPSAM:TRUSTED">ldapsam:trusted = yes</link> 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.
	</para>


<para>Default: <emphasis><parameter>ldapsam:trusted</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap ssl</primary></indexterm><anchor id="LDAPSSL"/><title>

ldap ssl (G)
</title><variablelist><varlistentry><listitem>
	<para>This option is used to define whether or not Samba should
	use SSL when connecting to the ldap server
	This is <emphasis>NOT</emphasis> related to
	Samba's previous SSL support which was enabled by specifying the
	<literal>--with-ssl</literal> option to the
	<filename moreinfo="none">configure</filename>
	script.</para>

	<para>LDAP connections should be secured where possible. This may be
	done setting <emphasis>either</emphasis> this parameter to
	<parameter moreinfo="none">Start_tls</parameter>
	<emphasis>or</emphasis> by specifying <parameter moreinfo="none">ldaps://</parameter> in
        the URL argument of <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSDBBACKEND" xlink:href="smb.conf.5.html#PASSDBBACKEND">passdb backend</link>.</para>

	<para>The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSL" xlink:href="smb.conf.5.html#LDAPSSL">ldap ssl</link> can be set to one of
	two values:</para>
	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">Off</parameter> = Never
			use SSL when querying the directory.</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">start tls</parameter> = Use
			the LDAPv3 StartTLS extended operation (RFC2830) for
			communicating with the directory server.</para>
		</listitem>
	</itemizedlist>
	<para>
	Please note that this parameter does only affect <emphasis>rpc</emphasis>
	methods. To enable the LDAPv3 StartTLS extended operation (RFC2830) for
	<emphasis>ads</emphasis>, set
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSL" xlink:href="smb.conf.5.html#LDAPSSL">ldap ssl = yes</link>
	<emphasis>and</emphasis>
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSLADS" xlink:href="smb.conf.5.html#LDAPSSLADS">ldap ssl ads = yes</link>.
	See <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
	for more information on	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSLADS" xlink:href="smb.conf.5.html#LDAPSSLADS">ldap ssl ads</link>.
        </para>


<para>Default: <emphasis><parameter>ldap ssl</parameter> = <literal>start tls</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap ssl ads</primary></indexterm><anchor id="LDAPSSLADS"/><title>

ldap ssl ads (G)
</title><variablelist><varlistentry><listitem>
	<para>This option is used to define whether or not Samba should
	use SSL when connecting to the ldap server using
	<emphasis>ads</emphasis> methods.
	Rpc methods are not affected by this parameter. Please note, that
	this parameter won't have any effect if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSL" xlink:href="smb.conf.5.html#LDAPSSL">ldap ssl</link>
	is set to <parameter>no</parameter>.
	</para>

	<para>See <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
	for more information on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSL" xlink:href="smb.conf.5.html#LDAPSSL">ldap ssl</link>.
	</para>


<para>Default: <emphasis><parameter>ldap ssl ads</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap suffix</primary></indexterm><anchor id="LDAPSUFFIX"/><title>

ldap suffix (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies the base for all ldap suffixes and for storing the sambaDomain object.</para>

	<para>
	The ldap suffix will be appended to the values specified for the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPUSERSUFFIX" xlink:href="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</link>,
	 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPGROUPSUFFIX" xlink:href="smb.conf.5.html#LDAPGROUPSUFFIX">ldap group suffix</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPMACHINESUFFIX" xlink:href="smb.conf.5.html#LDAPMACHINESUFFIX">ldap machine suffix</link>, and the
	 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPIDMAPSUFFIX" xlink:href="smb.conf.5.html#LDAPIDMAPSUFFIX">ldap idmap suffix</link>. Each of these should be given only a DN relative to the
	 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link>.
	</para>

<para>Default: <emphasis><parameter>ldap suffix</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap suffix</parameter> = <literal>dc=samba,dc=org</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap timeout</primary></indexterm><anchor id="LDAPTIMEOUT"/><title>

ldap timeout (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter defines the number of seconds that Samba should use as timeout for LDAP operations.
	</para>

<para>Default: <emphasis><parameter>ldap timeout</parameter> = <literal>15</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap user suffix</primary></indexterm><anchor id="LDAPUSERSUFFIX"/><title>

ldap user suffix (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies where users are added to the tree. If this parameter is unset, 
	the value of <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> will be used instead.  The suffix 
	string is pre-pended to the  <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSUFFIX" xlink:href="smb.conf.5.html#LDAPSUFFIX">ldap suffix</link> string so use a partial DN.
	</para>


<para>Default: <emphasis><parameter>ldap user suffix</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap user suffix</parameter> = <literal>ou=people</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>blocking locks</primary></indexterm><anchor id="BLOCKINGLOCKS"/><title>

blocking locks (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter controls the behavior 
	of <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> 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.</para>
		
	<para>If this parameter is set and the lock range requested 
	cannot be immediately satisfied, samba will internally 
	queue the lock request, and periodically attempt to obtain 
	the lock until the timeout period expires.</para>

	<para>If this parameter is set to <constant>no</constant>, then 
	samba will behave as previous versions of Samba would and 
	will fail the lock request immediately if the lock range 
	cannot be obtained.</para>


<para>Default: <emphasis><parameter>blocking locks</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>csc policy</primary></indexterm><anchor id="CSCPOLICY"/><title>

csc policy (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This stands for <emphasis>client-side caching policy</emphasis>, and specifies how clients capable of offline
	caching will cache the files in the share. The valid values are: manual, documents, programs, disable.
	</para>

	<para>
	These values correspond to those used on Windows servers.
	</para>

	<para>
	For example, shares containing roaming profiles can have offline caching disabled using 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CSCPOLICY" xlink:href="smb.conf.5.html#CSCPOLICY">csc policy = disable</link>.
	</para>

<para>Default: <emphasis><parameter>csc policy</parameter> = <literal>manual</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>csc policy</parameter> = <literal>programs</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>fake oplocks</primary></indexterm><anchor id="FAKEOPLOCKS"/><title>

fake oplocks (S)
</title><variablelist><varlistentry><listitem>
	<para>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.
	</para>

	<para>When you set <literal>fake oplocks = yes</literal>, <citerefentry>
	<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum></citerefentry> will
	always grant oplock requests no matter how many clients are using the file.</para>

	<para>It is generally much better to use the real <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="OPLOCKS" xlink:href="smb.conf.5.html#OPLOCKS">oplocks</link> support rather 
	than this parameter.</para>
		
	<para>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 
	a big performance improvement on many operations. If you enable 
	this option on shares where multiple clients may be accessing the 
	files read-write at the same time you can get data corruption. Use 
	this option carefully!</para>

<para>Default: <emphasis><parameter>fake oplocks</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>kernel oplocks</primary></indexterm><anchor id="KERNELOPLOCKS"/><title>

kernel oplocks (S)
</title><variablelist><varlistentry><listitem>
	<para>For UNIXes that support kernel based <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="OPLOCKS" xlink:href="smb.conf.5.html#OPLOCKS">oplocks</link>
	(currently only IRIX and the Linux 2.4 kernel), this parameter 
	allows the use of them to be turned on or off. However, this disables
	Level II oplocks for clients as the Linux and IRIX kernels do not
	support them properly.</para>

	<para>Kernel oplocks support allows Samba <parameter moreinfo="none">oplocks
	</parameter> to be broken whenever a local UNIX process or NFS operation 
	accesses a file that <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> has oplocked. This allows complete 
	data consistency between SMB/CIFS, NFS and local file access (and is 
	a <emphasis>very</emphasis> cool feature :-).</para>
	<para>If you do not need this interaction, you should disable the
	parameter on Linux and IRIX to get Level II oplocks and the associated
	performance benefit.</para>

	<para>This parameter defaults to <constant>no</constant> and is translated
	to a no-op on systems that do not have the necessary kernel support.</para>

<para>Default: <emphasis><parameter>kernel oplocks</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>kernel share modes</primary></indexterm><anchor id="KERNELSHAREMODES"/><title>

kernel share modes (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter controls whether SMB share modes are
	translated into UNIX flocks.
	</para>

	<para>
	Kernel share modes provide a minimal level of interoperability
	with local UNIX processes and NFS operations by preventing
	access with flocks corresponding to the SMB share modes.
	Generally, it is very desirable to leave this enabled.
	</para>

	<para>
	Note that in order to use SMB2 durable file handles on a share,
	you have to turn kernel share modes off.
	</para>

	<para>
	This parameter defaults to <constant>yes</constant> and
	is translated to a no-op on systems that do not have the
	 necessary kernel flock support.
	</para>

<para>Default: <emphasis><parameter>kernel share modes</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>level2 oplocks</primary></indexterm><anchor id="LEVEL2OPLOCKS"/><title>

level2 oplocks (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter controls whether Samba supports
	level2 (read-only) oplocks on a share.</para>
		
	<para>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 
	of releasing all oplocks on a second open, as in traditional, 
	exclusive oplocks). This allows all openers of the file that 
	support level2 oplocks to cache the file for read-ahead only (ie. 
	they may not cache writes or lock requests) and increases performance 
	for many accesses of files that are not commonly written (such as 
	application .EXE files).</para>

	<para>Once one of the clients which have a read-only oplock 
	writes to the file all clients are notified (no reply is needed 
	or waited for) and told to break their oplocks to "none" and 
	delete any read-ahead caches.</para>

	<para>It is recommended that this parameter be turned on to
	speed access to shared executables.</para>

	<para>For more discussions on level2 oplocks see the CIFS spec.</para>

	<para>
	Currently, if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERNELOPLOCKS" xlink:href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks</link> are supported then
	level2 oplocks are not granted (even if this parameter is set to
	<constant>yes</constant>).  Note also, the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="OPLOCKS" xlink:href="smb.conf.5.html#OPLOCKS">oplocks</link>
	parameter must be set to <constant>yes</constant> on this share in order for 
	this parameter to have any effect.</para>

<para>Default: <emphasis><parameter>level2 oplocks</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>locking</primary></indexterm><anchor id="LOCKING"/><title>

locking (S)
</title><variablelist><varlistentry><listitem>
	<para>This controls whether or not locking will be 
	performed by the server in response to lock requests from the 
	client.</para>

	<para>If <literal>locking = no</literal>, all lock and unlock 
	requests will appear to succeed and all lock queries will report 
	that the file in question is available for locking.</para>

	<para>If <literal>locking = yes</literal>, real locking will be performed 
	by the server.</para>

	<para>This option <emphasis>may</emphasis> be useful for read-only 
	filesystems which <emphasis>may</emphasis> not need locking (such as 
	CDROM drives), although setting this parameter of <constant>no</constant> 
	is not really recommended even in this case.</para>

	<para>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.</para>

<para>Default: <emphasis><parameter>locking</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lock spin time</primary></indexterm><anchor id="LOCKSPINTIME"/><title>

lock spin time (G)
</title><variablelist><varlistentry><listitem>
	<para>The time in milliseconds 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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOCKSPINCOUNT" xlink:href="smb.conf.5.html#LOCKSPINCOUNT">lock spin count</link> parameter is
	no longer used in Samba 3.0.24. You should not need
	to change the value of this parameter.</para>

<para>Default: <emphasis><parameter>lock spin time</parameter> = <literal>200</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>oplock break wait time</primary></indexterm><anchor id="OPLOCKBREAKWAITTIME"/><title>

oplock break wait time (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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 
	of time Samba will wait before sending an oplock break request to such (broken) clients.
	</para>

	<warning><para>
	DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
	</para></warning>

<para>Default: <emphasis><parameter>oplock break wait time</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>oplock contention limit</primary></indexterm><anchor id="OPLOCKCONTENTIONLIMIT"/><title>

oplock contention limit (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This is a <emphasis>very</emphasis> advanced <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> tuning option to improve the efficiency of the 
	granting of oplocks under multiple client contention for the same file.
	</para>
		
	<para>
	In brief it specifies a number, which causes <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>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 <literal>smbd</literal> to behave in a similar 
	way to Windows NT.
	</para>

	<warning><para>
	DO NOT CHANGE THIS PARAMETER UNLESS YOU HAVE READ AND UNDERSTOOD THE SAMBA OPLOCK CODE.
	</para></warning>


<para>Default: <emphasis><parameter>oplock contention limit</parameter> = <literal>2</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>oplocks</primary></indexterm><anchor id="OPLOCKS"/><title>

oplocks (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This boolean option tells <literal>smbd</literal> whether to 
	issue oplocks (opportunistic locks) to file open requests on this 
	share. The oplock code can dramatically (approx. 30% or more) improve 
	the speed of access to files on Samba servers. It allows the clients 
	to aggressively cache files locally and you may want to disable this 
	option for unreliable network environments (it is turned on by 
	default in Windows NT Servers).
	</para>

	<para>
	Oplocks may be selectively turned off on certain files with a share. See 
	the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VETOOPLOCKFILES" xlink:href="smb.conf.5.html#VETOOPLOCKFILES">veto oplock files</link> 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 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERNELOPLOCKS" xlink:href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks</link> parameter for details.
	</para>

<para>Default: <emphasis><parameter>oplocks</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>posix locking</primary></indexterm><anchor id="POSIXLOCKING"/><title>

posix locking (S)
</title><variablelist><varlistentry><listitem>
	<para>
	The <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
	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). It is very unlikely that you need to set this parameter
	to "no", unless you are sharing from an NFS mount, which is not a good idea in the first place.
	</para>

<para>Default: <emphasis><parameter>posix locking</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb2 leases</primary></indexterm><anchor id="SMB2LEASES"/><title>

smb2 leases (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This boolean option tells <literal>smbd</literal> whether to
	globally negotiate SMB2 leases on file open requests. Leasing is an SMB2-only
	feature which allows clients to aggressively cache files locally above and
	beyond the caching allowed by SMB1 oplocks. This (experimental) parameter is
	set to off by default until the SMB2 leasing code is declared fully stable.
	</para>

	<para>
	This is only available with <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="OPLOCKS" xlink:href="smb.conf.5.html#OPLOCKS">oplocks = yes</link>
	and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERNELOPLOCKS" xlink:href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks = no</link>.
	</para>

	<para>Note that the write cache won't be used for file handles with a smb2 write lease.</para>

	<para>
	The Samba implementation of leases is currently marked as experimental!
	</para>

<para>Default: <emphasis><parameter>smb2 leases</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>strict locking</primary></indexterm><anchor id="STRICTLOCKING"/><title>

strict locking (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This is an enumerated type that controls the handling of file locking in the server. When this is set to <constant>yes</constant>,
	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.
	</para>

	<para>
	When strict locking is set to Auto (the default), the server performs file lock checks only on non-oplocked files.
	As most Windows redirectors perform file locking checks locally on oplocked files this is a good trade off for
	improved performance.
	</para>

	<para>
	When strict locking is disabled, the server performs file lock checks only when the client explicitly asks for them.
	</para>

	<para>
	Well-behaved clients always ask for lock checks when it is important.  So in the vast majority of cases, 
	 <literal>strict locking = Auto</literal> or
	 <literal>strict locking = no</literal> is acceptable.
	</para>

<para>Default: <emphasis><parameter>strict locking</parameter> = <literal>Auto</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debug class</primary></indexterm><anchor id="DEBUGCLASS"/><title>

debug class (G)
</title><variablelist><varlistentry><listitem>
    <para>
    With this boolean parameter enabled, the debug class (DBGC_CLASS) 
    will be displayed in the debug header.
    </para>
    <para>
    For more information about currently available debug classes, see
    section about <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGLEVEL" xlink:href="smb.conf.5.html#LOGLEVEL">log level</link>.
    </para>


<para>Default: <emphasis><parameter>debug class</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debug hires timestamp</primary></indexterm><anchor id="DEBUGHIRESTIMESTAMP"/><title>

debug hires timestamp (G)
</title><variablelist><varlistentry><listitem>
    <para>
    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.
    </para>

    <para>
    Note that the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGTIMESTAMP" xlink:href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</link> must be on for this to have an effect.
    </para>


<para>Default: <emphasis><parameter>debug hires timestamp</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debug pid</primary></indexterm><anchor id="DEBUGPID"/><title>

debug pid (G)
</title><variablelist><varlistentry><listitem>
    <para>
    When using only one log file for more then one forked <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry>-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.
    </para>

    <para>
    Note that the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGTIMESTAMP" xlink:href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</link> must be on for this to have an effect.
    </para>

<para>Default: <emphasis><parameter>debug pid</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debug prefix timestamp</primary></indexterm><anchor id="DEBUGPREFIXTIMESTAMP"/><title>

debug prefix timestamp (G)
</title><variablelist><varlistentry><listitem>
    <para>
    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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGTIMESTAMP" xlink:href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</link> 
    parameter. This gives timestamps to the messages without adding an additional line.
    </para>

    <para>
    Note that this parameter overrides the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGTIMESTAMP" xlink:href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</link> parameter.
    </para>


<para>Default: <emphasis><parameter>debug prefix timestamp</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>timestamp logs</primary><see>debug timestamp</see></indexterm><title>

<anchor id="TIMESTAMPLOGS"/>timestamp logs
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="DEBUGTIMESTAMP">debug timestamp</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>debug timestamp</primary></indexterm><anchor id="DEBUGTIMESTAMP"/><title>

debug timestamp (G)
</title><variablelist><varlistentry><listitem>
    <para>
    Samba debug log messages are timestamped by default. If you are running at a high 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGLEVEL" xlink:href="smb.conf.5.html#DEBUGLEVEL">debug level</link> these timestamps can be distracting. This 
    boolean parameter allows timestamping to be turned off.
	</para>

<para>Default: <emphasis><parameter>debug timestamp</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debug uid</primary></indexterm><anchor id="DEBUGUID"/><title>

debug uid (G)
</title><variablelist><varlistentry><listitem>
    <para>
    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.
    </para>
		
    <para>
    Note that the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGTIMESTAMP" xlink:href="smb.conf.5.html#DEBUGTIMESTAMP">debug timestamp</link> must be on for this to have an effect.
    </para>

<para>Default: <emphasis><parameter>debug uid</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap debug level</primary></indexterm><anchor id="LDAPDEBUGLEVEL"/><title>

ldap debug level (G)
</title><variablelist><varlistentry><listitem>
	<para>
		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
		 <citerefentry>
			<refentrytitle>slapd.conf</refentrytitle>
			<manvolnum>5</manvolnum>
		</citerefentry>
		manpage.
		A typical useful value will be
		 <emphasis>1</emphasis> for tracing function calls.
	</para>
	<para>
		The debug output 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 <parameter>ldap debug threshold</parameter>.
	</para>

<para>Default: <emphasis><parameter>ldap debug level</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap debug level</parameter> = <literal>1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ldap debug threshold</primary></indexterm><anchor id="LDAPDEBUGTHRESHOLD"/><title>

ldap debug threshold (G)
</title><variablelist><varlistentry><listitem>
	<para>
		This parameter controls the Samba debug level at which
		the ldap library debug output is
		printed in the Samba logs. See the description of
		 <parameter>ldap debug level</parameter> for details.
	</para>

<para>Default: <emphasis><parameter>ldap debug threshold</parameter> = <literal>10</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ldap debug threshold</parameter> = <literal>5</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>log file</primary></indexterm><anchor id="LOGFILE"/><title>

log file (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This option allows you to override the name of the Samba log file (also known as the debug file).
    </para>

    <para>
    This option takes the standard substitutions, allowing you to have separate log files for each user or machine.
    </para>

<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>log file</parameter> = <literal>/usr/local/samba/var/log.%m</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>logging</primary></indexterm><anchor id="LOGGING"/><title>

logging (G)
</title><variablelist><varlistentry><listitem>

  <para>This parameter configures logging backends. Multiple
    backends can be specified at the same time, with different log
    levels for each backend. The parameter is a list of backends,
    where each backend is specified as backend[:option][@loglevel].</para>

  <para>The 'option' parameter can be used to pass backend-specific
    options.</para>

  <para>The log level for a backend is optional, if it is not set for
    a backend, all messages are sent to this backend. The parameter
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGLEVEL" xlink:href="smb.conf.5.html#LOGLEVEL">log level</link> determines overall log levels,
    while the log levels specified here define what is sent to the
    individual backends.</para>

  <para>When <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGGING" xlink:href="smb.conf.5.html#LOGGING">logging</link> is set, it overrides the
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SYSLOG" xlink:href="smb.conf.5.html#SYSLOG">syslog</link>  and  <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SYSLOGONLY" xlink:href="smb.conf.5.html#SYSLOGONLY">syslog     only</link> parameters.</para>

  <para>Some backends are only available when Samba has been compiled
  with the additional libraries. The overall list of logging backends:</para>

  <itemizedlist>
    <listitem><para><parameter moreinfo="none">syslog</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">file</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">systemd</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">lttng</parameter></para></listitem>
    <listitem><para><parameter moreinfo="none">gpfs</parameter></para></listitem>
  </itemizedlist>


<para>Default: <emphasis><parameter>logging</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>logging</parameter> = <literal>syslog@1 file</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>debuglevel</primary><see>log level</see></indexterm><title>

<anchor id="DEBUGLEVEL"/>debuglevel
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="LOGLEVEL">log level</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>log level</primary></indexterm><anchor id="LOGLEVEL"/><title>

log level (G)
</title><variablelist><varlistentry><listitem>
    <para>
    The value of the parameter (a astring) allows the debug level (logging level) to be specified in the 
    <filename moreinfo="none">smb.conf</filename> file. 
    </para>

    <para>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:
    </para>

    <itemizedlist>
	<listitem><para><parameter moreinfo="none">all</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">tdb</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">printdrivers</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">lanman</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">smb</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">rpc_parse</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">rpc_srv</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">rpc_cli</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">passdb</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">sam</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">auth</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">winbind</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">vfs</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">idmap</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">quota</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">acls</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">locking</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">msdfs</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">dmapi</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">registry</parameter></para></listitem>
    </itemizedlist>
    

<para>Default: <emphasis><parameter>log level</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>log level</parameter> = <literal>3 passdb:5 auth:10 winbind:2</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max log size</primary></indexterm><anchor id="MAXLOGSIZE"/><title>

max log size (G)
</title><variablelist><varlistentry><listitem>
    <para>
    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 <filename moreinfo="none">.old</filename> extension.
	</para>

	<para>A size of 0 means no limit.
	</para>

<para>Default: <emphasis><parameter>max log size</parameter> = <literal>5000</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max log size</parameter> = <literal>1000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>syslog</primary></indexterm><anchor id="SYSLOG"/><title>

syslog (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This parameter maps how Samba debug messages are logged onto the system syslog logging levels. 
    Samba debug level zero maps onto syslog <constant>LOG_ERR</constant>, debug level one maps onto 
    <constant>LOG_WARNING</constant>, debug level two maps onto <constant>LOG_NOTICE</constant>,
    debug level three maps onto LOG_INFO. All higher levels are mapped to <constant>LOG_DEBUG</constant>.
    </para>

    <para>
    This parameter sets the threshold for sending messages to syslog.  Only messages with debug 
    level less than this value will be sent to syslog. There still will be some
    logging to log.[sn]mbd even if <emphasis>syslog only</emphasis> is enabled.
    </para>

    <para>The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGGING" xlink:href="smb.conf.5.html#LOGGING">logging</link> parameter should be used
      instead. When <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGGING" xlink:href="smb.conf.5.html#LOGGING">logging</link> is set, it
      overrides the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SYSLOG" xlink:href="smb.conf.5.html#SYSLOG">syslog</link> parameter.</para>

<para>Default: <emphasis><parameter>syslog</parameter> = <literal>1</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>syslog only</primary></indexterm><anchor id="SYSLOGONLY"/><title>

syslog only (G)
</title><variablelist><varlistentry><listitem>
    <para>
    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 <emphasis>syslog only</emphasis> is enabled.
    </para>


    <para>The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGGING" xlink:href="smb.conf.5.html#LOGGING">logging</link> parameter should be used
      instead. When <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGGING" xlink:href="smb.conf.5.html#LOGGING">logging</link> is set, it
      overrides the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SYSLOGONLY" xlink:href="smb.conf.5.html#SYSLOGONLY">syslog only</link> parameter.</para>

<para>Default: <emphasis><parameter>syslog only</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>abort shutdown script</primary></indexterm><anchor id="ABORTSHUTDOWNSCRIPT"/><title>

abort shutdown script (G)
</title><variablelist><varlistentry><listitem>
	<para>This a full path name to a script called by <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> that
	should stop a shutdown procedure issued by the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SHUTDOWNSCRIPT" xlink:href="smb.conf.5.html#SHUTDOWNSCRIPT">shutdown script</link>.</para>
		
	<para>If the connected user possesses the <constant>SeRemoteShutdownPrivilege</constant>,
	right, this command will be run as root.</para>

<para>Default: <emphasis><parameter>abort shutdown script</parameter> = <literal>""</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>abort shutdown script</parameter> = <literal>/sbin/shutdown -c</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>add group script</primary></indexterm><anchor id="ADDGROUPSCRIPT"/><title>

add group script (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This is the full pathname to a script that will be run <emphasis>AS ROOT</emphasis> by <citerefentry>
	<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum></citerefentry> when a new group is requested. It
	will expand any <parameter moreinfo="none">%g</parameter> 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
	gid of the created group on stdout.
	</para>

<para>Default: <emphasis><parameter>add group script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>add group script</parameter> = <literal>/usr/sbin/groupadd %g</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>add machine script</primary></indexterm><anchor id="ADDMACHINESCRIPT"/><title>

add machine script (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This is the full pathname to a script that will  be run by
	 <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 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.
	</para>
        <para>This option is very similar to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ADDUSERSCRIPT" xlink:href="smb.conf.5.html#ADDUSERSCRIPT">add user script</link>, and likewise uses the %u
        substitution for the account name.  Do not use the %m
        substitution.  </para>

<para>Default: <emphasis><parameter>add machine script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>add machine script</parameter> = <literal>/usr/sbin/adduser -n -g machines -c Machine -d /var/lib/nobody -s /bin/false %u</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>add user script</primary></indexterm><anchor id="ADDUSERSCRIPT"/><title>

add user script (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This is the full pathname to a script that will be run <emphasis>AS ROOT</emphasis> by 
	<citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 
	under special circumstances described below.
	</para>

	<para>
	Normally, a Samba server requires that UNIX users are created for all users accessing 
	files on this server. For sites that use Windows NT account databases as their primary 
	user database creating these users and keeping the user list in sync with the Windows 
	NT PDC is an onerous task. This option allows smbd to create the required UNIX users 
	 <emphasis>ON DEMAND</emphasis> when a user accesses the Samba server.
	</para>

	<para>
	When the Windows user attempts to access the Samba server, at login (session setup in 
	the SMB protocol) time, <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> contacts the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWORDSERVER" xlink:href="smb.conf.5.html#PASSWORDSERVER">password server</link> 
	and attempts to authenticate the given user with the given password. If the authentication 
	succeeds then <literal>smbd</literal> attempts to find a UNIX user in the UNIX 
	password database to map the Windows user into. If this lookup fails, and 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ADDUSERSCRIPT" xlink:href="smb.conf.5.html#ADDUSERSCRIPT">add user script</link> is set then <literal>smbd</literal> will
	call the specified script <emphasis>AS ROOT</emphasis>, expanding any 
	<parameter moreinfo="none">%u</parameter> argument to be the user name to create.
	</para>

	<para>
	If this script successfully creates the user then <literal>smbd</literal> will 
	continue on as though the UNIX user already existed. In this way, UNIX users are dynamically created to
	match existing Windows NT accounts.
	</para>

	<para>
	See also <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWORDSERVER" xlink:href="smb.conf.5.html#PASSWORDSERVER">password server</link>,
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEUSERSCRIPT" xlink:href="smb.conf.5.html#DELETEUSERSCRIPT">delete user script</link>.
	</para>

<para>Default: <emphasis><parameter>add user script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>add user script</parameter> = <literal>/usr/local/samba/bin/add_user %u</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>add user to group script</primary></indexterm><anchor id="ADDUSERTOGROUPSCRIPT"/><title>

add user to group script (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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 <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>
	<emphasis>AS ROOT</emphasis>. Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and 
	any <parameter moreinfo="none">%u</parameter> will be replaced with the user name.
	</para>

	<para>
	Note that the <literal>adduser</literal> command used in the example below does 
	not support the used syntax on all systems. 
	</para>


<para>Default: <emphasis><parameter>add user to group script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>add user to group script</parameter> = <literal>/usr/sbin/adduser %u %g</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allow nt4 crypto</primary></indexterm><anchor id="ALLOWNT4CRYPTO"/><title>

allow nt4 crypto (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether the netlogon server (currently
	only in 'active directory domain controller' mode), will
	reject clients which does not support NETLOGON_NEG_STRONG_KEYS
	nor NETLOGON_NEG_SUPPORTS_AES.</para>

	<para>This option was added with Samba 4.2.0. It may lock out clients
	which worked fine with Samba versions up to 4.1.x. as the effective default
	was "yes" there, while it is "no" now.</para>

	<para>If you have clients without RequireStrongKey = 1 in the registry,
	you may need to set "allow nt4 crypto = yes", until you have fixed all clients.
	</para>

	<para>"allow nt4 crypto = yes" allows weak crypto to be negotiated, maybe via downgrade attacks.</para>

	<para>This option yields precedence to the 'reject md5 clients' option.</para>

<para>Default: <emphasis><parameter>allow nt4 crypto</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete group script</primary></indexterm><anchor id="DELETEGROUPSCRIPT"/><title>

delete group script (G)
</title><variablelist><varlistentry><listitem>
	<para>This is the full pathname to a script that will 
	be run <emphasis>AS ROOT</emphasis> <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> when a group is requested to be deleted. 
	It will expand any <parameter moreinfo="none">%g</parameter> to the group name passed.  
	This script is only useful for installations using the Windows NT domain administration tools.
	</para>

<para>Default: <emphasis><parameter>delete group script</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete user from group script</primary></indexterm><anchor id="DELETEUSERFROMGROUPSCRIPT"/><title>

delete user from group script (G)
</title><variablelist><varlistentry><listitem>
	<para>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 <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> <emphasis>AS ROOT</emphasis>. 
	Any <parameter moreinfo="none">%g</parameter> will be replaced with the group name and 
	any <parameter moreinfo="none">%u</parameter> will be replaced with the user name.
</para>

<para>Default: <emphasis><parameter>delete user from group script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>delete user from group script</parameter> = <literal>/usr/sbin/deluser %u %g</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete user script</primary></indexterm><anchor id="DELETEUSERSCRIPT"/><title>

delete user script (G)
</title><variablelist><varlistentry><listitem>
	<para>This is the full pathname to a script that will 
	be run by <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> when managing users 
	with remote RPC (NT) tools.
	</para>

	<para>This script is called when a remote client removes a user
	from the server, normally using 'User Manager for Domains' or
	<literal>rpcclient</literal>.</para>

	<para>This script should delete the given UNIX username.</para>

<para>Default: <emphasis><parameter>delete user script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>delete user script</parameter> = <literal>/usr/local/samba/bin/del_user %u</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>domain logons</primary></indexterm><anchor id="DOMAINLOGONS"/><title>

domain logons (G)
</title><variablelist><varlistentry><listitem>
	<para>
	If set to <constant>yes</constant>, the Samba server will
	provide the netlogon service for Windows 9X network logons for the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> 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.
	</para>

<para>Default: <emphasis><parameter>domain logons</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enable privileges</primary></indexterm><anchor id="ENABLEPRIVILEGES"/><title>

enable privileges (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This deprecated parameter controls whether or not smbd will honor privileges assigned to specific SIDs via either
	 <literal>net rpc rights</literal> 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
	assign privileges to users or groups which can then result in certain smbd operations running as root that
	would normally run under the context of the connected user.
	</para>

	<para>
	An example of how privileges can be used is to assign the right to join clients to a Samba controlled
	domain without providing root access to the server via smbd.
	</para>

	<para>
	Please read the extended description provided in the Samba HOWTO documentation.
	</para>


<para>Default: <emphasis><parameter>enable privileges</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>init logon delay</primary></indexterm><anchor id="INITLOGONDELAY"/><title>

init logon delay (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies a delay in milliseconds for the hosts configured
	for delayed initial samlogon with
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INITLOGONDELAYEDHOSTS" xlink:href="smb.conf.5.html#INITLOGONDELAYEDHOSTS">init logon delayed hosts</link>.
	</para>

<para>Default: <emphasis><parameter>init logon delay</parameter> = <literal>100</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>init logon delayed hosts</primary></indexterm><anchor id="INITLOGONDELAYEDHOSTS"/><title>

init logon delayed hosts (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter takes a list of host names, addresses or networks for
	which the initial samlogon reply should be delayed (so other DCs get
	preferred by XP workstations if there are any).
	</para>

	<para>
	The length of the delay can be specified with the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INITLOGONDELAY" xlink:href="smb.conf.5.html#INITLOGONDELAY">init logon delay</link> parameter.
	</para>

<para>Default: <emphasis><parameter>init logon delayed hosts</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>init logon delayed hosts</parameter> = <literal>150.203.5. myhost.mynet.de</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>logon drive</primary></indexterm><anchor id="LOGONDRIVE"/><title>

logon drive (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the local path to which the home directory will be
	connected (see <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONHOME" xlink:href="smb.conf.5.html#LOGONHOME">logon home</link>) and is only used by NT
	Workstations.
	</para>

	<para>
	Note that this option is only useful if Samba is set up as a logon server.
	</para>

<para>Default: <emphasis><parameter>logon drive</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>logon drive</parameter> = <literal>h:</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>logon home</primary></indexterm><anchor id="LOGONHOME"/><title>

logon home (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the home directory location when a Win95/98 or NT Workstation logs into a Samba PDC.  
	It allows you to do
	</para>
		
	<para>
	<prompt moreinfo="none">C:\&gt;</prompt><userinput moreinfo="none">NET USE H: /HOME</userinput>
	</para>

	<para>
	from a command prompt, for example.
	</para>

	<para>
	This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
	</para>

	<para>
	This parameter can be used with Win9X workstations to ensure that roaming profiles are stored in a 
	subdirectory of the user's 	home directory.  This is done in the following way:
	</para>

	<para>
	<literal>logon home = \\%N\%U\profile</literal>
	</para>

	<para>
	This tells Samba to return the above string, with substitutions made when a client requests the info, generally 
	in a NetUserGetInfo request.  Win9X clients truncate the info to \\server\share when a user does 
  	 <literal>net use /home</literal> but use the whole string when dealing with profiles.
	</para>

	<para>
	Note that in prior versions of Samba, the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONPATH" xlink:href="smb.conf.5.html#LOGONPATH">logon path</link> was returned rather than 
	<parameter moreinfo="none">logon home</parameter>.  This broke <literal>net use /home</literal> 
	but allowed profiles outside the home directory. The current implementation is correct, and can be used for 
	profiles if you use the above trick.
	</para>

	<para>
	Disable this feature by setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONHOME" xlink:href="smb.conf.5.html#LOGONHOME">logon home = ""</link> - using the empty string.
	</para>

	<para>
	This option is only useful if Samba is set up as a logon server.
	</para>

<para>Default: <emphasis><parameter>logon home</parameter> = <literal>\\%N\%U</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>logon home</parameter> = <literal>\\remote_smb_server\%U</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>logon path</primary></indexterm><anchor id="LOGONPATH"/><title>

logon path (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONHOME" xlink:href="smb.conf.5.html#LOGONHOME">logon home</link> parameter.
	</para>

	<para>
	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", <filename moreinfo="none">desktop</filename>, <filename moreinfo="none">start menu</filename>, <filename moreinfo="none">network neighborhood</filename>, <filename moreinfo="none">programs</filename> and other
	folders, and their contents, are loaded and displayed on your Windows NT client.
	</para>

	<para>
	The share and the path must be readable by the user for the preferences and directories to be loaded onto the
	Windows NT client. The share must be writeable when the user logs in for the first time, in order that the
	Windows NT client can create the NTuser.dat and other directories.  
	Thereafter, the directories and any of the contents can, if required, be made read-only.  It is not advisable
	that the NTuser.dat file be made read-only - rename it to NTuser.man to achieve the desired effect (a
	<emphasis>MAN</emphasis>datory profile).
	</para>

	<para>
	Windows clients can sometimes maintain a connection to the [homes] share, even though there is no user logged
	in.  Therefore, it is vital that the logon path does not include a reference to the homes share (i.e. setting
	this parameter to \\%N\homes\profile_path will cause problems).
	</para>

	<para>
	This option takes the standard substitutions, allowing you to have separate logon scripts for each user or machine.
	</para>

	<warning><para>
	Do not quote the value. Setting this as <quote>\\%N\profile\%U</quote>
	will break profile handling. Where the tdbsam or ldapsam passdb backend
	is used, at the time the user account is created the value configured
	for this parameter is written to the passdb backend and that value will
	over-ride the parameter value present in the smb.conf file. Any error
	present in the passdb backend account record must be editted using the
	appropriate tool (pdbedit on the command-line, or any other locally
	provided system tool).
	</para></warning>

	<para>Note that this option is only useful if Samba is set up as a domain controller.</para>

	<para>
	Disable the use of roaming profiles by setting the value of this parameter to the empty string. For
	example, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONPATH" xlink:href="smb.conf.5.html#LOGONPATH">logon path = ""</link>. 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.
	</para>

	<para>
	An example of use is:
<programlisting>
logon path = \\PROFILESERVER\PROFILE\%U
</programlisting>
	</para>

<para>Default: <emphasis><parameter>logon path</parameter> = <literal>\\%N\%U\profile</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>logon script</primary></indexterm><anchor id="LOGONSCRIPT"/><title>

logon script (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the batch file (<filename>.bat</filename>) or NT command file
	(<filename>.cmd</filename>) 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.
	</para>
		
	<para>
	The script must be a relative path to the <parameter>[netlogon]</parameter> service.  If the [netlogon]
	service specifies a <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PATH" xlink:href="smb.conf.5.html#PATH">path</link> of <filename moreinfo="none">/usr/local/samba/netlogon</filename>, and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOGONSCRIPT" xlink:href="smb.conf.5.html#LOGONSCRIPT">logon  script = STARTUP.BAT</link>, then the file that will be downloaded is:
<programlisting>
	/usr/local/samba/netlogon/STARTUP.BAT
</programlisting>
	</para>

	<para>
	The contents of the batch file are entirely your choice.  A suggested command would be to add <literal>NET TIME \\SERVER /SET /YES</literal>, to force every machine to synchronize clocks with the
	same time server.  Another use would be to add <literal>NET USE U: \\SERVER\UTILS</literal>
	for commonly used utilities, or 
<programlisting>
<userinput>NET USE Q: \\SERVER\ISO9001_QA</userinput>
</programlisting> 
	for example.
	</para>

	<para>
	Note that it is particularly important not to allow write access to the [netlogon] share, or to grant users
	write permission on the batch files in a secure environment, as this would allow the batch files to be
	arbitrarily modified and security to be breached.	
	</para>

	<para>
	This option takes the standard substitutions, allowing you to have separate logon scripts for each user or
	machine.
	</para>

	<para>
	This option is only useful if Samba is set up as a logon server.
	</para>

<para>Default: <emphasis><parameter>logon script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>logon script</parameter> = <literal>scripts\%U.bat</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>reject md5 clients</primary></indexterm><anchor id="REJECTMD5CLIENTS"/><title>

reject md5 clients (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether the netlogon server (currently
	only in 'active directory domain controller' mode), will
	reject clients which does not support NETLOGON_NEG_SUPPORTS_AES.</para>

	<para>You can set this to yes if all domain members support aes.
	This will prevent downgrade attacks.</para>

	<para>This option takes precedence to the 'allow nt4 crypto' option.</para>

<para>Default: <emphasis><parameter>reject md5 clients</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>set primary group script</primary></indexterm><anchor id="SETPRIMARYGROUPSCRIPT"/><title>

set primary group script (G)
</title><variablelist><varlistentry><listitem>

	<para>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 user database when an
	administrator sets the primary group from the windows user
	manager or when fetching a SAM with <literal>net rpc
	vampire</literal>. <parameter>%u</parameter> will be replaced
	with the user whose primary group is to be set. 
	<parameter>%g</parameter> will be replaced with the group to
	set.</para>

<para>Default: <emphasis><parameter>set primary group script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>set primary group script</parameter> = <literal>/usr/sbin/usermod -g '%g' '%u'</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>shutdown script</primary></indexterm><anchor id="SHUTDOWNSCRIPT"/><title>

shutdown script (G)
</title><variablelist><varlistentry><listitem>
	<para>This a full path name to a script called by 
	 <citerefentry><refentrytitle>smbd</refentrytitle> 
        <manvolnum>8</manvolnum></citerefentry> that should 
	start a shutdown procedure.</para>

	<para>If the connected user possesses the <constant>SeRemoteShutdownPrivilege</constant>,
	right, this command will be run as root.</para>

	<para>The %z %t %r %f variables are expanded as follows:</para>
	
	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">%z</parameter> will be substituted with the
			shutdown message sent to the server.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%t</parameter> will be substituted with the
			number of seconds to wait before effectively starting the
			shutdown procedure.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%r</parameter> will be substituted with the
			switch <emphasis>-r</emphasis>. It means reboot after shutdown
			for NT.</para>
		</listitem>
		
		<listitem>
			<para><parameter moreinfo="none">%f</parameter> will be substituted with the
			switch <emphasis>-f</emphasis>. It means force the shutdown
			even if applications do not respond for NT.</para>
		</listitem>
	</itemizedlist>

	<para>Shutdown script example:
<programlisting format="linespecific">
#!/bin/bash

time=$2
let time="${time} / 60"
let time="${time} + 1"

/sbin/shutdown $3 $4 +$time $1 &amp;

</programlisting>
        Shutdown does not return so we need to launch it in background.
	</para>


<para>Default: <emphasis><parameter>shutdown script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>shutdown script</parameter> = <literal>/usr/local/samba/sbin/shutdown %m %t %r %f</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>add share command</primary></indexterm><anchor id="ADDSHARECOMMAND"/><title>

add share command (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
	Manager.  The <parameter moreinfo="none">add share command</parameter> is used to define an external program
	or script which will add a new service definition to
	<filename moreinfo="none">smb.conf</filename>.
	</para>

	<para>
	In order to successfully execute the
	<parameter moreinfo="none">add share command</parameter>,
	<literal>smbd</literal> requires that the administrator
	connects using a root account (i.e.  uid == 0) or has the
	<literal>SeDiskOperatorPrivilege</literal>.
	Scripts defined in the <parameter moreinfo="none">add share command</parameter>
	parameter are executed as root.
	</para>

	<para>
	When executed, <literal>smbd</literal> will automatically invoke the
	<parameter moreinfo="none">add share command</parameter> with five parameters.
	</para>

	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename moreinfo="none">smb.conf</filename> file.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">shareName</parameter> - the name of the new share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
			directory on disk.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new
			share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">max
			connections</parameter>
			Number of maximum simultaneous connections to this
			share.
			</para>
		</listitem>
	</itemizedlist>

	<para>
	This parameter is only used to add file shares. To add printer shares, see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ADDPRINTERCOMMAND" xlink:href="smb.conf.5.html#ADDPRINTERCOMMAND">addprinter command</link>.
	</para>

<para>Default: <emphasis><parameter>add share command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>add share command</parameter> = <literal>/usr/local/bin/addshare</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>afs share</primary></indexterm><anchor id="AFSSHARE"/><title>

afs share (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter controls whether special AFS features are enabled
	for this share. If enabled, it assumes that the directory exported via
	the <parameter>path</parameter> 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.
	</para>

<para>Default: <emphasis><parameter>afs share</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>afs token lifetime</primary></indexterm><anchor id="AFSTOKENLIFETIME"/><title>

afs token lifetime (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter controls the lifetime of tokens that the AFS
		fake-kaserver claims.  In reality these never expire but this lifetime
		controls when the afs client will forget the token.  </para>

	<para>Set this parameter to 0 to get <constant>NEVERDATE</constant>.</para>

<para>Default: <emphasis><parameter>afs token lifetime</parameter> = <literal>604800</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>afs username map</primary></indexterm><anchor id="AFSUSERNAMEMAP"/><title>

afs username map (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	as DOMAIN+User as it is done by winbind with the + as a separator.
	</para>

	<para>The mapped user name must contain the cell name to log into,
	so without setting this parameter there will be no token.</para>

<para>Default: <emphasis><parameter>afs username map</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>afs username map</parameter> = <literal>%u@afs.samba.org</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allow insecure wide links</primary></indexterm><anchor id="ALLOWINSECUREWIDELINKS"/><title>

allow insecure wide links (G)
</title><variablelist><varlistentry><listitem>
	<para>
	In normal operation the option <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WIDELINKS" xlink:href="smb.conf.5.html#WIDELINKS">wide links</link>
	which allows the server to follow symlinks outside of a share path
	is automatically disabled when <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="UNIXEXTENSIONS" xlink:href="smb.conf.5.html#UNIXEXTENSIONS">unix extensions</link>
	are enabled on a Samba server. This is done for security purposes
	to prevent UNIX clients creating symlinks to areas of the server
	file system that the administrator does not wish to export.
	</para>
	<para>
	Setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ALLOWINSECUREWIDELINKS" xlink:href="smb.conf.5.html#ALLOWINSECUREWIDELINKS">allow insecure wide links</link> to
	true disables the link between these two parameters, removing
	this protection and allowing a site to configure
	the server to follow symlinks (by setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WIDELINKS" xlink:href="smb.conf.5.html#WIDELINKS">wide links</link>
	to "true") even when <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="UNIXEXTENSIONS" xlink:href="smb.conf.5.html#UNIXEXTENSIONS">unix extensions</link>
	is turned on.
	</para>
	<para>
	If is not recommended to enable this option unless you
	fully understand the implications of allowing the server to
	follow symbolic links created by UNIX clients. For most
	normal Samba configurations this would be considered a security
	hole and setting this parameter is not recommended.
	</para>
	<para>
	This option was added at the request of sites who had
	deliberately set Samba up in this way and needed to continue
	supporting this functionality without having to patch the
	Samba code.
	</para>

<para>Default: <emphasis><parameter>allow insecure wide links</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>async smb echo handler</primary></indexterm><anchor id="ASYNCSMBECHOHANDLER"/><title>

async smb echo handler (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies whether Samba should fork the
	  async smb echo handler. It can be beneficial if your file
	  system can block syscalls for a very long time. In some
	  circumstances, it prolongs the timeout that Windows uses to
	  determine whether a connection is dead.
	</para>

<para>Default: <emphasis><parameter>async smb echo handler</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>available</primary></indexterm><anchor id="AVAILABLE"/><title>

available (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter lets you "turn off" a service. If 
	<parameter moreinfo="none">available = no</parameter>, then <emphasis>ALL</emphasis> 
	attempts to connect to the service will fail. Such failures are 
	logged.</para>


<para>Default: <emphasis><parameter>available</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cache directory</primary></indexterm><anchor id="CACHEDIRECTORY"/><title>

cache directory (G)
</title><variablelist><varlistentry><listitem>
	<para>Usually, most of the TDB files are stored in the <parameter moreinfo="none">lock directory</parameter>. Since Samba 3.4.0, it is
	possible to differentiate between TDB files with persistent data and
	TDB files with non-persistent data using the
	<parameter moreinfo="none">state directory</parameter> and the
	<parameter moreinfo="none">cache directory</parameter> options.
	</para>

	<para> This option specifies the directory where TDB files containing
	non-persistent data will be stored.
	</para>

<para>Default: <emphasis><parameter>cache directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/cache</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cache directory</parameter> = <literal>/var/run/samba/locks/cache</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>change notify</primary></indexterm><anchor id="CHANGENOTIFY"/><title>

change notify (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies whether Samba should reply
	to a client's file change notify requests.
	</para>

	<para>You should never need to change this parameter</para>

<para>Default: <emphasis><parameter>change notify</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>change share command</primary></indexterm><anchor id="CHANGESHARECOMMAND"/><title>

change share command (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager.  The <parameter moreinfo="none">change share command</parameter> is used to define an external
program or script which will modify an existing service definition in <filename moreinfo="none">smb.conf</filename>.
	</para>

	<para>
	In order to successfully execute the
	<parameter moreinfo="none">change share command</parameter>,
	<literal>smbd</literal> requires that the administrator
	connects using a root account (i.e. uid == 0) or has the
	<literal>SeDiskOperatorPrivilege</literal>.
	Scripts defined in the <parameter moreinfo="none">change share command</parameter>
	parameter are executed as root.
	</para>

	<para>
	When executed, <literal>smbd</literal> will automatically invoke the
	<parameter moreinfo="none">change share command</parameter> with six parameters.
	</para>

	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">configFile</parameter> - the location
			of the global <filename moreinfo="none">smb.conf</filename> file.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">shareName</parameter> - the name of the new
			share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
			directory on disk.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">comment</parameter> - comment string to associate
			with the new share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">max
			connections</parameter>
			Number of maximum simultaneous connections to this
			share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">CSC policy</parameter> - client side caching
			policy in string form. Valid values are: manual, documents, programs, disable.
			</para>
		</listitem>
	</itemizedlist>

	<para>
	This parameter is only used to modify existing file share definitions.
	To modify printer shares, use the "Printers..." folder as seen
	when browsing the Samba host.
	</para>

<para>Default: <emphasis><parameter>change share command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>change share command</parameter> = <literal>/usr/local/bin/changeshare</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cluster addresses</primary></indexterm><anchor id="CLUSTERADDRESSES"/><title>

cluster addresses (G)
</title><variablelist><varlistentry><listitem>
	<para>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.
	</para>

<para>Default: <emphasis><parameter>cluster addresses</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cluster addresses</parameter> = <literal>10.0.0.1 10.0.0.2 10.0.0.3</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>clustering</primary></indexterm><anchor id="CLUSTERING"/><title>

clustering (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies whether Samba should contact
	ctdb for accessing its tdb files and use ctdb as a backend
	for its messaging backend.
	</para>

	<para>Set this parameter to <literal>yes</literal> only if
	you have a cluster setup with ctdb running.
	</para>

<para>Default: <emphasis><parameter>clustering</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>config file</primary></indexterm><anchor id="CONFIGFILE"/><title>

config file (G)
</title><variablelist><varlistentry><listitem>
	<para>This allows you to override the config file 
	to use, instead of the default (usually <filename moreinfo="none">smb.conf</filename>). 
	There is a chicken and egg problem here as this option is set 
	in the config file!</para>

	<para>For this reason, if the name of the config file has changed 
	when the parameters are loaded then it will reload them from 
	the new config file.</para>

	<para>This option takes the usual substitutions, which can 
	be very useful.</para>

	<para>If the config file doesn't exist then it won't be loaded 
	(allowing you to special case the config files of just a few 
	clients).</para>

<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>config file</parameter> = <literal>/usr/local/samba/lib/smb.conf.%m</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>copy</primary></indexterm><anchor id="COPY"/><title>

copy (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>This feature lets you set up a 'template' service and 
	create similar services easily. Note that the service being 
	copied must occur earlier in the configuration file than the 
	service doing the copying.</para>

<para>Default: <emphasis><parameter>copy</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>copy</parameter> = <literal>otherservice</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ctdbd socket</primary></indexterm><anchor id="CTDBDSOCKET"/><title>

ctdbd socket (G)
</title><variablelist><varlistentry><listitem>
	<para>If you set <literal>clustering=yes</literal>,
	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.
	</para>

<para>Default: <emphasis><parameter>ctdbd socket</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ctdbd socket</parameter> = <literal>/tmp/ctdb.socket</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ctdb locktime warn threshold</primary></indexterm><anchor id="CTDBLOCKTIMEWARNTHRESHOLD"/><title>

ctdb locktime warn threshold (G)
</title><variablelist><varlistentry><listitem>

	<para>
	In a cluster environment using Samba and ctdb it is critical
	that locks on central ctdb-hosted databases like locking.tdb
	are not held for long. With the current Samba architecture
	it happens that Samba takes a lock and while holding that
	lock makes file system calls into the shared cluster file
	system. This option makes Samba warn if it detects that it
	has held locks for the specified number of milliseconds. If
	this happens, <emphasis>smbd</emphasis> will emit a debug level 0
	message into its logs and potentially into syslog. The most likely
	reason for such a log message is that an operation of the cluster
	file system Samba exports is taking longer than expected.
	The messages are meant as a debugging aid for potential
	cluster problems.
	</para>

	<para>The default value of 0 disables this logging.</para>


<para>Default: <emphasis><parameter>ctdb locktime warn threshold</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ctdb timeout</primary></indexterm><anchor id="CTDBTIMEOUT"/><title>

ctdb timeout (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies a timeout in seconds for the
	  connection between Samba and ctdb. It is only valid if you
	  have compiled Samba with clustering and if you have
	  set <parameter>clustering=yes</parameter>.
	</para>
	<para>When something in the cluster blocks, it can happen that
	  we wait indefinitely long for ctdb, just adding to the
	  blocking condition. In a well-running cluster this should
	  never happen, but there are too many components in a cluster
	  that might have hickups. Choosing the right balance for this
	  value is very tricky, because on a busy cluster long service
	  times to transfer something across the cluster might be
	  valid. Setting it too short will degrade the service your
	  cluster presents, setting it too long might make the cluster
	  itself not recover from something severely broken for too
	  long.
	</para>
	<para>
	  Be aware that if you set this parameter, this needs to be in
	  the file smb.conf, it is not really helpful to put this into
	  a registry configuration (typical on a cluster), because to
	  access the registry contact to ctdb is required.
	</para>
	<para>Setting <parameter>ctdb timeout</parameter> to n makes
	  any process waiting longer than n seconds for a reply by the
	  cluster panic. Setting it to 0 (the default) makes Samba
	  block forever, which is the highly recommended default.
	</para>

<para>Default: <emphasis><parameter>ctdb timeout</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>default</primary><see>default service</see></indexterm><title>

<anchor id="DEFAULT"/>default
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="DEFAULTSERVICE">default service</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>default service</primary></indexterm><anchor id="DEFAULTSERVICE"/><title>

default service (G)
</title><variablelist><varlistentry><listitem>
	<para>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 <emphasis>NOT</emphasis>
	given in the parameter value (see example below).</para>

	<para>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.</para>

	<para>
	Typically the default service would be a <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READ-ONLY" xlink:href="smb.conf.5.html#READ-ONLY">read-only</link> service.</para> <para>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 <parameter moreinfo="none">%S</parameter> to make a wildcard service.
	</para>

	<para>Note also that any "_" characters in the name of the service 
	used in the default service will get mapped to a "/". This allows for
	interesting things.</para>

<para>Default: <emphasis><parameter>default service</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>default service</parameter> = <literal>pub</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete readonly</primary></indexterm><anchor id="DELETEREADONLY"/><title>

delete readonly (S)
</title><variablelist><varlistentry><listitem>
	<para>This parameter allows readonly files to be deleted.  
	This is not normal DOS semantics, but is allowed by UNIX.</para>
		
	<para>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.</para>

<para>Default: <emphasis><parameter>delete readonly</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>delete share command</primary></indexterm><anchor id="DELETESHARECOMMAND"/><title>

delete share command (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
	Manager.  The <parameter moreinfo="none">delete share command</parameter> is used to define an external
	program or script which will remove an existing service definition from
	<filename moreinfo="none">smb.conf</filename>.
	</para>

	<para>In order to successfully execute the
	<parameter moreinfo="none">delete share command</parameter>,
	<literal>smbd</literal>	requires that the administrator
	connects using a root account (i.e.  uid == 0) or has the
	<literal>SeDiskOperatorPrivilege</literal>.
	Scripts defined in the <parameter moreinfo="none">delete share command</parameter>
	parameter are executed as root.
	</para>

	<para>
	When executed, <literal>smbd</literal> will automatically invoke the
	<parameter moreinfo="none">delete share command</parameter> with two parameters.
	</para>

	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">configFile</parameter> - the location
			of the global <filename moreinfo="none">smb.conf</filename> file.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">shareName</parameter> - the name of
			the existing service.
			</para>
		</listitem>
	</itemizedlist>

	<para>
	This parameter is only used to remove file shares.  To delete printer shares,
	see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEPRINTERCOMMAND" xlink:href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</link>.
	</para>

<para>Default: <emphasis><parameter>delete share command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>delete share command</parameter> = <literal>/usr/local/bin/delshare</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dfree cache time</primary></indexterm><anchor id="DFREECACHETIME"/><title>

dfree cache time (S)
</title><variablelist><varlistentry><listitem>

	<para>
	The <parameter moreinfo="none">dfree cache time</parameter> 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
	end of each directory listing.
	</para>

	<para>
	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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DFREECOMMAND" xlink:href="smb.conf.5.html#DFREECOMMAND">dfree command</link> scripts increasing the load.
	</para>

	<para>
	By default this parameter is zero, meaning no caching will be done.
	</para>


<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>dfree cache time</parameter> = <literal>60</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dfree command</primary></indexterm><anchor id="DFREECOMMAND"/><title>

dfree command (S)
</title><variablelist><varlistentry><listitem>

	<para>
	The <parameter moreinfo="none">dfree command</parameter> 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"
	at the end of each directory listing.
	</para>

	<para>
	This setting allows the replacement of the internal routines to calculate the total disk space and amount
	available with an external routine. The example below gives a possible script that might fulfill this
	function.
	</para>

	<para>
	In Samba version 3.0.21 this parameter has been changed to be a per-share parameter, and in addition the
	parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DFREECACHETIME" xlink:href="smb.conf.5.html#DFREECACHETIME">dfree cache time</link> was added to allow the output of this script to be cached
	for systems under heavy load.
	</para>

	<para>
	The external program will be passed a single parameter indicating a directory in the filesystem being queried.
	This will typically consist of the string <filename moreinfo="none">./</filename>. The script should return
	two integers in ASCII. The first should be the total disk space in blocks, and the second should be the number
	of available blocks. An optional third return value can give the block size in bytes. The default blocksize is
	1024 bytes.
	</para>

	<para>
	Note: Your script should <emphasis>NOT</emphasis> be setuid or setgid and should be owned by (and writeable
	only by) root!
	</para>

	<para>
	Where the script dfree (which must be made executable) could be:
<programlisting format="linespecific"> 
#!/bin/sh
df $1 | tail -1 | awk '{print $(NF-4),$(NF-2)}'
</programlisting>
	or perhaps (on Sys V based systems):
<programlisting format="linespecific"> 
#!/bin/sh
/usr/bin/df -k $1 | tail -1 | awk '{print $3" "$5}'
</programlisting>
	Note that you may have to replace the command names with full path names on some systems.
	</para>

	<para>
	By default internal routines for determining the disk capacity and remaining space will be used.
	</para>


<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>dfree command</parameter> = <literal>/usr/local/samba/bin/dfree</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>directory name cache size</primary></indexterm><anchor id="DIRECTORYNAMECACHESIZE"/><title>

directory name cache size (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the size of the directory name cache.
	It will be needed to turn this off for *BSD systems.
	</para>


<para>Default: <emphasis><parameter>directory name cache size</parameter> = <literal>100</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dmapi support</primary></indexterm><anchor id="DMAPISUPPORT"/><title>

dmapi support (S)
</title><variablelist><varlistentry><listitem>
	<para>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.
	</para>

	<para>Note that Samba infers the status of a file by examining the
	events that a DMAPI application has registered interest in. This
	heuristic is satisfactory for a number of hierarchical storage
	systems, but there may be system for which it will fail. In this
	case, Samba may erroneously report files to be offline.
	</para>

	<para>This parameter is only available if a supported DMAPI
	implementation was found at compilation time. It will only be used
	if DMAPI is found to enabled on the system at run time.
	</para>

	<para>
	</para>

<para>Default: <emphasis><parameter>dmapi support</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dont descend</primary></indexterm><anchor id="DONTDESCEND"/><title>

dont descend (S)
</title><variablelist><varlistentry><listitem>
	<para>There are certain directories on some systems 
	(e.g., the <filename moreinfo="none">/proc</filename> 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 
	that the server should always show as empty.</para>

	<para>Note that Samba can be very fussy about the exact format 
	of the "dont descend" entries. For example you may need <filename moreinfo="none">
	./proc</filename> instead of just <filename moreinfo="none">/proc</filename>. 
	Experimentation is the best policy :-)  </para>

<para>Default: <emphasis><parameter>dont descend</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>dont descend</parameter> = <literal>/proc,/dev</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dos filemode</primary></indexterm><anchor id="DOSFILEMODE"/><title>

dos filemode (S)
</title><variablelist><varlistentry><listitem>
	<para> 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
	allows a user who has write access to the file (by whatever
	means, including an ACL permission) to modify the permissions
	(including ACL) on it. Note that a user belonging to the group
	owning the file will not be allowed to change permissions if
	the group is only granted read access. Ownership of the
	file/directory may also be changed.

	Note that using the VFS modules acl_xattr or acl_tdb which store native
	Windows as meta-data will automatically turn this option on for any
	share for which they are loaded, as they require this option to emulate
	Windows ACLs correctly.
	</para>

<para>Default: <emphasis><parameter>dos filemode</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dos filetime resolution</primary></indexterm><anchor id="DOSFILETIMERESOLUTION"/><title>

dos filetime resolution (S)
</title><variablelist><varlistentry><listitem>
	<para>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 <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>.</para>

	<para>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
	one-second granularity, the other uses a two second granularity. As
	the two second call rounds any odd second down, then if the file has a
	timestamp of an odd number of seconds then the two timestamps will not
	match and Visual C++ will keep reporting the file has changed. Setting
	this option causes the two timestamps to match, and Visual C++ is
	happy.</para>

<para>Default: <emphasis><parameter>dos filetime resolution</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dos filetimes</primary></indexterm><anchor id="DOSFILETIMES"/><title>

dos filetimes (S)
</title><variablelist><varlistentry><listitem>
	<para>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 emulates the DOS semantics and allows to change the 
	timestamp on a file if the user <literal>smbd</literal> is acting 
	on behalf has write permissions.
	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
	changed by another user if this parameter is not set to "yes" and files are being
	shared between users.
	</para>

<para>Default: <emphasis><parameter>dos filetimes</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>fake directory create times</primary></indexterm><anchor id="FAKEDIRECTORYCREATETIMES"/><title>

fake directory create times (S)
</title><variablelist><varlistentry><listitem>
	<para>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 
	this parameter for a share causes Samba to always report midnight 
	1-1-1980 as the create time for directories.</para>

	<para>This option is mainly used as a compatibility option for 
	Visual C++ when used against Samba shares. Visual C++ generated 
	makefiles have the object directory as a dependency for each object 
	file, and a make rule to create the directory. Also, when NMAKE 
	compares timestamps it uses the creation time when examining a 
	directory. Thus the object directory will be created if it does not 
	exist, but once it does exist it will always have an earlier 
	timestamp than the object files it contains.</para>

	<para>However, Unix time semantics mean that the create time 
	reported by Samba will be updated whenever a file is created
	or deleted in the directory.  NMAKE finds all object files in 
	the object directory.  The timestamp of the last one built is then 
	compared to the timestamp of the object directory.  If the 
	directory's timestamp if newer, then all object files
	will be rebuilt.  Enabling this option 
	ensures directories always predate their contents and an NMAKE build 
	will proceed as expected.</para>

<para>Default: <emphasis><parameter>fake directory create times</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>follow symlinks</primary></indexterm><anchor id="FOLLOWSYMLINKS"/><title>

follow symlinks (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter allows the Samba administrator to stop <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>	from following symbolic links in a particular share. Setting this 
	parameter to <constant>no</constant> 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 <filename moreinfo="none">/etc/passwd</filename> in their home directory for instance.  However 
	it will slow filename lookups down slightly.
	</para>

	<para>
	This option is enabled (i.e. <literal>smbd</literal> will follow symbolic links) by default.
	</para>

<para>Default: <emphasis><parameter>follow symlinks</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>fss: prune stale</primary></indexterm><anchor id="FSS:PRUNESTALE"/><title>

fss: prune stale (G)
</title><variablelist><varlistentry><listitem>
	<para>
	When enabled, Samba's File Server Remove VSS Protocol (FSRVP) server
	checks all FSRVP initiated snapshots on startup, and removes any
	corresponding state (including share definitions) for nonexistent
	snapshot paths.
	</para>

<para>Default: <emphasis><parameter>fss: prune stale</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>fss: prune stale</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>fss: sequence timeout</primary></indexterm><anchor id="FSS:SEQUENCETIMEOUT"/><title>

fss: sequence timeout (G)
</title><variablelist><varlistentry><listitem>
	<para>
	The File Server Remove VSS Protocol (FSRVP) server includes a message
	sequence timer to ensure cleanup on unexpected client disconnect. This
	parameter overrides the default timeout between FSRVP operations.
	FSRVP timeouts can be completely disabled via a value of 0.
	</para>

<para>Default: <emphasis><parameter>fss: sequence timeout</parameter> = <literal>180 or 1800, depending on operation</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>fss: sequence timeout</parameter> = <literal>0</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>fstype</primary></indexterm><anchor id="FSTYPE"/><title>

fstype (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter allows the administrator to configure the string that specifies the type of filesystem a share 
	is using that is reported by <citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 
	when a client queries the filesystem type for a share. The default type is <constant>NTFS</constant> for compatibility 
	with Windows NT but this can be changed to other strings such as <constant>Samba</constant> or <constant>FAT</constant> 
	if required.
	</para>

<para>Default: <emphasis><parameter>fstype</parameter> = <literal>NTFS</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>fstype</parameter> = <literal>Samba</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>homedir map</primary></indexterm><anchor id="HOMEDIRMAP"/><title>

homedir map (G)
</title><variablelist><varlistentry><listitem>
	<para>
	If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NISHOMEDIR" xlink:href="smb.conf.5.html#NISHOMEDIR">nis homedir</link> is <constant>yes</constant>, and <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> is also acting 	as a Win95/98 <parameter moreinfo="none">logon server</parameter> 
	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:
<programlisting>
<literal>username server:/some/file/system</literal>
</programlisting>
	and the program will extract the servername from before the first ':'.  There should probably be a better parsing system 
	that copes with different map formats and also Amd (another automounter) maps.
	</para>
		
	<note><para>
	A working NIS client is required on the system for this option to work.
	</para></note>

<para>Default: <emphasis><parameter>homedir map</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>homedir map</parameter> = <literal>amd.homedir</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>include</primary></indexterm><anchor id="INCLUDE"/><title>

include (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This allows you to include one config file inside another.  The file is included literally, as though typed 
	in place.
	</para>

	<para>
	It takes the standard substitutions, except <parameter moreinfo="none">%u</parameter>, 
	<parameter moreinfo="none">%P</parameter> and <parameter moreinfo="none">%S</parameter>.
	</para>

	<para>
	The parameter <parameter>include = registry</parameter> has
	a special meaning: It does <emphasis>not</emphasis> include
	a file named <emphasis>registry</emphasis> 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.
	</para>

<para>Default: <emphasis><parameter>include</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>include</parameter> = <literal>/usr/local/samba/lib/admin_smb.conf</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>kernel change notify</primary></indexterm><anchor id="KERNELCHANGENOTIFY"/><title>

kernel change notify (S)
</title><variablelist><varlistentry><listitem>
	<para>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.
	</para>

	<para>This parameter is only used when your kernel supports 
	change notification to user programs using the inotify interface.
	</para>

<para>Default: <emphasis><parameter>kernel change notify</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lock dir</primary><see>lock directory</see></indexterm><title>

<anchor id="LOCKDIR"/>lock dir
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="LOCKDIRECTORY">lock directory</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>lock directory</primary></indexterm><anchor id="LOCKDIRECTORY"/><title>

lock directory (G)
</title><variablelist><varlistentry><listitem>
	<para>This option specifies the directory where lock 
	files will be placed.  The lock files are used to implement the 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAXCONNECTIONS" xlink:href="smb.conf.5.html#MAXCONNECTIONS">max connections</link> option.
	</para>

	<para>
		Note: This option can not be set inside registry
		configurations.
	</para>

<para>Default: <emphasis><parameter>lock directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/lock</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lock directory</parameter> = <literal>/var/run/samba/locks</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>log writeable files on exit</primary></indexterm><anchor id="LOGWRITEABLEFILESONEXIT"/><title>

log writeable files on exit (G)
</title><variablelist><varlistentry><listitem>
	<para>
	When the network connection between a CIFS client and Samba
	dies, Samba has no option but to simply shut down the server
	side of the network connection. If this happens, there is a
	risk of data corruption because the Windows client did not
	complete all write operations that the Windows application
	requested. Setting this option to "yes" makes smbd log with
	a level 0 message a list of all files that have been opened
	for writing when the network connection died. Those are the
	files that are potentially corrupted. It is meant as an aid
	for the administrator to give him a list of files to do
	consistency checks on.
	</para>

<para>Default: <emphasis><parameter>log writeable files on exit</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>magic output</primary></indexterm><anchor id="MAGICOUTPUT"/><title>

magic output (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter specifies the name of a file which will contain output created by a magic script (see the 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAGICSCRIPT" xlink:href="smb.conf.5.html#MAGICSCRIPT">magic script</link> parameter below).
	</para>

	<warning><para>If two clients use the same <parameter moreinfo="none">magic script
	</parameter> in the same directory the output file content is undefined.
	</para></warning>

<para>Default: <emphasis><parameter>magic output</parameter> = <literal>
# &lt;magic script name&gt;.out</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>magic output</parameter> = <literal>myfile.txt</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>magic script</primary></indexterm><anchor id="MAGICSCRIPT"/><title>

magic script (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>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.</para>

	<para>If the script generates output, output will be sent to 
	the file specified by the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAGICOUTPUT" xlink:href="smb.conf.5.html#MAGICOUTPUT">magic output</link>
	parameter (see above).</para>

	<para>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 
	<emphasis>as is</emphasis> on the host, which for some hosts and 
	some shells will require filtering at the DOS end.</para>

	<para>Magic scripts are <emphasis>EXPERIMENTAL</emphasis> and 
		should <emphasis>NOT</emphasis> be relied upon.</para>

<para>Default: <emphasis><parameter>magic script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>magic script</parameter> = <literal>user.csh</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>message command</primary></indexterm><anchor id="MESSAGECOMMAND"/><title>

message command (G)
</title><variablelist><varlistentry><listitem>
	<para>This specifies what command to run when the 
	server receives a WinPopup style message.</para>

	<para>This would normally be a command that would 
	deliver the message somehow. How this is to be done is 
	up to your imagination.</para>

	<para>An example is:
<programlisting>
<literal>message command = csh -c 'xedit %s;rm %s' &amp;</literal>
</programlisting>
	</para>

	<para>This delivers the message using <literal>xedit</literal>, then 
	removes it afterwards. <emphasis>NOTE THAT IT IS VERY IMPORTANT 
	THAT THIS COMMAND RETURN IMMEDIATELY</emphasis>. That's why I 
	have the '&amp;' on the end. If it doesn't return immediately then 
	your PCs may freeze when sending messages (they should recover 
	after 30 seconds, hopefully).</para>

	<para>All messages are delivered as the global guest user. 
	The command takes the standard substitutions, although <parameter moreinfo="none">
	%u</parameter> won't work (<parameter moreinfo="none">%U</parameter> may be better 
	in this case).</para>

	<para>Apart from the standard substitutions, some additional 
	ones apply. In particular:</para>

	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">%s</parameter> = the filename containing 
				the message.</para>
		</listitem>
			
		<listitem>
			<para><parameter moreinfo="none">%t</parameter> = the destination that 
				the message was sent to (probably the server name).</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">%f</parameter> = who the message 
				is from.</para>
		</listitem>
	</itemizedlist>

	<para>You could make this command send mail, or whatever else 
	takes your fancy. Please let us know of any really interesting 
	ideas you have.</para>

	<para>
	Here's a way of sending the messages as mail to root:
<programlisting>
<literal>message command = /bin/mail -s 'message from %f on %m' root &lt; %s; rm %s</literal>
</programlisting>
	</para>

	<para>If you don't have a message command then the message 
	won't be delivered and Samba will tell the sender there was 
	an error. Unfortunately WfWg totally ignores the error code 
	and carries on regardless, saying that the message was delivered.
	</para>

	<para>
	If you want to silently delete it then try:
<programlisting>
<literal>message command = rm %s</literal>
</programlisting>
	</para>
	

<para>Default: <emphasis><parameter>message command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>message command</parameter> = <literal>csh -c 'xedit %s; rm %s' &amp;</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>socket address</primary><see>nbt client socket address</see></indexterm><title>

<anchor id="SOCKETADDRESS"/>socket address
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="NBTCLIENTSOCKETADDRESS">nbt client socket address</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>nbt client socket address</primary></indexterm><anchor id="NBTCLIENTSOCKETADDRESS"/><title>

nbt client socket address (G)
</title><variablelist><varlistentry><listitem>
	<para>This option allows you to control what address Samba
	will send NBT client packets from, and process replies using,
	including in nmbd. </para>
	<para>Setting this option should never be necessary on usual Samba
	servers running only one nmbd.</para>

	<para>By default Samba will send UDP packets from the OS default address for the destination, and accept replies on 0.0.0.0.</para>
	<para>This parameter is deprecated.  See <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="BINDINTERFACESONLY" xlink:href="smb.conf.5.html#BINDINTERFACESONLY">bind interfaces only = Yes</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> for the previous behaviour of controlling the normal listening sockets.</para>

<para>Default: <emphasis><parameter>nbt client socket address</parameter> = <literal>0.0.0.0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>nbt client socket address</parameter> = <literal>192.168.2.20</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ncalrpc dir</primary></indexterm><anchor id="NCALRPCDIR"/><title>

ncalrpc dir (G)
</title><variablelist><varlistentry><listitem>
	<para>This directory will hold a series of named pipes to allow RPC over inter-process communication.</para>
	<para>This will allow Samba and other unix processes to interact over DCE/RPC without using TCP/IP. Additionally a sub-directory 'np' has restricted permissions, and allows a trusted communication channel between Samba processes</para>

<para>Default: <emphasis><parameter>ncalrpc dir</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/run/ncalrpc</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>ncalrpc dir</parameter> = <literal>/var/run/samba/ncalrpc</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>NIS homedir</primary></indexterm><anchor id="NISHOMEDIR"/><title>

NIS homedir (G)
</title><variablelist><varlistentry><listitem>
	<para>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. </para>

	<para>When the Samba logon server is not the actual home directory 
	server, but is mounting the home directories via NFS then two 
	network hops would be required to access the users home directory 
	if the logon server told the client to use itself as the SMB server 
	for home directories (one over SMB and one over NFS). This can 
	be very slow.</para>

	<para>This option allows Samba to return the home share as 
	being on a different server to the logon server and as 
	long as a Samba daemon is running on the home directory server, 
	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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="HOMEDIRMAP" xlink:href="smb.conf.5.html#HOMEDIRMAP">homedir map</link> and return the server 
	listed there.</para>

	<para>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.</para>

<para>Default: <emphasis><parameter>NIS homedir</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nmbd bind explicit broadcast</primary></indexterm><anchor id="NMBDBINDEXPLICITBROADCAST"/><title>

nmbd bind explicit broadcast (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This option causes <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> to explicitly bind to the
	broadcast address of the local subnets. This is needed to make nmbd
	work correctly in combination with the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SOCKETADDRESS" xlink:href="smb.conf.5.html#SOCKETADDRESS">socket address</link> option.
	You should not need to unset this option.
	</para>

<para>Default: <emphasis><parameter>nmbd bind explicit broadcast</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>panic action</primary></indexterm><anchor id="PANICACTION"/><title>

panic action (G)
</title><variablelist><varlistentry><listitem>
	<para>This is a Samba developer option that allows a 
	system command to be called when either <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>	crashes. This is usually used to 
	draw attention to the fact that a problem occurred.
	</para>

<para>Default: <emphasis><parameter>panic action</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>panic action</parameter> = <literal>"/bin/sleep 90000"</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>perfcount module</primary></indexterm><anchor id="PERFCOUNTMODULE"/><title>

perfcount module (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the perfcount backend to be used when monitoring SMB
	operations.  Only one perfcount module may be used, and it must implement all of the
	apis contained in the smb_perfcount_handler structure defined in smb.h.
	</para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>pid directory</primary></indexterm><anchor id="PIDDIRECTORY"/><title>

pid directory (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This option specifies the directory where pid files will be placed.  
	</para>

<para>Default: <emphasis><parameter>pid directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/run</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>pid directory</parameter> = <literal>/var/run/</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>postexec</primary></indexterm><anchor id="POSTEXEC"/><title>

postexec (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>An interesting example may be to unmount server 
	resources:</para>

<para><literal>postexec = /etc/umount /cdrom</literal></para>

<para>Default: <emphasis><parameter>postexec</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>postexec</parameter> = <literal>echo \"%u disconnected from %S from %m (%I)\" &gt;&gt; /tmp/log</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>exec</primary><see>preexec</see></indexterm><title>

<anchor id="EXEC"/>exec
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PREEXEC">preexec</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>preexec</primary></indexterm><anchor id="PREEXEC"/><title>

preexec (S)
</title><variablelist><varlistentry><listitem>
	<para>This option specifies a command to be run whenever 
	the service is connected to. It takes the usual substitutions.</para>

	<para>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:</para>

	<para>
	<literal>preexec = csh -c 'echo \"Welcome to %S!\" |
	/usr/local/samba/bin/smbclient -M %m -I %I' &amp; </literal>
	</para>

	<para>Of course, this could get annoying after a while :-)</para>

	<para>
	See also <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PREEXECCLOSE" xlink:href="smb.conf.5.html#PREEXECCLOSE">preexec close</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="POSTEXEC" xlink:href="smb.conf.5.html#POSTEXEC">postexec</link>.
	</para>

<para>Default: <emphasis><parameter>preexec</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>preexec</parameter> = <literal>echo \"%u connected to %S from %m (%I)\" &gt;&gt; /tmp/log</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>preexec close</primary></indexterm><anchor id="PREEXECCLOSE"/><title>

preexec close (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This boolean option controls whether a non-zero return code from <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PREEXEC" xlink:href="smb.conf.5.html#PREEXEC">preexec</link> 
	should close the service being connected to.
	</para>

<para>Default: <emphasis><parameter>preexec close</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>auto services</primary><see>preload</see></indexterm><title>

<anchor id="AUTOSERVICES"/>auto services
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PRELOAD">preload</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>preload</primary></indexterm><anchor id="PRELOAD"/><title>

preload (G)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

	<para>
	Note that if you just want all printers in your 
	printcap file loaded then the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOADPRINTERS" xlink:href="smb.conf.5.html#LOADPRINTERS">load printers</link>
	 option is easier.
	</para>

<para>Default: <emphasis><parameter>preload</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>preload</parameter> = <literal>fred lp colorlp</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>registry shares</primary></indexterm><anchor id="REGISTRYSHARES"/><title>

registry shares (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This turns on or off support for share definitions read from
	registry. Shares defined in <emphasis>smb.conf</emphasis> take
	precedence over shares with the same name defined in
	registry. See the section on registry-based configuration
	for details. 
	</para>

	<para>
		Note that this parameter defaults to <emphasis>no</emphasis>,
		but it is set to <emphasis>yes</emphasis> when
		 <parameter>config backend</parameter> is set
		to <emphasis>registry</emphasis>.
	</para>

<para>Default: <emphasis><parameter>registry shares</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>registry shares</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>remote announce</primary></indexterm><anchor id="REMOTEANNOUNCE"/><title>

remote announce (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> to periodically announce itself 
	to arbitrary IP addresses with an arbitrary workgroup name.
	</para>

	<para>
	This is useful if you want your Samba server to appear in a remote workgroup for 
	which the normal browse propagation rules don't work. The remote workgroup can be 
	anywhere that you can send IP packets to.
	</para>

	<para>
	For example:
<programlisting>
<literal>remote announce = 192.168.2.255/SERVERS 192.168.4.255/STAFF</literal>
</programlisting>
	the above line would cause <literal>nmbd</literal> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WORKGROUP" xlink:href="smb.conf.5.html#WORKGROUP">workgroup</link> parameter 
	is used instead.
	</para>

	<para>
	The IP addresses you choose would normally be the broadcast addresses of the remote 
	networks, but can also be the IP addresses of known browse masters if your network 
	config is that stable.
	</para>

	<para>
	See the chapter on Network Browsing in the Samba-HOWTO book.
	</para>

<para>Default: <emphasis><parameter>remote announce</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>remote browse sync</primary></indexterm><anchor id="REMOTEBROWSESYNC"/><title>

remote browse sync (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This option allows you to setup <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> 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 
	is done in a manner that does not work with any non-Samba servers.
	</para>

	<para>
	This is useful if you want your Samba server and all local 
	clients to appear in a remote workgroup for which the normal browse 
	propagation rules don't work. The remote workgroup can be anywhere 
	that you can send IP packets to.
	</para>

	<para>
	For example:
<programlisting>
<parameter>remote browse sync = 192.168.2.255 192.168.4.255</parameter>
</programlisting>
	the above line would cause <literal>nmbd</literal> to request the master browser on the 
	specified subnets or addresses to synchronize their browse lists with 
	the local server.
	</para>

	<para>
	The IP addresses you choose would normally be the broadcast 
	addresses of the remote networks, but can also be the IP addresses 
	of known browse masters if your network config is that stable. If 
	a machine IP address is given Samba makes NO attempt to validate 
	that the remote machine is available, is listening, nor that it 
	is in fact the browse master on its segment.
	</para>

	<para>
	The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="REMOTEBROWSESYNC" xlink:href="smb.conf.5.html#REMOTEBROWSESYNC">remote browse sync</link> 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.
	</para>

<para>Default: <emphasis><parameter>remote browse sync</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>reset on zero vc</primary></indexterm><anchor id="RESETONZEROVC"/><title>

reset on zero vc (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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.

	Setting this parameter to yes becomes necessary when you have a flaky
	network and windows decides to reconnect while the old connection
	still has files with share modes open. These files become inaccessible
	over the new connection.

	The client sends a zero VC on the new connection, and Windows 2003
	kills all other connections coming from the same IP. This way the
	locked files are accessible again.

	Please be aware that enabling this option will kill connections behind
	a masquerading router.

	</para>

<para>Default: <emphasis><parameter>reset on zero vc</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>root postexec</primary></indexterm><anchor id="ROOTPOSTEXEC"/><title>

root postexec (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This is the same as the <parameter moreinfo="none">postexec</parameter>
	parameter except that the command is run as root. This is useful for 
	unmounting filesystems (such as CDROMs) after a connection is closed.
	</para>

<para>Default: <emphasis><parameter>root postexec</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>root preexec</primary></indexterm><anchor id="ROOTPREEXEC"/><title>

root preexec (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This is the same as the <parameter moreinfo="none">preexec</parameter>
	parameter except that the command is run as root. This is useful for 
	mounting filesystems (such as CDROMs) when a connection is opened.
	</para>

<para>Default: <emphasis><parameter>root preexec</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>root preexec close</primary></indexterm><anchor id="ROOTPREEXECCLOSE"/><title>

root preexec close (S)
</title><variablelist><varlistentry><listitem>
	<para>This is the same as the <parameter moreinfo="none">preexec close
	</parameter> parameter except that the command is run as root.</para>

<para>Default: <emphasis><parameter>root preexec close</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>rpc_daemon:DAEMON</primary></indexterm><anchor id="RPC_DAEMON:DAEMON"/><title>

rpc_daemon:DAEMON (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Defines whether to use the embedded code or start a separate daemon
	for the defined rpc services.
	The rpc_daemon prefix must be followed by the server name, and a value.
	</para>

	<para>
	Two possible values are currently supported:
	<programlisting>
		disabled
		fork
	</programlisting>
	</para>

	<para>
	The classic method is to run rpc services as internal daemons
	embedded in smbd, therefore the external daemons are
	<emphasis>disabled</emphasis> by default.
	</para>

	<para>
	Choosing the <emphasis>fork</emphasis> option will cause samba to fork
	a separate proces for each daemon configured this way. Each daemon may
	in turn fork a number of children used to handle requests from multiple
	smbds and direct tcp/ip connections (if the Endpoint Mapper is
	enabled). Communication with smbd happens over named pipes and require
	that said pipes are forward to the external daemon (see <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="RPC_SERVER" xlink:href="smb.conf.5.html#RPC_SERVER">rpc_server</link>).
	</para>

	<para>
	Forked RPC Daemons support dynamically forking children to handle
	connections. The heuristics about how many children to keep around and
	how fast to allow them to fork and also how many clients each child is
	allowed to handle concurrently is defined by parametrical options named
	after the daemon.
	Five options are currently supported:
	<programlisting>
		prefork_min_children
		prefork_max_children
		prefork_spawn_rate
		prefork_max_allowed_clients
		prefork_child_min_life
	</programlisting>

	To set one of these options use the follwing syntax:
	<programlisting>
	damonname:prefork_min_children = 5
	</programlisting>
	</para>

	<para>
	Samba includes separate daemons for spoolss, lsarpc/lsass, netlogon,
	samr, and FSRVP. Currently four daemons are available and they are
	called:
	<programlisting>
		epmd
		lsasd
		spoolssd
		fssd
	</programlisting>
	Example:
	<programlisting>
	rpc_daemon:spoolssd = fork
	</programlisting>
	</para>

<para>Default: <emphasis><parameter>rpc_daemon:DAEMON</parameter> = <literal>disabled</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>rpc_server:SERVER</primary></indexterm><anchor id="RPC_SERVER:SERVER"/><title>

rpc_server:SERVER (G)
</title><variablelist><varlistentry><listitem>
	<para>
		With this option you can define if a rpc service should be
		running internal/embedded in smbd or should be redirected to an
		external daemon like Samba4, the endpoint mapper daemon, the
		spoolss daemon or the new LSA service daemon. The rpc_server
		prefix must be followed by the pipe name, and a value.
	</para>

	<para>
		This option can be set for each available rpc service in Samba.
		The following list shows all available pipe names services you
		can modify with this option.
	</para>

	<itemizedlist>
		<listitem><para>epmapper     - Endpoint Mapper</para></listitem>
		<listitem><para>winreg       - Remote Registry Service</para></listitem>
		<listitem><para>srvsvc       - Remote Server Services</para></listitem>
		<listitem><para>lsarpc       - Local Security Authority</para></listitem>
		<listitem><para>samr         - Security Account Management</para></listitem>
		<listitem><para>netlogon     - Netlogon Remote Protocol</para></listitem>
		<listitem><para>netdfs       - Settings for Distributed File System</para></listitem>
		<listitem><para>dssetup      - Active Directory Setup</para></listitem>
		<listitem><para>wkssvc       - Workstation Services</para></listitem>
		<listitem><para>spoolss      - Network Printing Spooler</para></listitem>
		<listitem><para>svcctl       - Service Control</para></listitem>
		<listitem><para>ntsvcs       - Plug and Play Services</para></listitem>
		<listitem><para>eventlog     - Event Logger</para></listitem>
		<listitem><para>initshutdown - Init Shutdown Service</para></listitem>
	</itemizedlist>

	<para>
		Three possible values currently supported are:
		<literal>embedded</literal>
		<literal>external</literal>
		<literal>disabled</literal>
	</para>

	<para>
		The classic method is to run every pipe as an internal function
		<emphasis>embedded</emphasis> in smbd. The defaults may vary
		depending on the service.
	</para>

	<para>
		Choosing the <emphasis>external</emphasis> option allows to run
		a separate daemon or even a completely independent (3rd party)
		server capable of interfacing with samba via the MS-RPC
		interface over named pipes.
	</para>

	<para>
		Currently in Samba3 we support three daemons, spoolssd, epmd and
		lsasd. These daemons can be enabled using the
		<emphasis>rpc_daemon</emphasis> option. For spoolssd you have
		to enable the daemon and proxy the named pipe with:
	</para>

	<para>
		Examples:
		<programlisting>
			rpc_daemon:lsasd = fork
			rpc_server:lsarpc = external
			rpc_server:samr = external
			rpc_server:netlogon = external

			rpc_server:spoolss = external
			rpc_server:epmapper = disabled
		</programlisting>
	</para>

	<para>
		There is one special option which allows you to enable rpc
		services to listen for ncacn_ip_tcp connections too. Currently
		this is only used for testing and doesn't scale!

		<programlisting>
			rpc_server:tcpip = yes
		</programlisting>
	</para>


<para>Default: <emphasis><parameter>rpc_server:SERVER</parameter> = <literal>embedded</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smbd profiling level</primary></indexterm><anchor id="SMBDPROFILINGLEVEL"/><title>

smbd profiling level (G)
</title><variablelist><varlistentry><listitem>
	<para>
	  This parameter allows the administrator to enable profiling support.
	</para>
	<para>
	  Possible values are <constant>off</constant>,
	  <constant>count</constant> and <constant>on</constant>.
	</para>

<para>Default: <emphasis><parameter>smbd profiling level</parameter> = <literal>off</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>smbd profiling level</parameter> = <literal>on</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>state directory</primary></indexterm><anchor id="STATEDIRECTORY"/><title>

state directory (G)
</title><variablelist><varlistentry><listitem>
	<para>Usually, most of the TDB files are stored in the
	<parameter moreinfo="none">lock directory</parameter>. Since
	Samba 3.4.0, it is possible to differentiate between TDB files
	with persistent data and TDB files with non-persistent data using
	the <parameter moreinfo="none">state directory</parameter> and the
	<parameter moreinfo="none">cache directory</parameter> options.
	</para>

	<para> This option specifies the directory where TDB files containing
	persistent data will be stored.
	</para>

<para>Default: <emphasis><parameter>state directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/locks</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>state directory</parameter> = <literal>/var/run/samba/locks/state</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare allow guests</primary></indexterm><anchor id="USERSHAREALLOWGUESTS"/><title>

usershare allow guests (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	<parameter moreinfo="none">guest ok = yes</parameter> in a share
	definition. Due to its security sensitive nature, the default
	is set to off.</para>


<para>Default: <emphasis><parameter>usershare allow guests</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare max shares</primary></indexterm><anchor id="USERSHAREMAXSHARES"/><title>

usershare max shares (G)
</title><variablelist><varlistentry><listitem>
	<para>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.
	</para>


<para>Default: <emphasis><parameter>usershare max shares</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare owner only</primary></indexterm><anchor id="USERSHAREOWNERONLY"/><title>

usershare owner only (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	the user who owns the usershare file defining this share and
	refuses to create the share if not. If set to False then no
	such check is performed and any directory path may be exported
	regardless of who owns it.
	</para>


<para>Default: <emphasis><parameter>usershare owner only</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare path</primary></indexterm><anchor id="USERSHAREPATH"/><title>

usershare path (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	"sticky" bit must also be set, restricting rename and delete to
	owners of a file (in the same way the /tmp directory is usually configured).
	Members of the group owner of this directory are the users allowed to create
	usershares.
	</para>
	<para>
	For example, a valid usershare directory might be /usr/local/samba/lib/usershares,
	set up as follows.
	</para>
	<para>
	<programlisting>
	ls -ld /usr/local/samba/lib/usershares/
	drwxrwx--T  2 root power_users 4096 2006-05-05 12:27 /usr/local/samba/lib/usershares/
	</programlisting>
	</para>
	<para>
	In this case, only members of the group "power_users" can create user defined shares.
	</para>


<para>Default: <emphasis><parameter>usershare path</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/locks/usershares</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare prefix allow list</primary></indexterm><anchor id="USERSHAREPREFIXALLOWLIST"/><title>

usershare prefix allow list (G)
</title><variablelist><varlistentry><listitem>
	<para>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 to be exported doesn't start with one of the strings in this
	list, the user defined share will not be allowed. This allows the Samba
	administrator to restrict the directories on the system that can be
	exported by user defined shares.
	</para>
	<para>
	If there is a "usershare prefix deny list" and also a
	"usershare prefix allow list" the deny list is processed
	first, followed by the allow list, thus leading to the most
	restrictive interpretation.
	</para>


<para>Default: <emphasis><parameter>usershare prefix allow list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>usershare prefix allow list</parameter> = <literal>/home /data /space</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare prefix deny list</primary></indexterm><anchor id="USERSHAREPREFIXDENYLIST"/><title>

usershare prefix deny list (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	starting with one of these strings will be allowed to be exported
	as a usershare. This allows the Samba administrator to restrict the
	directories on the system that can be exported by user defined shares.
	</para>
	<para>
	If there is a "usershare prefix deny list" and also a
	"usershare prefix allow list" the deny list is processed
	first, followed by the allow list, thus leading to the most
	restrictive interpretation.
	</para>


<para>Default: <emphasis><parameter>usershare prefix deny list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>usershare prefix deny list</parameter> = <literal>/etc /dev /private</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>usershare template share</primary></indexterm><anchor id="USERSHARETEMPLATESHARE"/><title>

usershare template share (G)
</title><variablelist><varlistentry><listitem>
	<para>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
	created have their defaults set from the parameters set on this
	share.
	</para>
	<para>
	The target share may be set to be invalid for real file
	sharing by setting the parameter "-valid = False" on the template
	share definition. This causes it not to be seen as a real exported
	share but to be able to be used as a template for usershares.
	</para>


<para>Default: <emphasis><parameter>usershare template share</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>usershare template share</parameter> = <literal>template_share</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>utmp</primary></indexterm><anchor id="UTMP"/><title>

utmp (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This boolean parameter is only available if Samba has been configured and compiled  
	with the option <literal>--with-utmp</literal>. If set to 
	 <constant>yes</constant> 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.
	</para>

	<para>
	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. 
	</para>

<para>Default: <emphasis><parameter>utmp</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>utmp directory</primary></indexterm><anchor id="UTMPDIRECTORY"/><title>

utmp directory (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter is only available if Samba has 
	been configured and compiled with the option <literal>
	--with-utmp</literal>. It specifies a directory pathname that is
	used to store the utmp or utmpx files (depending on the UNIX system) that
	record user connections to a Samba server. By default this is 
	not set, meaning the system will use whatever utmp file the 
	native system is set to use (usually 
	<filename moreinfo="none">/var/run/utmp</filename> on Linux).</para>

<para>Default: <emphasis><parameter>utmp directory</parameter> = <literal>
# Determined automatically</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>utmp directory</parameter> = <literal>/var/run/utmp</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>-valid</primary></indexterm><anchor id="-VALID"/><title>

-valid (S)
</title><variablelist><varlistentry><listitem>
	<para> 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.
	</para>

	<para>
	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.
	</para>

<para>Default: <emphasis><parameter>-valid</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>volume</primary></indexterm><anchor id="VOLUME"/><title>

volume (S)
</title><variablelist><varlistentry><listitem>
	<para>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.</para>

<para>Default: <emphasis><parameter>volume</parameter> = <literal>
# the name of the share</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wide links</primary></indexterm><anchor id="WIDELINKS"/><title>

wide links (S)
</title><variablelist><varlistentry><listitem>
	<para>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 
	to areas that are outside the directory tree being exported.</para>

	<para>Note: Turning this parameter on when UNIX extensions are enabled
	will allow UNIX clients to create symbolic links on the share that
	can point to files or directories outside restricted path exported
	by the share definition. This can cause access to areas outside of
	the share. Due to this problem, this parameter will be automatically
	disabled (with a message in the log file) if the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="UNIXEXTENSIONS" xlink:href="smb.conf.5.html#UNIXEXTENSIONS">unix extensions</link> option is on.
	</para>
	<para>
	See the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ALLOWINSECUREWIDELINKS" xlink:href="smb.conf.5.html#ALLOWINSECUREWIDELINKS">allow insecure wide links</link>
	if you wish to change this coupling between the two parameters.
	</para>

<para>Default: <emphasis><parameter>wide links</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wtmp directory</primary></indexterm><anchor id="WTMPDIRECTORY"/><title>

wtmp directory (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter is only available if Samba has been configured and compiled with the option <literal>
	--with-utmp</literal>. 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 
	that user info is kept after a user has logged out.
	</para>
		
	<para>
	By default this is not set, meaning the system will use whatever utmp file the 	native system is set to use (usually 
	<filename moreinfo="none">/var/run/wtmp</filename> on Linux).
	</para>

<para>Default: <emphasis><parameter>wtmp directory</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>wtmp directory</parameter> = <literal>/var/log/wtmp</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>addport command</primary></indexterm><anchor id="ADDPORTCOMMAND"/><title>

addport command (G)
</title><variablelist><varlistentry><listitem>
    <para>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.
	The script is passed two parameters:</para>
		
    <itemizedlist>
	<listitem><para><parameter moreinfo="none">port name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">device URI</parameter></para></listitem>
    </itemizedlist>
		
    <para>The deviceURI is in the format of socket://&lt;hostname&gt;[:&lt;portnumber&gt;]
	or lpd://&lt;hostname&gt;/&lt;queuename&gt;.</para>

<para>Default: <emphasis><parameter>addport command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>addport command</parameter> = <literal>/etc/samba/scripts/addport.sh</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>addprinter command</primary></indexterm><anchor id="ADDPRINTERCOMMAND"/><title>

addprinter command (G)
</title><variablelist><varlistentry><listitem>
    <para>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
    allows for printers to be add remotely to a Samba or Windows 
    NT/2000 print server.</para>
		
    <para>For a Samba host this means that the printer must be 
    physically added to the underlying printing system.
    The <parameter moreinfo="none">addprinter command</parameter>
    defines a script to be run which
    will perform the necessary operations for adding the printer
    to the print system and to add the appropriate service definition 
    to the  <filename moreinfo="none">smb.conf</filename> file in order that it can be 
    shared by <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry>.</para>
		
    <para>The <parameter moreinfo="none">addprinter command</parameter> is
    automatically invoked with the following parameter (in 
    order):</para>
		
    <itemizedlist>
	<listitem><para><parameter moreinfo="none">printer name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">share name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">port name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">driver name</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">location</parameter></para></listitem>
	<listitem><para><parameter moreinfo="none">Windows 9x driver location</parameter></para></listitem>
    </itemizedlist>
		
    <para>All parameters are filled in from the PRINTER_INFO_2 structure sent 
    by the Windows NT/2000 client with one exception.  The "Windows 9x
    driver location" parameter is included for backwards compatibility
    only.  The remaining fields in the structure are generated from answers
    to the APW questions.</para>

    <para>Once the <parameter moreinfo="none">addprinter command</parameter> has 
    been executed, <literal>smbd</literal> will reparse the <filename moreinfo="none">
    smb.conf</filename> to determine if the share defined by the APW
    exists.  If the sharename is still invalid, then <literal>smbd
    </literal> will return an ACCESS_DENIED error to the client.</para>

    <para>
    The <parameter moreinfo="none">addprinter command</parameter> program
    can output a single line of text,
    which Samba will set as the port the new printer is connected to. 
    If this line isn't output, Samba won't reload its printer shares.
    </para>
		

<para>Default: <emphasis><parameter>addprinter command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>addprinter command</parameter> = <literal>/usr/bin/addprinter</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cups connection timeout</primary></indexterm><anchor id="CUPSCONNECTIONTIMEOUT"/><title>

cups connection timeout (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This parameter is only applicable if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> is set to <constant>cups</constant>.
    </para>

   <para>
   If set, this option specifies the number of seconds that smbd will wait
   whilst trying to contact to the CUPS server. The connection will fail
   if it takes longer than this number of seconds.
   </para>

<para>Default: <emphasis><parameter>cups connection timeout</parameter> = <literal>30</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cups connection timeout</parameter> = <literal>60</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cups encrypt</primary></indexterm><anchor id="CUPSENCRYPT"/><title>

cups encrypt (G)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter is only applicable if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link>
	is set to <constant>cups</constant> and if you use CUPS newer than
	1.0.x.It is used to define whether or not Samba should use encryption
	when talking to the CUPS server. Possible values are
	<emphasis>auto</emphasis>, <emphasis>yes</emphasis> and
	<emphasis>no</emphasis>
	</para>

	<para>
	When set to auto we will try to do a TLS handshake on each CUPS
	connection setup. If that fails, we will fall back to unencrypted
	operation.
	</para>


<para>Default: <emphasis><parameter>cups encrypt</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cups options</primary></indexterm><anchor id="CUPSOPTIONS"/><title>

cups options (S)
</title><variablelist><varlistentry><listitem>
    <para>
    This parameter is only applicable if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> is 
    set to <constant>cups</constant>.  Its value is a free form string of options
    passed directly to the cups library.  
    </para>

   <para>
   You can pass any generic print option known to CUPS (as listed
   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.
   </para>

   <para>
   You should set this parameter to <constant>raw</constant> if your CUPS server 
   <filename>error_log</filename> file contains messages such as
   "Unsupported format 'application/octet-stream'" when printing from a Windows client 
   through Samba.  It is no longer necessary to enable
   system wide raw printing in <filename>/etc/cups/mime.{convs,types}</filename>.
   </para>


<para>Default: <emphasis><parameter>cups options</parameter> = <literal>""</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cups options</parameter> = <literal>"raw media=a4"</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cups server</primary></indexterm><anchor id="CUPSSERVER"/><title>

cups server (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This parameter is only applicable if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> is set to <constant>cups</constant>.
    </para>

   <para>
   If set, this option overrides the ServerName option in the CUPS <filename>client.conf</filename>. This is 
   necessary if you have virtual samba servers that connect to different CUPS daemons.
   </para>

   <para>Optionally, a port can be specified by separating the server name 
	   and port number with a colon. If no port was specified, 
	   the default port for IPP (631) will be used.
   </para>
	  

<para>Default: <emphasis><parameter>cups server</parameter> = <literal>""</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cups server</parameter> = <literal>mycupsserver</literal>
</emphasis>
</para><para>Example: <emphasis><parameter>cups server</parameter> = <literal>mycupsserver:1631</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>default devmode</primary></indexterm><anchor id="DEFAULTDEVMODE"/><title>

default devmode (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter is only applicable to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTABLE" xlink:href="smb.conf.5.html#PRINTABLE">printable</link> 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
    generated by the printer driver itself (which can only be executed on a
    Win32 platform).  Because smbd is unable to execute the driver code
    to generate the device mode, the default behavior is to set this field
    to NULL.
    </para>

    <para>Most problems with serving printer drivers to Windows NT/2k/XP clients
    can be traced to a problem with the generated device mode.  Certain drivers
    will do things such as crashing the client's Explorer.exe with a NULL devmode.
    However, other printer drivers can cause the client's spooler service
    (spoolsv.exe) to die if the devmode was not created by the driver itself
    (i.e. smbd generates a default devmode).
    </para>

    <para>This parameter should be used with care and tested with the printer
    driver in question.  It is better to leave the device mode to NULL
    and let the Windows client set the correct values.  Because drivers do not
    do this all the time, setting <literal>default devmode = yes</literal>
    will instruct smbd to generate a default one.
    </para>

    <para>For more information on Windows NT/2k printing and Device Modes,
    see the <ulink url="http://msdn.microsoft.com/">MSDN documentation</ulink>.
</para>

<para>Default: <emphasis><parameter>default devmode</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>deleteprinter command</primary></indexterm><anchor id="DELETEPRINTERCOMMAND"/><title>

deleteprinter command (G)
</title><variablelist><varlistentry><listitem>
    <para>With the introduction of MS-RPC based printer
    support for Windows NT/2000 clients in Samba 2.2, it is now 
    possible to delete a printer at run time by issuing the
    DeletePrinter() RPC call.</para>
		
    <para>For a Samba host this means that the printer must be 
    physically deleted from the underlying printing system.  The
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEPRINTERCOMMAND" xlink:href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</link> defines a script to be run which 
    will perform the necessary operations for removing the printer
    from the print system and from <filename moreinfo="none">smb.conf</filename>.
    </para>
		
    <para>The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEPRINTERCOMMAND" xlink:href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</link> is 
    automatically called with only one parameter: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTERNAME" xlink:href="smb.conf.5.html#PRINTERNAME">printer name</link>.
	</para>
		
    <para>Once the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DELETEPRINTERCOMMAND" xlink:href="smb.conf.5.html#DELETEPRINTERCOMMAND">deleteprinter command</link> has 
    been executed, <literal>smbd</literal> will reparse the <filename moreinfo="none">
    smb.conf</filename> to check that the associated printer no longer exists.
    If the sharename is still valid, then <literal>smbd
    </literal> will return an ACCESS_DENIED error to the client.</para>

<para>Default: <emphasis><parameter>deleteprinter command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>deleteprinter command</parameter> = <literal>/usr/bin/removeprinter</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>disable spoolss</primary></indexterm><anchor id="DISABLESPOOLSS"/><title>

disable spoolss (G)
</title><variablelist><varlistentry><listitem>
    <para>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
    the parameter. However, this will also disable the ability to upload
    printer drivers to a Samba server via the Windows NT Add Printer
    Wizard or by using the NT printer properties dialog window.  It will
    also disable the capability of Windows NT/2000 clients to download
    print drivers from the Samba host upon demand.
    <emphasis>Be very careful about enabling this parameter.</emphasis>
</para>

<para>Default: <emphasis><parameter>disable spoolss</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enable spoolss</primary></indexterm><anchor id="ENABLESPOOLSS"/><title>

enable spoolss (G)
</title><variablelist><varlistentry><listitem>
    <para>Inverted synonym for <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DISABLESPOOLSS" xlink:href="smb.conf.5.html#DISABLESPOOLSS">disable spoolss</link>.</para>

<para>Default: <emphasis><parameter>enable spoolss</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enumports command</primary></indexterm><anchor id="ENUMPORTSCOMMAND"/><title>

enumports command (G)
</title><variablelist><varlistentry><listitem>
    <para>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
    (i.e. LPD Port Monitor, etc...).  By default, Samba has only one
    port defined--<constant>"Samba Printer Port"</constant>.  Under 
    Windows NT/2000, all printers must have a valid port name.  
    If you wish to have a list of ports displayed (<literal>smbd
    </literal> does not use a port name for anything) other than 
    the default <constant>"Samba Printer Port"</constant>, you 
    can define <parameter moreinfo="none">enumports command</parameter> to point to
    a program which should generate a list of ports, one per line,
    to standard output.  This listing will then be used in response
    to the level 1 and 2 EnumPorts() RPC.</para>

<para>Default: <emphasis><parameter>enumports command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>enumports command</parameter> = <literal>/usr/bin/listports</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force printername</primary></indexterm><anchor id="FORCEPRINTERNAME"/><title>

force printername (S)
</title><variablelist><varlistentry><listitem>
    <para>When printing from Windows NT (or later), 
    each printer in <filename>smb.conf</filename> has two 
    associated names which can be used by the client.  The first
    is the sharename (or shortname) defined in smb.conf.  This
    is the only printername available for use by Windows 9x clients.
    The second name associated with a printer can be seen when 
    browsing to the "Printers" (or "Printers and Faxes") folder 
    on the Samba server.  This is referred to simply as the printername
    (not to be confused with the <parameter>printer name</parameter> option).
    </para>

    <para>When assigning a new driver to a printer on a remote 
    Windows compatible print server such as Samba, the Windows client
    will rename the printer to match the driver name just uploaded.
    This can result in confusion for users when multiple 
    printers are bound to the same driver.  To prevent Samba from
    allowing the printer's printername to differ from the sharename
    defined in smb.conf, set <parameter>force printername = yes</parameter>.
    </para>

    <para>Be aware that enabling this parameter may affect migrating
    printers from a Windows server to Samba since Windows has no way to 
    force the sharename and printername to match.</para>

    <para>It is recommended that this parameter's value not be changed
    once the printer is in use by clients as this could cause a user
    not be able to delete printer connections from their local Printers 
    folder.</para>


<para>Default: <emphasis><parameter>force printername</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>iprint server</primary></indexterm><anchor id="IPRINTSERVER"/><title>

iprint server (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This parameter is only applicable if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> is set to <constant>iprint</constant>.
    </para>

   <para>
   If set, this option overrides the ServerName option in the CUPS <filename>client.conf</filename>. This is 
   necessary if you have virtual samba servers that connect to different CUPS daemons.
   </para>

<para>Default: <emphasis><parameter>iprint server</parameter> = <literal>""</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>iprint server</parameter> = <literal>MYCUPSSERVER</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>load printers</primary></indexterm><anchor id="LOADPRINTERS"/><title>

load printers (G)
</title><variablelist><varlistentry><listitem>
    <para>A boolean variable that controls whether all 
    printers in the printcap will be loaded for browsing by default. 
    See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTERS" xlink:href="smb.conf.5.html#PRINTERS">printers</link> section for 
    more details.</para>

<para>Default: <emphasis><parameter>load printers</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lppause command</primary></indexterm><anchor id="LPPAUSECOMMAND"/><title>

lppause command (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies the command to be 
    executed on the server host in order to stop printing or spooling 
    a specific print job.</para>

    <para>This command should be a program or script which takes 
    a printer name and job number to pause the print job. One way 
    of implementing this is by using job priorities, where jobs 
    having a too low priority won't be sent to the printer.</para>

    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
    the job number (an integer).  On HPUX (see <parameter moreinfo="none">printing=hpux
    </parameter>), if the <parameter moreinfo="none">-p%p</parameter> option is added 
    to the lpq command, the job will show up with the correct status, i.e. 
    if the job priority is lower than the set fence priority it will 
    have the PAUSED status, whereas if  the priority is equal or higher it 
    will have the SPOOLED or PRINTING status.</para>

    <para>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.</para>

    <para>Currently no default value is given to
    this string, unless the value of the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> 
    parameter is <constant>SYSV</constant>, in which case the default is : 
    <literal>lp -i %p-%j -H hold</literal> or if the value of the 
    <parameter moreinfo="none">printing</parameter> parameter is 
    <constant>SOFTQ</constant>, then the default is: 
    <literal>qstat -s -j%j -h</literal>. </para>


<para>Default: <emphasis><parameter>lppause command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lppause command</parameter> = <literal>/usr/bin/lpalt %p-%j -p0</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lpq cache time</primary></indexterm><anchor id="LPQCACHETIME"/><title>

lpq cache time (G)
</title><variablelist><varlistentry><listitem>
	<para>This controls how long lpq info will be cached 
	for to prevent the <literal>lpq</literal> command being called too 
	often. A separate cache is kept for each variation of the <literal>
	lpq</literal> command used by the system, so if you use different 
	<literal>lpq</literal> commands for different users then they won't
	share cache information.</para>

	<para>The cache files are stored in <filename moreinfo="none">/tmp/lpq.xxxx</filename> 
	where xxxx is a hash of the <literal>lpq</literal> command in use.</para>

	<para>The default is 30 seconds, meaning that the cached results 
	of a previous identical <literal>lpq</literal> command will be used 
	if the cached data is less than 30 seconds old. A large value may 
	be advisable if your <literal>lpq</literal> command is very slow.</para>

<para>A value of 0 will disable caching completely.</para>

<para>Default: <emphasis><parameter>lpq cache time</parameter> = <literal>30</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lpq cache time</parameter> = <literal>10</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lpq command</primary></indexterm><anchor id="LPQCOMMAND"/><title>

lpq command (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies the command to be 
    executed on the server host in order to obtain <literal>lpq
    </literal>-style printer status information.</para>

    <para>This command should be a program or script which 
    takes a printer name as its only parameter and outputs printer 
    status information.</para>

    <para>Currently nine styles of printer status information 
    are supported; BSD, AIX, LPRNG, PLP, SYSV, HPUX, QNX, CUPS, and SOFTQ. 
    This covers most UNIX systems. You control which type is expected 
    using the <parameter moreinfo="none">printing =</parameter> option.</para>

    <para>Some clients (notably Windows for Workgroups) may not 
    correctly send the connection number for the printer they are 
    requesting status information about. To get around this, the 
    server reports on the first printer service connected to by the 
    client. This only happens if the connection number sent is invalid.</para>

    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. Otherwise it is placed at the end of the 
    command.</para>

    <para>Note that it is good practice to include the absolute path 
    in the <parameter moreinfo="none">lpq command</parameter> as the <envar>$PATH
    </envar> may not be available to the server.  When compiled with
    the CUPS libraries, no <parameter moreinfo="none">lpq command</parameter> is
    needed because smbd will make a library call to obtain the 
	print queue listing.</para>

<para>Default: <emphasis><parameter>lpq command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lpq command</parameter> = <literal>/usr/bin/lpq -P%p</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lpresume command</primary></indexterm><anchor id="LPRESUMECOMMAND"/><title>

lpresume command (S)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

    <para>This command should be a program or script which takes 
    a printer name and job number to resume the print job. See 
    also the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LPPAUSECOMMAND" xlink:href="smb.conf.5.html#LPPAUSECOMMAND">lppause command</link> parameter.</para>

    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
    the job number (an integer).</para>
		
    <para>Note that it is good practice to include the absolute path 
    in the <parameter moreinfo="none">lpresume command</parameter> as the PATH may not 
    be available to the server.</para>
		
    <para>See also the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link> parameter.</para>

    <para>Default: Currently no default value is given 
    to this string, unless the value of the <parameter moreinfo="none">printing</parameter> 
    parameter is <constant>SYSV</constant>, in which case the default is:</para>

    <para><literal>lp -i %p-%j -H resume</literal></para>

    <para>or if the value of the <parameter moreinfo="none">printing</parameter> parameter 
    is <constant>SOFTQ</constant>, then the default is:</para>

    <para><literal>qstat -s -j%j -r</literal></para>

<para>Default: <emphasis><parameter>lpresume command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>lpresume command</parameter> = <literal>/usr/bin/lpalt %p-%j -p2</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lprm command</primary></indexterm><anchor id="LPRMCOMMAND"/><title>

lprm command (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies the command to be 
    executed on the server host in order to delete a print job.</para>

    <para>This command should be a program or script which takes 
    a printer name and job number, and deletes the print job.</para>

    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. A <parameter moreinfo="none">%j</parameter> is replaced with 
    the job number (an integer).</para>

    <para>Note that it is good practice to include the absolute 
    path in the <parameter moreinfo="none">lprm command</parameter> as the PATH may not be 
    available to the server.</para>

	<para>
	Examples of use are:
<programlisting>
lprm command = /usr/bin/lprm -P%p %j

or

lprm command = /usr/bin/cancel %p-%j
</programlisting>
	</para>


<para>Default: <emphasis><parameter>lprm command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max print jobs</primary></indexterm><anchor id="MAXPRINTJOBS"/><title>

max print jobs (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter limits the maximum number of 
    jobs allowable in a Samba printer queue at any given moment.
    If this number is exceeded, <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> will remote "Out of Space" to the client.
	</para>

<para>Default: <emphasis><parameter>max print jobs</parameter> = <literal>1000</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max print jobs</parameter> = <literal>5000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max reported print jobs</primary></indexterm><anchor id="MAXREPORTEDPRINTJOBS"/><title>

max reported print jobs (S)
</title><variablelist><varlistentry><listitem>
    <para>
    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 
    print jobs reported.
    </para>

<para>Default: <emphasis><parameter>max reported print jobs</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max reported print jobs</parameter> = <literal>1000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>os2 driver map</primary></indexterm><anchor id="OS2DRIVERMAP"/><title>

os2 driver map (G)
</title><variablelist><varlistentry><listitem>
    <para>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:</para>
		
    <para>&lt;nt driver name&gt; = &lt;os2 driver name&gt;.&lt;device name&gt;</para>
		
    <para>For example, a valid entry using the HP LaserJet 5
    printer driver would appear as <literal>HP LaserJet 5L = LASERJET.HP 
    LaserJet 5L</literal>.</para>
		
    <para>
    The need for the file is due to the printer driver namespace problem described in 
    the chapter on Classical Printing in the Samba3-HOWTO book.  For more
    details on OS/2 clients, please refer to chapter on other clients in the Samba3-HOWTO book.
    </para>

<para>Default: <emphasis><parameter>os2 driver map</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>print ok</primary><see>printable</see></indexterm><title>

<anchor id="PRINTOK"/>print ok
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PRINTABLE">printable</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>printable</primary></indexterm><anchor id="PRINTABLE"/><title>

printable (S)
</title><variablelist><varlistentry><listitem>
    <para>If this parameter is <constant>yes</constant>, then 
    clients may open, write to and submit spool files on the directory 
    specified for the service. </para>
		
    <para>Note that a printable service will ALWAYS allow writing 
    to the service path (user privileges permitting) via the spooling 
    of print data. The <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only</link> parameter controls only non-printing access to 
    the resource.</para>

<para>Default: <emphasis><parameter>printable</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>printcap cache time</primary></indexterm><anchor id="PRINTCAPCACHETIME"/><title>

printcap cache time (G)
</title><variablelist><varlistentry><listitem>
    <para>This option specifies the number of seconds before the printing
    subsystem is again asked for the known printers.
    </para>

    <para>Setting this parameter to 0 disables any rescanning for new 
    or removed printers after the initial startup.
    </para>

<para>Default: <emphasis><parameter>printcap cache time</parameter> = <literal>750</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>printcap cache time</parameter> = <literal>600</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>printcap</primary><see>printcap name</see></indexterm><title>

<anchor id="PRINTCAP"/>printcap
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PRINTCAPNAME">printcap name</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>printcap name</primary></indexterm><anchor id="PRINTCAPNAME"/><title>

printcap name (G)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter may be used to override the compiled-in default printcap name used by the server (usually
	<filename moreinfo="none"> /etc/printcap</filename>). See the discussion of the <link linkend="PRINTERSSECT">[printers]</link> section above for reasons why you might want to do this.
	</para>

    <para>
	To use the CUPS printing interface set <literal>printcap name = cups </literal>. This should
	be supplemented by an additional setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing = cups</link> in the [global]
	section.  <literal>printcap name = cups</literal> will use the  "dummy" printcap
	created by CUPS, as specified in your CUPS configuration file.
    </para>

    <para>
	On System V systems that use <literal>lpstat</literal> to 
    list available printers you can use <literal>printcap name = lpstat
    </literal> to automatically obtain lists of available printers. This 
    is the default for systems that define SYSV at configure time in 
    Samba (this includes most System V based systems). If <parameter moreinfo="none">
    printcap name</parameter> is set to <literal>lpstat</literal> on 
    these systems then Samba will launch <literal>lpstat -v</literal> and 
    attempt to parse the output to obtain a printer list.
	</para>

    <para>
	A minimal printcap file would look something like this:
<programlisting format="linespecific">
print1|My Printer 1
print2|My Printer 2
print3|My Printer 3
print4|My Printer 4
print5|My Printer 5
</programlisting>
    where the '|' separates aliases of a printer. The fact that the second alias has a space in
	it gives a hint to Samba that it's a comment.
	</para>

    <note><para>
	Under AIX the default printcap name is <filename moreinfo="none">/etc/qconfig</filename>. Samba will
	assume the file is in AIX <filename moreinfo="none">qconfig</filename> format if the string <filename moreinfo="none">qconfig</filename> appears in the printcap filename.
	</para></note>


<para>Default: <emphasis><parameter>printcap name</parameter> = <literal>/etc/printcap</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>printcap name</parameter> = <literal>/etc/myprintcap</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>print command</primary></indexterm><anchor id="PRINTCOMMAND"/><title>

print command (S)
</title><variablelist><varlistentry><listitem>
    <para>After a print job has finished spooling to 
    a service, this command will be used via a <literal>system()</literal> 
    call to process the spool file. Typically the command specified will 
    submit the spool file to the host's printing subsystem, but there 
    is no requirement that this be the case. The server will not remove 
    the spool file, so whatever command you specify should remove the 
    spool file when it has been processed, otherwise you will need to 
    manually remove old spool files.</para>
		
    <para>The print command is simply a text string. It will be used 
    verbatim after macro substitutions have been made:</para>

	<para>%s, %f - the path to the spool
    file name</para>

    <para>%p - the appropriate printer 
    name</para>

    <para>%J - the job 
    name as transmitted by the client.</para>

    <para>%c - The number of printed pages
    of the spooled job (if known).</para>

    <para>%z - the size of the spooled
    print job (in bytes)</para>

    <para>The print command <emphasis>MUST</emphasis> contain at least 
    one occurrence of <parameter moreinfo="none">%s</parameter> or <parameter moreinfo="none">%f
    </parameter> - the <parameter moreinfo="none">%p</parameter> is optional. At the time 
    a job is submitted, if no printer name is supplied the <parameter moreinfo="none">%p
    </parameter> will be silently removed from the printer command.</para>

    <para>If specified in the [global] section, the print command given 
    will be used for any printable service that does not have its own 
    print command specified.</para>

    <para>If there is neither a specified print command for a 
    printable service nor a global print command, spool files will 
    be created but not processed and (most importantly) not removed.</para>

    <para>Note that printing may fail on some UNIXes from the 
    <constant>nobody</constant> account. If this happens then create 
    an alternative guest account that can print and set the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link> 
    in the [global] section.</para>

    <para>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.</para>

    <para><literal>print command = echo Printing %s &gt;&gt; 
    /tmp/print.log; lpr -P %p %s; rm %s</literal></para>

    <para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTING" xlink:href="smb.conf.5.html#PRINTING">printing</link>
	parameter.</para>

    <para>Default: For <literal>printing = BSD, AIX, QNX, LPRNG 
    or PLP :</literal></para>
    <para><literal>print command = lpr -r -P%p %s</literal></para>

    <para>For <literal>printing = SYSV or HPUX :</literal></para>
    <para><literal>print command = lp -c -d%p %s; rm %s</literal></para>

    <para>For <literal>printing = SOFTQ :</literal></para>
    <para><literal>print command = lp -d%p -s %s; rm %s</literal></para>

    <para>For printing = CUPS :   If SAMBA is compiled against
    libcups, then <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTCAP" xlink:href="smb.conf.5.html#PRINTCAP">printcap = cups</link> 
    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
    uses <literal>lp -c -d%p -oraw; rm %s</literal>.   
    With <literal>printing = cups</literal>,
    and if SAMBA is compiled against libcups, any manually 
	set print command will be ignored.</para>

<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>print command</parameter> = <literal>/usr/local/samba/bin/myprintscript %p %s</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>printer</primary><see>printer name</see></indexterm><title>

<anchor id="PRINTER"/>printer
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PRINTERNAME">printer name</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>printer name</primary></indexterm><anchor id="PRINTERNAME"/><title>

printer name (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter specifies the name of the printer to which print jobs spooled through a printable service
	will be sent.
	</para>

    <para>
	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.
	</para>

	<para>
	The default value of the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRINTERNAME" xlink:href="smb.conf.5.html#PRINTERNAME">printer name</link> may be <literal>lp</literal> on many
	systems.
	</para>

<para>Default: <emphasis><parameter>printer name</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>printer name</parameter> = <literal>laserwriter</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>printing</primary></indexterm><anchor id="PRINTING"/><title>

printing (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameters controls how printer status  information is
    interpreted on your system. It also affects the  default values for
    the <parameter moreinfo="none">print command</parameter>,  <parameter moreinfo="none">lpq command</parameter>, <parameter moreinfo="none">lppause command </parameter>, <parameter moreinfo="none">lpresume command</parameter>, and  <parameter moreinfo="none">lprm command</parameter> if specified in the 
    [global] section.</para>

    <para>Currently nine printing styles are supported. They are
    <constant>BSD</constant>, <constant>AIX</constant>, 
    <constant>LPRNG</constant>, <constant>PLP</constant>,
    <constant>SYSV</constant>, <constant>HPUX</constant>,
    <constant>QNX</constant>, <constant>SOFTQ</constant>,
    <constant>CUPS</constant> and <constant>IPRINT</constant>.</para>

    <para>Be aware that CUPS and IPRINT are only available if the CUPS
    development library was available at the time Samba was compiled
    or packaged.</para>

    <para>To see what the defaults are for the other print 
    commands when using the various options use the <citerefentry><refentrytitle>testparm</refentrytitle>
    <manvolnum>1</manvolnum></citerefentry> program.</para>

    <para>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 <parameter>printing</parameter> option since it will 
    reset the printing commands to default values.</para>

    <para>See also the discussion in the <link linkend="PRINTERSSECT">
    [printers]</link> section.</para>

    <para>See <literal>testparm -v.</literal> for the default
    value on your system</para>

<para>Default: <emphasis><parameter>printing</parameter> = <literal>
# Depends on the operating system</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>printjob username</primary></indexterm><anchor id="PRINTJOBUSERNAME"/><title>

printjob username (S)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

<para>Default: <emphasis><parameter>printjob username</parameter> = <literal>%U</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>printjob username</parameter> = <literal>%D\%U</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>print notify backchannel</primary></indexterm><anchor id="PRINTNOTIFYBACKCHANNEL"/><title>

print notify backchannel (S)
</title><variablelist><varlistentry><listitem>
<para>Windows print clients can update print queue status by expecting
	the server to open a backchannel SMB connection to them. Due to
	client firewall settings this can cause considerable timeouts
	and will often fail, as there is no guarantee the client is even
	running an SMB server. By default, the Samba print server will
	not try to connect back to clients, and will treat corresponding
	requests as if the connection back to the client failed.
</para>

<para>Default: <emphasis><parameter>print notify backchannel</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>queuepause command</primary></indexterm><anchor id="QUEUEPAUSECOMMAND"/><title>

queuepause command (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies the command to be 
    executed on the server host in order to pause the printer queue.</para>

    <para>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.</para>

    <para>This command is not supported by Windows for Workgroups, 
    but can be issued from the Printers window under Windows 95 
    and NT.</para>
		
    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. Otherwise it is placed at the end of the command.
    </para>

    <para>Note that it is good practice to include the absolute 
    path in the command as the PATH may not be available to the 
	server.</para>

<para>Default: <emphasis><parameter>queuepause command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>queuepause command</parameter> = <literal>disable %p</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>queueresume command</primary></indexterm><anchor id="QUEUERESUMECOMMAND"/><title>

queueresume command (S)
</title><variablelist><varlistentry><listitem>
    <para>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 (<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="QUEUEPAUSECOMMAND" xlink:href="smb.conf.5.html#QUEUEPAUSECOMMAND">queuepause command</link>).</para>
 
    <para>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.</para>

    <para>This command is not supported by Windows for Workgroups, 
    but can be issued from the Printers window under Windows 95 
    and NT.</para>

    <para>If a <parameter moreinfo="none">%p</parameter> is given then the printer name 
    is put in its place. Otherwise it is placed at the end of the 
    command.</para>

    <para>Note that it is good practice to include the absolute 
    path in the command as the PATH may not be available to the 
	server.</para>

<para>Default: <emphasis><parameter>queueresume command</parameter> = <literal>
# determined by printing parameter</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>queueresume command</parameter> = <literal>enable %p</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>show add printer wizard</primary></indexterm><anchor id="SHOWADDPRINTERWIZARD"/><title>

show add printer wizard (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    possible to disable this feature regardless of the level of privilege 
    of the connected user.</para>
		
    <para>Under normal circumstances, the Windows NT/2000 client will 
    open a handle on the printer server with OpenPrinterEx() asking for
    Administrator privileges.  If the user does not have administrative
    access on the print server (i.e is not root or has granted the
    SePrintOperatorPrivilege), the OpenPrinterEx()
    call fails and the client makes another open call with a request for 
    a lower privilege level.  This should succeed, however the APW 
    icon will not be displayed.</para>
		
    <para>Disabling the <parameter moreinfo="none">show add printer wizard</parameter>
    parameter will always cause the OpenPrinterEx() on the server
	to fail.  Thus the APW icon will never be displayed. 
</para>
<note><para>This does not prevent the same user from having 
		administrative privilege on an individual printer.</para></note>

<para>Default: <emphasis><parameter>show add printer wizard</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>spoolss: architecture</primary></indexterm><anchor id="SPOOLSS:ARCHITECTURE"/><title>

spoolss: architecture (G)
</title><variablelist><varlistentry><listitem>
	<para>Windows spoolss print clients only allow association of server-side drivers
	with printers when the driver architecture matches the advertised print server
	architecture. Samba's spoolss print server architecture can be changed using
	this parameter.</para>

<para>Default: <emphasis><parameter>spoolss: architecture</parameter> = <literal>Windows NT x86</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>spoolss: architecture</parameter> = <literal>Windows x64</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>spoolss: os_major</primary></indexterm><anchor id="SPOOLSS:OS_MAJOR"/><title>

spoolss: os_major (G)
</title><variablelist><varlistentry><listitem>
	<para>Windows might require a new os version number. This option allows
		to modify the build number. The complete default version number is:
		5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
	</para>

<para>Default: <emphasis><parameter>spoolss: os_major</parameter> = <literal>5</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>spoolss: os_major</parameter> = <literal>6</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>

<section><indexterm significance="preferred"><primary>spoolss: os_minor</primary></indexterm><anchor id="SPOOLSS:OS_MINOR"/><title>

spoolss: os_minor (G)
</title><variablelist><varlistentry><listitem>
	<para>Windows might require a new os version number. This option allows
		to modify the build number. The complete default version number is:
		5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
	</para>

<para>Default: <emphasis><parameter>spoolss: os_minor</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>spoolss: os_minor</parameter> = <literal>1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>

<section><indexterm significance="preferred"><primary>spoolss: os_build</primary></indexterm><anchor id="SPOOLSS:OS_BUILD"/><title>

spoolss: os_build (G)
</title><variablelist><varlistentry><listitem>
	<para>Windows might require a new os version number. This option allows
		to modify the build number. The complete default version number is:
		5.0.2195 (Windows 2000). The example is 6.1.7601 (Windows 2008 R2).
	</para>

<para>Default: <emphasis><parameter>spoolss: os_build</parameter> = <literal>2195</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>spoolss: os_build</parameter> = <literal>7601</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>use client driver</primary></indexterm><anchor id="USECLIENTDRIVER"/><title>

use client driver (S)
</title><variablelist><varlistentry><listitem>
    <para>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
    to install a local printer driver.  From this point on, the client
    will treat the print as a local printer and not a network printer 
    connection.  This is much the same behavior that will occur
    when <literal>disable spoolss = yes</literal>.
    </para>

    <para>The differentiating  factor is that under normal
    circumstances, the NT/2000 client will  attempt to open the network
    printer using MS-RPC.  The problem is that because the client
    considers the printer to be local, it will attempt to issue the
    OpenPrinterEx() call requesting access rights associated  with the
    logged on user. If the user possesses local administrator rights but
    not root privilege on the Samba host (often the case), the
    OpenPrinterEx() call will fail.  The result is that the client will
    now display an "Access Denied; Unable to connect" message
    in the printer queue window (even though jobs may successfully be
    printed).  </para>

    <para>If this parameter is enabled for a printer, then any attempt
    to open the printer with the PRINTER_ACCESS_ADMINISTER right is mapped
    to PRINTER_ACCESS_USE instead.  Thus allowing the OpenPrinterEx()
    call to succeed.  <emphasis>This parameter MUST not be enabled
    on a print share which has valid print driver installed on the Samba 
	server.</emphasis></para>

<para>Default: <emphasis><parameter>use client driver</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>acl allow execute always</primary></indexterm><anchor id="ACLALLOWEXECUTEALWAYS"/><title>

acl allow execute always (S)
</title><variablelist><varlistentry><listitem>
    <para>
    This boolean parameter controls the behaviour of <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> when receiving a protocol request of "open for execution"
    from a Windows client.
    With Samba 3.6 and older, the execution right in the ACL was not checked, so a client
    could execute a file even if it did not have execute rights on the file. In Samba 4.0,
    this has been fixed, so that by default, i.e. when this parameter is set to "False",
    "open for execution" is now denied when execution permissions are not present.
    </para>
    <para>
    If this parameter is set to "True", Samba does not check execute permissions on
    "open for execution", thus re-establishing the behaviour of Samba 3.6.
    This can be useful to smoothen upgrades from older Samba versions to 4.0 and newer.
    This setting is not meant to be used as a permanent setting, but as a temporary relief:
    It is recommended to fix the permissions in the ACLs and reset this parameter to the
    default after a certain transition period.
    </para>

<para>Default: <emphasis><parameter>acl allow execute always</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>acl check permissions</primary></indexterm><anchor id="ACLCHECKPERMISSIONS"/><title>

acl check permissions (S)
</title><variablelist><varlistentry><listitem>
    <para>Please note this parameter is now deprecated in Samba 3.6.2 and will be removed
    in a future version of Samba.
    </para>
    <para>This boolean parameter controls what <citerefentry><refentrytitle>smbd</refentrytitle> 
    <manvolnum>8</manvolnum></citerefentry> 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
    delete request by unsetting the "delete on close" bit Samba cannot delete the file immediately
    on "open for delete" request as we cannot restore such a deleted file. With this parameter set to
    true (the default) then smbd checks the file system permissions directly on "open for delete" and denies the
    request without actually deleting the file if the file system permissions would seem to deny it.
    This is not perfect, as it's possible a user could have deleted a file without Samba being able to
    check the permissions correctly, but it is close enough to Windows semantics for mostly correct
    behaviour. Samba will correctly check POSIX ACL semantics in this case.
    </para>
    <para>If this parameter is set to "false" Samba doesn't check permissions on "open for delete"
    and allows the open. If the user doesn't have permission to delete the file this will only be
    discovered at close time, which is too late for the Windows user tools to display an error message
    to the user. The symptom of this is files that appear to have been deleted "magically" re-appearing
    on a Windows explorer refresh. This is an extremely advanced protocol option which should not
    need to be changed. This parameter was introduced in its final form in 3.0.21, an earlier version
    with slightly different semantics was introduced in 3.0.20. That older version is not documented here.
    </para>

<para>Default: <emphasis><parameter>acl check permissions</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>acl map full control</primary></indexterm><anchor id="ACLMAPFULLCONTROL"/><title>

acl map full control (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> 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.
	</para>

<para>Default: <emphasis><parameter>acl map full control</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>cldap port</primary></indexterm><anchor id="CLDAPPORT"/><title>

cldap port (G)
</title><variablelist><varlistentry><listitem>
    <para>This option controls the port used by the CLDAP protocol.
</para>

<para>Default: <emphasis><parameter>cldap port</parameter> = <literal>389</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>cldap port</parameter> = <literal>3389</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client max protocol</primary></indexterm><anchor id="CLIENTMAXPROTOCOL"/><title>

client max protocol (G)
</title><variablelist><varlistentry><listitem>
    <para>The value of the parameter (a string) is the highest 
    protocol level that will be supported by the client.</para>

    <para>Possible values are :</para>
    <itemizedlist>
	<listitem>
	    <para><constant>CORE</constant>: Earliest version. No 
	    concept of user names.</para>
	</listitem>
			
	<listitem>
	    <para><constant>COREPLUS</constant>: Slight improvements on 
	    CORE for efficiency.</para>
	</listitem>

	<listitem>
	    <para><constant>LANMAN1</constant>: First <emphasis>modern</emphasis>
	    version of the protocol. Long filename support.</para>
	</listitem>

	<listitem>
	    <para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.</para>
	</listitem>

	<listitem>
	    <para><constant>NT1</constant>: Current up to date version of the protocol. 
	    Used by Windows NT. Known as CIFS.</para>
	</listitem>

	<listitem>
	    <para><constant>SMB2</constant>: Re-implementation of the SMB protocol.
	    Used by Windows Vista and later versions of Windows. SMB2 has sub protocols available.</para>
	    <itemizedlist>
		<listitem>
		    <para><constant>SMB2_02</constant>: The earliest SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_10</constant>: Windows 7 SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_22</constant>: Early Windows 8 SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_24</constant>: Windows 8 beta SMB2 version.</para>
		</listitem>
	    </itemizedlist>
	    <para>By default SMB2 selects the SMB2_10 variant.</para>
	</listitem>

	<listitem>
	    <para><constant>SMB3</constant>: The same as SMB2.
	    Used by Windows 8. SMB3 has sub protocols available.</para>
	    <itemizedlist>
		<listitem>
		    <para><constant>SMB3_00</constant>: Windows 8 SMB3 version. (mostly the same as SMB2_24)</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_02</constant>: Windows 8.1 SMB3 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_10</constant>: early Windows 10 technical preview SMB3 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_11</constant>: Windows 10 technical preview SMB3 version (maybe final).</para>
		</listitem>
	    </itemizedlist>
	    <para>By default SMB3 selects the SMB3_11 variant.</para>
	</listitem>
    </itemizedlist>

    <para>Normally this option should not be set as the automatic 
    negotiation phase in the SMB protocol takes care of choosing 
    the appropriate protocol.</para>

    <para>The value <constant>default</constant> refers to the default protocol in each
    part of the code, currently <constant>NT1</constant> in the client tools and
    <constant>SMB3_02</constant> in winbindd.</para>

<para>Default: <emphasis><parameter>client max protocol</parameter> = <literal>default</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>client max protocol</parameter> = <literal>LANMAN1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client min protocol</primary></indexterm><anchor id="CLIENTMINPROTOCOL"/><title>

client min protocol (G)
</title><variablelist><varlistentry><listitem>
	<para>This setting controls the minimum protocol version that the
	client will attempt to use.</para>

	<para>Normally this option should not be set as the automatic
	negotiation phase in the SMB protocol takes care of choosing
	the appropriate protocol.</para>

	<para>See <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTMAXPROTOCOL" xlink:href="smb.conf.5.html#CLIENTMAXPROTOCOL">client max protocol</link></para> for a full list
	of available protocols.</para>

<para>Default: <emphasis><parameter>client min protocol</parameter> = <literal>CORE</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>client min protocol</parameter> = <literal>NT1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client use spnego</primary></indexterm><anchor id="CLIENTUSESPNEGO"/><title>

client use spnego (G)
</title><variablelist><varlistentry><listitem>
    <para> 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.</para>

<para>Default: <emphasis><parameter>client use spnego</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dcerpc endpoint servers</primary></indexterm><anchor id="DCERPCENDPOINTSERVERS"/><title>

dcerpc endpoint servers (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which DCE/RPC endpoint servers should be run.</para>

<para>Default: <emphasis><parameter>dcerpc endpoint servers</parameter> = <literal>epmapper, wkssvc, rpcecho, samr, netlogon, lsarpc, spoolss, drsuapi, dssetup, unixinfo, browser, eventlog6, backupkey, dnsserver</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>dcerpc endpoint servers</parameter> = <literal>rpcecho</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>defer sharing violations</primary></indexterm><anchor id="DEFERSHARINGVIOLATIONS"/><title>

defer sharing violations (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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 
	the share settings specified by other processes. This parameter causes
	smbd to act as a Windows server does, and defer returning a "sharing
	violation" error message for up to one second, allowing the client
	to close the file causing the violation in the meantime.
	</para>

	<para>UNIX by default does not have this behaviour.</para>

	<para>
	There should be no reason to turn off this parameter, as it is
	designed to enable Samba to more correctly emulate Windows.
	</para>

<para>Default: <emphasis><parameter>defer sharing violations</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dgram port</primary></indexterm><anchor id="DGRAMPORT"/><title>

dgram port (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which ports the server should listen on for NetBIOS datagram traffic.</para>

<para>Default: <emphasis><parameter>dgram port</parameter> = <literal>138</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>disable netbios</primary></indexterm><anchor id="DISABLENETBIOS"/><title>

disable netbios (G)
</title><variablelist><varlistentry><listitem>
    <para>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. </para>

    <note><para>Clients that only support netbios won't be able to 
    see your samba server when netbios support is disabled.
	</para></note>

<para>Default: <emphasis><parameter>disable netbios</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>durable handles</primary></indexterm><anchor id="DURABLEHANDLES"/><title>

durable handles (S)
</title><variablelist><varlistentry><listitem>
    <para>
    This boolean parameter controls
    whether Samba can grant SMB2 durable file handles on a share.
    </para>
    <para>
    Note that durable handles are only enabled if
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERNELOPLOCKS" xlink:href="smb.conf.5.html#KERNELOPLOCKS">kernel oplocks = no</link>,
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERNELSHAREMODES" xlink:href="smb.conf.5.html#KERNELSHAREMODES">kernel share modes = no</link>, and
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="POSIXLOCKING" xlink:href="smb.conf.5.html#POSIXLOCKING">posix locking = no</link>,
    i.e. if the share is configured for CIFS/SMB2 only access,
    not supporting interoperability features with local UNIX processes
    or NFS operations.
    </para>
    <para>
    Also note that, for the time being, durability is not granted
    for a handle that has the delete on close flag set.
    </para>

<para>Default: <emphasis><parameter>durable handles</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ea support</primary></indexterm><anchor id="EASUPPORT"/><title>

ea support (S)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle>                                       
    <manvolnum>8</manvolnum></citerefentry> 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.</para>

<para>Default: <emphasis><parameter>ea support</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>enable asu support</primary></indexterm><anchor id="ENABLEASUSUPPORT"/><title>

enable asu support (G)
</title><variablelist><varlistentry><listitem>
    <para>Hosts running the "Advanced Server for Unix (ASU)" product
    require some special accomodations such as creating a builtin [ADMIN$]
    share that only supports IPC connections.  The has been the default
    behavior in smbd for many years.  However, certain Microsoft applications
    such as the Print Migrator tool require that the remote server support
    an [ADMIN$] file share.  Disabling this parameter allows for creating
    an [ADMIN$] file share in smb.conf.</para>

<para>Default: <emphasis><parameter>enable asu support</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>eventlog list</primary></indexterm><anchor id="EVENTLOGLIST"/><title>

eventlog list (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    <filename>$(statedir)/eventlog</filename>.
    </para>

    <para>
    The administrator must use an external process to parse the normal 
    Unix logs such as <filename>/var/log/messages</filename>
    and write then entries to the eventlog tdb files.  Refer to the
    eventlogadm(8) utility for how to write eventlog entries.
    </para>

<para>Default: <emphasis><parameter>eventlog list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>eventlog list</parameter> = <literal>Security Application Syslog Apache</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>large readwrite</primary></indexterm><anchor id="LARGEREADWRITE"/><title>

large readwrite (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not
    <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> supports the new 64k
    streaming read and write variant 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
    system such as IRIX, Solaris or a Linux 2.4 kernel. Can improve
    performance by 10% with Windows 2000 clients. Defaults to on. Not as
	tested as some other Samba code paths.</para>

<para>Default: <emphasis><parameter>large readwrite</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map acl inherit</primary></indexterm><anchor id="MAPACLINHERIT"/><title>

map acl inherit (S)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle>                                       
    <manvolnum>8</manvolnum></citerefentry> 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
    allows the Windows 2000 ACL editor to correctly use inheritance with the Samba
    POSIX ACL mapping code.
    </para>

<para>Default: <emphasis><parameter>map acl inherit</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max mux</primary></indexterm><anchor id="MAXMUX"/><title>

max mux (G)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

<para>Default: <emphasis><parameter>max mux</parameter> = <literal>50</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max ttl</primary></indexterm><anchor id="MAXTTL"/><title>

max ttl (G)
</title><variablelist><varlistentry><listitem>
    <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> what the default 'time to live' 
    of NetBIOS names should be (in seconds) when <literal>nmbd</literal> 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.</para>

<para>Default: <emphasis><parameter>max ttl</parameter> = <literal>259200</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max wins ttl</primary></indexterm><anchor id="MAXWINSTTL"/><title>

max wins ttl (G)
</title><variablelist><varlistentry><listitem>
    <para>This option tells <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> when acting as a WINS server
	(<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINSSUPPORT" xlink:href="smb.conf.5.html#WINSSUPPORT">wins support = yes</link>) what the maximum
    'time to live' of NetBIOS names that <literal>nmbd</literal> 
    will grant will be (in seconds). You should never need to change this
	parameter.  The default is 6 days (518400 seconds).</para>

<para>Default: <emphasis><parameter>max wins ttl</parameter> = <literal>518400</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max xmit</primary></indexterm><anchor id="MAXXMIT"/><title>

max xmit (G)
</title><variablelist><varlistentry><listitem>
    <para>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.
</para>

<para>Default: <emphasis><parameter>max xmit</parameter> = <literal>16644</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max xmit</parameter> = <literal>8192</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>min receivefile size</primary></indexterm><anchor id="MINRECEIVEFILESIZE"/><title>

min receivefile size (G)
</title><variablelist><varlistentry><listitem>
<para>This option changes the behavior of <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> 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
socket buffers into the filesystem buffer cache, if available. It may improve performance
but user testing is recommended. If set to zero Samba processes SMBwriteX calls in the
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.</para>
<para>Note this option will have NO EFFECT if set on a SMB signed connection.</para>
<para>The default is zero, which disables this option.</para>

<para>Default: <emphasis><parameter>min receivefile size</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>min wins ttl</primary></indexterm><anchor id="MINWINSTTL"/><title>

min wins ttl (G)
</title><variablelist><varlistentry><listitem>
    <para>This option tells <citerefentry><refentrytitle>nmbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry>
    when acting as a WINS server (<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINSSUPPORT" xlink:href="smb.conf.5.html#WINSSUPPORT">wins support = yes</link>) what the minimum 'time to live' 
    of NetBIOS names that <literal>nmbd</literal> will grant will be (in 
    seconds). You should never need to change this parameter.  The default 
    is 6 hours (21600 seconds).</para>

<para>Default: <emphasis><parameter>min wins ttl</parameter> = <literal>21600</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>name resolve order</primary></indexterm><anchor id="NAMERESOLVEORDER"/><title>

name resolve order (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    separated string of name resolution options.</para>

    <para>The options are: "lmhosts", "host",
    "wins" and "bcast". They cause names to be
    resolved as follows:</para>

    <itemizedlist>
	<listitem>
	    <para>
		<constant>lmhosts</constant> : Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has 
	    no name type attached to the NetBIOS name (see the manpage for lmhosts for details) then
	    any name type matches for lookup.
		</para>
	</listitem>

	<listitem>
	    <para>
		<constant>host</constant> : Do a standard host name to IP address resolution, using the system
		<filename moreinfo="none">/etc/hosts </filename>, NIS, or DNS lookups. This method of name resolution is
		operating system depended for instance on IRIX or Solaris this may be controlled by the <filename moreinfo="none">/etc/nsswitch.conf</filename> file.  Note that this method is used only if the NetBIOS name
		type being queried is the 0x20 (server) name type or 0x1c (domain controllers).  The latter case is only
		useful for active directory domains and results in a DNS query for the SRV RR entry matching
		_ldap._tcp.domain.
	</para>
	</listitem>

	<listitem>
	    <para><constant>wins</constant> : Query a name with 
	    the IP address listed in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINSSERVER" xlink:href="smb.conf.5.html#WINSSERVER">WINSSERVER</link> parameter.  If no WINS server has
	    been specified this method will be ignored.</para>
	</listitem>

	<listitem>
	    <para><constant>bcast</constant> : Do a broadcast on 
	    each of the known local interfaces listed in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INTERFACES" xlink:href="smb.conf.5.html#INTERFACES">interfaces</link> 
	    parameter. This is the least reliable of the name resolution 
	    methods as it depends on the target host being on a locally 
	    connected subnet.</para>
	</listitem>
</itemizedlist>

    <para>The example below will cause the local lmhosts file to be examined 
    first, followed by a broadcast attempt, followed by a normal 
    system hostname lookup.</para>

    <para>When Samba is functioning in ADS security mode (<literal>security = ads</literal>)
    it is advised to use following settings for <parameter moreinfo="none">name resolve order</parameter>:</para>

    <para><literal>name resolve order = wins bcast</literal></para>

    <para>DC lookups will still be done via DNS, but fallbacks to netbios names will
		not inundate your DNS servers with needless querys for DOMAIN&lt;0x1c&gt; lookups.</para>
 

<para>Default: <emphasis><parameter>name resolve order</parameter> = <literal>lmhosts wins host bcast</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>name resolve order</parameter> = <literal>lmhosts bcast host</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nbt port</primary></indexterm><anchor id="NBTPORT"/><title>

nbt port (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which port the server should use for NetBIOS over IP name
		services traffic.</para>

<para>Default: <emphasis><parameter>nbt port</parameter> = <literal>137</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nt acl support</primary></indexterm><anchor id="NTACLSUPPORT"/><title>

nt acl support (S)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle>                                       
    <manvolnum>8</manvolnum></citerefentry> will attempt to map 
    UNIX permissions into Windows NT access control lists.  The UNIX
    permissions considered are 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.</para>

<para>Default: <emphasis><parameter>nt acl support</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nt pipe support</primary></indexterm><anchor id="NTPIPESUPPORT"/><title>

nt pipe support (G)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether 
    <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> will allow Windows NT 
    clients to connect to the NT SMB specific <constant>IPC$</constant> 
    pipes. This is a developer debugging option and can be left
	alone.</para>

<para>Default: <emphasis><parameter>nt pipe support</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>nt status support</primary></indexterm><anchor id="NTSTATUSSUPPORT"/><title>

nt status support (G)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether <citerefentry><refentrytitle>smbd</refentrytitle>                                       
    <manvolnum>8</manvolnum></citerefentry> 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 <constant>no</constant> then Samba offers
    exactly the same DOS error codes that versions prior to Samba 2.2.3
    reported.</para>

    <para>You should not need to ever disable this parameter.</para>

<para>Default: <emphasis><parameter>nt status support</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>profile acls</primary></indexterm><anchor id="PROFILEACLS"/><title>

profile acls (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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
	packs do security ACL checking on the owner and ability to write of the
	profile directory stored on a local workstation when copied from a Samba
	share.
	</para>

	<para>
	When not in domain mode with winbindd then the security info copied
	onto the local workstation has no meaning to the logged in user (SID) on
	that workstation so the profile storing fails. Adding this parameter
	onto a share used for profile storage changes two things about the
	returned Windows ACL. Firstly it changes the owner and group owner
	of all reported files and directories to be BUILTIN\\Administrators,
	BUILTIN\\Users respectively (SIDs S-1-5-32-544, S-1-5-32-545). Secondly
	it adds an ACE entry of "Full Control" to the SID BUILTIN\\Users to
	every returned ACL. This will allow any Windows 2000 or XP workstation
	user to access the profile.
	</para>

	<para>
	Note that if you have multiple users logging
	on to a workstation then in order to prevent them from being able to access
	each others profiles you must remove the "Bypass traverse checking" advanced
	user right. This will prevent access to other users profile directories as
	the top level profile directory (named after the user) is created by the
	workstation profile code and has an ACL restricting entry to the directory
	tree to the owning user.
	</para>

	<para>
	Note that this parameter should be set to yes on dedicated profile shares only.
	On other shares, it might cause incorrect file ownerships.
	</para>


<para>Default: <emphasis><parameter>profile acls</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>read raw</primary></indexterm><anchor id="READRAW"/><title>

read raw (G)
</title><variablelist><varlistentry><listitem>
    <para>This is ignored if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ASYNCECHOHANDLER" xlink:href="smb.conf.5.html#ASYNCECHOHANDLER">async echo handler</link> is set,
    because this feature is incompatible with raw read SMB requests</para>

    <para>If enabled, raw reads allow reads of 65535 bytes in 
    one packet. This typically provides a major performance benefit for some very, very old clients.
    </para>

    <para>However, some clients either negotiate the allowable 
    block size incorrectly or are incapable of supporting larger block 
	sizes, and for these clients you may need to disable raw reads.</para>

<para>In general this parameter should be viewed as a system tuning 
	tool and left severely alone.</para>

<para>Default: <emphasis><parameter>read raw</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>rpc big endian</primary></indexterm><anchor id="RPCBIGENDIAN"/><title>

rpc big endian (G)
</title><variablelist><varlistentry><listitem>
	<para>Setting this option will force the RPC client and server to
		transfer data in big endian.</para>

	<para>If it is disabled, data will be transferred in little endian.</para>

	<para>The behaviour is independent of the endianness of the host machine.</para>

<para>Default: <emphasis><parameter>rpc big endian</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max protocol</primary><see>server max protocol</see></indexterm><title>

<anchor id="MAXPROTOCOL"/>max protocol
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="SERVERMAXPROTOCOL">server max protocol</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>protocol</primary><see>server max protocol</see></indexterm><title>

<anchor id="PROTOCOL"/>protocol
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="SERVERMAXPROTOCOL">server max protocol</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>server max protocol</primary></indexterm><anchor id="SERVERMAXPROTOCOL"/><title>

server max protocol (G)
</title><variablelist><varlistentry><listitem>
    <para>The value of the parameter (a string) is the highest 
    protocol level that will be supported by the server.</para>

    <para>Possible values are :</para>
    <itemizedlist>
	<listitem>
	    <para><constant>LANMAN1</constant>: First <emphasis>modern</emphasis>
	    version of the protocol. Long filename support.</para>
	</listitem>

	<listitem>
	    <para><constant>LANMAN2</constant>: Updates to Lanman1 protocol.</para>
	</listitem>

	<listitem>
	    <para><constant>NT1</constant>: Current up to date version of the protocol. 
	    Used by Windows NT. Known as CIFS.</para>
	</listitem>

	<listitem>
	    <para><constant>SMB2</constant>: Re-implementation of the SMB protocol.
	    Used by Windows Vista and later versions of Windows. SMB2 has sub protocols available.</para>
	    <itemizedlist>
		<listitem>
		    <para><constant>SMB2_02</constant>: The earliest SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_10</constant>: Windows 7 SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_22</constant>: Early Windows 8 SMB2 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB2_24</constant>: Windows 8 beta SMB2 version.</para>
		</listitem>
	    </itemizedlist>
	    <para>By default SMB2 selects the SMB2_10 variant.</para>
	</listitem>

	<listitem>
	    <para><constant>SMB3</constant>: The same as SMB2.
	    Used by Windows 8. SMB3 has sub protocols available.</para>
	    <itemizedlist>
		<listitem>
		    <para><constant>SMB3_00</constant>: Windows 8 SMB3 version. (mostly the same as SMB2_24)</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_02</constant>: Windows 8.1 SMB3 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_10</constant>: early Windows 10 technical preview SMB3 version.</para>
		</listitem>
		<listitem>
		    <para><constant>SMB3_11</constant>: Windows 10 technical preview SMB3 version (maybe final).</para>
		</listitem>
	    </itemizedlist>
	    <para>By default SMB3 selects the SMB3_11 variant.</para>
	</listitem>
    </itemizedlist>

    <para>Normally this option should not be set as the automatic 
    negotiation phase in the SMB protocol takes care of choosing 
    the appropriate protocol.</para>

<para>Default: <emphasis><parameter>server max protocol</parameter> = <literal>SMB3</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server max protocol</parameter> = <literal>LANMAN1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>min protocol</primary><see>server min protocol</see></indexterm><title>

<anchor id="MINPROTOCOL"/>min protocol
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="SERVERMINPROTOCOL">server min protocol</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>server min protocol</primary></indexterm><anchor id="SERVERMINPROTOCOL"/><title>

server min protocol (G)
</title><variablelist><varlistentry><listitem>
	<para>This setting controls the minimum protocol version that the server
	will allow the client to use.</para>

	<para>Normally this option should not be set as the automatic negotiation
	phase in the SMB protocol takes care of choosing the appropriate
	protocol.</para>

	<para>See <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERMAXPROTOCOL" xlink:href="smb.conf.5.html#SERVERMAXPROTOCOL">server max protocol</link></para> for a full list
	of available protocols.</para>

<para>Default: <emphasis><parameter>server min protocol</parameter> = <literal>LANMAN1</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server min protocol</parameter> = <literal>NT1</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>share:fake_fscaps</primary></indexterm><anchor id="SHARE:FAKE_FSCAPS"/><title>

share:fake_fscaps (G)
</title><variablelist><varlistentry><listitem>

	<para>
	This is needed to support some special application that makes
	QFSINFO calls to check whether we set the SPARSE_FILES bit
	(0x40). If this bit is not set that particular application
	refuses to work against
	Samba. With <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SHARE:FAKE_FSCAPS" xlink:href="smb.conf.5.html#SHARE:FAKE_FSCAPS">share:fake_fscaps = 64</link>
	the SPARSE_FILES file system capability flag is set. Use other
	decimal values to specify the bitmask you need to fake.
	</para>


<para>Default: <emphasis><parameter>share:fake_fscaps</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb2 max credits</primary></indexterm><anchor id="SMB2MAXCREDITS"/><title>

smb2 max credits (G)
</title><variablelist><varlistentry><listitem>
<para>This option controls the maximum number of outstanding simultaneous SMB2 operations
that Samba tells the client it will allow. This is similar to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAXMUX" xlink:href="smb.conf.5.html#MAXMUX">max mux</link>
parameter for SMB1. You should never need to set this parameter.
</para>
<para>The default is 8192 credits, which is the same as a Windows 2008R2 SMB2 server.</para>

<para>Default: <emphasis><parameter>smb2 max credits</parameter> = <literal>8192</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb2 max read</primary></indexterm><anchor id="SMB2MAXREAD"/><title>

smb2 max read (G)
</title><variablelist><varlistentry><listitem>
<para>This option specifies the protocol value that <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> will return to a client, informing the client of the largest
size that may be returned by a single SMB2 read call.
</para>
<para>The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2.</para>
<para>Please note that the default is 8MiB, but it's limit is based on the
smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB &gt;= 2.1 with LargeMTU).
Large MTU is not supported over NBT (tcp port 139).</para>

<para>Default: <emphasis><parameter>smb2 max read</parameter> = <literal>8388608</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb2 max trans</primary></indexterm><anchor id="SMB2MAXTRANS"/><title>

smb2 max trans (G)
</title><variablelist><varlistentry><listitem>
<para>This option specifies the protocol value that <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> will return to a client, informing the client of the largest
size of buffer that may be used in querying file meta-data via QUERY_INFO and related SMB2 calls.
</para>
<para>The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2.</para>
<para>Please note that the default is 8MiB, but it's limit is based on the
smb2 dialect (64KiB for SMB == 2.0, 1MiB for SMB &gt;= 2.1 with LargeMTU).
Large MTU is not supported over NBT (tcp port 139).</para>

<para>Default: <emphasis><parameter>smb2 max trans</parameter> = <literal>8388608</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb2 max write</primary></indexterm><anchor id="SMB2MAXWRITE"/><title>

smb2 max write (G)
</title><variablelist><varlistentry><listitem>
<para>This option specifies the protocol value that <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> will return to a client, informing the client of the largest
size that may be sent to the server by a single SMB2 write call.
</para>
<para>The maximum is 8388608 bytes (8MiB), which is the same as a Windows Server 2012 r2.</para>
<para>Please note that the default is 8MiB, but it's limit is based on the
smb2 dialect (64KiB for SMB == 2.0, 8MiB for SMB =&gt; 2.1 with LargeMTU).
Large MTU is not supported over NBT (tcp port 139).</para>

<para>Default: <emphasis><parameter>smb2 max write</parameter> = <literal>8388608</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb ports</primary></indexterm><anchor id="SMBPORTS"/><title>

smb ports (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which ports the server should listen on for SMB traffic.</para>

<para>Default: <emphasis><parameter>smb ports</parameter> = <literal>445 139</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>svcctl list</primary></indexterm><anchor id="SVCCTLLIST"/><title>

svcctl list (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    Unix server running Samba.</para>

    <para>The administrator must create a directory
    name <filename>svcctl</filename> in Samba's $(libdir)
    and create symbolic links to the init scripts in 
    <filename>/etc/init.d/</filename>.  The name of the links
    must match the names given as part of the <parameter>svcctl list</parameter>.
    </para>

<para>Default: <emphasis><parameter>svcctl list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>svcctl list</parameter> = <literal>cups postfix portmap httpd</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>time server</primary></indexterm><anchor id="TIMESERVER"/><title>

time server (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines if <citerefentry><refentrytitle>nmbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> advertises itself as a time server to Windows 
clients.</para>

<para>Default: <emphasis><parameter>time server</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>unicode</primary></indexterm><anchor id="UNICODE"/><title>

unicode (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies whether the server and client should support unicode.</para>

	<para>If this option is set to false, the use of ASCII will be forced.</para>

<para>Default: <emphasis><parameter>unicode</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>unix extensions</primary></indexterm><anchor id="UNIXEXTENSIONS"/><title>

unix extensions (G)
</title><variablelist><varlistentry><listitem>
    <para>This boolean parameter controls whether Samba
    implements 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.</para>
    <para>
    Note if this parameter is turned on, the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WIDELINKS" xlink:href="smb.conf.5.html#WIDELINKS">wide links</link>
    parameter will automatically be disabled.
    </para>
    <para>
    See the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ALLOWINSECUREWIDELINKS" xlink:href="smb.conf.5.html#ALLOWINSECUREWIDELINKS">allow insecure wide links</link>
    if you wish to change this coupling between the two parameters.
    </para>

<para>Default: <emphasis><parameter>unix extensions</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>use spnego</primary></indexterm><anchor id="USESPNEGO"/><title>

use spnego (G)
</title><variablelist><varlistentry><listitem>
    <para>This deprecated variable 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. 
</para>

<para>
    Unless further issues are discovered with our SPNEGO
    implementation, there is no reason this should ever be
	disabled.</para>

<para>Default: <emphasis><parameter>use spnego</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>web port</primary></indexterm><anchor id="WEBPORT"/><title>

web port (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which port the Samba web server should listen on.</para>

<para>Default: <emphasis><parameter>web port</parameter> = <literal>901</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>web port</parameter> = <literal>80</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>write raw</primary></indexterm><anchor id="WRITERAW"/><title>

write raw (G)
</title><variablelist><varlistentry><listitem>
    <para>This is ignored if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ASYNCECHOHANDLER" xlink:href="smb.conf.5.html#ASYNCECHOHANDLER">async echo handler</link> is set, 
    because this feature is incompatible with raw write SMB requests</para>

    <para>If enabled, raw writes allow writes of 65535 bytes in 
    one packet. This typically provides a major performance benefit for some very, very old clients.
    </para>

    <para>However, some clients either negotiate the allowable 
    block size incorrectly or are incapable of supporting larger block 
	sizes, and for these clients you may need to disable raw writes.</para>

<para>In general this parameter should be viewed as a system tuning 
	tool and left severely alone.</para>

<para>Default: <emphasis><parameter>write raw</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>access based share enum</primary></indexterm><anchor id="ACCESSBASEDSHAREENUM"/><title>

access based share enum (S)
</title><variablelist><varlistentry><listitem>
     <para>If this parameter is <constant>yes</constant> for a
    service, then the share hosted by the service will only be visible
    to users who have read or write access to the share during share
    enumeration (for example net view \\sambaserver). The share ACLs
    which allow or deny the access to the share can be modified using
    for example the <literal>sharesec</literal> command
    or using the appropriate Windows tools. This has
    parallels to access based enumeration, the main difference being
    that only share permissions are evaluated, and security
    descriptors on files contained on the share are not used in
    computing enumeration access rights.</para>
 
<para>Default: <emphasis><parameter>access based share enum</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>acl group control</primary></indexterm><anchor id="ACLGROUPCONTROL"/><title>

acl group control (S)
</title><variablelist><varlistentry><listitem>
	<para>
	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
 	 <emphasis>primary group owner</emphasis> of a file or directory to modify the permissions and ACLs
	on that file.
	</para>
	<para>
	On a Windows server, groups may be the owner of a file or directory - thus allowing anyone in
	that group to modify the permissions on it. This allows the delegation of security controls
	on a point in the filesystem to the group owner of a directory and anything below it also owned
	by that group. This means there are multiple people with permissions to modify ACLs on a file
	or directory, easing manageability.
	</para>
	<para>
	This parameter allows Samba to also permit delegation of the control over a point in the exported
	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.
	</para>

	<para>
	This parameter is best used with the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INHERITOWNER" xlink:href="smb.conf.5.html#INHERITOWNER">inherit owner</link> option and also
	on a share containing directories with the UNIX <emphasis>setgid bit</emphasis> set
	on them, which causes new files and directories created within it to inherit the group
	ownership from the containing directory. 
	</para>

	<para>
	This is parameter has been was deprecated in Samba 3.0.23, but re-activated in
	Samba 3.0.31 and above, as it now only controls permission changes if the user
	is in the owning primary group. It is now no longer equivalent to the
	<parameter moreinfo="none">dos filemode</parameter> option.
	</para>


<para>Default: <emphasis><parameter>acl group control</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>admin users</primary></indexterm><anchor id="ADMINUSERS"/><title>

admin users (S)
</title><variablelist><varlistentry><listitem>
    <para>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).</para>

    <para>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.</para>


<para>Default: <emphasis><parameter>admin users</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>admin users</parameter> = <literal>jason</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>algorithmic rid base</primary></indexterm><anchor id="ALGORITHMICRIDBASE"/><title>

algorithmic rid base (G)
</title><variablelist><varlistentry><listitem>
    <para>This determines how Samba will use its
    algorithmic mapping from uids/gid to the RIDs needed to construct
    NT Security Identifiers.
    </para>

    <para>Setting this option to a larger value could be useful to sites
    transitioning from WinNT and Win2k, as existing user and 
    group rids would otherwise clash with system users etc. 
    </para>

    <para>All UIDs and GIDs must be able to be resolved into SIDs for  
    the correct operation of ACLs on the server.  As such the algorithmic
    mapping can't be 'turned off', but pushing it 'out of the way' should
    resolve the issues.  Users and groups can then be assigned 'low' RIDs
    in arbitrary-rid supporting backends.
    </para>

<para>Default: <emphasis><parameter>algorithmic rid base</parameter> = <literal>1000</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>algorithmic rid base</parameter> = <literal>100000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allow trusted domains</primary></indexterm><anchor id="ALLOWTRUSTEDDOMAINS"/><title>

allow trusted domains (G)
</title><variablelist><varlistentry><listitem>
    <para>
    This option only takes effect when the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> option is set to 
    <constant>server</constant>, <constant>domain</constant> or <constant>ads</constant>.  
    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 
    in will fail, even if that domain is trusted by the remote server 
    doing the authentication.</para>
		
    <para>This is useful if you only want your Samba server to 
    serve resources to users in the domain it is a member of. As 
    an example, suppose that there are two domains DOMA and DOMB.  DOMB 
    is trusted by DOMA, which contains the Samba server.  Under normal 
    circumstances, a user with an account in DOMB can then access the 
    resources of a UNIX account with the same account name on the 
    Samba server even if they do not have an account in DOMA.  This 
    can make implementing a security boundary difficult.</para>

<para>Default: <emphasis><parameter>allow trusted domains</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>auth methods</primary></indexterm><anchor id="AUTHMETHODS"/><title>

auth methods (G)
</title><variablelist><varlistentry><listitem>

    <para>
    This option allows the administrator to chose what authentication methods <literal>smbd</literal> 
    will use when authenticating a user. This option defaults to sensible values based on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link>.  
    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.
    </para>

    <para>
    Each entry in the list attempts to authenticate the user in turn, until
    the user authenticates.  In practice only one method will ever actually 
    be able to complete the authentication.
    </para>

    <para>
    Possible options include <constant>guest</constant> (anonymous access), 
    <constant>sam</constant> (lookups in local list of accounts based on netbios 
    name or domain name), <constant>winbind</constant> (relay authentication requests
    for remote users through winbindd), <constant>ntdomain</constant> (pre-winbindd 
    method of authentication for remote domain users; deprecated in favour of winbind method), 
    <constant>trustdomain</constant> (authenticate trusted users by contacting the 
    remote DC directly from smbd; deprecated in favour of winbind method).
    </para>


<para>Default: <emphasis><parameter>auth methods</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>auth methods</parameter> = <literal>guest sam winbind</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>check password script</primary></indexterm><anchor id="CHECKPASSWORDSCRIPT"/><title>

check password script (G)
</title><variablelist><varlistentry><listitem>
    <para>The name of a program that can be used to check password
    complexity. The password is sent to the program's standard input.</para>
 
    <para>The program must return 0 on a good password, or any other value
    if the password is bad.
    In case the password is considered weak (the program does not return 0) the
    user will be notified and the password change will fail.</para>

    <para>Note: In the example directory is a sample program called <literal>crackcheck</literal>
    that uses cracklib to check the password quality.</para>


<para>Default: <emphasis><parameter>check password script</parameter> = <literal>
# Disabled</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>check password script</parameter> = <literal>/usr/local/sbin/crackcheck</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client lanman auth</primary></indexterm><anchor id="CLIENTLANMANAUTH"/><title>

client lanman auth (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not <citerefentry><refentrytitle>smbclient</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> 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 
    Windows 95/98) will be able to be connected from the Samba client.</para>

    <para>The LANMAN encrypted response is easily broken, due to its
    case-insensitive nature, and the choice of algorithm.  Clients
    without Windows 95/98 servers are advised to disable
    this option.  </para>

    <para>Disabling this option will also disable the <literal>client plaintext auth</literal> option.</para>

    <para>Likewise, if the <literal>client ntlmv2
    auth</literal> parameter is enabled, then only NTLMv2 logins will be
    attempted.</para>

<para>Default: <emphasis><parameter>client lanman auth</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client NTLMv2 auth</primary></indexterm><anchor id="CLIENTNTLMV2AUTH"/><title>

client NTLMv2 auth (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not <citerefentry><refentrytitle>smbclient</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> will attempt to
    authenticate itself to servers using the NTLMv2 encrypted password
    response.</para>

    <para>If enabled, only an NTLMv2 and LMv2 response (both much more
    secure than earlier versions) will be sent.  Older servers
    (including NT4 &lt; SP4, Win9x and Samba 2.2) are not compatible with
    NTLMv2 when not in an NTLMv2 supporting domain</para>

    <para>Similarly, if enabled, NTLMv1, <literal>client lanman auth</literal> and <literal>client plaintext auth</literal>
    authentication will be disabled.  This also disables share-level 
    authentication. </para>

    <para>If disabled, an NTLM response (and possibly a LANMAN response)
    will be sent by the client, depending on the value of <literal>client lanman auth</literal>.  </para>

    <para>Note that Windows Vista and later versions already use
    NTLMv2 by default, and some sites (particularly those following
    'best practice' security polices) only allow NTLMv2 responses, and
    not the weaker LM or NTLM.</para>

<para>Default: <emphasis><parameter>client NTLMv2 auth</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client plaintext auth</primary></indexterm><anchor id="CLIENTPLAINTEXTAUTH"/><title>

client plaintext auth (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies whether a client should send a plaintext 
		password if the server does not support encrypted passwords.</para>

<para>Default: <emphasis><parameter>client plaintext auth</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>

<section><indexterm significance="preferred"><primary>client schannel</primary></indexterm><anchor id="CLIENTSCHANNEL"/><title>

client schannel (G)
</title><variablelist><varlistentry><listitem>

    <para>
    This controls whether the client offers or even demands the use of the netlogon schannel.
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = no</link> does not offer the schannel, 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = auto</link> offers the schannel but does not
    enforce it, and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = yes</link> denies access 
    if the server is not able to speak netlogon schannel. 
    </para>

    <para>Note that for active directory domains this is hardcoded to
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = yes</link>.</para>

    <para>This option yields precedence to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="REQUIRESTRONGKEY" xlink:href="smb.conf.5.html#REQUIRESTRONGKEY">require strong key</link> option.</para>

<para>Default: <emphasis><parameter>client schannel</parameter> = <literal>auto</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>client schannel</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client signing</primary></indexterm><anchor id="CLIENTSIGNING"/><title>

client signing (G)
</title><variablelist><varlistentry><listitem>
    <para>This controls whether the client is allowed or required to use SMB signing. Possible values 
    are <emphasis>auto</emphasis>, <emphasis>mandatory</emphasis> 
    and <emphasis>disabled</emphasis>. 
    </para>

    <para>When set to auto or default, SMB signing is offered, but not
    enforced, except in winbindd, where it is enforced to Active
    Directory Domain Controllers. </para>

    <para>When set to mandatory, SMB signing is required and if set
	to disabled, SMB signing is not offered either.
</para>

<para>Default: <emphasis><parameter>client signing</parameter> = <literal>default</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>client use spnego principal</primary></indexterm><anchor id="CLIENTUSESPNEGOPRINCIPAL"/><title>

client use spnego principal (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not
    <citerefentry><refentrytitle>smbclient</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> and other samba components
    acting as a client will attempt to use the server-supplied
    principal sometimes given in the SPNEGO exchange.</para>

    <para>If enabled, Samba can attempt to use Kerberos to contact
    servers known only by IP address.  Kerberos relies on names, so
    ordinarily cannot function in this situation. </para>

    <para>This is a VERY BAD IDEA for security reasons, and so this
    parameter SHOULD NOT BE USED. It will be removed in a future
    version of Samba.</para>

    <para>If disabled, Samba will use the name used to look up the
    server when asking the KDC for a ticket.  This avoids situations
    where a server may impersonate another, soliciting authentication
    as one principal while being known on the network as another.
    </para>

    <para>Note that Windows XP SP2 and later versions already follow
    this behaviour, and Windows Vista and later servers no longer
    supply this 'rfc4178 hint' principal on the server side.</para>

    <para>This parameter is deprecated in Samba 4.2.1 and will be removed
    (along with the functionality) in a later release of Samba.</para>

<para>Default: <emphasis><parameter>client use spnego principal</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>create mode</primary><see>create mask</see></indexterm><title>

<anchor id="CREATEMODE"/>create mode
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="CREATEMASK">create mask</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>create mask</primary></indexterm><anchor id="CREATEMASK"/><title>

create mask (S)
</title><variablelist><varlistentry><listitem>
    <para>
	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 <emphasis>not</emphasis> set here will
	be removed from the modes set on a file when it is created.
	</para>

    <para>
	The default value of this parameter removes the <literal>group</literal> and <literal>other</literal>
	write and execute bits from the UNIX modes.
	</para>

    <para>
	Following this Samba will bit-wise 'OR' the UNIX mode created from this parameter with the value of the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="FORCECREATEMODE" xlink:href="smb.conf.5.html#FORCECREATEMODE">force create mode</link> parameter which is set to 000 by default.
	</para>

    <para>
	This parameter does not affect directory masks. See the parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DIRECTORYMASK" xlink:href="smb.conf.5.html#DIRECTORYMASK">directory mask</link>
	for details.
	</para>

<para>Default: <emphasis><parameter>create mask</parameter> = <literal>0744</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>create mask</parameter> = <literal>0775</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dedicated keytab file</primary></indexterm><anchor id="DEDICATEDKEYTABFILE"/><title>

dedicated keytab file (G)
</title><variablelist><varlistentry><listitem>
	<para>
	  Specifies the path to the kerberos keytab file when
	  <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="KERBEROSMETHOD" xlink:href="smb.conf.5.html#KERBEROSMETHOD">kerberos method</link> is set to "dedicated
	  keytab".
	</para>

<para>Default: <emphasis><parameter>dedicated keytab file</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>dedicated keytab file</parameter> = <literal>/usr/local/etc/krb5.keytab</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>

<section><indexterm significance="preferred"><primary>directory mode</primary><see>directory mask</see></indexterm><title>

<anchor id="DIRECTORYMODE"/>directory mode
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="DIRECTORYMASK">directory mask</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>directory mask</primary></indexterm><anchor id="DIRECTORYMASK"/><title>

directory mask (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter is the octal modes which are 
    used when converting DOS modes to UNIX modes when creating UNIX 
    directories.</para>

    <para>When a directory 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 directory. Any bit <emphasis>not</emphasis> set 
    here will be removed from the modes set on a directory when it is 
    created.</para>

    <para>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.</para>
		
    <para>Following this Samba will bit-wise 'OR' the UNIX mode 
    created from this parameter with the value of the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="FORCEDIRECTORYMODE" xlink:href="smb.conf.5.html#FORCEDIRECTORYMODE">force directory mode</link> parameter. 
    This parameter is set to 000 by default (i.e. no extra mode bits are added).</para>

<para>Default: <emphasis><parameter>directory mask</parameter> = <literal>0755</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>directory mask</parameter> = <literal>0775</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>directory security mask</primary></indexterm><anchor id="DIRECTORYSECURITYMASK"/><title>

directory security mask (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter has been removed for Samba 4.0.0.
    </para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>encrypt passwords</primary></indexterm><anchor id="ENCRYPTPASSWORDS"/><title>

encrypt passwords (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    Samba see the chapter "User Database" in the Samba HOWTO Collection.
    </para>

    <para>
    MS Windows clients that expect Microsoft encrypted passwords and that
    do not have plain text password support enabled will be able to
    connect only to a Samba server that has encrypted password support
    enabled and for which the user accounts have a valid encrypted password.
    Refer to the smbpasswd command man page for information regarding the
    creation of encrypted passwords for user accounts.
    </para>

    <para>
    The use of plain text passwords is NOT advised as support for this feature
    is no longer maintained in Microsoft Windows products. If you want to use
    plain text passwords you must set this parameter to no.
    </para>

    <para>In order for encrypted passwords to work correctly
    <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> must either 
    have access to a local <citerefentry><refentrytitle>smbpasswd</refentrytitle>
    <manvolnum>5</manvolnum></citerefentry> file (see the <citerefentry><refentrytitle>smbpasswd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> program for information on how to set up 
    and maintain this file), or set the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security = [domain|ads]</link> parameter which
    causes <literal>smbd</literal> to authenticate against another 
	server.</para>

<para>Default: <emphasis><parameter>encrypt passwords</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force create mode</primary></indexterm><anchor id="FORCECREATEMODE"/><title>

force create mode (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies a set of UNIX mode bit
    permissions that will <emphasis>always</emphasis> 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. The default for this parameter is (in octal)
    000. The modes in this parameter are bitwise 'OR'ed onto the file
    mode after the mask set in the <parameter moreinfo="none">create mask</parameter>
    parameter is applied.</para>

    <para>The example below would force all newly created files to have read and execute
    permissions set for 'group' and 'other' as well as the
    read/write/execute bits set for the 'user'.</para>


<para>Default: <emphasis><parameter>force create mode</parameter> = <literal>0000</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>force create mode</parameter> = <literal>0755</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force directory mode</primary></indexterm><anchor id="FORCEDIRECTORYMODE"/><title>

force directory mode (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter specifies a set of UNIX mode bit 
    permissions that will <emphasis>always</emphasis> 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 
    parameter is (in octal) 0000 which will not add any extra permission 
    bits to a created directory. This operation is done after the mode 
    mask in the parameter <parameter moreinfo="none">directory mask</parameter> is 
    applied.</para>

	<para>The example below would force all created directories to have read and execute
    permissions set for 'group' and 'other' as well as the
    read/write/execute bits set for the 'user'.</para>

<para>Default: <emphasis><parameter>force directory mode</parameter> = <literal>0000</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>force directory mode</parameter> = <literal>0755</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force directory security mode</primary></indexterm><anchor id="FORCEDIRECTORYSECURITYMODE"/><title>

force directory security mode (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter has been removed for Samba 4.0.0.
    </para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>group</primary><see>force group</see></indexterm><title>

<anchor id="GROUP"/>group
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="FORCEGROUP">force group</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>force group</primary></indexterm><anchor id="FORCEGROUP"/><title>

force group (S)
</title><variablelist><varlistentry><listitem>
    <para>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 
    their permissions checking. Thus, by assigning permissions for this 
    group to the files and directories within this service the Samba 
    administrator can restrict or allow sharing of these files.</para>

    <para>In Samba 2.0.5 and above this parameter has extended 
    functionality in the following way. If the group name listed here 
    has a '+' character prepended to it then the current user accessing 
    the share only has the primary group default assigned to this group 
    if they are already assigned as a member of that group. This allows 
    an administrator to decide that only users who are already in a 
    particular group will create files with group ownership set to that 
    group. This gives a finer granularity of ownership assignment. For 
    example, the setting <filename moreinfo="none">force group = +sys</filename> means 
    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.</para>

    <para>
	If the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="FORCEUSER" xlink:href="smb.conf.5.html#FORCEUSER">force user</link> parameter is also set the group specified in 
    <parameter moreinfo="none">force group</parameter> will override the primary group
    set in <parameter moreinfo="none">force user</parameter>.</para>


<para>Default: <emphasis><parameter>force group</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>force group</parameter> = <literal>agroup</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force security mode</primary></indexterm><anchor id="FORCESECURITYMODE"/><title>

force security mode (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter has been removed for Samba 4.0.0.
    </para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force unknown acl user</primary></indexterm><anchor id="FORCEUNKNOWNACLUSER"/><title>

force unknown acl user (S)
</title><variablelist><varlistentry><listitem>
    <para>
    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.
    </para>

    <para>
    This is designed to allow Windows NT clients to copy files and folders containing ACLs that were 
    created locally on the client machine and contain users local to that machine only (no domain
    users) to be copied to a Samba server (usually with XCOPY /O) and have the unknown userid and 
    groupid of the file owner map to the current connected user.  This can only be fixed correctly
    when winbindd allows arbitrary mapping from any Windows NT SID to a UNIX uid or gid.
    </para>

    <para>
    Try using this parameter when XCOPY /O gives an ACCESS_DENIED error.
    </para>

<para>Default: <emphasis><parameter>force unknown acl user</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>force user</primary></indexterm><anchor id="FORCEUSER"/><title>

force user (S)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

    <para>This user name only gets used once a connection is established. 
    Thus clients still need to connect as a valid user and supply a 
    valid password. Once connected, all file operations will be performed 
    as the "forced user", no matter what username the client connected 
    as.  This can be very useful.</para>

    <para>In Samba 2.0.5 and above this parameter also causes the 
    primary group of the forced user to be used as the primary group 
    for all file activity. Prior to 2.0.5 the primary group was left 
    as the primary group of the connecting user (this was a bug).</para>


<para>Default: <emphasis><parameter>force user</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>force user</parameter> = <literal>auser</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>guest account</primary></indexterm><anchor id="GUESTACCOUNT"/><title>

guest account (G)
</title><variablelist><varlistentry><listitem>
    <para>This is a username which will be used for access 
    to services which are specified as <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok</link> (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 
    for this parameter. 
    </para>

    <para>On some systems the default guest account "nobody" may not 
    be able to print. Use another account in this case. You should test 
    this by trying to log in as your guest user (perhaps by using the 
    <literal>su -</literal> command) and trying to print using the 
    system print command such as <literal>lpr(1)</literal> or <literal>
    lp(1)</literal>.</para>

    <para>This parameter does not accept % macros, because
    many parts of the system require this value to be
	constant for correct operation.</para>

<para>Default: <emphasis><parameter>guest account</parameter> = <literal>nobody
# default can be changed at compile-time</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>guest account</parameter> = <literal>ftp</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>public</primary><see>guest ok</see></indexterm><title>

<anchor id="PUBLIC"/>public
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="GUESTOK">guest ok</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>guest ok</primary></indexterm><anchor id="GUESTOK"/><title>

guest ok (S)
</title><variablelist><varlistentry><listitem>
    <para>If this parameter is <constant>yes</constant> for 
    a service, then no password is required to connect to the service. 
    Privileges will be those of the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>.</para>

    <para>This parameter nullifies the benefits of setting
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="RESTRICTANONYMOUS" xlink:href="smb.conf.5.html#RESTRICTANONYMOUS">restrict anonymous = 2</link>
	</para>

    <para>See the section below on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> for more information about this option.
	</para>

<para>Default: <emphasis><parameter>guest ok</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>only guest</primary><see>guest only</see></indexterm><title>

<anchor id="ONLYGUEST"/>only guest
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="GUESTONLY">guest only</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>guest only</primary></indexterm><anchor id="GUESTONLY"/><title>

guest only (S)
</title><variablelist><varlistentry><listitem>
    <para>If this parameter is <constant>yes</constant> for 
    a service, then only guest connections to the service are permitted. 
    This parameter will have no effect if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok</link> is not set for the service.</para>

    <para>See the section below on <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> for more information about this option.
	</para>

<para>Default: <emphasis><parameter>guest only</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allow hosts</primary><see>hosts allow</see></indexterm><title>

<anchor id="ALLOWHOSTS"/>allow hosts
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="HOSTSALLOW">hosts allow</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>hosts allow</primary></indexterm><anchor id="HOSTSALLOW"/><title>

hosts allow (S)
</title><variablelist><varlistentry><listitem>
    <para>A synonym for this parameter is <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ALLOWHOSTS" xlink:href="smb.conf.5.html#ALLOWHOSTS">allow hosts</link>.</para>
		
    <para>This parameter is a comma, space, or tab delimited 
    set of hosts which are permitted to access a service.</para>

    <para>If specified in the [global] section then it will
    apply to all services, regardless of whether the individual 
    service has a different setting.</para>

    <para>You can specify the hosts by name or IP number. For 
    example, you could restrict access to only the hosts on a 
    Class C subnet with something like <literal>allow hosts = 150.203.5.</literal>.
	The full syntax of the list is described in the man 
    page <filename>hosts_access(5)</filename>. Note that this man
    page may not be present on your system, so a brief description will
    be given here also.</para>

    <para>Note that the localhost address 127.0.0.1 will always 
    be allowed access unless specifically denied by a <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="HOSTSDENY" xlink:href="smb.conf.5.html#HOSTSDENY">hosts deny</link> option.</para>

    <para>You can also specify hosts by network/netmask pairs and 
    by netgroup names if your system supports netgroups. The 
    <emphasis>EXCEPT</emphasis> keyword can also be used to limit a 
    wildcard list. The following examples may provide some help:</para>

<para>Example 1: allow all IPs in 150.203.*.*; except one</para>

    <para><literal>hosts allow = 150.203. EXCEPT 150.203.6.66</literal></para>

    <para>Example 2: allow hosts that match the given network/netmask</para>

    <para><literal>hosts allow = 150.203.15.0/255.255.255.0</literal></para>

    <para>Example 3: allow a couple of hosts</para>

    <para><literal>hosts allow = lapland, arvidsjaur</literal></para>

    <para>Example 4: allow only hosts in NIS netgroup "foonet", but 
    deny access from one particular host</para>

    <para><literal>hosts allow = @foonet</literal></para>

    <para><literal>hosts deny = pirate</literal></para>

    <note><para>Note that access still requires suitable user-level passwords.</para></note>

    <para>See <citerefentry><refentrytitle>testparm</refentrytitle>
    <manvolnum>1</manvolnum></citerefentry> for a way of testing your host access 
    to see if it does what you expect.</para>

		

<para>Default: <emphasis><parameter>hosts allow</parameter> = <literal>
# none (i.e., all hosts permitted access)</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>hosts allow</parameter> = <literal>150.203.5. myhost.mynet.edu.au</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>deny hosts</primary><see>hosts deny</see></indexterm><title>

<anchor id="DENYHOSTS"/>deny hosts
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="HOSTSDENY">hosts deny</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>hosts deny</primary></indexterm><anchor id="HOSTSDENY"/><title>

hosts deny (S)
</title><variablelist><varlistentry><listitem>
    <para>The opposite of <parameter moreinfo="none">hosts allow</parameter> 
    - hosts listed here are <emphasis>NOT</emphasis> permitted access to 
    services unless the specific services have their own lists to override 
    this one. Where the lists conflict, the <parameter moreinfo="none">allow</parameter> 
	list takes precedence.</para>

	<para>
	In the event that it is necessary to deny all by default, use the keyword
	ALL (or the netmask <literal>0.0.0.0/0</literal>) and then explicitly specify
	to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="HOSTSALLOW" xlink:href="smb.conf.5.html#HOSTSALLOW">hosts allow = hosts allow</link> parameter those hosts
	that should be permitted access.
	</para>

<para>Default: <emphasis><parameter>hosts deny</parameter> = <literal>
# none (i.e., no hosts specifically excluded)</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>hosts deny</parameter> = <literal>150.203.4. badhost.mynet.edu.au</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>inherit acls</primary></indexterm><anchor id="INHERITACLS"/><title>

inherit acls (S)
</title><variablelist><varlistentry><listitem>
    <para>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. 
    Enabling this option sets the unix mode to 0777, thus guaranteeing that 
    default directory acls are propagated.

    Note that using the VFS modules acl_xattr or acl_tdb which store native
    Windows as meta-data will automatically turn this option on for any
    share for which they are loaded, as they require this option to emulate
    Windows ACLs correctly.
</para>

<para>Default: <emphasis><parameter>inherit acls</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>inherit owner</primary></indexterm><anchor id="INHERITOWNER"/><title>

inherit owner (S)
</title><variablelist><varlistentry><listitem>
	<para>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
	by the ownership of the parent directory.</para>
	
	<para>Common scenarios where this behavior is useful is in 
	implementing drop-boxes, where users can create and edit files but
	not delete them and ensuring that newly created files in a user's
	roaming profile directory are actually owned by the user.</para>

<para>Default: <emphasis><parameter>inherit owner</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>inherit permissions</primary></indexterm><anchor id="INHERITPERMISSIONS"/><title>

inherit permissions (S)
</title><variablelist><varlistentry><listitem>
    <para>
	The permissions on new files and directories are normally governed by <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CREATEMASK" xlink:href="smb.conf.5.html#CREATEMASK">create mask</link>,
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DIRECTORYMASK" xlink:href="smb.conf.5.html#DIRECTORYMASK">directory mask</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="FORCECREATEMODE" xlink:href="smb.conf.5.html#FORCECREATEMODE">force create mode</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="FORCEDIRECTORYMODE" xlink:href="smb.conf.5.html#FORCEDIRECTORYMODE">force directory mode</link> but the boolean inherit permissions parameter overrides this.
	</para>
		
    <para>New directories inherit the mode of the parent directory,
    including bits such as setgid.</para>

    <para>
	New files inherit their read/write bits from the parent directory.  Their execute bits continue to be
	determined by <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPARCHIVE" xlink:href="smb.conf.5.html#MAPARCHIVE">map archive</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPHIDDEN" xlink:href="smb.conf.5.html#MAPHIDDEN">map hidden</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPSYSTEM" xlink:href="smb.conf.5.html#MAPSYSTEM">map system</link> as usual.
	</para>

    <para>Note that the setuid bit is <emphasis>never</emphasis> set via 
    inheritance (the code explicitly prohibits this).</para>

    <para>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.</para>

<para>Default: <emphasis><parameter>inherit permissions</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>invalid users</primary></indexterm><anchor id="INVALIDUSERS"/><title>

invalid users (S)
</title><variablelist><varlistentry><listitem>
    <para>This is a list of users that should not be allowed 
    to login to this service. This is really a <emphasis>paranoid</emphasis> 
    check to absolutely ensure an improper setting does not breach 
    your security.</para>
		
    <para>A name starting with a '@' is interpreted as an NIS 
    netgroup first (if your system supports NIS), and then as a UNIX 
    group if the name was not found in the NIS netgroup database.</para>

    <para>A name starting with '+' is interpreted only 
    by looking in the UNIX group database via the NSS getgrnam() interface. A name starting with 
    '&amp;' is interpreted only by looking in the NIS netgroup database 
    (this requires NIS to be working on your system). The characters 
    '+' and '&amp;' may be used at the start of the name in either order 
    so the value <parameter moreinfo="none">+&amp;group</parameter> means check the 
    UNIX group database, followed by the NIS netgroup database, and 
    the value <parameter moreinfo="none">&amp;+group</parameter> means check the NIS
    netgroup database, followed by the UNIX group database (the 
    same as the '@' prefix).</para>

    <para>The current servicename is substituted for <parameter moreinfo="none">%S</parameter>. 
		This is useful in the [homes] section.</para>

<para>Default: <emphasis><parameter>invalid users</parameter> = <literal>
# no invalid users</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>invalid users</parameter> = <literal>root fred admin @wheel</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>kerberos method</primary></indexterm><anchor id="KERBEROSMETHOD"/><title>

kerberos method (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Controls how kerberos tickets are verified.
	</para>

	<para>Valid options are:</para>
	<itemizedlist>
	  <listitem><para>secrets only - use only the secrets.tdb for
	  ticket verification (default)</para></listitem>

	  <listitem><para>system keytab - use only the system keytab
	  for ticket verification</para></listitem>

	  <listitem><para>dedicated keytab - use a dedicated keytab
	  for ticket verification</para></listitem>

	  <listitem><para>secrets and keytab - use the secrets.tdb
	  first, then the system keytab</para></listitem>
	</itemizedlist>

	<para>
	  The major difference between "system keytab" and "dedicated
	  keytab" is that the latter method relies on kerberos to find the
	  correct keytab entry instead of filtering based on expected
	  principals.
	</para>

	<para>
	  When the kerberos method is in "dedicated keytab" mode,
	  <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEDICATEDKEYTABFILE" xlink:href="smb.conf.5.html#DEDICATEDKEYTABFILE">dedicated keytab file</link> must be set to
	  specify the location of the keytab file.
	</para>

<para>Default: <emphasis><parameter>kerberos method</parameter> = <literal>default</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>kpasswd port</primary></indexterm><anchor id="KPASSWDPORT"/><title>

kpasswd port (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which ports the Kerberos server should listen on for
		password changes.</para>

<para>Default: <emphasis><parameter>kpasswd port</parameter> = <literal>464</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>krb5 port</primary></indexterm><anchor id="KRB5PORT"/><title>

krb5 port (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies which port the KDC should listen on for Kerberos traffic.</para>

<para>Default: <emphasis><parameter>krb5 port</parameter> = <literal>88</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>lanman auth</primary></indexterm><anchor id="LANMANAUTH"/><title>

lanman auth (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> 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 
    Windows 95/98 or the MS DOS network client) will be able to
    connect to the Samba host.</para>

    <para>The LANMAN encrypted response is easily broken, due to its
    case-insensitive nature, and the choice of algorithm.  Servers
    without Windows 95/98/ME or MS DOS clients are advised to disable
    this option.  </para>

    <para>When this parameter is set to <literal>no</literal> this
    will also result in sambaLMPassword in Samba's passdb being
    blanked after the next password change. As a result of that
    lanman clients won't be able to authenticate, even if lanman
    auth is reenabled later on.
    </para>
		
    <para>Unlike the <literal>encrypt
    passwords</literal> option, this parameter cannot alter client
    behaviour, and the LANMAN response will still be sent over the
    network.  See the <literal>client lanman
    auth</literal> to disable this for Samba's clients (such as smbclient)</para>

    <para>If this option, and <literal>ntlm
    auth</literal> are both disabled, then only NTLMv2 logins will be
    permited.  Not all clients support NTLMv2, and most will require
    special configuration to use it.</para>

<para>Default: <emphasis><parameter>lanman auth</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>log nt token command</primary></indexterm><anchor id="LOGNTTOKENCOMMAND"/><title>

log nt token command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option can be set to a command that will be called when new nt
		tokens are created.</para>

	<para>This is only useful for development purposes.</para>

<para>Default: <emphasis><parameter>log nt token command</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map to guest</primary></indexterm><anchor id="MAPTOGUEST"/><title>

map to guest (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter can take four different values, which tell
    <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> what to do with user 
    login requests that don't match a valid UNIX user in some way.</para>

    <para>The four settings are :</para>

    <itemizedlist>
	<listitem>
	    <para><constant>Never</constant> - Means user login 
	    requests with an invalid password are rejected. This is the 
	    default.</para>
	</listitem>
			
	<listitem>
	    <para><constant>Bad User</constant> - 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>.</para>
	</listitem>

	<listitem>
	    <para><constant>Bad Password</constant> - Means user logins 
	    with an invalid password are treated as a guest login and mapped 
	    into the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>. 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
	    they should - there will have been no message given to them
	    that they got their password wrong. Helpdesk services will
	    <emphasis>hate</emphasis> you if you set the <parameter moreinfo="none">map to 
	    guest</parameter> parameter this way :-).</para>
	</listitem>
	<listitem>
	    <para><constant>Bad Uid</constant> - Is only applicable when Samba is configured
	    in some type of domain mode security (security = {domain|ads}) and means that
	    user logins which are successfully authenticated but which have no valid Unix
	    user account (and smbd is unable to create one) should be mapped to the defined
	    guest account. This was the default behavior of Samba 2.x releases.  Note that 
	    if a member server is running winbindd,  this option should never be required
	    because the nss_winbind library will export the Windows domain users and groups
	    to the underlying OS via the Name Service Switch interface.</para>
	</listitem>
    </itemizedlist>

    <para>Note that this parameter is needed to set up "Guest" 
    share services. This is because in these modes the name of the resource being
    requested is <emphasis>not</emphasis> sent to the server until after 
    the server has successfully authenticated the client so the server 
    cannot make authentication decisions at the correct time (connection 
    to the share) for "Guest" shares. </para>

<para>Default: <emphasis><parameter>map to guest</parameter> = <literal>Never</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>map to guest</parameter> = <literal>Bad User</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>map untrusted to domain</primary></indexterm><anchor id="MAPUNTRUSTEDTODOMAIN"/><title>

map untrusted to domain (G)
</title><variablelist><varlistentry><listitem>
    <para>
    If a client connects to smbd using an untrusted domain name, such as
    BOGUS\user, smbd replaces the BOGUS domain with it's SAM name before
    attempting to authenticate that user.  In the case where smbd is acting as
    a PDC this will be DOMAIN\user.  In the case where smbd is acting as a
    domain member server or a standalone server this will be WORKSTATION\user.
    </para>

    <para>
    In previous versions of Samba (pre 3.4), if smbd was acting as a domain
    member server, the BOGUS domain name would instead be replaced by the
    primary domain which smbd was a member of.  In this case authentication
    would be deferred off to a DC using the credentials DOMAIN\user.
    </para>

    <para>
    When this parameter is set to <constant>yes</constant> smbd provides the
    legacy behavior of mapping untrusted domain names to the primary domain.
    When smbd is not acting as a domain member server, this parameter has no
    effect.
    </para>


<para>Default: <emphasis><parameter>map untrusted to domain</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ntlm auth</primary></indexterm><anchor id="NTLMAUTH"/><title>

ntlm auth (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter determines whether or not <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> 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.</para>

    <para>If this option, and <literal>lanman
    auth</literal> are both disabled, then only NTLMv2 logins will be
    permited.  Not all clients support NTLMv2, and most will require
	special configuration to use it.</para>

<para>Default: <emphasis><parameter>ntlm auth</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ntp signd socket directory</primary></indexterm><anchor id="NTPSIGNDSOCKETDIRECTORY"/><title>

ntp signd socket directory (G)
</title><variablelist><varlistentry><listitem>
	<para>This setting controls the location of the socket that
		the NTP daemon uses to communicate with Samba for
		signing packets.</para>

	<para>If a non-default path is specified here, then it is also necessary
		to make NTP aware of the new path using the <constant>ntpsigndsocket</constant>
		directive in <filename>ntp.conf</filename>.</para>

<para>Default: <emphasis><parameter>ntp signd socket directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/lib/ntp_signd</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>null passwords</primary></indexterm><anchor id="NULLPASSWORDS"/><title>

null passwords (G)
</title><variablelist><varlistentry><listitem>
    <para>Allow or disallow client access to accounts that have null passwords. </para>

    <para>See also <citerefentry><refentrytitle>smbpasswd</refentrytitle>
			<manvolnum>5</manvolnum></citerefentry>.</para>

<para>Default: <emphasis><parameter>null passwords</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>obey pam restrictions</primary></indexterm><anchor id="OBEYPAMRESTRICTIONS"/><title>

obey pam restrictions (G)
</title><variablelist><varlistentry><listitem>
    <para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = yes</link>.  The reason 
    is that PAM modules cannot support the challenge/response
    authentication mechanism needed in the presence of SMB password encryption.
</para>

<para>Default: <emphasis><parameter>obey pam restrictions</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>old password allowed period</primary></indexterm><anchor id="OLDPASSWORDALLOWEDPERIOD"/><title>

old password allowed period (G)
</title><variablelist><varlistentry><listitem>
    <para>Number of minutes to permit an NTLM login after a password change or reset using the old password.  This allows the user to re-cache the new password on multiple clients without disrupting a network reconnection in the meantime. </para>

    <para>This parameter only applies when <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERROLE" xlink:href="smb.conf.5.html#SERVERROLE">server role</link> is set to Active Directory Domain Controller</para>

<para>Default: <emphasis><parameter>old password allowed period</parameter> = <literal>60</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>only user</primary></indexterm><anchor id="ONLYUSER"/><title>

only user (S)
</title><variablelist><varlistentry><listitem>
    <para>To restrict a service to a particular set of users you
    can use the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VALIDUSERS" xlink:href="smb.conf.5.html#VALIDUSERS">valid users</link> parameter.</para>

    <para>This parameter is deprecated</para>

    <para>However, it currently operates only in conjunction with
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAME" xlink:href="smb.conf.5.html#USERNAME">username</link>.  The supported way to restrict
    a service to a particular set of users is the
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VALIDUSERS" xlink:href="smb.conf.5.html#VALIDUSERS">valid users</link> parameter.</para>


<para>Default: <emphasis><parameter>only user</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>pam password change</primary></indexterm><anchor id="PAMPASSWORDCHANGE"/><title>

pam password change (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWDPROGRAM" xlink:href="smb.conf.5.html#PASSWDPROGRAM">passwd program</link>. 
    It should be possible to enable this without changing your 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWDCHAT" xlink:href="smb.conf.5.html#PASSWDCHAT">passwd chat</link> parameter for most setups.</para>

<para>Default: <emphasis><parameter>pam password change</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passdb backend</primary></indexterm><anchor id="PASSDBBACKEND"/><title>

passdb backend (G)
</title><variablelist><varlistentry><listitem>

    <para>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 different storage mechanisms without recompile. </para>

    <para>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.</para>

    <para>Available backends can include:
	<itemizedlist>
	    <listitem>
		<para><literal>smbpasswd</literal> - The old plaintext passdb
		backend. Some Samba features will not work if this passdb
		backend is used. Takes a path to the smbpasswd file as an
		optional argument.
		</para>
	    </listitem>
			
	    <listitem>
		<para><literal>tdbsam</literal> - The TDB based password storage
                backend.  Takes a path to the TDB as an optional argument (defaults to passdb.tdb 
                in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> directory.</para>
	    </listitem>
			
	    <listitem>
		<para><literal>ldapsam</literal> - The LDAP based passdb 
                backend.  Takes an LDAP URL as an optional argument (defaults to 
                <literal>ldap://localhost</literal>)</para>
			
		<para>LDAP connections should be secured where possible.  This may be done using either
                Start-TLS (see <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LDAPSSL" xlink:href="smb.conf.5.html#LDAPSSL">ldap ssl</link>) or by
                specifying <parameter moreinfo="none">ldaps://</parameter> in
                the URL argument. </para>

                <para>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.
		</para>

	    </listitem>
	</itemizedlist>

    </para>
	Examples of use are:
<programlisting>
passdb backend = tdbsam:/etc/samba/private/passdb.tdb 

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"
</programlisting>

<para>Default: <emphasis><parameter>passdb backend</parameter> = <literal>tdbsam</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passdb expand explicit</primary></indexterm><anchor id="PASSDBEXPANDEXPLICIT"/><title>

passdb expand explicit (G)
</title><variablelist><varlistentry><listitem>
    <para>
	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.
    </para>

<para>Default: <emphasis><parameter>passdb expand explicit</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passwd chat</primary></indexterm><anchor id="PASSWDCHAT"/><title>

passwd chat (G)
</title><variablelist><varlistentry><listitem>
    <para>This string controls the <emphasis>"chat"</emphasis> 
    conversation that takes places between <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> and the local password changing
    program to change the user's password. The string describes a 
    sequence of response-receive pairs that <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> uses to determine what to send to the 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWDPROGRAM" xlink:href="smb.conf.5.html#PASSWDPROGRAM">passwd program</link> and what to expect back. If the expected output is not 
    received then the password is not changed.</para>

    <para>This chat sequence is often quite site specific, depending 
    on what local methods are used for password control (such as NIS 
    etc).</para>

    <para>Note that this parameter only is used if the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="UNIXPASSWORDSYNC" xlink:href="smb.conf.5.html#UNIXPASSWORDSYNC">unix password sync</link> parameter is set  to <constant>yes</constant>. This sequence is 
    then called <emphasis>AS ROOT</emphasis> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWDPROGRAM" xlink:href="smb.conf.5.html#PASSWDPROGRAM">passwd program</link> must
    be executed on the NIS master.
    </para>

    <para>The string can contain the macro <parameter moreinfo="none">%n</parameter> which is substituted 
    for the new password.  The old passsword (<parameter moreinfo="none">%o</parameter>) is only available when
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</link> 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 
    a '*' which matches any sequence of characters. Double quotes can 
    be used to collect strings with spaces in them into a single 
    string.</para>

    <para>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.</para>

    <para>If the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PAMPASSWORDCHANGE" xlink:href="smb.conf.5.html#PAMPASSWORDCHANGE">pam password change</link> parameter is set to <constant>yes</constant>, 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.
    </para>


<para>Default: <emphasis><parameter>passwd chat</parameter> = <literal>*new*password* %n\n *new*password* %n\n *changed*</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>passwd chat</parameter> = <literal>"*Enter NEW password*" %n\n "*Reenter NEW password*" %n\n "*Password changed*"</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passwd chat debug</primary></indexterm><anchor id="PASSWDCHATDEBUG"/><title>

passwd chat debug (G)
</title><variablelist><varlistentry><listitem>
    <para>This boolean specifies if the passwd chat script 
    parameter is run in <emphasis>debug</emphasis> mode. In this mode the 
    strings passed to and received from the passwd chat are printed 
    in the <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> log with a 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="DEBUGLEVEL" xlink:href="smb.conf.5.html#DEBUGLEVEL">debug level</link> 
    of 100. This is a dangerous option as it will allow plaintext passwords 
    to be seen in the <literal>smbd</literal> log. It is available to help 
    Samba admins debug their <parameter moreinfo="none">passwd chat</parameter> scripts 
    when calling the <parameter moreinfo="none">passwd program</parameter> and should 
    be turned off after this has been done. This option has no effect if the 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PAMPASSWORDCHANGE" xlink:href="smb.conf.5.html#PAMPASSWORDCHANGE">pam password change</link>
	parameter is set. This parameter is off by default.</para>

<para>Default: <emphasis><parameter>passwd chat debug</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passwd chat timeout</primary></indexterm><anchor id="PASSWDCHATTIMEOUT"/><title>

passwd chat timeout (G)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

<para>Default: <emphasis><parameter>passwd chat timeout</parameter> = <literal>2</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>passwd program</primary></indexterm><anchor id="PASSWDPROGRAM"/><title>

passwd program (G)
</title><variablelist><varlistentry><listitem>
    <para>The name of a program that can be used to set 
    UNIX user passwords.  Any occurrences of <parameter moreinfo="none">%u</parameter> 
    will be replaced with the user name. The user name is checked for 
    existence before calling the password changing program.</para>

    <para>Also note that many passwd programs insist in <emphasis>reasonable
    </emphasis> passwords, such as a minimum length, or the inclusion 
    of mixed case chars and digits. This can pose a problem as some clients 
    (such as Windows for Workgroups) uppercase the password before sending 
    it.</para>

    <para><emphasis>Note</emphasis> that if the <parameter moreinfo="none">unix 
    password sync</parameter> parameter is set to <constant>yes
    </constant> then this program is called <emphasis>AS ROOT</emphasis> 
    before the SMB password in the smbpasswd
    file is changed. If this UNIX password change fails, then 
    <literal>smbd</literal> will fail to change the SMB password also 
    (this is by design).</para>

    <para>If the <parameter moreinfo="none">unix password sync</parameter> parameter 
    is set this parameter <emphasis>MUST USE ABSOLUTE PATHS</emphasis> 
    for <emphasis>ALL</emphasis> programs called, and must be examined 
    for security implications. Note that by default <parameter moreinfo="none">unix 
    password sync</parameter> is set to <constant>no</constant>.</para>
	
<para>Default: <emphasis><parameter>passwd program</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>passwd program</parameter> = <literal>/bin/passwd %u</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>password server</primary></indexterm><anchor id="PASSWORDSERVER"/><title>

password server (G)
</title><variablelist><varlistentry><listitem>
    <para>By specifying the name of a domain controller with this option,
    and using <literal>security = [ads|domain]</literal>
    it is possible to get Samba
    to do all its username/password validation using a specific remote server.</para>

    <para>Ideally, this option
    <emphasis>should not</emphasis> be used, as the default '*' indicates to Samba 
    to determine the best DC to contact dynamically, just as all other hosts in an 
    AD domain do.  This allows the domain to be maintained (addition
    and removal of domain controllers) without modification to
    the smb.conf file.  The cryptographic protection on the authenticated RPC calls
    used to verify passwords ensures that this default is safe.</para>

    <para><emphasis>It is strongly recommended that you use the
    default of '*'</emphasis>, however if in your particular
    environment you have reason to specify a particular DC list, then
    the list of machines in this option must be a list of names or IP
    addresses of Domain controllers for the Domain. If you use the
    default of '*', or list several hosts in the <parameter moreinfo="none">password server</parameter> option then <literal>smbd </literal> will try each in turn till it
    finds one that responds.  This is useful in case your primary
    server goes down.</para>

    <para>If the list of servers contains both names/IP's and the '*'
    character, the list is treated as a list of preferred 
    domain controllers, but an auto lookup of all remaining DC's
    will be added to the list as well.  Samba will not attempt to optimize 
    this list by locating the closest DC.</para>
		
    <para>If parameter is a name, it is looked up using the 
    parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="NAMERESOLVEORDER" xlink:href="smb.conf.5.html#NAMERESOLVEORDER">name resolve order</link> and so may resolved
    by any method and order described in that parameter.</para>


<para>Default: <emphasis><parameter>password server</parameter> = <literal>*</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>password server</parameter> = <literal>NT-PDC, NT-BDC1, NT-BDC2, *</literal>
</emphasis>
</para><para>Example: <emphasis><parameter>password server</parameter> = <literal>windc.mydomain.com:389 192.168.1.101 *</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>preload modules</primary></indexterm><anchor id="PRELOADMODULES"/><title>

preload modules (G)
</title><variablelist><varlistentry><listitem>
	<para>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. </para>

<para>Default: <emphasis><parameter>preload modules</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>preload modules</parameter> = <literal>/usr/lib/samba/passdb/mysql.so</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>private directory</primary><see>private dir</see></indexterm><title>

<anchor id="PRIVATEDIRECTORY"/>private directory
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="PRIVATEDIR">private dir</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>private dir</primary></indexterm><anchor id="PRIVATEDIR"/><title>

private dir (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameters defines the directory
    smbd will use for storing such files as <filename moreinfo="none">smbpasswd</filename>
    and <filename moreinfo="none">secrets.tdb</filename>.
</para>

<para>Default: <emphasis><parameter>private dir</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/private</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>read list</primary></indexterm><anchor id="READLIST"/><title>

read list (S)
</title><variablelist><varlistentry><listitem>
    <para>
	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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only</link> option is set
	to. The list can include group names using the syntax described in the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="INVALIDUSERS" xlink:href="smb.conf.5.html#INVALIDUSERS">invalid users</link>
	parameter.
	</para>

<para>Default: <emphasis><parameter>read list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>read list</parameter> = <literal>mary, @students</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>write ok</primary><see>read only</see></indexterm><title>

<anchor id="WRITEOK"/>write ok
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="READONLY">read only</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>read only</primary></indexterm><anchor id="READONLY"/><title>

read only (S)
</title><variablelist><varlistentry><listitem>
    <para>An inverted synonym is <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WRITEABLE" xlink:href="smb.conf.5.html#WRITEABLE">writeable</link>.</para>

    <para>If this parameter is <constant>yes</constant>, then users 
    of a service may not create or modify files in the service's 
    directory.</para>

    <para>Note that a printable service (<literal>printable = yes</literal>)
    will <emphasis>ALWAYS</emphasis> allow writing to the directory 
    (user privileges permitting), but only via spooling operations.</para>

<para>Default: <emphasis><parameter>read only</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>rename user script</primary></indexterm><anchor id="RENAMEUSERSCRIPT"/><title>

rename user script (G)
</title><variablelist><varlistentry><listitem>
    <para>
	This is the full pathname to a script that will be run as root by <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> under special circumstances described below.
	</para>

	<para>
	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, <literal>%uold</literal> and
	<literal>%unew</literal>, will be substituted with the old and new usernames, respectively.  The script should
	return 0 upon successful completion, and nonzero otherwise.
	</para>

	<note><para>
	The script has all responsibility to rename all the necessary data that is accessible in this posix method.
	This can mean different requirements for different backends.  The tdbsam and smbpasswd backends will take care
	of the contents of their respective files, so the script is responsible only for changing the POSIX username, and
	other data that may required for your circumstances, such as home directory.  Please also consider whether or
	not you need to rename the actual home directories themselves.  The ldapsam backend will not make any changes,
	because of the potential issues with renaming the LDAP naming attribute.  In this case the script is
	responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that
	needs to change for other applications using the same directory.
	</para></note>


<para>Default: <emphasis><parameter>rename user script</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>restrict anonymous</primary></indexterm><anchor id="RESTRICTANONYMOUS"/><title>

restrict anonymous (G)
</title><variablelist><varlistentry><listitem>
    <para>The setting of this parameter determines whether user and
    group list information is returned for an anonymous connection.
    and mirrors the effects of the
<programlisting>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\
           Control\LSA\RestrictAnonymous
</programlisting>
	registry key in Windows 2000 and Windows NT.  When set to 0, user
	and group list information is returned to anyone who asks.  When set
    to 1, only an authenticated user can retrieve user and
    group list information.  For the value 2, supported by
    Windows 2000/XP and Samba, no anonymous connections are allowed at
    all.  This can break third party and Microsoft
    applications which expect to be allowed to perform
	operations anonymously.</para>

	<para>
    The security advantage of using restrict anonymous = 1 is dubious,
    as user and group list information can be obtained using other
	means.
	</para>

	<note>
	<para>
    The security advantage of using restrict anonymous = 2 is removed
    by setting <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTOK" xlink:href="smb.conf.5.html#GUESTOK">guest ok = yes</link> on any share.
	</para>
	</note>

<para>Default: <emphasis><parameter>restrict anonymous</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>root</primary><see>root directory</see></indexterm><title>

<anchor id="ROOT"/>root
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="ROOTDIRECTORY">root directory</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>root dir</primary><see>root directory</see></indexterm><title>

<anchor id="ROOTDIR"/>root dir
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="ROOTDIRECTORY">root directory</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>root directory</primary></indexterm><anchor id="ROOTDIRECTORY"/><title>

root directory (G)
</title><variablelist><varlistentry><listitem>
    <para>The server will <literal>chroot()</literal> (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
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WIDESMBCONFOPTIONS" xlink:href="smb.conf.5.html#WIDESMBCONFOPTIONS">wide smbconfoptions</link> parameter).
    </para>

    <para>Adding a <parameter moreinfo="none">root directory</parameter> 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 
    sub-tree specified in the <parameter moreinfo="none">root directory</parameter> 
    option, <emphasis>including</emphasis> some files needed for 
    complete operation of the server. To maintain full operability 
    of the server you will need to mirror some system files 
    into the <parameter moreinfo="none">root directory</parameter> tree. In particular 
    you will need to mirror <filename moreinfo="none">/etc/passwd</filename> (or a 
    subset of it), and any binaries or configuration files needed for 
    printing (if required). The set of files that must be mirrored is
    operating system dependent.</para>

<para>Default: <emphasis><parameter>root directory</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>root directory</parameter> = <literal>/homes/smb</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>samba kcc command</primary></indexterm><anchor id="SAMBAKCCCOMMAND"/><title>

samba kcc command (G)
</title><variablelist><varlistentry><listitem>
	<para>This option specifies the path to the Samba KCC command.
		This script is used for replication topology replication.
	</para>

	<para>It should not be necessary to modify this option except
		for testing purposes or if the <filename>samba_kcc</filename>
		was installed in a non-default location.
	</para>

<para>Default: <emphasis><parameter>samba kcc command</parameter> = <literal>/home/ubuntu/autobuild/b22271/samba/source4/scripting/bin/samba_kcc</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>samba kcc command</parameter> = <literal>/usr/local/bin/kcc</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>security</primary></indexterm><anchor id="SECURITY"/><title>

security (G)
</title><variablelist><varlistentry><listitem>
    <para>This option affects how clients respond to 
    Samba and is one of the most important settings in the <filename moreinfo="none">
    smb.conf</filename> file.</para>

    <para>The default is <literal>security = user</literal>, as this is
    the most common setting, used for a standalone file server or a DC.</para>

    <para>The alternatives are
    <literal>security = ads</literal> or <literal>security = domain
    </literal>, which support joining Samba to a Windows domain</para>

    <para>You should use <literal>security = user</literal> and 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPTOGUEST" xlink:href="smb.conf.5.html#MAPTOGUEST">map to guest</link> if you 
    want to mainly setup shares without a password (guest shares). This 
    is commonly used for a shared printer server. </para>
		
    <para>The different settings will now be explained.</para>


    <para><anchor id="SECURITYEQUALSAUTO"/><emphasis>SECURITY = AUTO</emphasis></para>

    <para>This is the default security setting in Samba, and causes Samba to consult
    the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERROLE" xlink:href="smb.conf.5.html#SERVERROLE">server role</link> parameter (if set) to determine the security mode.</para>

    <para><anchor id="SECURITYEQUALSUSER"/><emphasis>SECURITY = USER</emphasis></para>

    <para>If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERROLE" xlink:href="smb.conf.5.html#SERVERROLE">server role</link> is not specified, this is the default security setting in Samba. 
    With user-level security a client must first "log-on" with a 
    valid username and password (which can be mapped using the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAP" xlink:href="smb.conf.5.html#USERNAMEMAP">username map</link> 
    parameter). Encrypted passwords (see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link> parameter) can also
    be used in this security mode. Parameters such as <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USER" xlink:href="smb.conf.5.html#USER">user</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTONLY" xlink:href="smb.conf.5.html#GUESTONLY">guest only</link> 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.</para>

    <para><emphasis>Note</emphasis> that the name of the resource being 
    requested is <emphasis>not</emphasis> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>. 
    See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPTOGUEST" xlink:href="smb.conf.5.html#MAPTOGUEST">map to guest</link> parameter for details on doing this.</para>

    <para><anchor id="SECURITYEQUALSDOMAIN"/><emphasis>SECURITY = DOMAIN</emphasis></para>

    <para>This mode will only work correctly if <citerefentry><refentrytitle>net</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> has been used to add this
    machine into a Windows NT Domain. It expects the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link>
	parameter to be set to <constant>yes</constant>. 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 
    the same way that a Windows NT Server would do.</para>

    <para><emphasis>Note</emphasis> that a valid UNIX user must still 
    exist as well as the account on the Domain Controller to allow 
    Samba to have a valid UNIX account to map file access to.</para>

    <para><emphasis>Note</emphasis> that from the client's point 
    of view <literal>security = domain</literal> is the same 
    as <literal>security = user</literal>. It only 
    affects how the server deals with the authentication, 
    it does not in any way affect what the client sees.</para>

    <para><emphasis>Note</emphasis> that the name of the resource being 
    requested is <emphasis>not</emphasis> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>. 
    See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPTOGUEST" xlink:href="smb.conf.5.html#MAPTOGUEST">map to guest</link> parameter for details on doing this.</para>

    <para>See also the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWORDSERVER" xlink:href="smb.conf.5.html#PASSWORDSERVER">password server</link> parameter and
	 the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link> parameter.</para>


    <para><emphasis>Note</emphasis> that the name of the resource being 
    requested is <emphasis>not</emphasis> 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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTACCOUNT" xlink:href="smb.conf.5.html#GUESTACCOUNT">guest account</link>. 
    See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPTOGUEST" xlink:href="smb.conf.5.html#MAPTOGUEST">map to guest</link> parameter for details on doing this.</para>

    <para>See also the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PASSWORDSERVER" xlink:href="smb.conf.5.html#PASSWORDSERVER">password server</link> parameter and the 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link> parameter.</para>

	<para><anchor id="SECURITYEQUALSADS"/><emphasis>SECURITY = ADS</emphasis></para>
	
	<para>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. </para>
	
	<para>Note that this mode does NOT make Samba operate as a Active Directory Domain 
		Controller. </para>

	<para>Note that this forces <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="REQUIRESTRONGKEY" xlink:href="smb.conf.5.html#REQUIRESTRONGKEY">require strong key = yes</link>
	and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel = yes</link> for the primary domain.</para>

	<para>Read the chapter about Domain Membership in the HOWTO for details.</para>

<para>Default: <emphasis><parameter>security</parameter> = <literal>AUTO</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>security</parameter> = <literal>DOMAIN</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>security mask</primary></indexterm><anchor id="SECURITYMASK"/><title>

security mask (S)
</title><variablelist><varlistentry><listitem>
    <para>
	This parameter has been removed for Samba 4.0.0.
    </para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>server role</primary></indexterm><anchor id="SERVERROLE"/><title>

server role (G)
</title><variablelist><varlistentry><listitem>
    <para>This option determines the basic operating mode of a Samba
    server and is one of the most important settings in the <filename moreinfo="none"> smb.conf</filename> file.</para>

    <para>The default is <literal>server role = auto</literal>, as causes
    Samba to operate according to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> setting, or if not
    specified as a simple file server that is not connected to any domain.</para>

    <para>The alternatives are
    <literal>server role = standalone</literal> or <literal>server role = member server
    </literal>, which support joining Samba to a Windows domain, along with <literal>server role = domain controller</literal>, which run Samba as a Windows domain controller.</para>

    <para>You should use <literal>server role = standalone</literal> and 
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MAPTOGUEST" xlink:href="smb.conf.5.html#MAPTOGUEST">map to guest</link> if you 
    want to mainly setup shares without a password (guest shares). This 
    is commonly used for a shared printer server. </para>
		
    <para><anchor id="AUTO"/><emphasis>SERVER ROLE = AUTO</emphasis></para>

    <para>This is the default server role in Samba, and causes Samba to consult
    the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> parameter (if set) to determine the server role, giving compatable behaviours to previous Samba versions.</para>

    <para><anchor id="STANDALONE"/><emphasis>SERVER ROLE = STANDALONE</emphasis></para>

    <para>If <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SECURITY" xlink:href="smb.conf.5.html#SECURITY">security</link> is also not specified, this is the default security setting in Samba. 
    In standalone operation, a client must first "log-on" with a 
    valid username and password (which can be mapped using the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAP" xlink:href="smb.conf.5.html#USERNAMEMAP">username map</link> 
    parameter) stored on this machine. Encrypted passwords (see the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link> parameter) are by default
    used in this security mode. Parameters such as <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USER" xlink:href="smb.conf.5.html#USER">user</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="GUESTONLY" xlink:href="smb.conf.5.html#GUESTONLY">guest only</link> 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.</para>

    <para><anchor id="MEMBER SERVER"/><emphasis>SERVER ROLE = MEMBER SERVER</emphasis></para>

    <para>This mode will only work correctly if <citerefentry><refentrytitle>net</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> has been used to add this
    machine into a Windows Domain. It expects the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ENCRYPTEDPASSWORDS" xlink:href="smb.conf.5.html#ENCRYPTEDPASSWORDS">encrypted passwords</link>
	parameter to be set to <constant>yes</constant>. In this 
    mode Samba will try to validate the username/password by passing
    it to a Windows or Samba Domain Controller, in exactly 
    the same way that a Windows Server would do.</para>

    <para><emphasis>Note</emphasis> that a valid UNIX user must still 
    exist as well as the account on the Domain Controller to allow 
    Samba to have a valid UNIX account to map file access to.  Winbind can provide this.</para>

    <para><anchor id="PDC"/><emphasis>SERVER ROLE = CLASSIC PRIMARY DOMAIN CONTROLLER</emphasis></para>

    <para>This mode of operation runs a classic Samba primary domain
    controller, providing domain logon services to Windows and Samba
    clients of an NT4-like domain.  Clients must be joined to the domain to
    create a secure, trusted path across the network.  There must be
    only one PDC per NetBIOS scope (typcially a broadcast network or
    clients served by a single WINS server).</para>

    <para><anchor id="BDC"/><emphasis>SERVER ROLE = NETBIOS BACKUP DOMAIN CONTROLLER</emphasis></para>

    <para>This mode of operation runs a classic Samba backup domain
    controller, providing domain logon services to Windows and Samba
    clients of an NT4-like domain.  As a BDC, this allows
    multiple Samba servers to provide redundant logon services to a
    single NetBIOS scope.</para>

    <para><anchor id="AD-DC"/><emphasis>SERVER ROLE = ACTIVE DIRECTORY DOMAIN CONTROLLER</emphasis></para>

    <para>This mode of operation runs Samba as an active directory
    domain controller, providing domain logon services to Windows and
    Samba clients of the domain.  This role requires special
    configuration, see the <ulink url="http://wiki.samba.org/index.php/Samba4/HOWTO">Samba4
    HOWTO</ulink></para>


<para>Default: <emphasis><parameter>server role</parameter> = <literal>AUTO</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server role</parameter> = <literal>DOMAIN CONTROLLER</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>server schannel</primary></indexterm><anchor id="SERVERSCHANNEL"/><title>

server schannel (G)
</title><variablelist><varlistentry><listitem>
    <para>
	This controls whether the server offers or even demands the use of the netlogon schannel.
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERSCHANNEL" xlink:href="smb.conf.5.html#SERVERSCHANNEL">server schannel = no</link> does not offer the schannel, <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERSCHANNEL" xlink:href="smb.conf.5.html#SERVERSCHANNEL">server schannel = auto</link> offers the schannel but does not enforce it, and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERSCHANNEL" xlink:href="smb.conf.5.html#SERVERSCHANNEL">server schannel = yes</link> denies access if the client is not able to speak netlogon schannel.
	This is only the case for Windows NT4 before SP4.
	</para>

    <para>
	Please note that with this set to <literal>no</literal>, you will have to apply the WindowsXP
	<filename>WinXP_SignOrSeal.reg</filename> registry patch found in the docs/registry subdirectory of the Samba distribution tarball.
	</para>

<para>Default: <emphasis><parameter>server schannel</parameter> = <literal>auto</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>server schannel</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>server signing</primary></indexterm><anchor id="SERVERSIGNING"/><title>

server signing (G)
</title><variablelist><varlistentry><listitem>

    <para>This controls whether the client is allowed or required to use SMB1 and SMB2 signing. Possible values
    are <emphasis>default</emphasis>, <emphasis>auto</emphasis>, <emphasis>mandatory</emphasis>
    and <emphasis>disabled</emphasis>.
    </para>

    <para>By default, and when smb signing is set to
    <emphasis>default</emphasis>, smb signing enabled when
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERROLE" xlink:href="smb.conf.5.html#SERVERROLE">server role</link> is <emphasis>active directory
    domain controller</emphasis> and disabled otherwise.</para>

    <para>When set to auto, SMB1 signing is offered, but not enforced.
    When set to mandatory, SMB1 signing is required and if set
    to disabled, SMB signing is not offered either.</para>

    <para>For the SMB2 protocol, by design, signing cannot be disabled. In the case
    where SMB2 is negotiated, if this parameter is set to <emphasis>disabled</emphasis>,
    it will be treated as <emphasis>auto</emphasis>. Setting it to <emphasis>mandatory</emphasis>
    will still require SMB2 clients to use signing.</para>

<para>Default: <emphasis><parameter>server signing</parameter> = <literal>default</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb encrypt</primary></indexterm><anchor id="SMBENCRYPT"/><title>

smb encrypt (S)
</title><variablelist><varlistentry><listitem>
	<para>
	This parameter controls whether a remote client is allowed or required
	to use SMB encryption. It has different effects depending on whether
	the connection uses SMB1 or SMB2 and newer:
	</para>

	<itemizedlist>
	<listitem>
		<para>
		If the connection uses SMB1, then this option controls the use
		of a Samba-specific extension to the SMB protocol introduced in
		Samba 3.2 that makes use of the Unix extensions.
		</para>
	</listitem>

	<listitem>
		<para>
		If the connection uses SMB2 or newer, then this option controls
		the use of the SMB-level encryption that is supported in SMB
		version 3.0 and above and available in Windows 8 and newer.
		</para>
	</listitem>
	</itemizedlist>

	<para>
		This parameter can be set globally and on a per-share bases.
		Possible values are
		<emphasis>off</emphasis> or <emphasis>disabled</emphasis>,
		<emphasis>auto</emphasis> or <emphasis>enabled</emphasis>, and
		<emphasis>mandatory</emphasis> or <emphasis>required</emphasis>.
		A special value is <emphasis>default</emphasis> which is
		the implicit default setting.
	</para>

	<variablelist>
		<varlistentry>
		<term><emphasis>Effects for SMB1</emphasis></term>
		<listitem>
		<para>
		The Samba-specific encryption of SMB1 connections is an
		extension to the SMB 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 enabled it provides a secure method of
		SMB/CIFS communication, similar to an ssh protected session, but
		using SMB/CIFS authentication to negotiate encryption and
		signing keys. Currently this is only supported smbclient of by
		Samba 3.2 and newer, and hopefully soon Linux CIFSFS and MacOS/X
		clients. Windows clients do not support this feature.
		</para>

		<para>This may be set on a per-share
		basis, but clients may chose to encrypt the entire session, not
		just traffic to a specific share. If this is set to mandatory
		then all traffic to a share <emphasis>must</emphasis>
		be encrypted once the connection has been made to the share.
		The server would return "access denied" to all non-encrypted
		requests on such a share. Selecting encrypted traffic reduces
		throughput as smaller packet sizes must be used (no huge UNIX
		style read/writes allowed) as well as the overhead of encrypting
		and signing all the data.
		</para>

		<para>
		If SMB encryption is selected, Windows style SMB signing (see
		the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SERVERSIGNING" xlink:href="smb.conf.5.html#SERVERSIGNING">server signing</link> option) is no longer
		necessary, as the GSSAPI flags use select both signing and
		sealing of the data.
		</para>

		<para>
		When set to auto or default, 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.
		</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term><emphasis>Effects for SMB2</emphasis></term>
		<listitem>
		<para>
		Native SMB transport encryption is available in SMB version 3.0
		or newer. It is only offered by Samba if
		<emphasis>server max protocol</emphasis> is set to
		<emphasis>SMB3</emphasis> or newer.
		Clients supporting this type of encryption include
		Windows 8 and newer,
		Windows server 2012 and newer,
		and smbclient of Samba 4.1 and newer.
		</para>

		<para>
		The protocol implementation offers various options:
		</para>

		<itemizedlist>
			<listitem>
			<para>
			The capability to perform SMB encryption can be
			negotiated during prorocol negotiation.
			</para>
			</listitem>

			<listitem>
			<para>
			Data encryption can be enabled globally. In that case,
			an encryption-capable connection will have all traffic
			in all its sessions encrypted. In particular all share
			connections will be encrypted.
			</para>
			</listitem>

			<listitem>
			<para>
			Data encryption can also be enabled per share if not
			enabled globally. For an encryption-capable connection,
			all connections to an encryption-enabled share will be
			encrypted.
			</para>
			</listitem>

			<listitem>
			<para>
			Encryption can be enforced. This means that session
			setups will be denied on non-encryption-capable
			connections if data encryption has been enabled
			globally. And tree connections will be denied for
			non-encryption capable connections to shares with data
			encryption enabled.
			</para>
			</listitem>
		</itemizedlist>

		<para>
		These features can be crontrolled with settings of
		<emphasis>smb encrypt</emphasis> as follows:
		</para>

		<itemizedlist>
			<listitem>
			<para>
			Leaving it as default or explicitly setting
			<emphasis>default</emphasis> globally will enable
			negotiation of encryption but will not turn on
			data encryption globally or per share.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>enabled</emphasis> globally will
			enable negotiation and turn on data encryption globally.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>required</emphasis> globally
			will enable negotiation and enforce data encryption
			globally.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>off</emphasis> globally will
			completely disable the encryption feature.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>enabled</emphasis> on a share
			will turn on data encryption for this share if
			negotiation has been enabled globally.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>required</emphasis> on a share
			will enforce data encryption for this share if
			negotiation has been enabled globally. Note that this
			allows enforcing to be controlled in Samba more
			fine-grainedly than in Windows.  This is a small
			deviation from the MS-SMB2 protocol document.
			</para>
			</listitem>

			<listitem>
			<para>
			Setting it to <emphasis>off</emphasis> for a share has
			no effect.
			</para>
			</listitem>
		</itemizedlist>
		</listitem>
		</varlistentry>
	</variablelist>

<para>Default: <emphasis><parameter>smb encrypt</parameter> = <literal>default</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>smb passwd file</primary></indexterm><anchor id="SMBPASSWDFILE"/><title>

smb passwd file (G)
</title><variablelist><varlistentry><listitem>
    <para>This option sets the path to the encrypted smbpasswd file. By
    default the path to the smbpasswd file  is compiled into Samba.</para>

    <para>
    An example of use is:
<programlisting>
smb passwd file = /etc/samba/smbpasswd
</programlisting>
    </para>

<para>Default: <emphasis><parameter>smb passwd file</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/private/smbpasswd</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls cafile</primary></indexterm><anchor id="TLSCAFILE"/><title>

tls cafile (G)
</title><variablelist><varlistentry><listitem>
	 <para>This option can be set to a file (PEM format)
		 containing CA certificates of root CAs to trust to sign
		 certificates or intermediate CA certificates.</para>
	 <para>This path is relative to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> if the path
	 does not start with a /.</para>
 
<para>Default: <emphasis><parameter>tls cafile</parameter> = <literal>tls/ca.pem</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls certfile</primary></indexterm><anchor id="TLSCERTFILE"/><title>

tls certfile (G)
</title><variablelist><varlistentry><listitem>
	 <para>This option can be set to a file (PEM format)
		 containing the RSA certificate. </para>
	 <para>This path is relative to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> if the path
	 does not start with a /.</para>

<para>Default: <emphasis><parameter>tls certfile</parameter> = <literal>tls/cert.pem</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls crlfile</primary></indexterm><anchor id="TLSCRLFILE"/><title>

tls crlfile (G)
</title><variablelist><varlistentry><listitem>
	 <para>This option can be set to a file containing a certificate
		 revocation list (CRL).</para>
	 <para>This path is relative to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> if the path
	 does not start with a /.</para>

<para>Default: <emphasis><parameter>tls crlfile</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls dh params file</primary></indexterm><anchor id="TLSDHPARAMSFILE"/><title>

tls dh params file (G)
</title><variablelist><varlistentry><listitem>
	 <para>This option can be set to a file with Diffie-Hellman parameters
		 which will be used with EDH ciphers.
	 </para>
	 <para>This path is relative to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> if the path
	 does not start with a /.</para>

<para>Default: <emphasis><parameter>tls dh params file</parameter> = <literal/>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls enabled</primary></indexterm><anchor id="TLSENABLED"/><title>

tls enabled (G)
</title><variablelist><varlistentry><listitem>
	 <para>If this option is set to <constant>yes</constant>, then Samba
		 will use TLS when possible in communication.</para>
 
<para>Default: <emphasis><parameter>tls enabled</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>tls keyfile</primary></indexterm><anchor id="TLSKEYFILE"/><title>

tls keyfile (G)
</title><variablelist><varlistentry><listitem>
	 <para>This option can be set to a file (PEM format)
		 containing the RSA private key. This file must be accessible without
		 a pass-phrase, i.e. it must not be encrypted.</para>
	 <para>This path is relative to <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="PRIVATEDIR" xlink:href="smb.conf.5.html#PRIVATEDIR">private dir</link> if the path
	 does not start with a /.</para>
 
<para>Default: <emphasis><parameter>tls keyfile</parameter> = <literal>tls/key.pem</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>unix password sync</primary></indexterm><anchor id="UNIXPASSWORDSYNC"/><title>

unix password sync (G)
</title><variablelist><varlistentry><listitem>
    <para>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 <constant>yes</constant> the program specified in the <parameter moreinfo="none">passwd
    program</parameter> parameter is called <emphasis>AS ROOT</emphasis> -
    to allow the new UNIX password to be set without access to the 
    old UNIX password (as the SMB password change code has no 
	access to the old password cleartext, only the new).</para>

<para>Default: <emphasis><parameter>unix password sync</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>user</primary><see>username</see></indexterm><title>

<anchor id="USER"/>user
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="USERNAME">username</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>users</primary><see>username</see></indexterm><title>

<anchor id="USERS"/>users
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="USERNAME">username</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>username</primary></indexterm><anchor id="USERNAME"/><title>

username (S)
</title><variablelist><varlistentry><listitem>
    <para>To restrict a service to a particular set of users you 
    can use the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VALIDUSERS" xlink:href="smb.conf.5.html#VALIDUSERS">valid users</link> parameter.</para>

    <para>This parameter is deprecated</para>

    <para>However, it currently operates only in conjunction with
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="ONLYUSER" xlink:href="smb.conf.5.html#ONLYUSER">only user</link>.  The supported way to restrict
    a service to a particular set of users is the
    <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VALIDUSERS" xlink:href="smb.conf.5.html#VALIDUSERS">valid users</link> parameter.</para>


<para>Default: <emphasis><parameter>username</parameter> = <literal>
# The guest account if a guest service, 
		else &lt;empty string&gt;.</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>username</parameter> = <literal>fred, mary, jack, jane, @users, @pcgroup</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>username level</primary></indexterm><anchor id="USERNAMELEVEL"/><title>

username level (G)
</title><variablelist><varlistentry><listitem>
    <para>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 
    username is not found on the UNIX machine.</para>

    <para>If this parameter is set to non-zero the behavior changes. 
    This parameter is a number that specifies the number of uppercase
    combinations to try while trying to determine the UNIX user name. The
    higher the number the more combinations will be tried, but the slower
    the discovery of usernames will be. Use this parameter when you have
    strange usernames on your UNIX machine, such as <constant>AstrangeUser
    </constant>.</para>

    <para>This parameter is needed only on UNIX systems that have case
    sensitive usernames.</para>

<para>Default: <emphasis><parameter>username level</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>username level</parameter> = <literal>5</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>username map</primary></indexterm><anchor id="USERNAMEMAP"/><title>

username map (G)
</title><variablelist><varlistentry><listitem>
    <para>
	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
	can more easily share files.
	</para>

    <para>
	Please note that for user 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 entries in the map table (e.g.
	biddle = <literal>DOMAIN\foo</literal>).
	</para>
    
    <para>
	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
	@group in which case they will match any UNIX username in that group. The special client name '*' is a
	wildcard and matches any name. Each line of the map file may be up to 1023 characters long.
	</para>

    <para>
	The file is processed on each line by taking the supplied username and comparing it with each username on the
	right hand side of the '=' signs. If the supplied name matches any of the names on the right hand side then it
	is replaced with the name on the left. Processing then continues with the next line.
	</para>

    <para>
	If any line begins with a '#' or a ';' then it is ignored.
	</para>

    <para>
	If any line begins with an '!' then the processing will stop after that line if a mapping was done by the
	line.  Otherwise mapping continues with every line being processed.  Using '!' is most useful when you have a
	wildcard mapping line later in the file.
	</para>

    <para>
	For example to map from the name <constant>admin</constant> or <constant>administrator</constant> to the UNIX
	name <constant> root</constant> you would use:
<programlisting>
<literal>root = admin administrator</literal>
</programlisting>
	Or to map anyone in the UNIX group <constant>system</constant> to the UNIX name <constant>sys</constant> you would use:
<programlisting>
<literal>sys = @system</literal>
</programlisting>
	</para>

    <para>
	You can have as many mappings as you like in a username map file.
	</para>


    <para>
	If your system supports the NIS NETGROUP option then the netgroup database is checked before the <filename moreinfo="none">/etc/group </filename> database for matching groups.
	</para>

    <para>
	You can map Windows usernames that have spaces in them by using double quotes around the name. For example:
<programlisting>
<literal>tridge = "Andrew Tridgell"</literal>
</programlisting>
    would map the windows username "Andrew Tridgell" to the unix username "tridge".
	</para>

    <para>
	The following example would map mary and fred to the unix user sys, and map the rest to guest. Note the use of the
    '!' to tell Samba to stop processing if it gets a match on that line:
<programlisting format="linespecific">
!sys = mary fred
guest = *
</programlisting>
    </para>

    <para>
	Note that the remapping is applied to all occurrences of usernames.  Thus if you connect to \\server\fred and
	<constant>fred</constant> is remapped to <constant>mary</constant> then you will actually be connecting to
	\\server\mary and will need to supply a password suitable for <constant>mary</constant> not
	<constant>fred</constant>. The only exception to this is the
	username passed to a Domain Controller (if you have one). The DC will receive whatever username the client
	supplies without  modification.
    </para>

    <para>
	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.
	</para>

   <para>
	Samba versions prior to 3.0.8 would only support reading the fully qualified username 
	(e.g.: <literal>DOMAIN\user</literal>) 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.
   </para>

   <para>
   The following functionality is obeyed in version 3.0.8 and later:
   </para>

   <para>
    When performing local authentication, the username map is applied to the login name before attempting to authenticate
    the connection.
    </para>

    <para>
    When relying upon a external domain controller for validating authentication requests, smbd will apply the username map
    to the fully qualified username (i.e. <literal>DOMAIN\user</literal>) only after the user has been successfully authenticated.
    </para>

    <para>
    An example of use is:
<programlisting>
username map = /usr/local/samba/lib/users.map
</programlisting>
    </para>


<para>Default: <emphasis><parameter>username map</parameter> = <literal>
# no username map</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>username map cache time</primary></indexterm><anchor id="USERNAMEMAPCACHETIME"/><title>

username map cache time (G)
</title><variablelist><varlistentry><listitem>
	<para>
	Mapping usernames with the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAP" xlink:href="smb.conf.5.html#USERNAMEMAP">username map</link>
	or <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAPSCRIPT" xlink:href="smb.conf.5.html#USERNAMEMAPSCRIPT">username map script</link>
	features of Samba can be relatively expensive.
	During login of a user, the mapping is done several times.
	In particular, calling the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAPSCRIPT" xlink:href="smb.conf.5.html#USERNAMEMAPSCRIPT">username map script</link>
	can slow down logins if external databases have to be queried from
	the script being called.
	</para>

	<para>
	The parameter <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAPCACHETIME" xlink:href="smb.conf.5.html#USERNAMEMAPCACHETIME">username map cache time</link>
	controls a mapping cache. It specifies the number of seconds a
	mapping from the username map file or script is to be efficiently cached.
	The default of 0 means no caching is done.
	</para>

<para>Default: <emphasis><parameter>username map cache time</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>username map cache time</parameter> = <literal>60</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>username map script</primary></indexterm><anchor id="USERNAMEMAPSCRIPT"/><title>

username map script (G)
</title><variablelist><varlistentry><listitem>
	<para>This script is a mutually exclusive alternative to the 
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="USERNAMEMAP" xlink:href="smb.conf.5.html#USERNAMEMAP">username map</link> 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 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.
	</para>

<para>Default: <emphasis><parameter>username map script</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>username map script</parameter> = <literal>/etc/samba/scripts/mapusers.sh</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>valid users</primary></indexterm><anchor id="VALIDUSERS"/><title>

valid users (S)
</title><variablelist><varlistentry><listitem>
    <para>
    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 
    <parameter moreinfo="none">invalid users</parameter> parameter.
    </para>

    <para>
    If this is empty (the default) then any user can login. If a username is in both this list 
    and the <parameter moreinfo="none">invalid users</parameter> list then access is denied 
    for that user.
    </para>

    <para>
    The current servicename is substituted for <parameter moreinfo="none">%S</parameter>. 
    This is useful in the [homes] section.
    </para>

    <para><emphasis>Note: </emphasis>When used in the [global] section this
    parameter may have unwanted side effects. For example: If samba is configured as a MASTER BROWSER (see
    <parameter moreinfo="none">local master</parameter>,
    <parameter moreinfo="none">os level</parameter>,
    <parameter moreinfo="none">domain master</parameter>,
    <parameter moreinfo="none">preferred master</parameter>) this option
    will prevent workstations from being able to browse the network.
    </para>


<para>Default: <emphasis><parameter>valid users</parameter> = <literal>
# No valid users list (anyone can login) </literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>valid users</parameter> = <literal>greg, @pcusers</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>writable</primary><see>writeable</see></indexterm><title>

<anchor id="WRITABLE"/>writable
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="WRITEABLE">writeable</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>writeable</primary></indexterm><anchor id="WRITEABLE"/><title>

writeable (S)
</title><variablelist><varlistentry><listitem>
    <para>Inverted synonym for <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only</link>.</para>

<para>Default: <emphasis><parameter>writeable</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>write list</primary></indexterm><anchor id="WRITELIST"/><title>

write list (S)
</title><variablelist><varlistentry><listitem>
    <para>
    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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="READONLY" xlink:href="smb.conf.5.html#READONLY">read only</link> option is set to. The list can 
    include group names using the @group syntax.
    </para>

    <para>
    Note that if a user is in both the read list and the write list then they will be 
    given write access.
    </para>


<para>Default: <emphasis><parameter>write list</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>write list</parameter> = <literal>admin, root, @staff</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>aio read size</primary></indexterm><anchor id="AIOREADSIZE"/><title>

aio read size (S)
</title><variablelist><varlistentry><listitem>
  <para>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.</para>

  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
    only up to 10 outstanding asynchronous requests, read and write combined.</para>

  <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WRITECACHESIZE" xlink:href="smb.conf.5.html#WRITECACHESIZE">write cache size</link></para>
  <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="AIOWRITESIZE" xlink:href="smb.conf.5.html#AIOWRITESIZE">aio write size</link></para>

<para>Default: <emphasis><parameter>aio read size</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>aio read size</parameter> = <literal>16384
#  Use asynchronous I/O for reads bigger than 16KB
    request size</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>aio write behind</primary></indexterm><anchor id="AIOWRITEBEHIND"/><title>

aio write behind (S)
</title><variablelist><varlistentry><listitem>
	<para>If Samba has been built with asynchronous I/O support,
	Samba will not wait until write requests are finished before returning
	the result to the client for files listed in this parameter.
	Instead, Samba will immediately return that the write
	request has been finished successfully, no matter if the
	operation will succeed or not. This might speed up clients without
	aio support, but is really dangerous, because data could be lost
	and files could be damaged.
	</para>
	<para>
	The syntax is identical to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="VETOFILES" xlink:href="smb.conf.5.html#VETOFILES">veto files</link>
	parameter.
	</para>

<para>Default: <emphasis><parameter>aio write behind</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>aio write behind</parameter> = <literal>/*.tmp/</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>aio write size</primary></indexterm><anchor id="AIOWRITESIZE"/><title>

aio write size (S)
</title><variablelist><varlistentry><listitem>
  <para>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.</para>

  <para>Current implementation of asynchronous I/O in Samba 3.0 does support
    only up to 10 outstanding asynchronous requests, read and write combined.</para>
  
  <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WRITECACHESIZE" xlink:href="smb.conf.5.html#WRITECACHESIZE">write cache size</link></para>
  <para>Related command: <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="AIOREADSIZE" xlink:href="smb.conf.5.html#AIOREADSIZE">aio read size</link></para>

<para>Default: <emphasis><parameter>aio write size</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>aio write size</parameter> = <literal>16384
#  Use asynchronous I/O for writes bigger than 16KB
    request size</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>allocation roundup size</primary></indexterm><anchor id="ALLOCATIONROUNDUPSIZE"/><title>

allocation roundup size (S)
</title><variablelist><varlistentry><listitem>
    <para>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
    difficulties for some applications, e.g. MS Visual Studio.
    If the MS Visual Studio compiler starts to crash with an
    internal error, set this parameter to zero for this share.
    </para>

    <para>The integer parameter specifies the roundup size in bytes.</para>

<para>Default: <emphasis><parameter>allocation roundup size</parameter> = <literal>1048576</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>allocation roundup size</parameter> = <literal>0
# (to disable roundups)</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>block size</primary></indexterm><anchor id="BLOCKSIZE"/><title>

block size (S)
</title><variablelist><varlistentry><listitem>
    <para>This parameter controls the behavior of <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> when reporting disk free 
    sizes. By default, this reports a disk block size of 1024 bytes.
    </para>        
		
    <para>Changing this parameter may have some effect on the
    efficiency of client writes, this is not yet confirmed. This
    parameter was added to allow advanced administrators to change
    it (usually to a higher value) and test the effect it has on
    client write performance without re-compiling the code. As this
    is an experimental option it may be removed in a future release.
    </para>

    <para>Changing this option does not change the disk free reporting
    size, just the block size unit reported to the client.
    </para>

<para>Default: <emphasis><parameter>block size</parameter> = <literal>1024</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>block size</parameter> = <literal>4096</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>deadtime</primary></indexterm><anchor id="DEADTIME"/><title>

deadtime (G)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>
		
    <para>This is useful to stop a server's resources being 
    exhausted by a large number of inactive connections.</para>

    <para>Most clients have an auto-reconnect feature when a 
    connection is broken so in most cases this parameter should be 
    transparent to users.</para>

    <para>Using this parameter with a timeout of a few minutes 
    is recommended for most systems.</para>

    <para>A deadtime of zero indicates that no auto-disconnection 
		should be performed.</para>

<para>Default: <emphasis><parameter>deadtime</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>deadtime</parameter> = <literal>15</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>getwd cache</primary></indexterm><anchor id="GETWDCACHE"/><title>

getwd cache (G)
</title><variablelist><varlistentry><listitem>
    <para>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 <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WIDESMBCONFOPTIONS" xlink:href="smb.conf.5.html#WIDESMBCONFOPTIONS">wide smbconfoptions</link> parameter is set to <constant>no</constant>.</para>

<para>Default: <emphasis><parameter>getwd cache</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>hostname lookups</primary></indexterm><anchor id="HOSTNAMELOOKUPS"/><title>

hostname lookups (G)
</title><variablelist><varlistentry><listitem>
    <para>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 <literal>hosts deny</literal> and <literal>hosts allow</literal>.
    </para>

<para>Default: <emphasis><parameter>hostname lookups</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>hostname lookups</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>keepalive</primary></indexterm><anchor id="KEEPALIVE"/><title>

keepalive (G)
</title><variablelist><varlistentry><listitem>
    <para>The value of the parameter (an integer) represents 
    the number of seconds between <parameter moreinfo="none">keepalive</parameter> 
    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.</para>

    <para>Keepalives should, in general, not be needed if the socket 
    has the SO_KEEPALIVE attribute set on it by default. (see <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="SOCKETOPTIONS" xlink:href="smb.conf.5.html#SOCKETOPTIONS">socket options</link>). 
Basically you should only use this option if you strike difficulties.</para>

    <para>Please note this option only applies to SMB1 client connections, and
    has no effect on SMB2 clients.</para>

<para>Default: <emphasis><parameter>keepalive</parameter> = <literal>300</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>keepalive</parameter> = <literal>600</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max connections</primary></indexterm><anchor id="MAXCONNECTIONS"/><title>

max connections (S)
</title><variablelist><varlistentry><listitem>
    <para>This option allows the number of simultaneous connections to a service to be limited.
    If <parameter moreinfo="none">max connections</parameter> 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.</para>

    <para>Record lock files are used to implement this feature. The lock files will be stored in 
    the directory specified by the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="LOCKDIRECTORY" xlink:href="smb.conf.5.html#LOCKDIRECTORY">lock directory</link> option.</para>

<para>Default: <emphasis><parameter>max connections</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max connections</parameter> = <literal>10</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max disk size</primary></indexterm><anchor id="MAXDISKSIZE"/><title>

max disk size (G)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

    <para>Note that this option does not limit the amount of 
    data you can put on the disk. In the above case you could still 
    store much more than 100 MB on the disk, but if a client ever asks 
    for the amount of free disk space or the total disk size then the 
    result will be bounded by the amount specified in <parameter moreinfo="none">max 
    disk size</parameter>.</para>

    <para>This option is primarily useful to work around bugs 
    in some pieces of software that can't handle very large disks, 
    particularly disks over 1GB in size.</para>

    <para>A <parameter moreinfo="none">max disk size</parameter> of 0 means no limit.</para>

<para>Default: <emphasis><parameter>max disk size</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max disk size</parameter> = <literal>1000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max open files</primary></indexterm><anchor id="MAXOPENFILES"/><title>

max open files (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter limits the maximum number of
    open files that one <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> file
    serving process may have open for a client at any one time.
    This parameter can be set very high (16384) as Samba uses
    only one bit per unopened file. Setting this parameter lower than
    16384 will cause Samba to complain and set this value back to
    the minimum of 16384, as Windows 7 depends on this number of
    open file handles being available.</para>

    <para>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.</para>

<para>Default: <emphasis><parameter>max open files</parameter> = <literal>16384</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>max smbd processes</primary></indexterm><anchor id="MAXSMBDPROCESSES"/><title>

max smbd processes (G)
</title><variablelist><varlistentry><listitem>
    <para>This parameter limits the maximum number of <citerefentry><refentrytitle>smbd</refentrytitle>                                       
    <manvolnum>8</manvolnum></citerefentry> 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 <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> associated with him or her to handle connections to all
    shares from a given host.</para>

<para>Default: <emphasis><parameter>max smbd processes</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>max smbd processes</parameter> = <literal>1000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>min print space</primary></indexterm><anchor id="MINPRINTSPACE"/><title>

min print space (S)
</title><variablelist><varlistentry><listitem>
    <para>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.</para>

<para>Default: <emphasis><parameter>min print space</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>min print space</parameter> = <literal>2000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>name cache timeout</primary></indexterm><anchor id="NAMECACHETIMEOUT"/><title>

name cache timeout (G)
</title><variablelist><varlistentry><listitem>
    <para>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.
</para>

<para>Default: <emphasis><parameter>name cache timeout</parameter> = <literal>660</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>name cache timeout</parameter> = <literal>0</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>socket options</primary></indexterm><anchor id="SOCKETOPTIONS"/><title>

socket options (G)
</title><variablelist><varlistentry><listitem>
    <para>
        <warning>
        <para>Modern server operating systems are tuned for high
        network performance in the majority of situations; when you set socket
        options you are overriding those settings.  Linux in particular has an
        auto-tuning mechanism for buffer sizes that will be disabled if you
        specify a socket buffer size.  This can potentially cripple your
        TCP/IP stack.</para>

        <para> Getting the socket options correct can make a big difference to
        your performance, but getting them wrong can degrade it by just as
        much.  As with any other low level setting, if you must make changes
        to it, make small changes and <emphasis>test</emphasis> the effect
        before making any large changes.</para>
        </warning>
    </para>

    <para>This option allows you to set socket options 
    to be used when talking with the client.</para>

    <para>Socket options are controls on the networking layer 
    of the operating systems which allow the connection to be 
    tuned.</para>

    <para>This option will typically be used to tune your Samba  server
    for optimal performance for your local network. There is  no way
    that Samba can know what the optimal parameters are for  your net,
    so you must experiment and choose them yourself. We  strongly
    suggest you read the appropriate documentation for your  operating
    system first (perhaps <literal>man
    setsockopt</literal> will help).</para>

    <para>You may find that on some systems Samba will say 
    "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 <ulink url="mailto:samba-technical@lists.samba.org">
    samba-technical@lists.samba.org</ulink>.</para>

    <para>Any of the supported socket options may be combined 
    in any way you like, as long as your OS allows it.</para>

    <para>This is the list of socket options currently settable 
    using this option:</para>

    <itemizedlist>
    	<listitem><para>SO_KEEPALIVE</para></listitem>
    	<listitem><para>SO_REUSEADDR</para></listitem>
    	<listitem><para>SO_BROADCAST</para></listitem>
    	<listitem><para>TCP_NODELAY</para></listitem>
    	<listitem><para>IPTOS_LOWDELAY</para></listitem>
    	<listitem><para>IPTOS_THROUGHPUT</para></listitem>
    	<listitem><para>SO_SNDBUF *</para></listitem>
    	<listitem><para>SO_RCVBUF *</para></listitem>
    	<listitem><para>SO_SNDLOWAT *</para></listitem>
    	<listitem><para>SO_RCVLOWAT *</para></listitem>
    </itemizedlist>

    <para>Those marked with a <emphasis>'*'</emphasis> take an integer 
    argument. The others can optionally take a 1 or 0 argument to enable 
    or disable the option, by default they will be enabled if you 
    don't specify 1 or 0.</para>

    <para>To specify an argument use the syntax SOME_OPTION = VALUE 
    for example <literal>SO_SNDBUF = 8192</literal>. Note that you must 
    not have any spaces before or after the = sign.</para>

    <para>If you are on a local network then a sensible option 
    might be:</para>

    <para><literal>socket options = IPTOS_LOWDELAY</literal></para>

    <para>If you have a local network then you could try:</para>

    <para><literal>socket options = IPTOS_LOWDELAY TCP_NODELAY</literal></para>

    <para>If you are on a wide area network then perhaps try 
    setting IPTOS_THROUGHPUT. </para>

    <para>Note that several of the options may cause your Samba 
		server to fail completely. Use these options with caution!</para>

<para>Default: <emphasis><parameter>socket options</parameter> = <literal>TCP_NODELAY</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>socket options</parameter> = <literal>IPTOS_LOWDELAY</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>strict allocate</primary></indexterm><anchor id="STRICTALLOCATE"/><title>

strict allocate (S)
</title><variablelist><varlistentry><listitem>
    <para>This is a boolean that controls the handling of
    disk space allocation in the server. When this is set to <constant>yes</constant>
    the server will change from UNIX behaviour of not committing real
    disk storage blocks when a file is extended to the Windows behaviour
    of actually forcing the disk system to allocate real storage blocks
    when a file is created or extended to be a given size. In UNIX
    terminology this means that Samba will stop creating sparse files.</para>

    <para>This option is really designed for file systems that support
    fast allocation of large numbers of blocks such as extent-based file systems.
    On file systems that don't support extents (most notably ext3) this can
    make Samba slower. When you work with large files over &gt;100MB on file
    systems without extents you may even run into problems with clients
    running into timeouts.</para>

    <para>When you have an extent based filesystem it's likely that we can make
    use of unwritten extents which allows Samba to allocate even large amounts
    of space very fast and you will not see any timeout problems caused by
    strict allocate. With strict allocate in use you will also get much better
    out of quota messages in case you use quotas. Another advantage of
    activating this setting is that it will help to reduce file
    fragmentation.</para>

    <para>To give you an idea on which filesystems this setting might currently
    be a good option for you: XFS, ext4, btrfs, ocfs2 on Linux and JFS2 on
    AIX support unwritten extents. On Filesystems that do not support it,
    preallocation is probably an expensive operation where you will see reduced
    performance and risk to let clients run into timeouts when creating large
    files. Examples are ext3, ZFS, HFS+ and most others, so be aware if you
    activate this setting on those filesystems.</para>


<para>Default: <emphasis><parameter>strict allocate</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>strict rename</primary></indexterm><anchor id="STRICTRENAME"/><title>

strict rename (S)
</title><variablelist><varlistentry><listitem>
    <para>By default a Windows SMB server prevents directory
    renames when there are open file or directory handles below
    it in the filesystem hierarchy. Historically Samba has always
    allowed this as POSIX filesystem semantics require it.</para>

    <para>This boolean parameter allows Samba to match the Windows
    behavior. Setting this to "yes" is a very expensive change,
    as it forces Samba to travers the entire open file handle
    database on every directory rename request. In a clustered
    Samba system the cost is even greater than the non-clustered
    case.</para>

    <para>For this reason the default is "no", and it is recommended
    to be left that way unless a specific Windows application requires
    it to be changed.</para>


<para>Default: <emphasis><parameter>strict rename</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>strict sync</primary></indexterm><anchor id="STRICTSYNC"/><title>

strict sync (S)
</title><variablelist><varlistentry><listitem>
    <para>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 <constant>no</constant> (the default) means that
    <citerefentry><refentrytitle>smbd</refentrytitle>
    <manvolnum>8</manvolnum></citerefentry> 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.</para>

<para>Default: <emphasis><parameter>strict sync</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>sync always</primary></indexterm><anchor id="SYNCALWAYS"/><title>

sync always (S)
</title><variablelist><varlistentry><listitem>
    <para>This is a boolean parameter that controls 
    whether writes will always be written to stable storage before 
    the write call returns. If this is <constant>no</constant> then the server will be 
    guided by the client's request in each write call (clients can 
    set a bit indicating that a particular write should be synchronous). 
    If this is <constant>yes</constant> then every write will be followed by a <literal>fsync()
    </literal> call to ensure the data is written to disk. Note that 
    the <parameter moreinfo="none">strict sync</parameter> parameter must be set to
    <constant>yes</constant> in order for this parameter to have 
    any effect.</para>

<para>Default: <emphasis><parameter>sync always</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>use mmap</primary></indexterm><anchor id="USEMMAP"/><title>

use mmap (G)
</title><variablelist><varlistentry><listitem>
    <para>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 <constant>no</constant> by
    default on HPUX. On all other systems this parameter should be left alone. This
    parameter is provided to help the Samba developers track down problems with
    the tdb internal code.
    </para>

<para>Default: <emphasis><parameter>use mmap</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>use sendfile</primary></indexterm><anchor id="USESENDFILE"/><title>

use sendfile (S)
</title><variablelist><varlistentry><listitem>
    <para>If this parameter is <constant>yes</constant>, and the <constant>sendfile()</constant> 
    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
    and cause Samba to be faster. Samba automatically turns this off for clients
    that use protocol levels lower than NT LM 0.12 and when it detects a client is
    Windows 9x (using sendfile from Linux will cause these clients to fail).
    </para>

<para>Default: <emphasis><parameter>use sendfile</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>write cache size</primary></indexterm><anchor id="WRITECACHESIZE"/><title>

write cache size (S)
</title><variablelist><varlistentry><listitem>
    <para>If this integer parameter is set to non-zero value,
    Samba will create an in-memory cache for each oplocked file 
    (it does <emphasis>not</emphasis> do this for 
    non-oplocked files). All writes that the client does not request 
    to be flushed directly to disk will be stored in this cache if possible. 
    The cache is flushed onto disk when a write comes in whose offset 
    would not fit into the cache or when the file is closed by the client. 
    Reads for the file are also served from this cache if the data is stored 
    within it.</para>

    <para>This cache allows Samba to batch client writes into a more 
    efficient write size for RAID disks (i.e. writes may be tuned to 
    be the RAID stripe size) and can improve performance on systems 
    where the disk subsystem is a bottleneck but there is free 
    memory for userspace programs.</para>

    <para>The integer parameter specifies the size of this cache 
		(per oplocked file) in bytes.</para>

    <para>Note that the write cache won't be used for file handles with a smb2 write lease.</para>

<para>Default: <emphasis><parameter>write cache size</parameter> = <literal>0</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>write cache size</parameter> = <literal>262144
#  for a 256k cache size per file</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>get quota command</primary></indexterm><anchor id="GETQUOTACOMMAND"/><title>

get quota command (G)
</title><variablelist><varlistentry><listitem>
	<para>The <literal>get quota command</literal> should only be used 
	whenever there is no operating system API available from the OS that 
	samba can use.</para>

	<para>This option is only available Samba was compiled with
	quotas support.</para>

	<para>This parameter should specify the path to a script that 
	queries the quota information for the specified 
	user/group for the partition that 
	the specified directory is on.</para>

	<para>Such a script is being given 3 arguments:</para>

	<itemizedlist>
		<listitem><para>directory</para></listitem>
		<listitem><para>type of query</para></listitem>
		<listitem><para>uid of user or gid of group</para></listitem>
	</itemizedlist>

	<para>The directory is actually mostly just "." - It needs to be
	treated relatively to the current working directory that the script can
	also query.</para>

	<para>The type of query can be one of:</para>

	<itemizedlist>
		<listitem><para>1 - user quotas</para></listitem>
		<listitem><para>2 - user default quotas (uid = -1)</para></listitem>
		<listitem><para>3 - group quotas</para></listitem>
		<listitem><para>4 - group default quotas (gid = -1)</para></listitem>
	</itemizedlist>

	<para>This script should print one line as output with spaces between the columns. The printed columns should be: 
	      </para>

	<itemizedlist>
		<listitem><para>1 - quota flags (0 = no quotas, 1 = quotas enabled, 2 = quotas enabled and enforced)</para></listitem>
		<listitem><para>2 - number of currently used blocks</para></listitem>
		<listitem><para>3 - the softlimit number of blocks</para></listitem>
		<listitem><para>4 - the hardlimit number of blocks</para></listitem>
		<listitem><para>5 - currently used number of inodes</para></listitem>
		<listitem><para>6 - the softlimit number of inodes</para></listitem>
		<listitem><para>7 - the hardlimit number of inodes</para></listitem>
		<listitem><para>8 (optional) - the number of bytes in a block(default is 1024)</para></listitem>
	</itemizedlist>

<para>Default: <emphasis><parameter>get quota command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>get quota command</parameter> = <literal>/usr/local/sbin/query_quota</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>host msdfs</primary></indexterm><anchor id="HOSTMSDFS"/><title>

host msdfs (G)
</title><variablelist><varlistentry><listitem>
	<para>
	If set to <constant>yes</constant>, Samba will act as a Dfs server, and allow Dfs-aware clients to browse
	Dfs trees hosted on the server.
	</para>

	<para>
	See also the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MSDFSROOT" xlink:href="smb.conf.5.html#MSDFSROOT">msdfs root</link> share  level  parameter.  For more  information  on
	setting  up a Dfs tree on Samba, refer to the MSFDS chapter in the book Samba3-HOWTO.
	</para>

<para>Default: <emphasis><parameter>host msdfs</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>msdfs proxy</primary></indexterm><anchor id="MSDFSPROXY"/><title>

msdfs proxy (S)
</title><variablelist><varlistentry><listitem>
	<para>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 one or multiple, comma separated
	proxied shares using the SMB-Dfs protocol.</para>

	<para>Only Dfs roots can act as proxy shares. Take a look at the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="MSDFSROOT" xlink:href="smb.conf.5.html#MSDFSROOT">msdfs root</link> and <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="HOSTMSDFS" xlink:href="smb.conf.5.html#HOSTMSDFS">host msdfs</link>
	options to find out how to set up a Dfs root share.</para>

<para><emphasis>No default</emphasis></para>
<para>Example: <emphasis><parameter>msdfs proxy</parameter> = <literal>\otherserver\someshare,\otherserver2\someshare</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>msdfs root</primary></indexterm><anchor id="MSDFSROOT"/><title>

msdfs root (S)
</title><variablelist><varlistentry><listitem>
	<para>If set to <constant>yes</constant>, 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
	links of the form <filename>msdfs:serverA\\shareA,serverB\\shareB</filename>
	and so on.  For more information on setting up a Dfs tree on
	Samba, refer to the MSDFS chapter in the Samba3-HOWTO book.</para>

<para>Default: <emphasis><parameter>msdfs root</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>msdfs shuffle referrals</primary></indexterm><anchor id="MSDFSSHUFFLEREFERRALS"/><title>

msdfs shuffle referrals (S)
</title><variablelist><varlistentry><listitem>
	<para>If set to <constant>yes</constant>, Samba will shuffle
	Dfs referrals for a given Dfs link if multiple are available,
	allowing for load balancing across clients. For more information
	on setting up a Dfs tree on Samba, refer to the MSDFS chapter in
	the Samba3-HOWTO book.</para>

<para>Default: <emphasis><parameter>msdfs shuffle referrals</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>ntvfs handler</primary></indexterm><anchor id="NTVFSHANDLER"/><title>

ntvfs handler (S)
</title><variablelist><varlistentry><listitem>
	<para>This specifies the NTVFS handlers for this share.</para>

	<itemizedlist>
	  <listitem><para>posix: Maps POSIX FS semantics to NT semantics</para></listitem>
	  <listitem><para>unixuid: Sets up user credentials based on POSIX gid/uid.</para></listitem>
	  <listitem><para>cifs: Proxies a remote CIFS FS. Mainly useful for testing.</para></listitem>
	  <listitem><para>nbench: Filter module that saves data useful to the nbench benchmark suite.</para></listitem>
	  <listitem><para>ipc: Allows using SMB for inter process communication. Only used for the IPC$ share.</para></listitem>
	  <listitem><para>posix: Maps POSIX FS semantics to NT semantics</para></listitem>
	  <listitem><para>print: Allows printing over SMB. This is
	  LANMAN-style printing, not the be confused with the spoolss
	  DCE/RPC interface used by later versions of
	  Windows.</para></listitem>
	</itemizedlist>

	<para>Note that this option is only used when the NTVFS file server
		is in use. It is not used with the (default)
		s3fs file server.
	</para>

<para>Default: <emphasis><parameter>ntvfs handler</parameter> = <literal>unixuid, default</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>set quota command</primary></indexterm><anchor id="SETQUOTACOMMAND"/><title>

set quota command (G)
</title><variablelist><varlistentry><listitem>
	<para>The <literal>set quota command</literal> should only be used 
	whenever there is no operating system API available from the OS that 
	samba can use.</para>

	<para>This option is only available if Samba was compiled with
	quota support.</para>

	<para>This parameter should specify the path to a script that 
	can set quota for the specified arguments.</para>

	<para>The specified script should take the following arguments:</para>

	<itemizedlist>
		<listitem><para>1 - path to where the quota needs to be set.
		This needs to be interpreted relative to the current working
		directory that the script may also check for.</para></listitem>
		<listitem><para>2 - quota type
			<itemizedlist>
				<listitem><para>1 - user quotas</para></listitem>
				<listitem><para>2 - user default quotas (uid = -1)</para></listitem>
				<listitem><para>3 - group quotas</para></listitem>
				<listitem><para>4 - group default quotas (gid = -1)</para></listitem>
			</itemizedlist></para></listitem>
		<listitem><para>3 - id (uid for user, gid for group, -1 if N/A)</para></listitem>
		<listitem><para>4 - quota state (0 = disable, 1 = enable, 2 = enable and enforce)</para></listitem>
		<listitem><para>5 - block softlimit</para></listitem>
		<listitem><para>6 - block hardlimit</para></listitem>
		<listitem><para>7 - inode softlimit</para></listitem>
		<listitem><para>8 - inode hardlimit</para></listitem>
		<listitem><para>9(optional) - block size, defaults to 1024</para></listitem>
	</itemizedlist>

	<para>The script should output at least one line of data on success. And nothing on failure.</para>

<para>Default: <emphasis><parameter>set quota command</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>set quota command</parameter> = <literal>/usr/local/sbin/set_quota</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>vfs object</primary><see>vfs objects</see></indexterm><title>

<anchor id="VFSOBJECT"/>vfs object
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="VFSOBJECTS">vfs objects</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>vfs objects</primary></indexterm><anchor id="VFSOBJECTS"/><title>

vfs objects (S)
</title><variablelist><varlistentry><listitem>
	<para>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. </para>

<para>Default: <emphasis><parameter>vfs objects</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>vfs objects</parameter> = <literal>extd_audit recycle</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>create krb5 conf</primary></indexterm><anchor id="CREATEKRB5CONF"/><title>

create krb5 conf (G)
</title><variablelist><varlistentry><listitem>

	<para>
	Setting this parameter to <literal>no</literal> prevents
	winbind from creating custom krb5.conf files. Winbind normally does
	this because the krb5 libraries are not AD-site-aware and thus would
	pick any domain controller out of potentially very many. Winbind
	is site-aware and makes the krb5 libraries use a local DC by
	creating its own krb5.conf files.
	</para>
	<para>
	Preventing winbind from doing this might become necessary if you
	have to add special options into your system-krb5.conf that winbind
	does not see.
	</para>


<para>Default: <emphasis><parameter>create krb5 conf</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>idmap backend</primary></indexterm><anchor id="IDMAPBACKEND"/><title>

idmap backend (G)
</title><variablelist><varlistentry><listitem>
	<para>
	The idmap backend provides a plugin interface for Winbind to use
	varying backends to store SID/uid/gid mapping tables.
	</para>

	<para>
	This option specifies the default backend that is used when no special
	configuration set, but it is now deprecated in favour of the new
	spelling <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG*:BACKEND" xlink:href="smb.conf.5.html#IDMAPCONFIG*:BACKEND">idmap config * :  backend</link>.
	</para>

<para>Default: <emphasis><parameter>idmap backend</parameter> = <literal>tdb</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>idmap cache time</primary></indexterm><anchor id="IDMAPCACHETIME"/><title>

idmap cache time (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the number of seconds that Winbind's
	idmap interface will cache positive SID/uid/gid query results. By
    default, Samba will cache these results for one week.
	</para>

<para>Default: <emphasis><parameter>idmap cache time</parameter> = <literal>604800</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>idmap config:OPTION</primary></indexterm><anchor id="IDMAPCONFIG:OPTION"/><title>

idmap config:OPTION (G)
</title><variablelist><varlistentry><listitem>

	<para>
	ID mapping in Samba is the mapping between Windows SIDs and Unix user
	and group IDs. This is performed by Winbindd with a configurable plugin
	interface. Samba's ID mapping is configured by options starting with the
	<link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG" xlink:href="smb.conf.5.html#IDMAPCONFIG">idmap config</link> prefix.
	An idmap option consists of the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG" xlink:href="smb.conf.5.html#IDMAPCONFIG">idmap config</link>
	prefix, followed by a domain name or the asterisk character (*),
	a colon, and the name of an idmap setting for the chosen domain.
	</para>

	<para>
	The idmap configuration is hence divided into groups, one group
	for each domain to be configured, and one group with the
	asterisk instead of a proper domain name, which specifies the
	default configuration that is used to catch all domains that do
	not have an explicit idmap configuration of their own.
	</para>

	<para>
	There are three general options available:
	</para>

	<variablelist>
		<varlistentry>
		<term>backend = backend_name</term>
		<listitem><para>
		This specifies the name of the idmap plugin to use as the
		SID/uid/gid backend for this domain. The standard backends are
		tdb
		(<citerefentry><refentrytitle>idmap_tdb</refentrytitle> <manvolnum>8</manvolnum> </citerefentry>),
		tdb2
		(<citerefentry><refentrytitle>idmap_tdb2</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		ldap
		(<citerefentry><refentrytitle>idmap_ldap</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		,
		rid
		(<citerefentry><refentrytitle>idmap_rid</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		,
		hash
		(<citerefentry><refentrytitle>idmap_hash</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		,
		autorid
		(<citerefentry><refentrytitle>idmap_autorid</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		,
		ad
		(<citerefentry><refentrytitle>idmap_ad</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		,
		and nss.
		(<citerefentry><refentrytitle>idmap_nss</refentrytitle> <manvolnum>8</manvolnum></citerefentry>),
		The corresponding manual pages contain the details, but
		here is a summary.
		</para>
		<para>
		The first three of these create mappings of their own using
		internal unixid counters and store the mappings in a database.
		These are suitable for use in the default idmap configuration.
		The rid and hash backends use a pure algorithmic calculation
		to determine the unixid for a SID. The autorid module is a
		mixture of the tdb and rid backend. It creates ranges for
		each domain encountered and then uses the rid algorithm for each
		of these automatically configured domains individually.
		The ad backend usees unix IDs stored in Active Directory via
		the standard schema extensions. The nss backend reverses
		the standard winbindd setup and gets the unixids via names
		from nsswitch which can be useful in an ldap setup.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>range = low - high</term>
		<listitem><para>
		Defines the available matching uid and gid range for which the
		backend is authoritative. For allocating backends, this also
		defines the start and the end of the range for allocating
		new unique IDs.
		</para>
		<para>
		winbind uses this parameter to find the backend that is
		authoritative for a unix ID to SID mapping, so it must be set
		for each individually configured domain and for the default
		configuration. The configured ranges must be mutually disjoint.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>read only = yes|no</term>
		<listitem><para>
		This option can be used to turn the writing backends
		tdb, tdb2, and ldap into read only mode. This can be useful
		e.g. in cases where a pre-filled database exists that should
		not be extended automatically.
		</para></listitem>
		</varlistentry>
	</variablelist>

	<para>
	The following example illustrates how to configure the <citerefentry>
	<refentrytitle>idmap_ad</refentrytitle> <manvolnum>8</manvolnum>
	</citerefentry> backend for the CORP domain and the
	<citerefentry><refentrytitle>idmap_tdb</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> backend for all other
	domains. This configuration assumes that the admin of CORP assigns
	unix ids below 1000000 via the SFU extensions, and winbind is supposed
	to use the next million entries for its own mappings from trusted
	domains and for local groups for example.
	</para>

	<programlisting>
	idmap config * : backend = tdb
	idmap config * : range = 1000000-1999999

	idmap config CORP : backend  = ad
	idmap config CORP : range = 1000-999999
	</programlisting>
	

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind gid</primary><see>idmap gid</see></indexterm><title>

<anchor id="WINBINDGID"/>winbind gid
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="IDMAPGID">idmap gid</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>idmap gid</primary></indexterm><anchor id="IDMAPGID"/><title>

idmap gid (G)
</title><variablelist><varlistentry><listitem>
	<para>
	The idmap gid parameter specifies the range of group ids
	for the default idmap configuration. It is now deprecated
	in favour of <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG*:RANGE" xlink:href="smb.conf.5.html#IDMAPCONFIG*:RANGE">idmap config * : range</link>.
	</para>

	<para>See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG" xlink:href="smb.conf.5.html#IDMAPCONFIG">idmap config</link> option.</para>

<para>Default: <emphasis><parameter>idmap gid</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>idmap gid</parameter> = <literal>10000-20000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>idmap negative cache time</primary></indexterm><anchor id="IDMAPNEGATIVECACHETIME"/><title>

idmap negative cache time (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the number of seconds that Winbind's
	idmap interface will cache negative SID/uid/gid query results.
	</para>

<para>Default: <emphasis><parameter>idmap negative cache time</parameter> = <literal>120</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind uid</primary><see>idmap uid</see></indexterm><title>

<anchor id="WINBINDUID"/>winbind uid
</title><variablelist><varlistentry><listitem><para>This parameter is a synonym for <link linkend="IDMAPUID">idmap uid</link>.</para></listitem></varlistentry></variablelist>
</section><section><indexterm significance="preferred"><primary>idmap uid</primary></indexterm><anchor id="IDMAPUID"/><title>

idmap uid (G)
</title><variablelist><varlistentry><listitem>
	<para>
	The idmap uid parameter specifies the range of user ids for
	the default idmap configuration. It is now deprecated in favour
	of <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG*:RANGE" xlink:href="smb.conf.5.html#IDMAPCONFIG*:RANGE">idmap config * : range</link>.
	</para>

	<para>See the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="IDMAPCONFIG" xlink:href="smb.conf.5.html#IDMAPCONFIG">idmap config</link> option.</para>

<para>Default: <emphasis><parameter>idmap uid</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>idmap uid</parameter> = <literal>10000-20000</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>neutralize nt4 emulation</primary></indexterm><anchor id="NEUTRALIZENT4EMULATION"/><title>

neutralize nt4 emulation (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether winbindd sends
	the NETLOGON_NEG_NEUTRALIZE_NT4_EMULATION flag in order to bypass
	the NT4 emulation of a domain controller.</para>

	<para>Typically you should not need set this.
	It can be useful for upgrades from NT4 to AD domains.</para>

	<para>The behavior can be controlled per netbios domain
	by using 'neutralize nt4 emulation:NETBIOSDOMAIN = yes' as option.</para>

<para>Default: <emphasis><parameter>neutralize nt4 emulation</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>reject md5 servers</primary></indexterm><anchor id="REJECTMD5SERVERS"/><title>

reject md5 servers (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether winbindd requires support
	for aes support for the netlogon secure channel.</para>

	<para>The following flags will be required NETLOGON_NEG_ARCFOUR,
	NETLOGON_NEG_SUPPORTS_AES, NETLOGON_NEG_PASSWORD_SET2 and NETLOGON_NEG_AUTHENTICATED_RPC.</para>

	<para>You can set this to yes if all domain controllers support aes.
	This will prevent downgrade attacks.</para>

	<para>The behavior can be controlled per netbios domain
	by using 'reject md5 servers:NETBIOSDOMAIN = yes' as option.</para>

	<para>This option takes precedence to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="REQUIRESTRONGKEY" xlink:href="smb.conf.5.html#REQUIRESTRONGKEY">require strong key</link> option.</para>

<para>Default: <emphasis><parameter>reject md5 servers</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>require strong key</primary></indexterm><anchor id="REQUIRESTRONGKEY"/><title>

require strong key (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether winbindd requires support
	for md5 strong key support for the netlogon secure channel.</para>

	<para>The following flags will be required NETLOGON_NEG_STRONG_KEYS,
	NETLOGON_NEG_ARCFOUR and NETLOGON_NEG_AUTHENTICATED_RPC.</para>

	<para>You can set this to no if some domain controllers only support des.
	This might allows weak crypto to be negotiated, may via downgrade attacks.</para>

	<para>The behavior can be controlled per netbios domain
	by using 'require strong key:NETBIOSDOMAIN = no' as option.</para>

	<para>Note for active directory domain this option is hardcoded to 'yes'</para>

	<para>This option yields precedence to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="REJECTMD5SERVERS" xlink:href="smb.conf.5.html#REJECTMD5SERVERS">reject md5 servers</link> option.</para>

	<para>This option takes precedence to the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="CLIENTSCHANNEL" xlink:href="smb.conf.5.html#CLIENTSCHANNEL">client schannel</link> option.</para>

<para>Default: <emphasis><parameter>require strong key</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>template homedir</primary></indexterm><anchor id="TEMPLATEHOMEDIR"/><title>

template homedir (G)
</title><variablelist><varlistentry><listitem>
	<para>When filling out the user information for a Windows NT 
	user, the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon  uses this
	parameter to fill in the home directory for that user. If the
	string <parameter moreinfo="none">%D</parameter> is present it
	is substituted  with the user's Windows NT domain name. If the
	string <parameter moreinfo="none">%U</parameter> is present it
	is substituted with the user's Windows  NT user name.</para>

<para>Default: <emphasis><parameter>template homedir</parameter> = <literal>/home/%D/%U</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>template shell</primary></indexterm><anchor id="TEMPLATESHELL"/><title>

template shell (G)
</title><variablelist><varlistentry><listitem>
	<para>When filling out the user information for a Windows NT 
	user, the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon uses this
	parameter to fill in the login shell for that user.</para>

<para>Default: <emphasis><parameter>template shell</parameter> = <literal>/bin/false</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind cache time</primary></indexterm><anchor id="WINBINDCACHETIME"/><title>

winbind cache time (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the number of 
	seconds the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon will cache 
	user and group information before querying a Windows NT server 
	again.</para>

        <para>
	This does not apply to authentication requests, these are always 
	evaluated in real time unless the <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINBINDOFFLINELOGON" xlink:href="smb.conf.5.html#WINBINDOFFLINELOGON">winbind   offline logon</link> option has been enabled.
	</para>

<para>Default: <emphasis><parameter>winbind cache time</parameter> = <literal>300</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbindd privileged socket directory</primary></indexterm><anchor id="WINBINDDPRIVILEGEDSOCKETDIRECTORY"/><title>

winbindd privileged socket directory (G)
</title><variablelist><varlistentry><listitem>
	<para>This setting controls the location of the winbind daemon's privileged
		socket.</para>

<para>Default: <emphasis><parameter>winbindd privileged socket directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/lib/winbindd_privileged</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbindd socket directory</primary></indexterm><anchor id="WINBINDDSOCKETDIRECTORY"/><title>

winbindd socket directory (G)
</title><variablelist><varlistentry><listitem>
	<para>This setting controls the location of the winbind daemon's socket.</para>
	<para>Except within automated test scripts, this should not be
	altered, as the client tools (nss_winbind etc) do not honour
	this parameter.  Client tools must then be advised of the
	altered path with the WINBINDD_SOCKET_DIR environment
	varaible.</para>

<para>Default: <emphasis><parameter>winbindd socket directory</parameter> = <literal>/home/ubuntu/autobuild/b22271/prefix/samba/var/run/winbindd</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind enum groups</primary></indexterm><anchor id="WINBINDENUMGROUPS"/><title>

winbind enum groups (G)
</title><variablelist><varlistentry><listitem>
	<para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> it may be necessary to suppress 
	the enumeration of groups through the <literal>setgrent()</literal>,
	<literal>getgrent()</literal> and
	<literal>endgrent()</literal> group of system calls.  If
	the <parameter moreinfo="none">winbind enum groups</parameter> parameter is
	<constant>no</constant>, calls to the <literal>getgrent()</literal> system
	call will not return any data. </para>

<warning><para>Turning off group enumeration may cause some programs to behave oddly.  </para></warning>

<para>Default: <emphasis><parameter>winbind enum groups</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind enum users</primary></indexterm><anchor id="WINBINDENUMUSERS"/><title>

winbind enum users (G)
</title><variablelist><varlistentry><listitem>
	<para>On large installations using <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> it may be
	necessary to suppress the enumeration of users through the <literal>setpwent()</literal>,
	 <literal>getpwent()</literal> and
	 <literal>endpwent()</literal> group of system calls.  If
	the <parameter moreinfo="none">winbind enum users</parameter> parameter is
	 <constant>no</constant>, calls to the <literal>getpwent</literal> system call
	will not return any data. </para>

<warning><para>Turning off user
	enumeration may cause some programs to behave oddly.  For
	example, the finger program relies on having access to the
	full user list when searching for matching
	usernames. </para></warning>

<para>Default: <emphasis><parameter>winbind enum users</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind expand groups</primary></indexterm><anchor id="WINBINDEXPANDGROUPS"/><title>

winbind expand groups (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls the maximum depth that winbindd
              will traverse when flattening nested group memberships
	      of Windows domain groups.  This is different from the
	      <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINBINDNESTEDGROUPS" xlink:href="smb.conf.5.html#WINBINDNESTEDGROUPS">winbind nested groups</link> option
              which implements the Windows NT4 model of local group 
	      nesting.  The "winbind expand groups"
              parameter specifically applies to the membership of 
	      domain groups.</para>

	 <para>Be aware that a high value for this parameter can
	 result in system slowdown as the main parent winbindd daemon
	 must perform the group unrolling and will be unable to answer
	 incoming NSS or authentication requests during this time.</para>

	<para>The default value was changed from 1 to 0 with Samba 4.2.
	Some broken applications calculate the group memberships of
	users by traversing groups, such applications will require
	"winbind expand groups = 1". But the new default makes winbindd more reliable
	as it doesn't require SAMR access to domain controllers of trusted domains.</para>

<para>Default: <emphasis><parameter>winbind expand groups</parameter> = <literal>0</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind max clients</primary></indexterm><anchor id="WINBINDMAXCLIENTS"/><title>

winbind max clients (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the maximum number of clients
	the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon can connect with.
	</para>

<para>Default: <emphasis><parameter>winbind max clients</parameter> = <literal>200</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind max domain connections</primary></indexterm><anchor id="WINBINDMAXDOMAINCONNECTIONS"/><title>

winbind max domain connections (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the maximum number of simultaneous
	connections that the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon should open to the
	domain controller of one domain.
	Setting this parameter to a value greater than 1 can improve
	scalability with many simultaneous winbind requests,
	some of which might be slow.
	</para>
	<para>
	Note that if <link xmlns:xlink="http://www.w3.org/1999/xlink" linkend="WINBINDOFFLINELOGON" xlink:href="smb.conf.5.html#WINBINDOFFLINELOGON">winbind offline logon</link> is set to
	<constant>Yes</constant>, then only one
	DC connection is allowed per domain, regardless of this setting.
	</para>

<para>Default: <emphasis><parameter>winbind max domain connections</parameter> = <literal>1</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind max domain connections</parameter> = <literal>10</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind nested groups</primary></indexterm><anchor id="WINBINDNESTEDGROUPS"/><title>

winbind nested groups (G)
</title><variablelist><varlistentry><listitem>
	<para>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
                 between DC's through their SAM) and can contain users and
                 global groups from any trusted SAM. To be able to use nested
                 groups, you need to run nss_winbind.</para>

<para>Default: <emphasis><parameter>winbind nested groups</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind normalize names</primary></indexterm><anchor id="WINBINDNORMALIZENAMES"/><title>

winbind normalize names (G)
</title><variablelist><varlistentry><listitem>
	<para>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".
	  Frequently Unix shell scripts will have difficulty with usernames
	  contains whitespace due to the default field separator in the shell.
	  If your domain possesses names containing the underscore character,
	  this option may cause problems unless the name aliasing feature
	  is supported by your nss_info plugin.
        </para>

	<para>This feature also enables the name aliasing API which can
	  be used to make domain user and group names to a non-qualified
	  version.  Please refer to the manpage for the configured
	  idmap and nss_info plugin for the specifics on how to configure
	  name aliasing for a specific configuration.  Name aliasing takes
	  precedence (and is mutually exclusive) over the whitespace
	  replacement mechanism discussed previously.
	  </para>


<para>Default: <emphasis><parameter>winbind normalize names</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind normalize names</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind nss info</primary></indexterm><anchor id="WINBINDNSSINFO"/><title>

winbind nss info (G)
</title><variablelist><varlistentry><listitem>

	<para>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:

	<itemizedlist>
		<listitem>
			<para><parameter moreinfo="none">template</parameter>
			- The default, using the parameters of <parameter moreinfo="none">template
			shell</parameter> and <parameter moreinfo="none">template homedir</parameter>)
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">&lt;sfu | sfu20 | rfc2307 &gt;</parameter>
			- 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
			directory attributes directly from your Directory Server. For SFU 3.0 or 3.5 simply choose
			"sfu", if you use SFU 2.0 please choose "sfu20". Note that
			retrieving UID and GID from your ADS-Server requires to
			use <parameter moreinfo="none">idmap config DOMAIN:backend</parameter> = ad
			as well. The primary group membership is currently
			always calculated via the "primaryGroupID" LDAP attribute.
			</para>
		</listitem>
	</itemizedlist>

</para>

<para>Default: <emphasis><parameter>winbind nss info</parameter> = <literal>template</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind nss info</parameter> = <literal>sfu</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind offline logon</primary></indexterm><anchor id="WINBINDOFFLINELOGON"/><title>

winbind offline logon (G)
</title><variablelist><varlistentry><listitem>

	<para>This parameter is designed to control whether Winbind should
	allow to login with the <parameter moreinfo="none">pam_winbind</parameter> 
	module using Cached Credentials. If enabled, winbindd will store user credentials
	from successful logins encrypted in a local cache.
	</para>


<para>Default: <emphasis><parameter>winbind offline logon</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind offline logon</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind reconnect delay</primary></indexterm><anchor id="WINBINDRECONNECTDELAY"/><title>

winbind reconnect delay (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the number of
	seconds the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon will wait between
	attempts to contact a Domain controller for a domain that is
	determined to be down or not contactable.</para>

<para>Default: <emphasis><parameter>winbind reconnect delay</parameter> = <literal>30</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind refresh tickets</primary></indexterm><anchor id="WINBINDREFRESHTICKETS"/><title>

winbind refresh tickets (G)
</title><variablelist><varlistentry><listitem>

	<para>This parameter is designed to control whether Winbind should refresh Kerberos Tickets
	retrieved using the <parameter moreinfo="none">pam_winbind</parameter> module.

</para>

<para>Default: <emphasis><parameter>winbind refresh tickets</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind refresh tickets</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind request timeout</primary></indexterm><anchor id="WINBINDREQUESTTIMEOUT"/><title>

winbind request timeout (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies the number of
	seconds the <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> daemon will wait before
	disconnecting either a client connection with no outstanding
	requests (idle) or a client connection with a request that has
	remained outstanding (hung) for longer than this number of seconds.</para>

<para>Default: <emphasis><parameter>winbind request timeout</parameter> = <literal>60</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind rpc only</primary></indexterm><anchor id="WINBINDRPCONLY"/><title>

winbind rpc only (G)
</title><variablelist><varlistentry><listitem>

	<para>
	Setting this parameter to <literal>yes</literal> forces 
	winbindd to use RPC instead of LDAP to retrieve information from Domain
        Controllers.
	</para>
	

<para>Default: <emphasis><parameter>winbind rpc only</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind sealed pipes</primary></indexterm><anchor id="WINBINDSEALEDPIPES"/><title>

winbind sealed pipes (G)
</title><variablelist><varlistentry><listitem>
	<para>This option controls whether any requests from winbindd to domain controllers
		pipe will be sealed. Disabling sealing can be useful for debugging
		purposes.</para>

	<para>The behavior can be controlled per netbios domain
	by using 'winbind sealed pipes:NETBIOSDOMAIN = no' as option.</para>

<para>Default: <emphasis><parameter>winbind sealed pipes</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind separator</primary></indexterm><anchor id="WINBINDSEPARATOR"/><title>

winbind separator (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter allows an admin to define the character 
	used when listing a username of the form of <replaceable>DOMAIN
	</replaceable>\<replaceable>user</replaceable>.  This parameter 
	is only applicable when using the <filename moreinfo="none">pam_winbind.so</filename>
	and <filename moreinfo="none">nss_winbind.so</filename> modules for UNIX services.
	</para>

	<para>Please note that setting this parameter to + causes problems
	with group membership at least on glibc systems, as the character +
	is used as a special character for NIS in /etc/group.</para>

<para>Default: <emphasis><parameter>winbind separator</parameter> = <literal>\</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind separator</parameter> = <literal>+</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind trusted domains only</primary></indexterm><anchor id="WINBINDTRUSTEDDOMAINSONLY"/><title>

winbind trusted domains only (G)
</title><variablelist><varlistentry><listitem>
	<para>
	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.
	Therefore, the user <literal>DOMAIN\user1</literal> would be mapped to 
	the account user1 in /etc/passwd instead of allocating a new uid for him or her.
	</para>

	<para>
	This parameter is now deprecated in favor of the newer idmap_nss backend.
	Refer to the <citerefentry><refentrytitle>idmap_nss</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> man page for more information.
	</para>

<para>Default: <emphasis><parameter>winbind trusted domains only</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>winbind use default domain</primary></indexterm><anchor id="WINBINDUSEDEFAULTDOMAIN"/><title>

winbind use default domain (G)
</title><variablelist><varlistentry><listitem>
	<para>This parameter specifies whether the
	 <citerefentry><refentrytitle>winbindd</refentrytitle> 
	<manvolnum>8</manvolnum></citerefentry> 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 benefit Windows users, it makes SSH, FTP and
	e-mail function in a way much closer to the way they
	would in a native unix system.</para>
	<para>This option should be avoided if possible. It can cause confusion
	about responsibilities for a user or group. In many situations it is
	not clear whether winbind or /etc/passwd should be seen as authoritative
	for a user, likewise for groups.</para>

<para>Default: <emphasis><parameter>winbind use default domain</parameter> = <literal>no</literal>
</emphasis>
</para>
<para>Example: <emphasis><parameter>winbind use default domain</parameter> = <literal>yes</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>dns proxy</primary></indexterm><anchor id="DNSPROXY"/><title>

dns proxy (G)
</title><variablelist><varlistentry><listitem>
	<para>Specifies that <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> 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.</para>

	<para>Note that the maximum length for a NetBIOS name is 15 
	characters, so the DNS name (or DNS alias) can likewise only be 
	15 characters, maximum.</para>

	<para><literal>nmbd</literal> spawns a second copy of itself to do the
	DNS name lookup requests, as doing a name lookup is a blocking 
	action.</para>

<para>Default: <emphasis><parameter>dns proxy</parameter> = <literal>yes</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wins hook</primary></indexterm><anchor id="WINSHOOK"/><title>

wins hook (G)
</title><variablelist><varlistentry><listitem>
	<para>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 
	dynamic DNS.</para>

	<para>The wins hook parameter specifies the name of a script 
	or executable that will be called as follows:</para>

	<para><literal>wins_hook operation name nametype ttl IP_list</literal></para>

	<itemizedlist>
		<listitem>
			<para>The first argument is the operation and is
			one  of "add", "delete", or
			"refresh". In most cases the operation
			can  be ignored as the rest of the parameters
			provide sufficient  information. Note that
			"refresh" may sometimes be called when
			the  name has not previously been added, in that
			case it should be treated  as an add.</para>
		</listitem>

		<listitem>
			<para>The second argument is the NetBIOS name. If the 
			name is not a legal name then the wins hook is not called. 
			Legal names contain only  letters, digits, hyphens, underscores 
			and periods.</para>
		</listitem>

		<listitem>
			<para>The third argument is the NetBIOS name 
			type as a 2 digit hexadecimal number. </para>
		</listitem>

		<listitem>
			<para>The fourth argument is the TTL (time to live) 
			for the name in seconds.</para>
		</listitem>
			
		<listitem>
			<para>The fifth and subsequent arguments are the IP 
			addresses currently registered for that name. If this list is 
			empty then the name should be deleted.</para>
		</listitem>
	</itemizedlist>

	<para>An example script that calls the BIND dynamic DNS update 
	program <literal>nsupdate</literal> is provided in the examples 
	directory of the Samba source code. </para>

<para><emphasis>No default</emphasis></para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wins proxy</primary></indexterm><anchor id="WINSPROXY"/><title>

wins proxy (G)
</title><variablelist><varlistentry><listitem>
	<para>This is a boolean that controls if <citerefentry><refentrytitle>nmbd</refentrytitle>                                 
	<manvolnum>8</manvolnum></citerefentry> will respond to broadcast name 
	queries on behalf of  other hosts. You may need to set this 
	to <constant>yes</constant> for some older clients.</para>

<para>Default: <emphasis><parameter>wins proxy</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wins server</primary></indexterm><anchor id="WINSSERVER"/><title>

wins server (G)
</title><variablelist><varlistentry><listitem>
	<para>This specifies the IP address (or DNS name: IP 
	address for preference) of the WINS server that <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> should register with. If you have a WINS server on 
	your network then you should set this to the WINS server's IP.</para>

	<para>You should point this at your WINS server if you have a
	multi-subnetted network.</para>

	<para>If you want to work in multiple namespaces, you can 
	give every wins server a 'tag'. For each tag, only one 
	(working) server will be queried for a name. The tag should be 
	separated from the ip address by a colon.
	</para>

	<note><para>You need to set up Samba to point 
	to a WINS server if you have multiple subnets and wish cross-subnet 
	browsing to work correctly.</para></note>
	<para>See the chapter in the Samba3-HOWTO on Network Browsing.</para>

<para>Default: <emphasis><parameter>wins server</parameter> = <literal/>
</emphasis>
</para>
<para>Example: <emphasis><parameter>wins server</parameter> = <literal>mary:192.9.200.1 fred:192.168.3.199 mary:192.168.2.61
	
# For this example when querying a certain name, 192.19.200.1 will 
	be asked first and if that doesn't respond 192.168.2.61. If either 
	of those doesn't know the name 192.168.3.199 will be queried.</literal>
</emphasis>
</para><para>Example: <emphasis><parameter>wins server</parameter> = <literal>192.9.200.1 192.168.2.61</literal>
</emphasis>
</para>
</listitem></varlistentry></variablelist>
</section>
<section><indexterm significance="preferred"><primary>wins support</primary></indexterm><anchor id="WINSSUPPORT"/><title>

wins support (G)
</title><variablelist><varlistentry><listitem>
	<para>This boolean controls if the <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry> process in Samba will act as a WINS server. You should 
	not set this to <constant>yes</constant> unless you have a multi-subnetted network and 
	you wish a particular <literal>nmbd</literal> to be your WINS server. 
	Note that you should <emphasis>NEVER</emphasis> set this to <constant>yes</constant>
	on more than one machine in your network.</para>


<para>Default: <emphasis><parameter>wins support</parameter> = <literal>no</literal>
</emphasis>
</para>

</listitem></varlistentry></variablelist>
</section>
</section>

</refsect1>

<refsect1>
	<title>WARNINGS</title>
	
	<para>
	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.
	</para>

	<para>
	On a similar note, many clients - especially DOS clients - limit service names to eight characters.
	<citerefentry><refentrytitle>smbd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> 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.
	</para>

	<para>
	Use of the <literal>[homes]</literal> and <literal>[printers]</literal> special sections make life 
	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.
	</para>

</refsect1>

<refsect1>
	<title>VERSION</title>

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

<refsect1>
	<title>SEE ALSO</title>
	<para>
	<citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbpasswd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba-tool</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmblookup</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry>.</para>
</refsect1>

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

</refentry>
