man-pages/man3/Dpkg::Changelog::Parse.3perl.html
2021-03-31 01:06:50 +01:00

144 lines
3.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Dpkg::Changelog::Parse</TITLE>
</HEAD><BODY>
<H1>Dpkg::Changelog::Parse</H1>
Section: libdpkg-perl (3perl)<BR>Updated: 2020-03-23<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
Dpkg::Changelog::Parse - generic changelog parser for dpkg-parsechangelog
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>
This module provides a set of functions which reproduce all the features
of dpkg-parsechangelog.
<A NAME="lbAD">&nbsp;</A>
<H2>FUNCTIONS</H2>
<DL COMPACT>
<DT id="1">$fields = changelog_parse_debian(%opt)<DD>
This function is deprecated, use <B>changelog_parse()</B> instead, with the changelog
format set to ``debian''.
<DT id="2">$fields = changelog_parse_plugin(%opt)<DD>
This function is deprecated, use <B>changelog_parse()</B> instead.
<DT id="3">$fields = changelog_parse(%opt)<DD>
This function will parse a changelog. In list context, it returns as many
Dpkg::Control objects as the parser did create. In scalar context, it will
return only the first one. If the parser did not return any data, it will
return an empty list in list context or undef on scalar context. If the
parser failed, it will die.
<P>
The changelog file that is parsed is <I>debian/changelog</I> by default but it
can be overridden with <TT>$opt</TT>{file}. The default output format is ``dpkg'' but
it can be overridden with <TT>$opt</TT>{format}.
<P>
The parsing itself is done by a parser module (searched in the standard
perl library directories. That module is named according to the format that
it is able to parse, with the name capitalized. By default it is either
Dpkg::Changelog::Debian (from the ``debian'' format) or the format name looked
up in the 40 last lines of the changelog itself (extracted with this perl
regular expression ``\schangelog-format:\s+([0-9a-z]+)\W''). But it can be
overridden with <TT>$opt</TT>{changelogformat}.
<P>
If <TT>$opt</TT>{compression} is false, the file will be loaded without compression
support, otherwise by default compression support is disabled if the file
is the default.
<P>
All the other keys in <TT>%opt</TT> are forwarded to the parser module constructor.
</DL>
<A NAME="lbAE">&nbsp;</A>
<H2>CHANGES</H2>
<A NAME="lbAF">&nbsp;</A>
<H3>Version 1.03 (dpkg 1.19.0)</H3>
New option: 'compression' in <B>changelog_parse()</B>.
<A NAME="lbAG">&nbsp;</A>
<H3>Version 1.02 (dpkg 1.18.8)</H3>
Deprecated functions: <B>changelog_parse_debian()</B>, <B>changelog_parse_plugin()</B>.
<P>
Obsolete options: <TT>$forceplugin</TT>, <TT>$libdir</TT>.
<A NAME="lbAH">&nbsp;</A>
<H3>Version 1.01 (dpkg 1.18.2)</H3>
New functions: <B>changelog_parse_debian()</B>, <B>changelog_parse_plugin()</B>.
<A NAME="lbAI">&nbsp;</A>
<H3>Version 1.00 (dpkg 1.15.6)</H3>
Mark the module as public.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="4"><A HREF="#lbAB">NAME</A><DD>
<DT id="5"><A HREF="#lbAC">DESCRIPTION</A><DD>
<DT id="6"><A HREF="#lbAD">FUNCTIONS</A><DD>
<DT id="7"><A HREF="#lbAE">CHANGES</A><DD>
<DL>
<DT id="8"><A HREF="#lbAF">Version 1.03 (dpkg 1.19.0)</A><DD>
<DT id="9"><A HREF="#lbAG">Version 1.02 (dpkg 1.18.8)</A><DD>
<DT id="10"><A HREF="#lbAH">Version 1.01 (dpkg 1.18.2)</A><DD>
<DT id="11"><A HREF="#lbAI">Version 1.00 (dpkg 1.15.6)</A><DD>
</DL>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:38 GMT, March 31, 2021
</BODY>
</HTML>