dpkg (1.18.25) stretch; urgency=medium
[dpkg] / man / dpkg-genchanges.man
CommitLineData
1479465f
GJ
1.\" dpkg manual page - dpkg-genchanges(1)
2.\"
3.\" Copyright © 1995-1996 Ian Jackson <ijackson@chiark.greenend.org.uk>
4.\" Copyright © 2000 Wichert Akkerman <wakkerma@debian.org>
5.\" Copyright © 2006-2016 Guillem Jover <guillem@debian.org>
6.\" Copyright © 2008-2010 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 <https://www.gnu.org/licenses/>.
20.
21.TH dpkg\-genchanges 1 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
22.nh
23.SH NAME
24dpkg\-genchanges \- generate Debian .changes files
25.
26.SH SYNOPSIS
27.B dpkg\-genchanges
28.RI [ option ...]
29.br
30.
31.SH DESCRIPTION
32.B dpkg\-genchanges
33reads information from an unpacked and built Debian source tree and
34from the files it has generated and generates a Debian upload control
35file
36.RB ( .changes " file)."
37.
38.SH OPTIONS
39.TP
40.BI \-\-build= type
41Specifies the build \fItype\fP from a comma-separated list of components
42(since dpkg 1.18.5).
43
44The allowed values are:
45.RS
46.TP
47.B source
48Upload the source package.
49.TP
50.B any
51Upload the architecture specific binary packages.
52.TP
53.B all
54Upload the architecture independent binary packages.
55.TP
56.B binary
57Upload the architecture specific and independent binary packages.
58This is an alias for \fBany,all\fP.
59.TP
60.B full
61Upload everything.
62This is alias for \fBsource,any,all\fP, and the same as the default case
63when no build option is specified.
64.RE
65.TP
66.B \-g
67Equivalent to \fB\-\-build=source,all\fP (since dpkg 1.17.11).
68.TP
69.B \-G
70Equivalent to \fB\-\-build=source,any\fP (since dpkg 1.17.11).
71.TP
72.B \-b
73Equivalent to \fB\-\-build=binary\fP or \fB\-\-build=any,all\fP.
74.TP
75.B \-B
76Equivalent to \fB\-\-build=any\fP.
77.TP
78.B \-A
79Equivalent to \fB\-\-build=all\fP.
80.TP
81.B \-S
82Equivalent to \fB\-\-build=source\fP.
83.PP
84The \fB\-s\fP\fIx\fP options control whether the original source archive is
85included in the upload if any source is being generated (i.e.
86.BR \-b " or " \-B
87haven't been used).
88.TP
89.B \-si
90By default, or if specified, the original source will be included only if
91the upstream version number (the version without epoch and without Debian
92revision) differs from the upstream version number of the previous
93changelog entry.
94.TP
95.B \-sa
96Forces the inclusion of the original source.
97.TP
98.B \-sd
99Forces the exclusion of the original source and includes only the diff.
100.fi
101.TP
102.BI \-v version
103Causes changelog information from all versions strictly later than
104.I version
105to be used.
106.TP
107.BI \-C changes-description
108Read the description of the changes from the file
109.I changes-description
110rather than using the information from the source tree's changelog
111file.
112.TP
113.BI \-m maintainer-address
114Use
115.I maintainer-address
116as the name and email address of the maintainer for this package,
117rather than using the information from the source tree's control file.
118.TP
119.BI \-e maintainer-address
120Use
121.I maintainer-address
122as the name and email address of the maintainer for this upload,
123rather than using the information from the source tree's changelog.
124.TP
125.BI \-V name = value
126Set an output substitution variable.
127See \fBdeb\-substvars\fP(5) for a discussion of output substitution.
128.TP
129.BI \-T substvars-file
130Read substitution variables in
131.IR substvars-file ;
132the default is
133.BR debian/substvars .
134No variable substitution is done on any of the fields that are output,
135however the special variable \fIFormat\fR will override the field of the
136same name. This option can be used multiple times to read substitution
137variables from multiple files (since dpkg 1.15.6).
138
139.TP
140.BI \-D field = value
141Override or add an output control file field.
142.TP
143.BI \-U field
144Remove an output control file field.
145.TP
146.BI \-c controlfile
147Specifies the main source control file to read information from. The
148default is
149.BR debian/control .
150.TP
151.BI \-l changelog-file
152Specifies the changelog file to read information from. The
153default is
154.BR debian/changelog .
155.TP
156.BI \-f files-list-file
157Read the list of files to be uploaded here, rather than using
158.BR debian/files .
159.TP
160.BI \-F changelog-format
161Specifies the format of the changelog. See \fBdpkg\-parsechangelog\fP(1)
162for information about alternative formats.
163.TP
164.BI \-u upload-files-dir
165Look for the files to be uploaded in
166.I upload-files-dir
167rather than
168.B ..
169.RB ( dpkg\-genchanges
170needs to find these files so that it can include their sizes and
171checksums in the
172.B .changes
173file).
174.TP
175.B \-q
176Usually
177.B dpkg\-genchanges
178will produce informative messages on standard error, for example about
179how many of the package's source files are being uploaded.
180.B \-q
181suppresses these messages.
182.TP
183.BR \-O [\fIfilename\fP]
184Print the changes file to standard output (the default) or to \fIfilename\fP
185if specified (since dpkg 1.18.5).
186.TP
187.BR \-? ", " \-\-help
188Show the usage message and exit.
189.TP
190.BR \-\-version
191Show the version and exit.
192.
193.SH FILES
194.TP
195.B debian/files
196The list of generated files which are part of the upload being
197prepared.
198.B dpkg\-genchanges
199reads the data here when producing a
200.B .changes
201file.
202.
203.SH SEE ALSO
204.ad l
205.BR deb\-substvars (5),
206.BR deb\-src\-control (5),
207.BR deb\-src\-files (5),
208.BR deb\-changelog (5),
209.BR deb\-changes (5).