From: Kurt Zeilenga <kurt@openldap.org>
Date: Thu, 8 May 2003 06:39:54 +0000 (+0000)
Subject: ITS#2493: attributeoptions man page update
X-Git-Tag: OPENLDAP_REL_ENG_2_1_19
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=ebb4534d4b3eafecae62c19044ddaab86d9dea09;hp=9f8539fa0e35e8cd6243ac9aa204259c9c3c8c4a;p=openldap

ITS#2493: attributeoptions man page update
---

diff --git a/CHANGES b/CHANGES
index c47aa930dd..cbde80b6c1 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,8 +1,10 @@
 OpenLDAP 2.1 Change Log
 
-OpenLDAP 2.1.19 Engineering
+OpenLDAP 2.1.19 Release
 	Fixed slapd substring index normalization (ITS#2468)
 	Fixed back-bdb attribute index tracking (ITS#2496)
+	Documentation
+		Misc man page updates
 
 OpenLDAP 2.1.18 Release
 	Fixed slapd slave update when updateref missing bug (ITS#2435)
diff --git a/build/version.var b/build/version.var
index acbd0f8720..8aa46ce656 100644
--- a/build/version.var
+++ b/build/version.var
@@ -7,7 +7,7 @@
 ol_package=OpenLDAP
 ol_major=2
 ol_minor=1
-ol_patch=0
+ol_patch=19
 ol_api_inc=20118
 ol_api_lib=2:118:0
-ol_release_date="05-05-2003"
+ol_release_date="05-07-2003"
diff --git a/doc/man/man5/slapd.conf.5 b/doc/man/man5/slapd.conf.5
index e359a4fdca..d82903ea51 100644
--- a/doc/man/man5/slapd.conf.5
+++ b/doc/man/man5/slapd.conf.5
@@ -95,6 +95,32 @@ The ( absolute ) name of a file that will hold the
 .B slapd
 server's command line options
 if started without the debugging command line option.
+.TP
+.B attributeoptions [option-name]...
+Define tagging attribute options or option tag/range prefixes.
+Options must not end with `-', prefixes must end with `-'.
+The `lang-' prefix is predefined.
+If you use the
+.B attributeoptions
+directive, `lang-' will no longer be defined and you must specify it
+explicitly if you want it defined.
+
+An attribute description with a tagging option is a subtype of that
+attribute description without the option.
+Except for that, options defined this way have no special semantics.
+Prefixes defined this way work like the `lang-' options:
+They define a prefix for tagging options starting with the prefix.
+That is, if you define the prefix `x-foo-', you can use the option
+`x-foo-bar'.
+Furthermore, in a search or compare, a prefix or range name (with
+a trailing `-') matches all options starting with that name, as well
+as the option with the range name sans the trailing `-'.
+That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
+
+RFC2251 reserves options beginning with `x-' for private experiments.
+Other options should be registered with IANA, see RFC3383 section 3.4.
+OpenLDAP also has the `binary' option built in, but this is a transfer
+option, not a tagging option.
 .HP
 .hy 0
 .B attributetype "(\ <oid> [NAME\ <name>] [OBSOLETE]\
@@ -1058,6 +1084,12 @@ Here is a short example of a configuration file:
 include   SYSCONFDIR/schema/core.schema
 pidfile   LOCALSTATEDIR/slapd.pid
 
+# Subtypes of "name" (e.g. "cn" and "ou") with the
+# option ";x-hidden" can be searched for/compared,
+# but are not shown.  See \fBslapd.access\fP(5).
+attributeoptions x-hidden lang-
+access to attr=name;x-hidden by * =cs
+
 database  bdb
 suffix    "dc=our-domain,dc=com"
 # The database directory MUST exist prior to