.\" -*- 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 "patchedit 1"
.TH patchedit 1 2024-03-04 "pkg-perl-tools 0.78" "Debian Perl packaging Tools"
.\" 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
patchedit \- Edit headers of a patch according to DEP3
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpatchedit\fR [\fIcommand\fR] \fIpatchfile\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpatchedit\fR is a helper script for managing patch headers according to
<http://dep.debian.net/deps/dep3/>.
.SH COMMANDS
.IX Header "COMMANDS"
.IP "\fIedit\fR (default)" 4
.IX Item "edit (default)"
Opens \fIpatchfile\fR in EDITOR (or VISUAL or sensible-editor) and
.RS 4
.IP \(bu 4
checks all headers
.IP \(bu 4
marks problems
.IP \(bu 4
adds missing required headers with proposals for their values
.RE
.RS 4
.Sp
If no command is given, \fIedit\fR is chosen automatically.
.RE
.IP \fIcheck\fR 4
.IX Item "check"
Does a non-interactive check if the headers conform to DEP3. Prints the
results (missing required headers, wrong values, ...) to stdout.
.SH ARGUMENTS
.IX Header "ARGUMENTS"
.IP "\fIpatchfile\fR (required)" 4
.IX Item "patchfile (required)"
The patch to work on.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-f|\-\-fix\fR 4
.IX Item "-f|--fix"
Tries to fix problems in the headers when editing/checking patches.
.IP \fB\-o|\-\-optional\fR 4
.IX Item "-o|--optional"
Also add/print missing optional headers.
.IP \fB\-h|\-\-help\fR 4
.IX Item "-h|--help"
Help output.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
\&\fBpatchedit\fR respects DEBEMAIL (or EMAIL) and DEBFULLNAME (for new Author or
Reviewed-by headers).
.SH NOTE
.IX Header "NOTE"
This script is not pkg-perl specific. It should go into \fIdevscripts\fR
eventually.
.SH TODO
.IX Header "TODO"
.Vb 2
\& * preserve the extra fields
\& * preserve the order of the fields
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010, Jozef Kutej <jkutej@cpan.org>.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.