.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::LDIF 3"
.TH Net::LDAP::LDIF 3 "2020-12-26" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::LDAP::LDIF \- LDIF reading and writing
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Net::LDAP::LDIF;
\&
\& $ldif = Net::LDAP::LDIF\->new( "file.ldif", "r", onerror => \*(Aqundef\*(Aq );
\& while ( not $ldif\->eof ( ) ) {
\& $entry = $ldif\->read_entry ( );
\& if ( $ldif\->error ( ) ) {
\& print "Error msg: ", $ldif\->error ( ), "\en";
\& print "Error lines:\en", $ldif\->error_lines ( ), "\en";
\& } else {
\& # do stuff
\& }
\& }
\& $ldif\->done ( );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBNet::LDAP::LDIF\fR provides a means to convert between
Net::LDAP::Entry objects and \s-1LDAP\s0 entries represented in \s-1LDIF\s0
format files. Reading and writing are supported and may manipulate
single entries or lists of entries.
.PP
As when reading an entire file into memory with perl normally, take
into account the possibility of memory use when loading an \s-1LDIF\s0 file
in one go.
.SH "SPECIAL FEATURES"
.IX Header "SPECIAL FEATURES"
By default, Net::LDAP::LDIF supports reading attribute values from
URLs of type \f(CW\*(C`file://\*(C'\fR.
.PP
When Gisle Aas' \s-1LWP\s0 module package is installed, Net::LDAP::LDIF uses
it to also support reading data from the \s-1URL\s0 types supported by these
modules; most prominently \f(CW\*(C`http://\*(C'\fR, \f(CW\*(C`https://\*(C'\fR, and \f(CW\*(C`ftp://\*(C'\fR resources.
This extended feature is dynamically detected at runtime.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new ( \s-1FILE\s0 [[, \s-1MODE\s0 ], \s-1OPTIONS\s0 ] )" 4
.IX Item "new ( FILE [[, MODE ], OPTIONS ] )"
Open the file with the given mode.
.Sp
\&\f(CW\*(C`FILE\*(C'\fR may be the name of a file or an already open filehandle. If \f(CW\*(C`FILE\*(C'\fR
begins or ends with a \f(CW\*(C`|\*(C'\fR then \f(CW\*(C`FILE\*(C'\fR will be passed directly to \f(CW\*(C`open\*(C'\fR.
.Sp
\&\f(CW\*(C`MODE\*(C'\fR can be any of the modes allowed for Perl's \fBopen()\fR
function, potentially extended by PerlIO layers as described in
perlopentut.
Alternatively, it can be one of the mode indicators \f(CW\*(C`r\*(C'\fR, \f(CW\*(C`r+\*(C'\fR, \f(CW\*(C`w\*(C'\fR,
\&\f(CW\*(C`w+\*(C'\fR, \f(CW\*(C`a\*(C'\fR, \f(CW\*(C`a+\*(C'\fR known from C's \fBfopen()\fR function, which get mapped to
their Perl counterparts.
If \f(CW\*(C`MODE\*(C'\fR is omitted, it defaults to \f(CW\*(C`r\*(C'\fR for reading.
.Sp
\&\f(CW\*(C`OPTIONS\*(C'\fR is a list of name/value pairs, recognizing:
.RS 4
.IP "encode => 'none' | 'canonical' | 'base64'" 4
.IX Item "encode => 'none' | 'canonical' | 'base64'"
Some \s-1DN\s0 values in \s-1LDIF\s0 cannot be written verbatim and have to be encoded
in some way:
.RS 4
.IP "'none'" 4
.IX Item "'none'"
The default.
.IP "'canonical'" 4
.IX Item "'canonical'"
See \*(L"canonical_dn\*(R" in Net::LDAP::Util.
.IP "'base64'" 4
.IX Item "'base64'"
Use base64.
.RE
.RS 4
.RE
.IP "onerror => 'die' | 'warn' | 'undef'" 4
.IX Item "onerror => 'die' | 'warn' | 'undef'"
Specify what happens when an error is detected.
.RS 4
.IP "'die'" 4
.IX Item "'die'"
\&\f(CW\*(C`Net::LDAP::LDIF\*(C'\fR will croak with an appropriate message.
.IP "'warn'" 4
.IX Item "'warn'"
\&\f(CW\*(C`Net::LDAP::LDIF\*(C'\fR will warn with an appropriate message.
.IP "'undef'" 4
.IX Item "'undef'"
\&\f(CW\*(C`Net::LDAP::LDIF\*(C'\fR will warn with an appropriate message if \f(CW\*(C`\-w\*(C'\fR is
in effect. The method that was called will return \f(CW\*(C`undef\*(C'\fR.
.Sp
Note this value is the string \f(CW\*(Aqundef\*(Aq\fR, not the \f(CW\*(C`undef\*(C'\fR value.
.RE
.RS 4
.RE
.IP "change => 1" 4
.IX Item "change => 1"
Write entry changes to the \s-1LDIF\s0 file instead of the entries itself.
I.e. write \s-1LDAP\s0 operations acting on the entries to the file instead of the entries contents.
.IP "lowercase => 1" 4
.IX Item "lowercase => 1"
Convert attribute names to lowercase when writing.
.IP "sort => 1" 4
.IX Item "sort => 1"
Sort attribute names when writing entries according to the rule:
objectclass first then all other attributes alphabetically sorted
.IP "version => '1'" 4
.IX Item "version => '1'"
Set the \s-1LDIF\s0 version to write to the resulting \s-1LDIF\s0 file.
.Sp
According to \s-1RFC 2849\s0 currently the only legal value for this option is \fI1\fR.
.Sp
When this option is set Net::LDAP::LDIF tries to adhere more strictly to the
\&\s-1LDIF\s0 specification in \s-1RFC2489\s0 in a few places.
.Sp
The default is \fIundef\fR meaning no version information is written to the \s-1LDIF\s0 file.
.IP "wrap => 78" 4
.IX Item "wrap => 78"
Number of columns where output line wrapping shall occur.
.Sp
Default is 78. Setting it to 40 or lower inhibits wrapping.
.IP "raw => \s-1REGEX\s0" 4
.IX Item "raw => REGEX"
Use \s-1REGEX\s0 to denote the names of attributes that are to be considered
binary when reading.
.Sp
When this option is given, Net::LDAP converts all
values of attributes not matching this \s-1REGEX\s0 into Perl \s-1UTF\-8\s0 strings
so that the regular Perl operators (pattern matching, ...) can operate
as one expects even on strings with international characters.
.Sp
If this option is not given, attribute values are treated as byte strings.
.Sp
Example: raw => qr/(?i:^jpegPhoto|;binary)/
.RE
.RS 4
.RE
.SH "METHODS"
.IX Header "METHODS"
.IP "read_entry ( )" 4
.IX Item "read_entry ( )"
Read one entry from the file and return it as a \f(CW\*(C`Net::LDAP::Entry\*(C'\fR
object.
.Sp
In scalar mode, the \f(CW\*(C`Net::LDAP::Entry\*(C'\fR object is returned alone,
while in list mode a list is returned consisting of the
\&\f(CW\*(C`Net::LDAP::Entry\*(C'\fR object as first element followed by all
\&\f(CW\*(C`Net::LDAP::Control\*(C'\fR objects that were part of the \s-1LDIF\s0 entry.
See \s-1RFC 2849\s0 for details.
.IP "eof ( )" 4
.IX Item "eof ( )"
Returns \fItrue\fR when the end of the file is reached.
.IP "write_entry ( \s-1ENTRY\s0 [, \s-1OPTIONS\s0 ], ... )" 4
.IX Item "write_entry ( ENTRY [, OPTIONS ], ... )"
Write entries to the \s-1LDIF\s0 file.
.Sp
The arguments accepted are a list of entries, optionally interspersed with
options belonging to the preceding entry.
.Sp
For each entry, \f(CW\*(C`OPTIONS\*(C'\fR is a list of key-value pairs, recognizing:
.RS 4
.IP "control => \s-1CONTROL\s0" 4
.IX Item "control => CONTROL"
.PD 0
.IP "control => [ \s-1CONTROL, ...\s0 ]" 4
.IX Item "control => [ CONTROL, ... ]"
.PD
See \*(L"\s-1CONTROLS\*(R"\s0 in Net::LDAP.
.RE
.RS 4
.RE
.IP "write_version ( )" 4
.IX Item "write_version ( )"
If the object's version is defined, this method allows one to explicitly
write the version before an entry is written.
.Sp
If not called explicitly, it gets called automatically when writing
the first entry.
.IP "version ( [ \s-1VERSION\s0 ] )" 4
.IX Item "version ( [ VERSION ] )"
If called without arguments it returns the version of the \s-1LDIF\s0 file
or undef if no version has been set.
If called with an argument it sets the \s-1LDIF\s0 version to \s-1VERSION.\s0
.Sp
According to \s-1RFC 2849\s0 currently the only legal value for \s-1VERSION\s0 is \fI1\fR.
.IP "handle ( )" 4
.IX Item "handle ( )"
Returns the file handle the \f(CW\*(C`Net::LDAP::LDIF\*(C'\fR object reads from
or writes to.
.IP "done ( )" 4
.IX Item "done ( )"
This method signals that the \s-1LDIF\s0 object is no longer needed. If a
file was opened automatically when the object was created it will be
closed. This method is called automatically via \s-1DESTROY\s0 when the
object goes out of scope.
.IP "error ( )" 4
.IX Item "error ( )"
Returns error message if error was found.
.IP "error_lines ( )" 4
.IX Item "error_lines ( )"
Returns lines that resulted in error.
.IP "current_entry ( )" 4
.IX Item "current_entry ( )"
Returns the current \f(CW\*(C`Net::LDAP::Entry\*(C'\fR object.
.IP "current_lines ( )" 4
.IX Item "current_lines ( )"
Returns the lines that generated the current \f(CW\*(C`Net::LDAP::Entry\*(C'\fR
object.
.IP "next_lines ( )" 4
.IX Item "next_lines ( )"
Returns the lines that will generate the next \f(CW\*(C`Net::LDAP::Entry\*(C'\fR
object.
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>.
.PP
Please report any bugs, or post any suggestions, to the perl-ldap
mailing list <perl\-ldap@perl.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1997\-2004 Graham Barr. All rights reserved. This program
is free software; you can redistribute it and/or modify it under the
same terms as Perl itself.