.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "MK-ORIGTARGZ 1"
.TH MK-ORIGTARGZ 1 "2021-07-18" "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"
mk\-origtargz \- rename upstream tarball, optionally changing the compression and removing unwanted files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.IP "\fBmk-origtargz\fR [\fIoptions\fR] \fIfoo\-1.0.tar.gz\fR" 4
.IX Item "mk-origtargz [options] foo-1.0.tar.gz"
.PD 0
.IP "\fBmk-origtargz\fR \fB\-\-help\fR" 4
.IX Item "mk-origtargz --help"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBmk-origtargz\fR renames the given file to match what is expected by
\&\fBdpkg-buildpackage\fR, based on the source package name and version in
\&\fIdebian/changelog\fR. It can convert \fBzip\fR to \fBtar\fR, optionally change the
compression scheme and remove files according to \fBFiles-Excluded\fR and
\&\fBFiles\-Excluded\-\fR\fIcomponent\fR in \fIdebian/copyright\fR. The resulting file is
placed in \fIdebian/../..\fR. (In \fIdebian/copyright\fR, the \fBFiles-Excluded\fR and
\&\fBFiles\-Excluded\-\fR\fIcomponent\fR stanzas are a part of the first paragraph and
there is a blank line before the following paragraphs which contain \fBFiles\fR
and other stanzas. The \fBFiles-Included\fR stanza may be used to ignore
parts of subdirectories specified by the \fBFiles-Excluded\fR stanza See
\&\fBuscan\fR(1) \*(L"\s-1COPYRIGHT FILE EXAMPLE\*(R".\s0)
.PP
The archive type for \fBzip\fR is detected by "\fBfile \-\-dereference \-\-brief
\&\-\-mime\-type\fR" command.  So any \fBzip\fR type archives such as \fBjar\fR are treated
in the same way.  The \fBxpi\fR archive is detected by its extension and is
handled properly using the \fBxpi-unpack\fR command.
.PP
If the package name is given via the \fB\-\-package\fR option, no information is
read from \fIdebian/\fR, and the result file is placed in the current directory.
.PP
\&\fBmk-origtargz\fR is commonly called via \fBuscan\fR, which first obtains the
upstream tarball.
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "Metadata options"
.IX Subsection "Metadata options"
The following options extend or replace information taken from \fIdebian/\fR.
.IP "\fB\-\-package\fR \fIpackage\fR" 4
.IX Item "--package package"
Use \fIpackage\fR as the name of the Debian source package, and do not require or
use a \fIdebian/\fR directory. This option can only be used together with
\&\fB\-\-version\fR.
.Sp
The default is to use the package name of the first entry in \fIdebian/changelog\fR.
.IP "\fB\-v\fR, \fB\-\-version\fR \fIversion\fR" 4
.IX Item "-v, --version version"
Use \fIversion\fR as the version of the package. This needs to be the upstream
version portion of a full Debian version, i.e. no Debian revision, no epoch.
.Sp
The default is to use the upstream portion of the version of the first entry in
\&\fIdebian/changelog\fR.
.IP "\fB\-\-exclude\-file\fR \fIglob\fR" 4
.IX Item "--exclude-file glob"
Remove files matching the given \fIglob\fR from the tarball, as if it was listed in
\&\fBFiles-Excluded\fR.
.IP "\fB\-\-copyright\-file\fR \fIfilename\fR" 4
.IX Item "--copyright-file filename"
Remove files matching the patterns found in \fIfilename\fR, which should have the
format of a Debian \fIcopyright\fR file
(\fBFormat: https://www.debian.org/doc/packaging\-manuals/copyright\-format/1.0/\fR
to be precise). Errors parsing that file are silently ignored, exactly as is
the case with \fIdebian/copyright\fR.
.Sp
Unmatched patterns will emit a warning so the user can verify whether it is
correct.  If there are multiple patterns which match a file, only the last one
will count as being matched.
.Sp
Both the \fB\-\-exclude\-file\fR and \fB\-\-copyright\-file\fR options amend the list of
patterns found in \fIdebian/copyright\fR. If you do not want to read that file,
you will have to use \fB\-\-package\fR.
.IP "\fB\-\-signature\fR \fIsignature-mode\fR" 4
.IX Item "--signature signature-mode"
Set \fIsignature-mode\fR:
.RS 4
.IP "0 for no signature" 4
.IX Item "0 for no signature"
.PD 0
.IP "1 for normal detached signature" 4
.IX Item "1 for normal detached signature"
.IP "2 for signature on decompressed" 4
.IX Item "2 for signature on decompressed"
.IP "3 for self signature" 4
.IX Item "3 for self signature"
.RE
.RS 4
.RE
.IP "\fB\-\-signature\-file\fR \fIsignature-file\fR" 4
.IX Item "--signature-file signature-file"
.PD
Use \fIsignature-file\fR as the signature file corresponding to the Debian source
package to create a \fBdpkg-source\fR (post-stretch) compatible signature file.
(optional)
.SS "Action options"
.IX Subsection "Action options"
These options specify what exactly \fBmk-origtargz\fR should do. The options
\&\fB\-\-copy\fR, \fB\-\-rename\fR and \fB\-\-symlink\fR are mutually exclusive.
.IP "\fB\-\-symlink\fR" 4
.IX Item "--symlink"
Make the resulting file a symlink to the given original file. (This is the
default behaviour.)
.Sp
If the file has to be modified (because it is a \fBzip\fR, or \fBxpi\fR file, because
of \fB\-\-repack\fR or \fBFiles-Excluded\fR), this option behaves like \fB\-\-copy\fR.
.IP "\fB\-\-copy\fR" 4
.IX Item "--copy"
Make the resulting file a copy of the original file (unless it has to be
modified, of course).
.IP "\fB\-\-rename\fR" 4
.IX Item "--rename"
Rename the original file.
.Sp
If the file has to be modified (because it is a \fBzip\fR, or \fBxpi\fR file, because
of \fB\-\-repack\fR or \fBFiles-Excluded\fR), this implies that the original file is
deleted afterwards.
.IP "\fB\-\-repack\fR" 4
.IX Item "--repack"
If the given file is not compressed using the desired format (see
\&\fB\-\-compression\fR), recompress it.
.IP "\fB\-S\fR, \fB\-\-repack\-suffix\fR \fIsuffix\fR" 4
.IX Item "-S, --repack-suffix suffix"
If the file has to be modified, because of \fBFiles-Excluded\fR, append \fIsuffix\fR
to the upstream version.
.IP "\fB\-\-force\-repack\fR" 4
.IX Item "--force-repack"
Recompress even if file is compressed using the desired format and no files
were deleted.
.IP "\fB\-c\fR, \fB\-\-component\fR \fIcomponentname\fR" 4
.IX Item "-c, --component componentname"
Use <componentname> as the component name for the secondary upstream tarball.
Set \fIcomponentname\fR as the component name.  This is used only for the
secondary upstream tarball of the Debian source package.
Then \fIpackagename_version.orig\-componentname.tar.gz\fR is created.
.IP "\fB\-\-compression\fR [ \fBgzip\fR | \fBbzip2\fR | \fBlzma\fR | \fBxz\fR | \fBdefault\fR ]" 4
.IX Item "--compression [ gzip | bzip2 | lzma | xz | default ]"
The default method is \fBxz\fR. When mk-origtargz is launched in a debian source
repository which format is \*(L"1.0\*(R" or undefined, the method switches to \fBgzip\fR.
.IP "\fB\-C\fR, \fB\-\-directory\fR \fIdirectory\fR" 4
.IX Item "-C, --directory directory"
Put the resulting file in the given directory.
.IP "\fB\-\-unzipopt\fR \fIoptions\fR" 4
.IX Item "--unzipopt options"
Add the extra options to use with the \fBunzip\fR command such as \fB\-a\fR, \fB\-aa\fR,
and \fB\-b\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBuscan\fR(1), \fBuupdate\fR(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\fBmk-origtargz\fR and this manpage have been written by Joachim Breitner
<\fInomeata@debian.org\fR>.