| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "BUNDLEDOC 1" |
| 58 |
.TH BUNDLEDOC 1 2026-05-16 v3.6 "User Commands" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
bundledoc \- bundle all the files needed by a LaTeX document |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
bundledoc |
| 68 |
[\fB\-\-version\fR] |
| 69 |
[\fB\-\-help\fR] |
| 70 |
[\fB\-\-\fR[\fBno\fR]\fBverbose\fR] |
| 71 |
[\fB\-\-texfile\fR=\fIfile.tex\fR] |
| 72 |
[\fB\-\-directory\fR=\fIdirectory\fR] |
| 73 |
[\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR] |
| 74 |
[\fB\-\-exclude\fR=\fIstring\fR] |
| 75 |
[\fB\-\-include\fR=\fIfilespec\fR] |
| 76 |
[\fB\-\-manifest\fR=\fIfile\fR] |
| 77 |
[\fB\-\-\fR\fBlistdeps\fR=[yes|no|only|rel]...] |
| 78 |
[\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR] |
| 79 |
[\fB\-\-config\fR=\fIfile.cfg\fR] |
| 80 |
\&\fIfile.dep\fR |
| 81 |
.SH DESCRIPTION |
| 82 |
.IX Header "DESCRIPTION" |
| 83 |
\&\fBbundledoc\fR is a post-processor for the \fBsnapshot\fR package that |
| 84 |
bundles together all the classes, packages, and files needed to build |
| 85 |
a given LaTeX document. It reads the \fI.dep\fR file that \fBsnapshot\fR |
| 86 |
produces, finds each of the files mentioned therein, and packages them |
| 87 |
into a single archive file (e.g., a \fI.tar.gz\fR file), suitable for |
| 88 |
moving across systems, transmitting to a colleague, etc. |
| 89 |
.PP |
| 90 |
As the simplest example possible, consider a LaTeX file called, say, |
| 91 |
\&\fIhello.tex\fR: |
| 92 |
.PP |
| 93 |
.Vb 2 |
| 94 |
\& \eRequirePackage{snapshot} % Needed by bundledoc |
| 95 |
\& \edocumentclass[11pt]{article} |
| 96 |
\& |
| 97 |
\& \ebegin{document} |
| 98 |
\& Hello, world! |
| 99 |
\& \eend{document} |
| 100 |
.Ve |
| 101 |
.PP |
| 102 |
The \f(CW\*(C`\eRequirePackage{snapshot}\*(C'\fR causes a \fIhello.dep\fR file to be produced. |
| 103 |
When \fBbundledoc\fR is then given \f(CW\*(C`hello.dep\*(C'\fR as an argument, it locates the |
| 104 |
dependent files \-\- \fIsnapshot.sty\fR, \fIarticle.cls\fR, and \fIsize11.clo\fR \-\- |
| 105 |
and bundles them into a single archive file, along with \fIhello.tex\fR and a |
| 106 |
\&\fIMANIFEST\fR file (described in "OPTIONS", below). |
| 107 |
.SH OPTIONS |
| 108 |
.IX Header "OPTIONS" |
| 109 |
In the following descriptions, \fIsomefile\fR refers to the name of your |
| 110 |
main LaTeX document (no extension). |
| 111 |
.PP |
| 112 |
\&\fBbundledoc\fR requires the name of the dependency file produced by |
| 113 |
\&\fBsnapshot\fR, normally \fIsomefile\fR\fI.dep\fR). (For convenience, the file |
| 114 |
can be specified without its \fI.dep\fR extension.) The following |
| 115 |
options may also be given: |
| 116 |
.IP \fB\-\-version\fR 4 |
| 117 |
.IX Item "--version" |
| 118 |
Output the \fBbundledoc\fR script's version number. This overrides all |
| 119 |
of the remaining options. |
| 120 |
.IP \fB\-\-help\fR 4 |
| 121 |
.IX Item "--help" |
| 122 |
Give a brief usage message. This overrides all of the remaining options. |
| 123 |
.IP \fB\-\-verbose\fR 4 |
| 124 |
.IX Item "--verbose" |
| 125 |
\&\fBbundledoc\fR normally does not output anything except error messages. |
| 126 |
With \f(CW\*(C`\-\-verbose\*(C'\fR, it outputs copious status messages. Additional |
| 127 |
uses of \f(CW\*(C`\-\-verbose\*(C'\fR increase the verbosity. |
| 128 |
.IP "\fB\-\-texfile\fR=\fImain .tex file\fR (default: \fIsomefile\fR\fI.tex\fR)" 4 |
| 129 |
.IX Item "--texfile=main .tex file (default: somefile.tex)" |
| 130 |
\&\fBsnapshot\fR's dependency file does not list the main LaTeX file (the |
| 131 |
one that gets passed to \fBlatex\fR). In order for \fBbundledoc\fR to find |
| 132 |
and bundle that file, \fBbundledoc\fR assumes it has the same name as the |
| 133 |
\&\fBsnapshot\fR dependency file but with a \fI.tex\fR extension. If this is |
| 134 |
not the case, then use \f(CW\*(C`\-\-texfile\*(C'\fR to specify the correct filename. |
| 135 |
.IP "\fB\-\-directory\fR=\fIarchive directory\fR (default: \fIsomefile\fR)" 4 |
| 136 |
.IX Item "--directory=archive directory (default: somefile)" |
| 137 |
When \fBbundledoc\fR creates an archive (e.g., a \fI.tar\fR or \fI.zip\fR file) |
| 138 |
containing the document's files, it puts all of them in a directory to |
| 139 |
avoid cluttering the current directory with files. If the given |
| 140 |
dependency file is called \fIsomefile\fR\fI.dep\fR then the resulting |
| 141 |
archive will, by default, store all the dependent files in a |
| 142 |
\&\fIsomefile\fR directory. To change the directory name use the |
| 143 |
\&\f(CW\*(C`\-\-directory\*(C'\fR option. |
| 144 |
.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR (default: ""nolocalonly"")" 4 |
| 145 |
.el .IP "\fB\-\-\fR[\fBno\fR]\fBlocalonly\fR (default: \f(CWnolocalonly\fR)" 4 |
| 146 |
.IX Item "--[no]localonly (default: nolocalonly)" |
| 147 |
Although \fBbundledoc\fR normally archives all of the files named in the |
| 148 |
\&\fI.dep\fR file, the \f(CW\*(C`\-\-localonly\*(C'\fR option tells \fBbundledoc\fR to exclude |
| 149 |
all files located in a directory other than the \fI.tex\fR file's |
| 150 |
directory or one of its subdirectories. |
| 151 |
.IP "\fB\-\-exclude\fR=\fIstring\fR (default: \fInone\fR)" 4 |
| 152 |
.IX Item "--exclude=string (default: none)" |
| 153 |
While \f(CW\*(C`\-\-localonly\*(C'\fR causes files outside of the \fI.tex\fR file's |
| 154 |
directory tree to be omitted from the archive, \f(CW\*(C`\-\-exclude\*(C'\fR provides |
| 155 |
finer-grained control over files to omit from the archive. The |
| 156 |
\&\f(CW\*(C`\-\-exclude\*(C'\fR option, which can be specified repeatedly on the command |
| 157 |
line, causes all files whose name contains \fIstring\fR to be omitted |
| 158 |
from the archive. |
| 159 |
.IP "\fB\-\-include\fR=\fIfilespec\fR (default: \fInone\fR)" 4 |
| 160 |
.IX Item "--include=filespec (default: none)" |
| 161 |
The \f(CW\*(C`\-\-include\*(C'\fR option, which can be specified repeatedly on the |
| 162 |
command line, instructs \fBbundledoc\fR to include in the archive all of |
| 163 |
the files matching \fIfilespec\fR, even if they're not referenced in the |
| 164 |
\&\fI.dep\fR file. |
| 165 |
.IP "\fB\-\-manifest\fR=\fImanifest file\fR (default: \fIMANIFEST\fR)" 4 |
| 166 |
.IX Item "--manifest=manifest file (default: MANIFEST)" |
| 167 |
In addition to the dependent files, \fBbundledoc\fR includes in the |
| 168 |
archive file one extra file called, by default, ``\fIMANIFEST\fR''. |
| 169 |
\&\fIMANIFEST\fR is a text file that lists the original filenames of all |
| 170 |
the dependencies. To change the filename from ``\fIMANIFEST\fR'' to |
| 171 |
something else, use the \f(CW\*(C`\-\-manifest\*(C'\fR option. As a special case, |
| 172 |
\&\f(CW\*(C`\-\-manifest=""\*(C'\fR tells \fBbundledoc\fR not to include a manifest file at |
| 173 |
all. |
| 174 |
.ie n .IP "\fB\-\-listdeps\fR=[yes|no|only|rel]...] (default: ""no"")" 4 |
| 175 |
.el .IP "\fB\-\-listdeps\fR=[yes|no|only|rel]...] (default: \f(CWno\fR)" 4 |
| 176 |
.IX Item "--listdeps=[yes|no|only|rel]...] (default: no)" |
| 177 |
\&\f(CW\*(C`\-\-listdeps\*(C'\fR accepts one or more of \f(CW\*(C`yes\*(C'\fR, \f(CW\*(C`no\*(C'\fR, \f(CW\*(C`only\*(C'\fR, or \f(CW\*(C`rel\*(C'\fR |
| 178 |
as a comma-separated list. As long as \f(CW\*(C`no\*(C'\fR does not appear in this |
| 179 |
list, \fBbundledoc\fR outputs all of the main LaTeX file's dependencies. |
| 180 |
If the list contains \f(CW\*(C`rel\*(C'\fR, then \fBbundledoc\fR outputs the list of |
| 181 |
dependencies with relative pathnames. If the list contains \f(CW\*(C`only\*(C'\fR, |
| 182 |
then \fBbundledoc\fR exits after displaying the list, without producing |
| 183 |
an archive. |
| 184 |
.ie n .IP "\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR (default: ""nokeepdirs"")" 4 |
| 185 |
.el .IP "\fB\-\-\fR[\fBno\fR]\fBkeepdirs\fR (default: \f(CWnokeepdirs\fR)" 4 |
| 186 |
.IX Item "--[no]keepdirs (default: nokeepdirs)" |
| 187 |
Normally, the archive file that \fBbundledoc\fR produces contains a |
| 188 |
single directory \-\- and subdirectories, if the document refers |
| 189 |
explicitly to them \-\- in which all the dependent files lie. If |
| 190 |
\&\f(CW\*(C`\-\-keepdirs\*(C'\fR is specified, all the dependent files are stored with |
| 191 |
their original pathnames. For example, if \fIsomefile.tex\fR depends on |
| 192 |
\&\fIfigures/somefigure.eps\fR, \fIarticle.cls\fR, and \fIsnapshot.sty\fR, then |
| 193 |
the \fIsomefile\fR archive will normally contain the following files: |
| 194 |
.RS 4 |
| 195 |
.IP \(bu 4 |
| 196 |
\&\fIsomefile/somefile.tex\fR |
| 197 |
.IP \(bu 4 |
| 198 |
\&\fIsomefile/figures/somefigure.eps\fR |
| 199 |
.IP \(bu 4 |
| 200 |
\&\fIsomefile/article.cls\fR |
| 201 |
.IP \(bu 4 |
| 202 |
\&\fIsomefile/snapshot.sty\fR |
| 203 |
.IP \(bu 4 |
| 204 |
\&\fIsomefile/MANIFEST\fR |
| 205 |
.RE |
| 206 |
.RS 4 |
| 207 |
.Sp |
| 208 |
However, \f(CW\*(C`\-\-keepdirs\*(C'\fR will cause the \fIsomefile\fR archive to contain |
| 209 |
the following sorts of filenames instead: |
| 210 |
.IP \(bu 4 |
| 211 |
\&\fIhome/me/mydocs/somefile.tex\fR |
| 212 |
.IP \(bu 4 |
| 213 |
\&\fIhome/me/mydocs/figures/somefigure.eps\fR |
| 214 |
.IP \(bu 4 |
| 215 |
\&\fIusr/share/texmf/tex/latex/base/article.cls\fR |
| 216 |
.IP \(bu 4 |
| 217 |
\&\fIusr/share/texmf/tex/latex/snapshot/snapshot.sty\fR |
| 218 |
.RE |
| 219 |
.RS 4 |
| 220 |
.Sp |
| 221 |
\&\f(CW\*(C`\-\-directory\*(C'\fR is not used when \f(CW\*(C`\-\-keepdirs\*(C'\fR is in effect. In |
| 222 |
addition, no manifest file is written to the archive file as it |
| 223 |
contains redundant information. |
| 224 |
.RE |
| 225 |
.IP "\fB\-\-config\fR=\fIconfiguration file\fR (default: <none>)" 4 |
| 226 |
.IX Item "--config=configuration file (default: <none>)" |
| 227 |
The \f(CW\*(C`\-\-config\*(C'\fR option is used to point \fBbundledoc\fR to the |
| 228 |
appropriate configuration (\fI.cfg\fR) file for your TeX distribution and |
| 229 |
operating system. \fBbundledoc\fR comes with a few configuration files |
| 230 |
and it's easy to write more. See "CONFIGURATION FILES" (below) for |
| 231 |
a description of the configuration file format. For convenience, the |
| 232 |
file can be specified without its \fI.cfg\fR extension. |
| 233 |
.SH "CONFIGURATION FILES" |
| 234 |
.IX Header "CONFIGURATION FILES" |
| 235 |
.SS Format |
| 236 |
.IX Subsection "Format" |
| 237 |
Configuration files follow a fairly simple format. Lines beginning with |
| 238 |
\&\f(CW\*(C`#\*(C'\fR are comments. Blank lines are ignored. All other lines are of the |
| 239 |
form: |
| 240 |
.PP |
| 241 |
.Vb 1 |
| 242 |
\& variable: value |
| 243 |
.Ve |
| 244 |
.PP |
| 245 |
The current version of \fBbundledoc\fR recognizes the following variables: |
| 246 |
.IP \fBbundle\fR 4 |
| 247 |
.IX Item "bundle" |
| 248 |
The command to use to bundle a set of files into a single archive file |
| 249 |
.IP \fBsink\fR 4 |
| 250 |
.IX Item "sink" |
| 251 |
The affix to a command to discard its output |
| 252 |
.IP \fBfind\fR 4 |
| 253 |
.IX Item "find" |
| 254 |
The command to find a file within the TeX tree(s). |
| 255 |
.PP |
| 256 |
Values that are too long for one line can be split across multiple lines |
| 257 |
by using \f(CW\*(C`\e\*(C'\fR as the line-continuation symbol. |
| 258 |
.PP |
| 259 |
There are two environment variables that \fBbundledoc\fR makes available |
| 260 |
for use by configuration-file commands: \f(CW\*(C`BDBASE\*(C'\fR, which is set to |
| 261 |
\&\fIsomefile\fR (as in "OPTIONS"), and \f(CW\*(C`BDINPUTS\*(C'\fR, which is set to a |
| 262 |
space-separated list of files that a command is to operate upon. That |
| 263 |
is, when the command associated with \f(CW\*(C`bundle\*(C'\fR is running, \f(CW\*(C`BDINPUTS\*(C'\fR |
| 264 |
contains the list of all the files that are to be archived. In |
| 265 |
contrast, when the command associated with \f(CW\*(C`find\*(C'\fR is running, |
| 266 |
\&\f(CW\*(C`BDINPUTS\*(C'\fR contains the name of the file to search for. |
| 267 |
.SS Examples |
| 268 |
.IX Subsection "Examples" |
| 269 |
The following configuration file parallels \fBbundledoc\fR's default |
| 270 |
values of the various configuration-file variables, which represents a |
| 271 |
kpathsea-based TeX distribution running on a generic Unix system, |
| 272 |
which doesn't necessarily have any of the GNU tools, such as \fBgzip\fR |
| 273 |
or GNU \fBtar\fR: |
| 274 |
.PP |
| 275 |
.Vb 2 |
| 276 |
\& # "Default" configuration file |
| 277 |
\& # By Scott Pakin <[email protected]> |
| 278 |
\& |
| 279 |
\& bundle: (tar \-cvf \- $BDINPUTS | compress > $BDBASE.tar.Z) |
| 280 |
\& sink: > /dev/null 2>&1 |
| 281 |
\& find: kpsewhich \-progname=latex $BDINPUTS |
| 282 |
.Ve |
| 283 |
.PP |
| 284 |
The parentheses in the \f(CW\*(C`bundle:\*(C'\fR line tell the Unix shell to run the |
| 285 |
command in a subshell. This is to make the \f(CW\*(C`sink:\*(C'\fR affix work |
| 286 |
properly (i.e., so there aren't two \f(CW\*(C`>\*(C'\fR's in the same command). |
| 287 |
.PP |
| 288 |
Notice how the commands treat \f(CW\*(C`BDBASE\*(C'\fR and \f(CW\*(C`BDINPUTS\*(C'\fR like any other |
| 289 |
environment variables in a Unix shell, using \f(CW\*(C`$\*(C'\fR to take their value. |
| 290 |
Other operating systems use different conventions for referring to |
| 291 |
environment variables. For instance, a configuration file for a |
| 292 |
Windows-based TeX distribution would use \f(CW\*(C`%BDBASE%\*(C'\fR and \f(CW\*(C`%BDINPUTS%\*(C'\fR |
| 293 |
instead. |
| 294 |
.PP |
| 295 |
The value for \f(CW\*(C`sink:\*(C'\fR is specific to an operating system. The value |
| 296 |
for \f(CW\*(C`find:\*(C'\fR is specific to a TeX distribution. \f(CW\*(C`bundle:\*(C'\fR is where |
| 297 |
the most opportunity for customization lies. You can use \f(CW\*(C`bundle:\*(C'\fR |
| 298 |
to specify your favorite archive format. For example, you can produce |
| 299 |
a shar file on Unix with something like: |
| 300 |
.PP |
| 301 |
.Vb 1 |
| 302 |
\& bundle: (shar \-\-archive\-name="$BDBASE" $BDINPUTS > $BDBASE.sh) |
| 303 |
.Ve |
| 304 |
.PP |
| 305 |
or a CAB file on Microsoft Windows with something like: |
| 306 |
.PP |
| 307 |
.Vb 1 |
| 308 |
\& bundle: cabarc \-r \-p N %BDBASE%.cab %BDINPUTS% |
| 309 |
.Ve |
| 310 |
.SH EXAMPLES |
| 311 |
.IX Header "EXAMPLES" |
| 312 |
Assume that \fImyfile.dep\fR was produced from \fImyfile.tex\fR by following |
| 313 |
the instructions in the Description section. The |
| 314 |
following command produces a \fI.zip\fR file with the MikTeX TeX |
| 315 |
distribution running on Microsoft Windows: |
| 316 |
.PP |
| 317 |
.Vb 1 |
| 318 |
\& bundledoc \-\-config=miktex.cfg myfile.dep |
| 319 |
.Ve |
| 320 |
.PP |
| 321 |
This can be abbreviated to |
| 322 |
.PP |
| 323 |
.Vb 1 |
| 324 |
\& bundledoc \-\-config=miktex myfile |
| 325 |
.Ve |
| 326 |
.PP |
| 327 |
The following builds a \fI.tar.gz\fR archive with the TeX Live |
| 328 |
distribution running on a Unix-like operating system. \fBbundledoc\fR |
| 329 |
will produce verbose output describing its operations. All files not |
| 330 |
in the same directory tree as \fImyfile.tex\fR and all files containing |
| 331 |
".fd" or ".sty" in their names are omitted. However, all \fI.bib\fR |
| 332 |
files in the current directory will be included in the archive even |
| 333 |
though none of them are referenced by \fImyfile.dep\fR. Finally, no |
| 334 |
\&\fIMANIFEST\fR file will be produced. |
| 335 |
.PP |
| 336 |
.Vb 3 |
| 337 |
\& bundledoc \-\-config=texlive\-unix.cfg \-\-verbose \-\-localonly \e |
| 338 |
\& \-\-exclude=.fd \-\-exclude=.cfg \-\-include="*.bib" \-\-manifest="" \e |
| 339 |
\& myfile.dep |
| 340 |
.Ve |
| 341 |
.SH FILES |
| 342 |
.IX Header "FILES" |
| 343 |
The user must have previously installed \fIsnapshot.sty\fR and used it to |
| 344 |
produce a dependency file for his document. Besides that, the set of |
| 345 |
external files needed by \fBbundledoc\fR is system-specific and depends on the |
| 346 |
configuration file used. (See "CONFIGURATION FILES", above.) |
| 347 |
.PP |
| 348 |
\&\fBbundledoc\fR currently comes with two configuration files: |
| 349 |
.IP \fItexlive\-unix.cfg\fR 4 |
| 350 |
.IX Item "texlive-unix.cfg" |
| 351 |
Configuration file for TeX Live installations on Unix or Linux. TeX |
| 352 |
Live is a kpathsea-based TeX distribution that runs on various flavors |
| 353 |
of Unix and Microsoft Windows. \fItexlive\-unix.cfg\fR assumes you have |
| 354 |
\&\fBgzip\fR and uses it to produce a \fI.tar.gz\fR archive file. The |
| 355 |
configuration file has \fBbundledoc\fR use \fBkpsewhich\fR to find LaTeX |
| 356 |
files. |
| 357 |
.IP \fImiktex.cfg\fR 4 |
| 358 |
.IX Item "miktex.cfg" |
| 359 |
Configuration file for MikTeX installations. MikTeX is a popular TeX |
| 360 |
distribution for Microsoft Windows. \fImiktex.cfg\fR assumes you have |
| 361 |
\&\fBzip\fR and uses it to produce a \fI.zip\fR archive file. The |
| 362 |
configuration file now has \fBbundledoc\fR use \fBkpsewhich\fR to find LaTeX |
| 363 |
files; older version of MikTeX required the rather nonstandard |
| 364 |
\&\fBinitexmf\fR for this purpose. |
| 365 |
.IP \fItexlive\-unix\-arlatex.cfg\fR 4 |
| 366 |
.IX Item "texlive-unix-arlatex.cfg" |
| 367 |
This is a variant of \fItexlive\-unix.cfg\fR that uses \fBarlatex\fR instead |
| 368 |
of \fBgzip\fR to archive files. \fBarlatex\fR is a script included in the |
| 369 |
\&\fBbundledoc\fR distribution that generates a self-extracting \fI.tex\fR |
| 370 |
file based on LaTeX's \f(CW\*(C`filecontents\*(C'\fR environment. |
| 371 |
.SH NOTES |
| 372 |
.IX Header "NOTES" |
| 373 |
.SS "Including and excluding files" |
| 374 |
.IX Subsection "Including and excluding files" |
| 375 |
The \f(CW\*(C`\-\-localonly\*(C'\fR, \f(CW\*(C`\-\-exclude\*(C'\fR, and \f(CW\*(C`\-\-include\*(C'\fR options provide |
| 376 |
control over the archive's contents. \f(CW\*(C`\-\-exclude\*(C'\fR and \f(CW\*(C`\-\-include\*(C'\fR |
| 377 |
can be specified repeatedly on the command line. The order in which |
| 378 |
these options are specified is immaterial; \fBbundledoc\fR processes file |
| 379 |
inclusions and exclusions in the following order: |
| 380 |
.IP 1. 4 |
| 381 |
All files referenced by the \fI.dep\fR file are added to the list of |
| 382 |
files to archive. |
| 383 |
.IP 2. 4 |
| 384 |
If \f(CW\*(C`\-\-localonly\*(C'\fR is specified, all files not found in the \fI.tex\fR |
| 385 |
file's directory are removed from the list. |
| 386 |
.IP 3. 4 |
| 387 |
For each \f(CW\*(C`\-\-exclude\*(C'\fR string specified, all files containing that |
| 388 |
string are removed from the list. |
| 389 |
.IP 4. 4 |
| 390 |
For each \f(CW\*(C`\-\-include\*(C'\fR file specification, the set of files designated |
| 391 |
by its expansion are added to the list. |
| 392 |
.SS "Issues When Running Under Microsoft Windows" |
| 393 |
.IX Subsection "Issues When Running Under Microsoft Windows" |
| 394 |
First, because \fBbundledoc\fR is a Perl script, you should do one of the |
| 395 |
following to run it under Windows: |
| 396 |
.IP \(bu 4 |
| 397 |
\&\f(CW\*(C`perl bundledoc\*(C'\fR |
| 398 |
.IP \(bu 4 |
| 399 |
Rename \fIbundledoc\fR to \fIbundledoc.pl\fR and run \f(CW\*(C`bundledoc.pl\*(C'\fR. (This |
| 400 |
is assuming you have a file association set up for \fI.pl\fR.) |
| 401 |
.IP \(bu 4 |
| 402 |
Run the \fBpl2bat\fR script (if you have it) to convert \fIbundledoc\fR to |
| 403 |
\&\fIbundledoc.bat\fR, then run \f(CW\*(C`bundledoc\*(C'\fR. |
| 404 |
.PP |
| 405 |
Second, Windows uses a multi-rooted filesystem (i.e., multiple drive |
| 406 |
letters). I wouldn't be surprised if bad things were to happen if the |
| 407 |
files to be bundled are scattered across drives. In addition, Windows |
| 408 |
supports ``UNC'' filenames, which have no drive letter at all, just a |
| 409 |
machine and share name. UNC filenames are also untested waters for |
| 410 |
\&\fBbundledoc\fR. Be careful! |
| 411 |
.SS "Testing Status" |
| 412 |
.IX Subsection "Testing Status" |
| 413 |
I have tested \fBbundledoc\fR only with Perl v5.6.0 and later and only on |
| 414 |
the following platforms: |
| 415 |
.IP \(bu 4 |
| 416 |
Linux + TeX Live |
| 417 |
.IP \(bu 4 |
| 418 |
Linux + teTeX |
| 419 |
.IP \(bu 4 |
| 420 |
Windows NT + MiKTeX |
| 421 |
.IP \(bu 4 |
| 422 |
Solaris + ??? (something kpathsea-based) |
| 423 |
.PP |
| 424 |
It is my hope that \fBbundledoc\fR works on many more platforms than |
| 425 |
those. I tried to make the program itself fairly independent of the |
| 426 |
operating system; only the configuration files should have to change |
| 427 |
to run \fBbundledoc\fR on a different system. |
| 428 |
.SS "Future Work" |
| 429 |
.IX Subsection "Future Work" |
| 430 |
I'd like \fBbundledoc\fR to work on as wide a variety of TeX |
| 431 |
distributions as possible. If your platform is significantly |
| 432 |
different from the ones listed in "Testing Status" (e.g., if you're |
| 433 |
running OS\ X) and you need to create a substantially different |
| 434 |
configuration file from \fItexlive\-unix.cfg\fR and \fImiktex.cfg\fR, please |
| 435 |
send it to me at the address listed in "AUTHOR" so I can include it |
| 436 |
in a future version of \fBbundledoc\fR. (I make no promises, though). |
| 437 |
.PP |
| 438 |
Once \fBbundledoc\fR works on all the major operating systems and TeX |
| 439 |
distributions it would be really convenient if I could get |
| 440 |
\&\fBbundledoc\fR to detect the platform it's running on and automatically |
| 441 |
select an appropriate configuration file. |
| 442 |
.PP |
| 443 |
Finally, it would be handy for \fBbundledoc\fR to include fonts in the |
| 444 |
archive file. At a minimum, it should include \fI.tfm\fR files, but it |
| 445 |
would be even better if it included \fI.mf\fR, \fI.pfb\fR, \fI.ttf\fR, and |
| 446 |
other common font formats, as well. |
| 447 |
.SS Acknowledgments |
| 448 |
.IX Subsection "Acknowledgments" |
| 449 |
Thanks to Fabien Vignes-Tourneret for suggesting what became the |
| 450 |
\&\f(CW\*(C`\-\-localonly\*(C'\fR option and for a discussion that led to the |
| 451 |
\&\f(CW\*(C`\-\-exclude\*(C'\fR and \f(CW\*(C`\-\-include\*(C'\fR options; to Marius Kleiner for updating |
| 452 |
\&\fBbundledoc\fR to properly handle document subdirectories; and to Frank |
| 453 |
Mittelbach for suggesting using Kpathsea to help find \fI.cfg\fR files |
| 454 |
and to automatically append \fI.cfg\fR and \fI.dep\fR extensions if |
| 455 |
necessary. |
| 456 |
.SH "SEE ALSO" |
| 457 |
.IX Header "SEE ALSO" |
| 458 |
\&\fBarlatex\fR\|(1), \fBgzip\fR\|(1), \fBkpsewhich\fR\|(1), \fBlatex\fR\|(1), \fBperl\fR\|(1), \fBzip\fR\|(1), |
| 459 |
the \fBsnapshot\fR documentation |
| 460 |
.SH AUTHOR |
| 461 |
.IX Header "AUTHOR" |
| 462 |
Scott Pakin, \[email protected]\fR |