292 lines
8.9 KiB
HTML
292 lines
8.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of dpkg-parsechangelog</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>dpkg-parsechangelog</H1>
|
|
Section: dpkg suite (1)<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"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
dpkg-parsechangelog - parse Debian changelog files
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>dpkg-parsechangelog</B>
|
|
|
|
[<I>option</I>...]
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>dpkg-parsechangelog</B>
|
|
|
|
reads and parses the changelog of an unpacked Debian source tree and
|
|
outputs the information in it to standard output in a machine-readable
|
|
form.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-l</B>, <B>--file</B> <I>changelog-file</I>
|
|
|
|
<DD>
|
|
Specifies the changelog file to read information from.
|
|
A '-' can be used to specify reading from standard input.
|
|
The default is
|
|
<B>debian/changelog</B>.
|
|
|
|
<DT id="2"><B>-F</B> <I>changelog-format</I>
|
|
|
|
<DD>
|
|
Specifies the format of the changelog. By default the format is read
|
|
from a special line near the bottom of the changelog or failing that
|
|
defaults to the <B>debian</B> standard format. See also
|
|
<B>CHANGELOG FORMATS</B>.
|
|
<DT id="3"><B>-L</B> <I>libdir</I>
|
|
|
|
<DD>
|
|
Obsolete option without effect (since dpkg 1.18.8).
|
|
Setting the perl environment variables <B>PERL5LIB</B> or <B>PERLLIB</B>
|
|
has a similar effect when looking for the parser perl modules.
|
|
<DT id="4"><B>-S</B>, <B>--show-field</B> <I>field</I>
|
|
|
|
<DD>
|
|
Specifies the name of the field to show (since dpkg 1.17.0).
|
|
The field name is not printed, only its value.
|
|
<DT id="5"><B>-?</B>, <B>--help</B>
|
|
|
|
<DD>
|
|
Show the usage message and exit.
|
|
<DT id="6"><B>--version</B>
|
|
|
|
<DD>
|
|
Show the version and exit.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H3>Parser Options</H3>
|
|
|
|
The following options can be used to influence the output of
|
|
the changelog parser, e.g. the range of entries or the format
|
|
of the output.
|
|
<DL COMPACT>
|
|
<DT id="7"><B>--format</B><I> output-format</I>
|
|
|
|
<DD>
|
|
Set the output format. Currently supported values are
|
|
<B>dpkg</B> and <B>rfc822</B>.
|
|
|
|
<B>dpkg</B> is the classic output format (from before this
|
|
option existed) and the default. It consists of one paragraph
|
|
in Debian control format (see <B><A HREF="/cgi-bin/man/man2html?5+deb-control">deb-control</A></B>(5)). If more
|
|
than one entry is requested, then most fields are taken from the
|
|
first entry (usually the most recent entry), except otherwise stated:
|
|
<DL COMPACT><DT id="8"><DD>
|
|
<DL COMPACT>
|
|
<DT id="9"><B>Source:</B><I> pkg-name</I>
|
|
|
|
<DD>
|
|
<DT id="10"><B>Version:</B><I> version</I>
|
|
|
|
<DD>
|
|
<DT id="11"><B>Distribution:</B><I> target-distribution</I>
|
|
|
|
<DD>
|
|
<DT id="12"><B>Urgency:</B><I> urgency</I>
|
|
|
|
<DD>
|
|
The highest urgency of all included entries is used, followed by the
|
|
concatenated (space-separated) comments from all the versions requested.
|
|
<DT id="13"><B>Maintainer:</B><I> author</I>
|
|
|
|
<DD>
|
|
<DT id="14"><B>Date:</B><I> date</I>
|
|
|
|
<DD>
|
|
The date of the entry as a string, as it appears in the changelog.
|
|
With a <B><A HREF="/cgi-bin/man/man2html?3+strptime">strptime</A></B>(3) format "<B>%a, %d %b %Y %T %z</B>", but where the
|
|
day of the week might not actually correspond to the real day obtained
|
|
from the rest of the date string.
|
|
If you need a more accurate representation of the date, use the
|
|
<B>Timestamp</B> field, but take into account it might not be possible to
|
|
map it back to the exact value in this field.
|
|
<DT id="15"><B>Timestamp:</B><I> timestamp</I>
|
|
|
|
<DD>
|
|
The date of the entry as a timestamp in seconds since the epoch
|
|
(since dpkg 1.18.8).
|
|
<DT id="16"><B>Closes:</B><I> bug-number</I>
|
|
|
|
<DD>
|
|
The Closes fields of all included entries are merged.
|
|
<DT id="17"><B>Changes:</B><I> changelog-entries</I>
|
|
|
|
<DD>
|
|
The text of all changelog entries is concatenated. To make
|
|
this field a valid Debian control format multiline field
|
|
empty lines are replaced with a single full stop and all lines
|
|
is intended by one space character. The exact content depends
|
|
on the changelog format.
|
|
</DL>
|
|
</DL>
|
|
|
|
<DT id="18"><DD>
|
|
The <B>Version</B>, <B>Distribution</B>, <B>Urgency</B>, <B>Maintainer</B> and
|
|
<B>Changes</B> fields are mandatory.
|
|
<DT id="19"><DD>
|
|
There might be additional user-defined fields present.
|
|
<DT id="20"><DD>
|
|
The <B>rfc822</B> format uses the same fields but outputs
|
|
a separate paragraph for each changelog entry so that all
|
|
metadata for each entry is preserved.
|
|
<DT id="21"><B>--reverse</B>
|
|
|
|
<DD>
|
|
Include all changes in reverse order (since dpkg 1.19.1).
|
|
Note: for the <B>dpkg</B> format the first entry will be the most ancient entry.
|
|
<DT id="22"><B>--all</B>
|
|
|
|
<DD>
|
|
Include all changes. Note: other options have no effect when this is in use.
|
|
<DT id="23"><B>-s</B>, <B>--since</B> <I>version</I>
|
|
|
|
<DD>
|
|
|
|
<B>-v</B> <I>version</I>
|
|
|
|
Include all changes later than <I>version</I>.
|
|
<DT id="24"><B>-u</B>, <B>--until</B> <I>version</I>
|
|
|
|
<DD>
|
|
Include all changes earlier than <I>version</I>.
|
|
<DT id="25"><B>-f</B>, <B>--from</B> <I>version</I>
|
|
|
|
<DD>
|
|
Include all changes equal or later than <I>version</I>.
|
|
<DT id="26"><B>-t</B>, <B>--to</B> <I>version</I>
|
|
|
|
<DD>
|
|
Include all changes up to or equal than <I>version</I>.
|
|
<DT id="27"><B>-c</B>, <B>--count</B> <I>number</I>
|
|
|
|
<DD>
|
|
|
|
<B>-n</B> <I>number</I>
|
|
|
|
Include <I>number</I> entries from the top (or the tail
|
|
if <I>number</I> is lower than 0).
|
|
<DT id="28"><B>-o</B>, <B>--offset</B> <I>number</I>
|
|
|
|
<DD>
|
|
Change the starting point for <B>--count</B>, counted from the top
|
|
(or the tail if <I>number</I> is lower than 0).
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CHANGELOG FORMATS</H2>
|
|
|
|
It is possible to use a different format to the standard one, by providing
|
|
a parser for that alternative format.
|
|
<P>
|
|
In order to have <B>dpkg-parsechangelog</B> run the new parser, a line must
|
|
be included within the last 40 lines of the changelog file, matching the Perl
|
|
regular expression: "<B>\schangelog-format:\s+([0-9a-z]+)\W</B>".
|
|
The part in parentheses should be the name of the format. For example:
|
|
<P>
|
|
<BR> @@@ changelog-format: <I>otherformat</I> @@@
|
|
<P>
|
|
Changelog format names are non-empty strings of lowercase alphanumerics
|
|
("a-z0-9").
|
|
<P>
|
|
If such a line exists then <B>dpkg-parsechangelog</B> will look for
|
|
the parser as a <B>Dpkg::Changelog::</B><I>Otherformat</I> perl module;
|
|
it is an error for it not being present.
|
|
The parser name in the perl module will be automatically capitalized.
|
|
The default changelog format is <B>debian</B>, and a parser for it is
|
|
provided by default.
|
|
<P>
|
|
The parser should be derived from the Dpkg::Changelog class and implement
|
|
the required documented interface.
|
|
<P>
|
|
If the changelog format which is being parsed always or almost always
|
|
leaves a blank line between individual change notes, these blank lines
|
|
should be stripped out, so as to make the resulting output compact.
|
|
<P>
|
|
If the changelog format does not contain date or package name information
|
|
this information should be omitted from the output. The parser should not
|
|
attempt to synthesize it or find it from other sources.
|
|
<P>
|
|
If the changelog does not have the expected format the parser should
|
|
error out, rather than trying to muddle through and possibly generating
|
|
incorrect output.
|
|
<P>
|
|
A changelog parser may not interact with the user at all.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
All <B>Parser Options</B> except for <B>-v</B> are only supported
|
|
since dpkg 1.14.16.
|
|
<P>
|
|
|
|
Short option parsing with non-bundled values available only since dpkg 1.18.0.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="29"><B>DPKG_COLORS</B>
|
|
|
|
<DD>
|
|
Sets the color mode (since dpkg 1.18.5).
|
|
The currently accepted values are: <B>auto</B> (default), <B>always</B> and
|
|
<B>never</B>.
|
|
<DT id="30"><B>DPKG_NLS</B>
|
|
|
|
<DD>
|
|
If set, it will be used to decide whether to activate Native Language Support,
|
|
also known as internationalization (or i18n) support (since dpkg 1.19.0).
|
|
The accepted values are: <B>0</B> and <B>1</B> (default).
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="31"><B>debian/changelog</B>
|
|
|
|
<DD>
|
|
The changelog file, used to obtain version-dependent information about
|
|
the source package, such as the urgency and distribution of an upload,
|
|
the changes made since a particular release, and the source version
|
|
number itself.
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?5+deb-changelog">deb-changelog</A></B>(5).
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="32"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="33"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="34"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="35"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DL>
|
|
<DT id="36"><A HREF="#lbAF">Parser Options</A><DD>
|
|
</DL>
|
|
<DT id="37"><A HREF="#lbAG">CHANGELOG FORMATS</A><DD>
|
|
<DT id="38"><A HREF="#lbAH">NOTES</A><DD>
|
|
<DT id="39"><A HREF="#lbAI">ENVIRONMENT</A><DD>
|
|
<DT id="40"><A HREF="#lbAJ">FILES</A><DD>
|
|
<DT id="41"><A HREF="#lbAK">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:11 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|