man/dpkg-genbuildinfo.pod

   1 # dpkg manual page - dpkg-genbuildinfo(1)
   2 #
   3 # Copyright © 1995-1996 Ian Jackson <ian@chiark.chu.cam.ac.uk>
   4 # Copyright © 2000 Wichert Akkerman <wakkerma@debian.org>
   5 # Copyright © 2008-2010 Raphaël Hertzog <hertzog@debian.org>
   6 # Copyright © 2006-2016 Guillem Jover <guillem@debian.org>
   7 # Copyright © 2015 Jérémy Bobbio <lunar@debian.org>
   8 #
   9 # This is free software; you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 2 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # This is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  21
  22 =encoding utf8
  23
  24 =head1 NAME
  25
  26 dpkg-genbuildinfo - generate Debian .buildinfo files
  27
  28 =head1 SYNOPSIS
  29
  30 B<dpkg-genbuildinfo>
  31 [I<option>...]
  32
  33 =head1 DESCRIPTION
  34
  35 B<dpkg-genbuildinfo>
  36 reads information from an unpacked and built Debian source tree and
  37 from the files it has generated and generates a Debian control
  38 file describing the build environment and the build artifacts
  39 (B<.buildinfo> file).
  40
  41 This program was introduced in dpkg 1.18.11.
  42
  43 =head1 OPTIONS
  44
  45 =over
  46
  47 =item B<--build=>I<type>
  48
  49 Specifies the build I<type> from a comma-separated list of components.
  50
  51 The allowed values are:
  52
  53 =over
  54
  55 =item B<any>
  56
  57 Generate build information including unqualified build dependencies
  58 (B<Build-Depends>) and architecture specific build dependencies
  59 (B<Build-Depends-Arch>).
  60
  61 =item B<all>
  62
  63 Generate build information including unqualified build dependencies
  64 (B<Build-Depends>) and architecture independent build dependencies
  65 (B<Build-Depends-Indep>).
  66
  67 =item B<source>
  68
  69 Effectively ignored; generate build information with just the unqualified
  70 build dependencies (B<Build-Depends>).
  71
  72 =item B<binary>
  73
  74 Generate build information with all three types of build dependencies.
  75 This is an alias for B<any,all>.
  76
  77 =item B<full>
  78
  79 Generate build information with all three types of build dependencies.
  80 This is an alias for B<any,all,source>, and the same as the default
  81 case when no build option is specified.
  82
  83 =back
  84
  85 =item B<-c>I<controlfile>
  86
  87 Specifies the main source control file to read information from.
  88 The
  89 default is
  90 B<debian/control>.
  91
  92 =item B<-l>I<changelog-file>
  93
  94 Specifies the changelog file to read information from.
  95 The
  96 default is
  97 B<debian/changelog>.
  98
  99 =item B<-f>I<files-list-file>
 100
 101 Specifies where is the list of files that have been produced by the build,
 102 rather than using
 103 B<debian/files>.
 104
 105 =item B<-F>I<changelog-format>
 106
 107 Specifies the format of the changelog.
 108 See L<dpkg-parsechangelog(1)>
 109 for information about alternative formats.
 110
 111 =item B<-O>[I<filename>]
 112
 113 Print the buildinfo file to standard output (or I<filename> if specified)
 114 rather than to
 115 I<dir>B</>I<source-name>B<_>I<binary-version>B<_>I<arch>B<.buildinfo>
 116 (where I<dir> is B<..> by default or I<upload-files-dir>
 117 if B<-u> was used).
 118
 119 =item B<-u>I<upload-files-dir>
 120
 121 Look for the files to be uploaded in
 122 I<upload-files-dir>
 123 rather than
 124 B<..>
 125 (B<dpkg-genbuildinfo> needs to find these files so that it can include
 126 their sizes and checksums in the B<.buildinfo> file).
 127
 128 =item B<--always-include-kernel>
 129
 130 By default, the B<Build-Kernel-Version> field will not be written out.
 131
 132 Specify this option (since dpkg 1.19.0) to always write a
 133 B<Build-Kernel-Version> field when generating the B<.buildinfo>.
 134
 135 =item B<--always-include-path>
 136
 137 By default, the B<Build-Path> field will only be written if the current
 138 directory starts with an allowed pattern.
 139
 140 On Debian and derivatives the pattern matches on B</build/> at the start
 141 of the pathname.
 142
 143 Specify this option to always write a B<Build-Path> field when generating
 144 the B<.buildinfo>.
 145
 146 =item B<--admindir=>I<dir>
 147
 148 Change the location of the B<dpkg> database.
 149 The default location is
 150 I</var/lib/dpkg>.
 151
 152 =item B<-q>
 153
 154 B<dpkg-genbuildinfo>
 155 might produce informative messages on standard error.
 156 B<-q>
 157 suppresses these messages.
 158
 159 =item B<-?>, B<--help>
 160
 161 Show the usage message and exit.
 162
 163 =item B<--version>
 164
 165 Show the version and exit.
 166
 167 =back
 168
 169 =head1 ENVIRONMENT
 170
 171 =over
 172
 173 =item B<DEB_BUILD_OPTIONS>
 174
 175 This variable can be used to enable or disable various features that affect
 176 the information included in the .buildinfo file, via the B<buildinfo>
 177 option (since dpkg 1.18.19).
 178 This option contains a comma-separated list of features, prefixed with the
 179 ‘B<+>’ or ‘B<->’ modifiers, to denote whether to enable or disable
 180 them.
 181 The special feature “B<all>” can be used to enable or disable all other
 182 features.
 183 The feature “B<path>” controls whether to unconditionally include the
 184 B<Build-Path> field.
 185
 186 =item B<DEB_BUILD_ARCH>
 187
 188 Sets the build architecture.
 189 This affects the value for the B<Build-Architecture> field,
 190 and the check for the cross-compilation mode.
 191
 192 =item B<DEB_HOST_ARCH>
 193
 194 Sets the host architecture.
 195 This affects the filename used for the .buildinfo file,
 196 and the check for the cross-compilation mode.
 197
 198 =item B<DPKG_COLORS>
 199
 200 Sets the color mode (since dpkg 1.18.5).
 201 The currently accepted values are: B<auto> (default), B<always> and
 202 B<never>.
 203
 204 =item B<DPKG_NLS>
 205
 206 If set, it will be used to decide whether to activate Native Language Support,
 207 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 208 The accepted values are: B<0> and B<1> (default).
 209
 210 =back
 211
 212 =head1 FILES
 213
 214 =over
 215
 216 =item B<debian/files>
 217
 218 The list of generated files.
 219 B<dpkg-genbuildinfo>
 220 reads the data here when producing a
 221 B<.buildinfo>
 222 file.
 223
 224 =back
 225
 226 =head1 SEE ALSO
 227
 228 L<deb-buildinfo(5)>.