man-pages/man1/dpkg-genbuildinfo.1.html
2021-03-31 01:06:50 +01:00

236 lines
6.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of dpkg-genbuildinfo</TITLE>
</HEAD><BODY>
<H1>dpkg-genbuildinfo</H1>
Section: dpkg suite (1)<BR>Updated: 2020-03-23<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
dpkg-genbuildinfo - generate Debian .buildinfo files
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>dpkg-genbuildinfo</B>
[<I>option</I>...]
<BR>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>dpkg-genbuildinfo</B>
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
(<B>.buildinfo</B> file).
<P>
This command was introduced in dpkg 1.18.11.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>--build=</B><I>type</I>
<DD>
Specifies the build <I>type</I> from a comma-separated list of components.
<P>
The allowed values are:
<DL COMPACT><DT id="2"><DD>
<DL COMPACT>
<DT id="3"><B>any</B>
<DD>
Generate build information including unqualified build dependencies
(<B>Build-Depends</B>) and architecture specific build dependencies
(<B>Build-Depends-Arch</B>).
<DT id="4"><B>all</B>
<DD>
Generate build information including unqualified build dependencies
(<B>Build-Depends</B>) and architecture independent build dependencies
(<B>Build-Depends-Indep</B>).
<DT id="5"><B>source</B>
<DD>
Effectively ignored; generate build information with just the unqualified
build dependencies (<B>Build-Depends</B>).
<DT id="6"><B>binary</B>
<DD>
Generate build information with all three types of build dependencies.
This is an alias for <B>any,all</B>.
<DT id="7"><B>full</B>
<DD>
Generate build information with all three types of build dependencies.
This is an alias for <B>any,all,source</B>, and the same as the default
case when no build option is specified.
</DL>
</DL>
<DT id="8"><B>-c</B><I>controlfile</I>
<DD>
Specifies the main source control file to read information from. The
default is
<B>debian/control</B>.
<DT id="9"><B>-l</B><I>changelog-file</I>
<DD>
Specifies the changelog file to read information from. The
default is
<B>debian/changelog</B>.
<DT id="10"><B>-f</B><I>files-list-file</I>
<DD>
Specifies where is the list of files that have been produced by the build,
rather than using
<B>debian/files</B>.
<DT id="11"><B>-F</B><I>changelog-format</I>
<DD>
Specifies the format of the changelog. See <B><A HREF="/cgi-bin/man/man2html?1+dpkg-parsechangelog">dpkg-parsechangelog</A></B>(1)
for information about alternative formats.
<DT id="12"><B>-O</B>[<I>filename</I>]
<DD>
Print the buildinfo file to standard output (or <I>filename</I> if specified)
rather than to
<I>dir</I><B>/</B><I>source-name</I><B>_</B><I>binary-version</I><B>_</B><I>arch</I><B>.buildinfo</B>
(where <I>dir</I> is <B>..</B> by default or <I>upload-files-dir</I>
if <B>-u</B> was used).
<DT id="13"><B>-u</B><I>upload-files-dir</I>
<DD>
Look for the files to be uploaded in
<I>upload-files-dir</I>
rather than
<B>..</B>
(<B>dpkg-genbuildinfo</B> needs to find these files so that it can include
their sizes and checksums in the <B>.buildinfo</B> file).
<DT id="14"><B>--always-include-kernel</B>
<DD>
By default, the <B>Build-Kernel-Version</B> field will not be written out.
<P>
Specify this option (since dpkg 1.19.0) to always write a
<B>Build-Kernel-Version</B> field when generating the <B>.buildinfo</B>.
<DT id="15"><B>--always-include-path</B>
<DD>
By default, the <B>Build-Path</B> field will only be written if the current
directory starts with a whitelisted pattern.
<P>
On Debian and derivatives the pattern matches on <B>/build/</B> at the start
of the pathname.
<P>
Specify this option to always write a <B>Build-Path</B> field when generating
the <B>.buildinfo</B>.
<DT id="16"><B>--admindir=</B><I>dir</I>
<DD>
Change the location of the <B>dpkg</B> database. The default location is
<I>/var/lib/dpkg</I>.
<DT id="17"><B>-q</B>
<DD>
<B>dpkg-genbuildinfo</B>
might produce informative messages on standard error.
<B>-q</B>
suppresses these messages.
<DT id="18"><B>-?</B>, <B>--help</B>
<DD>
Show the usage message and exit.
<DT id="19"><B>--version</B>
<DD>
Show the version and exit.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<DL COMPACT>
<DT id="20"><B>DEB_BUILD_OPTIONS</B>
<DD>
This variable can be used to enable or disable various features that affect
the information included in the .buildinfo file, via the <B>buildinfo</B>
option (since dpkg 1.18.19).
This option contains a comma-separated list of features, prefixed with the
'<B>+</B>' or '<B>-</B>' modifiers, to denote whether to enable or disable
them.
The special feature "<B>all</B>" can be used to enable or disable all other
features.
The feature "<B>path</B>" controls whether to unconditionally include the
<B>Build-Path</B> field.
<DT id="21"><B>DPKG_COLORS</B>
<DD>
Sets the color mode (since dpkg 1.18.5).
The currently accepted values are: <B>auto</B> (default), <B>always</B> and
<B>never</B>.
<DT id="22"><B>DPKG_NLS</B>
<DD>
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: <B>0</B> and <B>1</B> (default).
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>FILES</H2>
<DL COMPACT>
<DT id="23"><B>debian/files</B>
<DD>
The list of generated files.
<B>dpkg-genbuildinfo</B>
reads the data here when producing a
<B>.buildinfo</B>
file.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?5+deb-buildinfo">deb-buildinfo</A></B>(5).
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="24"><A HREF="#lbAB">NAME</A><DD>
<DT id="25"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="26"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="27"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="28"><A HREF="#lbAF">ENVIRONMENT</A><DD>
<DT id="29"><A HREF="#lbAG">FILES</A><DD>
<DT id="30"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:11 GMT, March 31, 2021
</BODY>
</HTML>