s3-docs: Add more verbose description of "username map cache time".
authorVolker Lendecke <vl@samba.org>
Mon, 19 Jul 2010 10:22:05 +0000 (12:22 +0200)
committerKarolin Seeger <kseeger@samba.org>
Mon, 19 Jul 2010 10:22:05 +0000 (12:22 +0200)
docs-xml/smbdotconf/security/usernamemapcachetime.xml

index 5461cb1a6c8f1546c7b67d884d746258b8d737ad..4361b1896d8cc65a956149b7897f8526e3a4c035 100644 (file)
@@ -4,13 +4,22 @@
                                 type="integer"
                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
 <description>
-    <para>This option controls if and how long the result of the
-      <smbconfoption name="username map"/> and
-      <smbconfoption name="username map script"/> across smbds in gencache.
-      If set to non-zero, it denotes the number of seconds the output of
-      both mappings will be cached.</para>
-    <para>This option is mainly useful for heavy-weight
-      <smbconfoption name="username map script"/> scripts.</para>
+       <para>
+       Mapping usernames with the <smbconfoption name="username map"/>
+       or <smbconfoption name="username map script"/>
+       features of Samba can be relatively expensive.
+       During login of a user, the mapping is done several times.
+       In particular, calling the <smbconfoption name="username map script"/>
+       can slow down logins if external databases have to be queried from
+       the script being called.
+       </para>
+
+       <para>
+       The parameter <smbconfoption name="username map cache time"/>
+       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>
 </description>
 
 <value type="default">0</value>