man/dpkg-genchanges.pod

   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 =encoding utf8
  22
  23 =head1 NAME
  24
  25 dpkg-genchanges - generate Debian .changes files
  26
  27 =head1 SYNOPSIS
  28
  29 B<dpkg-genchanges>
  30 [I<option>...]
  31
  32 =head1 DESCRIPTION
  33
  34 B<dpkg-genchanges>
  35 reads information from an unpacked and built Debian source tree and
  36 from the files it has generated and generates a Debian upload control
  37 file
  38 (B<.changes> file).
  39
  40 =head1 OPTIONS
  41
  42 =over
  43
  44 =item B<--build=>I<type>
  45
  46 Specifies the build I<type> from a comma-separated list of components
  47 (since dpkg 1.18.5).
  48
  49 The allowed values are:
  50
  51 =over
  52
  53 =item B<source>
  54
  55 Upload the source package.
  56
  57 =item B<any>
  58
  59 Upload the architecture specific binary packages.
  60
  61 =item B<all>
  62
  63 Upload the architecture independent binary packages.
  64
  65 =item B<binary>
  66
  67 Upload the architecture specific and independent binary packages.
  68 This is an alias for B<any,all>.
  69
  70 =item B<full>
  71
  72 Upload everything.
  73 This is alias for B<source,any,all>, and the same as the default case
  74 when no build option is specified.
  75
  76 =back
  77
  78 =item B<-g>
  79
  80 Equivalent to B<--build=source,all> (since dpkg 1.17.11).
  81
  82 =item B<-G>
  83
  84 Equivalent to B<--build=source,any> (since dpkg 1.17.11).
  85
  86 =item B<-b>
  87
  88 Equivalent to B<--build=binary> or B<--build=any,all>.
  89
  90 =item B<-B>
  91
  92 Equivalent to B<--build=any>.
  93
  94 =item B<-A>
  95
  96 Equivalent to B<--build=all>.
  97
  98 =item B<-S>
  99
 100 Equivalent to B<--build=source>.
 101
 102 =back
 103
 104 The B<-s>I<x> options control whether the original source archive is
 105 included in the upload if any source is being generated (i.e.
 106 B<-b> or B<-B>
 107 haven't been used).
 108
 109 =over
 110
 111 =item B<-si>
 112
 113 By default, or if specified, the original source will be included only if
 114 the upstream version number (the version without epoch and without Debian
 115 revision) differs from the upstream version number of the previous
 116 changelog entry.
 117
 118 =item B<-sa>
 119
 120 Forces the inclusion of the original source.
 121
 122 =item B<-sd>
 123
 124 Forces the exclusion of the original source and includes only the diff.
 125
 126 =item B<-v>I<version>
 127
 128 Causes changelog information from all versions strictly later than
 129 I<version>
 130 to be used.
 131
 132 =item B<-C>I<changes-description>
 133
 134 Read the description of the changes from the file
 135 I<changes-description>
 136 rather than using the information from the source tree's changelog
 137 file.
 138
 139 =item B<-m>I<maintainer-address>
 140
 141 Use
 142 I<maintainer-address>
 143 as the name and email address of the maintainer for this package,
 144 rather than using the information from the source tree's control file.
 145
 146 =item B<-e>I<maintainer-address>
 147
 148 Use
 149 I<maintainer-address>
 150 as the name and email address of the maintainer for this upload,
 151 rather than using the information from the source tree's changelog.
 152
 153 =item B<-V>I<name>B<=>I<value>
 154
 155 Set an output substitution variable.
 156 See L<deb-substvars(5)> for a discussion of output substitution.
 157
 158 =item B<-T>I<substvars-file>
 159
 160 Read substitution variables in
 161 I<substvars-file>;
 162 the default is
 163 B<debian/substvars>.
 164 No variable substitution is done on any of the fields that are output,
 165 except for the contents extracted from each binary package B<Description>
 166 field (since dpkg 1.19.0), however the special variable I<Format> will
 167 override the field of the same name.
 168 This option can be used multiple times to read substitution
 169 variables from multiple files (since dpkg 1.15.6).
 170
 171 =item B<-D>I<field>B<=>I<value>
 172
 173 Override or add an output control file field.
 174
 175 =item B<-U>I<field>
 176
 177 Remove an output control file field.
 178
 179 =item B<-c>I<controlfile>
 180
 181 Specifies the main source control file to read information from.
 182 The
 183 default is
 184 B<debian/control>.
 185
 186 =item B<-l>I<changelog-file>
 187
 188 Specifies the changelog file to read information from.
 189 The
 190 default is
 191 B<debian/changelog>.
 192
 193 =item B<-f>I<files-list-file>
 194
 195 Read the list of files to be uploaded here, rather than using
 196 B<debian/files>.
 197
 198 =item B<-F>I<changelog-format>
 199
 200 Specifies the format of the changelog.
 201 See L<dpkg-parsechangelog(1)>
 202 for information about alternative formats.
 203
 204 =item B<-u>I<upload-files-dir>
 205
 206 Look for the files to be uploaded in
 207 I<upload-files-dir>
 208 rather than
 209 B<..>
 210 (B<dpkg-genchanges>
 211 needs to find these files so that it can include their sizes and
 212 checksums in the
 213 B<.changes>
 214 file).
 215
 216 =item B<-q>
 217
 218 Usually
 219 B<dpkg-genchanges>
 220 will produce informative messages on standard error, for example about
 221 how many of the package's source files are being uploaded.
 222 B<-q>
 223 suppresses these messages.
 224
 225 =item B<-O>[I<filename>]
 226
 227 Print the changes file to standard output (the default) or to I<filename>
 228 if specified (since dpkg 1.18.5).
 229
 230 =item B<-?>, B<--help>
 231
 232 Show the usage message and exit.
 233
 234 =item B<--version>
 235
 236 Show the version and exit.
 237
 238 =back
 239
 240 =head1 ENVIRONMENT
 241
 242 =over
 243
 244 =item B<DPKG_COLORS>
 245
 246 Sets the color mode (since dpkg 1.18.5).
 247 The currently accepted values are: B<auto> (default), B<always> and
 248 B<never>.
 249
 250 =item B<DPKG_NLS>
 251
 252 If set, it will be used to decide whether to activate Native Language Support,
 253 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 254 The accepted values are: B<0> and B<1> (default).
 255
 256 =back
 257
 258 =head1 FILES
 259
 260 =over
 261
 262 =item B<debian/files>
 263
 264 The list of generated files which are part of the upload being
 265 prepared.
 266 B<dpkg-genchanges>
 267 reads the data here when producing a
 268 B<.changes>
 269 file.
 270
 271 =back
 272
 273 =head1 SEE ALSO
 274
 275 L<deb-substvars(5)>,
 276 L<deb-src-control(5)>,
 277 L<deb-src-files(5)>,
 278 L<deb-changelog(5)>,
 279 L<deb-changes(5)>.