home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / octa21fs.zip / octave / kpathsea / doc / kpathsea.info (.txt) < prev    next >
GNU Info File  |  2000-01-15  |  189KB  |  3,487 lines
  1. This is Info file kpathsea.info, produced by Makeinfo version 1.68 from
  2. the input file kpathsea.texi.
  3. INFO-DIR-SECTION TeX
  4. START-INFO-DIR-ENTRY
  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.
  12. END-INFO-DIR-ENTRY
  13.   This file documents the Kpathsea library for path searching.
  14.   Copyright (C) 1993, 94, 95, 96, 97 K. Berry & O. Weber.
  15.   Permission is granted to make and distribute verbatim copies of this
  16. manual provided the copyright notice and this permission notice are
  17. preserved on all copies.
  18.   Permission is granted to copy and distribute modified versions of this
  19. manual under the conditions for verbatim copying, provided that the
  20. entire resulting derived work is distributed under the terms of a
  21. permission notice identical to this one.
  22.   Permission is granted to copy and distribute translations of this
  23. manual into another language, under the above conditions for modified
  24. versions, except that this permission notice may be stated in a
  25. translation approved by the Free Software Foundation.
  26. File: kpathsea.info,  Node: Top,  Next: Introduction,  Up: (dir)
  27. Kpathsea library
  28. ****************
  29.   This manual documents how to install and use the Kpathsea library for
  30. filename lookup.  It corresponds to version 3.2, released in October
  31. 1997.
  32. * Menu:
  33. * Introduction::                Overview.
  34. * Installation::                Compilation, installation, and bug reporting.
  35. * Path searching::              How filename lookups work.
  36. * TeX support::                 Special support for TeX-related file lookups.
  37. * Programming::                 How to use Kpathsea features in your program.
  38. * Index::                       General index.
  39. File: kpathsea.info,  Node: Introduction,  Next: Installation,  Prev: Top,  Up: Top
  40. Introduction
  41. ************
  42.   This manual corresponds to version 3.2 of the Kpathsea library,
  43. released in October 1997.
  44.   The library's fundamental purpose is to return a filename from a list
  45. of directories specified by the user, similar to what shells do when
  46. looking up program names to execute.
  47.   The following software, all of which we maintain, uses this library:
  48.    * Dviljk (see the `dvilj' man page)
  49.    * Dvipsk (*note Introduction: (dvips)Top.)
  50.    * GNU font utilities (*note Introduction: (fontu)Top.)
  51.    * Web2c (*note Introduction: (web2c)Top.)
  52.    * Xdvik (see the `xdvi' man page)
  53. Other software that we do not maintain also uses it.
  54.   We are still actively maintaining the library (and probably always
  55. will be, despite our hopes).  If you have comments or suggestions,
  56. please send them to us (*note Reporting bugs::.).
  57.   We distribute the library under the GNU Library General Public License
  58. (LGPL), with one exception (see below).  In short, this means if you
  59. write a program using the library, you must (offer to) distribute the
  60. source to the library, along with any changes you have made, and allow
  61. anyone to modify the library source and distribute their modifications.
  62. It does not mean you have to distribute the source to your program,
  63. although we hope you will.
  64.   The exception is the part of the file `expand.c' which implements
  65. brace expansion.  We took this from Bash, which is covered by the GNU
  66. General Public License (GPL).  Therefore, if you wish to redistribute
  67. the library under the LGPL, you must remove this code.  (If you write a
  68. replacement we can distribute, we hope you'll share it with us.)  See
  69. the files `COPYING' and `COPYING.LIB' for the text of the GNU licenses.
  70.   If you know enough about TeX to be reading this manual, then you (or
  71. your institution) should consider joining the TeX Users Group (if
  72. you're already a member, great!).  TUG produces the periodical
  73. `TUGboat', sponsors an annual meeting and publishes the proceedings,
  74. and arranges courses on TeX for all levels of users throughout the
  75. world.  Anyway, here is the address:
  76.      TeX Users Group
  77.      P.O. Box 1239
  78.      Three Rivers, CA 93271-1239
  79.      USA
  80.      phone: 1 209 561 0112
  81.      fax: 1 209 561 4584
  82.      email: <tug@tug.org>
  83. * Menu:
  84. * History::
  85. File: kpathsea.info,  Node: History,  Up: Introduction
  86. History
  87. =======
  88.   (This section is for those people who are curious about how the
  89. library came about.)  (If you like to read historical accounts of
  90. software, we urge you to seek out the GNU Autoconf manual and the
  91. "Errors of TeX" paper by Don Knuth, published in `Software--Practice and
  92. Experience' 19(7), July 1989.)
  93.   [Karl writes.]  My first ChangeLog entry for Web2c seems to be
  94. February 1990, but I may have done some work before then.  In any case,
  95. Tim Morgan and I were jointly maintaining it for a time.  (I should
  96. mention here that Tim had made Web2c into a real distribution long
  97. before I had ever used it or even heard of it, and Tom Rokicki did the
  98. original implementation.  I was using `pxp' and `pc' on VAX 11/750's
  99. and the hot new Sun 2 machines.)
  100.   It must have been later in 1990 and 1991 that I started working on
  101. `TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils
  102. (which I was also writing at the time) all used different environment
  103. variables, and, more importantly, had different bugs in their path
  104. searching. This became extremely painful, as I was stressing everything
  105. to the limit working on the book.  I also desperately wanted to
  106. implement subdirectory searching, since I couldn't stand putting
  107. everything in one big directory, and also couldn't stand having to
  108. explicitly specify `cm', `pandora', ... in a path.
  109.   In the first incarnation, I just hacked separately on each
  110. program--that was the original subdirectory searching code in both Xdvi
  111. and Dvips, though I think Paul Vojta has completely rewritten Xdvi's
  112. support by now.  That is, I tried to go with the flow in each program,
  113. rather than changing the program's calling sequences to conform to
  114. common routines.
  115.   Then, as bugs inevitably appeared, I found I was fixing the same thing
  116. three times (Web2c and fontutils were always sharing code, since I
  117. maintained those--there was no Dvipsk or Xdvik or Dviljk at this
  118. point).  After a while, I finally started sharing source files.  They
  119. weren't yet a library, though.  I just kept things up to date with shell
  120. scripts.  (I was developing on a 386 running ISC 2.2 at the time, and so
  121. didn't have symbolic links.  An awful experience.)
  122.   The ChangeLogs for Xdvik and Dvipsk record initial releases of those
  123. distributions in May and June 1992.  I think it was because I was tired
  124. of the different configuration strategies of each program, not so much
  125. because of the path searching.  (Autoconf was being developed by David
  126. MacKenzie and others, and I was adapting it to TeX and friends.)
  127.   I started to make a separate library that other programs could link
  128. with on my birthday in April 1993, according to the ChangeLog.  I don't
  129. remember exactly why I finally took the time to make it a separate
  130. library; a conversation with david zuhn that initiated it.  Just seemed
  131. like it was time.
  132.   Dviljk got started in March 1994 after I bought a Laserjet 4.
  133. (Kpathsea work got suspended while Norm Walsh and I, with Gustaf
  134. Neumann's help, implemented a way for TeX to get at all those neat
  135. builtin LJ4 fonts ... such a treat to have something to typeset in
  136. besides Palatino!)
  137.   By spring of 1995, I had implemented just about all the path-searching
  138. features in Kpathsea that I plan to, driven beyond my initial goals by
  139. Thomas Esser and others.  I then started to integrate Web2c with
  140. Kpathsea. After the release of a stable Web2c, I hope to be able to stop
  141. development, and turn most of my attention back to making fonts for GNU.
  142. (Always assuming Micros**t hasn't completely obliterated Unix by then,
  143. or that software patents haven't stopped software development by anybody
  144. smaller than a company with a million-dollar-a-year legal budget.  Which
  145. is actually what I think is likely to happen, but that's another
  146. story...)
  147.   [Olaf writes.]  At the end of 1997, UNIX is still alive and kicking,
  148. individuals still develop software, and Web2c development still
  149. continues.  Karl had been looking for some time for someone to take up
  150. part of the burden, and I volunteered.
  151. File: kpathsea.info,  Node: Installation,  Next: Path searching,  Prev: Introduction,  Up: Top
  152. Installation
  153. ************
  154.   (A copy of this chapter is in the distribution file
  155. `kpathsea/INSTALL'.)
  156.   The procedure for Kpathsea (and Web2c, etc.) configuration and
  157. installation follows.  If you encounter trouble, see *Note Common
  158. problems::, a copy of which is in the file `kpathsea/BUGS'.
  159. * Menu:
  160. * Simple installation::      If you just want to do it.
  161. * Custom installation::      If you want to change things around.
  162. * Security::                 Who can write what files, etc.
  163. * TeX directory structure::  Managing the horde of TeX input files.
  164. * unixtex.ftp::              Getting software via FTP, on CD-ROM, or on tape.
  165. * Reporting bugs::           Where and how to report bugs.
  166. File: kpathsea.info,  Node: Simple installation,  Next: Custom installation,  Up: Installation
  167. Simple installation
  168. ===================
  169.   Installing TeX and friends for the first time can be a daunting
  170. experience.  Thus, you may prefer to skip this whole thing and just get
  171. precompiled executables: see *Note unixtex.ftp::.
  172.   This section explains what to do if you wish to take the defaults for
  173. everything, and generally to install in the simplest possible way.  Most
  174. steps here refer to corresponding subsection in the next section which
  175. explains how to override defaults and generally gives more details.
  176.   By default everything will be installed under `/usr/local' and the
  177. following discussion assumes this.  However, if you already have TeX
  178. installed, its location is used to derive the directory under which
  179. everything is to be installed.
  180.   1. Be sure you have enough disk space: approximately 8 megabytes for
  181.      the compressed archives, 15MB for sources, 45MB for compilation,
  182.      40MB for the (initial) installed system (including library files).
  183.      *Note Disk space::.
  184.   2. Retrieve these two distribution archives:
  185.     `ftp://ftp.tug.org/tex/texk.tar.gz'
  186.           These are the sources, which you will be compiling.
  187.     `ftp://ftp.tug.org/tex/texmflib.tar.gz'
  188.           This is a basic set of input files.  You should unpack it in
  189.           the directory `/usr/local/share'; doing so will create a
  190.           `texmf' subdirectory there.
  191.      *Note Kpathsea application distributions::.
  192.   3. When using the default search paths, there is no need to edit any
  193.      distribution files. *Note Changing search paths::.
  194.   4. At the top level of the distribution, run `sh configure'.  (If you
  195.      have the GNU Bash shell installed, run `bash configure'.)  *Note
  196.      Running configure::.
  197.   5. `make'. *Note Running make::.  If you are using a BSD 4.4 system
  198.      such as FreeBSD or NetBSD, use GNU make (often installed in
  199.      `/usr/local/bin'), not the BSD make.
  200.      If you are using a HP-UX 10 system and the native compiler,
  201.      specify the `+u' flag in `XCFLAGS'.
  202.   6. `make install'. *Note Installing files::.
  203.   7. `make distclean'. *Note Cleaning up::.
  204.   8. Set up a cron job to rebuild the filename database that makes
  205.      searching faster.  This line will rebuild it every midnight:
  206.           0 0 * * * cd /usr/local/share/texmf && /BINDIR/mktexlsr
  207.      *Note Filename database generation::, and *Note Filename
  208.      database::.
  209.   9. If you're installing Dvips, you also need to set up configuration
  210.      files for your printers and make any additional PostScript fonts
  211.      available.  *Note Installation: (dvips)Installation.  If you have
  212.      any color printers, see *Note Color device configuration:
  213.      (dvips)Color device configuration.
  214.  10. The first time you run a DVI driver, a bunch of PK fonts will be
  215.      built by Metafont via `mktexpk' (and added to the filename
  216.      database).  This will take some time.  Don't be alarmed; they will
  217.      created only this first time (unless something is wrong with your
  218.      path definitions).
  219.      By default, `mktexpk' will create these fonts in a hierarchy under
  220.      `/var/tmp/texfonts'; it simply assumes that `/var/tmp' exists and
  221.      is globally writable.  If you need a different arrangement, see
  222.      *Note mktex configuration::.
  223.      *Note mktex scripts::.
  224.  11. For some simple tests, try `tex story \\bye' and `latex sample2e'.
  225.      Then run `xdvi story' or `dvips sample2e' on the resulting DVI
  226.      files to preview/print the documents.  *Note Installation
  227.      testing::.
  228. File: kpathsea.info,  Node: Custom installation,  Next: Security,  Prev: Simple installation,  Up: Installation
  229. Custom installation
  230. ===================
  231.   Most sites need to modify the default installation procedure in some
  232. way, perhaps merely changing the prefix from `/usr/local', perhaps
  233. adding extra compiler or loader options to work around `configure'
  234. bugs.  This section explains how to override default choices.  For
  235. additional distribution-specific information:
  236.    * `dviljk/INSTALL'.
  237.    * *Note Installation: (dvips)Installation.
  238.    * *Note Installation: (web2c)Installation.
  239.    * `xdvik/INSTALL'.
  240.   These instructions are for Unix systems.  Other operating-system
  241. specific distributions have their own instructions.  The code base
  242. itself supports Amiga, DOS, OS/2, and VMS.
  243.   Following are the same steps as in the previous section (which
  244. describes the simplest installation), but with much more detail.
  245. * Menu:
  246. * Disk space::
  247. * Kpathsea application distributions::
  248. * Changing search paths::
  249. * Running configure::
  250. * Running make::
  251. * Installing files::
  252. * Cleaning up::
  253. * Filename database generation::
  254. * mktex scripts::
  255. * Installation testing::
  256. File: kpathsea.info,  Node: Disk space,  Next: Kpathsea application distributions,  Up: Custom installation
  257. Disk space
  258. ----------
  259.   Here is a table showing the disk space needed for each distribution
  260. (described in the next section).  The `(totals)' line reflects the
  261. `texk' source distribution and `texmflib'; the individual distributions
  262. don't enter into it.  Sizes are in megabytes.  All numbers are
  263. approximate.
  264. Distribution  .tar.gz  Unpacked  Compiled  Installed  
  265. dviljk        .9       3.8                            
  266. dvipsk        .9       3.2                            
  267. xdvik         .7       2.5                            
  268. web2c         1.3      5.0                            
  269. web           1.9      6.5       -         -          
  270. texk          3.8      14.1      43.1      23.5       
  271. texmflib      3.8      15.0      -         15.0       
  272. (totals)      7.6      29.1      43.1      38.5       
  273. File: kpathsea.info,  Node: Kpathsea application distributions,  Next: Changing search paths,  Prev: Disk space,  Up: Custom installation
  274. Kpathsea application distributions
  275. ----------------------------------
  276.   The archive `ftp://ftp.tug.org/tex/texk.tar.gz' contains all of the
  277. Kpathsea applications I maintain, and the library itself.  For example,
  278. since NeXT does not generally support X11, you'd probably want to skip
  279. `xdvik' (or simply remove it after unpacking `texk.tar.gz'.  If you are
  280. not interested in all of them, you can also retrieve them separately:
  281. `dviljk.tar.gz'
  282.      DVI to PCL, for LaserJet printers.
  283. `dvipsk.tar.gz'
  284.      DVI to PostScript, for previewers, printers, or PDF generation.
  285. `web2c.tar.gz'
  286.      The software needed to compile TeX and friends.
  287. `web.tar.gz'
  288.      The original WEB source files, also used in compilation.
  289. `xdvik.tar.gz'
  290.      DVI previewing under the X window system.
  291.   If you want to use the Babel LaTeX package for support of non-English
  292. typesetting, you may need to retrieve additional files.  See the file
  293. `install.txt' in the Babel distribution.
  294. File: kpathsea.info,  Node: Changing search paths,  Next: Running configure,  Prev: Kpathsea application distributions,  Up: Custom installation
  295. Changing search paths
  296. ---------------------
  297.   If the search paths for your installation differ from the standard
  298. TeX directory structure (*note Introduction: (tds)Top.), edit the file
  299. `kpathsea/texmf.in' as desired, before running `configure'.  For
  300. example, if you have all your fonts or macros in one big directory.
  301.   You may also wish to edit the file `mktex.cnf', either before or
  302. after installation, to control various aspects of `mktexpk' and
  303. friends.  *Note mktex configuration::.
  304.   You do not need to edit `texmf.in' to change the default top-level or
  305. other installation *directories* (only the paths).  You can and should
  306. do that when you run `configure' (next step).
  307.   You also do not need to edit `texmf.in' if you are willing to rely on
  308. `texmf.cnf' at runtime to define the paths, and let the compile-time
  309. default paths be incorrect.  Usually there is no harm in doing this.
  310.   The section below explains default generation in more detail.
  311. * Menu:
  312. * Default path features::
  313. * Default path generation::
  314. File: kpathsea.info,  Node: Default path features,  Next: Default path generation,  Up: Changing search paths
  315. Default path features
  316. .....................
  317.   The purpose of having all the different files described in the section
  318. above is to avoid having the same information in more than one place. If
  319. you change the installation directories or top-level prefix at
  320. `configure'-time, those changes will propagate through the whole
  321. sequence.  And if you change the default paths in `texmf.in', those
  322. changes are propagated to the compile-time defaults.
  323.   The Make definitions are all repeated in several Makefile's; but
  324. changing the top-level `Makefile' should suffice, as it passes down all
  325. the variable definitions, thus overriding the submakes.  (The
  326. definitions are repeated so you can run Make in the subdirectories, if
  327. you should have occasion to.)
  328.   By default, the bitmap font paths end with `/$MAKETEX_MODE', thus
  329. including the device name (usually a Metafont mode name such as
  330. `ljfour').  This distinguishes two different devices with the same
  331. resolution--a write/white from a write/black 300dpi printer, for
  332. example.
  333.   However, since most sites don't have this complication, Kpathsea
  334. (specifically, the `kpse_init_prog' function in `kpathsea/proginit.c')
  335. has a special case: if the mode has not been explicitly set by the user
  336. (or in a configuration file), it sets `MAKETEX_MODE' to `/'.  This
  337. makes the default PK path, for example, expand into `.../pk//', so
  338. fonts will be found even if there is no subdirectory for the mode (if
  339. you arranged things that way because your site has only one printer,
  340. for example) or if the program is mode-independent (e.g., `pktype').
  341.   To make the paths independent of the mode, simply edit `texmf.in'
  342. before installation, or the installed `texmf.cnf', and remove the
  343. `$MAKETEX_MODE'.
  344.   *Note mktex script arguments::, for how this interacts with `mktexpk'.
  345.   *Note TeX directory structure: TeX directory structure, for a
  346. description of the default arrangement of the input files that comprise
  347. the TeX system.  The file `kpathsea/HIER' is a copy of that section.
  348. File: kpathsea.info,  Node: Default path generation,  Prev: Default path features,  Up: Changing search paths
  349. Default path generation
  350. .......................
  351.   This section describes how the default paths are constructed.
  352.   You may wish to ignore the whole mess and simply edit `texmf.cnf'
  353. after it is installed, perhaps even copying it into place beforehand so
  354. you can complete the installation, if it seems necessary.
  355.   To summarize the chain of events that go into defining the default
  356. paths:
  357.   1. `configure' creates a `Makefile' from each `Makefile.in'.
  358.   2. When Make runs in the `kpathsea' directory, it creates a file
  359.      `texmf.sed' that substitutes the Make value of `$(var)' for a
  360.      string `@var@'.  The variables in question are the one that define
  361.      the installation directories.
  362.   3. `texmf.sed' (together with a little extra magic--see
  363.      `kpathsea/Makefile') is applied to `texmf.in' to generate
  364.      `texmf.cnf'.  This is the file that will eventually be installed
  365.      and used.
  366.   4. The definitions in `texmf.cnf' are recast as C `#define''s in
  367.      `paths.h'.  These values will be the compile-time defaults; they
  368.      are not used at runtime unless no `texmf.cnf' file can be found.
  369.      (That's a lie: the compile-time defaults are what any extra :'s in
  370.      `texmf.cnf' expand into; but the paths as distributed have no extra
  371.      :'s, and there's no particular reason for them to.)
  372. File: kpathsea.info,  Node: Running configure,  Next: Running make,  Prev: Changing search paths,  Up: Custom installation
  373. Running `configure'
  374. -------------------
  375.   Run `sh configure OPTIONS' (in the top-level directory, the one
  376. containing `kpathsea/'), possibly using a shell other than `sh' (*note
  377. configure shells::.).
  378.   `configure' adapts the source distribution to the present system via
  379. `#define''s in `*/c-auto.h', which are created from the corresponding
  380. `c-auto.in'.  It also creates a `Makefile' from the corresponding
  381. `Makefile.in', doing `@VAR@' and `ac_include' substitutions).
  382.   `configure' is the best place to control the configuration,
  383. compilation, and installed location of the software, either via
  384. command-line options, or by setting environment variables before
  385. invoking it.  For example, you can disable `mktexpk' by default with
  386. the option `--disable-mktexpk'.  *Note configure options::.
  387. * Menu:
  388. * configure shells::
  389. * configure options::
  390. * configure environment::
  391. * configure scenarios::
  392. * Shared library::
  393. File: kpathsea.info,  Node: configure shells,  Next: configure options,  Up: Running configure
  394. `configure' shells
  395. ..................
  396.   If you have Bash, the GNU shell, use it if `sh' runs into trouble
  397. (*note Top: (features)Top.).
  398.   Most Bourne shell variants other than Bash cannot handle `configure'
  399. scripts as generated by GNU Autoconf (*note Introduction:
  400. (autoconf)Top.).  Specifically:
  401. `ksh'
  402.      The Korn shell may be installed as `/bin/sh' on AIX.  `/bin/bsh'
  403.      may serve instead.
  404. `ash'
  405.      Ash is sometimes installed as `/bin/sh' on NetBSD, FreeBSD, and
  406.      Linux systems.  `/bin/bash' should be available.
  407. `Ultrix /bin/sh'
  408.      `/bin/sh' under Ultrix is a DEC-grown shell that is notably
  409.      deficient in many ways.  `/bin/sh5' may be necessary.
  410. File: kpathsea.info,  Node: configure options,  Next: configure environment,  Prev: configure shells,  Up: Running configure
  411. `configure' options
  412. ...................
  413.   For a complete list of all `configure' options, run `configure
  414. --help' or see *Note Running `configure' scripts: (autoconf)Invoking
  415. configure, (a copy is in the file `kpathsea/README.CONFIGURE').  The
  416. generic options are listed first in the `--help' output, and the
  417. package-specific options come last.  The environment variables
  418. `configure' pays attention to are listed below.
  419.   Options particularly likely to be useful are `--prefix', `--datadir',
  420. and the like; see *Note configure scenarios::.
  421.   This section gives pointers to descriptions of the `--with' and
  422. `--enable' options to `configure' that Kpathsea-using programs accept.
  423. `--without-mktexmf-default'
  424. `--without-mktexpk-default'
  425. `--without-mktextfm-default'
  426. `--with-mktextex-default'
  427.      Enable or disable the dynamic generation programs.  *Note mktex
  428.      configuration::.
  429. `--enable-shared'
  430.      Build Kpathsea as a shared library, and link against it.  Also
  431.      build the usual static library.  *Note Shared library::.
  432. `--disable-static'
  433.      Build only the shared library.   Implies `--enable-shared'.
  434. `--enable-maintainer-mode'
  435.      Enables make targets that are useful for the maintainer and likely
  436.      to be a pain for anyone else; the makefiles created when this
  437.      option is enabled may not work at all for you.  You have been
  438.      warned.
  439. File: kpathsea.info,  Node: configure environment,  Next: configure scenarios,  Prev: configure options,  Up: Running configure
  440. `configure' environment
  441. .......................
  442.   `configure' uses the value of the following environment variables in
  443. determining your system's characteristics, and substitutes for them in
  444. Makefile's:
  445.      The compiler to use: default is `gcc' if it's installed, otherwise
  446.      `cc'.
  447. `CFLAGS'
  448.      Options to give the compiler: default is `-g -O2' for `gcc', `-g'
  449.      otherwise.  `CFLAGS' comes after any other options.  You may need
  450.      to include `-w' here if your compilations commonly have useless
  451.      warnings (e.g., `NULL redefined'), or `configure' may fail to
  452.      detect the presence of header files (it takes the messages on
  453.      standard error to mean the header file doesn't exist).
  454. `CPPFLAGS'
  455.      Options to pass to the compiler preprocessor; this matters most for
  456.      configuration, not the actual source compilation.  The `configure'
  457.      script often does only preprocessing (e.g., to check for the
  458.      existence of #include files), and `CFLAGS' is not used for this.
  459.      You may need to set this to something like
  460.      `-I/usr/local/include/wwwhatever' if you have the libwww library
  461.      installed for hyper-xdvik (see `xdvik/INSTALL').
  462. `DEFS'
  463.      Additional preprocessor options, but not used by `configure'.
  464.      Provided for enabling or disabling program features, as documented
  465.      in the various program-specific installation instructions.  `DEFS'
  466.      comes before any compiler options included by the distribution
  467.      `Makefile's or by `configure'.
  468. `LDFLAGS'
  469.      Additional options to give to the loader.  `LDFLAGS' comes before
  470.      any other linker options.
  471. `LIBS'
  472.      Additional libraries to link with.
  473. File: kpathsea.info,  Node: configure scenarios,  Next: Shared library,  Prev: configure environment,  Up: Running configure
  474. `configure' scenarios
  475. .....................
  476.   Here are some common installation scenarios:
  477.    * Including X support in Metafont.  This is disabled by default,
  478.      since many sites have no use for it, and it's a leading cause of
  479.      configuration problems.
  480.           configure --with-x-toolkit
  481.    * Putting the binaries, TeX files, GNU info files, etc. into a single
  482.      TeX hierarchy, say `/texmf', requires overriding defaults in both
  483.      `configure' and `make':
  484.           configure --prefix=`/texmf' --datadir=`/texmf'
  485.           make texmf=`/texmf'
  486.    * You can compile on multiple architectures simultaneously either by
  487.      building symbolic link trees with the `lndir' script from the X11
  488.      distribution, or with the `--srcdir' option:
  489.           configure --srcdir=SRCDIR
  490.    * If you are installing binaries for multiple architectures into a
  491.      single hierarchy, you will probably want to override the default
  492.      `bin' and `lib' directories, something like this:
  493.           configure --prefix=TEXMF --datadir=TEXMF \
  494.             --bindir=TEXMF/ARCH/bin --libdir=TEXMF/ARCH/lib
  495.           make texmf=TEXMF
  496.       (Unless you make provisions for architecture-specific files in
  497.      other ways, e.g., with Depot or an automounter.)
  498.    * To compile with optimization (to compile without debugging, remove
  499.      the `-g'):
  500.           env CFLAGS="-g -O" sh configure ...
  501.       For a potential problem if you optimize, see *Note TeX or
  502.      Metafont failing: TeX or Metafont failing.
  503. File: kpathsea.info,  Node: Shared library,  Prev: configure scenarios,  Up: Running configure
  504. Shared library
  505. ..............
  506.   You can compile Kpathsea as a shared library on a few systems, by
  507. specifying the option `--enable-shared' when you run `configure'.
  508.   The main advantage in doing this is that the executables can then
  509. share the code, thus decreasing memory and disk space requirements.
  510.   On some systems, you can record the location of shared libraries in a
  511. binary, usually by giving certain options to the linker.  Then
  512. individual users do not need to set their system's environment variable
  513. (e.g., `LD_LIBRARY_PATH') to find shared libraries.  If you want to do
  514. this, you will need to add the necessary options to `LDFLAGS' yourself;
  515. for example, on Solaris, include something like `-R${prefix}/lib', on
  516. IRIX or Linux, use `-rpath${prefix}/lib'.  (Unfortunately, making this
  517. happen by default is very difficult, because of interactions with an
  518. existing installed shared library.)
  519.   Currently, shared library support is implemented only on Linux, SunOS
  520. 4 (Solaris 1), SunOS 5 (Solaris 2), IRIX 5, and IRIX 6.  If you're
  521. interested and willing in adding support for other systems, please see
  522. the `configure' mode in the `klibtool' script, especially the
  523. host-specific case statement around line 250.
  524. File: kpathsea.info,  Node: Running make,  Next: Installing files,  Prev: Running configure,  Up: Custom installation
  525. Running `make'
  526. --------------
  527.   `make' (still in the top-level directory).  This also creates the
  528. `texmf.cnf' and `paths.h' files that define the default search paths,
  529. and (by default) the `plain' and `latex' TeX formats.
  530.   You can override directory names and other values at `make'-time.
  531. `make/paths.make' lists the variables most commonly reset.  For
  532. example, `make default_texsizes=600' changes the list of fallback
  533. resolutions.
  534.   You can also override each of `configure''s environment variables
  535. (*note configure environment::.).  The Make variables have the same
  536. names.
  537.   Finally, you can supply additional options via the following
  538. variables.  (`configure' does not use these.)
  539. `XCPPFLAGS'
  540. `XDEFS'
  541.      Preprocessor options.
  542. `XCFLAGS'
  543.      Compiler options.
  544. `XLDFLAGS'
  545.      Loader options (included at beginning of link commands).
  546. `XLOADLIBES'
  547.      More loader options (included at end of link commands).
  548. `XMAKEARGS'
  549.      Additional Make arguments passed to all sub-`make''s. You may need
  550.      to include assignments to the other variables here via `XMAKEARGS';
  551.      for example: `make XMAKEARGS="CFLAGS=-O XDEFS=-DA4"'.
  552.   It's generally a bad idea to use a different compiler (`CC') or
  553. libraries (`LIBS') for compilation than you did for configuration,
  554. since the values `configure' determined may then be incorrect.
  555.   Adding compiler options to change the "universe" you are using
  556. (typically BSD vs. system V) is generally a cause of trouble.  It's
  557. best to use the native environment, whatever that is; `configure' and
  558. the software usually adapt best to that.  In particular, under Solaris
  559. 2.x, you should not use the BSD-compatibility library (`libucb') or
  560. include files (`ucbinclude').
  561.   If you want to use the Babel LaTeX package for support of non-English
  562. typesetting, you need to modify some files before making the LaTeX
  563. format.  See the file `install.txt' in the Babel distribution.
  564. File: kpathsea.info,  Node: Installing files,  Next: Cleaning up,  Prev: Running make,  Up: Custom installation
  565. Installing files
  566. ----------------
  567.   The basic command is the usual `make install'.  For security issues,
  568. *note Security::..
  569.   The first time you install any manual in the GNU Info system, you
  570. should add a line (you choose where) to the file `dir' in your
  571. `$(infodir)' directory.  Sample text for this is given near the top of
  572. the Texinfo source files (`kpathsea/kpathsea.texi',
  573. `dvipsk/dvips.texi', and `web2c/doc/web2c.texi').  If you have a recent
  574. version of the GNU Texinfo distribution installed
  575. (`ftp://prep.ai.mit.edu/pub/gnu/texinfo-3.9.tar.gz' or later), this
  576. should happen automatically.
  577.   On the offchance that this is your first Info installation, the `dir'
  578. file I use is included in the distribution as `etc/dir-example'.
  579.   You may wish to use one of the following targets, especially if you
  580. are installing on multiple architectures:
  581.    * `make install-exec' to install in architecture-dependent
  582.      directories, i.e., ones that depend on the `$(exec_prefix)' Make
  583.      variable.  This includes links to binaries, libraries, etc., not
  584.      just "executables".
  585.    * `make install-data' to install in architecture-independent
  586.      directories, such as documentation, configuration files, pool
  587.      files, etc.
  588.   If you use the Andrew File System, the normal path (e.g., PREFIX/bin)
  589. only gets you to a read-only copy of the files, and you must specify a
  590. different path for installation.  The best way to do this is by setting
  591. the `prefix' variable on the `make' command line.  The sequence becomes
  592. something like this:
  593.      configure --prefix=/whatever
  594.      make
  595.      make install prefix=/afs/.SYSTEM.NAME/system/1.3/@sys/whatever
  596.    With AFS, you will definitely want to use relative filenames in
  597. `ls-R' (*note Filename database::.), not absolute filenames.  This is
  598. done by default, but check anyway.
  599. File: kpathsea.info,  Node: Cleaning up,  Next: Filename database generation,  Prev: Installing files,  Up: Custom installation
  600. Cleaning up
  601. -----------
  602. The basic command is `make distclean'.  This removes all files created
  603. by the build.
  604.   Alternatively,
  605.    * `make mostlyclean' if you intend to compile on another
  606.      architecture.  For Web2C, since the generated C files are portable,
  607.      they are not removed.  If the `lex' vs. `flex' situation is going
  608.      to be different on the next machine, `rm web2c/lex.yy.c'.
  609.    * `make clean' to remove files created by compiling, but leave
  610.      configuration files and Makefiles.
  611.    * `make maintainer-clean' to remove everything that the Makefiles can
  612.      rebuild.  This is more than `distclean' removes, and you should
  613.      only use it if you are thoroughly conversant with (and have the
  614.      necessary versions of) Autoconf.
  615.    * `make extraclean' to remove other junk, e.g., core files, log
  616.      files, patch rejects.  This is independent of the other `clean'
  617.      targets.
  618. File: kpathsea.info,  Node: Filename database generation,  Next: mktex scripts,  Prev: Cleaning up,  Up: Custom installation
  619. Filename database generation
  620. ----------------------------
  621.   You will probably want to set up a `cron' entry on the appropriate
  622. machine(s) to rebuild the filename database nightly or so, as in:
  623.      0 0 * * * cd TEXMF && /BINDIR/mktexlsr
  624.    *Note Filename database::.
  625. Although the `mktex...' scripts make every effort to add newly-created
  626. files on the fly, it can't hurt to make sure you get a fresh version
  627. every so often.
  628. File: kpathsea.info,  Node: mktex scripts,  Next: Installation testing,  Prev: Filename database generation,  Up: Custom installation
  629. `mktex' scripts
  630. ---------------
  631.   If Kpathsea cannot otherwise find a file, for some file types it is
  632. configured by default to invoke an external program to create it
  633. dynamically (*note mktex configuration::.).  This is most useful for
  634. fonts (bitmaps, TFM's, and arbitrarily-sizable Metafont sources such as
  635. the Sauter and EC fonts), since any given document can use fonts never
  636. before referenced.  Trying to build all fonts in advance is therefore
  637. impractical, if not impossible.
  638.   The script is passed the name of the file to create and possibly other
  639. arguments, as explained below.  It must echo the full pathname of the
  640. file it created (and nothing else) to standard output; it can write
  641. diagnostics to standard error.
  642. * Menu:
  643. * mktex configuration::
  644. * mktex script names::
  645. * mktex script arguments::
  646. File: kpathsea.info,  Node: mktex configuration,  Next: mktex script names,  Up: mktex scripts
  647. `mktex' configuration
  648. .....................
  649.   The following file types can run an external program to create missing
  650. files: `pk', `tfm', `mf', `tex'; the scripts are named `mktexpk',
  651. `mktextfm', `mktexmf', and `mktextex'.
  652.   In the absence of `configure' options specifying otherwise,
  653. everything but `mktextex' will be enabled by default. The `configure'
  654. options to change the defaults are:
  655.      --without-mktexmf-default
  656.      --without-mktexpk-default
  657.      --without-mktextfm-default
  658.      --with-mktextex-default
  659.   The `configure' setting is overridden if the environment variable or
  660. configuration file value named for the script is set; e.g., `MKTEXPK'
  661. (*note mktex script arguments::.).
  662.   As distributed, all the scripts source a file `texmf/web2c/mktex.cnf'
  663. if it exists, so you can override various defaults.  See `mktex.opt',
  664. for instance, which defines the default mode, resolution, some special
  665. directory names, etc.  If you prefer not to change the distributed
  666. scripts, you can simply create `mktex.cnf' with the appropriate
  667. definitions (you do not need to create it if you have nothing to put in
  668. it).  `mktex.cnf' has no special syntax; it's an arbitrary Bourne shell
  669. script.  The distribution contains a sample `mktex.cnf' for you to copy
  670. and modify as you please (it is not installed anywhere).
  671.   In addition, you can configure a number of features with the
  672. `MT_FEATURES' variable, which you can define:
  673.    * in `mktex.opt', as just mentioned;
  674.    * by editing the file `mktex.opt', either before `make install' (in
  675.      the source hierarchy) or after (in the installed hierarchy);
  676.    * or in the environment.
  677.   If none of the options below are enabled, `mktexpk', `mktextfm', and
  678. `mktexmf' follow the following procedure to decide where fonts should
  679. be installed.  Find the tree where the font's sources are, and test the
  680. permissions of the `fonts' directory of that tree to determine whether
  681. it is writable.  If it is, put the files in the tree in appropriate
  682. locations.  If it isn't writable, see whether the tree is a system tree
  683. (named in `SYSTEXMF').  If so, the `VARTEXFONTS' tree is used.  In all
  684. other cases the working directory is used.
  685.   The `appendonlydir' option is enabled by default.
  686. `appendonlydir'
  687.      Tell `mktexdir' to create directories append-only, i.e., set their
  688.      sticky bit (*note Mode Structure: (fileutils)Mode Structure.).
  689.      This feature is silently ignored on non-Unix platforms (e.g.
  690.      Windows/NT and MS-DOS) which don't support similar functionality.
  691.      This feature is enabled by default.
  692. `dosnames'
  693.      Use 8.3 names; e.g., `dpi600/cmr10.pk' instead of `cmr10.600pk'.
  694.      Note that this feature only affects filenames that would otherwise
  695.      clash with other TeX-related filenames; `mktex' scripts do nothing
  696.      about filenames which exceed the 8+3 MS-DOS limits but remain
  697.      unique when truncated (by the OS) to these limits, and nether do
  698.      the scripts care about possible clashes with files which aren't
  699.      related with TeX.  For example, `cmr10.600pk' would clash with
  700.      `cmr10.600gf' and is therefore changed when `dosnames' is in
  701.      effect, but `mf.pool' and `mp.base' don't clash with any
  702.      TeX-related files and are therefore unchanged.
  703.      This feature is turned on by default on MS-DOS.  If you do not wish
  704.      `dosnames' to be set on an MS-DOS platform, you need to set the
  705.      `MT_FEATURES' environment variable to a value that doesn't include
  706.      `dosnames'.  You can also change the default setting by editing
  707.      `mktex.opt', but only if you use the `mktex' shell scripts; the
  708.      emulation programs don't consult `mktex.opt'.
  709. `fontmaps'
  710.      Instead of deriving the location of a font in the destination tree
  711.      from the location of the sources, the aliases and directory names
  712.      from the Fontname distribution are used. (*note Introduction:
  713.      (fontname)Top.).
  714. `nomode'
  715.      Omit the directory level for the mode name; this is fine as long as
  716.      you generate fonts for only one mode.
  717. `stripsupplier'
  718.      Omit the font supplier name directory level.
  719. `striptypeface'
  720.      Omit the font typeface name directory level.
  721. `strip'
  722.      Omit the font supplier and typeface name directory levels.  This
  723.      feature is deprecated in favour of `stripsupplier' and
  724.      `striptypeface'.
  725. `varfonts'
  726.      When this option is enabled, fonts that would otherwise be written
  727.      in system texmf tree go to the `VARTEXFONTS' tree instead.  The
  728.      default value in `kpathsea/Makefile.in' is `/var/tmp/texfonts'.
  729.      The `Linux File System Standard' recommends `/var/tex/fonts'.
  730.      The `varfonts' setting in `MT_FEATURES' is overridden by the
  731.      `USE_VARTEXFONTS' environment variable: if set to `1', the feature
  732.      is enabled, and if set to `0', the feature is disabled.
  733. File: kpathsea.info,  Node: mktex script names,  Next: mktex script arguments,  Prev: mktex configuration,  Up: mktex scripts
  734. `mktex' script names
  735. ....................
  736.   The following table shows the default name of the script for each
  737. possible file types.  (The source is the variable `kpse_make_specs' in
  738. `kpathsea/tex-make.c'.)
  739. `mktexpk'
  740.      Glyph fonts.
  741. `mktextex'
  742.      TeX input files.
  743. `mktexmf'
  744.      Metafont input files.
  745. `mktextfm'
  746.      TFM files.
  747. These names are overridden by an environment variable specific to the
  748. program--for example, `DVIPSMAKEPK' for Dvipsk.
  749.   If a `mktex...' script fails, the invocation is appended to a file
  750. `missfont.log' (by default) in the current directory.  You can then
  751. execute the log file to create the missing files after fixing the
  752. problem.
  753.   If the current directory is not writable and the environment variable
  754. or configuration file value `TEXMFOUTPUT' is set, its value is used.
  755. Otherwise, nothing is written.  The name `missfont.log' is overridden
  756. by the `MISSFONT_LOG' environment variable or configuration file value.
  757. File: kpathsea.info,  Node: mktex script arguments,  Prev: mktex script names,  Up: mktex scripts
  758. `mktex' script arguments
  759. ........................
  760.   The first argument to a `mktex' script is always the name of the file
  761. to be created.
  762.   In the default `mktexpk' implementation, additional arguments may
  763. also be passed:
  764. `--dpi NUM'
  765.      Sets the resolution of the generated font to NUM.
  766. `--mfmode NAME'
  767.      Sets the Metafont mode to NAME.
  768. `--bdpi NUM'
  769.      Sets the the "base dpi" for the font.  This must match the mode
  770.      being used.
  771. `--mag STRING'
  772.      A "magstep" string suitable for the Metafont `mag' variable.  This
  773.      must match the combination of BDPI and DPI being used.
  774. `--destdir STRING'
  775.      A directory name. If the directory is absolute, it is used as-is.
  776.      Otherwise, it is appended to the root destination directory set in
  777.      the script.
  778. File: kpathsea.info,  Node: Installation testing,  Prev: mktex scripts,  Up: Custom installation
  779. Installation testing
  780. --------------------
  781.   Besides the tests listed in *Note Simple installation::, you can try
  782. running `make check'.  This includes the torture tests (trip, trap, and
  783. mptrap) that come with Web2c (*note Triptrap: (web2c)Triptrap.).
  784. File: kpathsea.info,  Node: Security,  Next: TeX directory structure,  Prev: Custom installation,  Up: Installation
  785. Security
  786. ========
  787.   None of the programs in the TeX system require any special system
  788. privileges, so there's no first-level security concern of people gaining
  789. illegitimate root access.
  790.   A TeX document, however, can write to arbitrary files, e.g.,
  791. `~/.rhosts', and thus an unwitting user who runs TeX on a random
  792. document is vulnerable to a trojan horse attack.  This loophole is
  793. closed by default, but you can be permissive if you so desire in
  794. `texmf.cnf'.  *Note tex invocation: (web2c)tex invocation.  MetaPost has
  795. the same issue.
  796.   Dvips, Xdvi, and TeX can also execute shell commands under some
  797. circumstances.  To disable this, see the `-R' option in *Note Option
  798. details: (dvips)Option details, the xdvi man page, and *Note tex
  799. invocation: (web2c)tex invocation, respectively.
  800.   Another security issue arises because it's very useful--almost
  801. necessary--to make arbitrary fonts on user demand with `mktexpk' and
  802. friends.  Where do these files get installed?  By default, the
  803. `mktexpk' distributed with Kpathsea assumes a world-writable `/var/tmp'
  804. directory; this is a simple and convenient approach, but it may not
  805. suit your situation because it means that a local cache of fonts is
  806. created on every machine.
  807.   To avoid this duplication, many people consider a shared, globally
  808. writable font tree desirable, in spite of the potential security
  809. problems.  To do this you should change the value of `VARTEXFONTS' in
  810. `texmf.cnf' to refer to some globally known directory.  *Note mktex
  811. configuration::.
  812.   The first restriction you can apply is to make newly-created
  813. directories under `texmf' be append-only with an option in `mktex.cnf'.
  814. *Note mktex configuration::.
  815.   Another approach is to establish a group (or user) for TeX files,
  816. make the `texmf' tree writable only to that group (or user), and make
  817. `mktexpk' et al. setgid to that group (or setuid to that user).  Then
  818. users must invoke the scripts to install things.  (If you're worried
  819. about the inevitable security holes in scripts, then you could write a
  820. C wrapper to exec the script.)
  821.   The `mktex...' scripts install files with the same read and write
  822. permissions as the directory they are installed in.  The executable,
  823. sgid, suid, and sticky bits are always cleared.
  824.   Any directories created by the `mktex...' scripts have the same
  825. permissions as their parent directory, unless the `appendonlydir'
  826. feature is used, in which case the sticky bit is always set.
  827. File: kpathsea.info,  Node: TeX directory structure,  Next: unixtex.ftp,  Prev: Security,  Up: Installation
  828. TeX directory structure
  829. =======================
  830.   This section describes the default installation hierarchy of the
  831. distribution.  It conforms to both the GNU coding standards and the TeX
  832. directory structure (TDS) standard.  For rationale and further
  833. explanation, please see those documents.  The GNU standard is available
  834. as `ftp://prep.ai.mit.edu/pub/gnu/standards/standards.texi' and
  835. mirrors.  The TDS document is available from `CTAN:/tex-archive/tds'
  836. (*note unixtex.ftp::.).
  837.   You can change the default paths in many ways (*note Changing search
  838. paths::.).  One common desire is to put everything (binaries and all)
  839. under a single top-level directory such as `/usr/local/texmf' or
  840. `/opt/texmf'--in the terms used below, make PREFIX and TEXMF the same.
  841. For specific instructions on doing that, see *Note configure
  842. scenarios::.
  843.   Here is a skeleton of the default directory structure, extracted from
  844. the TDS document:
  845.      PREFIX/      installation root (`/usr/local' by default)
  846.       bin/         executables
  847.       man/         man pages
  848.       include/     C header files
  849.       info/        GNU info files
  850.       lib/         libraries (`libkpathsea.*')
  851.       share/       architecture-independent files
  852.        texmf/      TDS root
  853.         bibtex/     BibTeX input files
  854.          bib/        BibTeX databases
  855.           base/       base distribution (e.g., `xampl.bib')
  856.           misc/       single-file databases
  857.           PKG/       name of a package
  858.          bst/        BibTeX style files
  859.           base/       base distribution (e.g., `plain.bst', `acm.bst')
  860.           misc/       single-file styles
  861.           PKG/       name of a package
  862.         doc/         additional documentation
  863.         dvips/       `.pro', `.ps', `psfonts.map'
  864.         fonts/       font-related files
  865.          TYPE/         file type (e.g., `tfm', `pk')
  866.           MODE/          type of output device (types `pk' and `gf' only)
  867.            SUPPLIER/       name of a font supplier (e.g., `public')
  868.             TYPEFACE/        name of a typeface (e.g., `cm')
  869.              dpiNNN/           font resolution (types `pk' and `gf' only)
  870.         metafont/    Metafont (non-font) input files
  871.          base/        base distribution (e.g., `plain.mf')
  872.          misc/        single-file packages (e.g., `modes.mf')
  873.          PKG/           name of a package (e.g., `mfpic')
  874.         metapost/    MetaPost input files
  875.          base/        base distribution (e.g., `plain.mp')
  876.          misc/        single-file packages
  877.          PKG/           name of a package
  878.          support/     support files for MetaPost-related utilities (e.g., `trfonts.map')
  879.         mft/         `MFT' inputs (e.g., `plain.mft')
  880.         tex/         TeX input files
  881.          FORMAT/         name of a format (e.g., `plain')
  882.           base/        base distribution for FORMAT (e.g., `plain.tex')
  883.           misc/        single-file packages (e.g., `webmac.tex')
  884.           local/       local additions to or local configuration files for FORMAT
  885.           PKG/           name of a package (e.g., `graphics', `mfnfss')
  886.          generic/     format-independent packages
  887.           hyphen/      hyphenation patterns (e.g., `hyphen.tex')
  888.           images/      image input files (e.g., Encapsulated PostScript)
  889.           misc/        single-file format-independent packages (e.g., `null.tex').
  890.           PKG/           name of a package (e.g., `babel')
  891.         web2c/        implementation-dependent files (`.pool', `.fmt', `texmf.cnf', etc.)
  892.   Some concrete examples for most file types:
  893.      /usr/local/bin/tex
  894.      /usr/local/man/man1/xdvi.1
  895.      /usr/local/info/kpathsea.info
  896.      /usr/local/lib/libkpathsea.a
  897.      /usr/local/share/texmf/bibtex/bst/base/plain.bst
  898.      /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
  899.      /usr/local/share/texmf/fonts/source/public/pandora/pnr10.mf
  900.      /usr/local/share/texmf/fonts/tfm/public/cm/cmr10.tfm
  901.      /usr/local/share/texmf/fonts/type1/adobe/utopia/putr.pfa
  902.      /usr/local/share/texmf/metafont/base/plain.mf
  903.      /usr/local/share/texmf/metapost/base/plain.mp
  904.      /usr/local/share/texmf/tex/plain/base/plain.tex
  905.      /usr/local/share/texmf/tex/generic/hyphen/hyphen.tex
  906.      /usr/local/share/texmf/web2c/tex.pool
  907.      /usr/local/share/texmf/web2c/tex.fmt
  908.      /usr/local/share/texmf/web2c/texmf.cnf
  909. File: kpathsea.info,  Node: unixtex.ftp,  Next: Reporting bugs,  Prev: TeX directory structure,  Up: Installation
  910. `unixtex.ftp': Obtaining TeX
  911. ============================
  912.   This is `ftp://ftp.tug.org/tex/unixtex.ftp', last updated 18 March
  913. 1998.  Also available as `http://www.tug.org/unixtex.ftp'.  The IP
  914. address is currently `[158.121.106.10]', and the canonical host name is
  915. currently `tug.org'.  It is also in Kpathsea source distributions as
  916. `etc/unixtex.ftp' (although the network version is usually newer).
  917. Mail <kb@mail.tug.org> with comments or questions.
  918.   Following are general instructions for Unix or other sites who wish to
  919. acquire the Web2c distribution, (plain) TeX, LaTeX (2e), BibTeX,
  920. Metafont, MetaPost, DVI processors for the X window system, PostScript,
  921. the PCL language in the HP LaserJet, and related programs.  They are
  922. oriented towards building from the original sources, though some
  923. information on alternative packages is included in the last section.
  924. See also `http://www.tug.org/web2c', the Web2c and Kpathsea home page.
  925.   Please consider joining the TeX Users Group (TUG) to help support the
  926. maintenance and development of the programs you retrieve.  Email
  927. <tug@tug.org> or see `http://www.tug.org' for information and a
  928. membership form.
  929.   For actual installation instructions after obtaining the necessary
  930. sources, see *Note Installation::.  A copy is in the distribution file
  931. `kpathsea/INSTALL'.
  932. * Menu:
  933. * Electronic distribution::  CTAN and so forth.
  934. * CD-ROM distribution::
  935. * Tape distribution::
  936. * Other TeX packages::
  937. File: kpathsea.info,  Node: Electronic distribution,  Next: CD-ROM distribution,  Up: unixtex.ftp
  938. Electronic distribution
  939. -----------------------
  940.   In many places we refer to CTAN:.  This is *both* a host name and a
  941. directory name.  Here are some primary locations:
  942.      `ftp://ctan.tug.org/tex-archive'    (California, USA)
  943.      `ftp://ftp.dante.de/tex-archive'    (Germany)
  944.      `ftp://ftp.tex.ac.uk/tex-archive'   (England)
  945. CTAN has many mirrors worldwide; see the top-level file
  946. `README.mirrors' from one of the sites above, or finger
  947. <ctan@ftp.tug.org>, or see `http://www.tug.org/CTAN.sites'.  A list
  948. current as of the time of distribution is in the top-level file
  949. `./MIRROR'.
  950.   You can also access CTAN via the World Wide Web, Gopher, electronic
  951. mail, or NFS.  The same `README.mirrors' file explains how.
  952.   You will need to retrieve some or all of the following archives,
  953. depending on your needs (don't forget to set binary mode for file
  954. transfers):
  955. `CTAN:/systems/web2c/texmflib.tar.gz'
  956.      A basic collection of fonts (TFM files only) and macro packages
  957.      (including Texinfo and LaTeX 2e).  It unpacks into `texmf/'; if
  958.      you change the structure of this hierarchy, you will also have to
  959.      change the default search paths (*note Changing search paths::.).
  960.      It is required unless you already have these files, in which case
  961.      you should change the default paths as necessary to find them.
  962.      There are other packages of library files, `etexlib.tar.gz',
  963.      `omegalib.tar.gz', and `pdftexlib.tar.gz', that are required as
  964.      well if you install e-TeX, Omega, or pdfTeX respectively.
  965. `CTAN:/systems/web2c/web.tar.gz'
  966.      The original WEB source files, written mostly by Don Knuth.
  967.      Required unless you already have this `web' version.  (The WEB
  968.      sources change irregularly with respect to Web2c itself.)  Unpacks
  969.      into `web2c-VERSION'.
  970. `CTAN:/systems/web2c/web2c.tar.gz'
  971.      The Web2c system.  Required.  Also unpacks into `web2c-VERSION'.
  972. `CTAN:/systems/web2c/web2c-etex.tar.gz'
  973.      Additions to the Web2c system for building e-TeX.  Optional.  Also
  974.      unpacks into `web2c-VERSION'.
  975. `CTAN:/systems/web2c/web2c-omega.tar.gz'
  976.      Additions to the Web2c system for building Omega.  Optional.  Also
  977.      unpacks into `web2c-VERSION'.
  978. `CTAN:/systems/web2c/web2c-pdftex.tar.gz'
  979.      Additions to the Web2c system for building pdfTeX.  Optional.  Also
  980.      unpacks into `web2c-VERSION'.
  981. `CTAN:/systems/web2c/texk.tar.gz'
  982.      The web and web2c sources, plus the additions for web2c, plus the
  983.      dvi drivers mentioned below, plus extra dvi drivers and tools not
  984.      packaged separately.  Recommended if you want to build a complete
  985.      system.  Unpacks into `texk-VERSION'.
  986. `CTAN:/dviware/dvipsk/dvipsk.tar.gz'
  987.      DVI-to-PostScript translator.  Unpacks into `dvipsk-VERSION'.
  988.      Optional.
  989. `CTAN:/dviware/xdvik/xdvik.tar.gz'
  990.      X window system DVI previewer.  Unpacks into `xdvik-VERSION'.
  991.      Optional.
  992. `CTAN:/dviware/dviljk/dviljk.tar.gz'
  993.      DVI-to-PCL (HP LaserJet) translator.  Unpacks into
  994.      `dviljk-VERSION'.  Optional.
  995.   All that said, the originating host for the software above is
  996. `ftp.tug.org'.  You can retrieve these distributions (but not much
  997. else) from the `tex/' directory on that host.
  998. File: kpathsea.info,  Node: CD-ROM distribution,  Next: Tape distribution,  Prev: Electronic distribution,  Up: unixtex.ftp
  999. CD-ROM distribution
  1000. -------------------
  1001.   Numerous organizations distribute various TeX CD-ROM's:
  1002.    * TUG, UK TUG, and GUTenberg (French-speaking TeX user group)
  1003.      collaborated to produce the `TeX Live' CD-ROM, based on teTeX,
  1004.      which in turn is based on Web2c; email <tex-live@mail.tug.org> or
  1005.      see `http://www.tug.org/tex-live.html'.
  1006.    * Dante (the German-speaking TeX user group) has produced a CD-ROM.
  1007.      See `http://www.dante.de/dante/DANTE-CTAN-CD-ROM.html', and
  1008.      `http://www.dante.de/tex-informationen/CD-ROMs.html' for
  1009.      information about TeX CD's in general.  Both are in German.
  1010.    * The Free Software Foundation's `Source Code CD-ROM' contains the
  1011.      minimal TeX source distribution described in the previous section
  1012.      (i.e., enough to print GNU documentation); email
  1013.      <gnu@prep.ai.mit.edu>.
  1014.    * The Gateway! CD-ROM set contains a runnable NetBSD/Amiga
  1015.      distribution and sources; see
  1016.      `http://www.netbsd.org/Sites/cdroms.html'.
  1017.    * The InfoMagic CD-ROM is a copy of CTAN (see previous section); see
  1018.      `http://www.infomagic.com'.
  1019.    * NTG (Dutch-speaking TeX user group) produced the 4allTeX CD-ROM;
  1020.      email <ntg@nic.surfnet.nl>, or see `http://www.ntg.nl/4allcd/'.
  1021.      This is a runnable system.
  1022.    * The Prime Time TeXcetera CD-ROM is also a copy of CTAN; email
  1023.      <ptf@ctcl.com> or see `http://www.ptf.com/ptf/'.
  1024.    * Walnut Creek's TeX CD-ROM is also a copy of CTAN; email
  1025.      <info@cdrom.com> or see `http://www.cdrom.com:/titles/tex.html'.
  1026.    * Most Linux distributions include some TeX package based on Web2c;
  1027.      see the Linux documentation file `Distribution-HOWTO' for a
  1028.      comparison of Linux distributions, available (for example) via
  1029.      `http://www.linux.org'.
  1030.   If you know of additional TeX CD-ROM distributions to add to this
  1031. list, please inform <kb@mail.tug.org>.
  1032. File: kpathsea.info,  Node: Tape distribution,  Next: Other TeX packages,  Prev: CD-ROM distribution,  Up: unixtex.ftp
  1033. Tape distribution
  1034. -----------------
  1035.   You can obtain a complete TeX distribution, including Web2c, on tape.
  1036. Contact:
  1037.      Pierre MacKay / Denny Hall, Mail Stop DH-10 / Department of Classics
  1038.      University of Washington / Seattle, WA 98195 / USA
  1039.      phone: 206-543-2268; email: <unixtex@u.washington.edu>
  1040.   At this writing, the distribution is available in `tar' format on 1/4
  1041. inch 4-track QIC-24 cartridges and 4mm DAT cartridges, and the cost is
  1042. US$210.  Make checks payable to the University of Washington, drawn on
  1043. a U.S. bank.  Purchase orders are acceptable, but they carry an extra
  1044. charge of $10 to pay for invoice processing.  Overseas sites, please
  1045. add $20 for shipment via air parcel post, or $30 for shipment via
  1046. courier.
  1047. File: kpathsea.info,  Node: Other TeX packages,  Prev: Tape distribution,  Up: unixtex.ftp
  1048. Other TeX packages
  1049. ------------------
  1050.   Many other TeX implementations are available in `CTAN:/systems',
  1051. including ready-to-run distributions for Unix, Amiga, Acorn, VMS,
  1052. Macintosh, DOS, and Windows (in various forms).  Although Web2c has
  1053. support in the source code for many operating systems, and in fact some
  1054. of the other distributions are based on it, it's unlikely to work as
  1055. distributed on anything but Unix.  (Please contribute improvements!)
  1056.   The Unix distribution alluded to above is the teTeX distribution.
  1057. This includes both complete sources and precompiled binaries for many
  1058. popular Unix variants, including Linux. It is based on Web2c, and
  1059. contains many other TeX-related programs as well.
  1060.   The host labrea.stanford.edu is the original source for the files for
  1061. which Donald Knuth is directly responsible: `tex.web', `plain.tex',
  1062. etc. However, unless you want to build your TeX library tree ab initio,
  1063. it is more reliable and less work to retrieve these files as part of
  1064. the above packages. In any case, labrea is not the canonical source for
  1065. anything except what was created by Stanford TeX project, so do not
  1066. rely on all the files available at that ftp site being up-to-date.
  1067. File: kpathsea.info,  Node: Reporting bugs,  Prev: unixtex.ftp,  Up: Installation
  1068. Reporting bugs
  1069. ==============
  1070.   (A copy of this chapter is in the file `kpathsea/BUGS'.)
  1071.   If you have problems or suggestions, please report them to
  1072. <tex-k@mail.tug.org> using the bug checklist below.
  1073.   Please report bugs in the documentation; not only factual errors or
  1074. inconsistent behavior, but unclear or incomplete explanations, typos,
  1075. wrong fonts, ...
  1076. * Menu:
  1077. * Bug checklist::       What to include in a good bug report.
  1078. * Mailing lists::       Joining the bugs or announcements mailing lists.
  1079. * Debugging::           Analyzing runtime problems.
  1080. * Logging::             Recording searches.
  1081. * Common problems::     When things go wrong.
  1082. File: kpathsea.info,  Node: Bug checklist,  Next: Mailing lists,  Up: Reporting bugs
  1083. Bug checklist
  1084. -------------
  1085.   Before reporting a bug, please check below to be sure it isn't already
  1086. known (*note Common problems::.).
  1087.   Bug reports should be sent via electronic mail to
  1088. <tex-k@mail.tug.org>, or by postal mail to 135 Center Hill Road /
  1089. Plymouth, MA 02360 / USA.
  1090.   The general principle is that a good bug report includes all the
  1091. information necessary for reproduction.  Therefore, to enable
  1092. investigation, your report should include the following:
  1093.    * The version number(s) of the program(s) involved, and of Kpathsea
  1094.      itself.  You can get the former by giving a sole option `--version'
  1095.      to the program, and the latter by running `kpsewhich --version'.
  1096.      The `NEWS' and `ChangeLog' files also contain the version number.
  1097.    * The hardware, operating system (including version number),
  1098.      compiler, and `make' program you are using (the output of `uname
  1099.      -a' is a start on the first two, though often incomplete).  If the
  1100.      bug involves the X window system, include X version and supplier
  1101.      information as well (examples: X11R6 from MIT; X11R4 from HP;
  1102.      OpenWindows 3.3 bundled with SunOS 4.1.4).
  1103.    * Any options you gave to `configure'.  This is recorded in the
  1104.      `config.status' files.
  1105.      If you are reporting a bug in `configure' itself, it's probably
  1106.      system-dependent, and it will be unlikely the maintainers can do
  1107.      anything useful if you merely report that thus-and-such is broken.
  1108.      Therefore, you need to do some additional work: for some bugs, you
  1109.      can look in the file `config.log' where the test that failed should
  1110.      appear, along with the compiler invocation and source program in
  1111.      question.  You can then compile it yourself by hand, and discover
  1112.      why the test failed.  Other `configure' bugs do not involve the
  1113.      compiler; in that case, the only recourse is to inspect the
  1114.      `configure' shell script itself, or the Autoconf macros that
  1115.      generated `configure'.
  1116.    * The log of all debugging output, if the bug is in path searching.
  1117.      You can get this by setting the environment variable
  1118.      `KPATHSEA_DEBUG' to `-1' before running the program.  Please look
  1119.      at the log yourself to make sure the behavior is really a bug
  1120.      before reporting it; perhaps "old" environment variable settings
  1121.      are causing files not to be found, for example.
  1122.    * The contents of any input files necessary to reproduce the bug.
  1123.      For bugs in DVI-reading programs, for example, this generally
  1124.      means a DVI file (and any EPS or other files it uses)--TeX source
  1125.      files are helpful, but the DVI file is necessary, because that's
  1126.      the actual program input.
  1127.      GNU `shar', available from `ftp://prep.ai.mit.edu/pub/gnu' is a
  1128.      convenient way of packaging multiple (possibly binary) files for
  1129.      electronic mail.  If you feel your input files are too big to send
  1130.      by email, you can ftp them to `ftp://ftp.tug.org/incoming' (that
  1131.      directory is writable, but not readable).
  1132.    * If you are sending a patch (do so if you can!), please do so in
  1133.      the form of a context diff (`diff -c') against the original
  1134.      distribution source.  Any other form of diff is either not as
  1135.      complete or harder for me to understand.  Please also include a
  1136.      `ChangeLog' entry.
  1137.    * If the bug involved is an actual crash (i.e., core dump), it is
  1138.      easy and useful to include a stack trace from a debugger (I
  1139.      recommend the GNU debugger GDB, available from
  1140.      `ftp://prep.ai.mit.edu/pub/gnu').  If the cause is apparent (a
  1141.      `NULL' value being dereferenced, for example), please send the
  1142.      details along.  If the program involved is TeX or Metafont, and
  1143.      the crash is happening at apparently-sound code, however, the bug
  1144.      may well be in the compiler, rather than in the program or the
  1145.      library (*note TeX or Metafont failing: TeX or Metafont failing.).
  1146.    * Any additional information that will be helpful in reproducing,
  1147.      diagnosing, or fixing the bug.
  1148. File: kpathsea.info,  Node: Mailing lists,  Next: Debugging,  Prev: Bug checklist,  Up: Reporting bugs
  1149. Mailing lists
  1150. -------------
  1151.   Web2c and Kpathsea in general are discussed on the mailing list
  1152. <tex-k@mail.tug.org>.  To join, email <tex-k-request@mail.tug.org> with
  1153. a line consisting of
  1154.      subscribe YOU@YOUR.PREFERRED.EMAIL.ADDRESS
  1155. in the body of the message.
  1156.   You do not need to join to submit a report, nor will it affect whether
  1157. you get a response.  There is no Usenet newsgroup equivalent (if you can
  1158. be the one to set this up, email `tex-k-request').  Traffic on the list
  1159. is fairly light, and is mainly bug reports and enhancement requests to
  1160. the software.  The best way to decide if you want to join or not is
  1161. read some of the archives from `ftp://ftp.tug.org/mail/archives/tex-k/'.
  1162.   Be aware that large data files are sometimes included in bug reports.
  1163. If this is a problem for you, do not join the list.
  1164.   If you only want announcements of new releases, not bug reports and
  1165. discussion, join <tex-archive@math.utah.edu> (via mail to
  1166. <tex-archive-request@math.utah.edu>).
  1167.   If you are looking for general TeX help, such as how to use LaTeX,
  1168. please use the mailing list <info-tex@shsu.edu> mailing list, which is
  1169. gatewayed to the `comp.text.tex' Usenet newsgroup (or post to the
  1170. newsgroup; the gateway is bidirectional).
  1171. File: kpathsea.info,  Node: Debugging,  Next: Logging,  Prev: Mailing lists,  Up: Reporting bugs
  1172. Debugging
  1173. ---------
  1174.   Kpathsea provides a number of runtime debugging options, detailed
  1175. below by their names and corresponding numeric values.  When the files
  1176. you expect aren't being found, the thing to do is enable these options
  1177. and examine the output.
  1178.   You can set these with some runtime argument (e.g., `-d') to the
  1179. program; in that case, you should use the numeric values described in
  1180. the program's documentation (which, for Dvipsk and Xdvik, are different
  1181. than those below).  It's best to give the `-d' (or whatever) option
  1182. first, for maximal output.  Dvipsk and Xdvik have additional
  1183. program-specific debugging options as well.
  1184.   You can also set the environment variable `KPATHSEA_DEBUG'; in this
  1185. case, you should use the numbers below.  If you run the program under a
  1186. debugger and set the variable `kpathsea_debug', also use the numbers
  1187. below.
  1188.   In any case, by far the simplest value to use is `-1', which will
  1189. turn on all debugging output.  This is usually better than guessing
  1190. which particular values will yield the output you need.
  1191.   Debugging output always goes to standard error, so you can redirect it
  1192. easily.  For example, in Bourne-compatible shells:
  1193.      dvips -d -1 ... 2>/tmp/debug
  1194.   It is sometimes helpful to run the standalone Kpsewhich utility
  1195. (*note Invoking kpsewhich::.), instead of the original program.
  1196.   In any case, you can *not* use the *names* below; you must always use
  1197. somebody's numbers.  (Sorry.)  To set more than one option, just sum
  1198. the corresponding numbers.
  1199. `KPSE_DEBUG_STAT (1)'
  1200.      Report `stat'(2) calls. This is useful for verifying that your
  1201.      directory structure is not forcing Kpathsea to do many additional
  1202.      file tests (*note Slow path searching::., and *note Subdirectory
  1203.      expansion::.). If you are using an up-to-date `ls-R' database
  1204.      (*note Filename database::.), this should produce no output unless
  1205.      a nonexistent file that must exist is searched for.
  1206. `KPSE_DEBUG_HASH (2)'
  1207.      Report lookups in all hash tables: `ls-R' and `aliases' (*note
  1208.      Filename database::.); font aliases (*note Fontmap::.); and config
  1209.      file values (*note Config files::.).  Useful when expected values
  1210.      are not being found, e.g.., file searches are looking at the disk
  1211.      instead of using `ls-R'.
  1212. `KPSE_DEBUG_FOPEN (4)'
  1213.      Report file openings and closings. Especially useful when your
  1214.      system's file table is full, for seeing which files have been
  1215.      opened but never closed. In case you want to set breakpoints in a
  1216.      debugger: this works by redefining `fopen' (`fclose') to be
  1217.      `kpse_fopen_trace' (`kpse_fclose_trace').
  1218. `KPSE_DEBUG_PATHS (8)'
  1219.      Report general path information for each file type Kpathsea is
  1220.      asked to search. This is useful when you are trying to track down
  1221.      how a particular path got defined--from `texmf.cnf', `config.ps',
  1222.      an environment variable, the compile-time default, etc.  This is
  1223.      the contents of the `kpse_format_info_type' structure defined in
  1224.      `tex-file.h'.
  1225. `KPSE_DEBUG_EXPAND (16)'
  1226.      Report the directory list corresponding to each path element
  1227.      Kpathsea searches. This is only relevant when Kpathsea searches
  1228.      the disk, since `ls-R' searches don't look through directory lists
  1229.      in this way.
  1230. `KPSE_DEBUG_SEARCH (32)'
  1231.      Report on each file search: the name of the file searched for, the
  1232.      path searched in, whether or not the file must exist (when drivers
  1233.      search for `cmr10.vf', it need not exist), and whether or not we
  1234.      are collecting all occurrences of the file in the path (as with,
  1235.      e.g., `texmf.cnf' and `texfonts.map'), or just the first (as with
  1236.      most lookups).  This can help you correlate what Kpathsea is doing
  1237.      with what is in your input file.
  1238. `KPSE_DEBUG_VARS (64)'
  1239.      Report the value of each variable Kpathsea looks up.  This is
  1240.      useful for verifying that variables do indeed obtain their correct
  1241.      values.
  1242. `GSFTOPK_DEBUG (128)'
  1243.      Activates debugging printout specific to `gsftopk' program.
  1244. `MAKETEX_DEBUG (512)'
  1245.      If you use the optional `mktex' programs instead of the
  1246.      traditional shell scripts, this will report the name of the site
  1247.      file (`mktex.cnf' by default) which is read, directories created by
  1248.      `mktexdir', the full path of the `ls-R' database built by
  1249.      `mktexlsr', font map searches, `MT_FEATURES' in effect, parameters
  1250.      from `mktexnam', filenames added by `mktexupd', and some
  1251.      subsidiary commands run by the programs.
  1252. `MAKETEX_FINE_DEBUG (1024)'
  1253.      When the optional `mktex' programs are used, this will print
  1254.      additional debugging info from functions internal to these
  1255.      programs.
  1256.   Debugging output from Kpathsea is always written to standard error,
  1257. and begins with the string `kdebug:'. (Except for hash table buckets,
  1258. which just start with the number, but you can only get that output
  1259. running under a debugger. See comments at the `hash_summary_only'
  1260. variable in `kpathsea/db.c'.)
  1261. File: kpathsea.info,  Node: Logging,  Next: Common problems,  Prev: Debugging,  Up: Reporting bugs
  1262. Logging
  1263. -------
  1264.   Kpathsea can record the time and filename found for each successful
  1265. search.  This may be useful in finding good candidates for deletion when
  1266. your filesystem is full, or in discovering usage patterns at your site.
  1267.   To do this, define the environment or config file variable
  1268. `TEXMFLOG'.  The value is the name of the file to append the
  1269. information to.  The file is created if it doesn't exist, and appended
  1270. to if it does.
  1271.   Each successful search turns into one line in the log file: two words
  1272. separated by a space. The first word is the time of the search, as the
  1273. integer number of seconds since "the epoch", i.e., UTC midnight 1
  1274. January 1970 (more precisely, the result of the `time' system call).
  1275. The second word is the filename.
  1276.   For example, after `setenv TEXMFLOG /tmp/log', running Dvips on
  1277. `story.dvi' appends the following lines:
  1278.      774455887 /usr/local/share/texmf/dvips/config.ps
  1279.      774455887 /usr/local/share/texmf/dvips/psfonts.map
  1280.      774455888 /usr/local/share/texmf/dvips/texc.pro
  1281.      774455888 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmbx10.600pk
  1282.      774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmsl10.600pk
  1283.      774455889 /usr/local/share/texmf/fonts/pk/ljfour/public/cm/cmr10.600pk
  1284.      774455889 /usr/local/share/texmf/dvips/texc.pro
  1285. Only filenames that are absolute are recorded, to preserve some
  1286. semblance of privacy.
  1287. File: kpathsea.info,  Node: Common problems,  Prev: Logging,  Up: Reporting bugs
  1288. Common problems
  1289. ---------------
  1290.   Here are some common problems with configuration, compilation,
  1291. linking, execution, ...
  1292. * Menu:
  1293. * Unable to find files::        If your program can't find fonts (or whatever).
  1294. * Slow path searching::         If it takes forever to find anything.
  1295. * Unable to generate fonts::    If mktexpk fails.
  1296. * TeX or Metafont failing::     Likely compiler bugs.
  1297. * Empty Makefiles::                When configure produces empty makefiles.
  1298. * XtStrings::                   When _XtStrings is undefined.
  1299. * dlopen::                      When dlopen is undefined.
  1300. * ShellWidgetClass::            For dynamic linking troubles under OpenWindows.
  1301. * Pointer combination warnings::  For old compilers that don't grok char *.
  1302. File: kpathsea.info,  Node: Unable to find files,  Next: Slow path searching,  Up: Common problems
  1303. Unable to find files
  1304. ....................
  1305.   If a program complains it cannot find fonts (or other input files),
  1306. any of several things might be wrong.  In any case, you may find the
  1307. debugging options helpful.  *Note Debugging::.
  1308.    * Perhaps you simply haven't installed all the necessary files; the
  1309.      basic fonts and input files are distributed separately from the
  1310.      programs.  *Note unixtex.ftp::.
  1311.    * You have (perhaps unknowingly) told Kpathsea to use search paths
  1312.      that don't reflect where the files actually are.  One common cause
  1313.      is having environment variables set from a previous installation,
  1314.      thus overriding what you carefully set in `texmf.cnf' (*note
  1315.      Supported file formats::.).  System `/etc/profile' or other files
  1316.      such may be the culprit.
  1317.    * Your files reside in a directory that is only pointed to via a
  1318.      symbolic link, in a leaf directory and is not listed in `ls-R'.
  1319.      Unfortunately, Kpathsea's subdirectory searching has an
  1320.      irremediable deficiency: If a directory D being searched for
  1321.      subdirectories contains plain files and symbolic links to other
  1322.      directories, but no true subdirectories, D will be considered a
  1323.      leaf directory, i.e., the symbolic links will not be followed.
  1324.      *Note Subdirectory expansion::.
  1325.      You can work around this problem by creating an empty dummy
  1326.      subdirectory in D. Then D will no longer be a leaf, and the
  1327.      symlinks will be followed.
  1328.      The directory immediately followed by the `//' in the path
  1329.      specification, however, is always searched for subdirectories,
  1330.      even if it is a leaf.  Presumably you would not have asked for the
  1331.      directory to be searched for subdirectories if you didn't want it
  1332.      to be.
  1333.    * If the fonts (or whatever) don't already exist, `mktexpk' (or
  1334.      `mktexmf' or `mktextfm') will try to create them.  If these rather
  1335.      complicated shell scripts fail, you'll eventually get an error
  1336.      message saying something like `Can't find font FONTNAME'. The best
  1337.      solution is to fix (or at least report) the bug in `mktexpk'; the
  1338.      workaround is to generate the necessary fonts by hand with
  1339.      Metafont, or to grab them from a CTAN site (*note unixtex.ftp::.).
  1340.    * There is a bug in the library. *Note Reporting bugs::.
  1341. File: kpathsea.info,  Node: Slow path searching,  Next: Unable to generate fonts,  Prev: Unable to find files,  Up: Common problems
  1342. Slow path searching
  1343. ...................
  1344.   If your program takes an excessively long time to find fonts or other
  1345. input files, but does eventually succeed, here are some possible
  1346. culprits:
  1347.    * Most likely, you just have a lot of directories to search, and that
  1348.      takes a noticeable time. The solution is to create and maintain a
  1349.      separate `ls-R' file that lists all the files in your main TeX
  1350.      hierarchy.  *Note Filename database::.  Kpathsea always uses `ls-R'
  1351.      if it's present; there's no need to recompile or reconfigure any
  1352.      of the programs.
  1353.    * Your recursively-searched directories (e.g.,
  1354.      `/usr/local/share/texmf/fonts//'), contain a mixture of files and
  1355.      directories. This prevents Kpathsea from using a useful
  1356.      optimization (*note Subdirectory expansion::.).
  1357.      It is best to have only directories (and perhaps a `README') in the
  1358.      upper levels of the directory structure, and it's very important
  1359.      to have *only* files, and no subdirectories, in the leaf
  1360.      directories where the dozens of TFM, PK, or whatever files reside.
  1361.   In any case, you may find the debugging options helpful in determining
  1362. precisely when the disk or network is being pounded.  *Note Debugging::.
  1363. File: kpathsea.info,  Node: Unable to generate fonts,  Next: TeX or Metafont failing,  Prev: Slow path searching,  Up: Common problems
  1364. Unable to generate fonts
  1365. ........................
  1366.   This can happen if either `mktexpk' hasn't been installed properly,
  1367. or if the local installation of Metafont isn't correct.
  1368.   If `mf' is a command not found by `mktexpk', then you need to install
  1369. Metafont (*note unixtex.ftp::.).
  1370.   If Metafont runs, but generates fonts at the wrong resolution, you
  1371. need to be sure the `M' and `D' lines in your Dvips configuration file
  1372. match (*note Config files: (dvips)Config files.).  For example, if
  1373. `mktexpk' is generating 300dpi fonts, but you need 600dpi fonts, you
  1374. should have:
  1375.      M ljfour
  1376.      D 600
  1377.   If Metafont runs but generates fonts at a resolution of 2602dpi (and
  1378. prints out the name of each character as well as just a character
  1379. number, and maybe tries to display the characters), then your Metafont
  1380. base file probably hasn't been made properly.  (It's using the default
  1381. `proof' mode, instead of an actual device mode.)  To make a proper
  1382. `plain.base', assuming the local mode definitions are contained in a
  1383. file `modes.mf', run the following command (assuming Unix):
  1384.      inimf "plain; input modes; dump"
  1385. Then copy the `plain.base' file from the current directory to where the
  1386. base files are stored on your system (`/usr/local/share/texmf/web2c' by
  1387. default), and make a link (either hard or soft) from `plain.base' to
  1388. `mf.base' in that directory.  *Note inimf invocation: (web2c)inimf
  1389. invocation.
  1390. File: kpathsea.info,  Node: TeX or Metafont failing,  Next: Empty Makefiles,  Prev: Unable to generate fonts,  Up: Common problems
  1391. TeX or Metafont failing
  1392. .......................
  1393.   If TeX or Metafont get a segmentation fault or otherwise fail while
  1394. running a normal input file, the problem is usually a compiler bug
  1395. (unlikely as that may sound).  Even if the trip and trap tests are
  1396. passed, problems may lurk.  Optimization occasionally causes trouble in
  1397. programs other than TeX and Metafont themselves, too.
  1398.   Insufficient swap space may also cause core dumps or other erratic
  1399. behavior.
  1400.   For a workaround, if you enabled any optimization flags, it's best to
  1401. omit optimization entirely.  In any case, the way to find the facts is
  1402. to run the program under the debugger and see where it's failing.
  1403.   Also, if you have trouble with a system C compiler, I advise trying
  1404. the GNU C compiler. And vice versa, unfortunately; but in that case I
  1405. also recommend reporting a bug to the GCC mailing list; see *Note Bugs:
  1406. (gcc)Bugs.
  1407.   To report compiler bugs effectively requires perseverance and
  1408. perspicacity: you must find the miscompiled line, and that usually
  1409. involves delving backwards in time from the point of error, checking
  1410. through TeX's (or whatever program's) data structures.  Things are not
  1411. helped by all-too-common bugs in the debugger itself.  Good luck.
  1412.   One known cause of trouble is the way arrays are handled.  Some of the
  1413. Pascal arrays have a lower index other than 0, and the C code will take
  1414. the pointer to the allocated memory, subtract the lower index, and use
  1415. the resulting pointer for the array.  While this trick often works, ANSI
  1416. C doesn't guarantee that it will.  It it known to fail on HP-UX 10
  1417. mchines when the native compiler is used, unless the `+u' compiler
  1418. switch was specified.  Using GCC will work on this platform as well.
  1419. File: kpathsea.info,  Node: Empty Makefiles,  Next: XtStrings,  Prev: TeX or Metafont failing,  Up: Common problems
  1420. Empty Makefiles
  1421. ...............
  1422.   On some systems (NetBSD, FreeBSD, AIX 4.1, and Mach10), `configure'
  1423. may fail to properly create the Makefiles. Instead, you get an error
  1424. which looks something like this:
  1425.      prompt$ ./configure
  1426.      ...
  1427.      creating Makefile
  1428.      sed: 1: "\\@^ac_include make/pat ...": \ can not be used as a string delimiter
  1429.   So far as I know, the bug here is in `/bin/sh' on these systems. I
  1430. don't have access to a machine running any of them, so if someone can
  1431. find a workaround that avoids the quoting bug, I'd be most grateful.
  1432. (Search for `ac_include' in the `configure' script to get to the
  1433. problematic code.)
  1434.   It should work to run `bash configure', instead of using `/bin/sh'.
  1435. You can get Bash from `ftp://prep.ai.mit.edu/pub/gnu' and mirrors.
  1436.   Another possible cause (reported for NeXT) is a bug in the `sed'
  1437. command.  In that case the error may look like this:
  1438.      Unrecognized command: \@^ac_include make/paths.make@r make/paths.make
  1439.   In this case, installing GNU `sed' should solve the problem.  You can
  1440. get GNU `sed' from the same places as Bash.
  1441. File: kpathsea.info,  Node: XtStrings,  Next: dlopen,  Prev: Empty Makefiles,  Up: Common problems
  1442. `XtStrings'
  1443. ...........
  1444.   You may find that linking X programs results in an error from the
  1445. linker that `XtStrings' is undefined, something like this:
  1446.      gcc -o virmf ...
  1447.      .../x11.c:130: undefined reference to `XtStrings'
  1448.   This generally happens because of a mismatch between the X include
  1449. files with which you compiled and the X libraries with which you linked;
  1450. often, the include files are from MIT and the libraries from Sun.
  1451.   The solution is to use the same X distribution for compilation and
  1452. linking.  Probably `configure' was unable to guess the proper
  1453. directories from your installation.  You can use the `configure'
  1454. options `--x-includes=PATH' and `--x-libraries=PATH' to explicitly
  1455. specify them.
  1456. File: kpathsea.info,  Node: dlopen,  Next: ShellWidgetClass,  Prev: XtStrings,  Up: Common problems
  1457. `dlopen'
  1458. ........
  1459.   (This section adapted from the file `dlsym.c' in the X distribution.)
  1460.   The `Xlib' library uses the standard C function `wcstombs'.  Under
  1461. SunOS 4.1, `wcstombs' uses the `dlsym' interface defined in `libdl.so'.
  1462. Unfortunately, the SunOS 4.1 distribution does not include a static
  1463. `libdl.a' library.
  1464.   As a result, if you try to link an X program statically under SunOS,
  1465. you may get undefined references to `dlopen', `dlsym', and `dlclose'.
  1466. One workaround is to include these definitions when you link:
  1467.      void *dlopen() { return 0; }
  1468.      void *dlsym()  { return 0; }
  1469.      int dlclose()  { return -1; }
  1470. These are contained in the `dlsym.c' file in the MIT X distribution.
  1471. File: kpathsea.info,  Node: ShellWidgetClass,  Next: Pointer combination warnings,  Prev: dlopen,  Up: Common problems
  1472. `ShellWidgetClass'
  1473. ..................
  1474.   (This section adapted from the comp.sys.sun.admin FAQ.)
  1475.   If you are linking with Sun's OpenWindows libraries in SunOS 4.1.x,
  1476. you may get undefined symbols `_get_wmShellWidgetClass' and
  1477. `_get_applicationShellWidgetClass' when linking. This problem does not
  1478. arise using the standard MIT X libraries under SunOS.
  1479.   The cause is bugs in the `Xmu' shared library as shipped from Sun.
  1480. There are several fixes:
  1481.    * Install the free MIT distribution from `ftp.x.org' and mirrors.
  1482.    * Get the OpenWindows patches listed below.
  1483.    * Statically link the `Xmu' library into the executable.
  1484.    * Avoid using `Xmu' at all. If you are compiling Metafont, see *Note
  1485.      Online Metafont graphics: (web2c)Online Metafont graphics. If you
  1486.      are compiling Xdvi, see the `-DNOTOOL' option in `xdvik/INSTALL'.
  1487.    * Ignore the errors. The binary runs fine regardless.
  1488.   Here is the information for getting the two patches:
  1489.      Patch ID: 100512-02
  1490.      Bug ID's: 1086793, 1086912, 1074766
  1491.      Description: 4.1.x OpenWindows 3.0 `libXt' jumbo patch
  1492.      
  1493.      Patch ID: 100573-03
  1494.      Bug ID: 1087332
  1495.      Description: 4.1.x OpenWindows 3.0 undefined symbols when using shared `libXmu'.
  1496.   The way to statically link with `libXmu' depends on whether you are
  1497. using a Sun compiler (e.g., `cc') or `gcc'. If the latter, alter the
  1498. `x_libs' Make variable to include
  1499.      -static -lXmu -dynamic
  1500.   If you are using the Sun compiler, use `-Bstatic' and `-Bdynamic'.
  1501. File: kpathsea.info,  Node: Pointer combination warnings,  Prev: ShellWidgetClass,  Up: Common problems
  1502. Pointer combination warnings
  1503. ............................
  1504.   When compiling with old C compilers, you may get some warnings about
  1505. "illegal pointer combinations".  These are spurious; just ignore them.
  1506. I decline to clutter up the source with casts to get rid of them.
  1507. File: kpathsea.info,  Node: Path searching,  Next: TeX support,  Prev: Installation,  Up: Top
  1508. Path searching
  1509. **************
  1510.   This chapter describes the generic path searching mechanism Kpathsea
  1511. provides.  For information about searching for particular file types
  1512. (e.g., TeX fonts), see the next chapter.
  1513. * Menu:
  1514. * Searching overview::          Basic scheme for searching.
  1515. * Path sources::                Where search paths can be defined.
  1516. * Path expansion::              Special constructs in search paths.
  1517. * Filename database::           Using an externally-built list to search.
  1518. * Invoking kpsewhich::          Standalone path lookup.
  1519. File: kpathsea.info,  Node: Searching overview,  Next: Path sources,  Up: Path searching
  1520. Searching overview
  1521. ==================
  1522.   A "search path" is a colon-separated list of "path elements", which
  1523. are directory names with a few extra frills.  A search path can come
  1524. from (a combination of) many sources; see below.  To look up a file
  1525. `foo' along a path `.:/dir', Kpathsea checks each element of the path
  1526. in turn: first `./foo', then `/dir/foo', returning the first match (or
  1527. possibly all matches).
  1528.   The "colon" and "slash" mentioned here aren't necessarily `:' and `/'
  1529. on non-Unix systems.  Kpathsea tries to adapt to other operating
  1530. systems' conventions.
  1531.   To check a particular path element E, Kpathsea first sees if a
  1532. prebuilt database (*note Filename database::.) applies to E, i.e., if
  1533. the database is in a directory that is a prefix of E.  If so, the path
  1534. specification is matched against the contents of the database.
  1535.   If the database does not exist, or does not apply to this path
  1536. element, or contains no matches, the filesystem is searched (if this
  1537. was not forbidden by the specification with `!!' and if the file being
  1538. searched for must exist).  Kpathsea constructs the list of directories
  1539. that correspond to this path element, and then checks in each for the
  1540. file being searched for.  (To help speed future lookups of files in the
  1541. same directory, the directory in which a file is found is floated to the
  1542. top of the directory list.)
  1543.   The "file must exist" condition comes into play with VF files and
  1544. input files read by the TeX `\openin' command.  These files may not
  1545. exist (consider `cmr10.vf'), and so it would be wrong to search the
  1546. disk for them.  Therefore, if you fail to update `ls-R' when you
  1547. install a new VF file, it will never be found.
  1548.   Each path element is checked in turn: first the database, then the
  1549. disk.  If a match is found, the search stops and the result is
  1550. returned.  This avoids possibly-expensive processing of path
  1551. specifications that are never needed on a particular run.  (Unless the
  1552. search explicitly requested all matches.)
  1553.   Although the simplest and most common path element is a directory
  1554. name, Kpathsea supports additional features in search paths: layered
  1555. default values, environment variable names, config file values, users'
  1556. home directories, and recursive subdirectory searching.  Thus, we say
  1557. that Kpathsea "expands" a path element, meaning transforming all the
  1558. magic specifications into the basic directory name or names.  This
  1559. process is described in the sections below.  It happens in the same
  1560. order as the sections.
  1561.   Exception to all of the above: If the filename being searched for is
  1562. absolute or explicitly relative, i.e., starts with `/' or `./' or
  1563. `../', Kpathsea simply checks if that file exists.
  1564.   Ordinarily, if Kpathsea tries to access a file or directory that
  1565. cannot be read, it gives a warning.  This is so you will be alerted to
  1566. directories or files that accidentally lack read permission (for
  1567. example, a `lost+found').  If you prefer not to see these warnings,
  1568. include the value `readable' in the `TEX_HUSH' environment variable or
  1569. config file value.
  1570.   This generic path searching algorithm is implemented in
  1571. `kpathsea/pathsearch.c'.  It is employed by a higher-level algorithm
  1572. when searching for a file of a particular type (*note File lookup::.,
  1573. and *Note Glyph lookup::).
  1574. File: kpathsea.info,  Node: Path sources,  Next: Path expansion,  Prev: Searching overview,  Up: Path searching
  1575. Path sources
  1576. ============
  1577.   A search path can come from many sources.  In the order in which
  1578. Kpathsea uses them:
  1579.   1. A user-set environment variable, e.g., `TEXINPUTS'.  Environment
  1580.      variables with an underscore and the program name appended
  1581.      override; for example, `TEXINPUTS_latex' overrides `TEXINPUTS' if
  1582.      the program being run is named `latex'.
  1583.   2. A program-specific configuration file, e.g., an `S /a:/b' line in
  1584.      Dvips' `config.ps' (*note Config files: (dvips)Config files.).
  1585.   3. A line in a Kpathsea configuration file `texmf.cnf', e.g.,
  1586.      `TEXINPUTS=/c:/d' (see below).
  1587.   4. The compile-time default (specified in `kpathsea/paths.h').
  1588.   You can see each of these values for a given search path by using the
  1589. debugging options (*note Debugging::.).
  1590.   These sources may be combined via default expansion (*note Default
  1591. expansion::.).
  1592. * Menu:
  1593. * Config files::        Kpathsea's runtime config files (texmf.cnf).
  1594. File: kpathsea.info,  Node: Config files,  Up: Path sources
  1595. Config files
  1596. ------------
  1597.   As mentioned above, Kpathsea reads "runtime configuration files"
  1598. named `texmf.cnf' for search path and other definitions.  The search
  1599. path used to look for these configuration files is named `TEXMFCNF',
  1600. and is constructed in the usual way, as described above, except that
  1601. configuration files cannot be used to define the path, naturally; also,
  1602. an `ls-R' database is not used to search for them.
  1603.   Kpathsea reads *all* `texmf.cnf' files in the search path, not just
  1604. the first one found; definitions in earlier files override those in
  1605. later files.  Thus, if the search path is `.:$TEXMF', values from
  1606. `./texmf.cnf' override those from `$TEXMF/texmf.cnf'.
  1607.   While (or instead of) reading this description, you may find it
  1608. helpful to look at the distributed `texmf.cnf', which uses or at least
  1609. mentions most features.  The format of `texmf.cnf' files follows:
  1610.    * Comments start with `%' and continue to the end of the line.
  1611.    * Blank lines are ignored.
  1612.    * A `\' at the end of a line acts as a continuation character, i.e.,
  1613.      the next line is appended.  Whitespace at the beginning of
  1614.      continuation lines is not ignored.
  1615.    * Each remaining line must look like
  1616.           VARIABLE [. PROGNAME] [=] VALUE
  1617.      where the `=' and surrounding whitespace is optional.
  1618.    * The VARIABLE name may contain any character other than whitespace,
  1619.      `=', or `.', but sticking to `A-Za-z_' is safest.
  1620.    * If `.PROGNAME' is present, the definition only applies if the
  1621.      program that is running is named (i.e., the last component of
  1622.      `argv[0]' is) PROGNAME or `PROGNAME.exe'.  This allows different
  1623.      flavors of TeX to have different search paths, for example.
  1624.    * VALUE may contain any characters except `%' and `@'.  (These
  1625.      restrictions are only necessary because of the processing done on
  1626.      `texmf.cnf' at build time, so you can stick those characters in
  1627.      after installation if you have to.)  The `$VAR.PROG' feature is
  1628.      not available on the right-hand side; instead, you must use an
  1629.      additional variable (see below for example).  A `;' in VALUE is
  1630.      translated to `:' if running under Unix; this is useful to write a
  1631.      single `texmf.cnf' which can be used under both Unix and NT.  (If
  1632.      you really want `;''s in your filenames, add
  1633.      `-DALLOW_SEMICOLON_IN_FILENAMES' to `CFLAGS'.)
  1634.    * All definitions are read before anything is expanded, so you can
  1635.      use variables before they are defined (like Make, unlike most other
  1636.      programs).
  1637. Here is a configuration file fragment illustrating most of these points:
  1638.      % TeX input files -- i.e., anything to be found by \input or \openin ...
  1639.      latex209_inputs = .:$TEXMF/tex/latex209//:$TEXMF/tex//
  1640.      latex2e_inputs = .:$TEXMF/tex/latex//:$TEXMF/tex//
  1641.      TEXINPUTS = .:$TEXMF/tex//
  1642.      TEXINPUTS.latex209 = $latex209_inputs
  1643.      TEXINPUTS.latex2e = $latex2e_inputs
  1644.      TEXINPUTS.latex = $latex2e_inputs
  1645.   Although this format has obvious similarities to Bourne shell
  1646. scripts--change the comment character to `#', disallow spaces around
  1647. the `=', and get rid of the `.NAME' convention, and it could be run
  1648. through the shell.  But there seemed little advantage to doing this,
  1649. since all the information would have to passed back to Kpathsea and
  1650. parsed there anyway, since the `sh' process couldn't affect its
  1651. parent's environment.
  1652.   The implementation of all this is in `kpathsea/cnf.c'.
  1653. File: kpathsea.info,  Node: Path expansion,  Next: Filename database,  Prev: Path sources,  Up: Path searching
  1654. Path expansion
  1655. ==============
  1656.   Kpathsea recognizes certain special characters and constructions in
  1657. search paths, similar to that in shells.  As a general example:
  1658. `~$USER/{foo,bar}//baz' expands to all subdirectories under directories
  1659. `foo' and `bar' in $USER's home directory that contain a directory or
  1660. file `baz'.  These expansions are explained in the sections below.
  1661. * Menu:
  1662. * Default expansion::           a: or :a or a::b expands to a default.
  1663. * Variable expansion::          $foo and ${foo} expand to environment values.
  1664. * Tilde expansion::             ~ and ~user expand to home directories.
  1665. * Brace expansion::             a{foo,bar}b expands to afoob abarb.
  1666. * KPSE_DOT expansion::          . is replaced with $KPSE_DOT if it is defined.
  1667. * Subdirectory expansion::      a// and a//b recursively expand to subdirs.
  1668. File: kpathsea.info,  Node: Default expansion,  Next: Variable expansion,  Up: Path expansion
  1669. Default expansion
  1670. -----------------
  1671.   If the highest-priority search path (*note Path sources::.) contains
  1672. an "extra colon" (i.e., leading, trailing, or doubled), Kpathsea
  1673. inserts at that point the next-highest-priority search path that is
  1674. defined.  If that inserted path has an extra colon, the same happens
  1675. with the next-highest.  (An extra colon in the compile-time default
  1676. value has unpredictable results, so installers beware.)
  1677.   For example, given an environment variable setting
  1678.      setenv TEXINPUTS /home/karl:
  1679. and a `TEXINPUTS' value from `texmf.cnf' of
  1680.      .:$TEXMF//tex
  1681. then the final value used for searching will be:
  1682.      /home/karl:.:$TEXMF//tex
  1683.   Since Kpathsea looks for multiple configuration files, it would be
  1684. natural to expect that (for example) an extra colon in `./texmf.cnf'
  1685. would expand to the path in `$TEXMF/texmf.cnf'.  Or, with Dvips'
  1686. configuration files, that an extra colon in `config.$PRINTER' would
  1687. expand to the path in `config.ps'.  This doesn't happen.  It's not
  1688. clear this would be desirable in all cases, and trying to devise a way
  1689. to specify the path to which the extra colon should expand seemed truly
  1690. baroque.
  1691.   Technicality: Since it would be useless to insert the default value in
  1692. more than one place, Kpathsea changes only one extra `:' and leaves any
  1693. others in place (they will eventually be ignored).  Kpathsea checks
  1694. first for a leading `:', then a trailing `:', then a doubled `:'.
  1695.   You can trace this by debugging "paths" (*note Debugging::.).
  1696. Default expansion is implemented in the source file
  1697. `kpathsea/kdefault.c'.
  1698. File: kpathsea.info,  Node: Variable expansion,  Next: Tilde expansion,  Prev: Default expansion,  Up: Path expansion
  1699. Variable expansion
  1700. ------------------
  1701.   `$foo' or `${foo}' in a path element is replaced by (1) the value of
  1702. an environment variable `foo' (if defined); (2) the value of `foo' from
  1703. `texmf.cnf' (if defined); (3) the empty string.
  1704.   If the character after the `$' is alphanumeric or `_', the variable
  1705. name consists of all consecutive such characters. If the character
  1706. after the `$' is a `{', the variable name consists of everything up to
  1707. the next `}' (braces may not be nested around variable names).
  1708. Otherwise, Kpathsea gives a warning and ignores the `$' and its
  1709. following character.
  1710.   You must quote the $'s and braces as necessary for your shell.
  1711. *Shell* variable values cannot be seen by Kpathsea, i.e., ones defined
  1712. by `set' in C shells and without `export' in Bourne shells.
  1713.   For example, given
  1714.      setenv tex /home/texmf
  1715.      setenv TEXINPUTS .:$tex:${tex}prev
  1716.    the final `TEXINPUTS' path is the three directories:
  1717.      .:/home/texmf:/home/texmfprev
  1718.   The `.PROGNAME' suffix on variables and `_PROGNAME' on environment
  1719. variable names are not implemented for general variable expansions.
  1720. These are only recognized when search paths are initialized (*note Path
  1721. sources::.).
  1722.   Variable expansion is implemented in the source file
  1723. `kpathsea/variable.c'.
  1724. File: kpathsea.info,  Node: Tilde expansion,  Next: Brace expansion,  Prev: Variable expansion,  Up: Path expansion
  1725. Tilde expansion
  1726. ---------------
  1727.   A leading `~' in a path element is replaced by the value of the
  1728. environment variable `HOME', or `.' if `HOME' is not set.
  1729.   A leading `~USER' in a path element is replaced by USER's home
  1730. directory from the system `passwd' database.
  1731.   For example,
  1732.      setenv TEXINPUTS ~/mymacros:
  1733. will prepend a directory `mymacros' in your home directory to the
  1734. default path.
  1735.   As a special case, if a home directory ends in `/', the trailing
  1736. slash is dropped, to avoid inadvertently creating a `//' construct in
  1737. the path.  For example, if the home directory of the user `root' is
  1738. `/', the path element `~root/mymacros' expands to just `/mymacros', not
  1739. `//mymacros'.
  1740.   Tilde expansion is implemented in the source file `kpathsea/tilde.c'.
  1741. File: kpathsea.info,  Node: Brace expansion,  Next: KPSE_DOT expansion,  Prev: Tilde expansion,  Up: Path expansion
  1742. Brace expansion
  1743. ---------------
  1744.   `x{A:B}y' expands to `xAy:xBy'.  For example:
  1745.      foo/{1:2}/baz
  1746. expands to `foo/1/baz:foo/2/baz'.  `:' is the path separator on the
  1747. current system; e.g., on a DOS system, it's `;'.
  1748.   Braces can be nested; for example, `x{A:B{1:2}}y' expands to
  1749. `xAy:xB1y:xB2y'.
  1750.   Multiple non-nested braces are expanded from right to left; for
  1751. example, `x{A:B}{1:2}y' expands to `x{A:B}1y:x{A:B}2y', which expands
  1752. to `xA1y:xB1y:xA2y:xB2:y'.
  1753.   This feature can be used to implement multiple TeX hierarchies, by
  1754. assigning a brace list to `$TEXMF', as mentioned in `texmf.in'.
  1755.   In old versions of the library you had to use a comma.  While this
  1756. usage is deprecated, it is still supported for backwards compatibility
  1757. with old configurations.  The last example could have been written
  1758. `x{A,B}{1,2}y'.
  1759.   Brace expansion is implemented in the source file
  1760. `kpathsea/expand.c'.  It is a modification of the Bash sources, and is
  1761. thus covered by the GNU General Public License, rather than the Library
  1762. General Public License that covers the rest of Kpathsea.
  1763. File: kpathsea.info,  Node: KPSE_DOT expansion,  Next: Subdirectory expansion,  Prev: Brace expansion,  Up: Path expansion
  1764. `KPSE_DOT' expansion
  1765. --------------------
  1766.   When `KPSE_DOT' is defined in the environment, it names a directory
  1767. that should be considered the current directory for the purpose of
  1768. looking up files in the search paths.  This feature is needed by the
  1769. `mktex...' scripts *Note mktex scripts::, because these change the
  1770. working directory.  You should not ever define it yourself.
  1771. File: kpathsea.info,  Node: Subdirectory expansion,  Prev: KPSE_DOT expansion,  Up: Path expansion
  1772. Subdirectory expansion
  1773. ----------------------
  1774.   Two or more consecutive slashes in a path element following a
  1775. directory D is replaced by all subdirectories of D: first those
  1776. subdirectories directly under D, then the subsubdirectories under
  1777. those, and so on.  At each level, the order in which the directories are
  1778. searched is unspecified.  (It's "directory order", and definitely not
  1779. alphabetical.)
  1780.   If you specify any filename components after the `//', only
  1781. subdirectories which match those components are included.  For example,
  1782. `/a//b' would expand into directories `/a/1/b', `/a/2/b', `/a/1/1/b',
  1783. and so on, but not `/a/b/c' or `/a/1'.
  1784.   You can include multiple `//' constructs in the path.
  1785.   `//' at the beginning of a path is ignored; you didn't really want to
  1786. search every directory on the system, did you?
  1787.   I should mention one related implementation trick, which I took from
  1788. GNU find.  Matthew Farwell suggested it, and David MacKenzie
  1789. implemented it.
  1790.   The trick is that in every real Unix implementation (as opposed to the
  1791. POSIX specification), a directory which contains no subdirectories will
  1792. have exactly two links (namely, one for `.' and one for `..').  That is
  1793. to say, the `st_nlink' field in the `stat' structure will be two.
  1794. Thus, we don't have to stat everything in the bottom-level (leaf)
  1795. directories--we can just check `st_nlink', notice it's two, and do no
  1796. more work.
  1797.   But if you have a directory that contains a single subdirectory and
  1798. 500 regular files, `st_nlink' will be 3, and Kpathsea has to stat every
  1799. one of those 501 entries.  Therein lies slowness.
  1800.   You can disable the trick by undefining `UNIX_ST_LINK' in
  1801. `kpathsea/config.h'. (It is undefined by default except under Unix.)
  1802.   Unfortunately, in some cases files in leaf directories are `stat''d:
  1803. if the path specification is, say, `$TEXMF/fonts//pk//', then files in
  1804. a subdirectory `.../pk', even if it is a leaf, are checked. The reason
  1805. cannot be explained without reference to the implementation, so read
  1806. `kpathsea/elt-dirs.c' (search for `may descend') if you are curious.
  1807. And if you can find a way to *solve* the problem, please let me know.
  1808.   Subdirectory expansion is implemented in the source file
  1809. `kpathsea/elt-dirs.c'.
  1810. File: kpathsea.info,  Node: Filename database,  Next: Invoking kpsewhich,  Prev: Path expansion,  Up: Path searching
  1811. Filename database (`ls-R')
  1812. ==========================
  1813.   Kpathsea goes to some lengths to minimize disk accesses for searches
  1814. (*note Subdirectory expansion::.).  Nevertheless, at installations with
  1815. enough directories, searching each possible directory for a given file
  1816. can take an excessively long time (depending on the speed of the disk,
  1817. whether it's NFS-mounted, how patient you are, etc.).
  1818.   In practice, a font tree containing the standard PostScript and PCL
  1819. fonts is large enough for searching to be noticeably slow on typical
  1820. systems these days.  Therefore, Kpathsea can use an externally-built
  1821. "database" file named `ls-R' that maps files to directories, thus
  1822. avoiding the need to exhaustively search the disk.
  1823.   A second database file `aliases' allows you to give additional names
  1824. to the files listed in `ls-R'.  This can be helpful to adapt to "8.3"
  1825. filename conventions in source files.
  1826.   The `ls-R' and `aliases' features are implemented in the source file
  1827. `kpathsea/db.c'.
  1828. * Menu:
  1829. * ls-R::                        The main filename database.
  1830. * Filename aliases::            Aliases for those names.
  1831. * Database format::             Syntax details of the database file.
  1832. File: kpathsea.info,  Node: ls-R,  Next: Filename aliases,  Up: Filename database
  1833. `ls-R'
  1834. ------
  1835.   As mentioned above, you must name the main filename database `ls-R'.
  1836. You can put one at the root of each TeX installation hierarchy you wish
  1837. to search (`$TEXMF' by default); most sites have only one hierarchy.
  1838. Kpathsea looks for `ls-R' files along the `TEXMFDBS' path, so that
  1839. should presumably match the list of hierarchies.
  1840.   The recommended way to create and maintain `ls-R' is to run the
  1841. `mktexlsr' script, which is installed in `$(bindir)' (`/usr/local/bin'
  1842. by default).  That script goes to some trouble to follow symbolic links
  1843. as necessary, etc.  It's also invoked by the distributed `mktex...'
  1844. scripts.
  1845.   At its simplest, though, you can build `ls-R' with the command
  1846.      cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R
  1847. presuming your `ls' produces the right output format (see the section
  1848. below).  GNU `ls', for example, outputs in this format.  Also presuming
  1849. your `ls' hasn't been aliased in a system file (e.g., `/etc/profile')
  1850. to something problematic, e.g., `ls --color=tty'.  In that case, you
  1851. will have to disable the alias before generating `ls-R'.  For the
  1852. precise definition of the file format, see *Note Database format::.
  1853.   Regardless of whether you use the supplied script or your own, you
  1854. will almost certainly want to invoke it via `cron', so when you make
  1855. changes in the installed files (say if you install a new LaTeX
  1856. package), `ls-R' will be automatically updated.
  1857.   The `-A' option to `ls' includes files beginning with `.'  (except
  1858. for `.' and `..'), such as the file `.tex' included with the LaTeX
  1859. tools package.  (On the other hand, *directories* whose names begin
  1860. with `.' are always ignored.)
  1861.   If your system does not support symbolic links, omit the `-L'.
  1862.   `ls -LAR /YOUR/TEXMF/ROOT' will also work.  But using `./' avoids
  1863. embedding absolute pathnames, so the hierarchy can be easily
  1864. transported.  It also avoids possible trouble with automounters or
  1865. other network filesystem conventions.
  1866.   Kpathsea warns you if it finds an `ls-R' file, but the file does not
  1867. contain any usable entries.  The usual culprit is running plain `ls -R'
  1868. instead of `ls -LR ./' or `ls -R /YOUR/TEXMF/ROOT'.  Another
  1869. possibility is some system directory name starting with a `.' (perhaps
  1870. if you are using AFS); Kpathsea ignores everything under such
  1871. directories.
  1872.   Because the database may be out-of-date for a particular run, if a
  1873. file is not found in the database, by default Kpathsea goes ahead and
  1874. searches the disk. If a particular path element begins with `!!',
  1875. however, *only* the database will be searched for that element, never
  1876. the disk.  If the database does not exist, nothing will be searched.
  1877. Because this can surprise users ("I see the font `foo.tfm' when I do an
  1878. `ls'; why can't Dvips find it?"), it is not in any of the default
  1879. search paths.
  1880. File: kpathsea.info,  Node: Filename aliases,  Next: Database format,  Prev: ls-R,  Up: Filename database
  1881. Filename aliases
  1882. ----------------
  1883.   In some circumstances, you may wish to find a file under several
  1884. names.  For example, suppose a TeX document was created using a DOS
  1885. system and tries to read `longtabl.sty'.  But now it's being run on a
  1886. Unix system, and the file has its original name, `longtable.sty'.  The
  1887. file won't be found.  You need to give the actual file `longtable.sty'
  1888. an alias `longtabl.sty'.
  1889.   You can handle this by creating a file `aliases' as a companion to
  1890. the `ls-R' for the hierarchy containing the file in question.  (You
  1891. must have an `ls-R' for the alias feature to work.)
  1892.   The format of `aliases' is simple: two whitespace-separated words per
  1893. line; the first is the real name `longtable.sty', and second is the
  1894. alias (`longtabl.sty').  These must be base filenames, with no
  1895. directory components.  `longtable.sty' must be in the sibling `ls-R'.
  1896.   Also, blank lines and lines starting with `%' or `#' are ignored in
  1897. `aliases', to allow for comments.
  1898.   If a real file `longtabl.sty' exists, it is used regardless of any
  1899. aliases.
  1900. File: kpathsea.info,  Node: Database format,  Prev: Filename aliases,  Up: Filename database
  1901. Database format
  1902. ---------------
  1903.   The "database" read by Kpathsea is a line-oriented file of plain
  1904. text. The format is that generated by GNU (and most other) `ls'
  1905. programs given the `-R' option, as follows.
  1906.    * Blank lines are ignored.
  1907.    * If a line begins with `/' or `./' or `../' and ends with a colon,
  1908.      it's the name of a directory.  (`../' lines aren't useful,
  1909.      however, and should not be generated.)
  1910.    * All other lines define entries in the most recently seen directory.
  1911.      /'s in such lines will produce possibly-strange results.
  1912.    * Files with no preceding directory line are ignored.
  1913.   For example, here's the first few lines of `ls-R' (which totals about
  1914. 30K bytes) on my system:
  1915.      bibtex
  1916.      dvips
  1917.      fonts
  1918.      ls-R
  1919.      metafont
  1920.      metapost
  1921.      tex
  1922.      web2c
  1923.      
  1924.      ./bibtex:
  1925.      bib
  1926.      bst
  1927.      doc
  1928.      
  1929.      ./bibtex/bib:
  1930.      asi.bib
  1931.      btxdoc.bib
  1932.      ...
  1933. File: kpathsea.info,  Node: Invoking kpsewhich,  Prev: Filename database,  Up: Path searching
  1934. `kpsewhich': Standalone path searching
  1935. ======================================
  1936.   The Kpsewhich program exercises the path searching functionality
  1937. independent of any particular application.  This can also be useful as a
  1938. sort of `find' program to locate files in your TeX hierarchies, perhaps
  1939. in administrative scripts.  It is used heavily in the distributed
  1940. `mktex...' scripts.
  1941.   Synopsis:
  1942.      kpsewhich OPTION... FILENAME...
  1943.   The options and filename(s) to look up can be intermixed.  Options
  1944. can start with either `-' or `--', and any unambiguous abbreviation is
  1945. accepted.
  1946. * Menu:
  1947. * Path searching options::      Changing the mode, resolution, etc.
  1948. * Auxiliary tasks::             Path and variable expansion.
  1949. * Standard options::            -help and -version.
  1950. File: kpathsea.info,  Node: Path searching options,  Next: Auxiliary tasks,  Up: Invoking kpsewhich
  1951. Path searching options
  1952. ----------------------
  1953.   Kpsewhich looks up each non-option argument on the command line as a
  1954. filename, and returns the first file found.  There is no option to
  1955. return all the files with a particular name (you can run the Unix
  1956. `find' utility for that, *note Invoking find: (findutils)Invoking
  1957. find.).
  1958.   Various options alter the path searching behavior:
  1959. `--dpi=NUM'
  1960.      Set the resolution to NUM; this only affects `gf' and `pk'
  1961.      lookups.  `-D' is a synonym, for compatibility with Dvips.
  1962.      Default is 600.
  1963. `--format=NAME'
  1964.      Set the format for lookup to NAME.  By default, the format is
  1965.      guessed from the filename, with `tex' being used if nothing else
  1966.      fits.  The recognized filename extensions (including any leading
  1967.      `.') are also allowable NAMEs.
  1968.      All formats also have a name, which is the only way to specify
  1969.      formats with no associated suffix.  For example, for Dvips
  1970.      configuration files you can use `--format="dvips config"'.  (The
  1971.      quotes are for the sake of the shell.)
  1972.      Here's the current list of recognized names and the associated
  1973.      suffixes.  *Note Supported file formats::, for more information on
  1974.      each of these.
  1975.           gf: gf
  1976.           pk: pk
  1977.           bitmap font
  1978.           afm: .afm
  1979.           base: .base
  1980.           bib: .bib
  1981.           bst: .bst
  1982.           cnf: .cnf
  1983.           ls-R: ls-R
  1984.           fmt: .fmt
  1985.           map: .map
  1986.           mem: .mem
  1987.           mf: .mf
  1988.           mfpool: .pool
  1989.           mft: .mft
  1990.           mp: .mp
  1991.           mppool: .pool
  1992.           MetaPost support
  1993.           ocp: .ocp
  1994.           ofm: .ofm .tfm
  1995.           opl: .opl
  1996.           otp: .otp
  1997.           ovf: .ovf
  1998.           ovp: .ovp
  1999.           graphic/figure: .eps .epsi
  2000.           tex: .tex
  2001.           TeX system documentation
  2002.           texpool: .pool
  2003.           TeX system sources
  2004.           PostScript header/font: .pro
  2005.           Troff fonts
  2006.           tfm: .tfm
  2007.           type1 fonts: .pfa .pfb
  2008.           vf: .vf
  2009.           dvips config
  2010.           ist: .ist
  2011.           truetype fonts: .ttf .ttc
  2012.           type42 fonts
  2013.           web2c files
  2014.           other text files
  2015.           other binary files
  2016.      This option and `--path' are mutually exclusive.
  2017. `--interactive'
  2018.      After processing the command line, read additional filenames to
  2019.      look up from standard input.
  2020. `-mktex=FILETYPE'
  2021. `-no-mktex=FILETYPE'
  2022.      Turn on or off the `mktex' script associated with FILETYPE.  The
  2023.      only values that make sense for FILETYPE are `pk', `mf', `tex',
  2024.      and `tfm'. By default, all are off in Kpsewhich.  *Note mktex
  2025.      scripts::.
  2026. `--mode=STRING'
  2027.      Set the mode name to STRING; this also only affects `gf' and `pk'
  2028.      lookups.  No default: any mode will be found.  *Note mktex script
  2029.      arguments::.
  2030. `--must-exist'
  2031.      Do everything possible to find the files, notably including
  2032.      searching the disk.  By default, only the `ls-R' database is
  2033.      checked, in the interest of efficiency.
  2034. `--path=STRING'
  2035.      Search along the path STRING (colon-separated as usual), instead
  2036.      of guessing the search path from the filename.  `//' and all the
  2037.      usual expansions are supported (*note Path expansion::.).  This
  2038.      option and `--format' are mutually exclusive.  To output the
  2039.      complete directory expansion of a path, instead of doing a
  2040.      one-shot lookup, see `--expand-path' in the following section.
  2041. `--progname=NAME'
  2042.      Set the program name to NAME; default is `kpsewhich'.  This can
  2043.      affect the search paths via the `.PROGNAM' feature in
  2044.      configuration files (*note Config files::.).
  2045. File: kpathsea.info,  Node: Auxiliary tasks,  Next: Standard options,  Prev: Path searching options,  Up: Invoking kpsewhich
  2046. Auxiliary tasks
  2047. ---------------
  2048.   Kpsewhich provides some additional features not strictly related to
  2049. path lookup:
  2050.    * `--debug=NUM' sets the debugging options to NUM.  *Note
  2051.      Debugging::.
  2052.    * `--expand-braces=STRING' outputs the variable and brace expansion
  2053.      of STRING.  *Note Path expansion::.
  2054.    * `--expand-var=STRING' outputs the variable expansion of STRING.
  2055.      For example, the `mktex...' scripts run `kpsewhich
  2056.      --expand-var='$TEXMF'' to find the root of the TeX system
  2057.      hierarchy.  *Note Path expansion::.
  2058.    * `--expand-path=STRING' outputs the complete expansion of STRING as
  2059.      a colon-separated path.  This is useful to construct a search path
  2060.      for a program that doesn't accept recursive subdirectory
  2061.      specifications.
  2062.      For one-shot uses of an arbitrary (not built in to Kpathsea) path,
  2063.      see `--path' in the previous section.
  2064.    * `--show-path=NAME' shows the path that would be used for file
  2065.      lookups of file type NAME.  Either a filename extension (`pk',
  2066.      `.vf', etc.) or an integer can be used, just as with `--format',
  2067.      described in the previous section.
  2068. File: kpathsea.info,  Node: Standard options,  Prev: Auxiliary tasks,  Up: Invoking kpsewhich
  2069. Standard options
  2070. ----------------
  2071.   Kpsewhich accepts the standard GNU options:
  2072.    * `--help' prints a help message on standard output and exits.
  2073.    * `--version' prints the Kpathsea version number and exits.
  2074. File: kpathsea.info,  Node: TeX support,  Next: Programming,  Prev: Path searching,  Up: Top
  2075. TeX support
  2076. ***********
  2077.   Although the basic features in Kpathsea can be used for any type of
  2078. path searching, it came about (like all libraries) with a specific
  2079. application in mind: I wrote Kpathsea specifically for TeX system
  2080. programs.  I had been struggling with the programs I was using (Dvips,
  2081. Xdvi, and TeX itself) having slightly different notions of how to
  2082. specify paths; and debugging was painful, since no code was shared.
  2083.   Therefore, Kpathsea provides some TeX-specific formats and features.
  2084. Indeed, many of the supposedly generic path searching features were
  2085. provided because they seemed useful in that conTeXt (font lookup,
  2086. particularly).
  2087.   Kpathsea provides a standard way to search for files of any of the
  2088. supported file types; glyph fonts are a bit different than all the rest.
  2089. Searches are based solely on filenames, not file contents--if a GF file
  2090. is named `cmr10.600pk', it will be found as a PK file.
  2091. * Menu:
  2092. * Supported file formats::      File types Kpathsea knows about.
  2093. * File lookup::                 Searching for most kinds of files.
  2094. * Glyph lookup::                Searching for bitmap fonts.
  2095. * Suppressing warnings::        Avoiding warnings via TEX_HUSH.
  2096. File: kpathsea.info,  Node: Supported file formats,  Next: File lookup,  Up: TeX support
  2097. Supported file formats
  2098. ======================
  2099.   Kpathsea has support for a number of file types.  Each file type has a
  2100. list of environment and config file variables that are checked to define
  2101. the search path, and most have a default suffix that plays a role in
  2102. finding files (see the next section).  Some also define additional
  2103. suffixes, and/or a program to be run to create missing files on the fly.
  2104.   Since environment variables containing periods, such as
  2105. `TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for
  2106. environment variables with an underscore, e.g., `TEXINPUTS_latex'
  2107. (*note Config files::.).
  2108.   The following table lists the above information.
  2109. `afm'
  2110.      (Adobe font metrics, *note Metric files: (dvips)Metric files.)
  2111.      `AFMFONTS'; suffix `.afm'.
  2112. `base'
  2113.      (Metafont memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2114.      `MFBASES', `TEXMFINI'; suffix `.base'.
  2115. `bib'
  2116.      (BibTeX bibliography source, *note bibtex invocation:
  2117.      (web2c)bibtex invocation.)  `BIBINPUTS', `TEXBIB'; suffix `.bib'.
  2118. `bst'
  2119.      (BibTeX style file, *note Basic BibTeX style files: (web2c)Basic
  2120.      BibTeX style files.)  `BSTINPUTS'; suffix `.bst'.
  2121. `cnf'
  2122.      (Runtime configuration files, *note Config files::.)  `TEXMFCNF';
  2123.      suffix `.cnf'.
  2124. `dvips config'
  2125.      (Dvips `config.*' files, such as `config.ps', *note Config files:
  2126.      (dvips)Config files.)  `TEXCONFIG'.
  2127. `fmt'
  2128.      (TeX memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2129.      `TEXFORMATS', `TEXMFINI'; suffix `.fmt'.
  2130.      (generic font bitmap, *note Glyph files: (dvips)Glyph files.)
  2131.      `PROGRAMFONTS', `GFFONTS', `GLYPHFONTS', `TEXFONTS'; suffix `gf'.
  2132. `graphic/figure'
  2133.      (Encapsulated PostScript figures, *note PostScript figures:
  2134.      (dvips)PostScript figures.)  `TEXPICTS', `TEXINPUTS'; additional
  2135.      suffixes: `.eps', `.epsi'.
  2136. `ist'
  2137.      (makeindex style files) `TEXINDEXSTYLE', `INDEXSTYLE'; suffix
  2138.      `.ist'.
  2139. `ls-R'
  2140.      (Filename databases, *note Filename database::.)  `TEXMFDBS'.
  2141. `map'
  2142.      (Fontmaps, *note Fontmap::.)  `TEXFONTMAPS'; suffix `.map'.
  2143. `mem'
  2144.      (MetaPost memory dump, *note Memory dumps: (web2c)Memory dumps.)
  2145.      `MPMEMS', `TEXMFINI'; suffix `.mem'.
  2146. `MetaPost support'
  2147.      (MetaPost support files, used by DMP; *note dmp invocation:
  2148.      (web2c)dmp invocation.)  `MPSUPPORT'.
  2149.      (Metafont source, *note mf invocation: (web2c)mf invocation.)
  2150.      `MFINPUTS'; suffix `.mf'; dynamic creation program: `mktexmf'.
  2151. `mfpool'
  2152.      (Metafont program strings, *note pooltype invocation:
  2153.      (web2c)pooltype invocation.)  `MFPOOL', `TEXMFINI'; suffix `.pool'.
  2154. `mft'
  2155.      (`MFT' style file, *note mft invocation: (web2c)mft invocation.)
  2156.      `MFTINPUTS'; suffix `.mft'.
  2157.      (MetaPost source, *note mpost invocation: (web2c)mpost invocation.)
  2158.      `MPINPUTS'; suffix `.mp'.
  2159. `mppool'
  2160.      (MetaPost program strings, *note pooltype invocation:
  2161.      (web2c)pooltype invocation.)  `MPPOOL', `TEXMFINI'; suffix `.pool'.
  2162. `ocp'
  2163.      (Omega compiled process files) `OCPINPUTS';
  2164.      suffix `.ocp'; dynamic creation program: `MakeOmegaOCP'.
  2165. `ofm'
  2166.      (Omega font metrics) `OFMFONTS', `TEXFONTS';
  2167.      suffixes `.ofm', `.tfm'; dynamic creation program: `MakeOmegaOFM'.
  2168. `opl'
  2169.      (Omega property lists) `OPLFONTS', `TEXFONTS'; suffix `.opl'.
  2170. `otp'
  2171.      (Omega translation process files) `OTPINPUTS'; suffix `.otp'.
  2172. `ovf'
  2173.      (Omega virtual fonts) `OVFFONTS', `TEXFONTS'; suffix `.ovf'.
  2174. `ovp'
  2175.      (Omega virtual property lists) `OVPFONTS', `TEXFONTS'; suffix
  2176.      `.ovp'.
  2177.      (packed bitmap fonts, *note Glyph files: (dvips)Glyph files.)
  2178.      `PROGRAMFONTS' (PROGRAM being `XDVI', etc.), `PKFONTS', `TEXPKS',
  2179.      `GLYPHFONTS', `TEXFONTS'; suffix `pk'; dynamic creation program:
  2180.      `mktexpk'.
  2181. `PostScript header'
  2182.      (downloadable PostScript, *note Header files: (dvips)Header files.)
  2183.      `TEXPSHEADERS', `PSHEADERS'; additional suffix `.pro'.
  2184. `tex'
  2185.      (TeX source, *note tex invocation: (web2c)tex invocation.)
  2186.      `TEXINPUTS'; suffix `.tex'; additional suffixes: none, because
  2187.      such a list cannot be complete; dynamic creation program:
  2188.      `mktextex'.
  2189. `TeX system documentation'
  2190.      (Documentation files for the TeX system) `TEXDOCS'.
  2191. `TeX system sources'
  2192.      (Source files for the TeX system) `TEXSOURCES'.
  2193. `texpool'
  2194.      (TeX program strings, *note pooltype invocation: (web2c)pooltype
  2195.      invocation.)  `TEXPOOL', `TEXMFINI'; suffix `.pool'.
  2196. `tfm'
  2197.      (TeX font metrics, *note Metric files: (dvips)Metric files.)
  2198.      `TFMFONTS', `TEXFONTS'; suffix `.tfm'; dynamic creation program:
  2199.      `mktextfm'.
  2200. `Troff fonts'
  2201.      (Troff fonts, used by DMP; *note DMP invocation: (web2c)DMP
  2202.      invocation.)  `TRFONTS'.
  2203. `truetype fonts'
  2204.      (TrueType outline fonts) `TTFONTS'; suffixes `.ttf', `.ttc'.
  2205. `type1 fonts'
  2206.      (Type 1 PostScript outline fonts, *note Glyph files: (dvips)Glyph
  2207.      files.)  `T1FONTS', `T1INPUTS', `TEXPSHEADERS', `DVIPSHEADERS';
  2208.      suffixes `.pfa', `.pfb'.
  2209. `type42 fonts'
  2210.      (Type 42 PostScript outline fonts) `T42FONTS'.
  2211.      (virtual fonts, *note Virtual fonts: (dvips)Virtual fonts.)
  2212.      `VFFONTS', `TEXFONTS'; suffix `.vf'.
  2213.   There are two special cases, because the paths and environment
  2214. variables always depend on the name of the program: the variable name is
  2215. constructed by converting the program name to upper case, and then
  2216. appending `INPUTS'.  Assuming the program is called `foo', this gives
  2217. us the following table.
  2218. `other text files'
  2219.      (text files used by `foo') `FOOINPUTS'.
  2220. `other binary files'
  2221.      (binary files used by `foo') `FOOINPUTS'.
  2222.   If an environment variable by these names are set, the corresponding
  2223. `texmf.cnf' definition won't be looked at (unless, as usual, the
  2224. environment variable value has an extra `:').  *Note Default
  2225. expansion::.
  2226.   For the font variables, the intent is that:
  2227.    * `TEXFONTS' is the default for everything.
  2228.    * `GLYPHFONTS' is the default for bitmap (or, more precisely,
  2229.      non-metric) files.
  2230.    * Each font format has a variable of its own.
  2231.    * Each program has its own font override path as well; e.g.,
  2232.      `DVIPSFONTS' for Dvipsk.  Again, this is for bitmaps, not metrics.
  2233. File: kpathsea.info,  Node: File lookup,  Next: Glyph lookup,  Prev: Supported file formats,  Up: TeX support
  2234. File lookup
  2235. ===========
  2236.   This section describes how Kpathsea searches for most files (bitmap
  2237. font searches are the exception, as described in the next section).
  2238.   Here is the search strategy for a file NAME:
  2239.   1. If the file format defines default suffixes, and the suffix of
  2240.      NAME name is not already a known suffix for that format, try the
  2241.      name with each default appended, and use alternative names found
  2242.      in the fontmaps if necessary.  We postpone searching the disk as
  2243.      long as possible.  Example: given `foo.sty', look for `foo.sty.tex'
  2244.      before `foo.sty'.  This is unfortunate, but allows us to find
  2245.      `foo.bar.tex' before `foo.bar' if both exist and we were given
  2246.      `foo.bar'.
  2247.   2. Search for NAME, and if necssary for alternative names found in
  2248.      the fontmaps.  Again we avoid searching the disk if possible.
  2249.      Example: given `foo', we look for `foo'.
  2250.   3. If the file format defines a program to invoke to create missing
  2251.      files, run it (*note mktex scripts::.).
  2252.   This is implemented in the routine `kpse_find_file' in
  2253. `kpathsea/tex-file.c'.  You can watch it in action with the debugging
  2254. options (*note Debugging::.).
  2255. File: kpathsea.info,  Node: Glyph lookup,  Next: Suppressing warnings,  Prev: File lookup,  Up: TeX support
  2256. Glyph lookup
  2257. ============
  2258.   This section describes how Kpathsea searches for a bitmap font in GF
  2259. or PK format (or either) given a font name (e.g., `cmr10') and a
  2260. resolution (e.g., 600).
  2261.   Here is an outline of the search strategy (details in the sections
  2262. below) for a file NAME at resolution DPI.  The search stops at the
  2263. first successful lookup.
  2264.   1. Look for an existing file NAME.DPIFORMAT in the specified
  2265.      format(s).
  2266.   2. If NAME is an alias for a file F in the fontmap file
  2267.      `texfonts.map', look for F.DPI.
  2268.   3. Run an external program (typically named `mktexpk') to generate
  2269.      the font (*note mktex scripts::.)
  2270.   4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font
  2271.      (typically `cmr10').
  2272.   This is implemented in `kpse_find_glyph_format' in
  2273. `kpathsea/tex-glyph.c'.
  2274. * Menu:
  2275. * Basic glyph lookup::          Features common to all glyph lookups.
  2276. * Fontmap::                     Aliases for fonts.
  2277. * Fallback font::               Resolutions and fonts of last resort.
  2278. File: kpathsea.info,  Node: Basic glyph lookup,  Next: Fontmap,  Up: Glyph lookup
  2279. Basic glyph lookup
  2280. ------------------
  2281.   When Kpathsea looks for a bitmap font NAME at resolution DPI in a
  2282. format FORMAT, it first checks each directory in the search path for a
  2283. file `NAME.DPIFORMAT'; for example, `cmr10.600pk'.  Kpathsea looks for
  2284. a PK file first, then a GF file.
  2285.   If that fails, Kpathsea looks for `dpiDPI/NAME.FORMAT'; for example,
  2286. `dpi600/cmr10.pk'. This is how fonts are typically stored on
  2287. filesystems (such as DOS) that permit only three-character extensions.
  2288.   If that fails, Kpathsea looks for a font with a close-enough DPI.
  2289. "Close enough" is defined by the macro `KPSE_BITMAP_TOLERANCE' in
  2290. `kpathsea/tex-glyph.h' to be `DPI / 500 + 1'.  This is slightly more
  2291. than the 0.2% minimum allowed by the DVI standard
  2292. (`CTAN:/dviware/driv-standard/level-0').
  2293. File: kpathsea.info,  Node: Fontmap,  Next: Fallback font,  Prev: Basic glyph lookup,  Up: Glyph lookup
  2294. Fontmap
  2295. -------
  2296.   If a bitmap font or metric file is not found with the original name
  2297. (see the previous section), Kpathsea looks through any "fontmap" files
  2298. for an "alias" for the original font name.  These files are named
  2299. `texfonts.map' and searched for along the `TEXFONTMAPS'
  2300. environment/config file variable.  All `texfonts.map' files that are
  2301. found are read; earlier definitions override later ones.
  2302.   This feature is intended to help in two respects:
  2303.   1. An alias name is limited in length only by available memory, not
  2304.      by your filesystem.  Therefore, if you want to ask for
  2305.      `Times-Roman' instead of `ptmr', you can (you get `ptmr8r').
  2306.   2. A few fonts have historically had multiple names: specifically,
  2307.      LaTeX's "circle font" has variously been known as `circle10',
  2308.      `lcircle10', and `lcirc10'.  Aliases can make all the names
  2309.      equivalent, so that it no longer matters what the name of the
  2310.      installed file is; TeX documents will find their favorite name.
  2311.   The format of fontmap files is straightforward:
  2312.    * Comments start with `%' and continue to the end of the line.
  2313.    * Blank lines are ignored.
  2314.    * Each nonblank line is broken up into a series of "words":   a
  2315.      sequence of non-whitespace characters.
  2316.    * If the first word is `include', the second word is used as   a
  2317.      filename, and it is searched for and read.
  2318.    * Otherwise, the first word on each line is the true filename;
  2319.    * the second word is the alias;
  2320.    * subsequent words are ignored.
  2321.   If an alias has an extension, it matches only those files with that
  2322. extension; otherwise, it matches anything with the same root, regardless
  2323. of extension.  For example, an alias `foo.tfm' matches only when
  2324. `foo.tfm' is being searched for; but an alias `foo' matches `foo.vf',
  2325. `foo.600pk', etc.
  2326.   As an example, here is an excerpt from the `texfonts.map' in the
  2327. Web2c distribution.  It makes the circle fonts equivalent and includes
  2328. automatically generated maps for most PostScript fonts available from
  2329. various font suppliers.
  2330.      circle10        lcircle10
  2331.      circle10        lcirc10
  2332.      lcircle10       circle10
  2333.      lcircle10       lcirc10
  2334.      lcirc10         circle10
  2335.      lcirc10         lcircle10
  2336.      ...
  2337.      include adobe.map
  2338.      include apple.map
  2339.      include bitstrea.map
  2340.      ...
  2341.   Fontmaps are implemented in the file `kpathsea/fontmap.c'.  The
  2342. Fontname distribution has much more information on font naming (*note
  2343. Introduction: (fontname)Introduction.).
  2344. File: kpathsea.info,  Node: Fallback font,  Prev: Fontmap,  Up: Glyph lookup
  2345. Fallback font
  2346. -------------
  2347.   If a bitmap font cannot be found or created at the requested size,
  2348. Kpathsea looks for the font at a set of "fallback resolutions".  You
  2349. specify these resolutions as a colon-separated list (like search paths).
  2350. Kpathsea looks first for a program-specific environment variable (e.g.,
  2351. `DVIPSSIZES' for Dvipsk), then the environment variable `TEXSIZES',
  2352. then a default specified at compilation time (the Make variable
  2353. `default_texsizes').  You can set this list to be empty if you prefer
  2354. to find fonts at their stated size or not at all.
  2355.   Finally, if the font cannot be found even at the fallback resolutions,
  2356. Kpathsea looks for a fallback font, typically `cmr10'.  Programs must
  2357. enable this feature by assigning to the global variable
  2358. `kpse_fallback_font' or calling `kpse_init_prog' (*note Calling
  2359. sequence::.); the default is no fallback font.
  2360. File: kpathsea.info,  Node: Suppressing warnings,  Prev: Glyph lookup,  Up: TeX support
  2361. Suppressing warnings
  2362. ====================
  2363.   Kpathsea provides a way to suppress selected usually-harmless
  2364. warnings; this is useful at large sites where most users are not
  2365. administrators, and thus the warnings are merely a source of confusion,
  2366. not a help.  To do this, you set the environment variable or
  2367. configuration file value `TEX_HUSH' to a colon-separated list of
  2368. values.  Here are the possibilities:
  2369. `all'
  2370.      Suppress everything possible.
  2371. `checksum'
  2372.      Suppress mismatched font checksum warnings.
  2373. `lostchar'
  2374.      Suppress warnings when a character is missing from a font that a
  2375.      DVI or VF file tries to typeset.
  2376. `readable'
  2377.      Suppress warnings about attempts to access a file whose permissions
  2378.      render it unreadable.
  2379. `special'
  2380.      Suppresses warnings about an unimplemented or unparsable
  2381.      `\special' command.
  2382. `tex-hush.c' defines the function that checks the variable value.  Each
  2383. driver implements its own checks where appropriate.
  2384. File: kpathsea.info,  Node: Programming,  Next: Index,  Prev: TeX support,  Up: Top
  2385. Programming
  2386. ***********
  2387.   This chapter is for programmers who wish to use Kpathsea.  *Note
  2388. Introduction::, for the conditions under which you may do so.
  2389. * Menu:
  2390. * Overview: Programming overview.         Introduction.
  2391. * Calling sequence::                      Specifics of what to call.
  2392. * Program-specific files::                How to handle these.
  2393. * Config: Programming with config files.  Getting info from texmf.cnf.
  2394. File: kpathsea.info,  Node: Programming overview,  Next: Calling sequence,  Up: Programming
  2395. Programming overview
  2396. ====================
  2397.   Aside from this manual, your best source of information is the source
  2398. to the programs I've modified to use Kpathsea (*note Introduction::.).
  2399. Of those, Dviljk is probably the simplest, and hence a good place to
  2400. start.  Xdvik adds VF support and the complication of X resources.
  2401. Dvipsk adds the complication of its own config files.  Web2c is source
  2402. code I also maintain, so it uses Kpathsea rather straightforwardly, but
  2403. is of course complicated by the Web to C translation.  Finally,
  2404. Kpsewhich is a small utility program whose sole purpose is to exercise
  2405. the main path-searching functionality.
  2406.   Beyond these examples, the `.h' files in the Kpathsea source describe
  2407. the interfaces and functionality (and of course the `.c' files define
  2408. the actual routines, which are the ultimate documentation).
  2409. `pathsearch.h' declares the basic searching routine.  `tex-file.h' and
  2410. `tex-glyph.h' define the interfaces for looking up particular kinds of
  2411. files.  You may wish to use `#include <kpathsea/kpathsea.h>', which
  2412. includes every Kpathsea header.
  2413.   The library provides no way for an external program to register new
  2414. file types: `tex-file.[ch]' must be modified to do this. For example,
  2415. Kpathsea has support for looking up Dvips config files, even though no
  2416. program other than Dvips will likely ever want to do so.  I felt this
  2417. was acceptable, since along with new file types should also come new
  2418. defaults in `texmf.cnf' (and its descendant `paths.h'), since it's
  2419. simplest for users if they can modify one configuration file for all
  2420. kinds of paths.
  2421.   Kpathsea does not parse any formats itself; it barely opens any files.
  2422. Its primary purpose is to return filenames.  The GNU font utilities does
  2423. contain libraries to read TFM, GF, and PK files, as do the programs
  2424. above, of course.
  2425. File: kpathsea.info,  Node: Calling sequence,  Next: Program-specific files,  Prev: Programming overview,  Up: Programming
  2426. Calling sequence
  2427. ================
  2428.   The typical way to use Kpathsea in your program goes something like
  2429. this:
  2430.   1. Call `kpse_set_program_name' with `argv[0]' as the first argument;
  2431.      the second argument is a string or `NULL'.  The second argument is
  2432.      used by Kpathsea as the program name for the `.PROGRAM' feature of
  2433.      config files (*note Config files::.).  If the second argument is
  2434.      `NULL', the value of the first argument is used.  This function
  2435.      must be called before any other use of the Kpathsea library.
  2436.      If necessary, `kpse_set_program_name' sets the global variables
  2437.      `program_invocation_name' and `program_invocation_short_name'.
  2438.      These variables are used in the error message macros defined in
  2439.      `kpathsea/lib.h'.  It sets the global variable `kpse_program_name'
  2440.      to the program name it uses.  It also initializes debugging
  2441.      options based on the environment variable `KPATHSEA_DEBUG' (if
  2442.      that is set).  Finally, it sets the variables `SELFAUTOLOC',
  2443.      `SELFAUTODIR' and `SELFAUTOPARENT' to the location, parent and
  2444.      grandparent directory of the executable, removing `.' and `..'
  2445.      path elements and resolving symbolic links.  These are used in the
  2446.      default configuration file to allow people to invoke TeX from
  2447.      anywhere, specifically from a mounted CD-ROM.  (You can use
  2448.      `--expand-var=\$SELFAUTOLOC', etc., to see the values finds.)
  2449.   2. The `kpse_set_progname' is deprecated.  A call to
  2450.      `kpse_set_progname' with `argv[0]' is equivalent to a call of
  2451.      `kpse_set_program_name' with first argument `argv[0]' and second
  2452.      argument `NULL'.  The function is deprecated because it cannot
  2453.      ensure that the `.PROGRAM' feature of config files will always
  2454.      work (*note Config files::.).
  2455.   3. Set debugging options. *Note Debugging::.  If your program doesn't
  2456.      have a debugging option already, you can define one and set
  2457.      `kpathsea_debug' to the number that the user supplies (as in Dviljk
  2458.      and Web2c), or you can just omit this altogether (people can
  2459.      always set `KPATHSEA_DEBUG').  If you do have runtime debugging
  2460.      already, you need to merge Kpathsea's options with yours (as in
  2461.      Dvipsk and Xdvik).
  2462.   4. If your program has its own configuration files that can define
  2463.      search paths, you should assign those paths to the `client_path'
  2464.      member in the appropriate element of the `kpse_format_info' array.
  2465.      (This array is indexed by file type; see `tex-file.h'.)  See
  2466.      `resident.c' in Dvipsk for an example.
  2467.   5. Call `kpse_init_prog' (see `proginit.c'). It's useful for the DVI
  2468.      drivers, at least, but for other programs it may be simpler to
  2469.      extract the parts of it that actually apply.  This does not
  2470.      initialize any paths, it just looks for (and sets) certain
  2471.      environment variables and other random information.  (A search
  2472.      path is always initialized at the first call to find a file of
  2473.      that type; this eliminates much useless work, e.g., initializing
  2474.      the BibTeX search paths in a DVI driver.)
  2475.   6. The routine to actually find a file of type FORMAT is
  2476.      `kpse_find_FORMAT', defined in `tex-file.h'. These are macros that
  2477.      expand to a call to `kpse_find_file'.  You can call, say,
  2478.      `kpse_find_tfm' after doing only the first of the initialization
  2479.      steps above--Kpathsea automatically reads the `texmf.cnf' generic
  2480.      config files, looks for environment variables, and does expansions
  2481.      at the first lookup.
  2482.   7. To find PK and/or GF bitmap fonts, the routines are `kpse_find_pk',
  2483.      `kpse_find_gf' and `kpse_find_glyph', defined in `tex-glyph.h'.
  2484.      These return a structure in addition to the resultant filename,
  2485.      because fonts can be found in so many ways. See the documentation
  2486.      in the source.
  2487.   8. To actually open a file, not just return a filename, call
  2488.      `kpse_open_file'.  This function takes the name to look up and a
  2489.      Kpathsea file format as arguments, and returns the usual `FILE *'.
  2490.      It always assumes the file must exist, and thus will search the
  2491.      disk if necessary (unless the search path specified `!!', etc.).
  2492.      In other words, if you are looking up a VF or some other file that
  2493.      need not exist, don't use this.
  2494.   Kpathsea also provides many utility routines. Some are generic: hash
  2495. tables, memory allocation, string concatenation and copying, string
  2496. lists, reading input lines of arbitrary length, etc. Others are
  2497. filename-related: default path, tilde, and variable expansion, `stat'
  2498. calls, etc. (Perhaps someday I'll move the former to a separate
  2499. library.)
  2500.   The `c-*.h' header files can also help your program adapt to many
  2501. different systems.  You will almost certainly want to use Autoconf for
  2502. configuring your software if you use Kpathsea; I strongly recommend
  2503. using Autoconf regardless.  It is available from
  2504. `ftp://prep.ai.mit.edu/pub/gnu/'.
  2505. File: kpathsea.info,  Node: Program-specific files,  Next: Programming with config files,  Prev: Calling sequence,  Up: Programming
  2506. Program-specific files
  2507. ======================
  2508.   Many programs will need to find some configuration files.  Kpathsea
  2509. contains some support to make it easy to place them in their own
  2510. directories.  The Standard TeX directory structure (*note Introduction:
  2511. (tds)Top.), specifies that such files should go into a subdirectory
  2512. named after the program, like `texmf/ttf2pk'.
  2513.   Two special formats, `kpse_program_text_format' and
  2514. `kpse_program_binary_format' exist, which use `.:$TEXMF/PROGRAM//' as
  2515. their compiled-in search path.  To override this default, you can use
  2516. the variable `PROGRAMINPUTS' in the environment and/or `texmf.cnf'.
  2517. That is to say, the name of the variable is constructed by converting
  2518. the name of the program to upper case, and appending `INPUTS'.
  2519.   The only difference between these two formats is whether
  2520. `kpse_open_file' will open the files it finds in text or binary mode.
  2521. File: kpathsea.info,  Node: Programming with config files,  Prev: Program-specific files,  Up: Programming
  2522. Programming with config files
  2523. =============================
  2524.   You can (and probably should) use the same `texmf.cnf' configuration
  2525. file that Kpathsea uses for your program.  This helps installers by
  2526. keeping all configuration in one place.
  2527.   To retrieve a value VAR from config files, the best way is to call
  2528. `kpse_var_value' on the string `VAR'.  This will look first for an
  2529. environment variable VAR, then a config file value.  The result will be
  2530. the value found or `NULL'.  This function is declared in
  2531. `kpathsea/variable.h'.  For an example, see the `shell_escape' code in
  2532. `web2c/lib/texmfmp.c'.
  2533.   The routine to do variable expansion in the context of a search path
  2534. (as opposed to simply retrieving a value) is `kpse_var_expand', also
  2535. declared in `kpathsea/variable.h'.  It's generally only necessary to
  2536. set the search path structure components as explained in the previous
  2537. section, rather than using this yourself.
  2538.   If for some reason you want to retrieve a value *only* from a config
  2539. file, not automatically looking for a corresponding environment
  2540. variable, call `kpse_cnf_get' (declared in `kpathsea/cnf.h') with the
  2541. string VAR.
  2542.   No initialization calls are needed.
  2543. File: kpathsea.info,  Node: Index,  Prev: Programming,  Up: Top
  2544. Index
  2545. *****
  2546. * Menu:
  2547. * !! in path specifications:             ls-R.
  2548. * $ expansion:                           Variable expansion.
  2549. * --color=tty:                           ls-R.
  2550. * --debug=NUM:                           Auxiliary tasks.
  2551. * --disable-static:                      configure options.
  2552. * --dpi=NUM:                             Path searching options.
  2553. * --enable options:                      configure options.
  2554. * --enable-maintainer-mode:              configure options.
  2555. * --enable-shared <1>:                   Shared library.
  2556. * --enable-shared:                       configure options.
  2557. * --expand-braces=STRING:                Auxiliary tasks.
  2558. * --expand-path=STRING:                  Auxiliary tasks.
  2559. * --expand-var=STRING:                   Auxiliary tasks.
  2560. * --format=NAME:                         Path searching options.
  2561. * --help:                                Standard options.
  2562. * --interactive:                         Path searching options.
  2563. * --mode=STRING:                         Path searching options.
  2564. * --must-exist:                          Path searching options.
  2565. * --path=STRING:                         Path searching options.
  2566. * --progname=NAME:                       Path searching options.
  2567. * --show-path=NAME:                      Auxiliary tasks.
  2568. * --srcdir, for building multiple architectures: configure scenarios.
  2569. * --version:                             Standard options.
  2570. * --with options:                        configure options.
  2571. * --with-mktextex-default:               mktex configuration.
  2572. * --without-mktexmf-default:             mktex configuration.
  2573. * --without-mktexpk-default:             mktex configuration.
  2574. * --without-mktextfm-default:            mktex configuration.
  2575. * -1 debugging value:                    Debugging.
  2576. * -A option to ls:                       ls-R.
  2577. * -Bdynamic:                             ShellWidgetClass.
  2578. * -Bstatic:                              ShellWidgetClass.
  2579. * -D NUM:                                Path searching options.
  2580. * -dynamic:                              ShellWidgetClass.
  2581. * -g, compiling without:                 configure scenarios.
  2582. * -L option to ls:                       ls-R.
  2583. * -mktex=FILETYPE:                       Path searching options.
  2584. * -no-mktex=FILETYPE:                    Path searching options.
  2585. * -O, compiling with:                    configure scenarios.
  2586. * -static:                               ShellWidgetClass.
  2587. * . directories, ignored:                ls-R.
  2588. * . files:                               ls-R.
  2589. * .2602gf:                               Unable to generate fonts.
  2590. * .afm:                                  Supported file formats.
  2591. * .base:                                 Supported file formats.
  2592. * .bib:                                  Supported file formats.
  2593. * .bst:                                  Supported file formats.
  2594. * .cnf:                                  Supported file formats.
  2595. * .eps:                                  Supported file formats.
  2596. * .epsi:                                 Supported file formats.
  2597. * .fmt:                                  Supported file formats.
  2598. * .ist:                                  Supported file formats.
  2599. * .map:                                  Supported file formats.
  2600. * .mem:                                  Supported file formats.
  2601. * .mf:                                   Supported file formats.
  2602. * .mft:                                  Supported file formats.
  2603. * .mp:                                   Supported file formats.
  2604. * .ocp:                                  Supported file formats.
  2605. * .ofm:                                  Supported file formats.
  2606. * .opl:                                  Supported file formats.
  2607. * .otp:                                  Supported file formats.
  2608. * .ovf:                                  Supported file formats.
  2609. * .ovp:                                  Supported file formats.
  2610. * .pfa:                                  Supported file formats.
  2611. * .pfb:                                  Supported file formats.
  2612. * .pk:                                   Supported file formats.
  2613. * .pool:                                 Supported file formats.
  2614. * .pro:                                  Supported file formats.
  2615. * .rhosts, writable by TeX:              Security.
  2616. * .tex:                                  Supported file formats.
  2617. * .tex file, included in ls-R:           ls-R.
  2618. * .tfm:                                  Supported file formats.
  2619. * .ttc:                                  Supported file formats.
  2620. * .ttf:                                  Supported file formats.
  2621. * .vf:                                   Supported file formats.
  2622. * / may not be /:                        Searching overview.
  2623. * /, trailing in home directory:         Tilde expansion.
  2624. * //:                                    Subdirectory expansion.
  2625. * /afs/... , installing into:            Installing files.
  2626. * /etc/profile:                          Unable to find files.
  2627. * /etc/profile and aliases:              ls-R.
  2628. * /var/tmp/texfonts:                     mktex configuration.
  2629. * 2602gf:                                Unable to generate fonts.
  2630. * 4allTeX Live CD-ROM:                   CD-ROM distribution.
  2631. * 8.3 filenames, using:                  mktex configuration.
  2632. * : may not be ::                        Searching overview.
  2633. * :: expansion:                          Default expansion.
  2634. * @VAR@ substitutions:                   Running configure.
  2635. * \, line continuation in texmf.cnf:     Config files.
  2636. * \openin:                               Searching overview.
  2637. * \special, suppressing warnings about:  Suppressing warnings.
  2638. * absolute filenames:                    Searching overview.
  2639. * ac_include, Autoconf extension:        Running configure.
  2640. * access warnings:                       Searching overview.
  2641. * Acorn TeX implementations:             Other TeX packages.
  2642. * AFMFONTS:                              Supported file formats.
  2643. * AFS:                                   Installing files.
  2644. * AIX 4.1 configure error:               Empty Makefiles.
  2645. * AIX shells and configure:              configure shells.
  2646. * aliases for fonts:                     Fontmap.
  2647. * aliases, for filenames:                Filename aliases.
  2648. * all:                                   Suppressing warnings.
  2649. * alphabetical order, not:               Subdirectory expansion.
  2650. * Amiga support:                         Custom installation.
  2651. * Amiga TeX implementations:             Other TeX packages.
  2652. * Andrew File System, installing with:   Installing files.
  2653. * announcement mailing list:             Mailing lists.
  2654. * ANSI C:                                TeX or Metafont failing.
  2655. * append-only directories and mktexpk:   Security.
  2656. * appendonlydir:                         mktex configuration.
  2657. * architecture-(in)dependent files, installing only: Installing files.
  2658. * architectures, compiling multiple:     configure scenarios.
  2659. * arguments to mktex:                    mktex script arguments.
  2660. * argv[0]:                               Calling sequence.
  2661. * ash, losing with configure:            configure shells.
  2662. * autoconf, recommended:                 Calling sequence.
  2663. * automounter, and configuration:        configure scenarios.
  2664. * automounter, and ls-R:                 ls-R.
  2665. * auxiliary tasks:                       Auxiliary tasks.
  2666. * Babel <1>:                             Running make.
  2667. * Babel:                                 Kpathsea application distributions.
  2668. * Bach, Johann Sebastian:                Default expansion.
  2669. * backbone of CTAN:                      Electronic distribution.
  2670. * backslash-newline:                     Config files.
  2671. * bash, recommended for running configure: configure shells.
  2672. * basic glyph lookup:                    Basic glyph lookup.
  2673. * Berry, Karl:                           History.
  2674. * BIBINPUTS:                             Supported file formats.
  2675. * binary mode, for file transfers:       Electronic distribution.
  2676. * blank lines, in texmf.cnf:             Config files.
  2677. * brace expansion:                       Brace expansion.
  2678. * BSD universe:                          Running make.
  2679. * bsh, ok with configure:                configure shells.
  2680. * BSTINPUTS:                             Supported file formats.
  2681. * bug address:                           Reporting bugs.
  2682. * bug checklist:                         Bug checklist.
  2683. * bug mailing list:                      Mailing lists.
  2684. * bugs, reporting:                       Reporting bugs.
  2685. * c-*.h:                                 Calling sequence.
  2686. * c-auto.in:                             Running configure.
  2687. * cache of fonts, local:                 Security.
  2688. * calling sequence:                      Calling sequence.
  2689. * CC:                                    configure environment.
  2690. * cc warnings:                           Pointer combination warnings.
  2691. * cc, compiling with:                    configure environment.
  2692. * CD-ROM distributions:                  CD-ROM distribution.
  2693. * CFLAGS:                                configure environment.
  2694. * ChangeLog entry:                       Bug checklist.
  2695. * checklist for bug reports:             Bug checklist.
  2696. * checksum:                              Suppressing warnings.
  2697. * circle fonts:                          Fontmap.
  2698. * clean Make target:                     Cleaning up.
  2699. * client_path in kpse_format_info:       Calling sequence.
  2700. * cmr10, as fallback font:               Fallback font.
  2701. * cmr10.vf:                              Searching overview.
  2702. * cnf.c:                                 Config files.
  2703. * cnf.h:                                 Programming with config files.
  2704. * code sharing:                          Shared library.
  2705. * color printers, configuring:           Simple installation.
  2706. * comments, in fontmap files:            Fontmap.
  2707. * comments, in texmf.cnf:                Config files.
  2708. * comments, making:                      Introduction.
  2709. * common features in glyph lookup:       Basic glyph lookup.
  2710. * common problems:                       Common problems.
  2711. * comp.sys.sun.admin FAQ:                ShellWidgetClass.
  2712. * comp.text.tex:                         Mailing lists.
  2713. * compilation:                           Installation.
  2714. * compilation value, source for path:    Path sources.
  2715. * compiler bugs:                         TeX or Metafont failing.
  2716. * compiler bugs, finding:                TeX or Metafont failing.
  2717. * compiler options, additional:          Running make.
  2718. * compiler options, specifying:          configure environment.
  2719. * compiler, changing:                    Running make.
  2720. * compiling on HP-UX:                    TeX or Metafont failing.
  2721. * conditions for use:                    Introduction.
  2722. * config files:                          Config files.
  2723. * config files, for Kpathsea-using programs: Calling sequence.
  2724. * config files, programming with:        Programming with config files.
  2725. * config.log:                            Bug checklist.
  2726. * config.ps, search path for:            Supported file formats.
  2727. * config.status:                         Bug checklist.
  2728. * configuration:                         Installation.
  2729. * configuration bugs:                    Bug checklist.
  2730. * configuration compiler options:        configure environment.
  2731. * configuration file, source for path:   Path sources.
  2732. * configuration files as shell scripts.: Config files.
  2733. * configuration of mktex scripts:        mktex configuration.
  2734. * configuration of optional features:    configure options.
  2735. * configure error from sed:              Empty Makefiles.
  2736. * configure options:                     configure options.
  2737. * configure options for mktex scripts:   mktex configuration.
  2738. * configure, running:                    Running configure.
  2739. * context diff:                          Bug checklist.
  2740. * continuation character:                Config files.
  2741. * core dumps, reporting:                 Bug checklist.
  2742. * CPPFLAGS:                              configure environment.
  2743. * crashes, reporting:                    Bug checklist.
  2744. * CTAN, defined:                         Electronic distribution.
  2745. * CTAN.sites:                            Electronic distribution.
  2746. * custom installation:                   Custom installation.
  2747. * Dante TeX CD-ROM:                      CD-ROM distribution.
  2748. * database search:                       Searching overview.
  2749. * database, for filenames:               Filename database.
  2750. * database, format of:                   Database format.
  2751. * debug.h:                               Debugging.
  2752. * debugger:                              Bug checklist.
  2753. * debugging:                             Debugging.
  2754. * debugging options, in Kpathsea-using program: Calling sequence.
  2755. * debugging output:                      Debugging.
  2756. * debugging with -g, disabling:          configure scenarios.
  2757. * DEC shells and configure:              configure shells.
  2758. * default expansion:                     Default expansion.
  2759. * default path features:                 Default path features.
  2760. * default paths, changing:               Default path generation.
  2761. * default paths, how they're made:       Default path generation.
  2762. * default_texsizes:                      Fallback font.
  2763. * DEFS:                                  configure environment.
  2764. * depot:                                 configure scenarios.
  2765. * directories, changing default installation: Default path generation.
  2766. * directories, making append-only:       mktex configuration.
  2767. * directory permissions:                 Security.
  2768. * directory structure, for TeX files:    TeX directory structure.
  2769. * disabling mktex scripts:               mktex configuration.
  2770. * disk search:                           Searching overview.
  2771. * disk searching, avoiding:              ls-R.
  2772. * disk space, needed:                    Disk space.
  2773. * disk usage, reducing:                  Logging.
  2774. * distclean Make target:                 Cleaning up.
  2775. * distributions, compiling simultaneously: Kpathsea application distributions.
  2776. * distributions, not compiling:          Kpathsea application distributions.
  2777. * distributions, on CD-ROM:              CD-ROM distribution.
  2778. * distributions, on tape:                Tape distribution.
  2779. * distributions, via ftp:                Electronic distribution.
  2780. * dlclose:                               dlopen.
  2781. * dlopen:                                dlopen.
  2782. * dlsym:                                 dlopen.
  2783. * dlsym.c:                               dlopen.
  2784. * doc files:                             Supported file formats.
  2785. * DOS compatible names:                  mktex configuration.
  2786. * DOS support:                           Custom installation.
  2787. * DOS TeX implementations:               Other TeX packages.
  2788. * dosnames:                              mktex configuration.
  2789. * dot files:                             ls-R.
  2790. * doubled colons:                        Default expansion.
  2791. * dpiNNN directories:                    mktex configuration.
  2792. * DVI drivers:                           Kpathsea application distributions.
  2793. * DVILJMAKEPK:                           mktex script names.
  2794. * DVILJSIZES:                            Fallback font.
  2795. * DVIPSFONTS:                            Supported file formats.
  2796. * DVIPSHEADERS:                          Supported file formats.
  2797. * DVIPSMAKEPK:                           mktex script names.
  2798. * DVIPSSIZES:                            Fallback font.
  2799. * dynamic creation of files:             mktex scripts.
  2800. * dynamic linking problems with OpenWin libraries: ShellWidgetClass.
  2801. * EC fonts, and dynamic source creation: mktex scripts.
  2802. * elt-dirs.c:                            Subdirectory expansion.
  2803. * email CTAN access:                     Electronic distribution.
  2804. * enabling mktex scripts:                mktex configuration.
  2805. * environment variable, source for path: Path sources.
  2806. * environment variables for TeX:         Supported file formats.
  2807. * environment variables in paths:        Variable expansion.
  2808. * environment variables, old:            Unable to find files.
  2809. * epoch, seconds since:                  Logging.
  2810. * error message macros:                  Calling sequence.
  2811. * excessive startup time:                Slow path searching.
  2812. * expand.c:                              Brace expansion.
  2813. * expanding symlinks:                    Calling sequence.
  2814. * expansion, default:                    Default expansion.
  2815. * expansion, path element:               Searching overview.
  2816. * expansion, search path:                Path expansion.
  2817. * expansion, subdirectory:               Subdirectory expansion.
  2818. * expansion, tilde:                      Tilde expansion.
  2819. * expansion, variable:                   Variable expansion.
  2820. * explicitly relative filenames:         Searching overview.
  2821. * externally-built filename database:    Filename database.
  2822. * extra colons:                          Default expansion.
  2823. * extraclean Make target:                Cleaning up.
  2824. * failed mktex... script invocation:     mktex script names.
  2825. * fallback font:                         Fallback font.
  2826. * fallback resolutions:                  Fallback font.
  2827. * fallback resolutions, overriding:      Running make.
  2828. * FAQ, comp.sys.sun.admin:               ShellWidgetClass.
  2829. * FAQ, Kpathsea:                         Common problems.
  2830. * Farwell, Matthew:                      Subdirectory expansion.
  2831. * features, of default paths:            Default path features.
  2832. * file formats, supported:               Supported file formats.
  2833. * file lookup:                           File lookup.
  2834. * file permissions:                      Security.
  2835. * file types, registering new:           Programming overview.
  2836. * filename aliases:                      Filename aliases.
  2837. * filename database:                     Filename database.
  2838. * filename database generation:          Filename database generation.
  2839. * filenames, absolute or explicitly relative: Searching overview.
  2840. * files, unable to find:                 Unable to find files.
  2841. * filesystem search:                     Searching overview.
  2842. * floating directories:                  Searching overview.
  2843. * font alias files:                      Fontmap.
  2844. * font generation failures:              Unable to generate fonts.
  2845. * font of last resort:                   Fallback font.
  2846. * font set, infinite:                    mktex scripts.
  2847. * fontmap files:                         Fontmap.
  2848. * fontmaps:                              mktex configuration.
  2849. * fontname:                              mktex configuration.
  2850. * fontnames, arbitrary length:           Fontmap.
  2851. * fonts, being created:                  Simple installation.
  2852. * FOOINPUTS:                             Supported file formats.
  2853. * fopen, redefined:                      Debugging.
  2854. * format of external database:           Database format.
  2855. * Free Software Foundation:              CD-ROM distribution.
  2856. * FreeBSD configure error:               Empty Makefiles.
  2857. * FreeBSD shells and configure:          configure shells.
  2858. * FSF Source Code CD-ROM:                CD-ROM distribution.
  2859. * ftp retrieval:                         Electronic distribution.
  2860. * ftp.tug.org:                           unixtex.ftp.
  2861. * fundamental purpose of Kpathsea:       Introduction.
  2862. * gcc, compiling with:                   configure environment.
  2863. * gdb, recommended:                      Bug checklist.
  2864. * generation of filename database:       Filename database generation.
  2865. * German TeX CD info:                    CD-ROM distribution.
  2866. * get_applicationShellWidgetClass:       ShellWidgetClass.
  2867. * get_wmShellWidgetClass:                ShellWidgetClass.
  2868. * gf:                                    Supported file formats.
  2869. * GFFONTS:                               Supported file formats.
  2870. * globally writable directories:         Security.
  2871. * glyph lookup:                          Glyph lookup.
  2872. * glyph lookup bitmap tolerance:         Basic glyph lookup.
  2873. * GLYPHFONTS:                            Supported file formats.
  2874. * GNU C compiler bugs:                   TeX or Metafont failing.
  2875. * GNU General Public License:            Introduction.
  2876. * Gopher CTAN access:                    Electronic distribution.
  2877. * group-writable directories:            Security.
  2878. * GSFTOPK_DEBUG (128):                   Debugging.
  2879. * GUTenberg:                             CD-ROM distribution.
  2880. * hash table buckets, printing:          Debugging.
  2881. * hash table routines:                   Calling sequence.
  2882. * hash_summary_only variable for debugging: Debugging.
  2883. * help, mailing list for general TeX:    Mailing lists.
  2884. * HIER:                                  Default path features.
  2885. * history of Kpathsea:                   History.
  2886. * home directories in paths:             Tilde expansion.
  2887. * HOME, as ~ expansion:                  Tilde expansion.
  2888. * HP-UX, compiling on:                   TeX or Metafont failing.
  2889. * identifiers, characters valid in:      Config files.
  2890. * illegal pointer combination warnings:  Pointer combination warnings.
  2891. * include fontmap directive:             Fontmap.
  2892. * INDEXSTYLE:                            Supported file formats.
  2893. * info-tex@shsu.edu:                     Mailing lists.
  2894. * input lines, reading:                  Calling sequence.
  2895. * install-data Make target:              Installing files.
  2896. * install-exec Make target:              Installing files.
  2897. * installation:                          Installation.
  2898. * installation testing:                  Installation testing.
  2899. * installation, architecture-(in)dependent files only: Installing files.
  2900. * installation, changing default directories: Default path generation.
  2901. * installation, customized:              Custom installation.
  2902. * installation, getting executables instead of: Simple installation.
  2903. * installation, simple:                  Simple installation.
  2904. * installing files:                      Installing files.
  2905. * interactive query:                     Path searching options.
  2906. * interface, not frozen:                 Introduction.
  2907. * introduction:                          Introduction.
  2908. * kdebug::                               Debugging.
  2909. * kdefault.c:                            Default expansion.
  2910. * Knuth, Donald E.:                      History.
  2911. * Knuth, Donald E., archive of programs by: Other TeX packages.
  2912. * Knuth, Donald E., original author:     Electronic distribution.
  2913. * Korn shell, losing with configure:     configure shells.
  2914. * Kpathsea config file, source for path: Path sources.
  2915. * Kpathsea version number:               Kpathsea application distributions.
  2916. * kpathsea.h:                            Programming overview.
  2917. * kpathsea/HIER:                         Default path features.
  2918. * kpathsea/README.CONFIGURE:             Running configure.
  2919. * KPATHSEA_DEBUG:                        Calling sequence.
  2920. * kpathsea_debug:                        Debugging.
  2921. * KPATHSEA_DEBUG:                        Debugging.
  2922. * kpathsea_debug:                        Debugging.
  2923. * kpathsea_debug variable:               Calling sequence.
  2924. * KPSE_BITMAP_TOLERANCE:                 Basic glyph lookup.
  2925. * kpse_cnf_get:                          Programming with config files.
  2926. * KPSE_DEBUG_EXPAND (16):                Debugging.
  2927. * KPSE_DEBUG_FOPEN (4):                  Debugging.
  2928. * KPSE_DEBUG_HASH (2):                   Debugging.
  2929. * KPSE_DEBUG_PATHS (8):                  Debugging.
  2930. * KPSE_DEBUG_SEARCH (32):                Debugging.
  2931. * KPSE_DEBUG_STAT (1):                   Debugging.
  2932. * KPSE_DEBUG_VARS (64):                  Debugging.
  2933. * KPSE_DOT expansion:                    KPSE_DOT expansion.
  2934. * kpse_fallback_font:                    Fallback font.
  2935. * kpse_find_*:                           Calling sequence.
  2936. * kpse_find_file <1>:                    Calling sequence.
  2937. * kpse_find_file:                        File lookup.
  2938. * kpse_find_glyph_format:                Glyph lookup.
  2939. * kpse_format_info:                      Calling sequence.
  2940. * kpse_format_info_type:                 Debugging.
  2941. * kpse_init_prog:                        Calling sequence.
  2942. * kpse_init_prog, and MAKETEX_MODE:      Default path features.
  2943. * kpse_make_specs:                       mktex script names.
  2944. * kpse_open_file:                        Calling sequence.
  2945. * kpse_program_name:                     Calling sequence.
  2946. * kpse_set_progname:                     Calling sequence.
  2947. * kpse_set_program_name:                 Calling sequence.
  2948. * kpse_var_value:                        Programming with config files.
  2949. * kpsewhich:                             Invoking kpsewhich.
  2950. * Kpsewhich, and debugging:              Debugging.
  2951. * ksh, losing with configure:            configure shells.
  2952. * labrea.stanford.edu:                   Other TeX packages.
  2953. * LaserJet drive:                        Kpathsea application distributions.
  2954. * last-resort font:                      Fallback font.
  2955. * LaTeX help mailing list:               Mailing lists.
  2956. * lcircle10:                             Fontmap.
  2957. * LDFLAGS:                               configure environment.
  2958. * leading colons:                        Default expansion.
  2959. * leaf directories wrongly guessed:      Unable to find files.
  2960. * leaf directory trick:                  Subdirectory expansion.
  2961. * libdl.a:                               dlopen.
  2962. * libraries, changing:                   Running make.
  2963. * libraries, specifying additional:      configure environment.
  2964. * LIBS:                                  configure environment.
  2965. * libucb, avoiding:                      Running make.
  2966. * license for using the library:         Introduction.
  2967. * lines, reading arbitrary-length:       Calling sequence.
  2968. * Linux File System Standard:            mktex configuration.
  2969. * Linux shells and configure:            configure shells.
  2970. * Linux, using Web2c:                    CD-ROM distribution.
  2971. * lndir for building symlink trees:      configure scenarios.
  2972. * loader options:                        configure environment.
  2973. * loader options, final:                 Running make.
  2974. * loader options, initial:               Running make.
  2975. * local cache of fonts:                  Security.
  2976. * log file:                              Logging.
  2977. * logging successful searches:           Logging.
  2978. * lost+found directory:                  Searching overview.
  2979. * lostchar:                              Suppressing warnings.
  2980. * ls-R:                                  Supported file formats.
  2981. * ls-R and AFS:                          Installing files.
  2982. * ls-R database file:                    ls-R.
  2983. * ls-R, simplest build:                  ls-R.
  2984. * Mach10 configure error:                Empty Makefiles.
  2985. * Macintosh TeX implementations:         Other TeX packages.
  2986. * MacKenzie, David <1>:                  Subdirectory expansion.
  2987. * MacKenzie, David:                      History.
  2988. * magic characters:                      Searching overview.
  2989. * mailing lists:                         Mailing lists.
  2990. * maintainer-clean Make target:          Cleaning up.
  2991. * Make arguments, additional:            Running make.
  2992. * make, running:                         Running make.
  2993. * Makefile.in:                           Running configure.
  2994. * Makefiles, empty:                      Empty Makefiles.
  2995. * MAKETEX_DEBUG (512):                   Debugging.
  2996. * MAKETEX_FINE_DEBUG (1024):             Debugging.
  2997. * MAKETEX_MODE:                          Default path features.
  2998. * memory allocation routines:            Calling sequence.
  2999. * Metafont failures:                     TeX or Metafont failing.
  3000. * Metafont installation:                 Unable to generate fonts.
  3001. * Metafont making too-large fonts:       Unable to generate fonts.
  3002. * Metafont using the wrong resolution:   Unable to generate fonts.
  3003. * MFBASES:                               Supported file formats.
  3004. * MFINPUTS:                              Supported file formats.
  3005. * MFPOOL:                                Supported file formats.
  3006. * MFTINPUTS:                             Supported file formats.
  3007. * mirrors, FTP:                          Electronic distribution.
  3008. * mismatched checksum warnings:          Suppressing warnings.
  3009. * missfont.log:                          mktex script names.
  3010. * MISSFONT_LOG:                          mktex script names.
  3011. * missing character warnings:            Suppressing warnings.
  3012. * mktex script configuration:            mktex configuration.
  3013. * mktex script names:                    mktex script names.
  3014. * mktex scripts:                         mktex scripts.
  3015. * mktex.cnf:                             mktex configuration.
  3016. * mktex.opt:                             mktex configuration.
  3017. * mktexdir:                              mktex configuration.
  3018. * mktexmf:                               mktex script names.
  3019. * mktexpk:                               mktex script names.
  3020. * mktexpk , initial runs:                Simple installation.
  3021. * mktextex:                              mktex script names.
  3022. * mktextfm:                              mktex script names.
  3023. * mode directory, omitting:              mktex configuration.
  3024. * Morgan, Tim:                           History.
  3025. * mostlyclean Make target:               Cleaning up.
  3026. * MPINPUTS:                              Supported file formats.
  3027. * MPMEMS:                                Supported file formats.
  3028. * MPPOOL:                                Supported file formats.
  3029. * MPSUPPORT:                             Supported file formats.
  3030. * MT_FEATURES:                           mktex configuration.
  3031. * multiple architectures, compiling on:  configure scenarios.
  3032. * multiple architectures, directories for: configure scenarios.
  3033. * multiple architectures, installing on: Installing files.
  3034. * multiple TeX hierarchies:              Brace expansion.
  3035. * must exist:                            Searching overview.
  3036. * names for mktex scripts:               mktex script names.
  3037. * NetBSD configure error:                Empty Makefiles.
  3038. * NetBSD shells and configure:           configure shells.
  3039. * Neumann, Gustaf:                       History.
  3040. * newsgroup for TeX:                     Mailing lists.
  3041. * NeXT sed error:                        Empty Makefiles.
  3042. * NeXT, lacking X11:                     Kpathsea application distributions.
  3043. * NFS and ls-R:                          ls-R.
  3044. * NFS CTAN access:                       Electronic distribution.
  3045. * nomode:                                mktex configuration.
  3046. * non-English typesetting:               Kpathsea application distributions.
  3047. * non-Unix operating systems:            Custom installation.
  3048. * Northwest Computing Support Center:    Tape distribution.
  3049. * NTG:                                   CD-ROM distribution.
  3050. * null pointers, dereferencing:          Bug checklist.
  3051. * numeric debugging values:              Debugging.
  3052. * obtaining TeX:                         unixtex.ftp.
  3053. * obtaining TeX on tape:                 Tape distribution.
  3054. * obtaining Web2c by ftp:                Electronic distribution.
  3055. * obtaining Web2c on CD-ROM:             CD-ROM distribution.
  3056. * OCPINPUTS:                             Supported file formats.
  3057. * OFMFONTS:                              Supported file formats.
  3058. * online Metafont display, spurious:     Unable to generate fonts.
  3059. * OpenWin libraries, dynamic linking problems: ShellWidgetClass.
  3060. * optimization caveat:                   TeX or Metafont failing.
  3061. * optimization, enabling:                configure scenarios.
  3062. * options for debugging:                 Debugging.
  3063. * options to configure:                  configure options.
  3064. * OS/2 support:                          Custom installation.
  3065. * other TeX distributions:               Other TeX packages.
  3066. * OTPINPUTS:                             Supported file formats.
  3067. * overview of path searching:            Searching overview.
  3068. * overview of programming with Kpathsea: Programming overview.
  3069. * OVFFONTS:                              Supported file formats.
  3070. * OVPFONTS:                              Supported file formats.
  3071. * patches, Sun OpenWin:                  ShellWidgetClass.
  3072. * path expansion:                        Path expansion.
  3073. * path searching:                        Path searching.
  3074. * path searching options:                Path searching options.
  3075. * path searching, overview:              Searching overview.
  3076. * path searching, standalone:            Invoking kpsewhich.
  3077. * path sources:                          Path sources.
  3078. * paths, changing default <1>:           Default path generation.
  3079. * paths, changing default:               Changing search paths.
  3080. * paths, device name included in:        Default path features.
  3081. * paths.h:                               Default path generation.
  3082. * paths.h, creating:                     Running make.
  3083. * pathsearch.h:                          Programming overview.
  3084. * pc Pascal compiler:                    History.
  3085. * PCL driver:                            Kpathsea application distributions.
  3086. * PDF generation:                        Kpathsea application distributions.
  3087. * permission denied:                     Searching overview.
  3088. * permissions, directory:                Security.
  3089. * permissions, file:                     Security.
  3090. * PKFONTS:                               Supported file formats.
  3091. * plain.base:                            Unable to generate fonts.
  3092. * pointer combination warnings:          Pointer combination warnings.
  3093. * PostScript driver:                     Kpathsea application distributions.
  3094. * PostScript fonts, additional:          Simple installation.
  3095. * precompiled executables, instead of installation: Simple installation.
  3096. * precompiled Unix binaries:             Other TeX packages.
  3097. * preprocessor options:                  configure environment.
  3098. * preprocessor options, additional:      Running make.
  3099. * Prime Time TeXcetera CD-ROM:           CD-ROM distribution.
  3100. * printer configuration files:           Simple installation.
  3101. * privacy, semblance of:                 Logging.
  3102. * problems, common:                      Common problems.
  3103. * proginit.c:                            Default path features.
  3104. * proginit.h:                            Calling sequence.
  3105. * program-varying paths:                 Supported file formats.
  3106. * program_invocation_name:               Calling sequence.
  3107. * program_invocation_short_name:         Calling sequence.
  3108. * programming overview:                  Programming overview.
  3109. * programming with config files:         Programming with config files.
  3110. * programming with Kpathsea:             Calling sequence.
  3111. * programs using the library:            Introduction.
  3112. * proof mode:                            Unable to generate fonts.
  3113. * PSHEADERS:                             Supported file formats.
  3114. * pxp Pascal preprocessor:               History.
  3115. * quoting variable values:               Variable expansion.
  3116. * readable:                              Suppressing warnings.
  3117. * reading arbitrary-length lines:        Calling sequence.
  3118. * README.CONFIGURE:                      Running configure.
  3119. * README.mirrors:                        Electronic distribution.
  3120. * recording successful searches:         Logging.
  3121. * relative filenames:                    Searching overview.
  3122. * relative filenames in ls-R:            Installing files.
  3123. * reporting bugs:                        Reporting bugs.
  3124. * resident.c:                            Calling sequence.
  3125. * resolution, setting:                   Path searching options.
  3126. * resolution, wrong:                     Unable to generate fonts.
  3127. * resolutions, last-resort:              Fallback font.
  3128. * retrieving TeX:                        unixtex.ftp.
  3129. * right-hand side of variable assignments: Config files.
  3130. * Rokicki, Tom:                          History.
  3131. * root user:                             Tilde expansion.
  3132. * runtime configuration files:           Config files.
  3133. * runtime debugging:                     Debugging.
  3134. * Sauter fonts, and dynamic source creation: mktex scripts.
  3135. * scripts for file creation:             mktex scripts.
  3136. * search path, defined:                  Searching overview.
  3137. * search paths, changing default:        Changing search paths.
  3138. * searching for files:                   File lookup.
  3139. * searching for glyphs:                  Glyph lookup.
  3140. * searching overview:                    Searching overview.
  3141. * searching the database:                Searching overview.
  3142. * searching the disk:                    Searching overview.
  3143. * security considerations:               Security.
  3144. * sed error from configure:              Empty Makefiles.
  3145. * SELFAUTODIR:                           Calling sequence.
  3146. * SELFAUTOLOC:                           Calling sequence.
  3147. * SELFAUTOPARENT:                        Calling sequence.
  3148. * sending patches:                       Bug checklist.
  3149. * setgid scripts:                        Security.
  3150. * sh5, ok with configure:                configure shells.
  3151. * shar, recommended:                     Bug checklist.
  3152. * shared library, making:                Shared library.
  3153. * shell scripts as configuration files:  Config files.
  3154. * shell variables:                       Variable expansion.
  3155. * shell_escape, example for code:        Programming with config files.
  3156. * shells and configure:                  configure shells.
  3157. * simple installation:                   Simple installation.
  3158. * site overrides for mktex...:           mktex configuration.
  3159. * size of distribution archives:         Disk space.
  3160. * skeleton TeX directory:                TeX directory structure.
  3161. * slow startup time:                     Slow path searching.
  3162. * Solaris BSD compatibility, not:        Running make.
  3163. * source files:                          Supported file formats.
  3164. * sources for search paths:              Path sources.
  3165. * special:                               Suppressing warnings.
  3166. * st_nlink:                              Subdirectory expansion.
  3167. * stack trace:                           Bug checklist.
  3168. * standalone path searching:             Invoking kpsewhich.
  3169. * standard error and debugging output:   Debugging.
  3170. * standard options:                      Standard options.
  3171. * startup time, excessive:               Slow path searching.
  3172. * static linking:                        ShellWidgetClass.
  3173. * static linking and dlsym:              dlopen.
  3174. * string routines:                       Calling sequence.
  3175. * strip:                                 mktex configuration.
  3176. * stripsupplier:                         mktex configuration.
  3177. * striptypeface:                         mktex configuration.
  3178. * subdirectory searching:                Subdirectory expansion.
  3179. * suggestions, making:                   Introduction.
  3180. * Sun 2:                                 History.
  3181. * Sun OpenWin patches:                   ShellWidgetClass.
  3182. * supplier directory, omitting:          mktex configuration.
  3183. * support organization:                  Tape distribution.
  3184. * supported file formats:                Supported file formats.
  3185. * suppressing warnings:                  Suppressing warnings.
  3186. * symbolic link trees, for multiple architectures: configure scenarios.
  3187. * symbolic links not found:              Unable to find files.
  3188. * symbolic links, and ls-R:              ls-R.
  3189. * symlinks, resolving:                   Calling sequence.
  3190. * system C compiler bugs:                TeX or Metafont failing.
  3191. * system dependencies:                   Running configure.
  3192. * system V universe:                     Running make.
  3193. * T1FONTS:                               Supported file formats.
  3194. * T1INPUTS:                              Supported file formats.
  3195. * T42FONTS:                              Supported file formats.
  3196. * tape distribution:                     Tape distribution.
  3197. * TDS:                                   TeX directory structure.
  3198. * testing, post-installation:            Installation testing.
  3199. * tests, simple:                         Simple installation.
  3200. * teTeX:                                 Other TeX packages.
  3201. * TeX directory structure:               TeX directory structure.
  3202. * TeX distributions besides Web2c:       Other TeX packages.
  3203. * TeX environment variables:             Supported file formats.
  3204. * TeX failures:                          TeX or Metafont failing.
  3205. * TeX file lookup:                       File lookup.
  3206. * TeX glyph lookup:                      Glyph lookup.
  3207. * TeX help mailing list:                 Mailing lists.
  3208. * TeX hierarchy, one:                    configure scenarios.
  3209. * TeX Live CD-ROM:                       CD-ROM distribution.
  3210. * TeX support:                           TeX support.
  3211. * TeX Users Group:                       Introduction.
  3212. * tex-archive@math.utah.edu:             Mailing lists.
  3213. * tex-file.c:                            File lookup.
  3214. * tex-file.h:                            Programming overview.
  3215. * tex-glyph.c:                           Glyph lookup.
  3216. * tex-glyph.h:                           Programming overview.
  3217. * tex-k-request@mail.tug.org:            Mailing lists.
  3218. * tex-k@mail.tug.org (bug address):      Reporting bugs.
  3219. * tex-make.c:                            mktex script names.
  3220. * TEX_HUSH <1>:                          Suppressing warnings.
  3221. * TEX_HUSH:                              Searching overview.
  3222. * TEXBIB:                                Supported file formats.
  3223. * TEXCONFIG:                             Supported file formats.
  3224. * TEXDOCS:                               Supported file formats.
  3225. * TEXFONTMAPS:                           Supported file formats.
  3226. * TEXFONTS:                              Supported file formats.
  3227. * texfonts.map:                          Fontmap.
  3228. * TEXFORMATS:                            Supported file formats.
  3229. * TEXINDEXSTYLE:                         Supported file formats.
  3230. * TEXINPUTS:                             Supported file formats.
  3231. * TEXMF:                                 TeX directory structure.
  3232. * texmf.cnf, and variable expansion:     Variable expansion.
  3233. * texmf.cnf, creating:                   Running make.
  3234. * texmf.cnf, definition for:             Config files.
  3235. * texmf.cnf, generated:                  Default path generation.
  3236. * texmf.cnf, source for path:            Path sources.
  3237. * texmf.in:                              Default path generation.
  3238. * texmf.in, editing:                     Changing search paths.
  3239. * texmf.sed:                             Default path generation.
  3240. * TEXMFCNF <1>:                          Supported file formats.
  3241. * TEXMFCNF:                              Config files.
  3242. * TEXMFDBS <1>:                          Supported file formats.
  3243. * TEXMFDBS:                              ls-R.
  3244. * TEXMFINI:                              Supported file formats.
  3245. * TEXMFLOG:                              Logging.
  3246. * TEXMFOUTPUT:                           mktex script names.
  3247. * TEXPICTS:                              Supported file formats.
  3248. * TEXPKS:                                Supported file formats.
  3249. * TEXPOOL:                               Supported file formats.
  3250. * TEXPSHEADERS:                          Supported file formats.
  3251. * TEXSIZES:                              Fallback font.
  3252. * TEXSOURCES:                            Supported file formats.
  3253. * TFMFONTS:                              Supported file formats.
  3254. * tilde expansion:                       Tilde expansion.
  3255. * tilde.c:                               Tilde expansion.
  3256. * time system call:                      Logging.
  3257. * tolerance for glyph lookup:            Basic glyph lookup.
  3258. * total disk space:                      Disk space.
  3259. * trailing / in home directory:          Tilde expansion.
  3260. * trailing colons:                       Default expansion.
  3261. * TRFONTS:                               Supported file formats.
  3262. * trick for detecting leaf directories:  Subdirectory expansion.
  3263. * trojan horse attack:                   Security.
  3264. * TTFONTS:                               Supported file formats.
  3265. * TUG:                                   CD-ROM distribution.
  3266. * tug.org:                               unixtex.ftp.
  3267. * tug@tug.org:                           Introduction.
  3268. * typeface directory, omitting:          mktex configuration.
  3269. * ucbinclude, avoiding:                  Running make.
  3270. * UKTUG:                                 CD-ROM distribution.
  3271. * Ultrix shells and configure:           configure shells.
  3272. * unable to find files:                  Unable to find files.
  3273. * unable to generate fonts:              Unable to generate fonts.
  3274. * uname:                                 Bug checklist.
  3275. * universe, BSD vs. system V:            Running make.
  3276. * UNIX_ST_LINK:                          Subdirectory expansion.
  3277. * unixtex.ftp:                           unixtex.ftp.
  3278. * unixtex@u.washington.edu:              Tape distribution.
  3279. * unknown special warnings:              Suppressing warnings.
  3280. * unreadable file warnings:              Suppressing warnings.
  3281. * unreadable files:                      Searching overview.
  3282. * unusable ls-R warning:                 ls-R.
  3283. * usage patterns, finding:               Logging.
  3284. * USE_VARTEXFONTS:                       mktex configuration.
  3285. * Usenet TeX newsgroup:                  Mailing lists.
  3286. * varfonts:                              mktex configuration.
  3287. * variable expansion:                    Variable expansion.
  3288. * variable.c:                            Variable expansion.
  3289. * variable.h:                            Programming with config files.
  3290. * VARTEXFONTS:                           mktex configuration.
  3291. * VAX 11/750:                            History.
  3292. * version number, of Kpathsea:           Kpathsea application distributions.
  3293. * version numbers, determining:          Bug checklist.
  3294. * VF files, not found:                   Searching overview.
  3295. * VFFONTS:                               Supported file formats.
  3296. * VMS support:                           Custom installation.
  3297. * VMS TeX implementations:               Other TeX packages.
  3298. * Vojta, Paul:                           History.
  3299. * Walnut Creek TeX CD-ROM:               CD-ROM distribution.
  3300. * Walsh, Norman:                         History.
  3301. * warning about unusable ls-R:           ls-R.
  3302. * warnings, file access:                 Searching overview.
  3303. * warnings, pointer combinations:        Pointer combination warnings.
  3304. * warnings, suppressing:                 Suppressing warnings.
  3305. * wcstombs:                              dlopen.
  3306. * Weber, Olaf:                           History.
  3307. * whitespace, in fontmap files:          Fontmap.
  3308. * whitespace, not ignored on continuation lines: Config files.
  3309. * Windows TeX implementations:           Other TeX packages.
  3310. * World Wide Web CTAN access:            Electronic distribution.
  3311. * www.tug.org:                           unixtex.ftp.
  3312. * X11 previewer:                         Kpathsea application distributions.
  3313. * X11, lacking on NeXT:                  Kpathsea application distributions.
  3314. * XCFLAGS:                               Running make.
  3315. * XCPPFLAGS:                             Running make.
  3316. * XDEFS:                                 Running make.
  3317. * XDVIFONTS:                             Supported file formats.
  3318. * XDVIMAKEPK:                            mktex script names.
  3319. * XDVISIZES:                             Fallback font.
  3320. * XLDFLAGS:                              Running make.
  3321. * XLOADLIBES:                            Running make.
  3322. * XMAKEARGS:                             Running make.
  3323. * Xmu library problems:                  ShellWidgetClass.
  3324. * XtStrings:                             XtStrings.
  3325. * zuhn, david:                           History.
  3326. * { expansion:                           Brace expansion.
  3327. * ~ expansion:                           Tilde expansion.
  3328. Tag Table:
  3329. Node: Top
  3330. Node: Introduction
  3331. Node: History
  3332. Node: Installation
  3333. Node: Simple installation
  3334. Node: Custom installation
  3335. 12892
  3336. Node: Disk space
  3337. 14058
  3338. Node: Kpathsea application distributions
  3339. 14973
  3340. Node: Changing search paths
  3341. 16077
  3342. Node: Default path features
  3343. 17245
  3344. Node: Default path generation
  3345. 19361
  3346. Node: Running configure
  3347. 20788
  3348. Node: configure shells
  3349. 21828
  3350. Node: configure options
  3351. 22597
  3352. Node: configure environment
  3353. 24088
  3354. Node: configure scenarios
  3355. 25876
  3356. Node: Shared library
  3357. 27499
  3358. Node: Running make
  3359. 28816
  3360. Node: Installing files
  3361. 30848
  3362. Node: Cleaning up
  3363. 32783
  3364. Node: Filename database generation
  3365. 33818
  3366. Node: mktex scripts
  3367. 34372
  3368. Node: mktex configuration
  3369. 35319
  3370. Node: mktex script names
  3371. 40211
  3372. Node: mktex script arguments
  3373. 41292
  3374. Node: Installation testing
  3375. 42167
  3376. Node: Security
  3377. 42519
  3378. Node: TeX directory structure
  3379. 45072
  3380. Node: unixtex.ftp
  3381. 49487
  3382. Node: Electronic distribution
  3383. 51051
  3384. Node: CD-ROM distribution
  3385. 54329
  3386. Node: Tape distribution
  3387. 56314
  3388. Node: Other TeX packages
  3389. 57174
  3390. Node: Reporting bugs
  3391. 58463
  3392. Node: Bug checklist
  3393. 59198
  3394. Node: Mailing lists
  3395. 63288
  3396. Node: Debugging
  3397. 64633
  3398. Node: Logging
  3399. 69695
  3400. Node: Common problems
  3401. 71193
  3402. Node: Unable to find files
  3403. 72014
  3404. Node: Slow path searching
  3405. 74413
  3406. Node: Unable to generate fonts
  3407. 75776
  3408. Node: TeX or Metafont failing
  3409. 77321
  3410. Node: Empty Makefiles
  3411. 79180
  3412. Node: XtStrings
  3413. 80392
  3414. Node: dlopen
  3415. 81212
  3416. Node: ShellWidgetClass
  3417. 82014
  3418. Node: Pointer combination warnings
  3419. 83631
  3420. Node: Path searching
  3421. 84006
  3422. Node: Searching overview
  3423. 84651
  3424. Node: Path sources
  3425. 88010
  3426. Node: Config files
  3427. 89075
  3428. Node: Path expansion
  3429. 92568
  3430. Node: Default expansion
  3431. 93511
  3432. Node: Variable expansion
  3433. 95189
  3434. Node: Tilde expansion
  3435. 96578
  3436. Node: Brace expansion
  3437. 97462
  3438. Node: KPSE_DOT expansion
  3439. 98657
  3440. Node: Subdirectory expansion
  3441. 99160
  3442. Node: Filename database
  3443. 101491
  3444. Node: ls-R
  3445. 102797
  3446. Node: Filename aliases
  3447. 105674
  3448. Node: Database format
  3449. 106839
  3450. Node: Invoking kpsewhich
  3451. 107851
  3452. Node: Path searching options
  3453. 108718
  3454. Node: Auxiliary tasks
  3455. 112411
  3456. Node: Standard options
  3457. 113669
  3458. Node: TeX support
  3459. 113979
  3460. Node: Supported file formats
  3461. 115266
  3462. Node: File lookup
  3463. 121524
  3464. Node: Glyph lookup
  3465. 122808
  3466. Node: Basic glyph lookup
  3467. 123928
  3468. Node: Fontmap
  3469. 124795
  3470. Node: Fallback font
  3471. 127393
  3472. Node: Suppressing warnings
  3473. 128349
  3474. Node: Programming
  3475. 129406
  3476. Node: Programming overview
  3477. 129917
  3478. Node: Calling sequence
  3479. 131833
  3480. Node: Program-specific files
  3481. 136856
  3482. Node: Programming with config files
  3483. 137886
  3484. Node: Index
  3485. 139176
  3486. End Tag Table
  3487.