.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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_INSTALLDEB 1"
.TH DH_INSTALLDEB 1 "2022-11-26" "13.11.1~bpo11+1" "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_installdeb \- install files into the DEBIAN directory
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_installdeb\fR [\fIdebhelper options\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_installdeb\fR is a debhelper program that is responsible for installing
files into the \fI\s-1DEBIAN\s0\fR directories in package build directories with the
correct permissions.
.SH "FILES"
.IX Header "FILES"
.IP "\fIpackage\fR.postinst" 4
.IX Item "package.postinst"
.PD 0
.IP "\fIpackage\fR.preinst" 4
.IX Item "package.preinst"
.IP "\fIpackage\fR.postrm" 4
.IX Item "package.postrm"
.IP "\fIpackage\fR.prerm" 4
.IX Item "package.prerm"
.PD
These maintainer scripts are installed into the \fI\s-1DEBIAN\s0\fR directory.
.Sp
\&\fBdh_installdeb\fR will perform substitution of known tokens of
the pattern \fB#TOKEN#\fR.  In generally, scripts will want to
include the \fB#DEBHELPER#\fR to benefit from the shell scripts
generated by debhelper commands (including those from
\&\fBdh_installdeb\fR when it processes \fIpackage\fR.maintscript files).
.Sp
The \fB#DEBHELPER#\fR token should be placed on its own line as it is
often replaced by a multi-line shell script.
.IP "\fIpackage\fR.triggers" 4
.IX Item "package.triggers"
.PD 0
.IP "\fIpackage\fR.shlibs" 4
.IX Item "package.shlibs"
.PD
These control files are installed into the \fI\s-1DEBIAN\s0\fR directory.
.Sp
Note that \fIpackage\fR.shlibs is only installed in compat level 9 and
earlier.  In compat 10, please use \fBdh_makeshlibs\fR\|(1).
.IP "\fIpackage\fR.conffiles" 4
.IX Item "package.conffiles"
This file will be installed into the \fI\s-1DEBIAN\s0\fR directory. The
provided file will be enriched by debhelper to include all the
\&\fBconffiles\fR auto-detected by debhelper (the maintainer should
not list there as debhelper assumes it should handle that part).
.Sp
This file is primarily useful for using \*(L"special\*(R" entries such as
the \fBremove-on-upgrade\fR feature from dpkg.
.IP "\fIpackage\fR.maintscript" 4
.IX Item "package.maintscript"
Lines in this file correspond to \fBdpkg\-maintscript\-helper\fR\|(1)
commands and parameters.  However, the \*(L"maint-script-parameters\*(R"
should \fInot\fR be included as debhelper will add those automatically.
.Sp
Example:
.Sp
.Vb 4
\&    # Correct
\&    rm_conffile /etc/obsolete.conf 0.2~ foo
\&    # INCORRECT
\&    rm_conffile /etc/obsolete.conf 0.2~ foo \-\- "$@"
.Ve
.Sp
In compat 10 or later, any shell metacharacters will be escaped, so
arbitrary shell code cannot be inserted here.  For example, a line
such as \f(CW\*(C`mv_conffile /etc/oldconffile /etc/newconffile\*(C'\fR will insert
maintainer script snippets into all maintainer scripts sufficient to
move that conffile.
.Sp
It was also the intention to escape shell metacharacters in previous
compat levels.  However, it did not work properly and as such it was
possible to embed arbitrary shell code in earlier compat levels.
.Sp
The \fBdh_installdeb\fR tool will do some basic validation of some of
the commands listed in this file to catch common mistakes.  The
validation is enabled as a warning since compat 10 and as a hard
error in compat 12.
.Sp
Where possible, \fBdh_installdeb\fR may choose to rewrite some or all
of the entries into equivalent features supported in dpkg without
relying on maintainer scripts at its sole discretion (examples
include rewriting \fBrm_conffile\fR into dpkg's \fBremove-on-upgrade\fR).
The minimum requirement for activating this feature is that debhelper
runs in compat 10 or later.
.Sp
Supports substitution variables in compat 13 and later as
documented in \fBdebhelper\fR\|(7).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-D\fR\fITOKEN=VALUE\fR, \fB\-\-define\fR \fITOKEN=VALUE\fR" 4
.IX Item "-DTOKEN=VALUE, --define TOKEN=VALUE"
Define tokens to be replaced inside the maintainer scripts when
it is generated.  Please note that the limitations described in
\&\*(L"Limitations in token names\*(R" also applies to tokens defined
on the command line.  Invalid token names will trigger an error.
.Sp
In the simple case, this parameter will cause \fB#\f(BI\s-1TOKEN\s0\fB#\fR
to be replaced by \fI\s-1VALUE\s0\fR.  If \fI\s-1VALUE\s0\fR starts with a literal
\&\fI@\fR\-sign, then \fI\s-1VALUE\s0\fR is expected to point to a file
containing the actual value to insert.
.Sp
An explicit declared token with this parameter will replace built-in
tokens.
.Sp
Test examples to aid with the understanding:
.Sp
.Vb 6
\&        cat >> debian/postinst <<EOF
\&        #SIMPLE#
\&        #FILEBASED#
\&        EOF
\&        echo \-n "Complex value" > some\-file
\&    dh_installdeb \-\-define SIMPLE=direct \-\-define FILEBASED=@some\-file
.Ve
.Sp
In this example, \fB#SIMPLE#\fR will expand to \fBdirect\fR and \fB#FILEBASED#\fR
will expand to \fBComplex value\fR.
.Sp
It is also possible to set package-specific values for a given
token.  This is useful when \fBdh_installdeb\fR is acting on multiple
packages that need different values for the same token.  This is
done by prefixing the token name with \fBpkg.\f(BIpackage-name\fB.\fR.
.Sp
This can be used as in the following example:
.Sp
.Vb 10
\&        cat >> debian/foo.postinst <<EOF
\&        # Script for #PACKAGE#
\&        #TOKEN#
\&        EOF
\&        cat >> debian/bar.postinst <<EOF
\&        # Script for #PACKAGE#
\&        #TOKEN#
\&        EOF
\&        cat >> debian/baz.postinst <<EOF
\&        # Script for #PACKAGE#
\&        #TOKEN#
\&        EOF
\&    dh_installdeb \-pfoo \-pbar \-pbaz  \-\-define TOKEN=default \-\-define pkg.bar.TOKEN=unique\-bar\-value \e
\&      \-\-define pkg.baz.TOKEN=unique\-baz\-value
.Ve
.Sp
In this example, \fB#TOKEN#\fR will expand to \fBdefault\fR in \fIdebian/foo.postinst\fR,
to \fBunique-bar-value\fR in \fIdebian/bar.postinst\fR and to \fBunique-baz-value\fR
in \fIdebian/baz.postinst\fR.
.Sp
Note that the \fB#pkg.*#\fR tokens will be visible in all scripts acted on.  E.g.
you can refer to \fB#pkg.bar.TOKEN#\fR inside \fIdebian/foo.postinst\fR and it will
be replaced by \fBunique-bar-value\fR.
.SH "SUBSTITUTION IN MAINTAINER SCRIPTS"
.IX Header "SUBSTITUTION IN MAINTAINER SCRIPTS"
The \fBdh_installdeb\fR will automatically replace the following tokens
inside a provided maintainer script (if not replaced via \fB\-D\fR/\fB\-\-define\fR):
.IP "#DEBHELPER#" 4
.IX Item "#DEBHELPER#"
This token is by default replaced with generated shell snippets debhelper
commands.  This includes the snippets generated by
\&\fBdh_installdeb\fR from \fIpackage\fR.maintscript file (if present).
.IP "#DEB_HOST_\fI\s-1NAME\s0\fR#, #DEB_BUILD_\fI\s-1NAME\s0\fR#, #DEB_TARGET_\fI\s-1NAME\s0\fR#" 4
.IX Item "#DEB_HOST_NAME#, #DEB_BUILD_NAME#, #DEB_TARGET_NAME#"
These tokens are replaced with the respective variable from
\&\fBdpkg\-architecture\fR\|(1).  In almost all cases, you will want
use the \fB#DEB_HOST_\f(BI\s-1NAME\s0\fB\fR variant in a script to ensure
you get the right value when cross-building.
.Sp
On a best effort, tokens of this pattern that do not match
a variable in \fBdpkg\-architecture\fR\|(1) will be left as-is.
.IP "#ENV.\fI\s-1NAME\s0\fR#" 4
.IX Item "#ENV.NAME#"
These tokens of this form will be replaced with value of the
corresponding environment variable.  If the environment
variable is unset, the token is replaced with the empty
string.
.Sp
Note that there are limits on which names can be used (see
\&\*(L"Limitations in token names\*(R").
.IP "#PACKAGE#" 4
.IX Item "#PACKAGE#"
This token is by default replaced by the package name, which will contain
the concrete script.
.SS "Limitations in token names"
.IX Subsection "Limitations in token names"
All tokens intended to be substituted must match the regex: #[A\-Za\-z0\-9_.+]+#
.PP
Tokens that do not match that regex will be silently ignored if found in the
script template.  Invalid token names passed to \fB\-D\fR or \fB\-\-define\fR will
cause \fBdh_installdeb\fR to reject the command with an error in most cases.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(7)
.PP
This program is a part of debhelper.
.SH "AUTHOR"
.IX Header "AUTHOR"
Joey Hess <joeyh@debian.org>