cleanup

[openldap] / doc / man / man3 / ldap_schema.3

diff --git a/doc/man/man3/ldap_schema.3 b/doc/man/man3/ldap_schema.3
index 5f76997bfae5f2f4ad533dea9c4903f8b68534a7..13518a7aa65a28a7478b7a8bc8b24cf36d7c7a5b 100644 (file)
--- a/doc/man/man3/ldap_schema.3
+++ b/doc/man/man3/ldap_schema.3
@@ -1,6 +1,6 @@
-.TH LDAP_SCHEMA 3 "4 June 2000" "OpenLDAP LDVERSION"
+.TH LDAP_SCHEMA 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 2000-2006 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_str2syntax, ldap_syntax2str, ldap_syntax2name, ldap_syntax_free,
@@ -11,13 +11,16 @@ ldap_attributetype2name, ldap_attributetype_free,
 ldap_str2objectclass, ldap_objectclass2str, ldap_objectclass2name,
 ldap_objectclass_free,
 ldap_scherr2str \- Schema definition handling routines
+.SH LIBRARY
+OpenLDAP LDAP (libldap, -lldap)
 .SH SYNOPSIS
 .nf
 .ft B
 #include <ldap.h>
+#include <ldap_schema.h>
 .LP
 .ft B
-LDAP_SYNTAX * ldap_str2syntax(s, code, errp, flags)
+LDAPSyntax * ldap_str2syntax(s, code, errp, flags)
 .ft
 const char * s;
 int * code;
@@ -27,20 +30,20 @@ const int flags;
 .ft B
 char * ldap_syntax2str(syn)
 .ft
-const LDAP_SYNTAX * syn;
+const LDAPSyntax * syn;
 .LP
 .ft B
 const char * ldap_syntax2name(syn)
 .ft
-LDAP_SYNTAX * syn;
+LDAPSyntax * syn;
 .LP
 .ft B
 ldap_syntax_free(syn)
 .ft
-LDAP_SYNTAX * syn;
+LDAPSyntax * syn;
 .LP
 .ft B
-LDAP_MATCHING_RULE * ldap_str2matchingrule(s, code, errp, flags)
+LDAPMatchingRule * ldap_str2matchingrule(s, code, errp, flags)
 .ft
 const char * s;
 int * code;
@@ -50,20 +53,20 @@ const int flags;
 .ft B
 char * ldap_matchingrule2str(mr);
 .ft
-const LDAP_MATCHING_RULE * mr;
+const LDAPMatchingRule * mr;
 .LP
 .ft B
 const char * ldap_matchingrule2name(mr)
 .ft
-LDAP_MATCHING_RULE * mr;
+LDAPMatchingRule * mr;
 .LP
 .ft B
 ldap_matchingrule_free(mr)
 .ft
-LDAP_MATCHING_RULE * mr;
+LDAPMatchingRule * mr;
 .LP
 .ft B
-LDAP_ATTRIBUTE_TYPE * ldap_str2attributetype(s, code, errp, flags)
+LDAPAttributeType * ldap_str2attributetype(s, code, errp, flags)
 .ft
 const char * s;
 int * code;
@@ -73,20 +76,20 @@ const int flags;
 .ft B
 char * ldap_attributetype2str(at)
 .ft
-const LDAP_ATTRIBUTE_TYPE * at;
+const LDAPAttributeType * at;
 .LP
 .ft B
 const char * ldap_attributetype2name(at)
 .ft
-LDAP_ATTRIBUTE_TYPE * at;
+LDAPAttributeType * at;
 .LP
 .ft B
 ldap_attributetype_free(at)
 .ft
-LDAP_ATTRIBUTE_TYPE * at;
+LDAPAttributeType * at;
 .LP
 .ft B
-LDAP_OBJECT_CLASS * ldap_str2objectclass(s, code, errp, flags)
+LDAPObjectClass * ldap_str2objectclass(s, code, errp, flags)
 .ft
 const char * s;
 int * code;
@@ -96,17 +99,17 @@ const int flags;
 .ft B
 char * ldap_objectclass2str(oc)
 .ft
-const LDAP_OBJECT_CLASS * oc;
+const LDAPObjectClass * oc;
 .LP
 .ft B
 const char * ldap_objectclass2name(oc)
 .ft
-LDAP_OBJECT_CLASS * oc;
+LDAPObjectClass * oc;
 .LP
 .ft B
 ldap_objectclass_free(oc)
 .ft
-LDAP_OBJECT_CLASS * oc;
+LDAPObjectClass * oc;
 .LP
 .ft B
 char * ldap_scherr2str(code)
@@ -116,7 +119,7 @@ int code;
 These routines are used to parse schema definitions in the syntax
 defined in RFC 2252 into structs and handle these structs.  These
 routines handle four kinds of definitions: syntaxes, matching rules,
-attribute types and objectclasses.  For each definition kind, four
+attribute types and object classes.  For each definition kind, four
 routines are provided.
 .LP
 .B ldap_str2xxx()
@@ -168,18 +171,18 @@ The structures returned are as follows:
 .RS
 .nf
 .ne 7
-.ta 8n 16n 32 n
+.ta 8n 16n 32n
 typedef struct ldap_schema_extension_item {
        char *lsei_name;        /* Extension name */
        char **lsei_values;     /* Extension values */
-} LDAP_SCHEMA_EXTENSION_ITEM;
+} LDAPSchemaExtensionItem;
 
 typedef struct ldap_syntax {
        char *syn_oid;          /* OID */
        char **syn_names;       /* Names */
        char *syn_desc;         /* Description */
-       LDAP_SCHEMA_EXTENSION_ITEM **syn_extensions; /* Extension */
-} LDAP_SYNTAX;
+       LDAPSchemaExtensionItem **syn_extensions; /* Extension */
+} LDAPSyntax;
 
 typedef struct ldap_matchingrule {
        char *mr_oid;           /* OID */
@@ -187,8 +190,8 @@ typedef struct ldap_matchingrule {
        char *mr_desc;          /* Description */
        int  mr_obsolete;       /* Is obsolete? */
        char *mr_syntax_oid;    /* Syntax of asserted values */
-       LDAP_SCHEMA_EXTENSION_ITEM **mr_extensions; /* Extensions */
-} LDAP_MATCHING_RULE;
+       LDAPSchemaExtensionItem **mr_extensions; /* Extensions */
+} LDAPMatchingRule;
 
 typedef struct ldap_attributetype {
        char *at_oid;           /* OID */
@@ -205,8 +208,8 @@ typedef struct ldap_attributetype {
        int  at_collective;     /* Is collective? */
        int  at_no_user_mod;    /* Are changes forbidden through LDAP? */
        int  at_usage;          /* Usage, see below */
-       LDAP_SCHEMA_EXTENSION_ITEM **at_extensions; /* Extensions */
-} LDAP_ATTRIBUTE_TYPE;
+       LDAPSchemaExtensionItem **at_extensions; /* Extensions */
+} LDAPAttributeType;
 
 typedef struct ldap_objectclass {
        char *oc_oid;           /* OID */
@@ -217,8 +220,8 @@ typedef struct ldap_objectclass {
        int  oc_kind;           /* Kind, see below */
        char **oc_at_oids_must; /* OIDs of required attribute types */
        char **oc_at_oids_may;  /* OIDs of optional attribute types */
-       LDAP_SCHEMA_EXTENSION_ITEM **oc_extensions; /* Extensions */
-} LDAP_OBJECT_CLASS;
+       LDAPSchemaExtensionItem **oc_extensions; /* Extensions */
+} LDAPObjectClass;
 .ta
 .fi
 .RE
@@ -319,10 +322,10 @@ Duplicate option.
 Unexpected end of data.
 
 .SH SEE ALSO
-.BR ldap (3),
+.BR ldap (3)
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.