.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DH_ELPA.IN 1"
.TH DH_ELPA.IN 1 "2017-01-08" "perl v5.24.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_elpa \- install emacs lisp packages into package build directories
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_elpa\fR [\fIdebhelper\ options\fR]  [\fIpkg-file\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_elpa\fR is a debhelper program that is responsible for installing
elpa style emacs lisp packages into package build directories.
.PP
\&\fBdh_elpa\fR will attempt to run \s-1ERT\s0 and Buttercup test suites using
\&\fIdh_elpa_test\fR\|(1) if the debhelper compat level is 10 or higher.  To
disable this behaviour, or tweak it if it is failing to run the tests
as they should be run, set environment variables in debian/rules as
detailed in \fIdh_elpa_test\fR\|(1).
.SH "FILES"
.IX Header "FILES"
.IP "debian/\fIpackage\fR.elpa" 4
.IX Item "debian/package.elpa"
List of files to be installed into \fIpackage\fR as an elpa package.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-byte\-compile\fR, \fB\-\-no\-byte\-compile\fR" 4
.IX Item "--byte-compile, --no-byte-compile"
Enable (default) or disable byte compilation of installed emacs lisp
files.  Disabling byte compilation changes the destination directory
to one that is found by the emacs package system.
.IP "\fB\-\-fix\-autoload\-date\fR, \fB\-\-no\*(--fix\-autoload\-date\fR" 4
.IX Item "--fix-autoload-date, --nofix-autoload-date"
Enable (default) or disable munging the dates in Emacs generated
autoload files to match debian/changelog.
.SH "SUBSTVARS"
.IX Header "SUBSTVARS"
dh_elpa currently defines three substvars (cf. \fIdeb\-substvars\fR\|(5)) that
can be used in debian/control
.IP "${misc:Depends}" 4
.IX Item "${misc:Depends}"
These are dependencies needed by every dh_elpa based package.
.IP "${misc:Built\-Using}" 4
.IX Item "${misc:Built-Using}"
This adds a value suitable for a Built-Using header identifying the
version of dh_elpa used at build time.
.IP "${elpa:Depends}" 4
.IX Item "${elpa:Depends}"
These are dependencies on other \s-1ELPA\s0 packages as given in the
Package-Requires: line of the package's main Emacs Lisp file.
.Sp
Note that Emacs Lisp dependencies packaged outside the elpa\-* dpkg
namespace must be specified manually.  For example, the s.el library
is provided by the binary package s\-el.  If dh_elpa adds dependency
elpa-x where x is an Emacs Lisp binary package outside the elpa\-*
namespace, please file a bug against dh_elpa to have an exclusion
added.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Here is an example of using the helper in a \fIdh\fR\|(1) style debian/rules
.Sp
.Vb 3
\&    #!/usr/bin/make \-f
\&    %:
\&        dh $@ \-\-with elpa
.Ve
.PP
Here is an example of a binary package stanza using dh_elpa generated
substvars
.Sp
.Vb 6
\&    Package: elpa\-hello
\&    Architecture: all
\&    Depends: ${misc:Depends}, ${elpa:Depends}
\&    Built\-Using: ${misc:Built\-Using}
\&    Description: Emacs addon to say hello
\&     The Emacs editor addon likes to wave and say hello.
.Ve
.SH "HINTS"
.IX Header "HINTS"
.SS "Specifying the package version"
.IX Subsection "Specifying the package version"
If dh_elpa can't determine the package version by looking at *.el
files (usually because upstream has failed to include the proper
headers or *\-pkg.el file), it will fallback to the
\&\s-1DEB_UPSTREAM_VERSION\s0 and \s-1DEB_VERSION_UPSTREAM. \s0 An easy way to set one
of these based on your latest Debian changelog entry is just to
prepend the following to your rules file:
.Sp
.Vb 2
\&    include /usr/share/dpkg/pkg\-info.mk
\&    export DEB_VERSION_UPSTREAM
.Ve
.PP
Certain Debian upstream version strings cannot be translated into
version strings Emacs will accept (see the docstring for the Emacs
function `version\-to\-list' for details).  dh_elpa will error out if
the version cannot be translated.  You should resort to patching in a
Package-Version header or adding a *\-pkg.el file.