.\" 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 "ORIGTARGZ 1"
.TH 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"
origtargz \- fetch the orig tarball of a Debian package from various sources, and unpack it
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.IP "\fBorigtargz\fR [\fI\s-1OPTIONS\s0\fR] [\fB\-\-unpack\fR[=\fBno\fR|\fBonce\fR|\fByes\fR]]" 4
.IX Item "origtargz [OPTIONS] [--unpack[=no|once|yes]]"
.PD 0
.IP "\fBorigtargz\fR \fB\-\-help\fR" 4
.IX Item "origtargz --help"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBorigtargz\fR downloads the orig tarball of a Debian package, and also unpacks
it into the current directory, if it just contains a \fIdebian\fR directory. The
main use for \fBorigtargz\fR is with debian-dir-only repository checkouts, but it
is useful as a general tarball download wrapper. The version number for the
tarball to be downloaded is determined from \fIdebian/changelog\fR. It should be
invoked from the top level directory of an unpacked Debian source package.
.PP
Various download locations are tried:
.IP "\(bu" 4
First, an existing file is looked for.
.IP "\(bu" 4
Directories given with \fB\-\-path\fR are searched.
.IP "\(bu" 4
\&\fBpristine-tar\fR is tried.
.IP "\(bu" 4
\&\fBpristine-lfs\fR is tried.
.IP "\(bu" 4
\&\fBapt-get source\fR is tried when \fBapt-cache showsrc\fR reports a matching version.
.IP "\(bu" 4
Finally, \fBuscan \-\-download \-\-download\-current\-version\fR is tried.
.PP
When asked to unpack the orig tarball, \fBorigtargz\fR will remove all files and
directories from the current directory, except the debian directory, and the
\&\s-1VCS\s0 repository directories. \fINote that this will drop all non-committed changes\fR
for the patch system in use (e.g. source format \*(L"3.0 (quilt)\*(R"), and will even
remove all patches from the package when no patch system is in use (the
original \*(L"1.0\*(R" source format). Some \s-1VCS\s0 control files outside \fIdebian/\fR
preserved (\fI.bzr\-builddeb\fR, \fI.bzr\-ignore\fR, \fI.gitignore\fR, \fI.hgignore\fR), if
stored in \s-1VCS.\s0
.PP
The default behavior is to unpack the orig tarball if the current directory
is empty except for a \fIdebian\fR directory and the \s-1VCS\s0 files mentioned above.
.SH "NOTES"
.IX Header "NOTES"
Despite \fBorigtargz\fR being called \*(L"targz\*(R", it will work with any compression
scheme used for the tarball.
.PP
A similar tool to unpack orig tarballs is \fBuupdate\fR(1). \fBuupdate\fR creates a
new working directory, unpacks the tarball, and applies the Debian \fI.diff.gz\fR
changes. In contrast, \fBorigtargz\fR uses the current directory, keeping \s-1VCS\s0
metadata.
.PP
For Debian package repositories that keep the full upstream source, other tools
should be used to upgrade the repository from the new tarball. See
\&\fBgbp-import-orig\fR(1) and \fBsvn-upgrade\fR(1) for examples. \fBorigtargz\fR is still
useful for downloading the current tarball.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-p\fR, \fB\-\-path\fR \fIdirectory\fR" 4
.IX Item "-p, --path directory"
Add \fIdirectory\fR to the list of locations to search for an existing tarball.
When found, a hardlink is created if possible, otherwise a symlink.
.IP "\fB\-u\fR, \fB\-\-unpack\fR[=\fBno\fR|\fBonce\fR|\fByes\fR]" 4
.IX Item "-u, --unpack[=no|once|yes]"
Unpack the downloaded orig tarball to the current directory, replacing
everything except the debian directory. Existing files are removed, except for
\&\fIdebian/\fR and \s-1VCS\s0 files. Preserved are: \fI.bzr\fR, \fI.bzrignore\fR,
\&\fI.bzr\-builddeb\fR, \fI.git\fR, \fI.gitignore\fR, \fI.hg\fR, \fI.hgignore\fR, \fI_darcs\fR and
\&\fI.svn\fR.
.RS 4
.IP "\fBno\fR" 4
.IX Item "no"
Do not unpack the orig tarball.
.IP "\fBonce\fR (default when \fB\-\-unpack\fR is not used)" 4
.IX Item "once (default when --unpack is not used)"
If the current directory contains only a \fIdebian\fR directory (and possibly some
dotfiles), unpack the orig tarball. This is the default behavior.
.IP "\fByes\fR (default for \fB\-\-unpack\fR without argument)" 4
.IX Item "yes (default for --unpack without argument)"
Always unpack the orig tarball.
.RE
.RS 4
.RE
.IP "\fB\-d\fR, \fB\-\-download\-only\fR" 4
.IX Item "-d, --download-only"
Alias for \fB\-\-unpack=no\fR.
.IP "\fB\-t\fR, \fB\-\-tar\-only\fR" 4
.IX Item "-t, --tar-only"
When using \fBapt-get source\fR, pass \fB\-\-tar\-only\fR to it. The default is to
download the full source package including \fI.dsc\fR and \fI.diff.gz\fR or
\&\fI.debian.tar.gz\fR components so \fBdebdiff\fR can be used to diff the last upload
to the next one. With \fB\-\-tar\-only\fR, only download the \fI.orig.tar.*\fR file.
.IP "\fB\-\-clean\fR" 4
.IX Item "--clean"
Remove existing files as with \fB\-\-unpack\fR. Note that like \fB\-\-unpack\fR, this
will remove upstream files even if they are stored in \s-1VCS.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebcheckout\fR(1), \fBgbp-import-orig\fR(1), \fBpristine-tar\fR(1), \fBsvn-upgrade\fR(1), \fBuupdate\fR(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\fBorigtargz\fR and this manpage have been written by Christoph Berg
<\fImyon@debian.org\fR>.