debhelper.1

   1 .TH DEBHELPER 1 "" "Debhelper Commands" "Debhelper Commands"
   2 .SH NAME
   3 debhelper \- overview of the debhelper commands
   4 .SH SYNOPSIS
   5 .B dh_*
   6 .I "[-v] [-a] [-i] [--no-act] [-ppackage] [-Npackage] [-Ptmpdir]"
   7 .SH "DESCRIPTION"
   8 Debhelper is a collection of programs that can be used in debian/rules files
   9 to automate common tasks related to building debian binary packages. All the
  10 debhelper commands accept a set of options, and this man page is here to
  11 document those options and to document debhelper as a whole. For additional
  12 options, and documentation for each individual command, see the commands' own
  13 man pages.
  14 .SH "SHARED DEBHLPER OPTIONS"
  15 .TP
  16 .B \-v, \--verbose
  17 Verbose mode: show all commands that modify the package build directory.
  18 .TP
  19 .B \--no-act
  20 Do not really do anything. If used with -v, the result is that the command
  21 will output a list of what it would have done.
  22 .TP
  23 .B \-a, \--arch
  24 Act on all architecture dependent packages.
  25 .TP
  26 .B \-i, \--indep
  27 Act on all architecture independent packages.
  28 .TP
  29 .B \-ppackage, \--package=package
  30 Act on the package named "package".
  31 .TP
  32 .B \-Npackage, \--no-package=package
  33 Do not act on the specified package even if an -a, -i, or -p option lists
  34 the package as one that should be acted on.
  35 .TP
  36 .B \-Ptmpdir, \--tmpdir=tmpdir
  37 Use "tmpdir" for package build directory.
  38 .SH NOTES
  39 .TP
  40 .B Multiple binary package support
  41 .RS
  42 If your source package generates more than one binary package, debhelper
  43 programs will default to acting on all binary packages when run. If your
  44 source package happens to generate one architecture dependent package, and
  45 another architecture independent package, this is not the correct behavior,
  46 because you need to generate the architecture dependent packages in the
  47 binary-arch debian/rules target, and the architecture independent packages
  48 in the binary-indep debian/rules target.
  49
  50 To facilitate this, as well as give you more control over which packages
  51 are acted on by debhelper programs, all debhelper programs accept the
  52 .B -a
  53 ,
  54 .B -i
  55 , and
  56 .B -p
  57 parameters. These parameters are cumulative. If none are given,
  58 debhelper programs default to acting on all packages listed in the control
  59 file.
  60 .P
  61 See
  62 .BR /usr/doc/debhelper/examples/rules.multi
  63 for an example of how to use this.
  64 .RE
  65 .TP
  66 .B Package build directories
  67 .RS
  68 By default, all debhelper programs assume that the temporary directory used
  69 for assembling the tree of files in a package is debian/tmp for the first
  70 package listed in debian/control, and debian/<packagename> for each
  71 additional package.
  72 .P
  73 Sometimes, you might want to use some other temporary directory. This is
  74 supported by the
  75 .B -P
  76 flag. For example, "dh_installdocs -Pdebian/tmp", will use debian/tmp as the
  77 temporary directory. Note that if you use -P, the debhelper programs can only
  78 be acting on a single package at a time. So if you have a package that builds
  79 many binary packages, you will need to use the -p flag to specify which
  80 binary package the debhelper program will act on.
  81 .RE
  82 .TP
  83 .B Other notes
  84 In general, if any debhelper program needs a directory to exist under
  85 debian/, it will create it. I haven't bothered to document this in all the
  86 man pages, but for example, dh_installdeb knows to make debian/tmp/DEBIAN/
  87 before trying to put files there, dh_installmenu knows you need a
  88 debian/tmp/usr/lib/menu/ before installing the menu files, etc.
  89 .SH ENVIRONMENT
  90 .TP
  91 .I DH_VERBOSE
  92 Enables verbose mode.
  93 .TP
  94 .I DH_NO_ACT
  95 Enables no-act mode.
  96 .SH "SEE ALSO"
  97 .TP
  98 .BR /usr/doc/debhelper/README
  99 An introduction to debhelper.
 100 .TP
 101 .BR /usr/doc/debhelper/examples/
 102 A set of example debian/rules files that use debhelper.
 103 .SH AUTHOR
 104 Joey Hess <joeyh@master.debian.org>