Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

[openldap] / doc / man / man5 / slapo-pcache.5

diff --git a/doc/man/man5/slapo-pcache.5 b/doc/man/man5/slapo-pcache.5
index 33c91132aea3f1c3fe37defc59d3c81636953e1b..ef8fb212ad210f3ad8dfe734e9b60b67953c9a98 100644 (file)
--- a/doc/man/man5/slapo-pcache.5
+++ b/doc/man/man5/slapo-pcache.5
@@ -1,5 +1,5 @@
 .TH SLAPO-PCACHE 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2009 The OpenLDAP Foundation, All Rights Reserved.
+.\" Copyright 1998-2011 The OpenLDAP Foundation, All Rights Reserved.
 .\" Copying restrictions apply.  See the COPYRIGHT file.
 .\" Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
 .\" $OpenLDAP$
@@ -49,7 +49,8 @@ with the
 .BR meta ,
 and
 .BR sql
-backends.
+backends. Please note that the underlying backend must have a configured
+.BR rootdn.
 .TP
 .B pcache <database> <max_entries> <numattrsets> <entry_limit> <cc_period> 
 The directive enables proxy caching in the current backend and sets general
@@ -78,6 +79,7 @@ special attributes "*" (all user attributes), "+" (all operational attributes)
 or both; in the latter case, any other attribute is redundant and should
 be avoided for clarity.  A set of attributes can contain "1.1" as the only
 attribute; in this case, only the presence of the entries is cached.
+Attributes prefixed by "undef:" need not be present in the schema.
 
 .TP
 .B pcacheMaxQueries <queries>
@@ -146,7 +148,7 @@ template "(&(objectClass=posixAccount)(uid=))" should be used here. When
 converted to a regular template e.g. "(&(objectClass=)(uid=))" this
 template and the <attrset_index> must match an already defined
 \fBpcacheTemplate\fP clause. The "time to refresh" <ttr> determines the
-time interval after which the cached credentials will be refreshed. The
+time interval after which the cached credentials may be refreshed. The
 first Bind request that occurs after that time will trigger the refresh
 attempt. Refreshes are not performed when the overlay is Offline. There
 is no "time to live" parameter for the Bind credentials; the credentials
@@ -212,7 +214,7 @@ cachesize 100
 .LP
 Any valid directives for the chosen database type may be used. Indexing
 should be used as appropriate for the queries being handled. In addition,
-an equality index on the \fBqueryid\fP attribute should be configured, to
+an equality index on the \fBpcacheQueryid\fP attribute should be configured, to
 assist in the removal of expired query data.
 .SH BACKWARD COMPATIBILITY
 The configuration keywords have been renamed and the older form is