Add overlay config stuff, handle overlay responses

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

diff --git a/doc/man/man5/slapo-valsort.5 b/doc/man/man5/slapo-valsort.5
index 3cd439ad16c63a1321a10e4191497d91665a270d..132878ab8d21d7bd5e6b535a3ef72a52dafd3a1f 100644 (file)
--- a/doc/man/man5/slapo-valsort.5
+++ b/doc/man/man5/slapo-valsort.5
@@ -1,9 +1,9 @@
 .TH SLAPO-VALSORT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2005-2011 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
-slapo-valsort \- Value Sorting overlay
+slapo\-valsort \- Value Sorting overlay to slapd
 .SH SYNOPSIS
 ETCDIR/slapd.conf
 .SH DESCRIPTION
@@ -16,41 +16,43 @@ numeric or alphanumeric sort methods. Additionally, a "weighted" sort can
 be specified, which uses a numeric weight prepended to the attribute values.
 The weighted sort is always performed in ascending order, but may be combined
 with the other methods for values that all have equal weights. The weight
-is specified by prepending an integer weight
-.B {<weight>}
+is specified by prepending an integer weight {<\fIweight\fP>}
 in front of each value of the attribute for which weighted sorting is
 desired. This weighting factor is stripped off and never returned in
 search results.
 
 .SH CONFIGURATION
 These
-.B slapd.conf
+.I slapd.conf
 options apply to the Value Sorting overlay.
 They should appear after the
 .B overlay
-directive and before any subsequent
-.B database
 directive.
 .TP
-.B valsort-attr <attribute> <baseDN> (<sort-method> | weighted [<sort-method>])
+valsort\-attr <\fIattribute\fP> <\fIbaseDN\fP> (<\fIsort-method\fP> | weighted [<\fIsort-method\fP>])
 Configure a sorting method for the specified
-.B attribute
+.I attribute
 in the subtree rooted at
-.BR baseDN .
+.IR baseDN .
 The 
-.B sort-method
+.I sort-method
 may be one of
-.BR alpha-ascend ,
-.BR alpha-descend ,
-.BR numeric-ascend ,
+.BR alpha\-ascend ,
+.BR alpha\-descend ,
+.BR numeric\-ascend ,
 or
-.BR numeric-descend .
+.BR numeric\-descend .
 If the special
 .B weighted
-method is specified, a secondary sort-method may also be specified. It is an
-error to specify an alphanumeric sort-method for an attribute with Integer
-or NumericString syntax, and it is an error to specify a numeric sort for
-an attribute with a syntax other than Integer or NumericString.
+method is specified, a secondary
+.I sort-method
+may also be specified. It is an
+error to specify an alphanumeric
+.I sort-method
+for an attribute with Integer
+or NumericString syntax, and it is an error to specify a numeric
+.I sort-method
+for an attribute with a syntax other than Integer or NumericString.
 .SH EXAMPLES
 .LP
 .nf
@@ -58,15 +60,16 @@ an attribute with a syntax other than Integer or NumericString.
        suffix dc=example,dc=com
        ...
        overlay valsort
-       valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
+       valsort\-attr member ou=groups,dc=example,dc=com alpha\-ascend
 .fi
 
 .SH FILES
 .TP
-ETCDIR/slapd.conf
-default slapd configuration file
+\fIETCDIR/slapd.conf\fP
+default \fBslapd\fP configuration file
 .SH SEE ALSO
-.BR slapd.conf (5).
+.BR slapd.conf (5),
+.BR slapd\-config (5).
 .SH ACKNOWLEDGEMENTS
 .P
 This module was written in 2005 by Howard Chu of Symas Corporation. The