1 This is kpathsea.info, produced by makeinfo version 5.1 from
\r
4 This file documents the Kpathsea library for path searching.
\r
6 Copyright (C) 1996-2013 Karl Berry & Olaf Weber.
\r
8 Permission is granted to make and distribute verbatim copies of this
\r
9 manual provided the copyright notice and this permission notice are
\r
10 preserved on all copies.
\r
12 Permission is granted to copy and distribute modified versions of
\r
13 this manual under the conditions for verbatim copying, provided that the
\r
14 entire resulting derived work is distributed under the terms of a
\r
15 permission notice identical to this one.
\r
17 Permission is granted to copy and distribute translations of this
\r
18 manual into another language, under the above conditions for modified
\r
19 versions, except that this permission notice may be stated in a
\r
20 translation approved by the TeX Users Group.
\r
21 INFO-DIR-SECTION TeX
\r
22 START-INFO-DIR-ENTRY
\r
23 * Kpathsea: (kpathsea). File lookup along search paths.
\r
24 * kpsewhich: (kpathsea)Invoking kpsewhich. TeX file searching.
\r
25 * mktexfmt: (kpathsea)mktex scripts. Format (fmt/base/mem) generation.
\r
26 * mktexlsr: (kpathsea)Filename database. Update ls-R.
\r
27 * mktexmf: (kpathsea)mktex scripts. MF source generation.
\r
28 * mktexpk: (kpathsea)mktex scripts. PK bitmap generation.
\r
29 * mktextex: (kpathsea)mktex scripts. TeX source generation.
\r
30 * mktextfm: (kpathsea)mktex scripts. TeX font metric generation.
\r
34 File: kpathsea.info, Node: Top, Next: Introduction, Up: (dir)
\r
39 This manual documents how to install and use the Kpathsea library for
\r
40 filename lookup. It corresponds to version 6.1.1, released in April
\r
45 * Introduction:: Overview.
\r
46 * Installation:: Compilation, installation, and bug reporting.
\r
48 * Path searching:: How filename lookups work.
\r
49 * TeX support:: Special support for TeX-related file lookups.
\r
51 * Programming:: How to use Kpathsea features in your program.
\r
53 * Index:: General index.
\r
56 File: kpathsea.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
\r
61 This manual corresponds to version 6.1.1 of the Kpathsea library,
\r
62 released in April 2013.
\r
64 The library's fundamental purpose is to return a filename from a list
\r
65 of directories specified by the user, similar to what shells do when
\r
66 looking up program names to execute.
\r
68 The following software, all of which we maintain, uses this library:
\r
70 * Dviljk (see the 'dvilj' man page)
\r
71 * Dvipsk (*note Introduction: (dvips)Top.)
\r
72 * GNU font utilities (*note Introduction: (fontu)Top.)
\r
73 * Web2c (*note Introduction: (web2c)Top.)
\r
74 * Xdvik (see the 'xdvi' man page)
\r
76 Other software that we do not maintain also uses it.
\r
78 We are still actively maintaining the library (and probably always
\r
79 will be, despite our hopes). If you have comments or suggestions,
\r
80 please send them to us (*note Reporting bugs::).
\r
82 We distribute the library under the GNU Library General Public
\r
83 License (LGPL). In short, this means if you write a program using the
\r
84 library, you must (offer to) distribute the source to the library, along
\r
85 with any changes you have made, and allow anyone to modify the library
\r
86 source and distribute their modifications. It does not mean you have to
\r
87 distribute the source to your program, although we hope you will. See
\r
88 the accompanying files for the text of the GNU licenses.
\r
90 If you know enough about TeX to be reading this manual, then you (or
\r
91 your institution) should consider joining the TeX Users Group (if you're
\r
92 already a member, thanks!). TUG produces the periodical 'TUGboat',
\r
93 sponsors an annual meeting and publishes the proceedings, and arranges
\r
94 courses on TeX for all levels of users throughout the world. See
\r
95 <http://tug.org> for information.
\r
102 File: kpathsea.info, Node: History, Up: Introduction
\r
107 (This section is for those people who are curious about how the library
\r
108 came about.) (If you like to read historical accounts of software, we
\r
109 urge you to seek out the GNU Autoconf manual and the "Errors of TeX"
\r
110 paper by Don Knuth, published in 'Software--Practice and Experience'
\r
113 [Karl writes.] My first ChangeLog entry for Web2c seems to be
\r
114 February 1990, but I may have done some work before then. In any case,
\r
115 Tim Morgan and I were jointly maintaining it for a time. (I should
\r
116 mention here that Tim had made Web2c into a real distribution long
\r
117 before I had ever used it or even heard of it, and Tom Rokicki did the
\r
118 original implementation. I was using 'pxp' and 'pc' on VAX 11/750's and
\r
119 the hot new Sun 2 machines.)
\r
121 It must have been later in 1990 and 1991 that I started working on
\r
122 'TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
\r
123 (which I was also writing at the time) all used different environment
\r
124 variables, and, more importantly, had different bugs in their path
\r
125 searching. This became extremely painful, as I was stressing everything
\r
126 to the limit working on the book. I also desperately wanted to
\r
127 implement subdirectory searching, since I couldn't stand putting
\r
128 everything in one big directory, and also couldn't stand having to
\r
129 explicitly specify 'cm', 'pandora', ... in a path.
\r
131 In the first incarnation, I just hacked separately on each
\r
132 program--that was the original subdirectory searching code in both Xdvi
\r
133 and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
\r
134 support by now. That is, I tried to go with the flow in each program,
\r
135 rather than changing the program's calling sequences to conform to
\r
138 Then, as bugs inevitably appeared, I found I was fixing the same
\r
139 thing three times (Web2c and fontutils were always sharing code, since I
\r
140 maintained those--there was no Dvipsk or Xdvik or Dviljk at this point).
\r
141 After a while, I finally started sharing source files. They weren't yet
\r
142 a library, though. I just kept things up to date with shell scripts.
\r
143 (I was developing on a 386 running ISC 2.2 at the time, and so didn't
\r
144 have symbolic links. An awful experience.)
\r
146 The ChangeLogs for Xdvik and Dvipsk record initial releases of those
\r
147 distributions in May and June 1992. I think it was because I was tired
\r
148 of the different configuration strategies of each program, not so much
\r
149 because of the path searching. (Autoconf was being developed by David
\r
150 MacKenzie and others, and I was adapting it to TeX and friends.)
\r
152 I started to make a separate library that other programs could link
\r
153 with on my birthday in April 1993, according to the ChangeLog. I don't
\r
154 remember exactly why I finally took the time to make it a separate
\r
155 library; a conversation with david zuhn that initiated it. Just seemed
\r
158 Dviljk got started in March 1994 after I bought a Laserjet 4.
\r
159 (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
\r
160 Neumann's help, implemented a way for TeX to get at all those neat
\r
161 builtin LJ4 fonts ... such a treat to have something to typeset in
\r
164 By spring of 1995, I had implemented just about all the
\r
165 path-searching features in Kpathsea that I plan to, driven beyond my
\r
166 initial goals by Thomas Esser and others. I then started to integrate
\r
167 Web2c with Kpathsea. After the release of a stable Web2c, I hope to be
\r
168 able to stop development, and turn most of my attention back to making
\r
169 fonts for GNU. (Always assuming Micros**t hasn't completely obliterated
\r
170 Unix by then, or that software patents haven't stopped software
\r
171 development by anybody smaller than a company with a
\r
172 million-dollar-a-year legal budget. Which is actually what I think is
\r
173 likely to happen, but that's another story...)
\r
175 [Olaf writes.] At the end of 1997, UNIX is still alive and kicking,
\r
176 individuals still develop software, and Web2c development still
\r
177 continues. Karl had been looking for some time for someone to take up
\r
178 part of the burden, and I volunteered.
\r
181 File: kpathsea.info, Node: Installation, Next: Path searching, Prev: Introduction, Up: Top
\r
186 (A copy of this chapter is in the distribution file 'kpathsea/INSTALL'.)
\r
188 The procedure for Kpathsea (and Web2c, etc.) configuration and
\r
189 installation follows. If you encounter trouble, see *note Common
\r
190 problems::, a copy of which is in the file 'kpathsea/BUGS'.
\r
194 * Simple installation:: If you just want to do it.
\r
195 * Custom installation:: If you want to change things around.
\r
196 * Security:: Who can write what files, etc.
\r
197 * TeX directory structure:: Managing the horde of TeX input files.
\r
198 * unixtex.ftp:: Getting software via FTP, on CD-ROM, or on tape.
\r
199 * Reporting bugs:: Where and how to report bugs.
\r
202 File: kpathsea.info, Node: Simple installation, Next: Custom installation, Up: Installation
\r
204 2.1 Simple installation
\r
205 =======================
\r
207 Installing TeX and friends for the first time can be a daunting
\r
208 experience. Thus, you may prefer to skip this whole thing and just get
\r
209 precompiled executables: see *note unixtex.ftp::.
\r
211 This section explains what to do if you wish to take the defaults for
\r
212 everything, and generally to install in the simplest possible way. Most
\r
213 steps here refer to corresponding subsection in the next section which
\r
214 explains how to override defaults and generally gives more details.
\r
216 By default everything will be installed under '/usr/local' and the
\r
217 following discussion assumes this. However, if you already have TeX
\r
218 installed, its location is used to derive the directory under which
\r
219 everything is to be installed.
\r
221 1. Be sure you have enough disk space: approximately 8 megabytes for
\r
222 the compressed archives, 15MB for sources, 50MB for compilation,
\r
223 40MB for the (initial) installed system (including library files).
\r
224 *Note Disk space::.
\r
226 2. Retrieve these distribution archives:
\r
227 <ftp://ftp.tug.org/tex/texk.tar.gz>
\r
228 These are the sources, which you will be compiling.
\r
230 <ftp://ftp.tug.org/tex/texklib.tar.gz>
\r
231 This is a basic set of input files. You should unpack it in
\r
232 the directory '/usr/local/share'; doing so will create a
\r
233 'texmf' subdirectory there.
\r
235 These archives are mirrored on the CTAN hosts, in the
\r
236 'systems/web2c' directory.
\r
238 *Note Kpathsea application distributions::.
\r
240 3. When using the default search paths, there is no need to edit any
\r
241 distribution files. *Note Changing search paths::.
\r
243 4. At the top level of the distribution, run 'sh configure'. (If you
\r
244 have the GNU Bash shell installed, run 'bash configure'.) *Note
\r
245 Running configure::.
\r
247 5. 'make'. *Note Running make::. If you are using a BSD 4.4 system
\r
248 such as FreeBSD or NetBSD, you may have to use GNU make (often
\r
249 installed in '/usr/local/bin'), not the BSD make.
\r
251 6. 'make install'. *Note Installing files::.
\r
253 7. 'make distclean'. *Note Cleaning up::.
\r
255 8. Set up a cron job to rebuild the filename database that makes
\r
256 searching faster. This line will rebuild it every midnight:
\r
257 0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
\r
258 *Note Filename database generation::, and *note Filename
\r
261 9. If you're installing Dvips, you also need to set up configuration
\r
262 files for your printers and make any additional PostScript fonts
\r
263 available. *Note (dvips)Installation::. If you have any color
\r
264 printers, see *note (dvips)Color device configuration::.
\r
266 10. The first time you run a DVI driver, a bunch of PK fonts will be
\r
267 built by Metafont via 'mktexpk' (and added to the filename
\r
268 database). This will take some time. Don't be alarmed; they will
\r
269 created only this first time (unless something is wrong with your
\r
272 By default, 'mktexpk' will create these fonts in a hierarchy under
\r
273 '/var/tmp/texfonts'; it simply assumes that '/var/tmp' exists and
\r
274 is globally writable. If you need a different arrangement, see
\r
275 *note mktex configuration::.
\r
277 *Note mktex scripts::.
\r
279 11. For some simple tests, try 'tex story \\bye' and 'latex sample2e'.
\r
280 Then run 'xdvi story' or 'dvips sample2e' on the resulting DVI
\r
281 files to preview/print the documents. *Note Installation
\r
285 File: kpathsea.info, Node: Custom installation, Next: Security, Prev: Simple installation, Up: Installation
\r
287 2.2 Custom installation
\r
288 =======================
\r
290 Most sites need to modify the default installation procedure in some
\r
291 way, perhaps merely changing the prefix from '/usr/local', perhaps
\r
292 adding extra compiler or loader options to work around 'configure' bugs.
\r
293 This section explains how to override default choices. For additional
\r
294 distribution-specific information:
\r
295 * 'dviljk/INSTALL'.
\r
296 * *Note (dvips)Installation::.
\r
297 * *Note (web2c)Installation::.
\r
300 These instructions are for Unix systems. Other operating-system
\r
301 specific distributions have their own instructions. The code base
\r
302 itself supports Amiga, DOS, OS/2, and VMS.
\r
304 Following are the same steps as in the previous section (which
\r
305 describes the simplest installation), but with much more detail.
\r
310 * Kpathsea application distributions::
\r
311 * Changing search paths::
\r
312 * Running configure::
\r
314 * Installing files::
\r
316 * Filename database generation::
\r
318 * Installation testing::
\r
321 File: kpathsea.info, Node: Disk space, Next: Kpathsea application distributions, Up: Custom installation
\r
326 Here is a table showing the disk space needed for each distribution
\r
327 (described in the next section). The '(totals)' line reflects the
\r
328 'texk' source distribution and 'texklib'; the individual distributions
\r
329 don't enter into it. Sizes are in megabytes. All numbers are
\r
332 Distribution .tar.gz Unpacked Compiled Installed
\r
338 texk 7.5 32.1 95.3 33.5
\r
339 texklib 6.3 15.0 - 15.0
\r
340 (totals) 14.6 47.1 95.3 48.5
\r
343 File: kpathsea.info, Node: Kpathsea application distributions, Next: Changing search paths, Prev: Disk space, Up: Custom installation
\r
345 2.2.2 Kpathsea application distributions
\r
346 ----------------------------------------
\r
348 The archive <ftp://ftp.tug.org/tex/texk.tar.gz> contains all of the
\r
349 Kpathsea applications I maintain, and the library itself. For example,
\r
350 since NeXT does not generally support X11, you'd probably want to skip
\r
351 'xdvik' (or simply remove it after unpacking 'texk.tar.gz'. If you are
\r
352 not interested in all of them, you can also retrieve them separately:
\r
355 DVI to PCL, for LaserJet printers.
\r
358 DVI to PostScript, for previewers, printers, or PDF generation.
\r
361 The software needed to compile TeX and friends.
\r
364 The original WEB source files, also used in compilation.
\r
367 DVI previewing under the X window system.
\r
369 If you want to use the Babel LaTeX package for support of non-English
\r
370 typesetting, you may need to retrieve additional files. See the file
\r
371 'install.txt' in the Babel distribution.
\r
374 File: kpathsea.info, Node: Changing search paths, Next: Running configure, Prev: Kpathsea application distributions, Up: Custom installation
\r
376 2.2.3 Changing search paths
\r
377 ---------------------------
\r
379 If the search paths for your installation differ from the standard TeX
\r
380 directory structure (*note Introduction: (tds)Top.), edit the file
\r
381 'kpathsea/texmf.in' as desired, before running 'configure'. For
\r
382 example, if you have all your fonts or macros in one big directory.
\r
384 You may also wish to edit the file 'mktex.cnf', either before or
\r
385 after installation, to control various aspects of 'mktexpk' and friends.
\r
386 *Note mktex configuration::.
\r
388 You do not need to edit 'texmf.in' to change the default top-level or
\r
389 other installation _directories_ (only the paths). You can and should
\r
390 do that when you run 'configure' (next step).
\r
392 You also do not need to edit 'texmf.in' if you are willing to rely on
\r
393 'texmf.cnf' at runtime to define the paths, and let the compile-time
\r
394 default paths be incorrect. Usually there is no harm in doing this.
\r
396 The section below explains default generation in more detail.
\r
400 * Default path features::
\r
401 * Default path generation::
\r
404 File: kpathsea.info, Node: Default path features, Next: Default path generation, Up: Changing search paths
\r
406 2.2.3.1 Default path features
\r
407 .............................
\r
409 The purpose of having all the different files described in the section
\r
410 above is to avoid having the same information in more than one place.
\r
411 If you change the installation directories or top-level prefix at
\r
412 'configure'-time, those changes will propagate through the whole
\r
413 sequence. And if you change the default paths in 'texmf.in', those
\r
414 changes are propagated to the compile-time defaults.
\r
416 The Make definitions are all repeated in several Makefile's; but
\r
417 changing the top-level 'Makefile' should suffice, as it passes down all
\r
418 the variable definitions, thus overriding the submakes. (The
\r
419 definitions are repeated so you can run Make in the subdirectories, if
\r
420 you should have occasion to.)
\r
422 By default, the bitmap font paths end with '/$MAKETEX_MODE', thus
\r
423 including the device name (usually a Metafont mode name such as
\r
424 'ljfour'). This distinguishes two different devices with the same
\r
425 resolution--a write/white from a write/black 300dpi printer, for
\r
428 However, since most sites don't have this complication, Kpathsea
\r
429 (specifically, the 'kpse_init_prog' function in 'kpathsea/proginit.c')
\r
430 has a special case: if the mode has not been explicitly set by the user
\r
431 (or in a configuration file), it sets 'MAKETEX_MODE' to '/'. This makes
\r
432 the default PK path, for example, expand into '.../pk//', so fonts will
\r
433 be found even if there is no subdirectory for the mode (if you arranged
\r
434 things that way because your site has only one printer, for example) or
\r
435 if the program is mode-independent (e.g., 'pktype').
\r
437 To make the paths independent of the mode, simply edit 'texmf.in'
\r
438 before installation, or the installed 'texmf.cnf', and remove the
\r
441 *Note mktex script arguments::, for how this interacts with
\r
444 *Note TeX directory structure: TeX directory structure, for a
\r
445 description of the default arrangement of the input files that comprise
\r
449 File: kpathsea.info, Node: Default path generation, Prev: Default path features, Up: Changing search paths
\r
451 2.2.3.2 Default path generation
\r
452 ...............................
\r
454 This section describes how the default paths are constructed.
\r
456 You may wish to ignore the whole mess and simply edit 'texmf.cnf'
\r
457 after it is installed, perhaps even copying it into place beforehand so
\r
458 you can complete the installation, if it seems necessary.
\r
460 To summarize the chain of events that go into defining the default
\r
463 1. 'configure' creates a 'Makefile' from each 'Makefile.in'.
\r
465 2. When Make runs in the 'kpathsea' directory, it creates a file
\r
466 'texmf.sed' that substitutes the Make value of '$(var)' for a
\r
467 string '@var@'. The variables in question are the one that define
\r
468 the installation directories.
\r
470 3. 'texmf.sed' (together with a little extra magic--see
\r
471 'kpathsea/Makefile') is applied to 'texmf.in' to generate
\r
472 'texmf.cnf'. This is the file that will eventually be installed
\r
475 4. The definitions in 'texmf.cnf' are recast as C '#define''s in
\r
476 'paths.h'. These values will be the compile-time defaults; they
\r
477 are not used at runtime unless no 'texmf.cnf' file can be found.
\r
479 (That's a lie: the compile-time defaults are what any extra :'s in
\r
480 'texmf.cnf' expand into; but the paths as distributed have no extra
\r
481 :'s, and there's no particular reason for them to.)
\r
484 File: kpathsea.info, Node: Running configure, Next: Running make, Prev: Changing search paths, Up: Custom installation
\r
486 2.2.4 Running 'configure'
\r
487 -------------------------
\r
489 Run 'sh configure OPTIONS' (in the top-level directory, the one
\r
490 containing 'kpathsea/'), possibly using a shell other than 'sh' (*note
\r
491 configure shells::).
\r
493 'configure' adapts the source distribution to the present system via
\r
494 '#define''s in '*/c-auto.h', which are created from the corresponding
\r
495 'c-auto.in'. It also creates a 'Makefile' from the corresponding
\r
496 'Makefile.in', doing '@VAR@' and 'ac_include' substitutions).
\r
498 'configure' is the best place to control the configuration,
\r
499 compilation, and installed location of the software, either via
\r
500 command-line options, or by setting environment variables before
\r
501 invoking it. For example, you can disable 'mktexpk' by default with the
\r
502 option '--disable-mktexpk'. *Note configure options::.
\r
506 * configure shells::
\r
507 * configure options::
\r
508 * configure environment::
\r
509 * configure scenarios::
\r
513 File: kpathsea.info, Node: configure shells, Next: configure options, Up: Running configure
\r
515 2.2.4.1 'configure' shells
\r
516 ..........................
\r
518 Considerable effort has gone into trying to ensure that the 'configure'
\r
519 scripts can be run by most Bourne shell variants. If 'sh' runs into
\r
520 trouble, your best bet is to use Bash, the GNU Bourne-again shell (*note
\r
523 Bourne shell variants for which problems have been reported in the
\r
526 Old versions of the Korn shell may fail to handle the scripts. The
\r
527 Korn shell may be installed as '/bin/sh' on AIX, in which case
\r
528 '/bin/bsh' may serve instead.
\r
531 Old versions of ash are unable to handle the scripts. Ash is
\r
532 sometimes installed as '/bin/sh' on NetBSD, FreeBSD, and Linux
\r
533 systems. '/bin/bash' should be available for those systems, but
\r
534 might not be part of a default installation.
\r
537 '/bin/sh' under Ultrix is a DEC-grown shell that is notably
\r
538 deficient in many ways. '/bin/sh5' may be necessary.
\r
541 File: kpathsea.info, Node: configure options, Next: configure environment, Prev: configure shells, Up: Running configure
\r
543 2.2.4.2 'configure' options
\r
544 ...........................
\r
546 For a complete list of all 'configure' options, run 'configure --help'
\r
547 or see *note Running 'configure' scripts: (autoconf)Invoking configure,
\r
548 (a copy is in the file 'kpathsea/README.CONFIGURE'). The generic
\r
549 options are listed first in the '--help' output, and the
\r
550 package-specific options come last. The environment variables
\r
551 'configure' pays attention to are listed below.
\r
553 Options particularly likely to be useful are '--prefix', '--datadir',
\r
554 and the like; see *note configure scenarios::.
\r
556 This section gives pointers to descriptions of the '--with' and
\r
557 '--enable' options to 'configure' that Kpathsea-using programs accept.
\r
559 '--without-mktexmf-default'
\r
560 '--without-mktexpk-default'
\r
561 '--without-mktextfm-default'
\r
562 '--with-mktextex-default'
\r
563 Enable or disable the dynamic generation programs. *Note mktex
\r
567 Build Kpathsea as a shared library, and link against it. Also
\r
568 build the usual static library. *Note Shared library::.
\r
571 Build only the shared library. Implies '--enable-shared'.
\r
573 '--enable-maintainer-mode'
\r
574 Enables make targets that are useful for the maintainer and likely
\r
575 to be a pain for anyone else; the makefiles created when this
\r
576 option is enabled may not work at all for you. You have been
\r
580 File: kpathsea.info, Node: configure environment, Next: configure scenarios, Prev: configure options, Up: Running configure
\r
582 2.2.4.3 'configure' environment
\r
583 ...............................
\r
585 'configure' uses the value of the following environment variables in
\r
586 determining your system's characteristics, and substitutes for them in
\r
590 The compiler to use: default is 'gcc' if it's installed, otherwise
\r
594 Options to give the compiler: default is '-g -O2' for 'gcc', '-g'
\r
595 otherwise. 'CFLAGS' comes after any other options. You may need
\r
596 to include '-w' here if your compilations commonly have useless
\r
597 warnings (e.g., 'NULL redefined'), or 'configure' may fail to
\r
598 detect the presence of header files (it takes the messages on
\r
599 standard error to mean the header file doesn't exist).
\r
602 Options to pass to the compiler preprocessor; this matters most for
\r
603 configuration, not the actual source compilation. The 'configure'
\r
604 script often does only preprocessing (e.g., to check for the
\r
605 existence of #include files), and 'CFLAGS' is not used for this.
\r
606 You may need to set this to something like
\r
607 '-I/usr/local/include/wwwhatever' if you have the libwww library
\r
608 installed for hyper-xdvik (see 'xdvik/INSTALL').
\r
611 Additional preprocessor options, but not used by 'configure'.
\r
612 Provided for enabling or disabling program features, as documented
\r
613 in the various program-specific installation instructions. 'DEFS'
\r
614 comes before any compiler options included by the distribution
\r
615 'Makefile's or by 'configure'.
\r
618 Additional options to give to the loader. 'LDFLAGS' comes before
\r
619 any other linker options.
\r
622 Additional libraries to link with.
\r
625 File: kpathsea.info, Node: configure scenarios, Next: Shared library, Prev: configure environment, Up: Running configure
\r
627 2.2.4.4 'configure' scenarios
\r
628 .............................
\r
630 Here are some common installation scenarios:
\r
632 * Including X support in Metafont. This is disabled by default,
\r
633 since many sites have no use for it, and it's a leading cause of
\r
634 configuration problems.
\r
637 * Putting the binaries, TeX files, GNU info files, etc. into a single
\r
638 TeX hierarchy, say '/here/texmf', requires overriding defaults in
\r
640 configure --prefix=/here/texmf --datadir=/here
\r
642 * You can compile on multiple architectures simultaneously either by
\r
643 building symbolic link trees with the 'lndir' script from the X11
\r
644 distribution, or with the '--srcdir' option:
\r
645 configure --srcdir=SRCDIR
\r
647 * If you are installing binaries for multiple architectures into a
\r
648 single hierarchy, you will probably want to override the default
\r
649 'bin' and 'lib' directories, something like this:
\r
650 configure --prefix=TEXMF --datadir=TEXMF \
\r
651 --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
\r
653 (Unless you make provisions for architecture-specific files in
\r
654 other ways, e.g., with Depot or an automounter.)
\r
656 * To compile with optimization (to compile without debugging, remove
\r
658 env CFLAGS="-g -O" sh configure ...
\r
659 For a potential problem if you optimize, see *note TeX or Metafont
\r
660 failing: TeX or Metafont failing.
\r
663 File: kpathsea.info, Node: Shared library, Prev: configure scenarios, Up: Running configure
\r
665 2.2.4.5 Shared library
\r
666 ......................
\r
668 You can compile Kpathsea as a shared library on a few systems, by
\r
669 specifying the option '--enable-shared' when you run 'configure'.
\r
671 The main advantage in doing this is that the executables can then
\r
672 share the code, thus decreasing memory and disk space requirements.
\r
674 On some systems, you can record the location of shared libraries in a
\r
675 binary, usually by giving certain options to the linker. Then
\r
676 individual users do not need to set their system's environment variable
\r
677 (e.g., 'LD_LIBRARY_PATH') to find shared libraries. If you want to do
\r
678 this, you will need to add the necessary options to 'LDFLAGS' yourself;
\r
679 for example, on Solaris, include something like '-R${prefix}/lib', on
\r
680 IRIX or Linux, use '-rpath${prefix}/lib'. (Unfortunately, making this
\r
681 happen by default is very difficult, because of interactions with an
\r
682 existing installed shared library.)
\r
685 File: kpathsea.info, Node: Running make, Next: Installing files, Prev: Running configure, Up: Custom installation
\r
687 2.2.5 Running 'make'
\r
688 --------------------
\r
690 'make' (still in the top-level directory). This also creates the
\r
691 'texmf.cnf' and 'paths.h' files that define the default search paths,
\r
692 and (by default) the 'plain' and 'latex' TeX formats.
\r
694 You can override directory names and other values at 'make'-time.
\r
695 'make/paths.make' lists the variables most commonly reset. For example,
\r
696 'make default_texsizes=600' changes the list of fallback resolutions.
\r
698 You can also override each of 'configure''s environment variables
\r
699 (*note configure environment::). The Make variables have the same
\r
702 Finally, you can supply additional options via the following
\r
703 variables. ('configure' does not use these.)
\r
707 Preprocessor options.
\r
713 Loader options (included at beginning of link commands).
\r
716 More loader options (included at end of link commands).
\r
719 Additional Make arguments passed to all sub-'make''s. You may need
\r
720 to include assignments to the other variables here via 'XMAKEARGS';
\r
721 for example: 'make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
\r
723 It's generally a bad idea to use a different compiler ('CC') or
\r
724 libraries ('LIBS') for compilation than you did for configuration, since
\r
725 the values 'configure' determined may then be incorrect.
\r
727 Adding compiler options to change the "universe" you are using
\r
728 (typically BSD vs. system V) is generally a cause of trouble. It's best
\r
729 to use the native environment, whatever that is; 'configure' and the
\r
730 software usually adapt best to that. In particular, under Solaris 2.x,
\r
731 you should not use the BSD-compatibility library ('libucb') or include
\r
732 files ('ucbinclude').
\r
734 If you want to use the Babel LaTeX package for support of non-English
\r
735 typesetting, you need to modify some files before making the LaTeX
\r
736 format. See the file 'install.txt' in the Babel distribution.
\r
739 File: kpathsea.info, Node: Installing files, Next: Cleaning up, Prev: Running make, Up: Custom installation
\r
741 2.2.6 Installing files
\r
742 ----------------------
\r
744 The basic command is the usual 'make install'. For security issues,
\r
747 The first time you install any manual in the GNU Info system, you
\r
748 should add a line (you choose where) to the file 'dir' in your
\r
749 '$(infodir)' directory. Sample text for this is given near the top of
\r
750 the Texinfo source files ('kpathsea/kpathsea.texi', 'dvipsk/dvips.texi',
\r
751 and 'web2c/doc/web2c.texi'). If you have a recent version of the GNU
\r
752 Texinfo distribution installed
\r
753 (<ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz> or later), this
\r
754 should happen automatically.
\r
756 On the offchance that this is your first Info installation, the 'dir'
\r
757 file I use is included in the distribution as 'etc/dir-example'.
\r
759 You may wish to use one of the following targets, especially if you
\r
760 are installing on multiple architectures:
\r
761 * 'make install-exec' to install in architecture-dependent
\r
762 directories, i.e., ones that depend on the '$(exec_prefix)' Make
\r
763 variable. This includes links to binaries, libraries, etc., not
\r
764 just "executables".
\r
766 * 'make install-data' to install in architecture-independent
\r
767 directories, such as documentation, configuration files, pool
\r
770 If you use the Andrew File System, the normal path (e.g., PREFIX/bin)
\r
771 only gets you to a read-only copy of the files, and you must specify a
\r
772 different path for installation. The best way to do this is by setting
\r
773 the 'prefix' variable on the 'make' command line. The sequence becomes
\r
774 something like this:
\r
775 configure --prefix=/whatever
\r
777 make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
\r
778 With AFS, you will definitely want to use relative filenames in 'ls-R'
\r
779 (*note Filename database::), not absolute filenames. This is done by
\r
780 default, but check anyway.
\r
783 File: kpathsea.info, Node: Cleaning up, Next: Filename database generation, Prev: Installing files, Up: Custom installation
\r
788 The basic command is 'make distclean'. This removes all files created
\r
792 * 'make mostlyclean' if you intend to compile on another
\r
793 architecture. For Web2C, since the generated C files are portable,
\r
794 they are not removed. If the 'lex' vs. 'flex' situation is going
\r
795 to be different on the next machine, 'rm web2c/lex.yy.c'.
\r
797 * 'make clean' to remove files created by compiling, but leave
\r
798 configuration files and Makefiles.
\r
800 * 'make maintainer-clean' to remove everything that the Makefiles can
\r
801 rebuild. This is more than 'distclean' removes, and you should
\r
802 only use it if you are thoroughly conversant with (and have the
\r
803 necessary versions of) Autoconf.
\r
805 * 'make extraclean' to remove other junk, e.g., core files, log
\r
806 files, patch rejects. This is independent of the other 'clean'
\r
810 File: kpathsea.info, Node: Filename database generation, Next: mktex scripts, Prev: Cleaning up, Up: Custom installation
\r
812 2.2.8 Filename database generation
\r
813 ----------------------------------
\r
815 You will probably want to set up a 'cron' entry on the appropriate
\r
816 machine(s) to rebuild the filename database nightly or so, as in:
\r
817 0 0 * * * cd TEXMF && /BINDIR/mktexlsr
\r
818 *Note Filename database::.
\r
820 Although the 'mktex...' scripts make every effort to add
\r
821 newly-created files on the fly, it can't hurt to make sure you get a
\r
822 fresh version every so often.
\r
825 File: kpathsea.info, Node: mktex scripts, Next: Installation testing, Prev: Filename database generation, Up: Custom installation
\r
827 2.2.9 'mktex' scripts
\r
828 ---------------------
\r
830 If Kpathsea cannot otherwise find a file, for some file types it is
\r
831 configured by default to invoke an external program to create it
\r
832 dynamically (*note mktex configuration::). These are collectively known
\r
833 as "'mktex' scripts", since most of them are named 'mktex...'.
\r
835 For example, this is useful for fonts (bitmaps, TFM's, and
\r
836 arbitrarily-sizable Metafont sources such as the Sauter and EC fonts),
\r
837 since any given document can use fonts never before referenced.
\r
838 Building all fonts in advance is therefore impractical, if not
\r
841 It is also useful for the TeX '.fmt' (and Metafont '.base' and
\r
842 Metapost '.mem' files, *note (Web2c)Memory dumps::), where
\r
843 pre-generating every format consumes a lot of both time and space.
\r
845 The script is passed the name of the file to create and possibly
\r
846 other arguments, as explained below. It must echo the full pathname of
\r
847 the file it created (and nothing else) to standard output; it can write
\r
848 diagnostics to standard error.
\r
852 * config: mktex configuration.
\r
853 * names: mktex script names.
\r
854 * args: mktex script arguments.
\r
857 File: kpathsea.info, Node: mktex configuration, Next: mktex script names, Up: mktex scripts
\r
859 2.2.9.1 'mktex' configuration
\r
860 .............................
\r
862 The list of file types and program names that can run an external
\r
863 program to create missing files is listed in the next section. In the
\r
864 absence of 'configure' options specifying otherwise, everything but
\r
865 'mktextex' will be enabled by default. The 'configure' options to
\r
866 change the defaults are:
\r
868 --without-mktexfmt-default
\r
869 --without-mktexmf-default
\r
870 --without-mktexocp-default
\r
871 --without-mktexofm-default
\r
872 --without-mktexpk-default
\r
873 --without-mktextfm-default
\r
874 --with-mktextex-default
\r
876 The 'configure' setting is overridden if the environment variable or
\r
877 configuration file value named for the script is set; e.g., 'MKTEXPK'
\r
878 (*note mktex script arguments::).
\r
880 'mktexfmt' reads a file 'fmtutil.cnf', typically located in
\r
881 'texmf/web2c/' to glean its configuration information. The rest of the
\r
882 files and features in this section are primarily intended for the font
\r
883 generation scripts.
\r
885 As distributed, all the scripts source a file 'texmf/web2c/mktex.cnf'
\r
886 if it exists, so you can override various defaults. See 'mktex.opt',
\r
887 for instance, which defines the default mode, resolution, some special
\r
888 directory names, etc. If you prefer not to change the distributed
\r
889 scripts, you can simply create 'mktex.cnf' with the appropriate
\r
890 definitions (you do not need to create it if you have nothing to put in
\r
891 it). 'mktex.cnf' has no special syntax; it's an arbitrary Bourne shell
\r
892 script. The distribution contains a sample 'mktex.cnf' for you to copy
\r
893 and modify as you please (it is not installed anywhere).
\r
895 In addition, you can configure a number of features with the
\r
896 'MT_FEATURES' variable, which you can define:
\r
898 * in 'mktex.opt', as just mentioned;
\r
900 * by editing the file 'mktex.opt', either before 'make install' (in
\r
901 the source hierarchy) or after (in the installed hierarchy);
\r
903 * or in the environment.
\r
905 If none of the options below are enabled, 'mktexpk', 'mktextfm', and
\r
906 'mktexmf' follow the following procedure to decide where fonts should be
\r
907 installed. Find the tree where the font's sources are, and test the
\r
908 permissions of the 'fonts' directory of that tree to determine whether
\r
909 it is writable. If it is, put the files in the tree in appropriate
\r
910 locations. If it isn't writable, see whether the tree is a system tree
\r
911 (named in 'SYSTEXMF'). If so, the 'VARTEXFONTS' tree is used. In all
\r
912 other cases the working directory is used.
\r
914 The 'appendonlydir' option is enabled by default.
\r
917 Tell 'mktexdir' to create directories append-only, i.e., set their
\r
918 sticky bit (*note (coreutils)Mode Structure::). This feature is
\r
919 silently ignored on non-Unix platforms (e.g. Windows/NT and
\r
920 MS-DOS) which don't support similar functionality. This feature is
\r
921 enabled by default.
\r
924 Use 8.3 names; e.g., 'dpi600/cmr10.pk' instead of 'cmr10.600pk'.
\r
925 Note that this feature only affects filenames that would otherwise
\r
926 clash with other TeX-related filenames; 'mktex' scripts do nothing
\r
927 about filenames which exceed the 8+3 MS-DOS limits but remain
\r
928 unique when truncated (by the OS) to these limits, and nether do
\r
929 the scripts care about possible clashes with files which aren't
\r
930 related with TeX. For example, 'cmr10.600pk' would clash with
\r
931 'cmr10.600gf' and is therefore changed when 'dosnames' is in
\r
932 effect, but 'mf.pool' and 'mp.base' don't clash with any
\r
933 TeX-related files and are therefore unchanged.
\r
935 This feature is turned on by default on MS-DOS. If you do not wish
\r
936 'dosnames' to be set on an MS-DOS platform, you need to set the
\r
937 'MT_FEATURES' environment variable to a value that doesn't include
\r
938 'dosnames'. You can also change the default setting by editing
\r
939 'mktex.opt', but only if you use the 'mktex' shell scripts; the
\r
940 emulation programs don't consult 'mktex.opt'.
\r
943 Instead of deriving the location of a font in the destination tree
\r
944 from the location of the sources, the aliases and directory names
\r
945 from the Fontname distribution are used. (*note Introduction:
\r
949 Let mktexpk and mktextfm create metafont driver files in a
\r
950 temporary directory. These will be used for just one metafont run
\r
951 and not installed permanently.
\r
954 Omit the directory level for the mode name; this is fine as long as
\r
955 you generate fonts for only one mode.
\r
958 Omit the font supplier name directory level.
\r
961 Omit the font typeface name directory level.
\r
964 Omit the font supplier and typeface name directory levels. This
\r
965 feature is deprecated in favour of 'stripsupplier' and
\r
969 When this option is enabled, fonts that would otherwise be written
\r
970 in system texmf tree go to the 'VARTEXFONTS' tree instead. The
\r
971 default value in 'kpathsea/Makefile.in' is '/var/tmp/texfonts'.
\r
972 The 'Linux File System Standard' recommends '/var/tex/fonts'.
\r
974 The 'varfonts' setting in 'MT_FEATURES' is overridden by the
\r
975 'USE_VARTEXFONTS' environment variable: if set to '1', the feature
\r
976 is enabled, and if set to '0', the feature is disabled.
\r
979 Force generated files that would go into a system tree (as defined
\r
980 by 'SYSTEXMF') into 'TEXMFVAR'. Starting with teTeX-3.0, the
\r
981 variable 'TEXMFVAR' is always set. The 'varfonts' feature takes
\r
982 precedence if also set.
\r
984 The 'texmfvar' setting in 'MT_FEATURES' is overridden by the
\r
985 'USE_TEXMFVAR' environment variable: if set to '1', the feature is
\r
986 enabled, and if set to '0', the feature is disabled.
\r
989 File: kpathsea.info, Node: mktex script names, Next: mktex script arguments, Prev: mktex configuration, Up: mktex scripts
\r
991 2.2.9.2 'mktex' script names
\r
992 ............................
\r
994 The following table shows the default name of the script for each of the
\r
995 file types which support runtime generation.
\r
998 ('.fmt', '.base', '.mem') TeX/Metafont/MetaPost formats. This
\r
999 script is also named 'fmtutil', and reads 'fmtutil.cnf' for
\r
1000 configuration information.
\r
1003 ('.mf') Metafont input files.
\r
1006 ('.ocp') Omega compiled process files.
\r
1009 ('.ofm') Omega font metric files.
\r
1012 ('pk') Glyph fonts.
\r
1015 ('.tex') TeX input files (disabled by default).
\r
1018 ('.tfm') TFM files.
\r
1020 These names can be overridden by an environment variable specific to the
\r
1021 program--for example, 'DVIPSMAKEPK' for Dvipsk.
\r
1023 If a 'mktex...' script fails, the invocation is appended to a file
\r
1024 'missfont.log' (by default) in the current directory. You can then
\r
1025 execute the log file to create the missing files after fixing the
\r
1028 If the current directory is not writable and the environment variable
\r
1029 or configuration file value 'TEXMFOUTPUT' is set, its value is used.
\r
1030 Otherwise, nothing is written. The name 'missfont.log' is overridden by
\r
1031 the 'MISSFONT_LOG' environment variable or configuration file value.
\r
1034 File: kpathsea.info, Node: mktex script arguments, Prev: mktex script names, Up: mktex scripts
\r
1036 2.2.9.3 'mktex' script arguments
\r
1037 ................................
\r
1039 The first argument to a 'mktex' script is always the name of the file to
\r
1042 In the default 'mktexpk' implementation, additional arguments may
\r
1046 Sets the resolution of the generated font to NUM.
\r
1048 Sets the Metafont mode to NAME.
\r
1050 Sets the "base dpi" for the font. This must match the mode being
\r
1053 A "magstep" string suitable for the Metafont 'mag' variable. This
\r
1054 must match the combination of BDPI and DPI being used.
\r
1055 '--destdir STRING'
\r
1056 A directory name. If the directory is absolute, it is used as-is.
\r
1057 Otherwise, it is appended to the root destination directory set in
\r
1061 File: kpathsea.info, Node: Installation testing, Prev: mktex scripts, Up: Custom installation
\r
1063 2.2.10 Installation testing
\r
1064 ---------------------------
\r
1066 Besides the tests listed in *note Simple installation::, you can try
\r
1067 running 'make check'. This includes the torture tests (trip, trap, and
\r
1068 mptrap) that come with Web2c (*note (web2c)Triptrap::).
\r
1071 File: kpathsea.info, Node: Security, Next: TeX directory structure, Prev: Custom installation, Up: Installation
\r
1076 None of the programs in the TeX system require any special system
\r
1077 privileges, so there's no first-level security concern of people gaining
\r
1078 illegitimate root access.
\r
1080 A TeX document, however, can write to arbitrary files, e.g.,
\r
1081 '~/.rhosts', and thus an unwitting user who runs TeX on a random
\r
1082 document is vulnerable to a trojan horse attack. This loophole is
\r
1083 closed by default, but you can be permissive if you so desire in
\r
1084 'texmf.cnf'. *Note (web2c)tex invocation::. MetaPost has the same
\r
1087 Dvips, Xdvi, and TeX can also execute shell commands under some
\r
1088 circumstances. To disable this, see the '-R' option in *note
\r
1089 (dvips)Option details::, the xdvi man page, and *note (web2c)tex
\r
1090 invocation::, respectively.
\r
1092 Another security issue arises because it's very useful--almost
\r
1093 necessary--to make arbitrary fonts on user demand with 'mktexpk' and
\r
1094 friends. Where do these files get installed? By default, the 'mktexpk'
\r
1095 distributed with Kpathsea assumes a world-writable '/var/tmp' directory;
\r
1096 this is a simple and convenient approach, but it may not suit your
\r
1097 situation because it means that a local cache of fonts is created on
\r
1100 To avoid this duplication, many people consider a shared, globally
\r
1101 writable font tree desirable, in spite of the potential security
\r
1102 problems. To do this you should change the value of 'VARTEXFONTS' in
\r
1103 'texmf.cnf' to refer to some globally known directory. *Note mktex
\r
1106 The first restriction you can apply is to make newly-created
\r
1107 directories under 'texmf' be append-only with an option in 'mktex.cnf'.
\r
1108 *Note mktex configuration::.
\r
1110 Another approach is to establish a group (or user) for TeX files,
\r
1111 make the 'texmf' tree writable only to that group (or user), and make
\r
1112 'mktexpk' et al. setgid to that group (or setuid to that user). Then
\r
1113 users must invoke the scripts to install things. (If you're worried
\r
1114 about the inevitable security holes in scripts, then you could write a C
\r
1115 wrapper to exec the script.)
\r
1117 The 'mktex...' scripts install files with the same read and write
\r
1118 permissions as the directory they are installed in. The executable,
\r
1119 sgid, suid, and sticky bits are always cleared.
\r
1121 Any directories created by the 'mktex...' scripts have the same
\r
1122 permissions as their parent directory, unless the 'appendonlydir'
\r
1123 feature is used, in which case the sticky bit is always set.
\r
1126 File: kpathsea.info, Node: TeX directory structure, Next: unixtex.ftp, Prev: Security, Up: Installation
\r
1128 2.4 TeX directory structure
\r
1129 ===========================
\r
1131 This section describes the default installation hierarchy of the
\r
1132 distribution. It conforms to both the GNU coding standards and the TeX
\r
1133 directory structure (TDS) standard. For rationale and further
\r
1134 explanation, please see those documents. The GNU standard is available
\r
1135 as <ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi> and mirrors.
\r
1136 The TDS document is available from 'CTAN:/tex-archive/tds' (*note
\r
1139 You can change the default paths in many ways (*note Changing search
\r
1140 paths::). One common desire is to put everything (binaries and all)
\r
1141 under a single top-level directory such as '/usr/local/texmf' or
\r
1142 '/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
\r
1143 For specific instructions on doing that, see *note configure
\r
1146 Here is a skeleton of the default directory structure, extracted from
\r
1149 PREFIX/ installation root ('/usr/local' by default)
\r
1152 include/ C header files
\r
1153 info/ GNU info files
\r
1154 lib/ libraries ('libkpathsea.*')
\r
1155 share/ architecture-independent files
\r
1157 bibtex/ BibTeX input files
\r
1158 bib/ BibTeX databases
\r
1159 base/ base distribution (e.g., 'xampl.bib')
\r
1160 misc/ single-file databases
\r
1161 PKG/ name of a package
\r
1162 bst/ BibTeX style files
\r
1163 base/ base distribution (e.g., 'plain.bst', 'acm.bst')
\r
1164 misc/ single-file styles
\r
1165 PKG/ name of a package
\r
1166 doc/ additional documentation
\r
1167 dvips/ '.pro', '.ps', 'psfonts.map'
\r
1168 fonts/ font-related files
\r
1169 TYPE/ file type (e.g., 'tfm', 'pk')
\r
1170 MODE/ type of output device (types 'pk' and 'gf' only)
\r
1171 SUPPLIER/ name of a font supplier (e.g., 'public')
\r
1172 TYPEFACE/ name of a typeface (e.g., 'cm')
\r
1173 dpiNNN/ font resolution (types 'pk' and 'gf' only)
\r
1174 metafont/ Metafont (non-font) input files
\r
1175 base/ base distribution (e.g., 'plain.mf')
\r
1176 misc/ single-file packages (e.g., 'modes.mf')
\r
1177 PKG/ name of a package (e.g., 'mfpic')
\r
1178 metapost/ MetaPost input files
\r
1179 base/ base distribution (e.g., 'plain.mp')
\r
1180 misc/ single-file packages
\r
1181 PKG/ name of a package
\r
1182 support/ support files for MetaPost-related utilities (e.g., 'trfonts.map')
\r
1183 mft/ 'MFT' inputs (e.g., 'plain.mft')
\r
1184 tex/ TeX input files
\r
1185 FORMAT/ name of a format (e.g., 'plain')
\r
1186 base/ base distribution for FORMAT (e.g., 'plain.tex')
\r
1187 misc/ single-file packages (e.g., 'webmac.tex')
\r
1188 local/ local additions to or local configuration files for FORMAT
\r
1189 PKG/ name of a package (e.g., 'graphics', 'mfnfss')
\r
1190 generic/ format-independent packages
\r
1191 hyphen/ hyphenation patterns (e.g., 'hyphen.tex')
\r
1192 images/ image input files (e.g., Encapsulated PostScript)
\r
1193 misc/ single-file format-independent packages (e.g., 'null.tex').
\r
1194 PKG/ name of a package (e.g., 'babel')
\r
1195 web2c/ implementation-dependent files ('.pool', '.fmt', 'texmf.cnf', etc.)
\r
1197 Some concrete examples for most file types:
\r
1199 /usr/local/bin/tex
\r
1200 /usr/local/man/man1/xdvi.1
\r
1201 /usr/local/info/kpathsea.info
\r
1202 /usr/local/lib/libkpathsea.a
\r
1203 /usr/local/share/texmf/bibtex/bst/base/plain.bst
\r
1204 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
\r
1205 /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
\r
1206 /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
\r
1207 /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
\r
1208 /usr/local/share/texmf/metafont/base/plain.mf
\r
1209 /usr/local/share/texmf/metapost/base/plain.mp
\r
1210 /usr/local/share/texmf/tex/plain/base/plain.tex
\r
1211 /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
\r
1212 /usr/local/share/texmf/web2c/tex.pool
\r
1213 /usr/local/share/texmf/web2c/tex.fmt
\r
1214 /usr/local/share/texmf/web2c/texmf.cnf
\r
1217 File: kpathsea.info, Node: unixtex.ftp, Next: Reporting bugs, Prev: TeX directory structure, Up: Installation
\r
1219 2.5 'unixtex.ftp': Obtaining TeX
\r
1220 ================================
\r
1222 This is <ftp://ftp.tug.org/tex/unixtex.ftp>, last updated 13 June 2010.
\r
1223 Also available as <http://www.tug.org/unixtex.ftp>. Email
\r
1224 <tex-k@tug.org> with comments or questions.
\r
1226 The principal free TeX distribution for Unix-like systems is TeX
\r
1227 Live, on the web at <http://tug.org/texlive>. The pages there describe
\r
1228 many ways to acquire TeX, over the Internet or on physical media, both
\r
1229 the sources and precompiled binaries for many systems, either standalone
\r
1230 or as part of various operating system distributions.
\r
1232 Web2C, Kpathsea, Dvips, and Dviljk are no longer released as a
\r
1233 separate packages. Their sources are now maintained as part of TeX
\r
1236 The host ftp.cs.stanford.edu is the original source for the files for
\r
1237 which Donald Knuth is directly responsible: 'tex.web', 'plain.tex', etc.
\r
1238 However, unless you want to build your TeX library tree ab initio, it is
\r
1239 more reliable and less work to retrieve these files as part of a larger
\r
1240 package. In any case, that ftp site is not the canonical source for
\r
1241 anything except what was created as part of Stanford TeX project, so do
\r
1242 not rely on the other files available there being up-to-date.
\r
1245 File: kpathsea.info, Node: Reporting bugs, Prev: unixtex.ftp, Up: Installation
\r
1247 2.6 Reporting bugs
\r
1248 ==================
\r
1250 (A copy of this chapter is in the file 'kpathsea/BUGS'.)
\r
1252 If you have problems or suggestions, please report them to
\r
1253 <tex-k@tug.org> using the bug checklist below.
\r
1255 Please report bugs in the documentation; not only factual errors or
\r
1256 inconsistent behavior, but unclear or incomplete explanations, typos,
\r
1261 * Bug checklist:: What to include in a good bug report.
\r
1262 * Mailing lists:: Joining the bugs or announcements mailing lists.
\r
1263 * Debugging:: Analyzing runtime problems.
\r
1264 * Logging:: Recording searches.
\r
1265 * Common problems:: When things go wrong.
\r
1268 File: kpathsea.info, Node: Bug checklist, Next: Mailing lists, Up: Reporting bugs
\r
1270 2.6.1 Bug checklist
\r
1271 -------------------
\r
1273 Before reporting a bug, please check below to be sure it isn't already
\r
1274 known (*note Common problems::).
\r
1276 Bug reports should be sent via electronic mail to <tex-k@tug.org>.
\r
1278 The general principle is that a good bug report includes all the
\r
1279 information necessary for reproduction. Therefore, to enable
\r
1280 investigation, your report should include the following:
\r
1282 * The version number(s) of the program(s) involved, and of Kpathsea
\r
1283 itself. You can get the former by giving a sole option '--version'
\r
1284 to the program, and the latter by running 'kpsewhich --version'.
\r
1285 The 'NEWS' and 'ChangeLog' files also contain the version number.
\r
1287 * The hardware, operating system (including version number),
\r
1288 compiler, and 'make' program you are using (the output of 'uname
\r
1289 -a' is a start on the first two, though often incomplete). If the
\r
1290 bug involves the X window system, include X version and supplier
\r
1291 information as well (examples: X11R6 from MIT; X11R4 from HP;
\r
1292 OpenWindows 3.3 bundled with SunOS 4.1.4).
\r
1294 * Any options you gave to 'configure'. This is recorded in the
\r
1295 'config.status' files.
\r
1297 If you are reporting a bug in 'configure' itself, it's probably
\r
1298 system-dependent, and it will be unlikely the maintainers can do
\r
1299 anything useful if you merely report that thus-and-such is broken.
\r
1300 Therefore, you need to do some additional work: for some bugs, you
\r
1301 can look in the file 'config.log' where the test that failed should
\r
1302 appear, along with the compiler invocation and source program in
\r
1303 question. You can then compile it yourself by hand, and discover
\r
1304 why the test failed. Other 'configure' bugs do not involve the
\r
1305 compiler; in that case, the only recourse is to inspect the
\r
1306 'configure' shell script itself, or the Autoconf macros that
\r
1307 generated 'configure'.
\r
1309 * The log of all debugging output, if the bug is in path searching.
\r
1310 You can get this by setting the environment variable
\r
1311 'KPATHSEA_DEBUG' to '-1' before running the program. Please look
\r
1312 at the log yourself to make sure the behavior is really a bug
\r
1313 before reporting it; perhaps "old" environment variable settings
\r
1314 are causing files not to be found, for example.
\r
1316 * The contents of any input files necessary to reproduce the bug.
\r
1317 For bugs in DVI-reading programs, for example, this generally means
\r
1318 a DVI file (and any EPS or other files it uses)--TeX source files
\r
1319 are helpful, but the DVI file is necessary, because that's the
\r
1320 actual program input.
\r
1322 * If you are sending a patch (do so if you can!), please do so in the
\r
1323 form of a context diff ('diff -c') against the original
\r
1324 distribution source. Any other form of diff is either not as
\r
1325 complete or harder for me to understand. Please also include a
\r
1326 'ChangeLog' entry.
\r
1328 * If the bug involved is an actual crash (i.e., core dump), it is
\r
1329 easy and useful to include a stack trace from a debugger (I
\r
1330 recommend the GNU debugger GDB, available from
\r
1331 <ftp://prep.ai.mit.edu/pub/gnu>). If the cause is apparent (a
\r
1332 'NULL' value being dereferenced, for example), please send the
\r
1333 details along. If the program involved is TeX or Metafont, and the
\r
1334 crash is happening at apparently-sound code, however, the bug may
\r
1335 well be in the compiler, rather than in the program or the library
\r
1336 (*note TeX or Metafont failing: TeX or Metafont failing.).
\r
1338 * Any additional information that will be helpful in reproducing,
\r
1339 diagnosing, or fixing the bug.
\r
1342 File: kpathsea.info, Node: Mailing lists, Next: Debugging, Prev: Bug checklist, Up: Reporting bugs
\r
1344 2.6.2 Mailing lists
\r
1345 -------------------
\r
1347 Web2c and Kpathsea in general are discussed on the mailing list
\r
1348 <tex-k@tug.org>. To join, email <tex-k-request@tug.org> with a line
\r
1351 subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
\r
1353 in the body of the message.
\r
1355 You do not need to join to submit a report, nor will it affect
\r
1356 whether you get a response. There is no Usenet newsgroup equivalent (if
\r
1357 you can be the one to set this up, email 'tex-k-request'). Traffic on
\r
1358 the list is fairly light, and is mainly bug reports and enhancement
\r
1359 requests to the software. The best way to decide if you want to join or
\r
1360 not is read some of the archives from
\r
1361 <ftp://ftp.tug.org/mail/archives/tex-k/>.
\r
1363 Be aware that large data files are sometimes included in bug reports.
\r
1364 If this is a problem for you, do not join the list.
\r
1366 If you are looking for general TeX help, such as how to use LaTeX,
\r
1367 please use the mailing list <texhax@tug.org> mailing list
\r
1368 (<http://lists.tug.org/texhax>) which is gatewayed to the
\r
1369 'comp.text.tex' Usenet newsgroup (or post to the newsgroup; the gateway
\r
1370 is bidirectional).
\r
1373 File: kpathsea.info, Node: Debugging, Next: Logging, Prev: Mailing lists, Up: Reporting bugs
\r
1378 Kpathsea provides a number of runtime debugging options, detailed below
\r
1379 by their names and corresponding numeric values. When the files you
\r
1380 expect aren't being found, the thing to do is enable these options and
\r
1381 examine the output.
\r
1383 You can set these with some runtime argument (e.g., '-d') to the
\r
1384 program; in that case, you should use the numeric values described in
\r
1385 the program's documentation (which, for Dvipsk and Xdvik, are different
\r
1386 than those below). It's best to give the '-d' (or whatever) option
\r
1387 first, for maximal output. Dvipsk and Xdvik have additional
\r
1388 program-specific debugging options as well.
\r
1390 You can also set the environment variable 'KPATHSEA_DEBUG'; in this
\r
1391 case, you should use the numbers below. If you run the program under a
\r
1392 debugger and set the instance variable 'kpse->debug', also use the
\r
1395 In any case, by far the simplest value to use is '-1', which will
\r
1396 turn on all debugging output. This is usually better than guessing
\r
1397 which particular values will yield the output you need.
\r
1399 Debugging output always goes to standard error, so you can redirect
\r
1400 it easily. For example, in Bourne-compatible shells:
\r
1401 dvips -d -1 ... 2>/tmp/debug
\r
1403 It is sometimes helpful to run the standalone Kpsewhich utility
\r
1404 (*note Invoking kpsewhich::), instead of the original program.
\r
1406 In any case, you can _not_ use the _names_ below; you must always use
\r
1407 somebody's numbers. (Sorry.) To set more than one option, just sum the
\r
1408 corresponding numbers.
\r
1410 'KPSE_DEBUG_STAT (1)'
\r
1411 Report 'stat'(2) calls. This is useful for verifying that your
\r
1412 directory structure is not forcing Kpathsea to do many additional
\r
1413 file tests (*note Slow path searching::, and *note Subdirectory
\r
1414 expansion::). If you are using an up-to-date 'ls-R' database
\r
1415 (*note Filename database::), this should produce no output unless a
\r
1416 nonexistent file that must exist is searched for.
\r
1418 'KPSE_DEBUG_HASH (2)'
\r
1419 Report lookups in all hash tables: 'ls-R' and 'aliases' (*note
\r
1420 Filename database::); font aliases (*note Fontmap::); and config
\r
1421 file values (*note Config files::). Useful when expected values
\r
1422 are not being found, e.g.., file searches are looking at the disk
\r
1423 instead of using 'ls-R'.
\r
1425 'KPSE_DEBUG_FOPEN (4)'
\r
1426 Report file openings and closings. Especially useful when your
\r
1427 system's file table is full, for seeing which files have been
\r
1428 opened but never closed. In case you want to set breakpoints in a
\r
1429 debugger: this works by redefining 'fopen' ('fclose') to be
\r
1430 'kpse_fopen_trace' ('kpse_fclose_trace').
\r
1432 'KPSE_DEBUG_PATHS (8)'
\r
1433 Report general path information for each file type Kpathsea is
\r
1434 asked to search. This is useful when you are trying to track down
\r
1435 how a particular path got defined--from 'texmf.cnf', 'config.ps',
\r
1436 an environment variable, the compile-time default, etc. This is
\r
1437 the contents of the 'kpse_format_info_type' structure defined in
\r
1440 'KPSE_DEBUG_EXPAND (16)'
\r
1441 Report the directory list corresponding to each path element
\r
1442 Kpathsea searches. This is only relevant when Kpathsea searches
\r
1443 the disk, since 'ls-R' searches don't look through directory lists
\r
1446 'KPSE_DEBUG_SEARCH (32)'
\r
1447 Report on each file search: the name of the file searched for, the
\r
1448 path searched in, whether or not the file must exist (when drivers
\r
1449 search for 'cmr10.vf', it need not exist), and whether or not we
\r
1450 are collecting all occurrences of the file in the path (as with,
\r
1451 e.g., 'texmf.cnf' and 'texfonts.map'), or just the first (as with
\r
1452 most lookups). This can help you correlate what Kpathsea is doing
\r
1453 with what is in your input file.
\r
1455 'KPSE_DEBUG_VARS (64)'
\r
1456 Report the value of each variable Kpathsea looks up. This is
\r
1457 useful for verifying that variables do indeed obtain their correct
\r
1460 'GSFTOPK_DEBUG (128)'
\r
1461 Activates debugging printout specific to 'gsftopk' program.
\r
1463 'MAKETEX_DEBUG (512)'
\r
1464 If you use the optional 'mktex' programs instead of the traditional
\r
1465 shell scripts, this will report the name of the site file
\r
1466 ('mktex.cnf' by default) which is read, directories created by
\r
1467 'mktexdir', the full path of the 'ls-R' database built by
\r
1468 'mktexlsr', font map searches, 'MT_FEATURES' in effect, parameters
\r
1469 from 'mktexnam', filenames added by 'mktexupd', and some subsidiary
\r
1470 commands run by the programs.
\r
1472 'MAKETEX_FINE_DEBUG (1024)'
\r
1473 When the optional 'mktex' programs are used, this will print
\r
1474 additional debugging info from functions internal to these
\r
1477 Debugging output from Kpathsea is always written to standard error,
\r
1478 and begins with the string 'kdebug:'. (Except for hash table buckets,
\r
1479 which just start with the number, but you can only get that output
\r
1480 running under a debugger. See comments at the 'hash_summary_only'
\r
1481 variable in 'kpathsea/db.c'.)
\r
1484 File: kpathsea.info, Node: Logging, Next: Common problems, Prev: Debugging, Up: Reporting bugs
\r
1489 Kpathsea can record the time and filename found for each successful
\r
1490 search. This may be useful in finding good candidates for deletion when
\r
1491 your filesystem is full, or in discovering usage patterns at your site.
\r
1493 To do this, define the environment or config file variable
\r
1494 'TEXMFLOG'. The value is the name of the file to append the information
\r
1495 to. The file is created if it doesn't exist, and appended to if it
\r
1498 Each successful search turns into one line in the log file: two words
\r
1499 separated by a space. The first word is the time of the search, as the
\r
1500 integer number of seconds since "the epoch", i.e., UTC midnight 1
\r
1501 January 1970 (more precisely, the result of the 'time' system call).
\r
1502 The second word is the filename.
\r
1504 For example, after 'setenv TEXMFLOG /tmp/log', running Dvips on
\r
1505 'story.dvi' appends the following lines:
\r
1507 774455887 /usr/local/share/texmf/dvips/config.ps
\r
1508 774455887 /usr/local/share/texmf/dvips/psfonts.map
\r
1509 774455888 /usr/local/share/texmf/dvips/texc.pro
\r
1510 774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
\r
1511 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
\r
1512 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
\r
1513 774455889 /usr/local/share/texmf/dvips/texc.pro
\r
1515 Only filenames that are absolute are recorded, to preserve some
\r
1516 semblance of privacy.
\r
1518 In addition to this Kpathsea-specific logging, 'pdftex' provides an
\r
1519 option '-recorder' to write the names of all files accessed during a run
\r
1520 to the file 'BASEFILE.fls'.
\r
1522 Finally, most systems provide a general tool to output each system
\r
1523 call, thus including opening and closing files. It might be named
\r
1524 'strace', 'truss', 'struss', or something else.
\r
1527 File: kpathsea.info, Node: Common problems, Prev: Logging, Up: Reporting bugs
\r
1529 2.6.5 Common problems
\r
1530 ---------------------
\r
1532 Here are some common problems with configuration, compilation, linking,
\r
1537 * Unable to find files:: If your program can't find fonts (or whatever).
\r
1538 * Slow path searching:: If it takes forever to find anything.
\r
1539 * Unable to generate fonts:: If mktexpk fails.
\r
1540 * TeX or Metafont failing:: Likely compiler bugs.
\r
1542 * Empty Makefiles:: When configure produces empty makefiles.
\r
1543 * XtStrings:: When _XtStrings is undefined.
\r
1544 * dlopen:: When dlopen is undefined.
\r
1545 * ShellWidgetClass:: For dynamic linking troubles under OpenWindows.
\r
1546 * Pointer combination warnings:: For old compilers that don't grok char *.
\r
1549 File: kpathsea.info, Node: Unable to find files, Next: Slow path searching, Up: Common problems
\r
1551 2.6.5.1 Unable to find files
\r
1552 ............................
\r
1554 If a program complains it cannot find fonts (or other input files), any
\r
1555 of several things might be wrong. In any case, you may find the
\r
1556 debugging options helpful. *Note Debugging::.
\r
1558 * Perhaps you simply haven't installed all the necessary files; the
\r
1559 basic fonts and input files are distributed separately from the
\r
1560 programs. *Note unixtex.ftp::.
\r
1562 * You have (perhaps unknowingly) told Kpathsea to use search paths
\r
1563 that don't reflect where the files actually are. One common cause
\r
1564 is having environment variables set from a previous installation,
\r
1565 thus overriding what you carefully set in 'texmf.cnf' (*note
\r
1566 Supported file formats::). System '/etc/profile' or other files
\r
1567 such may be the culprit.
\r
1569 * Your files reside in a directory that is only pointed to via a
\r
1570 symbolic link, in a leaf directory and is not listed in 'ls-R'.
\r
1572 Unfortunately, Kpathsea's subdirectory searching has an
\r
1573 irremediable deficiency: If a directory D being searched for
\r
1574 subdirectories contains plain files and symbolic links to other
\r
1575 directories, but no true subdirectories, D will be considered a
\r
1576 leaf directory, i.e., the symbolic links will not be followed.
\r
1577 *Note Subdirectory expansion::.
\r
1579 You can work around this problem by creating an empty dummy
\r
1580 subdirectory in D. Then D will no longer be a leaf, and the
\r
1581 symlinks will be followed.
\r
1583 The directory immediately followed by the '//' in the path
\r
1584 specification, however, is always searched for subdirectories, even
\r
1585 if it is a leaf. Presumably you would not have asked for the
\r
1586 directory to be searched for subdirectories if you didn't want it
\r
1589 * If the fonts (or whatever) don't already exist, 'mktexpk' (or
\r
1590 'mktexmf' or 'mktextfm') will try to create them. If these rather
\r
1591 complicated shell scripts fail, you'll eventually get an error
\r
1592 message saying something like 'Can't find font FONTNAME'. The best
\r
1593 solution is to fix (or at least report) the bug in 'mktexpk'; the
\r
1594 workaround is to generate the necessary fonts by hand with
\r
1595 Metafont, or to grab them from a CTAN site (*note unixtex.ftp::).
\r
1597 * There is a bug in the library. *Note Reporting bugs::.
\r
1600 File: kpathsea.info, Node: Slow path searching, Next: Unable to generate fonts, Prev: Unable to find files, Up: Common problems
\r
1602 2.6.5.2 Slow path searching
\r
1603 ...........................
\r
1605 If your program takes an excessively long time to find fonts or other
\r
1606 input files, but does eventually succeed, here are some possible
\r
1609 * Most likely, you just have a lot of directories to search, and that
\r
1610 takes a noticeable time. The solution is to create and maintain a
\r
1611 separate 'ls-R' file that lists all the files in your main TeX
\r
1612 hierarchy. *Note Filename database::. Kpathsea always uses 'ls-R'
\r
1613 if it's present; there's no need to recompile or reconfigure any of
\r
1616 * Your recursively-searched directories (e.g.,
\r
1617 '/usr/local/share/texmf/fonts//'), contain a mixture of files and
\r
1618 directories. This prevents Kpathsea from using a useful
\r
1619 optimization (*note Subdirectory expansion::).
\r
1621 It is best to have only directories (and perhaps a 'README') in the
\r
1622 upper levels of the directory structure, and it's very important to
\r
1623 have _only_ files, and no subdirectories, in the leaf directories
\r
1624 where the dozens of TFM, PK, or whatever files reside.
\r
1626 In any case, you may find the debugging options helpful in
\r
1627 determining precisely when the disk or network is being pounded. *Note
\r
1631 File: kpathsea.info, Node: Unable to generate fonts, Next: TeX or Metafont failing, Prev: Slow path searching, Up: Common problems
\r
1633 2.6.5.3 Unable to generate fonts
\r
1634 ................................
\r
1636 Metafont outputs fonts in bitmap format, tuned for a particular device
\r
1637 at a particular resolution, in order to allow for the highest-possible
\r
1638 quality of output. Some DVI-to-whatever programs, such as Dvips, try to
\r
1639 generate these on the fly when they are needed, but this generation may
\r
1640 fail in several cases.
\r
1642 If 'mktexpk' runs, but fails with this error:
\r
1643 mktexpk: Can't guess mode for NNN dpi devices.
\r
1644 mktexpk: Use a config file to specify the mode, or update me.
\r
1645 you need to ensure the resolution and mode match; just specifying the
\r
1646 resolution, as in '-D 360', is not enough.
\r
1648 You can specify the mode name with the '-mode' option on the Dvips
\r
1649 command line, or in a Dvips configuration file (*note (dvips)Config
\r
1650 files::), such as 'config.ps' in your document directory, '~/.dvipsrc'
\r
1651 in your home directory, or in a system directory (again named
\r
1652 'config.ps'). (Other drivers use other files, naturally.)
\r
1654 For example, if you need 360dpi fonts, you could include this in a
\r
1655 configuration file:
\r
1659 If Metafont runs, but generates fonts at the wrong resolution or for
\r
1660 the wrong device, most likely 'mktexpk''s built-in guess for the mode is
\r
1661 wrong, and you should override it as above.
\r
1663 See <ftp://ftp.tug.org/tex/modes.mf> for a list of resolutions and
\r
1664 mode names for most devices (additional submissions are welcome).
\r
1666 If Metafont runs but generates fonts at a resolution of 2602dpi (and
\r
1667 prints out the name of each character as well as just a character
\r
1668 number, and maybe tries to display the characters), then your Metafont
\r
1669 base file probably hasn't been made properly. (It's using the default
\r
1670 'proof' mode, instead of an actual device mode.) To make a proper
\r
1671 'plain.base', assuming the local mode definitions are contained in a
\r
1672 file 'modes.mf', run the following command (assuming Unix):
\r
1674 inimf "plain; input modes; dump"
\r
1676 Then copy the 'plain.base' file from the current directory to where the
\r
1677 base files are stored on your system ('/usr/local/share/texmf/web2c' by
\r
1678 default), and make a link (either hard or soft) from 'plain.base' to
\r
1679 'mf.base' in that directory. *Note (web2c)inimf invocation::.
\r
1681 If 'mf' is a command not found at all by 'mktexpk', then you need to
\r
1682 install Metafont (*note unixtex.ftp::).
\r
1685 File: kpathsea.info, Node: TeX or Metafont failing, Next: Empty Makefiles, Prev: Unable to generate fonts, Up: Common problems
\r
1687 2.6.5.4 TeX or Metafont failing
\r
1688 ...............................
\r
1690 If TeX or Metafont get a segmentation fault or otherwise fail while
\r
1691 running a normal input file, the problem is usually a compiler bug
\r
1692 (unlikely as that may sound). Even if the trip and trap tests are
\r
1693 passed, problems may lurk. Optimization occasionally causes trouble in
\r
1694 programs other than TeX and Metafont themselves, too.
\r
1696 Insufficient swap space may also cause core dumps or other erratic
\r
1699 For a workaround, if you enabled any optimization flags, it's best to
\r
1700 omit optimization entirely. In any case, the way to find the facts is
\r
1701 to run the program under the debugger and see where it's failing.
\r
1703 Also, if you have trouble with a system C compiler, I advise trying
\r
1704 the GNU C compiler. And vice versa, unfortunately; but in that case I
\r
1705 also recommend reporting a bug to the GCC mailing list; see *note
\r
1708 To report compiler bugs effectively requires perseverance and
\r
1709 perspicacity: you must find the miscompiled line, and that usually
\r
1710 involves delving backwards in time from the point of error, checking
\r
1711 through TeX's (or whatever program's) data structures. Things are not
\r
1712 helped by all-too-common bugs in the debugger itself. Good luck.
\r
1714 One known cause of trouble is the way arrays are handled. Some of
\r
1715 the Pascal arrays have a lower index other than 0, and the C code will
\r
1716 take the pointer to the allocated memory, subtract the lower index, and
\r
1717 use the resulting pointer for the array. While this trick often works,
\r
1718 ANSI C doesn't guarantee that it will. It it known to fail on HP-UX 10
\r
1719 machines when the native compiler is used, unless the '+u' compiler
\r
1720 switch was specified. Using GCC will work on this platform as well.
\r
1723 File: kpathsea.info, Node: Empty Makefiles, Next: XtStrings, Prev: TeX or Metafont failing, Up: Common problems
\r
1725 2.6.5.5 Empty Makefiles
\r
1726 .......................
\r
1728 On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), 'configure' may
\r
1729 fail to properly create the Makefiles. Instead, you get an error which
\r
1730 looks something like this:
\r
1732 prompt$ ./configure
\r
1735 sed: 1: "\\@^ac_include make/pat ...": \ can not
\r
1736 be used as a string delimiter
\r
1738 So far as I know, the bug here is in '/bin/sh' on these systems. I
\r
1739 don't have access to a machine running any of them, so if someone can
\r
1740 find a workaround that avoids the quoting bug, I'd be most grateful.
\r
1741 (Search for 'ac_include' in the 'configure' script to get to the
\r
1742 problematic code.)
\r
1744 It should work to run 'bash configure', instead of using '/bin/sh'.
\r
1745 You can get Bash from <ftp://prep.ai.mit.edu/pub/gnu> and mirrors.
\r
1747 Another possible cause (reported for NeXT) is a bug in the 'sed'
\r
1748 command. In that case the error may look like this:
\r
1750 Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
\r
1752 In this case, installing GNU 'sed' should solve the problem. You can
\r
1753 get GNU 'sed' from the same places as Bash.
\r
1756 File: kpathsea.info, Node: XtStrings, Next: dlopen, Prev: Empty Makefiles, Up: Common problems
\r
1758 2.6.5.6 'XtStrings'
\r
1759 ...................
\r
1761 You may find that linking X programs results in an error from the linker
\r
1762 that 'XtStrings' is undefined, something like this:
\r
1765 .../x11.c:130: undefined reference to `XtStrings'
\r
1767 This generally happens because of a mismatch between the X include
\r
1768 files with which you compiled and the X libraries with which you linked;
\r
1769 often, the include files are from MIT and the libraries from Sun.
\r
1771 The solution is to use the same X distribution for compilation and
\r
1772 linking. Probably 'configure' was unable to guess the proper
\r
1773 directories from your installation. You can use the 'configure' options
\r
1774 '--x-includes=PATH' and '--x-libraries=PATH' to explicitly specify them.
\r
1777 File: kpathsea.info, Node: dlopen, Next: ShellWidgetClass, Prev: XtStrings, Up: Common problems
\r
1782 (This section adapted from the file 'dlsym.c' in the X distribution.)
\r
1784 The 'Xlib' library uses the standard C function 'wcstombs'. Under
\r
1785 SunOS 4.1, 'wcstombs' uses the 'dlsym' interface defined in 'libdl.so'.
\r
1786 Unfortunately, the SunOS 4.1 distribution does not include a static
\r
1787 'libdl.a' library.
\r
1789 As a result, if you try to link an X program statically under SunOS,
\r
1790 you may get undefined references to 'dlopen', 'dlsym', and 'dlclose'.
\r
1791 One workaround is to include these definitions when you link:
\r
1793 void *dlopen() { return 0; }
\r
1794 void *dlsym() { return 0; }
\r
1795 int dlclose() { return -1; }
\r
1797 These are contained in the 'dlsym.c' file in the MIT X distribution.
\r
1800 File: kpathsea.info, Node: ShellWidgetClass, Next: Pointer combination warnings, Prev: dlopen, Up: Common problems
\r
1802 2.6.5.8 'ShellWidgetClass'
\r
1803 ..........................
\r
1805 (This section adapted from the comp.sys.sun.admin FAQ.)
\r
1807 If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
\r
1808 you may get undefined symbols '_get_wmShellWidgetClass' and
\r
1809 '_get_applicationShellWidgetClass' when linking. This problem does not
\r
1810 arise using the standard MIT X libraries under SunOS.
\r
1812 The cause is bugs in the 'Xmu' shared library as shipped from Sun.
\r
1813 There are several fixes:
\r
1815 * Install the free MIT distribution from 'ftp.x.org' and mirrors.
\r
1817 * Get the OpenWindows patches listed below.
\r
1819 * Statically link the 'Xmu' library into the executable.
\r
1821 * Avoid using 'Xmu' at all. If you are compiling Metafont, see *note
\r
1822 (web2c)Online Metafont graphics::. If you are compiling Xdvi, see
\r
1823 the '-DNOTOOL' option in 'xdvik/INSTALL'.
\r
1825 * Ignore the errors. The binary runs fine regardless.
\r
1827 Here is the information for getting the two patches:
\r
1829 Patch ID: 100512-02
\r
1830 Bug ID's: 1086793, 1086912, 1074766
\r
1831 Description: 4.1.x OpenWindows 3.0 'libXt' jumbo patch
\r
1833 Patch ID: 100573-03
\r
1835 Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared 'libXmu'.
\r
1837 The way to statically link with 'libXmu' depends on whether you are
\r
1838 using a Sun compiler (e.g., 'cc') or 'gcc'. If the latter, alter the
\r
1839 'x_libs' Make variable to include
\r
1841 -static -lXmu -dynamic
\r
1843 If you are using the Sun compiler, use '-Bstatic' and '-Bdynamic'.
\r
1846 File: kpathsea.info, Node: Pointer combination warnings, Prev: ShellWidgetClass, Up: Common problems
\r
1848 2.6.5.9 Pointer combination warnings
\r
1849 ....................................
\r
1851 When compiling with old C compilers, you may get some warnings about
\r
1852 "illegal pointer combinations". These are spurious; just ignore them.
\r
1853 I decline to clutter up the source with casts to get rid of them.
\r
1856 File: kpathsea.info, Node: Path searching, Next: TeX support, Prev: Installation, Up: Top
\r
1861 This chapter describes the generic path searching mechanism Kpathsea
\r
1862 provides. For information about searching for particular file types
\r
1863 (e.g., TeX fonts), see the next chapter.
\r
1867 * Searching overview:: Basic scheme for searching.
\r
1868 * Path sources:: Where search paths can be defined.
\r
1869 * Path expansion:: Special constructs in search paths.
\r
1870 * Filename database:: Using an externally-built list to search.
\r
1871 * Invoking kpsewhich:: Standalone path lookup.
\r
1874 File: kpathsea.info, Node: Searching overview, Next: Path sources, Up: Path searching
\r
1876 3.1 Searching overview
\r
1877 ======================
\r
1879 A "search path" is a colon-separated list of "path elements", which are
\r
1880 directory names with a few extra frills. A search path can come from (a
\r
1881 combination of) many sources; see below. To look up a file 'foo' along
\r
1882 a path '.:/dir', Kpathsea checks each element of the path in turn: first
\r
1883 './foo', then '/dir/foo', returning the first match (or possibly all
\r
1886 The "colon" and "slash" mentioned here aren't necessarily ':' and '/'
\r
1887 on non-Unix systems. Kpathsea tries to adapt to other operating
\r
1888 systems' conventions.
\r
1890 To check a particular path element E, Kpathsea first sees if a
\r
1891 prebuilt database (*note Filename database::) applies to E, i.e., if the
\r
1892 database is in a directory that is a prefix of E. If so, the path
\r
1893 specification is matched against the contents of the database.
\r
1895 If the database does not exist, or does not apply to this path
\r
1896 element, or contains no matches, the filesystem is searched (if this was
\r
1897 not forbidden by the specification with '!!' and if the file being
\r
1898 searched for must exist). Kpathsea constructs the list of directories
\r
1899 that correspond to this path element, and then checks in each for the
\r
1900 file being searched for. (To help speed future lookups of files in the
\r
1901 same directory, the directory in which a file is found is floated to the
\r
1902 top of the directory list.)
\r
1904 The "file must exist" condition comes into play with VF files and
\r
1905 input files read by the TeX '\openin' command. These files might very
\r
1906 well not exist (consider 'cmr10.vf'), and so it would be wrong to search
\r
1907 the disk for them. Therefore, if you fail to update 'ls-R' when you
\r
1908 install a new VF file, it will not be found.
\r
1910 Each path element is checked in turn: first the database, then the
\r
1911 disk. If a match is found, the search stops and the result is returned.
\r
1912 This avoids possibly-expensive processing of path specifications that
\r
1913 are never needed on a particular run. (Unless the search explicitly
\r
1914 requested all matches.)
\r
1916 Although the simplest and most common path element is a directory
\r
1917 name, Kpathsea supports additional features in search paths: layered
\r
1918 default values, environment variable names, config file values, users'
\r
1919 home directories, and recursive subdirectory searching. Thus, we say
\r
1920 that Kpathsea "expands" a path element, meaning transforming all the
\r
1921 magic specifications into the basic directory name or names. This
\r
1922 process is described in the sections below. It happens in the same
\r
1923 order as the sections.
\r
1925 Exception to all of the above: If the filename being searched for is
\r
1926 absolute or explicitly relative, i.e., starts with '/' or './' or '../',
\r
1927 Kpathsea simply checks if that file exists.
\r
1929 Ordinarily, if Kpathsea tries to access a file or directory that
\r
1930 cannot be read, it gives a warning. This is so you will be alerted to
\r
1931 directories or files that accidentally lack any read permission (for
\r
1932 example, a 'lost+found' directory). If you prefer not to see these
\r
1933 warnings, include the value 'readable' in the 'TEX_HUSH' environment
\r
1934 variable or config file value.
\r
1936 This generic path searching algorithm is implemented in
\r
1937 'kpathsea/pathsearch.c'. It is employed by a higher-level algorithm
\r
1938 when searching for a file of a particular type (*note File lookup::, and
\r
1939 *note Glyph lookup::).
\r
1942 File: kpathsea.info, Node: Path sources, Next: Path expansion, Prev: Searching overview, Up: Path searching
\r
1947 A search path can come from many sources. In the order in which
\r
1948 Kpathsea uses them:
\r
1950 1. A user-set environment variable, e.g., 'TEXINPUTS'. Environment
\r
1951 variables with an underscore and the program name appended
\r
1952 override; for example, 'TEXINPUTS_latex' overrides 'TEXINPUTS' if
\r
1953 the program being run is named 'latex'.
\r
1955 2. A program-specific configuration file, e.g., an 'S /a:/b' line in
\r
1956 Dvips' 'config.ps' (*note (dvips)Config files::).
\r
1958 3. A line in a Kpathsea configuration file 'texmf.cnf', e.g.,
\r
1959 'TEXINPUTS=/c:/d' (see below).
\r
1961 4. The compile-time default (specified in 'kpathsea/paths.h').
\r
1963 You can see each of these values for a given search path by using the
\r
1964 debugging options (*note Debugging::).
\r
1966 These sources may be combined via default expansion (*note Default
\r
1971 * Config files:: Kpathsea's runtime config files (texmf.cnf).
\r
1974 File: kpathsea.info, Node: Config files, Up: Path sources
\r
1976 3.2.1 Config files
\r
1977 ------------------
\r
1979 As mentioned above, Kpathsea reads "runtime configuration files" named
\r
1980 'texmf.cnf' for search path and other definitions. The search path used
\r
1981 to look for these configuration files is named 'TEXMFCNF', and is
\r
1982 constructed in the usual way, as described above, except that
\r
1983 configuration files cannot be used to define the path, naturally; also,
\r
1984 an 'ls-R' database is not used to search for them.
\r
1986 Kpathsea reads _all_ 'texmf.cnf' files in the search path, not just
\r
1987 the first one found; definitions in earlier files override those in
\r
1988 later files. Thus, if the search path is '.:$TEXMF', values from
\r
1989 './texmf.cnf' override those from '$TEXMF/texmf.cnf'.
\r
1991 If Kpathsea cannot find any 'texmf.cnf' file, it reports a warning
\r
1992 including all the directories it checked. If you don't want to see this
\r
1993 warning, set the environment variable 'KPATHSEA_WARNING' to the single
\r
1994 character '0' (zero, not oh).
\r
1996 While (or instead of) reading this description, you may find it
\r
1997 helpful to look at the distributed 'texmf.cnf', which uses or at least
\r
1998 mentions most features. The format of 'texmf.cnf' files follows:
\r
2000 * Comments start with '%', either at the beginning of a line or
\r
2001 preceded by whitespace, and continue to the end of the line. That
\r
2002 is, as with most shells, a '%' in the "middle" of a value does not
\r
2003 start a comment. Examples:
\r
2005 % this is a comment
\r
2006 var = a%b % but the value of var will be "a%b".
\r
2008 * Blank lines are ignored.
\r
2010 * A '\' at the end of a line acts as a continuation character, i.e.,
\r
2011 the next line is appended. Whitespace at the beginning of
\r
2012 continuation lines is not ignored.
\r
2014 * Each remaining line must look like
\r
2016 VARIABLE [. PROGNAME] [=] VALUE
\r
2018 where the '=' and surrounding whitespace is optional.
\r
2020 * The VARIABLE name may contain any character other than whitespace,
\r
2021 '=', or '.', but sticking to 'A-Za-z_' is safest.
\r
2023 * If '.PROGNAME' is present, the definition only applies if the
\r
2024 program that is running is named (i.e., the last component of
\r
2025 'argv[0]' is) PROGNAME or 'PROGNAME.{exe,bat,cmd,...}'. Most
\r
2026 notably, this allows different flavors of TeX to have different
\r
2029 * VALUE may contain any characters except '%' and '@'. (These
\r
2030 restrictions are only necessary because of the processing done on
\r
2031 'texmf.cnf' at build time, so you can stick those characters in
\r
2032 after installation if you have to.) The '$VAR.PROG' feature is not
\r
2033 available on the right-hand side; instead, you must use an
\r
2034 additional variable (see below for example). A ';' in VALUE is
\r
2035 translated to ':' if running under Unix; this is useful to write a
\r
2036 single 'texmf.cnf' which can be used under both Unix and Windows.
\r
2038 * All definitions are read before anything is expanded, so you can
\r
2039 use variables before they are defined (like Make, unlike most other
\r
2042 Here is a configuration file fragment illustrating most of these points:
\r
2044 % TeX input files -- i.e., anything to be found by \input or \openin ...
\r
2045 latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
\r
2046 latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
\r
2047 TEXINPUTS = .:$TEXMF/tex//
\r
2048 TEXINPUTS.latex209 = $latex209_inputs
\r
2049 TEXINPUTS.latex2e = $latex2e_inputs
\r
2050 TEXINPUTS.latex = $latex2e_inputs
\r
2052 This format has obvious similarities to Bourne shell scripts--change
\r
2053 the comment character to '#', disallow spaces around the '=', and get
\r
2054 rid of the '.NAME' convention, and it could be run through the shell.
\r
2055 However, there seemed little advantage in this, since all the
\r
2056 information would have to passed back to Kpathsea and parsed there
\r
2057 anyway, since the 'sh' process couldn't affect its parent's environment.
\r
2059 The implementation of all this is in 'kpathsea/cnf.c'.
\r
2062 File: kpathsea.info, Node: Path expansion, Next: Filename database, Prev: Path sources, Up: Path searching
\r
2064 3.3 Path expansion
\r
2065 ==================
\r
2067 Kpathsea recognizes certain special characters and constructions in
\r
2068 search paths, similar to that in shells. As a general example:
\r
2069 '~$USER/{foo,bar}//baz' expands to all subdirectories under directories
\r
2070 'foo' and 'bar' in $USER's home directory that contain a directory or
\r
2071 file 'baz'. These expansions are explained in the sections below.
\r
2075 * Default expansion:: a: or :a or a::b expands to a default.
\r
2076 * Variable expansion:: $foo and ${foo} expand to environment values.
\r
2077 * Tilde expansion:: ~ and ~user expand to home directories.
\r
2078 * Brace expansion:: a{foo,bar}b expands to afoob abarb.
\r
2079 * KPSE_DOT expansion:: . is replaced with $KPSE_DOT if it is defined.
\r
2080 * Subdirectory expansion:: a// and a//b recursively expand to subdirs.
\r
2083 File: kpathsea.info, Node: Default expansion, Next: Variable expansion, Up: Path expansion
\r
2085 3.3.1 Default expansion
\r
2086 -----------------------
\r
2088 If the highest-priority search path (*note Path sources::) contains an
\r
2089 "extra colon" (i.e., leading, trailing, or doubled), Kpathsea inserts at
\r
2090 that point the next-highest-priority search path that is defined. If
\r
2091 that inserted path has an extra colon, the same happens with the
\r
2092 next-highest. (An extra colon in the compile-time default value has
\r
2093 unpredictable results, so installers beware.)
\r
2095 For example, given an environment variable setting
\r
2097 setenv TEXINPUTS /home/karl:
\r
2099 and a 'TEXINPUTS' value from 'texmf.cnf' of
\r
2103 then the final value used for searching will be:
\r
2105 /home/karl:.:$TEXMF//tex
\r
2107 Put another way, default expansion works on "formats" (search paths),
\r
2108 and not directly on environment variables. Example, showing the
\r
2109 trailing ':' ignored in the first case and expanded in the second:
\r
2111 $ env TTFONTS=/tmp: kpsewhich --expand-path '$TTFONTS'
\r
2113 $ env TTFONTS=/tmp: kpsewhich --show-path=.ttf
\r
2114 /tmp:.:/home/olaf/texmf/fonts/truetype//:...
\r
2116 Since Kpathsea looks for multiple configuration files, it would be
\r
2117 natural to expect that (for example) an extra colon in './texmf.cnf'
\r
2118 would expand to the path in '$TEXMF/texmf.cnf'. Or, with Dvips'
\r
2119 configuration files, that an extra colon in 'config.$PRINTER' would
\r
2120 expand to the path in 'config.ps'. This doesn't happen. It's not clear
\r
2121 this would be desirable in all cases, and trying to devise a way to
\r
2122 specify the path to which the extra colon should expand seemed truly
\r
2125 Technicality: Since it would be useless to insert the default value
\r
2126 in more than one place, Kpathsea changes only one extra ':' and leaves
\r
2127 any others in place (they will eventually be ignored). Kpathsea checks
\r
2128 first for a leading ':', then a trailing ':', then a doubled ':'.
\r
2130 You can trace this by debugging "paths" (*note Debugging::). Default
\r
2131 expansion is implemented in the source file 'kpathsea/kdefault.c'.
\r
2134 File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: Default expansion, Up: Path expansion
\r
2136 3.3.2 Variable expansion
\r
2137 ------------------------
\r
2139 '$foo' or '${foo}' in a path element is replaced by (1) the value of an
\r
2140 environment variable 'foo' (if defined); (2) the value of 'foo' from
\r
2141 'texmf.cnf' (if defined); (3) the empty string.
\r
2143 If the character after the '$' is alphanumeric or '_', the variable
\r
2144 name consists of all consecutive such characters. If the character
\r
2145 after the '$' is a '{', the variable name consists of everything up to
\r
2146 the next '}' (braces may not be nested around variable names).
\r
2147 Otherwise, Kpathsea gives a warning and ignores the '$' and its
\r
2148 following character.
\r
2150 You must quote the $'s and braces as necessary for your shell.
\r
2151 _Shell_ variable values cannot be seen by Kpathsea, i.e., ones defined
\r
2152 by 'set' in C shells and without 'export' in Bourne shells.
\r
2154 For example, given
\r
2155 setenv tex /home/texmf
\r
2156 setenv TEXINPUTS .:$tex:${tex}prev
\r
2157 the final 'TEXINPUTS' path is the three directories:
\r
2158 .:/home/texmf:/home/texmfprev
\r
2160 The '.PROGNAME' suffix on variables and '_PROGNAME' on environment
\r
2161 variable names are not implemented for general variable expansions.
\r
2162 These are only recognized when search paths are initialized (*note Path
\r
2165 Variable expansion is implemented in the source file
\r
2166 'kpathsea/variable.c'.
\r
2169 File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Variable expansion, Up: Path expansion
\r
2171 3.3.3 Tilde expansion
\r
2172 ---------------------
\r
2174 A leading '~' in a path element is replaced by the value of the
\r
2175 environment variable 'HOME', or '.' if 'HOME' is not set. On Windows,
\r
2176 the environment variable 'USERPROFILE' is checked instead of 'HOME'.
\r
2178 A leading '~USER' in a path element is replaced by USER's home
\r
2179 directory from the system 'passwd' database.
\r
2182 setenv TEXINPUTS ~/mymacros:
\r
2184 will prepend a directory 'mymacros' in your home directory to the
\r
2187 As a special case, if a home directory ends in '/', the trailing
\r
2188 slash is dropped, to avoid inadvertently creating a '//' construct in
\r
2189 the path. For example, if the home directory of the user 'root' is '/',
\r
2190 the path element '~root/mymacros' expands to just '/mymacros', not
\r
2193 Tilde expansion is implemented in the source file 'kpathsea/tilde.c'.
\r
2196 File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: Tilde expansion, Up: Path expansion
\r
2198 3.3.4 Brace expansion
\r
2199 ---------------------
\r
2201 'x{A,B}y' expands to 'xAy:xBy'. For example:
\r
2205 expands to 'foo/1/baz:foo/2/baz'. ':' is the path separator on the
\r
2206 current system; e.g., on a DOS system, it's ';'.
\r
2208 Braces can be nested; for example, 'x{A,B{1,2}}y' expands to
\r
2211 Multiple non-nested braces are expanded from right to left; for
\r
2212 example, 'x{A,B}{1,2}y' expands to 'x{A,B}1y:x{A,B}2y', which expands to
\r
2213 'xA1y:xB1y:xA2y:xB2y'.
\r
2215 This feature can be used to implement multiple TeX hierarchies, by
\r
2216 assigning a brace list to '$TEXMF', as mentioned in 'texmf.in'.
\r
2218 You can also use the path separator instead of the comma. The last
\r
2219 example could have been written 'x{A:B}{1:2}y'.
\r
2221 Brace expansion is implemented in the source file
\r
2222 'kpathsea/expand.c'.
\r
2225 File: kpathsea.info, Node: KPSE_DOT expansion, Next: Subdirectory expansion, Prev: Brace expansion, Up: Path expansion
\r
2227 3.3.5 'KPSE_DOT' expansion
\r
2228 --------------------------
\r
2230 When 'KPSE_DOT' is defined in the environment, it names a directory that
\r
2231 should be considered the current directory for the purpose of looking up
\r
2232 files in the search paths. This feature is needed by the 'mktex...'
\r
2233 scripts *note mktex scripts::, because these change the working
\r
2234 directory. You should not ever define it yourself.
\r
2237 File: kpathsea.info, Node: Subdirectory expansion, Prev: KPSE_DOT expansion, Up: Path expansion
\r
2239 3.3.6 Subdirectory expansion
\r
2240 ----------------------------
\r
2242 Two or more consecutive slashes in a path element following a directory
\r
2243 D is replaced by all subdirectories of D: first those subdirectories
\r
2244 directly under D, then the subsubdirectories under those, and so on. At
\r
2245 each level, the order in which the directories are searched is
\r
2246 unspecified. (It's "directory order", and definitely not alphabetical.)
\r
2248 If you specify any filename components after the '//', only
\r
2249 subdirectories which match those components are included. For example,
\r
2250 '/a//b' would expand into directories '/a/1/b', '/a/2/b', '/a/1/1/b',
\r
2251 and so on, but not '/a/b/c' or '/a/1'.
\r
2253 You can include multiple '//' constructs in the path.
\r
2255 '//' at the beginning of a path is ignored; you didn't really want to
\r
2256 search every directory on the system, did you?
\r
2258 I should mention one related implementation trick, which I took from
\r
2259 GNU find. Matthew Farwell suggested it, and David MacKenzie implemented
\r
2262 The trick is that in every real Unix implementation (as opposed to
\r
2263 the POSIX specification), a directory which contains no subdirectories
\r
2264 will have exactly two links (namely, one for '.' and one for '..').
\r
2265 That is to say, the 'st_nlink' field in the 'stat' structure will be
\r
2266 two. Thus, we don't have to stat everything in the bottom-level (leaf)
\r
2267 directories--we can just check 'st_nlink', notice it's two, and do no
\r
2270 But if you have a directory that contains a single subdirectory and
\r
2271 500 regular files, 'st_nlink' will be 3, and Kpathsea has to stat every
\r
2272 one of those 501 entries. Therein lies slowness.
\r
2274 You can disable the trick by undefining 'ST_NLINK_TRICK' in
\r
2275 'kpathsea/config.h'. (It is undefined by default except under Unix.)
\r
2277 Unfortunately, in some cases files in leaf directories are 'stat''d:
\r
2278 if the path specification is, say, '$TEXMF/fonts//pk//', then files in a
\r
2279 subdirectory '.../pk', even if it is a leaf, are checked. The reason
\r
2280 cannot be explained without reference to the implementation, so read
\r
2281 'kpathsea/elt-dirs.c' (search for 'may descend') if you are curious.
\r
2282 And if you can find a way to _solve_ the problem, please let me know.
\r
2284 Subdirectory expansion is implemented in the source file
\r
2285 'kpathsea/elt-dirs.c'.
\r
2288 File: kpathsea.info, Node: Filename database, Next: Invoking kpsewhich, Prev: Path expansion, Up: Path searching
\r
2290 3.4 Filename database ('ls-R')
\r
2291 ==============================
\r
2293 Kpathsea goes to some lengths to minimize disk accesses for searches
\r
2294 (*note Subdirectory expansion::). Nevertheless, in practice searching
\r
2295 each possible directory in typical TeX installations takes an
\r
2296 excessively long time.
\r
2298 Therefore, Kpathsea can use an externally-built "filename database"
\r
2299 file named 'ls-R' that maps files to directories, thus avoiding the need
\r
2300 to exhaustively search the disk.
\r
2302 A second database file 'aliases' allows you to give additional names
\r
2303 to the files listed in 'ls-R'. This can be helpful to adapt to "8.3"
\r
2304 filename conventions in source files.
\r
2306 The 'ls-R' and 'aliases' features are implemented in the source file
\r
2311 * ls-R:: The main filename database.
\r
2312 * Filename aliases:: Aliases for those names.
\r
2313 * Database format:: Syntax details of the database file.
\r
2316 File: kpathsea.info, Node: ls-R, Next: Filename aliases, Up: Filename database
\r
2321 As mentioned above, you must name the main filename database 'ls-R'.
\r
2322 You can put one at the root of each TeX installation hierarchy you wish
\r
2323 to search ('$TEXMF' by default); most sites have only one hierarchy.
\r
2324 Kpathsea looks for 'ls-R' files along the 'TEXMFDBS' path, so that
\r
2325 should presumably match the list of hierarchies.
\r
2327 The recommended way to create and maintain 'ls-R' is to run the
\r
2328 'mktexlsr' script, which is installed in '$(bindir)' ('/usr/local/bin'
\r
2329 by default). That script goes to some trouble to follow symbolic links
\r
2330 as necessary, etc. It's also invoked by the distributed 'mktex...'
\r
2333 At its simplest, though, you can build 'ls-R' with the command
\r
2334 cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
\r
2336 presuming your 'ls' produces the right output format (see the section
\r
2337 below). GNU 'ls', for example, outputs in this format. Also presuming
\r
2338 your 'ls' hasn't been aliased in a system file (e.g., '/etc/profile') to
\r
2339 something problematic, e.g., 'ls --color=tty'. In that case, you will
\r
2340 have to disable the alias before generating 'ls-R'. For the precise
\r
2341 definition of the file format, see *note Database format::.
\r
2343 Regardless of whether you use the supplied script or your own, you
\r
2344 will almost certainly want to invoke it via 'cron', so when you make
\r
2345 changes in the installed files (say if you install a new LaTeX package),
\r
2346 'ls-R' will be automatically updated.
\r
2348 The '-A' option to 'ls' includes files beginning with '.' (except for
\r
2349 '.' and '..'), such as the file '.tex' included with the LaTeX tools
\r
2350 package. (On the other hand, _directories_ whose names begin with '.'
\r
2351 are always ignored.)
\r
2353 If your system does not support symbolic links, omit the '-L'.
\r
2355 'ls -LAR /YOUR/TEXMF/ROOT' will also work. But using './' avoids
\r
2356 embedding absolute pathnames, so the hierarchy can be easily
\r
2357 transported. It also avoids possible trouble with automounters or other
\r
2358 network filesystem conventions.
\r
2360 Kpathsea warns you if it finds an 'ls-R' file, but the file does not
\r
2361 contain any usable entries. The usual culprit is running plain 'ls -R'
\r
2362 instead of 'ls -LR ./' or 'ls -R /YOUR/TEXMF/ROOT'. Another possibility
\r
2363 is some system directory name starting with a '.' (perhaps if you are
\r
2364 using AFS); Kpathsea ignores everything under such directories.
\r
2366 Because the database may be out-of-date for a particular run, if a
\r
2367 file is not found in the database, by default Kpathsea goes ahead and
\r
2368 searches the disk. If a particular path element begins with '!!',
\r
2369 however, _only_ the database will be searched for that element, never
\r
2370 the disk. If the database does not exist, nothing will be searched.
\r
2371 Because this can surprise users ("I see the font 'foo.tfm' when I do an
\r
2372 'ls'; why can't Dvips find it?"), it is not in any of the default search
\r
2376 File: kpathsea.info, Node: Filename aliases, Next: Database format, Prev: ls-R, Up: Filename database
\r
2378 3.4.2 Filename aliases
\r
2379 ----------------------
\r
2381 In some circumstances, you may wish to find a file under several names.
\r
2382 For example, suppose a TeX document was created using a DOS system and
\r
2383 tries to read 'longtabl.sty'. But now it's being run on a Unix system,
\r
2384 and the file has its original name, 'longtable.sty'. The file won't be
\r
2385 found. You need to give the actual file 'longtable.sty' an alias
\r
2388 You can handle this by creating a file 'aliases' as a companion to
\r
2389 the 'ls-R' for the hierarchy containing the file in question. (You must
\r
2390 have an 'ls-R' for the alias feature to work.)
\r
2392 The format of 'aliases' is simple: two whitespace-separated words per
\r
2393 line; the first is the real name 'longtable.sty', and second is the
\r
2394 alias ('longtabl.sty'). These must be base filenames, with no directory
\r
2395 components. 'longtable.sty' must be in the sibling 'ls-R'.
\r
2397 Also, blank lines and lines starting with '%' or '#' are ignored in
\r
2398 'aliases', to allow for comments.
\r
2400 If a real file 'longtabl.sty' exists, it is used regardless of any
\r
2404 File: kpathsea.info, Node: Database format, Prev: Filename aliases, Up: Filename database
\r
2406 3.4.3 Database format
\r
2407 ---------------------
\r
2409 The "database" read by Kpathsea is a line-oriented file of plain text.
\r
2410 The format is that generated by GNU (and most other) 'ls' programs given
\r
2411 the '-R' option, as follows.
\r
2413 * Blank lines are ignored.
\r
2415 * If a line begins with '/' or './' or '../' and ends with a colon,
\r
2416 it's the name of a directory. ('../' lines aren't useful, however,
\r
2417 and should not be generated.)
\r
2419 * All other lines define entries in the most recently seen directory.
\r
2420 /'s in such lines will produce possibly-strange results.
\r
2422 * Files with no preceding directory line are ignored.
\r
2424 For example, here's the first few lines of 'ls-R' (which totals about
\r
2425 30K bytes) on my system:
\r
2447 File: kpathsea.info, Node: Invoking kpsewhich, Prev: Filename database, Up: Path searching
\r
2449 3.5 'kpsewhich': Standalone path searching
\r
2450 ==========================================
\r
2452 The Kpsewhich program exercises the path searching functionality
\r
2453 independent of any particular application. This can also be useful as a
\r
2454 sort of 'find' program to locate files in your TeX hierarchies, perhaps
\r
2455 in administrative scripts. It is used heavily in the distributed
\r
2456 'mktex...' scripts.
\r
2460 kpsewhich OPTION... FILENAME...
\r
2462 The options and filename(s) to look up can be intermixed. Options
\r
2463 can start with either '-' or '--', and any unambiguous abbreviation is
\r
2468 * Path searching options:: Changing the mode, resolution, etc.
\r
2469 * Specially-recognized files:: Default formats for texmf.cnf, etc.
\r
2470 * Auxiliary tasks:: Path and variable expansion.
\r
2471 * Standard options:: -help and -version.
\r
2474 File: kpathsea.info, Node: Path searching options, Next: Specially-recognized files, Up: Invoking kpsewhich
\r
2476 3.5.1 Path searching options
\r
2477 ----------------------------
\r
2479 Kpsewhich looks up each non-option argument on the command line as a
\r
2480 filename, and returns the first file found.
\r
2482 Various options alter the path searching behavior:
\r
2485 Report all matches found, one per line. By default, if there is
\r
2486 more than one match, just one will be reported (chosen effectively
\r
2490 Set the resolution to NUM; this only affects 'gf' and 'pk' lookups.
\r
2491 '-D' is a synonym, for compatibility with Dvips. Default is 600.
\r
2494 Set the engine name to NAME. By default it is not set. The engine
\r
2495 name is used in some search paths to allow files with the same name
\r
2496 but used by different engines to coexist.
\r
2498 In particular, since the memory dump files ('.fmt'/'.base'/'.mem')
\r
2499 are now stored in subdirectories named for the engine ('tex',
\r
2500 'pdftex', 'xetex', etc.), you must specify an engine name in order
\r
2501 to find them. For example, 'cont-en.fmt' typically exists for both
\r
2502 'pdftex' and 'xetex'. With the default path settings, you can use
\r
2503 '--engine=/' to look for any dump file, regardless of engine; if a
\r
2504 dump file exists for more than one engine, it's indeterminate which
\r
2505 one is returned. (The '/' ends up specifying a normal recursive
\r
2506 search along the path where the dumps are stored, namely
\r
2507 '$TEXMF/web2c{/$engine,}'.)
\r
2510 Set the format for lookup to NAME. By default, the format is
\r
2511 guessed from the filename, with 'tex' being used if nothing else
\r
2512 fits. The recognized filename extensions (including any leading
\r
2513 '.') are also allowable NAMEs.
\r
2515 All formats also have a name, which is the only way to specify
\r
2516 formats with no associated suffix. For example, for Dvips
\r
2517 configuration files you can use '--format="dvips config"'. (The
\r
2518 quotes are for the sake of the shell.)
\r
2520 Here's the current list of recognized names and the associated
\r
2521 suffixes. *Note Supported file formats::, for more information on
\r
2524 The strings in parentheses are abbreviations recognized only by
\r
2525 'kpsewhich' (not the underlying library calls). They are provided
\r
2526 when it would otherwise require an argument containing a space to
\r
2527 specify the format, to simplify quoting of calls from shells.
\r
2531 bitmap font (bitmapfont):
\r
2547 MetaPost support (mpsupport):
\r
2554 graphic/figure: .eps .epsi
\r
2555 tex: .tex .sty .cls .fd .aux .bbl .def .clo .ldf
\r
2556 TeX system documentation (doc):
\r
2558 TeX system sources (source): .dtx .ins
\r
2559 PostScript header: .pro
\r
2560 Troff fonts (trofffont):
\r
2561 type1 fonts: .pfa .pfb
\r
2563 dvips config (dvipsconfig):
\r
2565 truetype fonts: .ttf .ttc .TTF .TTC .dfont
\r
2566 type42 fonts: .t42 .T42
\r
2567 web2c files (web2c):
\r
2568 other text files (othertext):
\r
2569 other binary files (otherbin):
\r
2570 misc fonts (miscfont):
\r
2574 cmap files (cmap):
\r
2575 subfont definition files: .sfd
\r
2576 opentype fonts: .otf
\r
2577 pdftex config (pdftexconfig):
\r
2580 lua: .luc .luctex .texluc .lua .luatex .texlua
\r
2581 font feature files: .fea
\r
2582 cid maps: .cid .cidmap
\r
2583 mlbib: .mlbib .bib
\r
2584 mlbst: .mlbst .bst
\r
2589 This option and '--path' are mutually exclusive.
\r
2592 After processing the command line, read additional filenames to
\r
2593 look up from standard input.
\r
2595 '--mktex=FILETYPE'
\r
2596 '--no-mktex=FILETYPE'
\r
2597 Turn on or off the 'mktex' script associated with FILETYPE. Usual
\r
2598 values for FILETYPE are 'pk', 'mf', 'tex', and 'tfm'. By default,
\r
2599 all are off in Kpsewhich, even if they are enabled for TeX. This
\r
2600 option implies setting '--must-exist'. *Note mktex scripts::.
\r
2603 Set the mode name to STRING; this also only affects 'gf' and 'pk'
\r
2604 lookups. No default: any mode will be found. *Note mktex script
\r
2608 Do everything possible to find the files, notably including
\r
2609 searching the disk and running the 'mktex' scripts. By default,
\r
2610 only the 'ls-R' database is checked, in the interest of efficiency.
\r
2613 Search along the path STRING (colon-separated as usual), instead of
\r
2614 guessing the search path from the filename. '//' and all the usual
\r
2615 expansions are supported (*note Path expansion::). This option and
\r
2616 '--format' are mutually exclusive. To output the complete
\r
2617 directory expansion of a path, instead of doing a one-shot lookup,
\r
2618 see '--expand-path' and '--show-path' in the following section.
\r
2621 Set the program name to NAME; default is 'kpsewhich'. This can
\r
2622 affect the search paths via the '.PROGNAM' feature in configuration
\r
2623 files (*note Config files::).
\r
2625 '--safe-in-name=NAME'
\r
2626 '--safe-out-name=NAME'
\r
2627 Exit successfully if NAME is safe to open for reading or writing,
\r
2628 respectively, else unsuccessfully. No output is written. These
\r
2629 tests take account of the related Kpathsea configuration settings
\r
2630 (*note Calling sequence::).
\r
2633 Report only those matches whose directory part _ends_ with STRING
\r
2634 (compared literally, except case is ignored on a case-insensitive
\r
2635 operating system). For example, suppose there are two matches for
\r
2639 => /some/where/foo.sty
\r
2640 /another/place/foo.sty
\r
2642 Then we can narrow the result to what we are interested in with
\r
2645 kpsewhich --subdir=where foo.sty
\r
2646 => /some/where/foo.sty
\r
2648 kpsewhich --subdir=place foo.sty
\r
2649 => /another/place/foo.sty
\r
2651 The string to match must be at the end of the directory part of the
\r
2652 match, and it is taken literally, with no pattern matching:
\r
2654 kpsewhich --subdir=another foo.sty
\r
2657 The string to match may cross directory components:
\r
2659 kpsewhich --subdir=some/where foo.sty
\r
2660 => /some/where/foo.sty
\r
2662 '--subdir' implies '--all'; if there is more than one match, they
\r
2663 will all be reported (in our example, both 'where' and 'place' end
\r
2666 kpsewhich --subdir=e
\r
2667 => /some/where/foo.sty
\r
2668 /another/place/foo.sty
\r
2670 Because of the above rules, the presence of a leading '/' is
\r
2671 important, since it "anchors" the match to a full component name:
\r
2673 kpsewhich --subdir=/lace foo.sty
\r
2676 However, a trailing '/' is immaterial (and ignored), since the
\r
2677 match always takes place at the end of the directory part:
\r
2679 kpsewhich --subdir=lace/ foo.sty
\r
2680 => /another/place/foo.sty
\r
2682 The purpose of these rules is to make it convenient to find results
\r
2683 only within a particular area of the tree. For instance, a given
\r
2684 script named 'foo.lua' might exist within both
\r
2685 'texmf-dist/scripts/pkg1/' and 'texmf-dist/scripts/pkg2/'. By
\r
2686 specifying, say, '--subdir=/pkg1', you can be sure of getting the
\r
2687 one you are interested in.
\r
2689 We only match at the end because a site might happen to install TeX
\r
2690 in '/some/coincidental/pkg1/path/', and we wouldn't want to match
\r
2691 'texmf-dist/scripts/pkg2/' that when searching for '/pkg1'.
\r
2694 File: kpathsea.info, Node: Specially-recognized files, Next: Auxiliary tasks, Prev: Path searching options, Up: Invoking kpsewhich
\r
2696 3.5.2 Specially-recognized files for 'kpsewhich'
\r
2697 ------------------------------------------------
\r
2699 'kpsewhich' recognizes a few special filenames on the command line and
\r
2700 defaults to using the 'known' file formats for them, merely to save the
\r
2701 time and trouble of specifying the format. This is only a feature of
\r
2702 'kpsewhich'; when using the Kpathsea library itself, none of these
\r
2703 special filenames are recognized, and it's still up to the caller to
\r
2704 specify the desired format.
\r
2706 Here is the list of special filenames to 'kpsewhich', along with
\r
2707 their corresponding format:
\r
2713 'other text files'
\r
2724 'pdfglyphlist.txt'
\r
2728 'pdftex config' (although 'pdftex.cfg' is not used any more; look
\r
2729 for the file 'pdftexconfig.tex' instead.)
\r
2735 'other text files'
\r
2737 A user-specified format will override the above defaults.
\r
2739 Another useful configuration file in this regard is 'tcfmgr.map',
\r
2740 found in 'texmf/texconfig/tcfmgr.map', which records various information
\r
2741 about the above configuration files (among others).
\r
2744 File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Specially-recognized files, Up: Invoking kpsewhich
\r
2746 3.5.3 Auxiliary tasks
\r
2747 ---------------------
\r
2749 Kpsewhich provides some additional features not strictly related to path
\r
2752 * '--debug=NUM' sets the debugging options to NUM. *Note
\r
2755 * '--var-value=VARIABLE' outputs the value of VARIABLE, expanding '$'
\r
2756 (*note Variable expansion:: and '~' (*note Tilde expansion::)
\r
2757 constructs, but not performing other expansions.
\r
2759 * '--expand-braces=STRING' outputs the variable and brace expansion
\r
2760 of STRING. *Note Path expansion::.
\r
2762 * '--expand-var=STRING' outputs the variable and tilde expansion of
\r
2763 STRING. For example, the 'mktex...' scripts run 'kpsewhich
\r
2764 --expand-var='$TEXMF'' to find the root of the TeX system
\r
2765 hierarchy. *Note Path expansion::.
\r
2767 * '--expand-path=STRING' outputs the complete expansion of STRING,
\r
2768 with each element separated by the usual path separator on the
\r
2769 current system (';' on Windows, ':' otherwise). This may be useful
\r
2770 to construct a custom search path for a format not otherwise
\r
2771 supported. To retrieve the search path for a format that is
\r
2772 already supported, see '--show-path', next.
\r
2774 Nonexistent directories are culled from the output:
\r
2776 $ kpsewhich --expand-path '/tmp'
\r
2778 $ kpsewhich --expand-path '/nonesuch'
\r
2781 For one-shot uses of an arbitrary (not built in to Kpathsea) path,
\r
2782 see '--path' in the previous section.
\r
2784 * '--show-path=NAME' shows the path that would be used for file
\r
2785 lookups of file type NAME. Either a filename extension ('pk',
\r
2786 '.vf', etc.) or an integer can be used, just as with '--format',
\r
2787 described in the previous section.
\r
2790 File: kpathsea.info, Node: Standard options, Prev: Auxiliary tasks, Up: Invoking kpsewhich
\r
2792 3.5.4 Standard options
\r
2793 ----------------------
\r
2795 Kpsewhich accepts the standard GNU options:
\r
2797 * '--help' prints a help message on standard output and exits
\r
2800 * '--version' prints the Kpathsea version number and exits
\r
2804 File: kpathsea.info, Node: TeX support, Next: Programming, Prev: Path searching, Up: Top
\r
2809 Although the basic features in Kpathsea can be used for any type of path
\r
2810 searching, it came about (like all libraries) with a specific
\r
2811 application in mind: I wrote Kpathsea specifically for TeX system
\r
2812 programs. I had been struggling with the programs I was using (Dvips,
\r
2813 Xdvi, and TeX itself) having slightly different notions of how to
\r
2814 specify paths; and debugging was painful, since no code was shared.
\r
2816 Therefore, Kpathsea provides some TeX-specific formats and features.
\r
2817 Indeed, many of the supposedly generic path searching features were
\r
2818 provided because they seemed useful in that conTeXt (font lookup,
\r
2821 Kpathsea provides a standard way to search for files of any of the
\r
2822 supported file types; glyph fonts are a bit different than all the rest.
\r
2823 Searches are based solely on filenames, not file contents--if a GF file
\r
2824 is named 'cmr10.600pk', it will be found as a PK file.
\r
2828 * Supported file formats:: File types Kpathsea knows about.
\r
2829 * File lookup:: Searching for most kinds of files.
\r
2830 * Glyph lookup:: Searching for bitmap fonts.
\r
2831 * Suppressing warnings:: Avoiding warnings via TEX_HUSH.
\r
2834 File: kpathsea.info, Node: Supported file formats, Next: File lookup, Up: TeX support
\r
2836 4.1 Supported file formats
\r
2837 ==========================
\r
2839 Kpathsea has support for a number of file types. Each file type has a
\r
2840 list of environment and config file variables that are checked to define
\r
2841 the search path, and most have a default suffix that plays a role in
\r
2842 finding files (see the next section). Some also define additional
\r
2843 suffixes, and/or a program to be run to create missing files on the fly.
\r
2845 Since environment variables containing periods, such as
\r
2846 'TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
\r
2847 environment variables with an underscore, e.g., 'TEXINPUTS_latex' (*note
\r
2850 The following table lists the above information.
\r
2853 (Adobe font metrics, *note (dvips)Metric files::) 'AFMFONTS';
\r
2857 (Metafont memory dump, *note (web2c)Memory dumps::) 'MFBASES',
\r
2858 'TEXMFINI'; suffix '.base'.
\r
2861 (BibTeX bibliography source, *note (web2c)bibtex invocation::)
\r
2862 'BIBINPUTS', 'TEXBIB'; suffix '.bib'.
\r
2865 (BibTeX style, *note Basic BibTeX style files: (web2c)Basic BibTeX
\r
2866 style files.) 'BSTINPUTS'; suffix '.bst'.
\r
2869 (character map files) 'CMAPFONTS'; suffix '.cmap'.
\r
2872 (Runtime configuration files, *note Config files::) 'TEXMFCNF';
\r
2876 (CWEB input files) 'CWEBINPUTS'; suffixes '.w', '.web'; additional
\r
2880 (Dvips 'config.*' files, such as 'config.ps', *note (dvips)Config
\r
2881 files::) 'TEXCONFIG'.
\r
2884 (encoding vectors) 'ENCFONTS'; suffix '.enc'.
\r
2887 (TeX memory dump, *note (web2c)Memory dumps::) 'TEXFORMATS',
\r
2888 'TEXMFINI'; suffix '.fmt'.
\r
2891 (CJK mapping) 'FONTCIDMAPS' suffix '.cid'.
\r
2893 'font feature files'
\r
2894 (primarily for OpenType font features) 'FONTFEATURES' suffix
\r
2898 (generic font bitmap, *note (dvips)Glyph files::) 'PROGRAMFONTS',
\r
2899 'GFFONTS', 'GLYPHFONTS', 'TEXFONTS'; suffix 'gf'.
\r
2902 (Encapsulated PostScript figures, *note (dvips)PostScript
\r
2903 figures::) 'TEXPICTS', 'TEXINPUTS'; additional suffixes: '.eps',
\r
2907 (makeindex style files) 'TEXINDEXSTYLE', 'INDEXSTYLE'; suffix
\r
2911 (ligature definition files) 'LIGFONTS'; suffix '.lig'.
\r
2914 (Filename databases, *note Filename database::) 'TEXMFDBS'.
\r
2917 (Fontmaps, *note Fontmap::) 'TEXFONTMAPS'; suffix '.map'.
\r
2920 (MetaPost memory dump, *note (web2c)Memory dumps::) 'MPMEMS',
\r
2921 'TEXMFINI'; suffix '.mem'.
\r
2923 'MetaPost support'
\r
2924 (MetaPost support files, used by DMP; *note (web2c)dmp
\r
2925 invocation::) 'MPSUPPORT'.
\r
2928 (Metafont source, *note (web2c)mf invocation::) 'MFINPUTS'; suffix
\r
2929 '.mf'; dynamic creation program: 'mktexmf'.
\r
2932 (Metafont program strings, *note (web2c)pooltype invocation::)
\r
2933 'MFPOOL', 'TEXMFINI'; suffix '.pool'.
\r
2936 ('MFT' style file, *note (web2c)mft invocation::) 'MFTINPUTS';
\r
2940 (font-related files that don't fit the other categories)
\r
2944 (MlBibTeX bibliography source) 'MLBIBINPUTS', 'BIBINPUTS',
\r
2945 'TEXBIB'; suffixes '.mlbib', '.mlbib'.
\r
2948 (MlBibTeX style) 'MLBSTINPUTS', 'BSTINPUTS'; suffixes '.mlbst',
\r
2952 (MetaPost source, *note (web2c)mpost invocation::) 'MPINPUTS';
\r
2956 (MetaPost program strings, *note (web2c)pooltype invocation::)
\r
2957 'MPPOOL', 'TEXMFINI'; suffix '.pool'.
\r
2960 (Omega compiled process files) 'OCPINPUTS';
\r
2961 suffix '.ocp'; dynamic creation program: 'MakeOmegaOCP'.
\r
2964 (Omega font metrics) 'OFMFONTS', 'TEXFONTS';
\r
2965 suffixes '.ofm', '.tfm'; dynamic creation program: 'MakeOmegaOFM'.
\r
2968 (OpenType fonts) 'OPENTYPEFONTS'.
\r
2971 (Omega property lists) 'OPLFONTS', 'TEXFONTS'; suffix '.opl'.
\r
2974 (Omega translation process files) 'OTPINPUTS'; suffix '.otp'.
\r
2977 (Omega virtual fonts) 'OVFFONTS', 'TEXFONTS'; suffix '.ovf'.
\r
2980 (Omega virtual property lists) 'OVPFONTS', 'TEXFONTS'; suffix
\r
2984 (PDFTeX-specific configuration files) 'PDFTEXCONFIG'.
\r
2987 (packed bitmap fonts, *note (dvips)Glyph files::) 'PROGRAMFONTS'
\r
2988 (PROGRAM being 'XDVI', etc.), 'PKFONTS', 'TEXPKS', 'GLYPHFONTS',
\r
2989 'TEXFONTS'; suffix 'pk'; dynamic creation program: 'mktexpk'.
\r
2991 'PostScript header'
\r
2992 (downloadable PostScript, *note (dvips)Header files::)
\r
2993 'TEXPSHEADERS', 'PSHEADERS'; additional suffix '.pro'.
\r
2995 'subfont definition files'
\r
2996 (subfont definition files) 'SFDFONTS' suffix '.sfd'.
\r
2999 (TeX source, *note (web2c)tex invocation::) 'TEXINPUTS'; suffix
\r
3000 '.tex'; additional suffixes: none, because such a list cannot be
\r
3001 complete; dynamic creation program: 'mktextex'.
\r
3003 'TeX system documentation'
\r
3004 (Documentation files for the TeX system) 'TEXDOCS'.
\r
3006 'TeX system sources'
\r
3007 (Source files for the TeX system) 'TEXSOURCES'.
\r
3010 (Architecture-independent executables distributed in the texmf
\r
3011 trees) 'TEXMFSCRIPTS'.
\r
3014 (TeX program strings, *note (web2c)pooltype invocation::)
\r
3015 'TEXPOOL', 'TEXMFINI'; suffix '.pool'.
\r
3018 (TeX font metrics, *note (dvips)Metric files::) 'TFMFONTS',
\r
3019 'TEXFONTS'; suffix '.tfm'; dynamic creation program: 'mktextfm'.
\r
3022 (Troff fonts, used by DMP; *note (web2c)DMP invocation::)
\r
3026 (TrueType outline fonts) 'TTFONTS'; suffixes '.ttf' and '.TTF',
\r
3027 '.ttc' and '.TTC', '.dfont'.
\r
3030 (Type 1 PostScript outline fonts, *note (dvips)Glyph files::)
\r
3031 'T1FONTS', 'T1INPUTS', 'TEXPSHEADERS', 'DVIPSHEADERS'; suffixes
\r
3035 (Type 42 PostScript outline fonts) 'T42FONTS'.
\r
3038 (virtual fonts, *note (dvips)Virtual fonts::) 'VFFONTS',
\r
3039 'TEXFONTS'; suffix '.vf'.
\r
3042 (WEB input files) 'WEBINPUTS'; suffix '.web'; additional suffix
\r
3046 (files specific to the web2c implementation) 'WEB2C'.
\r
3048 There are two special cases, because the paths and environment
\r
3049 variables always depend on the name of the program: the variable name is
\r
3050 constructed by converting the program name to upper case, and then
\r
3051 appending 'INPUTS'. Assuming the program is called 'foo', this gives us
\r
3052 the following table.
\r
3054 'other text files'
\r
3055 (text files used by 'foo') 'FOOINPUTS'.
\r
3057 'other binary files'
\r
3058 (binary files used by 'foo') 'FOOINPUTS'.
\r
3060 If an environment variable by these names are set, the corresponding
\r
3061 'texmf.cnf' definition won't be looked at (unless, as usual, the
\r
3062 environment variable value has an extra ':'). *Note Default
\r
3065 For the font variables, the intent is that:
\r
3066 * 'TEXFONTS' is the default for everything.
\r
3068 * 'GLYPHFONTS' is the default for bitmap (or, more precisely,
\r
3069 non-metric) files.
\r
3071 * Each font format has a variable of its own.
\r
3073 * Each program has its own font override path as well; e.g.,
\r
3074 'DVIPSFONTS' for Dvipsk. Again, this is for bitmaps, not metrics.
\r
3077 File: kpathsea.info, Node: File lookup, Next: Glyph lookup, Prev: Supported file formats, Up: TeX support
\r
3082 This section describes how Kpathsea searches for most files (bitmap font
\r
3083 searches are the exception, as described in the next section).
\r
3085 Here is the search strategy for a file NAME:
\r
3087 1. If the file format defines default suffixes, and the suffix of NAME
\r
3088 name is not already a known suffix for that format, try the name
\r
3089 with each default appended, and use alternative names found in the
\r
3090 fontmaps if necessary. Example: given 'foo.bar', look for
\r
3093 2. Search for NAME, and if necessary for alternative names found in
\r
3094 the fontmaps. Example: given 'foo.bar', we also look for
\r
3097 3. If the file format defines a program to invoke to create missing
\r
3098 files, run it (*note mktex scripts::).
\r
3100 The order in which we search for "suffixed" name (item 1) or the
\r
3101 "as-is" name (item 2) is controlled by the 'try_std_extension_first'
\r
3102 configuration value. The default set in 'texmf.cnf' is true, since
\r
3103 common suffixes are already recognized: 'babel.sty' will only look for
\r
3104 'babel.sty', not 'babel.sty.tex', regardless of this setting.
\r
3106 When the suffix is unknown (e.g., 'foo.bar'), both names are always
\r
3107 tried; the difference is the order in which they are tried.
\r
3109 'try_std_extension_first' only affects names being looked up which
\r
3110 *already* have an extension. A name without an extension (e.g., 'tex
\r
3111 story') will always have an extension added first.
\r
3113 This algorithm is implemented in the function 'kpathsea_find_file' in
\r
3114 the source file 'kpathsea/tex-file.c'. You can watch it in action with
\r
3115 the debugging options (*note Debugging::).
\r
3118 File: kpathsea.info, Node: Glyph lookup, Next: Suppressing warnings, Prev: File lookup, Up: TeX support
\r
3123 This section describes how Kpathsea searches for a bitmap font in GF or
\r
3124 PK format (or either) given a font name (e.g., 'cmr10') and a resolution
\r
3127 Here is an outline of the search strategy (details in the sections
\r
3128 below) for a file NAME at resolution DPI. The search stops at the first
\r
3129 successful lookup.
\r
3131 1. Look for an existing file NAME.DPIFORMAT in the specified
\r
3134 2. If NAME is an alias for a file F in the fontmap file
\r
3135 'texfonts.map', look for F.DPI.
\r
3137 3. Run an external program (typically named 'mktexpk') to generate the
\r
3138 font (*note mktex scripts::)
\r
3140 4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
\r
3141 (typically 'cmr10').
\r
3143 This is implemented in 'kpathsea_find_glyph' in
\r
3144 'kpathsea/tex-glyph.c'.
\r
3148 * Basic glyph lookup:: Features common to all glyph lookups.
\r
3149 * Fontmap:: Aliases for fonts.
\r
3150 * Fallback font:: Resolutions and fonts of last resort.
\r
3153 File: kpathsea.info, Node: Basic glyph lookup, Next: Fontmap, Up: Glyph lookup
\r
3155 4.3.1 Basic glyph lookup
\r
3156 ------------------------
\r
3158 When Kpathsea looks for a bitmap font NAME at resolution DPI in a format
\r
3159 FORMAT, it first checks each directory in the search path for a file
\r
3160 'NAME.DPIFORMAT'; for example, 'cmr10.600pk'. Kpathsea looks for a PK
\r
3161 file first, then a GF file.
\r
3163 If that fails, Kpathsea looks for 'dpiDPI/NAME.FORMAT'; for example,
\r
3164 'dpi600/cmr10.pk'. This is how fonts are typically stored on
\r
3165 filesystems (such as DOS) that permit only three-character extensions.
\r
3167 If that fails, Kpathsea looks for a font with a close-enough DPI.
\r
3168 "Close enough" is defined by the macro 'KPSE_BITMAP_TOLERANCE' in
\r
3169 'kpathsea/tex-glyph.h' to be 'DPI / 500 + 1'. This is slightly more
\r
3170 than the 0.2% minimum allowed by the DVI standard
\r
3171 (<CTAN:/dviware/driv-standard/level-0>).
\r
3174 File: kpathsea.info, Node: Fontmap, Next: Fallback font, Prev: Basic glyph lookup, Up: Glyph lookup
\r
3179 If a bitmap font or metric file is not found with the original name (see
\r
3180 the previous section), Kpathsea looks through any "fontmap" files for an
\r
3181 "alias" for the original font name. These files are named
\r
3182 'texfonts.map' and searched for along the 'TEXFONTMAPS'
\r
3183 environment/config file variable. All 'texfonts.map' files that are
\r
3184 found are read; earlier definitions override later ones.
\r
3186 This feature is intended to help in two respects:
\r
3188 1. An alias name is limited in length only by available memory, not by
\r
3189 your filesystem. Therefore, if you want to ask for 'Times-Roman'
\r
3190 instead of 'ptmr', you can (you get 'ptmr8r').
\r
3192 2. A few fonts have historically had multiple names: specifically,
\r
3193 LaTeX's "circle font" has variously been known as 'circle10',
\r
3194 'lcircle10', and 'lcirc10'. Aliases can make all the names
\r
3195 equivalent, so that it no longer matters what the name of the
\r
3196 installed file is; TeX documents will find their favorite name.
\r
3198 The format of fontmap files is straightforward:
\r
3200 * Comments start with '%' and continue to the end of the line.
\r
3201 * Blank lines are ignored.
\r
3202 * Each nonblank line is broken up into a series of "words": a
\r
3203 sequence of non-whitespace characters.
\r
3204 * If the first word is 'include', the second word is used as a
\r
3205 filename, and it is searched for and read.
\r
3206 * Otherwise, the first word on each line is the true filename;
\r
3207 * the second word is the alias;
\r
3208 * subsequent words are ignored.
\r
3210 If an alias has an extension, it matches only those files with that
\r
3211 extension; otherwise, it matches anything with the same root, regardless
\r
3212 of extension. For example, an alias 'foo.tfm' matches only when
\r
3213 'foo.tfm' is being searched for; but an alias 'foo' matches 'foo.vf',
\r
3216 As an example, here is an excerpt from the 'texfonts.map' in the
\r
3217 Web2c distribution. It makes the circle fonts equivalent and includes
\r
3218 automatically generated maps for most PostScript fonts available from
\r
3219 various font suppliers.
\r
3221 circle10 lcircle10
\r
3223 lcircle10 circle10
\r
3230 include bitstrea.map
\r
3233 Fontmaps are implemented in the file 'kpathsea/fontmap.c'. The
\r
3234 Fontname distribution has much more information on font naming (*note
\r
3235 (fontname)Introduction::).
\r
3238 File: kpathsea.info, Node: Fallback font, Prev: Fontmap, Up: Glyph lookup
\r
3240 4.3.3 Fallback font
\r
3241 -------------------
\r
3243 If a bitmap font cannot be found or created at the requested size,
\r
3244 Kpathsea looks for the font at a set of "fallback resolutions". You
\r
3245 specify these resolutions as a colon-separated list (like search paths).
\r
3246 Kpathsea looks first for a program-specific environment variable (e.g.,
\r
3247 'DVIPSSIZES' for Dvipsk), then the environment variable 'TEXSIZES', then
\r
3248 a default specified at compilation time (the Make variable
\r
3249 'default_texsizes'). You can set this list to be empty if you prefer to
\r
3250 find fonts at their stated size or not at all.
\r
3252 Finally, if the font cannot be found even at the fallback
\r
3253 resolutions, Kpathsea looks for a fallback font, typically 'cmr10'.
\r
3254 Programs must enable this feature by calling 'kpathsea_init_prog' (*note
\r
3255 Calling sequence::); the default is no fallback font.
\r
3258 File: kpathsea.info, Node: Suppressing warnings, Prev: Glyph lookup, Up: TeX support
\r
3260 4.4 Suppressing warnings
\r
3261 ========================
\r
3263 Kpathsea provides a way to suppress selected usually-harmless warnings;
\r
3264 this is useful at large sites where most users are not administrators,
\r
3265 and thus the warnings are merely a source of confusion, not a help. To
\r
3266 do this, you set the environment variable or configuration file value
\r
3267 'TEX_HUSH' to a colon-separated list of values. Here are the
\r
3271 Suppress everything possible.
\r
3274 Suppress mismatched font checksum warnings.
\r
3277 Suppress warnings when a character is missing from a font that a
\r
3278 DVI or VF file tries to typeset.
\r
3281 Don't suppress any warnings.
\r
3284 Suppress warnings about attempts to access a file whose permissions
\r
3285 render it unreadable.
\r
3288 Suppresses warnings about an unimplemented or unparsable '\special'
\r
3291 'tex-hush.c' defines the function that checks the variable value. Each
\r
3292 driver implements its own checks where appropriate.
\r
3295 File: kpathsea.info, Node: Programming, Next: Index, Prev: TeX support, Up: Top
\r
3300 This chapter is for programmers who wish to use Kpathsea. *Note
\r
3301 Introduction::, for the conditions under which you may do so.
\r
3305 * Overview: Programming overview. Introduction.
\r
3306 * Calling sequence:: Specifics of what to call.
\r
3307 * Program-specific files:: How to handle these.
\r
3308 * Config: Programming with config files. Getting info from texmf.cnf.
\r
3311 File: kpathsea.info, Node: Programming overview, Next: Calling sequence, Up: Programming
\r
3313 5.1 Programming overview
\r
3314 ========================
\r
3316 Aside from this manual, your best source of information is the source to
\r
3317 the programs that use Kpathsea (*note Introduction::). Of those, Dviljk
\r
3318 is probably the simplest, and hence a good place to start. Xdvik adds
\r
3319 VF support and the complication of X resources. Dvipsk adds the
\r
3320 complication of its own config files. Web2c is source code I also
\r
3321 maintain, so it uses Kpathsea rather straightforwardly, but is of course
\r
3322 complicated by the Web to C translation. Finally, Kpsewhich is a small
\r
3323 utility program whose sole purpose is to exercise the main
\r
3324 path-searching functionality.
\r
3326 When looking at these program sources, you should know that previous
\r
3327 versions of the library had a different programming interface, to
\r
3328 support re-entrancy. In that interface the library function names were
\r
3329 prefixed with 'kpse_' instead of 'kpathsea_', and they did not need an
\r
3330 instance variable as first argument. This change was made in 2009.
\r
3331 Some of the programs mentioned above may still be using the previous
\r
3334 Beyond these examples, the '.h' files in the Kpathsea source describe
\r
3335 the interfaces and functionality (and of course the '.c' files define
\r
3336 the actual routines, which are the ultimate documentation).
\r
3337 'pathsearch.h' declares the basic searching routine. 'tex-file.h' and
\r
3338 'tex-glyph.h' define the interfaces for looking up particular kinds of
\r
3339 files. In view of the way the headers depend on each other, it is
\r
3340 recommended to use '#include <kpathsea/kpathsea.h>', which includes
\r
3341 every Kpathsea header.
\r
3343 If you want to include only specific headers, you should still
\r
3344 consider including 'kpathsea/config.h' before including any other
\r
3345 Kpathsea header, as it provides symbols used in the other headers. Note
\r
3346 that 'kpathsea/config.h' includes 'kpathsea/c-auto.h', which is
\r
3347 generated by Autoconf.
\r
3349 The library provides no way for an external program to register new
\r
3350 file types: 'tex-file.[ch]' must be modified to do this. For example,
\r
3351 Kpathsea has support for looking up Dvips config files, even though no
\r
3352 program other than Dvips will likely ever want to do so. I felt this
\r
3353 was acceptable, since along with new file types should also come new
\r
3354 defaults in 'texmf.cnf' (and its descendant 'paths.h'), since it's
\r
3355 simplest for users if they can modify one configuration file for all
\r
3358 Kpathsea does not parse any formats itself; it barely opens any
\r
3359 files. Its primary purpose is to return filenames. The GNU font
\r
3360 utilities does contain libraries to read TFM, GF, and PK files, as do
\r
3361 the programs above, of course.
\r
3364 File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Prev: Programming overview, Up: Programming
\r
3366 5.2 Calling sequence
\r
3367 ====================
\r
3369 The typical way to use Kpathsea in your program goes something like
\r
3372 1. Call 'kpathsea_new' to create a new library instance. This
\r
3373 variable must be passed as the first argument to all the following
\r
3374 library functions. The rest of this manual will be using 'kpse' as
\r
3375 a placeholder for the name of this variable.
\r
3377 2. Call 'kpathsea_set_program_name' with 'argv[0]' as the second
\r
3378 argument; the third argument is a string or 'NULL'. The third
\r
3379 argument is used by Kpathsea as the program name for the '.PROGRAM'
\r
3380 feature of config files (*note Config files::). If the third
\r
3381 argument is 'NULL', the value of the second argument is used. This
\r
3382 function must be called before any other use of the Kpathsea
\r
3385 'kpathsea_set_program_name' always sets the variables
\r
3386 'kpse->invocation_name' and 'kpse->invocation_short_name'. These
\r
3387 variables are used in the error message macros defined in
\r
3388 'kpathsea/lib.h'. It sets the variable 'kpse->program_name' to the
\r
3389 program name it uses.
\r
3391 It also initializes debugging options based on the environment
\r
3392 variable 'KPATHSEA_DEBUG' (if that is set).
\r
3394 Finally, it sets the environment variables 'SELFAUTOLOC',
\r
3395 'SELFAUTODIR' and 'SELFAUTOPARENT' to the location, parent and
\r
3396 grandparent directory of the executable, removing '.' and '..' path
\r
3397 elements and resolving symbolic links. These are used in the
\r
3398 default configuration file to allow people to invoke TeX from
\r
3399 anywhere. You can use 'kpsewhich --expand-var=\$SELFAUTOLOC',
\r
3400 etc., to see the values.
\r
3402 3. Set debugging options. *Note Debugging::. If your program doesn't
\r
3403 have a debugging option already, you can define one and set
\r
3404 'kpse->debug' to the number that the user supplies (as in Dviljk
\r
3405 and Web2c), or you can just omit this altogether (people can always
\r
3406 set 'KPATHSEA_DEBUG'). If you do have runtime debugging already,
\r
3407 you need to merge Kpathsea's options with yours (as in Dvipsk and
\r
3410 4. If your program has its own configuration files that can define
\r
3411 search paths, you should assign those paths to the 'client_path'
\r
3412 member in the appropriate element of the 'kpse->format_info' array.
\r
3413 (This array is indexed by file type; see 'tex-file.h'.) See
\r
3414 'resident.c' in Dvipsk for an example.
\r
3416 5. Call 'kpathsea_init_prog' (see 'proginit.c'). It's useful for the
\r
3417 DVI drivers, at least, but for other programs it may be simpler to
\r
3418 extract the parts of it that actually apply. This does not
\r
3419 initialize any paths, it just looks for (and sets) certain
\r
3420 environment variables and other random information. (A search path
\r
3421 is always initialized at the first call to find a file of that
\r
3422 type; this eliminates much useless work, e.g., initializing the
\r
3423 BibTeX search paths in a DVI driver.)
\r
3425 6. The routine to actually find a file of type FORMAT is
\r
3426 'kpathsea_find_file'. You can call 'kpathsea_find_file' after
\r
3427 doing only the first and second of the initialization steps
\r
3428 above--Kpathsea automatically reads the 'texmf.cnf' generic config
\r
3429 files, looks for environment variables, and does expansions at the
\r
3432 7. To find PK and/or GF bitmap fonts, the routine is
\r
3433 'kpathsea_find_glyph', defined in 'tex-glyph.h'. This returns a
\r
3434 structure in addition to the resultant filename, because fonts can
\r
3435 be found in so many ways. See the documentation in the source.
\r
3437 8. To actually open a file, not just return a filename, call
\r
3438 'kpathsea_open_file'. This function takes the name to look up and
\r
3439 a Kpathsea file format as arguments, and returns the usual 'FILE
\r
3440 *'. It always assumes the file must exist, and thus will search
\r
3441 the disk if necessary (unless the search path specified '!!',
\r
3442 etc.). In other words, if you are looking up a VF or some other
\r
3443 file that need not exist, don't use this.
\r
3445 9. TeX can write output files, via the '\openout' primitive; this
\r
3446 opens a security hole vulnerable to Trojan horse attack: an
\r
3447 unwitting user could run a TeX program that overwrites, say,
\r
3448 '~/.rhosts'. Analogous security holes exist for many other
\r
3449 programs. To alleviate this, there is a configuration variable
\r
3450 'openout_any', which selects one of three levels of security. When
\r
3451 it is set to 'a' (for "any"), no restrictions are imposed. When it
\r
3452 is set to 'r' (for "restricted"), filenames beginning with '.' are
\r
3453 disallowed (except '.tex' because LaTeX needs it). When it is set
\r
3454 to 'p' (for "paranoid") additional restrictions are imposed: an
\r
3455 absolute filename must refer to a file in (a subdirectory) of
\r
3456 'TEXMFOUTPUT', and any attempt to go up a directory level is
\r
3457 forbidden (that is, paths may not contain a '..' component). The
\r
3458 paranoid setting is the default. (For backwards compatibility, 'y'
\r
3459 and '1' are synonyms of 'a', while 'n' and '0' are synonyms for
\r
3460 'r'.) The function 'kpathsea_out_name_ok', with a filename as
\r
3461 second argument, returns 'true' if that filename is acceptable to
\r
3462 be opend for output or 'false' otherwise.
\r
3464 10. Similarly, the function 'kpathsea_in_name_ok', with a filename as
\r
3465 second argument, returns 'true' if that filename is acceptable to
\r
3466 be opend for input or 'false' otherwise, depending on the value of
\r
3467 the configuration variable 'openin_any' (with 'a' as default).
\r
3469 11. To close the kpathsea library instance you are using, call
\r
3470 'kpathsea_finish'. This function closes any open log files and
\r
3471 frees the memory used by the instance.
\r
3473 Kpathsea also provides many utility routines. Some are generic: hash
\r
3474 tables, memory allocation, string concatenation and copying, string
\r
3475 lists, reading input lines of arbitrary length, etc. Others are
\r
3476 filename-related: default path, tilde, and variable expansion, 'stat'
\r
3477 calls, etc. (Perhaps someday I'll move the former to a separate
\r
3480 The 'c-*.h' header files can also help your program adapt to many
\r
3481 different systems. You will almost certainly want to use Autoconf and
\r
3482 probably Automake for configuring and building your software if you use
\r
3483 Kpathsea; I strongly recommend using Autoconf and Automake regardless.
\r
3484 They are available from <ftp://ftp.gnu.og/pub/gnu/>.
\r
3487 File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Calling sequence, Up: Programming
\r
3489 5.3 Program-specific files
\r
3490 ==========================
\r
3492 Many programs will need to find some configuration files. Kpathsea
\r
3493 contains some support to make it easy to place them in their own
\r
3494 directories. The Standard TeX directory structure (*note Introduction:
\r
3495 (tds)Top.), specifies that such files should go into a subdirectory
\r
3496 named after the program, like 'texmf/ttf2pk'.
\r
3498 Two formats, 'kpse_program_text_format' and
\r
3499 'kpse_program_binary_format', use '.:$TEXMF/PROGRAM//' as their
\r
3500 compiled-in search path. To override this default, you can use the
\r
3501 variable 'PROGRAMINPUTS' in the environment and/or 'texmf.cnf'. That is
\r
3502 to say, the name of the variable is constructed by converting the name
\r
3503 of the program to upper case, and appending 'INPUTS'.
\r
3505 The only difference between these two formats is whether
\r
3506 'kpathsea_open_file' will open the files it finds in text or binary
\r
3510 File: kpathsea.info, Node: Programming with config files, Prev: Program-specific files, Up: Programming
\r
3512 5.4 Programming with config files
\r
3513 =================================
\r
3515 You can (and probably should) use the same 'texmf.cnf' configuration
\r
3516 file that Kpathsea uses for your program. This helps installers by
\r
3517 keeping all configuration in one place.
\r
3519 To retrieve a value VAR from config files, the best way is to call
\r
3520 'kpathsea_var_value' on the string 'VAR'. This will look first for an
\r
3521 environment variable VAR, then a config file value. The result will be
\r
3522 the value found or 'NULL'. This function is declared in
\r
3523 'kpathsea/variable.h'. For an example, see the 'shell_escape' code in
\r
3524 'web2c/lib/texmfmp.c'.
\r
3526 The routine to do variable expansion in the context of a search path
\r
3527 (as opposed to simply retrieving a value) is 'kpathsea_var_expand', also
\r
3528 declared in 'kpathsea/variable.h'. It's generally only necessary to set
\r
3529 the search path structure components as explained in the previous
\r
3530 section, rather than using this yourself.
\r
3532 If for some reason you want to retrieve a value _only_ from a config
\r
3533 file, not automatically looking for a corresponding environment
\r
3534 variable, call 'kpathsea_cnf_get' (declared in 'kpathsea/cnf.h') with
\r
3537 No initialization calls are needed.
\r
3540 File: kpathsea.info, Node: Index, Prev: Programming, Up: Top
\r
3548 * !! in path specifications: ls-R. (line 51)
\r
3549 * $ expansion: Variable expansion. (line 6)
\r
3550 * --all: Path searching options.
\r
3552 * --color=tty: ls-R. (line 21)
\r
3553 * --debug=NUM: Auxiliary tasks. (line 9)
\r
3554 * --disable-static: configure options. (line 31)
\r
3555 * --dpi=NUM: Path searching options.
\r
3557 * --enable options: configure options. (line 16)
\r
3558 * --enable-maintainer-mode: configure options. (line 34)
\r
3559 * --enable-shared: configure options. (line 27)
\r
3560 * --enable-shared <1>: Shared library. (line 6)
\r
3561 * --engine=NAME: Path searching options.
\r
3563 * --expand-braces=STRING: Auxiliary tasks. (line 16)
\r
3564 * --expand-path=STRING: Auxiliary tasks. (line 24)
\r
3565 * --expand-var=STRING: Auxiliary tasks. (line 19)
\r
3566 * --format=NAME: Path searching options.
\r
3568 * --help: Standard options. (line 8)
\r
3569 * --interactive: Path searching options.
\r
3571 * --mktex=FILETYPE: Path searching options.
\r
3573 * --mode=STRING: Path searching options.
\r
3575 * --must-exist: Path searching options.
\r
3577 * --no-mktex=FILETYPE: Path searching options.
\r
3579 * --path=STRING: Path searching options.
\r
3581 * --progname=NAME: Path searching options.
\r
3583 * --safe-in-name=NAME: Path searching options.
\r
3585 * --safe-out-name=NAME: Path searching options.
\r
3587 * --show-path=NAME: Auxiliary tasks. (line 41)
\r
3588 * --srcdir, for building multiple architectures: configure scenarios.
\r
3590 * --subdir=STRING: Path searching options.
\r
3592 * --var-value=VARIABLE: Auxiliary tasks. (line 12)
\r
3593 * --version: Standard options. (line 11)
\r
3594 * --with options: configure options. (line 16)
\r
3595 * --with-mktextex-default: mktex configuration. (line 12)
\r
3596 * --without-mktexfmt-default: mktex configuration. (line 12)
\r
3597 * --without-mktexmf-default: mktex configuration. (line 12)
\r
3598 * --without-mktexocp-default: mktex configuration. (line 12)
\r
3599 * --without-mktexofm-default: mktex configuration. (line 12)
\r
3600 * --without-mktexpk-default: mktex configuration. (line 12)
\r
3601 * --without-mktextfm-default: mktex configuration. (line 12)
\r
3602 * -1 debugging value: Debugging. (line 23)
\r
3603 * -A option to 'ls': ls-R. (line 33)
\r
3604 * -Bdynamic: ShellWidgetClass. (line 44)
\r
3605 * -Bstatic: ShellWidgetClass. (line 44)
\r
3606 * -D NUM: Path searching options.
\r
3608 * -dynamic: ShellWidgetClass. (line 42)
\r
3609 * -g, compiling without: configure scenarios. (line 32)
\r
3610 * -L option to 'ls': ls-R. (line 38)
\r
3611 * -O, compiling with: configure scenarios. (line 32)
\r
3612 * -static: ShellWidgetClass. (line 42)
\r
3613 * . directories, ignored: ls-R. (line 33)
\r
3614 * . files: ls-R. (line 33)
\r
3615 * .2602gf: Unable to generate fonts.
\r
3617 * .afm: Supported file formats.
\r
3619 * .base: Supported file formats.
\r
3621 * .bib: Supported file formats.
\r
3623 * .bst: Supported file formats.
\r
3625 * .cid: Supported file formats.
\r
3627 * .cmap: Supported file formats.
\r
3629 * .cnf: Supported file formats.
\r
3631 * .enc: Supported file formats.
\r
3633 * .eps: Supported file formats.
\r
3635 * .epsi: Supported file formats.
\r
3637 * .fea: Supported file formats.
\r
3639 * .fmt: Supported file formats.
\r
3641 * .ist: Supported file formats.
\r
3643 * .lig: Supported file formats.
\r
3645 * .map: Supported file formats.
\r
3647 * .mem: Supported file formats.
\r
3649 * .mf: Supported file formats.
\r
3651 * .mft: Supported file formats.
\r
3653 * .mlbib: Supported file formats.
\r
3655 * .mlbst: Supported file formats.
\r
3657 * .mp: Supported file formats.
\r
3659 * .ocp: Supported file formats.
\r
3661 * .ofm: Supported file formats.
\r
3663 * .opl: Supported file formats.
\r
3665 * .otp: Supported file formats.
\r
3667 * .ovf: Supported file formats.
\r
3669 * .ovp: Supported file formats.
\r
3671 * .pfa: Supported file formats.
\r
3673 * .pfb: Supported file formats.
\r
3675 * .pk: Supported file formats.
\r
3677 * .pool: Supported file formats.
\r
3679 * .pool <1>: Supported file formats.
\r
3681 * .pool <2>: Supported file formats.
\r
3683 * .pro: Supported file formats.
\r
3685 * .rhosts, writable by TeX: Security. (line 10)
\r
3686 * .sfd: Supported file formats.
\r
3688 * .tex: Supported file formats.
\r
3690 * .tex file, included in 'ls-R': ls-R. (line 33)
\r
3691 * .tfm: Supported file formats.
\r
3693 * .ttc: Supported file formats.
\r
3695 * .ttf: Supported file formats.
\r
3697 * .vf: Supported file formats.
\r
3699 * .w: Supported file formats.
\r
3701 * .web: Supported file formats.
\r
3703 * .web <1>: Supported file formats.
\r
3705 * / may not be /: Searching overview. (line 13)
\r
3706 * /, trailing in home directory: Tilde expansion. (line 19)
\r
3707 * //: Subdirectory expansion.
\r
3709 * /afs/... , installing into: Installing files. (line 32)
\r
3710 * /etc/profile: Unable to find files.
\r
3712 * /etc/profile and aliases: ls-R. (line 21)
\r
3713 * /var/tmp/texfonts: mktex configuration. (line 113)
\r
3714 * 2602gf: Unable to generate fonts.
\r
3716 * 8.3 filenames, using: mktex configuration. (line 68)
\r
3717 * : may not be :: Searching overview. (line 13)
\r
3718 * :: expansion: Default expansion. (line 6)
\r
3719 * @VAR@ substitutions: Running configure. (line 6)
\r
3720 * \, line continuation in 'texmf.cnf': Config files. (line 37)
\r
3721 * \openin: Searching overview. (line 31)
\r
3722 * \special, suppressing warnings about: Suppressing warnings.
\r
3724 * { expansion: Brace expansion. (line 6)
\r
3725 * ~ expansion: Tilde expansion. (line 6)
\r
3726 * absolute filenames: Searching overview. (line 52)
\r
3727 * access warnings: Searching overview. (line 56)
\r
3728 * ac_include, Autoconf extension: Running configure. (line 6)
\r
3729 * AFMFONTS: Supported file formats.
\r
3731 * AFS: Installing files. (line 32)
\r
3732 * AIX 4.1 'configure' error: Empty Makefiles. (line 6)
\r
3733 * AIX shells and 'configure': configure shells. (line 14)
\r
3734 * aliases for fonts: Fontmap. (line 6)
\r
3735 * aliases, for filenames: Filename aliases. (line 6)
\r
3736 * all: Suppressing warnings.
\r
3738 * all matches, finding: Path searching options.
\r
3740 * alphabetical order, not: Subdirectory expansion.
\r
3742 * Amiga support: Custom installation. (line 16)
\r
3743 * Andrew File System, installing with: Installing files. (line 32)
\r
3744 * announcement mailing list: Mailing lists. (line 6)
\r
3745 * ANSI C: TeX or Metafont failing.
\r
3747 * API, re-entrant: Programming overview.
\r
3749 * append-only directories and 'mktexpk': Security. (line 36)
\r
3750 * appendonlydir: mktex configuration. (line 60)
\r
3751 * architecture-(in)dependent files, installing only: Installing files.
\r
3753 * architectures, compiling multiple: configure scenarios. (line 18)
\r
3754 * arguments to 'mktex': mktex script arguments.
\r
3756 * argv[0]: Calling sequence. (line 14)
\r
3757 * ash, losing with 'configure': configure shells. (line 19)
\r
3758 * autoconf, recommended: Calling sequence. (line 117)
\r
3759 * automounter, and configuration: configure scenarios. (line 29)
\r
3760 * automounter, and 'ls-R': ls-R. (line 40)
\r
3761 * auxiliary tasks: Auxiliary tasks. (line 6)
\r
3762 * Babel: Kpathsea application distributions.
\r
3764 * Babel <1>: Running make. (line 50)
\r
3765 * Bach, Johann Sebastian: Default expansion. (line 41)
\r
3766 * backslash-newline: Config files. (line 37)
\r
3767 * bash, recommended for running 'configure': configure shells.
\r
3769 * basic glyph lookup: Basic glyph lookup. (line 6)
\r
3770 * Berry, Karl: History. (line 12)
\r
3771 * BIBINPUTS: Supported file formats.
\r
3773 * BIBINPUTS <1>: Supported file formats.
\r
3775 * blank lines, in 'texmf.cnf': Config files. (line 35)
\r
3776 * brace expansion: Brace expansion. (line 6)
\r
3777 * BSD universe: Running make. (line 43)
\r
3778 * bsh, ok with 'configure': configure shells. (line 14)
\r
3779 * BSTINPUTS: Supported file formats.
\r
3781 * BSTINPUTS <1>: Supported file formats.
\r
3783 * bug address: Reporting bugs. (line 8)
\r
3784 * bug checklist: Bug checklist. (line 6)
\r
3785 * bug mailing list: Mailing lists. (line 6)
\r
3786 * bugs, reporting: Reporting bugs. (line 6)
\r
3787 * c-*.h: Calling sequence. (line 117)
\r
3788 * c-auto.h: Programming overview.
\r
3790 * c-auto.in: Running configure. (line 6)
\r
3791 * cache of fonts, local: Security. (line 22)
\r
3792 * calling sequence: Calling sequence. (line 6)
\r
3793 * CC: configure environment.
\r
3795 * cc warnings: Pointer combination warnings.
\r
3797 * cc, compiling with: configure environment.
\r
3799 * CFLAGS: configure environment.
\r
3801 * ChangeLog entry: Bug checklist. (line 55)
\r
3802 * checklist for bug reports: Bug checklist. (line 6)
\r
3803 * checksum: Suppressing warnings.
\r
3805 * circle fonts: Fontmap. (line 19)
\r
3806 * clean Make target: Cleaning up. (line 15)
\r
3807 * client_path in 'kpse->format_info': Calling sequence. (line 47)
\r
3808 * CMAPFONTS: Supported file formats.
\r
3810 * cmr10, as fallback font: Fallback font. (line 15)
\r
3811 * cmr10.vf: Searching overview. (line 31)
\r
3812 * cnf.c: Config files. (line 86)
\r
3813 * cnf.h: Programming with config files.
\r
3815 * code sharing: Shared library. (line 9)
\r
3816 * color printers, configuring: Simple installation. (line 60)
\r
3817 * comments, in fontmap files: Fontmap. (line 27)
\r
3818 * comments, in 'texmf.cnf': Config files. (line 27)
\r
3819 * comments, making: Introduction. (line 23)
\r
3820 * common features in glyph lookup: Basic glyph lookup. (line 6)
\r
3821 * common problems: Common problems. (line 6)
\r
3822 * comp.sys.sun.admin FAQ: ShellWidgetClass. (line 6)
\r
3823 * comp.text.tex: Mailing lists. (line 25)
\r
3824 * compilation: Installation. (line 6)
\r
3825 * compilation value, source for path: Path sources. (line 20)
\r
3826 * compiler bugs: TeX or Metafont failing.
\r
3828 * compiler bugs, finding: TeX or Metafont failing.
\r
3830 * compiler options, additional: Running make. (line 26)
\r
3831 * compiler options, specifying: configure environment.
\r
3833 * compiler, changing: Running make. (line 39)
\r
3834 * compiling on HP-UX: TeX or Metafont failing.
\r
3836 * conditions for use: Introduction. (line 27)
\r
3837 * config files: Config files. (line 6)
\r
3838 * config files, for Kpathsea-using programs: Calling sequence.
\r
3840 * config files, programming with: Programming with config files.
\r
3842 * config.h: Programming overview.
\r
3844 * config.log: Bug checklist. (line 27)
\r
3845 * config.ps: Specially-recognized files.
\r
3847 * config.ps, search path for: Supported file formats.
\r
3849 * config.status: Bug checklist. (line 30)
\r
3850 * configuration: Installation. (line 6)
\r
3851 * configuration bugs: Bug checklist. (line 30)
\r
3852 * configuration compiler options: configure environment.
\r
3854 * configuration file, source for path: Path sources. (line 17)
\r
3855 * configuration files as shell scripts.: Config files. (line 79)
\r
3856 * configuration of 'mktex' scripts: mktex configuration. (line 6)
\r
3857 * configuration of optional features: configure options. (line 16)
\r
3858 * configure error from 'sed': Empty Makefiles. (line 6)
\r
3859 * 'configure' options: configure options. (line 6)
\r
3860 * 'configure' options for 'mktex' scripts: mktex configuration.
\r
3862 * configure, running: Running configure. (line 6)
\r
3863 * context diff: Bug checklist. (line 55)
\r
3864 * continuation character: Config files. (line 37)
\r
3865 * core dumps, reporting: Bug checklist. (line 61)
\r
3866 * CPPFLAGS: configure environment.
\r
3868 * crashes, reporting: Bug checklist. (line 61)
\r
3869 * custom installation: Custom installation. (line 6)
\r
3870 * CWEBINPUTS: Supported file formats.
\r
3872 * database search: Searching overview. (line 17)
\r
3873 * database, for filenames: Filename database. (line 6)
\r
3874 * database, format of: Database format. (line 6)
\r
3875 * debug.h: Debugging. (line 6)
\r
3876 * debugger: Bug checklist. (line 61)
\r
3877 * debugging: Debugging. (line 6)
\r
3878 * debugging options, in Kpathsea-using program: Calling sequence.
\r
3880 * debugging output: Debugging. (line 27)
\r
3881 * debugging with '-g', disabling: configure scenarios. (line 32)
\r
3882 * DEC shells and 'configure': configure shells. (line 25)
\r
3883 * default expansion: Default expansion. (line 6)
\r
3884 * default path features: Default path features.
\r
3886 * default paths, changing: Default path generation.
\r
3888 * default paths, how they're made: Default path generation.
\r
3890 * default_texsizes: Fallback font. (line 6)
\r
3891 * DEFS: configure environment.
\r
3893 * depot: configure scenarios. (line 29)
\r
3894 * device, wrong: Unable to generate fonts.
\r
3896 * directories, changing default installation: Default path generation.
\r
3898 * directories, making append-only: mktex configuration. (line 61)
\r
3899 * directory permissions: Security. (line 51)
\r
3900 * directory structure, for TeX files: TeX directory structure.
\r
3902 * disabling 'mktex' scripts: mktex configuration. (line 6)
\r
3903 * disk search: Searching overview. (line 22)
\r
3904 * disk searching, avoiding: ls-R. (line 51)
\r
3905 * disk space, needed: Disk space. (line 6)
\r
3906 * disk usage, reducing: Logging. (line 6)
\r
3907 * distclean Make target: Cleaning up. (line 6)
\r
3908 * distributions, compiling simultaneously: Kpathsea application distributions.
\r
3910 * distributions, not compiling: Kpathsea application distributions.
\r
3912 * dlclose: dlopen. (line 6)
\r
3913 * dlopen: dlopen. (line 6)
\r
3914 * dlsym: dlopen. (line 6)
\r
3915 * dlsym.c: dlopen. (line 21)
\r
3916 * doc files: Supported file formats.
\r
3918 * DOS compatible names: mktex configuration. (line 68)
\r
3919 * DOS support: Custom installation. (line 16)
\r
3920 * dosnames: mktex configuration. (line 67)
\r
3921 * dot files: ls-R. (line 33)
\r
3922 * doubled colons: Default expansion. (line 6)
\r
3923 * dpiNNN directories: mktex configuration. (line 68)
\r
3924 * DVI drivers: Kpathsea application distributions.
\r
3926 * DVILJMAKEPK: mktex script names. (line 32)
\r
3927 * DVILJSIZES: Fallback font. (line 6)
\r
3928 * dvipdfmx.cfg: Specially-recognized files.
\r
3930 * DVIPSFONTS: Supported file formats.
\r
3932 * DVIPSHEADERS: Supported file formats.
\r
3934 * DVIPSMAKEPK: mktex script names. (line 32)
\r
3935 * DVIPSSIZES: Fallback font. (line 6)
\r
3936 * dynamic creation of files: mktex scripts. (line 6)
\r
3937 * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
\r
3939 * EC fonts, and dynamic source creation: mktex scripts. (line 6)
\r
3940 * elt-dirs.c: Subdirectory expansion.
\r
3942 * elt-dirs.c <1>: Subdirectory expansion.
\r
3944 * enabling 'mktex' scripts: mktex configuration. (line 6)
\r
3945 * ENCFONTS: Supported file formats.
\r
3947 * engine name: Path searching options.
\r
3949 * environment variable, source for path: Path sources. (line 9)
\r
3950 * environment variables for TeX: Supported file formats.
\r
3952 * environment variables in paths: Variable expansion. (line 6)
\r
3953 * environment variables, old: Unable to find files.
\r
3955 * epoch, seconds since: Logging. (line 15)
\r
3956 * error message macros: Calling sequence. (line 22)
\r
3957 * excessive startup time: Slow path searching. (line 6)
\r
3958 * expand.c: Brace expansion. (line 26)
\r
3959 * expanding symlinks: Calling sequence. (line 31)
\r
3960 * expansion, default: Default expansion. (line 6)
\r
3961 * expansion, path element: Searching overview. (line 43)
\r
3962 * expansion, search path: Path expansion. (line 6)
\r
3963 * expansion, subdirectory: Subdirectory expansion.
\r
3965 * expansion, tilde: Tilde expansion. (line 6)
\r
3966 * expansion, variable: Variable expansion. (line 6)
\r
3967 * explicitly relative filenames: Searching overview. (line 52)
\r
3968 * extensions, filename: File lookup. (line 24)
\r
3969 * externally-built filename database: Filename database. (line 6)
\r
3970 * extra colons: Default expansion. (line 6)
\r
3971 * extraclean Make target: Cleaning up. (line 23)
\r
3972 * failed 'mktex...' script invocation: mktex script names. (line 35)
\r
3973 * fallback font: Fallback font. (line 6)
\r
3974 * fallback resolutions: Fallback font. (line 6)
\r
3975 * fallback resolutions, overriding: Running make. (line 10)
\r
3976 * FAQ, comp.sys.sun.admin: ShellWidgetClass. (line 6)
\r
3977 * FAQ, Kpathsea: Common problems. (line 6)
\r
3978 * Farwell, Matthew: Subdirectory expansion.
\r
3980 * features, of default paths: Default path features.
\r
3982 * file formats, supported: Supported file formats.
\r
3984 * file lookup: File lookup. (line 6)
\r
3985 * file permissions: Security. (line 47)
\r
3986 * file types, registering new: Programming overview.
\r
3988 * filename aliases: Filename aliases. (line 6)
\r
3989 * filename database: Filename database. (line 6)
\r
3990 * filename database generation: Filename database generation.
\r
3992 * filenames, absolute or explicitly relative: Searching overview.
\r
3994 * files, unable to find: Unable to find files.
\r
3996 * filesystem search: Searching overview. (line 22)
\r
3997 * floating directories: Searching overview. (line 22)
\r
3998 * fmtutil: mktex script names. (line 10)
\r
3999 * fmtutil.cnf: Specially-recognized files.
\r
4001 * fmtutils.cnf: mktex configuration. (line 24)
\r
4002 * font alias files: Fontmap. (line 6)
\r
4003 * font generation failures: Unable to generate fonts.
\r
4005 * font of last resort: Fallback font. (line 6)
\r
4006 * font set, infinite: mktex scripts. (line 6)
\r
4007 * FONTCIDMAPS: Supported file formats.
\r
4009 * FONTFEATURES: Supported file formats.
\r
4011 * fontmap files: Fontmap. (line 6)
\r
4012 * fontmaps: mktex configuration. (line 86)
\r
4013 * fontmaps <1>: mktex configuration. (line 87)
\r
4014 * fontname: mktex configuration. (line 87)
\r
4015 * fontnames, arbitrary length: Fontmap. (line 15)
\r
4016 * fonts, being created: Simple installation. (line 78)
\r
4017 * FOOINPUTS: Supported file formats.
\r
4019 * FOOINPUTS <1>: Supported file formats.
\r
4021 * fopen, redefined: Debugging. (line 54)
\r
4022 * format of external database: Database format. (line 6)
\r
4023 * FreeBSD 'configure' error: Empty Makefiles. (line 6)
\r
4024 * FreeBSD shells and 'configure': configure shells. (line 19)
\r
4025 * ftp.cs.stanford.edu: unixtex.ftp. (line 20)
\r
4026 * ftp.tug.org: unixtex.ftp. (line 6)
\r
4027 * fundamental purpose of Kpathsea: Introduction. (line 6)
\r
4028 * gcc, compiling with: configure environment.
\r
4030 * gdb, recommended: Bug checklist. (line 61)
\r
4031 * generation of filename database: Filename database generation.
\r
4033 * get_applicationShellWidgetClass: ShellWidgetClass. (line 6)
\r
4034 * get_wmShellWidgetClass: ShellWidgetClass. (line 6)
\r
4035 * gf: Supported file formats.
\r
4037 * GFFONTS: Supported file formats.
\r
4039 * globally writable directories: Security. (line 30)
\r
4040 * glyph lookup: Glyph lookup. (line 6)
\r
4041 * glyph lookup bitmap tolerance: Basic glyph lookup. (line 15)
\r
4042 * GLYPHFONTS: Supported file formats.
\r
4044 * GLYPHFONTS <1>: Supported file formats.
\r
4046 * glyphlist.txt: Specially-recognized files.
\r
4048 * GNU C compiler bugs: TeX or Metafont failing.
\r
4050 * GNU General Public License: Introduction. (line 27)
\r
4051 * group-writable directories: Security. (line 40)
\r
4052 * GSFTOPK_DEBUG (128): Debugging. (line 88)
\r
4053 * hash table buckets, printing: Debugging. (line 105)
\r
4054 * hash table routines: Calling sequence. (line 110)
\r
4055 * hash_summary_only variable for debugging: Debugging. (line 105)
\r
4056 * help, mailing list for general TeX: Mailing lists. (line 25)
\r
4057 * history of Kpathsea: History. (line 6)
\r
4058 * home directories in paths: Tilde expansion. (line 6)
\r
4059 * HOME, as ~ expansion: Tilde expansion. (line 6)
\r
4060 * HP-UX, compiling on: TeX or Metafont failing.
\r
4062 * identifiers, characters valid in: Config files. (line 47)
\r
4063 * illegal pointer combination warnings: Pointer combination warnings.
\r
4065 * include fontmap directive: Fontmap. (line 30)
\r
4066 * INDEXSTYLE: Supported file formats.
\r
4068 * info-tex@shsu.edu: Mailing lists. (line 25)
\r
4069 * input lines, reading: Calling sequence. (line 110)
\r
4070 * install-data Make target: Installing files. (line 28)
\r
4071 * install-exec Make target: Installing files. (line 23)
\r
4072 * installation: Installation. (line 6)
\r
4073 * installation testing: Installation testing.
\r
4075 * installation, architecture-(in)dependent files only: Installing files.
\r
4077 * installation, changing default directories: Default path generation.
\r
4079 * installation, customized: Custom installation. (line 6)
\r
4080 * installation, getting executables instead of: Simple installation.
\r
4082 * installation, simple: Simple installation. (line 6)
\r
4083 * installing files: Installing files. (line 6)
\r
4084 * interactive query: Path searching options.
\r
4086 * interface, not frozen: Introduction. (line 23)
\r
4087 * introduction: Introduction. (line 6)
\r
4088 * 'kdebug:': Debugging. (line 105)
\r
4089 * kdefault.c: Default expansion. (line 48)
\r
4090 * Knuth, Donald E.: History. (line 6)
\r
4091 * Knuth, Donald E., archive of programs by: unixtex.ftp. (line 20)
\r
4092 * Korn shell, losing with 'configure': configure shells. (line 14)
\r
4093 * kpathsae_var_value: Programming with config files.
\r
4095 * Kpathsea config file, source for path: Path sources. (line 17)
\r
4096 * Kpathsea version number: Kpathsea application distributions.
\r
4098 * kpathsea.h: Programming overview.
\r
4100 * kpathsea/README.CONFIGURE: Running configure. (line 15)
\r
4101 * kpathsea_cnf_get: Programming with config files.
\r
4103 * KPATHSEA_DEBUG: Debugging. (line 18)
\r
4104 * KPATHSEA_DEBUG <1>: Calling sequence. (line 28)
\r
4105 * kpathsea_find_file: File lookup. (line 38)
\r
4106 * kpathsea_find_file <1>: Calling sequence. (line 62)
\r
4107 * kpathsea_find_glyph: Glyph lookup. (line 26)
\r
4108 * kpathsea_finish: Calling sequence. (line 106)
\r
4109 * kpathsea_init_prog: Fallback font. (line 15)
\r
4110 * kpathsea_init_prog <1>: Calling sequence. (line 53)
\r
4111 * kpathsea_in_name_ok: Calling sequence. (line 101)
\r
4112 * kpathsea_new: Calling sequence. (line 9)
\r
4113 * kpathsea_open_file: Calling sequence. (line 74)
\r
4114 * kpathsea_out_name_ok: Calling sequence. (line 82)
\r
4115 * kpathsea_set_program_name: Calling sequence. (line 14)
\r
4116 * KPATHSEA_WARNING: Config files. (line 18)
\r
4117 * kpse->debug: Debugging. (line 6)
\r
4118 * kpse->debug <1>: Debugging. (line 18)
\r
4119 * kpse->debug variable: Calling sequence. (line 39)
\r
4120 * kpse->format_info: Calling sequence. (line 47)
\r
4121 * kpse->invocation_name: Calling sequence. (line 22)
\r
4122 * kpse->invocation_short_name: Calling sequence. (line 22)
\r
4123 * kpse->program_name: Calling sequence. (line 22)
\r
4124 * kpsewhich: Invoking kpsewhich. (line 6)
\r
4125 * Kpsewhich, and debugging: Debugging. (line 31)
\r
4126 * KPSE_BITMAP_TOLERANCE: Basic glyph lookup. (line 15)
\r
4127 * KPSE_DEBUG_EXPAND (16): Debugging. (line 68)
\r
4128 * KPSE_DEBUG_FOPEN (4): Debugging. (line 53)
\r
4129 * KPSE_DEBUG_HASH (2): Debugging. (line 46)
\r
4130 * KPSE_DEBUG_PATHS (8): Debugging. (line 60)
\r
4131 * KPSE_DEBUG_SEARCH (32): Debugging. (line 74)
\r
4132 * KPSE_DEBUG_STAT (1): Debugging. (line 38)
\r
4133 * KPSE_DEBUG_VARS (64): Debugging. (line 83)
\r
4134 * KPSE_DOT expansion: KPSE_DOT expansion. (line 6)
\r
4135 * kpse_format_info_type: Debugging. (line 61)
\r
4136 * kpse_init_prog, and 'MAKETEX_MODE': Default path features.
\r
4138 * ksh, losing with 'configure': configure shells. (line 14)
\r
4139 * LaserJet drive: Kpathsea application distributions.
\r
4141 * last-resort font: Fallback font. (line 6)
\r
4142 * LaTeX help mailing list: Mailing lists. (line 25)
\r
4143 * lcircle10: Fontmap. (line 19)
\r
4144 * LDFLAGS: configure environment.
\r
4146 * leading colons: Default expansion. (line 6)
\r
4147 * leaf directories wrongly guessed: Unable to find files.
\r
4149 * leaf directory trick: Subdirectory expansion.
\r
4151 * libdl.a: dlopen. (line 6)
\r
4152 * libraries, changing: Running make. (line 39)
\r
4153 * libraries, specifying additional: configure environment.
\r
4155 * LIBS: configure environment.
\r
4157 * libucb, avoiding: Running make. (line 43)
\r
4158 * license for using the library: Introduction. (line 27)
\r
4159 * LIGFONTS: Supported file formats.
\r
4161 * lines, reading arbitrary-length: Calling sequence. (line 110)
\r
4162 * Linux File System Standard: mktex configuration. (line 113)
\r
4163 * Linux shells and 'configure': configure shells. (line 19)
\r
4164 * lndir for building symlink trees: configure scenarios. (line 18)
\r
4165 * loader options: configure environment.
\r
4167 * loader options, final: Running make. (line 32)
\r
4168 * loader options, initial: Running make. (line 29)
\r
4169 * local cache of fonts: Security. (line 22)
\r
4170 * log file: Logging. (line 6)
\r
4171 * logging successful searches: Logging. (line 6)
\r
4172 * lost+found directory: Searching overview. (line 56)
\r
4173 * lostchar: Suppressing warnings.
\r
4175 * ls-R: Supported file formats.
\r
4177 * ls-R and AFS: Installing files. (line 40)
\r
4178 * ls-R database file: ls-R. (line 6)
\r
4179 * ls-R, simplest build: ls-R. (line 18)
\r
4180 * Mach10 'configure' error: Empty Makefiles. (line 6)
\r
4181 * MacKenzie, David: History. (line 45)
\r
4182 * MacKenzie, David <1>: Subdirectory expansion.
\r
4184 * magic characters: Searching overview. (line 13)
\r
4185 * mailing lists: Mailing lists. (line 6)
\r
4186 * maintainer-clean Make target: Cleaning up. (line 18)
\r
4187 * Make arguments, additional: Running make. (line 35)
\r
4188 * make, running: Running make. (line 6)
\r
4189 * Makefile.in: Running configure. (line 6)
\r
4190 * Makefiles, empty: Empty Makefiles. (line 6)
\r
4191 * MAKETEX_DEBUG (512): Debugging. (line 91)
\r
4192 * MAKETEX_FINE_DEBUG (1024): Debugging. (line 100)
\r
4193 * MAKETEX_MODE: Default path features.
\r
4195 * memory allocation routines: Calling sequence. (line 110)
\r
4196 * metafont driver files: mktex configuration. (line 93)
\r
4197 * Metafont failures: TeX or Metafont failing.
\r
4199 * Metafont installation: Unable to generate fonts.
\r
4201 * Metafont making too-large fonts: Unable to generate fonts.
\r
4203 * Metafont using the wrong device: Unable to generate fonts.
\r
4205 * MFBASES: Supported file formats.
\r
4207 * MFINPUTS: Supported file formats.
\r
4209 * MFPOOL: Supported file formats.
\r
4211 * MFTINPUTS: Supported file formats.
\r
4213 * MISCFONTS: Supported file formats.
\r
4215 * mismatched checksum warnings: Suppressing warnings.
\r
4217 * missfont.log: mktex script names. (line 35)
\r
4218 * MISSFONT_LOG: mktex script names. (line 40)
\r
4219 * missing character warnings: Suppressing warnings.
\r
4221 * mkocp: mktex script names. (line 18)
\r
4222 * mkofm: mktex script names. (line 21)
\r
4223 * 'mktex' script configuration: mktex configuration. (line 6)
\r
4224 * 'mktex' script names: mktex script names. (line 6)
\r
4225 * 'mktex' scripts: mktex scripts. (line 6)
\r
4226 * mktex.cnf: mktex configuration. (line 29)
\r
4227 * mktex.cnf <1>: Specially-recognized files.
\r
4229 * mktex.opt: mktex configuration. (line 29)
\r
4230 * mktex.opt <1>: mktex configuration. (line 39)
\r
4231 * mktexdir: mktex configuration. (line 61)
\r
4232 * mktexfmt: mktex script names. (line 10)
\r
4233 * mktexmf: mktex script names. (line 15)
\r
4234 * mktexpk: mktex script names. (line 24)
\r
4235 * mktexpk , initial runs: Simple installation. (line 78)
\r
4236 * 'mktexpk' can't guess mode: Unable to generate fonts.
\r
4238 * mktextex: mktex script names. (line 27)
\r
4239 * mktextfm: mktex script names. (line 30)
\r
4240 * MLBIBINPUTS: Supported file formats.
\r
4242 * MLBSTINPUTS: Supported file formats.
\r
4244 * mode directory, omitting: mktex configuration. (line 98)
\r
4245 * Morgan, Tim: History. (line 12)
\r
4246 * mostlyclean Make target: Cleaning up. (line 10)
\r
4247 * MPINPUTS: Supported file formats.
\r
4249 * MPMEMS: Supported file formats.
\r
4251 * MPPOOL: Supported file formats.
\r
4253 * MPSUPPORT: Supported file formats.
\r
4255 * MT_FEATURES: mktex configuration. (line 39)
\r
4256 * multiple architectures, compiling on: configure scenarios. (line 18)
\r
4257 * multiple architectures, directories for: configure scenarios.
\r
4259 * multiple architectures, installing on: Installing files. (line 21)
\r
4260 * multiple TeX hierarchies: Brace expansion. (line 20)
\r
4261 * must exist: Searching overview. (line 31)
\r
4262 * names for 'mktex' scripts: mktex script names. (line 6)
\r
4263 * NetBSD 'configure' error: Empty Makefiles. (line 6)
\r
4264 * NetBSD shells and 'configure': configure shells. (line 19)
\r
4265 * Neumann, Gustaf: History. (line 57)
\r
4266 * newsgroup for TeX: Mailing lists. (line 25)
\r
4267 * NeXT 'sed' error: Empty Makefiles. (line 6)
\r
4268 * NeXT, lacking X11: Kpathsea application distributions.
\r
4270 * NFS and 'ls-R': ls-R. (line 40)
\r
4271 * nomfdrivers: mktex configuration. (line 92)
\r
4272 * nomode: mktex configuration. (line 97)
\r
4273 * non-English typesetting: Kpathsea application distributions.
\r
4275 * non-Unix operating systems: Custom installation. (line 16)
\r
4276 * none: Suppressing warnings.
\r
4278 * null pointers, dereferencing: Bug checklist. (line 61)
\r
4279 * numeric debugging values: Debugging. (line 34)
\r
4280 * obtaining TeX: unixtex.ftp. (line 6)
\r
4281 * OCPINPUTS: Supported file formats.
\r
4283 * OFMFONTS: Supported file formats.
\r
4285 * online Metafont display, spurious: Unable to generate fonts.
\r
4287 * OPENTYPEFONTS: Supported file formats.
\r
4289 * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
\r
4291 * optimization caveat: TeX or Metafont failing.
\r
4293 * optimization, enabling: configure scenarios. (line 32)
\r
4294 * options for debugging: Debugging. (line 6)
\r
4295 * options to 'configure': configure options. (line 16)
\r
4296 * OS/2 support: Custom installation. (line 16)
\r
4297 * OTPINPUTS: Supported file formats.
\r
4299 * overview of path searching: Searching overview. (line 6)
\r
4300 * overview of programming with Kpathsea: Programming overview.
\r
4302 * OVFFONTS: Supported file formats.
\r
4304 * OVPFONTS: Supported file formats.
\r
4306 * patches, Sun OpenWin: ShellWidgetClass. (line 28)
\r
4307 * path expansion: Path expansion. (line 6)
\r
4308 * path searching: Path searching. (line 6)
\r
4309 * path searching options: Path searching options.
\r
4311 * path searching, overview: Searching overview. (line 6)
\r
4312 * path searching, standalone: Invoking kpsewhich. (line 6)
\r
4313 * path sources: Path sources. (line 6)
\r
4314 * paths, changing default: Changing search paths.
\r
4316 * paths, changing default <1>: Default path generation.
\r
4318 * paths, device name included in: Default path features.
\r
4320 * paths.h: Default path generation.
\r
4322 * paths.h, creating: Running make. (line 6)
\r
4323 * pathsearch.h: Programming overview.
\r
4325 * pc Pascal compiler: History. (line 12)
\r
4326 * PCL driver: Kpathsea application distributions.
\r
4328 * PDF generation: Kpathsea application distributions.
\r
4330 * pdfglyphlist.txt: Specially-recognized files.
\r
4332 * pdftex.cfg: Specially-recognized files.
\r
4334 * PDFTEXCONFIG: Supported file formats.
\r
4336 * pdftexconfig.tex: Specially-recognized files.
\r
4338 * permission denied: Searching overview. (line 56)
\r
4339 * permissions, directory: Security. (line 51)
\r
4340 * permissions, file: Security. (line 47)
\r
4341 * PKFONTS: Supported file formats.
\r
4343 * plain.base: Unable to generate fonts.
\r
4345 * pointer combination warnings: Pointer combination warnings.
\r
4347 * PostScript driver: Kpathsea application distributions.
\r
4349 * PostScript fonts, additional: Simple installation. (line 60)
\r
4350 * precompiled executables, instead of installation: Simple installation.
\r
4352 * preprocessor options: configure environment.
\r
4354 * preprocessor options, additional: Running make. (line 23)
\r
4355 * printer configuration files: Simple installation. (line 60)
\r
4356 * privacy, semblance of: Logging. (line 32)
\r
4357 * problems, common: Common problems. (line 6)
\r
4358 * proginit.c: Default path features.
\r
4360 * proginit.h: Calling sequence. (line 53)
\r
4361 * program-varying paths: Supported file formats.
\r
4363 * programming overview: Programming overview.
\r
4365 * programming with config files: Programming with config files.
\r
4367 * programming with Kpathsea: Calling sequence. (line 6)
\r
4368 * programs using the library: Introduction. (line 13)
\r
4369 * proof mode: Unable to generate fonts.
\r
4371 * PSHEADERS: Supported file formats.
\r
4373 * pxp Pascal preprocessor: History. (line 12)
\r
4374 * quoting variable values: Variable expansion. (line 17)
\r
4375 * re-entrant API: Programming overview.
\r
4377 * readable: Suppressing warnings.
\r
4379 * reading arbitrary-length lines: Calling sequence. (line 110)
\r
4380 * README.CONFIGURE: Running configure. (line 15)
\r
4381 * recording successful searches: Logging. (line 6)
\r
4382 * relative filenames: Searching overview. (line 52)
\r
4383 * relative filenames in 'ls-R': Installing files. (line 40)
\r
4384 * reporting bugs: Reporting bugs. (line 6)
\r
4385 * resident.c: Calling sequence. (line 47)
\r
4386 * resolution, setting: Path searching options.
\r
4388 * resolutions, last-resort: Fallback font. (line 6)
\r
4389 * retrieving TeX: unixtex.ftp. (line 6)
\r
4390 * right-hand side of variable assignments: Config files. (line 56)
\r
4391 * Rokicki, Tom: History. (line 12)
\r
4392 * root user: Tilde expansion. (line 19)
\r
4393 * runtime configuration files: Config files. (line 6)
\r
4394 * runtime debugging: Debugging. (line 6)
\r
4395 * Sauter fonts, and dynamic source creation: mktex scripts. (line 6)
\r
4396 * scripts for file creation: mktex scripts. (line 6)
\r
4397 * search path, defined: Searching overview. (line 6)
\r
4398 * search paths, changing default: Changing search paths.
\r
4400 * searching for files: File lookup. (line 6)
\r
4401 * searching for glyphs: Glyph lookup. (line 6)
\r
4402 * searching overview: Searching overview. (line 6)
\r
4403 * searching the database: Searching overview. (line 17)
\r
4404 * searching the disk: Searching overview. (line 22)
\r
4405 * security considerations: Security. (line 6)
\r
4406 * sed error from 'configure': Empty Makefiles. (line 6)
\r
4407 * SELFAUTODIR: Calling sequence. (line 31)
\r
4408 * SELFAUTOLOC: Calling sequence. (line 31)
\r
4409 * SELFAUTOPARENT: Calling sequence. (line 31)
\r
4410 * sending patches: Bug checklist. (line 55)
\r
4411 * setgid scripts: Security. (line 40)
\r
4412 * SFDFONTS: Supported file formats.
\r
4414 * sh5, ok with 'configure': configure shells. (line 25)
\r
4415 * shared library, making: Shared library. (line 6)
\r
4416 * shell scripts as configuration files: Config files. (line 79)
\r
4417 * shell variables: Variable expansion. (line 17)
\r
4418 * shells and 'configure': configure shells. (line 6)
\r
4419 * shell_escape, example for code: Programming with config files.
\r
4421 * simple installation: Simple installation. (line 6)
\r
4422 * site overrides for 'mktex...': mktex configuration. (line 29)
\r
4423 * size of distribution archives: Disk space. (line 6)
\r
4424 * skeleton TeX directory: TeX directory structure.
\r
4426 * slow startup time: Slow path searching. (line 6)
\r
4427 * Solaris BSD compatibility, not: Running make. (line 43)
\r
4428 * source files: Supported file formats.
\r
4430 * sources for search paths: Path sources. (line 6)
\r
4431 * special: Suppressing warnings.
\r
4433 * stack trace: Bug checklist. (line 61)
\r
4434 * standalone path searching: Invoking kpsewhich. (line 6)
\r
4435 * standard error and debugging output: Debugging. (line 27)
\r
4436 * standard options: Standard options. (line 6)
\r
4437 * startup time, excessive: Slow path searching. (line 6)
\r
4438 * static linking: ShellWidgetClass. (line 38)
\r
4439 * static linking and 'dlsym': dlopen. (line 6)
\r
4440 * string routines: Calling sequence. (line 110)
\r
4441 * strip: mktex configuration. (line 107)
\r
4442 * stripsupplier: mktex configuration. (line 101)
\r
4443 * striptypeface: mktex configuration. (line 104)
\r
4444 * st_nlink: Subdirectory expansion.
\r
4446 * ST_NLINK_TRICK: Subdirectory expansion.
\r
4448 * subdirectory searching: Subdirectory expansion.
\r
4450 * suffixes, filename: File lookup. (line 24)
\r
4451 * suggestions, making: Introduction. (line 23)
\r
4452 * Sun 2: History. (line 12)
\r
4453 * Sun OpenWin patches: ShellWidgetClass. (line 28)
\r
4454 * supplier directory, omitting: mktex configuration. (line 102)
\r
4455 * supplier directory, omitting <1>: mktex configuration. (line 108)
\r
4456 * supported file formats: Supported file formats.
\r
4458 * suppressing warnings: Suppressing warnings.
\r
4460 * symbolic link trees, for multiple architectures: configure scenarios.
\r
4462 * symbolic links not found: Unable to find files.
\r
4464 * symbolic links, and 'ls-R': ls-R. (line 38)
\r
4465 * symlinks, resolving: Calling sequence. (line 31)
\r
4466 * system C compiler bugs: TeX or Metafont failing.
\r
4468 * system dependencies: Running configure. (line 6)
\r
4469 * system V universe: Running make. (line 43)
\r
4470 * T1FONTS: Supported file formats.
\r
4472 * T1INPUTS: Supported file formats.
\r
4474 * T42FONTS: Supported file formats.
\r
4476 * tcfmgr.map: Specially-recognized files.
\r
4478 * TDS: Default path features.
\r
4480 * TDS <1>: TeX directory structure.
\r
4482 * testing, post-installation: Installation testing.
\r
4484 * tests, simple: Simple installation. (line 78)
\r
4485 * TeX directory structure: Default path features.
\r
4487 * TeX directory structure <1>: TeX directory structure.
\r
4489 * TeX environment variables: Supported file formats.
\r
4491 * TeX failures: TeX or Metafont failing.
\r
4493 * TeX file lookup: File lookup. (line 6)
\r
4494 * TeX glyph lookup: Glyph lookup. (line 6)
\r
4495 * TeX help mailing list: Mailing lists. (line 25)
\r
4496 * TeX hierarchy, one: configure scenarios. (line 13)
\r
4497 * TeX support: TeX support. (line 6)
\r
4498 * TeX Users Group: Introduction. (line 35)
\r
4499 * tex-file.c: File lookup. (line 38)
\r
4500 * tex-file.h: Programming overview.
\r
4502 * tex-glyph.c: Glyph lookup. (line 26)
\r
4503 * tex-glyph.h: Programming overview.
\r
4505 * tex-k-request@tug.org: Mailing lists. (line 7)
\r
4506 * tex-k@tug.org (bug address): Reporting bugs. (line 8)
\r
4507 * tex.web: unixtex.ftp. (line 20)
\r
4508 * TEXBIB: Supported file formats.
\r
4510 * TEXBIB <1>: Supported file formats.
\r
4512 * TEXCONFIG: Supported file formats.
\r
4514 * TEXDOCS: Supported file formats.
\r
4516 * TEXFONTMAPS: Supported file formats.
\r
4518 * TEXFONTS: Supported file formats.
\r
4520 * TEXFONTS <1>: Supported file formats.
\r
4522 * TEXFONTS <2>: Supported file formats.
\r
4524 * TEXFONTS <3>: Supported file formats.
\r
4526 * texfonts.map: Fontmap. (line 6)
\r
4527 * TEXFORMATS: Supported file formats.
\r
4529 * TEXINDEXSTYLE: Supported file formats.
\r
4531 * TEXINPUTS: Supported file formats.
\r
4533 * TEXINPUTS <1>: Supported file formats.
\r
4535 * TEXMF: TeX directory structure.
\r
4537 * texmf.cnf: Specially-recognized files.
\r
4539 * 'texmf.cnf' missing, warning about: Config files. (line 18)
\r
4540 * texmf.cnf, and variable expansion: Variable expansion. (line 6)
\r
4541 * texmf.cnf, creating: Running make. (line 6)
\r
4542 * texmf.cnf, definition for: Config files. (line 6)
\r
4543 * texmf.cnf, generated: Default path generation.
\r
4545 * texmf.cnf, source for path: Path sources. (line 17)
\r
4546 * texmf.in: Default path generation.
\r
4548 * texmf.in, editing: Changing search paths.
\r
4550 * texmf.sed: Default path generation.
\r
4552 * TEXMFCNF: Config files. (line 6)
\r
4553 * TEXMFCNF <1>: Supported file formats.
\r
4555 * TEXMFDBS: ls-R. (line 6)
\r
4556 * TEXMFDBS <1>: Supported file formats.
\r
4558 * TEXMFINI: Supported file formats.
\r
4560 * TEXMFINI <1>: Supported file formats.
\r
4562 * TEXMFINI <2>: Supported file formats.
\r
4564 * TEXMFLOG: Logging. (line 10)
\r
4565 * TEXMFOUTPUT: mktex script names. (line 40)
\r
4566 * TEXMFSCRIPTS: Supported file formats.
\r
4568 * texmfvar: mktex configuration. (line 122)
\r
4569 * TEXMFVAR: mktex configuration. (line 123)
\r
4570 * TEXPICTS: Supported file formats.
\r
4572 * TEXPKS: Supported file formats.
\r
4574 * TEXPOOL: Supported file formats.
\r
4576 * TEXPSHEADERS: Supported file formats.
\r
4578 * TEXPSHEADERS <1>: Supported file formats.
\r
4580 * TEXSIZES: Fallback font. (line 6)
\r
4581 * TEXSOURCES: Supported file formats.
\r
4583 * TEX_HUSH: Searching overview. (line 56)
\r
4584 * TEX_HUSH <1>: Suppressing warnings.
\r
4586 * TFMFONTS: Supported file formats.
\r
4588 * tilde expansion: Tilde expansion. (line 6)
\r
4589 * tilde.c: Tilde expansion. (line 25)
\r
4590 * time system call: Logging. (line 15)
\r
4591 * tolerance for glyph lookup: Basic glyph lookup. (line 15)
\r
4592 * total disk space: Disk space. (line 6)
\r
4593 * trailing '/' in home directory: Tilde expansion. (line 19)
\r
4594 * trailing colons: Default expansion. (line 6)
\r
4595 * TRFONTS: Supported file formats.
\r
4597 * trick for detecting leaf directories: Subdirectory expansion.
\r
4599 * trojan horse attack: Security. (line 10)
\r
4600 * try_std_extension_first: File lookup. (line 24)
\r
4601 * TTFONTS: Supported file formats.
\r
4603 * tug.org: unixtex.ftp. (line 6)
\r
4604 * typeface directory, omitting: mktex configuration. (line 105)
\r
4605 * typeface directory, omitting <1>: mktex configuration. (line 108)
\r
4606 * ucbinclude, avoiding: Running make. (line 43)
\r
4607 * Ultrix shells and 'configure': configure shells. (line 25)
\r
4608 * unable to find files: Unable to find files.
\r
4610 * unable to generate fonts: Unable to generate fonts.
\r
4612 * uname: Bug checklist. (line 20)
\r
4613 * universe, BSD vs. system V: Running make. (line 43)
\r
4614 * unixtex.ftp: unixtex.ftp. (line 6)
\r
4615 * unknown special warnings: Suppressing warnings.
\r
4617 * unreadable file warnings: Suppressing warnings.
\r
4619 * unreadable files: Searching overview. (line 56)
\r
4620 * unusable 'ls-R' warning: ls-R. (line 45)
\r
4621 * usage patterns, finding: Logging. (line 6)
\r
4622 * Usenet TeX newsgroup: Mailing lists. (line 25)
\r
4623 * USERPROFILE, as ~ expansion: Tilde expansion. (line 6)
\r
4624 * USE_TEXMFVAR: mktex configuration. (line 128)
\r
4625 * USE_VARTEXFONTS: mktex configuration. (line 118)
\r
4626 * varfonts: mktex configuration. (line 112)
\r
4627 * variable expansion: Variable expansion. (line 6)
\r
4628 * variable.c: Variable expansion. (line 32)
\r
4629 * variable.h: Programming with config files.
\r
4631 * VARTEXFONTS: mktex configuration. (line 113)
\r
4632 * VAX 11/750: History. (line 12)
\r
4633 * version number, of Kpathsea: Kpathsea application distributions.
\r
4635 * version numbers, determining: Bug checklist. (line 15)
\r
4636 * VF files, not found: Searching overview. (line 31)
\r
4637 * VFFONTS: Supported file formats.
\r
4639 * VMS support: Custom installation. (line 16)
\r
4640 * Vojta, Paul: History. (line 30)
\r
4641 * Walsh, Norman: History. (line 57)
\r
4642 * warning about unusable 'ls-R': ls-R. (line 45)
\r
4643 * warning, about missing 'texmf.cnf': Config files. (line 18)
\r
4644 * warnings, file access: Searching overview. (line 56)
\r
4645 * warnings, pointer combinations: Pointer combination warnings.
\r
4647 * warnings, suppressing: Suppressing warnings.
\r
4649 * wcstombs: dlopen. (line 6)
\r
4650 * WEB2C: Supported file formats.
\r
4652 * Weber, Olaf: History. (line 74)
\r
4653 * WEBINPUTS: Supported file formats.
\r
4655 * whitespace, in fontmap files: Fontmap. (line 27)
\r
4656 * whitespace, not ignored on continuation lines: Config files.
\r
4658 * www.tug.org: unixtex.ftp. (line 6)
\r
4659 * X11 previewer: Kpathsea application distributions.
\r
4661 * X11, lacking on NeXT: Kpathsea application distributions.
\r
4663 * XCFLAGS: Running make. (line 25)
\r
4664 * XCPPFLAGS: Running make. (line 21)
\r
4665 * XDEFS: Running make. (line 22)
\r
4666 * XDvi: Specially-recognized files.
\r
4668 * XDVIFONTS: Supported file formats.
\r
4670 * XDVIMAKEPK: mktex script names. (line 32)
\r
4671 * XDVISIZES: Fallback font. (line 6)
\r
4672 * XLDFLAGS: Running make. (line 28)
\r
4673 * XLOADLIBES: Running make. (line 31)
\r
4674 * XMAKEARGS: Running make. (line 34)
\r
4675 * Xmu library problems: ShellWidgetClass. (line 13)
\r
4676 * XtStrings: XtStrings. (line 6)
\r
4677 * zuhn, david: History. (line 51)
\r
4683 Node: Introduction
\7f2124
\r
4684 Node: History
\7f3942
\r
4685 Node: Installation
\7f8034
\r
4686 Node: Simple installation
\7f8828
\r
4687 Node: Custom installation
\7f12376
\r
4688 Node: Disk space
\7f13697
\r
4689 Node: Kpathsea application distributions
\7f14505
\r
4690 Node: Changing search paths
\7f15619
\r
4691 Node: Default path features
\7f16812
\r
4692 Node: Default path generation
\7f18895
\r
4693 Node: Running configure
\7f20338
\r
4694 Node: configure shells
\7f21421
\r
4695 Node: configure options
\7f22470
\r
4696 Node: configure environment
\7f23976
\r
4697 Node: configure scenarios
\7f25778
\r
4698 Node: Shared library
\7f27364
\r
4699 Node: Running make
\7f28378
\r
4700 Node: Installing files
\7f30426
\r
4701 Node: Cleaning up
\7f32370
\r
4702 Node: Filename database generation
\7f33418
\r
4703 Node: mktex scripts
\7f33982
\r
4704 Node: mktex configuration
\7f35246
\r
4705 Node: mktex script names
\7f41053
\r
4706 Node: mktex script arguments
\7f42443
\r
4707 Node: Installation testing
\7f43326
\r
4708 Node: Security
\7f43681
\r
4709 Node: TeX directory structure
\7f46206
\r
4710 Node: unixtex.ftp
\7f50627
\r
4711 Node: Reporting bugs
\7f51962
\r
4712 Node: Bug checklist
\7f52700
\r
4713 Node: Mailing lists
\7f56397
\r
4714 Node: Debugging
\7f57606
\r
4715 Node: Logging
\7f62692
\r
4716 Node: Common problems
\7f64563
\r
4717 Node: Unable to find files
\7f65394
\r
4718 Node: Slow path searching
\7f67808
\r
4719 Node: Unable to generate fonts
\7f69187
\r
4720 Node: TeX or Metafont failing
\7f71667
\r
4721 Node: Empty Makefiles
\7f73543
\r
4722 Node: XtStrings
\7f74782
\r
4723 Node: dlopen
\7f75618
\r
4724 Node: ShellWidgetClass
\7f76436
\r
4725 Node: Pointer combination warnings
\7f78048
\r
4726 Node: Path searching
\7f78437
\r
4727 Node: Searching overview
\7f79084
\r
4728 Node: Path sources
\7f82479
\r
4729 Node: Config files
\7f83537
\r
4730 Node: Path expansion
\7f87464
\r
4731 Node: Default expansion
\7f88413
\r
4732 Node: Variable expansion
\7f90483
\r
4733 Node: Tilde expansion
\7f91884
\r
4734 Node: Brace expansion
\7f92864
\r
4735 Node: KPSE_DOT expansion
\7f93789
\r
4736 Node: Subdirectory expansion
\7f94302
\r
4737 Node: Filename database
\7f96656
\r
4738 Node: ls-R
\7f97710
\r
4739 Node: Filename aliases
\7f100605
\r
4740 Node: Database format
\7f101783
\r
4741 Node: Invoking kpsewhich
\7f102796
\r
4742 Node: Path searching options
\7f103740
\r
4743 Node: Specially-recognized files
\7f111946
\r
4744 Node: Auxiliary tasks
\7f113301
\r
4745 Node: Standard options
\7f115126
\r
4746 Node: TeX support
\7f115482
\r
4747 Node: Supported file formats
\7f116773
\r
4748 Node: File lookup
\7f123972
\r
4749 Node: Glyph lookup
\7f125721
\r
4750 Node: Basic glyph lookup
\7f126845
\r
4751 Node: Fontmap
\7f127725
\r
4752 Node: Fallback font
\7f130314
\r
4753 Node: Suppressing warnings
\7f131226
\r
4754 Node: Programming
\7f132331
\r
4755 Node: Programming overview
\7f132844
\r
4756 Node: Calling sequence
\7f135541
\r
4757 Node: Program-specific files
\7f142071
\r
4758 Node: Programming with config files
\7f143094
\r
4759 Node: Index
\7f144406
\r