man/dpkg-buildapi.pod

   1 # dpkg manual page - dpkg-buildapi(1)
   2 #
   3 # Copyright © 2023 Guillem Jover <guillem@debian.org>
   4 #
   5 # This is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 2 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  17
  18 =encoding utf8
  19
  20 =head1 NAME
  21
  22 dpkg-buildapi - returns the build API level to use during package build
  23
  24 =head1 SYNOPSIS
  25
  26 B<dpkg-buildapi> [I<option>...] [I<command>]
  27
  28 =head1 DESCRIPTION
  29
  30 B<dpkg-buildapi> is a tool to retrieve the L<dpkg-build-api(7)> level to
  31 use during build of source Debian packages.
  32
  33 This program was introduced in dpkg 1.22.0.
  34
  35 =head1 COMMANDS
  36
  37 =over
  38
  39 =item B<-c>I<control-file>
  40
  41 Specifies the main source control file to read information from.
  42 The default is F<debian/control>.
  43
  44 =item B<--help>
  45
  46 Show the usage message and exit.
  47
  48 =item B<--version>
  49
  50 Show the version and exit.
  51
  52 =back
  53
  54 =head1 ENVIRONMENT
  55
  56 =over
  57
  58 =item B<DPKG_BUILD_API>
  59
  60 The build API level to use.
  61 This is intended to be used internally by the tools executed from
  62 F<debian/rules> to avoid having to parse F<debian/control> multiple times,
  63 and not to set the global build API level from F<debian/rules>,
  64 otherwise build drivers (such as L<dpkg-buildpackage(1)>) cannot access it.
  65
  66 =back
  67
  68 =head1 FILES
  69
  70 =head2 Packaging support
  71
  72 =over
  73
  74 =item B<%PKGDATADIR%/buildapi.mk>
  75
  76 Makefile snippet that will parse the build API level.
  77
  78 =back