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 command 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. The
  88 default is
  89 B<debian/control>.
  90
  91 =item B<-l>I<changelog-file>
  92
  93 Specifies the changelog file to read information from. The
  94 default is
  95 B<debian/changelog>.
  96
  97 =item B<-f>I<files-list-file>
  98
  99 Specifies where is the list of files that have been produced by the build,
 100 rather than using
 101 B<debian/files>.
 102
 103 =item B<-F>I<changelog-format>
 104
 105 Specifies the format of the changelog. See B<dpkg-parsechangelog>(1)
 106 for information about alternative formats.
 107
 108 =item B<-O>[I<filename>]
 109
 110 Print the buildinfo file to standard output (or I<filename> if specified)
 111 rather than to
 112 I<dir>B</>I<source-name>B<_>I<binary-version>B<_>I<arch>B<.buildinfo>
 113 (where I<dir> is B<..> by default or I<upload-files-dir>
 114 if B<-u> was used).
 115
 116 =item B<-u>I<upload-files-dir>
 117
 118 Look for the files to be uploaded in
 119 I<upload-files-dir>
 120 rather than
 121 B<..>
 122 (B<dpkg-genbuildinfo> needs to find these files so that it can include
 123 their sizes and checksums in the B<.buildinfo> file).
 124
 125 =item B<--always-include-kernel>
 126
 127 By default, the B<Build-Kernel-Version> field will not be written out.
 128
 129 Specify this option (since dpkg 1.19.0) to always write a
 130 B<Build-Kernel-Version> field when generating the B<.buildinfo>.
 131
 132 =item B<--always-include-path>
 133
 134 By default, the B<Build-Path> field will only be written if the current
 135 directory starts with an allowed pattern.
 136
 137 On Debian and derivatives the pattern matches on B</build/> at the start
 138 of the pathname.
 139
 140 Specify this option to always write a B<Build-Path> field when generating
 141 the B<.buildinfo>.
 142
 143 =item B<--admindir=>I<dir>
 144
 145 Change the location of the B<dpkg> database. The default location is
 146 I</var/lib/dpkg>.
 147
 148 =item B<-q>
 149
 150 B<dpkg-genbuildinfo>
 151 might produce informative messages on standard error.
 152 B<-q>
 153 suppresses these messages.
 154
 155 =item B<-?>, B<--help>
 156
 157 Show the usage message and exit.
 158
 159 =item B<--version>
 160
 161 Show the version and exit.
 162
 163 =back
 164
 165 =head1 ENVIRONMENT
 166
 167 =over
 168
 169 =item B<DEB_BUILD_OPTIONS>
 170
 171 This variable can be used to enable or disable various features that affect
 172 the information included in the .buildinfo file, via the B<buildinfo>
 173 option (since dpkg 1.18.19).
 174 This option contains a comma-separated list of features, prefixed with the
 175 ‘B<+>’ or ‘B<->’ modifiers, to denote whether to enable or disable
 176 them.
 177 The special feature “B<all>” can be used to enable or disable all other
 178 features.
 179 The feature “B<path>” controls whether to unconditionally include the
 180 B<Build-Path> field.
 181
 182 =item B<DPKG_COLORS>
 183
 184 Sets the color mode (since dpkg 1.18.5).
 185 The currently accepted values are: B<auto> (default), B<always> and
 186 B<never>.
 187
 188 =item B<DPKG_NLS>
 189
 190 If set, it will be used to decide whether to activate Native Language Support,
 191 also known as internationalization (or i18n) support (since dpkg 1.19.0).
 192 The accepted values are: B<0> and B<1> (default).
 193
 194 =back
 195
 196 =head1 FILES
 197
 198 =over
 199
 200 =item B<debian/files>
 201
 202 The list of generated files.
 203 B<dpkg-genbuildinfo>
 204 reads the data here when producing a
 205 B<.buildinfo>
 206 file.
 207
 208 =back
 209
 210 =head1 SEE ALSO
 211
 212 B<deb-buildinfo>(5).