MAKE-PAPER-TARBALL(1)

NAME
make-paper-tarball - Make a submission-ready tarball of an academic paper manuscript.

SYNOPSIS
make-paper-tarball --help|-h

make-paper-tarball --version|-v

make-paper-tarball [ --zip|-z ] [ --nodir|-D ] [ --base|-b tarball-base-name ] main-LaTeX-file-name

DESCRIPTION
make-paper-tarball prepares an academic paper manuscript, whose main LaTeX file is main-LaTeX-file-name (with or without the .tex extension), for submission. It performs the following tasks:

•   Check that the manuscript can be compiled.

•   Identify source files (e.g. figures, bibliography) and copy then to a temporary directory.

•   Rename graphic files after the number of the figure/table that includes then, e.g. figure-1.png.

    Multiple graphic files per figure/table are named e.g. figure-1-plot-1.png, figure-1-plot-2.png etc.

•   Check that figures and tables are cited in order.

•   Insert LaTeX files included by \input directly into the main LaTeX file.

•   Insert code listings included by \lstinputlisting directly into the main LaTeX file.

•   Insert BibTex-generated bibliography directly into the main LaTeX file.

•   Strip out comments.

    Lines between comment lines

        % protect comments ...

    and

        % end protect comments ...

    are not stripped for comments.

•   Copy auxiliary files to the tarball. Use a comment line of the form:

        % add-to-tarball <src-file> <dest-file-within-tarball>

•   Create an archive containing only the the main LaTeX file, required source files, and specified auxiliary files.

    The archive is copied to the current directory.

OPTIONS

--zip|-z
    Create a .zip archive instead of a .tar.gz archive (the default).

--nodir|-D
    Do not put files into a subdirectory within the archive (the default); instead all files will be at the top level of the archive.

--base|-b tarball-base-name
    Use tarball-base-name as the base name for the archive, instead of main-LaTeX-file-name without the .tex extension (the default).

AUTHOR
Karl Wette

Project homepage: https://github.com/kwwette/make-paper-tarball