summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/INSTALL
blob: cfe9abd7580b3d79a30a3cd47b20cd285b579d52 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
INSTALLATION

If you have downloaded the glossaries package using the TeX Directory
Structure (TDS), that is you have downloaded an archive containing
doc, tex, scripts and source directories, you need to follow the
"Installing from TDS" instructions below.

If you have downloaded the following files:

glossaries.dtx
glossaries.ins
makeglossaries
makeglossaries.bat

You need to follow the "Installing from DTX and INS" instructions
below.

For further information on installing LaTeX packages see:

http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings

INSTALLING FROM TDS
===================

Files in tex and doc directories should go in the
corresponding TEXMF directories (for example, /usr/share/texmf-local/
or C:\localtexmf\). The scripts/glossaries/ directory
contains the Perl script makeglossaries and the batch file
makeglossaries.bat which should go somewhere on your operating system's
PATH. (Both files are required for Windows, but only the Perl script is
required for other operating systems.)

*Remember to refresh TeX's database*

A minimal example file called minimalgls.tex is provided for testing
and debugging purposes and can be found in the package documentation
samples directory (doc/latex/glossaries/samples/). To test your
installation do:

latex minimalgls
makeglossaries minimalgls
latex minimalgls

The LaTeX2HTML style file, glossaries.perl, is located in 
source/latex/glossaries and should go in the LaTeX2HTML styles 
directory.

INSTALLING FROM DTX AND INS
===========================

Run LaTeX on glossaries.ins to generate the package style files,
sample files and LaTeX2HTML style file:

latex glossaries.ins

To create the package documentation (glossaries.pdf):

pdflatex glossaries.dtx
makeindex -s gind.ist glossaries.idx
makeindex -s gglo.ist -o glossaries.gls glossaries.glo
pdflatex glossaries.dtx
pdflatex glossaries.dtx

If TEXMF denotes the base directory of your local TeX installation (e.g.
/usr/share/texmf-local/ or C:\localtexmf\) then create the following
directories (if they don't already exist):

TEXMF/doc/latex/glossaries
TEXMF/doc/latex/glossaries/samples
TEXMF/tex/latex/glossaries
TEXMF/tex/latex/glossaries/base
TEXMF/tex/latex/glossaries/styles
TEXMF/tex/latex/glossaries/dict

Move the sample files (*.tex) to TEXMF/doc/latex/glossaries/sample/

Move the documentation (*.pdf) to TEXMF/doc/latex/glossaries/

Move glossaries.sty, glossaries-babel.sty and mfirstuc.sty to TEXMF/tex/latex/glossaries/base/

Move the other style files (glossary-*.sty) to TEXMF/tex/latex/glossaries/styles/

Move the dictionary files (*.dict) to TEXMF/tex/latex/glossaries/dict/

Move makeglossaries to somewhere on your path, e.g. /usr/bin/.

If you are a Windows user, you will also need to move makeglossaries.bat
to the same location as makeglossaries, but you will need to have
Perl installed to be able to use makeglossaries. (It is possible
to use makeindex directly if you don't have Perl installed. See
the manual, glossaries.pdf, for details.)

*Remember to refresh TeX's database*

A minimal example file called minimalgls.tex is provided for testing
and debugging purposes. This file is created along with all the other
sample files when you run glossaries.ins through LaTeX. To test your
installation do:

latex minimalgls
makeglossaries minimalgls
latex minimalgls

If you want to use the glossaries package with LaTeX2HTML:
move glossaries.perl to the LaTeX2HTML styles directory.