This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

SLAPO-VALSORT(5)                                                                            SLAPO-VALSORT(5)



NAME
       slapo-valsort - Value Sorting overlay

SYNOPSIS
       /etc/openldap/slapd.conf

DESCRIPTION
       The  Value  Sorting overlay can be used with a backend database to sort the values of specific multi-valued multivalued
       valued attributes within a subtree. The sorting occurs whenever the  attributes  are  returned  in  a
       search response.

       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  {<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.


CONFIGURATION
       These slapd.conf options apply to the Value Sorting overlay.  They should appear  after  the  overlay
       directive.

       valsort-attr <attribute> <baseDN> (<sort-method> | weighted [<sort-method>])
              Configure  a  sorting method for the specified attribute in the subtree rooted at baseDN.  The
              sort-method may be one of alpha-ascend, alpha-descend, numeric-ascend, or numeric-descend.  If
              the special 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-method for an attribute with a syntax
              other than Integer or NumericString.

EXAMPLES
            database bdb
            suffix dc=example,dc=com
            ...
            overlay valsort
            valsort-attr member ou=groups,dc=example,dc=com alpha-ascend


FILES
       /etc/openldap/slapd.conf
              default slapd configuration file

SEE ALSO
       slapd.conf(5).

ACKNOWLEDGEMENTS
       This module was written in 2005 by Howard Chu of Symas Corporation. The work was sponsored  by  Stan-ford Stanford
       ford University.



OpenLDAP 2.3.27                                  2006/08/19                                 SLAPO-VALSORT(5)