summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-filesused.html
blob: 004943fadd19711f69e92db25985844aa4ea615a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<head>
<title>UK TeX FAQ -- question label filesused</title>
</head><body>
<h3>All the files used by this document</h3>
<p/>When you&#8217;re sharing a document with someone else (perhaps as part of a
co-development cycle) it&#8217;s as well to arrange that both correspondents
have the same set of auxiliary files, as well as the document in
question.  Your correspondent obviously needs the same set of files
(if you use the <i>url</i> package, she has to have <i>url</i>
too, for example).  But suppose you have a bug-free version of the
<i>shinynew</i> package but her copy is still the unstable
original; until you both realise what is happening, such a situation
can be very confusing.
<p/>The simplest solution is the LaTeX <code>\</code><code>listfiles</code> command.  This
places a list of the files used and their version numbers in the log
file.  If you extract that list and transmit it with your file, it can
be used as a check-list in case that problems arise.
<p/>Note that <code>\</code><code>listfiles</code> only registers things that are input by the
&#8220;standard&#8221; LaTeX mechanisms (<code>\</code><code>documentclass</code>, <code>\</code><code>usepackage</code>,
<code>\</code><code>include</code>, <code>\</code><code>includegraphics</code> and so on).
The <code>\</code><code>input</code> command, as modified by LaTeX and used, with
LaTeX syntax, as:
<pre>
  \input{mymacros}
</pre>
records file details for <i>mymacros.tex</i>, but if you use TeX
primitive syntax for <code>\</code><code>input</code>, as:
<pre>
  \input mymacros
</pre>
<i>mymacros.tex</i> <em>won&#8217;t</em> be recorded, and so won&#8217;t listed by
<code>\</code><code>listfiles</code> &#8212; you&#8217;ve bypassed the mechanism that records its use.
<p/>The <i>snapshot</i> package helps the owner of a LaTeX document
obtain a list of the external dependencies of the document, in a form
that can be embedded at the top of the document.  The intended use of
the package is the creation of archival copies of documents, but it
has application in document exchange situations too.
<p/>The <i>bundledoc</i> system uses the <i>snapshot</i> to produce an
archive (e.g., <code>.tar.gz</code> or <code>.zip</code>) of the files needed by your
document; it comes with configuration files for use with
<i>teTeX</i> and <i>MiKTeX</i>.  It&#8217;s plainly useful when
you&#8217;re sending the first copy of a document.
<dl>
<dt><tt><i>bundledoc</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/support/bundledoc.zip">support/bundledoc</a> (or <a href="http://www.tex.ac.uk/tex-archive/support/bundledoc/">browse the directory</a>)
<dt><tt><i>snapshot.sty</i></tt><dd><a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/snapshot.zip">macros/latex/contrib/snapshot</a> (or <a href="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/snapshot/">browse the directory</a>)
</dl>
<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filesused">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=filesused</a>
</body>