s3:docs: update the idmap_ldap manpage to reflect current facts.
authorMichael Adam <obnox@samba.org>
Tue, 20 Jan 2009 23:13:29 +0000 (00:13 +0100)
committerMichael Adam <obnox@samba.org>
Tue, 20 Jan 2009 23:16:29 +0000 (00:16 +0100)
Michael

docs-xml/manpages-3/idmap_ldap.8.xml

index c09c141bb49ecdfd66a660158f413630586c0223..ea9e5bf07ea69229972af34398dbc6ea99dba9fe 100644 (file)
 
        <para>The idmap_ldap plugin provides a means for Winbind to
        store and retrieve SID/uid/gid mapping tables in an LDAP directory
-       service.  The module implements both the &quot;idmap&quot; and
-       &quot;idmap alloc&quot; APIs.
+       service.
+       In contrast to read only backends like idmap_rid, it is an allocating
+       backend: This means that it needs to allocate new user and group IDs to
+       create new mappings as requests to yet unmapped users are answered.
+       </para>
+
+       <para>
+       Note that in order for this (or any other allocating) backend to
+       function at all, the default backend needs to be writeable.
+       The ranges used for uid and gid allocation are the default ranges
+       configured by &quot;idmap uid&quot; and &quot;idmap gid&quot;.
+       </para>
+
+       <para>
+       Furthermore, since there is only one global allocating backend
+       responsible for all domains using writeable idmap backends,
+       any explicitly configured domain with idmap backend ldap
+       should have the same range as the default range, since it needs
+       to use the global uid / gid allocator. See the example below.
        </para>
 </refsynopsisdiv>
 
                <term>range = low - high</term>
                 <listitem><para>
                        Defines the available matching uid and gid range for which the
-                       backend is authoritative.  Note that the range commonly matches
-                       the allocation range due to the fact that the same backend will
-                       store and retrieve SID/uid/gid mapping entries.  If the parameter
-                       is absent, Winbind fail over to use the &quot;idmap uid&quot; and
-                       &quot;idmap gid&quot; options from smb.conf.
+                       backend is authoritative.
+                       If the parameter is absent, Winbind fails over to use the
+                       &quot;idmap uid&quot; and &quot;idmap gid&quot; options
+                       from smb.conf.
                 </para></listitem>
                 </varlistentry>
        </variablelist>