man: Drop AUTHORS sections in favor of comments in source
[dpkg/dpkg.git] / man / dpkg-parsechangelog.1
1 .\" dpkg manual page - dpkg-parsechangelog(1)
2 .\"
3 .\" Copyright © 1995-1996 Ian Jackson <ian@chiark.chu.cam.ac.uk>
4 .\" Copyright © 2000 Wichert Akkerman <wakkerma@debian.org>
5 .\" Copyright © 2007-2008 Frank Lichtenheld <djpig@debian.org>
6 .\" Copyright © 2009 Raphaël Hertzog <hertzog@debian.org>
7 .\"
8 .\" This is free software; you can redistribute it and/or modify
9 .\" it under the terms of the GNU General Public License as published by
10 .\" the Free Software Foundation; either version 2 of the License, or
11 .\" (at your option) any later version.
12 .\"
13 .\" This is distributed in the hope that it will be useful,
14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 .\" GNU General Public License for more details.
17 .\"
18 .\" You should have received a copy of the GNU General Public License
19 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
20 .
21 .TH dpkg\-parsechangelog 1 "2011-08-14" "Debian Project" "dpkg utilities"
22 .SH NAME
23 dpkg\-parsechangelog \- parse Debian changelog files
24 .
25 .SH SYNOPSIS
26 .B dpkg\-parsechangelog
27 .RI [ option ...]
28 .
29 .SH DESCRIPTION
30 .B dpkg\-parsechangelog
31 reads and parses the changelog of an unpacked Debian source tree and
32 outputs the information in it to standard output in a machine-readable
33 form.
34 .
35 .SH OPTIONS
36 .TP
37 .BI \-l changelogfile
38 Specifies the change log file to read information from. The
39 default is
40 .BR debian/changelog .
41 .TP
42 .BI \-F changelogformat
43 Specifies the format of the changelog. By default the format is read
44 from a special line near the bottom of the changelog or failing that
45 defaults to the debian standard format.
46 .TP
47 .BI \-L libdir
48 Specify an additional directory to search for parser scripts.
49 This directory is searched before the default directories
50 which are currently
51 .BR /usr/local/lib/dpkg/parsechangelog " and "
52 .BR /usr/lib/dpkg/parsechangelog .
53 .TP
54 .BR \-h ", " \-\-help
55 Show the usage message and exit.
56 .TP
57 .BR \-\-version
58 Show the version and exit.
59 .SS Parser Options
60 The following options can be used to influence the output of
61 the changelog parser, e.g. the range of entries or the format
62 of the output. They need to be supported by the parser script
63 in question. See also \fBCAVEATS\fP.
64 .TP
65 .BI \-\-format " outputformat"
66 Set the output format. Currently supported values are
67 .IR dpkg " and " rfc822 .
68 \fIdpkg\fP is the classic output format (from before this
69 option existed) and the default. It consists of one paragraph
70 in Debian control format (see \fBdeb\-control\fP(5)). If more
71 than one entry is requested, then most fields are taken from the
72 latest entry, except otherwise stated:
73 .RS
74 .TP
75 .BI Source: " pkg-name"
76 .TP
77 .BI Version: " version"
78 .TP
79 .BI Distribution: " target-distribution"
80 .TP
81 .BI Urgency: " urgency"
82 The highest urgency of all included entries is used.
83 .TP
84 .BI Maintainer: " author"
85 .TP
86 .BI Date: " date"
87 .TP
88 .BI Closes: " bug-number"
89 The Closes fields of all included entries are merged.
90 .TP
91 .BI Changes: " changelog-entries"
92 The text of all changelog entries is concatenated. To make
93 this field a valid Debian control format multiline field
94 empty lines are replaced with a single full stop and all lines
95 is intended by one space character. The exact content depends
96 on the changelog format.
97 .RE
98 .IP
99 There might be additional user-defined fields present.
100 .IP
101 The \fBrfc822\fP format uses the same fields but outputs
102 a separate paragraph for each changelog entry so that all
103 metadata for each entry is preserved.
104 .TP
105 .BR \-\-since " \fIversion\fP, " \-s \fIversion\fP, " \-v" \fIversion\fP
106 include all changes later than \fIversion\fP.
107 .TP
108 .BR \-\-until " \fIversion\fP, " \-u \fIversion\fP
109 include all changes earlier than \fIversion\fP.
110 .TP
111 .BR \-\-from " \fIversion\fP, " \-f \fIversion\fP
112 include all changes equal or later than \fIversion\fP.
113 .TP
114 .BR \-\-to " \fIversion\fP, " \-t \fIversion\fP
115 include all changes up to or equal than \fIversion\fP.
116 .TP
117 .BR \-\-count " \fInumber\fP, " \-c "\fInumber\fP, " \-n \fInumber\fP
118 include \fInumber\fP entries from the top (or the tail
119 if \fInumber\fP is lower than 0).
120 .TP
121 .BR \-\-offset " \fInumber\fP, " \-o \fInumber\fP
122 change the starting point for \-\-count, counted from the top
123 (or the tail if \fInumber\fP is lower than 0).
124 .TP
125 .B \-\-all
126 include all changes. Note: other options have no effect when this is in
127 use.
128 .
129 .SH CAVEATS
130 All \fBParser Options\fP except for \-v are only supported in
131 \fBdpkg\fP, version 1.14.16 and later. Third party parsers for
132 changelog formats other than \fIdebian\fP might not support
133 all options.
134 .
135 .SH FILES
136 .TP
137 .B debian/changelog
138 The changelog file, used to obtain version-dependent information about
139 the source package, such as the urgency and distribution of an upload,
140 the changes made since a particular release, and the source version
141 number itself.