]> git.sur5r.net Git - openldap/blobdiff - doc/man/man5/ldif.5
ITS#2594 add URI support for replica config
[openldap] / doc / man / man5 / ldif.5
index 1cb621a5dc5c1dac265515b1aaa963cba7af1947..5b0c9e07df0da2b349045f8faaef08b588a4d46a 100644 (file)
@@ -1,6 +1,6 @@
-.TH LDIF 5 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDIF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldif \- LDAP Data Interchange Format
@@ -17,27 +17,29 @@ The basic form of an LDIF entry is:
 .nf
 .ft tt
        dn: <distinguished name>
-       <attrtype>: <attrvalue>
-       <attrtype>: <attrvalue>
-       <attrtype>:: <base64-encoded-value>
-       <attrtype>:< <URL>
+       <attrdesc>: <attrvalue>
+       <attrdesc>: <attrvalue>
+       <attrdesc>:: <base64-encoded-value>
+       <attrdesc>:< <URL>
        ...
 .ft
 .fi
 .LP
-The value may be specified as ASCII text or as base64 encoded data,
-or a URL may be provided to the location of the attribute value.
+The value may be specified as UTF-8 text or as base64 encoded data,
+or a URI may be provided to the location of the attribute value.
 .LP
 A line may be continued by starting the next line with a single space
 or tab, e.g.,
 .LP
 .nf
 .ft tt
-       dn: cn=Barbara J Jensen, dc=Open
-        LDAP, dc=org
+       dn: cn=Barbara J Jensen,dc=exam
+        ple,dc=com
 .ft
 .fi
 .LP
+Lines beginning with a sharpe sign ('#') are ignored.
+.LP
 Multiple attribute values are specified on separate lines, e.g.,
 .LP
 .nf
@@ -59,14 +61,15 @@ the value " begins with a space" would be encoded like this:
 .fi
 .LP
 If the attribute value is located in a file, the <attrtype> is
-followed by a ':<' and a file:// URL.  e.g., the value contained
+followed by a ':<' and a file: URI.  e.g., the value contained
 in the file /tmp/value would be listed like this:
 .LP
 .nf
 .ft tt
-       cn:< file://tmp/value
+       cn:< file:///tmp/value
 .ft
 .fi
+Other URI schemes (ftp,http) may be supported as well.
 .LP
 Multiple entries within the same LDIF file are separated by blank
 lines.
@@ -75,20 +78,20 @@ Here is an example of an LDIF file containing three entries.
 .LP
 .nf
 .ft tt
-       dn: cn=Barbara J Jensen, dc=OpenLDAP, dc=Org
+       dn: cn=Barbara J Jensen,dc=example,dc=com
        cn: Barbara J Jensen
        cn: Babs Jensen
        objectclass: person
-       description:< file://tmp/barbara
+       description:< file://tmp/babs
        sn: Jensen
 
-       dn: cn=Bjorn J Jensen, dc=OpenLDAP, dc=Org
+       dn: cn=Bjorn J Jensen,dc=example,dc=com
        cn: Bjorn J Jensen
        cn: Bjorn Jensen
        objectclass: person
        sn: Jensen
 
-       dn: cn=Jennifer J Jensen, dc=OpenLDAP, dc=Org
+       dn: cn=Jennifer J Jensen,dc=example,dc=com
        cn: Jennifer J Jensen
        cn: Jennifer Jensen
        objectclass: person
@@ -100,14 +103,15 @@ Here is an example of an LDIF file containing three entries.
 .ft
 .fi
 .LP
-Notice that the jpegPhoto in Jennifer Jensen's entry is encoded using
-base 64.
+Notice that the description in Barbara Jensen's entry is
+read from file://tmp/babs and the jpegPhoto in Jennifer
+Jensen's entry is encoded using base 64.
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldapsearch (1),
-.BR ldapadd (1)
+.BR ldapadd (1).
 .LP
-"The SLAPD and SLURPD Administrator's Guide"
+"LDAP Data Interchange Format," Good, G., RFC 2849.
 .SH ACKNOWLEDGEMENTS
 .B     OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).