Typo
[latex2e.git] / latex2e-20150101 / required / babel / install.txt
blobee83d65b9d8a8f5db37dbb791534abeac528e917
1                           Babel Installation Guide
2  
3                                20 February 2004
6         When you install the babel system you have first to decide
7         whether you want to make a new format file. If you don't, you
8         miss some of the functionality of the babel system, but you
9         can then skip steps 2 through 6 . If you do want to build a
10         new format, start with step 1.
12         When you want to produce the full listing of all the source
13         files in the babel system run babel.drv through LaTeX, then
14         use MakeIndex to produce babel.ind using the command:
15         makeindex -s bbind.ist babel
16         and use MakeIndex to produce babel.gls using the command:
17         makeindex -s bbglo.ist -o babel.gls babel.glo
18         Then run LaTeX on babel.drv again.
20         1 Make sure that you have the Docstrip (version 2) program
21           available (it is part of the LaTeX2e distribution);  then
22           run the file babel.ins through TeX. 
23           This strips all the .dtx files of the comments and produces
24           fast loadable versions of the files. 
25           The installation files that are part of the babel
26           distribution all contain \usedir{tex/generic/babel}
27           commands. The effect of this is that TeX will attempt to
28           write the files it produces into your TDS compliant
29           directory tree. If you have a different tree you should
30           either change these commands or comment them out. Using the
31           file docstrip.cfg you can instruct docstrip about the `root'
32           of the TDS tree. On my Win95 TeX-Live installation I have:
33 \BaseDirectory{D:/TeX-Local/texmf}
34 %\BaseDirectory{D:/TeX-Live/texmf}
35 \UseTDS
36           whereas on my Linux installation I use:
37 \BaseDirectory{/usr/local/TeX}
38 %\BaseDirectory{/usr/TeX/texmf}
39 \UseTDS
40           If all of these are correct and TeX still complains about
41           not being able to store the files it is possible that the
42           file texmf.cnf prohibits writing into the system trees.
43           Look for the line with openout_any; if it's value is 'p'
44           (paranoid) change it to 'r' (restricted).
45           If all of the above doesn't work for you (or you commented
46           out the \usedir lines) you will have to move the resulting 
47           .ldf, .sty, .def, .cfg and .fd files yourself into a
48           directory where TeX can find them. 
49           Do that now.
50           On some operating systems you might get an error message
51           such as:
53 ! I can't write on file `./catalan.sty'.
54 <to be read again>
55            \edef
56 l.455           }
58 Please type another output file name:
60           In such a case you have run into a maximum number of open
61           files limit in your computer. You can get around this by
62           telling docstrip to open less files at a time (from bug
63           report Babel/2592, answer by David Carlisle):
65           As long as you have a reasonably new copy of docstrip, 
66           you can make a docstrip.cfg file at your site to tell 
67           docstrip that you have operating system limits on the
68           number of open files.
69           Make a file docstrip.cfg with the two lines:
71 \maxfiles{8}
72 \maxoutfiles{8}
74           and docstrip will keep below 8 the number of files it has
75           open. (You may need to experiment to see how large your 
76           system lets you make these numbers, the default is 16)
77           See docstrip.dtx 
78           % \subsection{Setting maximum numbers of streams}
79           for more details.
81           Docstrip also produces two files called babel.drv and
82           user.drv. You can use babel.drv to produce the full
83           documented source listing of the babel system. (Which is
84           also provided as babel.dvi) You can use user.drv to produce
85           a short document that describes the features of each
86           language specific file.
88         2 Make sure you have the hyphenation patterns available for
89           the languages that you intend to use. If you don't have
90           them, you may be able to find them in CTAN, in the directory:
91           /tex-archive/language/hyphenation.
92           If you happen to have a set of patterns that is not
93           available there you could make it available by either
94           putting it in the /incoming directory or sending it to me.
96         3 The docstripping process will have produced a file called
97           hyphen.cfg. This file will be loaded when you build a
98           LaTeX format. To build a plain format with the babel system
99           preloaded you can use the file bplain.tex as a wrapper for
100           plain.tex. When you run it through iniTeX plain.tex will be
101           loaded, as well as hyphen.cfg. When you type \dump at the 
102           end you will get bplain.fmt which you can use as your
103           plain TeX format. Renaming hyphen.tex to something else is
104           not permitted by Don Knuth.
106         4 Check the hyphenation patterns that you have available and
107           want to load into the format. For each language that you
108           want to hyphenate correctly you need a hyphenation pattern.
109           List them all in the file `language.dat'. The file that is
110           in the distribution serves as an example of what you have to
111           put in there.
112           The files containing hyphenation patterns should be found
113           somewhere on TeX's `input path'. What that means depends on
114           the implementation of TeX you use:
115           - With emTeX there is an environment variable TEXINPUT in
116             which you can list the directories to search through,
117             adding a ! to a directory will make emTeX do a recursive
118             search through the directory tree.
119           - With Unix TeX the `system directories' do not need to be
120             specified in the environment variable TEXINPUTS; there
121             adding a double / to a directory name means recursive
122             searching of the directory tree.
124         5 Run iniTeX, telling it to load your favorite macro package
125           (ie plain or latex).
126           When you build a LaTeX format iniTeX will find the file
127           hyphen.cfg (provided that you have stored it in the
128           correct place).
129           When you build a plain TeX format using the supplied file
130           bplain.tex iniTeX will also find hyphen.cfg. 
132           *Beware*: some implementations of TeX only look in the
133           current directory when the \openin primitive is used. If
134           your TeX does that you need to put the file `languages.dat'
135           in the same directory where you build your format.
137         6 When the iniTeX run in step 5 stops with a message about
138           not enough memory (trie_size = ...) and "you can ask a
139           wizard to enlarge me" You have tried to load more
140           hyphenation patterns into TeX's memory then it has room for.
141           In that case you can either remove one or more languages
142           from the file language.dat or be your own wizard and enlarge
143           TeX. I can not tell you how to do that for all
144           implementations of TeX as it differs with each
145           implementation. Your distribution should contain a
146           description of what to. 
147           - With emTeX you can influence the size of some of the
148             memory arrays with command line switches (/mt:65000 for
149             the trie_size).
150           - With Unix TeX you have to change a file called tex.ch and
151             rebuild TeX using the supplied Makefile. The change you
152             need to make is to enlarge the trie_size and
153             trie_op_size. 
154           - With Web2C TeX (version 7 and newer) you can change the
155             value of the trie_size in the file web2c/texmf.cnf.
157 --- Copyright 2004 Johannes Braams.  All rights reserved ---