summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/html/FAQ-install-where.html
blob: 42ec4dd1199ca8d48b1cf330a050def52636e6b2 (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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<head>
<title>UK TeX FAQ -- question label install-where</title>
</head><body>
<h3>Where to install packages</h3>
<p/>We assume here that you have decided what tree to put your files in,
after reading 
&ldquo;<a href="FAQ-what-TDS.html">choosing a TDS tree</a>&rdquo;.  We will therefore
write <code>$TEXMF</code> for it, and you need to substitute the tree
you decided on.
<p/>The basic idea is to imitate the directory structure in your
existing tree(s). Here are some examples of where various sorts of
files should go:
<blockquote>
<pre>
.sty, .cls or .fd: $TEXMF/tex/&lt;format&gt;/&lt;package&gt;/
.mf:   $TEXMF/fonts/source/&lt;supplier&gt;/&lt;font&gt;/
.tfm:  $TEXMF/fonts/tfm/&lt;supplier&gt;/&lt;font&gt;/
.vf:   $TEXMF/fonts/vf/&lt;supplier&gt;/&lt;font&gt;/
.afm:  $TEXMF/fonts/afm/&lt;supplier&gt;/&lt;font&gt;/
.pfb:  $TEXMF/fonts/type1/&lt;supplier&gt;/&lt;font&gt;/
.ttf:  $TEXMF/fonts/truetype/&lt;supplier&gt;/&lt;font&gt;/
.otf:  $TEXMF/fonts/opentype/&lt;supplier&gt;/&lt;font&gt;/
.pool, .fmt, .base or .mem: $TEXMF/web2c
</pre>
</blockquote><p>
and for modern systems (those distributed in 2005 or later, using TDS
v1.1 layouts):
<blockquote>
<pre>
.map:  $TEXMF/fonts/map/&lt;syntax&gt;/&lt;bundle&gt;/
.enc:  $TEXMF/fonts/enc/&lt;syntax&gt;/&lt;bundle&gt;/
</pre>
</blockquote><p>
(Map and encoding files went to directories under
<i>$TEXMF/dvips/</i>, in earlier distributions.)
<p/>In the lists above &lt;<i>format</i>&gt; identifies the format the macros
are designed for &mdash; it can be things such as <code>plain</code>,
<code>generic</code> (i.e., any format), <code>latex</code> or
<code>context</code> (or several less common formats).
<p/>For fonts, &lt;<i>font</i>&gt; refers to the font family (such as <code>cm</code>
for Knuth&rsquo;s Computer Modern, <code>times</code> for Adobe&rsquo;s Times Roman).
The supplier is usually obvious &mdash; the supplier
&ldquo;public&rdquo; is commonly used for free fonts.
<p/>The &lt;<i>syntax</i>&gt; (for <code>.map</code> and <code>.enc</code> files) is a
categorisation based on the way the files are written; candidates are
names of programs such as <i>dvips</i> or <i>pdftex</i>.
<p/>&ldquo;Straight&rdquo; (La)TeX input can take other forms than the
<code>.sty</code>, <code>.cls</code> or <code>.fd</code> listed above, too
(apart from the &lsquo;obvious&rsquo; <code>.tex</code>).  Examples are (the
obvious) <code>.tex</code>, <code>.lfd</code> for <i>babel</i> language
definitions, <code>.sto</code> and <code>.clo</code> for package and class
options, <code>.cfg</code> for configuration information,
<code>.def</code> for variants (such as the types of devices
<i>graphics</i> drives).  The <i>README</i> of the package should
tell you of any others, though sometimes that information is printed
when the package&rsquo;s <a href="FAQ-install-unpack.html">comments are stripped</a>.
All of these files should live together with the main package files.
<p/>Note that &lt;<i>font</i>&gt; may stand for a single font or an entire family:
for example, files for all of Knuth&rsquo;s Computer Modern fonts are to be
found in <code>.../public/cm</code>, with various prefixes as appropriate.
<p/>The font &ldquo;supplier&rdquo; <em>public</em> is a sort of hold-all for
&ldquo;free fonts produced for use with (La)TeX&rdquo;: as well as Knuth&rsquo;s
fonts, <em>public</em>&rsquo;s directory holds fonts designed by others
(originally, but no longer exclusively, in Metafont).
<p/>Documentation for each package should all go, undifferentiated, into a
directory on the <i>doc/</i> subtree of the TDS.  The layout of
the subtree is slightly different: <i>doc/latex</i> hosts all
LaTeX documentation directories, but more fundamental things are
covered, e.g., by <i>doc/etex</i> or <i>doc/xetex</i>.
<p/><p>This question on the Web: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=install-where">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=install-where</a>
</body>