]> git.sur5r.net Git - openldap/blobdiff - doc/man/man5/slapd.conf.5
Move extern schema_init_done outside of #ifdef SLAPD_SCHEMA_NOT_COMPAT
[openldap] / doc / man / man5 / slapd.conf.5
index d502baee46853a1b6fd9ddc06baf2a14e7a5199f..a892fa4f27d81291943f365eb26c2f2328325b1b 100644 (file)
@@ -1,4 +1,7 @@
-.TH SLAPD.CONF 5 "20 January 1999" "OpenLDAP LDVERSION"
+.TH SLAPD.CONF 5 "5 August 1999" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
 .SH SYNOPSIS
@@ -10,12 +13,11 @@ contains configuration information for the
 .BR slapd (8)
 daemon.  This configuration file is also used by the
 .BR slurpd (8)
-replication daemon and by the LDBM indexing utilities
-.BR ldif2ldbm (8),
-.BR ldif2index (8),
-.BR ldif2id2entry (8),
+replication daemon and by the SLAPD tools
+.BR slapadd (8),
+.BR slapcat (8),
 and
-.BR ldif2id2children (8).
+.BR slapindex (8).
 .LP
 The
 .B slapd.conf
@@ -65,17 +67,46 @@ overridden in a backend definition. Arguments that should be replaced by
 actual text are shown in brackets <>.
 .TP
 .B
-access to <what> [ by <who> <accesslevel> ]+
-Grant access (specified by <accesslevel>) to a set of entries and/or
+access to <what> [ by <who> <access> <control> ]+
+Grant access (specified by <access>) to a set of entries and/or
 attributes (specified by <what>) by one or more requestors (specified
-by <who>).  Refer to "The SLAPD and SLURPD Administrator's Guide" for
-information on using the
-.B slapd
-access-control mechanisms.
+by <who>).
+See Developer's FAQ (http://www.openldap.org/faq/) for details.
 .TP
 .B
-attribute <name> [<name2>] { bin | ces | cis | tel | dn }
-Associate a syntax with an attribute name. By default, an 
+attributetype ( <oid> [NAME <name>] [DESC <description>] [OBSOLETE] \
+[SUP <oid>] [EQUALITY <oid>] [ORDERING <oid>] [SUBSTR <oid>] \
+[SYNTAX <oidlen>] [SINGLE-VALUE] [COLLECTIVE] [NO-USER-MODIFICATION] \
+[USAGE <attributeUsage>] )
+Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
+This is the preferred format for attribute type definitions. The slapd
+parser extends the RFC 2252 definition by allowing string forms as well
+as numeric OIDs to be used for the attribute OID and attribute syntax OID.
+(See the
+.B objectidentifier
+description.) Currently the syntax name parser is case-sensitive.
+The known syntax names are:
+.RS
+.RS
+.PD 0
+AttributeTypeDescription Audio Binary BitString Certificate CertificateList
+CertificatePair DN DeliveryMethod DirectoryString DITContentRuleDescription
+DITStructureRuleDescription EnhancedGuide FacsimileTelephoneNumber
+GeneralizedTime Guide IA5String Integer MatchingRuleDescription
+MatchingRuleUseDescription MailPreference NameAndOptionalUUID
+NameFormDescription NumericString ObjectClassDescription OID
+OtherMailbox OctetString PostalAddress ProtocolInformation
+PresentationAddress PrintableString SupportedAlgorithm TelephoneNumber
+TeletexTerminalIdentifier TelexNumber UTCTime LDAPSyntaxDescription
+SubstringAssertion NISnetgrouptriple Bootparameter
+.PD
+.RE
+.RE
+.TP
+.B 
+attribute[type] <name> [<name2>] { bin | ces | cis | tel | dn }
+Associate a syntax with an attribute name. This directive is deprecated
+in favor of the one above. By default, an 
 attribute is assumed to have syntax
 .BR cis .
 An optional alternate name can be 
@@ -103,9 +134,13 @@ distinguished name
 .RE
 .TP
 .B
-defaultaccess [self]{ none | compare | search | read | write }
-Specify the default access to grant requestors not matched by 
-any other access line.  The default behavior is to grant read access.
+defaultaccess { none | auth | compare | search | read | write }
+Specify the default access level to grant requestors when
+no access directives were provided for the database.
+The default behavior is to grant 'read' access.  It is
+recommended that
+.B access
+directives be used instead.
 .TP
 .B idletimeout <integer>
 Specify the number of seconds to wait before forcibly closing
@@ -190,9 +225,28 @@ entry parsing
 .RE
 .TP
 .B
+objectclass ( <oid> [NAME <name>] [DESC <description] [OBSOLETE] \
+[SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>] \
+[MAY <oids>] )
+Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
+This is the preferred format for object class definitions. The slapd
+parser extends the RFC 2252 definition by allowing string forms as well
+as numeric OIDs to be used for the object class OID. (See the
+.B
+objectidentifier
+description.) Object classes are "STRUCTURAL" by default.
+.TP
+.B
 objectclass <name> requires <attrs> allows <attrs>
 Define the schema rules for the object class named <name>.  These are
-used in conjunction with the schemacheck option.
+used in conjunction with the schemacheck option. This directive is
+deprecated in favor of the one above.
+.TP
+.B objectidentifier <name> { <oid> | <name>[:<suffix>] }
+Define a string name that equates to the given OID. The string can be used
+in place of the numeric OID in objectclass and attribute definitions. The
+name can also be used with a suffix of the form ":xx" in which case the
+value "oid.xx" will be used.
 .TP
 .B referral <url>
 Specify the referral to pass back when
@@ -263,7 +317,7 @@ Controls whether
 .B slapd
 will automatically maintain the 
 modifiersName, modifyTimestamp, creatorsName, and 
-createTimestamp attributes for entries.  By default, lastmod is off.
+createTimestamp attributes for entries.  By default, lastmod is on.
 .TP
 .B readonly on | off
 This option puts the database into "read-only" mode.  Any attempts to 
@@ -297,9 +351,10 @@ or administrative limit restrictions for operations on this database.
 .TP
 .B rootpw <password>
 Specify a password (or hash of the password) for the rootdn.
-This option accepts all password formats known to the server
-including \fB{SHA}\fP, \fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext.  
-Cleartext passwords are not recommended.
+This option accepts all RFC 2307 userPassword formats known to
+the server including \fB{SSHA}\fP, \fB{SHA}\fP, \fB{SMD5}\fP,
+\fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext schemes.  Cleartext
+passwords are not recommended.
 .TP
 .B suffix <dn suffix>
 Specify the DN suffix of queries that will be passed to this 
@@ -334,15 +389,19 @@ Specify the size in bytes of the in-memory cache associated
 with each open index file. If not supported by the underlying database 
 method, this option is ignored without comment.  The default is 100000 bytes.
 .TP
-.B dbcachenowsync
-Specify that database writes should not be immediately synchronized
-with in memory changes.  Enabling this option may improve performance
-at the expense of data security.
+.B dbnolocking
+Specify that no database locking should be performed.  
+Enabling this option may improve performance at the expense of data security.
+.B dbnosync
+Specify that on-disk database contents should not be immediately
+synchronized with in memory changes.  Enabling this option may improve
+performance at the expense of data security.
 .TP
 .B directory <directory>
-Specify the directory where the LDBM files containing the database and
-associated indexes live.  The default is
-.B /usr/tmp.
+Specify the directory where the LDBM files containing this database and
+associated indexes live.  A separate directory must be specified for
+each database.  The default is
+.BR LOCALSTATEDIR/openldap-ldbm .
 .TP
 .B
 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
@@ -408,6 +467,9 @@ ETCDIR/slapd.conf
 .BR locale (5),
 .BR passwd (5),
 .BR slapd (8),
+.BR slapadd (8),
+.BR slapcat (8),
+.BR slapindex (8),
 .BR slurpd (8),
 .LP
 "The SLAPD and SLURPD Administrator's Guide"