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 * mktexmf: (kpathsea)mktex scripts. MF source generation.
8 * mktexpk: (kpathsea)mktex scripts. PK bitmap generation.
9 * mktextex: (kpathsea)mktex scripts. TeX source generation.
10 * mktextfm: (kpathsea)mktex scripts. TeX font metric generation.
11 * mktexlsr: (kpathsea)Filename database. Update ls-R.
14 This file documents the Kpathsea library for path searching.
16 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
17 2005, 2007, 2008 Karl Berry & Olaf Weber.
19 Permission is granted to make and distribute verbatim copies of this
20 manual provided the copyright notice and this permission notice are
21 preserved on all copies.
23 Permission is granted to copy and distribute modified versions of
24 this manual under the conditions for verbatim copying, provided that the
25 entire resulting derived work is distributed under the terms of a
26 permission notice identical to this one.
28 Permission is granted to copy and distribute translations of this
29 manual into another language, under the above conditions for modified
30 versions, except that this permission notice may be stated in a
31 translation approved by the Free Software Foundation.
34 File: kpathsea.info, Node: Top, Next: Introduction, Up: (dir)
39 This manual documents how to install and use the Kpathsea library for
40 filename lookup. It corresponds to version 3.5.6dev, released in
45 * Introduction:: Overview.
46 * Installation:: Compilation, installation, and bug reporting.
48 * Path searching:: How filename lookups work.
49 * TeX support:: Special support for TeX-related file lookups.
51 * Programming:: How to use Kpathsea features in your program.
53 * Index:: General index.
56 File: kpathsea.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top
61 This manual corresponds to version 3.5.6dev of the Kpathsea library,
62 released in January 2008.
64 The library's fundamental purpose is to return a filename from a
65 list of directories specified by the user, similar to what shells do
66 when looking up program names to execute.
68 The following software, all of which we maintain, uses this library:
70 * Dviljk (see the `dvilj' man page)
72 * Dvipsk (*note Introduction: (dvips)Top.)
74 * GNU font utilities (*note Introduction: (fontu)Top.)
76 * Web2c (*note Introduction: (web2c)Top.)
78 * Xdvik (see the `xdvi' man page)
80 Other software that we do not maintain also uses it.
82 We are still actively maintaining the library (and probably always
83 will be, despite our hopes). If you have comments or suggestions,
84 please send them to us (*note Reporting bugs::).
86 We distribute the library under the GNU Library General Public
87 License (LGPL). In short, this means if you write a program using the
88 library, you must (offer to) distribute the source to the library,
89 along with any changes you have made, and allow anyone to modify the
90 library source and distribute their modifications. It does not mean
91 you have to distribute the source to your program, although we hope you
92 will. See the files `GPL' and `LGPL' for the text of the GNU licenses.
94 If you know enough about TeX to be reading this manual, then you (or
95 your institution) should consider joining the TeX Users Group (if
96 you're already a member, great!). TUG produces the periodical
97 `TUGboat', sponsors an annual meeting and publishes the proceedings,
98 and arranges courses on TeX for all levels of users throughout the
99 world. Anyway, here is the address:
103 Portland OR 97208-2311
105 phone: +1 503 223-9994
114 File: kpathsea.info, Node: History, Up: Introduction
119 (This section is for those people who are curious about how the library
120 came about.) (If you like to read historical accounts of software, we
121 urge you to seek out the GNU Autoconf manual and the "Errors of TeX"
122 paper by Don Knuth, published in `Software--Practice and Experience'
125 [Karl writes.] My first ChangeLog entry for Web2c seems to be
126 February 1990, but I may have done some work before then. In any case,
127 Tim Morgan and I were jointly maintaining it for a time. (I should
128 mention here that Tim had made Web2c into a real distribution long
129 before I had ever used it or even heard of it, and Tom Rokicki did the
130 original implementation. I was using `pxp' and `pc' on VAX 11/750's
131 and the hot new Sun 2 machines.)
133 It must have been later in 1990 and 1991 that I started working on
134 `TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
135 (which I was also writing at the time) all used different environment
136 variables, and, more importantly, had different bugs in their path
137 searching. This became extremely painful, as I was stressing everything
138 to the limit working on the book. I also desperately wanted to
139 implement subdirectory searching, since I couldn't stand putting
140 everything in one big directory, and also couldn't stand having to
141 explicitly specify `cm', `pandora', ... in a path.
143 In the first incarnation, I just hacked separately on each
144 program--that was the original subdirectory searching code in both Xdvi
145 and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
146 support by now. That is, I tried to go with the flow in each program,
147 rather than changing the program's calling sequences to conform to
150 Then, as bugs inevitably appeared, I found I was fixing the same
151 thing three times (Web2c and fontutils were always sharing code, since I
152 maintained those--there was no Dvipsk or Xdvik or Dviljk at this
153 point). After a while, I finally started sharing source files. They
154 weren't yet a library, though. I just kept things up to date with shell
155 scripts. (I was developing on a 386 running ISC 2.2 at the time, and so
156 didn't have symbolic links. An awful experience.)
158 The ChangeLogs for Xdvik and Dvipsk record initial releases of those
159 distributions in May and June 1992. I think it was because I was tired
160 of the different configuration strategies of each program, not so much
161 because of the path searching. (Autoconf was being developed by David
162 MacKenzie and others, and I was adapting it to TeX and friends.)
164 I started to make a separate library that other programs could link
165 with on my birthday in April 1993, according to the ChangeLog. I don't
166 remember exactly why I finally took the time to make it a separate
167 library; a conversation with david zuhn that initiated it. Just seemed
170 Dviljk got started in March 1994 after I bought a Laserjet 4.
171 (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
172 Neumann's help, implemented a way for TeX to get at all those neat
173 builtin LJ4 fonts ... such a treat to have something to typeset in
176 By spring of 1995, I had implemented just about all the
177 path-searching features in Kpathsea that I plan to, driven beyond my
178 initial goals by Thomas Esser and others. I then started to integrate
179 Web2c with Kpathsea. After the release of a stable Web2c, I hope to be
180 able to stop development, and turn most of my attention back to making
181 fonts for GNU. (Always assuming Micros**t hasn't completely
182 obliterated Unix by then, or that software patents haven't stopped
183 software development by anybody smaller than a company with a
184 million-dollar-a-year legal budget. Which is actually what I think is
185 likely to happen, but that's another story...)
187 [Olaf writes.] At the end of 1997, UNIX is still alive and kicking,
188 individuals still develop software, and Web2c development still
189 continues. Karl had been looking for some time for someone to take up
190 part of the burden, and I volunteered.
193 File: kpathsea.info, Node: Installation, Next: Path searching, Prev: Introduction, Up: Top
198 (A copy of this chapter is in the distribution file `kpathsea/INSTALL'.)
200 The procedure for Kpathsea (and Web2c, etc.) configuration and
201 installation follows. If you encounter trouble, see *note Common
202 problems::, a copy of which is in the file `kpathsea/BUGS'.
206 * Simple installation:: If you just want to do it.
207 * Custom installation:: If you want to change things around.
208 * Security:: Who can write what files, etc.
209 * TeX directory structure:: Managing the horde of TeX input files.
210 * unixtex.ftp:: Getting software via FTP, on CD-ROM, or on tape.
211 * Reporting bugs:: Where and how to report bugs.
214 File: kpathsea.info, Node: Simple installation, Next: Custom installation, Up: Installation
216 2.1 Simple installation
217 =======================
219 Installing TeX and friends for the first time can be a daunting
220 experience. Thus, you may prefer to skip this whole thing and just get
221 precompiled executables: see *note unixtex.ftp::.
223 This section explains what to do if you wish to take the defaults for
224 everything, and generally to install in the simplest possible way. Most
225 steps here refer to corresponding subsection in the next section which
226 explains how to override defaults and generally gives more details.
228 By default everything will be installed under `/usr/local' and the
229 following discussion assumes this. However, if you already have TeX
230 installed, its location is used to derive the directory under which
231 everything is to be installed.
233 1. Be sure you have enough disk space: approximately 8 megabytes for
234 the compressed archives, 15MB for sources, 50MB for compilation,
235 40MB for the (initial) installed system (including library files).
238 2. Retrieve these distribution archives:
239 `ftp://ftp.tug.org/tex/texk.tar.gz'
240 These are the sources, which you will be compiling.
242 `ftp://ftp.tug.org/tex/texklib.tar.gz'
243 This is a basic set of input files. You should unpack it in
244 the directory `/usr/local/share'; doing so will create a
245 `texmf' subdirectory there.
247 These archives are mirrored on the CTAN hosts, in the
248 `systems/web2c' directory.
250 *Note Kpathsea application distributions::.
252 3. When using the default search paths, there is no need to edit any
253 distribution files. *Note Changing search paths::.
255 4. At the top level of the distribution, run `sh configure'. (If you
256 have the GNU Bash shell installed, run `bash configure'.) *Note
259 5. `make'. *Note Running make::. If you are using a BSD 4.4 system
260 such as FreeBSD or NetBSD, you may have to use GNU make (often
261 installed in `/usr/local/bin'), not the BSD make.
263 6. `make install'. *Note Installing files::.
265 7. `make distclean'. *Note Cleaning up::.
267 8. Set up a cron job to rebuild the filename database that makes
268 searching faster. This line will rebuild it every midnight:
269 0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
270 *Note Filename database generation::, and *note Filename
273 9. If you're installing Dvips, you also need to set up configuration
274 files for your printers and make any additional PostScript fonts
275 available. *Note Installation: (dvips)Installation. If you have
276 any color printers, see *note Color device configuration:
277 (dvips)Color device configuration.
279 10. The first time you run a DVI driver, a bunch of PK fonts will be
280 built by Metafont via `mktexpk' (and added to the filename
281 database). This will take some time. Don't be alarmed; they will
282 created only this first time (unless something is wrong with your
285 By default, `mktexpk' will create these fonts in a hierarchy under
286 `/var/tmp/texfonts'; it simply assumes that `/var/tmp' exists and
287 is globally writable. If you need a different arrangement, see
288 *note mktex configuration::.
290 *Note mktex scripts::.
292 11. For some simple tests, try `tex story \\bye' and `latex sample2e'.
293 Then run `xdvi story' or `dvips sample2e' on the resulting DVI
294 files to preview/print the documents. *Note Installation
298 File: kpathsea.info, Node: Custom installation, Next: Security, Prev: Simple installation, Up: Installation
300 2.2 Custom installation
301 =======================
303 Most sites need to modify the default installation procedure in some
304 way, perhaps merely changing the prefix from `/usr/local', perhaps
305 adding extra compiler or loader options to work around `configure'
306 bugs. This section explains how to override default choices. For
307 additional distribution-specific information:
310 * *Note Installation: (dvips)Installation.
312 * *Note Installation: (web2c)Installation.
316 These instructions are for Unix systems. Other operating-system
317 specific distributions have their own instructions. The code base
318 itself supports Amiga, DOS, OS/2, and VMS.
320 Following are the same steps as in the previous section (which
321 describes the simplest installation), but with much more detail.
326 * Kpathsea application distributions::
327 * Changing search paths::
328 * Running configure::
332 * Filename database generation::
334 * Installation testing::
337 File: kpathsea.info, Node: Disk space, Next: Kpathsea application distributions, Up: Custom installation
342 Here is a table showing the disk space needed for each distribution
343 (described in the next section). The `(totals)' line reflects the
344 `texk' source distribution and `texklib'; the individual distributions
345 don't enter into it. Sizes are in megabytes. All numbers are
348 Distribution .tar.gz Unpacked Compiled Installed
354 texk 7.5 32.1 95.3 33.5
355 texklib 6.3 15.0 - 15.0
356 (totals) 14.6 47.1 95.3 48.5
359 File: kpathsea.info, Node: Kpathsea application distributions, Next: Changing search paths, Prev: Disk space, Up: Custom installation
361 2.2.2 Kpathsea application distributions
362 ----------------------------------------
364 The archive `ftp://ftp.tug.org/tex/texk.tar.gz' contains all of the
365 Kpathsea applications I maintain, and the library itself. For example,
366 since NeXT does not generally support X11, you'd probably want to skip
367 `xdvik' (or simply remove it after unpacking `texk.tar.gz'. If you are
368 not interested in all of them, you can also retrieve them separately:
371 DVI to PCL, for LaserJet printers.
374 DVI to PostScript, for previewers, printers, or PDF generation.
377 The software needed to compile TeX and friends.
380 The original WEB source files, also used in compilation.
383 DVI previewing under the X window system.
386 If you want to use the Babel LaTeX package for support of non-English
387 typesetting, you may need to retrieve additional files. See the file
388 `install.txt' in the Babel distribution.
391 File: kpathsea.info, Node: Changing search paths, Next: Running configure, Prev: Kpathsea application distributions, Up: Custom installation
393 2.2.3 Changing search paths
394 ---------------------------
396 If the search paths for your installation differ from the standard TeX
397 directory structure (*note Introduction: (tds)Top.), edit the file
398 `kpathsea/texmf.in' as desired, before running `configure'. For
399 example, if you have all your fonts or macros in one big directory.
401 You may also wish to edit the file `mktex.cnf', either before or
402 after installation, to control various aspects of `mktexpk' and
403 friends. *Note mktex configuration::.
405 You do not need to edit `texmf.in' to change the default top-level
406 or other installation _directories_ (only the paths). You can and
407 should do that when you run `configure' (next step).
409 You also do not need to edit `texmf.in' if you are willing to rely
410 on `texmf.cnf' at runtime to define the paths, and let the compile-time
411 default paths be incorrect. Usually there is no harm in doing this.
413 The section below explains default generation in more detail.
417 * Default path features::
418 * Default path generation::
421 File: kpathsea.info, Node: Default path features, Next: Default path generation, Up: Changing search paths
423 2.2.3.1 Default path features
424 .............................
426 The purpose of having all the different files described in the section
427 above is to avoid having the same information in more than one place. If
428 you change the installation directories or top-level prefix at
429 `configure'-time, those changes will propagate through the whole
430 sequence. And if you change the default paths in `texmf.in', those
431 changes are propagated to the compile-time defaults.
433 The Make definitions are all repeated in several Makefile's; but
434 changing the top-level `Makefile' should suffice, as it passes down all
435 the variable definitions, thus overriding the submakes. (The
436 definitions are repeated so you can run Make in the subdirectories, if
437 you should have occasion to.)
439 By default, the bitmap font paths end with `/$MAKETEX_MODE', thus
440 including the device name (usually a Metafont mode name such as
441 `ljfour'). This distinguishes two different devices with the same
442 resolution--a write/white from a write/black 300dpi printer, for
445 However, since most sites don't have this complication, Kpathsea
446 (specifically, the `kpse_init_prog' function in `kpathsea/proginit.c')
447 has a special case: if the mode has not been explicitly set by the user
448 (or in a configuration file), it sets `MAKETEX_MODE' to `/'. This
449 makes the default PK path, for example, expand into `.../pk//', so
450 fonts will be found even if there is no subdirectory for the mode (if
451 you arranged things that way because your site has only one printer,
452 for example) or if the program is mode-independent (e.g., `pktype').
454 To make the paths independent of the mode, simply edit `texmf.in'
455 before installation, or the installed `texmf.cnf', and remove the
458 *Note mktex script arguments::, for how this interacts with
461 *Note TeX directory structure: TeX directory structure, for a
462 description of the default arrangement of the input files that comprise
463 the TeX system. The file `kpathsea/HIER' is a copy of that section.
466 File: kpathsea.info, Node: Default path generation, Prev: Default path features, Up: Changing search paths
468 2.2.3.2 Default path generation
469 ...............................
471 This section describes how the default paths are constructed.
473 You may wish to ignore the whole mess and simply edit `texmf.cnf'
474 after it is installed, perhaps even copying it into place beforehand so
475 you can complete the installation, if it seems necessary.
477 To summarize the chain of events that go into defining the default
480 1. `configure' creates a `Makefile' from each `Makefile.in'.
482 2. When Make runs in the `kpathsea' directory, it creates a file
483 `texmf.sed' that substitutes the Make value of `$(var)' for a
484 string `@var@'. The variables in question are the one that define
485 the installation directories.
487 3. `texmf.sed' (together with a little extra magic--see
488 `kpathsea/Makefile') is applied to `texmf.in' to generate
489 `texmf.cnf'. This is the file that will eventually be installed
492 4. The definitions in `texmf.cnf' are recast as C `#define''s in
493 `paths.h'. These values will be the compile-time defaults; they
494 are not used at runtime unless no `texmf.cnf' file can be found.
496 (That's a lie: the compile-time defaults are what any extra :'s in
497 `texmf.cnf' expand into; but the paths as distributed have no extra
498 :'s, and there's no particular reason for them to.)
501 File: kpathsea.info, Node: Running configure, Next: Running make, Prev: Changing search paths, Up: Custom installation
503 2.2.4 Running `configure'
504 -------------------------
506 Run `sh configure OPTIONS' (in the top-level directory, the one
507 containing `kpathsea/'), possibly using a shell other than `sh' (*note
510 `configure' adapts the source distribution to the present system via
511 `#define''s in `*/c-auto.h', which are created from the corresponding
512 `c-auto.in'. It also creates a `Makefile' from the corresponding
513 `Makefile.in', doing `@VAR@' and `ac_include' substitutions).
515 `configure' is the best place to control the configuration,
516 compilation, and installed location of the software, either via
517 command-line options, or by setting environment variables before
518 invoking it. For example, you can disable `mktexpk' by default with
519 the option `--disable-mktexpk'. *Note configure options::.
524 * configure options::
525 * configure environment::
526 * configure scenarios::
530 File: kpathsea.info, Node: configure shells, Next: configure options, Up: Running configure
532 2.2.4.1 `configure' shells
533 ..........................
535 Considerable effort has gone into trying to ensure that the `configure'
536 scripts can be run by most Bourne shell variants. If `sh' runs into
537 trouble, your best bet is to use Bash, the GNU Bourne-again shell
538 (*note Top: (bash)Top.).
540 Bourne shell variants for which problems have been reported in the
543 Old versions of the Korn shell may fail to handle the scripts.
544 The Korn shell may be installed as `/bin/sh' on AIX, in which case
545 `/bin/bsh' may serve instead.
548 Old versions of ash are unable to handle the scripts. Ash is
549 sometimes installed as `/bin/sh' on NetBSD, FreeBSD, and Linux
550 systems. `/bin/bash' should be available for those systems, but
551 might not be part of a default installation.
554 `/bin/sh' under Ultrix is a DEC-grown shell that is notably
555 deficient in many ways. `/bin/sh5' may be necessary.
558 File: kpathsea.info, Node: configure options, Next: configure environment, Prev: configure shells, Up: Running configure
560 2.2.4.2 `configure' options
561 ...........................
563 For a complete list of all `configure' options, run `configure --help'
564 or see *note Running `configure' scripts: (autoconf)Invoking configure,
565 (a copy is in the file `kpathsea/README.CONFIGURE'). The generic
566 options are listed first in the `--help' output, and the
567 package-specific options come last. The environment variables
568 `configure' pays attention to are listed below.
570 Options particularly likely to be useful are `--prefix',
571 `--datadir', and the like; see *note configure scenarios::.
573 This section gives pointers to descriptions of the `--with' and
574 `--enable' options to `configure' that Kpathsea-using programs accept.
576 `--without-mktexmf-default'
577 `--without-mktexpk-default'
578 `--without-mktextfm-default'
579 `--with-mktextex-default'
580 Enable or disable the dynamic generation programs. *Note mktex
584 Build Kpathsea as a shared library, and link against it. Also
585 build the usual static library. *Note Shared library::.
588 Build only the shared library. Implies `--enable-shared'.
590 `--enable-maintainer-mode'
591 Enables make targets that are useful for the maintainer and likely
592 to be a pain for anyone else; the makefiles created when this
593 option is enabled may not work at all for you. You have been
597 File: kpathsea.info, Node: configure environment, Next: configure scenarios, Prev: configure options, Up: Running configure
599 2.2.4.3 `configure' environment
600 ...............................
602 `configure' uses the value of the following environment variables in
603 determining your system's characteristics, and substitutes for them in
607 The compiler to use: default is `gcc' if it's installed, otherwise
611 Options to give the compiler: default is `-g -O2' for `gcc', `-g'
612 otherwise. `CFLAGS' comes after any other options. You may need
613 to include `-w' here if your compilations commonly have useless
614 warnings (e.g., `NULL redefined'), or `configure' may fail to
615 detect the presence of header files (it takes the messages on
616 standard error to mean the header file doesn't exist).
619 Options to pass to the compiler preprocessor; this matters most for
620 configuration, not the actual source compilation. The `configure'
621 script often does only preprocessing (e.g., to check for the
622 existence of #include files), and `CFLAGS' is not used for this.
623 You may need to set this to something like
624 `-I/usr/local/include/wwwhatever' if you have the libwww library
625 installed for hyper-xdvik (see `xdvik/INSTALL').
628 Additional preprocessor options, but not used by `configure'.
629 Provided for enabling or disabling program features, as documented
630 in the various program-specific installation instructions. `DEFS'
631 comes before any compiler options included by the distribution
632 `Makefile's or by `configure'.
635 Additional options to give to the loader. `LDFLAGS' comes before
636 any other linker options.
639 Additional libraries to link with.
642 File: kpathsea.info, Node: configure scenarios, Next: Shared library, Prev: configure environment, Up: Running configure
644 2.2.4.4 `configure' scenarios
645 .............................
647 Here are some common installation scenarios:
649 * Including X support in Metafont. This is disabled by default,
650 since many sites have no use for it, and it's a leading cause of
651 configuration problems.
654 * Putting the binaries, TeX files, GNU info files, etc. into a single
655 TeX hierarchy, say `/here/texmf', requires overriding defaults in
657 configure --prefix=/here/texmf --datadir=/here
659 * You can compile on multiple architectures simultaneously either by
660 building symbolic link trees with the `lndir' script from the X11
661 distribution, or with the `--srcdir' option:
662 configure --srcdir=SRCDIR
664 * If you are installing binaries for multiple architectures into a
665 single hierarchy, you will probably want to override the default
666 `bin' and `lib' directories, something like this:
667 configure --prefix=TEXMF --datadir=TEXMF \
668 --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
670 (Unless you make provisions for architecture-specific files in
671 other ways, e.g., with Depot or an automounter.)
673 * To compile with optimization (to compile without debugging, remove
675 env CFLAGS="-g -O" sh configure ...
676 For a potential problem if you optimize, see *note TeX or Metafont
677 failing: TeX or Metafont failing.
680 File: kpathsea.info, Node: Shared library, Prev: configure scenarios, Up: Running configure
682 2.2.4.5 Shared library
683 ......................
685 You can compile Kpathsea as a shared library on a few systems, by
686 specifying the option `--enable-shared' when you run `configure'.
688 The main advantage in doing this is that the executables can then
689 share the code, thus decreasing memory and disk space requirements.
691 On some systems, you can record the location of shared libraries in a
692 binary, usually by giving certain options to the linker. Then
693 individual users do not need to set their system's environment variable
694 (e.g., `LD_LIBRARY_PATH') to find shared libraries. If you want to do
695 this, you will need to add the necessary options to `LDFLAGS' yourself;
696 for example, on Solaris, include something like `-R${prefix}/lib', on
697 IRIX or Linux, use `-rpath${prefix}/lib'. (Unfortunately, making this
698 happen by default is very difficult, because of interactions with an
699 existing installed shared library.)
702 File: kpathsea.info, Node: Running make, Next: Installing files, Prev: Running configure, Up: Custom installation
707 `make' (still in the top-level directory). This also creates the
708 `texmf.cnf' and `paths.h' files that define the default search paths,
709 and (by default) the `plain' and `latex' TeX formats.
711 You can override directory names and other values at `make'-time.
712 `make/paths.make' lists the variables most commonly reset. For
713 example, `make default_texsizes=600' changes the list of fallback
716 You can also override each of `configure''s environment variables
717 (*note configure environment::). The Make variables have the same
720 Finally, you can supply additional options via the following
721 variables. (`configure' does not use these.)
725 Preprocessor options.
731 Loader options (included at beginning of link commands).
734 More loader options (included at end of link commands).
737 Additional Make arguments passed to all sub-`make''s. You may need
738 to include assignments to the other variables here via `XMAKEARGS';
739 for example: `make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
741 It's generally a bad idea to use a different compiler (`CC') or
742 libraries (`LIBS') for compilation than you did for configuration,
743 since the values `configure' determined may then be incorrect.
745 Adding compiler options to change the "universe" you are using
746 (typically BSD vs. system V) is generally a cause of trouble. It's
747 best to use the native environment, whatever that is; `configure' and
748 the software usually adapt best to that. In particular, under Solaris
749 2.x, you should not use the BSD-compatibility library (`libucb') or
750 include files (`ucbinclude').
752 If you want to use the Babel LaTeX package for support of non-English
753 typesetting, you need to modify some files before making the LaTeX
754 format. See the file `install.txt' in the Babel distribution.
757 File: kpathsea.info, Node: Installing files, Next: Cleaning up, Prev: Running make, Up: Custom installation
759 2.2.6 Installing files
760 ----------------------
762 The basic command is the usual `make install'. For security issues,
765 The first time you install any manual in the GNU Info system, you
766 should add a line (you choose where) to the file `dir' in your
767 `$(infodir)' directory. Sample text for this is given near the top of
768 the Texinfo source files (`kpathsea/kpathsea.texi',
769 `dvipsk/dvips.texi', and `web2c/doc/web2c.texi'). If you have a recent
770 version of the GNU Texinfo distribution installed
771 (`ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz' or later), this
772 should happen automatically.
774 On the offchance that this is your first Info installation, the
775 `dir' file I use is included in the distribution as `etc/dir-example'.
777 You may wish to use one of the following targets, especially if you
778 are installing on multiple architectures:
779 * `make install-exec' to install in architecture-dependent
780 directories, i.e., ones that depend on the `$(exec_prefix)' Make
781 variable. This includes links to binaries, libraries, etc., not
784 * `make install-data' to install in architecture-independent
785 directories, such as documentation, configuration files, pool
788 If you use the Andrew File System, the normal path (e.g.,
789 PREFIX/bin) only gets you to a read-only copy of the files, and you
790 must specify a different path for installation. The best way to do this
791 is by setting the `prefix' variable on the `make' command line. The
792 sequence becomes something like this:
793 configure --prefix=/whatever
795 make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
796 With AFS, you will definitely want to use relative filenames in
797 `ls-R' (*note Filename database::), not absolute filenames. This is
798 done by default, but check anyway.
801 File: kpathsea.info, Node: Cleaning up, Next: Filename database generation, Prev: Installing files, Up: Custom installation
806 The basic command is `make distclean'. This removes all files created
810 * `make mostlyclean' if you intend to compile on another
811 architecture. For Web2C, since the generated C files are portable,
812 they are not removed. If the `lex' vs. `flex' situation is going
813 to be different on the next machine, `rm web2c/lex.yy.c'.
815 * `make clean' to remove files created by compiling, but leave
816 configuration files and Makefiles.
818 * `make maintainer-clean' to remove everything that the Makefiles can
819 rebuild. This is more than `distclean' removes, and you should
820 only use it if you are thoroughly conversant with (and have the
821 necessary versions of) Autoconf.
823 * `make extraclean' to remove other junk, e.g., core files, log
824 files, patch rejects. This is independent of the other `clean'
828 File: kpathsea.info, Node: Filename database generation, Next: mktex scripts, Prev: Cleaning up, Up: Custom installation
830 2.2.8 Filename database generation
831 ----------------------------------
833 You will probably want to set up a `cron' entry on the appropriate
834 machine(s) to rebuild the filename database nightly or so, as in:
835 0 0 * * * cd TEXMF && /BINDIR/mktexlsr
836 *Note Filename database::.
838 Although the `mktex...' scripts make every effort to add
839 newly-created files on the fly, it can't hurt to make sure you get a
840 fresh version every so often.
843 File: kpathsea.info, Node: mktex scripts, Next: Installation testing, Prev: Filename database generation, Up: Custom installation
845 2.2.9 `mktex' scripts
846 ---------------------
848 If Kpathsea cannot otherwise find a file, for some file types it is
849 configured by default to invoke an external program to create it
850 dynamically (*note mktex configuration::). This is most useful for
851 fonts (bitmaps, TFM's, and arbitrarily-sizable Metafont sources such as
852 the Sauter and EC fonts), since any given document can use fonts never
853 before referenced. Trying to build all fonts in advance is therefore
854 impractical, if not impossible.
856 The script is passed the name of the file to create and possibly
857 other arguments, as explained below. It must echo the full pathname of
858 the file it created (and nothing else) to standard output; it can write
859 diagnostics to standard error.
863 * mktex configuration::
864 * mktex script names::
865 * mktex script arguments::
868 File: kpathsea.info, Node: mktex configuration, Next: mktex script names, Up: mktex scripts
870 2.2.9.1 `mktex' configuration
871 .............................
873 The following file types can run an external program to create missing
874 files: `pk', `tfm', `mf', `tex'; the scripts are named `mktexpk',
875 `mktextfm', `mktexmf', and `mktextex'.
877 In the absence of `configure' options specifying otherwise,
878 everything but `mktextex' will be enabled by default. The `configure'
879 options to change the defaults are:
881 --without-mktexmf-default
882 --without-mktexpk-default
883 --without-mktextfm-default
884 --with-mktextex-default
886 The `configure' setting is overridden if the environment variable or
887 configuration file value named for the script is set; e.g., `MKTEXPK'
888 (*note mktex script arguments::).
890 As distributed, all the scripts source a file
891 `texmf/web2c/mktex.cnf' if it exists, so you can override various
892 defaults. See `mktex.opt', for instance, which defines the default
893 mode, resolution, some special directory names, etc. If you prefer not
894 to change the distributed scripts, you can simply create `mktex.cnf'
895 with the appropriate definitions (you do not need to create it if you
896 have nothing to put in it). `mktex.cnf' has no special syntax; it's an
897 arbitrary Bourne shell script. The distribution contains a sample
898 `mktex.cnf' for you to copy and modify as you please (it is not
901 In addition, you can configure a number of features with the
902 `MT_FEATURES' variable, which you can define:
903 * in `mktex.opt', as just mentioned;
905 * by editing the file `mktex.opt', either before `make install' (in
906 the source hierarchy) or after (in the installed hierarchy);
908 * or in the environment.
910 If none of the options below are enabled, `mktexpk', `mktextfm', and
911 `mktexmf' follow the following procedure to decide where fonts should
912 be installed. Find the tree where the font's sources are, and test the
913 permissions of the `fonts' directory of that tree to determine whether
914 it is writable. If it is, put the files in the tree in appropriate
915 locations. If it isn't writable, see whether the tree is a system tree
916 (named in `SYSTEXMF'). If so, the `VARTEXFONTS' tree is used. In all
917 other cases the working directory is used.
919 The `appendonlydir' option is enabled by default.
922 Tell `mktexdir' to create directories append-only, i.e., set their
923 sticky bit (*note Mode Structure: (coreutils)Mode Structure.).
924 This feature is silently ignored on non-Unix platforms (e.g.
925 Windows/NT and MS-DOS) which don't support similar functionality.
926 This feature is enabled by default.
929 Use 8.3 names; e.g., `dpi600/cmr10.pk' instead of `cmr10.600pk'.
930 Note that this feature only affects filenames that would otherwise
931 clash with other TeX-related filenames; `mktex' scripts do nothing
932 about filenames which exceed the 8+3 MS-DOS limits but remain
933 unique when truncated (by the OS) to these limits, and nether do
934 the scripts care about possible clashes with files which aren't
935 related with TeX. For example, `cmr10.600pk' would clash with
936 `cmr10.600gf' and is therefore changed when `dosnames' is in
937 effect, but `mf.pool' and `mp.base' don't clash with any
938 TeX-related files and are therefore unchanged.
940 This feature is turned on by default on MS-DOS. If you do not wish
941 `dosnames' to be set on an MS-DOS platform, you need to set the
942 `MT_FEATURES' environment variable to a value that doesn't include
943 `dosnames'. You can also change the default setting by editing
944 `mktex.opt', but only if you use the `mktex' shell scripts; the
945 emulation programs don't consult `mktex.opt'.
948 Instead of deriving the location of a font in the destination tree
949 from the location of the sources, the aliases and directory names
950 from the Fontname distribution are used. (*note Introduction:
954 Let mktexpk and mktextfm create metafont driver files in a
955 temporary directory. These will be used for just one metafont run
956 and not installed permanently.
959 Omit the directory level for the mode name; this is fine as long as
960 you generate fonts for only one mode.
963 Omit the font supplier name directory level.
966 Omit the font typeface name directory level.
969 Omit the font supplier and typeface name directory levels. This
970 feature is deprecated in favour of `stripsupplier' and
974 When this option is enabled, fonts that would otherwise be written
975 in system texmf tree go to the `VARTEXFONTS' tree instead. The
976 default value in `kpathsea/Makefile.in' is `/var/tmp/texfonts'.
977 The `Linux File System Standard' recommends `/var/tex/fonts'.
979 The `varfonts' setting in `MT_FEATURES' is overridden by the
980 `USE_VARTEXFONTS' environment variable: if set to `1', the feature
981 is enabled, and if set to `0', the feature is disabled.
984 Force generated files that would go into a system tree (as defined
985 by `SYSTEXMF') into `TEXMFVAR'. Starting with teTeX-3.0, the
986 variable `TEXMFVAR' is always set. The `varfonts' feature takes
987 precedence if also set.
989 The `texmfvar' setting in `MT_FEATURES' is overridden by the
990 `USE_TEXMFVAR' environment variable: if set to `1', the feature is
991 enabled, and if set to `0', the feature is disabled.
994 File: kpathsea.info, Node: mktex script names, Next: mktex script arguments, Prev: mktex configuration, Up: mktex scripts
996 2.2.9.2 `mktex' script names
997 ............................
999 The following table shows the default name of the script for each
1000 possible file types. (The source is the variable `kpse_make_specs' in
1001 `kpathsea/tex-make.c'.)
1010 Metafont input files.
1015 These names are overridden by an environment variable specific to the
1016 program--for example, `DVIPSMAKEPK' for Dvipsk.
1018 If a `mktex...' script fails, the invocation is appended to a file
1019 `missfont.log' (by default) in the current directory. You can then
1020 execute the log file to create the missing files after fixing the
1023 If the current directory is not writable and the environment
1024 variable or configuration file value `TEXMFOUTPUT' is set, its value is
1025 used. Otherwise, nothing is written. The name `missfont.log' is
1026 overridden by the `MISSFONT_LOG' environment variable or configuration
1030 File: kpathsea.info, Node: mktex script arguments, Prev: mktex script names, Up: mktex scripts
1032 2.2.9.3 `mktex' script arguments
1033 ................................
1035 The first argument to a `mktex' script is always the name of the file
1038 In the default `mktexpk' implementation, additional arguments may
1042 Sets the resolution of the generated font to NUM.
1045 Sets the Metafont mode to NAME.
1048 Sets the the "base dpi" for the font. This must match the mode
1052 A "magstep" string suitable for the Metafont `mag' variable. This
1053 must match the combination of BDPI and DPI being used.
1056 A directory name. If the directory is absolute, it is used as-is.
1057 Otherwise, it is appended to the root destination directory set in
1061 File: kpathsea.info, Node: Installation testing, Prev: mktex scripts, Up: Custom installation
1063 2.2.10 Installation testing
1064 ---------------------------
1066 Besides the tests listed in *note Simple installation::, you can try
1067 running `make check'. This includes the torture tests (trip, trap, and
1068 mptrap) that come with Web2c (*note Triptrap: (web2c)Triptrap.).
1071 File: kpathsea.info, Node: Security, Next: TeX directory structure, Prev: Custom installation, Up: Installation
1076 None of the programs in the TeX system require any special system
1077 privileges, so there's no first-level security concern of people gaining
1078 illegitimate root access.
1080 A TeX document, however, can write to arbitrary files, e.g.,
1081 `~/.rhosts', and thus an unwitting user who runs TeX on a random
1082 document is vulnerable to a trojan horse attack. This loophole is
1083 closed by default, but you can be permissive if you so desire in
1084 `texmf.cnf'. *Note tex invocation: (web2c)tex invocation. MetaPost has
1087 Dvips, Xdvi, and TeX can also execute shell commands under some
1088 circumstances. To disable this, see the `-R' option in *note Option
1089 details: (dvips)Option details, the xdvi man page, and *note tex
1090 invocation: (web2c)tex invocation, respectively.
1092 Another security issue arises because it's very useful--almost
1093 necessary--to make arbitrary fonts on user demand with `mktexpk' and
1094 friends. Where do these files get installed? By default, the
1095 `mktexpk' distributed with Kpathsea assumes a world-writable `/var/tmp'
1096 directory; this is a simple and convenient approach, but it may not
1097 suit your situation because it means that a local cache of fonts is
1098 created on every machine.
1100 To avoid this duplication, many people consider a shared, globally
1101 writable font tree desirable, in spite of the potential security
1102 problems. To do this you should change the value of `VARTEXFONTS' in
1103 `texmf.cnf' to refer to some globally known directory. *Note mktex
1106 The first restriction you can apply is to make newly-created
1107 directories under `texmf' be append-only with an option in `mktex.cnf'.
1108 *Note mktex configuration::.
1110 Another approach is to establish a group (or user) for TeX files,
1111 make the `texmf' tree writable only to that group (or user), and make
1112 `mktexpk' et al. setgid to that group (or setuid to that user). Then
1113 users must invoke the scripts to install things. (If you're worried
1114 about the inevitable security holes in scripts, then you could write a
1115 C wrapper to exec the script.)
1117 The `mktex...' scripts install files with the same read and write
1118 permissions as the directory they are installed in. The executable,
1119 sgid, suid, and sticky bits are always cleared.
1121 Any directories created by the `mktex...' scripts have the same
1122 permissions as their parent directory, unless the `appendonlydir'
1123 feature is used, in which case the sticky bit is always set.
1126 File: kpathsea.info, Node: TeX directory structure, Next: unixtex.ftp, Prev: Security, Up: Installation
1128 2.4 TeX directory structure
1129 ===========================
1131 This section describes the default installation hierarchy of the
1132 distribution. It conforms to both the GNU coding standards and the TeX
1133 directory structure (TDS) standard. For rationale and further
1134 explanation, please see those documents. The GNU standard is available
1135 as `ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi' and
1136 mirrors. The TDS document is available from `CTAN:/tex-archive/tds'
1137 (*note unixtex.ftp::).
1139 You can change the default paths in many ways (*note Changing search
1140 paths::). One common desire is to put everything (binaries and all)
1141 under a single top-level directory such as `/usr/local/texmf' or
1142 `/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
1143 For specific instructions on doing that, see *note configure
1146 Here is a skeleton of the default directory structure, extracted from
1149 PREFIX/ installation root (`/usr/local' by default)
1152 include/ C header files
1153 info/ GNU info files
1154 lib/ libraries (`libkpathsea.*')
1155 share/ architecture-independent files
1157 bibtex/ BibTeX input files
1158 bib/ BibTeX databases
1159 base/ base distribution (e.g., `xampl.bib')
1160 misc/ single-file databases
1161 PKG/ name of a package
1162 bst/ BibTeX style files
1163 base/ base distribution (e.g., `plain.bst', `acm.bst')
1164 misc/ single-file styles
1165 PKG/ name of a package
1166 doc/ additional documentation
1167 dvips/ `.pro', `.ps', `psfonts.map'
1168 fonts/ font-related files
1169 TYPE/ file type (e.g., `tfm', `pk')
1170 MODE/ type of output device (types `pk' and `gf' only)
1171 SUPPLIER/ name of a font supplier (e.g., `public')
1172 TYPEFACE/ name of a typeface (e.g., `cm')
1173 dpiNNN/ font resolution (types `pk' and `gf' only)
1174 metafont/ Metafont (non-font) input files
1175 base/ base distribution (e.g., `plain.mf')
1176 misc/ single-file packages (e.g., `modes.mf')
1177 PKG/ name of a package (e.g., `mfpic')
1178 metapost/ MetaPost input files
1179 base/ base distribution (e.g., `plain.mp')
1180 misc/ single-file packages
1181 PKG/ name of a package
1182 support/ support files for MetaPost-related utilities (e.g., `trfonts.map')
1183 mft/ `MFT' inputs (e.g., `plain.mft')
1184 tex/ TeX input files
1185 FORMAT/ name of a format (e.g., `plain')
1186 base/ base distribution for FORMAT (e.g., `plain.tex')
1187 misc/ single-file packages (e.g., `webmac.tex')
1188 local/ local additions to or local configuration files for FORMAT
1189 PKG/ name of a package (e.g., `graphics', `mfnfss')
1190 generic/ format-independent packages
1191 hyphen/ hyphenation patterns (e.g., `hyphen.tex')
1192 images/ image input files (e.g., Encapsulated PostScript)
1193 misc/ single-file format-independent packages (e.g., `null.tex').
1194 PKG/ name of a package (e.g., `babel')
1195 web2c/ implementation-dependent files (`.pool', `.fmt', `texmf.cnf', etc.)
1197 Some concrete examples for most file types:
1200 /usr/local/man/man1/xdvi.1
1201 /usr/local/info/kpathsea.info
1202 /usr/local/lib/libkpathsea.a
1203 /usr/local/share/texmf/bibtex/bst/base/plain.bst
1204 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1205 /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
1206 /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
1207 /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
1208 /usr/local/share/texmf/metafont/base/plain.mf
1209 /usr/local/share/texmf/metapost/base/plain.mp
1210 /usr/local/share/texmf/tex/plain/base/plain.tex
1211 /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
1212 /usr/local/share/texmf/web2c/tex.pool
1213 /usr/local/share/texmf/web2c/tex.fmt
1214 /usr/local/share/texmf/web2c/texmf.cnf
1217 File: kpathsea.info, Node: unixtex.ftp, Next: Reporting bugs, Prev: TeX directory structure, Up: Installation
1219 2.5 `unixtex.ftp': Obtaining TeX
1220 ================================
1222 This is `ftp://ftp.tug.org/tex/unixtex.ftp', last updated 26 December
1223 2003. Also available as `http://www.tug.org/unixtex.ftp'. The IP
1224 address is currently `[130.225.2.178]'. It is also in Kpathsea source
1225 distributions as `etc/unixtex.ftp' (although the network version is
1226 usually newer). Mail <tex-k@mail.tug.org> with comments or questions.
1228 Following are general instructions for Unix or other sites who wish
1229 to acquire the Web2c distribution, (plain) TeX, LaTeX (2e), BibTeX,
1230 Metafont, MetaPost, DVI processors for the X window system, PostScript,
1231 the PCL language in the HP LaserJet, and related programs. They are
1232 oriented towards building from the original sources, though some
1233 information on alternative packages is included in the last section.
1234 See also `http://www.tug.org/web2c/', the Web2c and Kpathsea home page.
1236 Please note that the Web2c distribution is a bare-bones distribution
1237 in source form, and building a complete installation from it is a
1238 non-trivial matter. For most uses, it is a better idea to install a
1239 distribution with pre-packaged binaries for your platform. The
1240 principal example of such a distribution is TeX Live
1241 (`http://www.tug.org/texlive/'), which is based on the Web2c sources.
1243 Please consider joining the TeX Users Group (TUG) or another user
1244 group of your choice to help support the maintenance and development of
1245 the programs you retrieve. See `http://www.tug.org/join.html' for
1246 information and the membership registration form, and
1247 `http://www.tug.org/usergroups.html' for a listing of all user groups.
1249 For actual installation instructions after obtaining the necessary
1250 sources, see *note Installation::. A copy is in the distribution file
1255 * Electronic distribution:: CTAN and so forth.
1256 * CD-ROM distribution::
1257 * Other TeX packages::
1260 File: kpathsea.info, Node: Electronic distribution, Next: CD-ROM distribution, Up: unixtex.ftp
1262 2.5.1 Electronic distribution
1263 -----------------------------
1265 In many places we refer to CTAN:. This is _both_ a host name and a
1266 directory name. Here are the primary locations:
1268 `ftp://ctan.tug.org/tex-archive/' (Vermont, USA)
1269 `ftp://ftp.dante.de/tex-archive/' (Germany)
1270 `ftp://ftp.tex.ac.uk/tex-archive/' (England)
1272 CTAN has many mirrors worldwide; see the top-level file
1273 `README.mirrors' from one of the sites above or see
1274 `http://www.tug.org/CTAN.sites'.
1276 You can also access CTAN via the World Wide Web, electronic mail, or
1277 NFS. The same `README.mirrors' file explains how.
1279 You will need to retrieve some or all of the following archives,
1280 depending on your needs (don't forget to set binary mode for file
1283 `CTAN:/systems/web2c/web.tar.gz'
1284 The original WEB source files, written primarily by Don Knuth.
1285 Required unless you already have this `web' version. (The WEB
1286 sources change irregularly with respect to Web2c itself.) Unpacks
1287 into `web2c-VERSION'.
1289 `CTAN:/systems/web2c/web2c.tar.gz'
1290 The Web2c system. Required. Also unpacks into `web2c-VERSION'.
1292 `CTAN:/systems/web2c/web2c-etex.tar.gz'
1293 Additions to the Web2c system for building e-TeX. Optional.
1294 Unpacks into `web2c-VERSION'.
1296 `CTAN:/systems/web2c/etexlib.tar.gz'
1297 Additions to the texmf tree needed to build e-TeX. Optional.
1298 Unpacks into `texmf/'.
1300 `CTAN:/systems/web2c/etexdoc.tar.gz'
1301 Documentation for e-TeX as an addition to the texmf tree.
1302 Optional. Unpacks into `texmf/'.
1304 `CTAN:/systems/web2c/web2c-omega.tar.gz'
1305 Additions to the Web2c system for building Omega. Optional.
1306 Unpacks into `web2c-VERSION'.
1308 `CTAN:/systems/web2c/omegalib.tar.gz'
1309 Additions to the texmf tree needed to build Omega. Optional.
1310 Unpacks into `texmf/'.
1312 `CTAN:/systems/web2c/omegadoc.tar.gz'
1313 Documentation for Omega as an addition to the texmf tree.
1314 Optional. Unpacks into `texmf/'.
1316 `CTAN:/systems/web2c/web2c-pdftex.tar.gz'
1317 Additions to the Web2c system for building pdfTeX. Optional.
1318 Unpacks into `web2c-VERSION'.
1320 `CTAN:/systems/web2c/pdftexlib.tar.gz'
1321 Additions to the texmf tree needed to build pdfTeX. Optional.
1322 Unpacks into `texmf/'.
1324 `CTAN:/dviware/xdvik/xdvik.tar.gz'
1325 X window system DVI previewer. Unpacks into `xdvik-VERSION'.
1328 Additional drivers, macro files, and other support are needed to
1329 build a working system. These are available in teTeX.
1331 All that said, the originating host for the software above is
1332 `ftp.tug.org'. You can retrieve these distributions (but not much
1333 else) from the `tex/' directory on that host.
1336 File: kpathsea.info, Node: CD-ROM distribution, Next: Other TeX packages, Prev: Electronic distribution, Up: unixtex.ftp
1338 2.5.2 CD-ROM distribution
1339 -------------------------
1341 Numerous organizations distribute various TeX CD-ROM's (and DVD's):
1343 * Virtually all the TeX user groups collaborate to produce the `TeX
1344 Live' distribution once a year; see `http://www.tug.org/texlive/'
1345 for more information.
1347 * The Free Software Foundation's `Source Code CD-ROM' contains the
1348 minimal TeX source distribution described in the previous section
1349 (i.e., enough to print GNU documentation); email <gnu@gnu.org>.
1351 * Most Linux distributions include some TeX package based on Web2c;
1352 see the Linux documentation file `Distribution-HOWTO' for a
1353 comparison of Linux distributions, available (for example) via
1354 `http://www.linux.org'.
1356 If you know of additional TeX distributions to add to this list,
1357 please inform <tex-k@mail.tug.org>.
1360 File: kpathsea.info, Node: Other TeX packages, Prev: CD-ROM distribution, Up: unixtex.ftp
1362 2.5.3 Other TeX packages
1363 ------------------------
1365 Many other TeX implementations are available in `CTAN:/systems',
1366 including ready-to-run distributions for Unix, Amiga, Acorn, VMS,
1367 Macintosh, DOS, and Windows (in various forms). Although Web2c has
1368 support in the source code for many operating systems, and in fact some
1369 of the other distributions are based on it, it's unlikely to work as
1370 distributed on anything but Unix. (Please contribute improvements!)
1372 The principal user-oriented Unix distribution based on Web2c is the
1373 teTeX distribution. It includes complete sources, and runs on all
1374 modern Unix variants, including Linux. It contains many TeX-related
1375 programs besides those in the core Web2c.
1377 The host labrea.stanford.edu is the original source for the files
1378 for which Donald Knuth is directly responsible: `tex.web', `plain.tex',
1379 etc. However, unless you want to build your TeX library tree ab initio,
1380 it is more reliable and less work to retrieve these files as part of
1381 the above packages. In any case, labrea is not the canonical source for
1382 anything except what was created by Stanford TeX project, so do not
1383 rely on all the files available at that ftp site being up-to-date.
1386 File: kpathsea.info, Node: Reporting bugs, Prev: unixtex.ftp, Up: Installation
1391 (A copy of this chapter is in the file `kpathsea/BUGS'.)
1393 If you have problems or suggestions, please report them to
1394 <tex-k@mail.tug.org> using the bug checklist below.
1396 Please report bugs in the documentation; not only factual errors or
1397 inconsistent behavior, but unclear or incomplete explanations, typos,
1402 * Bug checklist:: What to include in a good bug report.
1403 * Mailing lists:: Joining the bugs or announcements mailing lists.
1404 * Debugging:: Analyzing runtime problems.
1405 * Logging:: Recording searches.
1406 * Common problems:: When things go wrong.
1409 File: kpathsea.info, Node: Bug checklist, Next: Mailing lists, Up: Reporting bugs
1414 Before reporting a bug, please check below to be sure it isn't already
1415 known (*note Common problems::).
1417 Bug reports should be sent via electronic mail to
1418 <tex-k@mail.tug.org>.
1420 The general principle is that a good bug report includes all the
1421 information necessary for reproduction. Therefore, to enable
1422 investigation, your report should include the following:
1424 * The version number(s) of the program(s) involved, and of Kpathsea
1425 itself. You can get the former by giving a sole option `--version'
1426 to the program, and the latter by running `kpsewhich --version'.
1427 The `NEWS' and `ChangeLog' files also contain the version number.
1429 * The hardware, operating system (including version number),
1430 compiler, and `make' program you are using (the output of `uname
1431 -a' is a start on the first two, though often incomplete). If the
1432 bug involves the X window system, include X version and supplier
1433 information as well (examples: X11R6 from MIT; X11R4 from HP;
1434 OpenWindows 3.3 bundled with SunOS 4.1.4).
1436 * Any options you gave to `configure'. This is recorded in the
1437 `config.status' files.
1439 If you are reporting a bug in `configure' itself, it's probably
1440 system-dependent, and it will be unlikely the maintainers can do
1441 anything useful if you merely report that thus-and-such is broken.
1442 Therefore, you need to do some additional work: for some bugs, you
1443 can look in the file `config.log' where the test that failed should
1444 appear, along with the compiler invocation and source program in
1445 question. You can then compile it yourself by hand, and discover
1446 why the test failed. Other `configure' bugs do not involve the
1447 compiler; in that case, the only recourse is to inspect the
1448 `configure' shell script itself, or the Autoconf macros that
1449 generated `configure'.
1451 * The log of all debugging output, if the bug is in path searching.
1452 You can get this by setting the environment variable
1453 `KPATHSEA_DEBUG' to `-1' before running the program. Please look
1454 at the log yourself to make sure the behavior is really a bug
1455 before reporting it; perhaps "old" environment variable settings
1456 are causing files not to be found, for example.
1458 * The contents of any input files necessary to reproduce the bug.
1459 For bugs in DVI-reading programs, for example, this generally
1460 means a DVI file (and any EPS or other files it uses)--TeX source
1461 files are helpful, but the DVI file is necessary, because that's
1462 the actual program input.
1464 * If you are sending a patch (do so if you can!), please do so in
1465 the form of a context diff (`diff -c') against the original
1466 distribution source. Any other form of diff is either not as
1467 complete or harder for me to understand. Please also include a
1470 * If the bug involved is an actual crash (i.e., core dump), it is
1471 easy and useful to include a stack trace from a debugger (I
1472 recommend the GNU debugger GDB, available from
1473 `ftp://prep.ai.mit.edu/pub/gnu'). If the cause is apparent (a
1474 `NULL' value being dereferenced, for example), please send the
1475 details along. If the program involved is TeX or Metafont, and
1476 the crash is happening at apparently-sound code, however, the bug
1477 may well be in the compiler, rather than in the program or the
1478 library (*note TeX or Metafont failing: TeX or Metafont failing.).
1480 * Any additional information that will be helpful in reproducing,
1481 diagnosing, or fixing the bug.
1484 File: kpathsea.info, Node: Mailing lists, Next: Debugging, Prev: Bug checklist, Up: Reporting bugs
1489 Web2c and Kpathsea in general are discussed on the mailing list
1490 <tex-k@mail.tug.org>. To join, email <tex-k-request@mail.tug.org> with
1491 a line consisting of
1493 subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
1495 in the body of the message.
1497 You do not need to join to submit a report, nor will it affect
1498 whether you get a response. There is no Usenet newsgroup equivalent
1499 (if you can be the one to set this up, email `tex-k-request'). Traffic
1500 on the list is fairly light, and is mainly bug reports and enhancement
1501 requests to the software. The best way to decide if you want to join
1502 or not is read some of the archives from
1503 `ftp://ftp.tug.org/mail/archives/tex-k/'.
1505 Be aware that large data files are sometimes included in bug reports.
1506 If this is a problem for you, do not join the list.
1508 If you only want announcements of new releases, not bug reports and
1509 discussion, join <tex-archive@math.utah.edu> (via mail to
1510 <tex-archive-request@math.utah.edu>).
1512 If you are looking for general TeX help, such as how to use LaTeX,
1513 please use the mailing list <info-tex@shsu.edu> mailing list, which is
1514 gatewayed to the `comp.text.tex' Usenet newsgroup (or post to the
1515 newsgroup; the gateway is bidirectional).
1518 File: kpathsea.info, Node: Debugging, Next: Logging, Prev: Mailing lists, Up: Reporting bugs
1523 Kpathsea provides a number of runtime debugging options, detailed below
1524 by their names and corresponding numeric values. When the files you
1525 expect aren't being found, the thing to do is enable these options and
1528 You can set these with some runtime argument (e.g., `-d') to the
1529 program; in that case, you should use the numeric values described in
1530 the program's documentation (which, for Dvipsk and Xdvik, are different
1531 than those below). It's best to give the `-d' (or whatever) option
1532 first, for maximal output. Dvipsk and Xdvik have additional
1533 program-specific debugging options as well.
1535 You can also set the environment variable `KPATHSEA_DEBUG'; in this
1536 case, you should use the numbers below. If you run the program under a
1537 debugger and set the variable `kpathsea_debug', also use the numbers
1540 In any case, by far the simplest value to use is `-1', which will
1541 turn on all debugging output. This is usually better than guessing
1542 which particular values will yield the output you need.
1544 Debugging output always goes to standard error, so you can redirect
1545 it easily. For example, in Bourne-compatible shells:
1546 dvips -d -1 ... 2>/tmp/debug
1548 It is sometimes helpful to run the standalone Kpsewhich utility
1549 (*note Invoking kpsewhich::), instead of the original program.
1551 In any case, you can _not_ use the _names_ below; you must always
1552 use somebody's numbers. (Sorry.) To set more than one option, just
1553 sum the corresponding numbers.
1555 `KPSE_DEBUG_STAT (1)'
1556 Report `stat'(2) calls. This is useful for verifying that your
1557 directory structure is not forcing Kpathsea to do many additional
1558 file tests (*note Slow path searching::, and *note Subdirectory
1559 expansion::). If you are using an up-to-date `ls-R' database
1560 (*note Filename database::), this should produce no output unless a
1561 nonexistent file that must exist is searched for.
1563 `KPSE_DEBUG_HASH (2)'
1564 Report lookups in all hash tables: `ls-R' and `aliases' (*note
1565 Filename database::); font aliases (*note Fontmap::); and config
1566 file values (*note Config files::). Useful when expected values
1567 are not being found, e.g.., file searches are looking at the disk
1568 instead of using `ls-R'.
1570 `KPSE_DEBUG_FOPEN (4)'
1571 Report file openings and closings. Especially useful when your
1572 system's file table is full, for seeing which files have been
1573 opened but never closed. In case you want to set breakpoints in a
1574 debugger: this works by redefining `fopen' (`fclose') to be
1575 `kpse_fopen_trace' (`kpse_fclose_trace').
1577 `KPSE_DEBUG_PATHS (8)'
1578 Report general path information for each file type Kpathsea is
1579 asked to search. This is useful when you are trying to track down
1580 how a particular path got defined--from `texmf.cnf', `config.ps',
1581 an environment variable, the compile-time default, etc. This is
1582 the contents of the `kpse_format_info_type' structure defined in
1585 `KPSE_DEBUG_EXPAND (16)'
1586 Report the directory list corresponding to each path element
1587 Kpathsea searches. This is only relevant when Kpathsea searches
1588 the disk, since `ls-R' searches don't look through directory lists
1591 `KPSE_DEBUG_SEARCH (32)'
1592 Report on each file search: the name of the file searched for, the
1593 path searched in, whether or not the file must exist (when drivers
1594 search for `cmr10.vf', it need not exist), and whether or not we
1595 are collecting all occurrences of the file in the path (as with,
1596 e.g., `texmf.cnf' and `texfonts.map'), or just the first (as with
1597 most lookups). This can help you correlate what Kpathsea is doing
1598 with what is in your input file.
1600 `KPSE_DEBUG_VARS (64)'
1601 Report the value of each variable Kpathsea looks up. This is
1602 useful for verifying that variables do indeed obtain their correct
1605 `GSFTOPK_DEBUG (128)'
1606 Activates debugging printout specific to `gsftopk' program.
1608 `MAKETEX_DEBUG (512)'
1609 If you use the optional `mktex' programs instead of the
1610 traditional shell scripts, this will report the name of the site
1611 file (`mktex.cnf' by default) which is read, directories created by
1612 `mktexdir', the full path of the `ls-R' database built by
1613 `mktexlsr', font map searches, `MT_FEATURES' in effect, parameters
1614 from `mktexnam', filenames added by `mktexupd', and some
1615 subsidiary commands run by the programs.
1617 `MAKETEX_FINE_DEBUG (1024)'
1618 When the optional `mktex' programs are used, this will print
1619 additional debugging info from functions internal to these
1622 Debugging output from Kpathsea is always written to standard error,
1623 and begins with the string `kdebug:'. (Except for hash table buckets,
1624 which just start with the number, but you can only get that output
1625 running under a debugger. See comments at the `hash_summary_only'
1626 variable in `kpathsea/db.c'.)
1629 File: kpathsea.info, Node: Logging, Next: Common problems, Prev: Debugging, Up: Reporting bugs
1634 Kpathsea can record the time and filename found for each successful
1635 search. This may be useful in finding good candidates for deletion when
1636 your filesystem is full, or in discovering usage patterns at your site.
1638 To do this, define the environment or config file variable
1639 `TEXMFLOG'. The value is the name of the file to append the
1640 information to. The file is created if it doesn't exist, and appended
1643 Each successful search turns into one line in the log file: two words
1644 separated by a space. The first word is the time of the search, as the
1645 integer number of seconds since "the epoch", i.e., UTC midnight 1
1646 January 1970 (more precisely, the result of the `time' system call).
1647 The second word is the filename.
1649 For example, after `setenv TEXMFLOG /tmp/log', running Dvips on
1650 `story.dvi' appends the following lines:
1652 774455887 /usr/local/share/texmf/dvips/config.ps
1653 774455887 /usr/local/share/texmf/dvips/psfonts.map
1654 774455888 /usr/local/share/texmf/dvips/texc.pro
1655 774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
1656 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
1657 774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
1658 774455889 /usr/local/share/texmf/dvips/texc.pro
1660 Only filenames that are absolute are recorded, to preserve some
1661 semblance of privacy.
1663 In addition to this Kpathsea-specific logging, `pdftex' provides an
1664 option `-recorder' to write the names of all files accessed during a
1665 run to the file `BASEFILE.fls'.
1667 Finally, most systems provide a general tool to output each system
1668 call, thus including opening and closing files. It might be named
1669 `strace', `truss', `struss', or something else.
1672 File: kpathsea.info, Node: Common problems, Prev: Logging, Up: Reporting bugs
1674 2.6.5 Common problems
1675 ---------------------
1677 Here are some common problems with configuration, compilation, linking,
1682 * Unable to find files:: If your program can't find fonts (or whatever).
1683 * Slow path searching:: If it takes forever to find anything.
1684 * Unable to generate fonts:: If mktexpk fails.
1685 * TeX or Metafont failing:: Likely compiler bugs.
1687 * Empty Makefiles:: When configure produces empty makefiles.
1688 * XtStrings:: When _XtStrings is undefined.
1689 * dlopen:: When dlopen is undefined.
1690 * ShellWidgetClass:: For dynamic linking troubles under OpenWindows.
1691 * Pointer combination warnings:: For old compilers that don't grok char *.
1694 File: kpathsea.info, Node: Unable to find files, Next: Slow path searching, Up: Common problems
1696 2.6.5.1 Unable to find files
1697 ............................
1699 If a program complains it cannot find fonts (or other input files), any
1700 of several things might be wrong. In any case, you may find the
1701 debugging options helpful. *Note Debugging::.
1703 * Perhaps you simply haven't installed all the necessary files; the
1704 basic fonts and input files are distributed separately from the
1705 programs. *Note unixtex.ftp::.
1707 * You have (perhaps unknowingly) told Kpathsea to use search paths
1708 that don't reflect where the files actually are. One common cause
1709 is having environment variables set from a previous installation,
1710 thus overriding what you carefully set in `texmf.cnf' (*note
1711 Supported file formats::). System `/etc/profile' or other files
1712 such may be the culprit.
1714 * Your files reside in a directory that is only pointed to via a
1715 symbolic link, in a leaf directory and is not listed in `ls-R'.
1717 Unfortunately, Kpathsea's subdirectory searching has an
1718 irremediable deficiency: If a directory D being searched for
1719 subdirectories contains plain files and symbolic links to other
1720 directories, but no true subdirectories, D will be considered a
1721 leaf directory, i.e., the symbolic links will not be followed.
1722 *Note Subdirectory expansion::.
1724 You can work around this problem by creating an empty dummy
1725 subdirectory in D. Then D will no longer be a leaf, and the
1726 symlinks will be followed.
1728 The directory immediately followed by the `//' in the path
1729 specification, however, is always searched for subdirectories,
1730 even if it is a leaf. Presumably you would not have asked for the
1731 directory to be searched for subdirectories if you didn't want it
1734 * If the fonts (or whatever) don't already exist, `mktexpk' (or
1735 `mktexmf' or `mktextfm') will try to create them. If these rather
1736 complicated shell scripts fail, you'll eventually get an error
1737 message saying something like `Can't find font FONTNAME'. The best
1738 solution is to fix (or at least report) the bug in `mktexpk'; the
1739 workaround is to generate the necessary fonts by hand with
1740 Metafont, or to grab them from a CTAN site (*note unixtex.ftp::).
1742 * There is a bug in the library. *Note Reporting bugs::.
1745 File: kpathsea.info, Node: Slow path searching, Next: Unable to generate fonts, Prev: Unable to find files, Up: Common problems
1747 2.6.5.2 Slow path searching
1748 ...........................
1750 If your program takes an excessively long time to find fonts or other
1751 input files, but does eventually succeed, here are some possible
1754 * Most likely, you just have a lot of directories to search, and that
1755 takes a noticeable time. The solution is to create and maintain a
1756 separate `ls-R' file that lists all the files in your main TeX
1757 hierarchy. *Note Filename database::. Kpathsea always uses `ls-R'
1758 if it's present; there's no need to recompile or reconfigure any
1761 * Your recursively-searched directories (e.g.,
1762 `/usr/local/share/texmf/fonts//'), contain a mixture of files and
1763 directories. This prevents Kpathsea from using a useful
1764 optimization (*note Subdirectory expansion::).
1766 It is best to have only directories (and perhaps a `README') in the
1767 upper levels of the directory structure, and it's very important
1768 to have _only_ files, and no subdirectories, in the leaf
1769 directories where the dozens of TFM, PK, or whatever files reside.
1771 In any case, you may find the debugging options helpful in
1772 determining precisely when the disk or network is being pounded. *Note
1776 File: kpathsea.info, Node: Unable to generate fonts, Next: TeX or Metafont failing, Prev: Slow path searching, Up: Common problems
1778 2.6.5.3 Unable to generate fonts
1779 ................................
1781 Metafont outputs fonts in bitmap format, tuned for a particular device
1782 at a particular resolution, in order to allow for the highest-possible
1783 quality of output. Some DVI-to-whatever programs, such as Dvips, try
1784 to generate these on the fly when they are needed, but this generation
1785 may fail in several cases.
1787 If `mktexpk' runs, but fails with this error:
1788 mktexpk: Can't guess mode for NNN dpi devices.
1789 mktexpk: Use a config file to specify the mode, or update me.
1790 you need to ensure the resolution and mode match; just specifying
1791 the resolution, as in `-D 360', is not enough.
1793 You can specify the mode name with the `-mode' option on the Dvips
1794 command line, or in a Dvips configuration file (*note Config files:
1795 (dvips)Config files.), such as `config.ps' in your document directory,
1796 `~/.dvipsrc' in your home directory, or in a system directory (again
1797 named `config.ps'). (Other drivers use other files, naturally.)
1799 For example, if you need 360dpi fonts, you could include this in a
1804 If Metafont runs, but generates fonts at the wrong resolution or for
1805 the wrong device, most likely `mktexpk''s built-in guess for the mode
1806 is wrong, and you should override it as above.
1808 See `ftp://ftp.tug.org/tex/modes.mf' for a list of resolutions and
1809 mode names for most devices (additional submissions are welcome).
1811 If Metafont runs but generates fonts at a resolution of 2602dpi (and
1812 prints out the name of each character as well as just a character
1813 number, and maybe tries to display the characters), then your Metafont
1814 base file probably hasn't been made properly. (It's using the default
1815 `proof' mode, instead of an actual device mode.) To make a proper
1816 `plain.base', assuming the local mode definitions are contained in a
1817 file `modes.mf', run the following command (assuming Unix):
1819 inimf "plain; input modes; dump"
1821 Then copy the `plain.base' file from the current directory to where the
1822 base files are stored on your system (`/usr/local/share/texmf/web2c' by
1823 default), and make a link (either hard or soft) from `plain.base' to
1824 `mf.base' in that directory. *Note inimf invocation: (web2c)inimf
1827 If `mf' is a command not found at all by `mktexpk', then you need to
1828 install Metafont (*note unixtex.ftp::).
1831 File: kpathsea.info, Node: TeX or Metafont failing, Next: Empty Makefiles, Prev: Unable to generate fonts, Up: Common problems
1833 2.6.5.4 TeX or Metafont failing
1834 ...............................
1836 If TeX or Metafont get a segmentation fault or otherwise fail while
1837 running a normal input file, the problem is usually a compiler bug
1838 (unlikely as that may sound). Even if the trip and trap tests are
1839 passed, problems may lurk. Optimization occasionally causes trouble in
1840 programs other than TeX and Metafont themselves, too.
1842 Insufficient swap space may also cause core dumps or other erratic
1845 For a workaround, if you enabled any optimization flags, it's best to
1846 omit optimization entirely. In any case, the way to find the facts is
1847 to run the program under the debugger and see where it's failing.
1849 Also, if you have trouble with a system C compiler, I advise trying
1850 the GNU C compiler. And vice versa, unfortunately; but in that case I
1851 also recommend reporting a bug to the GCC mailing list; see *note Bugs:
1854 To report compiler bugs effectively requires perseverance and
1855 perspicacity: you must find the miscompiled line, and that usually
1856 involves delving backwards in time from the point of error, checking
1857 through TeX's (or whatever program's) data structures. Things are not
1858 helped by all-too-common bugs in the debugger itself. Good luck.
1860 One known cause of trouble is the way arrays are handled. Some of
1861 the Pascal arrays have a lower index other than 0, and the C code will
1862 take the pointer to the allocated memory, subtract the lower index, and
1863 use the resulting pointer for the array. While this trick often works,
1864 ANSI C doesn't guarantee that it will. It it known to fail on HP-UX 10
1865 mchines when the native compiler is used, unless the `+u' compiler
1866 switch was specified. Using GCC will work on this platform as well.
1869 File: kpathsea.info, Node: Empty Makefiles, Next: XtStrings, Prev: TeX or Metafont failing, Up: Common problems
1871 2.6.5.5 Empty Makefiles
1872 .......................
1874 On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), `configure' may
1875 fail to properly create the Makefiles. Instead, you get an error which
1876 looks something like this:
1881 sed: 1: "\\@^ac_include make/pat ...": \ can not be used as a string delimiter
1883 So far as I know, the bug here is in `/bin/sh' on these systems. I
1884 don't have access to a machine running any of them, so if someone can
1885 find a workaround that avoids the quoting bug, I'd be most grateful.
1886 (Search for `ac_include' in the `configure' script to get to the
1889 It should work to run `bash configure', instead of using `/bin/sh'.
1890 You can get Bash from `ftp://prep.ai.mit.edu/pub/gnu' and mirrors.
1892 Another possible cause (reported for NeXT) is a bug in the `sed'
1893 command. In that case the error may look like this:
1895 Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
1897 In this case, installing GNU `sed' should solve the problem. You
1898 can get GNU `sed' from the same places as Bash.
1901 File: kpathsea.info, Node: XtStrings, Next: dlopen, Prev: Empty Makefiles, Up: Common problems
1906 You may find that linking X programs results in an error from the linker
1907 that `XtStrings' is undefined, something like this:
1910 .../x11.c:130: undefined reference to `XtStrings'
1912 This generally happens because of a mismatch between the X include
1913 files with which you compiled and the X libraries with which you linked;
1914 often, the include files are from MIT and the libraries from Sun.
1916 The solution is to use the same X distribution for compilation and
1917 linking. Probably `configure' was unable to guess the proper
1918 directories from your installation. You can use the `configure'
1919 options `--x-includes=PATH' and `--x-libraries=PATH' to explicitly
1923 File: kpathsea.info, Node: dlopen, Next: ShellWidgetClass, Prev: XtStrings, Up: Common problems
1928 (This section adapted from the file `dlsym.c' in the X distribution.)
1930 The `Xlib' library uses the standard C function `wcstombs'. Under
1931 SunOS 4.1, `wcstombs' uses the `dlsym' interface defined in `libdl.so'.
1932 Unfortunately, the SunOS 4.1 distribution does not include a static
1935 As a result, if you try to link an X program statically under SunOS,
1936 you may get undefined references to `dlopen', `dlsym', and `dlclose'.
1937 One workaround is to include these definitions when you link:
1939 void *dlopen() { return 0; }
1940 void *dlsym() { return 0; }
1941 int dlclose() { return -1; }
1943 These are contained in the `dlsym.c' file in the MIT X distribution.
1946 File: kpathsea.info, Node: ShellWidgetClass, Next: Pointer combination warnings, Prev: dlopen, Up: Common problems
1948 2.6.5.8 `ShellWidgetClass'
1949 ..........................
1951 (This section adapted from the comp.sys.sun.admin FAQ.)
1953 If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
1954 you may get undefined symbols `_get_wmShellWidgetClass' and
1955 `_get_applicationShellWidgetClass' when linking. This problem does not
1956 arise using the standard MIT X libraries under SunOS.
1958 The cause is bugs in the `Xmu' shared library as shipped from Sun.
1959 There are several fixes:
1961 * Install the free MIT distribution from `ftp.x.org' and mirrors.
1963 * Get the OpenWindows patches listed below.
1965 * Statically link the `Xmu' library into the executable.
1967 * Avoid using `Xmu' at all. If you are compiling Metafont, see *note
1968 Online Metafont graphics: (web2c)Online Metafont graphics. If you
1969 are compiling Xdvi, see the `-DNOTOOL' option in `xdvik/INSTALL'.
1971 * Ignore the errors. The binary runs fine regardless.
1974 Here is the information for getting the two patches:
1977 Bug ID's: 1086793, 1086912, 1074766
1978 Description: 4.1.x OpenWindows 3.0 `libXt' jumbo patch
1982 Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared `libXmu'.
1984 The way to statically link with `libXmu' depends on whether you are
1985 using a Sun compiler (e.g., `cc') or `gcc'. If the latter, alter the
1986 `x_libs' Make variable to include
1988 -static -lXmu -dynamic
1990 If you are using the Sun compiler, use `-Bstatic' and `-Bdynamic'.
1993 File: kpathsea.info, Node: Pointer combination warnings, Prev: ShellWidgetClass, Up: Common problems
1995 2.6.5.9 Pointer combination warnings
1996 ....................................
1998 When compiling with old C compilers, you may get some warnings about
1999 "illegal pointer combinations". These are spurious; just ignore them.
2000 I decline to clutter up the source with casts to get rid of them.
2003 File: kpathsea.info, Node: Path searching, Next: TeX support, Prev: Installation, Up: Top
2008 This chapter describes the generic path searching mechanism Kpathsea
2009 provides. For information about searching for particular file types
2010 (e.g., TeX fonts), see the next chapter.
2014 * Searching overview:: Basic scheme for searching.
2015 * Path sources:: Where search paths can be defined.
2016 * Path expansion:: Special constructs in search paths.
2017 * Filename database:: Using an externally-built list to search.
2018 * Invoking kpsewhich:: Standalone path lookup.
2021 File: kpathsea.info, Node: Searching overview, Next: Path sources, Up: Path searching
2023 3.1 Searching overview
2024 ======================
2026 A "search path" is a colon-separated list of "path elements", which are
2027 directory names with a few extra frills. A search path can come from
2028 (a combination of) many sources; see below. To look up a file `foo'
2029 along a path `.:/dir', Kpathsea checks each element of the path in
2030 turn: first `./foo', then `/dir/foo', returning the first match (or
2031 possibly all matches).
2033 The "colon" and "slash" mentioned here aren't necessarily `:' and
2034 `/' on non-Unix systems. Kpathsea tries to adapt to other operating
2035 systems' conventions.
2037 To check a particular path element E, Kpathsea first sees if a
2038 prebuilt database (*note Filename database::) applies to E, i.e., if
2039 the database is in a directory that is a prefix of E. If so, the path
2040 specification is matched against the contents of the database.
2042 If the database does not exist, or does not apply to this path
2043 element, or contains no matches, the filesystem is searched (if this
2044 was not forbidden by the specification with `!!' and if the file being
2045 searched for must exist). Kpathsea constructs the list of directories
2046 that correspond to this path element, and then checks in each for the
2047 file being searched for. (To help speed future lookups of files in the
2048 same directory, the directory in which a file is found is floated to the
2049 top of the directory list.)
2051 The "file must exist" condition comes into play with VF files and
2052 input files read by the TeX `\openin' command. These files may not
2053 exist (consider `cmr10.vf'), and so it would be wrong to search the
2054 disk for them. Therefore, if you fail to update `ls-R' when you
2055 install a new VF file, it will never be found.
2057 Each path element is checked in turn: first the database, then the
2058 disk. If a match is found, the search stops and the result is
2059 returned. This avoids possibly-expensive processing of path
2060 specifications that are never needed on a particular run. (Unless the
2061 search explicitly requested all matches.)
2063 Although the simplest and most common path element is a directory
2064 name, Kpathsea supports additional features in search paths: layered
2065 default values, environment variable names, config file values, users'
2066 home directories, and recursive subdirectory searching. Thus, we say
2067 that Kpathsea "expands" a path element, meaning transforming all the
2068 magic specifications into the basic directory name or names. This
2069 process is described in the sections below. It happens in the same
2070 order as the sections.
2072 Exception to all of the above: If the filename being searched for is
2073 absolute or explicitly relative, i.e., starts with `/' or `./' or
2074 `../', Kpathsea simply checks if that file exists.
2076 Ordinarily, if Kpathsea tries to access a file or directory that
2077 cannot be read, it gives a warning. This is so you will be alerted to
2078 directories or files that accidentally lack read permission (for
2079 example, a `lost+found'). If you prefer not to see these warnings,
2080 include the value `readable' in the `TEX_HUSH' environment variable or
2083 This generic path searching algorithm is implemented in
2084 `kpathsea/pathsearch.c'. It is employed by a higher-level algorithm
2085 when searching for a file of a particular type (*note File lookup::,
2086 and *note Glyph lookup::).
2089 File: kpathsea.info, Node: Path sources, Next: Path expansion, Prev: Searching overview, Up: Path searching
2094 A search path can come from many sources. In the order in which
2097 1. A user-set environment variable, e.g., `TEXINPUTS'. Environment
2098 variables with an underscore and the program name appended
2099 override; for example, `TEXINPUTS_latex' overrides `TEXINPUTS' if
2100 the program being run is named `latex'.
2102 2. A program-specific configuration file, e.g., an `S /a:/b' line in
2103 Dvips' `config.ps' (*note Config files: (dvips)Config files.).
2105 3. A line in a Kpathsea configuration file `texmf.cnf', e.g.,
2106 `TEXINPUTS=/c:/d' (see below).
2108 4. The compile-time default (specified in `kpathsea/paths.h').
2110 You can see each of these values for a given search path by using the
2111 debugging options (*note Debugging::).
2113 These sources may be combined via default expansion (*note Default
2118 * Config files:: Kpathsea's runtime config files (texmf.cnf).
2121 File: kpathsea.info, Node: Config files, Up: Path sources
2126 As mentioned above, Kpathsea reads "runtime configuration files" named
2127 `texmf.cnf' for search path and other definitions. The search path
2128 used to look for these configuration files is named `TEXMFCNF', and is
2129 constructed in the usual way, as described above, except that
2130 configuration files cannot be used to define the path, naturally; also,
2131 an `ls-R' database is not used to search for them.
2133 Kpathsea reads _all_ `texmf.cnf' files in the search path, not just
2134 the first one found; definitions in earlier files override those in
2135 later files. Thus, if the search path is `.:$TEXMF', values from
2136 `./texmf.cnf' override those from `$TEXMF/texmf.cnf'.
2138 While (or instead of) reading this description, you may find it
2139 helpful to look at the distributed `texmf.cnf', which uses or at least
2140 mentions most features. The format of `texmf.cnf' files follows:
2142 * Comments start with `%' and continue to the end of the line.
2144 * Blank lines are ignored.
2146 * A `\' at the end of a line acts as a continuation character, i.e.,
2147 the next line is appended. Whitespace at the beginning of
2148 continuation lines is not ignored.
2150 * Each remaining line must look like
2152 VARIABLE [. PROGNAME] [=] VALUE
2154 where the `=' and surrounding whitespace is optional.
2156 * The VARIABLE name may contain any character other than whitespace,
2157 `=', or `.', but sticking to `A-Za-z_' is safest.
2159 * If `.PROGNAME' is present, the definition only applies if the
2160 program that is running is named (i.e., the last component of
2161 `argv[0]' is) PROGNAME or `PROGNAME.exe'. This allows different
2162 flavors of TeX to have different search paths, for example.
2164 * VALUE may contain any characters except `%' and `@'. (These
2165 restrictions are only necessary because of the processing done on
2166 `texmf.cnf' at build time, so you can stick those characters in
2167 after installation if you have to.) The `$VAR.PROG' feature is
2168 not available on the right-hand side; instead, you must use an
2169 additional variable (see below for example). A `;' in VALUE is
2170 translated to `:' if running under Unix; this is useful to write a
2171 single `texmf.cnf' which can be used under both Unix and NT.
2173 * All definitions are read before anything is expanded, so you can
2174 use variables before they are defined (like Make, unlike most other
2177 Here is a configuration file fragment illustrating most of these points:
2179 % TeX input files -- i.e., anything to be found by \input or \openin ...
2180 latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
2181 latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
2182 TEXINPUTS = .:$TEXMF/tex//
2183 TEXINPUTS.latex209 = $latex209_inputs
2184 TEXINPUTS.latex2e = $latex2e_inputs
2185 TEXINPUTS.latex = $latex2e_inputs
2187 Although this format has obvious similarities to Bourne shell
2188 scripts--change the comment character to `#', disallow spaces around
2189 the `=', and get rid of the `.NAME' convention, and it could be run
2190 through the shell. But there seemed little advantage to doing this,
2191 since all the information would have to passed back to Kpathsea and
2192 parsed there anyway, since the `sh' process couldn't affect its
2193 parent's environment.
2195 The implementation of all this is in `kpathsea/cnf.c'.
2198 File: kpathsea.info, Node: Path expansion, Next: Filename database, Prev: Path sources, Up: Path searching
2203 Kpathsea recognizes certain special characters and constructions in
2204 search paths, similar to that in shells. As a general example:
2205 `~$USER/{foo,bar}//baz' expands to all subdirectories under directories
2206 `foo' and `bar' in $USER's home directory that contain a directory or
2207 file `baz'. These expansions are explained in the sections below.
2211 * Default expansion:: a: or :a or a::b expands to a default.
2212 * Variable expansion:: $foo and ${foo} expand to environment values.
2213 * Tilde expansion:: ~ and ~user expand to home directories.
2214 * Brace expansion:: a{foo,bar}b expands to afoob abarb.
2215 * KPSE_DOT expansion:: . is replaced with $KPSE_DOT if it is defined.
2216 * Subdirectory expansion:: a// and a//b recursively expand to subdirs.
2219 File: kpathsea.info, Node: Default expansion, Next: Variable expansion, Up: Path expansion
2221 3.3.1 Default expansion
2222 -----------------------
2224 If the highest-priority search path (*note Path sources::) contains an
2225 "extra colon" (i.e., leading, trailing, or doubled), Kpathsea inserts
2226 at that point the next-highest-priority search path that is defined.
2227 If that inserted path has an extra colon, the same happens with the
2228 next-highest. (An extra colon in the compile-time default value has
2229 unpredictable results, so installers beware.)
2231 For example, given an environment variable setting
2233 setenv TEXINPUTS /home/karl:
2235 and a `TEXINPUTS' value from `texmf.cnf' of
2239 then the final value used for searching will be:
2241 /home/karl:.:$TEXMF//tex
2243 Put another way, default expansion works on "formats" (search
2244 paths), and not directly on environment variables. Example, showing
2245 the trailing `:' ignored in the first case and expanded in the second:
2247 $ env TTFONTS=/tmp: kpsewhich --expand-path '$TTFONTS'
2249 $ env TTFONTS=/tmp: kpsewhich --show-path=.ttf
2250 /tmp:.:/home/olaf/texmf/fonts/truetype//:...
2252 Since Kpathsea looks for multiple configuration files, it would be
2253 natural to expect that (for example) an extra colon in `./texmf.cnf'
2254 would expand to the path in `$TEXMF/texmf.cnf'. Or, with Dvips'
2255 configuration files, that an extra colon in `config.$PRINTER' would
2256 expand to the path in `config.ps'. This doesn't happen. It's not
2257 clear this would be desirable in all cases, and trying to devise a way
2258 to specify the path to which the extra colon should expand seemed truly
2261 Technicality: Since it would be useless to insert the default value
2262 in more than one place, Kpathsea changes only one extra `:' and leaves
2263 any others in place (they will eventually be ignored). Kpathsea checks
2264 first for a leading `:', then a trailing `:', then a doubled `:'.
2266 You can trace this by debugging "paths" (*note Debugging::).
2267 Default expansion is implemented in the source file
2268 `kpathsea/kdefault.c'.
2271 File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: Default expansion, Up: Path expansion
2273 3.3.2 Variable expansion
2274 ------------------------
2276 `$foo' or `${foo}' in a path element is replaced by (1) the value of an
2277 environment variable `foo' (if defined); (2) the value of `foo' from
2278 `texmf.cnf' (if defined); (3) the empty string.
2280 If the character after the `$' is alphanumeric or `_', the variable
2281 name consists of all consecutive such characters. If the character
2282 after the `$' is a `{', the variable name consists of everything up to
2283 the next `}' (braces may not be nested around variable names).
2284 Otherwise, Kpathsea gives a warning and ignores the `$' and its
2285 following character.
2287 You must quote the $'s and braces as necessary for your shell.
2288 _Shell_ variable values cannot be seen by Kpathsea, i.e., ones defined
2289 by `set' in C shells and without `export' in Bourne shells.
2292 setenv tex /home/texmf
2293 setenv TEXINPUTS .:$tex:${tex}prev
2294 the final `TEXINPUTS' path is the three directories:
2295 .:/home/texmf:/home/texmfprev
2297 The `.PROGNAME' suffix on variables and `_PROGNAME' on environment
2298 variable names are not implemented for general variable expansions.
2299 These are only recognized when search paths are initialized (*note Path
2302 Variable expansion is implemented in the source file
2303 `kpathsea/variable.c'.
2306 File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Variable expansion, Up: Path expansion
2308 3.3.3 Tilde expansion
2309 ---------------------
2311 A leading `~' in a path element is replaced by the value of the
2312 environment variable `HOME', or `.' if `HOME' is not set. On Windows,
2313 the environment variable `USERPROFILE' is checked instead of `HOME'.
2315 A leading `~USER' in a path element is replaced by USER's home
2316 directory from the system `passwd' database.
2319 setenv TEXINPUTS ~/mymacros:
2321 will prepend a directory `mymacros' in your home directory to the
2324 As a special case, if a home directory ends in `/', the trailing
2325 slash is dropped, to avoid inadvertently creating a `//' construct in
2326 the path. For example, if the home directory of the user `root' is
2327 `/', the path element `~root/mymacros' expands to just `/mymacros', not
2330 Tilde expansion is implemented in the source file `kpathsea/tilde.c'.
2333 File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: Tilde expansion, Up: Path expansion
2335 3.3.4 Brace expansion
2336 ---------------------
2338 `x{A,B}y' expands to `xAy:xBy'. For example:
2342 expands to `foo/1/baz:foo/2/baz'. `:' is the path separator on the
2343 current system; e.g., on a DOS system, it's `;'.
2345 Braces can be nested; for example, `x{A,B{1,2}}y' expands to
2348 Multiple non-nested braces are expanded from right to left; for
2349 example, `x{A,B}{1,2}y' expands to `x{A,B}1y:x{A,B}2y', which expands
2350 to `xA1y:xB1y:xA2y:xB2y'.
2352 This feature can be used to implement multiple TeX hierarchies, by
2353 assigning a brace list to `$TEXMF', as mentioned in `texmf.in'.
2355 You can also use the path separator in stead of the comma. The last
2356 example could have been written `x{A:B}{1:2}y'.
2358 Brace expansion is implemented in the source file
2359 `kpathsea/expand.c'. It is a modification of the Bash sources, and is
2360 thus covered by the GNU General Public License, rather than the Library
2361 General Public License that covers the rest of Kpathsea.
2364 File: kpathsea.info, Node: KPSE_DOT expansion, Next: Subdirectory expansion, Prev: Brace expansion, Up: Path expansion
2366 3.3.5 `KPSE_DOT' expansion
2367 --------------------------
2369 When `KPSE_DOT' is defined in the environment, it names a directory
2370 that should be considered the current directory for the purpose of
2371 looking up files in the search paths. This feature is needed by the
2372 `mktex...' scripts *note mktex scripts::, because these change the
2373 working directory. You should not ever define it yourself.
2376 File: kpathsea.info, Node: Subdirectory expansion, Prev: KPSE_DOT expansion, Up: Path expansion
2378 3.3.6 Subdirectory expansion
2379 ----------------------------
2381 Two or more consecutive slashes in a path element following a directory
2382 D is replaced by all subdirectories of D: first those subdirectories
2383 directly under D, then the subsubdirectories under those, and so on.
2384 At each level, the order in which the directories are searched is
2385 unspecified. (It's "directory order", and definitely not alphabetical.)
2387 If you specify any filename components after the `//', only
2388 subdirectories which match those components are included. For example,
2389 `/a//b' would expand into directories `/a/1/b', `/a/2/b', `/a/1/1/b',
2390 and so on, but not `/a/b/c' or `/a/1'.
2392 You can include multiple `//' constructs in the path.
2394 `//' at the beginning of a path is ignored; you didn't really want
2395 to search every directory on the system, did you?
2397 I should mention one related implementation trick, which I took from
2398 GNU find. Matthew Farwell suggested it, and David MacKenzie
2401 The trick is that in every real Unix implementation (as opposed to
2402 the POSIX specification), a directory which contains no subdirectories
2403 will have exactly two links (namely, one for `.' and one for `..').
2404 That is to say, the `st_nlink' field in the `stat' structure will be
2405 two. Thus, we don't have to stat everything in the bottom-level (leaf)
2406 directories--we can just check `st_nlink', notice it's two, and do no
2409 But if you have a directory that contains a single subdirectory and
2410 500 regular files, `st_nlink' will be 3, and Kpathsea has to stat every
2411 one of those 501 entries. Therein lies slowness.
2413 You can disable the trick by undefining `UNIX_ST_LINK' in
2414 `kpathsea/config.h'. (It is undefined by default except under Unix.)
2416 Unfortunately, in some cases files in leaf directories are `stat''d:
2417 if the path specification is, say, `$TEXMF/fonts//pk//', then files in
2418 a subdirectory `.../pk', even if it is a leaf, are checked. The reason
2419 cannot be explained without reference to the implementation, so read
2420 `kpathsea/elt-dirs.c' (search for `may descend') if you are curious.
2421 And if you can find a way to _solve_ the problem, please let me know.
2423 Subdirectory expansion is implemented in the source file
2424 `kpathsea/elt-dirs.c'.
2427 File: kpathsea.info, Node: Filename database, Next: Invoking kpsewhich, Prev: Path expansion, Up: Path searching
2429 3.4 Filename database (`ls-R')
2430 ==============================
2432 Kpathsea goes to some lengths to minimize disk accesses for searches
2433 (*note Subdirectory expansion::). Nevertheless, at installations with
2434 enough directories, searching each possible directory for a given file
2435 can take an excessively long time (depending on the speed of the disk,
2436 whether it's NFS-mounted, how patient you are, etc.).
2438 In practice, a font tree containing the standard PostScript and PCL
2439 fonts is large enough for searching to be noticeably slow on typical
2440 systems these days. Therefore, Kpathsea can use an externally-built
2441 "database" file named `ls-R' that maps files to directories, thus
2442 avoiding the need to exhaustively search the disk.
2444 A second database file `aliases' allows you to give additional names
2445 to the files listed in `ls-R'. This can be helpful to adapt to "8.3"
2446 filename conventions in source files.
2448 The `ls-R' and `aliases' features are implemented in the source file
2453 * ls-R:: The main filename database.
2454 * Filename aliases:: Aliases for those names.
2455 * Database format:: Syntax details of the database file.
2458 File: kpathsea.info, Node: ls-R, Next: Filename aliases, Up: Filename database
2463 As mentioned above, you must name the main filename database `ls-R'.
2464 You can put one at the root of each TeX installation hierarchy you wish
2465 to search (`$TEXMF' by default); most sites have only one hierarchy.
2466 Kpathsea looks for `ls-R' files along the `TEXMFDBS' path, so that
2467 should presumably match the list of hierarchies.
2469 The recommended way to create and maintain `ls-R' is to run the
2470 `mktexlsr' script, which is installed in `$(bindir)' (`/usr/local/bin'
2471 by default). That script goes to some trouble to follow symbolic links
2472 as necessary, etc. It's also invoked by the distributed `mktex...'
2475 At its simplest, though, you can build `ls-R' with the command
2476 cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
2478 presuming your `ls' produces the right output format (see the section
2479 below). GNU `ls', for example, outputs in this format. Also presuming
2480 your `ls' hasn't been aliased in a system file (e.g., `/etc/profile')
2481 to something problematic, e.g., `ls --color=tty'. In that case, you
2482 will have to disable the alias before generating `ls-R'. For the
2483 precise definition of the file format, see *note Database format::.
2485 Regardless of whether you use the supplied script or your own, you
2486 will almost certainly want to invoke it via `cron', so when you make
2487 changes in the installed files (say if you install a new LaTeX
2488 package), `ls-R' will be automatically updated.
2490 The `-A' option to `ls' includes files beginning with `.' (except
2491 for `.' and `..'), such as the file `.tex' included with the LaTeX
2492 tools package. (On the other hand, _directories_ whose names begin
2493 with `.' are always ignored.)
2495 If your system does not support symbolic links, omit the `-L'.
2497 `ls -LAR /YOUR/TEXMF/ROOT' will also work. But using `./' avoids
2498 embedding absolute pathnames, so the hierarchy can be easily
2499 transported. It also avoids possible trouble with automounters or
2500 other network filesystem conventions.
2502 Kpathsea warns you if it finds an `ls-R' file, but the file does not
2503 contain any usable entries. The usual culprit is running plain `ls -R'
2504 instead of `ls -LR ./' or `ls -R /YOUR/TEXMF/ROOT'. Another
2505 possibility is some system directory name starting with a `.' (perhaps
2506 if you are using AFS); Kpathsea ignores everything under such
2509 Because the database may be out-of-date for a particular run, if a
2510 file is not found in the database, by default Kpathsea goes ahead and
2511 searches the disk. If a particular path element begins with `!!',
2512 however, _only_ the database will be searched for that element, never
2513 the disk. If the database does not exist, nothing will be searched.
2514 Because this can surprise users ("I see the font `foo.tfm' when I do an
2515 `ls'; why can't Dvips find it?"), it is not in any of the default
2519 File: kpathsea.info, Node: Filename aliases, Next: Database format, Prev: ls-R, Up: Filename database
2521 3.4.2 Filename aliases
2522 ----------------------
2524 In some circumstances, you may wish to find a file under several names.
2525 For example, suppose a TeX document was created using a DOS system and
2526 tries to read `longtabl.sty'. But now it's being run on a Unix system,
2527 and the file has its original name, `longtable.sty'. The file won't be
2528 found. You need to give the actual file `longtable.sty' an alias
2531 You can handle this by creating a file `aliases' as a companion to
2532 the `ls-R' for the hierarchy containing the file in question. (You
2533 must have an `ls-R' for the alias feature to work.)
2535 The format of `aliases' is simple: two whitespace-separated words
2536 per line; the first is the real name `longtable.sty', and second is the
2537 alias (`longtabl.sty'). These must be base filenames, with no
2538 directory components. `longtable.sty' must be in the sibling `ls-R'.
2540 Also, blank lines and lines starting with `%' or `#' are ignored in
2541 `aliases', to allow for comments.
2543 If a real file `longtabl.sty' exists, it is used regardless of any
2547 File: kpathsea.info, Node: Database format, Prev: Filename aliases, Up: Filename database
2549 3.4.3 Database format
2550 ---------------------
2552 The "database" read by Kpathsea is a line-oriented file of plain text.
2553 The format is that generated by GNU (and most other) `ls' programs
2554 given the `-R' option, as follows.
2556 * Blank lines are ignored.
2558 * If a line begins with `/' or `./' or `../' and ends with a colon,
2559 it's the name of a directory. (`../' lines aren't useful,
2560 however, and should not be generated.)
2562 * All other lines define entries in the most recently seen directory.
2563 /'s in such lines will produce possibly-strange results.
2565 * Files with no preceding directory line are ignored.
2567 For example, here's the first few lines of `ls-R' (which totals
2568 about 30K bytes) on my system:
2590 File: kpathsea.info, Node: Invoking kpsewhich, Prev: Filename database, Up: Path searching
2592 3.5 `kpsewhich': Standalone path searching
2593 ==========================================
2595 The Kpsewhich program exercises the path searching functionality
2596 independent of any particular application. This can also be useful as a
2597 sort of `find' program to locate files in your TeX hierarchies, perhaps
2598 in administrative scripts. It is used heavily in the distributed
2602 kpsewhich OPTION... FILENAME...
2604 The options and filename(s) to look up can be intermixed. Options
2605 can start with either `-' or `--', and any unambiguous abbreviation is
2610 * Path searching options:: Changing the mode, resolution, etc.
2611 * Auxiliary tasks:: Path and variable expansion.
2612 * Standard options:: --help and --version.
2615 File: kpathsea.info, Node: Path searching options, Next: Auxiliary tasks, Up: Invoking kpsewhich
2617 3.5.1 Path searching options
2618 ----------------------------
2620 Kpsewhich looks up each non-option argument on the command line as a
2621 filename, and returns the first file found.
2623 Various options alter the path searching behavior:
2626 Report all matches found, one per line. By default, if there is
2627 more than one match, just one will be reported (chosen effectively
2631 Set the resolution to NUM; this only affects `gf' and `pk'
2632 lookups. `-D' is a synonym, for compatibility with Dvips.
2636 Set the engine name to NAME. By default it is not set. The
2637 engine name is used in some search paths to allow files with the
2638 same name but used by different engines to coexist.
2641 Set the format for lookup to NAME. By default, the format is
2642 guessed from the filename, with `tex' being used if nothing else
2643 fits. The recognized filename extensions (including any leading
2644 `.') are also allowable NAMEs.
2646 All formats also have a name, which is the only way to specify
2647 formats with no associated suffix. For example, for Dvips
2648 configuration files you can use `--format="dvips config"'. (The
2649 quotes are for the sake of the shell.)
2651 When the filename being searched for is `config.ps', the format is
2652 automatically switched to `dvips config'. Similarly, when the
2653 filename is `pdftex.cfg', the format is switched to `pdftex
2654 config' (although `pdftex.cfg' is not used any more; look for
2655 `pdftexconfig.tex' instead.)
2657 Here's the current list of recognized names and the associated
2658 suffixes. *Note Supported file formats::, for more information on
2684 graphic/figure: .eps .epsi
2686 TeX system documentation
2689 PostScript header/font: .pro
2692 type1 fonts: .pfa .pfb
2696 truetype fonts: .ttf .ttc
2712 This option and `--path' are mutually exclusive.
2715 After processing the command line, read additional filenames to
2716 look up from standard input.
2719 `-no-mktex=FILETYPE'
2720 Turn on or off the `mktex' script associated with FILETYPE. The
2721 only values that make sense for FILETYPE are `pk', `mf', `tex',
2722 and `tfm'. By default, all are off in Kpsewhich. *Note mktex
2726 Set the mode name to STRING; this also only affects `gf' and `pk'
2727 lookups. No default: any mode will be found. *Note mktex script
2731 Do everything possible to find the files, notably including
2732 searching the disk. By default, only the `ls-R' database is
2733 checked, in the interest of efficiency.
2736 Search along the path STRING (colon-separated as usual), instead
2737 of guessing the search path from the filename. `//' and all the
2738 usual expansions are supported (*note Path expansion::). This
2739 option and `--format' are mutually exclusive. To output the
2740 complete directory expansion of a path, instead of doing a
2741 one-shot lookup, see `--expand-path' and `--show-path' in the
2745 Set the program name to NAME; default is `kpsewhich'. This can
2746 affect the search paths via the `.PROGNAM' feature in
2747 configuration files (*note Config files::).
2750 Report only those matches whose directory part _ends_ with STRING
2751 (compared literally, except case is ignored on a case-insensitive
2752 operating system). For example, suppose there are two matches for
2756 => /some/where/foo.sty
2757 /another/place/foo.sty
2759 Then we can narrow the result to what we are interested in with
2762 kpsewhich --subdir=where foo.sty
2763 => /some/where/foo.sty
2765 kpsewhich --subdir=place foo.sty
2766 => /another/place/foo.sty
2768 The string to match must be at the end of the directory part of the
2769 match, and it is taken literally, with no pattern matching:
2771 kpsewhich --subdir=another foo.sty
2774 The string to match may cross directory components:
2776 kpsewhich --subdir=some/where foo.sty
2777 => /some/where/foo.sty
2779 `--subdir' implies `--all'; if there is more than one match, they
2780 will all be reported (in our example, both `where' and `place' end
2783 kpsewhich --subdir=e
2784 => /some/where/foo.sty
2785 /another/place/foo.sty
2787 Because of the above rules, the presence of a leading `/' is
2788 important, since it "anchors" the match to a full component name:
2790 kpsewhich --subdir=/lace foo.sty
2793 However, a trailing `/' is immaterial (and ignored), since the
2794 match always takes place at the end of the directory part:
2796 kpsewhich --subdir=lace/ foo.sty
2797 => /another/place/foo.sty
2799 The purpose of these rules is to make it convenient to find results
2800 only within a particular area of the tree. For instance, a given
2801 script named `foo.lua' might exist within both
2802 `texmf-dist/scripts/pkg1/' and `texmf-dist/scripts/pkg2/'. By
2803 specifying, say, `--subdir=/pkg1', you can be sure of getting the
2804 one you are interested in.
2806 We only match at the end because a site might happen to install TeX
2807 in `/some/coincidental/pkg1/path/', and we wouldn't want
2808 `texmf-dist/scripts/pkg2/' to match that when searching for
2813 File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Path searching options, Up: Invoking kpsewhich
2815 3.5.2 Auxiliary tasks
2816 ---------------------
2818 Kpsewhich provides some additional features not strictly related to path
2821 * `--debug=NUM' sets the debugging options to NUM. *Note
2824 * `--var-value=VARIABLE' outputs the value of VARIABLE, expanding
2825 `$' (*note Variable expansion:: and `~' (*note Tilde expansion::)
2826 constructs, but not performing other expansions.
2828 * `--expand-braces=STRING' outputs the variable and brace expansion
2829 of STRING. *Note Path expansion::.
2831 * `--expand-var=STRING' outputs the variable and tilde expansion of
2832 STRING. For example, the `mktex...' scripts run `kpsewhich
2833 --expand-var='$TEXMF'' to find the root of the TeX system
2834 hierarchy. *Note Path expansion::.
2836 * `--expand-path=STRING' outputs the complete expansion of STRING,
2837 with each element separated by the usual path separator on the
2838 current system (`;' on Windows, `:' otherwise). This may be
2839 useful to construct a custom search path for a format not
2840 otherwise supported. To retrieve the search path for a format
2841 that is already supported, see `--show-path', next.
2843 Nonexistent directories are culled from the output:
2845 $ kpsewhich --expand-path '/tmp'
2847 $ kpsewhich --expand-path '/nonesuch'
2850 For one-shot uses of an arbitrary (not built in to Kpathsea) path,
2851 see `--path' in the previous section.
2853 * `--show-path=NAME' shows the path that would be used for file
2854 lookups of file type NAME. Either a filename extension (`pk',
2855 `.vf', etc.) or an integer can be used, just as with `--format',
2856 described in the previous section.
2860 File: kpathsea.info, Node: Standard options, Prev: Auxiliary tasks, Up: Invoking kpsewhich
2862 3.5.3 Standard options
2863 ----------------------
2865 Kpsewhich accepts the standard GNU options:
2867 * `--help' prints a help message on standard output and exits.
2869 * `--version' prints the Kpathsea version number and exits.
2872 File: kpathsea.info, Node: TeX support, Next: Programming, Prev: Path searching, Up: Top
2877 Although the basic features in Kpathsea can be used for any type of path
2878 searching, it came about (like all libraries) with a specific
2879 application in mind: I wrote Kpathsea specifically for TeX system
2880 programs. I had been struggling with the programs I was using (Dvips,
2881 Xdvi, and TeX itself) having slightly different notions of how to
2882 specify paths; and debugging was painful, since no code was shared.
2884 Therefore, Kpathsea provides some TeX-specific formats and features.
2885 Indeed, many of the supposedly generic path searching features were
2886 provided because they seemed useful in that conTeXt (font lookup,
2889 Kpathsea provides a standard way to search for files of any of the
2890 supported file types; glyph fonts are a bit different than all the rest.
2891 Searches are based solely on filenames, not file contents--if a GF file
2892 is named `cmr10.600pk', it will be found as a PK file.
2896 * Supported file formats:: File types Kpathsea knows about.
2897 * File lookup:: Searching for most kinds of files.
2898 * Glyph lookup:: Searching for bitmap fonts.
2899 * Suppressing warnings:: Avoiding warnings via TEX_HUSH.
2902 File: kpathsea.info, Node: Supported file formats, Next: File lookup, Up: TeX support
2904 4.1 Supported file formats
2905 ==========================
2907 Kpathsea has support for a number of file types. Each file type has a
2908 list of environment and config file variables that are checked to define
2909 the search path, and most have a default suffix that plays a role in
2910 finding files (see the next section). Some also define additional
2911 suffixes, and/or a program to be run to create missing files on the fly.
2913 Since environment variables containing periods, such as
2914 `TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
2915 environment variables with an underscore, e.g., `TEXINPUTS_latex'
2916 (*note Config files::).
2918 The following table lists the above information.
2921 (Adobe font metrics, *note Metric files: (dvips)Metric files.)
2922 `AFMFONTS'; suffix `.afm'.
2925 (Metafont memory dump, *note Memory dumps: (web2c)Memory dumps.)
2926 `MFBASES', `TEXMFINI'; suffix `.base'.
2929 (BibTeX bibliography source, *note bibtex invocation:
2930 (web2c)bibtex invocation.) `BIBINPUTS', `TEXBIB'; suffix `.bib'.
2933 (BibTeX style file, *note Basic BibTeX style files: (web2c)Basic
2934 BibTeX style files.) `BSTINPUTS'; suffix `.bst'.
2937 (character map files) `CMAPFONTS'; suffix `.cmap'.
2940 (Runtime configuration files, *note Config files::) `TEXMFCNF';
2944 (CWEB input files) `CWEBINPUTS'; suffixes `.w', `.web'; additional
2948 (Dvips `config.*' files, such as `config.ps', *note Config files:
2949 (dvips)Config files.) `TEXCONFIG'.
2952 (encoding vectors) `ENCFONTS'; suffix `.enc'.
2955 (TeX memory dump, *note Memory dumps: (web2c)Memory dumps.)
2956 `TEXFORMATS', `TEXMFINI'; suffix `.fmt'.
2959 (generic font bitmap, *note Glyph files: (dvips)Glyph files.)
2960 `PROGRAMFONTS', `GFFONTS', `GLYPHFONTS', `TEXFONTS'; suffix `gf'.
2963 (Encapsulated PostScript figures, *note PostScript figures:
2964 (dvips)PostScript figures.) `TEXPICTS', `TEXINPUTS'; additional
2965 suffixes: `.eps', `.epsi'.
2968 (makeindex style files) `TEXINDEXSTYLE', `INDEXSTYLE'; suffix
2972 (ligature definition files) `LIGFONTS'; suffix `.lig'.
2975 (Filename databases, *note Filename database::) `TEXMFDBS'.
2978 (Fontmaps, *note Fontmap::) `TEXFONTMAPS'; suffix `.map'.
2981 (MetaPost memory dump, *note Memory dumps: (web2c)Memory dumps.)
2982 `MPMEMS', `TEXMFINI'; suffix `.mem'.
2985 (MetaPost support files, used by DMP; *note dmp invocation:
2986 (web2c)dmp invocation.) `MPSUPPORT'.
2989 (Metafont source, *note mf invocation: (web2c)mf invocation.)
2990 `MFINPUTS'; suffix `.mf'; dynamic creation program: `mktexmf'.
2993 (Metafont program strings, *note pooltype invocation:
2994 (web2c)pooltype invocation.) `MFPOOL', `TEXMFINI'; suffix `.pool'.
2997 (`MFT' style file, *note mft invocation: (web2c)mft invocation.)
2998 `MFTINPUTS'; suffix `.mft'.
3001 (font-related files that don't fit the other categories)
3005 (MetaPost source, *note mpost invocation: (web2c)mpost invocation.)
3006 `MPINPUTS'; suffix `.mp'.
3009 (MetaPost program strings, *note pooltype invocation:
3010 (web2c)pooltype invocation.) `MPPOOL', `TEXMFINI'; suffix `.pool'.
3013 (Omega compiled process files) `OCPINPUTS';
3014 suffix `.ocp'; dynamic creation program: `MakeOmegaOCP'.
3017 (Omega font metrics) `OFMFONTS', `TEXFONTS';
3018 suffixes `.ofm', `.tfm'; dynamic creation program: `MakeOmegaOFM'.
3021 (OpenType fonts) `OPENTYPEFONTS'.
3024 (Omega property lists) `OPLFONTS', `TEXFONTS'; suffix `.opl'.
3027 (Omega translation process files) `OTPINPUTS'; suffix `.otp'.
3030 (Omega virtual fonts) `OVFFONTS', `TEXFONTS'; suffix `.ovf'.
3033 (Omega virtual property lists) `OVPFONTS', `TEXFONTS'; suffix
3037 (PDFTeX-specific configuration files) `PDFTEXCONFIG'.
3040 (packed bitmap fonts, *note Glyph files: (dvips)Glyph files.)
3041 `PROGRAMFONTS' (PROGRAM being `XDVI', etc.), `PKFONTS', `TEXPKS',
3042 `GLYPHFONTS', `TEXFONTS'; suffix `pk'; dynamic creation program:
3046 (downloadable PostScript, *note Header files: (dvips)Header files.)
3047 `TEXPSHEADERS', `PSHEADERS'; additional suffix `.pro'.
3049 `subfont definition files'
3050 (subfont definition files) `SFDFONTS' suffix `.sfd'.
3053 (TeX source, *note tex invocation: (web2c)tex invocation.)
3054 `TEXINPUTS'; suffix `.tex'; additional suffixes: none, because
3055 such a list cannot be complete; dynamic creation program:
3058 `TeX system documentation'
3059 (Documentation files for the TeX system) `TEXDOCS'.
3061 `TeX system sources'
3062 (Source files for the TeX system) `TEXSOURCES'.
3065 (Architecture-independent executables distributed in the texmf
3066 tree) `TEXMFSCRIPTS'.
3069 (TeX program strings, *note pooltype invocation: (web2c)pooltype
3070 invocation.) `TEXPOOL', `TEXMFINI'; suffix `.pool'.
3073 (TeX font metrics, *note Metric files: (dvips)Metric files.)
3074 `TFMFONTS', `TEXFONTS'; suffix `.tfm'; dynamic creation program:
3078 (Troff fonts, used by DMP; *note DMP invocation: (web2c)DMP
3079 invocation.) `TRFONTS'.
3082 (TrueType outline fonts) `TTFONTS'; suffixes `.ttf', `.ttc'.
3085 (Type 1 PostScript outline fonts, *note Glyph files: (dvips)Glyph
3086 files.) `T1FONTS', `T1INPUTS', `TEXPSHEADERS', `DVIPSHEADERS';
3087 suffixes `.pfa', `.pfb'.
3090 (Type 42 PostScript outline fonts) `T42FONTS'.
3093 (virtual fonts, *note Virtual fonts: (dvips)Virtual fonts.)
3094 `VFFONTS', `TEXFONTS'; suffix `.vf'.
3097 (WEB input files) `WEBINPUTS'; suffix `.web'; additional suffix
3101 (files specific to the web2c implementation) `WEB2C'.
3103 There are two special cases, because the paths and environment
3104 variables always depend on the name of the program: the variable name is
3105 constructed by converting the program name to upper case, and then
3106 appending `INPUTS'. Assuming the program is called `foo', this gives
3107 us the following table.
3110 (text files used by `foo') `FOOINPUTS'.
3112 `other binary files'
3113 (binary files used by `foo') `FOOINPUTS'.
3115 If an environment variable by these names are set, the corresponding
3116 `texmf.cnf' definition won't be looked at (unless, as usual, the
3117 environment variable value has an extra `:'). *Note Default
3120 For the font variables, the intent is that:
3121 * `TEXFONTS' is the default for everything.
3123 * `GLYPHFONTS' is the default for bitmap (or, more precisely,
3126 * Each font format has a variable of its own.
3128 * Each program has its own font override path as well; e.g.,
3129 `DVIPSFONTS' for Dvipsk. Again, this is for bitmaps, not metrics.
3133 File: kpathsea.info, Node: File lookup, Next: Glyph lookup, Prev: Supported file formats, Up: TeX support
3138 This section describes how Kpathsea searches for most files (bitmap font
3139 searches are the exception, as described in the next section).
3141 Here is the search strategy for a file NAME:
3142 1. If the file format defines default suffixes, and the suffix of
3143 NAME name is not already a known suffix for that format, try the
3144 name with each default appended, and use alternative names found
3145 in the fontmaps if necessary. We postpone searching the disk as
3146 long as possible. Example: given `foo.sty', look for `foo.sty.tex'
3147 before `foo.sty'. This is unfortunate, but allows us to find
3148 `foo.bar.tex' before `foo.bar' if both exist and we were given
3151 2. Search for NAME, and if necessary for alternative names found in
3152 the fontmaps. Again we avoid searching the disk if possible.
3153 Example: given `foo', we look for `foo'.
3155 3. If the file format defines a program to invoke to create missing
3156 files, run it (*note mktex scripts::).
3158 This is implemented in the routine `kpse_find_file' in
3159 `kpathsea/tex-file.c'. You can watch it in action with the debugging
3160 options (*note Debugging::).
3163 File: kpathsea.info, Node: Glyph lookup, Next: Suppressing warnings, Prev: File lookup, Up: TeX support
3168 This section describes how Kpathsea searches for a bitmap font in GF or
3169 PK format (or either) given a font name (e.g., `cmr10') and a
3170 resolution (e.g., 600).
3172 Here is an outline of the search strategy (details in the sections
3173 below) for a file NAME at resolution DPI. The search stops at the
3174 first successful lookup.
3176 1. Look for an existing file NAME.DPIFORMAT in the specified
3179 2. If NAME is an alias for a file F in the fontmap file
3180 `texfonts.map', look for F.DPI.
3182 3. Run an external program (typically named `mktexpk') to generate
3183 the font (*note mktex scripts::)
3185 4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
3186 (typically `cmr10').
3188 This is implemented in `kpse_find_glyph_format' in
3189 `kpathsea/tex-glyph.c'.
3193 * Basic glyph lookup:: Features common to all glyph lookups.
3194 * Fontmap:: Aliases for fonts.
3195 * Fallback font:: Resolutions and fonts of last resort.
3198 File: kpathsea.info, Node: Basic glyph lookup, Next: Fontmap, Up: Glyph lookup
3200 4.3.1 Basic glyph lookup
3201 ------------------------
3203 When Kpathsea looks for a bitmap font NAME at resolution DPI in a
3204 format FORMAT, it first checks each directory in the search path for a
3205 file `NAME.DPIFORMAT'; for example, `cmr10.600pk'. Kpathsea looks for
3206 a PK file first, then a GF file.
3208 If that fails, Kpathsea looks for `dpiDPI/NAME.FORMAT'; for example,
3209 `dpi600/cmr10.pk'. This is how fonts are typically stored on
3210 filesystems (such as DOS) that permit only three-character extensions.
3212 If that fails, Kpathsea looks for a font with a close-enough DPI.
3213 "Close enough" is defined by the macro `KPSE_BITMAP_TOLERANCE' in
3214 `kpathsea/tex-glyph.h' to be `DPI / 500 + 1'. This is slightly more
3215 than the 0.2% minimum allowed by the DVI standard
3216 (`CTAN:/dviware/driv-standard/level-0').
3219 File: kpathsea.info, Node: Fontmap, Next: Fallback font, Prev: Basic glyph lookup, Up: Glyph lookup
3224 If a bitmap font or metric file is not found with the original name (see
3225 the previous section), Kpathsea looks through any "fontmap" files for
3226 an "alias" for the original font name. These files are named
3227 `texfonts.map' and searched for along the `TEXFONTMAPS'
3228 environment/config file variable. All `texfonts.map' files that are
3229 found are read; earlier definitions override later ones.
3231 This feature is intended to help in two respects:
3233 1. An alias name is limited in length only by available memory, not
3234 by your filesystem. Therefore, if you want to ask for
3235 `Times-Roman' instead of `ptmr', you can (you get `ptmr8r').
3237 2. A few fonts have historically had multiple names: specifically,
3238 LaTeX's "circle font" has variously been known as `circle10',
3239 `lcircle10', and `lcirc10'. Aliases can make all the names
3240 equivalent, so that it no longer matters what the name of the
3241 installed file is; TeX documents will find their favorite name.
3244 The format of fontmap files is straightforward:
3246 * Comments start with `%' and continue to the end of the line.
3248 * Blank lines are ignored.
3250 * Each nonblank line is broken up into a series of "words": a
3251 sequence of non-whitespace characters.
3253 * If the first word is `include', the second word is used as a
3254 filename, and it is searched for and read.
3256 * Otherwise, the first word on each line is the true filename;
3258 * the second word is the alias;
3260 * subsequent words are ignored.
3262 If an alias has an extension, it matches only those files with that
3263 extension; otherwise, it matches anything with the same root, regardless
3264 of extension. For example, an alias `foo.tfm' matches only when
3265 `foo.tfm' is being searched for; but an alias `foo' matches `foo.vf',
3268 As an example, here is an excerpt from the `texfonts.map' in the
3269 Web2c distribution. It makes the circle fonts equivalent and includes
3270 automatically generated maps for most PostScript fonts available from
3271 various font suppliers.
3282 include bitstrea.map
3285 Fontmaps are implemented in the file `kpathsea/fontmap.c'. The
3286 Fontname distribution has much more information on font naming (*note
3287 Introduction: (fontname)Introduction.).
3290 File: kpathsea.info, Node: Fallback font, Prev: Fontmap, Up: Glyph lookup
3295 If a bitmap font cannot be found or created at the requested size,
3296 Kpathsea looks for the font at a set of "fallback resolutions". You
3297 specify these resolutions as a colon-separated list (like search paths).
3298 Kpathsea looks first for a program-specific environment variable (e.g.,
3299 `DVIPSSIZES' for Dvipsk), then the environment variable `TEXSIZES',
3300 then a default specified at compilation time (the Make variable
3301 `default_texsizes'). You can set this list to be empty if you prefer
3302 to find fonts at their stated size or not at all.
3304 Finally, if the font cannot be found even at the fallback
3305 resolutions, Kpathsea looks for a fallback font, typically `cmr10'.
3306 Programs must enable this feature by assigning to the global variable
3307 `kpse_fallback_font' or calling `kpse_init_prog' (*note Calling
3308 sequence::); the default is no fallback font.
3311 File: kpathsea.info, Node: Suppressing warnings, Prev: Glyph lookup, Up: TeX support
3313 4.4 Suppressing warnings
3314 ========================
3316 Kpathsea provides a way to suppress selected usually-harmless warnings;
3317 this is useful at large sites where most users are not administrators,
3318 and thus the warnings are merely a source of confusion, not a help. To
3319 do this, you set the environment variable or configuration file value
3320 `TEX_HUSH' to a colon-separated list of values. Here are the
3324 Suppress everything possible.
3327 Suppress mismatched font checksum warnings.
3330 Suppress warnings when a character is missing from a font that a
3331 DVI or VF file tries to typeset.
3334 Don't suppress any warnings.
3337 Suppress warnings about attempts to access a file whose permissions
3338 render it unreadable.
3341 Suppresses warnings about an unimplemented or unparsable
3344 `tex-hush.c' defines the function that checks the variable value. Each
3345 driver implements its own checks where appropriate.
3348 File: kpathsea.info, Node: Programming, Next: Index, Prev: TeX support, Up: Top
3353 This chapter is for programmers who wish to use Kpathsea. *Note
3354 Introduction::, for the conditions under which you may do so.
3358 * Overview: Programming overview. Introduction.
3359 * Calling sequence:: Specifics of what to call.
3360 * Program-specific files:: How to handle these.
3361 * Config: Programming with config files. Getting info from texmf.cnf.
3364 File: kpathsea.info, Node: Programming overview, Next: Calling sequence, Up: Programming
3366 5.1 Programming overview
3367 ========================
3369 Aside from this manual, your best source of information is the source to
3370 the programs I've modified to use Kpathsea (*note Introduction::). Of
3371 those, Dviljk is probably the simplest, and hence a good place to start.
3372 Xdvik adds VF support and the complication of X resources. Dvipsk adds
3373 the complication of its own config files. Web2c is source code I also
3374 maintain, so it uses Kpathsea rather straightforwardly, but is of course
3375 complicated by the Web to C translation. Finally, Kpsewhich is a small
3376 utility program whose sole purpose is to exercise the main
3377 path-searching functionality.
3379 Beyond these examples, the `.h' files in the Kpathsea source
3380 describe the interfaces and functionality (and of course the `.c' files
3381 define the actual routines, which are the ultimate documentation).
3382 `pathsearch.h' declares the basic searching routine. `tex-file.h' and
3383 `tex-glyph.h' define the interfaces for looking up particular kinds of
3384 files. In view of the way the headers depend on each other, it is
3385 recommended to use `#include <kpathsea/kpathsea.h>', which includes
3386 every Kpathsea header.
3388 If you want to include only specific headers, you should still
3389 consider including `kpathsea/config.h' before including any other
3390 Kpathsea header, as it provides symbols used in the other headers.
3391 Note that `kpathsea/config.h' includes `kpathsea/c-auto.h', which is
3392 generated by Autoconf.
3394 The library provides no way for an external program to register new
3395 file types: `tex-file.[ch]' must be modified to do this. For example,
3396 Kpathsea has support for looking up Dvips config files, even though no
3397 program other than Dvips will likely ever want to do so. I felt this
3398 was acceptable, since along with new file types should also come new
3399 defaults in `texmf.cnf' (and its descendant `paths.h'), since it's
3400 simplest for users if they can modify one configuration file for all
3403 Kpathsea does not parse any formats itself; it barely opens any
3404 files. Its primary purpose is to return filenames. The GNU font
3405 utilities does contain libraries to read TFM, GF, and PK files, as do
3406 the programs above, of course.
3409 File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Prev: Programming overview, Up: Programming
3411 5.2 Calling sequence
3412 ====================
3414 The typical way to use Kpathsea in your program goes something like
3417 1. Call `kpse_set_program_name' with `argv[0]' as the first argument;
3418 the second argument is a string or `NULL'. The second argument is
3419 used by Kpathsea as the program name for the `.PROGRAM' feature of
3420 config files (*note Config files::). If the second argument is
3421 `NULL', the value of the first argument is used. This function
3422 must be called before any other use of the Kpathsea library.
3424 If necessary, `kpse_set_program_name' sets the global variables
3425 `program_invocation_name' and `program_invocation_short_name'.
3426 These variables are used in the error message macros defined in
3427 `kpathsea/lib.h'. It sets the global variable `kpse_program_name'
3428 to the program name it uses. It also initializes debugging
3429 options based on the environment variable `KPATHSEA_DEBUG' (if
3430 that is set). Finally, it sets the variables `SELFAUTOLOC',
3431 `SELFAUTODIR' and `SELFAUTOPARENT' to the location, parent and
3432 grandparent directory of the executable, removing `.' and `..'
3433 path elements and resolving symbolic links. These are used in the
3434 default configuration file to allow people to invoke TeX from
3435 anywhere, specifically from a mounted CD-ROM. (You can use
3436 `--expand-var=\$SELFAUTOLOC', etc., to see the values finds.)
3438 2. The `kpse_set_progname' is deprecated. A call to
3439 `kpse_set_progname' with `argv[0]' is equivalent to a call of
3440 `kpse_set_program_name' with first argument `argv[0]' and second
3441 argument `NULL'. The function is deprecated because it cannot
3442 ensure that the `.PROGRAM' feature of config files will always
3443 work (*note Config files::).
3445 3. Set debugging options. *Note Debugging::. If your program doesn't
3446 have a debugging option already, you can define one and set
3447 `kpathsea_debug' to the number that the user supplies (as in Dviljk
3448 and Web2c), or you can just omit this altogether (people can
3449 always set `KPATHSEA_DEBUG'). If you do have runtime debugging
3450 already, you need to merge Kpathsea's options with yours (as in
3453 4. If your program has its own configuration files that can define
3454 search paths, you should assign those paths to the `client_path'
3455 member in the appropriate element of the `kpse_format_info' array.
3456 (This array is indexed by file type; see `tex-file.h'.) See
3457 `resident.c' in Dvipsk for an example.
3459 5. Call `kpse_init_prog' (see `proginit.c'). It's useful for the DVI
3460 drivers, at least, but for other programs it may be simpler to
3461 extract the parts of it that actually apply. This does not
3462 initialize any paths, it just looks for (and sets) certain
3463 environment variables and other random information. (A search
3464 path is always initialized at the first call to find a file of
3465 that type; this eliminates much useless work, e.g., initializing
3466 the BibTeX search paths in a DVI driver.)
3468 6. The routine to actually find a file of type FORMAT is
3469 `kpse_find_FORMAT', defined in `tex-file.h'. These are macros that
3470 expand to a call to `kpse_find_file'. You can call, say,
3471 `kpse_find_tfm' after doing only the first of the initialization
3472 steps above--Kpathsea automatically reads the `texmf.cnf' generic
3473 config files, looks for environment variables, and does expansions
3474 at the first lookup.
3476 7. To find PK and/or GF bitmap fonts, the routines are `kpse_find_pk',
3477 `kpse_find_gf' and `kpse_find_glyph', defined in `tex-glyph.h'.
3478 These return a structure in addition to the resultant filename,
3479 because fonts can be found in so many ways. See the documentation
3482 8. To actually open a file, not just return a filename, call
3483 `kpse_open_file'. This function takes the name to look up and a
3484 Kpathsea file format as arguments, and returns the usual `FILE *'.
3485 It always assumes the file must exist, and thus will search the
3486 disk if necessary (unless the search path specified `!!', etc.).
3487 In other words, if you are looking up a VF or some other file that
3488 need not exist, don't use this.
3491 Kpathsea also provides many utility routines. Some are generic: hash
3492 tables, memory allocation, string concatenation and copying, string
3493 lists, reading input lines of arbitrary length, etc. Others are
3494 filename-related: default path, tilde, and variable expansion, `stat'
3495 calls, etc. (Perhaps someday I'll move the former to a separate
3498 The `c-*.h' header files can also help your program adapt to many
3499 different systems. You will almost certainly want to use Autoconf for
3500 configuring your software if you use Kpathsea; I strongly recommend
3501 using Autoconf regardless. It is available from
3502 `ftp://prep.ai.mit.edu/pub/gnu/'.
3505 File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Calling sequence, Up: Programming
3507 5.3 Program-specific files
3508 ==========================
3510 Many programs will need to find some configuration files. Kpathsea
3511 contains some support to make it easy to place them in their own
3512 directories. The Standard TeX directory structure (*note Introduction:
3513 (tds)Top.), specifies that such files should go into a subdirectory
3514 named after the program, like `texmf/ttf2pk'.
3516 Two special formats, `kpse_program_text_format' and
3517 `kpse_program_binary_format' exist, which use `.:$TEXMF/PROGRAM//' as
3518 their compiled-in search path. To override this default, you can use
3519 the variable `PROGRAMINPUTS' in the environment and/or `texmf.cnf'.
3520 That is to say, the name of the variable is constructed by converting
3521 the name of the program to upper case, and appending `INPUTS'.
3523 The only difference between these two formats is whether
3524 `kpse_open_file' will open the files it finds in text or binary mode.
3527 File: kpathsea.info, Node: Programming with config files, Prev: Program-specific files, Up: Programming
3529 5.4 Programming with config files
3530 =================================
3532 You can (and probably should) use the same `texmf.cnf' configuration
3533 file that Kpathsea uses for your program. This helps installers by
3534 keeping all configuration in one place.
3536 To retrieve a value VAR from config files, the best way is to call
3537 `kpse_var_value' on the string `VAR'. This will look first for an
3538 environment variable VAR, then a config file value. The result will be
3539 the value found or `NULL'. This function is declared in
3540 `kpathsea/variable.h'. For an example, see the `shell_escape' code in
3541 `web2c/lib/texmfmp.c'.
3543 The routine to do variable expansion in the context of a search path
3544 (as opposed to simply retrieving a value) is `kpse_var_expand', also
3545 declared in `kpathsea/variable.h'. It's generally only necessary to
3546 set the search path structure components as explained in the previous
3547 section, rather than using this yourself.
3549 If for some reason you want to retrieve a value _only_ from a config
3550 file, not automatically looking for a corresponding environment
3551 variable, call `kpse_cnf_get' (declared in `kpathsea/cnf.h') with the
3554 No initialization calls are needed.
3557 File: kpathsea.info, Node: Index, Prev: Programming, Up: Top
3565 * !! in path specifications: ls-R. (line 52)
3566 * $ expansion: Variable expansion. (line 6)
3567 * --all: Path searching options.
3569 * --color=tty: ls-R. (line 21)
3570 * --debug=NUM: Auxiliary tasks. (line 9)
3571 * --disable-static: configure options. (line 31)
3572 * --dpi=NUM: Path searching options.
3574 * --enable options: configure options. (line 16)
3575 * --enable-maintainer-mode: configure options. (line 34)
3576 * --enable-shared <1>: Shared library. (line 6)
3577 * --enable-shared: configure options. (line 27)
3578 * --engine=NAME: Path searching options.
3580 * --expand-braces=STRING: Auxiliary tasks. (line 16)
3581 * --expand-path=STRING: Auxiliary tasks. (line 24)
3582 * --expand-var=STRING: Auxiliary tasks. (line 19)
3583 * --format=NAME: Path searching options.
3585 * --help: Standard options. (line 8)
3586 * --interactive: Path searching options.
3588 * --mode=STRING: Path searching options.
3590 * --must-exist: Path searching options.
3592 * --path=STRING: Path searching options.
3594 * --progname=NAME: Path searching options.
3596 * --show-path=NAME: Auxiliary tasks. (line 41)
3597 * --srcdir, for building multiple architectures: configure scenarios.
3599 * --subdir=STRING: Path searching options.
3601 * --var-value=VARIABLE: Auxiliary tasks. (line 12)
3602 * --version: Standard options. (line 10)
3603 * --with options: configure options. (line 16)
3604 * --with-mktextex-default: mktex configuration. (line 14)
3605 * --without-mktexmf-default: mktex configuration. (line 14)
3606 * --without-mktexpk-default: mktex configuration. (line 14)
3607 * --without-mktextfm-default: mktex configuration. (line 14)
3608 * -1 debugging value: Debugging. (line 23)
3609 * -A option to ls: ls-R. (line 33)
3610 * -Bdynamic: ShellWidgetClass. (line 45)
3611 * -Bstatic: ShellWidgetClass. (line 45)
3612 * -D NUM: Path searching options.
3614 * -dynamic: ShellWidgetClass. (line 43)
3615 * -g, compiling without: configure scenarios. (line 32)
3616 * -L option to ls: ls-R. (line 38)
3617 * -mktex=FILETYPE: Path searching options.
3619 * -no-mktex=FILETYPE: Path searching options.
3621 * -O, compiling with: configure scenarios. (line 32)
3622 * -static: ShellWidgetClass. (line 43)
3623 * . directories, ignored: ls-R. (line 33)
3624 * . files: ls-R. (line 33)
3625 * .2602gf: Unable to generate fonts.
3627 * .afm: Supported file formats.
3629 * .base: Supported file formats.
3631 * .bib: Supported file formats.
3633 * .bst: Supported file formats.
3635 * .cmap: Supported file formats.
3637 * .cnf: Supported file formats.
3639 * .enc: Supported file formats.
3641 * .eps: Supported file formats.
3643 * .epsi: Supported file formats.
3645 * .fmt: Supported file formats.
3647 * .ist: Supported file formats.
3649 * .lig: Supported file formats.
3651 * .map: Supported file formats.
3653 * .mem: Supported file formats.
3655 * .mf: Supported file formats.
3657 * .mft: Supported file formats.
3659 * .mp: Supported file formats.
3661 * .ocp: Supported file formats.
3663 * .ofm: Supported file formats.
3665 * .opl: Supported file formats.
3667 * .otp: Supported file formats.
3669 * .ovf: Supported file formats.
3671 * .ovp: Supported file formats.
3673 * .pfa: Supported file formats.
3675 * .pfb: Supported file formats.
3677 * .pk: Supported file formats.
3679 * .pool: Supported file formats.
3681 * .pro: Supported file formats.
3683 * .rhosts, writable by TeX: Security. (line 10)
3684 * .sfd: Supported file formats.
3686 * .tex: Supported file formats.
3688 * .tex file, included in ls-R: ls-R. (line 33)
3689 * .tfm: Supported file formats.
3691 * .ttc: Supported file formats.
3693 * .ttf: Supported file formats.
3695 * .vf: Supported file formats.
3697 * .w: Supported file formats.
3699 * .web: Supported file formats.
3701 * / may not be /: Searching overview. (line 13)
3702 * /, trailing in home directory: Tilde expansion. (line 19)
3703 * //: Subdirectory expansion.
3705 * /afs/... , installing into: Installing files. (line 32)
3706 * /etc/profile: Unable to find files.
3708 * /etc/profile and aliases: ls-R. (line 21)
3709 * /var/tmp/texfonts: mktex configuration. (line 107)
3710 * 2602gf: Unable to generate fonts.
3712 * 8.3 filenames, using: mktex configuration. (line 62)
3713 * : may not be :: Searching overview. (line 13)
3714 * :: expansion: Default expansion. (line 6)
3715 * @VAR@ substitutions: Running configure. (line 6)
3716 * \, line continuation in texmf.cnf: Config files. (line 26)
3717 * \openin: Searching overview. (line 31)
3718 * \special, suppressing warnings about: Suppressing warnings.
3720 * absolute filenames: Searching overview. (line 52)
3721 * ac_include, Autoconf extension: Running configure. (line 6)
3722 * access warnings: Searching overview. (line 56)
3723 * Acorn TeX implementations: Other TeX packages. (line 6)
3724 * AFMFONTS: Supported file formats.
3726 * AFS: Installing files. (line 32)
3727 * AIX 4.1 configure error: Empty Makefiles. (line 6)
3728 * AIX shells and configure: configure shells. (line 14)
3729 * aliases for fonts: Fontmap. (line 6)
3730 * aliases, for filenames: Filename aliases. (line 6)
3731 * all: Suppressing warnings.
3733 * all matches, finding: Path searching options.
3735 * alphabetical order, not: Subdirectory expansion.
3737 * Amiga support: Custom installation. (line 19)
3738 * Amiga TeX implementations: Other TeX packages. (line 6)
3739 * Andrew File System, installing with: Installing files. (line 32)
3740 * announcement mailing list: Mailing lists. (line 6)
3741 * ANSI C: TeX or Metafont failing.
3743 * append-only directories and mktexpk: Security. (line 36)
3744 * appendonlydir: mktex configuration. (line 54)
3745 * architecture-(in)dependent files, installing only: Installing files.
3747 * architectures, compiling multiple: configure scenarios. (line 18)
3748 * arguments to mktex: mktex script arguments.
3750 * argv[0]: Calling sequence. (line 9)
3751 * ash, losing with configure: configure shells. (line 19)
3752 * autoconf, recommended: Calling sequence. (line 90)
3753 * automounter, and configuration: configure scenarios. (line 29)
3754 * automounter, and ls-R: ls-R. (line 40)
3755 * auxiliary tasks: Auxiliary tasks. (line 6)
3756 * Babel <1>: Running make. (line 51)
3757 * Babel: Kpathsea application distributions.
3759 * Bach, Johann Sebastian: Default expansion. (line 41)
3760 * backbone of CTAN: Electronic distribution.
3762 * backslash-newline: Config files. (line 26)
3763 * bash, recommended for running configure: configure shells. (line 6)
3764 * basic glyph lookup: Basic glyph lookup. (line 6)
3765 * Berry, Karl: History. (line 12)
3766 * BIBINPUTS: Supported file formats.
3768 * binary mode, for file transfers: Electronic distribution.
3770 * blank lines, in texmf.cnf: Config files. (line 24)
3771 * brace expansion: Brace expansion. (line 6)
3772 * BSD universe: Running make. (line 44)
3773 * bsh, ok with configure: configure shells. (line 14)
3774 * BSTINPUTS: Supported file formats.
3776 * bug address: Reporting bugs. (line 8)
3777 * bug checklist: Bug checklist. (line 6)
3778 * bug mailing list: Mailing lists. (line 6)
3779 * bugs, reporting: Reporting bugs. (line 6)
3780 * c-*.h: Calling sequence. (line 90)
3781 * c-auto.h: Programming overview.
3783 * c-auto.in: Running configure. (line 6)
3784 * cache of fonts, local: Security. (line 22)
3785 * calling sequence: Calling sequence. (line 6)
3786 * CC: configure environment.
3788 * cc warnings: Pointer combination warnings.
3790 * cc, compiling with: configure environment.
3792 * CD-ROM distributions: CD-ROM distribution. (line 6)
3793 * CFLAGS: configure environment.
3795 * ChangeLog entry: Bug checklist. (line 56)
3796 * checklist for bug reports: Bug checklist. (line 6)
3797 * checksum: Suppressing warnings.
3799 * circle fonts: Fontmap. (line 19)
3800 * clean Make target: Cleaning up. (line 15)
3801 * client_path in kpse_format_info: Calling sequence. (line 45)
3802 * CMAPFONTS: Supported file formats.
3804 * cmr10, as fallback font: Fallback font. (line 15)
3805 * cmr10.vf: Searching overview. (line 31)
3806 * cnf.c: Config files. (line 75)
3807 * cnf.h: Programming with config files.
3809 * code sharing: Shared library. (line 9)
3810 * color printers, configuring: Simple installation. (line 60)
3811 * comments, in fontmap files: Fontmap. (line 28)
3812 * comments, in texmf.cnf: Config files. (line 22)
3813 * comments, making: Introduction. (line 27)
3814 * common features in glyph lookup: Basic glyph lookup. (line 6)
3815 * common problems: Common problems. (line 6)
3816 * comp.sys.sun.admin FAQ: ShellWidgetClass. (line 6)
3817 * comp.text.tex: Mailing lists. (line 29)
3818 * compilation: Installation. (line 6)
3819 * compilation value, source for path: Path sources. (line 20)
3820 * compiler bugs: TeX or Metafont failing.
3822 * compiler bugs, finding: TeX or Metafont failing.
3824 * compiler options, additional: Running make. (line 27)
3825 * compiler options, specifying: configure environment.
3827 * compiler, changing: Running make. (line 40)
3828 * compiling on HP-UX: TeX or Metafont failing.
3830 * conditions for use: Introduction. (line 31)
3831 * config files: Config files. (line 6)
3832 * config files, for Kpathsea-using programs: Calling sequence.
3834 * config files, programming with: Programming with config files.
3836 * config.h: Programming overview.
3838 * config.log: Bug checklist. (line 28)
3839 * config.ps: Path searching options.
3841 * config.ps, search path for: Supported file formats.
3843 * config.status: Bug checklist. (line 31)
3844 * configuration: Installation. (line 6)
3845 * configuration bugs: Bug checklist. (line 31)
3846 * configuration compiler options: configure environment.
3848 * configuration file, source for path: Path sources. (line 17)
3849 * configuration files as shell scripts.: Config files. (line 67)
3850 * configuration of mktex scripts: mktex configuration. (line 6)
3851 * configuration of optional features: configure options. (line 16)
3852 * configure error from sed: Empty Makefiles. (line 6)
3853 * configure options: configure options. (line 6)
3854 * configure options for mktex scripts: mktex configuration. (line 14)
3855 * configure, running: Running configure. (line 6)
3856 * context diff: Bug checklist. (line 56)
3857 * continuation character: Config files. (line 26)
3858 * core dumps, reporting: Bug checklist. (line 62)
3859 * CPPFLAGS: configure environment.
3861 * crashes, reporting: Bug checklist. (line 62)
3862 * CTAN, defined: Electronic distribution.
3864 * CTAN.sites: Electronic distribution.
3866 * custom installation: Custom installation. (line 6)
3867 * CWEBINPUTS: Supported file formats.
3869 * database search: Searching overview. (line 17)
3870 * database, for filenames: Filename database. (line 6)
3871 * database, format of: Database format. (line 6)
3872 * debug.h: Debugging. (line 6)
3873 * debugger: Bug checklist. (line 62)
3874 * debugging: Debugging. (line 6)
3875 * debugging options, in Kpathsea-using program: Calling sequence.
3877 * debugging output: Debugging. (line 27)
3878 * debugging with -g, disabling: configure scenarios. (line 32)
3879 * DEC shells and configure: configure shells. (line 25)
3880 * default expansion: Default expansion. (line 6)
3881 * default path features: Default path features.
3883 * default paths, changing: Default path generation.
3885 * default paths, how they're made: Default path generation.
3887 * default_texsizes: Fallback font. (line 6)
3888 * DEFS: configure environment.
3890 * depot: configure scenarios. (line 29)
3891 * device, wrong: Unable to generate fonts.
3893 * directories, changing default installation: Default path generation.
3895 * directories, making append-only: mktex configuration. (line 55)
3896 * directory permissions: Security. (line 51)
3897 * directory structure, for TeX files: TeX directory structure.
3899 * disabling mktex scripts: mktex configuration. (line 6)
3900 * disk search: Searching overview. (line 22)
3901 * disk searching, avoiding: ls-R. (line 52)
3902 * disk space, needed: Disk space. (line 6)
3903 * disk usage, reducing: Logging. (line 6)
3904 * distclean Make target: Cleaning up. (line 6)
3905 * distributions, compiling simultaneously: Kpathsea application distributions.
3907 * distributions, not compiling: Kpathsea application distributions.
3909 * distributions, on CD-ROM: CD-ROM distribution. (line 6)
3910 * distributions, via ftp: Electronic distribution.
3912 * dlclose: dlopen. (line 6)
3913 * dlopen: dlopen. (line 6)
3914 * dlsym: dlopen. (line 6)
3915 * dlsym.c: dlopen. (line 21)
3916 * doc files: Supported file formats.
3918 * DOS compatible names: mktex configuration. (line 62)
3919 * DOS support: Custom installation. (line 19)
3920 * DOS TeX implementations: Other TeX packages. (line 6)
3921 * dosnames: mktex configuration. (line 61)
3922 * dot files: ls-R. (line 33)
3923 * doubled colons: Default expansion. (line 6)
3924 * dpiNNN directories: mktex configuration. (line 62)
3925 * DVI drivers: Kpathsea application distributions.
3927 * DVILJMAKEPK: mktex script names. (line 22)
3928 * DVILJSIZES: Fallback font. (line 6)
3929 * DVIPSFONTS: Supported file formats.
3931 * DVIPSHEADERS: Supported file formats.
3933 * DVIPSMAKEPK: mktex script names. (line 22)
3934 * DVIPSSIZES: Fallback font. (line 6)
3935 * dynamic creation of files: mktex scripts. (line 6)
3936 * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
3938 * EC fonts, and dynamic source creation: mktex scripts. (line 6)
3939 * elt-dirs.c: Subdirectory expansion.
3941 * email CTAN access: Electronic distribution.
3943 * enabling mktex scripts: mktex configuration. (line 6)
3944 * ENCFONTS: Supported file formats.
3946 * engine name: Path searching options.
3948 * environment variable, source for path: Path sources. (line 9)
3949 * environment variables for TeX: Supported file formats.
3951 * environment variables in paths: Variable expansion. (line 6)
3952 * environment variables, old: Unable to find files.
3954 * epoch, seconds since: Logging. (line 15)
3955 * error message macros: Calling sequence. (line 16)
3956 * excessive startup time: Slow path searching. (line 6)
3957 * expand.c: Brace expansion. (line 26)
3958 * expanding symlinks: Calling sequence. (line 16)
3959 * expansion, default: Default expansion. (line 6)
3960 * expansion, path element: Searching overview. (line 43)
3961 * expansion, search path: Path expansion. (line 6)
3962 * expansion, subdirectory: Subdirectory expansion.
3964 * expansion, tilde: Tilde expansion. (line 6)
3965 * expansion, variable: Variable expansion. (line 6)
3966 * explicitly relative filenames: Searching overview. (line 52)
3967 * externally-built filename database: Filename database. (line 6)
3968 * extra colons: Default expansion. (line 6)
3969 * extraclean Make target: Cleaning up. (line 23)
3970 * failed mktex... script invocation: mktex script names. (line 25)
3971 * fallback font: Fallback font. (line 6)
3972 * fallback resolutions: Fallback font. (line 6)
3973 * fallback resolutions, overriding: Running make. (line 10)
3974 * FAQ, comp.sys.sun.admin: ShellWidgetClass. (line 6)
3975 * FAQ, Kpathsea: Common problems. (line 6)
3976 * Farwell, Matthew: Subdirectory expansion.
3978 * features, of default paths: Default path features.
3980 * file formats, supported: Supported file formats.
3982 * file lookup: File lookup. (line 6)
3983 * file permissions: Security. (line 47)
3984 * file types, registering new: Programming overview.
3986 * filename aliases: Filename aliases. (line 6)
3987 * filename database: Filename database. (line 6)
3988 * filename database generation: Filename database generation.
3990 * filenames, absolute or explicitly relative: Searching overview.
3992 * files, unable to find: Unable to find files.
3994 * filesystem search: Searching overview. (line 22)
3995 * floating directories: Searching overview. (line 22)
3996 * font alias files: Fontmap. (line 6)
3997 * font generation failures: Unable to generate fonts.
3999 * font of last resort: Fallback font. (line 6)
4000 * font set, infinite: mktex scripts. (line 6)
4001 * fontmap files: Fontmap. (line 6)
4002 * fontmaps: mktex configuration. (line 80)
4003 * fontname: mktex configuration. (line 81)
4004 * fontnames, arbitrary length: Fontmap. (line 15)
4005 * fonts, being created: Simple installation. (line 79)
4006 * FOOINPUTS: Supported file formats.
4008 * fopen, redefined: Debugging. (line 54)
4009 * format of external database: Database format. (line 6)
4010 * Free Software Foundation: CD-ROM distribution. (line 12)
4011 * FreeBSD configure error: Empty Makefiles. (line 6)
4012 * FreeBSD shells and configure: configure shells. (line 19)
4013 * FSF Source Code CD-ROM: CD-ROM distribution. (line 12)
4014 * ftp retrieval: Electronic distribution.
4016 * ftp.tug.org: unixtex.ftp. (line 6)
4017 * fundamental purpose of Kpathsea: Introduction. (line 6)
4018 * gcc, compiling with: configure environment.
4020 * gdb, recommended: Bug checklist. (line 62)
4021 * generation of filename database: Filename database generation.
4023 * get_applicationShellWidgetClass: ShellWidgetClass. (line 6)
4024 * get_wmShellWidgetClass: ShellWidgetClass. (line 6)
4025 * gf: Supported file formats.
4027 * GFFONTS: Supported file formats.
4029 * globally writable directories: Security. (line 30)
4030 * glyph lookup: Glyph lookup. (line 6)
4031 * glyph lookup bitmap tolerance: Basic glyph lookup. (line 15)
4032 * GLYPHFONTS: Supported file formats.
4034 * GNU C compiler bugs: TeX or Metafont failing.
4036 * GNU General Public License: Introduction. (line 31)
4037 * group-writable directories: Security. (line 40)
4038 * GSFTOPK_DEBUG (128): Debugging. (line 88)
4039 * hash table buckets, printing: Debugging. (line 105)
4040 * hash table routines: Calling sequence. (line 83)
4041 * hash_summary_only variable for debugging: Debugging. (line 105)
4042 * help, mailing list for general TeX: Mailing lists. (line 29)
4043 * HIER: Default path features.
4045 * history of Kpathsea: History. (line 6)
4046 * home directories in paths: Tilde expansion. (line 6)
4047 * HOME, as ~ expansion: Tilde expansion. (line 6)
4048 * HP-UX, compiling on: TeX or Metafont failing.
4050 * identifiers, characters valid in: Config files. (line 36)
4051 * illegal pointer combination warnings: Pointer combination warnings.
4053 * include fontmap directive: Fontmap. (line 33)
4054 * INDEXSTYLE: Supported file formats.
4056 * info-tex@shsu.edu: Mailing lists. (line 29)
4057 * input lines, reading: Calling sequence. (line 83)
4058 * install-data Make target: Installing files. (line 28)
4059 * install-exec Make target: Installing files. (line 23)
4060 * installation: Installation. (line 6)
4061 * installation testing: Installation testing.
4063 * installation, architecture-(in)dependent files only: Installing files.
4065 * installation, changing default directories: Default path generation.
4067 * installation, customized: Custom installation. (line 6)
4068 * installation, getting executables instead of: Simple installation.
4070 * installation, simple: Simple installation. (line 6)
4071 * installing files: Installing files. (line 6)
4072 * interactive query: Path searching options.
4074 * interface, not frozen: Introduction. (line 27)
4075 * introduction: Introduction. (line 6)
4076 * kdebug:: Debugging. (line 105)
4077 * kdefault.c: Default expansion. (line 48)
4078 * Knuth, Donald E.: History. (line 6)
4079 * Knuth, Donald E., archive of programs by: Other TeX packages.
4081 * Knuth, Donald E., original author: Electronic distribution.
4083 * Korn shell, losing with configure: configure shells. (line 14)
4084 * Kpathsea config file, source for path: Path sources. (line 17)
4085 * Kpathsea version number: Kpathsea application distributions.
4087 * kpathsea.h: Programming overview.
4089 * kpathsea/HIER: Default path features.
4091 * kpathsea/README.CONFIGURE: Running configure. (line 15)
4092 * KPATHSEA_DEBUG: Calling sequence. (line 16)
4093 * kpathsea_debug: Debugging. (line 18)
4094 * KPATHSEA_DEBUG: Debugging. (line 18)
4095 * kpathsea_debug: Debugging. (line 6)
4096 * kpathsea_debug variable: Calling sequence. (line 37)
4097 * KPSE_BITMAP_TOLERANCE: Basic glyph lookup. (line 15)
4098 * kpse_cnf_get: Programming with config files.
4100 * KPSE_DEBUG_EXPAND (16): Debugging. (line 68)
4101 * KPSE_DEBUG_FOPEN (4): Debugging. (line 53)
4102 * KPSE_DEBUG_HASH (2): Debugging. (line 46)
4103 * KPSE_DEBUG_PATHS (8): Debugging. (line 60)
4104 * KPSE_DEBUG_SEARCH (32): Debugging. (line 74)
4105 * KPSE_DEBUG_STAT (1): Debugging. (line 38)
4106 * KPSE_DEBUG_VARS (64): Debugging. (line 83)
4107 * KPSE_DOT expansion: KPSE_DOT expansion. (line 6)
4108 * kpse_fallback_font: Fallback font. (line 15)
4109 * kpse_find_*: Calling sequence. (line 60)
4110 * kpse_find_file <1>: Calling sequence. (line 60)
4111 * kpse_find_file: File lookup. (line 26)
4112 * kpse_find_glyph_format: Glyph lookup. (line 26)
4113 * kpse_format_info: Calling sequence. (line 45)
4114 * kpse_format_info_type: Debugging. (line 61)
4115 * kpse_init_prog: Calling sequence. (line 51)
4116 * kpse_init_prog, and MAKETEX_MODE: Default path features.
4118 * kpse_make_specs: mktex script names. (line 6)
4119 * kpse_open_file: Calling sequence. (line 74)
4120 * kpse_program_name: Calling sequence. (line 16)
4121 * kpse_set_progname: Calling sequence. (line 30)
4122 * kpse_set_program_name: Calling sequence. (line 9)
4123 * kpse_var_value: Programming with config files.
4125 * kpsewhich: Invoking kpsewhich. (line 6)
4126 * Kpsewhich, and debugging: Debugging. (line 31)
4127 * ksh, losing with configure: configure shells. (line 14)
4128 * labrea.stanford.edu: Other TeX packages. (line 18)
4129 * LaserJet drive: Kpathsea application distributions.
4131 * last-resort font: Fallback font. (line 6)
4132 * LaTeX help mailing list: Mailing lists. (line 29)
4133 * lcircle10: Fontmap. (line 19)
4134 * LDFLAGS: configure environment.
4136 * leading colons: Default expansion. (line 6)
4137 * leaf directories wrongly guessed: Unable to find files.
4139 * leaf directory trick: Subdirectory expansion.
4141 * libdl.a: dlopen. (line 6)
4142 * libraries, changing: Running make. (line 40)
4143 * libraries, specifying additional: configure environment.
4145 * LIBS: configure environment.
4147 * libucb, avoiding: Running make. (line 44)
4148 * license for using the library: Introduction. (line 31)
4149 * LIGFONTS: Supported file formats.
4151 * lines, reading arbitrary-length: Calling sequence. (line 83)
4152 * Linux File System Standard: mktex configuration. (line 107)
4153 * Linux shells and configure: configure shells. (line 19)
4154 * Linux, using Web2c: CD-ROM distribution. (line 16)
4155 * lndir for building symlink trees: configure scenarios. (line 18)
4156 * loader options: configure environment.
4158 * loader options, final: Running make. (line 33)
4159 * loader options, initial: Running make. (line 30)
4160 * local cache of fonts: Security. (line 22)
4161 * log file: Logging. (line 6)
4162 * logging successful searches: Logging. (line 6)
4163 * lost+found directory: Searching overview. (line 56)
4164 * lostchar: Suppressing warnings.
4166 * ls-R: Supported file formats.
4168 * ls-R and AFS: Installing files. (line 40)
4169 * ls-R database file: ls-R. (line 6)
4170 * ls-R, simplest build: ls-R. (line 18)
4171 * Mach10 configure error: Empty Makefiles. (line 6)
4172 * Macintosh TeX implementations: Other TeX packages. (line 6)
4173 * MacKenzie, David <1>: Subdirectory expansion.
4175 * MacKenzie, David: History. (line 45)
4176 * magic characters: Searching overview. (line 13)
4177 * mailing lists: Mailing lists. (line 6)
4178 * maintainer-clean Make target: Cleaning up. (line 18)
4179 * Make arguments, additional: Running make. (line 36)
4180 * make, running: Running make. (line 6)
4181 * Makefile.in: Running configure. (line 6)
4182 * Makefiles, empty: Empty Makefiles. (line 6)
4183 * MAKETEX_DEBUG (512): Debugging. (line 91)
4184 * MAKETEX_FINE_DEBUG (1024): Debugging. (line 100)
4185 * MAKETEX_MODE: Default path features.
4187 * memory allocation routines: Calling sequence. (line 83)
4188 * metafont driver files: mktex configuration. (line 87)
4189 * Metafont failures: TeX or Metafont failing.
4191 * Metafont installation: Unable to generate fonts.
4193 * Metafont making too-large fonts: Unable to generate fonts.
4195 * Metafont using the wrong device: Unable to generate fonts.
4197 * MFBASES: Supported file formats.
4199 * MFINPUTS: Supported file formats.
4201 * MFPOOL: Supported file formats.
4203 * MFTINPUTS: Supported file formats.
4205 * mirrors, FTP: Electronic distribution.
4207 * MISCFONTS: Supported file formats.
4209 * mismatched checksum warnings: Suppressing warnings.
4211 * missfont.log: mktex script names. (line 25)
4212 * MISSFONT_LOG: mktex script names. (line 30)
4213 * missing character warnings: Suppressing warnings.
4215 * mktex script configuration: mktex configuration. (line 6)
4216 * mktex script names: mktex script names. (line 6)
4217 * mktex scripts: mktex scripts. (line 6)
4218 * mktex.cnf: mktex configuration. (line 23)
4219 * mktex.opt: mktex configuration. (line 34)
4220 * mktexdir: mktex configuration. (line 55)
4221 * mktexmf: mktex script names. (line 17)
4222 * mktexpk: mktex script names. (line 11)
4223 * mktexpk , initial runs: Simple installation. (line 79)
4224 * mktexpk can't guess mode: Unable to generate fonts.
4226 * mktextex: mktex script names. (line 14)
4227 * mktextfm: mktex script names. (line 20)
4228 * mode directory, omitting: mktex configuration. (line 92)
4229 * Morgan, Tim: History. (line 12)
4230 * mostlyclean Make target: Cleaning up. (line 10)
4231 * MPINPUTS: Supported file formats.
4233 * MPMEMS: Supported file formats.
4235 * MPPOOL: Supported file formats.
4237 * MPSUPPORT: Supported file formats.
4239 * MT_FEATURES: mktex configuration. (line 34)
4240 * multiple architectures, compiling on: configure scenarios. (line 18)
4241 * multiple architectures, directories for: configure scenarios.
4243 * multiple architectures, installing on: Installing files. (line 21)
4244 * multiple TeX hierarchies: Brace expansion. (line 20)
4245 * must exist: Searching overview. (line 31)
4246 * names for mktex scripts: mktex script names. (line 6)
4247 * NetBSD configure error: Empty Makefiles. (line 6)
4248 * NetBSD shells and configure: configure shells. (line 19)
4249 * Neumann, Gustaf: History. (line 57)
4250 * newsgroup for TeX: Mailing lists. (line 29)
4251 * NeXT sed error: Empty Makefiles. (line 6)
4252 * NeXT, lacking X11: Kpathsea application distributions.
4254 * NFS and ls-R: ls-R. (line 40)
4255 * NFS CTAN access: Electronic distribution.
4257 * nomfdrivers: mktex configuration. (line 86)
4258 * nomode: mktex configuration. (line 91)
4259 * non-English typesetting: Kpathsea application distributions.
4261 * non-Unix operating systems: Custom installation. (line 19)
4262 * none: Suppressing warnings.
4264 * null pointers, dereferencing: Bug checklist. (line 62)
4265 * numeric debugging values: Debugging. (line 34)
4266 * obtaining TeX: unixtex.ftp. (line 6)
4267 * obtaining Web2c by ftp: Electronic distribution.
4269 * obtaining Web2c on CD-ROM: CD-ROM distribution. (line 6)
4270 * OCPINPUTS: Supported file formats.
4272 * OFMFONTS: Supported file formats.
4274 * online Metafont display, spurious: Unable to generate fonts.
4276 * OPENTYPEFONTS: Supported file formats.
4278 * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
4280 * optimization caveat: TeX or Metafont failing.
4282 * optimization, enabling: configure scenarios. (line 32)
4283 * options for debugging: Debugging. (line 6)
4284 * options to configure: configure options. (line 16)
4285 * OS/2 support: Custom installation. (line 19)
4286 * other TeX distributions: Other TeX packages. (line 6)
4287 * OTPINPUTS: Supported file formats.
4289 * overview of path searching: Searching overview. (line 6)
4290 * overview of programming with Kpathsea: Programming overview.
4292 * OVFFONTS: Supported file formats.
4294 * OVPFONTS: Supported file formats.
4296 * patches, Sun OpenWin: ShellWidgetClass. (line 29)
4297 * path expansion: Path expansion. (line 6)
4298 * path searching: Path searching. (line 6)
4299 * path searching options: Path searching options.
4301 * path searching, overview: Searching overview. (line 6)
4302 * path searching, standalone: Invoking kpsewhich. (line 6)
4303 * path sources: Path sources. (line 6)
4304 * paths, changing default <1>: Default path generation.
4306 * paths, changing default: Changing search paths.
4308 * paths, device name included in: Default path features.
4310 * paths.h: Default path generation.
4312 * paths.h, creating: Running make. (line 6)
4313 * pathsearch.h: Programming overview.
4315 * pc Pascal compiler: History. (line 12)
4316 * PCL driver: Kpathsea application distributions.
4318 * PDF generation: Kpathsea application distributions.
4320 * pdftex.cfg: Path searching options.
4322 * PDFTEXCONFIG: Supported file formats.
4324 * pdftexconfig.tex: Path searching options.
4326 * permission denied: Searching overview. (line 56)
4327 * permissions, directory: Security. (line 51)
4328 * permissions, file: Security. (line 47)
4329 * PKFONTS: Supported file formats.
4331 * plain.base: Unable to generate fonts.
4333 * pointer combination warnings: Pointer combination warnings.
4335 * PostScript driver: Kpathsea application distributions.
4337 * PostScript fonts, additional: Simple installation. (line 60)
4338 * precompiled executables, instead of installation: Simple installation.
4340 * precompiled Unix binaries: Other TeX packages. (line 13)
4341 * preprocessor options: configure environment.
4343 * preprocessor options, additional: Running make. (line 24)
4344 * printer configuration files: Simple installation. (line 60)
4345 * privacy, semblance of: Logging. (line 32)
4346 * problems, common: Common problems. (line 6)
4347 * proginit.c: Default path features.
4349 * proginit.h: Calling sequence. (line 51)
4350 * program-varying paths: Supported file formats.
4352 * program_invocation_name: Calling sequence. (line 16)
4353 * program_invocation_short_name: Calling sequence. (line 16)
4354 * programming overview: Programming overview.
4356 * programming with config files: Programming with config files.
4358 * programming with Kpathsea: Calling sequence. (line 6)
4359 * programs using the library: Introduction. (line 13)
4360 * proof mode: Unable to generate fonts.
4362 * PSHEADERS: Supported file formats.
4364 * pxp Pascal preprocessor: History. (line 12)
4365 * quoting variable values: Variable expansion. (line 17)
4366 * readable: Suppressing warnings.
4368 * reading arbitrary-length lines: Calling sequence. (line 83)
4369 * README.CONFIGURE: Running configure. (line 15)
4370 * README.mirrors: Electronic distribution.
4372 * recording successful searches: Logging. (line 6)
4373 * relative filenames: Searching overview. (line 52)
4374 * relative filenames in ls-R: Installing files. (line 40)
4375 * reporting bugs: Reporting bugs. (line 6)
4376 * resident.c: Calling sequence. (line 45)
4377 * resolution, setting: Path searching options.
4379 * resolutions, last-resort: Fallback font. (line 6)
4380 * retrieving TeX: unixtex.ftp. (line 6)
4381 * right-hand side of variable assignments: Config files. (line 44)
4382 * Rokicki, Tom: History. (line 12)
4383 * root user: Tilde expansion. (line 19)
4384 * runtime configuration files: Config files. (line 6)
4385 * runtime debugging: Debugging. (line 6)
4386 * Sauter fonts, and dynamic source creation: mktex scripts. (line 6)
4387 * scripts for file creation: mktex scripts. (line 6)
4388 * search path, defined: Searching overview. (line 6)
4389 * search paths, changing default: Changing search paths.
4391 * searching for files: File lookup. (line 6)
4392 * searching for glyphs: Glyph lookup. (line 6)
4393 * searching overview: Searching overview. (line 6)
4394 * searching the database: Searching overview. (line 17)
4395 * searching the disk: Searching overview. (line 22)
4396 * security considerations: Security. (line 6)
4397 * sed error from configure: Empty Makefiles. (line 6)
4398 * SELFAUTODIR: Calling sequence. (line 16)
4399 * SELFAUTOLOC: Calling sequence. (line 16)
4400 * SELFAUTOPARENT: Calling sequence. (line 16)
4401 * sending patches: Bug checklist. (line 56)
4402 * setgid scripts: Security. (line 40)
4403 * SFDFONTS: Supported file formats.
4405 * sh5, ok with configure: configure shells. (line 25)
4406 * shared library, making: Shared library. (line 6)
4407 * shell scripts as configuration files: Config files. (line 67)
4408 * shell variables: Variable expansion. (line 17)
4409 * shell_escape, example for code: Programming with config files.
4411 * shells and configure: configure shells. (line 6)
4412 * simple installation: Simple installation. (line 6)
4413 * site overrides for mktex...: mktex configuration. (line 23)
4414 * size of distribution archives: Disk space. (line 6)
4415 * skeleton TeX directory: TeX directory structure.
4417 * slow startup time: Slow path searching. (line 6)
4418 * Solaris BSD compatibility, not: Running make. (line 44)
4419 * source files: Supported file formats.
4421 * sources for search paths: Path sources. (line 6)
4422 * special: Suppressing warnings.
4424 * st_nlink: Subdirectory expansion.
4426 * stack trace: Bug checklist. (line 62)
4427 * standalone path searching: Invoking kpsewhich. (line 6)
4428 * standard error and debugging output: Debugging. (line 27)
4429 * standard options: Standard options. (line 6)
4430 * startup time, excessive: Slow path searching. (line 6)
4431 * static linking: ShellWidgetClass. (line 39)
4432 * static linking and dlsym: dlopen. (line 6)
4433 * string routines: Calling sequence. (line 83)
4434 * strip: mktex configuration. (line 101)
4435 * stripsupplier: mktex configuration. (line 95)
4436 * striptypeface: mktex configuration. (line 98)
4437 * subdirectory searching: Subdirectory expansion.
4439 * suggestions, making: Introduction. (line 27)
4440 * Sun 2: History. (line 12)
4441 * Sun OpenWin patches: ShellWidgetClass. (line 29)
4442 * supplier directory, omitting: mktex configuration. (line 96)
4443 * supported file formats: Supported file formats.
4445 * suppressing warnings: Suppressing warnings.
4447 * symbolic link trees, for multiple architectures: configure scenarios.
4449 * symbolic links not found: Unable to find files.
4451 * symbolic links, and ls-R: ls-R. (line 38)
4452 * symlinks, resolving: Calling sequence. (line 16)
4453 * system C compiler bugs: TeX or Metafont failing.
4455 * system dependencies: Running configure. (line 6)
4456 * system V universe: Running make. (line 44)
4457 * T1FONTS: Supported file formats.
4459 * T1INPUTS: Supported file formats.
4461 * T42FONTS: Supported file formats.
4463 * TDS: TeX directory structure.
4465 * testing, post-installation: Installation testing.
4467 * tests, simple: Simple installation. (line 79)
4468 * teTeX: Other TeX packages. (line 13)
4469 * TeX directory structure: TeX directory structure.
4471 * TeX distributions besides Web2c: Other TeX packages. (line 6)
4472 * TeX environment variables: Supported file formats.
4474 * TeX failures: TeX or Metafont failing.
4476 * TeX file lookup: File lookup. (line 6)
4477 * TeX glyph lookup: Glyph lookup. (line 6)
4478 * TeX help mailing list: Mailing lists. (line 29)
4479 * TeX hierarchy, one: configure scenarios. (line 13)
4480 * TeX Live CD-ROM: CD-ROM distribution. (line 8)
4481 * TeX support: TeX support. (line 6)
4482 * TeX Users Group: Introduction. (line 39)
4483 * tex-archive@math.utah.edu: Mailing lists. (line 25)
4484 * tex-file.c: File lookup. (line 26)
4485 * tex-file.h: Programming overview.
4487 * tex-glyph.c: Glyph lookup. (line 26)
4488 * tex-glyph.h: Programming overview.
4490 * tex-k-request@mail.tug.org: Mailing lists. (line 7)
4491 * tex-k@mail.tug.org (bug address): Reporting bugs. (line 8)
4492 * tex-make.c: mktex script names. (line 6)
4493 * TEX_HUSH <1>: Suppressing warnings.
4495 * TEX_HUSH: Searching overview. (line 56)
4496 * TEXBIB: Supported file formats.
4498 * TEXCONFIG: Supported file formats.
4500 * TEXDOCS: Supported file formats.
4502 * TEXFONTMAPS: Supported file formats.
4504 * TEXFONTS: Supported file formats.
4506 * texfonts.map: Fontmap. (line 6)
4507 * TEXFORMATS: Supported file formats.
4509 * TEXINDEXSTYLE: Supported file formats.
4511 * TEXINPUTS: Supported file formats.
4513 * TEXMF: TeX directory structure.
4515 * texmf.cnf, and variable expansion: Variable expansion. (line 6)
4516 * texmf.cnf, creating: Running make. (line 6)
4517 * texmf.cnf, definition for: Config files. (line 6)
4518 * texmf.cnf, generated: Default path generation.
4520 * texmf.cnf, source for path: Path sources. (line 17)
4521 * texmf.in: Default path generation.
4523 * texmf.in, editing: Changing search paths.
4525 * texmf.sed: Default path generation.
4527 * TEXMFCNF <1>: Supported file formats.
4529 * TEXMFCNF: Config files. (line 6)
4530 * TEXMFDBS <1>: Supported file formats.
4532 * TEXMFDBS: ls-R. (line 6)
4533 * TEXMFINI: Supported file formats.
4535 * TEXMFLOG: Logging. (line 10)
4536 * TEXMFOUTPUT: mktex script names. (line 30)
4537 * TEXMFSCRIPTS: Supported file formats.
4539 * TEXMFVAR: mktex configuration. (line 117)
4540 * texmfvar: mktex configuration. (line 116)
4541 * TEXPICTS: Supported file formats.
4543 * TEXPKS: Supported file formats.
4545 * TEXPOOL: Supported file formats.
4547 * TEXPSHEADERS: Supported file formats.
4549 * TEXSIZES: Fallback font. (line 6)
4550 * TEXSOURCES: Supported file formats.
4552 * TFMFONTS: Supported file formats.
4554 * tilde expansion: Tilde expansion. (line 6)
4555 * tilde.c: Tilde expansion. (line 25)
4556 * time system call: Logging. (line 15)
4557 * tolerance for glyph lookup: Basic glyph lookup. (line 15)
4558 * total disk space: Disk space. (line 6)
4559 * trailing / in home directory: Tilde expansion. (line 19)
4560 * trailing colons: Default expansion. (line 6)
4561 * TRFONTS: Supported file formats.
4563 * trick for detecting leaf directories: Subdirectory expansion.
4565 * trojan horse attack: Security. (line 10)
4566 * TTFONTS: Supported file formats.
4568 * tug.org: unixtex.ftp. (line 6)
4569 * tug@tug.org: Introduction. (line 46)
4570 * typeface directory, omitting: mktex configuration. (line 99)
4571 * ucbinclude, avoiding: Running make. (line 44)
4572 * Ultrix shells and configure: configure shells. (line 25)
4573 * unable to find files: Unable to find files.
4575 * unable to generate fonts: Unable to generate fonts.
4577 * uname: Bug checklist. (line 21)
4578 * universe, BSD vs. system V: Running make. (line 44)
4579 * UNIX_ST_LINK: Subdirectory expansion.
4581 * unixtex.ftp: unixtex.ftp. (line 6)
4582 * unknown special warnings: Suppressing warnings.
4584 * unreadable file warnings: Suppressing warnings.
4586 * unreadable files: Searching overview. (line 56)
4587 * unusable ls-R warning: ls-R. (line 45)
4588 * usage patterns, finding: Logging. (line 6)
4589 * USE_TEXMFVAR: mktex configuration. (line 122)
4590 * USE_VARTEXFONTS: mktex configuration. (line 112)
4591 * Usenet TeX newsgroup: Mailing lists. (line 29)
4592 * USERPROFILE, as ~ expansion: Tilde expansion. (line 6)
4593 * varfonts: mktex configuration. (line 106)
4594 * variable expansion: Variable expansion. (line 6)
4595 * variable.c: Variable expansion. (line 32)
4596 * variable.h: Programming with config files.
4598 * VARTEXFONTS: mktex configuration. (line 107)
4599 * VAX 11/750: History. (line 12)
4600 * version number, of Kpathsea: Kpathsea application distributions.
4602 * version numbers, determining: Bug checklist. (line 16)
4603 * VF files, not found: Searching overview. (line 31)
4604 * VFFONTS: Supported file formats.
4606 * VMS support: Custom installation. (line 19)
4607 * VMS TeX implementations: Other TeX packages. (line 6)
4608 * Vojta, Paul: History. (line 30)
4609 * Walsh, Norman: History. (line 57)
4610 * warning about unusable ls-R: ls-R. (line 45)
4611 * warnings, file access: Searching overview. (line 56)
4612 * warnings, pointer combinations: Pointer combination warnings.
4614 * warnings, suppressing: Suppressing warnings.
4616 * wcstombs: dlopen. (line 6)
4617 * WEB2C: Supported file formats.
4619 * Weber, Olaf: History. (line 74)
4620 * WEBINPUTS: Supported file formats.
4622 * whitespace, in fontmap files: Fontmap. (line 28)
4623 * whitespace, not ignored on continuation lines: Config files.
4625 * Windows TeX implementations: Other TeX packages. (line 6)
4626 * World Wide Web CTAN access: Electronic distribution.
4628 * www.tug.org: unixtex.ftp. (line 6)
4629 * X11 previewer: Kpathsea application distributions.
4631 * X11, lacking on NeXT: Kpathsea application distributions.
4633 * XCFLAGS: Running make. (line 26)
4634 * XCPPFLAGS: Running make. (line 22)
4635 * XDEFS: Running make. (line 23)
4636 * XDVIFONTS: Supported file formats.
4638 * XDVIMAKEPK: mktex script names. (line 22)
4639 * XDVISIZES: Fallback font. (line 6)
4640 * XLDFLAGS: Running make. (line 29)
4641 * XLOADLIBES: Running make. (line 32)
4642 * XMAKEARGS: Running make. (line 35)
4643 * Xmu library problems: ShellWidgetClass. (line 13)
4644 * XtStrings: XtStrings. (line 6)
4645 * zuhn, david: History. (line 51)
4646 * { expansion: Brace expansion. (line 6)
4647 * ~ expansion: Tilde expansion. (line 6)
4653 Node: Introduction
\7f2124
4654 Node: History
\7f4106
4655 Node: Installation
\7f8198
4656 Node: Simple installation
\7f8988
4657 Node: Custom installation
\7f12571
4658 Node: Disk space
\7f13745
4659 Node: Kpathsea application distributions
\7f14629
4660 Node: Changing search paths
\7f15744
4661 Node: Default path features
\7f16926
4662 Node: Default path generation
\7f19062
4663 Node: Running configure
\7f20505
4664 Node: configure shells
\7f21556
4665 Node: configure options
\7f22608
4666 Node: configure environment
\7f24115
4667 Node: configure scenarios
\7f25917
4668 Node: Shared library
\7f27503
4669 Node: Running make
\7f28517
4670 Node: Installing files
\7f30564
4671 Node: Cleaning up
\7f32511
4672 Node: Filename database generation
\7f33559
4673 Node: mktex scripts
\7f34126
4674 Node: mktex configuration
\7f35083
4675 Node: mktex script names
\7f40627
4676 Node: mktex script arguments
\7f41725
4677 Node: Installation testing
\7f42615
4678 Node: Security
\7f42979
4679 Node: TeX directory structure
\7f45546
4680 Node: unixtex.ftp
\7f49968
4681 Node: Electronic distribution
\7f51983
4682 Node: CD-ROM distribution
\7f54748
4683 Node: Other TeX packages
\7f55718
4684 Node: Reporting bugs
\7f57014
4685 Node: Bug checklist
\7f57754
4686 Node: Mailing lists
\7f61456
4687 Node: Debugging
\7f62815
4688 Node: Logging
\7f67887
4689 Node: Common problems
\7f69757
4690 Node: Unable to find files
\7f70588
4691 Node: Slow path searching
\7f72999
4692 Node: Unable to generate fonts
\7f74376
4693 Node: TeX or Metafont failing
\7f76885
4694 Node: Empty Makefiles
\7f78763
4695 Node: XtStrings
\7f79993
4696 Node: dlopen
\7f80829
4697 Node: ShellWidgetClass
\7f81647
4698 Node: Pointer combination warnings
\7f83279
4699 Node: Path searching
\7f83668
4700 Node: Searching overview
\7f84315
4701 Node: Path sources
\7f87687
4702 Node: Config files
\7f88758
4703 Node: Path expansion
\7f92158
4704 Node: Default expansion
\7f93107
4705 Node: Variable expansion
\7f95177
4706 Node: Tilde expansion
\7f96580
4707 Node: Brace expansion
\7f97560
4708 Node: KPSE_DOT expansion
\7f98665
4709 Node: Subdirectory expansion
\7f99178
4710 Node: Filename database
\7f101527
4712 Node: Filename aliases
\7f105735
4713 Node: Database format
\7f106913
4714 Node: Invoking kpsewhich
\7f107926
4715 Node: Path searching options
\7f108803
4716 Node: Auxiliary tasks
\7f115452
4717 Node: Standard options
\7f117273
4718 Node: TeX support
\7f117593
4719 Node: Supported file formats
\7f118884
4720 Node: File lookup
\7f126032
4721 Node: Glyph lookup
\7f127323
4722 Node: Basic glyph lookup
\7f128450
4723 Node: Fontmap
\7f129329
4724 Node: Fallback font
\7f131946
4725 Node: Suppressing warnings
\7f132911
4726 Node: Programming
\7f134016
4727 Node: Programming overview
\7f134529
4728 Node: Calling sequence
\7f136805
4729 Node: Program-specific files
\7f141834
4730 Node: Programming with config files
\7f142872
4731 Node: Index
\7f144172
projects / mplib / blob