1 This is kpathsea.info, produced by makeinfo version 4.12 from
4 This file documents the Kpathsea library for path searching.
6 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
7 2005, 2007, 2008 Karl Berry & Olaf Weber.
9 Permission is granted to make and distribute verbatim copies of this
10 manual provided the copyright notice and this permission notice are
11 preserved on all copies.
13 Permission is granted to copy and distribute modified versions of
14 this manual under the conditions for verbatim copying, provided that the
15 entire resulting derived work is distributed under the terms of a
16 permission notice identical to this one.
18 Permission is granted to copy and distribute translations of this
19 manual into another language, under the above conditions for modified
20 versions, except that this permission notice may be stated in a
21 translation approved by the Free Software Foundation.
25 * Kpathsea: (kpathsea). File lookup along search paths.
26 * kpsewhich: (kpathsea)Invoking kpsewhich. TeX file searching.
27 * mktexfmt: (kpathsea)mktex scripts. Format (fmt/base/mem) generation.
28 * mktexlsr: (kpathsea)Filename database. Update ls-R.
29 * mktexmf: (kpathsea)mktex scripts. MF source generation.
30 * mktexpk: (kpathsea)mktex scripts. PK bitmap generation.
31 * mktextex: (kpathsea)mktex scripts. TeX source generation.
32 * mktextfm: (kpathsea)mktex scripts. TeX font metric generation.
36 File: kpathsea.info, Node: Top, Next: Introduction, Up: (dir)
41 This manual documents how to install and use the Kpathsea library for
42 filename lookup. It corresponds to version 3.5.7, released in
47 * Introduction:: Overview.
48 * Installation:: Compilation, installation, and bug reporting.
50 * Path searching:: How filename lookups work.
51 * TeX support:: Special support for TeX-related file lookups.
53 * Programming:: How to use Kpathsea features in your program.
55 * Index:: General index.
58 File: kpathsea.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
63 This manual corresponds to version 3.5.7 of the Kpathsea library,
64 released in July 2008.
66 The library's fundamental purpose is to return a filename from a
67 list of directories specified by the user, similar to what shells do
68 when looking up program names to execute.
70 The following software, all of which we maintain, uses this library:
72 * Dviljk (see the `dvilj' man page)
74 * Dvipsk (*note Introduction: (dvips)Top.)
76 * GNU font utilities (*note Introduction: (fontu)Top.)
78 * Web2c (*note Introduction: (web2c)Top.)
80 * Xdvik (see the `xdvi' man page)
82 Other software that we do not maintain also uses it.
84 We are still actively maintaining the library (and probably always
85 will be, despite our hopes). If you have comments or suggestions,
86 please send them to us (*note Reporting bugs::).
88 We distribute the library under the GNU Library General Public
89 License (LGPL). In short, this means if you write a program using the
90 library, you must (offer to) distribute the source to the library,
91 along with any changes you have made, and allow anyone to modify the
92 library source and distribute their modifications. It does not mean
93 you have to distribute the source to your program, although we hope you
94 will. See the files `GPL' and `LGPL' for the text of the GNU licenses.
96 If you know enough about TeX to be reading this manual, then you (or
97 your institution) should consider joining the TeX Users Group (if
98 you're already a member, great!). TUG produces the periodical
99 `TUGboat', sponsors an annual meeting and publishes the proceedings,
100 and arranges courses on TeX for all levels of users throughout the
101 world. Anyway, here is the address:
105 Portland OR 97208-2311
107 phone: +1 503 223-9994
116 File: kpathsea.info, Node: History, Up: Introduction
121 (This section is for those people who are curious about how the library
122 came about.) (If you like to read historical accounts of software, we
123 urge you to seek out the GNU Autoconf manual and the "Errors of TeX"
124 paper by Don Knuth, published in `Software--Practice and Experience'
127 [Karl writes.] My first ChangeLog entry for Web2c seems to be
128 February 1990, but I may have done some work before then. In any case,
129 Tim Morgan and I were jointly maintaining it for a time. (I should
130 mention here that Tim had made Web2c into a real distribution long
131 before I had ever used it or even heard of it, and Tom Rokicki did the
132 original implementation. I was using `pxp' and `pc' on VAX 11/750's
133 and the hot new Sun 2 machines.)
135 It must have been later in 1990 and 1991 that I started working on
136 `TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
137 (which I was also writing at the time) all used different environment
138 variables, and, more importantly, had different bugs in their path
139 searching. This became extremely painful, as I was stressing everything
140 to the limit working on the book. I also desperately wanted to
141 implement subdirectory searching, since I couldn't stand putting
142 everything in one big directory, and also couldn't stand having to
143 explicitly specify `cm', `pandora', ... in a path.
145 In the first incarnation, I just hacked separately on each
146 program--that was the original subdirectory searching code in both Xdvi
147 and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
148 support by now. That is, I tried to go with the flow in each program,
149 rather than changing the program's calling sequences to conform to
152 Then, as bugs inevitably appeared, I found I was fixing the same
153 thing three times (Web2c and fontutils were always sharing code, since I
154 maintained those--there was no Dvipsk or Xdvik or Dviljk at this
155 point). After a while, I finally started sharing source files. They
156 weren't yet a library, though. I just kept things up to date with shell
157 scripts. (I was developing on a 386 running ISC 2.2 at the time, and so
158 didn't have symbolic links. An awful experience.)
160 The ChangeLogs for Xdvik and Dvipsk record initial releases of those
161 distributions in May and June 1992. I think it was because I was tired
162 of the different configuration strategies of each program, not so much
163 because of the path searching. (Autoconf was being developed by David
164 MacKenzie and others, and I was adapting it to TeX and friends.)
166 I started to make a separate library that other programs could link
167 with on my birthday in April 1993, according to the ChangeLog. I don't
168 remember exactly why I finally took the time to make it a separate
169 library; a conversation with david zuhn that initiated it. Just seemed
172 Dviljk got started in March 1994 after I bought a Laserjet 4.
173 (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
174 Neumann's help, implemented a way for TeX to get at all those neat
175 builtin LJ4 fonts ... such a treat to have something to typeset in
178 By spring of 1995, I had implemented just about all the
179 path-searching features in Kpathsea that I plan to, driven beyond my
180 initial goals by Thomas Esser and others. I then started to integrate
181 Web2c with Kpathsea. After the release of a stable Web2c, I hope to be
182 able to stop development, and turn most of my attention back to making
183 fonts for GNU. (Always assuming Micros**t hasn't completely
184 obliterated Unix by then, or that software patents haven't stopped
185 software development by anybody smaller than a company with a
186 million-dollar-a-year legal budget. Which is actually what I think is
187 likely to happen, but that's another story...)
189 [Olaf writes.] At the end of 1997, UNIX is still alive and kicking,
190 individuals still develop software, and Web2c development still
191 continues. Karl had been looking for some time for someone to take up
192 part of the burden, and I volunteered.
195 File: kpathsea.info, Node: Installation, Next: Path searching, Prev: Introduction, Up: Top
200 (A copy of this chapter is in the distribution file `kpathsea/INSTALL'.)
202 The procedure for Kpathsea (and Web2c, etc.) configuration and
203 installation follows. If you encounter trouble, see *note Common
204 problems::, a copy of which is in the file `kpathsea/BUGS'.
208 * Simple installation:: If you just want to do it.
209 * Custom installation:: If you want to change things around.
210 * Security:: Who can write what files, etc.
211 * TeX directory structure:: Managing the horde of TeX input files.
212 * unixtex.ftp:: Getting software via FTP, on CD-ROM, or on tape.
213 * Reporting bugs:: Where and how to report bugs.
216 File: kpathsea.info, Node: Simple installation, Next: Custom installation, Up: Installation
218 2.1 Simple installation
219 =======================
221 Installing TeX and friends for the first time can be a daunting
222 experience. Thus, you may prefer to skip this whole thing and just get
223 precompiled executables: see *note unixtex.ftp::.
225 This section explains what to do if you wish to take the defaults for
226 everything, and generally to install in the simplest possible way. Most
227 steps here refer to corresponding subsection in the next section which
228 explains how to override defaults and generally gives more details.
230 By default everything will be installed under `/usr/local' and the
231 following discussion assumes this. However, if you already have TeX
232 installed, its location is used to derive the directory under which
233 everything is to be installed.
235 1. Be sure you have enough disk space: approximately 8 megabytes for
236 the compressed archives, 15MB for sources, 50MB for compilation,
237 40MB for the (initial) installed system (including library files).
240 2. Retrieve these distribution archives:
241 `ftp://ftp.tug.org/tex/texk.tar.gz'
242 These are the sources, which you will be compiling.
244 `ftp://ftp.tug.org/tex/texklib.tar.gz'
245 This is a basic set of input files. You should unpack it in
246 the directory `/usr/local/share'; doing so will create a
247 `texmf' subdirectory there.
249 These archives are mirrored on the CTAN hosts, in the
250 `systems/web2c' directory.
252 *Note Kpathsea application distributions::.
254 3. When using the default search paths, there is no need to edit any
255 distribution files. *Note Changing search paths::.
257 4. At the top level of the distribution, run `sh configure'. (If you
258 have the GNU Bash shell installed, run `bash configure'.) *Note
261 5. `make'. *Note Running make::. If you are using a BSD 4.4 system
262 such as FreeBSD or NetBSD, you may have to use GNU make (often
263 installed in `/usr/local/bin'), not the BSD make.
265 6. `make install'. *Note Installing files::.
267 7. `make distclean'. *Note Cleaning up::.
269 8. Set up a cron job to rebuild the filename database that makes
270 searching faster. This line will rebuild it every midnight:
271 0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
272 *Note Filename database generation::, and *note Filename
275 9. If you're installing Dvips, you also need to set up configuration
276 files for your printers and make any additional PostScript fonts
277 available. *Note Installation: (dvips)Installation. If you have
278 any color printers, see *note Color device configuration:
279 (dvips)Color device configuration.
281 10. The first time you run a DVI driver, a bunch of PK fonts will be
282 built by Metafont via `mktexpk' (and added to the filename
283 database). This will take some time. Don't be alarmed; they will
284 created only this first time (unless something is wrong with your
287 By default, `mktexpk' will create these fonts in a hierarchy under
288 `/var/tmp/texfonts'; it simply assumes that `/var/tmp' exists and
289 is globally writable. If you need a different arrangement, see
290 *note mktex configuration::.
292 *Note mktex scripts::.
294 11. For some simple tests, try `tex story \\bye' and `latex sample2e'.
295 Then run `xdvi story' or `dvips sample2e' on the resulting DVI
296 files to preview/print the documents. *Note Installation
300 File: kpathsea.info, Node: Custom installation, Next: Security, Prev: Simple installation, Up: Installation
302 2.2 Custom installation
303 =======================
305 Most sites need to modify the default installation procedure in some
306 way, perhaps merely changing the prefix from `/usr/local', perhaps
307 adding extra compiler or loader options to work around `configure'
308 bugs. This section explains how to override default choices. For
309 additional distribution-specific information:
312 * *Note Installation: (dvips)Installation.
314 * *Note Installation: (web2c)Installation.
318 These instructions are for Unix systems. Other operating-system
319 specific distributions have their own instructions. The code base
320 itself supports Amiga, DOS, OS/2, and VMS.
322 Following are the same steps as in the previous section (which
323 describes the simplest installation), but with much more detail.
328 * Kpathsea application distributions::
329 * Changing search paths::
330 * Running configure::
334 * Filename database generation::
336 * Installation testing::
339 File: kpathsea.info, Node: Disk space, Next: Kpathsea application distributions, Up: Custom installation
344 Here is a table showing the disk space needed for each distribution
345 (described in the next section). The `(totals)' line reflects the
346 `texk' source distribution and `texklib'; the individual distributions
347 don't enter into it. Sizes are in megabytes. All numbers are
350 Distribution .tar.gz Unpacked Compiled Installed
356 texk 7.5 32.1 95.3 33.5
357 texklib 6.3 15.0 - 15.0
358 (totals) 14.6 47.1 95.3 48.5
361 File: kpathsea.info, Node: Kpathsea application distributions, Next: Changing search paths, Prev: Disk space, Up: Custom installation
363 2.2.2 Kpathsea application distributions
364 ----------------------------------------
366 The archive `ftp://ftp.tug.org/tex/texk.tar.gz' contains all of the
367 Kpathsea applications I maintain, and the library itself. For example,
368 since NeXT does not generally support X11, you'd probably want to skip
369 `xdvik' (or simply remove it after unpacking `texk.tar.gz'. If you are
370 not interested in all of them, you can also retrieve them separately:
373 DVI to PCL, for LaserJet printers.
376 DVI to PostScript, for previewers, printers, or PDF generation.
379 The software needed to compile TeX and friends.
382 The original WEB source files, also used in compilation.
385 DVI previewing under the X window system.
388 If you want to use the Babel LaTeX package for support of non-English
389 typesetting, you may need to retrieve additional files. See the file
390 `install.txt' in the Babel distribution.
393 File: kpathsea.info, Node: Changing search paths, Next: Running configure, Prev: Kpathsea application distributions, Up: Custom installation
395 2.2.3 Changing search paths
396 ---------------------------
398 If the search paths for your installation differ from the standard TeX
399 directory structure (*note Introduction: (tds)Top.), edit the file
400 `kpathsea/texmf.in' as desired, before running `configure'. For
401 example, if you have all your fonts or macros in one big directory.
403 You may also wish to edit the file `mktex.cnf', either before or
404 after installation, to control various aspects of `mktexpk' and
405 friends. *Note mktex configuration::.
407 You do not need to edit `texmf.in' to change the default top-level
408 or other installation _directories_ (only the paths). You can and
409 should do that when you run `configure' (next step).
411 You also do not need to edit `texmf.in' if you are willing to rely
412 on `texmf.cnf' at runtime to define the paths, and let the compile-time
413 default paths be incorrect. Usually there is no harm in doing this.
415 The section below explains default generation in more detail.
419 * Default path features::
420 * Default path generation::
423 File: kpathsea.info, Node: Default path features, Next: Default path generation, Up: Changing search paths
425 2.2.3.1 Default path features
426 .............................
428 The purpose of having all the different files described in the section
429 above is to avoid having the same information in more than one place. If
430 you change the installation directories or top-level prefix at
431 `configure'-time, those changes will propagate through the whole
432 sequence. And if you change the default paths in `texmf.in', those
433 changes are propagated to the compile-time defaults.
435 The Make definitions are all repeated in several Makefile's; but
436 changing the top-level `Makefile' should suffice, as it passes down all
437 the variable definitions, thus overriding the submakes. (The
438 definitions are repeated so you can run Make in the subdirectories, if
439 you should have occasion to.)
441 By default, the bitmap font paths end with `/$MAKETEX_MODE', thus
442 including the device name (usually a Metafont mode name such as
443 `ljfour'). This distinguishes two different devices with the same
444 resolution--a write/white from a write/black 300dpi printer, for
447 However, since most sites don't have this complication, Kpathsea
448 (specifically, the `kpse_init_prog' function in `kpathsea/proginit.c')
449 has a special case: if the mode has not been explicitly set by the user
450 (or in a configuration file), it sets `MAKETEX_MODE' to `/'. This
451 makes the default PK path, for example, expand into `.../pk//', so
452 fonts will be found even if there is no subdirectory for the mode (if
453 you arranged things that way because your site has only one printer,
454 for example) or if the program is mode-independent (e.g., `pktype').
456 To make the paths independent of the mode, simply edit `texmf.in'
457 before installation, or the installed `texmf.cnf', and remove the
460 *Note mktex script arguments::, for how this interacts with
463 *Note TeX directory structure: TeX directory structure, for a
464 description of the default arrangement of the input files that comprise
465 the TeX system. The file `kpathsea/HIER' is a copy of that section.
468 File: kpathsea.info, Node: Default path generation, Prev: Default path features, Up: Changing search paths
470 2.2.3.2 Default path generation
471 ...............................
473 This section describes how the default paths are constructed.
475 You may wish to ignore the whole mess and simply edit `texmf.cnf'
476 after it is installed, perhaps even copying it into place beforehand so
477 you can complete the installation, if it seems necessary.
479 To summarize the chain of events that go into defining the default
482 1. `configure' creates a `Makefile' from each `Makefile.in'.
484 2. When Make runs in the `kpathsea' directory, it creates a file
485 `texmf.sed' that substitutes the Make value of `$(var)' for a
486 string `@var@'. The variables in question are the one that define
487 the installation directories.
489 3. `texmf.sed' (together with a little extra magic--see
490 `kpathsea/Makefile') is applied to `texmf.in' to generate
491 `texmf.cnf'. This is the file that will eventually be installed
494 4. The definitions in `texmf.cnf' are recast as C `#define''s in
495 `paths.h'. These values will be the compile-time defaults; they
496 are not used at runtime unless no `texmf.cnf' file can be found.
498 (That's a lie: the compile-time defaults are what any extra :'s in
499 `texmf.cnf' expand into; but the paths as distributed have no extra
500 :'s, and there's no particular reason for them to.)
503 File: kpathsea.info, Node: Running configure, Next: Running make, Prev: Changing search paths, Up: Custom installation
505 2.2.4 Running `configure'
506 -------------------------
508 Run `sh configure OPTIONS' (in the top-level directory, the one
509 containing `kpathsea/'), possibly using a shell other than `sh' (*note
512 `configure' adapts the source distribution to the present system via
513 `#define''s in `*/c-auto.h', which are created from the corresponding
514 `c-auto.in'. It also creates a `Makefile' from the corresponding
515 `Makefile.in', doing `@VAR@' and `ac_include' substitutions).
517 `configure' is the best place to control the configuration,
518 compilation, and installed location of the software, either via
519 command-line options, or by setting environment variables before
520 invoking it. For example, you can disable `mktexpk' by default with
521 the option `--disable-mktexpk'. *Note configure options::.
526 * configure options::
527 * configure environment::
528 * configure scenarios::
532 File: kpathsea.info, Node: configure shells, Next: configure options, Up: Running configure
534 2.2.4.1 `configure' shells
535 ..........................
537 Considerable effort has gone into trying to ensure that the `configure'
538 scripts can be run by most Bourne shell variants. If `sh' runs into
539 trouble, your best bet is to use Bash, the GNU Bourne-again shell
540 (*note Top: (bash)Top.).
542 Bourne shell variants for which problems have been reported in the
545 Old versions of the Korn shell may fail to handle the scripts.
546 The Korn shell may be installed as `/bin/sh' on AIX, in which case
547 `/bin/bsh' may serve instead.
550 Old versions of ash are unable to handle the scripts. Ash is
551 sometimes installed as `/bin/sh' on NetBSD, FreeBSD, and Linux
552 systems. `/bin/bash' should be available for those systems, but
553 might not be part of a default installation.
556 `/bin/sh' under Ultrix is a DEC-grown shell that is notably
557 deficient in many ways. `/bin/sh5' may be necessary.
560 File: kpathsea.info, Node: configure options, Next: configure environment, Prev: configure shells, Up: Running configure
562 2.2.4.2 `configure' options
563 ...........................
565 For a complete list of all `configure' options, run `configure --help'
566 or see *note Running `configure' scripts: (autoconf)Invoking configure,
567 (a copy is in the file `kpathsea/README.CONFIGURE'). The generic
568 options are listed first in the `--help' output, and the
569 package-specific options come last. The environment variables
570 `configure' pays attention to are listed below.
572 Options particularly likely to be useful are `--prefix',
573 `--datadir', and the like; see *note configure scenarios::.
575 This section gives pointers to descriptions of the `--with' and
576 `--enable' options to `configure' that Kpathsea-using programs accept.
578 `--without-mktexmf-default'
579 `--without-mktexpk-default'
580 `--without-mktextfm-default'
581 `--with-mktextex-default'
582 Enable or disable the dynamic generation programs. *Note mktex
586 Build Kpathsea as a shared library, and link against it. Also
587 build the usual static library. *Note Shared library::.
590 Build only the shared library. Implies `--enable-shared'.
592 `--enable-maintainer-mode'
593 Enables make targets that are useful for the maintainer and likely
594 to be a pain for anyone else; the makefiles created when this
595 option is enabled may not work at all for you. You have been
599 File: kpathsea.info, Node: configure environment, Next: configure scenarios, Prev: configure options, Up: Running configure
601 2.2.4.3 `configure' environment
602 ...............................
604 `configure' uses the value of the following environment variables in
605 determining your system's characteristics, and substitutes for them in
609 The compiler to use: default is `gcc' if it's installed, otherwise
613 Options to give the compiler: default is `-g -O2' for `gcc', `-g'
614 otherwise. `CFLAGS' comes after any other options. You may need
615 to include `-w' here if your compilations commonly have useless
616 warnings (e.g., `NULL redefined'), or `configure' may fail to
617 detect the presence of header files (it takes the messages on
618 standard error to mean the header file doesn't exist).
621 Options to pass to the compiler preprocessor; this matters most for
622 configuration, not the actual source compilation. The `configure'
623 script often does only preprocessing (e.g., to check for the
624 existence of #include files), and `CFLAGS' is not used for this.
625 You may need to set this to something like
626 `-I/usr/local/include/wwwhatever' if you have the libwww library
627 installed for hyper-xdvik (see `xdvik/INSTALL').
630 Additional preprocessor options, but not used by `configure'.
631 Provided for enabling or disabling program features, as documented
632 in the various program-specific installation instructions. `DEFS'
633 comes before any compiler options included by the distribution
634 `Makefile's or by `configure'.
637 Additional options to give to the loader. `LDFLAGS' comes before
638 any other linker options.
641 Additional libraries to link with.
644 File: kpathsea.info, Node: configure scenarios, Next: Shared library, Prev: configure environment, Up: Running configure
646 2.2.4.4 `configure' scenarios
647 .............................
649 Here are some common installation scenarios:
651 * Including X support in Metafont. This is disabled by default,
652 since many sites have no use for it, and it's a leading cause of
653 configuration problems.
656 * Putting the binaries, TeX files, GNU info files, etc. into a single
657 TeX hierarchy, say `/here/texmf', requires overriding defaults in
659 configure --prefix=/here/texmf --datadir=/here
661 * You can compile on multiple architectures simultaneously either by
662 building symbolic link trees with the `lndir' script from the X11
663 distribution, or with the `--srcdir' option:
664 configure --srcdir=SRCDIR
666 * If you are installing binaries for multiple architectures into a
667 single hierarchy, you will probably want to override the default
668 `bin' and `lib' directories, something like this:
669 configure --prefix=TEXMF --datadir=TEXMF \
670 --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
672 (Unless you make provisions for architecture-specific files in
673 other ways, e.g., with Depot or an automounter.)
675 * To compile with optimization (to compile without debugging, remove
677 env CFLAGS="-g -O" sh configure ...
678 For a potential problem if you optimize, see *note TeX or Metafont
679 failing: TeX or Metafont failing.
682 File: kpathsea.info, Node: Shared library, Prev: configure scenarios, Up: Running configure
684 2.2.4.5 Shared library
685 ......................
687 You can compile Kpathsea as a shared library on a few systems, by
688 specifying the option `--enable-shared' when you run `configure'.
690 The main advantage in doing this is that the executables can then
691 share the code, thus decreasing memory and disk space requirements.
693 On some systems, you can record the location of shared libraries in a
694 binary, usually by giving certain options to the linker. Then
695 individual users do not need to set their system's environment variable
696 (e.g., `LD_LIBRARY_PATH') to find shared libraries. If you want to do
697 this, you will need to add the necessary options to `LDFLAGS' yourself;
698 for example, on Solaris, include something like `-R${prefix}/lib', on
699 IRIX or Linux, use `-rpath${prefix}/lib'. (Unfortunately, making this
700 happen by default is very difficult, because of interactions with an
701 existing installed shared library.)
704 File: kpathsea.info, Node: Running make, Next: Installing files, Prev: Running configure, Up: Custom installation
709 `make' (still in the top-level directory). This also creates the
710 `texmf.cnf' and `paths.h' files that define the default search paths,
711 and (by default) the `plain' and `latex' TeX formats.
713 You can override directory names and other values at `make'-time.
714 `make/paths.make' lists the variables most commonly reset. For
715 example, `make default_texsizes=600' changes the list of fallback
718 You can also override each of `configure''s environment variables
719 (*note configure environment::). The Make variables have the same
722 Finally, you can supply additional options via the following
723 variables. (`configure' does not use these.)
727 Preprocessor options.
733 Loader options (included at beginning of link commands).
736 More loader options (included at end of link commands).
739 Additional Make arguments passed to all sub-`make''s. You may need
740 to include assignments to the other variables here via `XMAKEARGS';
741 for example: `make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
743 It's generally a bad idea to use a different compiler (`CC') or
744 libraries (`LIBS') for compilation than you did for configuration,
745 since the values `configure' determined may then be incorrect.
747 Adding compiler options to change the "universe" you are using
748 (typically BSD vs. system V) is generally a cause of trouble. It's
749 best to use the native environment, whatever that is; `configure' and
750 the software usually adapt best to that. In particular, under Solaris
751 2.x, you should not use the BSD-compatibility library (`libucb') or
752 include files (`ucbinclude').
754 If you want to use the Babel LaTeX package for support of non-English
755 typesetting, you need to modify some files before making the LaTeX
756 format. See the file `install.txt' in the Babel distribution.
759 File: kpathsea.info, Node: Installing files, Next: Cleaning up, Prev: Running make, Up: Custom installation
761 2.2.6 Installing files
762 ----------------------
764 The basic command is the usual `make install'. For security issues,
767 The first time you install any manual in the GNU Info system, you
768 should add a line (you choose where) to the file `dir' in your
769 `$(infodir)' directory. Sample text for this is given near the top of
770 the Texinfo source files (`kpathsea/kpathsea.texi',
771 `dvipsk/dvips.texi', and `web2c/doc/web2c.texi'). If you have a recent
772 version of the GNU Texinfo distribution installed
773 (`ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz' or later), this
774 should happen automatically.
776 On the offchance that this is your first Info installation, the
777 `dir' file I use is included in the distribution as `etc/dir-example'.
779 You may wish to use one of the following targets, especially if you
780 are installing on multiple architectures:
781 * `make install-exec' to install in architecture-dependent
782 directories, i.e., ones that depend on the `$(exec_prefix)' Make
783 variable. This includes links to binaries, libraries, etc., not
786 * `make install-data' to install in architecture-independent
787 directories, such as documentation, configuration files, pool
790 If you use the Andrew File System, the normal path (e.g.,
791 PREFIX/bin) only gets you to a read-only copy of the files, and you
792 must specify a different path for installation. The best way to do this
793 is by setting the `prefix' variable on the `make' command line. The
794 sequence becomes something like this:
795 configure --prefix=/whatever
797 make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
798 With AFS, you will definitely want to use relative filenames in
799 `ls-R' (*note Filename database::), not absolute filenames. This is
800 done by default, but check anyway.
803 File: kpathsea.info, Node: Cleaning up, Next: Filename database generation, Prev: Installing files, Up: Custom installation
808 The basic command is `make distclean'. This removes all files created
812 * `make mostlyclean' if you intend to compile on another
813 architecture. For Web2C, since the generated C files are portable,
814 they are not removed. If the `lex' vs. `flex' situation is going
815 to be different on the next machine, `rm web2c/lex.yy.c'.
817 * `make clean' to remove files created by compiling, but leave
818 configuration files and Makefiles.
820 * `make maintainer-clean' to remove everything that the Makefiles can
821 rebuild. This is more than `distclean' removes, and you should
822 only use it if you are thoroughly conversant with (and have the
823 necessary versions of) Autoconf.
825 * `make extraclean' to remove other junk, e.g., core files, log
826 files, patch rejects. This is independent of the other `clean'
830 File: kpathsea.info, Node: Filename database generation, Next: mktex scripts, Prev: Cleaning up, Up: Custom installation
832 2.2.8 Filename database generation
833 ----------------------------------
835 You will probably want to set up a `cron' entry on the appropriate
836 machine(s) to rebuild the filename database nightly or so, as in:
837 0 0 * * * cd TEXMF && /BINDIR/mktexlsr
838 *Note Filename database::.
840 Although the `mktex...' scripts make every effort to add
841 newly-created files on the fly, it can't hurt to make sure you get a
842 fresh version every so often.
845 File: kpathsea.info, Node: mktex scripts, Next: Installation testing, Prev: Filename database generation, Up: Custom installation
847 2.2.9 `mktex' scripts
848 ---------------------
850 If Kpathsea cannot otherwise find a file, for some file types it is
851 configured by default to invoke an external program to create it
852 dynamically (*note mktex configuration::). These are collectively
853 known as "`mktex' scripts", since most of them are named `mktex...'.
855 For example, this is useful for fonts (bitmaps, TFM's, and
856 arbitrarily-sizable Metafont sources such as the Sauter and EC fonts),
857 since any given document can use fonts never before referenced.
858 Building all fonts in advance is therefore impractical, if not
861 It is also useful for the TeX `.fmt' (and Metafont `.base' and
862 Metapost `.mem' files, *note Memory dumps: (Web2c)Memory dumps.), where
863 pre-generating every format consumes a lot of both time and space.
865 The script is passed the name of the file to create and possibly
866 other arguments, as explained below. It must echo the full pathname of
867 the file it created (and nothing else) to standard output; it can write
868 diagnostics to standard error.
872 * config: mktex configuration.
873 * names: mktex script names.
874 * args: mktex script arguments.
877 File: kpathsea.info, Node: mktex configuration, Next: mktex script names, Up: mktex scripts
879 2.2.9.1 `mktex' configuration
880 .............................
882 The list of file types and program names that can run an external
883 program to create missing files is listed in the next section. In the
884 absence of `configure' options specifying otherwise, everything but
885 `mktextex' will be enabled by default. The `configure' options to
886 change the defaults are:
888 --without-mktexfmt-default
889 --without-mktexmf-default
890 --without-mktexocp-default
891 --without-mktexofm-default
892 --without-mktexpk-default
893 --without-mktextfm-default
894 --with-mktextex-default
896 The `configure' setting is overridden if the environment variable or
897 configuration file value named for the script is set; e.g., `MKTEXPK'
898 (*note mktex script arguments::).
900 `mktexfmt' reads a file `fmtutil.cnf', typically located in
901 `texmf/web2c/' to glean its configuration information. The rest of the
902 files and features in this section are primarily intended for the font
905 As distributed, all the scripts source a file
906 `texmf/web2c/mktex.cnf' if it exists, so you can override various
907 defaults. See `mktex.opt', for instance, which defines the default
908 mode, resolution, some special directory names, etc. If you prefer not
909 to change the distributed scripts, you can simply create `mktex.cnf'
910 with the appropriate definitions (you do not need to create it if you
911 have nothing to put in it). `mktex.cnf' has no special syntax; it's an
912 arbitrary Bourne shell script. The distribution contains a sample
913 `mktex.cnf' for you to copy and modify as you please (it is not
916 In addition, you can configure a number of features with the
917 `MT_FEATURES' variable, which you can define:
919 * in `mktex.opt', as just mentioned;
921 * by editing the file `mktex.opt', either before `make install' (in
922 the source hierarchy) or after (in the installed hierarchy);
924 * or in the environment.
926 If none of the options below are enabled, `mktexpk', `mktextfm', and
927 `mktexmf' follow the following procedure to decide where fonts should
928 be installed. Find the tree where the font's sources are, and test the
929 permissions of the `fonts' directory of that tree to determine whether
930 it is writable. If it is, put the files in the tree in appropriate
931 locations. If it isn't writable, see whether the tree is a system tree
932 (named in `SYSTEXMF'). If so, the `VARTEXFONTS' tree is used. In all
933 other cases the working directory is used.
935 The `appendonlydir' option is enabled by default.
938 Tell `mktexdir' to create directories append-only, i.e., set their
939 sticky bit (*note Mode Structure: (coreutils)Mode Structure.).
940 This feature is silently ignored on non-Unix platforms (e.g.
941 Windows/NT and MS-DOS) which don't support similar functionality.
942 This feature is enabled by default.
945 Use 8.3 names; e.g., `dpi600/cmr10.pk' instead of `cmr10.600pk'.
946 Note that this feature only affects filenames that would otherwise
947 clash with other TeX-related filenames; `mktex' scripts do nothing
948 about filenames which exceed the 8+3 MS-DOS limits but remain
949 unique when truncated (by the OS) to these limits, and nether do
950 the scripts care about possible clashes with files which aren't
951 related with TeX. For example, `cmr10.600pk' would clash with
952 `cmr10.600gf' and is therefore changed when `dosnames' is in
953 effect, but `mf.pool' and `mp.base' don't clash with any
954 TeX-related files and are therefore unchanged.
956 This feature is turned on by default on MS-DOS. If you do not wish
957 `dosnames' to be set on an MS-DOS platform, you need to set the
958 `MT_FEATURES' environment variable to a value that doesn't include
959 `dosnames'. You can also change the default setting by editing
960 `mktex.opt', but only if you use the `mktex' shell scripts; the
961 emulation programs don't consult `mktex.opt'.
964 Instead of deriving the location of a font in the destination tree
965 from the location of the sources, the aliases and directory names
966 from the Fontname distribution are used. (*note Introduction:
970 Let mktexpk and mktextfm create metafont driver files in a
971 temporary directory. These will be used for just one metafont run
972 and not installed permanently.
975 Omit the directory level for the mode name; this is fine as long as
976 you generate fonts for only one mode.
979 Omit the font supplier name directory level.
982 Omit the font typeface name directory level.
985 Omit the font supplier and typeface name directory levels. This
986 feature is deprecated in favour of `stripsupplier' and
990 When this option is enabled, fonts that would otherwise be written
991 in system texmf tree go to the `VARTEXFONTS' tree instead. The
992 default value in `kpathsea/Makefile.in' is `/var/tmp/texfonts'.
993 The `Linux File System Standard' recommends `/var/tex/fonts'.
995 The `varfonts' setting in `MT_FEATURES' is overridden by the
996 `USE_VARTEXFONTS' environment variable: if set to `1', the feature
997 is enabled, and if set to `0', the feature is disabled.
1000 Force generated files that would go into a system tree (as defined
1001 by `SYSTEXMF') into `TEXMFVAR'. Starting with teTeX-3.0, the
1002 variable `TEXMFVAR' is always set. The `varfonts' feature takes
1003 precedence if also set.
1005 The `texmfvar' setting in `MT_FEATURES' is overridden by the
1006 `USE_TEXMFVAR' environment variable: if set to `1', the feature is
1007 enabled, and if set to `0', the feature is disabled.
1010 File: kpathsea.info, Node: mktex script names, Next: mktex script arguments, Prev: mktex configuration, Up: mktex scripts
1012 2.2.9.2 `mktex' script names
1013 ............................
1015 The following table shows the default name of the script for each of
1016 the file types which support runtime generation.
1019 (`.fmt', `.base', `.mem') TeX/Metafont/MetaPost formats. This
1020 script is also named `fmtutil', and reads `fmtutil.cnf' for
1021 configuration information.
1024 (`.mf') Metafont input files.
1027 (`.ocp') Omega compiled process files.
1030 (`.ofm') Omega font metric files.
1036 (`.tex') TeX input files (disabled by default).
1041 These names can be overridden by an environment variable specific to
1042 the program--for example, `DVIPSMAKEPK' for Dvipsk.
1044 If a `mktex...' script fails, the invocation is appended to a file
1045 `missfont.log' (by default) in the current directory. You can then
1046 execute the log file to create the missing files after fixing the
1049 If the current directory is not writable and the environment
1050 variable or configuration file value `TEXMFOUTPUT' is set, its value is
1051 used. Otherwise, nothing is written. The name `missfont.log' is
1052 overridden by the `MISSFONT_LOG' environment variable or configuration
1056 File: kpathsea.info, Node: mktex script arguments, Prev: mktex script names, Up: mktex scripts
1058 2.2.9.3 `mktex' script arguments
1059 ................................
1061 The first argument to a `mktex' script is always the name of the file
1064 In the default `mktexpk' implementation, additional arguments may
1068 Sets the resolution of the generated font to NUM.
1071 Sets the Metafont mode to NAME.
1074 Sets the the "base dpi" for the font. This must match the mode
1078 A "magstep" string suitable for the Metafont `mag' variable. This
1079 must match the combination of BDPI and DPI being used.
1082 A directory name. If the directory is absolute, it is used as-is.
1083 Otherwise, it is appended to the root destination directory set in
1087 File: kpathsea.info, Node: Installation testing, Prev: mktex scripts, Up: Custom installation
1089 2.2.10 Installation testing
1090 ---------------------------
1092 Besides the tests listed in *note Simple installation::, you can try
1093 running `make check'. This includes the torture tests (trip, trap, and
1094 mptrap) that come with Web2c (*note Triptrap: (web2c)Triptrap.).
1097 File: kpathsea.info, Node: Security, Next: TeX directory structure, Prev: Custom installation, Up: Installation
1102 None of the programs in the TeX system require any special system
1103 privileges, so there's no first-level security concern of people gaining
1104 illegitimate root access.
1106 A TeX document, however, can write to arbitrary files, e.g.,
1107 `~/.rhosts', and thus an unwitting user who runs TeX on a random
1108 document is vulnerable to a trojan horse attack. This loophole is
1109 closed by default, but you can be permissive if you so desire in
1110 `texmf.cnf'. *Note tex invocation: (web2c)tex invocation. MetaPost has
1113 Dvips, Xdvi, and TeX can also execute shell commands under some
1114 circumstances. To disable this, see the `-R' option in *note Option
1115 details: (dvips)Option details, the xdvi man page, and *note tex
1116 invocation: (web2c)tex invocation, respectively.
1118 Another security issue arises because it's very useful--almost
1119 necessary--to make arbitrary fonts on user demand with `mktexpk' and
1120 friends. Where do these files get installed? By default, the
1121 `mktexpk' distributed with Kpathsea assumes a world-writable `/var/tmp'
1122 directory; this is a simple and convenient approach, but it may not
1123 suit your situation because it means that a local cache of fonts is
1124 created on every machine.
1126 To avoid this duplication, many people consider a shared, globally
1127 writable font tree desirable, in spite of the potential security
1128 problems. To do this you should change the value of `VARTEXFONTS' in
1129 `texmf.cnf' to refer to some globally known directory. *Note mktex
1132 The first restriction you can apply is to make newly-created
1133 directories under `texmf' be append-only with an option in `mktex.cnf'.
1134 *Note mktex configuration::.
1136 Another approach is to establish a group (or user) for TeX files,
1137 make the `texmf' tree writable only to that group (or user), and make
1138 `mktexpk' et al. setgid to that group (or setuid to that user). Then
1139 users must invoke the scripts to install things. (If you're worried
1140 about the inevitable security holes in scripts, then you could write a
1141 C wrapper to exec the script.)
1143 The `mktex...' scripts install files with the same read and write
1144 permissions as the directory they are installed in. The executable,
1145 sgid, suid, and sticky bits are always cleared.
1147 Any directories created by the `mktex...' scripts have the same
1148 permissions as their parent directory, unless the `appendonlydir'
1149 feature is used, in which case the sticky bit is always set.
1152 File: kpathsea.info, Node: TeX directory structure, Next: unixtex.ftp, Prev: Security, Up: Installation
1154 2.4 TeX directory structure
1155 ===========================
1157 This section describes the default installation hierarchy of the
1158 distribution. It conforms to both the GNU coding standards and the TeX
1159 directory structure (TDS) standard. For rationale and further
1160 explanation, please see those documents. The GNU standard is available
1161 as `ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi' and
1162 mirrors. The TDS document is available from `CTAN:/tex-archive/tds'
1163 (*note unixtex.ftp::).
1165 You can change the default paths in many ways (*note Changing search
1166 paths::). One common desire is to put everything (binaries and all)
1167 under a single top-level directory such as `/usr/local/texmf' or
1168 `/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
1169 For specific instructions on doing that, see *note configure
1172 Here is a skeleton of the default directory structure, extracted from
1175 PREFIX/ installation root (`/usr/local' by default)
1178 include/ C header files
1179 info/ GNU info files
1180 lib/ libraries (`libkpathsea.*')
1181 share/ architecture-independent files
1183 bibtex/ BibTeX input files
1184 bib/ BibTeX databases
1185 base/ base distribution (e.g., `xampl.bib')
1186 misc/ single-file databases
1187 PKG/ name of a package
1188 bst/ BibTeX style files
1189 base/ base distribution (e.g., `plain.bst', `acm.bst')
1190 misc/ single-file styles
1191 PKG/ name of a package
1192 doc/ additional documentation
1193 dvips/ `.pro', `.ps', `psfonts.map'
1194 fonts/ font-related files
1195 TYPE/ file type (e.g., `tfm', `pk')
1196 MODE/ type of output device (types `pk' and `gf' only)
1197 SUPPLIER/ name of a font supplier (e.g., `public')
1198 TYPEFACE/ name of a typeface (e.g., `cm')
1199 dpiNNN/ font resolution (types `pk' and `gf' only)
1200 metafont/ Metafont (non-font) input files
1201 base/ base distribution (e.g., `plain.mf')
1202 misc/ single-file packages (e.g., `modes.mf')
1203 PKG/ name of a package (e.g., `mfpic')
1204 metapost/ MetaPost input files
1205 base/ base distribution (e.g., `plain.mp')
1206 misc/ single-file packages
1207 PKG/ name of a package
1208 support/ support files for MetaPost-related utilities (e.g., `trfonts.map')
1209 mft/ `MFT' inputs (e.g., `plain.mft')
1210 tex/ TeX input files
1211 FORMAT/ name of a format (e.g., `plain')
1212 base/ base distribution for FORMAT (e.g., `plain.tex')
1213 misc/ single-file packages (e.g., `webmac.tex')
1214 local/ local additions to or local configuration files for FORMAT
1215 PKG/ name of a package (e.g., `graphics', `mfnfss')
1216 generic/ format-independent packages
1217 hyphen/ hyphenation patterns (e.g., `hyphen.tex')
1218 images/ image input files (e.g., Encapsulated PostScript)
1219 misc/ single-file format-independent packages (e.g., `null.tex').
1220 PKG/ name of a package (e.g., `babel')
1221 web2c/ implementation-dependent files (`.pool', `.fmt', `texmf.cnf', etc.)
1223 Some concrete examples for most file types:
1226 /usr/local/man/man1/xdvi.1
1227 /usr/local/info/kpathsea.info
1228 /usr/local/lib/libkpathsea.a
1229 /usr/local/share/texmf/bibtex/bst/base/plain.bst
1230 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1231 /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
1232 /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
1233 /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
1234 /usr/local/share/texmf/metafont/base/plain.mf
1235 /usr/local/share/texmf/metapost/base/plain.mp
1236 /usr/local/share/texmf/tex/plain/base/plain.tex
1237 /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
1238 /usr/local/share/texmf/web2c/tex.pool
1239 /usr/local/share/texmf/web2c/tex.fmt
1240 /usr/local/share/texmf/web2c/texmf.cnf
1243 File: kpathsea.info, Node: unixtex.ftp, Next: Reporting bugs, Prev: TeX directory structure, Up: Installation
1245 2.5 `unixtex.ftp': Obtaining TeX
1246 ================================
1248 This is `ftp://ftp.tug.org/tex/unixtex.ftp', last updated 26 December
1249 2003. Also available as `http://www.tug.org/unixtex.ftp'. The IP
1250 address is currently `[130.225.2.178]'. It is also in Kpathsea source
1251 distributions as `etc/unixtex.ftp' (although the network version is
1252 usually newer). Mail <tex-k@mail.tug.org> with comments or questions.
1254 Following are general instructions for Unix or other sites who wish
1255 to acquire the Web2c distribution, (plain) TeX, LaTeX (2e), BibTeX,
1256 Metafont, MetaPost, DVI processors for the X window system, PostScript,
1257 the PCL language in the HP LaserJet, and related programs. They are
1258 oriented towards building from the original sources, though some
1259 information on alternative packages is included in the last section.
1260 See also `http://www.tug.org/web2c/', the Web2c and Kpathsea home page.
1262 Please note that the Web2c distribution is a bare-bones distribution
1263 in source form, and building a complete installation from it is a
1264 non-trivial matter. For most uses, it is a better idea to install a
1265 distribution with pre-packaged binaries for your platform. The
1266 principal example of such a distribution is TeX Live
1267 (`http://www.tug.org/texlive/'), which is based on the Web2c sources.
1269 Please consider joining the TeX Users Group (TUG) or another user
1270 group of your choice to help support the maintenance and development of
1271 the programs you retrieve. See `http://www.tug.org/join.html' for
1272 information and the membership registration form, and
1273 `http://www.tug.org/usergroups.html' for a listing of all user groups.
1275 For actual installation instructions after obtaining the necessary
1276 sources, see *note Installation::. A copy is in the distribution file
1281 * Electronic distribution:: CTAN and so forth.
1282 * CD-ROM distribution::
1283 * Other TeX packages::
1286 File: kpathsea.info, Node: Electronic distribution, Next: CD-ROM distribution, Up: unixtex.ftp
1288 2.5.1 Electronic distribution
1289 -----------------------------
1291 In many places we refer to CTAN:. This is _both_ a host name and a
1292 directory name. Here are the primary locations:
1294 `ftp://ctan.tug.org/tex-archive/' (Vermont, USA)
1295 `ftp://ftp.dante.de/tex-archive/' (Germany)
1296 `ftp://ftp.tex.ac.uk/tex-archive/' (England)
1298 CTAN has many mirrors worldwide; see the top-level file
1299 `README.mirrors' from one of the sites above or see
1300 `http://www.tug.org/CTAN.sites'.
1302 You can also access CTAN via the World Wide Web, electronic mail, or
1303 NFS. The same `README.mirrors' file explains how.
1305 You will need to retrieve some or all of the following archives,
1306 depending on your needs (don't forget to set binary mode for file
1309 `CTAN:/systems/web2c/web.tar.gz'
1310 The original WEB source files, written primarily by Don Knuth.
1311 Required unless you already have this `web' version. (The WEB
1312 sources change irregularly with respect to Web2c itself.) Unpacks
1313 into `web2c-VERSION'.
1315 `CTAN:/systems/web2c/web2c.tar.gz'
1316 The Web2c system. Required. Also unpacks into `web2c-VERSION'.
1318 `CTAN:/systems/web2c/web2c-etex.tar.gz'
1319 Additions to the Web2c system for building e-TeX. Optional.
1320 Unpacks into `web2c-VERSION'.
1322 `CTAN:/systems/web2c/etexlib.tar.gz'
1323 Additions to the texmf tree needed to build e-TeX. Optional.
1324 Unpacks into `texmf/'.
1326 `CTAN:/systems/web2c/etexdoc.tar.gz'
1327 Documentation for e-TeX as an addition to the texmf tree.
1328 Optional. Unpacks into `texmf/'.
1330 `CTAN:/systems/web2c/web2c-omega.tar.gz'
1331 Additions to the Web2c system for building Omega. Optional.
1332 Unpacks into `web2c-VERSION'.
1334 `CTAN:/systems/web2c/omegalib.tar.gz'
1335 Additions to the texmf tree needed to build Omega. Optional.
1336 Unpacks into `texmf/'.
1338 `CTAN:/systems/web2c/omegadoc.tar.gz'
1339 Documentation for Omega as an addition to the texmf tree.
1340 Optional. Unpacks into `texmf/'.
1342 `CTAN:/systems/web2c/web2c-pdftex.tar.gz'
1343 Additions to the Web2c system for building pdfTeX. Optional.
1344 Unpacks into `web2c-VERSION'.
1346 `CTAN:/systems/web2c/pdftexlib.tar.gz'
1347 Additions to the texmf tree needed to build pdfTeX. Optional.
1348 Unpacks into `texmf/'.
1350 `CTAN:/dviware/xdvik/xdvik.tar.gz'
1351 X window system DVI previewer. Unpacks into `xdvik-VERSION'.
1354 Additional drivers, macro files, and other support are needed to
1355 build a working system. These are available in teTeX.
1357 All that said, the originating host for the software above is
1358 `ftp.tug.org'. You can retrieve these distributions (but not much
1359 else) from the `tex/' directory on that host.
1362 File: kpathsea.info, Node: CD-ROM distribution, Next: Other TeX packages, Prev: Electronic distribution, Up: unixtex.ftp
1364 2.5.2 CD-ROM distribution
1365 -------------------------
1367 Numerous organizations distribute various TeX CD-ROM's (and DVD's):
1369 * Virtually all the TeX user groups collaborate to produce the `TeX
1370 Live' distribution once a year; see `http://www.tug.org/texlive/'
1371 for more information.
1373 * The Free Software Foundation's `Source Code CD-ROM' contains the
1374 minimal TeX source distribution described in the previous section
1375 (i.e., enough to print GNU documentation); email <gnu@gnu.org>.
1377 * Most Linux distributions include some TeX package based on Web2c;
1378 see the Linux documentation file `Distribution-HOWTO' for a
1379 comparison of Linux distributions, available (for example) via
1380 `http://www.linux.org'.
1382 If you know of additional TeX distributions to add to this list,
1383 please inform <tex-k@mail.tug.org>.
1386 File: kpathsea.info, Node: Other TeX packages, Prev: CD-ROM distribution, Up: unixtex.ftp
1388 2.5.3 Other TeX packages
1389 ------------------------
1391 Many other TeX implementations are available in `CTAN:/systems',
1392 including ready-to-run distributions for Unix, Amiga, Acorn, VMS,
1393 Macintosh, DOS, and Windows (in various forms). Although Web2c has
1394 support in the source code for many operating systems, and in fact some
1395 of the other distributions are based on it, it's unlikely to work as
1396 distributed on anything but Unix. (Please contribute improvements!)
1398 The principal user-oriented Unix distribution based on Web2c is the
1399 teTeX distribution. It includes complete sources, and runs on all
1400 modern Unix variants, including Linux. It contains many TeX-related
1401 programs besides those in the core Web2c.
1403 The host labrea.stanford.edu is the original source for the files
1404 for which Donald Knuth is directly responsible: `tex.web', `plain.tex',
1405 etc. However, unless you want to build your TeX library tree ab initio,
1406 it is more reliable and less work to retrieve these files as part of
1407 the above packages. In any case, labrea is not the canonical source for
1408 anything except what was created by Stanford TeX project, so do not
1409 rely on all the files available at that ftp site being up-to-date.
1412 File: kpathsea.info, Node: Reporting bugs, Prev: unixtex.ftp, Up: Installation
1417 (A copy of this chapter is in the file `kpathsea/BUGS'.)
1419 If you have problems or suggestions, please report them to
1420 <tex-k@mail.tug.org> using the bug checklist below.
1422 Please report bugs in the documentation; not only factual errors or
1423 inconsistent behavior, but unclear or incomplete explanations, typos,
1428 * Bug checklist:: What to include in a good bug report.
1429 * Mailing lists:: Joining the bugs or announcements mailing lists.
1430 * Debugging:: Analyzing runtime problems.
1431 * Logging:: Recording searches.
1432 * Common problems:: When things go wrong.
1435 File: kpathsea.info, Node: Bug checklist, Next: Mailing lists, Up: Reporting bugs
1440 Before reporting a bug, please check below to be sure it isn't already
1441 known (*note Common problems::).
1443 Bug reports should be sent via electronic mail to
1444 <tex-k@mail.tug.org>.
1446 The general principle is that a good bug report includes all the
1447 information necessary for reproduction. Therefore, to enable
1448 investigation, your report should include the following:
1450 * The version number(s) of the program(s) involved, and of Kpathsea
1451 itself. You can get the former by giving a sole option `--version'
1452 to the program, and the latter by running `kpsewhich --version'.
1453 The `NEWS' and `ChangeLog' files also contain the version number.
1455 * The hardware, operating system (including version number),
1456 compiler, and `make' program you are using (the output of `uname
1457 -a' is a start on the first two, though often incomplete). If the
1458 bug involves the X window system, include X version and supplier
1459 information as well (examples: X11R6 from MIT; X11R4 from HP;
1460 OpenWindows 3.3 bundled with SunOS 4.1.4).
1462 * Any options you gave to `configure'. This is recorded in the
1463 `config.status' files.
1465 If you are reporting a bug in `configure' itself, it's probably
1466 system-dependent, and it will be unlikely the maintainers can do
1467 anything useful if you merely report that thus-and-such is broken.
1468 Therefore, you need to do some additional work: for some bugs, you
1469 can look in the file `config.log' where the test that failed should
1470 appear, along with the compiler invocation and source program in
1471 question. You can then compile it yourself by hand, and discover
1472 why the test failed. Other `configure' bugs do not involve the
1473 compiler; in that case, the only recourse is to inspect the
1474 `configure' shell script itself, or the Autoconf macros that
1475 generated `configure'.
1477 * The log of all debugging output, if the bug is in path searching.
1478 You can get this by setting the environment variable
1479 `KPATHSEA_DEBUG' to `-1' before running the program. Please look
1480 at the log yourself to make sure the behavior is really a bug
1481 before reporting it; perhaps "old" environment variable settings
1482 are causing files not to be found, for example.
1484 * The contents of any input files necessary to reproduce the bug.
1485 For bugs in DVI-reading programs, for example, this generally
1486 means a DVI file (and any EPS or other files it uses)--TeX source
1487 files are helpful, but the DVI file is necessary, because that's
1488 the actual program input.
1490 * If you are sending a patch (do so if you can!), please do so in
1491 the form of a context diff (`diff -c') against the original
1492 distribution source. Any other form of diff is either not as
1493 complete or harder for me to understand. Please also include a
1496 * If the bug involved is an actual crash (i.e., core dump), it is
1497 easy and useful to include a stack trace from a debugger (I
1498 recommend the GNU debugger GDB, available from
1499 `ftp://prep.ai.mit.edu/pub/gnu'). If the cause is apparent (a
1500 `NULL' value being dereferenced, for example), please send the
1501 details along. If the program involved is TeX or Metafont, and
1502 the crash is happening at apparently-sound code, however, the bug
1503 may well be in the compiler, rather than in the program or the
1504 library (*note TeX or Metafont failing: TeX or Metafont failing.).
1506 * Any additional information that will be helpful in reproducing,
1507 diagnosing, or fixing the bug.
1510 File: kpathsea.info, Node: Mailing lists, Next: Debugging, Prev: Bug checklist, Up: Reporting bugs
1515 Web2c and Kpathsea in general are discussed on the mailing list
1516 <tex-k@mail.tug.org>. To join, email <tex-k-request@mail.tug.org> with
1517 a line consisting of
1519 subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
1521 in the body of the message.
1523 You do not need to join to submit a report, nor will it affect
1524 whether you get a response. There is no Usenet newsgroup equivalent
1525 (if you can be the one to set this up, email `tex-k-request'). Traffic
1526 on the list is fairly light, and is mainly bug reports and enhancement
1527 requests to the software. The best way to decide if you want to join
1528 or not is read some of the archives from
1529 `ftp://ftp.tug.org/mail/archives/tex-k/'.
1531 Be aware that large data files are sometimes included in bug reports.
1532 If this is a problem for you, do not join the list.
1534 If you only want announcements of new releases, not bug reports and
1535 discussion, join <tex-archive@math.utah.edu> (via mail to
1536 <tex-archive-request@math.utah.edu>).
1538 If you are looking for general TeX help, such as how to use LaTeX,
1539 please use the mailing list <info-tex@shsu.edu> mailing list, which is
1540 gatewayed to the `comp.text.tex' Usenet newsgroup (or post to the
1541 newsgroup; the gateway is bidirectional).
1544 File: kpathsea.info, Node: Debugging, Next: Logging, Prev: Mailing lists, Up: Reporting bugs
1549 Kpathsea provides a number of runtime debugging options, detailed below
1550 by their names and corresponding numeric values. When the files you
1551 expect aren't being found, the thing to do is enable these options and
1554 You can set these with some runtime argument (e.g., `-d') to the
1555 program; in that case, you should use the numeric values described in
1556 the program's documentation (which, for Dvipsk and Xdvik, are different
1557 than those below). It's best to give the `-d' (or whatever) option
1558 first, for maximal output. Dvipsk and Xdvik have additional
1559 program-specific debugging options as well.
1561 You can also set the environment variable `KPATHSEA_DEBUG'; in this
1562 case, you should use the numbers below. If you run the program under a
1563 debugger and set the variable `kpathsea_debug', also use the numbers
1566 In any case, by far the simplest value to use is `-1', which will
1567 turn on all debugging output. This is usually better than guessing
1568 which particular values will yield the output you need.
1570 Debugging output always goes to standard error, so you can redirect
1571 it easily. For example, in Bourne-compatible shells:
1572 dvips -d -1 ... 2>/tmp/debug
1574 It is sometimes helpful to run the standalone Kpsewhich utility
1575 (*note Invoking kpsewhich::), instead of the original program.
1577 In any case, you can _not_ use the _names_ below; you must always
1578 use somebody's numbers. (Sorry.) To set more than one option, just
1579 sum the corresponding numbers.
1581 `KPSE_DEBUG_STAT (1)'
1582 Report `stat'(2) calls. This is useful for verifying that your
1583 directory structure is not forcing Kpathsea to do many additional
1584 file tests (*note Slow path searching::, and *note Subdirectory
1585 expansion::). If you are using an up-to-date `ls-R' database
1586 (*note Filename database::), this should produce no output unless a
1587 nonexistent file that must exist is searched for.
1589 `KPSE_DEBUG_HASH (2)'
1590 Report lookups in all hash tables: `ls-R' and `aliases' (*note
1591 Filename database::); font aliases (*note Fontmap::); and config
1592 file values (*note Config files::). Useful when expected values
1593 are not being found, e.g.., file searches are looking at the disk
1594 instead of using `ls-R'.
1596 `KPSE_DEBUG_FOPEN (4)'
1597 Report file openings and closings. Especially useful when your
1598 system's file table is full, for seeing which files have been
1599 opened but never closed. In case you want to set breakpoints in a
1600 debugger: this works by redefining `fopen' (`fclose') to be
1601 `kpse_fopen_trace' (`kpse_fclose_trace').
1603 `KPSE_DEBUG_PATHS (8)'
1604 Report general path information for each file type Kpathsea is
1605 asked to search. This is useful when you are trying to track down
1606 how a particular path got defined--from `texmf.cnf', `config.ps',
1607 an environment variable, the compile-time default, etc. This is
1608 the contents of the `kpse_format_info_type' structure defined in
1611 `KPSE_DEBUG_EXPAND (16)'
1612 Report the directory list corresponding to each path element
1613 Kpathsea searches. This is only relevant when Kpathsea searches
1614 the disk, since `ls-R' searches don't look through directory lists
1617 `KPSE_DEBUG_SEARCH (32)'
1618 Report on each file search: the name of the file searched for, the
1619 path searched in, whether or not the file must exist (when drivers
1620 search for `cmr10.vf', it need not exist), and whether or not we
1621 are collecting all occurrences of the file in the path (as with,
1622 e.g., `texmf.cnf' and `texfonts.map'), or just the first (as with
1623 most lookups). This can help you correlate what Kpathsea is doing
1624 with what is in your input file.
1626 `KPSE_DEBUG_VARS (64)'
1627 Report the value of each variable Kpathsea looks up. This is
1628 useful for verifying that variables do indeed obtain their correct
1631 `GSFTOPK_DEBUG (128)'
1632 Activates debugging printout specific to `gsftopk' program.
1634 `MAKETEX_DEBUG (512)'
1635 If you use the optional `mktex' programs instead of the
1636 traditional shell scripts, this will report the name of the site
1637 file (`mktex.cnf' by default) which is read, directories created by
1638 `mktexdir', the full path of the `ls-R' database built by
1639 `mktexlsr', font map searches, `MT_FEATURES' in effect, parameters
1640 from `mktexnam', filenames added by `mktexupd', and some
1641 subsidiary commands run by the programs.
1643 `MAKETEX_FINE_DEBUG (1024)'
1644 When the optional `mktex' programs are used, this will print
1645 additional debugging info from functions internal to these
1648 Debugging output from Kpathsea is always written to standard error,
1649 and begins with the string `kdebug:'. (Except for hash table buckets,
1650 which just start with the number, but you can only get that output
1651 running under a debugger. See comments at the `hash_summary_only'
1652 variable in `kpathsea/db.c'.)
1655 File: kpathsea.info, Node: Logging, Next: Common problems, Prev: Debugging, Up: Reporting bugs
1660 Kpathsea can record the time and filename found for each successful
1661 search. This may be useful in finding good candidates for deletion when
1662 your filesystem is full, or in discovering usage patterns at your site.
1664 To do this, define the environment or config file variable
1665 `TEXMFLOG'. The value is the name of the file to append the
1666 information to. The file is created if it doesn't exist, and appended
1669 Each successful search turns into one line in the log file: two words
1670 separated by a space. The first word is the time of the search, as the
1671 integer number of seconds since "the epoch", i.e., UTC midnight 1
1672 January 1970 (more precisely, the result of the `time' system call).
1673 The second word is the filename.
1675 For example, after `setenv TEXMFLOG /tmp/log', running Dvips on
1676 `story.dvi' appends the following lines:
1678 774455887 /usr/local/share/texmf/dvips/config.ps
1679 774455887 /usr/local/share/texmf/dvips/psfonts.map
1680 774455888 /usr/local/share/texmf/dvips/texc.pro
1681 774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
1682 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
1683 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1684 774455889 /usr/local/share/texmf/dvips/texc.pro
1686 Only filenames that are absolute are recorded, to preserve some
1687 semblance of privacy.
1689 In addition to this Kpathsea-specific logging, `pdftex' provides an
1690 option `-recorder' to write the names of all files accessed during a
1691 run to the file `BASEFILE.fls'.
1693 Finally, most systems provide a general tool to output each system
1694 call, thus including opening and closing files. It might be named
1695 `strace', `truss', `struss', or something else.
1698 File: kpathsea.info, Node: Common problems, Prev: Logging, Up: Reporting bugs
1700 2.6.5 Common problems
1701 ---------------------
1703 Here are some common problems with configuration, compilation, linking,
1708 * Unable to find files:: If your program can't find fonts (or whatever).
1709 * Slow path searching:: If it takes forever to find anything.
1710 * Unable to generate fonts:: If mktexpk fails.
1711 * TeX or Metafont failing:: Likely compiler bugs.
1713 * Empty Makefiles:: When configure produces empty makefiles.
1714 * XtStrings:: When _XtStrings is undefined.
1715 * dlopen:: When dlopen is undefined.
1716 * ShellWidgetClass:: For dynamic linking troubles under OpenWindows.
1717 * Pointer combination warnings:: For old compilers that don't grok char *.
1720 File: kpathsea.info, Node: Unable to find files, Next: Slow path searching, Up: Common problems
1722 2.6.5.1 Unable to find files
1723 ............................
1725 If a program complains it cannot find fonts (or other input files), any
1726 of several things might be wrong. In any case, you may find the
1727 debugging options helpful. *Note Debugging::.
1729 * Perhaps you simply haven't installed all the necessary files; the
1730 basic fonts and input files are distributed separately from the
1731 programs. *Note unixtex.ftp::.
1733 * You have (perhaps unknowingly) told Kpathsea to use search paths
1734 that don't reflect where the files actually are. One common cause
1735 is having environment variables set from a previous installation,
1736 thus overriding what you carefully set in `texmf.cnf' (*note
1737 Supported file formats::). System `/etc/profile' or other files
1738 such may be the culprit.
1740 * Your files reside in a directory that is only pointed to via a
1741 symbolic link, in a leaf directory and is not listed in `ls-R'.
1743 Unfortunately, Kpathsea's subdirectory searching has an
1744 irremediable deficiency: If a directory D being searched for
1745 subdirectories contains plain files and symbolic links to other
1746 directories, but no true subdirectories, D will be considered a
1747 leaf directory, i.e., the symbolic links will not be followed.
1748 *Note Subdirectory expansion::.
1750 You can work around this problem by creating an empty dummy
1751 subdirectory in D. Then D will no longer be a leaf, and the
1752 symlinks will be followed.
1754 The directory immediately followed by the `//' in the path
1755 specification, however, is always searched for subdirectories,
1756 even if it is a leaf. Presumably you would not have asked for the
1757 directory to be searched for subdirectories if you didn't want it
1760 * If the fonts (or whatever) don't already exist, `mktexpk' (or
1761 `mktexmf' or `mktextfm') will try to create them. If these rather
1762 complicated shell scripts fail, you'll eventually get an error
1763 message saying something like `Can't find font FONTNAME'. The best
1764 solution is to fix (or at least report) the bug in `mktexpk'; the
1765 workaround is to generate the necessary fonts by hand with
1766 Metafont, or to grab them from a CTAN site (*note unixtex.ftp::).
1768 * There is a bug in the library. *Note Reporting bugs::.
1771 File: kpathsea.info, Node: Slow path searching, Next: Unable to generate fonts, Prev: Unable to find files, Up: Common problems
1773 2.6.5.2 Slow path searching
1774 ...........................
1776 If your program takes an excessively long time to find fonts or other
1777 input files, but does eventually succeed, here are some possible
1780 * Most likely, you just have a lot of directories to search, and that
1781 takes a noticeable time. The solution is to create and maintain a
1782 separate `ls-R' file that lists all the files in your main TeX
1783 hierarchy. *Note Filename database::. Kpathsea always uses `ls-R'
1784 if it's present; there's no need to recompile or reconfigure any
1787 * Your recursively-searched directories (e.g.,
1788 `/usr/local/share/texmf/fonts//'), contain a mixture of files and
1789 directories. This prevents Kpathsea from using a useful
1790 optimization (*note Subdirectory expansion::).
1792 It is best to have only directories (and perhaps a `README') in the
1793 upper levels of the directory structure, and it's very important
1794 to have _only_ files, and no subdirectories, in the leaf
1795 directories where the dozens of TFM, PK, or whatever files reside.
1797 In any case, you may find the debugging options helpful in
1798 determining precisely when the disk or network is being pounded. *Note
1802 File: kpathsea.info, Node: Unable to generate fonts, Next: TeX or Metafont failing, Prev: Slow path searching, Up: Common problems
1804 2.6.5.3 Unable to generate fonts
1805 ................................
1807 Metafont outputs fonts in bitmap format, tuned for a particular device
1808 at a particular resolution, in order to allow for the highest-possible
1809 quality of output. Some DVI-to-whatever programs, such as Dvips, try
1810 to generate these on the fly when they are needed, but this generation
1811 may fail in several cases.
1813 If `mktexpk' runs, but fails with this error:
1814 mktexpk: Can't guess mode for NNN dpi devices.
1815 mktexpk: Use a config file to specify the mode, or update me.
1816 you need to ensure the resolution and mode match; just specifying
1817 the resolution, as in `-D 360', is not enough.
1819 You can specify the mode name with the `-mode' option on the Dvips
1820 command line, or in a Dvips configuration file (*note Config files:
1821 (dvips)Config files.), such as `config.ps' in your document directory,
1822 `~/.dvipsrc' in your home directory, or in a system directory (again
1823 named `config.ps'). (Other drivers use other files, naturally.)
1825 For example, if you need 360dpi fonts, you could include this in a
1830 If Metafont runs, but generates fonts at the wrong resolution or for
1831 the wrong device, most likely `mktexpk''s built-in guess for the mode
1832 is wrong, and you should override it as above.
1834 See `ftp://ftp.tug.org/tex/modes.mf' for a list of resolutions and
1835 mode names for most devices (additional submissions are welcome).
1837 If Metafont runs but generates fonts at a resolution of 2602dpi (and
1838 prints out the name of each character as well as just a character
1839 number, and maybe tries to display the characters), then your Metafont
1840 base file probably hasn't been made properly. (It's using the default
1841 `proof' mode, instead of an actual device mode.) To make a proper
1842 `plain.base', assuming the local mode definitions are contained in a
1843 file `modes.mf', run the following command (assuming Unix):
1845 inimf "plain; input modes; dump"
1847 Then copy the `plain.base' file from the current directory to where the
1848 base files are stored on your system (`/usr/local/share/texmf/web2c' by
1849 default), and make a link (either hard or soft) from `plain.base' to
1850 `mf.base' in that directory. *Note inimf invocation: (web2c)inimf
1853 If `mf' is a command not found at all by `mktexpk', then you need to
1854 install Metafont (*note unixtex.ftp::).
1857 File: kpathsea.info, Node: TeX or Metafont failing, Next: Empty Makefiles, Prev: Unable to generate fonts, Up: Common problems
1859 2.6.5.4 TeX or Metafont failing
1860 ...............................
1862 If TeX or Metafont get a segmentation fault or otherwise fail while
1863 running a normal input file, the problem is usually a compiler bug
1864 (unlikely as that may sound). Even if the trip and trap tests are
1865 passed, problems may lurk. Optimization occasionally causes trouble in
1866 programs other than TeX and Metafont themselves, too.
1868 Insufficient swap space may also cause core dumps or other erratic
1871 For a workaround, if you enabled any optimization flags, it's best to
1872 omit optimization entirely. In any case, the way to find the facts is
1873 to run the program under the debugger and see where it's failing.
1875 Also, if you have trouble with a system C compiler, I advise trying
1876 the GNU C compiler. And vice versa, unfortunately; but in that case I
1877 also recommend reporting a bug to the GCC mailing list; see *note Bugs:
1880 To report compiler bugs effectively requires perseverance and
1881 perspicacity: you must find the miscompiled line, and that usually
1882 involves delving backwards in time from the point of error, checking
1883 through TeX's (or whatever program's) data structures. Things are not
1884 helped by all-too-common bugs in the debugger itself. Good luck.
1886 One known cause of trouble is the way arrays are handled. Some of
1887 the Pascal arrays have a lower index other than 0, and the C code will
1888 take the pointer to the allocated memory, subtract the lower index, and
1889 use the resulting pointer for the array. While this trick often works,
1890 ANSI C doesn't guarantee that it will. It it known to fail on HP-UX 10
1891 mchines when the native compiler is used, unless the `+u' compiler
1892 switch was specified. Using GCC will work on this platform as well.
1895 File: kpathsea.info, Node: Empty Makefiles, Next: XtStrings, Prev: TeX or Metafont failing, Up: Common problems
1897 2.6.5.5 Empty Makefiles
1898 .......................
1900 On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), `configure' may
1901 fail to properly create the Makefiles. Instead, you get an error which
1902 looks something like this:
1907 sed: 1: "\\@^ac_include make/pat ...": \ can not be used as a string delimiter
1909 So far as I know, the bug here is in `/bin/sh' on these systems. I
1910 don't have access to a machine running any of them, so if someone can
1911 find a workaround that avoids the quoting bug, I'd be most grateful.
1912 (Search for `ac_include' in the `configure' script to get to the
1915 It should work to run `bash configure', instead of using `/bin/sh'.
1916 You can get Bash from `ftp://prep.ai.mit.edu/pub/gnu' and mirrors.
1918 Another possible cause (reported for NeXT) is a bug in the `sed'
1919 command. In that case the error may look like this:
1921 Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
1923 In this case, installing GNU `sed' should solve the problem. You
1924 can get GNU `sed' from the same places as Bash.
1927 File: kpathsea.info, Node: XtStrings, Next: dlopen, Prev: Empty Makefiles, Up: Common problems
1932 You may find that linking X programs results in an error from the linker
1933 that `XtStrings' is undefined, something like this:
1936 .../x11.c:130: undefined reference to `XtStrings'
1938 This generally happens because of a mismatch between the X include
1939 files with which you compiled and the X libraries with which you linked;
1940 often, the include files are from MIT and the libraries from Sun.
1942 The solution is to use the same X distribution for compilation and
1943 linking. Probably `configure' was unable to guess the proper
1944 directories from your installation. You can use the `configure'
1945 options `--x-includes=PATH' and `--x-libraries=PATH' to explicitly
1949 File: kpathsea.info, Node: dlopen, Next: ShellWidgetClass, Prev: XtStrings, Up: Common problems
1954 (This section adapted from the file `dlsym.c' in the X distribution.)
1956 The `Xlib' library uses the standard C function `wcstombs'. Under
1957 SunOS 4.1, `wcstombs' uses the `dlsym' interface defined in `libdl.so'.
1958 Unfortunately, the SunOS 4.1 distribution does not include a static
1961 As a result, if you try to link an X program statically under SunOS,
1962 you may get undefined references to `dlopen', `dlsym', and `dlclose'.
1963 One workaround is to include these definitions when you link:
1965 void *dlopen() { return 0; }
1966 void *dlsym() { return 0; }
1967 int dlclose() { return -1; }
1969 These are contained in the `dlsym.c' file in the MIT X distribution.
1972 File: kpathsea.info, Node: ShellWidgetClass, Next: Pointer combination warnings, Prev: dlopen, Up: Common problems
1974 2.6.5.8 `ShellWidgetClass'
1975 ..........................
1977 (This section adapted from the comp.sys.sun.admin FAQ.)
1979 If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
1980 you may get undefined symbols `_get_wmShellWidgetClass' and
1981 `_get_applicationShellWidgetClass' when linking. This problem does not
1982 arise using the standard MIT X libraries under SunOS.
1984 The cause is bugs in the `Xmu' shared library as shipped from Sun.
1985 There are several fixes:
1987 * Install the free MIT distribution from `ftp.x.org' and mirrors.
1989 * Get the OpenWindows patches listed below.
1991 * Statically link the `Xmu' library into the executable.
1993 * Avoid using `Xmu' at all. If you are compiling Metafont, see *note
1994 Online Metafont graphics: (web2c)Online Metafont graphics. If you
1995 are compiling Xdvi, see the `-DNOTOOL' option in `xdvik/INSTALL'.
1997 * Ignore the errors. The binary runs fine regardless.
2000 Here is the information for getting the two patches:
2003 Bug ID's: 1086793, 1086912, 1074766
2004 Description: 4.1.x OpenWindows 3.0 `libXt' jumbo patch
2008 Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared `libXmu'.
2010 The way to statically link with `libXmu' depends on whether you are
2011 using a Sun compiler (e.g., `cc') or `gcc'. If the latter, alter the
2012 `x_libs' Make variable to include
2014 -static -lXmu -dynamic
2016 If you are using the Sun compiler, use `-Bstatic' and `-Bdynamic'.
2019 File: kpathsea.info, Node: Pointer combination warnings, Prev: ShellWidgetClass, Up: Common problems
2021 2.6.5.9 Pointer combination warnings
2022 ....................................
2024 When compiling with old C compilers, you may get some warnings about
2025 "illegal pointer combinations". These are spurious; just ignore them.
2026 I decline to clutter up the source with casts to get rid of them.
2029 File: kpathsea.info, Node: Path searching, Next: TeX support, Prev: Installation, Up: Top
2034 This chapter describes the generic path searching mechanism Kpathsea
2035 provides. For information about searching for particular file types
2036 (e.g., TeX fonts), see the next chapter.
2040 * Searching overview:: Basic scheme for searching.
2041 * Path sources:: Where search paths can be defined.
2042 * Path expansion:: Special constructs in search paths.
2043 * Filename database:: Using an externally-built list to search.
2044 * Invoking kpsewhich:: Standalone path lookup.
2047 File: kpathsea.info, Node: Searching overview, Next: Path sources, Up: Path searching
2049 3.1 Searching overview
2050 ======================
2052 A "search path" is a colon-separated list of "path elements", which are
2053 directory names with a few extra frills. A search path can come from
2054 (a combination of) many sources; see below. To look up a file `foo'
2055 along a path `.:/dir', Kpathsea checks each element of the path in
2056 turn: first `./foo', then `/dir/foo', returning the first match (or
2057 possibly all matches).
2059 The "colon" and "slash" mentioned here aren't necessarily `:' and
2060 `/' on non-Unix systems. Kpathsea tries to adapt to other operating
2061 systems' conventions.
2063 To check a particular path element E, Kpathsea first sees if a
2064 prebuilt database (*note Filename database::) applies to E, i.e., if
2065 the database is in a directory that is a prefix of E. If so, the path
2066 specification is matched against the contents of the database.
2068 If the database does not exist, or does not apply to this path
2069 element, or contains no matches, the filesystem is searched (if this
2070 was not forbidden by the specification with `!!' and if the file being
2071 searched for must exist). Kpathsea constructs the list of directories
2072 that correspond to this path element, and then checks in each for the
2073 file being searched for. (To help speed future lookups of files in the
2074 same directory, the directory in which a file is found is floated to the
2075 top of the directory list.)
2077 The "file must exist" condition comes into play with VF files and
2078 input files read by the TeX `\openin' command. These files might very
2079 well not exist (consider `cmr10.vf'), and so it would be wrong to
2080 search the disk for them. Therefore, if you fail to update `ls-R' when
2081 you install a new VF file, it will not be found.
2083 Each path element is checked in turn: first the database, then the
2084 disk. If a match is found, the search stops and the result is
2085 returned. This avoids possibly-expensive processing of path
2086 specifications that are never needed on a particular run. (Unless the
2087 search explicitly requested all matches.)
2089 Although the simplest and most common path element is a directory
2090 name, Kpathsea supports additional features in search paths: layered
2091 default values, environment variable names, config file values, users'
2092 home directories, and recursive subdirectory searching. Thus, we say
2093 that Kpathsea "expands" a path element, meaning transforming all the
2094 magic specifications into the basic directory name or names. This
2095 process is described in the sections below. It happens in the same
2096 order as the sections.
2098 Exception to all of the above: If the filename being searched for is
2099 absolute or explicitly relative, i.e., starts with `/' or `./' or
2100 `../', Kpathsea simply checks if that file exists.
2102 Ordinarily, if Kpathsea tries to access a file or directory that
2103 cannot be read, it gives a warning. This is so you will be alerted to
2104 directories or files that accidentally lack any read permission (for
2105 example, a `lost+found' directory). If you prefer not to see these
2106 warnings, include the value `readable' in the `TEX_HUSH' environment
2107 variable or config file value.
2109 This generic path searching algorithm is implemented in
2110 `kpathsea/pathsearch.c'. It is employed by a higher-level algorithm
2111 when searching for a file of a particular type (*note File lookup::,
2112 and *note Glyph lookup::).
2115 File: kpathsea.info, Node: Path sources, Next: Path expansion, Prev: Searching overview, Up: Path searching
2120 A search path can come from many sources. In the order in which
2123 1. A user-set environment variable, e.g., `TEXINPUTS'. Environment
2124 variables with an underscore and the program name appended
2125 override; for example, `TEXINPUTS_latex' overrides `TEXINPUTS' if
2126 the program being run is named `latex'.
2128 2. A program-specific configuration file, e.g., an `S /a:/b' line in
2129 Dvips' `config.ps' (*note Config files: (dvips)Config files.).
2131 3. A line in a Kpathsea configuration file `texmf.cnf', e.g.,
2132 `TEXINPUTS=/c:/d' (see below).
2134 4. The compile-time default (specified in `kpathsea/paths.h').
2136 You can see each of these values for a given search path by using the
2137 debugging options (*note Debugging::).
2139 These sources may be combined via default expansion (*note Default
2144 * Config files:: Kpathsea's runtime config files (texmf.cnf).
2147 File: kpathsea.info, Node: Config files, Up: Path sources
2152 As mentioned above, Kpathsea reads "runtime configuration files" named
2153 `texmf.cnf' for search path and other definitions. The search path
2154 used to look for these configuration files is named `TEXMFCNF', and is
2155 constructed in the usual way, as described above, except that
2156 configuration files cannot be used to define the path, naturally; also,
2157 an `ls-R' database is not used to search for them.
2159 Kpathsea reads _all_ `texmf.cnf' files in the search path, not just
2160 the first one found; definitions in earlier files override those in
2161 later files. Thus, if the search path is `.:$TEXMF', values from
2162 `./texmf.cnf' override those from `$TEXMF/texmf.cnf'.
2164 If Kpathsea cannot find any `texmf.cnf' file, it reports a warning
2165 including all the directories it checked. If you don't want to see
2166 this warning, set the environment variable `KPATHSEA_WARNING' to the
2167 single character `0' (zero, not oh).
2169 While (or instead of) reading this description, you may find it
2170 helpful to look at the distributed `texmf.cnf', which uses or at least
2171 mentions most features. The format of `texmf.cnf' files follows:
2173 * Comments start with `%' and continue to the end of the line.
2175 * Blank lines are ignored.
2177 * A `\' at the end of a line acts as a continuation character, i.e.,
2178 the next line is appended. Whitespace at the beginning of
2179 continuation lines is not ignored.
2181 * Each remaining line must look like
2183 VARIABLE [. PROGNAME] [=] VALUE
2185 where the `=' and surrounding whitespace is optional.
2187 * The VARIABLE name may contain any character other than whitespace,
2188 `=', or `.', but sticking to `A-Za-z_' is safest.
2190 * If `.PROGNAME' is present, the definition only applies if the
2191 program that is running is named (i.e., the last component of
2192 `argv[0]' is) PROGNAME or `PROGNAME.exe'. This allows different
2193 flavors of TeX to have different search paths, for example.
2195 * VALUE may contain any characters except `%' and `@'. (These
2196 restrictions are only necessary because of the processing done on
2197 `texmf.cnf' at build time, so you can stick those characters in
2198 after installation if you have to.) The `$VAR.PROG' feature is
2199 not available on the right-hand side; instead, you must use an
2200 additional variable (see below for example). A `;' in VALUE is
2201 translated to `:' if running under Unix; this is useful to write a
2202 single `texmf.cnf' which can be used under both Unix and NT.
2204 * All definitions are read before anything is expanded, so you can
2205 use variables before they are defined (like Make, unlike most other
2208 Here is a configuration file fragment illustrating most of these points:
2210 % TeX input files -- i.e., anything to be found by \input or \openin ...
2211 latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
2212 latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
2213 TEXINPUTS = .:$TEXMF/tex//
2214 TEXINPUTS.latex209 = $latex209_inputs
2215 TEXINPUTS.latex2e = $latex2e_inputs
2216 TEXINPUTS.latex = $latex2e_inputs
2218 Although this format has obvious similarities to Bourne shell
2219 scripts--change the comment character to `#', disallow spaces around
2220 the `=', and get rid of the `.NAME' convention, and it could be run
2221 through the shell. But there seemed little advantage to doing this,
2222 since all the information would have to passed back to Kpathsea and
2223 parsed there anyway, since the `sh' process couldn't affect its
2224 parent's environment.
2226 The implementation of all this is in `kpathsea/cnf.c'.
2229 File: kpathsea.info, Node: Path expansion, Next: Filename database, Prev: Path sources, Up: Path searching
2234 Kpathsea recognizes certain special characters and constructions in
2235 search paths, similar to that in shells. As a general example:
2236 `~$USER/{foo,bar}//baz' expands to all subdirectories under directories
2237 `foo' and `bar' in $USER's home directory that contain a directory or
2238 file `baz'. These expansions are explained in the sections below.
2242 * Default expansion:: a: or :a or a::b expands to a default.
2243 * Variable expansion:: $foo and ${foo} expand to environment values.
2244 * Tilde expansion:: ~ and ~user expand to home directories.
2245 * Brace expansion:: a{foo,bar}b expands to afoob abarb.
2246 * KPSE_DOT expansion:: . is replaced with $KPSE_DOT if it is defined.
2247 * Subdirectory expansion:: a// and a//b recursively expand to subdirs.
2250 File: kpathsea.info, Node: Default expansion, Next: Variable expansion, Up: Path expansion
2252 3.3.1 Default expansion
2253 -----------------------
2255 If the highest-priority search path (*note Path sources::) contains an
2256 "extra colon" (i.e., leading, trailing, or doubled), Kpathsea inserts
2257 at that point the next-highest-priority search path that is defined.
2258 If that inserted path has an extra colon, the same happens with the
2259 next-highest. (An extra colon in the compile-time default value has
2260 unpredictable results, so installers beware.)
2262 For example, given an environment variable setting
2264 setenv TEXINPUTS /home/karl:
2266 and a `TEXINPUTS' value from `texmf.cnf' of
2270 then the final value used for searching will be:
2272 /home/karl:.:$TEXMF//tex
2274 Put another way, default expansion works on "formats" (search
2275 paths), and not directly on environment variables. Example, showing
2276 the trailing `:' ignored in the first case and expanded in the second:
2278 $ env TTFONTS=/tmp: kpsewhich --expand-path '$TTFONTS'
2280 $ env TTFONTS=/tmp: kpsewhich --show-path=.ttf
2281 /tmp:.:/home/olaf/texmf/fonts/truetype//:...
2283 Since Kpathsea looks for multiple configuration files, it would be
2284 natural to expect that (for example) an extra colon in `./texmf.cnf'
2285 would expand to the path in `$TEXMF/texmf.cnf'. Or, with Dvips'
2286 configuration files, that an extra colon in `config.$PRINTER' would
2287 expand to the path in `config.ps'. This doesn't happen. It's not
2288 clear this would be desirable in all cases, and trying to devise a way
2289 to specify the path to which the extra colon should expand seemed truly
2292 Technicality: Since it would be useless to insert the default value
2293 in more than one place, Kpathsea changes only one extra `:' and leaves
2294 any others in place (they will eventually be ignored). Kpathsea checks
2295 first for a leading `:', then a trailing `:', then a doubled `:'.
2297 You can trace this by debugging "paths" (*note Debugging::).
2298 Default expansion is implemented in the source file
2299 `kpathsea/kdefault.c'.
2302 File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: Default expansion, Up: Path expansion
2304 3.3.2 Variable expansion
2305 ------------------------
2307 `$foo' or `${foo}' in a path element is replaced by (1) the value of an
2308 environment variable `foo' (if defined); (2) the value of `foo' from
2309 `texmf.cnf' (if defined); (3) the empty string.
2311 If the character after the `$' is alphanumeric or `_', the variable
2312 name consists of all consecutive such characters. If the character
2313 after the `$' is a `{', the variable name consists of everything up to
2314 the next `}' (braces may not be nested around variable names).
2315 Otherwise, Kpathsea gives a warning and ignores the `$' and its
2316 following character.
2318 You must quote the $'s and braces as necessary for your shell.
2319 _Shell_ variable values cannot be seen by Kpathsea, i.e., ones defined
2320 by `set' in C shells and without `export' in Bourne shells.
2323 setenv tex /home/texmf
2324 setenv TEXINPUTS .:$tex:${tex}prev
2325 the final `TEXINPUTS' path is the three directories:
2326 .:/home/texmf:/home/texmfprev
2328 The `.PROGNAME' suffix on variables and `_PROGNAME' on environment
2329 variable names are not implemented for general variable expansions.
2330 These are only recognized when search paths are initialized (*note Path
2333 Variable expansion is implemented in the source file
2334 `kpathsea/variable.c'.
2337 File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Variable expansion, Up: Path expansion
2339 3.3.3 Tilde expansion
2340 ---------------------
2342 A leading `~' in a path element is replaced by the value of the
2343 environment variable `HOME', or `.' if `HOME' is not set. On Windows,
2344 the environment variable `USERPROFILE' is checked instead of `HOME'.
2346 A leading `~USER' in a path element is replaced by USER's home
2347 directory from the system `passwd' database.
2350 setenv TEXINPUTS ~/mymacros:
2352 will prepend a directory `mymacros' in your home directory to the
2355 As a special case, if a home directory ends in `/', the trailing
2356 slash is dropped, to avoid inadvertently creating a `//' construct in
2357 the path. For example, if the home directory of the user `root' is
2358 `/', the path element `~root/mymacros' expands to just `/mymacros', not
2361 Tilde expansion is implemented in the source file `kpathsea/tilde.c'.
2364 File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: Tilde expansion, Up: Path expansion
2366 3.3.4 Brace expansion
2367 ---------------------
2369 `x{A,B}y' expands to `xAy:xBy'. For example:
2373 expands to `foo/1/baz:foo/2/baz'. `:' is the path separator on the
2374 current system; e.g., on a DOS system, it's `;'.
2376 Braces can be nested; for example, `x{A,B{1,2}}y' expands to
2379 Multiple non-nested braces are expanded from right to left; for
2380 example, `x{A,B}{1,2}y' expands to `x{A,B}1y:x{A,B}2y', which expands
2381 to `xA1y:xB1y:xA2y:xB2y'.
2383 This feature can be used to implement multiple TeX hierarchies, by
2384 assigning a brace list to `$TEXMF', as mentioned in `texmf.in'.
2386 You can also use the path separator in stead of the comma. The last
2387 example could have been written `x{A:B}{1:2}y'.
2389 Brace expansion is implemented in the source file
2390 `kpathsea/expand.c'. It is a modification of the Bash sources, and is
2391 thus covered by the GNU General Public License, rather than the Library
2392 General Public License that covers the rest of Kpathsea.
2395 File: kpathsea.info, Node: KPSE_DOT expansion, Next: Subdirectory expansion, Prev: Brace expansion, Up: Path expansion
2397 3.3.5 `KPSE_DOT' expansion
2398 --------------------------
2400 When `KPSE_DOT' is defined in the environment, it names a directory
2401 that should be considered the current directory for the purpose of
2402 looking up files in the search paths. This feature is needed by the
2403 `mktex...' scripts *note mktex scripts::, because these change the
2404 working directory. You should not ever define it yourself.
2407 File: kpathsea.info, Node: Subdirectory expansion, Prev: KPSE_DOT expansion, Up: Path expansion
2409 3.3.6 Subdirectory expansion
2410 ----------------------------
2412 Two or more consecutive slashes in a path element following a directory
2413 D is replaced by all subdirectories of D: first those subdirectories
2414 directly under D, then the subsubdirectories under those, and so on.
2415 At each level, the order in which the directories are searched is
2416 unspecified. (It's "directory order", and definitely not alphabetical.)
2418 If you specify any filename components after the `//', only
2419 subdirectories which match those components are included. For example,
2420 `/a//b' would expand into directories `/a/1/b', `/a/2/b', `/a/1/1/b',
2421 and so on, but not `/a/b/c' or `/a/1'.
2423 You can include multiple `//' constructs in the path.
2425 `//' at the beginning of a path is ignored; you didn't really want
2426 to search every directory on the system, did you?
2428 I should mention one related implementation trick, which I took from
2429 GNU find. Matthew Farwell suggested it, and David MacKenzie
2432 The trick is that in every real Unix implementation (as opposed to
2433 the POSIX specification), a directory which contains no subdirectories
2434 will have exactly two links (namely, one for `.' and one for `..').
2435 That is to say, the `st_nlink' field in the `stat' structure will be
2436 two. Thus, we don't have to stat everything in the bottom-level (leaf)
2437 directories--we can just check `st_nlink', notice it's two, and do no
2440 But if you have a directory that contains a single subdirectory and
2441 500 regular files, `st_nlink' will be 3, and Kpathsea has to stat every
2442 one of those 501 entries. Therein lies slowness.
2444 You can disable the trick by undefining `UNIX_ST_LINK' in
2445 `kpathsea/config.h'. (It is undefined by default except under Unix.)
2447 Unfortunately, in some cases files in leaf directories are `stat''d:
2448 if the path specification is, say, `$TEXMF/fonts//pk//', then files in
2449 a subdirectory `.../pk', even if it is a leaf, are checked. The reason
2450 cannot be explained without reference to the implementation, so read
2451 `kpathsea/elt-dirs.c' (search for `may descend') if you are curious.
2452 And if you can find a way to _solve_ the problem, please let me know.
2454 Subdirectory expansion is implemented in the source file
2455 `kpathsea/elt-dirs.c'.
2458 File: kpathsea.info, Node: Filename database, Next: Invoking kpsewhich, Prev: Path expansion, Up: Path searching
2460 3.4 Filename database (`ls-R')
2461 ==============================
2463 Kpathsea goes to some lengths to minimize disk accesses for searches
2464 (*note Subdirectory expansion::). Nevertheless, in practice searching
2465 each possible directory in typical TeX installations takes an
2466 excessively long time.
2468 Therefore, Kpathsea can use an externally-built "filename database"
2469 file named `ls-R' that maps files to directories, thus avoiding the
2470 need to exhaustively search the disk.
2472 A second database file `aliases' allows you to give additional names
2473 to the files listed in `ls-R'. This can be helpful to adapt to "8.3"
2474 filename conventions in source files.
2476 The `ls-R' and `aliases' features are implemented in the source file
2481 * ls-R:: The main filename database.
2482 * Filename aliases:: Aliases for those names.
2483 * Database format:: Syntax details of the database file.
2486 File: kpathsea.info, Node: ls-R, Next: Filename aliases, Up: Filename database
2491 As mentioned above, you must name the main filename database `ls-R'.
2492 You can put one at the root of each TeX installation hierarchy you wish
2493 to search (`$TEXMF' by default); most sites have only one hierarchy.
2494 Kpathsea looks for `ls-R' files along the `TEXMFDBS' path, so that
2495 should presumably match the list of hierarchies.
2497 The recommended way to create and maintain `ls-R' is to run the
2498 `mktexlsr' script, which is installed in `$(bindir)' (`/usr/local/bin'
2499 by default). That script goes to some trouble to follow symbolic links
2500 as necessary, etc. It's also invoked by the distributed `mktex...'
2503 At its simplest, though, you can build `ls-R' with the command
2504 cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
2506 presuming your `ls' produces the right output format (see the section
2507 below). GNU `ls', for example, outputs in this format. Also presuming
2508 your `ls' hasn't been aliased in a system file (e.g., `/etc/profile')
2509 to something problematic, e.g., `ls --color=tty'. In that case, you
2510 will have to disable the alias before generating `ls-R'. For the
2511 precise definition of the file format, see *note Database format::.
2513 Regardless of whether you use the supplied script or your own, you
2514 will almost certainly want to invoke it via `cron', so when you make
2515 changes in the installed files (say if you install a new LaTeX
2516 package), `ls-R' will be automatically updated.
2518 The `-A' option to `ls' includes files beginning with `.' (except
2519 for `.' and `..'), such as the file `.tex' included with the LaTeX
2520 tools package. (On the other hand, _directories_ whose names begin
2521 with `.' are always ignored.)
2523 If your system does not support symbolic links, omit the `-L'.
2525 `ls -LAR /YOUR/TEXMF/ROOT' will also work. But using `./' avoids
2526 embedding absolute pathnames, so the hierarchy can be easily
2527 transported. It also avoids possible trouble with automounters or
2528 other network filesystem conventions.
2530 Kpathsea warns you if it finds an `ls-R' file, but the file does not
2531 contain any usable entries. The usual culprit is running plain `ls -R'
2532 instead of `ls -LR ./' or `ls -R /YOUR/TEXMF/ROOT'. Another
2533 possibility is some system directory name starting with a `.' (perhaps
2534 if you are using AFS); Kpathsea ignores everything under such
2537 Because the database may be out-of-date for a particular run, if a
2538 file is not found in the database, by default Kpathsea goes ahead and
2539 searches the disk. If a particular path element begins with `!!',
2540 however, _only_ the database will be searched for that element, never
2541 the disk. If the database does not exist, nothing will be searched.
2542 Because this can surprise users ("I see the font `foo.tfm' when I do an
2543 `ls'; why can't Dvips find it?"), it is not in any of the default
2547 File: kpathsea.info, Node: Filename aliases, Next: Database format, Prev: ls-R, Up: Filename database
2549 3.4.2 Filename aliases
2550 ----------------------
2552 In some circumstances, you may wish to find a file under several names.
2553 For example, suppose a TeX document was created using a DOS system and
2554 tries to read `longtabl.sty'. But now it's being run on a Unix system,
2555 and the file has its original name, `longtable.sty'. The file won't be
2556 found. You need to give the actual file `longtable.sty' an alias
2559 You can handle this by creating a file `aliases' as a companion to
2560 the `ls-R' for the hierarchy containing the file in question. (You
2561 must have an `ls-R' for the alias feature to work.)
2563 The format of `aliases' is simple: two whitespace-separated words
2564 per line; the first is the real name `longtable.sty', and second is the
2565 alias (`longtabl.sty'). These must be base filenames, with no
2566 directory components. `longtable.sty' must be in the sibling `ls-R'.
2568 Also, blank lines and lines starting with `%' or `#' are ignored in
2569 `aliases', to allow for comments.
2571 If a real file `longtabl.sty' exists, it is used regardless of any
2575 File: kpathsea.info, Node: Database format, Prev: Filename aliases, Up: Filename database
2577 3.4.3 Database format
2578 ---------------------
2580 The "database" read by Kpathsea is a line-oriented file of plain text.
2581 The format is that generated by GNU (and most other) `ls' programs
2582 given the `-R' option, as follows.
2584 * Blank lines are ignored.
2586 * If a line begins with `/' or `./' or `../' and ends with a colon,
2587 it's the name of a directory. (`../' lines aren't useful,
2588 however, and should not be generated.)
2590 * All other lines define entries in the most recently seen directory.
2591 /'s in such lines will produce possibly-strange results.
2593 * Files with no preceding directory line are ignored.
2595 For example, here's the first few lines of `ls-R' (which totals
2596 about 30K bytes) on my system:
2618 File: kpathsea.info, Node: Invoking kpsewhich, Prev: Filename database, Up: Path searching
2620 3.5 `kpsewhich': Standalone path searching
2621 ==========================================
2623 The Kpsewhich program exercises the path searching functionality
2624 independent of any particular application. This can also be useful as a
2625 sort of `find' program to locate files in your TeX hierarchies, perhaps
2626 in administrative scripts. It is used heavily in the distributed
2630 kpsewhich OPTION... FILENAME...
2632 The options and filename(s) to look up can be intermixed. Options
2633 can start with either `-' or `--', and any unambiguous abbreviation is
2638 * Path searching options:: Changing the mode, resolution, etc.
2639 * Specially-recognized files:: Default formats for texmf.cnf, etc.
2640 * Auxiliary tasks:: Path and variable expansion.
2641 * Standard options:: --help and --version.
2644 File: kpathsea.info, Node: Path searching options, Next: Specially-recognized files, Up: Invoking kpsewhich
2646 3.5.1 Path searching options
2647 ----------------------------
2649 Kpsewhich looks up each non-option argument on the command line as a
2650 filename, and returns the first file found.
2652 Various options alter the path searching behavior:
2655 Report all matches found, one per line. By default, if there is
2656 more than one match, just one will be reported (chosen effectively
2660 Set the resolution to NUM; this only affects `gf' and `pk'
2661 lookups. `-D' is a synonym, for compatibility with Dvips.
2665 Set the engine name to NAME. By default it is not set. The
2666 engine name is used in some search paths to allow files with the
2667 same name but used by different engines to coexist.
2669 In particular, since the memory dump files (`.fmt'/`.base'/`.mem')
2670 are now stored in subdirectories named for the engine (`tex',
2671 `pdftex', `xetex', etc.), you must specify an engine name in order
2672 to find them. For example, `cont-en.fmt' typically exists for both
2673 `pdftex' and `xetex'. With the default path settings, you can use
2674 `--engine=/' to look for any dump file, regardless of engine; if a
2675 dump file exists for more than one engine, it's indeterminate
2676 which one is returned. (The `/' ends up specifying a normal
2677 recursive search along the path where the dumps are stored, namely
2678 `$TEXMF/web2c{/$engine,}'.)
2681 Set the format for lookup to NAME. By default, the format is
2682 guessed from the filename, with `tex' being used if nothing else
2683 fits. The recognized filename extensions (including any leading
2684 `.') are also allowable NAMEs.
2686 All formats also have a name, which is the only way to specify
2687 formats with no associated suffix. For example, for Dvips
2688 configuration files you can use `--format="dvips config"'. (The
2689 quotes are for the sake of the shell.)
2691 Here's the current list of recognized names and the associated
2692 suffixes. *Note Supported file formats::, for more information on
2718 graphic/figure: .eps .epsi
2720 TeX system documentation
2723 PostScript header/font: .pro
2726 type1 fonts: .pfa .pfb
2730 truetype fonts: .ttf .ttc
2746 This option and `--path' are mutually exclusive.
2749 After processing the command line, read additional filenames to
2750 look up from standard input.
2753 `-no-mktex=FILETYPE'
2754 Turn on or off the `mktex' script associated with FILETYPE. The
2755 only values that make sense for FILETYPE are `pk', `mf', `tex',
2756 and `tfm'. By default, all are off in Kpsewhich. *Note mktex
2760 Set the mode name to STRING; this also only affects `gf' and `pk'
2761 lookups. No default: any mode will be found. *Note mktex script
2765 Do everything possible to find the files, notably including
2766 searching the disk. By default, only the `ls-R' database is
2767 checked, in the interest of efficiency.
2770 Search along the path STRING (colon-separated as usual), instead
2771 of guessing the search path from the filename. `//' and all the
2772 usual expansions are supported (*note Path expansion::). This
2773 option and `--format' are mutually exclusive. To output the
2774 complete directory expansion of a path, instead of doing a
2775 one-shot lookup, see `--expand-path' and `--show-path' in the
2779 Set the program name to NAME; default is `kpsewhich'. This can
2780 affect the search paths via the `.PROGNAM' feature in
2781 configuration files (*note Config files::).
2784 Report only those matches whose directory part _ends_ with STRING
2785 (compared literally, except case is ignored on a case-insensitive
2786 operating system). For example, suppose there are two matches for
2790 => /some/where/foo.sty
2791 /another/place/foo.sty
2793 Then we can narrow the result to what we are interested in with
2796 kpsewhich --subdir=where foo.sty
2797 => /some/where/foo.sty
2799 kpsewhich --subdir=place foo.sty
2800 => /another/place/foo.sty
2802 The string to match must be at the end of the directory part of the
2803 match, and it is taken literally, with no pattern matching:
2805 kpsewhich --subdir=another foo.sty
2808 The string to match may cross directory components:
2810 kpsewhich --subdir=some/where foo.sty
2811 => /some/where/foo.sty
2813 `--subdir' implies `--all'; if there is more than one match, they
2814 will all be reported (in our example, both `where' and `place' end
2817 kpsewhich --subdir=e
2818 => /some/where/foo.sty
2819 /another/place/foo.sty
2821 Because of the above rules, the presence of a leading `/' is
2822 important, since it "anchors" the match to a full component name:
2824 kpsewhich --subdir=/lace foo.sty
2827 However, a trailing `/' is immaterial (and ignored), since the
2828 match always takes place at the end of the directory part:
2830 kpsewhich --subdir=lace/ foo.sty
2831 => /another/place/foo.sty
2833 The purpose of these rules is to make it convenient to find results
2834 only within a particular area of the tree. For instance, a given
2835 script named `foo.lua' might exist within both
2836 `texmf-dist/scripts/pkg1/' and `texmf-dist/scripts/pkg2/'. By
2837 specifying, say, `--subdir=/pkg1', you can be sure of getting the
2838 one you are interested in.
2840 We only match at the end because a site might happen to install TeX
2841 in `/some/coincidental/pkg1/path/', and we wouldn't want
2842 `texmf-dist/scripts/pkg2/' to match that when searching for
2847 File: kpathsea.info, Node: Specially-recognized files, Next: Auxiliary tasks, Prev: Path searching options, Up: Invoking kpsewhich
2849 3.5.2 Specially-recognized files for `kpsewhich'
2850 ------------------------------------------------
2852 `kpsewhich' recognizes a few special filenames on the command line and
2853 defaults to using the `known' file formats for them, merely to save the
2854 time and trouble of specifying the format. This is only a feature of
2855 `kpsewhich'; when using the Kpathsea library itself, none of these
2856 special filenames are recognized, and it's still up to the caller to
2857 specify the desired format.
2859 Here is the list of special filenames to `kpsewhich', along with
2860 their corresponding format:
2881 `pdftex config' (although `pdftex.cfg' is not used any more; look
2882 for the file `pdftexconfig.tex' instead.)
2888 A user-specified format will override the above defaults.
2890 Another useful configuration file in this regard is `tcfmgr.map',
2891 found in `texmf/texconfig/tcfmgr.map', which records various
2892 information about the above configuration files (among others).
2895 File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Specially-recognized files, Up: Invoking kpsewhich
2897 3.5.3 Auxiliary tasks
2898 ---------------------
2900 Kpsewhich provides some additional features not strictly related to path
2903 * `--debug=NUM' sets the debugging options to NUM. *Note
2906 * `--var-value=VARIABLE' outputs the value of VARIABLE, expanding
2907 `$' (*note Variable expansion:: and `~' (*note Tilde expansion::)
2908 constructs, but not performing other expansions.
2910 * `--expand-braces=STRING' outputs the variable and brace expansion
2911 of STRING. *Note Path expansion::.
2913 * `--expand-var=STRING' outputs the variable and tilde expansion of
2914 STRING. For example, the `mktex...' scripts run `kpsewhich
2915 --expand-var='$TEXMF'' to find the root of the TeX system
2916 hierarchy. *Note Path expansion::.
2918 * `--expand-path=STRING' outputs the complete expansion of STRING,
2919 with each element separated by the usual path separator on the
2920 current system (`;' on Windows, `:' otherwise). This may be
2921 useful to construct a custom search path for a format not
2922 otherwise supported. To retrieve the search path for a format
2923 that is already supported, see `--show-path', next.
2925 Nonexistent directories are culled from the output:
2927 $ kpsewhich --expand-path '/tmp'
2929 $ kpsewhich --expand-path '/nonesuch'
2932 For one-shot uses of an arbitrary (not built in to Kpathsea) path,
2933 see `--path' in the previous section.
2935 * `--show-path=NAME' shows the path that would be used for file
2936 lookups of file type NAME. Either a filename extension (`pk',
2937 `.vf', etc.) or an integer can be used, just as with `--format',
2938 described in the previous section.
2942 File: kpathsea.info, Node: Standard options, Prev: Auxiliary tasks, Up: Invoking kpsewhich
2944 3.5.4 Standard options
2945 ----------------------
2947 Kpsewhich accepts the standard GNU options:
2949 * `--help' prints a help message on standard output and exits.
2951 * `--version' prints the Kpathsea version number and exits.
2954 File: kpathsea.info, Node: TeX support, Next: Programming, Prev: Path searching, Up: Top
2959 Although the basic features in Kpathsea can be used for any type of path
2960 searching, it came about (like all libraries) with a specific
2961 application in mind: I wrote Kpathsea specifically for TeX system
2962 programs. I had been struggling with the programs I was using (Dvips,
2963 Xdvi, and TeX itself) having slightly different notions of how to
2964 specify paths; and debugging was painful, since no code was shared.
2966 Therefore, Kpathsea provides some TeX-specific formats and features.
2967 Indeed, many of the supposedly generic path searching features were
2968 provided because they seemed useful in that conTeXt (font lookup,
2971 Kpathsea provides a standard way to search for files of any of the
2972 supported file types; glyph fonts are a bit different than all the rest.
2973 Searches are based solely on filenames, not file contents--if a GF file
2974 is named `cmr10.600pk', it will be found as a PK file.
2978 * Supported file formats:: File types Kpathsea knows about.
2979 * File lookup:: Searching for most kinds of files.
2980 * Glyph lookup:: Searching for bitmap fonts.
2981 * Suppressing warnings:: Avoiding warnings via TEX_HUSH.
2984 File: kpathsea.info, Node: Supported file formats, Next: File lookup, Up: TeX support
2986 4.1 Supported file formats
2987 ==========================
2989 Kpathsea has support for a number of file types. Each file type has a
2990 list of environment and config file variables that are checked to define
2991 the search path, and most have a default suffix that plays a role in
2992 finding files (see the next section). Some also define additional
2993 suffixes, and/or a program to be run to create missing files on the fly.
2995 Since environment variables containing periods, such as
2996 `TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
2997 environment variables with an underscore, e.g., `TEXINPUTS_latex'
2998 (*note Config files::).
3000 The following table lists the above information.
3003 (Adobe font metrics, *note Metric files: (dvips)Metric files.)
3004 `AFMFONTS'; suffix `.afm'.
3007 (Metafont memory dump, *note Memory dumps: (web2c)Memory dumps.)
3008 `MFBASES', `TEXMFINI'; suffix `.base'.
3011 (BibTeX bibliography source, *note bibtex invocation:
3012 (web2c)bibtex invocation.) `BIBINPUTS', `TEXBIB'; suffix `.bib'.
3015 (BibTeX style file, *note Basic BibTeX style files: (web2c)Basic
3016 BibTeX style files.) `BSTINPUTS'; suffix `.bst'.
3019 (character map files) `CMAPFONTS'; suffix `.cmap'.
3022 (Runtime configuration files, *note Config files::) `TEXMFCNF';
3026 (CWEB input files) `CWEBINPUTS'; suffixes `.w', `.web'; additional
3030 (Dvips `config.*' files, such as `config.ps', *note Config files:
3031 (dvips)Config files.) `TEXCONFIG'.
3034 (encoding vectors) `ENCFONTS'; suffix `.enc'.
3037 (TeX memory dump, *note Memory dumps: (web2c)Memory dumps.)
3038 `TEXFORMATS', `TEXMFINI'; suffix `.fmt'.
3041 (generic font bitmap, *note Glyph files: (dvips)Glyph files.)
3042 `PROGRAMFONTS', `GFFONTS', `GLYPHFONTS', `TEXFONTS'; suffix `gf'.
3045 (Encapsulated PostScript figures, *note PostScript figures:
3046 (dvips)PostScript figures.) `TEXPICTS', `TEXINPUTS'; additional
3047 suffixes: `.eps', `.epsi'.
3050 (makeindex style files) `TEXINDEXSTYLE', `INDEXSTYLE'; suffix
3054 (ligature definition files) `LIGFONTS'; suffix `.lig'.
3057 (Filename databases, *note Filename database::) `TEXMFDBS'.
3060 (Fontmaps, *note Fontmap::) `TEXFONTMAPS'; suffix `.map'.
3063 (MetaPost memory dump, *note Memory dumps: (web2c)Memory dumps.)
3064 `MPMEMS', `TEXMFINI'; suffix `.mem'.
3067 (MetaPost support files, used by DMP; *note dmp invocation:
3068 (web2c)dmp invocation.) `MPSUPPORT'.
3071 (Metafont source, *note mf invocation: (web2c)mf invocation.)
3072 `MFINPUTS'; suffix `.mf'; dynamic creation program: `mktexmf'.
3075 (Metafont program strings, *note pooltype invocation:
3076 (web2c)pooltype invocation.) `MFPOOL', `TEXMFINI'; suffix `.pool'.
3079 (`MFT' style file, *note mft invocation: (web2c)mft invocation.)
3080 `MFTINPUTS'; suffix `.mft'.
3083 (font-related files that don't fit the other categories)
3087 (MetaPost source, *note mpost invocation: (web2c)mpost invocation.)
3088 `MPINPUTS'; suffix `.mp'.
3091 (MetaPost program strings, *note pooltype invocation:
3092 (web2c)pooltype invocation.) `MPPOOL', `TEXMFINI'; suffix `.pool'.
3095 (Omega compiled process files) `OCPINPUTS';
3096 suffix `.ocp'; dynamic creation program: `MakeOmegaOCP'.
3099 (Omega font metrics) `OFMFONTS', `TEXFONTS';
3100 suffixes `.ofm', `.tfm'; dynamic creation program: `MakeOmegaOFM'.
3103 (OpenType fonts) `OPENTYPEFONTS'.
3106 (Omega property lists) `OPLFONTS', `TEXFONTS'; suffix `.opl'.
3109 (Omega translation process files) `OTPINPUTS'; suffix `.otp'.
3112 (Omega virtual fonts) `OVFFONTS', `TEXFONTS'; suffix `.ovf'.
3115 (Omega virtual property lists) `OVPFONTS', `TEXFONTS'; suffix
3119 (PDFTeX-specific configuration files) `PDFTEXCONFIG'.
3122 (packed bitmap fonts, *note Glyph files: (dvips)Glyph files.)
3123 `PROGRAMFONTS' (PROGRAM being `XDVI', etc.), `PKFONTS', `TEXPKS',
3124 `GLYPHFONTS', `TEXFONTS'; suffix `pk'; dynamic creation program:
3128 (downloadable PostScript, *note Header files: (dvips)Header files.)
3129 `TEXPSHEADERS', `PSHEADERS'; additional suffix `.pro'.
3131 `subfont definition files'
3132 (subfont definition files) `SFDFONTS' suffix `.sfd'.
3135 (TeX source, *note tex invocation: (web2c)tex invocation.)
3136 `TEXINPUTS'; suffix `.tex'; additional suffixes: none, because
3137 such a list cannot be complete; dynamic creation program:
3140 `TeX system documentation'
3141 (Documentation files for the TeX system) `TEXDOCS'.
3143 `TeX system sources'
3144 (Source files for the TeX system) `TEXSOURCES'.
3147 (Architecture-independent executables distributed in the texmf
3148 tree) `TEXMFSCRIPTS'.
3151 (TeX program strings, *note pooltype invocation: (web2c)pooltype
3152 invocation.) `TEXPOOL', `TEXMFINI'; suffix `.pool'.
3155 (TeX font metrics, *note Metric files: (dvips)Metric files.)
3156 `TFMFONTS', `TEXFONTS'; suffix `.tfm'; dynamic creation program:
3160 (Troff fonts, used by DMP; *note DMP invocation: (web2c)DMP
3161 invocation.) `TRFONTS'.
3164 (TrueType outline fonts) `TTFONTS'; suffixes `.ttf', `.ttc'.
3167 (Type 1 PostScript outline fonts, *note Glyph files: (dvips)Glyph
3168 files.) `T1FONTS', `T1INPUTS', `TEXPSHEADERS', `DVIPSHEADERS';
3169 suffixes `.pfa', `.pfb'.
3172 (Type 42 PostScript outline fonts) `T42FONTS'.
3175 (virtual fonts, *note Virtual fonts: (dvips)Virtual fonts.)
3176 `VFFONTS', `TEXFONTS'; suffix `.vf'.
3179 (WEB input files) `WEBINPUTS'; suffix `.web'; additional suffix
3183 (files specific to the web2c implementation) `WEB2C'.
3185 There are two special cases, because the paths and environment
3186 variables always depend on the name of the program: the variable name is
3187 constructed by converting the program name to upper case, and then
3188 appending `INPUTS'. Assuming the program is called `foo', this gives
3189 us the following table.
3192 (text files used by `foo') `FOOINPUTS'.
3194 `other binary files'
3195 (binary files used by `foo') `FOOINPUTS'.
3197 If an environment variable by these names are set, the corresponding
3198 `texmf.cnf' definition won't be looked at (unless, as usual, the
3199 environment variable value has an extra `:'). *Note Default
3202 For the font variables, the intent is that:
3203 * `TEXFONTS' is the default for everything.
3205 * `GLYPHFONTS' is the default for bitmap (or, more precisely,
3208 * Each font format has a variable of its own.
3210 * Each program has its own font override path as well; e.g.,
3211 `DVIPSFONTS' for Dvipsk. Again, this is for bitmaps, not metrics.
3215 File: kpathsea.info, Node: File lookup, Next: Glyph lookup, Prev: Supported file formats, Up: TeX support
3220 This section describes how Kpathsea searches for most files (bitmap font
3221 searches are the exception, as described in the next section).
3223 Here is the search strategy for a file NAME:
3225 1. If the file format defines default suffixes, and the suffix of
3226 NAME name is not already a known suffix for that format, try the
3227 name with each default appended, and use alternative names found in
3228 the fontmaps if necessary. Example: given `foo.bar', look for
3231 2. Search for NAME, and if necessary for alternative names found in
3232 the fontmaps. Example: given `foo.bar', we also look for
3235 3. If the file format defines a program to invoke to create missing
3236 files, run it (*note mktex scripts::).
3238 The order in which we search for "suffixed" name (item 1) or the
3239 "as-is" name (item 2) is controlled by the `try_std_extension_first'
3240 configuration value. The default set in `texmf.cnf' is true, since
3241 common suffixes are already recognized: `babel.sty' will only look for
3242 `babel.sty', not `babel.sty.tex', regardless of this setting.
3244 When the suffix is unknown (e.g., `foo.bar'), both names are always
3245 tried; the difference is the order in which they are tried.
3247 `try_std_extension_first' only affects names being looked up which
3248 *already* have an extension. A name without an extension (e.g., `tex
3249 story') will always have an extension added first.
3251 This algorithm is implemented in the routine `kpse_find_file' in
3252 `kpathsea/tex-file.c'. You can watch it in action with the debugging
3253 options (*note Debugging::).
3256 File: kpathsea.info, Node: Glyph lookup, Next: Suppressing warnings, Prev: File lookup, Up: TeX support
3261 This section describes how Kpathsea searches for a bitmap font in GF or
3262 PK format (or either) given a font name (e.g., `cmr10') and a
3263 resolution (e.g., 600).
3265 Here is an outline of the search strategy (details in the sections
3266 below) for a file NAME at resolution DPI. The search stops at the
3267 first successful lookup.
3269 1. Look for an existing file NAME.DPIFORMAT in the specified
3272 2. If NAME is an alias for a file F in the fontmap file
3273 `texfonts.map', look for F.DPI.
3275 3. Run an external program (typically named `mktexpk') to generate
3276 the font (*note mktex scripts::)
3278 4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
3279 (typically `cmr10').
3281 This is implemented in `kpse_find_glyph_format' in
3282 `kpathsea/tex-glyph.c'.
3286 * Basic glyph lookup:: Features common to all glyph lookups.
3287 * Fontmap:: Aliases for fonts.
3288 * Fallback font:: Resolutions and fonts of last resort.
3291 File: kpathsea.info, Node: Basic glyph lookup, Next: Fontmap, Up: Glyph lookup
3293 4.3.1 Basic glyph lookup
3294 ------------------------
3296 When Kpathsea looks for a bitmap font NAME at resolution DPI in a
3297 format FORMAT, it first checks each directory in the search path for a
3298 file `NAME.DPIFORMAT'; for example, `cmr10.600pk'. Kpathsea looks for
3299 a PK file first, then a GF file.
3301 If that fails, Kpathsea looks for `dpiDPI/NAME.FORMAT'; for example,
3302 `dpi600/cmr10.pk'. This is how fonts are typically stored on
3303 filesystems (such as DOS) that permit only three-character extensions.
3305 If that fails, Kpathsea looks for a font with a close-enough DPI.
3306 "Close enough" is defined by the macro `KPSE_BITMAP_TOLERANCE' in
3307 `kpathsea/tex-glyph.h' to be `DPI / 500 + 1'. This is slightly more
3308 than the 0.2% minimum allowed by the DVI standard
3309 (`CTAN:/dviware/driv-standard/level-0').
3312 File: kpathsea.info, Node: Fontmap, Next: Fallback font, Prev: Basic glyph lookup, Up: Glyph lookup
3317 If a bitmap font or metric file is not found with the original name (see
3318 the previous section), Kpathsea looks through any "fontmap" files for
3319 an "alias" for the original font name. These files are named
3320 `texfonts.map' and searched for along the `TEXFONTMAPS'
3321 environment/config file variable. All `texfonts.map' files that are
3322 found are read; earlier definitions override later ones.
3324 This feature is intended to help in two respects:
3326 1. An alias name is limited in length only by available memory, not
3327 by your filesystem. Therefore, if you want to ask for
3328 `Times-Roman' instead of `ptmr', you can (you get `ptmr8r').
3330 2. A few fonts have historically had multiple names: specifically,
3331 LaTeX's "circle font" has variously been known as `circle10',
3332 `lcircle10', and `lcirc10'. Aliases can make all the names
3333 equivalent, so that it no longer matters what the name of the
3334 installed file is; TeX documents will find their favorite name.
3337 The format of fontmap files is straightforward:
3339 * Comments start with `%' and continue to the end of the line.
3341 * Blank lines are ignored.
3343 * Each nonblank line is broken up into a series of "words": a
3344 sequence of non-whitespace characters.
3346 * If the first word is `include', the second word is used as a
3347 filename, and it is searched for and read.
3349 * Otherwise, the first word on each line is the true filename;
3351 * the second word is the alias;
3353 * subsequent words are ignored.
3355 If an alias has an extension, it matches only those files with that
3356 extension; otherwise, it matches anything with the same root, regardless
3357 of extension. For example, an alias `foo.tfm' matches only when
3358 `foo.tfm' is being searched for; but an alias `foo' matches `foo.vf',
3361 As an example, here is an excerpt from the `texfonts.map' in the
3362 Web2c distribution. It makes the circle fonts equivalent and includes
3363 automatically generated maps for most PostScript fonts available from
3364 various font suppliers.
3375 include bitstrea.map
3378 Fontmaps are implemented in the file `kpathsea/fontmap.c'. The
3379 Fontname distribution has much more information on font naming (*note
3380 Introduction: (fontname)Introduction.).
3383 File: kpathsea.info, Node: Fallback font, Prev: Fontmap, Up: Glyph lookup
3388 If a bitmap font cannot be found or created at the requested size,
3389 Kpathsea looks for the font at a set of "fallback resolutions". You
3390 specify these resolutions as a colon-separated list (like search paths).
3391 Kpathsea looks first for a program-specific environment variable (e.g.,
3392 `DVIPSSIZES' for Dvipsk), then the environment variable `TEXSIZES',
3393 then a default specified at compilation time (the Make variable
3394 `default_texsizes'). You can set this list to be empty if you prefer
3395 to find fonts at their stated size or not at all.
3397 Finally, if the font cannot be found even at the fallback
3398 resolutions, Kpathsea looks for a fallback font, typically `cmr10'.
3399 Programs must enable this feature by assigning to the global variable
3400 `kpse_fallback_font' or calling `kpse_init_prog' (*note Calling
3401 sequence::); the default is no fallback font.
3404 File: kpathsea.info, Node: Suppressing warnings, Prev: Glyph lookup, Up: TeX support
3406 4.4 Suppressing warnings
3407 ========================
3409 Kpathsea provides a way to suppress selected usually-harmless warnings;
3410 this is useful at large sites where most users are not administrators,
3411 and thus the warnings are merely a source of confusion, not a help. To
3412 do this, you set the environment variable or configuration file value
3413 `TEX_HUSH' to a colon-separated list of values. Here are the
3417 Suppress everything possible.
3420 Suppress mismatched font checksum warnings.
3423 Suppress warnings when a character is missing from a font that a
3424 DVI or VF file tries to typeset.
3427 Don't suppress any warnings.
3430 Suppress warnings about attempts to access a file whose permissions
3431 render it unreadable.
3434 Suppresses warnings about an unimplemented or unparsable
3437 `tex-hush.c' defines the function that checks the variable value. Each
3438 driver implements its own checks where appropriate.
3441 File: kpathsea.info, Node: Programming, Next: Index, Prev: TeX support, Up: Top
3446 This chapter is for programmers who wish to use Kpathsea. *Note
3447 Introduction::, for the conditions under which you may do so.
3451 * Overview: Programming overview. Introduction.
3452 * Calling sequence:: Specifics of what to call.
3453 * Program-specific files:: How to handle these.
3454 * Config: Programming with config files. Getting info from texmf.cnf.
3457 File: kpathsea.info, Node: Programming overview, Next: Calling sequence, Up: Programming
3459 5.1 Programming overview
3460 ========================
3462 Aside from this manual, your best source of information is the source to
3463 the programs I've modified to use Kpathsea (*note Introduction::). Of
3464 those, Dviljk is probably the simplest, and hence a good place to start.
3465 Xdvik adds VF support and the complication of X resources. Dvipsk adds
3466 the complication of its own config files. Web2c is source code I also
3467 maintain, so it uses Kpathsea rather straightforwardly, but is of course
3468 complicated by the Web to C translation. Finally, Kpsewhich is a small
3469 utility program whose sole purpose is to exercise the main
3470 path-searching functionality.
3472 Beyond these examples, the `.h' files in the Kpathsea source
3473 describe the interfaces and functionality (and of course the `.c' files
3474 define the actual routines, which are the ultimate documentation).
3475 `pathsearch.h' declares the basic searching routine. `tex-file.h' and
3476 `tex-glyph.h' define the interfaces for looking up particular kinds of
3477 files. In view of the way the headers depend on each other, it is
3478 recommended to use `#include <kpathsea/kpathsea.h>', which includes
3479 every Kpathsea header.
3481 If you want to include only specific headers, you should still
3482 consider including `kpathsea/config.h' before including any other
3483 Kpathsea header, as it provides symbols used in the other headers.
3484 Note that `kpathsea/config.h' includes `kpathsea/c-auto.h', which is
3485 generated by Autoconf.
3487 The library provides no way for an external program to register new
3488 file types: `tex-file.[ch]' must be modified to do this. For example,
3489 Kpathsea has support for looking up Dvips config files, even though no
3490 program other than Dvips will likely ever want to do so. I felt this
3491 was acceptable, since along with new file types should also come new
3492 defaults in `texmf.cnf' (and its descendant `paths.h'), since it's
3493 simplest for users if they can modify one configuration file for all
3496 Kpathsea does not parse any formats itself; it barely opens any
3497 files. Its primary purpose is to return filenames. The GNU font
3498 utilities does contain libraries to read TFM, GF, and PK files, as do
3499 the programs above, of course.
3502 File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Prev: Programming overview, Up: Programming
3504 5.2 Calling sequence
3505 ====================
3507 The typical way to use Kpathsea in your program goes something like
3510 1. Call `kpse_set_program_name' with `argv[0]' as the first argument;
3511 the second argument is a string or `NULL'. The second argument is
3512 used by Kpathsea as the program name for the `.PROGRAM' feature of
3513 config files (*note Config files::). If the second argument is
3514 `NULL', the value of the first argument is used. This function
3515 must be called before any other use of the Kpathsea library.
3517 `kpse_set_program_name' always sets the global variables
3518 `program_invocation_name' and `program_invocation_short_name'.
3519 These variables are used in the error message macros defined in
3520 `kpathsea/lib.h'. It sets the global variable `kpse_program_name'
3521 to the program name it uses.
3523 It also initializes debugging options based on the environment
3524 variable `KPATHSEA_DEBUG' (if that is set).
3526 Finally, it sets the variables `SELFAUTOLOC', `SELFAUTODIR' and
3527 `SELFAUTOPARENT' to the location, parent and grandparent directory
3528 of the executable, removing `.' and `..' path elements and
3529 resolving symbolic links. These are used in the default
3530 configuration file to allow people to invoke TeX from anywhere.
3531 You can use `kpsewhich --expand-var=\$SELFAUTOLOC', etc., to see
3534 2. The `kpse_set_progname' is deprecated. A call to
3535 `kpse_set_progname' with `argv[0]' is equivalent to a call of
3536 `kpse_set_program_name' with first argument `argv[0]' and second
3537 argument `NULL'. The function is deprecated because it cannot
3538 ensure that the `.PROGRAM' feature of config files will always
3539 work (*note Config files::).
3541 3. Set debugging options. *Note Debugging::. If your program doesn't
3542 have a debugging option already, you can define one and set
3543 `kpathsea_debug' to the number that the user supplies (as in Dviljk
3544 and Web2c), or you can just omit this altogether (people can
3545 always set `KPATHSEA_DEBUG'). If you do have runtime debugging
3546 already, you need to merge Kpathsea's options with yours (as in
3549 4. If your program has its own configuration files that can define
3550 search paths, you should assign those paths to the `client_path'
3551 member in the appropriate element of the `kpse_format_info' array.
3552 (This array is indexed by file type; see `tex-file.h'.) See
3553 `resident.c' in Dvipsk for an example.
3555 5. Call `kpse_init_prog' (see `proginit.c'). It's useful for the DVI
3556 drivers, at least, but for other programs it may be simpler to
3557 extract the parts of it that actually apply. This does not
3558 initialize any paths, it just looks for (and sets) certain
3559 environment variables and other random information. (A search
3560 path is always initialized at the first call to find a file of
3561 that type; this eliminates much useless work, e.g., initializing
3562 the BibTeX search paths in a DVI driver.)
3564 6. The routine to actually find a file of type FORMAT is
3565 `kpse_find_FORMAT', defined in `tex-file.h'. These are macros that
3566 expand to a call to `kpse_find_file'. You can call, say,
3567 `kpse_find_tfm' after doing only the first of the initialization
3568 steps above--Kpathsea automatically reads the `texmf.cnf' generic
3569 config files, looks for environment variables, and does expansions
3570 at the first lookup.
3572 7. To find PK and/or GF bitmap fonts, the routines are `kpse_find_pk',
3573 `kpse_find_gf' and `kpse_find_glyph', defined in `tex-glyph.h'.
3574 These return a structure in addition to the resultant filename,
3575 because fonts can be found in so many ways. See the documentation
3578 8. To actually open a file, not just return a filename, call
3579 `kpse_open_file'. This function takes the name to look up and a
3580 Kpathsea file format as arguments, and returns the usual `FILE *'.
3581 It always assumes the file must exist, and thus will search the
3582 disk if necessary (unless the search path specified `!!', etc.).
3583 In other words, if you are looking up a VF or some other file that
3584 need not exist, don't use this.
3587 Kpathsea also provides many utility routines. Some are generic: hash
3588 tables, memory allocation, string concatenation and copying, string
3589 lists, reading input lines of arbitrary length, etc. Others are
3590 filename-related: default path, tilde, and variable expansion, `stat'
3591 calls, etc. (Perhaps someday I'll move the former to a separate
3594 The `c-*.h' header files can also help your program adapt to many
3595 different systems. You will almost certainly want to use Autoconf for
3596 configuring your software if you use Kpathsea; I strongly recommend
3597 using Autoconf regardless. It is available from
3598 `ftp://prep.ai.mit.edu/pub/gnu/'.
3601 File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Calling sequence, Up: Programming
3603 5.3 Program-specific files
3604 ==========================
3606 Many programs will need to find some configuration files. Kpathsea
3607 contains some support to make it easy to place them in their own
3608 directories. The Standard TeX directory structure (*note Introduction:
3609 (tds)Top.), specifies that such files should go into a subdirectory
3610 named after the program, like `texmf/ttf2pk'.
3612 Two special formats, `kpse_program_text_format' and
3613 `kpse_program_binary_format' exist, which use `.:$TEXMF/PROGRAM//' as
3614 their compiled-in search path. To override this default, you can use
3615 the variable `PROGRAMINPUTS' in the environment and/or `texmf.cnf'.
3616 That is to say, the name of the variable is constructed by converting
3617 the name of the program to upper case, and appending `INPUTS'.
3619 The only difference between these two formats is whether
3620 `kpse_open_file' will open the files it finds in text or binary mode.
3623 File: kpathsea.info, Node: Programming with config files, Prev: Program-specific files, Up: Programming
3625 5.4 Programming with config files
3626 =================================
3628 You can (and probably should) use the same `texmf.cnf' configuration
3629 file that Kpathsea uses for your program. This helps installers by
3630 keeping all configuration in one place.
3632 To retrieve a value VAR from config files, the best way is to call
3633 `kpse_var_value' on the string `VAR'. This will look first for an
3634 environment variable VAR, then a config file value. The result will be
3635 the value found or `NULL'. This function is declared in
3636 `kpathsea/variable.h'. For an example, see the `shell_escape' code in
3637 `web2c/lib/texmfmp.c'.
3639 The routine to do variable expansion in the context of a search path
3640 (as opposed to simply retrieving a value) is `kpse_var_expand', also
3641 declared in `kpathsea/variable.h'. It's generally only necessary to
3642 set the search path structure components as explained in the previous
3643 section, rather than using this yourself.
3645 If for some reason you want to retrieve a value _only_ from a config
3646 file, not automatically looking for a corresponding environment
3647 variable, call `kpse_cnf_get' (declared in `kpathsea/cnf.h') with the
3650 No initialization calls are needed.
3653 File: kpathsea.info, Node: Index, Prev: Programming, Up: Top
3661 * !! in path specifications: ls-R. (line 52)
3662 * $ expansion: Variable expansion. (line 6)
3663 * --all: Path searching options.
3665 * --color=tty: ls-R. (line 21)
3666 * --debug=NUM: Auxiliary tasks. (line 9)
3667 * --disable-static: configure options. (line 31)
3668 * --dpi=NUM: Path searching options.
3670 * --enable options: configure options. (line 16)
3671 * --enable-maintainer-mode: configure options. (line 34)
3672 * --enable-shared <1>: Shared library. (line 6)
3673 * --enable-shared: configure options. (line 27)
3674 * --engine=NAME: Path searching options.
3676 * --expand-braces=STRING: Auxiliary tasks. (line 16)
3677 * --expand-path=STRING: Auxiliary tasks. (line 24)
3678 * --expand-var=STRING: Auxiliary tasks. (line 19)
3679 * --format=NAME: Path searching options.
3681 * --help: Standard options. (line 8)
3682 * --interactive: Path searching options.
3684 * --mode=STRING: Path searching options.
3686 * --must-exist: Path searching options.
3688 * --path=STRING: Path searching options.
3690 * --progname=NAME: Path searching options.
3692 * --show-path=NAME: Auxiliary tasks. (line 41)
3693 * --srcdir, for building multiple architectures: configure scenarios.
3695 * --subdir=STRING: Path searching options.
3697 * --var-value=VARIABLE: Auxiliary tasks. (line 12)
3698 * --version: Standard options. (line 10)
3699 * --with options: configure options. (line 16)
3700 * --with-mktextex-default: mktex configuration. (line 12)
3701 * --without-mktexfmt-default: mktex configuration. (line 12)
3702 * --without-mktexmf-default: mktex configuration. (line 12)
3703 * --without-mktexocp-default: mktex configuration. (line 12)
3704 * --without-mktexofm-default: mktex configuration. (line 12)
3705 * --without-mktexpk-default: mktex configuration. (line 12)
3706 * --without-mktextfm-default: mktex configuration. (line 12)
3707 * -1 debugging value: Debugging. (line 23)
3708 * -A option to ls: ls-R. (line 33)
3709 * -Bdynamic: ShellWidgetClass. (line 45)
3710 * -Bstatic: ShellWidgetClass. (line 45)
3711 * -D NUM: Path searching options.
3713 * -dynamic: ShellWidgetClass. (line 43)
3714 * -g, compiling without: configure scenarios. (line 32)
3715 * -L option to ls: ls-R. (line 38)
3716 * -mktex=FILETYPE: Path searching options.
3718 * -no-mktex=FILETYPE: Path searching options.
3720 * -O, compiling with: configure scenarios. (line 32)
3721 * -static: ShellWidgetClass. (line 43)
3722 * . directories, ignored: ls-R. (line 33)
3723 * . files: ls-R. (line 33)
3724 * .2602gf: Unable to generate fonts.
3726 * .afm: Supported file formats.
3728 * .base: Supported file formats.
3730 * .bib: Supported file formats.
3732 * .bst: Supported file formats.
3734 * .cmap: Supported file formats.
3736 * .cnf: Supported file formats.
3738 * .enc: Supported file formats.
3740 * .eps: Supported file formats.
3742 * .epsi: Supported file formats.
3744 * .fmt: Supported file formats.
3746 * .ist: Supported file formats.
3748 * .lig: Supported file formats.
3750 * .map: Supported file formats.
3752 * .mem: Supported file formats.
3754 * .mf: Supported file formats.
3756 * .mft: Supported file formats.
3758 * .mp: Supported file formats.
3760 * .ocp: Supported file formats.
3762 * .ofm: Supported file formats.
3764 * .opl: Supported file formats.
3766 * .otp: Supported file formats.
3768 * .ovf: Supported file formats.
3770 * .ovp: Supported file formats.
3772 * .pfa: Supported file formats.
3774 * .pfb: Supported file formats.
3776 * .pk: Supported file formats.
3778 * .pool: Supported file formats.
3780 * .pro: Supported file formats.
3782 * .rhosts, writable by TeX: Security. (line 10)
3783 * .sfd: Supported file formats.
3785 * .tex: Supported file formats.
3787 * .tex file, included in ls-R: ls-R. (line 33)
3788 * .tfm: Supported file formats.
3790 * .ttc: Supported file formats.
3792 * .ttf: Supported file formats.
3794 * .vf: Supported file formats.
3796 * .w: Supported file formats.
3798 * .web: Supported file formats.
3800 * / may not be /: Searching overview. (line 13)
3801 * /, trailing in home directory: Tilde expansion. (line 19)
3802 * //: Subdirectory expansion.
3804 * /afs/... , installing into: Installing files. (line 32)
3805 * /etc/profile: Unable to find files.
3807 * /etc/profile and aliases: ls-R. (line 21)
3808 * /var/tmp/texfonts: mktex configuration. (line 114)
3809 * 2602gf: Unable to generate fonts.
3811 * 8.3 filenames, using: mktex configuration. (line 69)
3812 * : may not be :: Searching overview. (line 13)
3813 * :: expansion: Default expansion. (line 6)
3814 * @VAR@ substitutions: Running configure. (line 6)
3815 * \, line continuation in texmf.cnf: Config files. (line 31)
3816 * \openin: Searching overview. (line 31)
3817 * \special, suppressing warnings about: Suppressing warnings.
3819 * absolute filenames: Searching overview. (line 52)
3820 * ac_include, Autoconf extension: Running configure. (line 6)
3821 * access warnings: Searching overview. (line 56)
3822 * Acorn TeX implementations: Other TeX packages. (line 6)
3823 * AFMFONTS: Supported file formats.
3825 * AFS: Installing files. (line 32)
3826 * AIX 4.1 configure error: Empty Makefiles. (line 6)
3827 * AIX shells and configure: configure shells. (line 14)
3828 * aliases for fonts: Fontmap. (line 6)
3829 * aliases, for filenames: Filename aliases. (line 6)
3830 * all: Suppressing warnings.
3832 * all matches, finding: Path searching options.
3834 * alphabetical order, not: Subdirectory expansion.
3836 * Amiga support: Custom installation. (line 19)
3837 * Amiga TeX implementations: Other TeX packages. (line 6)
3838 * Andrew File System, installing with: Installing files. (line 32)
3839 * announcement mailing list: Mailing lists. (line 6)
3840 * ANSI C: TeX or Metafont failing.
3842 * append-only directories and mktexpk: Security. (line 36)
3843 * appendonlydir: mktex configuration. (line 61)
3844 * architecture-(in)dependent files, installing only: Installing files.
3846 * architectures, compiling multiple: configure scenarios. (line 18)
3847 * arguments to mktex: mktex script arguments.
3849 * argv[0]: Calling sequence. (line 9)
3850 * ash, losing with configure: configure shells. (line 19)
3851 * autoconf, recommended: Calling sequence. (line 93)
3852 * automounter, and configuration: configure scenarios. (line 29)
3853 * automounter, and ls-R: ls-R. (line 40)
3854 * auxiliary tasks: Auxiliary tasks. (line 6)
3855 * Babel <1>: Running make. (line 51)
3856 * Babel: Kpathsea application distributions.
3858 * Bach, Johann Sebastian: Default expansion. (line 41)
3859 * backbone of CTAN: Electronic distribution.
3861 * backslash-newline: Config files. (line 31)
3862 * bash, recommended for running configure: configure shells. (line 6)
3863 * basic glyph lookup: Basic glyph lookup. (line 6)
3864 * Berry, Karl: History. (line 12)
3865 * BIBINPUTS: Supported file formats.
3867 * binary mode, for file transfers: Electronic distribution.
3869 * blank lines, in texmf.cnf: Config files. (line 29)
3870 * brace expansion: Brace expansion. (line 6)
3871 * BSD universe: Running make. (line 44)
3872 * bsh, ok with configure: configure shells. (line 14)
3873 * BSTINPUTS: Supported file formats.
3875 * bug address: Reporting bugs. (line 8)
3876 * bug checklist: Bug checklist. (line 6)
3877 * bug mailing list: Mailing lists. (line 6)
3878 * bugs, reporting: Reporting bugs. (line 6)
3879 * c-*.h: Calling sequence. (line 93)
3880 * c-auto.h: Programming overview.
3882 * c-auto.in: Running configure. (line 6)
3883 * cache of fonts, local: Security. (line 22)
3884 * calling sequence: Calling sequence. (line 6)
3885 * CC: configure environment.
3887 * cc warnings: Pointer combination warnings.
3889 * cc, compiling with: configure environment.
3891 * CD-ROM distributions: CD-ROM distribution. (line 6)
3892 * CFLAGS: configure environment.
3894 * ChangeLog entry: Bug checklist. (line 56)
3895 * checklist for bug reports: Bug checklist. (line 6)
3896 * checksum: Suppressing warnings.
3898 * circle fonts: Fontmap. (line 19)
3899 * clean Make target: Cleaning up. (line 15)
3900 * client_path in kpse_format_info: Calling sequence. (line 48)
3901 * CMAPFONTS: Supported file formats.
3903 * cmr10, as fallback font: Fallback font. (line 15)
3904 * cmr10.vf: Searching overview. (line 31)
3905 * cnf.c: Config files. (line 80)
3906 * cnf.h: Programming with config files.
3908 * code sharing: Shared library. (line 9)
3909 * color printers, configuring: Simple installation. (line 60)
3910 * comments, in fontmap files: Fontmap. (line 28)
3911 * comments, in texmf.cnf: Config files. (line 27)
3912 * comments, making: Introduction. (line 27)
3913 * common features in glyph lookup: Basic glyph lookup. (line 6)
3914 * common problems: Common problems. (line 6)
3915 * comp.sys.sun.admin FAQ: ShellWidgetClass. (line 6)
3916 * comp.text.tex: Mailing lists. (line 29)
3917 * compilation: Installation. (line 6)
3918 * compilation value, source for path: Path sources. (line 20)
3919 * compiler bugs: TeX or Metafont failing.
3921 * compiler bugs, finding: TeX or Metafont failing.
3923 * compiler options, additional: Running make. (line 27)
3924 * compiler options, specifying: configure environment.
3926 * compiler, changing: Running make. (line 40)
3927 * compiling on HP-UX: TeX or Metafont failing.
3929 * conditions for use: Introduction. (line 31)
3930 * config files: Config files. (line 6)
3931 * config files, for Kpathsea-using programs: Calling sequence.
3933 * config files, programming with: Programming with config files.
3935 * config.h: Programming overview.
3937 * config.log: Bug checklist. (line 28)
3938 * config.ps: Specially-recognized files.
3940 * config.ps, search path for: Supported file formats.
3942 * config.status: Bug checklist. (line 31)
3943 * configuration: Installation. (line 6)
3944 * configuration bugs: Bug checklist. (line 31)
3945 * configuration compiler options: configure environment.
3947 * configuration file, source for path: Path sources. (line 17)
3948 * configuration files as shell scripts.: Config files. (line 72)
3949 * configuration of mktex scripts: mktex configuration. (line 6)
3950 * configuration of optional features: configure options. (line 16)
3951 * configure error from sed: Empty Makefiles. (line 6)
3952 * configure options: configure options. (line 6)
3953 * configure options for mktex scripts: mktex configuration. (line 12)
3954 * configure, running: Running configure. (line 6)
3955 * context diff: Bug checklist. (line 56)
3956 * continuation character: Config files. (line 31)
3957 * core dumps, reporting: Bug checklist. (line 62)
3958 * CPPFLAGS: configure environment.
3960 * crashes, reporting: Bug checklist. (line 62)
3961 * CTAN, defined: Electronic distribution.
3963 * CTAN.sites: Electronic distribution.
3965 * custom installation: Custom installation. (line 6)
3966 * CWEBINPUTS: Supported file formats.
3968 * database search: Searching overview. (line 17)
3969 * database, for filenames: Filename database. (line 6)
3970 * database, format of: Database format. (line 6)
3971 * debug.h: Debugging. (line 6)
3972 * debugger: Bug checklist. (line 62)
3973 * debugging: Debugging. (line 6)
3974 * debugging options, in Kpathsea-using program: Calling sequence.
3976 * debugging output: Debugging. (line 27)
3977 * debugging with -g, disabling: configure scenarios. (line 32)
3978 * DEC shells and configure: configure shells. (line 25)
3979 * default expansion: Default expansion. (line 6)
3980 * default path features: Default path features.
3982 * default paths, changing: Default path generation.
3984 * default paths, how they're made: Default path generation.
3986 * default_texsizes: Fallback font. (line 6)
3987 * DEFS: configure environment.
3989 * depot: configure scenarios. (line 29)
3990 * device, wrong: Unable to generate fonts.
3992 * directories, changing default installation: Default path generation.
3994 * directories, making append-only: mktex configuration. (line 62)
3995 * directory permissions: Security. (line 51)
3996 * directory structure, for TeX files: TeX directory structure.
3998 * disabling mktex scripts: mktex configuration. (line 6)
3999 * disk search: Searching overview. (line 22)
4000 * disk searching, avoiding: ls-R. (line 52)
4001 * disk space, needed: Disk space. (line 6)
4002 * disk usage, reducing: Logging. (line 6)
4003 * distclean Make target: Cleaning up. (line 6)
4004 * distributions, compiling simultaneously: Kpathsea application distributions.
4006 * distributions, not compiling: Kpathsea application distributions.
4008 * distributions, on CD-ROM: CD-ROM distribution. (line 6)
4009 * distributions, via ftp: Electronic distribution.
4011 * dlclose: dlopen. (line 6)
4012 * dlopen: dlopen. (line 6)
4013 * dlsym: dlopen. (line 6)
4014 * dlsym.c: dlopen. (line 21)
4015 * doc files: Supported file formats.
4017 * DOS compatible names: mktex configuration. (line 69)
4018 * DOS support: Custom installation. (line 19)
4019 * DOS TeX implementations: Other TeX packages. (line 6)
4020 * dosnames: mktex configuration. (line 68)
4021 * dot files: ls-R. (line 33)
4022 * doubled colons: Default expansion. (line 6)
4023 * dpiNNN directories: mktex configuration. (line 69)
4024 * DVI drivers: Kpathsea application distributions.
4026 * DVILJMAKEPK: mktex script names. (line 32)
4027 * DVILJSIZES: Fallback font. (line 6)
4028 * dvipdfmx.cfg: Specially-recognized files.
4030 * DVIPSFONTS: Supported file formats.
4032 * DVIPSHEADERS: Supported file formats.
4034 * DVIPSMAKEPK: mktex script names. (line 32)
4035 * DVIPSSIZES: Fallback font. (line 6)
4036 * dynamic creation of files: mktex scripts. (line 6)
4037 * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
4039 * EC fonts, and dynamic source creation: mktex scripts. (line 6)
4040 * elt-dirs.c: Subdirectory expansion.
4042 * email CTAN access: Electronic distribution.
4044 * enabling mktex scripts: mktex configuration. (line 6)
4045 * ENCFONTS: Supported file formats.
4047 * engine name: Path searching options.
4049 * environment variable, source for path: Path sources. (line 9)
4050 * environment variables for TeX: Supported file formats.
4052 * environment variables in paths: Variable expansion. (line 6)
4053 * environment variables, old: Unable to find files.
4055 * epoch, seconds since: Logging. (line 15)
4056 * error message macros: Calling sequence. (line 16)
4057 * excessive startup time: Slow path searching. (line 6)
4058 * expand.c: Brace expansion. (line 26)
4059 * expanding symlinks: Calling sequence. (line 25)
4060 * expansion, default: Default expansion. (line 6)
4061 * expansion, path element: Searching overview. (line 43)
4062 * expansion, search path: Path expansion. (line 6)
4063 * expansion, subdirectory: Subdirectory expansion.
4065 * expansion, tilde: Tilde expansion. (line 6)
4066 * expansion, variable: Variable expansion. (line 6)
4067 * explicitly relative filenames: Searching overview. (line 52)
4068 * extensions, filename: File lookup. (line 24)
4069 * externally-built filename database: Filename database. (line 6)
4070 * extra colons: Default expansion. (line 6)
4071 * extraclean Make target: Cleaning up. (line 23)
4072 * failed mktex... script invocation: mktex script names. (line 35)
4073 * fallback font: Fallback font. (line 6)
4074 * fallback resolutions: Fallback font. (line 6)
4075 * fallback resolutions, overriding: Running make. (line 10)
4076 * FAQ, comp.sys.sun.admin: ShellWidgetClass. (line 6)
4077 * FAQ, Kpathsea: Common problems. (line 6)
4078 * Farwell, Matthew: Subdirectory expansion.
4080 * features, of default paths: Default path features.
4082 * file formats, supported: Supported file formats.
4084 * file lookup: File lookup. (line 6)
4085 * file permissions: Security. (line 47)
4086 * file types, registering new: Programming overview.
4088 * filename aliases: Filename aliases. (line 6)
4089 * filename database: Filename database. (line 6)
4090 * filename database generation: Filename database generation.
4092 * filenames, absolute or explicitly relative: Searching overview.
4094 * files, unable to find: Unable to find files.
4096 * filesystem search: Searching overview. (line 22)
4097 * floating directories: Searching overview. (line 22)
4098 * fmtutil: mktex script names. (line 10)
4099 * fmtutil.cnf: Specially-recognized files.
4101 * fmtutils.cnf: mktex configuration. (line 24)
4102 * font alias files: Fontmap. (line 6)
4103 * font generation failures: Unable to generate fonts.
4105 * font of last resort: Fallback font. (line 6)
4106 * font set, infinite: mktex scripts. (line 6)
4107 * fontmap files: Fontmap. (line 6)
4108 * fontmaps: mktex configuration. (line 87)
4109 * fontname: mktex configuration. (line 88)
4110 * fontnames, arbitrary length: Fontmap. (line 15)
4111 * fonts, being created: Simple installation. (line 79)
4112 * FOOINPUTS: Supported file formats.
4114 * fopen, redefined: Debugging. (line 54)
4115 * format of external database: Database format. (line 6)
4116 * Free Software Foundation: CD-ROM distribution. (line 12)
4117 * FreeBSD configure error: Empty Makefiles. (line 6)
4118 * FreeBSD shells and configure: configure shells. (line 19)
4119 * FSF Source Code CD-ROM: CD-ROM distribution. (line 12)
4120 * ftp retrieval: Electronic distribution.
4122 * ftp.tug.org: unixtex.ftp. (line 6)
4123 * fundamental purpose of Kpathsea: Introduction. (line 6)
4124 * gcc, compiling with: configure environment.
4126 * gdb, recommended: Bug checklist. (line 62)
4127 * generation of filename database: Filename database generation.
4129 * get_applicationShellWidgetClass: ShellWidgetClass. (line 6)
4130 * get_wmShellWidgetClass: ShellWidgetClass. (line 6)
4131 * gf: Supported file formats.
4133 * GFFONTS: Supported file formats.
4135 * globally writable directories: Security. (line 30)
4136 * glyph lookup: Glyph lookup. (line 6)
4137 * glyph lookup bitmap tolerance: Basic glyph lookup. (line 15)
4138 * GLYPHFONTS: Supported file formats.
4140 * glyphlist.txt: Specially-recognized files.
4142 * GNU C compiler bugs: TeX or Metafont failing.
4144 * GNU General Public License: Introduction. (line 31)
4145 * group-writable directories: Security. (line 40)
4146 * GSFTOPK_DEBUG (128): Debugging. (line 88)
4147 * hash table buckets, printing: Debugging. (line 105)
4148 * hash table routines: Calling sequence. (line 86)
4149 * hash_summary_only variable for debugging: Debugging. (line 105)
4150 * help, mailing list for general TeX: Mailing lists. (line 29)
4151 * HIER: Default path features.
4153 * history of Kpathsea: History. (line 6)
4154 * home directories in paths: Tilde expansion. (line 6)
4155 * HOME, as ~ expansion: Tilde expansion. (line 6)
4156 * HP-UX, compiling on: TeX or Metafont failing.
4158 * identifiers, characters valid in: Config files. (line 41)
4159 * illegal pointer combination warnings: Pointer combination warnings.
4161 * include fontmap directive: Fontmap. (line 33)
4162 * INDEXSTYLE: Supported file formats.
4164 * info-tex@shsu.edu: Mailing lists. (line 29)
4165 * input lines, reading: Calling sequence. (line 86)
4166 * install-data Make target: Installing files. (line 28)
4167 * install-exec Make target: Installing files. (line 23)
4168 * installation: Installation. (line 6)
4169 * installation testing: Installation testing.
4171 * installation, architecture-(in)dependent files only: Installing files.
4173 * installation, changing default directories: Default path generation.
4175 * installation, customized: Custom installation. (line 6)
4176 * installation, getting executables instead of: Simple installation.
4178 * installation, simple: Simple installation. (line 6)
4179 * installing files: Installing files. (line 6)
4180 * interactive query: Path searching options.
4182 * interface, not frozen: Introduction. (line 27)
4183 * introduction: Introduction. (line 6)
4184 * kdebug:: Debugging. (line 105)
4185 * kdefault.c: Default expansion. (line 48)
4186 * Knuth, Donald E.: History. (line 6)
4187 * Knuth, Donald E., archive of programs by: Other TeX packages.
4189 * Knuth, Donald E., original author: Electronic distribution.
4191 * Korn shell, losing with configure: configure shells. (line 14)
4192 * Kpathsea config file, source for path: Path sources. (line 17)
4193 * Kpathsea version number: Kpathsea application distributions.
4195 * kpathsea.h: Programming overview.
4197 * kpathsea/HIER: Default path features.
4199 * kpathsea/README.CONFIGURE: Running configure. (line 15)
4200 * KPATHSEA_DEBUG: Calling sequence. (line 22)
4201 * kpathsea_debug: Debugging. (line 18)
4202 * KPATHSEA_DEBUG: Debugging. (line 18)
4203 * kpathsea_debug: Debugging. (line 6)
4204 * kpathsea_debug variable: Calling sequence. (line 40)
4205 * KPATHSEA_WARNING: Config files. (line 18)
4206 * KPSE_BITMAP_TOLERANCE: Basic glyph lookup. (line 15)
4207 * kpse_cnf_get: Programming with config files.
4209 * KPSE_DEBUG_EXPAND (16): Debugging. (line 68)
4210 * KPSE_DEBUG_FOPEN (4): Debugging. (line 53)
4211 * KPSE_DEBUG_HASH (2): Debugging. (line 46)
4212 * KPSE_DEBUG_PATHS (8): Debugging. (line 60)
4213 * KPSE_DEBUG_SEARCH (32): Debugging. (line 74)
4214 * KPSE_DEBUG_STAT (1): Debugging. (line 38)
4215 * KPSE_DEBUG_VARS (64): Debugging. (line 83)
4216 * KPSE_DOT expansion: KPSE_DOT expansion. (line 6)
4217 * kpse_fallback_font: Fallback font. (line 15)
4218 * kpse_find_*: Calling sequence. (line 63)
4219 * kpse_find_file <1>: Calling sequence. (line 63)
4220 * kpse_find_file: File lookup. (line 37)
4221 * kpse_find_glyph_format: Glyph lookup. (line 26)
4222 * kpse_format_info: Calling sequence. (line 48)
4223 * kpse_format_info_type: Debugging. (line 61)
4224 * kpse_init_prog: Calling sequence. (line 54)
4225 * kpse_init_prog, and MAKETEX_MODE: Default path features.
4227 * kpse_open_file: Calling sequence. (line 77)
4228 * kpse_program_name: Calling sequence. (line 16)
4229 * kpse_set_progname: Calling sequence. (line 33)
4230 * kpse_set_program_name: Calling sequence. (line 9)
4231 * kpse_var_value: Programming with config files.
4233 * kpsewhich: Invoking kpsewhich. (line 6)
4234 * Kpsewhich, and debugging: Debugging. (line 31)
4235 * ksh, losing with configure: configure shells. (line 14)
4236 * labrea.stanford.edu: Other TeX packages. (line 18)
4237 * LaserJet drive: Kpathsea application distributions.
4239 * last-resort font: Fallback font. (line 6)
4240 * LaTeX help mailing list: Mailing lists. (line 29)
4241 * lcircle10: Fontmap. (line 19)
4242 * LDFLAGS: configure environment.
4244 * leading colons: Default expansion. (line 6)
4245 * leaf directories wrongly guessed: Unable to find files.
4247 * leaf directory trick: Subdirectory expansion.
4249 * libdl.a: dlopen. (line 6)
4250 * libraries, changing: Running make. (line 40)
4251 * libraries, specifying additional: configure environment.
4253 * LIBS: configure environment.
4255 * libucb, avoiding: Running make. (line 44)
4256 * license for using the library: Introduction. (line 31)
4257 * LIGFONTS: Supported file formats.
4259 * lines, reading arbitrary-length: Calling sequence. (line 86)
4260 * Linux File System Standard: mktex configuration. (line 114)
4261 * Linux shells and configure: configure shells. (line 19)
4262 * Linux, using Web2c: CD-ROM distribution. (line 16)
4263 * lndir for building symlink trees: configure scenarios. (line 18)
4264 * loader options: configure environment.
4266 * loader options, final: Running make. (line 33)
4267 * loader options, initial: Running make. (line 30)
4268 * local cache of fonts: Security. (line 22)
4269 * log file: Logging. (line 6)
4270 * logging successful searches: Logging. (line 6)
4271 * lost+found directory: Searching overview. (line 56)
4272 * lostchar: Suppressing warnings.
4274 * ls-R: Supported file formats.
4276 * ls-R and AFS: Installing files. (line 40)
4277 * ls-R database file: ls-R. (line 6)
4278 * ls-R, simplest build: ls-R. (line 18)
4279 * Mach10 configure error: Empty Makefiles. (line 6)
4280 * Macintosh TeX implementations: Other TeX packages. (line 6)
4281 * MacKenzie, David <1>: Subdirectory expansion.
4283 * MacKenzie, David: History. (line 45)
4284 * magic characters: Searching overview. (line 13)
4285 * mailing lists: Mailing lists. (line 6)
4286 * maintainer-clean Make target: Cleaning up. (line 18)
4287 * Make arguments, additional: Running make. (line 36)
4288 * make, running: Running make. (line 6)
4289 * Makefile.in: Running configure. (line 6)
4290 * Makefiles, empty: Empty Makefiles. (line 6)
4291 * MAKETEX_DEBUG (512): Debugging. (line 91)
4292 * MAKETEX_FINE_DEBUG (1024): Debugging. (line 100)
4293 * MAKETEX_MODE: Default path features.
4295 * memory allocation routines: Calling sequence. (line 86)
4296 * metafont driver files: mktex configuration. (line 94)
4297 * Metafont failures: TeX or Metafont failing.
4299 * Metafont installation: Unable to generate fonts.
4301 * Metafont making too-large fonts: Unable to generate fonts.
4303 * Metafont using the wrong device: Unable to generate fonts.
4305 * MFBASES: Supported file formats.
4307 * MFINPUTS: Supported file formats.
4309 * MFPOOL: Supported file formats.
4311 * MFTINPUTS: Supported file formats.
4313 * mirrors, FTP: Electronic distribution.
4315 * MISCFONTS: Supported file formats.
4317 * mismatched checksum warnings: Suppressing warnings.
4319 * missfont.log: mktex script names. (line 35)
4320 * MISSFONT_LOG: mktex script names. (line 40)
4321 * missing character warnings: Suppressing warnings.
4323 * mkocp: mktex script names. (line 18)
4324 * mkofm: mktex script names. (line 21)
4325 * mktex script configuration: mktex configuration. (line 6)
4326 * mktex script names: mktex script names. (line 6)
4327 * mktex scripts: mktex scripts. (line 6)
4328 * mktex.cnf <1>: Specially-recognized files.
4330 * mktex.cnf: mktex configuration. (line 29)
4331 * mktex.opt: mktex configuration. (line 29)
4332 * mktexdir: mktex configuration. (line 62)
4333 * mktexfmt: mktex script names. (line 10)
4334 * mktexmf: mktex script names. (line 15)
4335 * mktexpk: mktex script names. (line 24)
4336 * mktexpk , initial runs: Simple installation. (line 79)
4337 * mktexpk can't guess mode: Unable to generate fonts.
4339 * mktextex: mktex script names. (line 27)
4340 * mktextfm: mktex script names. (line 30)
4341 * mode directory, omitting: mktex configuration. (line 99)
4342 * Morgan, Tim: History. (line 12)
4343 * mostlyclean Make target: Cleaning up. (line 10)
4344 * MPINPUTS: Supported file formats.
4346 * MPMEMS: Supported file formats.
4348 * MPPOOL: Supported file formats.
4350 * MPSUPPORT: Supported file formats.
4352 * MT_FEATURES: mktex configuration. (line 40)
4353 * multiple architectures, compiling on: configure scenarios. (line 18)
4354 * multiple architectures, directories for: configure scenarios.
4356 * multiple architectures, installing on: Installing files. (line 21)
4357 * multiple TeX hierarchies: Brace expansion. (line 20)
4358 * must exist: Searching overview. (line 31)
4359 * names for mktex scripts: mktex script names. (line 6)
4360 * NetBSD configure error: Empty Makefiles. (line 6)
4361 * NetBSD shells and configure: configure shells. (line 19)
4362 * Neumann, Gustaf: History. (line 57)
4363 * newsgroup for TeX: Mailing lists. (line 29)
4364 * NeXT sed error: Empty Makefiles. (line 6)
4365 * NeXT, lacking X11: Kpathsea application distributions.
4367 * NFS and ls-R: ls-R. (line 40)
4368 * NFS CTAN access: Electronic distribution.
4370 * nomfdrivers: mktex configuration. (line 93)
4371 * nomode: mktex configuration. (line 98)
4372 * non-English typesetting: Kpathsea application distributions.
4374 * non-Unix operating systems: Custom installation. (line 19)
4375 * none: Suppressing warnings.
4377 * null pointers, dereferencing: Bug checklist. (line 62)
4378 * numeric debugging values: Debugging. (line 34)
4379 * obtaining TeX: unixtex.ftp. (line 6)
4380 * obtaining Web2c by ftp: Electronic distribution.
4382 * obtaining Web2c on CD-ROM: CD-ROM distribution. (line 6)
4383 * OCPINPUTS: Supported file formats.
4385 * OFMFONTS: Supported file formats.
4387 * online Metafont display, spurious: Unable to generate fonts.
4389 * OPENTYPEFONTS: Supported file formats.
4391 * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
4393 * optimization caveat: TeX or Metafont failing.
4395 * optimization, enabling: configure scenarios. (line 32)
4396 * options for debugging: Debugging. (line 6)
4397 * options to configure: configure options. (line 16)
4398 * OS/2 support: Custom installation. (line 19)
4399 * other TeX distributions: Other TeX packages. (line 6)
4400 * OTPINPUTS: Supported file formats.
4402 * overview of path searching: Searching overview. (line 6)
4403 * overview of programming with Kpathsea: Programming overview.
4405 * OVFFONTS: Supported file formats.
4407 * OVPFONTS: Supported file formats.
4409 * patches, Sun OpenWin: ShellWidgetClass. (line 29)
4410 * path expansion: Path expansion. (line 6)
4411 * path searching: Path searching. (line 6)
4412 * path searching options: Path searching options.
4414 * path searching, overview: Searching overview. (line 6)
4415 * path searching, standalone: Invoking kpsewhich. (line 6)
4416 * path sources: Path sources. (line 6)
4417 * paths, changing default <1>: Default path generation.
4419 * paths, changing default: Changing search paths.
4421 * paths, device name included in: Default path features.
4423 * paths.h: Default path generation.
4425 * paths.h, creating: Running make. (line 6)
4426 * pathsearch.h: Programming overview.
4428 * pc Pascal compiler: History. (line 12)
4429 * PCL driver: Kpathsea application distributions.
4431 * PDF generation: Kpathsea application distributions.
4433 * pdfglyphlist.txt: Specially-recognized files.
4435 * pdftex.cfg: Specially-recognized files.
4437 * PDFTEXCONFIG: Supported file formats.
4439 * pdftexconfig.tex: Specially-recognized files.
4441 * permission denied: Searching overview. (line 56)
4442 * permissions, directory: Security. (line 51)
4443 * permissions, file: Security. (line 47)
4444 * PKFONTS: Supported file formats.
4446 * plain.base: Unable to generate fonts.
4448 * pointer combination warnings: Pointer combination warnings.
4450 * PostScript driver: Kpathsea application distributions.
4452 * PostScript fonts, additional: Simple installation. (line 60)
4453 * precompiled executables, instead of installation: Simple installation.
4455 * precompiled Unix binaries: Other TeX packages. (line 13)
4456 * preprocessor options: configure environment.
4458 * preprocessor options, additional: Running make. (line 24)
4459 * printer configuration files: Simple installation. (line 60)
4460 * privacy, semblance of: Logging. (line 32)
4461 * problems, common: Common problems. (line 6)
4462 * proginit.c: Default path features.
4464 * proginit.h: Calling sequence. (line 54)
4465 * program-varying paths: Supported file formats.
4467 * program_invocation_name: Calling sequence. (line 16)
4468 * program_invocation_short_name: Calling sequence. (line 16)
4469 * programming overview: Programming overview.
4471 * programming with config files: Programming with config files.
4473 * programming with Kpathsea: Calling sequence. (line 6)
4474 * programs using the library: Introduction. (line 13)
4475 * proof mode: Unable to generate fonts.
4477 * PSHEADERS: Supported file formats.
4479 * pxp Pascal preprocessor: History. (line 12)
4480 * quoting variable values: Variable expansion. (line 17)
4481 * readable: Suppressing warnings.
4483 * reading arbitrary-length lines: Calling sequence. (line 86)
4484 * README.CONFIGURE: Running configure. (line 15)
4485 * README.mirrors: Electronic distribution.
4487 * recording successful searches: Logging. (line 6)
4488 * relative filenames: Searching overview. (line 52)
4489 * relative filenames in ls-R: Installing files. (line 40)
4490 * reporting bugs: Reporting bugs. (line 6)
4491 * resident.c: Calling sequence. (line 48)
4492 * resolution, setting: Path searching options.
4494 * resolutions, last-resort: Fallback font. (line 6)
4495 * retrieving TeX: unixtex.ftp. (line 6)
4496 * right-hand side of variable assignments: Config files. (line 49)
4497 * Rokicki, Tom: History. (line 12)
4498 * root user: Tilde expansion. (line 19)
4499 * runtime configuration files: Config files. (line 6)
4500 * runtime debugging: Debugging. (line 6)
4501 * Sauter fonts, and dynamic source creation: mktex scripts. (line 6)
4502 * scripts for file creation: mktex scripts. (line 6)
4503 * search path, defined: Searching overview. (line 6)
4504 * search paths, changing default: Changing search paths.
4506 * searching for files: File lookup. (line 6)
4507 * searching for glyphs: Glyph lookup. (line 6)
4508 * searching overview: Searching overview. (line 6)
4509 * searching the database: Searching overview. (line 17)
4510 * searching the disk: Searching overview. (line 22)
4511 * security considerations: Security. (line 6)
4512 * sed error from configure: Empty Makefiles. (line 6)
4513 * SELFAUTODIR: Calling sequence. (line 25)
4514 * SELFAUTOLOC: Calling sequence. (line 25)
4515 * SELFAUTOPARENT: Calling sequence. (line 25)
4516 * sending patches: Bug checklist. (line 56)
4517 * setgid scripts: Security. (line 40)
4518 * SFDFONTS: Supported file formats.
4520 * sh5, ok with configure: configure shells. (line 25)
4521 * shared library, making: Shared library. (line 6)
4522 * shell scripts as configuration files: Config files. (line 72)
4523 * shell variables: Variable expansion. (line 17)
4524 * shell_escape, example for code: Programming with config files.
4526 * shells and configure: configure shells. (line 6)
4527 * simple installation: Simple installation. (line 6)
4528 * site overrides for mktex...: mktex configuration. (line 29)
4529 * size of distribution archives: Disk space. (line 6)
4530 * skeleton TeX directory: TeX directory structure.
4532 * slow startup time: Slow path searching. (line 6)
4533 * Solaris BSD compatibility, not: Running make. (line 44)
4534 * source files: Supported file formats.
4536 * sources for search paths: Path sources. (line 6)
4537 * special: Suppressing warnings.
4539 * st_nlink: Subdirectory expansion.
4541 * stack trace: Bug checklist. (line 62)
4542 * standalone path searching: Invoking kpsewhich. (line 6)
4543 * standard error and debugging output: Debugging. (line 27)
4544 * standard options: Standard options. (line 6)
4545 * startup time, excessive: Slow path searching. (line 6)
4546 * static linking: ShellWidgetClass. (line 39)
4547 * static linking and dlsym: dlopen. (line 6)
4548 * string routines: Calling sequence. (line 86)
4549 * strip: mktex configuration. (line 108)
4550 * stripsupplier: mktex configuration. (line 102)
4551 * striptypeface: mktex configuration. (line 105)
4552 * subdirectory searching: Subdirectory expansion.
4554 * suffixes, filename: File lookup. (line 24)
4555 * suggestions, making: Introduction. (line 27)
4556 * Sun 2: History. (line 12)
4557 * Sun OpenWin patches: ShellWidgetClass. (line 29)
4558 * supplier directory, omitting: mktex configuration. (line 103)
4559 * supported file formats: Supported file formats.
4561 * suppressing warnings: Suppressing warnings.
4563 * symbolic link trees, for multiple architectures: configure scenarios.
4565 * symbolic links not found: Unable to find files.
4567 * symbolic links, and ls-R: ls-R. (line 38)
4568 * symlinks, resolving: Calling sequence. (line 25)
4569 * system C compiler bugs: TeX or Metafont failing.
4571 * system dependencies: Running configure. (line 6)
4572 * system V universe: Running make. (line 44)
4573 * T1FONTS: Supported file formats.
4575 * T1INPUTS: Supported file formats.
4577 * T42FONTS: Supported file formats.
4579 * tcfmgr.map: Specially-recognized files.
4581 * TDS: TeX directory structure.
4583 * testing, post-installation: Installation testing.
4585 * tests, simple: Simple installation. (line 79)
4586 * teTeX: Other TeX packages. (line 13)
4587 * TeX directory structure: TeX directory structure.
4589 * TeX distributions besides Web2c: Other TeX packages. (line 6)
4590 * TeX environment variables: Supported file formats.
4592 * TeX failures: TeX or Metafont failing.
4594 * TeX file lookup: File lookup. (line 6)
4595 * TeX glyph lookup: Glyph lookup. (line 6)
4596 * TeX help mailing list: Mailing lists. (line 29)
4597 * TeX hierarchy, one: configure scenarios. (line 13)
4598 * TeX Live CD-ROM: CD-ROM distribution. (line 8)
4599 * TeX support: TeX support. (line 6)
4600 * TeX Users Group: Introduction. (line 39)
4601 * tex-archive@math.utah.edu: Mailing lists. (line 25)
4602 * tex-file.c: File lookup. (line 37)
4603 * tex-file.h: Programming overview.
4605 * tex-glyph.c: Glyph lookup. (line 26)
4606 * tex-glyph.h: Programming overview.
4608 * tex-k-request@mail.tug.org: Mailing lists. (line 7)
4609 * tex-k@mail.tug.org (bug address): Reporting bugs. (line 8)
4610 * TEX_HUSH <1>: Suppressing warnings.
4612 * TEX_HUSH: Searching overview. (line 56)
4613 * TEXBIB: Supported file formats.
4615 * TEXCONFIG: Supported file formats.
4617 * TEXDOCS: Supported file formats.
4619 * TEXFONTMAPS: Supported file formats.
4621 * TEXFONTS: Supported file formats.
4623 * texfonts.map: Fontmap. (line 6)
4624 * TEXFORMATS: Supported file formats.
4626 * TEXINDEXSTYLE: Supported file formats.
4628 * TEXINPUTS: Supported file formats.
4630 * TEXMF: TeX directory structure.
4632 * texmf.cnf: Specially-recognized files.
4634 * texmf.cnf missing, warning about: Config files. (line 18)
4635 * texmf.cnf, and variable expansion: Variable expansion. (line 6)
4636 * texmf.cnf, creating: Running make. (line 6)
4637 * texmf.cnf, definition for: Config files. (line 6)
4638 * texmf.cnf, generated: Default path generation.
4640 * texmf.cnf, source for path: Path sources. (line 17)
4641 * texmf.in: Default path generation.
4643 * texmf.in, editing: Changing search paths.
4645 * texmf.sed: Default path generation.
4647 * TEXMFCNF <1>: Supported file formats.
4649 * TEXMFCNF: Config files. (line 6)
4650 * TEXMFDBS <1>: Supported file formats.
4652 * TEXMFDBS: ls-R. (line 6)
4653 * TEXMFINI: Supported file formats.
4655 * TEXMFLOG: Logging. (line 10)
4656 * TEXMFOUTPUT: mktex script names. (line 40)
4657 * TEXMFSCRIPTS: Supported file formats.
4659 * TEXMFVAR: mktex configuration. (line 124)
4660 * texmfvar: mktex configuration. (line 123)
4661 * TEXPICTS: Supported file formats.
4663 * TEXPKS: Supported file formats.
4665 * TEXPOOL: Supported file formats.
4667 * TEXPSHEADERS: Supported file formats.
4669 * TEXSIZES: Fallback font. (line 6)
4670 * TEXSOURCES: Supported file formats.
4672 * TFMFONTS: Supported file formats.
4674 * tilde expansion: Tilde expansion. (line 6)
4675 * tilde.c: Tilde expansion. (line 25)
4676 * time system call: Logging. (line 15)
4677 * tolerance for glyph lookup: Basic glyph lookup. (line 15)
4678 * total disk space: Disk space. (line 6)
4679 * trailing / in home directory: Tilde expansion. (line 19)
4680 * trailing colons: Default expansion. (line 6)
4681 * TRFONTS: Supported file formats.
4683 * trick for detecting leaf directories: Subdirectory expansion.
4685 * trojan horse attack: Security. (line 10)
4686 * try_std_extension_first: File lookup. (line 24)
4687 * TTFONTS: Supported file formats.
4689 * tug.org: unixtex.ftp. (line 6)
4690 * tug@tug.org: Introduction. (line 46)
4691 * typeface directory, omitting: mktex configuration. (line 106)
4692 * ucbinclude, avoiding: Running make. (line 44)
4693 * Ultrix shells and configure: configure shells. (line 25)
4694 * unable to find files: Unable to find files.
4696 * unable to generate fonts: Unable to generate fonts.
4698 * uname: Bug checklist. (line 21)
4699 * universe, BSD vs. system V: Running make. (line 44)
4700 * UNIX_ST_LINK: Subdirectory expansion.
4702 * unixtex.ftp: unixtex.ftp. (line 6)
4703 * unknown special warnings: Suppressing warnings.
4705 * unreadable file warnings: Suppressing warnings.
4707 * unreadable files: Searching overview. (line 56)
4708 * unusable ls-R warning: ls-R. (line 45)
4709 * usage patterns, finding: Logging. (line 6)
4710 * USE_TEXMFVAR: mktex configuration. (line 129)
4711 * USE_VARTEXFONTS: mktex configuration. (line 119)
4712 * Usenet TeX newsgroup: Mailing lists. (line 29)
4713 * USERPROFILE, as ~ expansion: Tilde expansion. (line 6)
4714 * varfonts: mktex configuration. (line 113)
4715 * variable expansion: Variable expansion. (line 6)
4716 * variable.c: Variable expansion. (line 32)
4717 * variable.h: Programming with config files.
4719 * VARTEXFONTS: mktex configuration. (line 114)
4720 * VAX 11/750: History. (line 12)
4721 * version number, of Kpathsea: Kpathsea application distributions.
4723 * version numbers, determining: Bug checklist. (line 16)
4724 * VF files, not found: Searching overview. (line 31)
4725 * VFFONTS: Supported file formats.
4727 * VMS support: Custom installation. (line 19)
4728 * VMS TeX implementations: Other TeX packages. (line 6)
4729 * Vojta, Paul: History. (line 30)
4730 * Walsh, Norman: History. (line 57)
4731 * warning about unusable ls-R: ls-R. (line 45)
4732 * warning, about missing texmf.cnf: Config files. (line 18)
4733 * warnings, file access: Searching overview. (line 56)
4734 * warnings, pointer combinations: Pointer combination warnings.
4736 * warnings, suppressing: Suppressing warnings.
4738 * wcstombs: dlopen. (line 6)
4739 * WEB2C: Supported file formats.
4741 * Weber, Olaf: History. (line 74)
4742 * WEBINPUTS: Supported file formats.
4744 * whitespace, in fontmap files: Fontmap. (line 28)
4745 * whitespace, not ignored on continuation lines: Config files.
4747 * Windows TeX implementations: Other TeX packages. (line 6)
4748 * World Wide Web CTAN access: Electronic distribution.
4750 * www.tug.org: unixtex.ftp. (line 6)
4751 * X11 previewer: Kpathsea application distributions.
4753 * X11, lacking on NeXT: Kpathsea application distributions.
4755 * XCFLAGS: Running make. (line 26)
4756 * XCPPFLAGS: Running make. (line 22)
4757 * XDEFS: Running make. (line 23)
4758 * XDVIFONTS: Supported file formats.
4760 * XDVIMAKEPK: mktex script names. (line 32)
4761 * XDVISIZES: Fallback font. (line 6)
4762 * XLDFLAGS: Running make. (line 29)
4763 * XLOADLIBES: Running make. (line 32)
4764 * XMAKEARGS: Running make. (line 35)
4765 * Xmu library problems: ShellWidgetClass. (line 13)
4766 * XtStrings: XtStrings. (line 6)
4767 * zuhn, david: History. (line 51)
4768 * { expansion: Brace expansion. (line 6)
4769 * ~ expansion: Tilde expansion. (line 6)
4775 Node: Introduction
\7f2195
4776 Node: History
\7f4171
4777 Node: Installation
\7f8263
4778 Node: Simple installation
\7f9053
4779 Node: Custom installation
\7f12636
4780 Node: Disk space
\7f13810
4781 Node: Kpathsea application distributions
\7f14694
4782 Node: Changing search paths
\7f15809
4783 Node: Default path features
\7f16991
4784 Node: Default path generation
\7f19127
4785 Node: Running configure
\7f20570
4786 Node: configure shells
\7f21621
4787 Node: configure options
\7f22673
4788 Node: configure environment
\7f24180
4789 Node: configure scenarios
\7f25982
4790 Node: Shared library
\7f27568
4791 Node: Running make
\7f28582
4792 Node: Installing files
\7f30629
4793 Node: Cleaning up
\7f32576
4794 Node: Filename database generation
\7f33624
4795 Node: mktex scripts
\7f34191
4796 Node: mktex configuration
\7f35468
4797 Node: mktex script names
\7f41287
4798 Node: mktex script arguments
\7f42678
4799 Node: Installation testing
\7f43568
4800 Node: Security
\7f43932
4801 Node: TeX directory structure
\7f46499
4802 Node: unixtex.ftp
\7f50921
4803 Node: Electronic distribution
\7f52936
4804 Node: CD-ROM distribution
\7f55701
4805 Node: Other TeX packages
\7f56671
4806 Node: Reporting bugs
\7f57967
4807 Node: Bug checklist
\7f58707
4808 Node: Mailing lists
\7f62409
4809 Node: Debugging
\7f63768
4810 Node: Logging
\7f68840
4811 Node: Common problems
\7f70710
4812 Node: Unable to find files
\7f71541
4813 Node: Slow path searching
\7f73952
4814 Node: Unable to generate fonts
\7f75329
4815 Node: TeX or Metafont failing
\7f77838
4816 Node: Empty Makefiles
\7f79716
4817 Node: XtStrings
\7f80946
4818 Node: dlopen
\7f81782
4819 Node: ShellWidgetClass
\7f82600
4820 Node: Pointer combination warnings
\7f84232
4821 Node: Path searching
\7f84621
4822 Node: Searching overview
\7f85268
4823 Node: Path sources
\7f88664
4824 Node: Config files
\7f89735
4825 Node: Path expansion
\7f93380
4826 Node: Default expansion
\7f94329
4827 Node: Variable expansion
\7f96399
4828 Node: Tilde expansion
\7f97802
4829 Node: Brace expansion
\7f98782
4830 Node: KPSE_DOT expansion
\7f99887
4831 Node: Subdirectory expansion
\7f100400
4832 Node: Filename database
\7f102749
4834 Node: Filename aliases
\7f106697
4835 Node: Database format
\7f107875
4836 Node: Invoking kpsewhich
\7f108888
4837 Node: Path searching options
\7f109833
4838 Node: Specially-recognized files
\7f116853
4839 Node: Auxiliary tasks
\7f118177
4840 Node: Standard options
\7f120002
4841 Node: TeX support
\7f120322
4842 Node: Supported file formats
\7f121613
4843 Node: File lookup
\7f128761
4844 Node: Glyph lookup
\7f130489
4845 Node: Basic glyph lookup
\7f131616
4846 Node: Fontmap
\7f132495
4847 Node: Fallback font
\7f135112
4848 Node: Suppressing warnings
\7f136077
4849 Node: Programming
\7f137182
4850 Node: Programming overview
\7f137695
4851 Node: Calling sequence
\7f139971
4852 Node: Program-specific files
\7f144963
4853 Node: Programming with config files
\7f146001
4854 Node: Index
\7f147301
projects / mplib / blob