3 This is kpathsea.info, produced by makeinfo version 4.11 from kpathsea.texi.
5 * Kpathsea: (kpathsea). File lookup along search paths.
6 * kpsewhich: (kpathsea)Invoking kpsewhich. TeX file searching.
7 * mktexfmt: (kpathsea)mktex scripts. Format (fmt/base/mem) generation.
8 * mktexlsr: (kpathsea)Filename database. Update ls-R.
9 * mktexmf: (kpathsea)mktex scripts. MF source generation.
10 * mktexpk: (kpathsea)mktex scripts. PK bitmap generation.
11 * mktextex: (kpathsea)mktex scripts. TeX source generation.
12 * mktextfm: (kpathsea)mktex scripts. TeX font metric generation.
15 This file documents the Kpathsea library for path searching.
17 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
18 2005, 2007, 2008 Karl Berry & Olaf Weber.
20 Permission is granted to make and distribute verbatim copies of this
21 manual provided the copyright notice and this permission notice are
22 preserved on all copies.
24 Permission is granted to copy and distribute modified versions of
25 this manual under the conditions for verbatim copying, provided that the
26 entire resulting derived work is distributed under the terms of a
27 permission notice identical to this one.
29 Permission is granted to copy and distribute translations of this
30 manual into another language, under the above conditions for modified
31 versions, except that this permission notice may be stated in a
32 translation approved by the Free Software Foundation.
35 File: kpathsea.info, Node: Top, Next: Introduction, Up: (dir)
40 This manual documents how to install and use the Kpathsea library for
41 filename lookup. It corresponds to version 3.5.6dev, released in
46 * Introduction:: Overview.
47 * Installation:: Compilation, installation, and bug reporting.
49 * Path searching:: How filename lookups work.
50 * TeX support:: Special support for TeX-related file lookups.
52 * Programming:: How to use Kpathsea features in your program.
54 * Index:: General index.
57 File: kpathsea.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
62 This manual corresponds to version 3.5.6dev of the Kpathsea library,
63 released in February 2008.
65 The library's fundamental purpose is to return a filename from a
66 list of directories specified by the user, similar to what shells do
67 when looking up program names to execute.
69 The following software, all of which we maintain, uses this library:
71 * Dviljk (see the `dvilj' man page)
73 * Dvipsk (*note Introduction: (dvips)Top.)
75 * GNU font utilities (*note Introduction: (fontu)Top.)
77 * Web2c (*note Introduction: (web2c)Top.)
79 * Xdvik (see the `xdvi' man page)
81 Other software that we do not maintain also uses it.
83 We are still actively maintaining the library (and probably always
84 will be, despite our hopes). If you have comments or suggestions,
85 please send them to us (*note Reporting bugs::).
87 We distribute the library under the GNU Library General Public
88 License (LGPL). In short, this means if you write a program using the
89 library, you must (offer to) distribute the source to the library,
90 along with any changes you have made, and allow anyone to modify the
91 library source and distribute their modifications. It does not mean
92 you have to distribute the source to your program, although we hope you
93 will. See the files `GPL' and `LGPL' for the text of the GNU licenses.
95 If you know enough about TeX to be reading this manual, then you (or
96 your institution) should consider joining the TeX Users Group (if
97 you're already a member, great!). TUG produces the periodical
98 `TUGboat', sponsors an annual meeting and publishes the proceedings,
99 and arranges courses on TeX for all levels of users throughout the
100 world. Anyway, here is the address:
104 Portland OR 97208-2311
106 phone: +1 503 223-9994
115 File: kpathsea.info, Node: History, Up: Introduction
120 (This section is for those people who are curious about how the library
121 came about.) (If you like to read historical accounts of software, we
122 urge you to seek out the GNU Autoconf manual and the "Errors of TeX"
123 paper by Don Knuth, published in `Software--Practice and Experience'
126 [Karl writes.] My first ChangeLog entry for Web2c seems to be
127 February 1990, but I may have done some work before then. In any case,
128 Tim Morgan and I were jointly maintaining it for a time. (I should
129 mention here that Tim had made Web2c into a real distribution long
130 before I had ever used it or even heard of it, and Tom Rokicki did the
131 original implementation. I was using `pxp' and `pc' on VAX 11/750's
132 and the hot new Sun 2 machines.)
134 It must have been later in 1990 and 1991 that I started working on
135 `TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
136 (which I was also writing at the time) all used different environment
137 variables, and, more importantly, had different bugs in their path
138 searching. This became extremely painful, as I was stressing everything
139 to the limit working on the book. I also desperately wanted to
140 implement subdirectory searching, since I couldn't stand putting
141 everything in one big directory, and also couldn't stand having to
142 explicitly specify `cm', `pandora', ... in a path.
144 In the first incarnation, I just hacked separately on each
145 program--that was the original subdirectory searching code in both Xdvi
146 and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
147 support by now. That is, I tried to go with the flow in each program,
148 rather than changing the program's calling sequences to conform to
151 Then, as bugs inevitably appeared, I found I was fixing the same
152 thing three times (Web2c and fontutils were always sharing code, since I
153 maintained those--there was no Dvipsk or Xdvik or Dviljk at this
154 point). After a while, I finally started sharing source files. They
155 weren't yet a library, though. I just kept things up to date with shell
156 scripts. (I was developing on a 386 running ISC 2.2 at the time, and so
157 didn't have symbolic links. An awful experience.)
159 The ChangeLogs for Xdvik and Dvipsk record initial releases of those
160 distributions in May and June 1992. I think it was because I was tired
161 of the different configuration strategies of each program, not so much
162 because of the path searching. (Autoconf was being developed by David
163 MacKenzie and others, and I was adapting it to TeX and friends.)
165 I started to make a separate library that other programs could link
166 with on my birthday in April 1993, according to the ChangeLog. I don't
167 remember exactly why I finally took the time to make it a separate
168 library; a conversation with david zuhn that initiated it. Just seemed
171 Dviljk got started in March 1994 after I bought a Laserjet 4.
172 (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
173 Neumann's help, implemented a way for TeX to get at all those neat
174 builtin LJ4 fonts ... such a treat to have something to typeset in
177 By spring of 1995, I had implemented just about all the
178 path-searching features in Kpathsea that I plan to, driven beyond my
179 initial goals by Thomas Esser and others. I then started to integrate
180 Web2c with Kpathsea. After the release of a stable Web2c, I hope to be
181 able to stop development, and turn most of my attention back to making
182 fonts for GNU. (Always assuming Micros**t hasn't completely
183 obliterated Unix by then, or that software patents haven't stopped
184 software development by anybody smaller than a company with a
185 million-dollar-a-year legal budget. Which is actually what I think is
186 likely to happen, but that's another story...)
188 [Olaf writes.] At the end of 1997, UNIX is still alive and kicking,
189 individuals still develop software, and Web2c development still
190 continues. Karl had been looking for some time for someone to take up
191 part of the burden, and I volunteered.
194 File: kpathsea.info, Node: Installation, Next: Path searching, Prev: Introduction, Up: Top
199 (A copy of this chapter is in the distribution file `kpathsea/INSTALL'.)
201 The procedure for Kpathsea (and Web2c, etc.) configuration and
202 installation follows. If you encounter trouble, see *note Common
203 problems::, a copy of which is in the file `kpathsea/BUGS'.
207 * Simple installation:: If you just want to do it.
208 * Custom installation:: If you want to change things around.
209 * Security:: Who can write what files, etc.
210 * TeX directory structure:: Managing the horde of TeX input files.
211 * unixtex.ftp:: Getting software via FTP, on CD-ROM, or on tape.
212 * Reporting bugs:: Where and how to report bugs.
215 File: kpathsea.info, Node: Simple installation, Next: Custom installation, Up: Installation
217 2.1 Simple installation
218 =======================
220 Installing TeX and friends for the first time can be a daunting
221 experience. Thus, you may prefer to skip this whole thing and just get
222 precompiled executables: see *note unixtex.ftp::.
224 This section explains what to do if you wish to take the defaults for
225 everything, and generally to install in the simplest possible way. Most
226 steps here refer to corresponding subsection in the next section which
227 explains how to override defaults and generally gives more details.
229 By default everything will be installed under `/usr/local' and the
230 following discussion assumes this. However, if you already have TeX
231 installed, its location is used to derive the directory under which
232 everything is to be installed.
234 1. Be sure you have enough disk space: approximately 8 megabytes for
235 the compressed archives, 15MB for sources, 50MB for compilation,
236 40MB for the (initial) installed system (including library files).
239 2. Retrieve these distribution archives:
240 `ftp://ftp.tug.org/tex/texk.tar.gz'
241 These are the sources, which you will be compiling.
243 `ftp://ftp.tug.org/tex/texklib.tar.gz'
244 This is a basic set of input files. You should unpack it in
245 the directory `/usr/local/share'; doing so will create a
246 `texmf' subdirectory there.
248 These archives are mirrored on the CTAN hosts, in the
249 `systems/web2c' directory.
251 *Note Kpathsea application distributions::.
253 3. When using the default search paths, there is no need to edit any
254 distribution files. *Note Changing search paths::.
256 4. At the top level of the distribution, run `sh configure'. (If you
257 have the GNU Bash shell installed, run `bash configure'.) *Note
260 5. `make'. *Note Running make::. If you are using a BSD 4.4 system
261 such as FreeBSD or NetBSD, you may have to use GNU make (often
262 installed in `/usr/local/bin'), not the BSD make.
264 6. `make install'. *Note Installing files::.
266 7. `make distclean'. *Note Cleaning up::.
268 8. Set up a cron job to rebuild the filename database that makes
269 searching faster. This line will rebuild it every midnight:
270 0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
271 *Note Filename database generation::, and *note Filename
274 9. If you're installing Dvips, you also need to set up configuration
275 files for your printers and make any additional PostScript fonts
276 available. *Note Installation: (dvips)Installation. If you have
277 any color printers, see *note Color device configuration:
278 (dvips)Color device configuration.
280 10. The first time you run a DVI driver, a bunch of PK fonts will be
281 built by Metafont via `mktexpk' (and added to the filename
282 database). This will take some time. Don't be alarmed; they will
283 created only this first time (unless something is wrong with your
286 By default, `mktexpk' will create these fonts in a hierarchy under
287 `/var/tmp/texfonts'; it simply assumes that `/var/tmp' exists and
288 is globally writable. If you need a different arrangement, see
289 *note mktex configuration::.
291 *Note mktex scripts::.
293 11. For some simple tests, try `tex story \\bye' and `latex sample2e'.
294 Then run `xdvi story' or `dvips sample2e' on the resulting DVI
295 files to preview/print the documents. *Note Installation
299 File: kpathsea.info, Node: Custom installation, Next: Security, Prev: Simple installation, Up: Installation
301 2.2 Custom installation
302 =======================
304 Most sites need to modify the default installation procedure in some
305 way, perhaps merely changing the prefix from `/usr/local', perhaps
306 adding extra compiler or loader options to work around `configure'
307 bugs. This section explains how to override default choices. For
308 additional distribution-specific information:
311 * *Note Installation: (dvips)Installation.
313 * *Note Installation: (web2c)Installation.
317 These instructions are for Unix systems. Other operating-system
318 specific distributions have their own instructions. The code base
319 itself supports Amiga, DOS, OS/2, and VMS.
321 Following are the same steps as in the previous section (which
322 describes the simplest installation), but with much more detail.
327 * Kpathsea application distributions::
328 * Changing search paths::
329 * Running configure::
333 * Filename database generation::
335 * Installation testing::
338 File: kpathsea.info, Node: Disk space, Next: Kpathsea application distributions, Up: Custom installation
343 Here is a table showing the disk space needed for each distribution
344 (described in the next section). The `(totals)' line reflects the
345 `texk' source distribution and `texklib'; the individual distributions
346 don't enter into it. Sizes are in megabytes. All numbers are
349 Distribution .tar.gz Unpacked Compiled Installed
355 texk 7.5 32.1 95.3 33.5
356 texklib 6.3 15.0 - 15.0
357 (totals) 14.6 47.1 95.3 48.5
360 File: kpathsea.info, Node: Kpathsea application distributions, Next: Changing search paths, Prev: Disk space, Up: Custom installation
362 2.2.2 Kpathsea application distributions
363 ----------------------------------------
365 The archive `ftp://ftp.tug.org/tex/texk.tar.gz' contains all of the
366 Kpathsea applications I maintain, and the library itself. For example,
367 since NeXT does not generally support X11, you'd probably want to skip
368 `xdvik' (or simply remove it after unpacking `texk.tar.gz'. If you are
369 not interested in all of them, you can also retrieve them separately:
372 DVI to PCL, for LaserJet printers.
375 DVI to PostScript, for previewers, printers, or PDF generation.
378 The software needed to compile TeX and friends.
381 The original WEB source files, also used in compilation.
384 DVI previewing under the X window system.
387 If you want to use the Babel LaTeX package for support of non-English
388 typesetting, you may need to retrieve additional files. See the file
389 `install.txt' in the Babel distribution.
392 File: kpathsea.info, Node: Changing search paths, Next: Running configure, Prev: Kpathsea application distributions, Up: Custom installation
394 2.2.3 Changing search paths
395 ---------------------------
397 If the search paths for your installation differ from the standard TeX
398 directory structure (*note Introduction: (tds)Top.), edit the file
399 `kpathsea/texmf.in' as desired, before running `configure'. For
400 example, if you have all your fonts or macros in one big directory.
402 You may also wish to edit the file `mktex.cnf', either before or
403 after installation, to control various aspects of `mktexpk' and
404 friends. *Note mktex configuration::.
406 You do not need to edit `texmf.in' to change the default top-level
407 or other installation _directories_ (only the paths). You can and
408 should do that when you run `configure' (next step).
410 You also do not need to edit `texmf.in' if you are willing to rely
411 on `texmf.cnf' at runtime to define the paths, and let the compile-time
412 default paths be incorrect. Usually there is no harm in doing this.
414 The section below explains default generation in more detail.
418 * Default path features::
419 * Default path generation::
422 File: kpathsea.info, Node: Default path features, Next: Default path generation, Up: Changing search paths
424 2.2.3.1 Default path features
425 .............................
427 The purpose of having all the different files described in the section
428 above is to avoid having the same information in more than one place. If
429 you change the installation directories or top-level prefix at
430 `configure'-time, those changes will propagate through the whole
431 sequence. And if you change the default paths in `texmf.in', those
432 changes are propagated to the compile-time defaults.
434 The Make definitions are all repeated in several Makefile's; but
435 changing the top-level `Makefile' should suffice, as it passes down all
436 the variable definitions, thus overriding the submakes. (The
437 definitions are repeated so you can run Make in the subdirectories, if
438 you should have occasion to.)
440 By default, the bitmap font paths end with `/$MAKETEX_MODE', thus
441 including the device name (usually a Metafont mode name such as
442 `ljfour'). This distinguishes two different devices with the same
443 resolution--a write/white from a write/black 300dpi printer, for
446 However, since most sites don't have this complication, Kpathsea
447 (specifically, the `kpse_init_prog' function in `kpathsea/proginit.c')
448 has a special case: if the mode has not been explicitly set by the user
449 (or in a configuration file), it sets `MAKETEX_MODE' to `/'. This
450 makes the default PK path, for example, expand into `.../pk//', so
451 fonts will be found even if there is no subdirectory for the mode (if
452 you arranged things that way because your site has only one printer,
453 for example) or if the program is mode-independent (e.g., `pktype').
455 To make the paths independent of the mode, simply edit `texmf.in'
456 before installation, or the installed `texmf.cnf', and remove the
459 *Note mktex script arguments::, for how this interacts with
462 *Note TeX directory structure: TeX directory structure, for a
463 description of the default arrangement of the input files that comprise
464 the TeX system. The file `kpathsea/HIER' is a copy of that section.
467 File: kpathsea.info, Node: Default path generation, Prev: Default path features, Up: Changing search paths
469 2.2.3.2 Default path generation
470 ...............................
472 This section describes how the default paths are constructed.
474 You may wish to ignore the whole mess and simply edit `texmf.cnf'
475 after it is installed, perhaps even copying it into place beforehand so
476 you can complete the installation, if it seems necessary.
478 To summarize the chain of events that go into defining the default
481 1. `configure' creates a `Makefile' from each `Makefile.in'.
483 2. When Make runs in the `kpathsea' directory, it creates a file
484 `texmf.sed' that substitutes the Make value of `$(var)' for a
485 string `@var@'. The variables in question are the one that define
486 the installation directories.
488 3. `texmf.sed' (together with a little extra magic--see
489 `kpathsea/Makefile') is applied to `texmf.in' to generate
490 `texmf.cnf'. This is the file that will eventually be installed
493 4. The definitions in `texmf.cnf' are recast as C `#define''s in
494 `paths.h'. These values will be the compile-time defaults; they
495 are not used at runtime unless no `texmf.cnf' file can be found.
497 (That's a lie: the compile-time defaults are what any extra :'s in
498 `texmf.cnf' expand into; but the paths as distributed have no extra
499 :'s, and there's no particular reason for them to.)
502 File: kpathsea.info, Node: Running configure, Next: Running make, Prev: Changing search paths, Up: Custom installation
504 2.2.4 Running `configure'
505 -------------------------
507 Run `sh configure OPTIONS' (in the top-level directory, the one
508 containing `kpathsea/'), possibly using a shell other than `sh' (*note
511 `configure' adapts the source distribution to the present system via
512 `#define''s in `*/c-auto.h', which are created from the corresponding
513 `c-auto.in'. It also creates a `Makefile' from the corresponding
514 `Makefile.in', doing `@VAR@' and `ac_include' substitutions).
516 `configure' is the best place to control the configuration,
517 compilation, and installed location of the software, either via
518 command-line options, or by setting environment variables before
519 invoking it. For example, you can disable `mktexpk' by default with
520 the option `--disable-mktexpk'. *Note configure options::.
525 * configure options::
526 * configure environment::
527 * configure scenarios::
531 File: kpathsea.info, Node: configure shells, Next: configure options, Up: Running configure
533 2.2.4.1 `configure' shells
534 ..........................
536 Considerable effort has gone into trying to ensure that the `configure'
537 scripts can be run by most Bourne shell variants. If `sh' runs into
538 trouble, your best bet is to use Bash, the GNU Bourne-again shell
539 (*note Top: (bash)Top.).
541 Bourne shell variants for which problems have been reported in the
544 Old versions of the Korn shell may fail to handle the scripts.
545 The Korn shell may be installed as `/bin/sh' on AIX, in which case
546 `/bin/bsh' may serve instead.
549 Old versions of ash are unable to handle the scripts. Ash is
550 sometimes installed as `/bin/sh' on NetBSD, FreeBSD, and Linux
551 systems. `/bin/bash' should be available for those systems, but
552 might not be part of a default installation.
555 `/bin/sh' under Ultrix is a DEC-grown shell that is notably
556 deficient in many ways. `/bin/sh5' may be necessary.
559 File: kpathsea.info, Node: configure options, Next: configure environment, Prev: configure shells, Up: Running configure
561 2.2.4.2 `configure' options
562 ...........................
564 For a complete list of all `configure' options, run `configure --help'
565 or see *note Running `configure' scripts: (autoconf)Invoking configure,
566 (a copy is in the file `kpathsea/README.CONFIGURE'). The generic
567 options are listed first in the `--help' output, and the
568 package-specific options come last. The environment variables
569 `configure' pays attention to are listed below.
571 Options particularly likely to be useful are `--prefix',
572 `--datadir', and the like; see *note configure scenarios::.
574 This section gives pointers to descriptions of the `--with' and
575 `--enable' options to `configure' that Kpathsea-using programs accept.
577 `--without-mktexmf-default'
578 `--without-mktexpk-default'
579 `--without-mktextfm-default'
580 `--with-mktextex-default'
581 Enable or disable the dynamic generation programs. *Note mktex
585 Build Kpathsea as a shared library, and link against it. Also
586 build the usual static library. *Note Shared library::.
589 Build only the shared library. Implies `--enable-shared'.
591 `--enable-maintainer-mode'
592 Enables make targets that are useful for the maintainer and likely
593 to be a pain for anyone else; the makefiles created when this
594 option is enabled may not work at all for you. You have been
598 File: kpathsea.info, Node: configure environment, Next: configure scenarios, Prev: configure options, Up: Running configure
600 2.2.4.3 `configure' environment
601 ...............................
603 `configure' uses the value of the following environment variables in
604 determining your system's characteristics, and substitutes for them in
608 The compiler to use: default is `gcc' if it's installed, otherwise
612 Options to give the compiler: default is `-g -O2' for `gcc', `-g'
613 otherwise. `CFLAGS' comes after any other options. You may need
614 to include `-w' here if your compilations commonly have useless
615 warnings (e.g., `NULL redefined'), or `configure' may fail to
616 detect the presence of header files (it takes the messages on
617 standard error to mean the header file doesn't exist).
620 Options to pass to the compiler preprocessor; this matters most for
621 configuration, not the actual source compilation. The `configure'
622 script often does only preprocessing (e.g., to check for the
623 existence of #include files), and `CFLAGS' is not used for this.
624 You may need to set this to something like
625 `-I/usr/local/include/wwwhatever' if you have the libwww library
626 installed for hyper-xdvik (see `xdvik/INSTALL').
629 Additional preprocessor options, but not used by `configure'.
630 Provided for enabling or disabling program features, as documented
631 in the various program-specific installation instructions. `DEFS'
632 comes before any compiler options included by the distribution
633 `Makefile's or by `configure'.
636 Additional options to give to the loader. `LDFLAGS' comes before
637 any other linker options.
640 Additional libraries to link with.
643 File: kpathsea.info, Node: configure scenarios, Next: Shared library, Prev: configure environment, Up: Running configure
645 2.2.4.4 `configure' scenarios
646 .............................
648 Here are some common installation scenarios:
650 * Including X support in Metafont. This is disabled by default,
651 since many sites have no use for it, and it's a leading cause of
652 configuration problems.
655 * Putting the binaries, TeX files, GNU info files, etc. into a single
656 TeX hierarchy, say `/here/texmf', requires overriding defaults in
658 configure --prefix=/here/texmf --datadir=/here
660 * You can compile on multiple architectures simultaneously either by
661 building symbolic link trees with the `lndir' script from the X11
662 distribution, or with the `--srcdir' option:
663 configure --srcdir=SRCDIR
665 * If you are installing binaries for multiple architectures into a
666 single hierarchy, you will probably want to override the default
667 `bin' and `lib' directories, something like this:
668 configure --prefix=TEXMF --datadir=TEXMF \
669 --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
671 (Unless you make provisions for architecture-specific files in
672 other ways, e.g., with Depot or an automounter.)
674 * To compile with optimization (to compile without debugging, remove
676 env CFLAGS="-g -O" sh configure ...
677 For a potential problem if you optimize, see *note TeX or Metafont
678 failing: TeX or Metafont failing.
681 File: kpathsea.info, Node: Shared library, Prev: configure scenarios, Up: Running configure
683 2.2.4.5 Shared library
684 ......................
686 You can compile Kpathsea as a shared library on a few systems, by
687 specifying the option `--enable-shared' when you run `configure'.
689 The main advantage in doing this is that the executables can then
690 share the code, thus decreasing memory and disk space requirements.
692 On some systems, you can record the location of shared libraries in a
693 binary, usually by giving certain options to the linker. Then
694 individual users do not need to set their system's environment variable
695 (e.g., `LD_LIBRARY_PATH') to find shared libraries. If you want to do
696 this, you will need to add the necessary options to `LDFLAGS' yourself;
697 for example, on Solaris, include something like `-R${prefix}/lib', on
698 IRIX or Linux, use `-rpath${prefix}/lib'. (Unfortunately, making this
699 happen by default is very difficult, because of interactions with an
700 existing installed shared library.)
703 File: kpathsea.info, Node: Running make, Next: Installing files, Prev: Running configure, Up: Custom installation
708 `make' (still in the top-level directory). This also creates the
709 `texmf.cnf' and `paths.h' files that define the default search paths,
710 and (by default) the `plain' and `latex' TeX formats.
712 You can override directory names and other values at `make'-time.
713 `make/paths.make' lists the variables most commonly reset. For
714 example, `make default_texsizes=600' changes the list of fallback
717 You can also override each of `configure''s environment variables
718 (*note configure environment::). The Make variables have the same
721 Finally, you can supply additional options via the following
722 variables. (`configure' does not use these.)
726 Preprocessor options.
732 Loader options (included at beginning of link commands).
735 More loader options (included at end of link commands).
738 Additional Make arguments passed to all sub-`make''s. You may need
739 to include assignments to the other variables here via `XMAKEARGS';
740 for example: `make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
742 It's generally a bad idea to use a different compiler (`CC') or
743 libraries (`LIBS') for compilation than you did for configuration,
744 since the values `configure' determined may then be incorrect.
746 Adding compiler options to change the "universe" you are using
747 (typically BSD vs. system V) is generally a cause of trouble. It's
748 best to use the native environment, whatever that is; `configure' and
749 the software usually adapt best to that. In particular, under Solaris
750 2.x, you should not use the BSD-compatibility library (`libucb') or
751 include files (`ucbinclude').
753 If you want to use the Babel LaTeX package for support of non-English
754 typesetting, you need to modify some files before making the LaTeX
755 format. See the file `install.txt' in the Babel distribution.
758 File: kpathsea.info, Node: Installing files, Next: Cleaning up, Prev: Running make, Up: Custom installation
760 2.2.6 Installing files
761 ----------------------
763 The basic command is the usual `make install'. For security issues,
766 The first time you install any manual in the GNU Info system, you
767 should add a line (you choose where) to the file `dir' in your
768 `$(infodir)' directory. Sample text for this is given near the top of
769 the Texinfo source files (`kpathsea/kpathsea.texi',
770 `dvipsk/dvips.texi', and `web2c/doc/web2c.texi'). If you have a recent
771 version of the GNU Texinfo distribution installed
772 (`ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz' or later), this
773 should happen automatically.
775 On the offchance that this is your first Info installation, the
776 `dir' file I use is included in the distribution as `etc/dir-example'.
778 You may wish to use one of the following targets, especially if you
779 are installing on multiple architectures:
780 * `make install-exec' to install in architecture-dependent
781 directories, i.e., ones that depend on the `$(exec_prefix)' Make
782 variable. This includes links to binaries, libraries, etc., not
785 * `make install-data' to install in architecture-independent
786 directories, such as documentation, configuration files, pool
789 If you use the Andrew File System, the normal path (e.g.,
790 PREFIX/bin) only gets you to a read-only copy of the files, and you
791 must specify a different path for installation. The best way to do this
792 is by setting the `prefix' variable on the `make' command line. The
793 sequence becomes something like this:
794 configure --prefix=/whatever
796 make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
797 With AFS, you will definitely want to use relative filenames in
798 `ls-R' (*note Filename database::), not absolute filenames. This is
799 done by default, but check anyway.
802 File: kpathsea.info, Node: Cleaning up, Next: Filename database generation, Prev: Installing files, Up: Custom installation
807 The basic command is `make distclean'. This removes all files created
811 * `make mostlyclean' if you intend to compile on another
812 architecture. For Web2C, since the generated C files are portable,
813 they are not removed. If the `lex' vs. `flex' situation is going
814 to be different on the next machine, `rm web2c/lex.yy.c'.
816 * `make clean' to remove files created by compiling, but leave
817 configuration files and Makefiles.
819 * `make maintainer-clean' to remove everything that the Makefiles can
820 rebuild. This is more than `distclean' removes, and you should
821 only use it if you are thoroughly conversant with (and have the
822 necessary versions of) Autoconf.
824 * `make extraclean' to remove other junk, e.g., core files, log
825 files, patch rejects. This is independent of the other `clean'
829 File: kpathsea.info, Node: Filename database generation, Next: mktex scripts, Prev: Cleaning up, Up: Custom installation
831 2.2.8 Filename database generation
832 ----------------------------------
834 You will probably want to set up a `cron' entry on the appropriate
835 machine(s) to rebuild the filename database nightly or so, as in:
836 0 0 * * * cd TEXMF && /BINDIR/mktexlsr
837 *Note Filename database::.
839 Although the `mktex...' scripts make every effort to add
840 newly-created files on the fly, it can't hurt to make sure you get a
841 fresh version every so often.
844 File: kpathsea.info, Node: mktex scripts, Next: Installation testing, Prev: Filename database generation, Up: Custom installation
846 2.2.9 `mktex' scripts
847 ---------------------
849 If Kpathsea cannot otherwise find a file, for some file types it is
850 configured by default to invoke an external program to create it
851 dynamically (*note mktex configuration::). These are collectively
852 known as "`mktex' scripts", since most of them are named `mktex...'.
854 For example, this is useful for fonts (bitmaps, TFM's, and
855 arbitrarily-sizable Metafont sources such as the Sauter and EC fonts),
856 since any given document can use fonts never before referenced.
857 Building all fonts in advance is therefore impractical, if not
860 It is also useful for the TeX `.fmt' (and Metafont `.base' and
861 Metapost `.mem' files, *note Memory dumps: (Web2c)Memory dumps.), where
862 pre-generating every format consumes a lot of both time and space.
864 The script is passed the name of the file to create and possibly
865 other arguments, as explained below. It must echo the full pathname of
866 the file it created (and nothing else) to standard output; it can write
867 diagnostics to standard error.
871 * config: mktex configuration.
872 * names: mktex script names.
873 * args: mktex script arguments.
876 File: kpathsea.info, Node: mktex configuration, Next: mktex script names, Up: mktex scripts
878 2.2.9.1 `mktex' configuration
879 .............................
881 The list of file types and program names that can run an external
882 program to create missing files is listed in the next section. In the
883 absence of `configure' options specifying otherwise, everything but
884 `mktextex' will be enabled by default. The `configure' options to
885 change the defaults are:
887 --without-mktexfmt-default
888 --without-mktexmf-default
889 --without-mktexocp-default
890 --without-mktexofm-default
891 --without-mktexpk-default
892 --without-mktextfm-default
893 --with-mktextex-default
895 The `configure' setting is overridden if the environment variable or
896 configuration file value named for the script is set; e.g., `MKTEXPK'
897 (*note mktex script arguments::).
899 `mktexfmt' reads a file `fmtutil.cnf', typically located in
900 `texmf/web2c/' to glean its configuration information. The rest of the
901 files and features in this section are primarily intended for the font
904 As distributed, all the scripts source a file
905 `texmf/web2c/mktex.cnf' if it exists, so you can override various
906 defaults. See `mktex.opt', for instance, which defines the default
907 mode, resolution, some special directory names, etc. If you prefer not
908 to change the distributed scripts, you can simply create `mktex.cnf'
909 with the appropriate definitions (you do not need to create it if you
910 have nothing to put in it). `mktex.cnf' has no special syntax; it's an
911 arbitrary Bourne shell script. The distribution contains a sample
912 `mktex.cnf' for you to copy and modify as you please (it is not
915 In addition, you can configure a number of features with the
916 `MT_FEATURES' variable, which you can define:
918 * in `mktex.opt', as just mentioned;
920 * by editing the file `mktex.opt', either before `make install' (in
921 the source hierarchy) or after (in the installed hierarchy);
923 * or in the environment.
925 If none of the options below are enabled, `mktexpk', `mktextfm', and
926 `mktexmf' follow the following procedure to decide where fonts should
927 be installed. Find the tree where the font's sources are, and test the
928 permissions of the `fonts' directory of that tree to determine whether
929 it is writable. If it is, put the files in the tree in appropriate
930 locations. If it isn't writable, see whether the tree is a system tree
931 (named in `SYSTEXMF'). If so, the `VARTEXFONTS' tree is used. In all
932 other cases the working directory is used.
934 The `appendonlydir' option is enabled by default.
937 Tell `mktexdir' to create directories append-only, i.e., set their
938 sticky bit (*note Mode Structure: (coreutils)Mode Structure.).
939 This feature is silently ignored on non-Unix platforms (e.g.
940 Windows/NT and MS-DOS) which don't support similar functionality.
941 This feature is enabled by default.
944 Use 8.3 names; e.g., `dpi600/cmr10.pk' instead of `cmr10.600pk'.
945 Note that this feature only affects filenames that would otherwise
946 clash with other TeX-related filenames; `mktex' scripts do nothing
947 about filenames which exceed the 8+3 MS-DOS limits but remain
948 unique when truncated (by the OS) to these limits, and nether do
949 the scripts care about possible clashes with files which aren't
950 related with TeX. For example, `cmr10.600pk' would clash with
951 `cmr10.600gf' and is therefore changed when `dosnames' is in
952 effect, but `mf.pool' and `mp.base' don't clash with any
953 TeX-related files and are therefore unchanged.
955 This feature is turned on by default on MS-DOS. If you do not wish
956 `dosnames' to be set on an MS-DOS platform, you need to set the
957 `MT_FEATURES' environment variable to a value that doesn't include
958 `dosnames'. You can also change the default setting by editing
959 `mktex.opt', but only if you use the `mktex' shell scripts; the
960 emulation programs don't consult `mktex.opt'.
963 Instead of deriving the location of a font in the destination tree
964 from the location of the sources, the aliases and directory names
965 from the Fontname distribution are used. (*note Introduction:
969 Let mktexpk and mktextfm create metafont driver files in a
970 temporary directory. These will be used for just one metafont run
971 and not installed permanently.
974 Omit the directory level for the mode name; this is fine as long as
975 you generate fonts for only one mode.
978 Omit the font supplier name directory level.
981 Omit the font typeface name directory level.
984 Omit the font supplier and typeface name directory levels. This
985 feature is deprecated in favour of `stripsupplier' and
989 When this option is enabled, fonts that would otherwise be written
990 in system texmf tree go to the `VARTEXFONTS' tree instead. The
991 default value in `kpathsea/Makefile.in' is `/var/tmp/texfonts'.
992 The `Linux File System Standard' recommends `/var/tex/fonts'.
994 The `varfonts' setting in `MT_FEATURES' is overridden by the
995 `USE_VARTEXFONTS' environment variable: if set to `1', the feature
996 is enabled, and if set to `0', the feature is disabled.
999 Force generated files that would go into a system tree (as defined
1000 by `SYSTEXMF') into `TEXMFVAR'. Starting with teTeX-3.0, the
1001 variable `TEXMFVAR' is always set. The `varfonts' feature takes
1002 precedence if also set.
1004 The `texmfvar' setting in `MT_FEATURES' is overridden by the
1005 `USE_TEXMFVAR' environment variable: if set to `1', the feature is
1006 enabled, and if set to `0', the feature is disabled.
1009 File: kpathsea.info, Node: mktex script names, Next: mktex script arguments, Prev: mktex configuration, Up: mktex scripts
1011 2.2.9.2 `mktex' script names
1012 ............................
1014 The following table shows the default name of the script for each of
1015 the file types which support runtime generation.
1018 (`.fmt', `.base', `.mem') TeX/Metafont/MetaPost formats. This
1019 script is also named `fmtutil', and reads `fmtutil.cnf' for
1020 configuration information.
1023 (`.mf') Metafont input files.
1026 (`.ocp') Omega compiled process files.
1029 (`.ofm') Omega font metric files.
1035 (`.tex') TeX input files (disabled by default).
1040 These names can be overridden by an environment variable specific to
1041 the program--for example, `DVIPSMAKEPK' for Dvipsk.
1043 If a `mktex...' script fails, the invocation is appended to a file
1044 `missfont.log' (by default) in the current directory. You can then
1045 execute the log file to create the missing files after fixing the
1048 If the current directory is not writable and the environment
1049 variable or configuration file value `TEXMFOUTPUT' is set, its value is
1050 used. Otherwise, nothing is written. The name `missfont.log' is
1051 overridden by the `MISSFONT_LOG' environment variable or configuration
1055 File: kpathsea.info, Node: mktex script arguments, Prev: mktex script names, Up: mktex scripts
1057 2.2.9.3 `mktex' script arguments
1058 ................................
1060 The first argument to a `mktex' script is always the name of the file
1063 In the default `mktexpk' implementation, additional arguments may
1067 Sets the resolution of the generated font to NUM.
1070 Sets the Metafont mode to NAME.
1073 Sets the the "base dpi" for the font. This must match the mode
1077 A "magstep" string suitable for the Metafont `mag' variable. This
1078 must match the combination of BDPI and DPI being used.
1081 A directory name. If the directory is absolute, it is used as-is.
1082 Otherwise, it is appended to the root destination directory set in
1086 File: kpathsea.info, Node: Installation testing, Prev: mktex scripts, Up: Custom installation
1088 2.2.10 Installation testing
1089 ---------------------------
1091 Besides the tests listed in *note Simple installation::, you can try
1092 running `make check'. This includes the torture tests (trip, trap, and
1093 mptrap) that come with Web2c (*note Triptrap: (web2c)Triptrap.).
1096 File: kpathsea.info, Node: Security, Next: TeX directory structure, Prev: Custom installation, Up: Installation
1101 None of the programs in the TeX system require any special system
1102 privileges, so there's no first-level security concern of people gaining
1103 illegitimate root access.
1105 A TeX document, however, can write to arbitrary files, e.g.,
1106 `~/.rhosts', and thus an unwitting user who runs TeX on a random
1107 document is vulnerable to a trojan horse attack. This loophole is
1108 closed by default, but you can be permissive if you so desire in
1109 `texmf.cnf'. *Note tex invocation: (web2c)tex invocation. MetaPost has
1112 Dvips, Xdvi, and TeX can also execute shell commands under some
1113 circumstances. To disable this, see the `-R' option in *note Option
1114 details: (dvips)Option details, the xdvi man page, and *note tex
1115 invocation: (web2c)tex invocation, respectively.
1117 Another security issue arises because it's very useful--almost
1118 necessary--to make arbitrary fonts on user demand with `mktexpk' and
1119 friends. Where do these files get installed? By default, the
1120 `mktexpk' distributed with Kpathsea assumes a world-writable `/var/tmp'
1121 directory; this is a simple and convenient approach, but it may not
1122 suit your situation because it means that a local cache of fonts is
1123 created on every machine.
1125 To avoid this duplication, many people consider a shared, globally
1126 writable font tree desirable, in spite of the potential security
1127 problems. To do this you should change the value of `VARTEXFONTS' in
1128 `texmf.cnf' to refer to some globally known directory. *Note mktex
1131 The first restriction you can apply is to make newly-created
1132 directories under `texmf' be append-only with an option in `mktex.cnf'.
1133 *Note mktex configuration::.
1135 Another approach is to establish a group (or user) for TeX files,
1136 make the `texmf' tree writable only to that group (or user), and make
1137 `mktexpk' et al. setgid to that group (or setuid to that user). Then
1138 users must invoke the scripts to install things. (If you're worried
1139 about the inevitable security holes in scripts, then you could write a
1140 C wrapper to exec the script.)
1142 The `mktex...' scripts install files with the same read and write
1143 permissions as the directory they are installed in. The executable,
1144 sgid, suid, and sticky bits are always cleared.
1146 Any directories created by the `mktex...' scripts have the same
1147 permissions as their parent directory, unless the `appendonlydir'
1148 feature is used, in which case the sticky bit is always set.
1151 File: kpathsea.info, Node: TeX directory structure, Next: unixtex.ftp, Prev: Security, Up: Installation
1153 2.4 TeX directory structure
1154 ===========================
1156 This section describes the default installation hierarchy of the
1157 distribution. It conforms to both the GNU coding standards and the TeX
1158 directory structure (TDS) standard. For rationale and further
1159 explanation, please see those documents. The GNU standard is available
1160 as `ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi' and
1161 mirrors. The TDS document is available from `CTAN:/tex-archive/tds'
1162 (*note unixtex.ftp::).
1164 You can change the default paths in many ways (*note Changing search
1165 paths::). One common desire is to put everything (binaries and all)
1166 under a single top-level directory such as `/usr/local/texmf' or
1167 `/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
1168 For specific instructions on doing that, see *note configure
1171 Here is a skeleton of the default directory structure, extracted from
1174 PREFIX/ installation root (`/usr/local' by default)
1177 include/ C header files
1178 info/ GNU info files
1179 lib/ libraries (`libkpathsea.*')
1180 share/ architecture-independent files
1182 bibtex/ BibTeX input files
1183 bib/ BibTeX databases
1184 base/ base distribution (e.g., `xampl.bib')
1185 misc/ single-file databases
1186 PKG/ name of a package
1187 bst/ BibTeX style files
1188 base/ base distribution (e.g., `plain.bst', `acm.bst')
1189 misc/ single-file styles
1190 PKG/ name of a package
1191 doc/ additional documentation
1192 dvips/ `.pro', `.ps', `psfonts.map'
1193 fonts/ font-related files
1194 TYPE/ file type (e.g., `tfm', `pk')
1195 MODE/ type of output device (types `pk' and `gf' only)
1196 SUPPLIER/ name of a font supplier (e.g., `public')
1197 TYPEFACE/ name of a typeface (e.g., `cm')
1198 dpiNNN/ font resolution (types `pk' and `gf' only)
1199 metafont/ Metafont (non-font) input files
1200 base/ base distribution (e.g., `plain.mf')
1201 misc/ single-file packages (e.g., `modes.mf')
1202 PKG/ name of a package (e.g., `mfpic')
1203 metapost/ MetaPost input files
1204 base/ base distribution (e.g., `plain.mp')
1205 misc/ single-file packages
1206 PKG/ name of a package
1207 support/ support files for MetaPost-related utilities (e.g., `trfonts.map')
1208 mft/ `MFT' inputs (e.g., `plain.mft')
1209 tex/ TeX input files
1210 FORMAT/ name of a format (e.g., `plain')
1211 base/ base distribution for FORMAT (e.g., `plain.tex')
1212 misc/ single-file packages (e.g., `webmac.tex')
1213 local/ local additions to or local configuration files for FORMAT
1214 PKG/ name of a package (e.g., `graphics', `mfnfss')
1215 generic/ format-independent packages
1216 hyphen/ hyphenation patterns (e.g., `hyphen.tex')
1217 images/ image input files (e.g., Encapsulated PostScript)
1218 misc/ single-file format-independent packages (e.g., `null.tex').
1219 PKG/ name of a package (e.g., `babel')
1220 web2c/ implementation-dependent files (`.pool', `.fmt', `texmf.cnf', etc.)
1222 Some concrete examples for most file types:
1225 /usr/local/man/man1/xdvi.1
1226 /usr/local/info/kpathsea.info
1227 /usr/local/lib/libkpathsea.a
1228 /usr/local/share/texmf/bibtex/bst/base/plain.bst
1229 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1230 /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
1231 /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
1232 /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
1233 /usr/local/share/texmf/metafont/base/plain.mf
1234 /usr/local/share/texmf/metapost/base/plain.mp
1235 /usr/local/share/texmf/tex/plain/base/plain.tex
1236 /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
1237 /usr/local/share/texmf/web2c/tex.pool
1238 /usr/local/share/texmf/web2c/tex.fmt
1239 /usr/local/share/texmf/web2c/texmf.cnf
1242 File: kpathsea.info, Node: unixtex.ftp, Next: Reporting bugs, Prev: TeX directory structure, Up: Installation
1244 2.5 `unixtex.ftp': Obtaining TeX
1245 ================================
1247 This is `ftp://ftp.tug.org/tex/unixtex.ftp', last updated 26 December
1248 2003. Also available as `http://www.tug.org/unixtex.ftp'. The IP
1249 address is currently `[130.225.2.178]'. It is also in Kpathsea source
1250 distributions as `etc/unixtex.ftp' (although the network version is
1251 usually newer). Mail <tex-k@mail.tug.org> with comments or questions.
1253 Following are general instructions for Unix or other sites who wish
1254 to acquire the Web2c distribution, (plain) TeX, LaTeX (2e), BibTeX,
1255 Metafont, MetaPost, DVI processors for the X window system, PostScript,
1256 the PCL language in the HP LaserJet, and related programs. They are
1257 oriented towards building from the original sources, though some
1258 information on alternative packages is included in the last section.
1259 See also `http://www.tug.org/web2c/', the Web2c and Kpathsea home page.
1261 Please note that the Web2c distribution is a bare-bones distribution
1262 in source form, and building a complete installation from it is a
1263 non-trivial matter. For most uses, it is a better idea to install a
1264 distribution with pre-packaged binaries for your platform. The
1265 principal example of such a distribution is TeX Live
1266 (`http://www.tug.org/texlive/'), which is based on the Web2c sources.
1268 Please consider joining the TeX Users Group (TUG) or another user
1269 group of your choice to help support the maintenance and development of
1270 the programs you retrieve. See `http://www.tug.org/join.html' for
1271 information and the membership registration form, and
1272 `http://www.tug.org/usergroups.html' for a listing of all user groups.
1274 For actual installation instructions after obtaining the necessary
1275 sources, see *note Installation::. A copy is in the distribution file
1280 * Electronic distribution:: CTAN and so forth.
1281 * CD-ROM distribution::
1282 * Other TeX packages::
1285 File: kpathsea.info, Node: Electronic distribution, Next: CD-ROM distribution, Up: unixtex.ftp
1287 2.5.1 Electronic distribution
1288 -----------------------------
1290 In many places we refer to CTAN:. This is _both_ a host name and a
1291 directory name. Here are the primary locations:
1293 `ftp://ctan.tug.org/tex-archive/' (Vermont, USA)
1294 `ftp://ftp.dante.de/tex-archive/' (Germany)
1295 `ftp://ftp.tex.ac.uk/tex-archive/' (England)
1297 CTAN has many mirrors worldwide; see the top-level file
1298 `README.mirrors' from one of the sites above or see
1299 `http://www.tug.org/CTAN.sites'.
1301 You can also access CTAN via the World Wide Web, electronic mail, or
1302 NFS. The same `README.mirrors' file explains how.
1304 You will need to retrieve some or all of the following archives,
1305 depending on your needs (don't forget to set binary mode for file
1308 `CTAN:/systems/web2c/web.tar.gz'
1309 The original WEB source files, written primarily by Don Knuth.
1310 Required unless you already have this `web' version. (The WEB
1311 sources change irregularly with respect to Web2c itself.) Unpacks
1312 into `web2c-VERSION'.
1314 `CTAN:/systems/web2c/web2c.tar.gz'
1315 The Web2c system. Required. Also unpacks into `web2c-VERSION'.
1317 `CTAN:/systems/web2c/web2c-etex.tar.gz'
1318 Additions to the Web2c system for building e-TeX. Optional.
1319 Unpacks into `web2c-VERSION'.
1321 `CTAN:/systems/web2c/etexlib.tar.gz'
1322 Additions to the texmf tree needed to build e-TeX. Optional.
1323 Unpacks into `texmf/'.
1325 `CTAN:/systems/web2c/etexdoc.tar.gz'
1326 Documentation for e-TeX as an addition to the texmf tree.
1327 Optional. Unpacks into `texmf/'.
1329 `CTAN:/systems/web2c/web2c-omega.tar.gz'
1330 Additions to the Web2c system for building Omega. Optional.
1331 Unpacks into `web2c-VERSION'.
1333 `CTAN:/systems/web2c/omegalib.tar.gz'
1334 Additions to the texmf tree needed to build Omega. Optional.
1335 Unpacks into `texmf/'.
1337 `CTAN:/systems/web2c/omegadoc.tar.gz'
1338 Documentation for Omega as an addition to the texmf tree.
1339 Optional. Unpacks into `texmf/'.
1341 `CTAN:/systems/web2c/web2c-pdftex.tar.gz'
1342 Additions to the Web2c system for building pdfTeX. Optional.
1343 Unpacks into `web2c-VERSION'.
1345 `CTAN:/systems/web2c/pdftexlib.tar.gz'
1346 Additions to the texmf tree needed to build pdfTeX. Optional.
1347 Unpacks into `texmf/'.
1349 `CTAN:/dviware/xdvik/xdvik.tar.gz'
1350 X window system DVI previewer. Unpacks into `xdvik-VERSION'.
1353 Additional drivers, macro files, and other support are needed to
1354 build a working system. These are available in teTeX.
1356 All that said, the originating host for the software above is
1357 `ftp.tug.org'. You can retrieve these distributions (but not much
1358 else) from the `tex/' directory on that host.
1361 File: kpathsea.info, Node: CD-ROM distribution, Next: Other TeX packages, Prev: Electronic distribution, Up: unixtex.ftp
1363 2.5.2 CD-ROM distribution
1364 -------------------------
1366 Numerous organizations distribute various TeX CD-ROM's (and DVD's):
1368 * Virtually all the TeX user groups collaborate to produce the `TeX
1369 Live' distribution once a year; see `http://www.tug.org/texlive/'
1370 for more information.
1372 * The Free Software Foundation's `Source Code CD-ROM' contains the
1373 minimal TeX source distribution described in the previous section
1374 (i.e., enough to print GNU documentation); email <gnu@gnu.org>.
1376 * Most Linux distributions include some TeX package based on Web2c;
1377 see the Linux documentation file `Distribution-HOWTO' for a
1378 comparison of Linux distributions, available (for example) via
1379 `http://www.linux.org'.
1381 If you know of additional TeX distributions to add to this list,
1382 please inform <tex-k@mail.tug.org>.
1385 File: kpathsea.info, Node: Other TeX packages, Prev: CD-ROM distribution, Up: unixtex.ftp
1387 2.5.3 Other TeX packages
1388 ------------------------
1390 Many other TeX implementations are available in `CTAN:/systems',
1391 including ready-to-run distributions for Unix, Amiga, Acorn, VMS,
1392 Macintosh, DOS, and Windows (in various forms). Although Web2c has
1393 support in the source code for many operating systems, and in fact some
1394 of the other distributions are based on it, it's unlikely to work as
1395 distributed on anything but Unix. (Please contribute improvements!)
1397 The principal user-oriented Unix distribution based on Web2c is the
1398 teTeX distribution. It includes complete sources, and runs on all
1399 modern Unix variants, including Linux. It contains many TeX-related
1400 programs besides those in the core Web2c.
1402 The host labrea.stanford.edu is the original source for the files
1403 for which Donald Knuth is directly responsible: `tex.web', `plain.tex',
1404 etc. However, unless you want to build your TeX library tree ab initio,
1405 it is more reliable and less work to retrieve these files as part of
1406 the above packages. In any case, labrea is not the canonical source for
1407 anything except what was created by Stanford TeX project, so do not
1408 rely on all the files available at that ftp site being up-to-date.
1411 File: kpathsea.info, Node: Reporting bugs, Prev: unixtex.ftp, Up: Installation
1416 (A copy of this chapter is in the file `kpathsea/BUGS'.)
1418 If you have problems or suggestions, please report them to
1419 <tex-k@mail.tug.org> using the bug checklist below.
1421 Please report bugs in the documentation; not only factual errors or
1422 inconsistent behavior, but unclear or incomplete explanations, typos,
1427 * Bug checklist:: What to include in a good bug report.
1428 * Mailing lists:: Joining the bugs or announcements mailing lists.
1429 * Debugging:: Analyzing runtime problems.
1430 * Logging:: Recording searches.
1431 * Common problems:: When things go wrong.
1434 File: kpathsea.info, Node: Bug checklist, Next: Mailing lists, Up: Reporting bugs
1439 Before reporting a bug, please check below to be sure it isn't already
1440 known (*note Common problems::).
1442 Bug reports should be sent via electronic mail to
1443 <tex-k@mail.tug.org>.
1445 The general principle is that a good bug report includes all the
1446 information necessary for reproduction. Therefore, to enable
1447 investigation, your report should include the following:
1449 * The version number(s) of the program(s) involved, and of Kpathsea
1450 itself. You can get the former by giving a sole option `--version'
1451 to the program, and the latter by running `kpsewhich --version'.
1452 The `NEWS' and `ChangeLog' files also contain the version number.
1454 * The hardware, operating system (including version number),
1455 compiler, and `make' program you are using (the output of `uname
1456 -a' is a start on the first two, though often incomplete). If the
1457 bug involves the X window system, include X version and supplier
1458 information as well (examples: X11R6 from MIT; X11R4 from HP;
1459 OpenWindows 3.3 bundled with SunOS 4.1.4).
1461 * Any options you gave to `configure'. This is recorded in the
1462 `config.status' files.
1464 If you are reporting a bug in `configure' itself, it's probably
1465 system-dependent, and it will be unlikely the maintainers can do
1466 anything useful if you merely report that thus-and-such is broken.
1467 Therefore, you need to do some additional work: for some bugs, you
1468 can look in the file `config.log' where the test that failed should
1469 appear, along with the compiler invocation and source program in
1470 question. You can then compile it yourself by hand, and discover
1471 why the test failed. Other `configure' bugs do not involve the
1472 compiler; in that case, the only recourse is to inspect the
1473 `configure' shell script itself, or the Autoconf macros that
1474 generated `configure'.
1476 * The log of all debugging output, if the bug is in path searching.
1477 You can get this by setting the environment variable
1478 `KPATHSEA_DEBUG' to `-1' before running the program. Please look
1479 at the log yourself to make sure the behavior is really a bug
1480 before reporting it; perhaps "old" environment variable settings
1481 are causing files not to be found, for example.
1483 * The contents of any input files necessary to reproduce the bug.
1484 For bugs in DVI-reading programs, for example, this generally
1485 means a DVI file (and any EPS or other files it uses)--TeX source
1486 files are helpful, but the DVI file is necessary, because that's
1487 the actual program input.
1489 * If you are sending a patch (do so if you can!), please do so in
1490 the form of a context diff (`diff -c') against the original
1491 distribution source. Any other form of diff is either not as
1492 complete or harder for me to understand. Please also include a
1495 * If the bug involved is an actual crash (i.e., core dump), it is
1496 easy and useful to include a stack trace from a debugger (I
1497 recommend the GNU debugger GDB, available from
1498 `ftp://prep.ai.mit.edu/pub/gnu'). If the cause is apparent (a
1499 `NULL' value being dereferenced, for example), please send the
1500 details along. If the program involved is TeX or Metafont, and
1501 the crash is happening at apparently-sound code, however, the bug
1502 may well be in the compiler, rather than in the program or the
1503 library (*note TeX or Metafont failing: TeX or Metafont failing.).
1505 * Any additional information that will be helpful in reproducing,
1506 diagnosing, or fixing the bug.
1509 File: kpathsea.info, Node: Mailing lists, Next: Debugging, Prev: Bug checklist, Up: Reporting bugs
1514 Web2c and Kpathsea in general are discussed on the mailing list
1515 <tex-k@mail.tug.org>. To join, email <tex-k-request@mail.tug.org> with
1516 a line consisting of
1518 subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
1520 in the body of the message.
1522 You do not need to join to submit a report, nor will it affect
1523 whether you get a response. There is no Usenet newsgroup equivalent
1524 (if you can be the one to set this up, email `tex-k-request'). Traffic
1525 on the list is fairly light, and is mainly bug reports and enhancement
1526 requests to the software. The best way to decide if you want to join
1527 or not is read some of the archives from
1528 `ftp://ftp.tug.org/mail/archives/tex-k/'.
1530 Be aware that large data files are sometimes included in bug reports.
1531 If this is a problem for you, do not join the list.
1533 If you only want announcements of new releases, not bug reports and
1534 discussion, join <tex-archive@math.utah.edu> (via mail to
1535 <tex-archive-request@math.utah.edu>).
1537 If you are looking for general TeX help, such as how to use LaTeX,
1538 please use the mailing list <info-tex@shsu.edu> mailing list, which is
1539 gatewayed to the `comp.text.tex' Usenet newsgroup (or post to the
1540 newsgroup; the gateway is bidirectional).
1543 File: kpathsea.info, Node: Debugging, Next: Logging, Prev: Mailing lists, Up: Reporting bugs
1548 Kpathsea provides a number of runtime debugging options, detailed below
1549 by their names and corresponding numeric values. When the files you
1550 expect aren't being found, the thing to do is enable these options and
1553 You can set these with some runtime argument (e.g., `-d') to the
1554 program; in that case, you should use the numeric values described in
1555 the program's documentation (which, for Dvipsk and Xdvik, are different
1556 than those below). It's best to give the `-d' (or whatever) option
1557 first, for maximal output. Dvipsk and Xdvik have additional
1558 program-specific debugging options as well.
1560 You can also set the environment variable `KPATHSEA_DEBUG'; in this
1561 case, you should use the numbers below. If you run the program under a
1562 debugger and set the variable `kpathsea_debug', also use the numbers
1565 In any case, by far the simplest value to use is `-1', which will
1566 turn on all debugging output. This is usually better than guessing
1567 which particular values will yield the output you need.
1569 Debugging output always goes to standard error, so you can redirect
1570 it easily. For example, in Bourne-compatible shells:
1571 dvips -d -1 ... 2>/tmp/debug
1573 It is sometimes helpful to run the standalone Kpsewhich utility
1574 (*note Invoking kpsewhich::), instead of the original program.
1576 In any case, you can _not_ use the _names_ below; you must always
1577 use somebody's numbers. (Sorry.) To set more than one option, just
1578 sum the corresponding numbers.
1580 `KPSE_DEBUG_STAT (1)'
1581 Report `stat'(2) calls. This is useful for verifying that your
1582 directory structure is not forcing Kpathsea to do many additional
1583 file tests (*note Slow path searching::, and *note Subdirectory
1584 expansion::). If you are using an up-to-date `ls-R' database
1585 (*note Filename database::), this should produce no output unless a
1586 nonexistent file that must exist is searched for.
1588 `KPSE_DEBUG_HASH (2)'
1589 Report lookups in all hash tables: `ls-R' and `aliases' (*note
1590 Filename database::); font aliases (*note Fontmap::); and config
1591 file values (*note Config files::). Useful when expected values
1592 are not being found, e.g.., file searches are looking at the disk
1593 instead of using `ls-R'.
1595 `KPSE_DEBUG_FOPEN (4)'
1596 Report file openings and closings. Especially useful when your
1597 system's file table is full, for seeing which files have been
1598 opened but never closed. In case you want to set breakpoints in a
1599 debugger: this works by redefining `fopen' (`fclose') to be
1600 `kpse_fopen_trace' (`kpse_fclose_trace').
1602 `KPSE_DEBUG_PATHS (8)'
1603 Report general path information for each file type Kpathsea is
1604 asked to search. This is useful when you are trying to track down
1605 how a particular path got defined--from `texmf.cnf', `config.ps',
1606 an environment variable, the compile-time default, etc. This is
1607 the contents of the `kpse_format_info_type' structure defined in
1610 `KPSE_DEBUG_EXPAND (16)'
1611 Report the directory list corresponding to each path element
1612 Kpathsea searches. This is only relevant when Kpathsea searches
1613 the disk, since `ls-R' searches don't look through directory lists
1616 `KPSE_DEBUG_SEARCH (32)'
1617 Report on each file search: the name of the file searched for, the
1618 path searched in, whether or not the file must exist (when drivers
1619 search for `cmr10.vf', it need not exist), and whether or not we
1620 are collecting all occurrences of the file in the path (as with,
1621 e.g., `texmf.cnf' and `texfonts.map'), or just the first (as with
1622 most lookups). This can help you correlate what Kpathsea is doing
1623 with what is in your input file.
1625 `KPSE_DEBUG_VARS (64)'
1626 Report the value of each variable Kpathsea looks up. This is
1627 useful for verifying that variables do indeed obtain their correct
1630 `GSFTOPK_DEBUG (128)'
1631 Activates debugging printout specific to `gsftopk' program.
1633 `MAKETEX_DEBUG (512)'
1634 If you use the optional `mktex' programs instead of the
1635 traditional shell scripts, this will report the name of the site
1636 file (`mktex.cnf' by default) which is read, directories created by
1637 `mktexdir', the full path of the `ls-R' database built by
1638 `mktexlsr', font map searches, `MT_FEATURES' in effect, parameters
1639 from `mktexnam', filenames added by `mktexupd', and some
1640 subsidiary commands run by the programs.
1642 `MAKETEX_FINE_DEBUG (1024)'
1643 When the optional `mktex' programs are used, this will print
1644 additional debugging info from functions internal to these
1647 Debugging output from Kpathsea is always written to standard error,
1648 and begins with the string `kdebug:'. (Except for hash table buckets,
1649 which just start with the number, but you can only get that output
1650 running under a debugger. See comments at the `hash_summary_only'
1651 variable in `kpathsea/db.c'.)
1654 File: kpathsea.info, Node: Logging, Next: Common problems, Prev: Debugging, Up: Reporting bugs
1659 Kpathsea can record the time and filename found for each successful
1660 search. This may be useful in finding good candidates for deletion when
1661 your filesystem is full, or in discovering usage patterns at your site.
1663 To do this, define the environment or config file variable
1664 `TEXMFLOG'. The value is the name of the file to append the
1665 information to. The file is created if it doesn't exist, and appended
1668 Each successful search turns into one line in the log file: two words
1669 separated by a space. The first word is the time of the search, as the
1670 integer number of seconds since "the epoch", i.e., UTC midnight 1
1671 January 1970 (more precisely, the result of the `time' system call).
1672 The second word is the filename.
1674 For example, after `setenv TEXMFLOG /tmp/log', running Dvips on
1675 `story.dvi' appends the following lines:
1677 774455887 /usr/local/share/texmf/dvips/config.ps
1678 774455887 /usr/local/share/texmf/dvips/psfonts.map
1679 774455888 /usr/local/share/texmf/dvips/texc.pro
1680 774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
1681 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
1682 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1683 774455889 /usr/local/share/texmf/dvips/texc.pro
1685 Only filenames that are absolute are recorded, to preserve some
1686 semblance of privacy.
1688 In addition to this Kpathsea-specific logging, `pdftex' provides an
1689 option `-recorder' to write the names of all files accessed during a
1690 run to the file `BASEFILE.fls'.
1692 Finally, most systems provide a general tool to output each system
1693 call, thus including opening and closing files. It might be named
1694 `strace', `truss', `struss', or something else.
1697 File: kpathsea.info, Node: Common problems, Prev: Logging, Up: Reporting bugs
1699 2.6.5 Common problems
1700 ---------------------
1702 Here are some common problems with configuration, compilation, linking,
1707 * Unable to find files:: If your program can't find fonts (or whatever).
1708 * Slow path searching:: If it takes forever to find anything.
1709 * Unable to generate fonts:: If mktexpk fails.
1710 * TeX or Metafont failing:: Likely compiler bugs.
1712 * Empty Makefiles:: When configure produces empty makefiles.
1713 * XtStrings:: When _XtStrings is undefined.
1714 * dlopen:: When dlopen is undefined.
1715 * ShellWidgetClass:: For dynamic linking troubles under OpenWindows.
1716 * Pointer combination warnings:: For old compilers that don't grok char *.
1719 File: kpathsea.info, Node: Unable to find files, Next: Slow path searching, Up: Common problems
1721 2.6.5.1 Unable to find files
1722 ............................
1724 If a program complains it cannot find fonts (or other input files), any
1725 of several things might be wrong. In any case, you may find the
1726 debugging options helpful. *Note Debugging::.
1728 * Perhaps you simply haven't installed all the necessary files; the
1729 basic fonts and input files are distributed separately from the
1730 programs. *Note unixtex.ftp::.
1732 * You have (perhaps unknowingly) told Kpathsea to use search paths
1733 that don't reflect where the files actually are. One common cause
1734 is having environment variables set from a previous installation,
1735 thus overriding what you carefully set in `texmf.cnf' (*note
1736 Supported file formats::). System `/etc/profile' or other files
1737 such may be the culprit.
1739 * Your files reside in a directory that is only pointed to via a
1740 symbolic link, in a leaf directory and is not listed in `ls-R'.
1742 Unfortunately, Kpathsea's subdirectory searching has an
1743 irremediable deficiency: If a directory D being searched for
1744 subdirectories contains plain files and symbolic links to other
1745 directories, but no true subdirectories, D will be considered a
1746 leaf directory, i.e., the symbolic links will not be followed.
1747 *Note Subdirectory expansion::.
1749 You can work around this problem by creating an empty dummy
1750 subdirectory in D. Then D will no longer be a leaf, and the
1751 symlinks will be followed.
1753 The directory immediately followed by the `//' in the path
1754 specification, however, is always searched for subdirectories,
1755 even if it is a leaf. Presumably you would not have asked for the
1756 directory to be searched for subdirectories if you didn't want it
1759 * If the fonts (or whatever) don't already exist, `mktexpk' (or
1760 `mktexmf' or `mktextfm') will try to create them. If these rather
1761 complicated shell scripts fail, you'll eventually get an error
1762 message saying something like `Can't find font FONTNAME'. The best
1763 solution is to fix (or at least report) the bug in `mktexpk'; the
1764 workaround is to generate the necessary fonts by hand with
1765 Metafont, or to grab them from a CTAN site (*note unixtex.ftp::).
1767 * There is a bug in the library. *Note Reporting bugs::.
1770 File: kpathsea.info, Node: Slow path searching, Next: Unable to generate fonts, Prev: Unable to find files, Up: Common problems
1772 2.6.5.2 Slow path searching
1773 ...........................
1775 If your program takes an excessively long time to find fonts or other
1776 input files, but does eventually succeed, here are some possible
1779 * Most likely, you just have a lot of directories to search, and that
1780 takes a noticeable time. The solution is to create and maintain a
1781 separate `ls-R' file that lists all the files in your main TeX
1782 hierarchy. *Note Filename database::. Kpathsea always uses `ls-R'
1783 if it's present; there's no need to recompile or reconfigure any
1786 * Your recursively-searched directories (e.g.,
1787 `/usr/local/share/texmf/fonts//'), contain a mixture of files and
1788 directories. This prevents Kpathsea from using a useful
1789 optimization (*note Subdirectory expansion::).
1791 It is best to have only directories (and perhaps a `README') in the
1792 upper levels of the directory structure, and it's very important
1793 to have _only_ files, and no subdirectories, in the leaf
1794 directories where the dozens of TFM, PK, or whatever files reside.
1796 In any case, you may find the debugging options helpful in
1797 determining precisely when the disk or network is being pounded. *Note
1801 File: kpathsea.info, Node: Unable to generate fonts, Next: TeX or Metafont failing, Prev: Slow path searching, Up: Common problems
1803 2.6.5.3 Unable to generate fonts
1804 ................................
1806 Metafont outputs fonts in bitmap format, tuned for a particular device
1807 at a particular resolution, in order to allow for the highest-possible
1808 quality of output. Some DVI-to-whatever programs, such as Dvips, try
1809 to generate these on the fly when they are needed, but this generation
1810 may fail in several cases.
1812 If `mktexpk' runs, but fails with this error:
1813 mktexpk: Can't guess mode for NNN dpi devices.
1814 mktexpk: Use a config file to specify the mode, or update me.
1815 you need to ensure the resolution and mode match; just specifying
1816 the resolution, as in `-D 360', is not enough.
1818 You can specify the mode name with the `-mode' option on the Dvips
1819 command line, or in a Dvips configuration file (*note Config files:
1820 (dvips)Config files.), such as `config.ps' in your document directory,
1821 `~/.dvipsrc' in your home directory, or in a system directory (again
1822 named `config.ps'). (Other drivers use other files, naturally.)
1824 For example, if you need 360dpi fonts, you could include this in a
1829 If Metafont runs, but generates fonts at the wrong resolution or for
1830 the wrong device, most likely `mktexpk''s built-in guess for the mode
1831 is wrong, and you should override it as above.
1833 See `ftp://ftp.tug.org/tex/modes.mf' for a list of resolutions and
1834 mode names for most devices (additional submissions are welcome).
1836 If Metafont runs but generates fonts at a resolution of 2602dpi (and
1837 prints out the name of each character as well as just a character
1838 number, and maybe tries to display the characters), then your Metafont
1839 base file probably hasn't been made properly. (It's using the default
1840 `proof' mode, instead of an actual device mode.) To make a proper
1841 `plain.base', assuming the local mode definitions are contained in a
1842 file `modes.mf', run the following command (assuming Unix):
1844 inimf "plain; input modes; dump"
1846 Then copy the `plain.base' file from the current directory to where the
1847 base files are stored on your system (`/usr/local/share/texmf/web2c' by
1848 default), and make a link (either hard or soft) from `plain.base' to
1849 `mf.base' in that directory. *Note inimf invocation: (web2c)inimf
1852 If `mf' is a command not found at all by `mktexpk', then you need to
1853 install Metafont (*note unixtex.ftp::).
1856 File: kpathsea.info, Node: TeX or Metafont failing, Next: Empty Makefiles, Prev: Unable to generate fonts, Up: Common problems
1858 2.6.5.4 TeX or Metafont failing
1859 ...............................
1861 If TeX or Metafont get a segmentation fault or otherwise fail while
1862 running a normal input file, the problem is usually a compiler bug
1863 (unlikely as that may sound). Even if the trip and trap tests are
1864 passed, problems may lurk. Optimization occasionally causes trouble in
1865 programs other than TeX and Metafont themselves, too.
1867 Insufficient swap space may also cause core dumps or other erratic
1870 For a workaround, if you enabled any optimization flags, it's best to
1871 omit optimization entirely. In any case, the way to find the facts is
1872 to run the program under the debugger and see where it's failing.
1874 Also, if you have trouble with a system C compiler, I advise trying
1875 the GNU C compiler. And vice versa, unfortunately; but in that case I
1876 also recommend reporting a bug to the GCC mailing list; see *note Bugs:
1879 To report compiler bugs effectively requires perseverance and
1880 perspicacity: you must find the miscompiled line, and that usually
1881 involves delving backwards in time from the point of error, checking
1882 through TeX's (or whatever program's) data structures. Things are not
1883 helped by all-too-common bugs in the debugger itself. Good luck.
1885 One known cause of trouble is the way arrays are handled. Some of
1886 the Pascal arrays have a lower index other than 0, and the C code will
1887 take the pointer to the allocated memory, subtract the lower index, and
1888 use the resulting pointer for the array. While this trick often works,
1889 ANSI C doesn't guarantee that it will. It it known to fail on HP-UX 10
1890 mchines when the native compiler is used, unless the `+u' compiler
1891 switch was specified. Using GCC will work on this platform as well.
1894 File: kpathsea.info, Node: Empty Makefiles, Next: XtStrings, Prev: TeX or Metafont failing, Up: Common problems
1896 2.6.5.5 Empty Makefiles
1897 .......................
1899 On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), `configure' may
1900 fail to properly create the Makefiles. Instead, you get an error which
1901 looks something like this:
1906 sed: 1: "\\@^ac_include make/pat ...": \ can not be used as a string delimiter
1908 So far as I know, the bug here is in `/bin/sh' on these systems. I
1909 don't have access to a machine running any of them, so if someone can
1910 find a workaround that avoids the quoting bug, I'd be most grateful.
1911 (Search for `ac_include' in the `configure' script to get to the
1914 It should work to run `bash configure', instead of using `/bin/sh'.
1915 You can get Bash from `ftp://prep.ai.mit.edu/pub/gnu' and mirrors.
1917 Another possible cause (reported for NeXT) is a bug in the `sed'
1918 command. In that case the error may look like this:
1920 Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
1922 In this case, installing GNU `sed' should solve the problem. You
1923 can get GNU `sed' from the same places as Bash.
1926 File: kpathsea.info, Node: XtStrings, Next: dlopen, Prev: Empty Makefiles, Up: Common problems
1931 You may find that linking X programs results in an error from the linker
1932 that `XtStrings' is undefined, something like this:
1935 .../x11.c:130: undefined reference to `XtStrings'
1937 This generally happens because of a mismatch between the X include
1938 files with which you compiled and the X libraries with which you linked;
1939 often, the include files are from MIT and the libraries from Sun.
1941 The solution is to use the same X distribution for compilation and
1942 linking. Probably `configure' was unable to guess the proper
1943 directories from your installation. You can use the `configure'
1944 options `--x-includes=PATH' and `--x-libraries=PATH' to explicitly
1948 File: kpathsea.info, Node: dlopen, Next: ShellWidgetClass, Prev: XtStrings, Up: Common problems
1953 (This section adapted from the file `dlsym.c' in the X distribution.)
1955 The `Xlib' library uses the standard C function `wcstombs'. Under
1956 SunOS 4.1, `wcstombs' uses the `dlsym' interface defined in `libdl.so'.
1957 Unfortunately, the SunOS 4.1 distribution does not include a static
1960 As a result, if you try to link an X program statically under SunOS,
1961 you may get undefined references to `dlopen', `dlsym', and `dlclose'.
1962 One workaround is to include these definitions when you link:
1964 void *dlopen() { return 0; }
1965 void *dlsym() { return 0; }
1966 int dlclose() { return -1; }
1968 These are contained in the `dlsym.c' file in the MIT X distribution.
1971 File: kpathsea.info, Node: ShellWidgetClass, Next: Pointer combination warnings, Prev: dlopen, Up: Common problems
1973 2.6.5.8 `ShellWidgetClass'
1974 ..........................
1976 (This section adapted from the comp.sys.sun.admin FAQ.)
1978 If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
1979 you may get undefined symbols `_get_wmShellWidgetClass' and
1980 `_get_applicationShellWidgetClass' when linking. This problem does not
1981 arise using the standard MIT X libraries under SunOS.
1983 The cause is bugs in the `Xmu' shared library as shipped from Sun.
1984 There are several fixes:
1986 * Install the free MIT distribution from `ftp.x.org' and mirrors.
1988 * Get the OpenWindows patches listed below.
1990 * Statically link the `Xmu' library into the executable.
1992 * Avoid using `Xmu' at all. If you are compiling Metafont, see *note
1993 Online Metafont graphics: (web2c)Online Metafont graphics. If you
1994 are compiling Xdvi, see the `-DNOTOOL' option in `xdvik/INSTALL'.
1996 * Ignore the errors. The binary runs fine regardless.
1999 Here is the information for getting the two patches:
2002 Bug ID's: 1086793, 1086912, 1074766
2003 Description: 4.1.x OpenWindows 3.0 `libXt' jumbo patch
2007 Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared `libXmu'.
2009 The way to statically link with `libXmu' depends on whether you are
2010 using a Sun compiler (e.g., `cc') or `gcc'. If the latter, alter the
2011 `x_libs' Make variable to include
2013 -static -lXmu -dynamic
2015 If you are using the Sun compiler, use `-Bstatic' and `-Bdynamic'.
2018 File: kpathsea.info, Node: Pointer combination warnings, Prev: ShellWidgetClass, Up: Common problems
2020 2.6.5.9 Pointer combination warnings
2021 ....................................
2023 When compiling with old C compilers, you may get some warnings about
2024 "illegal pointer combinations". These are spurious; just ignore them.
2025 I decline to clutter up the source with casts to get rid of them.
2028 File: kpathsea.info, Node: Path searching, Next: TeX support, Prev: Installation, Up: Top
2033 This chapter describes the generic path searching mechanism Kpathsea
2034 provides. For information about searching for particular file types
2035 (e.g., TeX fonts), see the next chapter.
2039 * Searching overview:: Basic scheme for searching.
2040 * Path sources:: Where search paths can be defined.
2041 * Path expansion:: Special constructs in search paths.
2042 * Filename database:: Using an externally-built list to search.
2043 * Invoking kpsewhich:: Standalone path lookup.
2046 File: kpathsea.info, Node: Searching overview, Next: Path sources, Up: Path searching
2048 3.1 Searching overview
2049 ======================
2051 A "search path" is a colon-separated list of "path elements", which are
2052 directory names with a few extra frills. A search path can come from
2053 (a combination of) many sources; see below. To look up a file `foo'
2054 along a path `.:/dir', Kpathsea checks each element of the path in
2055 turn: first `./foo', then `/dir/foo', returning the first match (or
2056 possibly all matches).
2058 The "colon" and "slash" mentioned here aren't necessarily `:' and
2059 `/' on non-Unix systems. Kpathsea tries to adapt to other operating
2060 systems' conventions.
2062 To check a particular path element E, Kpathsea first sees if a
2063 prebuilt database (*note Filename database::) applies to E, i.e., if
2064 the database is in a directory that is a prefix of E. If so, the path
2065 specification is matched against the contents of the database.
2067 If the database does not exist, or does not apply to this path
2068 element, or contains no matches, the filesystem is searched (if this
2069 was not forbidden by the specification with `!!' and if the file being
2070 searched for must exist). Kpathsea constructs the list of directories
2071 that correspond to this path element, and then checks in each for the
2072 file being searched for. (To help speed future lookups of files in the
2073 same directory, the directory in which a file is found is floated to the
2074 top of the directory list.)
2076 The "file must exist" condition comes into play with VF files and
2077 input files read by the TeX `\openin' command. These files may not
2078 exist (consider `cmr10.vf'), and so it would be wrong to search the
2079 disk for them. Therefore, if you fail to update `ls-R' when you
2080 install a new VF file, it will never be found.
2082 Each path element is checked in turn: first the database, then the
2083 disk. If a match is found, the search stops and the result is
2084 returned. This avoids possibly-expensive processing of path
2085 specifications that are never needed on a particular run. (Unless the
2086 search explicitly requested all matches.)
2088 Although the simplest and most common path element is a directory
2089 name, Kpathsea supports additional features in search paths: layered
2090 default values, environment variable names, config file values, users'
2091 home directories, and recursive subdirectory searching. Thus, we say
2092 that Kpathsea "expands" a path element, meaning transforming all the
2093 magic specifications into the basic directory name or names. This
2094 process is described in the sections below. It happens in the same
2095 order as the sections.
2097 Exception to all of the above: If the filename being searched for is
2098 absolute or explicitly relative, i.e., starts with `/' or `./' or
2099 `../', Kpathsea simply checks if that file exists.
2101 Ordinarily, if Kpathsea tries to access a file or directory that
2102 cannot be read, it gives a warning. This is so you will be alerted to
2103 directories or files that accidentally lack read permission (for
2104 example, a `lost+found'). If you prefer not to see these warnings,
2105 include the value `readable' in the `TEX_HUSH' environment variable or
2108 This generic path searching algorithm is implemented in
2109 `kpathsea/pathsearch.c'. It is employed by a higher-level algorithm
2110 when searching for a file of a particular type (*note File lookup::,
2111 and *note Glyph lookup::).
2114 File: kpathsea.info, Node: Path sources, Next: Path expansion, Prev: Searching overview, Up: Path searching
2119 A search path can come from many sources. In the order in which
2122 1. A user-set environment variable, e.g., `TEXINPUTS'. Environment
2123 variables with an underscore and the program name appended
2124 override; for example, `TEXINPUTS_latex' overrides `TEXINPUTS' if
2125 the program being run is named `latex'.
2127 2. A program-specific configuration file, e.g., an `S /a:/b' line in
2128 Dvips' `config.ps' (*note Config files: (dvips)Config files.).
2130 3. A line in a Kpathsea configuration file `texmf.cnf', e.g.,
2131 `TEXINPUTS=/c:/d' (see below).
2133 4. The compile-time default (specified in `kpathsea/paths.h').
2135 You can see each of these values for a given search path by using the
2136 debugging options (*note Debugging::).
2138 These sources may be combined via default expansion (*note Default
2143 * Config files:: Kpathsea's runtime config files (texmf.cnf).
2146 File: kpathsea.info, Node: Config files, Up: Path sources
2151 As mentioned above, Kpathsea reads "runtime configuration files" named
2152 `texmf.cnf' for search path and other definitions. The search path
2153 used to look for these configuration files is named `TEXMFCNF', and is
2154 constructed in the usual way, as described above, except that
2155 configuration files cannot be used to define the path, naturally; also,
2156 an `ls-R' database is not used to search for them.
2158 Kpathsea reads _all_ `texmf.cnf' files in the search path, not just
2159 the first one found; definitions in earlier files override those in
2160 later files. Thus, if the search path is `.:$TEXMF', values from
2161 `./texmf.cnf' override those from `$TEXMF/texmf.cnf'.
2163 While (or instead of) reading this description, you may find it
2164 helpful to look at the distributed `texmf.cnf', which uses or at least
2165 mentions most features. The format of `texmf.cnf' files follows:
2167 * Comments start with `%' and continue to the end of the line.
2169 * Blank lines are ignored.
2171 * A `\' at the end of a line acts as a continuation character, i.e.,
2172 the next line is appended. Whitespace at the beginning of
2173 continuation lines is not ignored.
2175 * Each remaining line must look like
2177 VARIABLE [. PROGNAME] [=] VALUE
2179 where the `=' and surrounding whitespace is optional.
2181 * The VARIABLE name may contain any character other than whitespace,
2182 `=', or `.', but sticking to `A-Za-z_' is safest.
2184 * If `.PROGNAME' is present, the definition only applies if the
2185 program that is running is named (i.e., the last component of
2186 `argv[0]' is) PROGNAME or `PROGNAME.exe'. This allows different
2187 flavors of TeX to have different search paths, for example.
2189 * VALUE may contain any characters except `%' and `@'. (These
2190 restrictions are only necessary because of the processing done on
2191 `texmf.cnf' at build time, so you can stick those characters in
2192 after installation if you have to.) The `$VAR.PROG' feature is
2193 not available on the right-hand side; instead, you must use an
2194 additional variable (see below for example). A `;' in VALUE is
2195 translated to `:' if running under Unix; this is useful to write a
2196 single `texmf.cnf' which can be used under both Unix and NT.
2198 * All definitions are read before anything is expanded, so you can
2199 use variables before they are defined (like Make, unlike most other
2202 Here is a configuration file fragment illustrating most of these points:
2204 % TeX input files -- i.e., anything to be found by \input or \openin ...
2205 latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
2206 latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
2207 TEXINPUTS = .:$TEXMF/tex//
2208 TEXINPUTS.latex209 = $latex209_inputs
2209 TEXINPUTS.latex2e = $latex2e_inputs
2210 TEXINPUTS.latex = $latex2e_inputs
2212 Although this format has obvious similarities to Bourne shell
2213 scripts--change the comment character to `#', disallow spaces around
2214 the `=', and get rid of the `.NAME' convention, and it could be run
2215 through the shell. But there seemed little advantage to doing this,
2216 since all the information would have to passed back to Kpathsea and
2217 parsed there anyway, since the `sh' process couldn't affect its
2218 parent's environment.
2220 The implementation of all this is in `kpathsea/cnf.c'.
2223 File: kpathsea.info, Node: Path expansion, Next: Filename database, Prev: Path sources, Up: Path searching
2228 Kpathsea recognizes certain special characters and constructions in
2229 search paths, similar to that in shells. As a general example:
2230 `~$USER/{foo,bar}//baz' expands to all subdirectories under directories
2231 `foo' and `bar' in $USER's home directory that contain a directory or
2232 file `baz'. These expansions are explained in the sections below.
2236 * Default expansion:: a: or :a or a::b expands to a default.
2237 * Variable expansion:: $foo and ${foo} expand to environment values.
2238 * Tilde expansion:: ~ and ~user expand to home directories.
2239 * Brace expansion:: a{foo,bar}b expands to afoob abarb.
2240 * KPSE_DOT expansion:: . is replaced with $KPSE_DOT if it is defined.
2241 * Subdirectory expansion:: a// and a//b recursively expand to subdirs.
2244 File: kpathsea.info, Node: Default expansion, Next: Variable expansion, Up: Path expansion
2246 3.3.1 Default expansion
2247 -----------------------
2249 If the highest-priority search path (*note Path sources::) contains an
2250 "extra colon" (i.e., leading, trailing, or doubled), Kpathsea inserts
2251 at that point the next-highest-priority search path that is defined.
2252 If that inserted path has an extra colon, the same happens with the
2253 next-highest. (An extra colon in the compile-time default value has
2254 unpredictable results, so installers beware.)
2256 For example, given an environment variable setting
2258 setenv TEXINPUTS /home/karl:
2260 and a `TEXINPUTS' value from `texmf.cnf' of
2264 then the final value used for searching will be:
2266 /home/karl:.:$TEXMF//tex
2268 Put another way, default expansion works on "formats" (search
2269 paths), and not directly on environment variables. Example, showing
2270 the trailing `:' ignored in the first case and expanded in the second:
2272 $ env TTFONTS=/tmp: kpsewhich --expand-path '$TTFONTS'
2274 $ env TTFONTS=/tmp: kpsewhich --show-path=.ttf
2275 /tmp:.:/home/olaf/texmf/fonts/truetype//:...
2277 Since Kpathsea looks for multiple configuration files, it would be
2278 natural to expect that (for example) an extra colon in `./texmf.cnf'
2279 would expand to the path in `$TEXMF/texmf.cnf'. Or, with Dvips'
2280 configuration files, that an extra colon in `config.$PRINTER' would
2281 expand to the path in `config.ps'. This doesn't happen. It's not
2282 clear this would be desirable in all cases, and trying to devise a way
2283 to specify the path to which the extra colon should expand seemed truly
2286 Technicality: Since it would be useless to insert the default value
2287 in more than one place, Kpathsea changes only one extra `:' and leaves
2288 any others in place (they will eventually be ignored). Kpathsea checks
2289 first for a leading `:', then a trailing `:', then a doubled `:'.
2291 You can trace this by debugging "paths" (*note Debugging::).
2292 Default expansion is implemented in the source file
2293 `kpathsea/kdefault.c'.
2296 File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: Default expansion, Up: Path expansion
2298 3.3.2 Variable expansion
2299 ------------------------
2301 `$foo' or `${foo}' in a path element is replaced by (1) the value of an
2302 environment variable `foo' (if defined); (2) the value of `foo' from
2303 `texmf.cnf' (if defined); (3) the empty string.
2305 If the character after the `$' is alphanumeric or `_', the variable
2306 name consists of all consecutive such characters. If the character
2307 after the `$' is a `{', the variable name consists of everything up to
2308 the next `}' (braces may not be nested around variable names).
2309 Otherwise, Kpathsea gives a warning and ignores the `$' and its
2310 following character.
2312 You must quote the $'s and braces as necessary for your shell.
2313 _Shell_ variable values cannot be seen by Kpathsea, i.e., ones defined
2314 by `set' in C shells and without `export' in Bourne shells.
2317 setenv tex /home/texmf
2318 setenv TEXINPUTS .:$tex:${tex}prev
2319 the final `TEXINPUTS' path is the three directories:
2320 .:/home/texmf:/home/texmfprev
2322 The `.PROGNAME' suffix on variables and `_PROGNAME' on environment
2323 variable names are not implemented for general variable expansions.
2324 These are only recognized when search paths are initialized (*note Path
2327 Variable expansion is implemented in the source file
2328 `kpathsea/variable.c'.
2331 File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Variable expansion, Up: Path expansion
2333 3.3.3 Tilde expansion
2334 ---------------------
2336 A leading `~' in a path element is replaced by the value of the
2337 environment variable `HOME', or `.' if `HOME' is not set. On Windows,
2338 the environment variable `USERPROFILE' is checked instead of `HOME'.
2340 A leading `~USER' in a path element is replaced by USER's home
2341 directory from the system `passwd' database.
2344 setenv TEXINPUTS ~/mymacros:
2346 will prepend a directory `mymacros' in your home directory to the
2349 As a special case, if a home directory ends in `/', the trailing
2350 slash is dropped, to avoid inadvertently creating a `//' construct in
2351 the path. For example, if the home directory of the user `root' is
2352 `/', the path element `~root/mymacros' expands to just `/mymacros', not
2355 Tilde expansion is implemented in the source file `kpathsea/tilde.c'.
2358 File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: Tilde expansion, Up: Path expansion
2360 3.3.4 Brace expansion
2361 ---------------------
2363 `x{A,B}y' expands to `xAy:xBy'. For example:
2367 expands to `foo/1/baz:foo/2/baz'. `:' is the path separator on the
2368 current system; e.g., on a DOS system, it's `;'.
2370 Braces can be nested; for example, `x{A,B{1,2}}y' expands to
2373 Multiple non-nested braces are expanded from right to left; for
2374 example, `x{A,B}{1,2}y' expands to `x{A,B}1y:x{A,B}2y', which expands
2375 to `xA1y:xB1y:xA2y:xB2y'.
2377 This feature can be used to implement multiple TeX hierarchies, by
2378 assigning a brace list to `$TEXMF', as mentioned in `texmf.in'.
2380 You can also use the path separator in stead of the comma. The last
2381 example could have been written `x{A:B}{1:2}y'.
2383 Brace expansion is implemented in the source file
2384 `kpathsea/expand.c'. It is a modification of the Bash sources, and is
2385 thus covered by the GNU General Public License, rather than the Library
2386 General Public License that covers the rest of Kpathsea.
2389 File: kpathsea.info, Node: KPSE_DOT expansion, Next: Subdirectory expansion, Prev: Brace expansion, Up: Path expansion
2391 3.3.5 `KPSE_DOT' expansion
2392 --------------------------
2394 When `KPSE_DOT' is defined in the environment, it names a directory
2395 that should be considered the current directory for the purpose of
2396 looking up files in the search paths. This feature is needed by the
2397 `mktex...' scripts *note mktex scripts::, because these change the
2398 working directory. You should not ever define it yourself.
2401 File: kpathsea.info, Node: Subdirectory expansion, Prev: KPSE_DOT expansion, Up: Path expansion
2403 3.3.6 Subdirectory expansion
2404 ----------------------------
2406 Two or more consecutive slashes in a path element following a directory
2407 D is replaced by all subdirectories of D: first those subdirectories
2408 directly under D, then the subsubdirectories under those, and so on.
2409 At each level, the order in which the directories are searched is
2410 unspecified. (It's "directory order", and definitely not alphabetical.)
2412 If you specify any filename components after the `//', only
2413 subdirectories which match those components are included. For example,
2414 `/a//b' would expand into directories `/a/1/b', `/a/2/b', `/a/1/1/b',
2415 and so on, but not `/a/b/c' or `/a/1'.
2417 You can include multiple `//' constructs in the path.
2419 `//' at the beginning of a path is ignored; you didn't really want
2420 to search every directory on the system, did you?
2422 I should mention one related implementation trick, which I took from
2423 GNU find. Matthew Farwell suggested it, and David MacKenzie
2426 The trick is that in every real Unix implementation (as opposed to
2427 the POSIX specification), a directory which contains no subdirectories
2428 will have exactly two links (namely, one for `.' and one for `..').
2429 That is to say, the `st_nlink' field in the `stat' structure will be
2430 two. Thus, we don't have to stat everything in the bottom-level (leaf)
2431 directories--we can just check `st_nlink', notice it's two, and do no
2434 But if you have a directory that contains a single subdirectory and
2435 500 regular files, `st_nlink' will be 3, and Kpathsea has to stat every
2436 one of those 501 entries. Therein lies slowness.
2438 You can disable the trick by undefining `UNIX_ST_LINK' in
2439 `kpathsea/config.h'. (It is undefined by default except under Unix.)
2441 Unfortunately, in some cases files in leaf directories are `stat''d:
2442 if the path specification is, say, `$TEXMF/fonts//pk//', then files in
2443 a subdirectory `.../pk', even if it is a leaf, are checked. The reason
2444 cannot be explained without reference to the implementation, so read
2445 `kpathsea/elt-dirs.c' (search for `may descend') if you are curious.
2446 And if you can find a way to _solve_ the problem, please let me know.
2448 Subdirectory expansion is implemented in the source file
2449 `kpathsea/elt-dirs.c'.
2452 File: kpathsea.info, Node: Filename database, Next: Invoking kpsewhich, Prev: Path expansion, Up: Path searching
2454 3.4 Filename database (`ls-R')
2455 ==============================
2457 Kpathsea goes to some lengths to minimize disk accesses for searches
2458 (*note Subdirectory expansion::). Nevertheless, at installations with
2459 enough directories, searching each possible directory for a given file
2460 can take an excessively long time (depending on the speed of the disk,
2461 whether it's NFS-mounted, how patient you are, etc.).
2463 In practice, a font tree containing the standard PostScript and PCL
2464 fonts is large enough for searching to be noticeably slow on typical
2465 systems these days. Therefore, Kpathsea can use an externally-built
2466 "database" file named `ls-R' that maps files to directories, thus
2467 avoiding the need to exhaustively search the disk.
2469 A second database file `aliases' allows you to give additional names
2470 to the files listed in `ls-R'. This can be helpful to adapt to "8.3"
2471 filename conventions in source files.
2473 The `ls-R' and `aliases' features are implemented in the source file
2478 * ls-R:: The main filename database.
2479 * Filename aliases:: Aliases for those names.
2480 * Database format:: Syntax details of the database file.
2483 File: kpathsea.info, Node: ls-R, Next: Filename aliases, Up: Filename database
2488 As mentioned above, you must name the main filename database `ls-R'.
2489 You can put one at the root of each TeX installation hierarchy you wish
2490 to search (`$TEXMF' by default); most sites have only one hierarchy.
2491 Kpathsea looks for `ls-R' files along the `TEXMFDBS' path, so that
2492 should presumably match the list of hierarchies.
2494 The recommended way to create and maintain `ls-R' is to run the
2495 `mktexlsr' script, which is installed in `$(bindir)' (`/usr/local/bin'
2496 by default). That script goes to some trouble to follow symbolic links
2497 as necessary, etc. It's also invoked by the distributed `mktex...'
2500 At its simplest, though, you can build `ls-R' with the command
2501 cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
2503 presuming your `ls' produces the right output format (see the section
2504 below). GNU `ls', for example, outputs in this format. Also presuming
2505 your `ls' hasn't been aliased in a system file (e.g., `/etc/profile')
2506 to something problematic, e.g., `ls --color=tty'. In that case, you
2507 will have to disable the alias before generating `ls-R'. For the
2508 precise definition of the file format, see *note Database format::.
2510 Regardless of whether you use the supplied script or your own, you
2511 will almost certainly want to invoke it via `cron', so when you make
2512 changes in the installed files (say if you install a new LaTeX
2513 package), `ls-R' will be automatically updated.
2515 The `-A' option to `ls' includes files beginning with `.' (except
2516 for `.' and `..'), such as the file `.tex' included with the LaTeX
2517 tools package. (On the other hand, _directories_ whose names begin
2518 with `.' are always ignored.)
2520 If your system does not support symbolic links, omit the `-L'.
2522 `ls -LAR /YOUR/TEXMF/ROOT' will also work. But using `./' avoids
2523 embedding absolute pathnames, so the hierarchy can be easily
2524 transported. It also avoids possible trouble with automounters or
2525 other network filesystem conventions.
2527 Kpathsea warns you if it finds an `ls-R' file, but the file does not
2528 contain any usable entries. The usual culprit is running plain `ls -R'
2529 instead of `ls -LR ./' or `ls -R /YOUR/TEXMF/ROOT'. Another
2530 possibility is some system directory name starting with a `.' (perhaps
2531 if you are using AFS); Kpathsea ignores everything under such
2534 Because the database may be out-of-date for a particular run, if a
2535 file is not found in the database, by default Kpathsea goes ahead and
2536 searches the disk. If a particular path element begins with `!!',
2537 however, _only_ the database will be searched for that element, never
2538 the disk. If the database does not exist, nothing will be searched.
2539 Because this can surprise users ("I see the font `foo.tfm' when I do an
2540 `ls'; why can't Dvips find it?"), it is not in any of the default
2544 File: kpathsea.info, Node: Filename aliases, Next: Database format, Prev: ls-R, Up: Filename database
2546 3.4.2 Filename aliases
2547 ----------------------
2549 In some circumstances, you may wish to find a file under several names.
2550 For example, suppose a TeX document was created using a DOS system and
2551 tries to read `longtabl.sty'. But now it's being run on a Unix system,
2552 and the file has its original name, `longtable.sty'. The file won't be
2553 found. You need to give the actual file `longtable.sty' an alias
2556 You can handle this by creating a file `aliases' as a companion to
2557 the `ls-R' for the hierarchy containing the file in question. (You
2558 must have an `ls-R' for the alias feature to work.)
2560 The format of `aliases' is simple: two whitespace-separated words
2561 per line; the first is the real name `longtable.sty', and second is the
2562 alias (`longtabl.sty'). These must be base filenames, with no
2563 directory components. `longtable.sty' must be in the sibling `ls-R'.
2565 Also, blank lines and lines starting with `%' or `#' are ignored in
2566 `aliases', to allow for comments.
2568 If a real file `longtabl.sty' exists, it is used regardless of any
2572 File: kpathsea.info, Node: Database format, Prev: Filename aliases, Up: Filename database
2574 3.4.3 Database format
2575 ---------------------
2577 The "database" read by Kpathsea is a line-oriented file of plain text.
2578 The format is that generated by GNU (and most other) `ls' programs
2579 given the `-R' option, as follows.
2581 * Blank lines are ignored.
2583 * If a line begins with `/' or `./' or `../' and ends with a colon,
2584 it's the name of a directory. (`../' lines aren't useful,
2585 however, and should not be generated.)
2587 * All other lines define entries in the most recently seen directory.
2588 /'s in such lines will produce possibly-strange results.
2590 * Files with no preceding directory line are ignored.
2592 For example, here's the first few lines of `ls-R' (which totals
2593 about 30K bytes) on my system:
2615 File: kpathsea.info, Node: Invoking kpsewhich, Prev: Filename database, Up: Path searching
2617 3.5 `kpsewhich': Standalone path searching
2618 ==========================================
2620 The Kpsewhich program exercises the path searching functionality
2621 independent of any particular application. This can also be useful as a
2622 sort of `find' program to locate files in your TeX hierarchies, perhaps
2623 in administrative scripts. It is used heavily in the distributed
2627 kpsewhich OPTION... FILENAME...
2629 The options and filename(s) to look up can be intermixed. Options
2630 can start with either `-' or `--', and any unambiguous abbreviation is
2635 * Path searching options:: Changing the mode, resolution, etc.
2636 * Auxiliary tasks:: Path and variable expansion.
2637 * Standard options:: --help and --version.
2640 File: kpathsea.info, Node: Path searching options, Next: Auxiliary tasks, Up: Invoking kpsewhich
2642 3.5.1 Path searching options
2643 ----------------------------
2645 Kpsewhich looks up each non-option argument on the command line as a
2646 filename, and returns the first file found.
2648 Various options alter the path searching behavior:
2651 Report all matches found, one per line. By default, if there is
2652 more than one match, just one will be reported (chosen effectively
2656 Set the resolution to NUM; this only affects `gf' and `pk'
2657 lookups. `-D' is a synonym, for compatibility with Dvips.
2661 Set the engine name to NAME. By default it is not set. The
2662 engine name is used in some search paths to allow files with the
2663 same name but used by different engines to coexist.
2666 Set the format for lookup to NAME. By default, the format is
2667 guessed from the filename, with `tex' being used if nothing else
2668 fits. The recognized filename extensions (including any leading
2669 `.') are also allowable NAMEs.
2671 All formats also have a name, which is the only way to specify
2672 formats with no associated suffix. For example, for Dvips
2673 configuration files you can use `--format="dvips config"'. (The
2674 quotes are for the sake of the shell.)
2676 When the filename being searched for is `config.ps', the format is
2677 automatically switched to `dvips config'. Similarly, when the
2678 filename is `pdftex.cfg', the format is switched to `pdftex
2679 config' (although `pdftex.cfg' is not used any more; look for
2680 `pdftexconfig.tex' instead.)
2682 Here's the current list of recognized names and the associated
2683 suffixes. *Note Supported file formats::, for more information on
2709 graphic/figure: .eps .epsi
2711 TeX system documentation
2714 PostScript header/font: .pro
2717 type1 fonts: .pfa .pfb
2721 truetype fonts: .ttf .ttc
2737 This option and `--path' are mutually exclusive.
2740 After processing the command line, read additional filenames to
2741 look up from standard input.
2744 `-no-mktex=FILETYPE'
2745 Turn on or off the `mktex' script associated with FILETYPE. The
2746 only values that make sense for FILETYPE are `pk', `mf', `tex',
2747 and `tfm'. By default, all are off in Kpsewhich. *Note mktex
2751 Set the mode name to STRING; this also only affects `gf' and `pk'
2752 lookups. No default: any mode will be found. *Note mktex script
2756 Do everything possible to find the files, notably including
2757 searching the disk. By default, only the `ls-R' database is
2758 checked, in the interest of efficiency.
2761 Search along the path STRING (colon-separated as usual), instead
2762 of guessing the search path from the filename. `//' and all the
2763 usual expansions are supported (*note Path expansion::). This
2764 option and `--format' are mutually exclusive. To output the
2765 complete directory expansion of a path, instead of doing a
2766 one-shot lookup, see `--expand-path' and `--show-path' in the
2770 Set the program name to NAME; default is `kpsewhich'. This can
2771 affect the search paths via the `.PROGNAM' feature in
2772 configuration files (*note Config files::).
2775 Report only those matches whose directory part _ends_ with STRING
2776 (compared literally, except case is ignored on a case-insensitive
2777 operating system). For example, suppose there are two matches for
2781 => /some/where/foo.sty
2782 /another/place/foo.sty
2784 Then we can narrow the result to what we are interested in with
2787 kpsewhich --subdir=where foo.sty
2788 => /some/where/foo.sty
2790 kpsewhich --subdir=place foo.sty
2791 => /another/place/foo.sty
2793 The string to match must be at the end of the directory part of the
2794 match, and it is taken literally, with no pattern matching:
2796 kpsewhich --subdir=another foo.sty
2799 The string to match may cross directory components:
2801 kpsewhich --subdir=some/where foo.sty
2802 => /some/where/foo.sty
2804 `--subdir' implies `--all'; if there is more than one match, they
2805 will all be reported (in our example, both `where' and `place' end
2808 kpsewhich --subdir=e
2809 => /some/where/foo.sty
2810 /another/place/foo.sty
2812 Because of the above rules, the presence of a leading `/' is
2813 important, since it "anchors" the match to a full component name:
2815 kpsewhich --subdir=/lace foo.sty
2818 However, a trailing `/' is immaterial (and ignored), since the
2819 match always takes place at the end of the directory part:
2821 kpsewhich --subdir=lace/ foo.sty
2822 => /another/place/foo.sty
2824 The purpose of these rules is to make it convenient to find results
2825 only within a particular area of the tree. For instance, a given
2826 script named `foo.lua' might exist within both
2827 `texmf-dist/scripts/pkg1/' and `texmf-dist/scripts/pkg2/'. By
2828 specifying, say, `--subdir=/pkg1', you can be sure of getting the
2829 one you are interested in.
2831 We only match at the end because a site might happen to install TeX
2832 in `/some/coincidental/pkg1/path/', and we wouldn't want
2833 `texmf-dist/scripts/pkg2/' to match that when searching for
2838 File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Path searching options, Up: Invoking kpsewhich
2840 3.5.2 Auxiliary tasks
2841 ---------------------
2843 Kpsewhich provides some additional features not strictly related to path
2846 * `--debug=NUM' sets the debugging options to NUM. *Note
2849 * `--var-value=VARIABLE' outputs the value of VARIABLE, expanding
2850 `$' (*note Variable expansion:: and `~' (*note Tilde expansion::)
2851 constructs, but not performing other expansions.
2853 * `--expand-braces=STRING' outputs the variable and brace expansion
2854 of STRING. *Note Path expansion::.
2856 * `--expand-var=STRING' outputs the variable and tilde expansion of
2857 STRING. For example, the `mktex...' scripts run `kpsewhich
2858 --expand-var='$TEXMF'' to find the root of the TeX system
2859 hierarchy. *Note Path expansion::.
2861 * `--expand-path=STRING' outputs the complete expansion of STRING,
2862 with each element separated by the usual path separator on the
2863 current system (`;' on Windows, `:' otherwise). This may be
2864 useful to construct a custom search path for a format not
2865 otherwise supported. To retrieve the search path for a format
2866 that is already supported, see `--show-path', next.
2868 Nonexistent directories are culled from the output:
2870 $ kpsewhich --expand-path '/tmp'
2872 $ kpsewhich --expand-path '/nonesuch'
2875 For one-shot uses of an arbitrary (not built in to Kpathsea) path,
2876 see `--path' in the previous section.
2878 * `--show-path=NAME' shows the path that would be used for file
2879 lookups of file type NAME. Either a filename extension (`pk',
2880 `.vf', etc.) or an integer can be used, just as with `--format',
2881 described in the previous section.
2885 File: kpathsea.info, Node: Standard options, Prev: Auxiliary tasks, Up: Invoking kpsewhich
2887 3.5.3 Standard options
2888 ----------------------
2890 Kpsewhich accepts the standard GNU options:
2892 * `--help' prints a help message on standard output and exits.
2894 * `--version' prints the Kpathsea version number and exits.
2897 File: kpathsea.info, Node: TeX support, Next: Programming, Prev: Path searching, Up: Top
2902 Although the basic features in Kpathsea can be used for any type of path
2903 searching, it came about (like all libraries) with a specific
2904 application in mind: I wrote Kpathsea specifically for TeX system
2905 programs. I had been struggling with the programs I was using (Dvips,
2906 Xdvi, and TeX itself) having slightly different notions of how to
2907 specify paths; and debugging was painful, since no code was shared.
2909 Therefore, Kpathsea provides some TeX-specific formats and features.
2910 Indeed, many of the supposedly generic path searching features were
2911 provided because they seemed useful in that conTeXt (font lookup,
2914 Kpathsea provides a standard way to search for files of any of the
2915 supported file types; glyph fonts are a bit different than all the rest.
2916 Searches are based solely on filenames, not file contents--if a GF file
2917 is named `cmr10.600pk', it will be found as a PK file.
2921 * Supported file formats:: File types Kpathsea knows about.
2922 * File lookup:: Searching for most kinds of files.
2923 * Glyph lookup:: Searching for bitmap fonts.
2924 * Suppressing warnings:: Avoiding warnings via TEX_HUSH.
2927 File: kpathsea.info, Node: Supported file formats, Next: File lookup, Up: TeX support
2929 4.1 Supported file formats
2930 ==========================
2932 Kpathsea has support for a number of file types. Each file type has a
2933 list of environment and config file variables that are checked to define
2934 the search path, and most have a default suffix that plays a role in
2935 finding files (see the next section). Some also define additional
2936 suffixes, and/or a program to be run to create missing files on the fly.
2938 Since environment variables containing periods, such as
2939 `TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
2940 environment variables with an underscore, e.g., `TEXINPUTS_latex'
2941 (*note Config files::).
2943 The following table lists the above information.
2946 (Adobe font metrics, *note Metric files: (dvips)Metric files.)
2947 `AFMFONTS'; suffix `.afm'.
2950 (Metafont memory dump, *note Memory dumps: (web2c)Memory dumps.)
2951 `MFBASES', `TEXMFINI'; suffix `.base'.
2954 (BibTeX bibliography source, *note bibtex invocation:
2955 (web2c)bibtex invocation.) `BIBINPUTS', `TEXBIB'; suffix `.bib'.
2958 (BibTeX style file, *note Basic BibTeX style files: (web2c)Basic
2959 BibTeX style files.) `BSTINPUTS'; suffix `.bst'.
2962 (character map files) `CMAPFONTS'; suffix `.cmap'.
2965 (Runtime configuration files, *note Config files::) `TEXMFCNF';
2969 (CWEB input files) `CWEBINPUTS'; suffixes `.w', `.web'; additional
2973 (Dvips `config.*' files, such as `config.ps', *note Config files:
2974 (dvips)Config files.) `TEXCONFIG'.
2977 (encoding vectors) `ENCFONTS'; suffix `.enc'.
2980 (TeX memory dump, *note Memory dumps: (web2c)Memory dumps.)
2981 `TEXFORMATS', `TEXMFINI'; suffix `.fmt'.
2984 (generic font bitmap, *note Glyph files: (dvips)Glyph files.)
2985 `PROGRAMFONTS', `GFFONTS', `GLYPHFONTS', `TEXFONTS'; suffix `gf'.
2988 (Encapsulated PostScript figures, *note PostScript figures:
2989 (dvips)PostScript figures.) `TEXPICTS', `TEXINPUTS'; additional
2990 suffixes: `.eps', `.epsi'.
2993 (makeindex style files) `TEXINDEXSTYLE', `INDEXSTYLE'; suffix
2997 (ligature definition files) `LIGFONTS'; suffix `.lig'.
3000 (Filename databases, *note Filename database::) `TEXMFDBS'.
3003 (Fontmaps, *note Fontmap::) `TEXFONTMAPS'; suffix `.map'.
3006 (MetaPost memory dump, *note Memory dumps: (web2c)Memory dumps.)
3007 `MPMEMS', `TEXMFINI'; suffix `.mem'.
3010 (MetaPost support files, used by DMP; *note dmp invocation:
3011 (web2c)dmp invocation.) `MPSUPPORT'.
3014 (Metafont source, *note mf invocation: (web2c)mf invocation.)
3015 `MFINPUTS'; suffix `.mf'; dynamic creation program: `mktexmf'.
3018 (Metafont program strings, *note pooltype invocation:
3019 (web2c)pooltype invocation.) `MFPOOL', `TEXMFINI'; suffix `.pool'.
3022 (`MFT' style file, *note mft invocation: (web2c)mft invocation.)
3023 `MFTINPUTS'; suffix `.mft'.
3026 (font-related files that don't fit the other categories)
3030 (MetaPost source, *note mpost invocation: (web2c)mpost invocation.)
3031 `MPINPUTS'; suffix `.mp'.
3034 (MetaPost program strings, *note pooltype invocation:
3035 (web2c)pooltype invocation.) `MPPOOL', `TEXMFINI'; suffix `.pool'.
3038 (Omega compiled process files) `OCPINPUTS';
3039 suffix `.ocp'; dynamic creation program: `MakeOmegaOCP'.
3042 (Omega font metrics) `OFMFONTS', `TEXFONTS';
3043 suffixes `.ofm', `.tfm'; dynamic creation program: `MakeOmegaOFM'.
3046 (OpenType fonts) `OPENTYPEFONTS'.
3049 (Omega property lists) `OPLFONTS', `TEXFONTS'; suffix `.opl'.
3052 (Omega translation process files) `OTPINPUTS'; suffix `.otp'.
3055 (Omega virtual fonts) `OVFFONTS', `TEXFONTS'; suffix `.ovf'.
3058 (Omega virtual property lists) `OVPFONTS', `TEXFONTS'; suffix
3062 (PDFTeX-specific configuration files) `PDFTEXCONFIG'.
3065 (packed bitmap fonts, *note Glyph files: (dvips)Glyph files.)
3066 `PROGRAMFONTS' (PROGRAM being `XDVI', etc.), `PKFONTS', `TEXPKS',
3067 `GLYPHFONTS', `TEXFONTS'; suffix `pk'; dynamic creation program:
3071 (downloadable PostScript, *note Header files: (dvips)Header files.)
3072 `TEXPSHEADERS', `PSHEADERS'; additional suffix `.pro'.
3074 `subfont definition files'
3075 (subfont definition files) `SFDFONTS' suffix `.sfd'.
3078 (TeX source, *note tex invocation: (web2c)tex invocation.)
3079 `TEXINPUTS'; suffix `.tex'; additional suffixes: none, because
3080 such a list cannot be complete; dynamic creation program:
3083 `TeX system documentation'
3084 (Documentation files for the TeX system) `TEXDOCS'.
3086 `TeX system sources'
3087 (Source files for the TeX system) `TEXSOURCES'.
3090 (Architecture-independent executables distributed in the texmf
3091 tree) `TEXMFSCRIPTS'.
3094 (TeX program strings, *note pooltype invocation: (web2c)pooltype
3095 invocation.) `TEXPOOL', `TEXMFINI'; suffix `.pool'.
3098 (TeX font metrics, *note Metric files: (dvips)Metric files.)
3099 `TFMFONTS', `TEXFONTS'; suffix `.tfm'; dynamic creation program:
3103 (Troff fonts, used by DMP; *note DMP invocation: (web2c)DMP
3104 invocation.) `TRFONTS'.
3107 (TrueType outline fonts) `TTFONTS'; suffixes `.ttf', `.ttc'.
3110 (Type 1 PostScript outline fonts, *note Glyph files: (dvips)Glyph
3111 files.) `T1FONTS', `T1INPUTS', `TEXPSHEADERS', `DVIPSHEADERS';
3112 suffixes `.pfa', `.pfb'.
3115 (Type 42 PostScript outline fonts) `T42FONTS'.
3118 (virtual fonts, *note Virtual fonts: (dvips)Virtual fonts.)
3119 `VFFONTS', `TEXFONTS'; suffix `.vf'.
3122 (WEB input files) `WEBINPUTS'; suffix `.web'; additional suffix
3126 (files specific to the web2c implementation) `WEB2C'.
3128 There are two special cases, because the paths and environment
3129 variables always depend on the name of the program: the variable name is
3130 constructed by converting the program name to upper case, and then
3131 appending `INPUTS'. Assuming the program is called `foo', this gives
3132 us the following table.
3135 (text files used by `foo') `FOOINPUTS'.
3137 `other binary files'
3138 (binary files used by `foo') `FOOINPUTS'.
3140 If an environment variable by these names are set, the corresponding
3141 `texmf.cnf' definition won't be looked at (unless, as usual, the
3142 environment variable value has an extra `:'). *Note Default
3145 For the font variables, the intent is that:
3146 * `TEXFONTS' is the default for everything.
3148 * `GLYPHFONTS' is the default for bitmap (or, more precisely,
3151 * Each font format has a variable of its own.
3153 * Each program has its own font override path as well; e.g.,
3154 `DVIPSFONTS' for Dvipsk. Again, this is for bitmaps, not metrics.
3158 File: kpathsea.info, Node: File lookup, Next: Glyph lookup, Prev: Supported file formats, Up: TeX support
3163 This section describes how Kpathsea searches for most files (bitmap font
3164 searches are the exception, as described in the next section).
3166 Here is the search strategy for a file NAME:
3167 1. If the file format defines default suffixes, and the suffix of
3168 NAME name is not already a known suffix for that format, try the
3169 name with each default appended, and use alternative names found
3170 in the fontmaps if necessary. We postpone searching the disk as
3171 long as possible. Example: given `foo.sty', look for `foo.sty.tex'
3172 before `foo.sty'. This is unfortunate, but allows us to find
3173 `foo.bar.tex' before `foo.bar' if both exist and we were given
3176 2. Search for NAME, and if necessary for alternative names found in
3177 the fontmaps. Again we avoid searching the disk if possible.
3178 Example: given `foo', we look for `foo'.
3180 3. If the file format defines a program to invoke to create missing
3181 files, run it (*note mktex scripts::).
3183 This is implemented in the routine `kpse_find_file' in
3184 `kpathsea/tex-file.c'. You can watch it in action with the debugging
3185 options (*note Debugging::).
3188 File: kpathsea.info, Node: Glyph lookup, Next: Suppressing warnings, Prev: File lookup, Up: TeX support
3193 This section describes how Kpathsea searches for a bitmap font in GF or
3194 PK format (or either) given a font name (e.g., `cmr10') and a
3195 resolution (e.g., 600).
3197 Here is an outline of the search strategy (details in the sections
3198 below) for a file NAME at resolution DPI. The search stops at the
3199 first successful lookup.
3201 1. Look for an existing file NAME.DPIFORMAT in the specified
3204 2. If NAME is an alias for a file F in the fontmap file
3205 `texfonts.map', look for F.DPI.
3207 3. Run an external program (typically named `mktexpk') to generate
3208 the font (*note mktex scripts::)
3210 4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
3211 (typically `cmr10').
3213 This is implemented in `kpse_find_glyph_format' in
3214 `kpathsea/tex-glyph.c'.
3218 * Basic glyph lookup:: Features common to all glyph lookups.
3219 * Fontmap:: Aliases for fonts.
3220 * Fallback font:: Resolutions and fonts of last resort.
3223 File: kpathsea.info, Node: Basic glyph lookup, Next: Fontmap, Up: Glyph lookup
3225 4.3.1 Basic glyph lookup
3226 ------------------------
3228 When Kpathsea looks for a bitmap font NAME at resolution DPI in a
3229 format FORMAT, it first checks each directory in the search path for a
3230 file `NAME.DPIFORMAT'; for example, `cmr10.600pk'. Kpathsea looks for
3231 a PK file first, then a GF file.
3233 If that fails, Kpathsea looks for `dpiDPI/NAME.FORMAT'; for example,
3234 `dpi600/cmr10.pk'. This is how fonts are typically stored on
3235 filesystems (such as DOS) that permit only three-character extensions.
3237 If that fails, Kpathsea looks for a font with a close-enough DPI.
3238 "Close enough" is defined by the macro `KPSE_BITMAP_TOLERANCE' in
3239 `kpathsea/tex-glyph.h' to be `DPI / 500 + 1'. This is slightly more
3240 than the 0.2% minimum allowed by the DVI standard
3241 (`CTAN:/dviware/driv-standard/level-0').
3244 File: kpathsea.info, Node: Fontmap, Next: Fallback font, Prev: Basic glyph lookup, Up: Glyph lookup
3249 If a bitmap font or metric file is not found with the original name (see
3250 the previous section), Kpathsea looks through any "fontmap" files for
3251 an "alias" for the original font name. These files are named
3252 `texfonts.map' and searched for along the `TEXFONTMAPS'
3253 environment/config file variable. All `texfonts.map' files that are
3254 found are read; earlier definitions override later ones.
3256 This feature is intended to help in two respects:
3258 1. An alias name is limited in length only by available memory, not
3259 by your filesystem. Therefore, if you want to ask for
3260 `Times-Roman' instead of `ptmr', you can (you get `ptmr8r').
3262 2. A few fonts have historically had multiple names: specifically,
3263 LaTeX's "circle font" has variously been known as `circle10',
3264 `lcircle10', and `lcirc10'. Aliases can make all the names
3265 equivalent, so that it no longer matters what the name of the
3266 installed file is; TeX documents will find their favorite name.
3269 The format of fontmap files is straightforward:
3271 * Comments start with `%' and continue to the end of the line.
3273 * Blank lines are ignored.
3275 * Each nonblank line is broken up into a series of "words": a
3276 sequence of non-whitespace characters.
3278 * If the first word is `include', the second word is used as a
3279 filename, and it is searched for and read.
3281 * Otherwise, the first word on each line is the true filename;
3283 * the second word is the alias;
3285 * subsequent words are ignored.
3287 If an alias has an extension, it matches only those files with that
3288 extension; otherwise, it matches anything with the same root, regardless
3289 of extension. For example, an alias `foo.tfm' matches only when
3290 `foo.tfm' is being searched for; but an alias `foo' matches `foo.vf',
3293 As an example, here is an excerpt from the `texfonts.map' in the
3294 Web2c distribution. It makes the circle fonts equivalent and includes
3295 automatically generated maps for most PostScript fonts available from
3296 various font suppliers.
3307 include bitstrea.map
3310 Fontmaps are implemented in the file `kpathsea/fontmap.c'. The
3311 Fontname distribution has much more information on font naming (*note
3312 Introduction: (fontname)Introduction.).
3315 File: kpathsea.info, Node: Fallback font, Prev: Fontmap, Up: Glyph lookup
3320 If a bitmap font cannot be found or created at the requested size,
3321 Kpathsea looks for the font at a set of "fallback resolutions". You
3322 specify these resolutions as a colon-separated list (like search paths).
3323 Kpathsea looks first for a program-specific environment variable (e.g.,
3324 `DVIPSSIZES' for Dvipsk), then the environment variable `TEXSIZES',
3325 then a default specified at compilation time (the Make variable
3326 `default_texsizes'). You can set this list to be empty if you prefer
3327 to find fonts at their stated size or not at all.
3329 Finally, if the font cannot be found even at the fallback
3330 resolutions, Kpathsea looks for a fallback font, typically `cmr10'.
3331 Programs must enable this feature by assigning to the global variable
3332 `kpse_fallback_font' or calling `kpse_init_prog' (*note Calling
3333 sequence::); the default is no fallback font.
3336 File: kpathsea.info, Node: Suppressing warnings, Prev: Glyph lookup, Up: TeX support
3338 4.4 Suppressing warnings
3339 ========================
3341 Kpathsea provides a way to suppress selected usually-harmless warnings;
3342 this is useful at large sites where most users are not administrators,
3343 and thus the warnings are merely a source of confusion, not a help. To
3344 do this, you set the environment variable or configuration file value
3345 `TEX_HUSH' to a colon-separated list of values. Here are the
3349 Suppress everything possible.
3352 Suppress mismatched font checksum warnings.
3355 Suppress warnings when a character is missing from a font that a
3356 DVI or VF file tries to typeset.
3359 Don't suppress any warnings.
3362 Suppress warnings about attempts to access a file whose permissions
3363 render it unreadable.
3366 Suppresses warnings about an unimplemented or unparsable
3369 `tex-hush.c' defines the function that checks the variable value. Each
3370 driver implements its own checks where appropriate.
3373 File: kpathsea.info, Node: Programming, Next: Index, Prev: TeX support, Up: Top
3378 This chapter is for programmers who wish to use Kpathsea. *Note
3379 Introduction::, for the conditions under which you may do so.
3383 * Overview: Programming overview. Introduction.
3384 * Calling sequence:: Specifics of what to call.
3385 * Program-specific files:: How to handle these.
3386 * Config: Programming with config files. Getting info from texmf.cnf.
3389 File: kpathsea.info, Node: Programming overview, Next: Calling sequence, Up: Programming
3391 5.1 Programming overview
3392 ========================
3394 Aside from this manual, your best source of information is the source to
3395 the programs I've modified to use Kpathsea (*note Introduction::). Of
3396 those, Dviljk is probably the simplest, and hence a good place to start.
3397 Xdvik adds VF support and the complication of X resources. Dvipsk adds
3398 the complication of its own config files. Web2c is source code I also
3399 maintain, so it uses Kpathsea rather straightforwardly, but is of course
3400 complicated by the Web to C translation. Finally, Kpsewhich is a small
3401 utility program whose sole purpose is to exercise the main
3402 path-searching functionality.
3404 Beyond these examples, the `.h' files in the Kpathsea source
3405 describe the interfaces and functionality (and of course the `.c' files
3406 define the actual routines, which are the ultimate documentation).
3407 `pathsearch.h' declares the basic searching routine. `tex-file.h' and
3408 `tex-glyph.h' define the interfaces for looking up particular kinds of
3409 files. In view of the way the headers depend on each other, it is
3410 recommended to use `#include <kpathsea/kpathsea.h>', which includes
3411 every Kpathsea header.
3413 If you want to include only specific headers, you should still
3414 consider including `kpathsea/config.h' before including any other
3415 Kpathsea header, as it provides symbols used in the other headers.
3416 Note that `kpathsea/config.h' includes `kpathsea/c-auto.h', which is
3417 generated by Autoconf.
3419 The library provides no way for an external program to register new
3420 file types: `tex-file.[ch]' must be modified to do this. For example,
3421 Kpathsea has support for looking up Dvips config files, even though no
3422 program other than Dvips will likely ever want to do so. I felt this
3423 was acceptable, since along with new file types should also come new
3424 defaults in `texmf.cnf' (and its descendant `paths.h'), since it's
3425 simplest for users if they can modify one configuration file for all
3428 Kpathsea does not parse any formats itself; it barely opens any
3429 files. Its primary purpose is to return filenames. The GNU font
3430 utilities does contain libraries to read TFM, GF, and PK files, as do
3431 the programs above, of course.
3434 File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Prev: Programming overview, Up: Programming
3436 5.2 Calling sequence
3437 ====================
3439 The typical way to use Kpathsea in your program goes something like
3442 1. Call `kpse_set_program_name' with `argv[0]' as the first argument;
3443 the second argument is a string or `NULL'. The second argument is
3444 used by Kpathsea as the program name for the `.PROGRAM' feature of
3445 config files (*note Config files::). If the second argument is
3446 `NULL', the value of the first argument is used. This function
3447 must be called before any other use of the Kpathsea library.
3449 If necessary, `kpse_set_program_name' sets the global variables
3450 `program_invocation_name' and `program_invocation_short_name'.
3451 These variables are used in the error message macros defined in
3452 `kpathsea/lib.h'. It sets the global variable `kpse_program_name'
3453 to the program name it uses. It also initializes debugging
3454 options based on the environment variable `KPATHSEA_DEBUG' (if
3455 that is set). Finally, it sets the variables `SELFAUTOLOC',
3456 `SELFAUTODIR' and `SELFAUTOPARENT' to the location, parent and
3457 grandparent directory of the executable, removing `.' and `..'
3458 path elements and resolving symbolic links. These are used in the
3459 default configuration file to allow people to invoke TeX from
3460 anywhere, specifically from a mounted CD-ROM. (You can use
3461 `--expand-var=\$SELFAUTOLOC', etc., to see the values finds.)
3463 2. The `kpse_set_progname' is deprecated. A call to
3464 `kpse_set_progname' with `argv[0]' is equivalent to a call of
3465 `kpse_set_program_name' with first argument `argv[0]' and second
3466 argument `NULL'. The function is deprecated because it cannot
3467 ensure that the `.PROGRAM' feature of config files will always
3468 work (*note Config files::).
3470 3. Set debugging options. *Note Debugging::. If your program doesn't
3471 have a debugging option already, you can define one and set
3472 `kpathsea_debug' to the number that the user supplies (as in Dviljk
3473 and Web2c), or you can just omit this altogether (people can
3474 always set `KPATHSEA_DEBUG'). If you do have runtime debugging
3475 already, you need to merge Kpathsea's options with yours (as in
3478 4. If your program has its own configuration files that can define
3479 search paths, you should assign those paths to the `client_path'
3480 member in the appropriate element of the `kpse_format_info' array.
3481 (This array is indexed by file type; see `tex-file.h'.) See
3482 `resident.c' in Dvipsk for an example.
3484 5. Call `kpse_init_prog' (see `proginit.c'). It's useful for the DVI
3485 drivers, at least, but for other programs it may be simpler to
3486 extract the parts of it that actually apply. This does not
3487 initialize any paths, it just looks for (and sets) certain
3488 environment variables and other random information. (A search
3489 path is always initialized at the first call to find a file of
3490 that type; this eliminates much useless work, e.g., initializing
3491 the BibTeX search paths in a DVI driver.)
3493 6. The routine to actually find a file of type FORMAT is
3494 `kpse_find_FORMAT', defined in `tex-file.h'. These are macros that
3495 expand to a call to `kpse_find_file'. You can call, say,
3496 `kpse_find_tfm' after doing only the first of the initialization
3497 steps above--Kpathsea automatically reads the `texmf.cnf' generic
3498 config files, looks for environment variables, and does expansions
3499 at the first lookup.
3501 7. To find PK and/or GF bitmap fonts, the routines are `kpse_find_pk',
3502 `kpse_find_gf' and `kpse_find_glyph', defined in `tex-glyph.h'.
3503 These return a structure in addition to the resultant filename,
3504 because fonts can be found in so many ways. See the documentation
3507 8. To actually open a file, not just return a filename, call
3508 `kpse_open_file'. This function takes the name to look up and a
3509 Kpathsea file format as arguments, and returns the usual `FILE *'.
3510 It always assumes the file must exist, and thus will search the
3511 disk if necessary (unless the search path specified `!!', etc.).
3512 In other words, if you are looking up a VF or some other file that
3513 need not exist, don't use this.
3516 Kpathsea also provides many utility routines. Some are generic: hash
3517 tables, memory allocation, string concatenation and copying, string
3518 lists, reading input lines of arbitrary length, etc. Others are
3519 filename-related: default path, tilde, and variable expansion, `stat'
3520 calls, etc. (Perhaps someday I'll move the former to a separate
3523 The `c-*.h' header files can also help your program adapt to many
3524 different systems. You will almost certainly want to use Autoconf for
3525 configuring your software if you use Kpathsea; I strongly recommend
3526 using Autoconf regardless. It is available from
3527 `ftp://prep.ai.mit.edu/pub/gnu/'.
3530 File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Calling sequence, Up: Programming
3532 5.3 Program-specific files
3533 ==========================
3535 Many programs will need to find some configuration files. Kpathsea
3536 contains some support to make it easy to place them in their own
3537 directories. The Standard TeX directory structure (*note Introduction:
3538 (tds)Top.), specifies that such files should go into a subdirectory
3539 named after the program, like `texmf/ttf2pk'.
3541 Two special formats, `kpse_program_text_format' and
3542 `kpse_program_binary_format' exist, which use `.:$TEXMF/PROGRAM//' as
3543 their compiled-in search path. To override this default, you can use
3544 the variable `PROGRAMINPUTS' in the environment and/or `texmf.cnf'.
3545 That is to say, the name of the variable is constructed by converting
3546 the name of the program to upper case, and appending `INPUTS'.
3548 The only difference between these two formats is whether
3549 `kpse_open_file' will open the files it finds in text or binary mode.
3552 File: kpathsea.info, Node: Programming with config files, Prev: Program-specific files, Up: Programming
3554 5.4 Programming with config files
3555 =================================
3557 You can (and probably should) use the same `texmf.cnf' configuration
3558 file that Kpathsea uses for your program. This helps installers by
3559 keeping all configuration in one place.
3561 To retrieve a value VAR from config files, the best way is to call
3562 `kpse_var_value' on the string `VAR'. This will look first for an
3563 environment variable VAR, then a config file value. The result will be
3564 the value found or `NULL'. This function is declared in
3565 `kpathsea/variable.h'. For an example, see the `shell_escape' code in
3566 `web2c/lib/texmfmp.c'.
3568 The routine to do variable expansion in the context of a search path
3569 (as opposed to simply retrieving a value) is `kpse_var_expand', also
3570 declared in `kpathsea/variable.h'. It's generally only necessary to
3571 set the search path structure components as explained in the previous
3572 section, rather than using this yourself.
3574 If for some reason you want to retrieve a value _only_ from a config
3575 file, not automatically looking for a corresponding environment
3576 variable, call `kpse_cnf_get' (declared in `kpathsea/cnf.h') with the
3579 No initialization calls are needed.
3582 File: kpathsea.info, Node: Index, Prev: Programming, Up: Top
3590 * !! in path specifications: ls-R. (line 52)
3591 * $ expansion: Variable expansion. (line 6)
3592 * --all: Path searching options.
3594 * --color=tty: ls-R. (line 21)
3595 * --debug=NUM: Auxiliary tasks. (line 9)
3596 * --disable-static: configure options. (line 31)
3597 * --dpi=NUM: Path searching options.
3599 * --enable options: configure options. (line 16)
3600 * --enable-maintainer-mode: configure options. (line 34)
3601 * --enable-shared <1>: Shared library. (line 6)
3602 * --enable-shared: configure options. (line 27)
3603 * --engine=NAME: Path searching options.
3605 * --expand-braces=STRING: Auxiliary tasks. (line 16)
3606 * --expand-path=STRING: Auxiliary tasks. (line 24)
3607 * --expand-var=STRING: Auxiliary tasks. (line 19)
3608 * --format=NAME: Path searching options.
3610 * --help: Standard options. (line 8)
3611 * --interactive: Path searching options.
3613 * --mode=STRING: Path searching options.
3615 * --must-exist: Path searching options.
3617 * --path=STRING: Path searching options.
3619 * --progname=NAME: Path searching options.
3621 * --show-path=NAME: Auxiliary tasks. (line 41)
3622 * --srcdir, for building multiple architectures: configure scenarios.
3624 * --subdir=STRING: Path searching options.
3626 * --var-value=VARIABLE: Auxiliary tasks. (line 12)
3627 * --version: Standard options. (line 10)
3628 * --with options: configure options. (line 16)
3629 * --with-mktextex-default: mktex configuration. (line 12)
3630 * --without-mktexfmt-default: mktex configuration. (line 12)
3631 * --without-mktexmf-default: mktex configuration. (line 12)
3632 * --without-mktexocp-default: mktex configuration. (line 12)
3633 * --without-mktexofm-default: mktex configuration. (line 12)
3634 * --without-mktexpk-default: mktex configuration. (line 12)
3635 * --without-mktextfm-default: mktex configuration. (line 12)
3636 * -1 debugging value: Debugging. (line 23)
3637 * -A option to ls: ls-R. (line 33)
3638 * -Bdynamic: ShellWidgetClass. (line 45)
3639 * -Bstatic: ShellWidgetClass. (line 45)
3640 * -D NUM: Path searching options.
3642 * -dynamic: ShellWidgetClass. (line 43)
3643 * -g, compiling without: configure scenarios. (line 32)
3644 * -L option to ls: ls-R. (line 38)
3645 * -mktex=FILETYPE: Path searching options.
3647 * -no-mktex=FILETYPE: Path searching options.
3649 * -O, compiling with: configure scenarios. (line 32)
3650 * -static: ShellWidgetClass. (line 43)
3651 * . directories, ignored: ls-R. (line 33)
3652 * . files: ls-R. (line 33)
3653 * .2602gf: Unable to generate fonts.
3655 * .afm: Supported file formats.
3657 * .base: Supported file formats.
3659 * .bib: Supported file formats.
3661 * .bst: Supported file formats.
3663 * .cmap: Supported file formats.
3665 * .cnf: Supported file formats.
3667 * .enc: Supported file formats.
3669 * .eps: Supported file formats.
3671 * .epsi: Supported file formats.
3673 * .fmt: Supported file formats.
3675 * .ist: Supported file formats.
3677 * .lig: Supported file formats.
3679 * .map: Supported file formats.
3681 * .mem: Supported file formats.
3683 * .mf: Supported file formats.
3685 * .mft: Supported file formats.
3687 * .mp: Supported file formats.
3689 * .ocp: Supported file formats.
3691 * .ofm: Supported file formats.
3693 * .opl: Supported file formats.
3695 * .otp: Supported file formats.
3697 * .ovf: Supported file formats.
3699 * .ovp: Supported file formats.
3701 * .pfa: Supported file formats.
3703 * .pfb: Supported file formats.
3705 * .pk: Supported file formats.
3707 * .pool: Supported file formats.
3709 * .pro: Supported file formats.
3711 * .rhosts, writable by TeX: Security. (line 10)
3712 * .sfd: Supported file formats.
3714 * .tex: Supported file formats.
3716 * .tex file, included in ls-R: ls-R. (line 33)
3717 * .tfm: Supported file formats.
3719 * .ttc: Supported file formats.
3721 * .ttf: Supported file formats.
3723 * .vf: Supported file formats.
3725 * .w: Supported file formats.
3727 * .web: Supported file formats.
3729 * / may not be /: Searching overview. (line 13)
3730 * /, trailing in home directory: Tilde expansion. (line 19)
3731 * //: Subdirectory expansion.
3733 * /afs/... , installing into: Installing files. (line 32)
3734 * /etc/profile: Unable to find files.
3736 * /etc/profile and aliases: ls-R. (line 21)
3737 * /var/tmp/texfonts: mktex configuration. (line 114)
3738 * 2602gf: Unable to generate fonts.
3740 * 8.3 filenames, using: mktex configuration. (line 69)
3741 * : may not be :: Searching overview. (line 13)
3742 * :: expansion: Default expansion. (line 6)
3743 * @VAR@ substitutions: Running configure. (line 6)
3744 * \, line continuation in texmf.cnf: Config files. (line 26)
3745 * \openin: Searching overview. (line 31)
3746 * \special, suppressing warnings about: Suppressing warnings.
3748 * absolute filenames: Searching overview. (line 52)
3749 * ac_include, Autoconf extension: Running configure. (line 6)
3750 * access warnings: Searching overview. (line 56)
3751 * Acorn TeX implementations: Other TeX packages. (line 6)
3752 * AFMFONTS: Supported file formats.
3754 * AFS: Installing files. (line 32)
3755 * AIX 4.1 configure error: Empty Makefiles. (line 6)
3756 * AIX shells and configure: configure shells. (line 14)
3757 * aliases for fonts: Fontmap. (line 6)
3758 * aliases, for filenames: Filename aliases. (line 6)
3759 * all: Suppressing warnings.
3761 * all matches, finding: Path searching options.
3763 * alphabetical order, not: Subdirectory expansion.
3765 * Amiga support: Custom installation. (line 19)
3766 * Amiga TeX implementations: Other TeX packages. (line 6)
3767 * Andrew File System, installing with: Installing files. (line 32)
3768 * announcement mailing list: Mailing lists. (line 6)
3769 * ANSI C: TeX or Metafont failing.
3771 * append-only directories and mktexpk: Security. (line 36)
3772 * appendonlydir: mktex configuration. (line 61)
3773 * architecture-(in)dependent files, installing only: Installing files.
3775 * architectures, compiling multiple: configure scenarios. (line 18)
3776 * arguments to mktex: mktex script arguments.
3778 * argv[0]: Calling sequence. (line 9)
3779 * ash, losing with configure: configure shells. (line 19)
3780 * autoconf, recommended: Calling sequence. (line 90)
3781 * automounter, and configuration: configure scenarios. (line 29)
3782 * automounter, and ls-R: ls-R. (line 40)
3783 * auxiliary tasks: Auxiliary tasks. (line 6)
3784 * Babel <1>: Running make. (line 51)
3785 * Babel: Kpathsea application distributions.
3787 * Bach, Johann Sebastian: Default expansion. (line 41)
3788 * backbone of CTAN: Electronic distribution.
3790 * backslash-newline: Config files. (line 26)
3791 * bash, recommended for running configure: configure shells. (line 6)
3792 * basic glyph lookup: Basic glyph lookup. (line 6)
3793 * Berry, Karl: History. (line 12)
3794 * BIBINPUTS: Supported file formats.
3796 * binary mode, for file transfers: Electronic distribution.
3798 * blank lines, in texmf.cnf: Config files. (line 24)
3799 * brace expansion: Brace expansion. (line 6)
3800 * BSD universe: Running make. (line 44)
3801 * bsh, ok with configure: configure shells. (line 14)
3802 * BSTINPUTS: Supported file formats.
3804 * bug address: Reporting bugs. (line 8)
3805 * bug checklist: Bug checklist. (line 6)
3806 * bug mailing list: Mailing lists. (line 6)
3807 * bugs, reporting: Reporting bugs. (line 6)
3808 * c-*.h: Calling sequence. (line 90)
3809 * c-auto.h: Programming overview.
3811 * c-auto.in: Running configure. (line 6)
3812 * cache of fonts, local: Security. (line 22)
3813 * calling sequence: Calling sequence. (line 6)
3814 * CC: configure environment.
3816 * cc warnings: Pointer combination warnings.
3818 * cc, compiling with: configure environment.
3820 * CD-ROM distributions: CD-ROM distribution. (line 6)
3821 * CFLAGS: configure environment.
3823 * ChangeLog entry: Bug checklist. (line 56)
3824 * checklist for bug reports: Bug checklist. (line 6)
3825 * checksum: Suppressing warnings.
3827 * circle fonts: Fontmap. (line 19)
3828 * clean Make target: Cleaning up. (line 15)
3829 * client_path in kpse_format_info: Calling sequence. (line 45)
3830 * CMAPFONTS: Supported file formats.
3832 * cmr10, as fallback font: Fallback font. (line 15)
3833 * cmr10.vf: Searching overview. (line 31)
3834 * cnf.c: Config files. (line 75)
3835 * cnf.h: Programming with config files.
3837 * code sharing: Shared library. (line 9)
3838 * color printers, configuring: Simple installation. (line 60)
3839 * comments, in fontmap files: Fontmap. (line 28)
3840 * comments, in texmf.cnf: Config files. (line 22)
3841 * comments, making: Introduction. (line 27)
3842 * common features in glyph lookup: Basic glyph lookup. (line 6)
3843 * common problems: Common problems. (line 6)
3844 * comp.sys.sun.admin FAQ: ShellWidgetClass. (line 6)
3845 * comp.text.tex: Mailing lists. (line 29)
3846 * compilation: Installation. (line 6)
3847 * compilation value, source for path: Path sources. (line 20)
3848 * compiler bugs: TeX or Metafont failing.
3850 * compiler bugs, finding: TeX or Metafont failing.
3852 * compiler options, additional: Running make. (line 27)
3853 * compiler options, specifying: configure environment.
3855 * compiler, changing: Running make. (line 40)
3856 * compiling on HP-UX: TeX or Metafont failing.
3858 * conditions for use: Introduction. (line 31)
3859 * config files: Config files. (line 6)
3860 * config files, for Kpathsea-using programs: Calling sequence.
3862 * config files, programming with: Programming with config files.
3864 * config.h: Programming overview.
3866 * config.log: Bug checklist. (line 28)
3867 * config.ps: Path searching options.
3869 * config.ps, search path for: Supported file formats.
3871 * config.status: Bug checklist. (line 31)
3872 * configuration: Installation. (line 6)
3873 * configuration bugs: Bug checklist. (line 31)
3874 * configuration compiler options: configure environment.
3876 * configuration file, source for path: Path sources. (line 17)
3877 * configuration files as shell scripts.: Config files. (line 67)
3878 * configuration of mktex scripts: mktex configuration. (line 6)
3879 * configuration of optional features: configure options. (line 16)
3880 * configure error from sed: Empty Makefiles. (line 6)
3881 * configure options: configure options. (line 6)
3882 * configure options for mktex scripts: mktex configuration. (line 12)
3883 * configure, running: Running configure. (line 6)
3884 * context diff: Bug checklist. (line 56)
3885 * continuation character: Config files. (line 26)
3886 * core dumps, reporting: Bug checklist. (line 62)
3887 * CPPFLAGS: configure environment.
3889 * crashes, reporting: Bug checklist. (line 62)
3890 * CTAN, defined: Electronic distribution.
3892 * CTAN.sites: Electronic distribution.
3894 * custom installation: Custom installation. (line 6)
3895 * CWEBINPUTS: Supported file formats.
3897 * database search: Searching overview. (line 17)
3898 * database, for filenames: Filename database. (line 6)
3899 * database, format of: Database format. (line 6)
3900 * debug.h: Debugging. (line 6)
3901 * debugger: Bug checklist. (line 62)
3902 * debugging: Debugging. (line 6)
3903 * debugging options, in Kpathsea-using program: Calling sequence.
3905 * debugging output: Debugging. (line 27)
3906 * debugging with -g, disabling: configure scenarios. (line 32)
3907 * DEC shells and configure: configure shells. (line 25)
3908 * default expansion: Default expansion. (line 6)
3909 * default path features: Default path features.
3911 * default paths, changing: Default path generation.
3913 * default paths, how they're made: Default path generation.
3915 * default_texsizes: Fallback font. (line 6)
3916 * DEFS: configure environment.
3918 * depot: configure scenarios. (line 29)
3919 * device, wrong: Unable to generate fonts.
3921 * directories, changing default installation: Default path generation.
3923 * directories, making append-only: mktex configuration. (line 62)
3924 * directory permissions: Security. (line 51)
3925 * directory structure, for TeX files: TeX directory structure.
3927 * disabling mktex scripts: mktex configuration. (line 6)
3928 * disk search: Searching overview. (line 22)
3929 * disk searching, avoiding: ls-R. (line 52)
3930 * disk space, needed: Disk space. (line 6)
3931 * disk usage, reducing: Logging. (line 6)
3932 * distclean Make target: Cleaning up. (line 6)
3933 * distributions, compiling simultaneously: Kpathsea application distributions.
3935 * distributions, not compiling: Kpathsea application distributions.
3937 * distributions, on CD-ROM: CD-ROM distribution. (line 6)
3938 * distributions, via ftp: Electronic distribution.
3940 * dlclose: dlopen. (line 6)
3941 * dlopen: dlopen. (line 6)
3942 * dlsym: dlopen. (line 6)
3943 * dlsym.c: dlopen. (line 21)
3944 * doc files: Supported file formats.
3946 * DOS compatible names: mktex configuration. (line 69)
3947 * DOS support: Custom installation. (line 19)
3948 * DOS TeX implementations: Other TeX packages. (line 6)
3949 * dosnames: mktex configuration. (line 68)
3950 * dot files: ls-R. (line 33)
3951 * doubled colons: Default expansion. (line 6)
3952 * dpiNNN directories: mktex configuration. (line 69)
3953 * DVI drivers: Kpathsea application distributions.
3955 * DVILJMAKEPK: mktex script names. (line 32)
3956 * DVILJSIZES: Fallback font. (line 6)
3957 * DVIPSFONTS: Supported file formats.
3959 * DVIPSHEADERS: Supported file formats.
3961 * DVIPSMAKEPK: mktex script names. (line 32)
3962 * DVIPSSIZES: Fallback font. (line 6)
3963 * dynamic creation of files: mktex scripts. (line 6)
3964 * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
3966 * EC fonts, and dynamic source creation: mktex scripts. (line 6)
3967 * elt-dirs.c: Subdirectory expansion.
3969 * email CTAN access: Electronic distribution.
3971 * enabling mktex scripts: mktex configuration. (line 6)
3972 * ENCFONTS: Supported file formats.
3974 * engine name: Path searching options.
3976 * environment variable, source for path: Path sources. (line 9)
3977 * environment variables for TeX: Supported file formats.
3979 * environment variables in paths: Variable expansion. (line 6)
3980 * environment variables, old: Unable to find files.
3982 * epoch, seconds since: Logging. (line 15)
3983 * error message macros: Calling sequence. (line 16)
3984 * excessive startup time: Slow path searching. (line 6)
3985 * expand.c: Brace expansion. (line 26)
3986 * expanding symlinks: Calling sequence. (line 16)
3987 * expansion, default: Default expansion. (line 6)
3988 * expansion, path element: Searching overview. (line 43)
3989 * expansion, search path: Path expansion. (line 6)
3990 * expansion, subdirectory: Subdirectory expansion.
3992 * expansion, tilde: Tilde expansion. (line 6)
3993 * expansion, variable: Variable expansion. (line 6)
3994 * explicitly relative filenames: Searching overview. (line 52)
3995 * externally-built filename database: Filename database. (line 6)
3996 * extra colons: Default expansion. (line 6)
3997 * extraclean Make target: Cleaning up. (line 23)
3998 * failed mktex... script invocation: mktex script names. (line 35)
3999 * fallback font: Fallback font. (line 6)
4000 * fallback resolutions: Fallback font. (line 6)
4001 * fallback resolutions, overriding: Running make. (line 10)
4002 * FAQ, comp.sys.sun.admin: ShellWidgetClass. (line 6)
4003 * FAQ, Kpathsea: Common problems. (line 6)
4004 * Farwell, Matthew: Subdirectory expansion.
4006 * features, of default paths: Default path features.
4008 * file formats, supported: Supported file formats.
4010 * file lookup: File lookup. (line 6)
4011 * file permissions: Security. (line 47)
4012 * file types, registering new: Programming overview.
4014 * filename aliases: Filename aliases. (line 6)
4015 * filename database: Filename database. (line 6)
4016 * filename database generation: Filename database generation.
4018 * filenames, absolute or explicitly relative: Searching overview.
4020 * files, unable to find: Unable to find files.
4022 * filesystem search: Searching overview. (line 22)
4023 * floating directories: Searching overview. (line 22)
4024 * fmtutil: mktex script names. (line 10)
4025 * fmtutils.cnf: mktex configuration. (line 24)
4026 * font alias files: Fontmap. (line 6)
4027 * font generation failures: Unable to generate fonts.
4029 * font of last resort: Fallback font. (line 6)
4030 * font set, infinite: mktex scripts. (line 6)
4031 * fontmap files: Fontmap. (line 6)
4032 * fontmaps: mktex configuration. (line 87)
4033 * fontname: mktex configuration. (line 88)
4034 * fontnames, arbitrary length: Fontmap. (line 15)
4035 * fonts, being created: Simple installation. (line 79)
4036 * FOOINPUTS: Supported file formats.
4038 * fopen, redefined: Debugging. (line 54)
4039 * format of external database: Database format. (line 6)
4040 * Free Software Foundation: CD-ROM distribution. (line 12)
4041 * FreeBSD configure error: Empty Makefiles. (line 6)
4042 * FreeBSD shells and configure: configure shells. (line 19)
4043 * FSF Source Code CD-ROM: CD-ROM distribution. (line 12)
4044 * ftp retrieval: Electronic distribution.
4046 * ftp.tug.org: unixtex.ftp. (line 6)
4047 * fundamental purpose of Kpathsea: Introduction. (line 6)
4048 * gcc, compiling with: configure environment.
4050 * gdb, recommended: Bug checklist. (line 62)
4051 * generation of filename database: Filename database generation.
4053 * get_applicationShellWidgetClass: ShellWidgetClass. (line 6)
4054 * get_wmShellWidgetClass: ShellWidgetClass. (line 6)
4055 * gf: Supported file formats.
4057 * GFFONTS: Supported file formats.
4059 * globally writable directories: Security. (line 30)
4060 * glyph lookup: Glyph lookup. (line 6)
4061 * glyph lookup bitmap tolerance: Basic glyph lookup. (line 15)
4062 * GLYPHFONTS: Supported file formats.
4064 * GNU C compiler bugs: TeX or Metafont failing.
4066 * GNU General Public License: Introduction. (line 31)
4067 * group-writable directories: Security. (line 40)
4068 * GSFTOPK_DEBUG (128): Debugging. (line 88)
4069 * hash table buckets, printing: Debugging. (line 105)
4070 * hash table routines: Calling sequence. (line 83)
4071 * hash_summary_only variable for debugging: Debugging. (line 105)
4072 * help, mailing list for general TeX: Mailing lists. (line 29)
4073 * HIER: Default path features.
4075 * history of Kpathsea: History. (line 6)
4076 * home directories in paths: Tilde expansion. (line 6)
4077 * HOME, as ~ expansion: Tilde expansion. (line 6)
4078 * HP-UX, compiling on: TeX or Metafont failing.
4080 * identifiers, characters valid in: Config files. (line 36)
4081 * illegal pointer combination warnings: Pointer combination warnings.
4083 * include fontmap directive: Fontmap. (line 33)
4084 * INDEXSTYLE: Supported file formats.
4086 * info-tex@shsu.edu: Mailing lists. (line 29)
4087 * input lines, reading: Calling sequence. (line 83)
4088 * install-data Make target: Installing files. (line 28)
4089 * install-exec Make target: Installing files. (line 23)
4090 * installation: Installation. (line 6)
4091 * installation testing: Installation testing.
4093 * installation, architecture-(in)dependent files only: Installing files.
4095 * installation, changing default directories: Default path generation.
4097 * installation, customized: Custom installation. (line 6)
4098 * installation, getting executables instead of: Simple installation.
4100 * installation, simple: Simple installation. (line 6)
4101 * installing files: Installing files. (line 6)
4102 * interactive query: Path searching options.
4104 * interface, not frozen: Introduction. (line 27)
4105 * introduction: Introduction. (line 6)
4106 * kdebug:: Debugging. (line 105)
4107 * kdefault.c: Default expansion. (line 48)
4108 * Knuth, Donald E.: History. (line 6)
4109 * Knuth, Donald E., archive of programs by: Other TeX packages.
4111 * Knuth, Donald E., original author: Electronic distribution.
4113 * Korn shell, losing with configure: configure shells. (line 14)
4114 * Kpathsea config file, source for path: Path sources. (line 17)
4115 * Kpathsea version number: Kpathsea application distributions.
4117 * kpathsea.h: Programming overview.
4119 * kpathsea/HIER: Default path features.
4121 * kpathsea/README.CONFIGURE: Running configure. (line 15)
4122 * KPATHSEA_DEBUG: Calling sequence. (line 16)
4123 * kpathsea_debug: Debugging. (line 18)
4124 * KPATHSEA_DEBUG: Debugging. (line 18)
4125 * kpathsea_debug: Debugging. (line 6)
4126 * kpathsea_debug variable: Calling sequence. (line 37)
4127 * KPSE_BITMAP_TOLERANCE: Basic glyph lookup. (line 15)
4128 * kpse_cnf_get: Programming with config files.
4130 * KPSE_DEBUG_EXPAND (16): Debugging. (line 68)
4131 * KPSE_DEBUG_FOPEN (4): Debugging. (line 53)
4132 * KPSE_DEBUG_HASH (2): Debugging. (line 46)
4133 * KPSE_DEBUG_PATHS (8): Debugging. (line 60)
4134 * KPSE_DEBUG_SEARCH (32): Debugging. (line 74)
4135 * KPSE_DEBUG_STAT (1): Debugging. (line 38)
4136 * KPSE_DEBUG_VARS (64): Debugging. (line 83)
4137 * KPSE_DOT expansion: KPSE_DOT expansion. (line 6)
4138 * kpse_fallback_font: Fallback font. (line 15)
4139 * kpse_find_*: Calling sequence. (line 60)
4140 * kpse_find_file <1>: Calling sequence. (line 60)
4141 * kpse_find_file: File lookup. (line 26)
4142 * kpse_find_glyph_format: Glyph lookup. (line 26)
4143 * kpse_format_info: Calling sequence. (line 45)
4144 * kpse_format_info_type: Debugging. (line 61)
4145 * kpse_init_prog: Calling sequence. (line 51)
4146 * kpse_init_prog, and MAKETEX_MODE: Default path features.
4148 * kpse_open_file: Calling sequence. (line 74)
4149 * kpse_program_name: Calling sequence. (line 16)
4150 * kpse_set_progname: Calling sequence. (line 30)
4151 * kpse_set_program_name: Calling sequence. (line 9)
4152 * kpse_var_value: Programming with config files.
4154 * kpsewhich: Invoking kpsewhich. (line 6)
4155 * Kpsewhich, and debugging: Debugging. (line 31)
4156 * ksh, losing with configure: configure shells. (line 14)
4157 * labrea.stanford.edu: Other TeX packages. (line 18)
4158 * LaserJet drive: Kpathsea application distributions.
4160 * last-resort font: Fallback font. (line 6)
4161 * LaTeX help mailing list: Mailing lists. (line 29)
4162 * lcircle10: Fontmap. (line 19)
4163 * LDFLAGS: configure environment.
4165 * leading colons: Default expansion. (line 6)
4166 * leaf directories wrongly guessed: Unable to find files.
4168 * leaf directory trick: Subdirectory expansion.
4170 * libdl.a: dlopen. (line 6)
4171 * libraries, changing: Running make. (line 40)
4172 * libraries, specifying additional: configure environment.
4174 * LIBS: configure environment.
4176 * libucb, avoiding: Running make. (line 44)
4177 * license for using the library: Introduction. (line 31)
4178 * LIGFONTS: Supported file formats.
4180 * lines, reading arbitrary-length: Calling sequence. (line 83)
4181 * Linux File System Standard: mktex configuration. (line 114)
4182 * Linux shells and configure: configure shells. (line 19)
4183 * Linux, using Web2c: CD-ROM distribution. (line 16)
4184 * lndir for building symlink trees: configure scenarios. (line 18)
4185 * loader options: configure environment.
4187 * loader options, final: Running make. (line 33)
4188 * loader options, initial: Running make. (line 30)
4189 * local cache of fonts: Security. (line 22)
4190 * log file: Logging. (line 6)
4191 * logging successful searches: Logging. (line 6)
4192 * lost+found directory: Searching overview. (line 56)
4193 * lostchar: Suppressing warnings.
4195 * ls-R: Supported file formats.
4197 * ls-R and AFS: Installing files. (line 40)
4198 * ls-R database file: ls-R. (line 6)
4199 * ls-R, simplest build: ls-R. (line 18)
4200 * Mach10 configure error: Empty Makefiles. (line 6)
4201 * Macintosh TeX implementations: Other TeX packages. (line 6)
4202 * MacKenzie, David <1>: Subdirectory expansion.
4204 * MacKenzie, David: History. (line 45)
4205 * magic characters: Searching overview. (line 13)
4206 * mailing lists: Mailing lists. (line 6)
4207 * maintainer-clean Make target: Cleaning up. (line 18)
4208 * Make arguments, additional: Running make. (line 36)
4209 * make, running: Running make. (line 6)
4210 * Makefile.in: Running configure. (line 6)
4211 * Makefiles, empty: Empty Makefiles. (line 6)
4212 * MAKETEX_DEBUG (512): Debugging. (line 91)
4213 * MAKETEX_FINE_DEBUG (1024): Debugging. (line 100)
4214 * MAKETEX_MODE: Default path features.
4216 * memory allocation routines: Calling sequence. (line 83)
4217 * metafont driver files: mktex configuration. (line 94)
4218 * Metafont failures: TeX or Metafont failing.
4220 * Metafont installation: Unable to generate fonts.
4222 * Metafont making too-large fonts: Unable to generate fonts.
4224 * Metafont using the wrong device: Unable to generate fonts.
4226 * MFBASES: Supported file formats.
4228 * MFINPUTS: Supported file formats.
4230 * MFPOOL: Supported file formats.
4232 * MFTINPUTS: Supported file formats.
4234 * mirrors, FTP: Electronic distribution.
4236 * MISCFONTS: Supported file formats.
4238 * mismatched checksum warnings: Suppressing warnings.
4240 * missfont.log: mktex script names. (line 35)
4241 * MISSFONT_LOG: mktex script names. (line 40)
4242 * missing character warnings: Suppressing warnings.
4244 * mkocp: mktex script names. (line 18)
4245 * mkofm: mktex script names. (line 21)
4246 * mktex script configuration: mktex configuration. (line 6)
4247 * mktex script names: mktex script names. (line 6)
4248 * mktex scripts: mktex scripts. (line 6)
4249 * mktex.cnf: mktex configuration. (line 29)
4250 * mktex.opt: mktex configuration. (line 29)
4251 * mktexdir: mktex configuration. (line 62)
4252 * mktexfmt: mktex script names. (line 10)
4253 * mktexmf: mktex script names. (line 15)
4254 * mktexpk: mktex script names. (line 24)
4255 * mktexpk , initial runs: Simple installation. (line 79)
4256 * mktexpk can't guess mode: Unable to generate fonts.
4258 * mktextex: mktex script names. (line 27)
4259 * mktextfm: mktex script names. (line 30)
4260 * mode directory, omitting: mktex configuration. (line 99)
4261 * Morgan, Tim: History. (line 12)
4262 * mostlyclean Make target: Cleaning up. (line 10)
4263 * MPINPUTS: Supported file formats.
4265 * MPMEMS: Supported file formats.
4267 * MPPOOL: Supported file formats.
4269 * MPSUPPORT: Supported file formats.
4271 * MT_FEATURES: mktex configuration. (line 40)
4272 * multiple architectures, compiling on: configure scenarios. (line 18)
4273 * multiple architectures, directories for: configure scenarios.
4275 * multiple architectures, installing on: Installing files. (line 21)
4276 * multiple TeX hierarchies: Brace expansion. (line 20)
4277 * must exist: Searching overview. (line 31)
4278 * names for mktex scripts: mktex script names. (line 6)
4279 * NetBSD configure error: Empty Makefiles. (line 6)
4280 * NetBSD shells and configure: configure shells. (line 19)
4281 * Neumann, Gustaf: History. (line 57)
4282 * newsgroup for TeX: Mailing lists. (line 29)
4283 * NeXT sed error: Empty Makefiles. (line 6)
4284 * NeXT, lacking X11: Kpathsea application distributions.
4286 * NFS and ls-R: ls-R. (line 40)
4287 * NFS CTAN access: Electronic distribution.
4289 * nomfdrivers: mktex configuration. (line 93)
4290 * nomode: mktex configuration. (line 98)
4291 * non-English typesetting: Kpathsea application distributions.
4293 * non-Unix operating systems: Custom installation. (line 19)
4294 * none: Suppressing warnings.
4296 * null pointers, dereferencing: Bug checklist. (line 62)
4297 * numeric debugging values: Debugging. (line 34)
4298 * obtaining TeX: unixtex.ftp. (line 6)
4299 * obtaining Web2c by ftp: Electronic distribution.
4301 * obtaining Web2c on CD-ROM: CD-ROM distribution. (line 6)
4302 * OCPINPUTS: Supported file formats.
4304 * OFMFONTS: Supported file formats.
4306 * online Metafont display, spurious: Unable to generate fonts.
4308 * OPENTYPEFONTS: Supported file formats.
4310 * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
4312 * optimization caveat: TeX or Metafont failing.
4314 * optimization, enabling: configure scenarios. (line 32)
4315 * options for debugging: Debugging. (line 6)
4316 * options to configure: configure options. (line 16)
4317 * OS/2 support: Custom installation. (line 19)
4318 * other TeX distributions: Other TeX packages. (line 6)
4319 * OTPINPUTS: Supported file formats.
4321 * overview of path searching: Searching overview. (line 6)
4322 * overview of programming with Kpathsea: Programming overview.
4324 * OVFFONTS: Supported file formats.
4326 * OVPFONTS: Supported file formats.
4328 * patches, Sun OpenWin: ShellWidgetClass. (line 29)
4329 * path expansion: Path expansion. (line 6)
4330 * path searching: Path searching. (line 6)
4331 * path searching options: Path searching options.
4333 * path searching, overview: Searching overview. (line 6)
4334 * path searching, standalone: Invoking kpsewhich. (line 6)
4335 * path sources: Path sources. (line 6)
4336 * paths, changing default <1>: Default path generation.
4338 * paths, changing default: Changing search paths.
4340 * paths, device name included in: Default path features.
4342 * paths.h: Default path generation.
4344 * paths.h, creating: Running make. (line 6)
4345 * pathsearch.h: Programming overview.
4347 * pc Pascal compiler: History. (line 12)
4348 * PCL driver: Kpathsea application distributions.
4350 * PDF generation: Kpathsea application distributions.
4352 * pdftex.cfg: Path searching options.
4354 * PDFTEXCONFIG: Supported file formats.
4356 * pdftexconfig.tex: Path searching options.
4358 * permission denied: Searching overview. (line 56)
4359 * permissions, directory: Security. (line 51)
4360 * permissions, file: Security. (line 47)
4361 * PKFONTS: Supported file formats.
4363 * plain.base: Unable to generate fonts.
4365 * pointer combination warnings: Pointer combination warnings.
4367 * PostScript driver: Kpathsea application distributions.
4369 * PostScript fonts, additional: Simple installation. (line 60)
4370 * precompiled executables, instead of installation: Simple installation.
4372 * precompiled Unix binaries: Other TeX packages. (line 13)
4373 * preprocessor options: configure environment.
4375 * preprocessor options, additional: Running make. (line 24)
4376 * printer configuration files: Simple installation. (line 60)
4377 * privacy, semblance of: Logging. (line 32)
4378 * problems, common: Common problems. (line 6)
4379 * proginit.c: Default path features.
4381 * proginit.h: Calling sequence. (line 51)
4382 * program-varying paths: Supported file formats.
4384 * program_invocation_name: Calling sequence. (line 16)
4385 * program_invocation_short_name: Calling sequence. (line 16)
4386 * programming overview: Programming overview.
4388 * programming with config files: Programming with config files.
4390 * programming with Kpathsea: Calling sequence. (line 6)
4391 * programs using the library: Introduction. (line 13)
4392 * proof mode: Unable to generate fonts.
4394 * PSHEADERS: Supported file formats.
4396 * pxp Pascal preprocessor: History. (line 12)
4397 * quoting variable values: Variable expansion. (line 17)
4398 * readable: Suppressing warnings.
4400 * reading arbitrary-length lines: Calling sequence. (line 83)
4401 * README.CONFIGURE: Running configure. (line 15)
4402 * README.mirrors: Electronic distribution.
4404 * recording successful searches: Logging. (line 6)
4405 * relative filenames: Searching overview. (line 52)
4406 * relative filenames in ls-R: Installing files. (line 40)
4407 * reporting bugs: Reporting bugs. (line 6)
4408 * resident.c: Calling sequence. (line 45)
4409 * resolution, setting: Path searching options.
4411 * resolutions, last-resort: Fallback font. (line 6)
4412 * retrieving TeX: unixtex.ftp. (line 6)
4413 * right-hand side of variable assignments: Config files. (line 44)
4414 * Rokicki, Tom: History. (line 12)
4415 * root user: Tilde expansion. (line 19)
4416 * runtime configuration files: Config files. (line 6)
4417 * runtime debugging: Debugging. (line 6)
4418 * Sauter fonts, and dynamic source creation: mktex scripts. (line 6)
4419 * scripts for file creation: mktex scripts. (line 6)
4420 * search path, defined: Searching overview. (line 6)
4421 * search paths, changing default: Changing search paths.
4423 * searching for files: File lookup. (line 6)
4424 * searching for glyphs: Glyph lookup. (line 6)
4425 * searching overview: Searching overview. (line 6)
4426 * searching the database: Searching overview. (line 17)
4427 * searching the disk: Searching overview. (line 22)
4428 * security considerations: Security. (line 6)
4429 * sed error from configure: Empty Makefiles. (line 6)
4430 * SELFAUTODIR: Calling sequence. (line 16)
4431 * SELFAUTOLOC: Calling sequence. (line 16)
4432 * SELFAUTOPARENT: Calling sequence. (line 16)
4433 * sending patches: Bug checklist. (line 56)
4434 * setgid scripts: Security. (line 40)
4435 * SFDFONTS: Supported file formats.
4437 * sh5, ok with configure: configure shells. (line 25)
4438 * shared library, making: Shared library. (line 6)
4439 * shell scripts as configuration files: Config files. (line 67)
4440 * shell variables: Variable expansion. (line 17)
4441 * shell_escape, example for code: Programming with config files.
4443 * shells and configure: configure shells. (line 6)
4444 * simple installation: Simple installation. (line 6)
4445 * site overrides for mktex...: mktex configuration. (line 29)
4446 * size of distribution archives: Disk space. (line 6)
4447 * skeleton TeX directory: TeX directory structure.
4449 * slow startup time: Slow path searching. (line 6)
4450 * Solaris BSD compatibility, not: Running make. (line 44)
4451 * source files: Supported file formats.
4453 * sources for search paths: Path sources. (line 6)
4454 * special: Suppressing warnings.
4456 * st_nlink: Subdirectory expansion.
4458 * stack trace: Bug checklist. (line 62)
4459 * standalone path searching: Invoking kpsewhich. (line 6)
4460 * standard error and debugging output: Debugging. (line 27)
4461 * standard options: Standard options. (line 6)
4462 * startup time, excessive: Slow path searching. (line 6)
4463 * static linking: ShellWidgetClass. (line 39)
4464 * static linking and dlsym: dlopen. (line 6)
4465 * string routines: Calling sequence. (line 83)
4466 * strip: mktex configuration. (line 108)
4467 * stripsupplier: mktex configuration. (line 102)
4468 * striptypeface: mktex configuration. (line 105)
4469 * subdirectory searching: Subdirectory expansion.
4471 * suggestions, making: Introduction. (line 27)
4472 * Sun 2: History. (line 12)
4473 * Sun OpenWin patches: ShellWidgetClass. (line 29)
4474 * supplier directory, omitting: mktex configuration. (line 103)
4475 * supported file formats: Supported file formats.
4477 * suppressing warnings: Suppressing warnings.
4479 * symbolic link trees, for multiple architectures: configure scenarios.
4481 * symbolic links not found: Unable to find files.
4483 * symbolic links, and ls-R: ls-R. (line 38)
4484 * symlinks, resolving: Calling sequence. (line 16)
4485 * system C compiler bugs: TeX or Metafont failing.
4487 * system dependencies: Running configure. (line 6)
4488 * system V universe: Running make. (line 44)
4489 * T1FONTS: Supported file formats.
4491 * T1INPUTS: Supported file formats.
4493 * T42FONTS: Supported file formats.
4495 * TDS: TeX directory structure.
4497 * testing, post-installation: Installation testing.
4499 * tests, simple: Simple installation. (line 79)
4500 * teTeX: Other TeX packages. (line 13)
4501 * TeX directory structure: TeX directory structure.
4503 * TeX distributions besides Web2c: Other TeX packages. (line 6)
4504 * TeX environment variables: Supported file formats.
4506 * TeX failures: TeX or Metafont failing.
4508 * TeX file lookup: File lookup. (line 6)
4509 * TeX glyph lookup: Glyph lookup. (line 6)
4510 * TeX help mailing list: Mailing lists. (line 29)
4511 * TeX hierarchy, one: configure scenarios. (line 13)
4512 * TeX Live CD-ROM: CD-ROM distribution. (line 8)
4513 * TeX support: TeX support. (line 6)
4514 * TeX Users Group: Introduction. (line 39)
4515 * tex-archive@math.utah.edu: Mailing lists. (line 25)
4516 * tex-file.c: File lookup. (line 26)
4517 * tex-file.h: Programming overview.
4519 * tex-glyph.c: Glyph lookup. (line 26)
4520 * tex-glyph.h: Programming overview.
4522 * tex-k-request@mail.tug.org: Mailing lists. (line 7)
4523 * tex-k@mail.tug.org (bug address): Reporting bugs. (line 8)
4524 * TEX_HUSH <1>: Suppressing warnings.
4526 * TEX_HUSH: Searching overview. (line 56)
4527 * TEXBIB: Supported file formats.
4529 * TEXCONFIG: Supported file formats.
4531 * TEXDOCS: Supported file formats.
4533 * TEXFONTMAPS: Supported file formats.
4535 * TEXFONTS: Supported file formats.
4537 * texfonts.map: Fontmap. (line 6)
4538 * TEXFORMATS: Supported file formats.
4540 * TEXINDEXSTYLE: Supported file formats.
4542 * TEXINPUTS: Supported file formats.
4544 * TEXMF: TeX directory structure.
4546 * texmf.cnf, and variable expansion: Variable expansion. (line 6)
4547 * texmf.cnf, creating: Running make. (line 6)
4548 * texmf.cnf, definition for: Config files. (line 6)
4549 * texmf.cnf, generated: Default path generation.
4551 * texmf.cnf, source for path: Path sources. (line 17)
4552 * texmf.in: Default path generation.
4554 * texmf.in, editing: Changing search paths.
4556 * texmf.sed: Default path generation.
4558 * TEXMFCNF <1>: Supported file formats.
4560 * TEXMFCNF: Config files. (line 6)
4561 * TEXMFDBS <1>: Supported file formats.
4563 * TEXMFDBS: ls-R. (line 6)
4564 * TEXMFINI: Supported file formats.
4566 * TEXMFLOG: Logging. (line 10)
4567 * TEXMFOUTPUT: mktex script names. (line 40)
4568 * TEXMFSCRIPTS: Supported file formats.
4570 * TEXMFVAR: mktex configuration. (line 124)
4571 * texmfvar: mktex configuration. (line 123)
4572 * TEXPICTS: Supported file formats.
4574 * TEXPKS: Supported file formats.
4576 * TEXPOOL: Supported file formats.
4578 * TEXPSHEADERS: Supported file formats.
4580 * TEXSIZES: Fallback font. (line 6)
4581 * TEXSOURCES: Supported file formats.
4583 * TFMFONTS: Supported file formats.
4585 * tilde expansion: Tilde expansion. (line 6)
4586 * tilde.c: Tilde expansion. (line 25)
4587 * time system call: Logging. (line 15)
4588 * tolerance for glyph lookup: Basic glyph lookup. (line 15)
4589 * total disk space: Disk space. (line 6)
4590 * trailing / in home directory: Tilde expansion. (line 19)
4591 * trailing colons: Default expansion. (line 6)
4592 * TRFONTS: Supported file formats.
4594 * trick for detecting leaf directories: Subdirectory expansion.
4596 * trojan horse attack: Security. (line 10)
4597 * TTFONTS: Supported file formats.
4599 * tug.org: unixtex.ftp. (line 6)
4600 * tug@tug.org: Introduction. (line 46)
4601 * typeface directory, omitting: mktex configuration. (line 106)
4602 * ucbinclude, avoiding: Running make. (line 44)
4603 * Ultrix shells and configure: configure shells. (line 25)
4604 * unable to find files: Unable to find files.
4606 * unable to generate fonts: Unable to generate fonts.
4608 * uname: Bug checklist. (line 21)
4609 * universe, BSD vs. system V: Running make. (line 44)
4610 * UNIX_ST_LINK: Subdirectory expansion.
4612 * unixtex.ftp: unixtex.ftp. (line 6)
4613 * unknown special warnings: Suppressing warnings.
4615 * unreadable file warnings: Suppressing warnings.
4617 * unreadable files: Searching overview. (line 56)
4618 * unusable ls-R warning: ls-R. (line 45)
4619 * usage patterns, finding: Logging. (line 6)
4620 * USE_TEXMFVAR: mktex configuration. (line 129)
4621 * USE_VARTEXFONTS: mktex configuration. (line 119)
4622 * Usenet TeX newsgroup: Mailing lists. (line 29)
4623 * USERPROFILE, as ~ expansion: Tilde expansion. (line 6)
4624 * varfonts: mktex configuration. (line 113)
4625 * variable expansion: Variable expansion. (line 6)
4626 * variable.c: Variable expansion. (line 32)
4627 * variable.h: Programming with config files.
4629 * VARTEXFONTS: mktex configuration. (line 114)
4630 * VAX 11/750: History. (line 12)
4631 * version number, of Kpathsea: Kpathsea application distributions.
4633 * version numbers, determining: Bug checklist. (line 16)
4634 * VF files, not found: Searching overview. (line 31)
4635 * VFFONTS: Supported file formats.
4637 * VMS support: Custom installation. (line 19)
4638 * VMS TeX implementations: Other TeX packages. (line 6)
4639 * Vojta, Paul: History. (line 30)
4640 * Walsh, Norman: History. (line 57)
4641 * warning about unusable ls-R: ls-R. (line 45)
4642 * warnings, file access: Searching overview. (line 56)
4643 * warnings, pointer combinations: Pointer combination warnings.
4645 * warnings, suppressing: Suppressing warnings.
4647 * wcstombs: dlopen. (line 6)
4648 * WEB2C: Supported file formats.
4650 * Weber, Olaf: History. (line 74)
4651 * WEBINPUTS: Supported file formats.
4653 * whitespace, in fontmap files: Fontmap. (line 28)
4654 * whitespace, not ignored on continuation lines: Config files.
4656 * Windows TeX implementations: Other TeX packages. (line 6)
4657 * World Wide Web CTAN access: Electronic distribution.
4659 * www.tug.org: unixtex.ftp. (line 6)
4660 * X11 previewer: Kpathsea application distributions.
4662 * X11, lacking on NeXT: Kpathsea application distributions.
4664 * XCFLAGS: Running make. (line 26)
4665 * XCPPFLAGS: Running make. (line 22)
4666 * XDEFS: Running make. (line 23)
4667 * XDVIFONTS: Supported file formats.
4669 * XDVIMAKEPK: mktex script names. (line 32)
4670 * XDVISIZES: Fallback font. (line 6)
4671 * XLDFLAGS: Running make. (line 29)
4672 * XLOADLIBES: Running make. (line 32)
4673 * XMAKEARGS: Running make. (line 35)
4674 * Xmu library problems: ShellWidgetClass. (line 13)
4675 * XtStrings: XtStrings. (line 6)
4676 * zuhn, david: History. (line 51)
4677 * { expansion: Brace expansion. (line 6)
4678 * ~ expansion: Tilde expansion. (line 6)
4684 Node: Introduction
\7f2205
4685 Node: History
\7f4188
4686 Node: Installation
\7f8280
4687 Node: Simple installation
\7f9070
4688 Node: Custom installation
\7f12653
4689 Node: Disk space
\7f13827
4690 Node: Kpathsea application distributions
\7f14711
4691 Node: Changing search paths
\7f15826
4692 Node: Default path features
\7f17008
4693 Node: Default path generation
\7f19144
4694 Node: Running configure
\7f20587
4695 Node: configure shells
\7f21638
4696 Node: configure options
\7f22690
4697 Node: configure environment
\7f24197
4698 Node: configure scenarios
\7f25999
4699 Node: Shared library
\7f27585
4700 Node: Running make
\7f28599
4701 Node: Installing files
\7f30646
4702 Node: Cleaning up
\7f32593
4703 Node: Filename database generation
\7f33641
4704 Node: mktex scripts
\7f34208
4705 Node: mktex configuration
\7f35485
4706 Node: mktex script names
\7f41304
4707 Node: mktex script arguments
\7f42695
4708 Node: Installation testing
\7f43585
4709 Node: Security
\7f43949
4710 Node: TeX directory structure
\7f46516
4711 Node: unixtex.ftp
\7f50938
4712 Node: Electronic distribution
\7f52953
4713 Node: CD-ROM distribution
\7f55718
4714 Node: Other TeX packages
\7f56688
4715 Node: Reporting bugs
\7f57984
4716 Node: Bug checklist
\7f58724
4717 Node: Mailing lists
\7f62426
4718 Node: Debugging
\7f63785
4719 Node: Logging
\7f68857
4720 Node: Common problems
\7f70727
4721 Node: Unable to find files
\7f71558
4722 Node: Slow path searching
\7f73969
4723 Node: Unable to generate fonts
\7f75346
4724 Node: TeX or Metafont failing
\7f77855
4725 Node: Empty Makefiles
\7f79733
4726 Node: XtStrings
\7f80963
4727 Node: dlopen
\7f81799
4728 Node: ShellWidgetClass
\7f82617
4729 Node: Pointer combination warnings
\7f84249
4730 Node: Path searching
\7f84638
4731 Node: Searching overview
\7f85285
4732 Node: Path sources
\7f88657
4733 Node: Config files
\7f89728
4734 Node: Path expansion
\7f93128
4735 Node: Default expansion
\7f94077
4736 Node: Variable expansion
\7f96147
4737 Node: Tilde expansion
\7f97550
4738 Node: Brace expansion
\7f98530
4739 Node: KPSE_DOT expansion
\7f99635
4740 Node: Subdirectory expansion
\7f100148
4741 Node: Filename database
\7f102497
4743 Node: Filename aliases
\7f106705
4744 Node: Database format
\7f107883
4745 Node: Invoking kpsewhich
\7f108896
4746 Node: Path searching options
\7f109773
4747 Node: Auxiliary tasks
\7f116422
4748 Node: Standard options
\7f118243
4749 Node: TeX support
\7f118563
4750 Node: Supported file formats
\7f119854
4751 Node: File lookup
\7f127002
4752 Node: Glyph lookup
\7f128293
4753 Node: Basic glyph lookup
\7f129420
4754 Node: Fontmap
\7f130299
4755 Node: Fallback font
\7f132916
4756 Node: Suppressing warnings
\7f133881
4757 Node: Programming
\7f134986
4758 Node: Programming overview
\7f135499
4759 Node: Calling sequence
\7f137775
4760 Node: Program-specific files
\7f142804
4761 Node: Programming with config files
\7f143842
4762 Node: Index
\7f145142
projects / mplib / blob