chiark - git - mdw - dpkg/blob - man/dpkg-genbuildinfo.man

   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 .TH dpkg\-genbuildinfo 1 "%RELEASE_DATE%" "%VERSION%" "dpkg suite"
  23 .nh
  24 .SH NAME
  25 dpkg\-genbuildinfo \- generate Debian .buildinfo files
  26 .
  27 .SH SYNOPSIS
  28 .B dpkg\-genbuildinfo
  29 .RI [ option ...]
  30 .br
  31 .
  32 .SH DESCRIPTION
  33 .B dpkg\-genbuildinfo
  34 reads information from an unpacked and built Debian source tree and
  35 from the files it has generated and generates a Debian control
  36 file describing the build environment and the build artifacts
  37 .RB ( .buildinfo " file)."
  38 .P
  39 This command was introduced in dpkg 1.18.11.
  40 .
  41 .SH OPTIONS
  42 .TP
  43 .BI \-\-build= type
  44 Specifies the build \fItype\fP from a comma-separated list of components.
  45
  46 The allowed values are:
  47 .RS
  48 .TP
  49 .B any
  50 Generate build information including unqualified build dependencies
  51 (\fBBuild\-Depends\fP) and architecture specific build dependencies
  52 (\fBBuild\-Depends\-Arch\fP).
  53 .TP
  54 .B all
  55 Generate build information including unqualified build dependencies
  56 (\fBBuild\-Depends\fP) and architecture independent build dependencies
  57 (\fBBuild\-Depends\-Indep\fP).
  58 .TP
  59 .B source
  60 Effectively ignored; generate build information with just the unqualified
  61 build dependencies (\fBBuild\-Depends\fP).
  62 .TP
  63 .B binary
  64 Generate build information with all three types of build dependencies.
  65 This is an alias for \fBany,all\fP.
  66 .TP
  67 .B full
  68 Generate build information with all three types of build dependencies.
  69 This is an alias for \fBany,all,source\fP, and the same as the default
  70 case when no build option is specified.
  71 .RE
  72 .TP
  73 .BI \-c controlfile
  74 Specifies the main source control file to read information from. The
  75 default is
  76 .BR debian/control .
  77 .TP
  78 .BI \-l changelog-file
  79 Specifies the changelog file to read information from. The
  80 default is
  81 .BR debian/changelog .
  82 .TP
  83 .BI \-f files-list-file
  84 Specifies where is the list of files that have been produced by the build,
  85 rather than using
  86 .BR debian/files .
  87 .TP
  88 .BI \-F changelog-format
  89 Specifies the format of the changelog. See \fBdpkg\-parsechangelog\fP(1)
  90 for information about alternative formats.
  91 .TP
  92 .BR \-O [\fIfilename\fP]
  93 Print the buildinfo file to standard output (or \fIfilename\fP if specified)
  94 rather than to
  95 .IB dir / source-name _ binary-version _ arch .buildinfo
  96 (where \fIdir\fP is \fB..\fP by default or \fIupload-files-dir\fP
  97 if \fB\-u\fP was used).
  98 .TP
  99 .BI \-u upload-files-dir
 100 Look for the files to be uploaded in
 101 .I upload-files-dir
 102 rather than
 103 .B ..
 104 (\fBdpkg\-genbuildinfo\fP needs to find these files so that it can include
 105 their sizes and checksums in the \fB.buildinfo\fP file).
 106 .TP
 107 .BI \-\-always\-include\-path
 108 By default, the \fBBuild\-Path\fR field will only be written if the current
 109 directory starts with a whitelisted pattern.
 110
 111 On Debian and derivatives the pattern matches on \fB/build/\fR at the start
 112 of the pathname.
 113
 114 Specify this option to always write a \fBBuild\-Path\fR field when generating
 115 the \fB.buildinfo\fR.
 116 .TP
 117 .BI \-\-admindir= dir
 118 Change the location of the \fBdpkg\fR database. The default location is
 119 \fI/var/lib/dpkg\fP.
 120 .TP
 121 .B \-q
 122 .B dpkg\-genbuildinfo
 123 might produce informative messages on standard error.
 124 .B \-q
 125 suppresses these messages.
 126 .TP
 127 .BR \-? ", " \-\-help
 128 Show the usage message and exit.
 129 .TP
 130 .BR \-\-version
 131 Show the version and exit.
 132 .
 133 .SH ENVIRONMENT
 134 .TP
 135 .B DEB_BUILD_OPTIONS
 136 This variable can be used to enable or disable various features that affect
 137 the information included in the .buildinfo file, via the \fBbuildinfo\fP
 138 option (since dpkg 1.18.19).
 139 This option contains a comma-separated list of features, prefixed with the
 140 ‘\fB+\fP’ or ‘\fB\-\fP’ modifiers, to denote whether to enable or disable
 141 them.
 142 The special feature “\fBall\fP” can be used to enable or disable all other
 143 features.
 144 The feature “\fBpath\fP” controls whether to unconditionally include the
 145 \fBBuild\-Path\fP field.
 146 .
 147 .SH FILES
 148 .TP
 149 .B debian/files
 150 The list of generated files.
 151 .B dpkg\-genbuildinfo
 152 reads the data here when producing a
 153 .B .buildinfo
 154 file.
 155 .
 156 .SH SEE ALSO
 157 .BR deb-buildinfo (5).