]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/schema.sdf
Some misc cleanup
[openldap] / doc / guide / admin / schema.sdf
index 62e9e9b32af1a841ed74e8134830b02fef88bbbb..711bd99f172648a2b00f1a4f8038079df7a892e3 100644 (file)
@@ -181,7 +181,7 @@ where Attribute Type Description is defined by the following
 >          [ "EQUALITY" woid              ; Matching Rule name
 >          [ "ORDERING" woid              ; Matching Rule name
 >          [ "SUBSTR" woid ]              ; Matching Rule name
->          [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3
+>          [ "SYNTAX" whsp noidlen whsp ] ; Syntax OID
 >          [ "SINGLE-VALUE" whsp ]        ; default multi-valued
 >          [ "COLLECTIVE" whsp ]          ; default not collective
 >          [ "NO-USER-MODIFICATION" whsp ]; default user modifiable
@@ -196,32 +196,39 @@ where Attribute Type Description is defined by the following
 >
 
 where whsp is a space ('{{EX: }}'), numericoid is a globally unique
-OID in dotted-decimal form (e.g. {{EX:1.2.3}}), qdescrs is one or more
-names, woid is either the name or OID, and noidlen is an optional length
-specifier (e.g {{EX:{10}}}).
+OID in dotted-decimal form (e.g. {{EX:1.2.3}}), qdescrs is one or
+more names, woid is either the name or OID optionally followed
+length specifier (e.g {{EX:{10}}}).
 
 For example, the attribute types {{EX:name}} and {{EX:cn}} are defined
 in {{F:core.schema}} as:
 
 >      attributeType ( 2.5.4.41 NAME 'name'
+>              DESC 'name(s) associated with the object'
 >              EQUALITY caseIgnoreMatch
 >              SUBSTR caseIgnoreSubstringsMatch
 >              SYNTAX 1.3.6.1.4.1.1466.115.121.1.15{32768} )
->      attributeType ( 2.5.4.3 NAME
->              ( 'cn' $ 'commonName' ) SUP name )
-
-Notice that each defines the attribute's OID and descriptive
-names.  Each name is an alias for the OID.  {{slapd}}(8) returns
-the first listed name when returning results.
+>      attributeType ( 2.5.4.3 NAME ( 'cn' $ 'commonName' )
+>              DESC 'common name(s) assciated with the object'
+>              SUP name )
 
-The first attribute, {{EX:name}}, has a syntax of {{EX:directoryString}}
-(a UTF-8 encoded Unicode string) with a recommend maximun length.
-Note that syntaxes are specified by OID.  In addition, the equality
-and substring matching uses case ignore rules.  Below are tables 
-listing commonly used supported syntax and matching rules.
+Notice that each defines the attribute's OID, provides a short name,
+and a brief description.  Each name is an alias for the OID.
+{{slapd}}(8) returns the first listed name when returning results.
+
+The first attribute, {{EX:name}}, holds values of {{EX:directoryString}}
+(UTF-8 encoded Unicode) syntax.  The syntax are specified by OID
+(1.3.6.1.4.1.1466.115.121.1.15 identifies the directoryString
+syntax).  An length recommendation of 32768 is specified.  Servers
+should support values of this length, but may support longer values
+The field does NOT specify a size constraint, so is ignored on
+servers (such as slapd) which don't impose such size limits.  In
+addition, the equality and substring matching uses case ignore
+rules.  Below are tables listing commonly used syntax and
+matching rules (OpenLDAP supports these and many more).
 
 !block table; align=Center; coltags="EX,EX,N"; \
-       title="Table 6.3: Supported Syntaxes"
+       title="Table 6.3: Commonly Used Syntaxes"
 Name                   OID                             Description
 binary                 1.3.6.1.4.1.1466.115.121.1.5    BER/DER data
 boolean                        1.3.6.1.4.1.1466.115.121.1.7    boolean value
@@ -239,7 +246,7 @@ Printable String    1.3.6.1.4.1.1466.115.121.1.44   printable string
 > 
 
 !block table; align=Center; coltags="EX,N"; \
-       title="Table 6.4: Supported Matching Rules"
+       title="Table 6.4: Commonly Used Matching Rules"
 Name                           Type            Description
 booleanMatch                   equality        boolean
 objectIdentiferMatch           equality        OID
@@ -266,9 +273,8 @@ The second attribute, {{EX:cn}}, is a subtype of {{EX:name}} hence
 it inherits the syntax, matching rules, and usage of {{EX:name}}.
 {{EX:commonName}} is an alternative name.
 
-Neither attribute is restricted to a single value and both are
-meant for usage by user applications.  You likely won't need to
-specify other parameters such as {{EX:OBSOLETE}}.
+Neither attribute is restricted to a single value.  Both are meant
+for usage by user applications.  Neither is obsolete nor collective.
 
 The following subsections provide a couple of examples.