s3-docs: Add more verbose description of "username map cache time".
[Samba/gebeck_regimport.git] / docs-xml / smbdotconf / security / usernamemapcachetime.xml
blob4361b1896d8cc65a956149b7897f8526e3a4c035
1 <samba:parameter name="username map cache time"
2                  context="G"
3                  advanced="1" developer="0"
4                                  type="integer"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7         <para>
8         Mapping usernames with the <smbconfoption name="username map"/>
9         or <smbconfoption name="username map script"/>
10         features of Samba can be relatively expensive.
11         During login of a user, the mapping is done several times.
12         In particular, calling the <smbconfoption name="username map script"/>
13         can slow down logins if external databases have to be queried from
14         the script being called.
15         </para>
17         <para>
18         The parameter <smbconfoption name="username map cache time"/>
19         controls a mapping cache. It specifies the number of seconds a
20         mapping from the username map file or script is to be efficiently cached.
21         The default of 0 means no caching is done.
22         </para>
23 </description>
25 <value type="default">0</value>
26 <value type="example">60</value>
27 </samba:parameter>