bundledoc - Man Page

bundledoc [--version] [--help] [--[no]verbose] [--texfile=file.tex] [--directory=directory] [--[no]localonly] [--exclude=string] [--include=filespec] [--manifest=file] [--listdeps=[yes|no|only|rel]...] [--[no]keepdirs] [--config=file.cfg] file.dep

bundledoc is a post-processor for the snapshot package that bundles together all the classes, packages, and files needed to build a given LaTeX document.  It reads the .dep file that snapshot produces, finds each of the files mentioned therein, and packages them into a single archive file (e.g., a .tar.gz file), suitable for moving across systems, transmitting to a colleague, etc.

As the simplest example possible, consider a LaTeX file called, say, hello.tex:

    \RequirePackage{snapshot}       % Needed by bundledoc
    \documentclass[11pt]{article}

    \begin{document}
    Hello, world!
    \end{document}

The \RequirePackage{snapshot} causes a hello.dep file to be produced. When bundledoc is then given hello.dep as an argument, it locates the dependent files — snapshot.sty, article.cls, and size11.clo — and bundles them into a single archive file, along with hello.tex and a MANIFEST file (described in “Options”, below).

In the following descriptions, somefile refers to the name of your main LaTeX document (no extension).

bundledoc requires the name of the dependency file produced by snapshot, normally somefile.dep).  (For convenience, the file can be specified without its .dep extension.)  The following options may also be given:

--version

Output the bundledoc script's version number.  This overrides all of the remaining options.

--help

Give a brief usage message.  This overrides all of the remaining options.

--[no]verbose                    (default: noverbose)

bundledoc normally does not output anything except error messages. With --verbose, it outputs copious status messages.

--texfile=main .tex file            (default: somefile.tex)

snapshot's dependency file does not list the main LaTeX file (the one that gets passed to latex).  In order for bundledoc to find and bundle that file, bundledoc assumes it has the same name as the snapshot dependency file but with a .tex extension.  If this is not the case, then use --texfile to specify the correct filename.

--directory=archive directory       (default: somefile)

When bundledoc creates an archive (e.g., a .tar or .zip file) containing the document's files, it puts all of them in a directory to avoid cluttering the current directory with files.  If the given dependency file is called somefile.dep then the resulting archive will, by default, store all the dependent files in a somefile directory.  To change the directory name use the --directory option.

--[no]localonly                  (default: nolocalonly)

Although bundledoc normally archives all of the files named in the .dep file, the --localonly option tells bundledoc to exclude all files located in a directory other than the .tex file's directory or one of its subdirectories.

--exclude=string                    (default: none)

While --localonly causes files outside of the .tex file's directory tree to be omitted from the archive, --exclude provides finer-grained control over files to omit from the archive.  The --exclude option, which can be specified repeatedly on the command line, causes all files whose name contains string to be omitted from the archive.

--include=filespec                  (default: none)

The --include option, which can be specified repeatedly on the command line, instructs bundledoc to include in the archive all of the files matching filespec, even if they're not referenced in the .dep file.

--manifest=manifest file            (default: MANIFEST)

In addition to the dependent files, bundledoc includes in the archive file one extra file called, by default, “MANIFEST”. MANIFEST is a text file that lists the original filenames of all the dependencies.  To change the filename from “MANIFEST” to something else, use the --manifest option.  As a special case, --manifest="" tells bundledoc not to include a manifest file at all.

--listdeps=[yes|no|only|rel]...]       (default: no)

--listdeps accepts one or more of yes, no, only, or rel as a comma-separated list.  As long as no does not appear in this list, bundledoc outputs all of the main LaTeX file's dependencies. If the list contains rel, then bundledoc outputs the list of dependencies with relative pathnames.  If the list contains only, then bundledoc exits after displaying the list, without producing an archive.

--[no]keepdirs                   (default: nokeepdirs)

Normally, the archive file that bundledoc produces contains a single directory — and subdirectories, if the document refers explicitly to them — in which all the dependent files lie.  If --keepdirs is specified, all the dependent files are stored with their original pathnames.  For example, if somefile.tex depends on figures/somefigure.eps, article.cls, and snapshot.sty, then the somefile archive will normally contain the following files:

• somefile/somefile.tex
• somefile/figures/somefigure.eps
• somefile/article.cls
• somefile/snapshot.sty
• somefile/MANIFEST

However, --keepdirs will cause the somefile archive to contain the following sorts of filenames instead:

• home/me/mydocs/somefile.tex
• home/me/mydocs/figures/somefigure.eps
• usr/share/texmf/tex/latex/base/article.cls
• usr/share/texmf/tex/latex/snapshot/snapshot.sty

--directory is not used when --keepdirs is in effect.  In addition, no manifest file is written to the archive file as it contains redundant information.

--config=configuration file         (default: <none>)

The --config option is used to point bundledoc to the appropriate configuration (.cfg) file for your TeX distribution and operating system.  bundledoc comes with a few configuration files and it's easy to write more.  See “Configuration Files” (below) for a description of the configuration file format.  For convenience, the file can be specified without its .cfg extension.

Assume that myfile.dep was produced from myfile.tex by following the instructions in the Description section.  The following command produces a .zip file with the MikTeX TeX distribution running on Microsoft Windows:

    bundledoc --config=miktex.cfg myfile.dep

This can be abbreviated to

    bundledoc --config=miktex myfile

The following builds a .tar.gz archive with the TeX Live distribution running on a Unix-like operating system.  bundledoc will produce verbose output describing its operations.  All files not in the same directory tree as myfile.tex and all files containing “.fd” or “.sty” in their names are omitted.  However, all .bib files in the current directory will be included in the archive even though none of them are referenced by myfile.dep.  Finally, no MANIFEST file will be produced.

    bundledoc --config=texlive-unix.cfg --verbose --localonly \
      --exclude=.fd --exclude=.cfg --include="*.bib" --manifest="" \
      myfile.dep

The user must have previously installed snapshot.sty and used it to produce a dependency file for his document.  Besides that, the set of external files needed by bundledoc is system-specific and depends on the configuration file used.  (See “Configuration Files”, above.)

bundledoc currently comes with two configuration files:

texlive-unix.cfg

Configuration file for TeX Live installations on Unix or Linux.  TeX Live is a kpathsea-based TeX distribution that runs on various flavors of Unix and Microsoft Windows.  texlive-unix.cfg assumes you have gzip and uses it to produce a .tar.gz archive file.  The configuration file has bundledoc use kpsewhich to find LaTeX files.

miktex.cfg

Configuration file for MikTeX installations.  MikTeX is a popular TeX distribution for Microsoft Windows.  miktex.cfg assumes you have zip and uses it to produce a .zip archive file.  The configuration file now has bundledoc use kpsewhich to find LaTeX files; older version of MikTeX required the rather nonstandard initexmf for this purpose.

texlive-unix-arlatex.cfg

This is a variant of texlive-unix.cfg that uses arlatex instead of gzip to archive files.  arlatex is a script included in the bundledoc distribution that generates a self-extracting .tex file based on LaTeX's filecontents environment.

arlatex(1), gzip(1), kpsewhich(1), latex(1), perl(1), zip(1), the snapshot documentation

Scott Pakin, scott+bdoc@pakin.org

arlatex(1).