man/deb-src-rules.pod

   1 # dpkg manual page - deb-src-rules(5)
   2 #
   3 # Copyright © 2016-2017 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 deb-src-rules - Debian source package rules file
  23
  24 =head1 SYNOPSIS
  25
  26 B<debian/rules>
  27
  28 =head1 DESCRIPTION
  29
  30 This file contains the instructions necessary to build the binary packages
  31 from the source package.
  32
  33 The I<debian/rules> file is an executable Makefile, with a shebang that
  34 is usually set to "#!/usr/bin/make -f".
  35
  36 It must support the following make targets:
  37
  38 =over
  39
  40 =item B<clean>
  41
  42 Clean up the source tree, by undoing any change done by any of the build
  43 and binary targets.
  44 This target will be called with root privileges.
  45
  46 =item B<build-indep>
  47
  48 Build architecture independent files required to build any architecture
  49 independent binary package.
  50 If there are no architecture independent binary packages to generate,
  51 the target must still exist but do nothing.
  52 This target must not require root privileges.
  53
  54 =item B<build-arch>
  55
  56 Build architecture dependent files required to build any architecture
  57 dependent binary package.
  58 If there are no architecture dependent binary packages to generate,
  59 the target must still exist but do nothing.
  60 This target must not require root privileges.
  61
  62 =item B<build>
  63
  64 Build architecture independent and dependent files, either by depending
  65 (at least transitively) on B<build-indep> and/or B<build-arch> or
  66 by inlining what those targets would do.
  67 This target must not require root privileges.
  68
  69 =item B<binary-indep>
  70
  71 Build architecture independent binary packages.
  72 This target must depend (at least transitively) on either B<build-indep>
  73 or B<build>.
  74 This target will be called with root privileges.
  75
  76 =item B<binary-arch>
  77
  78 Build architecture dependent binary packages.
  79 This target must depend (at least transitively) on either B<build-arch>
  80 or B<build>.
  81 This target will be called with root privileges.
  82
  83 =item B<binary>
  84
  85 Build architecture independent and dependent binary packages, either by
  86 depending (at least transitively) on B<binary-indep> and/or
  87 B<binary-arch> or by inlining what those targets would do.
  88 This target will be called with root privileges.
  89
  90 =back
  91
  92 =head1 SEE ALSO
  93
  94 L<dpkg-architecture(1)>,
  95 L<dpkg-vendor(1)>,
  96 L<dpkg-buildflags(1)>,
  97 L<dpkg-parsechangelog(1)>,
  98 L<dpkg-shlibdeps(1)>,
  99 L<dpkg-gencontrol(1)>,
 100 L<dpkg-deb(1)>,
 101 L<dpkg-distaddfile(1)>.