Merge remote branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_4

[openldap] / doc / man / man5 / ldif.5

diff --git a/doc/man/man5/ldif.5 b/doc/man/man5/ldif.5
index fa9ad5654091bc61f3fbfe6a20664b62ec4c8df2..7e5077aa99fc6b3b8c66524d6f49e72745f85a5b 100644 (file)
--- a/doc/man/man5/ldif.5
+++ b/doc/man/man5/ldif.5
@@ -1,14 +1,19 @@
 .TH LDIF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .TH LDIF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$

-.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.

 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldif \- LDAP Data Interchange Format
 .SH DESCRIPTION
 The LDAP Data Interchange Format (LDIF) is used to represent LDAP
 entries and change records in text form. LDAP tools, such as
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldif \- LDAP Data Interchange Format
 .SH DESCRIPTION
 The LDAP Data Interchange Format (LDIF) is used to represent LDAP
 entries and change records in text form. LDAP tools, such as

-.BR ldapadd (1) and .BR ldapsearch (1), read and write LDIF entry
-records.  ldapmodify(1) reads LDIF change records.
+.BR ldapadd (1)
+and
+.BR ldapsearch (1),
+read and write LDIF entry
+records.
+.BR ldapmodify (1)
+reads LDIF change records.

 .LP
 This manual page provides a basic description of LDIF.  A
 formal specification of LDIF is published in RFC 2849.
 .LP
 This manual page provides a basic description of LDIF.  A
 formal specification of LDIF is published in RFC 2849.


@@ -131,7 +136,7 @@ of \fImodify\fP, the format is one or more of the following:
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...

-       -
+       \-

 .fi
 .LP
 Or, for a replace modification:
 .fi
 .LP
 Or, for a replace modification:


@@ -141,7 +146,7 @@ Or, for a replace modification:
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...

-       -
+       \-

 .fi
 .LP
 If no \fIattributetype\fP lines are given to replace,
 .fi
 .LP
 If no \fIattributetype\fP lines are given to replace,


@@ -154,7 +159,7 @@ Or, for a delete modification:
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...
        <attrdesc>: <value1>
        <attrdesc>: <value2>
        ...

-       -
+       \-

 .fi
 .LP
 If no \fIattributetype\fP lines are given to delete,
 .fi
 .LP
 If no \fIattributetype\fP lines are given to delete,


@@ -210,13 +215,13 @@ of each type of change.
        add: givenName
        givenName: Barbara
        givenName: babs
        add: givenName
        givenName: Barbara
        givenName: babs

-       -
+       \-

        replace: description
        description: the fabulous babs
        replace: description
        description: the fabulous babs

-       -
+       \-

        delete: sn
        sn: jensen
        delete: sn
        sn: jensen

-       -
+       \-

 
        dn: cn=Babs Jensen,dc=example,dc=com
        changetype: modrdn
 
        dn: cn=Babs Jensen,dc=example,dc=com
        changetype: modrdn


@@ -228,16 +233,46 @@ of each type of change.
        changetype: delete
 .fi
 
        changetype: delete
 .fi
 

+.SH INCLUDE STATEMENT
+The LDIF parser has been extended to support an
+.B include
+statement for referencing other LDIF files.  The
+.B include
+statement must be separated from other records by a blank line.
+The referenced file is specified using a file: URI and all of its
+contents are incorporated as if they were part of the original
+LDIF file. As above, other URI schemes may be supported. For example:
+.LP
+.nf
+       dn: dc=example,dc=com
+       objectclass: domain
+       dc: example
+
+       include: file:///tmp/example.com.ldif
+
+       dn: dc=example,dc=org
+       objectclass: domain
+       dc: example
+.fi
+This feature is not part of the LDIF specification in RFC 2849 but
+is expected to appear in a future revision of this spec. It is supported
+by the
+.BR ldapadd (1),
+.BR ldapmodify (1),
+and
+.BR slapadd (8)
+commands.
+

 .SH SEE ALSO
 .BR ldap (3),
 .BR ldapsearch (1),
 .BR ldapadd (1),
 .BR ldapmodify (1),
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldapsearch (1),
 .BR ldapadd (1),
 .BR ldapmodify (1),

+.BR slapadd (8),
+.BR slapcat (8),
+.BR slapd\-ldif (5),

 .BR slapd.replog (5).
 .LP
 "LDAP Data Interchange Format," Good, G., RFC 2849.
 .SH ACKNOWLEDGEMENTS
 .BR slapd.replog (5).
 .LP
 "LDAP Data Interchange Format," Good, G., RFC 2849.
 .SH ACKNOWLEDGEMENTS

-.B OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.
+.so ../Project