docs-xml: mention that the man pages are "part of" version x
[sfrench/samba-autobuild/.git] / docs-xml / manpages / smb.conf.5.xml
index e09eee0d55f1ef11e6bd785ab02ca2bac1f08799..f72833c003fdd267a701f73d08dca38c696fc653 100644 (file)
@@ -1,3 +1,5 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
 <refentry id="smb.conf.5" xmlns:xi="http://www.w3.org/2003/XInclude"
                         xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
        
@@ -6,7 +8,7 @@
        <manvolnum>5</manvolnum>
        <refmiscinfo class="source">Samba</refmiscinfo>
        <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
-       <refmiscinfo class="version">4.0</refmiscinfo>
+       <refmiscinfo class="version">&doc.version;</refmiscinfo>
 </refmeta>
 
 
        <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
-        <filename moreinfo="none">smb.conf</filename> file is designed to be configured and administered by the
-        <citerefentry><refentrytitle>swat</refentrytitle> <manvolnum>8</manvolnum></citerefentry> program. The
        complete description of the file format and possible parameters held within are here for reference purposes.
-       </para> 
+       </para>
 </refsect1>
 
 <refsect1 id="FILEFORMATSECT">
@@ -472,8 +472,11 @@ chmod 1770 /usr/local/samba/lib/usershares
                
                <varlistentry>
                <term>%R</term>
-               <listitem><para>the selected protocol level after protocol negotiation. It can be one of CORE, COREPLUS, 
-                       LANMAN1, LANMAN2 or NT1.</para></listitem>
+               <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>
@@ -508,6 +511,13 @@ chmod 1770 /usr/local/samba/lib/usershares
                </listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>%J</term>
+               <listitem><para>the IP address of the client machine,
+                       colons/dots replaced by underscores.</para>
+               </listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>%i</term>
                <listitem><para>the local IP address to which a client connected.</para>
@@ -516,11 +526,23 @@ chmod 1770 /usr/local/samba/lib/usershares
                </listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>%j</term>
+               <listitem><para>the local IP address to which a client connected,
+                       colons/dots replaced by underscores.</para>
+               </listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>%T</term>
                <listitem><para>the current date and time.</para></listitem>
                </varlistentry>
 
+               <varlistentry>
+               <term>%t</term>
+               <listitem><para>the current date and time in a minimal format without colons (YYYYYmmdd_HHMMSS).</para></listitem>
+               </varlistentry>
+
                <varlistentry>
                <term>%D</term>
                <listitem><para>name of the domain or workgroup of the current user.</para></listitem>
@@ -753,11 +775,74 @@ chmod 1770 /usr/local/samba/lib/usershares
 
 </refsect1>
 
+<refsect1 ID="IDMAPCONSIDERATIONS">
+       <title>IDENTITY MAPPING CONSIDERATIONS</title>
+
+       <para>
+       In the SMB protocol, users, groups, and machines are represented by their security identifiers (SIDs).
+       On POSIX system Samba processes need to run under corresponding POSIX user identities and
+       with supplemental POSIX groups to allow access to the files owned by those users and groups.
+       The process of mapping SIDs to POSIX users and groups is called <emphasis>IDENTITY MAPPING</emphasis>
+       or, in short, <emphasis>ID MAPPING</emphasis>.
+       </para>
+
+       <para>
+       Samba supports multiple ways to map SIDs to POSIX users and groups. The configuration is driven by
+       the <smbconfoption name="idmap config DOMAIN : OPTION"/> option which allows one to specify identity
+       mapping (idmap) options for each domain separately.
+       </para>
+
+       <para>
+       Identity mapping modules implement different strategies for mapping of SIDs to POSIX user and group
+       identities. They are applicable to different use cases and scenarios. It is advised to read the documentation
+       of the individual identity mapping modules before choosing a specific scenario to use. Each identity
+       management module is documented in a separate manual page. The standard idmap 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>),
+       nss (<citerefentry><refentrytitle>idmap_nss</refentrytitle> <manvolnum>8</manvolnum></citerefentry>), and
+       rfc2307 (<citerefentry><refentrytitle>idmap_rfc2307</refentrytitle> <manvolnum>8</manvolnum></citerefentry>).
+       </para>
+
+       <para>
+       Overall, ID mapping configuration should be decided carefully. Changes to the already deployed ID mapping
+       configuration may create the risk of losing access to the data or disclosing the data to the wrong parties.
+       </para>
+
+       <para>
+       This example shows how to configure two domains with <citerefentry><refentrytitle>idmap_rid</refentrytitle>
+       <manvolnum>8</manvolnum> </citerefentry>, the principal domain and a trusted domain,
+       leaving the default id mapping scheme at tdb.
+       </para>
+
+       <programlisting>
+       [global]
+       security = domain
+       workgroup = MAIN
+
+       idmap config * : backend        = tdb
+       idmap config * : range          = 1000000-1999999
+
+       idmap config MAIN : backend     = rid
+       idmap config MAIN : range       = 5000000-5999999
+
+       idmap config TRUSTED : backend  = rid
+       idmap config TRUSTED : range    = 6000000-6999999
+       </programlisting>
+</refsect1>
+
 <refsect1>
        <title>EXPLANATION OF EACH PARAMETER</title>
        
        <samba:parameterlist>
-               <xi:include href="../smbdotconf/parameters.all.xml" parse="xml"/>
+               <!-- 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 //-->
+               <xi:include href="http://www.samba.org/samba/smbdotconf/parameters.all.xml" parse="xml"/>
        </samba:parameterlist>
 
 </refsect1>
@@ -789,7 +874,7 @@ chmod 1770 /usr/local/samba/lib/usershares
 <refsect1>
        <title>VERSION</title>
 
-       <para>This man page is correct for version 3 of the Samba suite.</para>
+       <para>This man page is part of version &doc.version; of the Samba suite.</para>
 </refsect1>
 
 <refsect1>
@@ -797,13 +882,14 @@ chmod 1770 /usr/local/samba/lib/usershares
        <para>
        <citerefentry><refentrytitle>samba</refentrytitle>
        <manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbpasswd</refentrytitle>
-       <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>swat</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>, <citerefentry><refentrytitle>testprns</refentrytitle>
        <manvolnum>1</manvolnum></citerefentry>.</para>
 </refsect1>
 
@@ -814,14 +900,6 @@ chmod 1770 /usr/local/samba/lib/usershares
        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>