From 0cfffff4e223e4828d822d487ba87b90f5289ea3 Mon Sep 17 00:00:00 2001 From: Howard Chu Date: Mon, 24 Sep 2007 05:18:42 +0000 Subject: [PATCH] Add sortvals doc --- doc/man/man5/slapd-config.5 | 84 +++++++++++++++++++++---------------- doc/man/man5/slapd.conf.5 | 11 +++++ 2 files changed, 59 insertions(+), 36 deletions(-) diff --git a/doc/man/man5/slapd-config.5 b/doc/man/man5/slapd-config.5 index 146dc30131..0d88236129 100644 --- a/doc/man/man5/slapd-config.5 +++ b/doc/man/man5/slapd-config.5 @@ -479,6 +479,8 @@ lookup. The default is 2. For example, with the default values, a search using this filter "cn=*abcdefgh*" would generate index lookups for "abcd", "cdef", and "efgh". +Note: Indexing support depends on the particular backend in use. + .TP .B olcLocalSSF: Specifies the Security Strength Factor (SSF) to be given local LDAP sessions, @@ -616,42 +618,6 @@ versions of crypt(3) to use an MD5 algorithm and provides 8 random characters of salt. The default is "%s", which provides 31 characters of salt. .TP -.B olcPasswordHash: [...] -This option configures one or more hashes to be used in generation of user -passwords stored in the userPassword attribute during processing of -LDAP Password Modify Extended Operations (RFC 3062). -The must be one of -.BR {SSHA} , -.BR {SHA} , -.BR {SMD5} , -.BR {MD5} , -.BR {CRYPT} , -and -.BR {CLEARTEXT} . -The default is -.BR {SSHA} . - -.B {SHA} -and -.B {SSHA} -use the SHA-1 algorithm (FIPS 160-1), the latter with a seed. - -.B {MD5} -and -.B {SMD5} -use the MD5 algorithm (RFC 1321), the latter with a seed. - -.B {CRYPT} -uses the -.BR crypt (3). - -.B {CLEARTEXT} -indicates that the new password should be -added to userPassword as clear text. - -Note that this option does not alter the normal user applications -handling of userPassword during LDAP Add, Modify, or other LDAP operations. -.TP .B olcPidFile: The ( absolute ) name of a file that will hold the .B slapd @@ -1079,6 +1045,43 @@ non-base search request with an empty base DN. Base scoped search requests with an empty base DN are not affected. This setting is only allowed in the frontend entry. .TP +.B olcPasswordHash: [...] +This option configures one or more hashes to be used in generation of user +passwords stored in the userPassword attribute during processing of +LDAP Password Modify Extended Operations (RFC 3062). +The must be one of +.BR {SSHA} , +.BR {SHA} , +.BR {SMD5} , +.BR {MD5} , +.BR {CRYPT} , +and +.BR {CLEARTEXT} . +The default is +.BR {SSHA} . + +.B {SHA} +and +.B {SSHA} +use the SHA-1 algorithm (FIPS 160-1), the latter with a seed. + +.B {MD5} +and +.B {SMD5} +use the MD5 algorithm (RFC 1321), the latter with a seed. + +.B {CRYPT} +uses the +.BR crypt (3). + +.B {CLEARTEXT} +indicates that the new password should be +added to userPassword as clear text. + +Note that this option does not alter the normal user applications +handling of userPassword during LDAP Add, Modify, or other LDAP operations. +This setting is only allowed in the frontend entry. +.TP .B olcReadOnly: TRUE | FALSE This option puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error. By @@ -1189,6 +1192,15 @@ See .BR olcLimits for an explanation of the different flags. .TP +.B olcSortVals [...] +Specify a list of multi-valued attributes whose values will always +be maintained in sorted order. Using this option will allow Modify, +Compare, and filter evaluations on these attributes to be performed +more efficiently. The resulting sort order depends on the +attributes' syntax and matching rules and may not correspond to +lexical order or any other recognizable order. +This setting is only allowed in the frontend entry. +.TP .B olcTimeLimit: {|unlimited} .TP .B olcTimeLimit: time[.{soft|hard}]= [...] diff --git a/doc/man/man5/slapd.conf.5 b/doc/man/man5/slapd.conf.5 index e5c5a1cc2e..5d9fc030e1 100644 --- a/doc/man/man5/slapd.conf.5 +++ b/doc/man/man5/slapd.conf.5 @@ -495,6 +495,9 @@ for the segments of a filter string that are processed for a subany index lookup. The default is 2. For example, with the default values, a search using this filter "cn=*abcdefgh*" would generate index lookups for "abcd", "cdef", and "efgh". + +Note: Indexing support depends on the particular backend in use. + .TP .B localSSF Specifies the Security Strength Factor (SSF) to be given local LDAP sessions, @@ -891,6 +894,14 @@ The default is 262143. Specify the maximum incoming LDAP PDU size for authenticated sessions. The default is 4194303. .TP +.B sortvals [...] +Specify a list of multi-valued attributes whose values will always +be maintained in sorted order. Using this option will allow Modify, +Compare, and filter evaluations on these attributes to be performed +more efficiently. The resulting sort order depends on the +attributes' syntax and matching rules and may not correspond to +lexical order or any other recognizable order. +.TP .B threads Specify the maximum size of the primary thread pool. The default is 16; the minimum value is 2. -- 2.39.5