MK-ORIGTARGZ

Section: (1)
Updated: 2016-07-25
Index Return to Main Contents

NAME

mk-origtargz - rename upstream tarball, optionally changing the compression and removing unwanted files

SYNOPSIS

mk-origtargz [options] foo-1.0.tar.gz
mk-origtargz --help

DESCRIPTION

mk-origtargz renames the given file to match what is expected by dpkg-buildpackage, based on the source package name and version in debian/changelog. It can convert zip to tar, optionally change the compression scheme and remove files according to Files-Excluded in debian/copyright. The resulting file is placed in debian/../...

If the package name is given via the --package option, no information is read from debian/, and the result file is placed in the current directory.

mk-origtargz is commonly called via uscan, which first obtains the upstream tarball.

OPTIONS

Metadata options

The following options extend or replace information taken from debian/.

--package package: Use package as the name of the Debian source package, and do not require or use a debian/ directory. This option can only be used together with --version.
The default is to use the package name of the first entry in debian/changelog.
-v, --version version: Use version 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.
The default is to use the upstream portion of the version of the first entry in debian/changelog.
--exclude-file glob: Remove files matching the given glob from the tarball, as if it was listed in Files-Excluded.
--copyright-file filename: Remove files matching the patterns found in filename, which should have the format of a Debian copyright file (Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ to be precise). Errors parsing that file are silently ignored, exactly as it is the case with debian/copyright.
Both the --exclude-file and --copyright-file options amend the list of patterns found in debian/copyright. If you do not want to read that file, you will have to use --package.

Action options

These options specify what exactly mk-origtargz should do. The options --copy, --rename and --symlink are mutually exclusive.

--symlink: Make the resulting file a symlink to the given original file. (This is the default behaviour.)
If the file has to be modified (because it is a zip file, because of --repack or Files-Excluded), this option behaves like --copy.
--copy: Make the resulting file a copy of the original file (unless it has to be modified, of course).
--rename: Rename the original file.
If the file has to be modified (because it is a zip file, because of --repack or Files-Excluded), this implies that the original file is deleted afterwards.
--repack: If the given file is not compressed using the desired format (see --compression), recompress it.
-S, --repack-suffix suffix: If the file has to be modified, because of Files-Excluded, append suffix to the upstream version.
--compression [ gzip | bzip2 | lzma | xz ]: If --repack is used, or if the given file is a zip file, ensure that the resulting file is compressed using the given scheme. The default is gzip.
-C, --directory directory: Put the resulting file in the given directory.

AUTHOR

mk-origtargz and this manpage have been written by Joachim Breitner <nomeata@debian.org>.

SEE ALSO

AUTHOR