.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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-MAKE-ELPA 1"
.TH DH-MAKE-ELPA 1 2024-01-14 "perl v5.38.2" "User Contributed Perl Documentation"
.\" 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\-make\-elpa \- helper for creating Debian packages from ELPA packages
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.IP "dh-make-elpa [\-\-pkg\-emacsen] [make]" 4
.IX Item "dh-make-elpa [--pkg-emacsen] [make]"
.PD 0
.IP "dh-make-elpa help" 4
.IX Item "dh-make-elpa help"
.PD
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdh-make-elpa\fR will try to create the files required to build a
Debian source package from an unpacked GNU Emacs ELPA package.
.PP
\&\fBdh-make-elpa\fR is an experimental script that performs a lot of
guesswork.  You should throughly verify the contents of the debian/
directory before uploading
.SS "TYPICAL USAGE"
.IX Subsection "TYPICAL USAGE"
.RS 4
# Set your name and email address (these will be used in \fIdebian/control\fR)
% export DEBFULLNAME="Jane Bloggs"
% export DEBEMAIL=j.s.bloggs@example.com
.Sp
% git clone \-o upstream https://foo.org/foo.git
.Sp
% cd foo
.Sp
% git reset \-\-hard 1.0.0      # package latest stable release
.Sp
% git branch \-\-unset\-upstream # detaches master branch from upstream remote
.Sp
% dh-make-elpa \-\-pkg\-emacsen
.Sp
% git add debian && git commit \-m "initial Debianisation"
.Sp
% git deborig
.Sp
% dpkg-buildpackage \-us \-uc
.RE
.SS COMMANDS
.IX Subsection "COMMANDS"
.IP make 4
.IX Item "make"
Default command if no command is given. Creates debianisation from
scratch.  Fails with an error if \fIdebian/\fR directory already
exists.
.IP help 4
.IX Item "help"
Displays short usage information.
.SS OPTIONS
.IX Subsection "OPTIONS"
.IP \fB\-\-pkg\-emacsen\fR 4
.IX Item "--pkg-emacsen"
Sets \f(CW\*(C`Maintainer\*(C'\fR, \f(CW\*(C`Uploaders\*(C'\fR, \f(CW\*(C`Vcs\-Git\*(C'\fR and \f(CW\*(C`Vcs\-Browser\*(C'\fR fields
in \fIdebian/control\fR according to the Team's conventions.
.Sp
This option is useful when preparing a package for the Debian Emacs
Addon Packaging Team <https://pkg\-emacsen.alioth.debian.org>.
.IP \fB\-\-version\fR 4
.IX Item "--version"
Specify the ELPA package version.  Useful when upstream failed to
include either a Package-Version: header or a \-pkg.el file.
.SS TIPS
.IX Subsection "TIPS"
.IP "Upstream remote" 4
.IX Item "Upstream remote"
The remote for upstream's git repository should be called 'upstream'.
You can use:
.RS 4
.Sp
.RS 4
% git clone \-o upstream https://foo/bar
.RE
.RE
.RS 4
.RE
.SH AUTHOR
.IX Header "AUTHOR"
Originally written by Sean Whitton <spwhitton@spwhitton.name>,
currently maintained by Lev Lamberov <dogsleg@debian.org> and Debian
Emacsen team <debian\-emacsen@lists.debian.org>.
.PP
A great deal of the library code used by \fBdh-make-elpa\fR, and its
object-oriented structure, comes from \fBdh\-make\-perl\fR\|(1), written and
maintained by the Debian Perl Group.