Cleanup, document include: extension

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

diff --git a/doc/man/man5/ldif.5 b/doc/man/man5/ldif.5
index 7eb51e3c1a7d0c46fe64c49fffbdaf5bea3eabc8..3a5b77784e8af05bdbc3d85ef861328b4f48a8c7 100644 (file)
--- a/doc/man/man5/ldif.5
+++ b/doc/man/man5/ldif.5
@@ -7,8 +7,13 @@ 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.
@@ -228,11 +233,36 @@ of each type of change.
        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.
+
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldapsearch (1),
 .BR ldapadd (1),
 .BR ldapmodify (1),
+.BR slapadd (8),
 .BR slapd.replog (5).
 .LP
 "LDAP Data Interchange Format," Good, G., RFC 2849.