.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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 "DH 1"
.TH DH 1 "2016-07-19" "9.20150101+deb8u2" "Debhelper"
.\" 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"
dh \- debhelper command sequencer
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh\fR \fIsequence\fR [\fB\-\-with\fR \fIaddon\fR[\fB,\fR\fIaddon\fR ...]] [\fB\-\-list\fR] [\fIdebhelper options\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh\fR runs a sequence of debhelper commands. The supported \fIsequence\fRs
correspond to the targets of a \fIdebian/rules\fR file: \fBbuild-arch\fR,
\&\fBbuild-indep\fR, \fBbuild\fR, \fBclean\fR, \fBinstall-indep\fR, \fBinstall-arch\fR,
\&\fBinstall\fR, \fBbinary-arch\fR, \fBbinary-indep\fR, and \fBbinary\fR.
.SH "OVERRIDE TARGETS"
.IX Header "OVERRIDE TARGETS"
A \fIdebian/rules\fR file using \fBdh\fR can override the command that is run
at any step in a sequence, by defining an override target.
.PP
To override \fIdh_command\fR, add a target named \fBoverride_\fR\fIdh_command\fR to
the rules file. When it would normally run \fIdh_command\fR, \fBdh\fR will
instead call that target. The override target can then run the command with
additional options, or run entirely different commands instead. See
examples below.
.PP
Override targets can also be defined to run only when building
architecture dependent or architecture independent packages.
Use targets with names like \fBoverride_\fR\fIdh_command\fR\fB\-arch\fR
and \fBoverride_\fR\fIdh_command\fR\fB\-indep\fR.
(Note that to use this feature, you should Build-Depend on
debhelper 8.9.7 or above.)
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-with\fR \fIaddon\fR[\fB,\fR\fIaddon\fR ...]" 4
.IX Item "--with addon[,addon ...]"
Add the debhelper commands specified by the given addon to appropriate places
in the sequence of commands that is run. This option can be repeated more
than once, or multiple addons can be listed, separated by commas.
This is used when there is a third-party package that provides
debhelper commands. See the \fI\s-1PROGRAMMING\s0\fR file for documentation about
the sequence addon interface.
.IP "\fB\-\-without\fR \fIaddon\fR" 4
.IX Item "--without addon"
The inverse of \fB\-\-with\fR, disables using the given addon. This option
can be repeated more than once, or multiple addons to disable can be
listed, separated by commas.
.IP "\fB\-\-list\fR, \fB\-l\fR" 4
.IX Item "--list, -l"
List all available addons.
.IP "\fB\-\-no\-act\fR" 4
.IX Item "--no-act"
Prints commands that would run for a given sequence, but does not run them.
.Sp
Note that dh normally skips running commands that it knows will do nothing.
With \-\-no\-act, the full list of commands in a sequence is printed.
.PP
Other options passed to \fBdh\fR are passed on to each command it runs. This
can be used to set an option like \fB\-v\fR or \fB\-X\fR or \fB\-N\fR, as well as for more
specialised options.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
To see what commands are included in a sequence, without actually doing
anything:
.PP
.Vb 1
\&        dh binary\-arch \-\-no\-act
.Ve
.PP
This is a very simple rules file, for packages where the default sequences of
commands work with no additional options.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
.Ve
.PP
Often you'll want to pass an option to a specific debhelper command. The
easy way to do with is by adding an override target for that command.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
\&        
\&        override_dh_strip:
\&                dh_strip \-Xfoo
\&        
\&        override_dh_auto_configure:
\&                dh_auto_configure \-\- \-\-with\-foo \-\-disable\-bar
.Ve
.PP
Sometimes the automated \fIdh_auto_configure\fR\|(1) and \fIdh_auto_build\fR\|(1)
can't guess what to do for a strange package. Here's how to avoid running
either and instead run your own commands.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
\&
\&        override_dh_auto_configure:
\&                ./mondoconfig
\&
\&        override_dh_auto_build:
\&                make universe\-explode\-in\-delight
.Ve
.PP
Another common case is wanting to do something manually before or
after a particular debhelper command is run.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
\&
\&        override_dh_fixperms:
\&                dh_fixperms
\&                chmod 4755 debian/foo/usr/bin/foo
.Ve
.PP
If your package uses autotools and you want to freshen \fIconfig.sub\fR and
\&\fIconfig.guess\fR with newer versions from the \fBautotools-dev\fR package
at build time, you can use some commands provided in \fBautotools-dev\fR
that automate it, like this.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-with autotools_dev
.Ve
.PP
Python tools are not run by dh by default, due to the continual change
in that area. (Before compatibility level v9, dh does run \fBdh_pysupport\fR.)
Here is how to use \fBdh_python2\fR.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-with python2
.Ve
.PP
Here is how to force use of Perl's \fBModule::Build\fR build system,
which can be necessary if debhelper wrongly detects that the package
uses MakeMaker.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-buildsystem=perl_build
.Ve
.PP
Here is an example of overriding where the \fBdh_auto_\fR\fI*\fR commands find
the package's source, for a package where the source is located in a
subdirectory.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-sourcedirectory=src
.Ve
.PP
And here is an example of how to tell the \fBdh_auto_\fR\fI*\fR commands to build
in a subdirectory, which will be removed on \fBclean\fR.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-builddirectory=build
.Ve
.PP
If your package can be built in parallel, you can support parallel building
as follows. Then \fBdpkg-buildpackage \-j\fR will work.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@ \-\-parallel
.Ve
.PP
Here is a way to prevent \fBdh\fR from running several commands that you don't
want it to run, by defining empty override targets for each command.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
\&        
\&        # Commands not to run:
\&        override_dh_auto_test override_dh_compress override_dh_fixperms:
.Ve
.PP
A long build process for a separate documentation package can
be separated out using architecture independent overrides.
These will be skipped when running build-arch and binary-arch sequences.
.PP
.Vb 3
\&        #!/usr/bin/make \-f
\&        %:
\&                dh $@
\&        
\&        override_dh_auto_build\-indep:
\&                $(MAKE) \-C docs
\&
\&        # No tests needed for docs
\&        override_dh_auto_test\-indep:
\&
\&        override_dh_auto_install\-indep:
\&                $(MAKE) \-C docs install
.Ve
.PP
Adding to the example above, suppose you need to chmod a file, but only
when building the architecture dependent package, as it's not present
when building only documentation.
.PP
.Vb 3
\&        override_dh_fixperms\-arch:
\&                dh_fixperms
\&                chmod 4755 debian/foo/usr/bin/foo
.Ve
.SH "INTERNALS"
.IX Header "INTERNALS"
If you're curious about \fBdh\fR's internals, here's how it works under the hood.
.PP
Each debhelper command will record when it's successfully run in
\&\fIdebian/package.debhelper.log\fR. (Which \fBdh_clean\fR deletes.) So \fBdh\fR can tell
which commands have already been run, for which packages, and skip running
those commands again.
.PP
Each time \fBdh\fR is run, it examines the log, and finds the last logged command
that is in the specified sequence. It then continues with the next command
in the sequence. The \fB\-\-until\fR, \fB\-\-before\fR, \fB\-\-after\fR, and \fB\-\-remaining\fR
options can override this behavior.
.PP
A sequence can also run dependent targets in debian/rules.  For
example, the \*(L"binary\*(R" sequence runs the \*(L"install\*(R" target.
.PP
\&\fBdh\fR uses the \fB\s-1DH_INTERNAL_OPTIONS\s0\fR environment variable to pass information
through to debhelper commands that are run inside override targets. The
contents (and indeed, existence) of this environment variable, as the name
might suggest, is subject to change at any time.
.PP
Commands in the \fBbuild-indep\fR, \fBinstall-indep\fR and \fBbinary-indep\fR
sequences are passed the \fB\-i\fR option to ensure they only work on
architecture independent packages, and commands in the \fBbuild-arch\fR,
\&\fBinstall-arch\fR and \fBbinary-arch\fR sequences are passed the \fB\-a\fR
option to ensure they only work on architecture dependent packages.
.SH "DEPRECATED OPTIONS"
.IX Header "DEPRECATED OPTIONS"
The following options are deprecated. It's much 
better to use override targets instead.
.IP "\fB\-\-until\fR \fIcmd\fR" 4
.IX Item "--until cmd"
Run commands in the sequence until and including \fIcmd\fR, then stop.
.IP "\fB\-\-before\fR \fIcmd\fR" 4
.IX Item "--before cmd"
Run commands in the sequence before \fIcmd\fR, then stop.
.IP "\fB\-\-after\fR \fIcmd\fR" 4
.IX Item "--after cmd"
Run commands in the sequence that come after \fIcmd\fR.
.IP "\fB\-\-remaining\fR" 4
.IX Item "--remaining"
Run all commands in the sequence that have yet to be run.
.PP
In the above options, \fIcmd\fR can be a full name of a debhelper command, or
a substring. It'll first search for a command in the sequence exactly
matching the name, to avoid any ambiguity. If there are multiple substring
matches, the last one in the sequence will be used.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIdebhelper\fR\|(7)
.PP
This program is a part of debhelper.
.SH "AUTHOR"
.IX Header "AUTHOR"
Joey Hess <joeyh@debian.org>