arlatex (1) Linux Manual Page

NAME

arlatex – archive a number of ancillary LaTeX files into a master .tex file

SYNOPSIS

arlatex [–outfile=filename.tex] –document=filename.tex filename …

arlatex –version

arlatex –help

DESCRIPTION

arlatex is an archiving program like shar, tar, zip, etc. Unlike those other archivers, however, arlatex is designed specifically for use with LaTeX. arlatex takes the name of a master .tex file and a number of ancillary files used by that master file (e.g., .tex, .sty, .cls, and .eps files). From these, arlatex outputs a single file that, when it’s run through latex, both regenerates the ancillary files and compiles the document into a .dvi file.

arlatex has a few advantages over other archiving programs:

•

The .tex files produced by arlatex are in a plain-text format. They are therefore perfectly portable and trivial to e-mail to colleagues.

•

arlatex needs only LaTeX to run. There is no dependence on any external tools.

•

There is no explicit extraction step. As the generated document is run through latex, it extracts the ancillary files and builds the document in the same step. The user running latex may not even notice that additional files are being produced.

arlatex works by writing a number of "egin{filecontents*}" … "nd{filecontents*}" blocks to the output file, followed by the contents of the master file. (In fact, any LaTeX comments at the beginning of the master file are hoisted to the top of the generated file. This enables the author to draw attention, if so desired, to the fact that ancillary files will be generated.) The "filecontents*" environment, part of standard LaTeX2e, writes its contents verbatim to a specified file.

OPTIONS

–version

Output the arlatex script’s version number.

–help

Output brief arlatex usage information.

–document=.tex file

Specify the master document. The output from arlatex is this file with all of the other files named on the command line prepended to it. Note that "--document" is a mandatory parameter; arlatex will abort with an error message if "--document" is not specified.

–outfile=.tex file

Specify the output file. The output file looks just like the master document, but with a number of "filecontents*" environments preceding the "\documentclass" line. If "--outfile" is not specified, output will be written to the standard output device.

EXAMPLES

Suppose you have a paper called paper.tex that loads a custom package with "