.\" -*- 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 "MAKE-PAPER-TARBALL 1"
.TH MAKE-PAPER-TARBALL 1 2026-08-22 "Version 1.1" "General Commands Manual"
.\" 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
make\-paper\-tarball \- Make a submission\-ready tarball of an academic paper manuscript.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBmake-paper-tarball\fR \fB\-\-help\fR|\fB\-h\fR
.PP
\&\fBmake-paper-tarball\fR \fB\-\-version\fR|\fB\-v\fR
.PP
\&\fBmake-paper-tarball\fR [ \fB\-\-zip\fR|\fB\-z\fR ] [ \fB\-\-nodir\fR|\fB\-D\fR ] [ \fB\-\-base\fR|\fB\-b\fR \fItarball-base-name\fR ] \fImain-LaTeX-file-name\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBmake-paper-tarball\fR prepares an academic paper manuscript, whose main LaTeX file is \fImain-LaTeX-file-name\fR (with or without the \fI.tex\fR extension), for submission. It performs the following tasks:
.IP \(bu 4
Check that the manuscript can be compiled.
.IP \(bu 4
Identify source files (e.g. figures, bibliography) and copy then to a temporary directory.
.IP \(bu 4
Rename graphic files after the number of the figure/table that includes then, e.g. \fIfigure\-1.png\fR.
.Sp
Multiple graphic files per figure/table are named e.g. \fIfigure\-1\-plot\-1.png\fR, \fIfigure\-1\-plot\-2.png\fR etc.
.IP \(bu 4
Check that figures and tables are cited in order.
.IP \(bu 4
Insert LaTeX files included by \fI\einput\fR directly into the main LaTeX file.
.IP \(bu 4
Insert code listings included by \fI\elstinputlisting\fR directly into the main LaTeX file.
.IP \(bu 4
Insert BibTex-generated bibliography directly into the main LaTeX file.
.IP \(bu 4
Strip out comments.
.Sp
Lines between comment lines
.Sp
.Vb 1
\&    % protect comments ...
.Ve
.Sp
and
.Sp
.Vb 1
\&    % end protect comments ...
.Ve
.Sp
are not stripped for comments.
.IP \(bu 4
Copy auxiliary files to the tarball. Use a comment line of the form:
.Sp
.Vb 1
\&    % add\-to\-tarball <src\-file> <dest\-file\-within\-tarball>
.Ve
.IP \(bu 4
Create an archive containing only the the main LaTeX file, required source files, and specified auxiliary files.
.Sp
The archive is copied to the current directory.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-zip\fR|\fB\-z\fR 4
.IX Item "--zip|-z"
Create a \fI.zip\fR archive instead of a \fI.tar.gz\fR archive (the default).
.IP \fB\-\-nodir\fR|\fB\-D\fR 4
.IX Item "--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.
.IP "\fB\-\-base\fR|\fB\-b\fR \fItarball-base-name\fR" 4
.IX Item "--base|-b tarball-base-name"
Use \fItarball-base-name\fR as the base name for the archive, instead of \fImain-LaTeX-file-name\fR without the \fI.tex\fR extension (the default).
.SH AUTHOR
.IX Header "AUTHOR"
Karl Wette
.PP
Project homepage: https://github.com/kwwette/make\-paper\-tarball