From: Howard Chu <hyc@openldap.org>
Date: Tue, 23 Aug 2005 10:44:36 +0000 (+0000)
Subject: More for valsort
X-Git-Tag: OPENLDAP_REL_ENG_2_2_MP~603
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=02f52030b01abf2692b5347abc7a848b933dfd17;p=openldap

More for valsort
---

diff --git a/doc/man/man5/slapo-valsort.5 b/doc/man/man5/slapo-valsort.5
new file mode 100644
index 0000000000..3cd439ad16
--- /dev/null
+++ b/doc/man/man5/slapo-valsort.5
@@ -0,0 +1,73 @@
+.TH SLAPO-VALSORT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
+.\" Copyright 2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
+.\" $OpenLDAP$
+.SH NAME
+slapo-valsort \- Value Sorting overlay
+.SH SYNOPSIS
+ETCDIR/slapd.conf
+.SH DESCRIPTION
+The Value Sorting overlay can be used with a backend database to sort the
+values of specific multi-valued attributes within a subtree. The sorting
+occurs whenever the attributes are returned in a search response.
+.LP
+Sorting can be specified in ascending or descending order, using either
+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>}
+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
+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>])
+Configure a sorting method for the specified
+.B attribute
+in the subtree rooted at
+.BR baseDN .
+The 
+.B sort-method
+may be one of
+.BR alpha-ascend ,
+.BR alpha-descend ,
+.BR numeric-ascend ,
+or
+.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.
+.SH EXAMPLES
+.LP
+.nf
+	database bdb
+	suffix dc=example,dc=com
+	...
+	overlay valsort
+	valsort-attr member ou=groups,dc=example,dc=com alpha-ascend
+.fi
+
+.SH FILES
+.TP
+ETCDIR/slapd.conf
+default slapd configuration file
+.SH SEE ALSO
+.BR slapd.conf (5).
+.SH ACKNOWLEDGEMENTS
+.P
+This module was written in 2005 by Howard Chu of Symas Corporation. The
+work was sponsored by Stanford University.
diff --git a/servers/slapd/overlays/valsort.c b/servers/slapd/overlays/valsort.c
index 211b2e893d..3d064e03e6 100644
--- a/servers/slapd/overlays/valsort.c
+++ b/servers/slapd/overlays/valsort.c
@@ -16,7 +16,7 @@
  */
 /* ACKNOWLEDGEMENTS:
  * This work was initially developed by Howard Chu for inclusion in
- * OpenLDAP Software.
+ * OpenLDAP Software. This work was sponsored by Stanford University.
  */
 
 /*