.\" Automatically generated by Pod::Man 2.27 (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 "DEBCOMMIT 1"
.TH DEBCOMMIT 1 "2014-01-26" "Debian Utilities" " "
.\" 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"
debcommit \- commit changes to a package
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdebcommit\fR [\fIoptions\fR] [\fB\-\-all\fR | \fIfiles to commit\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdebcommit\fR generates a commit message based on new text in \fBdebian/changelog\fR,
and commits the change to a package's repository. It must be run in a working
copy for the package. Supported version control systems are:
\&\fBcvs\fR, \fBgit\fR, \fBhg\fR (mercurial), \fBsvk\fR, \fBsvn\fR (Subversion),
\&\fBbaz\fR, \fBbzr\fR, \fBtla\fR (arch), \fBdarcs\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-c\fR, \fB\-\-changelog\fR \fIpath\fR" 4
.IX Item "-c, --changelog path"
Specify an alternate location for the changelog. By default debian/changelog is
used.
.IP "\fB\-r\fR, \fB\-\-release\fR" 4
.IX Item "-r, --release"
Commit a release of the package. The version number is determined from
debian/changelog, and is used to tag the package in the repository.
.Sp
Note that svn/svk tagging conventions vary, so debcommit uses
\&\fIsvnpath\fR\|(1) to determine where the tag should be placed in the
repository.
.IP "\fB\-R\fR, \fB\-\-release\-use\-changelog\fR" 4
.IX Item "-R, --release-use-changelog"
When used in conjunction with \fB\-\-release\fR, if there are uncommited
changes to the changelog then derive the commit message from those
changes rather than using the default message.
.IP "\fB\-m\fR \fItext\fR, \fB\-\-message\fR \fItext\fR" 4
.IX Item "-m text, --message text"
Specify a commit message to use. Useful if the program cannot determine
a commit message on its own based on debian/changelog, or if you want to
override the default message.
.IP "\fB\-n\fR, \fB\-\-noact\fR" 4
.IX Item "-n, --noact"
Do not actually do anything, but do print the commands that would be run.
.IP "\fB\-d\fR, \fB\-\-diff\fR" 4
.IX Item "-d, --diff"
Instead of committing, do print the diff of what would have been committed if
this option were not given. A typical usage scenario of this option is the
generation of patches against the current working copy (e.g. when you don't have
commit access right).
.IP "\fB\-C\fR, \fB\-\-confirm\fR" 4
.IX Item "-C, --confirm"
Display the generated commit message and ask for confirmation before committing
it. It is also possible to edit the message at this stage; in this case, the
confirmation prompt will be re-displayed after the editing has been performed.
.IP "\fB\-e\fR, \fB\-\-edit\fR" 4
.IX Item "-e, --edit"
Edit the generated commit message in your favorite editor before committing
it.
.IP "\fB\-a\fR, \fB\-\-all\fR" 4
.IX Item "-a, --all"
Commit all files. This is the default operation when using a \s-1VCS\s0 other
than git.
.IP "\fB\-s\fR, \fB\-\-strip\-message\fR, \fB\-\-no\-strip\-message\fR" 4
.IX Item "-s, --strip-message, --no-strip-message"
If this option is set and the commit message has been derived from the
changelog, the characters \*(L"* \*(R" will be stripped from the beginning of
the message.
.Sp
This option is set by default and ignored if more than one line of
the message begins with \*(L"[*+\-] \*(R".
.IP "\fB\-\-sign\-tags\fR, \fB\-\-no\-sign\-tags\fR" 4
.IX Item "--sign-tags, --no-sign-tags"
If this option is set, then tags that debcommit creates will be signed
using gnupg. Currently this is only supported by git.
.IP "\fB\-\-changelog\-info\fR" 4
.IX Item "--changelog-info"
If this option is set, the commit author and date will be determined from
the Maintainer and Date field of the first paragraph in \fIdebian/changelog\fR.
This is mainly useful when using \fBdebchange\fR(1) with the \fB\-\-no\-mainttrailer\fR
option.
.SH "CONFIGURATION VARIABLES"
.IX Header "CONFIGURATION VARIABLES"
The two configuration files \fI/etc/devscripts.conf\fR and
\&\fI~/.devscripts\fR are sourced by a shell in that order to set
configuration variables.  Command line options can be used to override
configuration file settings.  Environment variable settings are
ignored for this purpose.  The currently recognised variables are:
.IP "\fB\s-1DEBCOMMIT_STRIP_MESSAGE\s0\fR" 4
.IX Item "DEBCOMMIT_STRIP_MESSAGE"
If this is set to \fIno\fR, then it is the same as the \fB\-\-no\-strip\-message\fR
command line parameter being used. The default is \fIyes\fR.
.IP "\fB\s-1DEBCOMMIT_SIGN_TAGS\s0\fR" 4
.IX Item "DEBCOMMIT_SIGN_TAGS"
If this is set to \fIyes\fR, then it is the same as the \fB\-\-sign\-tags\fR command
line parameter being used. The default is \fIno\fR.
.IP "\fB\s-1DEBCOMMIT_RELEASE_USE_CHANGELOG\s0\fR" 4
.IX Item "DEBCOMMIT_RELEASE_USE_CHANGELOG"
If this is set to \fIyes\fR, then it is the same as the \fB\-\-release\-use\-changelog\fR
command line parameter being used. The default is \fIno\fR.
.IP "\fB\s-1DEBSIGN_KEYID\s0\fR" 4
.IX Item "DEBSIGN_KEYID"
This is the key id used for signing tags. If not set, a default will be
chosen by the revision control system.
.SH "VCS SPECIFIC FEATURES"
.IX Header "VCS SPECIFIC FEATURES"
.IP "\fBtla\fR / \fBbaz\fR" 4
.IX Item "tla / baz"
If the commit message contains more than 72 characters, a summary will
be created containing as many full words from the message as will fit within
72 characters, followed by an ellipsis.
.PP
Each of the features described below is applicable only if the commit message
has been automatically determined from the changelog.
.IP "\fBgit\fR" 4
.IX Item "git"
If only a single change is detected in the changelog, \fBdebcommit\fR will unfold
it to a single line and behave as if \fB\-\-strip\-message\fR was used.
.Sp
Otherwise, the first change will be unfolded and stripped to form a summary line
and a commit message formed using the summary line followed by a blank line and
the changes as extracted from the changelog. \fBdebcommit\fR will then spawn an
editor so that the message may be fine-tuned before committing.
.IP "\fBhg\fR / \fBdarcs\fR" 4
.IX Item "hg / darcs"
The first change detected in the changelog will be unfolded to form a single line
summary. If multiple changes were detected then an editor will be spawned to
allow the message to be fine-tuned.
.IP "\fBbzr\fR" 4
.IX Item "bzr"
If the changelog entry used for the commit message closes any bugs then \fB\-\-fixes\fR
options to \*(L"bzr commit\*(R" will be generated to associate the revision and the bugs.
.SH "LICENSE"
.IX Header "LICENSE"
This code is copyright by Joey Hess <joeyh@debian.org>, all rights reserved.
This program comes with \s-1ABSOLUTELY NO WARRANTY.\s0
You are free to redistribute this code under the terms of the
\&\s-1GNU\s0 General Public License, version 2 or later.
.SH "AUTHOR"
.IX Header "AUTHOR"
Joey Hess <joeyh@debian.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebchange\fR(1), \fBsvnpath\fR(1)
