summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVolker Lendecke <vl@samba.org>2010-07-19 12:22:05 +0200
committerKarolin Seeger <kseeger@samba.org>2010-07-19 12:22:05 +0200
commit4c0f760edfa9ccdfe0340af46c27e388457ae9af (patch)
treec9f3ad68a0196d1d6bdd042ddfefbe23494de786
parenta785b4349c9041c81e0fb17060e0c0c4ece99439 (diff)
downloadsamba-4c0f760edfa9ccdfe0340af46c27e388457ae9af.tar.gz
samba-4c0f760edfa9ccdfe0340af46c27e388457ae9af.tar.bz2
samba-4c0f760edfa9ccdfe0340af46c27e388457ae9af.zip
s3-docs: Add more verbose description of "username map cache time".
-rw-r--r--docs-xml/smbdotconf/security/usernamemapcachetime.xml23
1 files changed, 16 insertions, 7 deletions
diff --git a/docs-xml/smbdotconf/security/usernamemapcachetime.xml b/docs-xml/smbdotconf/security/usernamemapcachetime.xml
index 5461cb1a6c..4361b1896d 100644
--- a/docs-xml/smbdotconf/security/usernamemapcachetime.xml
+++ b/docs-xml/smbdotconf/security/usernamemapcachetime.xml
@@ -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>