.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "dpkg-genbuildinfo 1"
.TH dpkg-genbuildinfo 1 2024-08-01 1.22.11 "dpkg suite"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dpkg\-genbuildinfo \- generate Debian .buildinfo files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdpkg-genbuildinfo\fR
[\fIoption\fR...]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdpkg-genbuildinfo\fR
reads information from an unpacked and built Debian source tree and
from the files it has generated and generates a Debian control
file describing the build environment and the build artifacts
(\fB.buildinfo\fR file).
.PP
This program was introduced in dpkg 1.18.11.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-build=\fR\fItype\fR 4
.IX Item "--build=type"
Specifies the build \fItype\fR from a comma-separated list of components.
.Sp
The allowed values are:
.RS 4
.IP \fBany\fR 4
.IX Item "any"
Generate build information including unqualified build dependencies
(\fBBuild-Depends\fR) and architecture specific build dependencies
(\fBBuild-Depends-Arch\fR).
.IP \fBall\fR 4
.IX Item "all"
Generate build information including unqualified build dependencies
(\fBBuild-Depends\fR) and architecture independent build dependencies
(\fBBuild-Depends-Indep\fR).
.IP \fBsource\fR 4
.IX Item "source"
Effectively ignored; generate build information with just the unqualified
build dependencies (\fBBuild-Depends\fR).
.IP \fBbinary\fR 4
.IX Item "binary"
Generate build information with all three types of build dependencies.
This is an alias for \fBany,all\fR.
.IP \fBfull\fR 4
.IX Item "full"
Generate build information with all three types of build dependencies.
This is an alias for \fBany,all,source\fR, and the same as the default
case when no build option is specified.
.RE
.RS 4
.RE
.IP \fB\-c\fR\fIcontrolfile\fR 4
.IX Item "-ccontrolfile"
Specifies the main source control file to read information from.
The
default is
\&\fBdebian/control\fR.
.IP \fB\-l\fR\fIchangelog-file\fR 4
.IX Item "-lchangelog-file"
Specifies the changelog file to read information from.
The
default is
\&\fBdebian/changelog\fR.
.IP \fB\-f\fR\fIfiles-list-file\fR 4
.IX Item "-ffiles-list-file"
Specifies where is the list of files that have been produced by the build,
rather than using
\&\fBdebian/files\fR.
.IP \fB\-F\fR\fIchangelog-format\fR 4
.IX Item "-Fchangelog-format"
Specifies the format of the changelog.
See \fBdpkg\-parsechangelog\fR\|(1)
for information about alternative formats.
.IP \fB\-O\fR[\fIfilename\fR] 4
.IX Item "-O[filename]"
Print the buildinfo file to standard output (or \fIfilename\fR if specified)
rather than to
\&\fIdir\fR\fB/\fR\fIsource-name\fR\fB_\fR\fIbinary-version\fR\fB_\fR\fIarch\fR\fB.buildinfo\fR
(where \fIdir\fR is \fB..\fR by default or \fIupload-files-dir\fR
if \fB\-u\fR was used).
.IP \fB\-u\fR\fIupload-files-dir\fR 4
.IX Item "-uupload-files-dir"
Look for the files to be uploaded in
\&\fIupload-files-dir\fR
rather than
\&\fB..\fR
(\fBdpkg-genbuildinfo\fR needs to find these files so that it can include
their sizes and checksums in the \fB.buildinfo\fR file).
.IP \fB\-\-always\-include\-kernel\fR 4
.IX Item "--always-include-kernel"
By default, the \fBBuild-Kernel-Version\fR field will not be written out.
.Sp
Specify this option (since dpkg 1.19.0) to always write a
\&\fBBuild-Kernel-Version\fR field when generating the \fB.buildinfo\fR.
.IP \fB\-\-always\-include\-path\fR 4
.IX Item "--always-include-path"
By default, the \fBBuild-Path\fR field will only be written if the current
directory starts with an allowed pattern.
.Sp
On Debian and derivatives the pattern matches on \fB/build/\fR at the start
of the pathname.
.Sp
Specify this option to always write a \fBBuild-Path\fR field when generating
the \fB.buildinfo\fR.
.IP \fB\-\-admindir=\fR\fIdir\fR 4
.IX Item "--admindir=dir"
Change the location of the \fBdpkg\fR database.
The default location is
\&\fI/var/lib/dpkg\fR.
.IP \fB\-q\fR 4
.IX Item "-q"
\&\fBdpkg-genbuildinfo\fR
might produce informative messages on standard error.
\&\fB\-q\fR
suppresses these messages.
.IP "\fB\-?\fR, \fB\-\-help\fR" 4
.IX Item "-?, --help"
Show the usage message and exit.
.IP \fB\-\-version\fR 4
.IX Item "--version"
Show the version and exit.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
.IP \fBDEB_BUILD_OPTIONS\fR 4
.IX Item "DEB_BUILD_OPTIONS"
This variable can be used to enable or disable various features that affect
the information included in the .buildinfo file, via the \fBbuildinfo\fR
option (since dpkg 1.18.19).
This option contains a comma-separated list of features, prefixed with the
\(oq\fB+\fR\(cq or \(oq\fB\-\fR\(cq modifiers, to denote whether to enable or disable
them.
The special feature \(lq\fBall\fR\(rq can be used to enable or disable all other
features.
The feature \(lq\fBpath\fR\(rq controls whether to unconditionally include the
\&\fBBuild-Path\fR field.
.IP \fBDEB_BUILD_ARCH\fR 4
.IX Item "DEB_BUILD_ARCH"
Sets the build architecture.
This affects the value for the \fBBuild-Architecture\fR field,
and the check for the cross-compilation mode.
.IP \fBDEB_HOST_ARCH\fR 4
.IX Item "DEB_HOST_ARCH"
Sets the host architecture.
This affects the filename used for the .buildinfo file,
and the check for the cross-compilation mode.
.IP \fBDPKG_COLORS\fR 4
.IX Item "DPKG_COLORS"
Sets the color mode (since dpkg 1.18.5).
The currently accepted values are: \fBauto\fR (default), \fBalways\fR and
\&\fBnever\fR.
.IP \fBDPKG_NLS\fR 4
.IX Item "DPKG_NLS"
If set, it will be used to decide whether to activate Native Language Support,
also known as internationalization (or i18n) support (since dpkg 1.19.0).
The accepted values are: \fB0\fR and \fB1\fR (default).
.SH FILES
.IX Header "FILES"
.IP \fBdebian/files\fR 4
.IX Item "debian/files"
The list of generated files.
\&\fBdpkg-genbuildinfo\fR
reads the data here when producing a
\&\fB.buildinfo\fR
file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdeb\-buildinfo\fR\|(5).