diff options
author | Karl Berry <karl@freefriends.org> | 2024-02-20 18:33:28 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2024-02-20 18:33:28 +0000 |
commit | 12a220e80344b5c02b56a57d4a994ccb854bc22c (patch) | |
tree | 09be80dc6f1fb1aa93c4c60ec8e20bcbd36e6f8d /Master/texmf-dist/doc/info | |
parent | 3575aa305fd619edaa92f3bc49368cfe9d2f76bc (diff) |
2024 man page, news, manual updates
git-svn-id: svn://tug.org/texlive/trunk@70015 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/info')
-rw-r--r-- | Master/texmf-dist/doc/info/dvips.info | 4 | ||||
-rw-r--r-- | Master/texmf-dist/doc/info/kpathsea.info | 2344 | ||||
-rw-r--r-- | Master/texmf-dist/doc/info/tlbuild.info | 1040 | ||||
-rw-r--r-- | Master/texmf-dist/doc/info/web2c.info | 2214 |
4 files changed, 2936 insertions, 2666 deletions
diff --git a/Master/texmf-dist/doc/info/dvips.info b/Master/texmf-dist/doc/info/dvips.info index 93020bf9632..1422d814de9 100644 --- a/Master/texmf-dist/doc/info/dvips.info +++ b/Master/texmf-dist/doc/info/dvips.info @@ -1,6 +1,6 @@ This is dvips.info, produced by makeinfo version 6.5 from dvips.texi. -This manual documents Dvips version 2023.1 (February 2022), a program to +This manual documents Dvips version 2024.1 (February 2024), a program to translate a DVI file into PostScript. You may freely use, modify and/or distribute this file. INFO-DIR-SECTION TeX @@ -16,7 +16,7 @@ File: dvips.info, Node: Top, Next: Why Dvips, Up: (dir) Dvips ***** -This manual documents Dvips version 2023.1 (February 2022), a program to +This manual documents Dvips version 2024.1 (February 2024), a program to translate a DVI file into PostScript. You may freely use, modify and/or distribute this file. diff --git a/Master/texmf-dist/doc/info/kpathsea.info b/Master/texmf-dist/doc/info/kpathsea.info index 32cddefe1b5..702aff57799 100644 --- a/Master/texmf-dist/doc/info/kpathsea.info +++ b/Master/texmf-dist/doc/info/kpathsea.info @@ -1,9 +1,9 @@ -This is kpathsea.info, produced by makeinfo version 6.5 from +This is kpathsea.info, produced by makeinfo version 7.1 from kpathsea.texi. This file documents the Kpathsea library for path searching. - Copyright (C) 1996-2023 Karl Berry & Olaf Weber. + Copyright © 1996-2024 Karl Berry & Olaf Weber. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -37,7 +37,7 @@ Kpathsea library **************** This manual documents the Kpathsea library for path searching. It -corresponds to version 6.3.5, released in February 2023. +corresponds to version 6.4.0, released in January 2024. * Menu: @@ -61,8 +61,8 @@ File: kpathsea.info, Node: Introduction, Next: unixtex.ftp, Prev: Top, Up: T 1 Introduction ************** -This manual corresponds to version 6.3.5 of the Kpathsea library, -released in February 2023. +This manual corresponds to version 6.4.0 of the Kpathsea library, +released in January 2024. The library's fundamental purpose is to return a filename from a list of directories specified by the user, similar to what shells do when @@ -71,11 +71,11 @@ looking up program names to execute. The following software, all of which is maintained in parallel, uses this library: - * Dviljk (see the 'dvilj' man page) - * Dvipsk (*note (dvips)::) - * GNU font utilities (*note (fontu)::) - * Web2c (*note (web2c)::) - * Xdvik (see the 'xdvi' man page) + • Dviljk (see the ‘dvilj’ man page) + • Dvipsk (*note (dvips)::) + • GNU font utilities (*note (fontu)::) + • Web2c (*note (web2c)::) + • Xdvik (see the ‘xdvi’ man page) Other software that we do not maintain also uses it. @@ -99,7 +99,7 @@ See accompanying files for the text of the GNU licenses, or If you know enough about TeX to be reading this manual, then you (or your institution) should consider joining the TeX Users Group (if you're -already a member, thanks!). TUG produces the periodical 'TUGboat', +already a member, thanks!). TUG produces the periodical ‘TUGboat’, sponsors an annual meeting and publishes the proceedings, and arranges courses on TeX for all levels of users throughout the world. See <https://tug.org> for information. @@ -117,7 +117,7 @@ File: kpathsea.info, Node: History, Up: Introduction This section is for those people who are curious about how the library came about. If you like to read historical accounts of software, we urge you to seek out the GNU Autoconf manual and the "Errors of TeX" -paper by Don Knuth, published in his book 'Digital Typography', among +paper by Don Knuth, published in his book ‘Digital Typography’, among other places. [Karl writes.] My first ChangeLog entry for Web2c seems to be @@ -125,18 +125,18 @@ February 1990, but I may have done some work before then. In any case, Tim Morgan and I were jointly maintaining it for a time. (I should mention here that Tim had made Web2c into a real distribution long before I had ever used it or even heard of it, and Tom Rokicki did the -original implementation. When I started, I was using 'pxp' and 'pc' on +original implementation. When I started, I was using ‘pxp’ and ‘pc’ on VAX 11/750's and the hot new Sun 2 machines.) It must have been later in 1990 and 1991 that I started working on -'TeX for the Impatient'. Dvips, Xdvi, Web2c, and the GNU fontutils +‘TeX for the Impatient’. Dvips, Xdvi, Web2c, and the GNU fontutils (which I was also writing at the time) all used different environment variables, and, more importantly, had different bugs in their path searching. This became extremely painful, as I was stressing everything to the limit working on the book. I also desperately wanted to implement subdirectory searching, since I couldn't stand putting everything in one big directory, and also couldn't stand having to -explicitly specify 'cm', 'pandora', ... in a path. +explicitly specify ‘cm’, ‘pandora’, ... in a path. In the first incarnation, I just hacked separately on each program--that was the original subdirectory searching code in both Xdvi @@ -198,7 +198,7 @@ respect to the overall TeX Live build, where Kpathsea is now maintained. File: kpathsea.info, Node: unixtex.ftp, Next: Security, Prev: Introduction, Up: Top -2 'unixtex.ftp': Obtaining TeX +2 ‘unixtex.ftp’: Obtaining TeX ****************************** This is <ftp://tug.org/tex/unixtex.ftp>, a.k.a. @@ -216,7 +216,7 @@ released as a separate packages. Their sources are now maintained as part of TeX Live. The host ftp.cs.stanford.edu is the original source for the files for -which Donald Knuth is directly responsible: 'tex.web', 'plain.tex', etc. +which Donald Knuth is directly responsible: ‘tex.web’, ‘plain.tex’, etc. However, unless you want to undertake the project of building your TeX system from scratch, it is more reliable and less work to retrieve these files as part of a larger package. @@ -237,51 +237,95 @@ None of the programs in the TeX system require any special system privileges, so there's no first-level security concern of people gaining illegitimate root access. - A TeX document, however, can write to arbitrary files, e.g., -'~/.rhosts', and thus an unwitting user who runs TeX on a random -document is vulnerable to a trojan horse attack. This loophole is -closed by default, but you can be permissive if you so desire in -'texmf.cnf'. *Note (web2c)tex invocation::. MetaPost has the same -issue. - - Dvips, Xdvi, and TeX can also execute shell commands under some -circumstances. To disable this, see the '-R' option in *note -(dvips)Option details::, the xdvi man page, and *note (web2c)tex -invocation::, respectively. - - Another security issue arises because it's very useful--almost -necessary--to make arbitrary fonts on user demand with 'mktexpk' and -friends. Where do these files get installed? By default, the 'mktexpk' -distributed with Kpathsea assumes a world-writable '/var/tmp' directory; -this is a simple and convenient approach, but it may not suit your -situation because it means that a local cache of fonts is created on -every machine. + Thus, the general goal of our security measures is to make an +untrusted TeX document safe to execute, in the sense of no document +being able to change the system or user configuration, or somehow +transmit information to an attacker. Here are some of the steps that +have been taken to make the TeX system safe in this regard: + + • A TeX document can write to arbitrary files via ‘\openout’, e.g., + ‘~/.profile’, and thus an unwitting user who runs TeX on an + untrusted document is vulnerable to a trojan horse attack. This + loophole is closed by default, but you can be permissive if you so + desire in ‘texmf.cnf’. *Note (web2c)tex invocation::. MetaPost + has the same issue. + + • Dvips, Xdvi, TeX, and others can execute shell commands. By + default, only a handful of commands that are believed to be safe + (to the best of our ability to check) are allowed. For the list, + see the ‘shell_escape_commands’ variable in ‘texmf.cnf’ (*note + (web2c)Shell escapes::). For more information, e.g., to disable + this completely, see the ‘-R’ option in *note (dvips)Option + details::, the xdvi man page, and *note (web2c)tex invocation::, + respectively. + + • LuaTeX is a special case. Since Lua is a general-purpose + programming language, it has all the usual functionality for + writing files, executing shell commands, and plenty more. When + LuaTeX is used in its so-called "kpse" mode, as with LuaLaTeX, we + have nevertheless done our best to also make it safe to execute by + default, by disabling or restricting the various problematic Lua + features. *Note Safe filenames::, for a bit more about this. (By + the way, when LuaTeX is run in non-kpse mode, as with ConTeXt MkIV, + everything is allowed; thus, untrusted documents should not be + processed without checking.) + + • There are some well-known ways to crash TeX, using (deliberately + unchecked) arithmetic overflow and other nefarious constructs (some + are listed at <https://tug.org/texmfbug/nobug.html>. While + disturbing, TeX has no special system access and so these crashes + don't present a security risk. + + • One more issue is the desire for a globally writable font cache + directory; see the section below for this (*note Global font cache + and security::). + +* Menu: + +* Global font cache and security:: + + +File: kpathsea.info, Node: Global font cache and security, Up: Security + +3.1 Global font cache and security +================================== + +It's useful to make arbitrary fonts on user demand with ‘mktexpk’ and +friends. Where do these files get installed? By default, the ‘mktexpk’ +distributed with Kpathsea assumes a world-writable ‘/var/tmp’ directory; +this is a simple and convenient approach, but it does not suit all +situations, because it means that a local cache of fonts is created on +every user's system. To avoid this duplication, many people consider a shared, globally writable font tree desirable, in spite of the potential security -problems. To do this you should change the value of 'VARTEXFONTS' in -'texmf.cnf' to refer to some globally known directory. *Note mktex +problems. To do this you should change the value of ‘VARTEXFONTS’ in +‘texmf.cnf’ to refer to some globally known directory. *Note mktex configuration::. The first restriction you can apply is to make newly-created -directories under 'texmf' be append-only with an option in 'mktex.cnf'. +directories under ‘texmf’ be append-only with an option in ‘mktex.cnf’. *Note mktex configuration::. Another approach is to establish a group (or user) for TeX files, -make the 'texmf' tree writable only to that group (or user), and make -'mktexpk' et al. setgid to that group (or setuid to that user). Then +make the ‘texmf’ tree writable only to that group (or user), and make +‘mktexpk’ et al. setgid to that group (or setuid to that user). Then users must invoke the scripts to install things. (If you're worried about the inevitable security holes in scripts, then you could write a C wrapper to exec the script.) - The 'mktex...' scripts install files with the same read and write + The ‘mktex...’ scripts install files with the same read and write permissions as the directory they are installed in. The executable, sgid, suid, and sticky bits are always cleared. - Any directories created by the 'mktex...' scripts have the same -permissions as their parent directory, unless the 'appendonlydir' + Any directories created by the ‘mktex...’ scripts have the same +permissions as their parent directory, unless the ‘appendonlydir’ feature is used, in which case the sticky bit is always set. + Nowadays, with bitmap files rarely used, and with individual systems +being so much more powerful, this is less of an issue than it was in the +past. But the question still comes up occasionally. + File: kpathsea.info, Node: TeX directory structure, Next: Path searching, Prev: Security, Up: Top @@ -298,53 +342,53 @@ from <https://ctan.org/pkg/tds> (*note unixtex.ftp::). In short, here is a skeleton of the default directory structure, extracted from the TDS document: - PREFIX/ installation root ('/usr/local' by default) + PREFIX/ installation root (‘/usr/local’ by default) bin/ executables man/ man pages include/ C header files info/ GNU info files - lib/ libraries ('libkpathsea.*') + lib/ libraries (‘libkpathsea.*’) share/ architecture-independent files texmf/ TDS root bibtex/ BibTeX input files bib/ BibTeX databases - base/ base distribution (e.g., 'xampl.bib') + base/ base distribution (e.g., ‘xampl.bib’) misc/ single-file databases PKG/ name of a package bst/ BibTeX style files - base/ base distribution (e.g., 'plain.bst', 'acm.bst') + base/ base distribution (e.g., ‘plain.bst’, ‘acm.bst’) misc/ single-file styles PKG/ name of a package doc/ additional documentation - dvips/ '.pro', '.ps', 'psfonts.map' + dvips/ ‘.pro’, ‘.ps’, ‘psfonts.map’ fonts/ font-related files - TYPE/ file type (e.g., 'tfm', 'pk') - MODE/ type of output device (types 'pk' and 'gf' only) - SUPPLIER/ name of a font supplier (e.g., 'public') - TYPEFACE/ name of a typeface (e.g., 'cm') - dpiNNN/ font resolution (types 'pk' and 'gf' only) + TYPE/ file type (e.g., ‘tfm’, ‘pk’) + MODE/ type of output device (types ‘pk’ and ‘gf’ only) + SUPPLIER/ name of a font supplier (e.g., ‘public’) + TYPEFACE/ name of a typeface (e.g., ‘cm’) + dpiNNN/ font resolution (types ‘pk’ and ‘gf’ only) metafont/ Metafont (non-font) input files - base/ base distribution (e.g., 'plain.mf') - misc/ single-file packages (e.g., 'modes.mf') - PKG/ name of a package (e.g., 'mfpic') + base/ base distribution (e.g., ‘plain.mf’) + misc/ single-file packages (e.g., ‘modes.mf’) + PKG/ name of a package (e.g., ‘mfpic’) metapost/ MetaPost input files - base/ base distribution (e.g., 'plain.mp') + base/ base distribution (e.g., ‘plain.mp’) misc/ single-file packages PKG/ name of a package - support/ support files for MetaPost-related utilities (e.g., 'trfonts.map') - mft/ 'MFT' inputs (e.g., 'plain.mft') + support/ support files for MetaPost-related utilities (e.g., ‘trfonts.map’) + mft/ ‘MFT’ inputs (e.g., ‘plain.mft’) tex/ TeX input files - FORMAT/ name of a format (e.g., 'plain') - base/ base distribution for FORMAT (e.g., 'plain.tex') - misc/ single-file packages (e.g., 'webmac.tex') + FORMAT/ name of a format (e.g., ‘plain’) + base/ base distribution for FORMAT (e.g., ‘plain.tex’) + misc/ single-file packages (e.g., ‘webmac.tex’) local/ local additions to or local configuration files for FORMAT - PKG/ name of a package (e.g., 'graphics', 'mfnfss') + PKG/ name of a package (e.g., ‘graphics’, ‘mfnfss’) generic/ format-independent packages - hyphen/ hyphenation patterns (e.g., 'hyphen.tex') + hyphen/ hyphenation patterns (e.g., ‘hyphen.tex’) images/ image input files (e.g., Encapsulated PostScript) - misc/ single-file format-independent packages (e.g., 'null.tex'). - PKG/ name of a package (e.g., 'babel') - web2c/ implementation-dependent files ('.pool', '.fmt', 'texmf.cnf', etc.) + misc/ single-file format-independent packages (e.g., ‘null.tex’). + PKG/ name of a package (e.g., ‘babel’) + web2c/ implementation-dependent files (‘.pool’, ‘.fmt’, ‘texmf.cnf’, etc.) Some concrete examples for most file types: @@ -395,14 +439,14 @@ File: kpathsea.info, Node: Searching overview, Next: Path sources, Up: Path s 5.1 Searching overview ====================== -A "search path" is a colon-separated list of "path elements", which are +A “search path” is a colon-separated list of “path elements”, which are directory names with a few extra frills. A search path can come from (a -combination of) many sources; see below. To look up a file 'foo' along -a path '.:/dir', Kpathsea checks each element of the path in turn: first -'./foo', then '/dir/foo', returning the first match (or possibly all +combination of) many sources; see below. To look up a file ‘foo’ along +a path ‘.:/dir’, Kpathsea checks each element of the path in turn: first +‘./foo’, then ‘/dir/foo’, returning the first match (or possibly all matches). - The "colon" and "slash" mentioned here aren't necessarily ':' and '/' + The "colon" and "slash" mentioned here aren't necessarily ‘:’ and ‘/’ on non-Unix systems. Kpathsea tries to adapt to other operating systems' conventions. @@ -413,7 +457,7 @@ specification is matched against the contents of the database. If the database does not exist, or does not apply to this path element, or contains no matches, the filesystem is searched (if this was -not forbidden by the specification with '!!' and if the file being +not forbidden by the specification with ‘!!’ and if the file being searched for must exist). Kpathsea constructs the list of directories that correspond to this path element, and then checks in each for the file being searched for. (To help speed future lookups of files in the @@ -421,9 +465,9 @@ same directory, the directory in which a file is found is floated to the top of the directory list.) The "file must exist" condition comes into play with VF files and -input files read by the TeX '\openin' command. These files might very -well not exist (consider 'cmr10.vf'), and so it would be wrong to search -the disk for them. Therefore, if you fail to update 'ls-R' when you +input files read by the TeX ‘\openin’ command. These files might very +well not exist (consider ‘cmr10.vf’), and so it would be wrong to search +the disk for them. Therefore, if you fail to update ‘ls-R’ when you install a new VF file, it will not be found. Each path element is checked in turn: first the database, then the @@ -435,32 +479,32 @@ needed on a particular run. On Unix-like systems, if no match is found by any of the above, and the path element allows checking the filesystem (per the above), a final check is made for a case-insensitive match. Thus, looking for a name -like './FooBar.TeX' will match a file './foobar.tex', and vice versa. +like ‘./FooBar.TeX’ will match a file ‘./foobar.tex’, and vice versa. This is not done on Windows. *Note Casefolding search::. Although the simplest and most common path element is a directory name, Kpathsea supports additional features in search paths: layered default values, environment variable names, config file values, users' home directories, and recursive subdirectory searching. Thus, we say -that Kpathsea "expands" a path element, meaning transforming all the +that Kpathsea “expands” a path element, meaning transforming all the magic specifications into the basic directory name or names. This process is described in the sections below. It happens in the same order as the sections. Exception to all of the above: If the filename being searched for is -absolute or explicitly relative, i.e., starts with '/' or './' or '../', +absolute or explicitly relative, i.e., starts with ‘/’ or ‘./’ or ‘../’, Kpathsea simply checks if that file exists, with a fallback to a casefolding match if needed and enabled, as described above. Ordinarily, if Kpathsea tries to access a file or directory that cannot be read, it gives a warning. This is so you will be alerted to directories or files that accidentally lack any read permission (for -example, a 'lost+found' directory). If you prefer not to see these -warnings, include the value 'readable' in the 'TEX_HUSH' environment +example, a ‘lost+found’ directory). If you prefer not to see these +warnings, include the value ‘readable’ in the ‘TEX_HUSH’ environment variable or config file value. This generic path searching algorithm is implemented in -'kpathsea/pathsearch.c'. It is employed by a higher-level algorithm +‘kpathsea/pathsearch.c’. It is employed by a higher-level algorithm when searching for a file of a particular type (*note File lookup::, and *note Glyph lookup::). @@ -473,21 +517,21 @@ File: kpathsea.info, Node: Path sources, Next: Path expansion, Prev: Searchin A search path or other configuration value can come from many sources. In the order in which Kpathsea looks for them: - 1. A command-line option such as '--cnf-line', available in - 'kpsewhich' and most TeX engines. *Note Path searching options::. + 1. A command-line option such as ‘--cnf-line’, available in + ‘kpsewhich’ and most TeX engines. *Note Path searching options::. - A user-set environment variable, e.g., 'TEXINPUTS'. Environment + A user-set environment variable, e.g., ‘TEXINPUTS’. Environment variables with an underscore and the program name appended - override; for example, 'TEXINPUTS_latex' overrides 'TEXINPUTS' if - the program being run is named 'latex'. + override; for example, ‘TEXINPUTS_latex’ overrides ‘TEXINPUTS’ if + the program being run is named ‘latex’. - 2. A program-specific configuration file, e.g., an 'S /a:/b' line in - Dvips' 'config.ps' (*note (dvips)Config files::). + 2. A program-specific configuration file, e.g., an ‘S /a:/b’ line in + Dvips' ‘config.ps’ (*note (dvips)Config files::). - 3. A line in a Kpathsea configuration file 'texmf.cnf', e.g., - 'TEXINPUTS=/c:/d' (see below). + 3. A line in a Kpathsea configuration file ‘texmf.cnf’, e.g., + ‘TEXINPUTS=/c:/d’ (see below). - 4. The compile-time default (specified in 'kpathsea/paths.h'). + 4. The compile-time default (specified in ‘kpathsea/paths.h’). You can see each of these values for a given search path by using the debugging options (*note Debugging::). @@ -505,28 +549,28 @@ File: kpathsea.info, Node: Config files, Up: Path sources 5.2.1 Config files ------------------ -As mentioned above, Kpathsea reads "runtime configuration files" named -'texmf.cnf' for search path and other definitions. The search path used -to look for these configuration files is named 'TEXMFCNF', and is +As mentioned above, Kpathsea reads “runtime configuration files” named +‘texmf.cnf’ for search path and other definitions. The search path used +to look for these configuration files is named ‘TEXMFCNF’, and is constructed in the usual way, as described above, except that configuration files cannot be used to define the path, naturally; also, -an 'ls-R' database is not used to search for them. +an ‘ls-R’ database is not used to search for them. - Kpathsea reads _all_ 'texmf.cnf' files in the search path, not just + Kpathsea reads _all_ ‘texmf.cnf’ files in the search path, not just the first one found; definitions in earlier files override those in -later files. Thus, if the search path is '.:$TEXMF', values from -'./texmf.cnf' override those from '$TEXMF/texmf.cnf'. +later files. Thus, if the search path is ‘.:$TEXMF’, values from +‘./texmf.cnf’ override those from ‘$TEXMF/texmf.cnf’. - If Kpathsea cannot find any 'texmf.cnf' file, it reports a warning + If Kpathsea cannot find any ‘texmf.cnf’ file, it reports a warning including all the directories it checked. If you don't want to see this -warning, set the environment variable 'KPATHSEA_WARNING' to the single -character '0' (zero, not oh). +warning, set the environment variable ‘KPATHSEA_WARNING’ to the single +character ‘0’ (zero, not oh). While (or instead of) reading this description, you may find it -helpful to look at the distributed 'texmf.cnf', which uses or at least -mentions most features. The format of 'texmf.cnf' files follows: +helpful to look at the distributed ‘texmf.cnf’, which uses or at least +mentions most features. The format of ‘texmf.cnf’ files follows: - * Comments start with '%' or '#', either at the beginning of a line + • Comments start with ‘%’ or ‘#’, either at the beginning of a line or preceded by whitespace, and continue to the end of the line. That is, similar to most shells, a comment character in the "middle" of a value does not start a comment. Examples: @@ -534,44 +578,44 @@ mentions most features. The format of 'texmf.cnf' files follows: % this is a comment var = a%b % but the value of var will be "a%b" - * Blank lines are ignored. + • Blank lines are ignored. - * A '\' at the end of a line acts as a continuation character, i.e., + • A ‘\’ at the end of a line acts as a continuation character, i.e., the next line is appended. Whitespace at the beginning of continuation lines is not ignored. - * Each remaining line will look like: + • Each remaining line will look like: VARIABLE [. PROGNAME] [=] VALUE - where the '=' and surrounding whitespace is optional. + where the ‘=’ and surrounding whitespace is optional. - * The VARIABLE name may contain any character other than whitespace, - '=', or '.', but sticking to 'A-Za-z_' is safest. + • The VARIABLE name may contain any character other than whitespace, + ‘=’, or ‘.’, but sticking to ‘A-Za-z_’ is safest. - * If '.PROGNAME' is present (preceding spaces are ignored), the + • If ‘.PROGNAME’ is present (preceding spaces are ignored), the definition only applies if the program that is running is named - (i.e., the last component of 'argv[0]' is) PROGNAME or - 'PROGNAME.{exe,bat,cmd,...}'. Most notably, this allows different + (i.e., the last component of ‘argv[0]’ is) PROGNAME or + ‘PROGNAME.{exe,bat,cmd,...}’. Most notably, this allows different flavors of TeX to have different search paths. The PROGNAME value is used literally, without variable or other expansions. - * Considered as strings, VALUE may contain any character. However, - in practice most 'texmf.cnf' values are related to path expansion, + • Considered as strings, VALUE may contain any character. However, + in practice most ‘texmf.cnf’ values are related to path expansion, and since various special characters are used in expansion, such as braces and commas, they cannot be used in directory names. - The '$VAR.PROG' feature is not available on the right-hand side; + The ‘$VAR.PROG’ feature is not available on the right-hand side; instead, you must use an additional variable (see below for example). - A ';' in VALUE is translated to ':' if running under Unix, in order - to have a single 'texmf.cnf' that can support both Unix and Windows + A ‘;’ in VALUE is translated to ‘:’ if running under Unix, in order + to have a single ‘texmf.cnf’ that can support both Unix and Windows systems. This translation happens with any value, not just search - paths, but fortunately in practice ';' is not needed in other + paths, but fortunately in practice ‘;’ is not needed in other values. - * All definitions are read before anything is expanded, so you can + • All definitions are read before anything is expanded, so you can use variables before they are defined (like Make, unlike most other programs). @@ -585,26 +629,26 @@ Here is a configuration file fragment illustrating most of these points: TEXINPUTS.latex2e = $latex2e_inputs TEXINPUTS.latex = $latex2e_inputs - The combination of spaces being ignored before the '.' of a program -name qualifer and the optional '=' for the assignment has an unexpected -consequence: if the value begins with a literal '.' and the '=' is + The combination of spaces being ignored before the ‘.’ of a program +name qualifer and the optional ‘=’ for the assignment has an unexpected +consequence: if the value begins with a literal ‘.’ and the ‘=’ is omitted, the intended value is interpreted as a program name. For -example, a line 'var .;/some/path' is taken as an empty value for 'var' -running under the program named ';/some/path'. To diagnose this, +example, a line ‘var .;/some/path’ is taken as an empty value for ‘var’ +running under the program named ‘;/some/path’. To diagnose this, Kpathsea warns if the program name contains a path separator or other special character. The simplest way to avoid the problem is to use the -'='. +‘=’. Exactly when a character will be considered special or act as itself depends on the context in which it is used. The rules are inherent in the multiple levels of interpretation of the configuration (parsing, expansion, search, ...) and so cannot be concisely stated, -unfortunately. There is no general escape mechanism; in particular, '\' -is not an "escape character" in 'texmf.cnf' files. When it comes +unfortunately. There is no general escape mechanism; in particular, ‘\’ +is not an "escape character" in ‘texmf.cnf’ files. When it comes choosing directory names for installation, it is safest to avoid them all. - The implementation of all this is in 'kpathsea/cnf.c'. + The implementation of all this is in ‘kpathsea/cnf.c’. File: kpathsea.info, Node: Path expansion, Next: Casefolding search, Prev: Path sources, Up: Path searching @@ -614,9 +658,9 @@ File: kpathsea.info, Node: Path expansion, Next: Casefolding search, Prev: Pa Kpathsea recognizes certain special characters and constructions in search paths, similar to that in shells. As a general example: -'~$USER/{foo,bar}//baz' expands to all subdirectories under directories -'foo' and 'bar' in $USER's home directory that contain a directory or -file 'baz'. +‘~$USER/{foo,bar}//baz’ expands to all subdirectories under directories +‘foo’ and ‘bar’ in $USER's home directory that contain a directory or +file ‘baz’. These expansions are explained in the sections below. @@ -636,7 +680,7 @@ File: kpathsea.info, Node: Default expansion, Next: Variable expansion, Up: P ----------------------- If the highest-priority search path (*note Path sources::) contains an -"extra colon" (i.e., leading, trailing, or doubled), Kpathsea inserts at +“extra colon” (i.e., leading, trailing, or doubled), Kpathsea inserts at that point the next-highest-priority search path that is defined. If that inserted path has an extra colon, the same happens with the next-highest. (An extra colon in the compile-time default value has @@ -646,7 +690,7 @@ unpredictable results, so installers beware.) setenv TEXINPUTS /home/karl: -and a 'TEXINPUTS' value from 'texmf.cnf' of +and a ‘TEXINPUTS’ value from ‘texmf.cnf’ of .:$TEXMF//tex @@ -656,7 +700,7 @@ then the final value used for searching will be: Put another way, default expansion works on "formats" (search paths), and not directly on environment variables. Example, showing the -trailing ':' ignored in the first case and expanded in the second: +trailing ‘:’ ignored in the first case and expanded in the second: $ env TTFONTS=/tmp: kpsewhich --expand-path '$TTFONTS' /tmp @@ -664,21 +708,21 @@ trailing ':' ignored in the first case and expanded in the second: /tmp:.:/home/olaf/texmf/fonts/truetype//:... Since Kpathsea looks for multiple configuration files, it would be -natural to expect that (for example) an extra colon in './texmf.cnf' -would expand to the path in '$TEXMF/texmf.cnf'. Or, with Dvips' -configuration files, that an extra colon in 'config.$PRINTER' would -expand to the path in 'config.ps'. This doesn't happen. It's not clear +natural to expect that (for example) an extra colon in ‘./texmf.cnf’ +would expand to the path in ‘$TEXMF/texmf.cnf’. Or, with Dvips' +configuration files, that an extra colon in ‘config.$PRINTER’ would +expand to the path in ‘config.ps’. This doesn't happen. It's not clear this would be desirable in all cases, and trying to devise a way to specify the path to which the extra colon should expand seemed truly baroque. Technicality: Since it would be useless to insert the default value -in more than one place, Kpathsea changes only one extra ':' and leaves +in more than one place, Kpathsea changes only one extra ‘:’ and leaves any others in place (they will eventually be ignored). Kpathsea checks -first for a leading ':', then a trailing ':', then a doubled ':'. +first for a leading ‘:’, then a trailing ‘:’, then a doubled ‘:’. You can trace this by debugging "paths" (*note Debugging::). Default -expansion is implemented in the source file 'kpathsea/kdefault.c'. +expansion is implemented in the source file ‘kpathsea/kdefault.c’. File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: Default expansion, Up: Path expansion @@ -686,34 +730,34 @@ File: kpathsea.info, Node: Variable expansion, Next: Tilde expansion, Prev: D 5.3.2 Variable expansion ------------------------ -'$foo' or '${foo}' in a path element is replaced by (1) the value of an -environment variable 'foo' (if defined); (2) the value of 'foo' from -'texmf.cnf' (if defined); (3) the empty string. +‘$foo’ or ‘${foo}’ in a path element is replaced by (1) the value of an +environment variable ‘foo’ (if defined); (2) the value of ‘foo’ from +‘texmf.cnf’ (if defined); (3) the empty string. - If the character after the '$' is alphanumeric or '_', the variable + If the character after the ‘$’ is alphanumeric or ‘_’, the variable name consists of all consecutive such characters. If the character -after the '$' is a '{', the variable name consists of everything up to -the next '}' (braces may not be nested around variable names). -Otherwise, Kpathsea gives a warning and ignores the '$' and its +after the ‘$’ is a ‘{’, the variable name consists of everything up to +the next ‘}’ (braces may not be nested around variable names). +Otherwise, Kpathsea gives a warning and ignores the ‘$’ and its following character. You must quote the $'s and braces as necessary for your shell. _Shell_ variable values cannot be seen by Kpathsea, i.e., ones defined -by 'set' in C shells and without 'export' in Bourne shells. +by ‘set’ in C shells and without ‘export’ in Bourne shells. For example, given setenv tex /home/texmf setenv TEXINPUTS .:$tex:${tex}prev -the final 'TEXINPUTS' path is the three directories: +the final ‘TEXINPUTS’ path is the three directories: .:/home/texmf:/home/texmfprev - The '.PROGNAME' suffix on variables and '_PROGNAME' on environment + The ‘.PROGNAME’ suffix on variables and ‘_PROGNAME’ on environment variable names are not implemented for general variable expansions. These are only recognized when search paths are initialized (*note Path sources::). Variable expansion is implemented in the source file -'kpathsea/variable.c'. +‘kpathsea/variable.c’. File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Variable expansion, Up: Path expansion @@ -721,26 +765,26 @@ File: kpathsea.info, Node: Tilde expansion, Next: Brace expansion, Prev: Vari 5.3.3 Tilde expansion --------------------- -A leading '~' in a path element is replaced by the value of the -environment variable 'HOME', or '.' if 'HOME' is not set. On Windows, -the environment variable 'USERPROFILE' is checked instead of 'HOME'. +A leading ‘~’ in a path element is replaced by the value of the +environment variable ‘HOME’, or ‘.’ if ‘HOME’ is not set. On Windows, +the environment variable ‘USERPROFILE’ is checked instead of ‘HOME’. - A leading '~USER' in a path element is replaced by USER's home -directory from the system 'passwd' database. + A leading ‘~USER’ in a path element is replaced by USER's home +directory from the system ‘passwd’ database. For example, setenv TEXINPUTS ~/mymacros: -will prepend a directory 'mymacros' in your home directory to the +will prepend a directory ‘mymacros’ in your home directory to the default path. - As a special case, if a home directory ends in '/', the trailing -slash is dropped, to avoid inadvertently creating a '//' construct in -the path. For example, if the home directory of the user 'root' is '/', -the path element '~root/mymacros' expands to just '/mymacros', not -'//mymacros'. + As a special case, if a home directory ends in ‘/’, the trailing +slash is dropped, to avoid inadvertently creating a ‘//’ construct in +the path. For example, if the home directory of the user ‘root’ is ‘/’, +the path element ‘~root/mymacros’ expands to just ‘/mymacros’, not +‘//mymacros’. - Tilde expansion is implemented in the source file 'kpathsea/tilde.c'. + Tilde expansion is implemented in the source file ‘kpathsea/tilde.c’. File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: Tilde expansion, Up: Path expansion @@ -748,38 +792,38 @@ File: kpathsea.info, Node: Brace expansion, Next: KPSE_DOT expansion, Prev: T 5.3.4 Brace expansion --------------------- -'x{A,B}y' expands to 'xAy:xBy'. For example: +‘x{A,B}y’ expands to ‘xAy:xBy’. For example: foo/{1,2}/baz -expands to 'foo/1/baz:foo/2/baz'. ':' is the path separator on the -current system; e.g., on a Windows system, it's ';'. +expands to ‘foo/1/baz:foo/2/baz’. ‘:’ is the path separator on the +current system; e.g., on a Windows system, it's ‘;’. - Braces can be nested; for example, 'x{A,B{1,2}}y' expands to -'xAy:xB1y:xB2y'. + Braces can be nested; for example, ‘x{A,B{1,2}}y’ expands to +‘xAy:xB1y:xB2y’. Multiple non-nested braces are expanded from right to left; for -example, 'x{A,B}{1,2}y' expands to 'x{A,B}1y:x{A,B}2y', which expands to -'xA1y:xB1y:xA2y:xB2y'. +example, ‘x{A,B}{1,2}y’ expands to ‘x{A,B}1y:x{A,B}2y’, which expands to +‘xA1y:xB1y:xA2y:xB2y’. This feature can be used to implement multiple TeX hierarchies, by -assigning a brace list to '$TEXMF', as mentioned in 'texmf.in'. +assigning a brace list to ‘$TEXMF’, as mentioned in ‘texmf.in’. You can also use the path separator instead of the comma. The last -example could have been written 'x{A:B}{1:2}y' (on Unix). +example could have been written ‘x{A:B}{1:2}y’ (on Unix). Brace expansion is implemented in the source file -'kpathsea/expand.c'. +‘kpathsea/expand.c’. File: kpathsea.info, Node: KPSE_DOT expansion, Next: Subdirectory expansion, Prev: Brace expansion, Up: Path expansion -5.3.5 'KPSE_DOT' expansion +5.3.5 ‘KPSE_DOT’ expansion -------------------------- -When 'KPSE_DOT' is defined in the environment, it names a directory that +When ‘KPSE_DOT’ is defined in the environment, it names a directory that should be considered the current directory for the purpose of looking up -files in the search paths. This feature is needed by the 'mktex...' +files in the search paths. This feature is needed by the ‘mktex...’ scripts *note mktex scripts::, because these change the working directory. You should not ever define it yourself. @@ -795,14 +839,14 @@ directly under D, then the subsubdirectories under those, and so on. At each level, the order in which the directories are searched is unspecified. (It's "directory order", and definitely not alphabetical.) - If you specify any filename components after the '//', only + If you specify any filename components after the ‘//’, only subdirectories which match those components are included. For example, -'/a//b' would expand into directories '/a/1/b', '/a/2/b', '/a/1/1/b', -and so on, but not '/a/b/c' or '/a/1'. +‘/a//b’ would expand into directories ‘/a/1/b’, ‘/a/2/b’, ‘/a/1/1/b’, +and so on, but not ‘/a/b/c’ or ‘/a/1’. - You can include multiple '//' constructs in the path. + You can include multiple ‘//’ constructs in the path. - '//' at the beginning of a path is ignored; you didn't really want to + ‘//’ at the beginning of a path is ignored; you didn't really want to search every directory on the system, did you? I should mention one related implementation trick, which I took from @@ -811,28 +855,28 @@ it. The trick is that in every real Unix implementation (as opposed to the POSIX specification), a directory which contains no subdirectories -will have exactly two links (namely, one for '.' and one for '..'). -That is to say, the 'st_nlink' field in the 'stat' structure will be +will have exactly two links (namely, one for ‘.’ and one for ‘..’). +That is to say, the ‘st_nlink’ field in the ‘stat’ structure will be two. Thus, we don't have to stat everything in the bottom-level (leaf) -directories--we can just check 'st_nlink', notice it's two, and do no +directories--we can just check ‘st_nlink’, notice it's two, and do no more work. But if you have a directory that contains a single subdirectory and -500 regular files, 'st_nlink' will be 3, and Kpathsea has to stat every +500 regular files, ‘st_nlink’ will be 3, and Kpathsea has to stat every one of those 501 entries. Therein lies slowness. - You can disable the trick by undefining 'ST_NLINK_TRICK' in -'kpathsea/config.h'. (It is undefined by default except under Unix.) + You can disable the trick by undefining ‘ST_NLINK_TRICK’ in +‘kpathsea/config.h’. (It is undefined by default except under Unix.) - Unfortunately, in some cases files in leaf directories are 'stat''d: -if the path specification is, say, '$TEXMF/fonts//pk//', then files in a -subdirectory '.../pk', even if it is a leaf, are checked. The reason + Unfortunately, in some cases files in leaf directories are ‘stat’'d: +if the path specification is, say, ‘$TEXMF/fonts//pk//’, then files in a +subdirectory ‘.../pk’, even if it is a leaf, are checked. The reason cannot be explained without reference to the implementation, so read -'kpathsea/elt-dirs.c' (search for 'may descend') if you are curious. +‘kpathsea/elt-dirs.c’ (search for ‘may descend’) if you are curious. And if you find a way to solve the problem, please let me know. Subdirectory expansion is implemented in the source file -'kpathsea/elt-dirs.c'. +‘kpathsea/elt-dirs.c’. File: kpathsea.info, Node: Casefolding search, Next: Filename database, Prev: Path expansion, Up: Path searching @@ -847,8 +891,8 @@ path element allows for checking the filesystem, a second check is made for a case-insensitive match. This is enabled at compile-time on Unix systems, and enabled at -runtime by setting the configuration variable 'texmf_casefold_search', -to a true value, e.g., '1'; this is done by default in TeX Live. +runtime by setting the configuration variable ‘texmf_casefold_search’, +to a true value, e.g., ‘1’; this is done by default in TeX Live. * Menu: @@ -866,7 +910,7 @@ documents between case-insensitive (file)systems and case-sensitive ones. In particular, Apple decided to make the default filesystem on Macs be case-insensitive some years ago, and this has exacerbated a problem of people creating documents that use, say, an image under the -name 'foo.jpg', while the actual file is named 'foo.JPG' or 'Foo.jpg'. +name ‘foo.jpg’, while the actual file is named ‘foo.JPG’ or ‘Foo.jpg’. It works on the Mac but if the document is transferred and run on a standard case-sensitive Unix (file)system, the file can't be found, due only to differences in case. @@ -902,58 +946,58 @@ difficulties in practice. If it's desirable in a given situation to have the exact same search behavior as previously, that can be accomplished by setting the -configuration variable 'texmf_casefold_search' to '0' (*note Path +configuration variable ‘texmf_casefold_search’ to ‘0’ (*note Path sources::). Some examples to illustrate the new behavior follow. - Example #1: suppose the file './foobar.tex' exists. Now, searching -for './FooBar.TeX' (or any other case variation) will succeed, returning -'./foobar.tex'--the name as stored on disk. In previous releases, or if -'texmf_casefold_search' is false, the search would fail. + Example #1: suppose the file ‘./foobar.tex’ exists. Now, searching +for ‘./FooBar.TeX’ (or any other case variation) will succeed, returning +‘./foobar.tex’--the name as stored on disk. In previous releases, or if +‘texmf_casefold_search’ is false, the search would fail. Example #2: suppose we are using a case-sensitive (file)system, and -the search path is '.:/somedir', and the files './foobar.tex' and -'/somedir/FooBar.TeX' both exist. Both now and previously, searching -for 'foobar.tex' returns './foobar.tex'. However, searching for -'FooBar.TeX' now returns './foobar.tex' instead of -'/somedir/FooBar.TeX'; this is the incompatibility mentioned above. -Also (as expected), searching for 'FOOBAR.TEX' (or whatever variation) -will now return './foobar.tex', whereas before it would fail. Searching -for all ('kpsewhich --all') 'foobar.tex' will return both matches. +the search path is ‘.:/somedir’, and the files ‘./foobar.tex’ and +‘/somedir/FooBar.TeX’ both exist. Both now and previously, searching +for ‘foobar.tex’ returns ‘./foobar.tex’. However, searching for +‘FooBar.TeX’ now returns ‘./foobar.tex’ instead of +‘/somedir/FooBar.TeX’; this is the incompatibility mentioned above. +Also (as expected), searching for ‘FOOBAR.TEX’ (or whatever variation) +will now return ‘./foobar.tex’, whereas before it would fail. Searching +for all (‘kpsewhich --all’) ‘foobar.tex’ will return both matches. Example #3: same as example #2, but on a case-insensitive -(file)system: both now and previously, searching for 'FooBar.TeX' -returns './foobar.tex', since the system considers that a match. The +(file)system: both now and previously, searching for ‘FooBar.TeX’ +returns ‘./foobar.tex’, since the system considers that a match. The Kpathsea casefolding never comes into play. Example #4: if we have (on a case-sensitive system) both -'./foobar.tex' and './FOOBAR.TEX', searching with the exact case returns -that exact match, now and previously. Searching for 'FooBar.tex' will +‘./foobar.tex’ and ‘./FOOBAR.TEX’, searching with the exact case returns +that exact match, now and previously. Searching for ‘FooBar.tex’ will now return one or the other (chosen arbitrarily), rather than failing. -Perhaps unexpectedly, searching for all 'foobar.tex' or 'FooBar.tex' +Perhaps unexpectedly, searching for all ‘foobar.tex’ or ‘FooBar.tex’ will also return only one or the other, not both (see more below). - Example #5: the font file 'STIX-Regular.otf' is included in TeX Live -in the system directory 'texmf-dist/fonts/opentype/public/stix'. + Example #5: the font file ‘STIX-Regular.otf’ is included in TeX Live +in the system directory ‘texmf-dist/fonts/opentype/public/stix’. Because Kpathsea never searches the disk in the big system directory, -the casefolding is not done, and a search for 'stix-regular.otf' will +the casefolding is not done, and a search for ‘stix-regular.otf’ will fail (on case-sensitive systems), as it always has. The caveat about not searching the disk amounts to saying that -casefolding does not happen in the trees specified with '!!' (*note -ls-R::), that is, where only database ('ls-R') searching is done. In -TeX Live, that is the 'texmf-local' and 'texmf-dist' trees (also -'$TEXMFSYSCONFIG' and '$TEXMFSYSVAR', but those are rarely noticed). +casefolding does not happen in the trees specified with ‘!!’ (*note +ls-R::), that is, where only database (‘ls-R’) searching is done. In +TeX Live, that is the ‘texmf-local’ and ‘texmf-dist’ trees (also +‘$TEXMFSYSCONFIG’ and ‘$TEXMFSYSVAR’, but those are rarely noticed). The rationale for this is that in practice, case mangling happens with user-created files, not with packages distributed as part of the TeX system. - One more caveat: the purpose of 'kpsewhich' is to exercise the path + One more caveat: the purpose of ‘kpsewhich’ is to exercise the path searching in Kpathsea as it is actually done. Therefore, as shown -above, 'kpsewhich --all' will not return all matches regardless of case +above, ‘kpsewhich --all’ will not return all matches regardless of case within a given path element. If you want to find all matches in all -directories, 'find' is the best tool, although the setup takes a couple +directories, ‘find’ is the best tool, although the setup takes a couple steps: kpsewhich -show-path=tex >/tmp/texpath # search path specification @@ -963,28 +1007,28 @@ steps: Sorry that it's annoyingly lengthy, but implementing this inside Kpathsea would be a lot of error-prone trouble for something that is -only useful for debugging. If your 'find' does not support '-iname', +only useful for debugging. If your ‘find’ does not support ‘-iname’, you can get GNU Find from <https://gnu.org/software/findutils>. The casefolding search is implemented in the source file -'kpathsea/pathsearch.c'. Two implementation points: +‘kpathsea/pathsearch.c’. Two implementation points: - * Kpathsea never tries to check if a given directory resides on a + • Kpathsea never tries to check if a given directory resides on a case-insensitive filesystem, because there is no efficient and portable way to do so. All it does is try to see if a potential - file name is a readable normal file (with, usually, the 'access' + file name is a readable normal file (with, usually, the ‘access’ system call). - * Kpathsea does not do any case-insensitive matching of the + • Kpathsea does not do any case-insensitive matching of the directories along the path. It's not going to find - '/Some/Random/file.tex' when looking for '/some/random/file.tex'. + ‘/Some/Random/file.tex’ when looking for ‘/some/random/file.tex’. The casefolding only happens with the elements of the leaf directory. File: kpathsea.info, Node: Filename database, Next: Invoking kpsewhich, Prev: Casefolding search, Up: Path searching -5.5 Filename database ('ls-R') +5.5 Filename database (‘ls-R’) ============================== Kpathsea goes to some lengths to minimize disk accesses for searches @@ -992,15 +1036,15 @@ Kpathsea goes to some lengths to minimize disk accesses for searches every possible directory in typical TeX installations takes an excessively long time. - Therefore, Kpathsea can use an externally-built "filename database" -file named 'ls-R' that maps files to directories, thus avoiding the need + Therefore, Kpathsea can use an externally-built “filename database” +file named ‘ls-R’ that maps files to directories, thus avoiding the need to exhaustively search the disk. - A second database file 'aliases' allows you to give additional names -to the files listed in 'ls-R'. + A second database file ‘aliases’ allows you to give additional names +to the files listed in ‘ls-R’. - The 'ls-R' and 'aliases' features are implemented in the source file -'kpathsea/db.c'. + The ‘ls-R’ and ‘aliases’ features are implemented in the source file +‘kpathsea/db.c’. * Menu: @@ -1011,77 +1055,77 @@ to the files listed in 'ls-R'. File: kpathsea.info, Node: ls-R, Next: Filename aliases, Up: Filename database -5.5.1 'ls-R' +5.5.1 ‘ls-R’ ------------ -As mentioned above, you must name the main filename database 'ls-R'. +As mentioned above, you must name the main filename database ‘ls-R’. You can put one at the root of each TeX installation hierarchy you wish -to search ('$TEXMF' by default, which expands to a braced list of +to search (‘$TEXMF’ by default, which expands to a braced list of several hierarchies in TeX Live). - Kpathsea looks for 'ls-R' files along the 'TEXMFDBS' path. It is -best for this to contain all and only those hierarchies from '$TEXMF' -which are specified with '!!'--and also to specify them with '!!' in -'TEXMFDBS'. (See the end of this section for more on '!!'.) + Kpathsea looks for ‘ls-R’ files along the ‘TEXMFDBS’ path. It is +best for this to contain all and only those hierarchies from ‘$TEXMF’ +which are specified with ‘!!’--and also to specify them with ‘!!’ in +‘TEXMFDBS’. (See the end of this section for more on ‘!!’.) - The recommended way to create and maintain 'ls-R' is to run the -'mktexlsr' script, which is installed in '$(bindir)' ('/usr/local/bin' + The recommended way to create and maintain ‘ls-R’ is to run the +‘mktexlsr’ script, which is installed in ‘$(bindir)’ (‘/usr/local/bin’ by default). That script goes to some trouble to follow symbolic links -as necessary, etc. It's also invoked by the distributed 'mktex...' +as necessary, etc. It's also invoked by the distributed ‘mktex...’ scripts. - At its simplest, though, you can build 'ls-R' with the command + At its simplest, though, you can build ‘ls-R’ with the command cd /YOUR/TEXMF/ROOT && ls -LAR ./ >ls-R -presuming your 'ls' produces the right output format (see the section -below). GNU 'ls', for example, outputs in this format. Also presuming -your 'ls' hasn't been aliased in a system file (e.g., '/etc/profile') to -something problematic, e.g., 'ls --color=tty'. In that case, you will -have to disable the alias before generating 'ls-R'. For the precise +presuming your ‘ls’ produces the right output format (see the section +below). GNU ‘ls’, for example, outputs in this format. Also presuming +your ‘ls’ hasn't been aliased in a system file (e.g., ‘/etc/profile’) to +something problematic, e.g., ‘ls --color=tty’. In that case, you will +have to disable the alias before generating ‘ls-R’. For the precise definition of the file format, see *note Database format::. Regardless of whether you use the supplied script or your own, you -will almost certainly want to invoke it via 'cron', so when you make +will almost certainly want to invoke it via ‘cron’, so when you make changes in the installed files (say if you install a new LaTeX package), -'ls-R' will be automatically updated. However, for those using TeX Live -or system distributions, the package managers should run 'mktexlsr' as +‘ls-R’ will be automatically updated. However, for those using TeX Live +or system distributions, the package managers should run ‘mktexlsr’ as needed. - The '-A' option to 'ls' includes files beginning with '.' (except for -'.' and '..'), such as the file '.tex' included with the LaTeX tools -package. (On the other hand, _directories_ whose names begin with '.' + The ‘-A’ option to ‘ls’ includes files beginning with ‘.’ (except for +‘.’ and ‘..’), such as the file ‘.tex’ included with the LaTeX tools +package. (On the other hand, _directories_ whose names begin with ‘.’ are always ignored.) - If your system does not support symbolic links, omit the '-L'. + If your system does not support symbolic links, omit the ‘-L’. - 'ls -LAR /YOUR/TEXMF/ROOT' will also work. But using './' avoids + ‘ls -LAR /YOUR/TEXMF/ROOT’ will also work. But using ‘./’ avoids embedding absolute pathnames, so the hierarchy can be easily transported. It also avoids possible trouble with automounters or other network filesystem conventions. - Kpathsea warns you if it finds an 'ls-R' file, but the file does not -contain any usable entries. The usual culprit is running plain 'ls -R' -instead of 'ls -LR ./' or 'ls -R /YOUR/TEXMF/ROOT'. Another possibility -is some system directory name starting with a '.' (perhaps if you are + Kpathsea warns you if it finds an ‘ls-R’ file, but the file does not +contain any usable entries. The usual culprit is running plain ‘ls -R’ +instead of ‘ls -LR ./’ or ‘ls -R /YOUR/TEXMF/ROOT’. Another possibility +is some system directory name starting with a ‘.’ (perhaps if you are using AFS); Kpathsea ignores everything under such directories. - If a particular path element begins with '!!', _only_ the database + If a particular path element begins with ‘!!’, _only_ the database will be searched for that element, never the disk; and if the database does not exist, nothing at all will be searched. In TeX Live, most of -the trees are specified with '!!'. +the trees are specified with ‘!!’. - For path elements that do not begin with '!!', if the database + For path elements that do not begin with ‘!!’, if the database exists, it will be used, and the disk will not be searched. However, in this case, if the database does not exist, the disk will be searched. -In TeX Live, the most notable case of this is the 'TEXMFHOME' tree, to +In TeX Live, the most notable case of this is the ‘TEXMFHOME’ tree, to allow users to add and remove files from their own tree without having -to worry about 'ls-R'. +to worry about ‘ls-R’. - (Aside: there are uncommon cases where a '!!' tree will be searched -on disk even if the 'ls-R' file exists; they are too obscure to try to -explain here. See 'pathsearch.c' in the source if you need to know.) + (Aside: there are uncommon cases where a ‘!!’ tree will be searched +on disk even if the ‘ls-R’ file exists; they are too obscure to try to +explain here. See ‘pathsearch.c’ in the source if you need to know.) - To sum up: do not create an 'ls-R' file unless you also take care to + To sum up: do not create an ‘ls-R’ file unless you also take care to keep it up to date. Otherwise newly-installed files will not be found. @@ -1092,24 +1136,24 @@ File: kpathsea.info, Node: Filename aliases, Next: Database format, Prev: ls- In some circumstances, you may wish to find a file under several names. For example, suppose a TeX document was created using a DOS system and -tries to read 'longtabl.sty'. But now it's being run on a Unix system, -and the file has its original name, 'longtable.sty'. The file won't be -found. You need to give the actual file 'longtable.sty' an alias -'longtabl.sty'. +tries to read ‘longtabl.sty’. But now it's being run on a Unix system, +and the file has its original name, ‘longtable.sty’. The file won't be +found. You need to give the actual file ‘longtable.sty’ an alias +‘longtabl.sty’. - You can handle this by creating a file 'aliases' as a companion to -the 'ls-R' for the hierarchy containing the file in question. (You must -have an 'ls-R' for the alias feature to work.) + You can handle this by creating a file ‘aliases’ as a companion to +the ‘ls-R’ for the hierarchy containing the file in question. (You must +have an ‘ls-R’ for the alias feature to work.) - The format of 'aliases' is simple: two whitespace-separated words per -line; the first is the real name 'longtable.sty', and second is the -alias ('longtabl.sty'). These must be base filenames, with no directory -components. 'longtable.sty' must be in the sibling 'ls-R'. + The format of ‘aliases’ is simple: two whitespace-separated words per +line; the first is the real name ‘longtable.sty’, and second is the +alias (‘longtabl.sty’). These must be base filenames, with no directory +components. ‘longtable.sty’ must be in the sibling ‘ls-R’. - Also, blank lines and lines starting with '%' or '#' are ignored in -'aliases', to allow for comments. + Also, blank lines and lines starting with ‘%’ or ‘#’ are ignored in +‘aliases’, to allow for comments. - If a real file 'longtabl.sty' exists, it is used regardless of any + If a real file ‘longtabl.sty’ exists, it is used regardless of any aliases. @@ -1119,21 +1163,21 @@ File: kpathsea.info, Node: Database format, Prev: Filename aliases, Up: Filen --------------------- The "database" read by Kpathsea is a line-oriented file of plain text. -The format is that generated by GNU (and most other) 'ls' programs given -the '-R' option, as follows. +The format is that generated by GNU (and most other) ‘ls’ programs given +the ‘-R’ option, as follows. - * Blank lines are ignored. + • Blank lines are ignored. - * If a line begins with '/' or './' or '../' and ends with a colon, - it's the name of a directory. ('../' lines aren't useful, however, + • If a line begins with ‘/’ or ‘./’ or ‘../’ and ends with a colon, + it's the name of a directory. (‘../’ lines aren't useful, however, and should not be generated.) - * All other lines define entries in the most recently seen directory. + • All other lines define entries in the most recently seen directory. /'s in such lines will produce possibly-strange results. - * Files with no preceding directory line are ignored. + • Files with no preceding directory line are ignored. - For example, here's the first few lines of 'ls-R' (which totals about + For example, here's the first few lines of ‘ls-R’ (which totals about 30K bytes) on my system: bibtex @@ -1158,21 +1202,21 @@ the '-R' option, as follows. File: kpathsea.info, Node: Invoking kpsewhich, Prev: Filename database, Up: Path searching -5.6 'kpsewhich': Standalone path searching +5.6 ‘kpsewhich’: Standalone path searching ========================================== The Kpsewhich program exercises the path searching functionality independent of any particular application. This can also be useful as a -sort of 'find' program to locate files in your TeX hierarchies, perhaps +sort of ‘find’ program to locate files in your TeX hierarchies, perhaps in administrative scripts. It is used heavily in the distributed -'mktex...' scripts. +‘mktex...’ scripts. Synopsis: kpsewhich OPTION... FILENAME... The options and filename(s) to look up can be intermixed. Options -can start with either '-' or '--', and any unambiguous abbreviation is +can start with either ‘-’ or ‘--’, and any unambiguous abbreviation is accepted. * Menu: @@ -1180,7 +1224,7 @@ accepted. * Path searching options:: Changing the mode, resolution, etc. * Specially-recognized files:: Default formats for texmf.cnf, etc. * Auxiliary tasks:: Path and variable expansion, etc. -* Standard options:: '--help' and '--version'. +* Standard options:: ‘--help’ and ‘--version’. File: kpathsea.info, Node: Path searching options, Next: Specially-recognized files, Up: Invoking kpsewhich @@ -1193,72 +1237,73 @@ filename, and returns the first file found. Various options alter the path searching behavior: -'--all' +‘--all’ Report all matches found, one per line. By default, if there is more than one match, just one will be reported (chosen effectively - at random). Exception: with the glyph formats ('pk', 'gf'), this + at random). Exception: with the glyph formats (‘pk’, ‘gf’), this option has no effect and only the first match is returned. -'--casefold-search' -'--no-casefold-search' +‘--casefold-search’ +‘--no-casefold-search’ Explicitly enable or disable the fallback to a case-insensitive search on Unix platforms (*note Casefolding search::); no effect on - Windows. The default is enabled, set in 'texmf.cnf'. Disabling - ('--no-casefold-search') does not mean that searches magically + Windows. The default is enabled, set in ‘texmf.cnf’. Disabling + (‘--no-casefold-search’) does not mean that searches magically become case-sensitive when the underlying (file)system is case-insensitive, it merely means that Kpathsea does not do any casefolding itself. -'--cnf-line=STR' - Parse STR as if it were a line in the 'texmf.cnf' configuration +‘--cnf-line=STR’ + Parse STR as if it were a line in the ‘texmf.cnf’ configuration file (*note Config files::), overriding settings in the actual configuration files, and also in the environment (*note Path sources::). This is implemented by making any settings from STR in the environment, overwriting any value already there. Thus, an - extra colon in a '--cnf-line' value will refer to the value from a + extra colon in a ‘--cnf-line’ value will refer to the value from a configuration file, not a user-set environment variable. Furthermore, any variable set from STR will also be set with the - program name suffix. For example, 'pdftex - --cnf-line=TEXINPUTS=/foo:' will set both 'TEXINPUTS' and - 'TEXINPUTS_pdftex' in the environment (and the value will be '/foo' - followed by the setting from 'texmf.cnf', ignoring any user-set - 'TEXINPUTS'). + program name suffix. For example, ‘pdftex + --cnf-line=TEXINPUTS=/foo:’ will set both ‘TEXINPUTS’ and + ‘TEXINPUTS_pdftex’ in the environment (and the value will be ‘/foo’ + followed by the setting from ‘texmf.cnf’, ignoring any user-set + ‘TEXINPUTS’). This behavior is desirable because, in practice, many variables in - the distributed 'texmf.cnf' are program-specific, and the intuitive - behavior is for values set on the command line with '--cnf-line' to + the distributed ‘texmf.cnf’ are program-specific, and the intuitive + behavior is for values set on the command line with ‘--cnf-line’ to override them. -'--dpi=NUM' - Set the resolution to NUM; this only affects 'gf' and 'pk' lookups. - '-D' is a synonym, for compatibility with Dvips. Default is 600. - -'--engine=NAME' - Set the engine name to NAME. By default it is not set. The engine - name is used in some search paths to allow files with the same name - but used by different engines to coexist. - - In particular, since the memory dump files ('.fmt'/'.base'/'.mem') - are now stored in subdirectories named for the engine ('tex', - 'pdftex', 'xetex', etc.), you must specify an engine name in order - to find them. For example, 'cont-en.fmt' typically exists for both - 'pdftex' and 'xetex'. With the default path settings, you can use - '--engine=/' to look for any dump file, regardless of engine; if a +‘--dpi=NUM’ + Set the resolution to NUM; this only affects ‘gf’ and ‘pk’ lookups. + ‘-D’ is a synonym, for compatibility with Dvips. Default is 600. + +‘--engine=NAME’ + Set the engine name to NAME. By default it is not set in + ‘kpsewhich’ (TeX engines set it to the appropriate string). The + engine name is used in some search paths to allow files with the + same name but used by different engines to coexist. + + In particular, since the memory dump files (‘.fmt’/‘.base’/‘.mem’) + are now stored in subdirectories named for the engine (‘tex’, + ‘pdftex’, ‘xetex’, etc.), you must specify an engine name in order + to find them. For example, ‘cont-en.fmt’ typically exists for both + ‘pdftex’ and ‘xetex’. With the default path settings, you can use + ‘--engine=/’ to look for any dump file, regardless of engine; if a dump file exists for more than one engine, it's indeterminate which - one is returned. (The '/' ends up specifying a normal recursive + one is returned. (The ‘/’ ends up specifying a normal recursive search along the path where the dumps are stored, namely - '$TEXMF/web2c{/$engine,}'.) + ‘$TEXMF/web2c{/$engine,}’.) -'--format=NAME' +‘--format=NAME’ Set the format for lookup to NAME. By default, the format is - guessed from the filename, with 'tex' being used if nothing else + guessed from the filename, with ‘tex’ being used if nothing else fits. The recognized filename extensions (including any leading - '.') are also allowable NAMEs. + ‘.’) are also allowable NAMEs. All formats also have a name, which is the only way to specify formats with no associated suffix. For example, for Dvips - configuration files you can use '--format="dvips config"'. (The + configuration files you can use ‘--format="dvips config"’. (The quotes are for the sake of the shell.) Here's the current list of recognized names and the associated @@ -1266,7 +1311,7 @@ filename, and returns the first file found. each of these. The strings in parentheses are abbreviations recognized only by - 'kpsewhich' (not the underlying library calls). They are provided + ‘kpsewhich’ (not the underlying library calls). They are provided when it would otherwise require an argument containing a space to specify the format, to simplify quoting of calls from shells. @@ -1330,152 +1375,152 @@ filename, and returns the first file found. ris: .ris bltxml: .bltxml - This option and '--path' are mutually exclusive. + This option and ‘--path’ are mutually exclusive. -'--interactive' +‘--interactive’ After processing the command line, read additional filenames to look up from standard input. -'--mktex=FILETYPE' -'--no-mktex=FILETYPE' - Turn on or off the 'mktex' script associated with FILETYPE. Usual - values for FILETYPE are 'pk', 'mf', 'tex', and 'tfm'. By default, +‘--mktex=FILETYPE’ +‘--no-mktex=FILETYPE’ + Turn on or off the ‘mktex’ script associated with FILETYPE. Usual + values for FILETYPE are ‘pk’, ‘mf’, ‘tex’, and ‘tfm’. By default, all are off in Kpsewhich, even if they are enabled for TeX. This - option implies setting '--must-exist'. *Note mktex scripts::. + option implies setting ‘--must-exist’. *Note mktex scripts::. -'--mode=STRING' - Set the mode name to STRING; this also only affects 'gf' and 'pk' +‘--mode=STRING’ + Set the mode name to STRING; this also only affects ‘gf’ and ‘pk’ lookups. No default: any mode will be found. *Note mktex script arguments::. -'--must-exist' +‘--must-exist’ Do everything possible to find the files, notably including - searching the disk and running the 'mktex' scripts. By default, - only the 'ls-R' database is checked, in the interest of efficiency. + searching the disk and running the ‘mktex’ scripts. By default, + only the ‘ls-R’ database is checked, in the interest of efficiency. -'--path=STRING' +‘--path=STRING’ Search along the path STRING (colon-separated as usual), instead of - guessing the search path from the filename. '//' and all the usual + guessing the search path from the filename. ‘//’ and all the usual expansions are supported (*note Path expansion::). This option and - '--format' are mutually exclusive. To output the complete + ‘--format’ are mutually exclusive. To output the complete directory expansion of a path, instead of doing a one-shot lookup, - see '--expand-path' and '--show-path' in the following section. + see ‘--expand-path’ and ‘--show-path’ in the following section. -'--progname=NAME' - Set the program name to NAME; default is 'kpsewhich'. This can - affect the search paths via the '.PROGNAM' feature in configuration +‘--progname=NAME’ + Set the program name to NAME; default is ‘kpsewhich’. This can + affect the search paths via the ‘.PROGNAM’ feature in configuration files (*note Config files::). -'--subdir=STRING' +‘--subdir=STRING’ Report only those matches whose directory part _ends_ with STRING (compared literally, except case is ignored on a case-insensitive operating system). For example, suppose there are two matches for a given name: kpsewhich foo.sty - => /some/where/foo.sty + ⇒ /some/where/foo.sty /another/place/foo.sty Then we can narrow the result to what we are interested in with - '--subdir': + ‘--subdir’: kpsewhich --subdir=where foo.sty - => /some/where/foo.sty + ⇒ /some/where/foo.sty kpsewhich --subdir=place foo.sty - => /another/place/foo.sty + ⇒ /another/place/foo.sty The string to match must be at the end of the directory part of the match, and it is taken literally, with no pattern matching: kpsewhich --subdir=another foo.sty - => + ⇒ The string to match may cross directory components: kpsewhich --subdir=some/where foo.sty - => /some/where/foo.sty + ⇒ /some/where/foo.sty - '--subdir' implies '--all'; if there is more than one match, they - will all be reported (in our example, both 'where' and 'place' end - in 'e'): + ‘--subdir’ implies ‘--all’; if there is more than one match, they + will all be reported (in our example, both ‘where’ and ‘place’ end + in ‘e’): kpsewhich --subdir=e - => /some/where/foo.sty + ⇒ /some/where/foo.sty /another/place/foo.sty - Because of the above rules, the presence of a leading '/' is + Because of the above rules, the presence of a leading ‘/’ is important, since it "anchors" the match to a full component name: kpsewhich --subdir=/lace foo.sty - => + ⇒ - However, a trailing '/' is immaterial (and ignored), since the + However, a trailing ‘/’ is immaterial (and ignored), since the match always takes place at the end of the directory part: kpsewhich --subdir=lace/ foo.sty - => /another/place/foo.sty + ⇒ /another/place/foo.sty The purpose of these rules is to make it convenient to find results only within a particular area of the tree. For instance, a given - script named 'foo.lua' might exist within both - 'texmf-dist/scripts/pkg1/' and 'texmf-dist/scripts/pkg2/'. By - specifying, say, '--subdir=/pkg1', you can be sure of getting the + script named ‘foo.lua’ might exist within both + ‘texmf-dist/scripts/pkg1/’ and ‘texmf-dist/scripts/pkg2/’. By + specifying, say, ‘--subdir=/pkg1’, you can be sure of getting the one you are interested in. We only match at the end because a site might happen to install TeX - in '/some/coincidental/pkg1/path/', and we wouldn't want to match - 'texmf-dist/scripts/pkg2/' that when searching for '/pkg1'. + in ‘/some/coincidental/pkg1/path/’, and we wouldn't want to match + ‘texmf-dist/scripts/pkg2/’ that when searching for ‘/pkg1’. File: kpathsea.info, Node: Specially-recognized files, Next: Auxiliary tasks, Prev: Path searching options, Up: Invoking kpsewhich -5.6.2 Specially-recognized files for 'kpsewhich' +5.6.2 Specially-recognized files for ‘kpsewhich’ ------------------------------------------------ -'kpsewhich' recognizes a few special filenames on the command line and +‘kpsewhich’ recognizes a few special filenames on the command line and defaults to using the 'known' file formats for them, merely to save the time and trouble of specifying the format. This is only a feature of -'kpsewhich'; when using the Kpathsea library itself, none of these +‘kpsewhich’; when using the Kpathsea library itself, none of these special filenames are recognized, and it's still up to the caller to specify the desired format. - Here is the list of special filenames to 'kpsewhich', along with + Here is the list of special filenames to ‘kpsewhich’, along with their corresponding format: -'config.ps' - 'dvips config' +‘config.ps’ + ‘dvips config’ -'dvipdfmx.cfg' - 'other text files' +‘dvipdfmx.cfg’ + ‘other text files’ -'fmtutil.cnf' - 'web2c files' +‘fmtutil.cnf’ + ‘web2c files’ -'glyphlist.txt' - 'map' +‘glyphlist.txt’ + ‘map’ -'mktex.cnf' - 'web2c files' +‘mktex.cnf’ + ‘web2c files’ -'pdfglyphlist.txt' - 'map' +‘pdfglyphlist.txt’ + ‘map’ -'pdftex.cfg' - 'pdftex config' (although 'pdftex.cfg' is not used any more; look - for the file 'pdftexconfig.tex' instead.) +‘pdftex.cfg’ + ‘pdftex config’ (although ‘pdftex.cfg’ is not used any more; look + for the file ‘pdftexconfig.tex’ instead.) -'texmf.cnf' - 'cnf' +‘texmf.cnf’ + ‘cnf’ -'XDvi' - 'other text files' +‘XDvi’ + ‘other text files’ A user-specified format will override the above defaults. - Another useful configuration file in this regard is 'tcfmgr.map', -found in 'texmf/texconfig/tcfmgr.map', which records various information -about the above configuration files (among others). + Another reference for information about TeX's many special files is +‘tcfmgr.map’, found in ‘texmf/texconfig/tcfmgr.map’, which records +various information about the above configuration files (among others). File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Specially-recognized files, Up: Invoking kpsewhich @@ -1485,84 +1530,90 @@ File: kpathsea.info, Node: Auxiliary tasks, Next: Standard options, Prev: Spe Kpsewhich provides some features in addition to path lookup as such: -'--debug=NUM' +‘--debug=NUM’ Set debugging options to NUM. *Note Debugging::. -'--expand-braces=STRING' +‘--expand-braces=STRING’ Output variable, tilde, and brace expansion of STRING, which is assumed to be a single path element. *Note Path expansion::. -'--expand-path=STRING' +‘--expand-path=STRING’ Output the complete expansion of STRING, with each element - separated by the usual path separator on the current system (';' on - Windows, ':' otherwise). This may be useful to construct a custom + separated by the usual path separator on the current system (‘;’ on + Windows, ‘:’ otherwise). This may be useful to construct a custom search path for a format not otherwise supported. To retrieve the search path for a format that is already supported, see - '--show-path'. + ‘--show-path’. Nonexistent directories are culled from the output: $ kpsewhich --expand-path '/tmp' - => /tmp + ⇒ /tmp $ kpsewhich --expand-path '/nonesuch' - => + ⇒ For one-shot uses of an arbitrary (not built in to Kpathsea) path, - see '--path' (*note Path searching options::). + see ‘--path’ (*note Path searching options::). -'--expand-var=STRING' +‘--expand-var=STRING’ Output the variable and tilde expansion of STRING. For example, - with the usual 'texmf.cnf', 'kpsewhich --expand-var='$TEXMF'' + with the usual ‘texmf.cnf’, ‘kpsewhich --expand-var='$TEXMF'’ returns the TeX system hierarchy root(s). *Note Path expansion::. The specified STRING can contain anything, though, not just - variable references. This calls 'kpse_var_expand' (*note + variable references. This calls ‘kpse_var_expand’ (*note Programming with config files::). -'--help-formats' +‘--help-formats’ Output information about each supported format (*note Supported file formats::), including the names and abbreviations, variables looked for, and the original path. -'--safe-in-name=NAME' -'--safe-out-name=NAME' +‘--safe-extended-in-name=NAME’ +‘--safe-extended-out-name=NAME’ + As with ‘--safe-in-name’ and ‘--safe-out-name’ (next item), but + also allow files under the variables ‘TEXMFVAR’ and ‘TEXMFSYSVAR’ + (*note Calling sequence::). + +‘--safe-in-name=NAME’ +‘--safe-out-name=NAME’ Exit successfully if NAME is safe to open for reading or writing, - respectively, else unsuccessfully. No output is written. These + respectively, else unsuccessfully. No errors are output. These tests take account of the related Kpathsea configuration settings (*note Calling sequence::). -'--show-path=NAME' +‘--show-path=NAME’ Show the path that would be used for file lookups of file type - NAME. Either a filename extension ('pk', '.vf', etc.) or an - integer can be used, just as with '--format', described in the + NAME. Either a filename extension (‘pk’, ‘.vf’, etc.) or an + integer can be used, just as with ‘--format’, described in the previous section. -'--var-brace-value=VARIABLE' - Like '--var-value' (next), but also expands '{...}' constructs. +‘--var-brace-value=VARIABLE’ + Like ‘--var-value’ (next), but also expands ‘{...}’ constructs. (*note Brace expansion::). Thus, the value is assumed to possibly - be several path elements, and '~' is expanded at the beginning of + be several path elements, and ‘~’ is expanded at the beginning of each. The path separator is changed to that of the current system in the expansion. - Example: 'FOO='.;~' kpsewhich --var-brace-value=FOO' outputs (on a - Unix-ish system) '.:/home/karl', supposing the latter is the - current user's home directory. Note that the ';' in the source - value, as commonly used in 'texmf.cnf', has changed to a ':', as + Example: ‘FOO='.;~' kpsewhich --var-brace-value=FOO’ outputs (on a + Unix-ish system) ‘.:/home/karl’, supposing the latter is the + current user's home directory. Note that the ‘;’ in the source + value, as commonly used in ‘texmf.cnf’, has changed to a ‘:’, as the normal path separator on the current system. On a Windows-ish - system, the ';' would remain. + system, the ‘;’ would remain. -'--var-value=VARIABLE' +‘--var-value=VARIABLE’ Outputs the value of VARIABLE (a simple identifier like - 'TEXMFDIST', with no '$' or other constructs), expanding '$' (*note - Variable expansion::) and '~' (*note Tilde expansion::) constructs - in the value. '~' expansion happens at the beginning of the + ‘TEXMFDIST’, with no ‘$’ or other constructs), expanding ‘$’ (*note + Variable expansion::) and ‘~’ (*note Tilde expansion::) constructs + in the value. ‘~’ expansion happens at the beginning of the overall value and at the beginning of a variable expansion, but not arbitrarily within the string. Braces are not expanded. - Example: '--var-value=texmf_casefold_search' outputs (if the - default is not changed) '1'. + Example: ‘--var-value=texmf_casefold_search’ outputs (if the + default is not changed) ‘1’. - Example to contrast with '--var-brace-value': 'FOO='.;~' kpsewhich - --var-value=FOO' outputs '.;~', i.e., the same as the input value, + Example to contrast with ‘--var-brace-value’: ‘FOO='.;~' kpsewhich + --var-value=FOO’ outputs ‘.;~’, i.e., the same as the input value, on all systems. @@ -1573,10 +1624,10 @@ File: kpathsea.info, Node: Standard options, Prev: Auxiliary tasks, Up: Invok Kpsewhich accepts the standard GNU options: - * '--help' prints a help message on standard output and exits + • ‘--help’ prints a help message on standard output and exits successfully. - * '--version' prints the Kpathsea version number and exits + • ‘--version’ prints the Kpathsea version number and exits successfully. @@ -1600,7 +1651,7 @@ particularly). Kpathsea provides a standard way to search for files of any of the supported file types; glyph fonts are a bit different than all the rest. Searches are based solely on names of files, not their contents--if a GF -file is (mis)named 'cmr10.600pk', it will be found as a PK file. +file is (mis)named ‘cmr10.600pk’, it will be found as a PK file. * Menu: @@ -1623,253 +1674,253 @@ finding files (see the next section). Some also define additional suffixes, and/or a program to be run to create missing files on the fly. Since environment variables containing periods, such as -'TEXINPUTS.latex', are not allowed on some systems, Kpathsea looks for -environment variables with an underscore, e.g., 'TEXINPUTS_latex' (*note +‘TEXINPUTS.latex’, are not allowed on some systems, Kpathsea looks for +environment variables with an underscore, e.g., ‘TEXINPUTS_latex’ (*note Config files::). The following table lists the above information. You can also get -the list by giving the '--help-formats' option to 'kpsewhich' (*note +the list by giving the ‘--help-formats’ option to ‘kpsewhich’ (*note Auxiliary tasks::). -'afm' - (Adobe font metrics, *note (dvips)Metric files::) 'AFMFONTS'; - suffix '.afm'. +‘afm’ + (Adobe font metrics, *note (dvips)Metric files::) ‘AFMFONTS’; + suffix ‘.afm’. -'base' - (Metafont memory dump, *note (web2c)Memory dumps::) 'MFBASES', - 'TEXMFINI'; suffix '.base'. +‘base’ + (Metafont memory dump, *note (web2c)Memory dumps::) ‘MFBASES’, + ‘TEXMFINI’; suffix ‘.base’. -'bib' +‘bib’ (BibTeX bibliography source, *note (web2c)bibtex invocation::) - 'BIBINPUTS', 'TEXBIB'; suffix '.bib'. + ‘BIBINPUTS’, ‘TEXBIB’; suffix ‘.bib’. -'bltxml' +‘bltxml’ (BibLaTeXML bibliography files for Biber, - <https://ctan.org/pkg/biber>) 'BLTXMLINPUTS' suffix '.bltxml'. + <https://ctan.org/pkg/biber>) ‘BLTXMLINPUTS’ suffix ‘.bltxml’. -'bst' +‘bst’ (BibTeX style, *note Basic BibTeX style files: (web2c)Basic BibTeX - style files.) 'BSTINPUTS'; suffix '.bst'. + style files.) ‘BSTINPUTS’; suffix ‘.bst’. -'clua' +‘clua’ (dynamic libraries for Lua, <https://ctan.org/pkg/luatex>) - 'CLUAINPUTS' suffixes '.dll' and '.so'. + ‘CLUAINPUTS’ suffixes ‘.dll’ and ‘.so’. -'cmap' - (character map files) 'CMAPFONTS'; suffix '.cmap'. +‘cmap’ + (character map files) ‘CMAPFONTS’; suffix ‘.cmap’. -'cnf' - (Runtime configuration files, *note Config files::) 'TEXMFCNF'; - suffix '.cnf'. +‘cnf’ + (Runtime configuration files, *note Config files::) ‘TEXMFCNF’; + suffix ‘.cnf’. -'cweb' - (CWEB input files) 'CWEBINPUTS'; suffixes '.w', '.web'; additional - suffix '.ch'. +‘cweb’ + (CWEB input files) ‘CWEBINPUTS’; suffixes ‘.w’, ‘.web’; additional + suffix ‘.ch’. -'dvips config' - (Dvips 'config.*' files, such as 'config.ps', *note (dvips)Config - files::) 'TEXCONFIG'. +‘dvips config’ + (Dvips ‘config.*’ files, such as ‘config.ps’, *note (dvips)Config + files::) ‘TEXCONFIG’. -'enc files' - (encoding vectors) 'ENCFONTS'; suffix '.enc'. +‘enc files’ + (encoding vectors) ‘ENCFONTS’; suffix ‘.enc’. -'fmt' - (TeX memory dump, *note (web2c)Memory dumps::) 'TEXFORMATS', - 'TEXMFINI'; suffix '.fmt'. +‘fmt’ + (TeX memory dump, *note (web2c)Memory dumps::) ‘TEXFORMATS’, + ‘TEXMFINI’; suffix ‘.fmt’. -'font cid map' - (CJK mapping) 'FONTCIDMAPS' suffix '.cid'. +‘font cid map’ + (CJK mapping) ‘FONTCIDMAPS’ suffix ‘.cid’. -'font feature files' - (primarily for OpenType font features) 'FONTFEATURES' suffix - '.fea'. +‘font feature files’ + (primarily for OpenType font features) ‘FONTFEATURES’ suffix + ‘.fea’. -'gf' - (generic font bitmap, *note (dvips)Glyph files::) 'PROGRAMFONTS', - 'GFFONTS', 'GLYPHFONTS', 'TEXFONTS'; suffix 'gf'. +‘gf’ + (generic font bitmap, *note (dvips)Glyph files::) ‘PROGRAMFONTS’, + ‘GFFONTS’, ‘GLYPHFONTS’, ‘TEXFONTS’; suffix ‘gf’. -'graphic/figure' +‘graphic/figure’ (Encapsulated PostScript figures, *note (dvips)PostScript - figures::) 'TEXPICTS', 'TEXINPUTS'; additional suffixes: '.eps', - '.epsi'. + figures::) ‘TEXPICTS’, ‘TEXINPUTS’; additional suffixes: ‘.eps’, + ‘.epsi’. -'ist' - (makeindex style files) 'TEXINDEXSTYLE', 'INDEXSTYLE'; suffix - '.ist'. +‘ist’ + (makeindex style files) ‘TEXINDEXSTYLE’, ‘INDEXSTYLE’; suffix + ‘.ist’. -'lig files' - (ligature definition files) 'LIGFONTS'; suffix '.lig'. +‘lig files’ + (ligature definition files) ‘LIGFONTS’; suffix ‘.lig’. -'ls-R' - (Filename databases, *note Filename database::) 'TEXMFDBS'. +‘ls-R’ + (Filename databases, *note Filename database::) ‘TEXMFDBS’. -'lua' - (Lua scripts, <https://ctan.org/pkg/luatex>) 'LUAINPUTS' suffixes - '.lua', '.luatex', '.luc', '.luctex', '.texlua', '.texluc', '.tlu'. +‘lua’ + (Lua scripts, <https://ctan.org/pkg/luatex>) ‘LUAINPUTS’ suffixes + ‘.lua’, ‘.luatex’, ‘.luc’, ‘.luctex’, ‘.texlua’, ‘.texluc’, ‘.tlu’. -'map' - (Fontmaps, *note Fontmap::) 'TEXFONTMAPS'; suffix '.map'. +‘map’ + (Fontmaps, *note Fontmap::) ‘TEXFONTMAPS’; suffix ‘.map’. -'mem' - (MetaPost memory dump, *note (web2c)Memory dumps::) 'MPMEMS', - 'TEXMFINI'; suffix '.mem'. +‘mem’ + (MetaPost memory dump, *note (web2c)Memory dumps::) ‘MPMEMS’, + ‘TEXMFINI’; suffix ‘.mem’. -'MetaPost support' +‘MetaPost support’ (MetaPost support files, used by DMP; *note (web2c)dmp - invocation::) 'MPSUPPORT'. + invocation::) ‘MPSUPPORT’. -'mf' - (Metafont source, *note (web2c)mf invocation::) 'MFINPUTS'; suffix - '.mf'; dynamic creation program: 'mktexmf'. +‘mf’ + (Metafont source, *note (web2c)mf invocation::) ‘MFINPUTS’; suffix + ‘.mf’; dynamic creation program: ‘mktexmf’. -'mfpool' +‘mfpool’ (Metafont program strings, *note (web2c)pooltype invocation::) - 'MFPOOL', 'TEXMFINI'; suffix '.pool'. + ‘MFPOOL’, ‘TEXMFINI’; suffix ‘.pool’. -'mft' - ('MFT' style file, *note (web2c)mft invocation::) 'MFTINPUTS'; - suffix '.mft'. +‘mft’ + (‘MFT’ style file, *note (web2c)mft invocation::) ‘MFTINPUTS’; + suffix ‘.mft’. -'misc fonts' +‘misc fonts’ (font-related files that don't fit the other categories) - 'MISCFONTS' + ‘MISCFONTS’ -'mlbib' - (MlBibTeX bibliography source) 'MLBIBINPUTS', 'BIBINPUTS', - 'TEXBIB'; suffixes '.mlbib', '.mlbib'. +‘mlbib’ + (MlBibTeX bibliography source) ‘MLBIBINPUTS’, ‘BIBINPUTS’, + ‘TEXBIB’; suffixes ‘.mlbib’, ‘.mlbib’. -'mlbst' - (MlBibTeX style) 'MLBSTINPUTS', 'BSTINPUTS'; suffixes '.mlbst', - '.bst'. +‘mlbst’ + (MlBibTeX style) ‘MLBSTINPUTS’, ‘BSTINPUTS’; suffixes ‘.mlbst’, + ‘.bst’. -'mp' - (MetaPost source, *note (web2c)mpost invocation::) 'MPINPUTS'; - suffix '.mp'. +‘mp’ + (MetaPost source, *note (web2c)mpost invocation::) ‘MPINPUTS’; + suffix ‘.mp’. -'mppool' +‘mppool’ (MetaPost program strings, *note (web2c)pooltype invocation::) - 'MPPOOL', 'TEXMFINI'; suffix '.pool'. + ‘MPPOOL’, ‘TEXMFINI’; suffix ‘.pool’. -'ocp' - (Omega compiled process files) 'OCPINPUTS'; - suffix '.ocp'; dynamic creation program: 'MakeOmegaOCP'. +‘ocp’ + (Omega compiled process files) ‘OCPINPUTS’; + suffix ‘.ocp’; dynamic creation program: ‘MakeOmegaOCP’. -'ofm' - (Omega font metrics) 'OFMFONTS', 'TEXFONTS'; - suffixes '.ofm', '.tfm'; dynamic creation program: 'MakeOmegaOFM'. +‘ofm’ + (Omega font metrics) ‘OFMFONTS’, ‘TEXFONTS’; + suffixes ‘.ofm’, ‘.tfm’; dynamic creation program: ‘MakeOmegaOFM’. -'opentype fonts' - (OpenType fonts) 'OPENTYPEFONTS'. +‘opentype fonts’ + (OpenType fonts) ‘OPENTYPEFONTS’. -'opl' - (Omega property lists) 'OPLFONTS', 'TEXFONTS'; suffix '.opl'. +‘opl’ + (Omega property lists) ‘OPLFONTS’, ‘TEXFONTS’; suffix ‘.opl’. -'otp' - (Omega translation process files) 'OTPINPUTS'; suffix '.otp'. +‘otp’ + (Omega translation process files) ‘OTPINPUTS’; suffix ‘.otp’. -'ovf' - (Omega virtual fonts) 'OVFFONTS', 'TEXFONTS'; suffix '.ovf'. +‘ovf’ + (Omega virtual fonts) ‘OVFFONTS’, ‘TEXFONTS’; suffix ‘.ovf’. -'ovp' - (Omega virtual property lists) 'OVPFONTS', 'TEXFONTS'; suffix - '.ovp'. +‘ovp’ + (Omega virtual property lists) ‘OVPFONTS’, ‘TEXFONTS’; suffix + ‘.ovp’. -'pdftex config' - (PDFTeX-specific configuration files) 'PDFTEXCONFIG'. +‘pdftex config’ + (PDFTeX-specific configuration files) ‘PDFTEXCONFIG’. -'pk' - (packed bitmap fonts, *note (dvips)Glyph files::) 'PROGRAMFONTS' - (PROGRAM being 'XDVI', etc.), 'PKFONTS', 'TEXPKS', 'GLYPHFONTS', - 'TEXFONTS'; suffix 'pk'; dynamic creation program: 'mktexpk'. +‘pk’ + (packed bitmap fonts, *note (dvips)Glyph files::) ‘PROGRAMFONTS’ + (PROGRAM being ‘XDVI’, etc.), ‘PKFONTS’, ‘TEXPKS’, ‘GLYPHFONTS’, + ‘TEXFONTS’; suffix ‘pk’; dynamic creation program: ‘mktexpk’. -'PostScript header' +‘PostScript header’ (downloadable PostScript, *note (dvips)Header files::) - 'TEXPSHEADERS', 'PSHEADERS'; additional suffix '.pro'. + ‘TEXPSHEADERS’, ‘PSHEADERS’; additional suffix ‘.pro’. -'ris' +‘ris’ (RIS bibliography files, primarily for Biber, - <https://ctan.org/pkg/biber>) 'RISINPUTS' suffix '.ris'. + <https://ctan.org/pkg/biber>) ‘RISINPUTS’ suffix ‘.ris’. -'subfont definition files' - (subfont definition files) 'SFDFONTS' suffix '.sfd'. +‘subfont definition files’ + (subfont definition files) ‘SFDFONTS’ suffix ‘.sfd’. -'tex' - (TeX source, *note (web2c)tex invocation::) 'TEXINPUTS'; suffix - '.tex'; additional suffixes: none, because such a list cannot be - complete; dynamic creation program: 'mktextex'. +‘tex’ + (TeX source, *note (web2c)tex invocation::) ‘TEXINPUTS’; suffix + ‘.tex’; additional suffixes: none, because such a list cannot be + complete; dynamic creation program: ‘mktextex’. -'TeX system documentation' - (Documentation files for the TeX system) 'TEXDOCS'. +‘TeX system documentation’ + (Documentation files for the TeX system) ‘TEXDOCS’. -'TeX system sources' - (Source files for the TeX system) 'TEXSOURCES'. +‘TeX system sources’ + (Source files for the TeX system) ‘TEXSOURCES’. -'texmfscripts' +‘texmfscripts’ (Architecture-independent executables distributed in the texmf - trees) 'TEXMFSCRIPTS'. + trees) ‘TEXMFSCRIPTS’. -'texpool' +‘texpool’ (TeX program strings, *note (web2c)pooltype invocation::) - 'TEXPOOL', 'TEXMFINI'; suffix '.pool'. + ‘TEXPOOL’, ‘TEXMFINI’; suffix ‘.pool’. -'tfm' - (TeX font metrics, *note (dvips)Metric files::) 'TFMFONTS', - 'TEXFONTS'; suffix '.tfm'; dynamic creation program: 'mktextfm'. +‘tfm’ + (TeX font metrics, *note (dvips)Metric files::) ‘TFMFONTS’, + ‘TEXFONTS’; suffix ‘.tfm’; dynamic creation program: ‘mktextfm’. -'Troff fonts' +‘Troff fonts’ (Troff fonts, used by DMP; *note (web2c)DMP invocation::) - 'TRFONTS'. + ‘TRFONTS’. -'truetype fonts' - (TrueType outline fonts) 'TTFONTS'; suffixes '.ttf' and '.TTF', - '.ttc' and '.TTC', '.dfont'. +‘truetype fonts’ + (TrueType outline fonts) ‘TTFONTS’; suffixes ‘.ttf’ and ‘.TTF’, + ‘.ttc’ and ‘.TTC’, ‘.dfont’. -'type1 fonts' +‘type1 fonts’ (Type 1 PostScript outline fonts, *note (dvips)Glyph files::) - 'T1FONTS', 'T1INPUTS', 'TEXPSHEADERS', 'DVIPSHEADERS'; suffixes - '.pfa', '.pfb'. + ‘T1FONTS’, ‘T1INPUTS’, ‘TEXPSHEADERS’, ‘DVIPSHEADERS’; suffixes + ‘.pfa’, ‘.pfb’. -'type42 fonts' - (Type 42 PostScript outline fonts) 'T42FONTS'. +‘type42 fonts’ + (Type 42 PostScript outline fonts) ‘T42FONTS’. -'vf' - (virtual fonts, *note (dvips)Virtual fonts::) 'VFFONTS', - 'TEXFONTS'; suffix '.vf'. +‘vf’ + (virtual fonts, *note (dvips)Virtual fonts::) ‘VFFONTS’, + ‘TEXFONTS’; suffix ‘.vf’. -'web' - (WEB input files) 'WEBINPUTS'; suffix '.web'; additional suffix - '.ch'. +‘web’ + (WEB input files) ‘WEBINPUTS’; suffix ‘.web’; additional suffix + ‘.ch’. -'web2c files' - (files specific to the web2c implementation) 'WEB2C'. +‘web2c files’ + (files specific to the web2c implementation) ‘WEB2C’. There are two special cases, because the paths and environment variables always depend on the name of the program: the variable name is constructed by converting the program name to upper case, and then -appending 'INPUTS'. Assuming the program is called 'foo', this gives us +appending ‘INPUTS’. Assuming the program is called ‘foo’, this gives us the following table. -'other text files' - (text files used by 'foo') 'FOOINPUTS'. +‘other text files’ + (text files used by ‘foo’) ‘FOOINPUTS’. -'other binary files' - (binary files used by 'foo') 'FOOINPUTS'. +‘other binary files’ + (binary files used by ‘foo’) ‘FOOINPUTS’. If an environment variable by these names are set, the corresponding -'texmf.cnf' definition won't be looked at (unless, as usual, the -environment variable value has an extra ':'). *Note Default +‘texmf.cnf’ definition won't be looked at (unless, as usual, the +environment variable value has an extra ‘:’). *Note Default expansion::. For the font variables, the intent is that: - * 'TEXFONTS' is the default for everything. + • ‘TEXFONTS’ is the default for everything. - * 'GLYPHFONTS' is the default for bitmap (or, more precisely, + • ‘GLYPHFONTS’ is the default for bitmap (or, more precisely, non-metric) files. - * Each font format has a variable of its own. + • Each font format has a variable of its own. - * Each program has its own font override path as well; e.g., - 'DVIPSFONTS' for Dvipsk. Again, this is for bitmaps, not metrics. + • Each program has its own font override path as well; e.g., + ‘DVIPSFONTS’ for Dvipsk. Again, this is for bitmaps, not metrics. File: kpathsea.info, Node: File lookup, Next: Glyph lookup, Prev: Supported file formats, Up: TeX support @@ -1885,31 +1936,31 @@ searches are the exception, as described in the next section). 1. If the file format defines default suffixes, and the suffix of NAME name is not already a known suffix for that format, try the name with each default appended, and use alternative names found in the - fontmaps if necessary. Example: given 'foo.bar', look for - 'foo.bar.tex'. + fontmaps if necessary. Example: given ‘foo.bar’, look for + ‘foo.bar.tex’. 2. Search for NAME, and if necessary for alternative names found in - the fontmaps. Example: given 'foo.bar', we also look for - 'foo.bar'. + the fontmaps. Example: given ‘foo.bar’, we also look for + ‘foo.bar’. 3. If the file format defines a program to invoke to create missing files, run it (*note mktex scripts::). The order in which we search for "suffixed" name (item 1) or the -"as-is" name (item 2) is controlled by the 'try_std_extension_first' -configuration value. The default set in 'texmf.cnf' is true, since -common suffixes are already recognized: 'babel.sty' will only look for -'babel.sty', not 'babel.sty.tex', regardless of this setting. +"as-is" name (item 2) is controlled by the ‘try_std_extension_first’ +configuration value. The default set in ‘texmf.cnf’ is true, since +common suffixes are already recognized: ‘babel.sty’ will only look for +‘babel.sty’, not ‘babel.sty.tex’, regardless of this setting. - When the suffix is unknown (e.g., 'foo.bar'), both names are always + When the suffix is unknown (e.g., ‘foo.bar’), both names are always tried; the difference is the order in which they are tried. - 'try_std_extension_first' only affects names being looked up which -*already* have an extension. A name without an extension (e.g., 'tex -story') will always have an extension added first. + ‘try_std_extension_first’ only affects names being looked up which +*already* have an extension. A name without an extension (e.g., ‘tex +story’) will always have an extension added first. - This algorithm is implemented in the function 'kpathsea_find_file' in -the source file 'kpathsea/tex-file.c'. You can watch it in action with + This algorithm is implemented in the function ‘kpathsea_find_file’ in +the source file ‘kpathsea/tex-file.c’. You can watch it in action with the debugging options (*note Debugging::). @@ -1919,7 +1970,7 @@ File: kpathsea.info, Node: Glyph lookup, Next: Suppressing warnings, Prev: Fi ================ This section describes how Kpathsea searches for a bitmap font in GF or -PK format (or either) given a font name (e.g., 'cmr10') and a resolution +PK format (or either) given a font name (e.g., ‘cmr10’) and a resolution (e.g., 600). Here is an outline of the search strategy (details in the sections @@ -1930,16 +1981,16 @@ successful lookup. format(s). 2. If NAME is an alias for a file F in the fontmap file - 'texfonts.map', look for F.DPI. + ‘texfonts.map’, look for F.DPI. - 3. Run an external program (typically named 'mktexpk') to generate the + 3. Run an external program (typically named ‘mktexpk’) to generate the font (*note mktex scripts::) 4. Look for FALLBACK.DPI, where FALLBACK is some last-resort font - (typically 'cmr10'). + (typically ‘cmr10’). - This is implemented in 'kpathsea_find_glyph' in -'kpathsea/tex-glyph.c'. + This is implemented in ‘kpathsea_find_glyph’ in +‘kpathsea/tex-glyph.c’. * Menu: @@ -1955,16 +2006,16 @@ File: kpathsea.info, Node: Basic glyph lookup, Next: Fontmap, Up: Glyph looku When Kpathsea looks for a bitmap font NAME at resolution DPI in a format FORMAT, it first checks each directory in the search path for a file -'NAME.DPIFORMAT'; for example, 'cmr10.600pk'. Kpathsea looks for a PK +‘NAME.DPIFORMAT’; for example, ‘cmr10.600pk’. Kpathsea looks for a PK file first, then a GF file. - If that fails, Kpathsea looks for 'dpiDPI/NAME.FORMAT'; for example, -'dpi600/cmr10.pk'. This is how fonts are typically stored on + If that fails, Kpathsea looks for ‘dpiDPI/NAME.FORMAT’; for example, +‘dpi600/cmr10.pk’. This is how fonts are typically stored on filesystems (such as DOS) that permit only three-character extensions. If that fails, Kpathsea looks for a font with a close-enough DPI. -"Close enough" is defined by the macro 'KPSE_BITMAP_TOLERANCE' in -'kpathsea/tex-glyph.h' to be 'DPI / 500 + 1'. This is slightly more +"Close enough" is defined by the macro ‘KPSE_BITMAP_TOLERANCE’ in +‘kpathsea/tex-glyph.h’ to be ‘DPI / 500 + 1’. This is slightly more than the 0.2% minimum allowed by the DVI standard (<CTAN:/dviware/driv-standard/level-0>). @@ -1975,51 +2026,51 @@ File: kpathsea.info, Node: Fontmap, Next: Fallback font, Prev: Basic glyph lo ------------- If a bitmap font or metric file is not found with the original name (see -the previous section), Kpathsea looks through any "fontmap" files for an -"alias" for the original font name. These files are named -'texfonts.map' and searched for along the 'TEXFONTMAPS' -environment/config file variable. All 'texfonts.map' files that are +the previous section), Kpathsea looks through any “fontmap” files for an +“alias” for the original font name. These files are named +‘texfonts.map’ and searched for along the ‘TEXFONTMAPS’ +environment/config file variable. All ‘texfonts.map’ files that are found are read; earlier definitions override later ones. This feature is intended to help in two respects: 1. An alias name is limited in length only by available memory, not by - your filesystem. Therefore, if you want to ask for 'Times-Roman' - instead of 'ptmr', you can (you get 'ptmr8r'). + your filesystem. Therefore, if you want to ask for ‘Times-Roman’ + instead of ‘ptmr’, you can (you get ‘ptmr8r’). 2. A few fonts have historically had multiple names: specifically, - LaTeX's "circle font" has variously been known as 'circle10', - 'lcircle10', and 'lcirc10'. Aliases can make all the names + LaTeX's "circle font" has variously been known as ‘circle10’, + ‘lcircle10’, and ‘lcirc10’. Aliases can make all the names equivalent, so that it no longer matters what the name of the installed file is; TeX documents will find their favorite name. The format of fontmap files: - * Comments start with the last '%' on a line and continue to the end + • Comments start with the last ‘%’ on a line and continue to the end of the line. (This provides for names that include a %, ill-advised as that may be.) - * Blank lines are ignored. + • Blank lines are ignored. - * Each nonblank line is broken up into a series of "words": a + • Each nonblank line is broken up into a series of “words”: a sequence of non-whitespace characters. - * If the first word is 'include', the second word is used as a + • If the first word is ‘include’, the second word is used as a filename, and it is searched for and read. - * Otherwise, the first word on each line is the true filename; + • Otherwise, the first word on each line is the true filename; - * the second word is the alias; + • the second word is the alias; - * subsequent words are ignored. + • subsequent words are ignored. If an alias has an extension, it matches only those files with that extension; otherwise, it matches anything with the same root, regardless -of extension. For example, an alias 'foo.tfm' matches only when -'foo.tfm' is being searched for; but an alias 'foo' matches 'foo.vf', -'foo.600pk', etc. +of extension. For example, an alias ‘foo.tfm’ matches only when +‘foo.tfm’ is being searched for; but an alias ‘foo’ matches ‘foo.vf’, +‘foo.600pk’, etc. - As an example, here is an excerpt from the 'texfonts.map' in the + As an example, here is an excerpt from the ‘texfonts.map’ in the Web2c distribution. It makes the old and new names of the LaTeX circle fonts equivalent. @@ -2031,7 +2082,7 @@ fonts equivalent. lcirc10 lcircle10 ... - Fontmaps are implemented in the file 'kpathsea/fontmap.c'. The + Fontmaps are implemented in the file ‘kpathsea/fontmap.c’. The Fontname distribution has much more information on font naming (*note (fontname)::). @@ -2042,17 +2093,17 @@ File: kpathsea.info, Node: Fallback font, Prev: Fontmap, Up: Glyph lookup ------------------- If a bitmap font cannot be found or created at the requested size, -Kpathsea looks for the font at a set of "fallback resolutions". You +Kpathsea looks for the font at a set of “fallback resolutions”. You specify these resolutions as a colon-separated list (like search paths). Kpathsea looks first for a program-specific environment variable (e.g., -'DVIPSSIZES' for Dvipsk), then the environment variable 'TEXSIZES', then +‘DVIPSSIZES’ for Dvipsk), then the environment variable ‘TEXSIZES’, then a default specified at compilation time (the Make variable -'default_texsizes'). You can set this list to be empty if you prefer to +‘default_texsizes’). You can set this list to be empty if you prefer to find fonts at their stated size or not at all. Finally, if the font cannot be found even at the fallback -resolutions, Kpathsea looks for a fallback font, typically 'cmr10'. -Programs must enable this feature by calling 'kpathsea_init_prog' (*note +resolutions, Kpathsea looks for a fallback font, typically ‘cmr10’. +Programs must enable this feature by calling ‘kpathsea_init_prog’ (*note Calling sequence::); the default is no fallback font. @@ -2065,43 +2116,43 @@ Kpathsea provides a way to suppress selected usually-harmless warnings; this is useful at large sites where most users are not administrators, and thus the warnings are merely a source of confusion, not a help. To do this, you set the environment variable or configuration file value -'TEX_HUSH' to a colon-separated list of values. Here are the +‘TEX_HUSH’ to a colon-separated list of values. Here are the possibilities: -'all' +‘all’ Suppress everything possible. -'checksum' +‘checksum’ Suppress mismatched font checksum warnings. -'lostchar' +‘lostchar’ Suppress warnings when a character is missing from a font that a DVI or VF file tries to typeset. -'none' +‘none’ Don't suppress any warnings. -'readable' +‘readable’ Suppress warnings about attempts to access a file whose permissions render it unreadable. -'special' - Suppresses warnings about an unimplemented or unparsable '\special' +‘special’ + Suppresses warnings about an unimplemented or unparsable ‘\special’ command. -'tex-hush.c' defines the function that checks the variable value. Each +‘tex-hush.c’ defines the function that checks the variable value. Each driver implements its own checks where appropriate. File: kpathsea.info, Node: mktex scripts, Prev: Suppressing warnings, Up: TeX support -6.5 'mktex' scripts +6.5 ‘mktex’ scripts =================== If Kpathsea cannot otherwise find a file, for some file types it is configured by default to invoke an external program to create it dynamically (*note mktex configuration::). These are collectively known -as "'mktex' scripts", since most of them are named 'mktex...'. +as “‘mktex’ scripts”, since most of them are named ‘mktex...’. For example, this is useful for fonts (bitmaps, TFM's, and arbitrarily-sizable Metafont sources such as the Sauter and EC fonts), @@ -2109,8 +2160,8 @@ since any given document can use fonts never before referenced. Building all fonts in advance is therefore impractical, if not impossible. - It is also useful for the TeX '.fmt' (and Metafont '.base' and -Metapost '.mem' files, *note (Web2c)Memory dumps::), where + It is also useful for the TeX ‘.fmt’ (and Metafont ‘.base’ and +Metapost ‘.mem’ files, *note (Web2c)Memory dumps::), where pre-generating every format consumes a lot of both time and space. The script is passed the name of the file to create and possibly @@ -2127,13 +2178,13 @@ diagnostics to standard error. File: kpathsea.info, Node: mktex configuration, Next: mktex script names, Up: mktex scripts -6.5.1 'mktex' configuration +6.5.1 ‘mktex’ configuration --------------------------- The list of file types and program names that can run an external program to create missing files is listed in the next section. In the -absence of 'configure' options specifying otherwise, everything but -'mktextex' will be enabled by default. The 'configure' options to +absence of ‘configure’ options specifying otherwise, everything but +‘mktextex’ will be enabled by default. The ‘configure’ options to change the defaults are: --without-mktexfmt-default @@ -2144,186 +2195,189 @@ change the defaults are: --without-mktextfm-default --with-mktextex-default - The 'configure' setting is overridden if the environment variable or -configuration file value named for the script is set; e.g., 'MKTEXPK' + The ‘configure’ setting is overridden if the environment variable or +configuration file value named for the script is set; e.g., ‘MKTEXPK’ (*note mktex script arguments::). - 'mktexfmt' reads a file 'fmtutil.cnf', typically located in -'texmf/web2c/' to glean its configuration information. The rest of the + ‘mktexfmt’ reads a file ‘fmtutil.cnf’, typically located in +‘texmf/web2c/’ to glean its configuration information. The rest of the files and features in this section are primarily intended for the font generation scripts. - As distributed, all the scripts source a file 'texmf/web2c/mktex.cnf' -if it exists, so you can override various defaults. See 'mktex.opt', + As distributed, all the scripts source a file ‘texmf/web2c/mktex.cnf’ +if it exists, so you can override various defaults. See ‘mktex.opt’, for instance, which defines the default mode, resolution, some special directory names, etc. If you prefer not to change the distributed -scripts, you can simply create 'mktex.cnf' with the appropriate +scripts, you can simply create ‘mktex.cnf’ with the appropriate definitions (you do not need to create it if you have nothing to put in -it). 'mktex.cnf' has no special syntax; it's an arbitrary Bourne shell -script. The distribution contains a sample 'mktex.cnf' for you to copy +it). ‘mktex.cnf’ has no special syntax; it's an arbitrary Bourne shell +script. The distribution contains a sample ‘mktex.cnf’ for you to copy and modify as you please (it is not installed anywhere). In addition, you can configure a number of features with the -'MT_FEATURES' variable, which you can define: +‘MT_FEATURES’ variable, which you can define: - * in 'mktex.opt', as just mentioned; + • in ‘mktex.opt’, as just mentioned; - * by editing the file 'mktex.opt', either before 'make install' (in + • by editing the file ‘mktex.opt’, either before ‘make install’ (in the source hierarchy) or after (in the installed hierarchy); - * or in the environment. + • or in the environment. - If none of the options below are enabled, 'mktexpk', 'mktextfm', and -'mktexmf' follow the following procedure to decide where fonts should be + If none of the options below are enabled, ‘mktexpk’, ‘mktextfm’, and +‘mktexmf’ follow the following procedure to decide where fonts should be installed. Find the tree where the font's sources are, and test the -permissions of the 'fonts' directory of that tree to determine whether +permissions of the ‘fonts’ directory of that tree to determine whether it is writable. If it is, put the files in the tree in appropriate locations. If it isn't writable, see whether the tree is a system tree -(named in 'SYSTEXMF'). If so, the 'VARTEXFONTS' tree is used. In all +(named in ‘SYSTEXMF’). If so, the ‘VARTEXFONTS’ tree is used. In all other cases the working directory is used. - The 'appendonlydir' option is enabled by default. + The ‘appendonlydir’ option is enabled by default. -'appendonlydir' - Tell 'mktexdir' to create directories append-only, i.e., set their +‘appendonlydir’ + Tell ‘mktexdir’ to create directories append-only, i.e., set their sticky bit (*note (coreutils)Mode Structure::). This feature is silently ignored on non-Unix platforms (e.g. Windows/NT and MS-DOS) which don't support similar functionality. This feature is enabled by default. -'dosnames' - Use 8.3 names; e.g., 'dpi600/cmr10.pk' instead of 'cmr10.600pk'. +‘dosnames’ + Use 8.3 names; e.g., ‘dpi600/cmr10.pk’ instead of ‘cmr10.600pk’. Note that this feature only affects filenames that would otherwise - clash with other TeX-related filenames; 'mktex' scripts do nothing + clash with other TeX-related filenames; ‘mktex’ scripts do nothing about filenames which exceed the 8+3 MS-DOS limits but remain unique when truncated (by the OS) to these limits, and nether do the scripts care about possible clashes with files which aren't - related with TeX. For example, 'cmr10.600pk' would clash with - 'cmr10.600gf' and is therefore changed when 'dosnames' is in - effect, but 'mf.pool' and 'mp.base' don't clash with any + related with TeX. For example, ‘cmr10.600pk’ would clash with + ‘cmr10.600gf’ and is therefore changed when ‘dosnames’ is in + effect, but ‘mf.pool’ and ‘mp.base’ don't clash with any TeX-related files and are therefore unchanged. This feature is turned on by default on MS-DOS. If you do not wish - 'dosnames' to be set on an MS-DOS platform, you need to set the - 'MT_FEATURES' environment variable to a value that doesn't include - 'dosnames'. You can also change the default setting by editing - 'mktex.opt', but only if you use the 'mktex' shell scripts; the - emulation programs don't consult 'mktex.opt'. + ‘dosnames’ to be set on an MS-DOS platform, you need to set the + ‘MT_FEATURES’ environment variable to a value that doesn't include + ‘dosnames’. You can also change the default setting by editing + ‘mktex.opt’, but only if you use the ‘mktex’ shell scripts; the + emulation programs don't consult ‘mktex.opt’. -'fontmaps' +‘fontmaps’ Instead of deriving the location of a font in the destination tree from the location of the sources, the aliases and directory names from the Fontname distribution are used. (*note Introduction: (fontname)Top.). -'nomfdrivers' +‘nomfdrivers’ Let mktexpk and mktextfm create metafont driver files in a temporary directory. These will be used for just one metafont run and not installed permanently. -'nomode' +‘nomode’ Omit the directory level for the mode name; this is fine as long as you generate fonts for only one mode. -'stripsupplier' +‘stripsupplier’ Omit the font supplier name directory level. -'striptypeface' +‘striptypeface’ Omit the font typeface name directory level. -'strip' +‘strip’ Omit the font supplier and typeface name directory levels. This - feature is deprecated in favour of 'stripsupplier' and - 'striptypeface'. + feature is deprecated in favour of ‘stripsupplier’ and + ‘striptypeface’. -'varfonts' +‘varfonts’ When this option is enabled, fonts that would otherwise be written - in system texmf tree go to the 'VARTEXFONTS' tree instead. The - default value in 'kpathsea/Makefile.in' is '/var/tmp/texfonts'. - The 'Linux File System Standard' recommends '/var/tex/fonts'. + in system texmf tree go to the ‘VARTEXFONTS’ tree instead. The + default value in ‘kpathsea/Makefile.in’ is ‘/var/tmp/texfonts’. + The ‘Linux File System Standard’ recommends ‘/var/tex/fonts’. - The 'varfonts' setting in 'MT_FEATURES' is overridden by the - 'USE_VARTEXFONTS' environment variable: if set to '1', the feature - is enabled, and if set to '0', the feature is disabled. + The ‘varfonts’ setting in ‘MT_FEATURES’ is overridden by the + ‘USE_VARTEXFONTS’ environment variable: if set to ‘1’, the feature + is enabled, and if set to ‘0’, the feature is disabled. -'texmfvar' +‘texmfvar’ Force generated files that would go into a system tree (as defined - by 'SYSTEXMF') into 'TEXMFVAR'. Starting with teTeX-3.0, the - variable 'TEXMFVAR' is always set. The 'varfonts' feature takes + by ‘SYSTEXMF’) into ‘TEXMFVAR’. Starting with teTeX-3.0, the + variable ‘TEXMFVAR’ is always set. The ‘varfonts’ feature takes precedence if also set. - The 'texmfvar' setting in 'MT_FEATURES' is overridden by the - 'USE_TEXMFVAR' environment variable: if set to '1', the feature is - enabled, and if set to '0', the feature is disabled. + The ‘texmfvar’ setting in ‘MT_FEATURES’ is overridden by the + ‘USE_TEXMFVAR’ environment variable: if set to ‘1’, the feature is + enabled, and if set to ‘0’, the feature is disabled. File: kpathsea.info, Node: mktex script names, Next: mktex script arguments, Prev: mktex configuration, Up: mktex scripts -6.5.2 'mktex' script names +6.5.2 ‘mktex’ script names -------------------------- The following table shows the default name of the script for each of the file types which support runtime generation. -'mktexfmt' - ('.fmt', '.base', '.mem') TeX/Metafont/MetaPost formats. This - script is also named 'fmtutil', and reads 'fmtutil.cnf' for +‘mktexfmt’ + (‘.fmt’, ‘.base’, ‘.mem’) TeX/Metafont/MetaPost formats. This + script is also named ‘fmtutil’, and reads ‘fmtutil.cnf’ for configuration information. -'mktexmf' - ('.mf') Metafont input files. +‘mktexmf’ + (‘.mf’) Metafont input files. -'mkocp' - ('.ocp') Omega compiled process files. +‘mkocp’ + (‘.ocp’) Omega compiled process files. -'mkofm' - ('.ofm') Omega font metric files. +‘mkofm’ + (‘.ofm’) Omega font metric files. -'mktexpk' - ('pk') Glyph fonts. +‘mktexpk’ + (‘pk’) Glyph fonts. -'mktextex' - ('.tex') TeX input files (disabled by default). +‘mktextex’ + (‘.tex’) TeX input files (disabled by default). -'mktextfm' - ('.tfm') TFM files. +‘mktextfm’ + (‘.tfm’) TFM files. These names can be overridden by an environment variable specific to the -program--for example, 'DVIPSMAKEPK' for Dvipsk. +program; for example, ‘DVIPSMAKEPK’ for Dvipsk. - If a 'mktex...' script fails, the invocation is appended to a file -'missfont.log' (by default) in the current directory. You can then -execute the log file to create the missing files after fixing the -problem. + If a ‘mktex...’ script fails, the invocation is appended to a file +‘missfont.log’ (by default) in the current directory. After fixing the +problem, you can then execute the log file to create the missing files. - If the current directory is not writable and the environment variable -or configuration file value 'TEXMFOUTPUT' is set, its value is used. -Otherwise, nothing is written. The name 'missfont.log' is overridden by -the 'MISSFONT_LOG' environment variable or configuration file value. + If the environment variable ‘TEXMF_OUTPUT_DIRECTORY’ is set, +‘missfont.log’ is first tried to be written there; if it's not set, the +current directory is tried first. If that first write fails and the +environment variable or configuration file value ‘TEXMFOUTPUT’ is set, +we try to write ‘missfont.log’ there. Otherwise nothing is written. + + The base filename ‘missfont.log’ is overridden by the ‘MISSFONT_LOG’ +environment variable or configuration file value. File: kpathsea.info, Node: mktex script arguments, Prev: mktex script names, Up: mktex scripts -6.5.3 'mktex' script arguments +6.5.3 ‘mktex’ script arguments ------------------------------ -The first argument to a 'mktex' script is always the name of the file to +The first argument to a ‘mktex’ script is always the name of the file to be created. - In the default 'mktexpk' implementation, additional arguments may + In the default ‘mktexpk’ implementation, additional arguments may also be passed: -'--dpi NUM' +‘--dpi NUM’ Sets the resolution of the generated font to NUM. -'--mfmode NAME' +‘--mfmode NAME’ Sets the Metafont mode to NAME. -'--bdpi NUM' +‘--bdpi NUM’ Sets the "base dpi" for the font. This must match the mode being used. -'--mag STRING' - A "magstep" string suitable for the Metafont 'mag' variable. This +‘--mag STRING’ + A "magstep" string suitable for the Metafont ‘mag’ variable. This must match the combination of BDPI and DPI being used. -'--destdir STRING' +‘--destdir STRING’ A directory name. If the directory is absolute, it is used as-is. Otherwise, it is appended to the root destination directory set in the script. @@ -2342,6 +2396,7 @@ it is released under LGPLv2.1 or later). * Overview: Programming overview. Introduction. * Calling sequence:: Specifics of what to call. +* Safe filenames:: Only opening allowed files. * Program-specific files:: How to handle these. * Config: Programming with config files. Getting info from texmf.cnf. @@ -2364,44 +2419,44 @@ translation. When looking at these program sources, you should know that previous versions of the library had a different programming interface; the current interface supports re-entrancy. Historically, the library -function names were prefixed with 'kpse_' instead of 'kpathsea_', and +function names were prefixed with ‘kpse_’ instead of ‘kpathsea_’, and they did not need an instance variable as first argument. This change was made in 2009. The old functions will never disappear, and can reliably continue to be used when they suffice, as they do for the programs above. The main application using the re-entrant API is the MetaPost library used by MetaPost and LuaTeX. - Beyond these examples, the '.h' files in the Kpathsea source describe -the interfaces and functionality (and of course the '.c' files define + Beyond these examples, the ‘.h’ files in the Kpathsea source describe +the interfaces and functionality (and of course the ‘.c’ files define the actual routines, which are the ultimate documentation). -'pathsearch.h' declares the basic searching routine. 'tex-file.h' and -'tex-glyph.h' define the interfaces for looking up particular kinds of +‘pathsearch.h’ declares the basic searching routine. ‘tex-file.h’ and +‘tex-glyph.h’ define the interfaces for looking up particular kinds of files. In view of the way the headers depend on each other, it is -recommended to use '#include <kpathsea/kpathsea.h>', which includes +recommended to use ‘#include <kpathsea/kpathsea.h>’, which includes every Kpathsea header. If you want to include only specific headers, you should still -consider including 'kpathsea/config.h' before including any other -Kpathsea header, as it provides symbols used in the other headers. Note -that 'kpathsea/config.h' includes 'kpathsea/c-auto.h', which is -generated by Autoconf. +consider including ‘kpathsea/config.h’ before including any other +Kpathsea header, as it provides symbols used in the other headers; +‘kpathsea/config.h’ includes ‘kpathsea/c-auto.h’, which is generated by +Autoconf. The library provides no way for an external program to register new -file types: 'tex-file.[ch]' must be modified to do this. For example, +file types: ‘tex-file.[ch]’ must be modified to do this. For example, Kpathsea has support for looking up Dvips config files, even though no -program other than Dvips will likely ever want to do so. I felt this +program other than Dvips is likely to ever want to do so. I felt this was acceptable, since along with new file types should also come new -defaults in 'texmf.cnf' (and its descendant 'paths.h'), since it's +defaults in ‘texmf.cnf’ (and its descendant ‘paths.h’), since it's simplest for users if they can modify one configuration file for all kinds of paths. Kpathsea does not parse any formats itself; it barely opens any files. Its primary purpose is to return filenames. The GNU font -utilities does contain libraries to read TFM, GF, and PK files, as do -the programs above, of course. +utilities package contains libraries to read TFM, GF, and PK files, as +do the programs above, of course. -File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Prev: Programming overview, Up: Programming +File: kpathsea.info, Node: Calling sequence, Next: Safe filenames, Prev: Programming overview, Up: Programming 7.2 Calling sequence ==================== @@ -2409,173 +2464,239 @@ File: kpathsea.info, Node: Calling sequence, Next: Program-specific files, Pr The typical way to use Kpathsea in your program goes something like this: - 1. Call 'kpathsea_new' to create a new library instance. This + 1. Call ‘kpathsea_new’ to create a new library instance. This variable must be passed as the first argument to all the following - library functions. The rest of this manual will be using 'kpse' as + library functions. The rest of this manual will be using ‘kpse’ as a placeholder for the name of this variable. - 2. Call 'kpathsea_set_program_name' with 'argv[0]' as the second - argument; the third argument is a string or 'NULL'. The third - argument is used by Kpathsea as the program name for the '.PROGRAM' + 2. Call ‘kpathsea_set_program_name’ with ‘argv[0]’ as the second + argument; the third argument is a string or ‘NULL’. The third + argument is used by Kpathsea as the program name for the ‘.PROGRAM’ feature of config files (*note Config files::). If the third - argument is 'NULL', the value of the second argument is used. This + argument is ‘NULL’, the value of the second argument is used. This function must be called before any other use of the Kpathsea library. - 'kpathsea_set_program_name' always sets the variables - 'kpse->invocation_name' and 'kpse->invocation_short_name'. These + ‘kpathsea_set_program_name’ always sets the variables + ‘kpse->invocation_name’ and ‘kpse->invocation_short_name’. These variables are used in the error message macros defined in - 'kpathsea/lib.h'. It sets the variable 'kpse->program_name' to the + ‘kpathsea/lib.h’. It sets the variable ‘kpse->program_name’ to the program name it uses. It also initializes debugging options based on the environment - variable 'KPATHSEA_DEBUG' (if that is set). + variable ‘KPATHSEA_DEBUG’ (if that is set). - Finally, it sets the environment variables 'SELFAUTOLOC', - 'SELFAUTODIR' and 'SELFAUTOPARENT' to the location, parent and - grandparent directory of the executable, removing '.' and '..' path + Finally, it sets the environment variables ‘SELFAUTOLOC’, + ‘SELFAUTODIR’ and ‘SELFAUTOPARENT’ to the location, parent and + grandparent directory of the executable, removing ‘.’ and ‘..’ path elements and resolving symbolic links. These are used in the default configuration file to allow people to invoke TeX from - anywhere. You can use 'kpsewhich --expand-var=\$SELFAUTOLOC', + anywhere. You can use ‘kpsewhich --expand-var=\$SELFAUTOLOC’, etc., to see the values. 3. Set debugging options. *Note Debugging::. If your program doesn't have a debugging option already, you can define one and set - 'kpse->debug' to the number that the user supplies (as in Dviljk - and Web2c), or you can just omit this altogether (people can always - set 'KPATHSEA_DEBUG'). If you do have runtime debugging already, - you need to merge Kpathsea's options with yours (as in Dvipsk and - Xdvik). + ‘kpse->debug’ to the number that the user supplies (as in Dviljk + and Web2c), or you can just omit this altogether (users can always + set the ‘KPATHSEA_DEBUG’ environment variable). If you do have + runtime debugging already, you need to merge Kpathsea's options + with yours (as in Dvipsk and Xdvik). 4. If your program has its own configuration files that can define - search paths, you should assign those paths to the 'client_path' - member in the appropriate element of the 'kpse->format_info' array. - (This array is indexed by file type; see 'tex-file.h'.) See - 'resident.c' in Dvipsk for an example. + search paths, you should assign those paths to the ‘client_path’ + member in the appropriate element of the ‘kpse->format_info’ array. + (This array is indexed by file type; see ‘tex-file.h’.) See + ‘resident.c’ in Dvipsk for an example. - 5. Call 'kpathsea_init_prog' (see 'proginit.c'). It's useful for the + 5. Call ‘kpathsea_init_prog’ (see ‘proginit.c’). It's useful for the DVI drivers, at least, but for other programs it may be simpler to extract the parts of it that actually apply. This does not initialize any paths, it just looks for (and sets) certain - environment variables and other random information. (A search path - is always initialized at the first call to find a file of that - type; this eliminates much useless work, e.g., initializing the - BibTeX search paths in a DVI driver.) + environment variables and other random information. Search paths + are always initialized at the first call to find a file of a given + type, not requiring an explicit initialization call; this + eliminates much useless work, e.g., initializing the BibTeX search + paths in a DVI driver. 6. The routine to actually find a file of type FORMAT is - 'kpathsea_find_file'. You can call 'kpathsea_find_file' after + ‘kpathsea_find_file’. You can call ‘kpathsea_find_file’ after doing only the first and second of the initialization steps - above--Kpathsea automatically reads the 'texmf.cnf' generic config + above--Kpathsea automatically reads the ‘texmf.cnf’ generic config files, looks for environment variables, and does expansions at the first lookup. 7. To find PK and/or GF bitmap fonts, the routine is - 'kpathsea_find_glyph', defined in 'tex-glyph.h'. This returns a + ‘kpathsea_find_glyph’, defined in ‘tex-glyph.h’. This returns a structure in addition to the resultant filename, because fonts can be found in so many ways. See the documentation in the source. - 8. To actually open a file, not just return a filename, call - 'kpathsea_open_file'. This function takes the name to look up and - a Kpathsea file format as arguments, and returns the usual 'FILE - *'. It always assumes the file must exist, and thus will search - the disk if necessary (unless the search path specified '!!', + 8. Before opening a file, especially for writing, you should check if + the filename is acceptable. See the next section (*note Safe + filenames::). + + 9. To actually open a file, not just return a filename, call + ‘kpathsea_open_file’. This function takes the name to look up and + a Kpathsea file format as arguments, and returns the usual ‘FILE + *’. It always assumes the file must exist, and thus will search + the disk if necessary (unless the search path specified ‘!!’, etc.). In other words, if you are looking up a VF or some other file that need not exist, don't use this. - 9. TeX can write output files, via the '\openout' primitive; this - opens a security hole vulnerable to Trojan horse attack: an - unwitting user could run a TeX program that overwrites, say, - '~/.rhosts'. Analogous security holes exist for many other - programs. To alleviate this, there is a configuration variable - 'openout_any', which selects one of three levels of security. When - it is set to 'a' (for "any"), no restrictions are imposed. When it - is set to 'r' (for "restricted"), filenames beginning with '.' are - disallowed (except '.tex' because LaTeX needs it). When it is set - to 'p' (for "paranoid") additional restrictions are imposed: an - absolute filename must refer to a file in (a subdirectory) of - 'TEXMFOUTPUT', and any attempt to go up a directory level is - forbidden (that is, paths may not contain a '..' component). The - paranoid setting is the default. (For backwards compatibility, 'y' - and '1' are synonyms of 'a', while 'n' and '0' are synonyms for - 'r'.) The function 'kpathsea_out_name_ok', with a filename as - second argument, returns 'true' if that filename is acceptable to - be opend for output or 'false' otherwise. - - 10. Similarly, the function 'kpathsea_in_name_ok', with a filename as - second argument, returns 'true' if that filename is acceptable to - be opend for input or 'false' otherwise, depending on the value of - the configuration variable 'openin_any' (with 'a' as default). - - 11. To close the kpathsea library instance you are using, call - 'kpathsea_finish'. This function closes any open log files and + 10. To close the Kpathsea library instance you are using, call + ‘kpathsea_finish’. This function closes any open log files and frees the memory used by the instance. Kpathsea also provides many utility routines. Some are generic: hash tables, memory allocation, string concatenation and copying, string lists, reading input lines of arbitrary length, etc. Others are -filename-related: default path, tilde, and variable expansion, 'stat' -calls, etc. (Perhaps someday I'll move the former to a separate -library.) +filename-related: default path, tilde, and variable expansion, ‘stat’ +calls, etc. - The 'c-*.h' header files can also help your program adapt to many + The ‘c-*.h’ header files can also help your program adapt to many different systems. You will almost certainly want to use Autoconf and probably Automake for configuring and building your software if you use Kpathsea; I strongly recommend using Autoconf and Automake regardless. They are available from <https://gnu.org/software>. -File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Calling sequence, Up: Programming +File: kpathsea.info, Node: Safe filenames, Next: Program-specific files, Prev: Calling sequence, Up: Programming + +7.3 Safe filenames +================== + +*Note Security::, for some general security considerations with the TeX +system. + + In the implementation, the main security feature to disallow writing +to potentially dangerous files is a configuration variable +‘openout_any’. It specifies one of three levels: + + • When set to ‘a’ (for "any"), no restrictions are imposed. + + • When is set to ‘r’ (for "restricted"), filenames beginning with ‘.’ + are disallowed (except ‘.tex’, because LaTeX needs it). + + • When set to ‘p’ (for "paranoid"), additional restrictions are + imposed. + + 1. First, an absolute filename must refer to a file in (or in a + subdirectory of) either the ‘TEXMF_OUTPUT_DIRECTORY’ + environment variable or the ‘TEXMFOUTPUT’ environment variable + or configuration file setting. + + 2. LuaTeX uses a so-called "extended" mode, in which the values + of ‘TEXMFVAR’ and ‘TEXMFSYSVAR’ are also checked for absolute + filenames. This is done because, in practice, fundamental + parts of the LuaLaTeX system (notably ‘luaotfload’) need a + cache directory, and historically the ‘TEXMF[SYS]VAR’ + variables are what has been used. We neither recommend nor + expect any other programs to need this. + + 3. Finally, any attempt to go up a directory level is forbidden; + that is, paths may not contain a ‘..’ component. + + The paranoid setting is the default. Any program intended to be +safely called from TeX should implement the same measures, one way or +another. *Note (web2c)Shell escapes::. + + Kpathsea does not resolve ‘..’ components, or symbolic links, to see +if the final result is an acceptable directory; they are simply +forbidden. That is, Kpathsea merely considers the value as a string, +not looking on the filesystem at all. (However, if another program +wants to do such resolutions and check the result, that's ok.) + + For backwards compatibility, ‘y’ and ‘1’ are synonyms of ‘a’, while +‘n’ and ‘0’ are synonyms for ‘r’. + + The function ‘kpathsea_out_name_ok’, with a filename as second +argument, returns ‘true’ if that filename is acceptable to be opened for +output or ‘false’ otherwise. The Kpsewhich program has an option +(‘--safe-out-name’) providing a command line interface for the check. + + For LuaTeX's extended mode, the function is +‘kpathsea_out_name_ok_extended’, and the Kpsewhich option is +‘--safe-extended-out-name’. + + Similarly, the function ‘kpathsea_in_name_ok’ (resp. ‘_extended’, +with a filename as second argument, returns ‘true’ if that filename is +acceptable to be opend for input or ‘false’ otherwise, depending on the +value of the configuration variable ‘openin_any’. Unfortunately, for +reading, ‘a’ is the default default; too many system directories and +files get involved to make ‘r’ or ‘p’ feasible. + + The functions above write a message to standard error if the usage is +forbidden (so every caller does not have to do so). Each function has a +‘_silent’ counterpart which does not write the message; this is what +Kpsewhich calls, since messages would be counterproductive in that case. +Thus: + + kpathsea_out_name_ok_silent + kpathsea_out_name_ok_silent_extended + kpathsea_in_name_ok_silent + kpathsea_in_name_ok_silent_extended + + Furthermore, there are ‘kpse_...’ versions of all the above functions +(as usual), with the default library instance implicitly passed as the +first argument. LuaTeX provides both ‘kpse.*’ and ‘kpathsea.*’ +bindings, so it's good to always have both. + + Sorry for the combinatorial explosion, but we hope no further options +will ever be needed. If so, we'll likely provide a more generic +interface as well as the above. + + +File: kpathsea.info, Node: Program-specific files, Next: Programming with config files, Prev: Safe filenames, Up: Programming -7.3 Program-specific files +7.4 Program-specific files ========================== Many programs will need to find some configuration files. Kpathsea contains some support to make it easy to place them in their own directories. The Standard TeX directory structure (*note Introduction: (tds)Top.), specifies that such files should go into a subdirectory -named after the program, like 'texmf/ttf2pk'. +named after the program, like ‘texmf/ttf2pk’. - Two formats, 'kpse_program_text_format' and -'kpse_program_binary_format', use '.:$TEXMF/PROGRAM//' as their + Two formats, ‘kpse_program_text_format’ and +‘kpse_program_binary_format’, use ‘.:$TEXMF/PROGRAM//’ as their compiled-in search path. To override this default, you can use the -variable 'PROGRAMINPUTS' in the environment and/or 'texmf.cnf'. That is +variable ‘PROGRAMINPUTS’ in the environment and/or ‘texmf.cnf’. That is to say, the name of the variable is constructed by converting the name -of the program to upper case, and appending 'INPUTS'. +of the program to upper case, and appending ‘INPUTS’. The only difference between these two formats is whether -'kpathsea_open_file' will open the files it finds in text or binary +‘kpathsea_open_file’ will open the files it finds in text or binary mode. File: kpathsea.info, Node: Programming with config files, Prev: Program-specific files, Up: Programming -7.4 Programming with config files +7.5 Programming with config files ================================= -You can (and probably should) use the same 'texmf.cnf' configuration +You can (and probably should) use the same ‘texmf.cnf’ configuration file that Kpathsea uses for your program. This helps installers by keeping all configuration in one place. To retrieve a value for a configuration variable VAR, the best way is -to call 'kpathsea_var_value' on the string 'VAR'. This will look first +to call ‘kpathsea_var_value’ on the string ‘VAR’. This will look first for an environment variable VAR, then a config file value. The result -will be the value found or 'NULL'. This function is declared in -'kpathsea/variable.h'. For an example, see the 'shell_escape' code in -'web2c/lib/texmfmp.c'. +will be the value found or ‘NULL’. This function is declared in +‘kpathsea/variable.h’. For an example, see the ‘shell_escape’ code in +‘web2c/lib/texmfmp.c’. The routine to do full variable and tilde expansion of an arbitrary string in the context of a search path (as opposed to simply retrieving -a value) is 'kpathsea_var_expand', also declared in -'kpathsea/variable.h'. However, it's generally only necessary to set +a value) is ‘kpathsea_var_expand’, also declared in +‘kpathsea/variable.h’. However, it's generally only necessary to set the search path structure components as explained in the previous section instead of using this directly. Because of its usage with any -input string, undefined '$FOO' constructs in the argument to -'kpathsea_var_expand' are returned literally ('"$FOO"'), while undefined -'${FOO}' constructs are expanded to the empty string. +input string, undefined ‘$FOO’ constructs in the argument to +‘kpathsea_var_expand’ are returned literally (‘"$FOO"’), while undefined +‘${FOO}’ constructs are expanded to the empty string. If for some reason you want to retrieve a value _only_ from a config file, not automatically looking for a corresponding environment -variable, call 'kpathsea_cnf_get' (declared in 'kpathsea/cnf.h') with +variable, call ‘kpathsea_cnf_get’ (declared in ‘kpathsea/cnf.h’) with the string VAR. No initialization calls are needed. @@ -2616,60 +2737,60 @@ known (*note Common problems::). information necessary for reproduction. Therefore, to enable investigation, your report should include the following: - * The version number(s) of the program(s) involved, and of Kpathsea - itself. You can get the former by giving a sole option '--version' - to the program, and the latter by running 'kpsewhich --version'. - The 'NEWS' and 'ChangeLog' files also contain the version number. + • The version number(s) of the program(s) involved, and of Kpathsea + itself. You can get the former by giving a sole option ‘--version’ + to the program, and the latter by running ‘kpsewhich --version’. + The ‘NEWS’ and ‘ChangeLog’ files also contain the version number. - * The hardware, operating system (including version), compiler, and - 'make' program you are using (the output of 'uname -a' is a start + • The hardware, operating system (including version), compiler, and + ‘make’ program you are using (the output of ‘uname -a’ is a start on the first two, though incomplete). - * Any options you gave to 'configure'. This is recorded in the - 'config.status' files. + • Any options you gave to ‘configure’. This is recorded in the + ‘config.status’ files. - If you are reporting a bug in 'configure' itself, it's probably + If you are reporting a bug in ‘configure’ itself, it's probably system-dependent, and it will be unlikely the maintainers can do anything useful if you merely report that thus-and-such is broken. Therefore, you need to do some additional work: for some bugs, you - can look in the file 'config.log' where the test that failed should + can look in the file ‘config.log’ where the test that failed should appear, along with the compiler invocation and source program in question. You can then compile it yourself by hand, and discover - why the test failed. Other 'configure' bugs do not involve the + why the test failed. Other ‘configure’ bugs do not involve the compiler; in that case, the only recourse is to inspect the - 'configure' shell script itself, or the Autoconf macros that - generated 'configure'. + ‘configure’ shell script itself, or the Autoconf macros that + generated ‘configure’. - * The log of all debugging output, if the bug is in path searching. + • The log of all debugging output, if the bug is in path searching. You can get this by setting the environment variable - 'KPATHSEA_DEBUG' to '-1' before running the program. Please look + ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. Please look at the log yourself to make sure the behavior is really a bug before reporting it; perhaps "old" environment variable settings are causing files not to be found, for example. - * The contents of any input files necessary to reproduce the bug. + • The contents of any input files necessary to reproduce the bug. For bugs in DVI-reading programs, for example, this generally means a DVI file (and any EPS or other files it uses)--TeX source files are helpful, but the DVI file is required, because that's the actual program input. - * If you are sending a patch (do so if you can!), please do so in the - form of a context diff ('diff -c') against the original + • If you are sending a patch (do so if you can!), please do so in the + form of a context diff (‘diff -c’) against the original distribution source. Any other form of diff is either not as complete or harder for me to understand. Please also include a - 'ChangeLog' entry. + ‘ChangeLog’ entry. - * If the bug involved is an actual crash (i.e., core dump), it is + • If the bug involved is an actual crash (i.e., core dump), it is easy and useful to include a stack trace from a debugger (I recommend the GNU debugger GDB (<https://gnu.org/software/gdb>). - If the cause is apparent (a 'NULL' value being dereferenced, for + If the cause is apparent (a ‘NULL’ value being dereferenced, for example), please send the details along. If the program involved is TeX or Metafont, and the crash is happening at apparently-sound code, however, the bug may well be in the compiler, rather than in the program or the library (*note TeX or Metafont failing: TeX or Metafont failing.). - * Any additional information that will be helpful in reproducing, + • Any additional information that will be helpful in reproducing, diagnosing, or fixing the bug. @@ -2702,19 +2823,19 @@ by their names and corresponding numeric values. When the files you expect aren't being found, the thing to do is enable these options and examine the output. - You can set these with some runtime argument (e.g., '-d') to the + You can set these with some runtime argument (e.g., ‘-d’) to the program; in that case, you should use the numeric values described in the program's documentation (which, for Dvipsk and Xdvik, are different -than those below). It's best to give the '-d' (or whatever) option +than those below). It's best to give the ‘-d’ (or whatever) option first, for maximal output. Dvipsk and Xdvik have additional program-specific debugging options as well. - You can also set the environment variable 'KPATHSEA_DEBUG'; in this + You can also set the environment variable ‘KPATHSEA_DEBUG’; in this case, you should use the numbers below. If you run the program under a -debugger and set the instance variable 'kpse->debug', also use the +debugger and set the instance variable ‘kpse->debug’, also use the numbers below. - In any case, by far the simplest value to use is '-1', which will + In any case, by far the simplest value to use is ‘-1’, which will turn on all debugging output. This is usually better than guessing which particular values will yield the output you need. @@ -2729,78 +2850,78 @@ it easily. For example, in Bourne-compatible shells: somebody's numbers. (Sorry.) To set more than one option, just sum the corresponding numbers. -'KPSE_DEBUG_STAT (1)' - Report 'stat'(2) calls. This is useful for verifying that your +‘KPSE_DEBUG_STAT (1)’ + Report ‘stat’(2) calls. This is useful for verifying that your directory structure is not forcing Kpathsea to do many additional file tests (*note Slow path searching::, and *note Subdirectory - expansion::). If you are using an up-to-date 'ls-R' database + expansion::). If you are using an up-to-date ‘ls-R’ database (*note Filename database::), this should produce no output unless a nonexistent file that must exist is searched for. -'KPSE_DEBUG_HASH (2)' - Report lookups in all hash tables: 'ls-R' and 'aliases' (*note +‘KPSE_DEBUG_HASH (2)’ + Report lookups in all hash tables: ‘ls-R’ and ‘aliases’ (*note Filename database::); font aliases (*note Fontmap::); and config file values (*note Config files::). Useful when expected values are not being found, e.g.., file searches are looking at the disk - instead of using 'ls-R'. + instead of using ‘ls-R’. -'KPSE_DEBUG_FOPEN (4)' +‘KPSE_DEBUG_FOPEN (4)’ Report file openings and closings. Especially useful when your system's file table is full, for seeing which files have been opened but never closed. In case you want to set breakpoints in a - debugger: this works by redefining 'fopen' ('fclose') to be - 'kpse_fopen_trace' ('kpse_fclose_trace'). + debugger: this works by redefining ‘fopen’ (‘fclose’) to be + ‘kpse_fopen_trace’ (‘kpse_fclose_trace’). -'KPSE_DEBUG_PATHS (8)' +‘KPSE_DEBUG_PATHS (8)’ Report general path information for each file type Kpathsea is asked to search. This is useful when you are trying to track down - how a particular path got defined--from 'texmf.cnf', 'config.ps', + how a particular path got defined--from ‘texmf.cnf’, ‘config.ps’, an environment variable, the compile-time default, etc. This is - the contents of the 'kpse_format_info_type' structure defined in - 'tex-file.h'. + the contents of the ‘kpse_format_info_type’ structure defined in + ‘tex-file.h’. -'KPSE_DEBUG_EXPAND (16)' +‘KPSE_DEBUG_EXPAND (16)’ Report the directory list corresponding to each path element Kpathsea searches. This is only relevant when Kpathsea searches - the disk, since 'ls-R' searches don't look through directory lists + the disk, since ‘ls-R’ searches don't look through directory lists in this way. -'KPSE_DEBUG_SEARCH (32)' +‘KPSE_DEBUG_SEARCH (32)’ Report on each file search: the name of the file searched for, the path searched in, whether or not the file must exist (when drivers - search for 'cmr10.vf', it need not exist), and whether or not we + search for ‘cmr10.vf’, it need not exist), and whether or not we are collecting all occurrences of the file in the path (as with, - e.g., 'texmf.cnf' and 'texfonts.map'), or just the first (as with + e.g., ‘texmf.cnf’ and ‘texfonts.map’), or just the first (as with most lookups). This can help you correlate what Kpathsea is doing with what is in your input file. -'KPSE_DEBUG_VARS (64)' +‘KPSE_DEBUG_VARS (64)’ Report the value of each variable Kpathsea looks up. This is useful for verifying that variables do indeed obtain their correct values. -'GSFTOPK_DEBUG (128)' - Activates debugging printout specific to 'gsftopk' program. +‘GSFTOPK_DEBUG (128)’ + Activates debugging printout specific to ‘gsftopk’ program. -'MAKETEX_DEBUG (512)' - If you use the optional 'mktex' programs instead of the traditional +‘MAKETEX_DEBUG (512)’ + If you use the optional ‘mktex’ programs instead of the traditional shell scripts, this will report the name of the site file - ('mktex.cnf' by default) which is read, directories created by - 'mktexdir', the full path of the 'ls-R' database built by - 'mktexlsr', font map searches, 'MT_FEATURES' in effect, parameters - from 'mktexnam', filenames added by 'mktexupd', and some subsidiary + (‘mktex.cnf’ by default) which is read, directories created by + ‘mktexdir’, the full path of the ‘ls-R’ database built by + ‘mktexlsr’, font map searches, ‘MT_FEATURES’ in effect, parameters + from ‘mktexnam’, filenames added by ‘mktexupd’, and some subsidiary commands run by the programs. -'MAKETEX_FINE_DEBUG (1024)' - When the optional 'mktex' programs are used, this will print +‘MAKETEX_FINE_DEBUG (1024)’ + When the optional ‘mktex’ programs are used, this will print additional debugging info from functions internal to these programs. Debugging output from Kpathsea is always written to standard error, -and begins with the string 'kdebug:'. (Except for hash table buckets, +and begins with the string ‘kdebug:’. (Except for hash table buckets, which just start with the number, but you can only get that output -running under a debugger. See comments at the 'hash_summary_only' -variable in 'kpathsea/db.c'.) +running under a debugger. See comments at the ‘hash_summary_only’ +variable in ‘kpathsea/db.c’.) File: kpathsea.info, Node: Logging, Next: Common problems, Prev: Debugging, Up: Reporting bugs @@ -2813,18 +2934,18 @@ search. This may be useful in finding good candidates for deletion when your filesystem is full, or in discovering usage patterns at your site. To do this, define the environment or config file variable -'TEXMFLOG'. The value is the name of the file to append the information +‘TEXMFLOG’. The value is the name of the file to append the information to. The file is created if it doesn't exist, and appended to if it does. Each successful search turns into one line in the log file: two words separated by a space. The first word is the time of the search, as the integer number of seconds since "the epoch", i.e., UTC midnight 1 -January 1970 (more precisely, the result of the 'time' system call). +January 1970 (more precisely, the result of the ‘time’ system call). The second word is the filename. - For example, after 'setenv TEXMFLOG /tmp/log', running Dvips on -'story.dvi' appends the following lines: + For example, after ‘setenv TEXMFLOG /tmp/log’, running Dvips on +‘story.dvi’ appends the following lines: 774455887 /usr/local/share/texmf/dvips/config.ps 774455887 /usr/local/share/texmf/dvips/psfonts.map @@ -2837,13 +2958,13 @@ The second word is the filename. Only filenames that are absolute are recorded, to preserve some semblance of privacy. - In addition to this Kpathsea-specific logging, 'pdftex' provides an -option '-recorder' to write the names of all files accessed during a run -to the file 'BASEFILE.fls'. + In addition to this Kpathsea-specific logging, ‘pdftex’ provides an +option ‘-recorder’ to write the names of all files accessed during a run +to the file ‘BASEFILE.fls’. Finally, most systems provide a general tool to output each system call, thus including opening and closing files. It might be named -'strace', 'truss', 'struss', or something else. +‘strace’, ‘truss’, ‘struss’, or something else. File: kpathsea.info, Node: Common problems, Prev: Logging, Up: Reporting bugs @@ -2871,19 +2992,19 @@ If a program complains it cannot find fonts (or other input files), any of several things might be wrong. In any case, you may find the debugging options helpful. *Note Debugging::. - * Perhaps you simply haven't installed all the necessary files; the + • Perhaps you simply haven't installed all the necessary files; the basic fonts and input files are distributed separately from the programs. *Note unixtex.ftp::. - * You have (perhaps unknowingly) told Kpathsea to use search paths + • You have (perhaps unknowingly) told Kpathsea to use search paths that don't reflect where the files actually are. One common cause is having environment variables set from a previous installation, - thus overriding what you carefully set in 'texmf.cnf' (*note - Supported file formats::). System '/etc/profile' or other files + thus overriding what you carefully set in ‘texmf.cnf’ (*note + Supported file formats::). System ‘/etc/profile’ or other files such may be the culprit. - * Your files reside in a directory that is only pointed to via a - symbolic link, in a leaf directory and is not listed in 'ls-R'. + • Your files reside in a directory that is only pointed to via a + symbolic link, in a leaf directory and is not listed in ‘ls-R’. Unfortunately, Kpathsea's subdirectory searching has an irremediable deficiency: If a directory D being searched for @@ -2896,21 +3017,21 @@ debugging options helpful. *Note Debugging::. subdirectory in D. Then D will no longer be a leaf, and the symlinks will be followed. - The directory immediately followed by the '//' in the path + The directory immediately followed by the ‘//’ in the path specification, however, is always searched for subdirectories, even if it is a leaf. Presumably you would not have asked for the directory to be searched for subdirectories if you didn't want it to be. - * If the fonts (or whatever) don't already exist, 'mktexpk' (or - 'mktexmf' or 'mktextfm') will try to create them. If these rather + • If the fonts (or whatever) don't already exist, ‘mktexpk’ (or + ‘mktexmf’ or ‘mktextfm’) will try to create them. If these rather complicated shell scripts fail, you'll eventually get an error - message saying something like 'Can't find font FONTNAME'. The best - solution is to fix (or at least report) the bug in 'mktexpk'; the + message saying something like ‘Can't find font FONTNAME’. The best + solution is to fix (or at least report) the bug in ‘mktexpk’; the workaround is to generate the necessary fonts by hand with Metafont, or to grab them from a CTAN site (*note unixtex.ftp::). - * There is a bug in the library. *Note Reporting bugs::. + • There is a bug in the library. *Note Reporting bugs::. File: kpathsea.info, Node: Slow path searching, Next: Unable to generate fonts, Prev: Unable to find files, Up: Common problems @@ -2922,19 +3043,19 @@ If your program takes an excessively long time to find fonts or other input files, but does eventually succeed, here are some possible culprits: - * Most likely, you just have a lot of directories to search, and that + • Most likely, you just have a lot of directories to search, and that takes a noticeable time. The solution is to create and maintain a - separate 'ls-R' file that lists all the files in your main TeX - hierarchy. *Note Filename database::. Kpathsea always uses 'ls-R' + separate ‘ls-R’ file that lists all the files in your main TeX + hierarchy. *Note Filename database::. Kpathsea always uses ‘ls-R’ if it's present; there's no need to recompile or reconfigure any of the programs. - * Your recursively-searched directories (e.g., - '/usr/local/share/texmf/fonts//'), contain a mixture of files and + • Your recursively-searched directories (e.g., + ‘/usr/local/share/texmf/fonts//’), contain a mixture of files and directories. This prevents Kpathsea from using a useful optimization (*note Subdirectory expansion::). - It is best to have only directories (and perhaps a 'README') in the + It is best to have only directories (and perhaps a ‘README’) in the upper levels of the directory structure, and it's very important to have _only_ files, and no subdirectories, in the leaf directories where the dozens of TFM, PK, or whatever files reside. @@ -2955,17 +3076,17 @@ quality of output. Some DVI-to-whatever programs, such as Dvips, try to generate these on the fly when they are needed, but this generation may fail in several cases. - If 'mktexpk' runs, but fails with this error: + If ‘mktexpk’ runs, but fails with this error: mktexpk: Can't guess mode for NNN dpi devices. mktexpk: Use a config file to specify the mode, or update me. you need to ensure the resolution and mode match; just specifying the -resolution, as in '-D 360', is not enough. +resolution, as in ‘-D 360’, is not enough. - You can specify the mode name with the '-mode' option on the Dvips + You can specify the mode name with the ‘-mode’ option on the Dvips command line, or in a Dvips configuration file (*note (dvips)Config -files::), such as 'config.ps' in your document directory, '~/.dvipsrc' +files::), such as ‘config.ps’ in your document directory, ‘~/.dvipsrc’ in your home directory, or in a system directory (again named -'config.ps'). (Other drivers use other files, naturally.) +‘config.ps’). (Other drivers use other files, naturally.) For example, if you need 360dpi fonts, you could include this in a configuration file: @@ -2973,7 +3094,7 @@ configuration file: M lqmed If Metafont runs, but generates fonts at the wrong resolution or for -the wrong device, most likely 'mktexpk''s built-in guess for the mode is +the wrong device, most likely ‘mktexpk’'s built-in guess for the mode is wrong, and you should override it as above. See <https://ctan.org/pkg/modes> for a list of resolutions and mode @@ -2983,18 +3104,18 @@ names for most devices (additional submissions are welcome). prints out the name of each character as well as just a character number, and maybe tries to display the characters), then your Metafont base file probably hasn't been made properly. (It's using the default -'proof' mode, instead of an actual device mode.) To make a proper -'plain.base', assuming the local mode definitions are contained in a -file 'modes.mf', run the following command (assuming Unix): +‘proof’ mode, instead of an actual device mode.) To make a proper +‘plain.base’, assuming the local mode definitions are contained in a +file ‘modes.mf’, run the following command (assuming Unix): inimf "plain; input modes; dump" -Then copy the 'plain.base' file from the current directory to where the -base files are stored on your system ('/usr/local/share/texmf/web2c' by -default), and make a link (either hard or soft) from 'plain.base' to -'mf.base' in that directory. *Note (web2c)inimf invocation::. +Then copy the ‘plain.base’ file from the current directory to where the +base files are stored on your system (‘/usr/local/share/texmf/web2c’ by +default), and make a link (either hard or soft) from ‘plain.base’ to +‘mf.base’ in that directory. *Note (web2c)inimf invocation::. - If 'mf' is a command not found at all by 'mktexpk', then you need to + If ‘mf’ is a command not found at all by ‘mktexpk’, then you need to install Metafont (*note unixtex.ftp::). @@ -3032,11 +3153,6 @@ Index * Menu: -* !! and casefolding: Casefolding examples. - (line 57) -* !! in path specifications: ls-R. (line 57) -* !! in TEXMFDBS: ls-R. (line 11) -* $ expansion: Variable expansion. (line 6) * --all: Path searching options. (line 12) * --casefold-search: Path searching options. @@ -3054,32 +3170,34 @@ Index * --expand-path=STRING: Auxiliary tasks. (line 16) * --expand-var=STRING: Auxiliary tasks. (line 34) * --format=NAME: Path searching options. - (line 69) + (line 70) * --help: Standard options. (line 8) * --help-formats: Auxiliary tasks. (line 42) * --interactive: Path searching options. - (line 151) + (line 152) * --mktex=FILETYPE: Path searching options. - (line 156) + (line 157) * --mode=STRING: Path searching options. - (line 162) + (line 163) * --must-exist: Path searching options. - (line 167) + (line 168) * --no-casefold-search: Path searching options. (line 19) * --no-mktex=FILETYPE: Path searching options. - (line 156) + (line 157) * --path=STRING: Path searching options. - (line 172) + (line 173) * --progname=NAME: Path searching options. - (line 180) -* --safe-in-name=NAME: Auxiliary tasks. (line 48) -* --safe-out-name=NAME: Auxiliary tasks. (line 48) -* --show-path=NAME: Auxiliary tasks. (line 54) + (line 181) +* --safe-extended-in-name=NAME: Auxiliary tasks. (line 48) +* --safe-extended-out-name=NAME: Auxiliary tasks. (line 48) +* --safe-in-name=NAME: Auxiliary tasks. (line 54) +* --safe-out-name=NAME: Auxiliary tasks. (line 54) +* --show-path=NAME: Auxiliary tasks. (line 60) * --subdir=STRING: Path searching options. - (line 185) -* --var-brace-value=VARIABLE: Auxiliary tasks. (line 60) -* --var-value=VARIABLE: Auxiliary tasks. (line 74) + (line 186) +* --var-brace-value=VARIABLE: Auxiliary tasks. (line 66) +* --var-value=VARIABLE: Auxiliary tasks. (line 80) * --version: Standard options. (line 11) * --with-mktextex-default: mktex configuration. (line 12) * --without-mktexfmt-default: mktex configuration. (line 12) @@ -3095,6 +3213,13 @@ Index * -iname, find predicate: Casefolding examples. (line 78) * -L option to ls: ls-R. (line 44) +* ; translated to : in texmf.cnf: Config files. (line 66) +* : may not be :: Searching overview. (line 13) +* :: expansion: Default expansion. (line 6) +* !! and casefolding: Casefolding examples. + (line 57) +* !! in path specifications: ls-R. (line 57) +* !! in TEXMFDBS: ls-R. (line 11) * . directories, ignored: ls-R. (line 39) * . files: ls-R. (line 39) * .2602gf: Unable to generate fonts. @@ -3179,8 +3304,8 @@ Index (line 199) * .pro: Supported file formats. (line 173) +* .profile, (un)writable by TeX: Security. (line 16) * .PROGNAME qualifier in texmf.cnf: Config files. (line 50) -* .rhosts, writable by TeX: Security. (line 10) * .ris: Supported file formats. (line 177) * .sfd: Supported file formats. @@ -3210,6 +3335,7 @@ Index (line 53) * .web <1>: Supported file formats. (line 227) +* { expansion: Brace expansion. (line 6) * / may not be /: Searching overview. (line 13) * /, trailing in home directory: Tilde expansion. (line 19) * //: Subdirectory expansion. @@ -3218,19 +3344,17 @@ Index (line 14) * /etc/profile and aliases: ls-R. (line 25) * /var/tmp/texfonts: mktex configuration. (line 113) -* 2602gf: Unable to generate fonts. - (line 36) -* 8.3 filenames, using: mktex configuration. (line 68) -* : may not be :: Searching overview. (line 13) -* :: expansion: Default expansion. (line 6) -* ; translated to : in texmf.cnf: Config files. (line 66) -* = omitted in texmf.cnf and misparsing: Config files. (line 86) * \, line continuation in texmf.cnf: Config files. (line 37) * \openin: Searching overview. (line 31) +* \openout: Security. (line 16) * \special, suppressing warnings about: Suppressing warnings. (line 31) -* { expansion: Brace expansion. (line 6) +* = omitted in texmf.cnf and misparsing: Config files. (line 86) * ~ expansion: Tilde expansion. (line 6) +* $ expansion: Variable expansion. (line 6) +* 2602gf: Unable to generate fonts. + (line 36) +* 8.3 filenames, using: mktex configuration. (line 68) * absolute filenames: Searching overview. (line 58) * access system call: Casefolding examples. (line 86) @@ -3248,14 +3372,15 @@ Index * announcement mailing list: Mailing lists. (line 6) * API, re-entrant: Programming overview. (line 16) -* append-only directories and mktexpk: Security. (line 36) +* append-only directories and mktexpk: Global font cache and security. + (line 19) * appendonlydir: mktex configuration. (line 60) * Apple filesystem, case-insensitive: Casefolding rationale. (line 6) * arguments to mktex: mktex script arguments. (line 6) * argv[0]: Calling sequence. (line 14) -* autoconf, recommended: Calling sequence. (line 117) +* autoconf, recommended: Calling sequence. (line 97) * automounter, and ls-R: ls-R. (line 46) * auxiliary tasks: Auxiliary tasks. (line 6) * Bach, Johann Sebastian: Default expansion. (line 41) @@ -3279,10 +3404,11 @@ Index * bug checklist: Bug checklist. (line 6) * bug mailing list: Mailing lists. (line 6) * bugs, reporting: Reporting bugs. (line 6) -* c-*.h: Calling sequence. (line 117) +* c-*.h: Calling sequence. (line 97) * c-auto.h: Programming overview. (line 35) -* cache of fonts, local: Security. (line 22) +* cache of fonts, local: Global font cache and security. + (line 6) * calling sequence: Calling sequence. (line 6) * casefolding examples: Casefolding examples. (line 6) @@ -3335,6 +3461,7 @@ Index * context diff: Bug checklist. (line 52) * continuation character: Config files. (line 37) * core dumps, reporting: Bug checklist. (line 58) +* crashes of TeX and security: Security. (line 43) * crashes, reporting: Bug checklist. (line 58) * CWEBINPUTS: Supported file formats. (line 53) @@ -3352,7 +3479,8 @@ Index * device, wrong: Unable to generate fonts. (line 29) * directories, making append-only: mktex configuration. (line 61) -* directory permissions: Security. (line 51) +* directory permissions: Global font cache and security. + (line 34) * directory structure, for TeX files: TeX directory structure. (line 6) * disabling mktex scripts: mktex configuration. (line 6) @@ -3420,7 +3548,8 @@ Index * file formats, supported: Supported file formats. (line 6) * file lookup: File lookup. (line 6) -* file permissions: Security. (line 47) +* file permissions: Global font cache and security. + (line 30) * file types, registering new: Programming overview. (line 41) * filename aliases: Filename aliases. (line 6) @@ -3467,7 +3596,8 @@ Index (line 75) * GFFONTS: Supported file formats. (line 75) -* globally writable directories: Security. (line 30) +* globally writable directories: Global font cache and security. + (line 13) * glyph lookup: Glyph lookup. (line 6) * glyph lookup bitmap tolerance: Basic glyph lookup. (line 15) * GLYPHFONTS: Supported file formats. @@ -3479,10 +3609,11 @@ Index * GNU C compiler bugs: TeX or Metafont failing. (line 16) * GNU General Public License: Introduction. (line 32) -* group-writable directories: Security. (line 40) +* group-writable directories: Global font cache and security. + (line 23) * GSFTOPK_DEBUG (128): Debugging. (line 88) * hash table buckets, printing: Debugging. (line 105) -* hash table routines: Calling sequence. (line 110) +* hash table routines: Calling sequence. (line 91) * hash_summary_only variable for debugging: Debugging. (line 105) * history of Kpathsea: History. (line 6) * Hoekwater, Taco: History. (line 78) @@ -3492,9 +3623,9 @@ Index * include fontmap directive: Fontmap. (line 36) * INDEXSTYLE: Supported file formats. (line 84) -* input lines, reading: Calling sequence. (line 110) +* input lines, reading: Calling sequence. (line 91) * interactive query: Path searching options. - (line 151) + (line 152) * interface, not frozen: Introduction. (line 29) * introduction: Introduction. (line 6) * kdebug:: Debugging. (line 105) @@ -3502,35 +3633,34 @@ Index * Knuth, Donald E.: History. (line 6) * Knuth, Donald E., archive of programs by: unixtex.ftp. (line 20) * Kpathsea config file, source for path: Path sources. (line 20) -* kpathsea.h: Programming overview. - (line 26) * kpathsea_cnf_get: Programming with config files. (line 27) * KPATHSEA_DEBUG: Calling sequence. (line 28) * KPATHSEA_DEBUG <1>: Debugging. (line 18) -* kpathsea_find_file: File lookup. (line 38) -* kpathsea_find_file <1>: Calling sequence. (line 62) +* kpathsea_find_file: File lookup. (line 37) +* kpathsea_find_file <1>: Calling sequence. (line 63) * kpathsea_find_glyph: Glyph lookup. (line 26) -* kpathsea_finish: Calling sequence. (line 106) +* kpathsea_find_glyph <1>: Calling sequence. (line 70) +* kpathsea_finish: Calling sequence. (line 87) +* kpathsea_in_name_ok: Safe filenames. (line 59) +* kpathsea_in_name_ok_extended: Safe filenames. (line 59) +* kpathsea_in_name_ok_silent: Safe filenames. (line 72) +* kpathsea_in_name_ok_silent_extended: Safe filenames. (line 72) * kpathsea_init_prog: Fallback font. (line 15) * kpathsea_init_prog <1>: Calling sequence. (line 53) -* kpathsea_in_name_ok: Calling sequence. (line 101) * kpathsea_new: Calling sequence. (line 9) -* kpathsea_open_file: Calling sequence. (line 74) -* kpathsea_out_name_ok: Calling sequence. (line 82) +* kpathsea_open_file: Calling sequence. (line 79) +* kpathsea_out_name_ok: Safe filenames. (line 50) +* kpathsea_out_name_ok_extended: Safe filenames. (line 55) +* kpathsea_out_name_ok_silent: Safe filenames. (line 72) +* kpathsea_out_name_ok_silent_extended: Safe filenames. (line 72) * kpathsea_set_program_name: Calling sequence. (line 14) * kpathsea_var_value: Programming with config files. (line 10) * KPATHSEA_WARNING: Config files. (line 18) -* kpse->debug: Debugging. (line 6) -* kpse->debug <1>: Debugging. (line 18) -* kpse->debug variable: Calling sequence. (line 39) -* kpse->format_info: Calling sequence. (line 47) -* kpse->invocation_name: Calling sequence. (line 22) -* kpse->invocation_short_name: Calling sequence. (line 22) -* kpse->program_name: Calling sequence. (line 22) -* kpsewhich: Invoking kpsewhich. (line 6) -* Kpsewhich, and debugging: Debugging. (line 31) +* kpathsea.h: Programming overview. + (line 26) +* kpse mode of LuaTeX: Security. (line 32) * KPSE_BITMAP_TOLERANCE: Basic glyph lookup. (line 15) * KPSE_DEBUG_EXPAND (16): Debugging. (line 68) * KPSE_DEBUG_FOPEN (4): Debugging. (line 53) @@ -3541,6 +3671,15 @@ Index * KPSE_DEBUG_VARS (64): Debugging. (line 83) * KPSE_DOT expansion: KPSE_DOT expansion. (line 6) * kpse_format_info_type: Debugging. (line 61) +* kpse->debug: Debugging. (line 6) +* kpse->debug <1>: Debugging. (line 18) +* kpse->debug variable: Calling sequence. (line 39) +* kpse->format_info: Calling sequence. (line 47) +* kpse->invocation_name: Calling sequence. (line 22) +* kpse->invocation_short_name: Calling sequence. (line 22) +* kpse->program_name: Calling sequence. (line 22) +* kpsewhich: Invoking kpsewhich. (line 6) +* Kpsewhich, and debugging: Debugging. (line 31) * last-resort font: Fallback font. (line 6) * lcircle10: Fontmap. (line 19) * leading colons: Default expansion. (line 6) @@ -3551,9 +3690,10 @@ Index * license for using the library: Introduction. (line 32) * LIGFONTS: Supported file formats. (line 88) -* lines, reading arbitrary-length: Calling sequence. (line 110) +* lines, reading arbitrary-length: Calling sequence. (line 91) * Linux File System Standard: mktex configuration. (line 113) -* local cache of fonts: Security. (line 22) +* local cache of fonts: Global font cache and security. + (line 6) * log file: Logging. (line 6) * logging successful searches: Logging. (line 6) * lost+found directory: Searching overview. (line 63) @@ -3565,6 +3705,8 @@ Index * ls-R, simplest build: ls-R. (line 22) * LUAINPUTS: Supported file formats. (line 94) +* luaotfload: Safe filenames. (line 26) +* LuaTeX and security: Security. (line 32) * Mac filesystem, case-insensitive: Casefolding rationale. (line 6) * MacKenzie, David: History. (line 44) @@ -3574,7 +3716,7 @@ Index * mailing lists: Mailing lists. (line 6) * MAKETEX_DEBUG (512): Debugging. (line 91) * MAKETEX_FINE_DEBUG (1024): Debugging. (line 100) -* memory allocation routines: Calling sequence. (line 110) +* memory allocation routines: Calling sequence. (line 91) * metafont driver files: mktex configuration. (line 93) * Metafont failures: TeX or Metafont failing. (line 6) @@ -3596,8 +3738,8 @@ Index (line 121) * mismatched checksum warnings: Suppressing warnings. (line 17) +* MISSFONT_LOG: mktex script names. (line 45) * missfont.log: mktex script names. (line 35) -* MISSFONT_LOG: mktex script names. (line 40) * missing character warnings: Suppressing warnings. (line 20) * mkocp: mktex script names. (line 18) @@ -3651,6 +3793,7 @@ Index (line 145) * online Metafont display, spurious: Unable to generate fonts. (line 36) +* openout_any: Safe filenames. (line 6) * OPENTYPEFONTS: Supported file formats. (line 149) * optimization caveat: TeX or Metafont failing. @@ -3665,6 +3808,7 @@ Index (line 158) * OVPFONTS: Supported file formats. (line 161) +* paranoid mode, for output files: Safe filenames. (line 18) * path expansion: Path expansion. (line 6) * path searching: Path searching. (line 6) * path searching options: Path searching options. @@ -3684,8 +3828,10 @@ Index * pdftexconfig.tex: Specially-recognized files. (line 34) * permission denied: Searching overview. (line 63) -* permissions, directory: Security. (line 51) -* permissions, file: Security. (line 47) +* permissions, directory: Global font cache and security. + (line 34) +* permissions, file: Global font cache and security. + (line 30) * PKFONTS: Supported file formats. (line 168) * plain.base: Unable to generate fonts. @@ -3713,7 +3859,7 @@ Index (line 16) * readable: Suppressing warnings. (line 26) -* reading arbitrary-length lines: Calling sequence. (line 110) +* reading arbitrary-length lines: Calling sequence. (line 91) * recording successful searches: Logging. (line 6) * relative filenames: Searching overview. (line 58) * reporting bugs: Reporting bugs. (line 6) @@ -3721,6 +3867,7 @@ Index * resolution, setting: Path searching options. (line 49) * resolutions, last-resort: Fallback font. (line 6) +* restricted mode, for output files: Safe filenames. (line 15) * retrieving TeX: unixtex.ftp. (line 6) * right-hand side of variable assignments: Config files. (line 57) * RISINPUTS: Supported file formats. @@ -3743,9 +3890,11 @@ Index * SELFAUTOLOC: Calling sequence. (line 31) * SELFAUTOPARENT: Calling sequence. (line 31) * sending patches: Bug checklist. (line 52) -* setgid scripts: Security. (line 40) +* setgid scripts: Global font cache and security. + (line 23) * SFDFONTS: Supported file formats. (line 181) +* shell commands, security: Security. (line 23) * shell variables: Variable expansion. (line 17) * shell_escape, example for code: Programming with config files. (line 10) @@ -3758,19 +3907,19 @@ Index * sources for search paths: Path sources. (line 6) * special: Suppressing warnings. (line 30) +* st_nlink: Subdirectory expansion. + (line 26) +* ST_NLINK_TRICK: Subdirectory expansion. + (line 38) * stack trace: Bug checklist. (line 58) * standalone path searching: Invoking kpsewhich. (line 6) * standard error and debugging output: Debugging. (line 27) * standard options: Standard options. (line 6) * startup time, excessive: Slow path searching. (line 6) -* string routines: Calling sequence. (line 110) +* string routines: Calling sequence. (line 91) * strip: mktex configuration. (line 107) * stripsupplier: mktex configuration. (line 101) * striptypeface: mktex configuration. (line 104) -* st_nlink: Subdirectory expansion. - (line 26) -* ST_NLINK_TRICK: Subdirectory expansion. - (line 38) * subdirectory searching: Subdirectory expansion. (line 6) * suffixes, filename: File lookup. (line 24) @@ -3809,8 +3958,11 @@ Index * TeX file lookup: File lookup. (line 6) * TeX glyph lookup: Glyph lookup. (line 6) * TeX support: TeX support. (line 6) -* TeX Users Group: Introduction. (line 43) -* tex-file.c: File lookup. (line 38) +* TeX Users Group: Introduction. (line 42) +* TEX_HUSH: Searching overview. (line 63) +* TEX_HUSH <1>: Suppressing warnings. + (line 6) +* tex-file.c: File lookup. (line 37) * tex-file.h: Programming overview. (line 26) * tex-glyph.c: Glyph lookup. (line 26) @@ -3848,6 +4000,11 @@ Index (line 184) * TEXMF: TeX directory structure. (line 6) +* texmf_casefold_search: Casefolding search. (line 12) +* TEXMF_OUTPUT_DIRECTORY, and missfont.log: mktex script names. + (line 39) +* TEXMF_OUTPUT_DIRECTORY, and paranoid output files: Safe filenames. + (line 21) * texmf.cnf: Specially-recognized files. (line 38) * texmf.cnf missing, warning about: Config files. (line 18) @@ -3867,12 +4024,14 @@ Index * TEXMFINI <2>: Supported file formats. (line 101) * TEXMFLOG: Logging. (line 10) -* TEXMFOUTPUT: mktex script names. (line 40) +* TEXMFOUTPUT, and missfont.log: mktex script names. (line 39) +* TEXMFOUTPUT, and paranoid output files: Safe filenames. (line 21) * TEXMFSCRIPTS: Supported file formats. (line 195) +* TEXMFSYSVAR: Safe filenames. (line 26) * texmfvar: mktex configuration. (line 122) * TEXMFVAR: mktex configuration. (line 123) -* texmf_casefold_search: Casefolding search. (line 12) +* TEXMFVAR <1>: Safe filenames. (line 26) * TEXPICTS: Supported file formats. (line 79) * TEXPKS: Supported file formats. @@ -3886,9 +4045,6 @@ Index * TEXSIZES: Fallback font. (line 6) * TEXSOURCES: Supported file formats. (line 192) -* TEX_HUSH: Searching overview. (line 63) -* TEX_HUSH <1>: Suppressing warnings. - (line 6) * TFMFONTS: Supported file formats. (line 203) * tilde expansion: Tilde expansion. (line 6) @@ -3903,7 +4059,8 @@ Index (line 207) * trick for detecting leaf directories: Subdirectory expansion. (line 22) -* trojan horse attack: Security. (line 10) +* trojan horse: Safe filenames. (line 6) +* trojan horse attack: Security. (line 16) * try_std_extension_first: File lookup. (line 24) * TTFONTS: Supported file formats. (line 211) @@ -3921,11 +4078,12 @@ Index * unreadable file warnings: Suppressing warnings. (line 27) * unreadable files: Searching overview. (line 63) +* unrestricted mode, for output files: Safe filenames. (line 13) * unusable ls-R warning: ls-R. (line 51) * usage patterns, finding: Logging. (line 6) -* USERPROFILE, as ~ expansion: Tilde expansion. (line 6) * USE_TEXMFVAR: mktex configuration. (line 128) * USE_VARTEXFONTS: mktex configuration. (line 118) +* USERPROFILE, as ~ expansion: Tilde expansion. (line 6) * varfonts: mktex configuration. (line 112) * variable expansion: Variable expansion. (line 6) * variable.c: Variable expansion. (line 32) @@ -3966,62 +4124,70 @@ Index Tag Table: -Node: Top1480 -Node: Introduction2263 -Node: History4333 -Node: unixtex.ftp8929 -Node: Security10399 -Node: TeX directory structure12903 -Node: Path searching16942 -Node: Searching overview17900 -Node: Path sources21719 -Node: Config files22945 -Node: Path expansion27817 -Node: Default expansion28770 -Node: Variable expansion30840 -Node: Tilde expansion32241 -Node: Brace expansion33221 -Node: KPSE_DOT expansion34160 -Node: Subdirectory expansion34673 -Node: Casefolding search37021 -Node: Casefolding rationale37790 -Node: Casefolding examples39136 -Node: Filename database44182 -Node: ls-R45164 -Node: Filename aliases48840 -Node: Database format50018 -Node: Invoking kpsewhich51031 -Node: Path searching options51986 -Node: Specially-recognized files61589 -Node: Auxiliary tasks62944 -Node: Standard options66669 -Node: TeX support67025 -Node: Supported file formats68379 -Node: File lookup76198 -Node: Glyph lookup77947 -Node: Basic glyph lookup79071 -Node: Fontmap79951 -Node: Fallback font82461 -Node: Suppressing warnings83373 -Node: mktex scripts84500 -Node: mktex configuration85715 -Node: mktex script names91518 -Node: mktex script arguments92904 -Node: Programming93783 -Node: Programming overview94356 -Node: Calling sequence97217 -Node: Program-specific files103746 -Node: Programming with config files104769 -Node: Reporting bugs106356 -Node: Bug checklist107034 -Node: Mailing lists110503 -Node: Debugging111180 -Node: Logging116257 -Node: Common problems118124 -Node: Unable to find files118601 -Node: Slow path searching121011 -Node: Unable to generate fonts122386 -Node: TeX or Metafont failing124858 -Node: Index126060 +Node: Top1479 +Node: Introduction2261 +Node: History4352 +Node: unixtex.ftp8972 +Node: Security10454 +Node: Global font cache and security13167 +Node: TeX directory structure15158 +Node: Path searching19333 +Node: Searching overview20291 +Node: Path sources24198 +Node: Config files25468 +Node: Path expansion30516 +Node: Default expansion31485 +Node: Variable expansion33607 +Node: Tilde expansion35076 +Node: Brace expansion36124 +Node: KPSE_DOT expansion37119 +Node: Subdirectory expansion37644 +Node: Casefolding search40084 +Node: Casefolding rationale40861 +Node: Casefolding examples42219 +Node: Filename database47441 +Node: ls-R48455 +Node: Filename aliases52327 +Node: Database format53569 +Node: Invoking kpsewhich54618 +Node: Path searching options55601 +Node: Specially-recognized files65603 +Node: Auxiliary tasks67078 +Node: Standard options71222 +Node: TeX support71590 +Node: Supported file formats72948 +Node: File lookup81699 +Node: Glyph lookup83504 +Node: Basic glyph lookup84652 +Node: Fontmap85560 +Node: Fallback font88168 +Node: Suppressing warnings89104 +Node: mktex scripts90267 +Node: mktex configuration91510 +Node: mktex script names97603 +Node: mktex script arguments99286 +Node: Programming100201 +Node: Programming overview100844 +Node: Calling sequence103755 +Node: Safe filenames109092 +Ref: openout_any109251 +Node: Program-specific files113104 +Node: Programming with config files114157 +Node: Reporting bugs115804 +Node: Bug checklist116482 +Node: Mailing lists120039 +Node: Debugging120716 +Node: Logging125973 +Node: Common problems127880 +Node: Unable to find files128357 +Node: Slow path searching130813 +Node: Unable to generate fonts132208 +Node: TeX or Metafont failing134744 +Node: Index135946 End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/Master/texmf-dist/doc/info/tlbuild.info b/Master/texmf-dist/doc/info/tlbuild.info index 0893c7691bb..08cc833a086 100644 --- a/Master/texmf-dist/doc/info/tlbuild.info +++ b/Master/texmf-dist/doc/info/tlbuild.info @@ -1,9 +1,9 @@ -This is tlbuild.info, produced by makeinfo version 7.0.2 from +This is tlbuild.info, produced by makeinfo version 7.1 from tlbuild.texi. This file documents the TeX Live build system and more. -Copyright (C) 2016-2023 Karl Berry. +Copyright (C) 2016-2024 Karl Berry. Copyright (C) 2013-2015 Karl Berry & Peter Breitenlohner. Permission is granted to make and distribute verbatim copies of this @@ -33,7 +33,7 @@ END-INFO-DIR-ENTRY File: tlbuild.info, Node: Top, Next: Introduction, Up: (dir) -Building TeX Live (2023) +Building TeX Live (2024) ************************ For an overview of this manual, *note Introduction::. @@ -59,8 +59,7 @@ File: tlbuild.info, Node: Introduction, Next: Overview of build system, Prev: 1 Introduction ************** -This manual (dated February 2023) corresponds to the TeX Live 2023 -release. +This manual (dated March 2024) corresponds to the TeX Live 2024 release. This manual is aimed at system installers and programmers, and focuses on how to configure, build, and develop the TeX Live (TL) @@ -299,9 +298,13 @@ rules when a tool (such as 'tangle', 'ctangle', and 'convert') creates several output files. This allows for parallel builds ('make -j N' with N>1 or even 'make -j') that can considerably speed up the TL build. - Incidentally, a noticeable speed-up can be independently gained by -using a configure cache file, i.e., specifying the 'configure' option -'-C' (recommended). + If you're using TL's 'Build' script, you can enable '-j' with the +environment variable 'TL_MAKE_FLAGS', as in: 'env +TL_MAKE_FLAGS=-j`nproc` ./Build'. + + Independently, a noticeable speed-up can also be gained by using a +configure cache file, i.e., specifying the 'configure' option '-C' +(recommended). File: tlbuild.info, Node: Build distribution, Next: Build one package, Prev: Build in parallel, Up: Building @@ -488,6 +491,11 @@ test name exactly as specified in the '.am' file: make -C $ww check SUBDIRS=. TESTS=hitexdir/tests/hello.test + Without the 'SUBDIRS=.', errors like this will show up, since 'make' +will descend into every directory. + + fatal: making test-suite.log: failed to create hitexdir/tests/hello.test + If you get tired of looking at the 'Entering'/'Leaving directory' lines, you can add the (GNU) make option '--no-print-dir'. @@ -700,7 +708,7 @@ is made in 'BINDIR'. For example, a symlink points from 'BINDIR/ps2eps' to 'DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl'. For Windows, a standard wrapper binary (copied to, e.g., 'BINDIR/ps2eps.exe') serves the same purpose. The source for the wrapper is in -'texk/texlive/w32_wrapper'. +'texk/texlive/windows_wrapper'. One reason for this is to avoid having many copies of the same script; a more important reason is that it guarantees the scripts will @@ -816,13 +824,13 @@ many extra hassles, so don't do that, tempting as it may be. Currently the versions we use are: - autoconf (GNU Autoconf) 2.71 + autoconf (GNU Autoconf) 2.72 automake (GNU automake) 1.16.5 bison (GNU Bison) 3.8.2 flex 2.6.0 ltmain.sh (GNU libtool) 2.4.7 m4 (GNU M4) 1.4.19 - makeinfo (GNU texinfo) 7.0.2 + makeinfo (GNU texinfo) 7.1 These versions should be used to update the generated files (e.g., 'configure' or 'Makefile.in') in all or parts of the TL tree after their @@ -1085,14 +1093,14 @@ due to the lack of symbolic links. -- Macro: KPSE_COND_WIN32_WRAP Call 'KPSE_COND_WIN32' and define the Automake conditional 'WIN32_WRAP' ('true' if the standard Windows wrapper - ('texk/texlive/w32_wrapper/runscript.exe') exists. This wrapper is - used on Windows instead of symlinks for the "linked scripts" (*note - Linked scripts::). + ('texk/texlive/windows_wrapper/runscript.exe') exists. This + wrapper is used on Windows instead of symlinks for the "linked + scripts" (*note Linked scripts::). -- Macro: KPSE_WIN32_CALL Call 'KPSE_COND_WIN32' and check if the file - 'texk/texlive/w32_wrapper/callexe.c' exists; if it does, create a - symlink in the build tree. Compiling 'callexe.c' with + 'texk/texlive/windows_wrapper/callexe.c' exists; if it does, create + a symlink in the build tree. Compiling 'callexe.c' with '-DEXEPROG='"FOO.exe"'' and installing 'callexe.exe' as 'BAR.exe' is used on Windows instead of a symlink 'BAR->FOO' for Unix-like systems. @@ -3065,7 +3073,7 @@ This script and its documentation were written for the TeX Live distribution (<https://tug.org/texlive>) and both are licensed under the GNU General Public License Version 2 or later. - $Id: install-tl 66236 2023-02-27 21:44:33Z karl $ + $Id: install-tl 69711 2024-02-05 17:23:27Z karl $ File: tlbuild.info, Node: tlmgr, Next: Index, Prev: install-tl, Up: Top @@ -3089,6 +3097,7 @@ Appendix B tlmgr * tlmgr MACHINE-READABLE OUTPUT:: * tlmgr ENVIRONMENT VARIABLES:: * tlmgr AUTHORS AND COPYRIGHT:: +* tlmgr POD ERRORS:: File: tlbuild.info, Node: tlmgr NAME, Next: tlmgr SYNOPSIS, Up: tlmgr @@ -3170,6 +3179,11 @@ with 'tlmgr': installation status and description, of searches for _what_ in all packages. +'tlmgr bug' _what_ + + Display available bug-reporting information for _what_, a package + or file name. + For all the capabilities and details of 'tlmgr', please read the following voluminous information. @@ -3403,6 +3417,7 @@ B.6 ACTIONS * tlmgr help:: * tlmgr version:: * tlmgr backup:: +* tlmgr bug [_search-string_]:: * tlmgr candidates _pkg_:: * tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all]:: * tlmgr conf:: @@ -3456,7 +3471,7 @@ Gives version information (same as '--version'). reported, too. -File: tlbuild.info, Node: tlmgr backup, Next: tlmgr candidates _pkg_, Prev: tlmgr version, Up: tlmgr ACTIONS +File: tlbuild.info, Node: tlmgr backup, Next: tlmgr bug [_search-string_], Prev: tlmgr version, Up: tlmgr ACTIONS B.6.3 backup ------------ @@ -3511,9 +3526,24 @@ B.6.3 backup to be performed are written to the terminal. -File: tlbuild.info, Node: tlmgr candidates _pkg_, Next: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all], Prev: tlmgr backup, Up: tlmgr ACTIONS +File: tlbuild.info, Node: tlmgr bug [_search-string_], Next: tlmgr candidates _pkg_, Prev: tlmgr backup, Up: tlmgr ACTIONS + +B.6.4 bug [_search-string_] +--------------------------- + +Searches for _search-string_ (prompted for, if not given) as a package +name and in package descriptions, as complete words, and in filenames, +as any substring, and outputs bug-reporting and other information for +the package selected from the results. + + The search is equivalent to 'tlmgr search --word --file +_search-string_. Thus, _search-string_ is interpreted as a (Perl) +regular expression.' + + +File: tlbuild.info, Node: tlmgr candidates _pkg_, Next: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all], Prev: tlmgr bug [_search-string_], Up: tlmgr ACTIONS -B.6.4 candidates _pkg_ +B.6.5 candidates _pkg_ ---------------------- Shows the available candidate repositories for package _pkg_. See *note @@ -3522,7 +3552,7 @@ MULTIPLE REPOSITORIES: tlmgr MULTIPLE REPOSITORIES. below. File: tlbuild.info, Node: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all], Next: tlmgr conf, Prev: tlmgr candidates _pkg_, Up: tlmgr ACTIONS -B.6.5 check [_option_...] [depends|executes|files|runfiles|texmfdbs|all] +B.6.6 check [_option_...] [depends|executes|files|runfiles|texmfdbs|all] ------------------------------------------------------------------------ Execute one (or all) check(s) of the consistency of the installation. @@ -3577,7 +3607,7 @@ what is being done, run 'tlmgr -v check'.) File: tlbuild.info, Node: tlmgr conf, Next: tlmgr dump-tlpdb [_option_...] [--json], Prev: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all], Up: tlmgr ACTIONS -B.6.6 conf +B.6.7 conf ---------- *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]* @@ -3636,7 +3666,7 @@ B.6.6 conf File: tlbuild.info, Node: tlmgr dump-tlpdb [_option_...] [--json], Next: tlmgr generate, Prev: tlmgr conf, Up: tlmgr ACTIONS -B.6.7 dump-tlpdb [_option_...] [--json] +B.6.8 dump-tlpdb [_option_...] [--json] --------------------------------------- Dump complete local or remote TLPDB to standard output, as-is. The @@ -3675,7 +3705,7 @@ platform. File: tlbuild.info, Node: tlmgr generate, Next: tlmgr gui, Prev: tlmgr dump-tlpdb [_option_...] [--json], Up: tlmgr ACTIONS -B.6.8 generate +B.6.9 generate -------------- *generate [_option_...] language* @@ -3781,15 +3811,15 @@ with an extension recreates only that given language file. File: tlbuild.info, Node: tlmgr gui, Next: tlmgr info, Prev: tlmgr generate, Up: tlmgr ACTIONS -B.6.9 gui ---------- +B.6.10 gui +---------- Start the graphical user interface. See *GUI* below. File: tlbuild.info, Node: tlmgr info, Next: tlmgr init-usertree, Prev: tlmgr gui, Up: tlmgr ACTIONS -B.6.10 info +B.6.11 info ----------- *info [_option_...] _pkg_...* @@ -3890,7 +3920,7 @@ B.6.10 info File: tlbuild.info, Node: tlmgr init-usertree, Next: tlmgr install [_option_...] _pkg_..., Prev: tlmgr info, Up: tlmgr ACTIONS -B.6.11 init-usertree +B.6.12 init-usertree -------------------- Sets up a texmf tree for so-called user mode management, either the @@ -3900,7 +3930,7 @@ with '--usertree'. See *note USER MODE: tlmgr USER MODE. below. File: tlbuild.info, Node: tlmgr install [_option_...] _pkg_..., Next: tlmgr key, Prev: tlmgr init-usertree, Up: tlmgr ACTIONS -B.6.12 install [_option_...] _pkg_... +B.6.13 install [_option_...] _pkg_... ------------------------------------- Install each _pkg_ given on the command line, if it is not already @@ -3972,7 +4002,7 @@ yourself if you are using this feature and want new symlinks added. File: tlbuild.info, Node: tlmgr key, Next: tlmgr list, Prev: tlmgr install [_option_...] _pkg_..., Up: tlmgr ACTIONS -B.6.13 key +B.6.14 key ---------- *key list* @@ -3998,7 +4028,7 @@ B.6.13 key File: tlbuild.info, Node: tlmgr list, Next: tlmgr option, Prev: tlmgr key, Up: tlmgr ACTIONS -B.6.14 list +B.6.15 list ----------- Synonym for *note info: tlmgr info. @@ -4006,7 +4036,7 @@ Synonym for *note info: tlmgr info. File: tlbuild.info, Node: tlmgr option, Next: tlmgr paper, Prev: tlmgr list, Up: tlmgr ACTIONS -B.6.15 option +B.6.16 option ------------- *option [--json] [show]* @@ -4112,7 +4142,7 @@ of only the current user. All three options are on by default. File: tlbuild.info, Node: tlmgr paper, Next: tlmgr path, Prev: tlmgr option, Up: tlmgr ACTIONS -B.6.16 paper +B.6.17 paper ------------ *paper [a4|letter]* @@ -4152,7 +4182,7 @@ settings. File: tlbuild.info, Node: tlmgr path, Next: tlmgr pinning, Prev: tlmgr paper, Up: tlmgr ACTIONS -B.6.17 path +B.6.18 path ----------- *path [--windowsmode=user|admin] add* @@ -4193,7 +4223,7 @@ B.6.17 path File: tlbuild.info, Node: tlmgr pinning, Next: tlmgr platform, Prev: tlmgr path, Up: tlmgr ACTIONS -B.6.18 pinning +B.6.19 pinning -------------- The 'pinning' action manages the pinning file, see *note Pinning: tlmgr @@ -4220,7 +4250,7 @@ Pinning. below. File: tlbuild.info, Node: tlmgr platform, Next: tlmgr postaction, Prev: tlmgr pinning, Up: tlmgr ACTIONS -B.6.19 platform +B.6.20 platform --------------- *platform list|add|remove _platform_...* @@ -4261,7 +4291,7 @@ B.6.19 platform File: tlbuild.info, Node: tlmgr postaction, Next: tlmgr print-platform, Prev: tlmgr platform, Up: tlmgr ACTIONS -B.6.20 postaction +B.6.21 postaction ----------------- *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]* @@ -4298,7 +4328,7 @@ B.6.20 postaction File: tlbuild.info, Node: tlmgr print-platform, Next: tlmgr print-platform-info, Prev: tlmgr postaction, Up: tlmgr ACTIONS -B.6.21 print-platform +B.6.22 print-platform --------------------- Print the TeX Live identifier for the detected platform @@ -4308,7 +4338,7 @@ Print the TeX Live identifier for the detected platform File: tlbuild.info, Node: tlmgr print-platform-info, Next: tlmgr remove [_option_...] _pkg_..., Prev: tlmgr print-platform, Up: tlmgr ACTIONS -B.6.22 print-platform-info +B.6.23 print-platform-info -------------------------- Print the TeX Live platform identifier, TL platform long name, and @@ -4317,7 +4347,7 @@ original output from guess. File: tlbuild.info, Node: tlmgr remove [_option_...] _pkg_..., Next: tlmgr repository, Prev: tlmgr print-platform-info, Up: tlmgr ACTIONS -B.6.23 remove [_option_...] _pkg_... +B.6.24 remove [_option_...] _pkg_... ------------------------------------ Remove each _pkg_ specified. Removing a collection removes all package @@ -4376,7 +4406,7 @@ individual package with a symlink in a system directory. File: tlbuild.info, Node: tlmgr repository, Next: tlmgr restore, Prev: tlmgr remove [_option_...] _pkg_..., Up: tlmgr ACTIONS -B.6.24 repository +B.6.25 repository ----------------- *repository list* @@ -4434,7 +4464,7 @@ B.6.24 repository File: tlbuild.info, Node: tlmgr restore, Next: tlmgr search, Prev: tlmgr repository, Up: tlmgr ACTIONS -B.6.25 restore +B.6.26 restore -------------- *restore [_option_...] _pkg_ [_rev_]* @@ -4491,7 +4521,7 @@ B.6.25 restore File: tlbuild.info, Node: tlmgr search, Next: tlmgr shell, Prev: tlmgr restore, Up: tlmgr ACTIONS -B.6.26 search +B.6.27 search ------------- *search [_option_...] _what_* @@ -4530,7 +4560,7 @@ B.6.26 search File: tlbuild.info, Node: tlmgr shell, Next: tlmgr show, Prev: tlmgr search, Up: tlmgr ACTIONS -B.6.27 shell +B.6.28 shell ------------ Starts an interactive mode, where tlmgr prompts for commands. This can @@ -4592,7 +4622,7 @@ get [_var_] =item set [_var_ [_val_]] File: tlbuild.info, Node: tlmgr show, Next: tlmgr uninstall, Prev: tlmgr shell, Up: tlmgr ACTIONS -B.6.28 show +B.6.29 show ----------- Synonym for *note info: tlmgr info. @@ -4600,7 +4630,7 @@ Synonym for *note info: tlmgr info. File: tlbuild.info, Node: tlmgr uninstall, Next: tlmgr update [_option_...] [_pkg_...], Prev: tlmgr show, Up: tlmgr ACTIONS -B.6.29 uninstall +B.6.30 uninstall ---------------- Synonym for *note remove: tlmgr remove [_option_...] _pkg_.... @@ -4608,7 +4638,7 @@ Synonym for *note remove: tlmgr remove [_option_...] _pkg_.... File: tlbuild.info, Node: tlmgr update [_option_...] [_pkg_...], Prev: tlmgr uninstall, Up: tlmgr ACTIONS -B.6.30 update [_option_...] [_pkg_...] +B.6.31 update [_option_...] [_pkg_...] -------------------------------------- Updates the packages given as arguments to the latest version available @@ -5671,7 +5701,7 @@ normal user installations. used, regardless of any setting. -File: tlbuild.info, Node: tlmgr AUTHORS AND COPYRIGHT, Prev: tlmgr ENVIRONMENT VARIABLES, Up: tlmgr +File: tlbuild.info, Node: tlmgr AUTHORS AND COPYRIGHT, Next: tlmgr POD ERRORS, Prev: tlmgr ENVIRONMENT VARIABLES, Up: tlmgr B.14 AUTHORS AND COPYRIGHT ========================== @@ -5680,7 +5710,20 @@ This script and its documentation were written for the TeX Live distribution (<https://tug.org/texlive>) and both are licensed under the GNU General Public License Version 2 or later. - $Id: tlmgr.pl 66236 2023-02-27 21:44:33Z karl $ + $Id: tlmgr.pl 70001 2024-02-19 23:17:07Z karl $ + + +File: tlbuild.info, Node: tlmgr POD ERRORS, Prev: tlmgr AUTHORS AND COPYRIGHT, Up: tlmgr + +B.15 POD ERRORS +=============== + +Hey! *The above document had some coding errors, which are explained +below:* + +Around line 8454: + + Unterminated C<...> sequence File: tlbuild.info, Node: Index, Prev: tlmgr, Up: Top @@ -5691,7 +5734,6 @@ Index * Menu: -* $@ target in normal make rules: Prerequisites. (line 13) * --bindir configure option: --prefix --bindir .... (line 6) * --bindir configure option <1>: --enable-multiplatform. @@ -5766,7 +5808,7 @@ Index * --host=HOST: Cross configuring. (line 6) * --libdir configure option: --enable-multiplatform. (line 6) -* --no-print-directory GNU make option: Build one engine. (line 56) +* --no-print-directory GNU make option: Build one engine. (line 61) * --prefix configure option: --prefix --bindir .... (line 6) * --with-banner-add=STR: Configure options for texk/web2c. @@ -5799,8 +5841,9 @@ Index (line 12) * --without-ln-s: --without-ln-s. (line 6) * --without-x: --without-x. (line 6) -* -C configure option: Build in parallel. (line 11) +* -C configure option: Build in parallel. (line 15) * -j make option: Build in parallel. (line 6) +* $@ target in normal make rules: Prerequisites. (line 13) * ac/withenable.ac: Adding a new program module. (line 42) * adapting TeX Live for distros: Distro builds. (line 54) @@ -5849,19 +5892,19 @@ Index * building: Building. (line 6) * building a distribution: Build distribution. (line 6) * building in parallel: Build in parallel. (line 6) -* C++11, removing dependent sources: Build one package. (line 85) -* C++11, required: Prerequisites. (line 17) * C, ANSI, required: Declarations and definitions. (line 6) +* C++11, removing dependent sources: Build one package. (line 85) +* C++11, required: Prerequisites. (line 17) * C99, avoided: Declarations and definitions. (line 6) -* cache file, for configure: Build in parallel. (line 11) +* cache file, for configure: Build in parallel. (line 15) * cache for configure: Build in parallel. (line 6) * callexe.c: Macros for Windows. (line 32) * CC: Variables for configure. (line 10) -* CC=C-COMPILER: Build one package. (line 77) * CC_BUILD: Cross problems. (line 13) +* CC=C-COMPILER: Build one package. (line 77) * ChangeLog: Adding a new program module. (line 73) * chktex: Declarations and definitions. @@ -5957,10 +6000,10 @@ Index * fontconfig library, required by xetex: Prerequisites. (line 40) * freetype cross compiling: Cross problems. (line 13) * freetype library: freetype library. (line 6) -* FreeType, requires gmake: Prerequisites. (line 13) * freetype-config: freetype library. (line 13) * freetype-config <1>: Variables for configure. (line 24) +* FreeType, requires gmake: Prerequisites. (line 13) * FT2_CONFIG: Variables for configure. (line 21) * gcc, default compilers: Build one package. (line 77) @@ -5984,11 +6027,11 @@ Index * ICU cross compiling: Cross problems. (line 20) * ICU libraries: Variables for configure. (line 24) -* ICU, requires C++11: Prerequisites. (line 17) -* icu-config: Variables for configure. - (line 24) * ICU_CONFIG: Variables for configure. (line 22) +* icu-config: Variables for configure. + (line 24) +* ICU, requires C++11: Prerequisites. (line 17) * infrastructure, tools needed for: Build system tools. (line 6) * inst/ top-level directory: Top-level directories. (line 39) @@ -6003,14 +6046,6 @@ Index (line 6) * kpathsea library: kpathsea library. (line 6) * kpathsea.ac: kpathsea library. (line 18) -* kpse-libpng-flags.m4: png library. (line 45) -* kpse-pkgs.m4: Overview of build system. - (line 30) -* kpse-zlib-flags.m4: zlib library. (line 6) -* kpsewhich: Variables for configure. - (line 30) -* KPSEWHICH: Variables for configure. - (line 29) * KPSE_ADD_FLAGS: Macros for library and header flags. (line 20) * KPSE_ALL_SYSTEM_FLAGS: Adding a new generic library module. @@ -6043,17 +6078,17 @@ Index (line 14) * KPSE_LARGEFILE: Macros for libraries. (line 8) -* KPSE_LIBPNG_FLAGS: Macros for library and header flags. - (line 10) -* KPSE_LIBPNG_FLAGS <1>: png library. (line 45) -* kpse_libs_pkgs: Adding a new generic library module. - (line 6) * KPSE_LIB_FLAGS: Macros for library and header flags. (line 6) * KPSE_LIB_FLAGS <1>: Adding a new generic library module. (line 26) * KPSE_LIB_SYSTEM_FLAGS: Adding a new generic library module. (line 34) +* KPSE_LIBPNG_FLAGS: Macros for library and header flags. + (line 10) +* KPSE_LIBPNG_FLAGS <1>: png library. (line 45) +* kpse_libs_pkgs: Adding a new generic library module. + (line 6) * KPSE_PROG_LEX: Macros for programs. (line 21) * KPSE_RESTORE_FLAGS: Macros for library and header flags. (line 24) @@ -6074,6 +6109,14 @@ Index (line 11) * KPSE_WITH_TEXLIB: Adding a new TeX-specific library module. (line 14) +* kpse-libpng-flags.m4: png library. (line 45) +* kpse-pkgs.m4: Overview of build system. + (line 30) +* kpse-zlib-flags.m4: zlib library. (line 6) +* kpsewhich: Variables for configure. + (line 30) +* KPSEWHICH: Variables for configure. + (line 29) * large file support: --disable-largefile. (line 6) * LATEX: Variables for configure. (line 40) @@ -6223,6 +6266,7 @@ Index * TEXMFROOT for running standalone: Build one package. (line 44) * tie: Cross problems. (line 26) * timestamps, in repository: Build system tools. (line 38) +* TL_MAKE_FLAGS: Build in parallel. (line 11) * TLpatches/patch-...: Adding a new program module. (line 68) * TLpatches/TL-Changes: Adding a new program module. @@ -6241,15 +6285,15 @@ Index (line 52) * variables for configure: Variables for configure. (line 6) -* warning, discards qualifiers: Const. (line 30) * WARNING_C[XX]FLAGS: Macros for compilers. (line 9) +* warning, discards qualifiers: Const. (line 30) * web2c program: Cross problems. (line 13) * web2c.ac: Configure options for texk/web2c. (line 37) * wget: Linked scripts. (line 23) -* WIN32, Automake conditional: Macros for Windows. (line 16) * WIN32_WRAP, Automake conditional: Macros for Windows. (line 25) +* WIN32, Automake conditional: Macros for Windows. (line 16) * Windows, invoking scripts on: Linked scripts. (line 6) * Windows, macros for: Macros for Windows. (line 6) * withenable.ac, for new modules: Adding a new program module. @@ -6285,427 +6329,431 @@ Index Tag Table: -Node: Top1210 -Node: Introduction2120 -Node: Overview of build system3948 -Node: Prerequisites5999 -Ref: Prerequisites-Footnote-18998 -Node: Building9301 -Node: Build iteration10643 -Node: Build in parallel11687 -Node: Build distribution12292 -Node: Build one package12940 -Node: Build one engine17653 -Node: Cross compilation20078 -Node: Cross configuring21357 -Node: Cross problems23034 -Node: Installing24696 -Node: Installation directories25716 -Node: Linked scripts27534 -Node: Distro builds29025 -Node: Layout and infrastructure31401 -Node: Build system tools32232 -Node: Top-level directories34451 -Node: Autoconf macros36687 -Node: General setup macros37449 -Node: Macros for programs38324 -Node: Macros for compilers39125 -Node: Macros for libraries40533 -Node: Macros for library and header flags40959 -Node: Macros for Windows42870 -Node: Library modules44457 -Node: png library44946 -Node: zlib library47294 -Node: freetype library47809 -Node: kpathsea library48505 -Node: Program modules49884 -Node: t1utils package50312 -Node: xindy package50857 -Node: xdvik package51973 -Node: asymptote53032 -Node: Extending TeX Live53536 -Node: Adding a new program module54343 -Node: Adding a new engine59106 -Node: Adding a new generic library module60891 -Node: Adding a new TeX-specific library module63112 -Node: Configure options63810 -Node: Global configure options65191 -Node: --disable-native-texlive-build65733 -Node: --prefix --bindir ...66695 -Node: --disable-largefile67235 -Node: --disable-missing67777 -Node: --enable-compiler-warnings=LEVEL68178 -Node: --enable-cxx-runtime-hack68834 -Node: --enable-maintainer-mode69254 -Node: --enable-multiplatform69783 -Node: --enable-shared70356 -Node: --enable-silent-rules70727 -Node: --without-ln-s71179 -Node: --without-x71526 -Node: Program-specific configure options71714 -Node: --enable-PROG --disable-PROG72357 -Node: --disable-all-pkgs72630 -Node: Configure options for texk/web2c73413 -Node: Configure options for texk/bibtex-x75951 -Node: Configure options for texk/dvipdfm-x76494 -Node: Configure options for texk/dvisvgm77270 -Node: Configure options for texk/texlive78151 -Node: Configure options for texk/xdvik78572 -Node: Configure options for utils/xindy79193 -Node: Library-specific configure options80083 -Node: Configure options for kpathsea81044 -Node: Variables for configure81748 -Node: Coding conventions83174 -Node: Declarations and definitions83889 -Node: Const86063 -Node: Continuous integration87927 -Node: Transfer from Subversion to Github88591 -Node: Automatic update of the Git mirror90753 -Node: CI testing on Travis-CI91335 -Node: Releases on Github92044 -Node: install-tl92484 -Node: install-tl NAME92928 -Node: install-tl SYNOPSIS93108 -Node: install-tl DESCRIPTION93346 -Node: install-tl REFERENCES94543 -Node: install-tl EXAMPLES95152 -Ref: install-tl install-tl --paper=letter95603 -Ref: install-tl install-tl --scheme _scheme_95739 -Ref: install-tl install-tl --no-interaction95894 -Ref: install-tl install-tl --profile _texlive.profile_96046 -Node: install-tl OPTIONS96314 -Ref: install-tl *-gui* [[=]_module_]96811 -Ref: install-tl *-no-gui*96822 -Ref: install-tl text97030 -Ref: install-tl tcl (or "perltk" or "wizard" or "expert" or nothing)97215 -Ref: install-tl *-lang* _llcode_97847 -Ref: install-tl *-repository* _url|path_98471 -Ref: install-tl *-select-repository*99365 -Ref: install-tl *-all-options*99783 -Ref: install-tl *-custom-bin* _path_100038 -Ref: install-tl *-debug-fakenet*100870 -Ref: install-tl *-debug-setup-vars*101084 -Ref: install-tl *-debug-translation*101232 -Ref: install-tl *-force-platform* _platform_101508 -Ref: install-tl *-help*, *--help*, *-?*101766 -Ref: install-tl *-in-place*102179 -Ref: install-tl *-init-from-profile* _profile_file_102724 -Ref: install-tl *-logfile* _file_102993 -Ref: install-tl *-no-cls*103344 -Ref: install-tl *-no-continue*103471 -Ref: install-tl *-no-doc-install*104042 -Ref: install-tl *-no-src-install*104061 -Ref: install-tl *-no-installation*104852 -Ref: install-tl *-no-interaction*105003 -Ref: install-tl *-no-persistent-downloads*105260 -Ref: install-tl *-persistent-downloads*105285 -Ref: install-tl *-no-verify-downloads*105892 -Ref: install-tl *-non-admin*106255 -Ref: install-tl *-paper* a4*|*letter106361 -Ref: install-tl *-portable*106557 -Ref: install-tl *-print-platform*106694 -Ref: install-tl *-profile* _profile_file_106892 -Ref: install-tl *-q*107113 -Ref: install-tl *-scheme* _scheme_107175 -Ref: install-tl *-texdir* _dir_107576 -Ref: install-tl *-texuserdir* _dir_108181 -Ref: install-tl *-texmflocal* _dir_108470 -Ref: install-tl *-texmfhome* _dir_109095 -Ref: install-tl *-texmfsysconfig* _dir_109404 -Ref: install-tl *-texmfsysvar* _dir_109426 -Ref: install-tl *-texmfconfig* _dir_109521 -Ref: install-tl *-texmfvar* _dir_109540 -Ref: install-tl *-v*109748 -Ref: install-tl *-version*, *--version*109904 -Node: install-tl PROFILES110038 -Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)113054 -Ref: install-tl instopt_adjustrepo (default 1)113130 -Ref: install-tl instopt_letter (default 0)113267 -Ref: install-tl instopt_portable (default 0)113358 -Ref: install-tl instopt_write18_restricted (default 1)113897 -Node: install-tl ENVIRONMENT VARIABLES115236 -Ref: install-tl NOPERLDOC115599 -Ref: install-tl TEXLIVE_DOWNLOADER115684 -Ref: install-tl TL_DOWNLOAD_PROGRAM115707 -Ref: install-tl TL_DOWNLOAD_ARGS115727 -Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK115931 -Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE116133 -Ref: install-tl TEXLIVE_INSTALL_NO_DISKCHECK116245 -Ref: install-tl TEXLIVE_INSTALL_NO_RESUME116661 -Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME116813 -Ref: install-tl TEXLIVE_INSTALL_PAPER116934 -Ref: install-tl TEXLIVE_INSTALL_PREFIX117080 -Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG117111 -Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR117139 -Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME117168 -Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL117198 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG117232 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR117263 -Node: install-tl DIRECTORY TREES117701 -Node: install-tl BUGS120285 -Node: install-tl AUTHORS AND COPYRIGHT121165 -Node: tlmgr121563 -Node: tlmgr NAME122048 -Node: tlmgr SYNOPSIS122192 -Node: tlmgr DESCRIPTION122394 -Node: tlmgr EXAMPLES123505 -Ref: tlmgr tlmgr option repository ctan123768 -Ref: tlmgr tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet123841 -Ref: tlmgr tlmgr update --list124446 -Ref: tlmgr tlmgr update --all124539 -Ref: tlmgr tlmgr info _what_124696 -Node: tlmgr OPTIONS124958 -Ref: tlmgr *--repository* _url|path_125491 -Ref: tlmgr /some/local/dir126677 -Ref: tlmgr file:/some/local/dir126706 -Ref: tlmgr ctan126779 -Ref: tlmgr https://mirror.ctan.org/systems/texlive/tlnet126833 -Ref: tlmgr http://server/path/to/tlnet127174 -Ref: tlmgr https://server/path/to/tlnet127555 -Ref: tlmgr ftp://server/path/to/tlnet128023 -Ref: tlmgr user@machine:/path/to/tlnet128155 -Ref: tlmgr scp://user@machine/path/to/tlnet128196 -Ref: tlmgr ssh://user@machine/path/to/tlnet128237 -Ref: tlmgr *--gui* [_action_]128631 -Ref: tlmgr *--gui-lang* _llcode_129445 -Ref: tlmgr *--command-logfile* _file_130187 -Ref: tlmgr *--debug-translation*130454 -Ref: tlmgr *--machine-readable*130658 -Ref: tlmgr *--no-execute-actions*130927 -Ref: tlmgr *--package-logfile* _file_131121 -Ref: tlmgr *--pause*131376 -Ref: tlmgr *--persistent-downloads*131532 -Ref: tlmgr *--no-persistent-downloads*131561 -Ref: tlmgr *--pin-file*132056 -Ref: tlmgr *--usermode*132275 -Ref: tlmgr *--usertree* _dir_132396 -Ref: tlmgr *--verify-repo=[none|main|all]*132523 -Node: tlmgr ACTIONS133422 -Node: tlmgr help134283 -Node: tlmgr version134760 -Node: tlmgr backup135023 -Ref: tlmgr *backup [_option_...] --all*135195 -Ref: tlmgr *backup [_option_...] _pkg_...*135228 -Ref: tlmgr *--backupdir* _directory_136295 -Ref: tlmgr *--all*136513 -Ref: tlmgr *--clean*[=_N_]136766 -Ref: tlmgr *--dry-run*137094 -Node: tlmgr candidates _pkg_137224 -Node: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all]137579 -Ref: tlmgr *depends*138093 -Ref: tlmgr *executes*138435 -Ref: tlmgr *files*138550 -Ref: tlmgr *runfiles*138686 -Ref: tlmgr *texmfdbs*138823 -Ref: tlmgr - all items in TEXMFDBS have the !! prefix.139053 -Ref: tlmgr - all items in TEXMFBDS have an ls-R file (if they exist at all).139129 -Ref: tlmgr - all items in TEXMF with !! are listed in TEXMFDBS.139194 -Ref: tlmgr - all items in TEXMF with an ls-R file are listed in TEXMFDBS.139269 -Ref: tlmgr *--use-svn*139295 -Node: tlmgr conf139436 -Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*139726 -Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|remove] [_value_]*139791 -Node: tlmgr dump-tlpdb [_option_...] [--json]142207 -Ref: tlmgr *--local*142643 -Ref: tlmgr *--remote*142683 -Ref: tlmgr *--json*142722 -Node: tlmgr generate143293 -Ref: tlmgr *generate [_option_...] language*143489 -Ref: tlmgr *generate [_option_...] language.dat*143528 -Ref: tlmgr *generate [_option_...] language.def*143567 -Ref: tlmgr *generate [_option_...] language.dat.lua*143610 -Ref: tlmgr *--dest* _output_file_145938 -Ref: tlmgr *--localcfg* _local_conf_file_146515 -Ref: tlmgr *--rebuild-sys*146639 -Node: tlmgr gui147454 -Node: tlmgr info147632 -Ref: tlmgr *info [_option_...] _pkg_...*147794 -Ref: tlmgr *info [_option_...] collections*147828 -Ref: tlmgr *info [_option_...] schemes*147858 -Ref: tlmgr *--list*149389 -Ref: tlmgr *--only-installed*149704 -Ref: tlmgr *--only-remote*149893 -Ref: tlmgr *--data item1,item2,...*150198 -Ref: tlmgr *--json* 1151571 -Node: tlmgr init-usertree151954 -Node: tlmgr install [_option_...] _pkg_...152335 -Ref: tlmgr *--dry-run* 1152844 -Ref: tlmgr *--file*152962 -Ref: tlmgr *--force*153185 -Ref: tlmgr *--no-depends*153406 -Ref: tlmgr *--no-depends-at-all*153566 -Ref: tlmgr *--reinstall*153967 -Ref: tlmgr *--with-doc*154346 -Ref: tlmgr *--with-src*154360 -Node: tlmgr key155088 -Ref: tlmgr *key list*155246 -Ref: tlmgr *key add _file_*155264 -Ref: tlmgr *key remove _keyid_*155286 -Node: tlmgr list155880 -Node: tlmgr option156042 -Ref: tlmgr *option [--json] [show]*156198 -Ref: tlmgr *option [--json] showall|help*156230 -Ref: tlmgr *option _key_ [_value_]*156256 -Node: tlmgr paper160835 -Ref: tlmgr *paper [a4|letter]*160984 -Ref: tlmgr *<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*>161061 -Ref: tlmgr *paper --json*161077 -Node: tlmgr path162292 -Ref: tlmgr *path [--windowsmode=user|admin] add*162458 -Ref: tlmgr *path [--windowsmode=user|admin] remove*162500 -Node: tlmgr pinning164015 -Ref: tlmgr pinning show164256 -Ref: tlmgr pinning add _repo_ _pkgglob_...164329 -Ref: tlmgr pinning remove _repo_ _pkgglob_...164448 -Ref: tlmgr pinning remove _repo_ --all164601 -Node: tlmgr platform164655 -Ref: tlmgr *platform list|add|remove _platform_...*164841 -Ref: tlmgr *platform set _platform_*164868 -Ref: tlmgr *platform set auto*164889 -Ref: tlmgr *--dry-run* 2165767 -Node: tlmgr postaction165886 -Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*166116 -Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*166190 -Ref: tlmgr *--windowsmode=[user|admin]*166510 -Ref: tlmgr *--fileassocmode=[1|2]*166935 -Ref: tlmgr *--all* 1167221 -Node: tlmgr print-platform167276 -Node: tlmgr print-platform-info167607 -Node: tlmgr remove [_option_...] _pkg_...167907 -Ref: tlmgr *--all* 2168392 -Ref: tlmgr *--backup*168503 -Ref: tlmgr *--backupdir* _directory_ 1168530 -Ref: tlmgr *--no-depends* 1168935 -Ref: tlmgr *--no-depends-at-all* 1168998 -Ref: tlmgr *--force* 1169105 -Ref: tlmgr *--dry-run* 3169579 -Node: tlmgr repository169956 -Ref: tlmgr *repository list*170144 -Ref: tlmgr *repository list _path|url|tag_*170178 -Ref: tlmgr *repository add _path_ [_tag_]*170211 -Ref: tlmgr *repository remove _path|tag_*170243 -Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*170297 -Ref: tlmgr *repository status*170318 -Ref: tlmgr The tag (which can be the same as the url);171545 -Node: tlmgr restore172023 -Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*172202 -Ref: tlmgr *restore [_option_...] --all*172233 -Ref: tlmgr *--all* 3172934 -Ref: tlmgr *--backupdir* _directory_ 2173149 -Ref: tlmgr *--dry-run* 4173331 -Ref: tlmgr *--force* 2173464 -Ref: tlmgr *--json* 2173511 -Node: tlmgr search173838 -Ref: tlmgr *search [_option_...] _what_*174002 -Ref: tlmgr *search [_option_...] --file _what_*174040 -Ref: tlmgr *search [_option_...] --all _what_*174077 -Ref: tlmgr *--file* 1174298 -Ref: tlmgr *--all* 4174361 -Ref: tlmgr *--global*174451 -Ref: tlmgr *--word*174579 -Node: tlmgr shell174894 -Ref: tlmgr protocol175629 -Ref: tlmgr help 1175693 -Ref: tlmgr version 1175746 -Ref: tlmgr quit, end, bye, byebye, EOF175814 -Ref: tlmgr restart175835 -Ref: tlmgr load [local|remote]175958 -Ref: tlmgr save176028 -Ref: tlmgr get [_var_] =item set [_var_ [_val_]]176151 -Node: tlmgr show176752 -Node: tlmgr uninstall176919 -Node: tlmgr update [_option_...] [_pkg_...]177151 -Ref: tlmgr *--all* 5177523 -Ref: tlmgr *--self*179703 -Ref: tlmgr *--dry-run* 5180468 -Ref: tlmgr *--list* [_pkg_]180646 -Ref: tlmgr *--exclude* _pkg_181336 -Ref: tlmgr *--no-auto-remove* [_pkg_...]182137 -Ref: tlmgr *--no-auto-install* [_pkg_...]182622 -Ref: tlmgr *--reinstall-forcibly-removed*183385 -Ref: tlmgr *--backup* 1183921 -Ref: tlmgr *--backupdir* _directory_ 3183948 -Ref: tlmgr *--no-depends* 2185115 -Ref: tlmgr *--no-depends-at-all* 2185319 -Ref: tlmgr *--force* 3185426 -Node: tlmgr CONFIGURATION FILE FOR TLMGR186417 -Ref: tlmgr auto-remove = 0 or 1 (default 1), same as command-line option.187419 -Ref: tlmgr gui-expertmode = 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.187551 -Ref: tlmgr gui-lang = _llcode_, with a language code value as with the command-line option.187635 -Ref: tlmgr no-checksums = 0 or 1 (default 0, see below).187684 -Ref: tlmgr persistent-downloads = 0 or 1 (default 1), same as command-line option.187759 -Ref: tlmgr require-verification = 0 or 1 (default 0), same as command-line option.187834 -Ref: tlmgr tkfontscale = _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends.187942 -Ref: tlmgr update-exclude = _comma-separated list of packages_ (no spaces allowed). Same as the command line option --exclude for the update action.188087 -Ref: tlmgr verify-downloads = 0 or 1 (default 1), same as command-line option.188158 -Ref: tlmgr allowed-actions = _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode). This allows distributors to include tlmgr in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this.188675 -Node: tlmgr CRYPTOGRAPHIC VERIFICATION189507 -Node: tlmgr Configuration of GnuPG invocation191680 -Node: tlmgr USER MODE192318 -Node: tlmgr User mode install195189 -Node: tlmgr User mode backup, restore, remove, update196335 -Node: tlmgr User mode generate, option, paper196781 -Node: tlmgr User mode logs197148 -Node: tlmgr MULTIPLE REPOSITORIES197446 -Node: tlmgr Pinning199175 -Node: tlmgr GUI FOR TLMGR201098 -Node: tlmgr Main display202747 -Node: tlmgr Display configuration area202999 -Ref: tlmgr Status203360 -Ref: tlmgr Category203524 -Ref: tlmgr Match203710 -Ref: tlmgr Selection203891 -Ref: tlmgr Display configuration buttons204095 -Node: tlmgr Package list area204278 -Ref: tlmgr a checkbox204862 -Ref: tlmgr package name204998 -Ref: tlmgr local revision (and version)205097 -Ref: tlmgr remote revision (and version)205472 -Ref: tlmgr short description205769 -Node: tlmgr Main display action buttons205814 -Ref: tlmgr Update all installed206080 -Ref: tlmgr Update206452 -Ref: tlmgr Install206502 -Ref: tlmgr Remove206688 -Ref: tlmgr Backup206866 -Node: tlmgr Menu bar207023 -Ref: tlmgr tlmgr menu207246 -Ref: tlmgr Options menu207554 -Ref: tlmgr Actions menu208637 -Ref: tlmgr Help menu209065 -Node: tlmgr GUI options209199 -Ref: tlmgr -background _color_209445 -Ref: tlmgr -font " _fontname_ _fontsize_ "209510 -Ref: tlmgr -foreground _color_209668 -Ref: tlmgr -geometry _geomspec_209720 -Ref: tlmgr -xrm _xresource_209912 -Node: tlmgr MACHINE-READABLE OUTPUT210181 -Node: tlmgr Machine-readable update and install output210995 -Ref: tlmgr location-url _location_212271 -Ref: tlmgr total-bytes _count_212487 -Ref: tlmgr _pkgname_212897 -Ref: tlmgr _status_213107 -Ref: tlmgr d213185 -Ref: tlmgr f213245 -Ref: tlmgr u213424 -Ref: tlmgr r213470 -Ref: tlmgr a213593 -Ref: tlmgr i213771 -Ref: tlmgr I213890 -Ref: tlmgr _localrev_213992 -Ref: tlmgr _serverrev_214099 -Ref: tlmgr _size_214211 -Ref: tlmgr _runtime_214380 -Ref: tlmgr _esttot_214450 -Node: tlmgr Machine-readable option output214483 -Node: tlmgr ENVIRONMENT VARIABLES214995 -Ref: tlmgr TEXLIVE_COMPRESSOR215506 -Ref: tlmgr TEXLIVE_DOWNLOADER216354 -Ref: tlmgr TL_DOWNLOAD_PROGRAM216377 -Ref: tlmgr TL_DOWNLOAD_ARGS216397 -Ref: tlmgr TEXLIVE_PREFER_OWN217423 -Node: tlmgr AUTHORS AND COPYRIGHT218247 -Node: Index218645 +Node: Top1208 +Node: Introduction2118 +Node: Overview of build system3943 +Node: Prerequisites5994 +Ref: Prerequisites-Footnote-18993 +Node: Building9296 +Node: Build iteration10638 +Node: Build in parallel11682 +Node: Build distribution12433 +Node: Build one package13081 +Node: Build one engine17794 +Node: Cross compilation20406 +Node: Cross configuring21685 +Node: Cross problems23362 +Node: Installing25024 +Node: Installation directories26044 +Node: Linked scripts27862 +Node: Distro builds29357 +Node: Layout and infrastructure31733 +Node: Build system tools32564 +Node: Top-level directories34781 +Node: Autoconf macros37017 +Node: General setup macros37779 +Node: Macros for programs38654 +Node: Macros for compilers39455 +Node: Macros for libraries40863 +Node: Macros for library and header flags41289 +Node: Macros for Windows43200 +Node: Library modules44795 +Node: png library45284 +Node: zlib library47632 +Node: freetype library48147 +Node: kpathsea library48843 +Node: Program modules50222 +Node: t1utils package50650 +Node: xindy package51195 +Node: xdvik package52311 +Node: asymptote53370 +Node: Extending TeX Live53874 +Node: Adding a new program module54681 +Node: Adding a new engine59444 +Node: Adding a new generic library module61229 +Node: Adding a new TeX-specific library module63450 +Node: Configure options64148 +Node: Global configure options65529 +Node: --disable-native-texlive-build66071 +Node: --prefix --bindir ...67033 +Node: --disable-largefile67573 +Node: --disable-missing68115 +Node: --enable-compiler-warnings=LEVEL68516 +Node: --enable-cxx-runtime-hack69172 +Node: --enable-maintainer-mode69592 +Node: --enable-multiplatform70121 +Node: --enable-shared70694 +Node: --enable-silent-rules71065 +Node: --without-ln-s71517 +Node: --without-x71864 +Node: Program-specific configure options72052 +Node: --enable-PROG --disable-PROG72695 +Node: --disable-all-pkgs72968 +Node: Configure options for texk/web2c73751 +Node: Configure options for texk/bibtex-x76289 +Node: Configure options for texk/dvipdfm-x76832 +Node: Configure options for texk/dvisvgm77608 +Node: Configure options for texk/texlive78489 +Node: Configure options for texk/xdvik78910 +Node: Configure options for utils/xindy79531 +Node: Library-specific configure options80421 +Node: Configure options for kpathsea81382 +Node: Variables for configure82086 +Node: Coding conventions83512 +Node: Declarations and definitions84227 +Node: Const86401 +Node: Continuous integration88265 +Node: Transfer from Subversion to Github88929 +Node: Automatic update of the Git mirror91091 +Node: CI testing on Travis-CI91673 +Node: Releases on Github92382 +Node: install-tl92822 +Node: install-tl NAME93266 +Node: install-tl SYNOPSIS93446 +Node: install-tl DESCRIPTION93684 +Node: install-tl REFERENCES94881 +Node: install-tl EXAMPLES95490 +Ref: install-tl install-tl --paper=letter95941 +Ref: install-tl install-tl --scheme _scheme_96077 +Ref: install-tl install-tl --no-interaction96232 +Ref: install-tl install-tl --profile _texlive.profile_96384 +Node: install-tl OPTIONS96652 +Ref: install-tl *-gui* [[=]_module_]97149 +Ref: install-tl *-no-gui*97160 +Ref: install-tl text97368 +Ref: install-tl tcl (or "perltk" or "wizard" or "expert" or nothing)97553 +Ref: install-tl *-lang* _llcode_98185 +Ref: install-tl *-repository* _url|path_98809 +Ref: install-tl *-select-repository*99703 +Ref: install-tl *-all-options*100121 +Ref: install-tl *-custom-bin* _path_100376 +Ref: install-tl *-debug-fakenet*101208 +Ref: install-tl *-debug-setup-vars*101422 +Ref: install-tl *-debug-translation*101570 +Ref: install-tl *-force-platform* _platform_101846 +Ref: install-tl *-help*, *--help*, *-?*102104 +Ref: install-tl *-in-place*102517 +Ref: install-tl *-init-from-profile* _profile_file_103062 +Ref: install-tl *-logfile* _file_103331 +Ref: install-tl *-no-cls*103682 +Ref: install-tl *-no-continue*103809 +Ref: install-tl *-no-doc-install*104380 +Ref: install-tl *-no-src-install*104399 +Ref: install-tl *-no-installation*105190 +Ref: install-tl *-no-interaction*105341 +Ref: install-tl *-no-persistent-downloads*105598 +Ref: install-tl *-persistent-downloads*105623 +Ref: install-tl *-no-verify-downloads*106230 +Ref: install-tl *-non-admin*106593 +Ref: install-tl *-paper* a4*|*letter106699 +Ref: install-tl *-portable*106895 +Ref: install-tl *-print-platform*107032 +Ref: install-tl *-profile* _profile_file_107230 +Ref: install-tl *-q*107451 +Ref: install-tl *-scheme* _scheme_107513 +Ref: install-tl *-texdir* _dir_107914 +Ref: install-tl *-texuserdir* _dir_108519 +Ref: install-tl *-texmflocal* _dir_108808 +Ref: install-tl *-texmfhome* _dir_109433 +Ref: install-tl *-texmfsysconfig* _dir_109742 +Ref: install-tl *-texmfsysvar* _dir_109764 +Ref: install-tl *-texmfconfig* _dir_109859 +Ref: install-tl *-texmfvar* _dir_109878 +Ref: install-tl *-v*110086 +Ref: install-tl *-version*, *--version*110242 +Node: install-tl PROFILES110376 +Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)113392 +Ref: install-tl instopt_adjustrepo (default 1)113468 +Ref: install-tl instopt_letter (default 0)113605 +Ref: install-tl instopt_portable (default 0)113696 +Ref: install-tl instopt_write18_restricted (default 1)114235 +Node: install-tl ENVIRONMENT VARIABLES115574 +Ref: install-tl NOPERLDOC115937 +Ref: install-tl TEXLIVE_DOWNLOADER116022 +Ref: install-tl TL_DOWNLOAD_PROGRAM116045 +Ref: install-tl TL_DOWNLOAD_ARGS116065 +Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK116269 +Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE116471 +Ref: install-tl TEXLIVE_INSTALL_NO_DISKCHECK116583 +Ref: install-tl TEXLIVE_INSTALL_NO_RESUME116999 +Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME117151 +Ref: install-tl TEXLIVE_INSTALL_PAPER117272 +Ref: install-tl TEXLIVE_INSTALL_PREFIX117418 +Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG117449 +Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR117477 +Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME117506 +Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL117536 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG117570 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR117601 +Node: install-tl DIRECTORY TREES118039 +Node: install-tl BUGS120623 +Node: install-tl AUTHORS AND COPYRIGHT121503 +Node: tlmgr121901 +Node: tlmgr NAME122407 +Node: tlmgr SYNOPSIS122551 +Node: tlmgr DESCRIPTION122753 +Node: tlmgr EXAMPLES123864 +Ref: tlmgr tlmgr option repository ctan124127 +Ref: tlmgr tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet124200 +Ref: tlmgr tlmgr update --list124805 +Ref: tlmgr tlmgr update --all124898 +Ref: tlmgr tlmgr info _what_125055 +Ref: tlmgr tlmgr bug _what_125233 +Node: tlmgr OPTIONS125428 +Ref: tlmgr *--repository* _url|path_125961 +Ref: tlmgr /some/local/dir127147 +Ref: tlmgr file:/some/local/dir127176 +Ref: tlmgr ctan127249 +Ref: tlmgr https://mirror.ctan.org/systems/texlive/tlnet127303 +Ref: tlmgr http://server/path/to/tlnet127644 +Ref: tlmgr https://server/path/to/tlnet128025 +Ref: tlmgr ftp://server/path/to/tlnet128493 +Ref: tlmgr user@machine:/path/to/tlnet128625 +Ref: tlmgr scp://user@machine/path/to/tlnet128666 +Ref: tlmgr ssh://user@machine/path/to/tlnet128707 +Ref: tlmgr *--gui* [_action_]129101 +Ref: tlmgr *--gui-lang* _llcode_129915 +Ref: tlmgr *--command-logfile* _file_130657 +Ref: tlmgr *--debug-translation*130924 +Ref: tlmgr *--machine-readable*131128 +Ref: tlmgr *--no-execute-actions*131397 +Ref: tlmgr *--package-logfile* _file_131591 +Ref: tlmgr *--pause*131846 +Ref: tlmgr *--persistent-downloads*132002 +Ref: tlmgr *--no-persistent-downloads*132031 +Ref: tlmgr *--pin-file*132526 +Ref: tlmgr *--usermode*132745 +Ref: tlmgr *--usertree* _dir_132866 +Ref: tlmgr *--verify-repo=[none|main|all]*132993 +Node: tlmgr ACTIONS133892 +Node: tlmgr help134785 +Node: tlmgr version135262 +Node: tlmgr backup135525 +Ref: tlmgr *backup [_option_...] --all*135702 +Ref: tlmgr *backup [_option_...] _pkg_...*135735 +Ref: tlmgr *--backupdir* _directory_136802 +Ref: tlmgr *--all*137020 +Ref: tlmgr *--clean*[=_N_]137273 +Ref: tlmgr *--dry-run*137601 +Node: tlmgr bug [_search-string_]137731 +Node: tlmgr candidates _pkg_138317 +Node: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all]138687 +Ref: tlmgr *depends*139201 +Ref: tlmgr *executes*139543 +Ref: tlmgr *files*139658 +Ref: tlmgr *runfiles*139794 +Ref: tlmgr *texmfdbs*139931 +Ref: tlmgr - all items in TEXMFDBS have the !! prefix.140161 +Ref: tlmgr - all items in TEXMFBDS have an ls-R file (if they exist at all).140237 +Ref: tlmgr - all items in TEXMF with !! are listed in TEXMFDBS.140302 +Ref: tlmgr - all items in TEXMF with an ls-R file are listed in TEXMFDBS.140377 +Ref: tlmgr *--use-svn*140403 +Node: tlmgr conf140544 +Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*140834 +Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|remove] [_value_]*140899 +Node: tlmgr dump-tlpdb [_option_...] [--json]143315 +Ref: tlmgr *--local*143751 +Ref: tlmgr *--remote*143791 +Ref: tlmgr *--json*143830 +Node: tlmgr generate144401 +Ref: tlmgr *generate [_option_...] language*144597 +Ref: tlmgr *generate [_option_...] language.dat*144636 +Ref: tlmgr *generate [_option_...] language.def*144675 +Ref: tlmgr *generate [_option_...] language.dat.lua*144718 +Ref: tlmgr *--dest* _output_file_147046 +Ref: tlmgr *--localcfg* _local_conf_file_147623 +Ref: tlmgr *--rebuild-sys*147747 +Node: tlmgr gui148562 +Node: tlmgr info148742 +Ref: tlmgr *info [_option_...] _pkg_...*148904 +Ref: tlmgr *info [_option_...] collections*148938 +Ref: tlmgr *info [_option_...] schemes*148968 +Ref: tlmgr *--list*150499 +Ref: tlmgr *--only-installed*150814 +Ref: tlmgr *--only-remote*151003 +Ref: tlmgr *--data item1,item2,...*151308 +Ref: tlmgr *--json* 1152681 +Node: tlmgr init-usertree153064 +Node: tlmgr install [_option_...] _pkg_...153445 +Ref: tlmgr *--dry-run* 1153954 +Ref: tlmgr *--file*154072 +Ref: tlmgr *--force*154295 +Ref: tlmgr *--no-depends*154516 +Ref: tlmgr *--no-depends-at-all*154676 +Ref: tlmgr *--reinstall*155077 +Ref: tlmgr *--with-doc*155456 +Ref: tlmgr *--with-src*155470 +Node: tlmgr key156198 +Ref: tlmgr *key list*156356 +Ref: tlmgr *key add _file_*156374 +Ref: tlmgr *key remove _keyid_*156396 +Node: tlmgr list156990 +Node: tlmgr option157152 +Ref: tlmgr *option [--json] [show]*157308 +Ref: tlmgr *option [--json] showall|help*157340 +Ref: tlmgr *option _key_ [_value_]*157366 +Node: tlmgr paper161945 +Ref: tlmgr *paper [a4|letter]*162094 +Ref: tlmgr *<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*>162171 +Ref: tlmgr *paper --json*162187 +Node: tlmgr path163402 +Ref: tlmgr *path [--windowsmode=user|admin] add*163568 +Ref: tlmgr *path [--windowsmode=user|admin] remove*163610 +Node: tlmgr pinning165125 +Ref: tlmgr pinning show165366 +Ref: tlmgr pinning add _repo_ _pkgglob_...165439 +Ref: tlmgr pinning remove _repo_ _pkgglob_...165558 +Ref: tlmgr pinning remove _repo_ --all165711 +Node: tlmgr platform165765 +Ref: tlmgr *platform list|add|remove _platform_...*165951 +Ref: tlmgr *platform set _platform_*165978 +Ref: tlmgr *platform set auto*165999 +Ref: tlmgr *--dry-run* 2166877 +Node: tlmgr postaction166996 +Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*167226 +Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*167300 +Ref: tlmgr *--windowsmode=[user|admin]*167620 +Ref: tlmgr *--fileassocmode=[1|2]*168045 +Ref: tlmgr *--all* 1168331 +Node: tlmgr print-platform168386 +Node: tlmgr print-platform-info168717 +Node: tlmgr remove [_option_...] _pkg_...169017 +Ref: tlmgr *--all* 2169502 +Ref: tlmgr *--backup*169613 +Ref: tlmgr *--backupdir* _directory_ 1169640 +Ref: tlmgr *--no-depends* 1170045 +Ref: tlmgr *--no-depends-at-all* 1170108 +Ref: tlmgr *--force* 1170215 +Ref: tlmgr *--dry-run* 3170689 +Node: tlmgr repository171066 +Ref: tlmgr *repository list*171254 +Ref: tlmgr *repository list _path|url|tag_*171288 +Ref: tlmgr *repository add _path_ [_tag_]*171321 +Ref: tlmgr *repository remove _path|tag_*171353 +Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*171407 +Ref: tlmgr *repository status*171428 +Ref: tlmgr The tag (which can be the same as the url);172655 +Node: tlmgr restore173133 +Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*173312 +Ref: tlmgr *restore [_option_...] --all*173343 +Ref: tlmgr *--all* 3174044 +Ref: tlmgr *--backupdir* _directory_ 2174259 +Ref: tlmgr *--dry-run* 4174441 +Ref: tlmgr *--force* 2174574 +Ref: tlmgr *--json* 2174621 +Node: tlmgr search174948 +Ref: tlmgr *search [_option_...] _what_*175112 +Ref: tlmgr *search [_option_...] --file _what_*175150 +Ref: tlmgr *search [_option_...] --all _what_*175187 +Ref: tlmgr *--file* 1175408 +Ref: tlmgr *--all* 4175471 +Ref: tlmgr *--global*175561 +Ref: tlmgr *--word*175689 +Node: tlmgr shell176004 +Ref: tlmgr protocol176739 +Ref: tlmgr help 1176803 +Ref: tlmgr version 1176856 +Ref: tlmgr quit, end, bye, byebye, EOF176924 +Ref: tlmgr restart176945 +Ref: tlmgr load [local|remote]177068 +Ref: tlmgr save177138 +Ref: tlmgr get [_var_] =item set [_var_ [_val_]]177261 +Node: tlmgr show177862 +Node: tlmgr uninstall178029 +Node: tlmgr update [_option_...] [_pkg_...]178261 +Ref: tlmgr *--all* 5178633 +Ref: tlmgr *--self*180813 +Ref: tlmgr *--dry-run* 5181578 +Ref: tlmgr *--list* [_pkg_]181756 +Ref: tlmgr *--exclude* _pkg_182446 +Ref: tlmgr *--no-auto-remove* [_pkg_...]183247 +Ref: tlmgr *--no-auto-install* [_pkg_...]183732 +Ref: tlmgr *--reinstall-forcibly-removed*184495 +Ref: tlmgr *--backup* 1185031 +Ref: tlmgr *--backupdir* _directory_ 3185058 +Ref: tlmgr *--no-depends* 2186225 +Ref: tlmgr *--no-depends-at-all* 2186429 +Ref: tlmgr *--force* 3186536 +Node: tlmgr CONFIGURATION FILE FOR TLMGR187527 +Ref: tlmgr auto-remove = 0 or 1 (default 1), same as command-line option.188529 +Ref: tlmgr gui-expertmode = 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.188661 +Ref: tlmgr gui-lang = _llcode_, with a language code value as with the command-line option.188745 +Ref: tlmgr no-checksums = 0 or 1 (default 0, see below).188794 +Ref: tlmgr persistent-downloads = 0 or 1 (default 1), same as command-line option.188869 +Ref: tlmgr require-verification = 0 or 1 (default 0), same as command-line option.188944 +Ref: tlmgr tkfontscale = _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends.189052 +Ref: tlmgr update-exclude = _comma-separated list of packages_ (no spaces allowed). Same as the command line option --exclude for the update action.189197 +Ref: tlmgr verify-downloads = 0 or 1 (default 1), same as command-line option.189268 +Ref: tlmgr allowed-actions = _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode). This allows distributors to include tlmgr in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this.189785 +Node: tlmgr CRYPTOGRAPHIC VERIFICATION190617 +Node: tlmgr Configuration of GnuPG invocation192790 +Node: tlmgr USER MODE193428 +Node: tlmgr User mode install196299 +Node: tlmgr User mode backup, restore, remove, update197445 +Node: tlmgr User mode generate, option, paper197891 +Node: tlmgr User mode logs198258 +Node: tlmgr MULTIPLE REPOSITORIES198556 +Node: tlmgr Pinning200285 +Node: tlmgr GUI FOR TLMGR202208 +Node: tlmgr Main display203857 +Node: tlmgr Display configuration area204109 +Ref: tlmgr Status204470 +Ref: tlmgr Category204634 +Ref: tlmgr Match204820 +Ref: tlmgr Selection205001 +Ref: tlmgr Display configuration buttons205205 +Node: tlmgr Package list area205388 +Ref: tlmgr a checkbox205972 +Ref: tlmgr package name206108 +Ref: tlmgr local revision (and version)206207 +Ref: tlmgr remote revision (and version)206582 +Ref: tlmgr short description206879 +Node: tlmgr Main display action buttons206924 +Ref: tlmgr Update all installed207190 +Ref: tlmgr Update207562 +Ref: tlmgr Install207612 +Ref: tlmgr Remove207798 +Ref: tlmgr Backup207976 +Node: tlmgr Menu bar208133 +Ref: tlmgr tlmgr menu208356 +Ref: tlmgr Options menu208664 +Ref: tlmgr Actions menu209747 +Ref: tlmgr Help menu210175 +Node: tlmgr GUI options210309 +Ref: tlmgr -background _color_210555 +Ref: tlmgr -font " _fontname_ _fontsize_ "210620 +Ref: tlmgr -foreground _color_210778 +Ref: tlmgr -geometry _geomspec_210830 +Ref: tlmgr -xrm _xresource_211022 +Node: tlmgr MACHINE-READABLE OUTPUT211291 +Node: tlmgr Machine-readable update and install output212105 +Ref: tlmgr location-url _location_213381 +Ref: tlmgr total-bytes _count_213597 +Ref: tlmgr _pkgname_214007 +Ref: tlmgr _status_214217 +Ref: tlmgr d214295 +Ref: tlmgr f214355 +Ref: tlmgr u214534 +Ref: tlmgr r214580 +Ref: tlmgr a214703 +Ref: tlmgr i214881 +Ref: tlmgr I215000 +Ref: tlmgr _localrev_215102 +Ref: tlmgr _serverrev_215209 +Ref: tlmgr _size_215321 +Ref: tlmgr _runtime_215490 +Ref: tlmgr _esttot_215560 +Node: tlmgr Machine-readable option output215593 +Node: tlmgr ENVIRONMENT VARIABLES216105 +Ref: tlmgr TEXLIVE_COMPRESSOR216616 +Ref: tlmgr TEXLIVE_DOWNLOADER217464 +Ref: tlmgr TL_DOWNLOAD_PROGRAM217487 +Ref: tlmgr TL_DOWNLOAD_ARGS217507 +Ref: tlmgr TEXLIVE_PREFER_OWN218533 +Node: tlmgr AUTHORS AND COPYRIGHT219357 +Node: tlmgr POD ERRORS219780 +Ref: tlmgr Around line 8454:220005 +Node: Index220041 End Tag Table diff --git a/Master/texmf-dist/doc/info/web2c.info b/Master/texmf-dist/doc/info/web2c.info index 724f07c4771..38de4baf444 100644 --- a/Master/texmf-dist/doc/info/web2c.info +++ b/Master/texmf-dist/doc/info/web2c.info @@ -1,10 +1,10 @@ -This is web2c.info, produced by makeinfo version 6.5 from web2c.texi. +This is web2c.info, produced by makeinfo version 7.0.3 from web2c.texi. This file documents the installation and use of the programs in Web2c, -an implementation of Donald Knuth's TeX system. +an implementation of Donald Knuth’s TeX system. - Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, -2005, 2007, 2008, 2009, 2010-2022 Karl Berry & Olaf Weber. + Copyright © 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, +2005, 2007, 2008, 2009, 2010–2023 Karl Berry & Olaf Weber. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -58,7 +58,7 @@ Web2c This document describes how to install and use the programs in the Web2c implementation of the TeX system, especially for Unix systems. It -corresponds to Web2c version 2023, released in February 2022. +corresponds to Web2c version 2023, released in October 2023. * Menu: @@ -83,12 +83,12 @@ File: web2c.info, Node: Introduction, Next: Installation, Prev: Top, Up: Top 1 Introduction ************** -This manual corresponds to version 2023 of Web2c, released in February -2022. +This manual corresponds to version 2023 of Web2c, released in October +2023. - "Web2c" (also spelled Web2C) is the name of a TeX implementation, + “Web2c” (also spelled Web2C) is the name of a TeX implementation, originally for Unix, but now also running under Windows and other -operating systems. By "TeX implementation", we mean all of the standard +operating systems. By “TeX implementation”, we mean all of the standard programs developed by the Stanford TeX project led by Donald E. Knuth: Metafont, DVItype, GFtoDVI, BibTeX, Tangle, etc., as well as TeX itself. Other programs are also included: DVIcopy, written by Peter @@ -98,10 +98,10 @@ John Hobby, and many more. General strategy: Web2c works, as its name implies, by translating the WEB source in which TeX is written into C source code. Its output is not self-contained, however; it makes extensive use of many macros -and functions in a library (the 'web2c/lib' directory in the sources). +and functions in a library (the ‘web2c/lib’ directory in the sources). Therefore, it will not work without change on an arbitrary WEB program. - Availability: All of Web2c is freely available--"free" both in the + Availability: All of Web2c is freely available—“free” both in the sense of no cost (free ice cream) and of having the source code to modify and/or redistribute (free speech). *Note (kpathsea)unixtex.ftp::, for the practical details of how to obtain @@ -115,7 +115,7 @@ executables are covered by the GNU General Public License or GNU Lesser General Public License, and therefore anyone who gets a binary distribution must also be able to get the sources, as explained by the terms of the GPL (<https://gnu.org/licenses/>). The GPL covers the -Web2c executables, including 'tex', because the Free Software Foundation +Web2c executables, including ‘tex’, because the Free Software Foundation sponsored the initial development of the Kpathsea library that Web2c uses. The basic source files from Stanford, however, have their own copyright terms or are in the public domain, and are not covered by the @@ -130,7 +130,7 @@ He made many changes to the original sources, and started using the shorter name Web2c. In 1997, Olaf Weber took over, and then in 2006, Karl started taking care of it again. No significant development or changes have been needed for many years, though dozens of other people -have contributed in many ways; their names are listed in the 'ChangeLog' +have contributed in many ways; their names are listed in the ‘ChangeLog’ files. Originally, Web2c was distributed as its own package, alongside the @@ -156,109 +156,109 @@ File: web2c.info, Node: Installation, Next: Commonalities, Prev: Introduction 2 Installation ************** -(A copy of this chapter is in the distribution file 'web2c/INSTALL'.) +(A copy of this chapter is in the distribution file ‘web2c/INSTALL’.) Installing Web2c is mostly the same as installing any other Kpathsea-using program. Therefore, for the basic steps involved, see *note (kpathsea)Installation::. (A copy is in the file -'kpathsea/INSTALL'.) +‘kpathsea/INSTALL’.) One peculiarity to Web2c is that the source distribution comes in two -files: 'web.tar.gz' and 'web2c.tar.gz'. You must retrieve and unpack +files: ‘web.tar.gz’ and ‘web2c.tar.gz’. You must retrieve and unpack them both. (We have two because the former archive contains the very large and seldom-changing original WEB source files.) *Note (kpathsea)unixtex.ftp::. Another peculiarity is the MetaPost program. Although it has been -installed previously as 'mp', as of Web2c 7.0 the installed name is now -'mpost', to avoid conflict with the 'mp' program that does +installed previously as ‘mp’, as of Web2c 7.0 the installed name is now +‘mpost’, to avoid conflict with the ‘mp’ program that does prettyprinting. This approach was recommended by the MetaPost author, John Hobby. If you as the TeX administrator wish to make it available under its shorter name as well, you will have to set up a link or some such yourself. And of course individual users can do the same. For solutions to common installation problems and information on how -to report a bug, see the file 'kpathsea/BUGS' (*note (kpathsea)Bugs::). +to report a bug, see the file ‘kpathsea/BUGS’ (*note (kpathsea)Bugs::). See also the Web2c home page, <http://www.tug.org/web2c>. Points worth repeating: - * Before starting the standard compilation and installation you must + • Before starting the standard compilation and installation you must install the basic fonts, macros, and other library files. *Note (kpathsea)Installation::. - * If you do not wish to use the standard file locations, see *note + • If you do not wish to use the standard file locations, see *note (kpathsea)Changing search paths::. - * Some Web2c features are enabled or disabled at 'configure' time, as + • Some Web2c features are enabled or disabled at ‘configure’ time, as described in the first section below. * Menu: -* configure options:: Especially -with and -enable. -* Compile-time options:: Unusual -D's. +* configure options:: Especially –with and –enable. +* Compile-time options:: Unusual -D’s. * Additional targets:: Breaking down the task. * Triptrap:: Running the torture tests. File: web2c.info, Node: configure options, Next: Compile-time options, Up: Installation -2.1 'configure' options +2.1 ‘configure’ options ======================= -This section gives pointers to descriptions of the '--with' and -'--enable' 'configure' arguments that Web2c accepts. Some are specific +This section gives pointers to descriptions of the ‘--with’ and +‘--enable’ ‘configure’ arguments that Web2c accepts. Some are specific to Web2c, others are generic to all Kpathsea-using programs. - For a list of all the options 'configure' accepts, run 'configure ---help'. The generic options are listed first, and the package-specific + For a list of all the options ‘configure’ accepts, run ‘configure +--help’. The generic options are listed first, and the package-specific options come last. For a description of the generic options (which mainly allow you to -specify installation directories) and basic 'configure' usage, see *note -Running 'configure' scripts: (autoconf)Invoking configure, a copy is in -the file 'kpathsea/CONFIGURE'. +specify installation directories) and basic ‘configure’ usage, see *note +Running ‘configure’ scripts: (autoconf)Invoking configure, a copy is in +the file ‘kpathsea/CONFIGURE’. -'--disable-dump-share' +‘--disable-dump-share’ Do not make fmt/base/mem files sharable across different endian architectures. *Note Hardware and memory dumps::. -'--without-maketexmf-default' -'--without-maketexpk-default' -'--without-maketextfm-default' -'--with-maketextex-default' +‘--without-maketexmf-default’ +‘--without-maketexpk-default’ +‘--without-maketextfm-default’ +‘--with-maketextex-default’ Enable or disable the dynamic generation programs. *Note (kpathsea)mktex configuration::. The defaults are the inverse of - the options, i.e., everything is enabled except 'mktextex'. + the options, i.e., everything is enabled except ‘mktextex’. -'--enable-shared' +‘--enable-shared’ Build Kpathsea as a shared library. *Note (kpathsea)Shared library::. -'--with-editor=CMD' - Change the default editor invoked by the 'e' interactive command. +‘--with-editor=CMD’ + Change the default editor invoked by the ‘e’ interactive command. *Note Editor invocation::. -'--with-epsfwin' -'--with-hp2627win' -'--with-mftalkwin' -'--with-nextwin' -'--with-regiswin' -'--with-suntoolswin' -'--with-tektronixwin' -'--with-unitermwin' -'--with-x' -'--with-x-toolkit=KIT' -'--with-x11win' -'--with-x11' +‘--with-epsfwin’ +‘--with-hp2627win’ +‘--with-mftalkwin’ +‘--with-nextwin’ +‘--with-regiswin’ +‘--with-suntoolswin’ +‘--with-tektronixwin’ +‘--with-unitermwin’ +‘--with-x’ +‘--with-x-toolkit=KIT’ +‘--with-x11win’ +‘--with-x11’ Define Metafont graphics support; by default, no graphics support is enabled. *Note Online Metafont graphics::. -'--x-includes=DIR' -'--x-libraries=DIR' +‘--x-includes=DIR’ +‘--x-libraries=DIR’ Define the locations of the X11 include files and libraries; by - default, 'configure' does its best to guess). *Note - (autoconf)Optional Features::. A copy is in 'kpathsea/CONFIGURE'. + default, ‘configure’ does its best to guess). *Note + (autoconf)Optional Features::. A copy is in ‘kpathsea/CONFIGURE’. File: web2c.info, Node: Compile-time options, Next: Additional targets, Prev: configure options, Up: Installation @@ -266,28 +266,28 @@ File: web2c.info, Node: Compile-time options, Next: Additional targets, Prev: 2.2 Compile-time options ======================== -In addition to the 'configure' options listed in the previous section, +In addition to the ‘configure’ options listed in the previous section, there are a few things that can be affected at compile-time with C -definitions, rather than with 'configure'. Using any of these is +definitions, rather than with ‘configure’. Using any of these is unusual. - To specify extra compiler flags ('-DNAME' in this case), the simplest + To specify extra compiler flags (‘-DNAME’ in this case), the simplest thing to do is: make XCFLAGS="CCOPTIONS" -You can also set the 'CFLAGS' environment variable before running -'configure'. *Note (kpathsea)configure environment::. +You can also set the ‘CFLAGS’ environment variable before running +‘configure’. *Note (kpathsea)configure environment::. Anyway, here are the possibilities: -'-DFIXPT' -'-DNO_MF_ASM' +‘-DFIXPT’ +‘-DNO_MF_ASM’ Use the original WEB fixed-point routines for Metafont and MetaPost arithmetic calculations regarding fractions. By default, assembly-language routines are used on x86 hardware with GNU C - (unless 'NO_MF_ASM' is defined), and floating-point routines are + (unless ‘NO_MF_ASM’ is defined), and floating-point routines are used otherwise. -'-DIPC_DEBUG' +‘-DIPC_DEBUG’ Report on various interprocess communication activities. *Note IPC and TeX: IPC and TeX. @@ -299,39 +299,39 @@ File: web2c.info, Node: Additional targets, Next: Triptrap, Prev: Compile-tim Web2c has several Make targets besides the standard ones. You can invoke these either in the top level directory of the source -distribution (the one containing 'kpathsea/' and 'web2c/'), or in the -'web2c/' directory. +distribution (the one containing ‘kpathsea/’ and ‘web2c/’), or in the +‘web2c/’ directory. -'c-sources' +‘c-sources’ Make only the C files, translated from the Web sources, presumably because you want to take them to a non-Unix machine. -'formats' -'install-formats' +‘formats’ +‘install-formats’ Make or install all the memory dumps (*note Memory dumps::). By - default, the standard plain formats plus 'latex.fmt' are made. You - can add other formats by redefining the 'fmts', 'bases', and 'mems' - variables. See the top of 'web2c/Makefile' for the possibilities. + default, the standard plain formats plus ‘latex.fmt’ are made. You + can add other formats by redefining the ‘fmts’, ‘bases’, and ‘mems’ + variables. See the top of ‘web2c/Makefile’ for the possibilities. -'fmts' -'install-fmts' - Make or install the TeX '.fmt' files. *Note Initial TeX::. +‘fmts’ +‘install-fmts’ + Make or install the TeX ‘.fmt’ files. *Note Initial TeX::. -'bases' -'install-bases' +‘bases’ +‘install-bases’ - Make or install the Metafont '.base' files. *Note Initial + Make or install the Metafont ‘.base’ files. *Note Initial Metafont::. -'mems' -'install-mems' - Make or install the MetaPost '.mem' files. *Note Initial +‘mems’ +‘install-mems’ + Make or install the MetaPost ‘.mem’ files. *Note Initial MetaPost::. -'triptrap' -'trip' -'trap' -'mptrap' +‘triptrap’ +‘trip’ +‘trap’ +‘mptrap’ To run the torture tests for TeX, Metafont, and MetaPost (respectively). See the next section. @@ -341,38 +341,38 @@ File: web2c.info, Node: Triptrap, Prev: Additional targets, Up: Installation 2.4 Trip, trap, and mptrap: Torture tests ========================================= -To validate your TeX, Metafont, and MetaPost executables, run 'make -triptrap'. This runs the trip, trap, and mptrap "torture tests". See -the files 'triptrap/tripman.tex', 'triptrap/trapman.tex', and -'triptrap/mptrap.readme' for detailed information and background on the +To validate your TeX, Metafont, and MetaPost executables, run ‘make +triptrap’. This runs the trip, trap, and mptrap “torture tests”. See +the files ‘triptrap/tripman.tex’, ‘triptrap/trapman.tex’, and +‘triptrap/mptrap.readme’ for detailed information and background on the tests. - The differences between your executables' behavior and the standard + The differences between your executables’ behavior and the standard values will show up on your terminal. The usual differences (these are all acceptable) are: - * string usage and table sizes; - * glue set ratios; - * 'down4', 'right4', and 'y4' commands in DVItype output; - * dates and times. + • string usage and table sizes; + • glue set ratios; + • ‘down4’, ‘right4’, and ‘y4’ commands in DVItype output; + • dates and times. Any other differences are trouble. The most common culprit in the past has been compiler bugs, especially when optimizing. *Note TeX or Metafont failing: (kpathsea)TeX or Metafont failing. - The files 'trip.diffs', 'mftrap.diffs', and 'mptrap.diffs' in the -'triptrap' directory show the standard diffs against the original + The files ‘trip.diffs’, ‘mftrap.diffs’, and ‘mptrap.diffs’ in the +‘triptrap’ directory show the standard diffs against the original output. If you diff your diffs against these files, you should come up clean. For example make trip >&mytrip.diffs diff triptrap/trip.diffs mytrip.diffs - To run the tests separately, use the targets 'trip', 'trap', and -'mptrap'. + To run the tests separately, use the targets ‘trip’, ‘trap’, and +‘mptrap’. To run simple tests for all the programs as well as the torture -tests, run 'make check'. You can compare the output to the distributed -file 'tests/check.log' if you like. +tests, run ‘make check’. You can compare the output to the distributed +file ‘tests/check.log’ if you like. File: web2c.info, Node: Commonalities, Next: Three programs, Prev: Installation, Up: Top @@ -388,10 +388,10 @@ available across all the engines; *note TeX extensions::. * Menu: -* Option conventions:: - or -, = or ' ' for values. -* Common options:: -help -version -verbose, and TeX/MF/MP options. +* Option conventions:: – or -, = or ‘ ’ for values. +* Common options:: –help –version –verbose, and TeX/MF/MP options. * Path searching:: Features of the common path searching library. -* Output file location:: TEXMFOUTPUT allows output in places other than '.'. +* Output file location:: TEXMFOUTPUT allows output in places other than ‘.’. File: web2c.info, Node: Option conventions, Next: Common options, Up: Commonalities @@ -400,20 +400,20 @@ File: web2c.info, Node: Option conventions, Next: Common options, Up: Commona ====================== To provide a clean and consistent behavior, we chose to have all these -programs use the GNU function 'getopt_long_only' to parse command lines. +programs use the GNU function ‘getopt_long_only’ to parse command lines. However, we do use in a restricted mode, where all the options have to come before the rest of the arguments. As a result, you can: - * use '-' or '--' to start an option name; + • use ‘-’ or ‘--’ to start an option name; - * use any unambiguous abbreviation for an option name; + • use any unambiguous abbreviation for an option name; - * separate option names and values with either '=' or one or more + • separate option names and values with either ‘=’ or one or more spaces; - * use filenames that would otherwise look like options by putting - them after an option '--'. + • use filenames that would otherwise look like options by putting + them after an option ‘--’. By convention, non-option arguments, if specified, generally define the name of an input file, as documented for each program. @@ -421,9 +421,9 @@ the name of an input file, as documented for each program. If a particular option with a value is given more than once, it is the last value that counts. - For example, the following command line specifies the options 'foo', -'bar', and 'verbose'; gives the value 'baz' to the 'abc' option, and the -value 'xyz' to the 'quux' option; and specifies the filename '-myfile-'. + For example, the following command line specifies the options ‘foo’, +‘bar’, and ‘verbose’; gives the value ‘baz’ to the ‘abc’ option, and the +value ‘xyz’ to the ‘quux’ option; and specifies the filename ‘-myfile-’. -foo --bar -verb -abc=baz -quux karl --quux xyz -- -myfile- @@ -433,112 +433,114 @@ File: web2c.info, Node: Common options, Next: Path searching, Prev: Option co 3.2 Common options ================== -All of these programs accept the standard GNU '--help' and '--version' -options, and several programs accept '--verbose'. Rather than writing +All of these programs accept the standard GNU ‘--help’ and ‘--version’ +options, and several programs accept ‘--verbose’. Rather than writing identical descriptions for every program, they are described here. -'--help' +‘--help’ Print a usage message listing basic usage and all available options to standard output, then exit successfully. -'--verbose' +‘--verbose’ Print progress reports to standard output. -'--version' +‘--version’ Print the version number to standard output, then exit successfully. TeX, Metafont, and MetaPost have a number of additional options in common: -'-cnf-line=STR' - Parse STR as if it were a line in the 'texmf.cnf' configuration +‘-cnf-line=STR’ + Parse STR as if it were a line in the ‘texmf.cnf’ configuration file, overriding all other settings. *Note (kpathsea)Path searching options::. -'-file-line-error' -'-no-file-line-error' +‘-file-line-error’ +‘-no-file-line-error’ Change (or do not change) the way error messages are printed. The alternate style looks like error messages from many compilers and is easier to parse for some editors that invoke TeX. This option - used to be called '-file-line-error-style'. - -'-fmt=DUMPNAME' -'-base=DUMPNAME' -'-mem=DUMPNAME' - Use DUMPNAME instead of the program name or a '%&' line to - determine the name of the memory dump file read ('fmt' for TeX, - 'base' for Metafont, 'mem' for MetaPost). *Note Memory dumps::. - Also sets the program name to DUMPNAME if no '-progname' option was + used to be called ‘-file-line-error-style’. + +‘-fmt=DUMPNAME’ +‘-base=DUMPNAME’ +‘-mem=DUMPNAME’ + Use DUMPNAME instead of the program name or a ‘%&’ line to + determine the name of the memory dump file read (‘fmt’ for TeX, + ‘base’ for Metafont, ‘mem’ for MetaPost). *Note Memory dumps::. + Also sets the program name to DUMPNAME if no ‘-progname’ option was given. -'-halt-on-error' +‘-halt-on-error’ Stop processing and exit when an error occurs, as opposed to the normal process of trying to recover and continue. -'-ini' - Enable the "initial" form of the program (*note Initial and - virgin::). This is implicitly set if the program name is 'initex' - resp. 'inimf'. +‘-ini’ + Enable the “initial” form of the program (*note Initial and + virgin::). This is implicitly set if the program name is ‘initex’ + resp. ‘inimf’. -'-interaction=STRING' +‘-interaction=STRING’ Set the interaction mode from the command line. The STRING must be - one of 'batchmode', 'nonstopmode', 'scrollmode', or - 'errorstopmode'. + one of ‘batchmode’, ‘nonstopmode’, ‘scrollmode’, or + ‘errorstopmode’. -'-jobname=STRING' +‘-jobname=STRING’ Set the job name to STRING, instead of deriving it from the name of the input file. -'-kpathsea-debug=NUMBER' +‘-kpathsea-debug=NUMBER’ Set path searching debugging flags according to the bits of NUMBER (*note (kpathsea)Debugging::). You can also specify this in - 'KPATHSEA_DEBUG' environment variable (for all Web2c programs). - (The command line value overrides.) The most useful value is '-1', + ‘KPATHSEA_DEBUG’ environment variable (for all Web2c programs). + (The command line value overrides.) The most useful value is ‘-1’, to get all available output. -'-output-directory=DIRNAME' +‘-output-directory=DIRNAME’ Specify the directory DIRNAME to which output files are written. Also look for input files in DIRNAME first, before looking along - the normal search path. *Note Output file location::. + the normal search path. Input files are only looked for as + specified; no default extension is added. *Note Output file + location::. -'-parse-first-line' -'-no-parse-first-line' +‘-parse-first-line’ +‘-no-parse-first-line’ Check or disable checking whether the first line of the main input - file starts with '%&', and parse it if it does. This line can be + file starts with ‘%&’, and parse it if it does. This line can be used specify the format and/or a TCX file. -'-progname=STRING' +‘-progname=STRING’ Set program (and memory dump) name to STRING. This may affect the search paths and other values used (*note (kpathsea)Config files::). Using this option is equivalent to making a link named STRING to the binary and then invoking the binary under that name. *Note Memory dumps::. -'-recorder' +‘-recorder’ Enable the filename recorder. This makes the program save a list - of the opened files into a file with (by default) extension '.fls'. + of the opened files into a file with (by default) extension ‘.fls’. For Aleph, this option is always on, and the file has extension - '.ofl'. + ‘.ofl’. - Ordinarily, the '.fls' file is written to the same location as the - '.log' file, for example, respecting '-output-directory' if it is + Ordinarily, the ‘.fls’ file is written to the same location as the + ‘.log’ file, for example, respecting ‘-output-directory’ if it is given (*note Output file location::). However, if TeX processing - is done on the command line (or in response to the '**' prompt), - the '.fls' might be written to the current directory, or include an - integer (the current pid), as in 'texput1234.fls'. You can use - '-jobname' to explicitly set the basename. + is done on the command line (or in response to the ‘**’ prompt), + the ‘.fls’ might be written to the current directory, or include an + integer (the current pid), as in ‘texput1234.fls’. You can use + ‘-jobname’ to explicitly set the basename. -'-translate-file=TCXFILE' +‘-translate-file=TCXFILE’ Use TCXFILE to define which characters are printable and translations between the internal and external character sets. Moreover, TCXFILE can be explicitly declared in the first line of - the main input file '%& -translate-file=TCXFILE'. This is the + the main input file ‘%& -translate-file=TCXFILE’. This is the recommended method for portability reasons. *Note TCX files::. -'-8bit' +‘-8bit’ This option specifies that by default all characters should be - considered printable. If '-translate-file' was given as well, then + considered printable. If ‘-translate-file’ was given as well, then the TCX file may mark characters as non-printable. This is a no-op in engines natively supporting Unicode. @@ -552,14 +554,14 @@ All of the Web2c programs, including TeX, which do path searching use the Kpathsea routines to do so. The precise names of the environment and configuration file variables which get searched for particular file formatted are therefore documented in the Kpathsea manual (*note -(kpathsea)Supported file formats::). Reading 'texmf.cnf' (*note -(kpathsea)Config files::), invoking 'mktex...' scripts (*note +(kpathsea)Supported file formats::). Reading ‘texmf.cnf’ (*note +(kpathsea)Config files::), invoking ‘mktex...’ scripts (*note (kpathsea)mktex scripts::), and so on are all handled by Kpathsea. The programs which read fonts make use of another Kpathsea feature: -'texfonts.map', which allows arbitrary aliases for the actual names of -font files; for example, 'Times-Roman' for 'ptmr8r.tfm'. The -distributed (and installed by default) 'texfonts.map' includes aliases +‘texfonts.map’, which allows arbitrary aliases for the actual names of +font files; for example, ‘Times-Roman’ for ‘ptmr8r.tfm’. The +distributed (and installed by default) ‘texfonts.map’ includes aliases for many widely available PostScript fonts by their PostScript names. @@ -568,29 +570,68 @@ File: web2c.info, Node: Output file location, Prev: Path searching, Up: Commo 3.4 Output file location ======================== -All the programs generally follow the usual convention for output files. -Namely, they are placed in the directory current when the program is +All the programs generally follow the usual convention for output files; +namely, they are placed in the directory current when the program is run, regardless of any input file location; or, in a few cases, output -is to standard output. - - For example, if you run 'tex /tmp/foo', for example, the output will -be in './foo.dvi' and './foo.log', not '/tmp/foo.dvi' and -'/tmp/foo.log'. - - You can use the '-output-directory' option to cause all output files -that would normally be written in the current directory to be written in -the specified directory instead. *Note Common options::. - - If the current directory is not writable, and '-output-directory' is -not specified, the main programs (TeX, Metafont, MetaPost, and BibTeX) -make an exception: if the config file or environment variable value -'TEXMFOUTPUT' is set (it is not by default), output files are written to -the directory specified. - - 'TEXMFOUTPUT' is also checked for input files, as TeX often generates -files that need to be subsequently read; for input, no suffixes (such as -'.tex') are added by default and no exhaustive path searching is done, -the input name is simply checked as given. +is to standard output. The main programs (TeX, Metafont, MetaPost) +provide several ways to override this, as explained below. + + For example, if you run ‘tex /tmp/foo’, by default the output will be +in ‘./foo.dvi’ and ‘./foo.log’, not ‘/tmp/foo.dvi’ and ‘/tmp/foo.log’. + + An explicitly-given output location is also checked for input files, +as TeX often generates files that need to be subsequently read. For +input, the input filename is simply checked as given. No suffixes, such +as ‘.tex’, are added by default, and no exhaustive path searching is +done. + +Override 1: ‘-output-directory’ option +-------------------------------------- + +If the ‘-output-directory’ option is specified, all output files that +would normally be written in the current directory are written in the +specified directory instead. *Note Common options::. + +Override 2: ‘TEXMF_OUTPUT_DIRECTORY’ environment variable +--------------------------------------------------------- + +Furthermore, if the ‘-output-directory’ option is specified, its +argument is saved in the environment variable ‘TEXMF_OUTPUT_DIRECTORY’. +This is for the benefit of any subprograms that might be called via +‘\write18’ (*note Shell escapes::), such as ‘kpsewhich’ (*note +(kpathsea)Invoking kpsewhich::). (This feature was added in TeX Live +2024.) + + If the ‘-output-directory’ option is not specified, but the +environment variable ‘TEXMF_OUTPUT_DIRECTORY’ is set, then the +environment variable value is used just as if it had been given to the +option. + + Warning: we most strongly recommend always setting +‘TEXMF_OUTPUT_DIRECTORY’ temporarily, for a given run. It has great +potential for confusion, since with it set, output files will not be in +the expected place. To reduce this chance somewhat, +‘TEXMF_OUTPUT_DIRECTORY’ must be set in the environment, not a +configuration file. + +Override 3: ‘TEXMFOUTPUT’ environment variable +---------------------------------------------- + +Finally, if neither ‘-output-directory’ nor ‘TEXMF_OUTPUT_DIRECTORY’ is +set, _and_ an output file is not writable, then the main programs (TeX, +Metafont, MetaPost), plus BibTeX for this one case, make an exception: +if the config file or environment variable value ‘TEXMFOUTPUT’ is set +(it is not by default), the output file is written to the directory +specified. Usually this is because the current directory is not +writable, and thus all output files are written to ‘TEXMFOUTPUT’, but +technically it works on a file-by-file basis. + + None of these explicitly-given output locations are checked until +(and unless) the program actually needs to write a file. For example, +the invocation +‘tex --output-directory=/nonesuch \\end’ +won’t generate an error until TeX tries to write the log file: +‘! I can't write on file `texput.log'.’. File: web2c.info, Node: Three programs, Next: TeX, Prev: Commonalities, Up: Top @@ -604,10 +645,10 @@ described in the previous section. * Menu: -* Runtime options:: The 'texmf.cnf' configuration file. +* Runtime options:: The ‘texmf.cnf’ configuration file. * Initial and virgin:: Making memory dumps vs. production runs. * Memory dumps:: .fmt/.base files for fast startup. -* Editor invocation:: The 'e' response at errors. +* Editor invocation:: The ‘e’ response at errors. * \input filenames:: Filename delimiters and Kpathsea expansion. @@ -618,26 +659,26 @@ File: web2c.info, Node: Runtime options, Next: Initial and virgin, Up: Three Besides the configure- and compile-time options described in the installation section (*note Installation::), you can control a number of -parameters in the 'texmf.cnf' runtime file read by Kpathsea (*note +parameters in the ‘texmf.cnf’ runtime file read by Kpathsea (*note (kpathsea)Config files::). - The main purpose of 'texmf.cnf' is to specify search paths, but array + The main purpose of ‘texmf.cnf’ is to specify search paths, but array sizes and other options are also set there. Most are rather obscure. Here are a few of the more interesting values: -'main_memory' +‘main_memory’ Total words of memory available, for TeX, Metafont, and MetaPost. Must remake the format file after changing. -'extra_mem_bot' - Extra space for "large" TeX data structures (default 0): boxes, +‘extra_mem_bot’ + Extra space for “large” TeX data structures (default 0): boxes, glue, breakpoints, et al. If you use PiCTeX, you may well want to set this. -'expand_depth' +‘expand_depth’ Limit on recursive expansion calls before TeX aborts (default 10000). If a TeX program does an unterminated recursive expansion, - TeX will dutifully expand macros until the system's runtime stack + TeX will dutifully expand macros until the system’s runtime stack overflows, typically with a segmentation fault (SIGSEGV). This parameter was introduced to minimize the chance of that unpleasant (though not dangerous) crash, instead allowing TeX to quit with a @@ -647,12 +688,12 @@ Here are a few of the more interesting values: exceptionally small memory allocation for its stack. There is no quantitative way to determine the limit, and it does not seem worth implementing system-dependent heuristics to guess at the number, - since it's highly improbable that any real TeX code will ever need + since it’s highly improbable that any real TeX code will ever need more than 10000 recursive expansions (it has never happened). For the same reason, using the libsigsegv library (<https://gnu.org/s/libsigsegv>) does not seem worth the effort. -'texmf_casefold_search' +‘texmf_casefold_search’ *Note (kpathsea)Casefolding search::. Ideally all arrays would be dynamically expanded as necessary, so the @@ -667,13 +708,13 @@ hand, the Web2c BibTeX implementation does do true dynamic reallocation of some arrays.) Nowadays there is rarely a reason to modify the values. But if you -do wish to modify 'texmf.cnf', in TeX Live the best approach is to put +do wish to modify ‘texmf.cnf’, in TeX Live the best approach is to put your changes, and only your changes at the top of the TL installation -tree. That is, if the system 'texmf.cnf' is installed in -'/some/path/to/texlive/YYYY/texmf-dist/web2c/texmf.cnf' is put your -custom settings in '/some/path/to/texlive/YYY/texmf.cnf', where YYYY is -the year of installation (if you use that subdirectory; it's the -default). That way, unrelated changes to the system 'texmf.cnf' can +tree. That is, if the system ‘texmf.cnf’ is installed in +‘/some/path/to/texlive/YYYY/texmf-dist/web2c/texmf.cnf’ is put your +custom settings in ‘/some/path/to/texlive/YYY/texmf.cnf’, where YYYY is +the year of installation (if you use that subdirectory; it’s the +default). That way, unrelated changes to the system ‘texmf.cnf’ can happen with normal updates, without affecting your local values. @@ -683,19 +724,19 @@ File: web2c.info, Node: Initial and virgin, Next: Memory dumps, Prev: Runtime ====================== The TeX and Metafont programs each have two main variants, called -"initial" and "virgin". MetaPost no longer makes this distinction. +“initial” and “virgin”. MetaPost no longer makes this distinction. The initial form is enabled if: - 1. the '-ini' option was specified; or - 2. the program name is 'initex' resp. 'inimf'; or - 3. the first line of the main input file is '%&ini'; + 1. the ‘-ini’ option was specified; or + 2. the program name is ‘initex’ resp. ‘inimf’; or + 3. the first line of the main input file is ‘%&ini’; otherwise, the virgin form is used. - The "virgin" form is the one generally invoked for production use. + The “virgin” form is the one generally invoked for production use. The first thing it does is read a memory dump (*note Determining the memory dump to use::), and then proceeds on with the main job. - The "initial" form is generally used only to create memory dumps (see + The “initial” form is generally used only to create memory dumps (see the next section). It starts up more slowly than the virgin form, because it must do lengthy initializations that are encapsulated in the memory dump file. @@ -707,7 +748,7 @@ File: web2c.info, Node: Memory dumps, Next: Editor invocation, Prev: Initial ================ In typical use, TeX and Metafont require a large number of macros to be -predefined; therefore, they support "memory dump" files, which can be +predefined; therefore, they support “memory dump” files, which can be read much more efficiently than ordinary source code. * Menu: @@ -726,7 +767,7 @@ The programs all create memory dumps in slightly idiosyncratic (thought substantially similar) way, so we describe the details in separate sections (references below). The basic idea is to run the initial version of the program (*note Initial and virgin::), read the source -file to define the macros, and then execute the '\dump' primitive. +file to define the macros, and then execute the ‘\dump’ primitive. Also, each program uses a different filename extension for its memory dumps, since although they are completely analogous they are not @@ -736,10 +777,10 @@ interchangeable (TeX cannot read a Metafont memory dump, for example). creating memory dumps: TeX - ('.fmt') *Note Initial TeX: Initial TeX. + (‘.fmt’) *Note Initial TeX: Initial TeX. Metafont - ('.base') *Note Initial Metafont::. + (‘.base’) *Note Initial Metafont::. When making memory dumps, the programs read environment variables and configuration files for path searching and other values as usual. If @@ -757,29 +798,29 @@ The virgin form (*note Initial and virgin::) of each program always reads a memory dump before processing normal source input. All three programs determine the memory dump to use in the same way: - 1. If the first non-option command-line argument begins with '&', the + 1. If the first non-option command-line argument begins with ‘&’, the program uses the remainder of that argument as the memory dump - name. For example, running 'tex \&super' reads 'super.fmt'. (The - backslash protects the '&' against interpretation by the shell.) + name. For example, running ‘tex \&super’ reads ‘super.fmt’. (The + backslash protects the ‘&’ against interpretation by the shell.) - 2. If the '-fmt' resp. '-base' option is specified, its value is used. + 2. If the ‘-fmt’ resp. ‘-base’ option is specified, its value is used. - 3. If the '-progname' option is specified, its value is used. + 3. If the ‘-progname’ option is specified, its value is used. 4. If the first line of the main input file (which must be specified - on the command line, not in response to '**') is '%&DUMP', and DUMP + on the command line, not in response to ‘**’) is ‘%&DUMP’, and DUMP is an existing memory dump of the appropriate type, DUMP is used. The first line of the main input file can also specify which character translation file is to be used: - '%&-translate-file=TCXFILE' (*note TCX files::). + ‘%&-translate-file=TCXFILE’ (*note TCX files::). - These two roles can be combined: '%&DUMP -translate-file=TCXFILE'. + These two roles can be combined: ‘%&DUMP -translate-file=TCXFILE’. If this is done, the name of the dump must be given first. 5. Otherwise, the program uses the program invocation name, most - commonly 'tex' resp. 'mf'. For example, if 'latex' is a link to - 'tex', and the user runs 'latex foo', 'latex.fmt' will be used. + commonly ‘tex’ resp. ‘mf’. For example, if ‘latex’ is a link to + ‘tex’, and the user runs ‘latex foo’, ‘latex.fmt’ will be used. File: web2c.info, Node: Hardware and memory dumps, Prev: Determining the memory dump to use, Up: Memory dumps @@ -789,41 +830,41 @@ File: web2c.info, Node: Hardware and memory dumps, Prev: Determining the memor By default, memory dump files are sharable between architectures of different types; specifically, on machines of different endianness -(*note (libc)Byte order::) and with different word sizes (4-byte 'long' -vs. 8-byte 'long'). This is a feature of the Web2c implementation, and +(*note (libc)Byte order::) and with different word sizes (4-byte ‘long’ +vs. 8-byte ‘long’). This is a feature of the Web2c implementation, and is not true of all TeX implementations. - The script 'tl-check-fmtshare' in the TeX Live source tree -('Master/tlpkg/bin') provides a relatively easy way to test that a -'.fmt' built on the local host can be loaded by a TeX engine built on + The script ‘tl-check-fmtshare’ in the TeX Live source tree +(‘Master/tlpkg/bin’) provides a relatively easy way to test that a +‘.fmt’ built on the local host can be loaded by a TeX engine built on some remote host. - If you specify '--disable-dump-share' to 'configure', however, memory + If you specify ‘--disable-dump-share’ to ‘configure’, however, memory dumps will be endian-dependent. The reason to do this is speed. To achieve endian-independence, the reading of memory dumps on LittleEndian -architectures, such as PC's and DEC architectures, is somewhat slowed +architectures, such as PC’s and DEC architectures, is somewhat slowed (all the multibyte values have to be swapped). Usually, this is not noticeable, and the advantage of being able to share memory dumps across -all platforms at a site far outweighs the speed loss. But if you're +all platforms at a site far outweighs the speed loss. But if you’re trying to squeeze out every possible bit of performance, you may wish to do this. - TeXnically, even without '--disable-dump-share', sharing of '.fmt' + TeXnically, even without ‘--disable-dump-share’, sharing of ‘.fmt’ files cannot be guaranteed to work. Floating-point values are always written in native format, and hence will generally not be readable across platforms. Fortunately, TeX uses floating point only to represent glue ratios, and none of the common formats (plain, LaTeX, -AMSTeX, ...) do any glue setting at '.fmt'-creation time. Metafont does +AMSTeX, ...) do any glue setting at ‘.fmt’-creation time. Metafont does not use floating point in any dumped value at all. Incidentally, different memory dump files will never compare equal byte-for-byte, because the programs dump the current date and time. So -don't be alarmed by a few bytes difference. +don’t be alarmed by a few bytes difference. - If you don't know what endianness your machine is, and you're -curious, here is a little C program to tell you. (The 'configure' -script contains a similar program.) This is from the book 'C: A -Reference Manual', by Samuel P. Harbison and Guy L. Steele Jr. (*note + If you don’t know what endianness your machine is, and you’re +curious, here is a little C program to tell you. (The ‘configure’ +script contains a similar program.) This is from the book ‘C: A +Reference Manual’, by Samuel P. Harbison and Guy L. Steele Jr. (*note References::). main () @@ -845,8 +886,8 @@ References::). exit (u.c[sizeof (long) - 1] == 1); } - You can add 'printf("long %d\n", sizeof(long));' to see the size of -the 'long' data type. + You can add ‘printf("long %d\n", sizeof(long));’ to see the size of +the ‘long’ data type. File: web2c.info, Node: Editor invocation, Next: \input filenames, Prev: Memory dumps, Up: Three programs @@ -856,45 +897,45 @@ File: web2c.info, Node: Editor invocation, Next: \input filenames, Prev: Memo TeX, Metafont, and MetaPost all (by default) stop and ask for user intervention at an error. If the input came from a file, and the user -responds with 'e' or 'E', the program invokes an editor. +responds with ‘e’ or ‘E’, the program invokes an editor. - Specifying '--with-editor=CMD' to 'configure' sets the default editor + Specifying ‘--with-editor=CMD’ to ‘configure’ sets the default editor command string to CMD. The environment variables/configuration values -'TEXEDIT', 'MFEDIT', and 'MPEDIT' (respectively) override this. If -'--with-editor' is not specified, the default is 'vi +%d %s' on Unix, -and an invocation of the TeXworks editor on Windows. (See 'texmf.cnf' +‘TEXEDIT’, ‘MFEDIT’, and ‘MPEDIT’ (respectively) override this. If +‘--with-editor’ is not specified, the default is ‘vi +%d %s’ on Unix, +and an invocation of the TeXworks editor on Windows. (See ‘texmf.cnf’ for the precise values.) - In this string, '%d' is replaced by the line number of the error, and -'%s' is replaced by the name of the current input file. + In this string, ‘%d’ is replaced by the line number of the error, and +‘%s’ is replaced by the name of the current input file. File: web2c.info, Node: \input filenames, Prev: Editor invocation, Up: Three programs -4.5 '\input' filenames +4.5 ‘\input’ filenames ====================== TeX, Metafont, and MetaPost source programs can all read other source -files with the '\input' (TeX) and 'input' (MF and MP) primitives: +files with the ‘\input’ (TeX) and ‘input’ (MF and MP) primitives: \input NAME % in TeX The file NAME can always be terminated with whitespace; for Metafont -and MetaPost, the statement terminator ';' also works. (LaTeX and other -macro packages provide other interfaces to '\input' that allow different +and MetaPost, the statement terminator ‘;’ also works. (LaTeX and other +macro packages provide other interfaces to ‘\input’ that allow different notation; here we are concerned only with the primitive operation.) As (allowed) extensions to standard TeX, Web2c also supports -specifying the filename in double quotes ('"some name"') and in braces -('{some name}'), which is convenient for filenames containing spaces or +specifying the filename in double quotes (‘"some name"’) and in braces +(‘{some name}’), which is convenient for filenames containing spaces or other special characters, as described in the sections below. In all cases, space tokens are ignored after the filename is read. - Also, double quote ('"') characters are ignored within the filename; -there is no way to read files whose names contain a '"'. + Also, double quote (‘"’) characters are ignored within the filename; +there is no way to read files whose names contain a ‘"’. However, for maximal portability of your document across systems, use -only the characters 'a'-'z', '0'-'9', and at most one '.'. Do not use +only the characters ‘a’–‘z’, ‘0’–‘9’, and at most one ‘.’. Do not use anything but simple filenames, since directory separators vary among systems; instead, add the necessary directories to the appropriate search path. @@ -908,11 +949,11 @@ search path. File: web2c.info, Node: \input quoted filename, Next: \input braced filename, Up: \input filenames -4.5.1 '\input' quoted filename: '\input "some name"' +4.5.1 ‘\input’ quoted filename: ‘\input "some name"’ ---------------------------------------------------- As of Web2c version 7.5.3 (2004), double-quote characters can be used to -include spaces or other special characters. In typical use, the '"' +include spaces or other special characters. In typical use, the ‘"’ characters surround the entire filename: \input "filename with spaces" @@ -921,7 +962,7 @@ can enclose any characters, as in: \input filename" "with" "spaces One more point. In LaTeX, the quotes are needed inside the braces of -its '\input' macro, thus: +its ‘\input’ macro, thus: \input{a b} % fails \input{"a b"} % ok @@ -930,16 +971,16 @@ its '\input' macro, thus: File: web2c.info, Node: \input braced filename, Next: \input filename caveats, Prev: \input quoted filename, Up: \input filenames -4.5.2 '\input' braced filename: '\input{some name}' +4.5.2 ‘\input’ braced filename: ‘\input{some name}’ --------------------------------------------------- -As of Web2c 2020, '\input' filenames in TeX engines (this does not apply +As of Web2c 2020, ‘\input’ filenames in TeX engines (this does not apply in Metafont and MetaPost) can also be specified within a TeX group, typically curly braces. For example: \input{filename with spaces} As always with TeX, the brace characters are not hardwired; what -counts is the category code: the first token after the '\input' must be +counts is the category code: the first token after the ‘\input’ must be of catcode 1 (begin group), and it is matched with the next character of catcode 2 (end group). @@ -947,18 +988,18 @@ catcode 2 (end group). characters. As with all forms of filenames, following spaces are ignored (after -the end group), and double quote ('"') characters are ignored within the +the end group), and double quote (‘"’) characters are ignored within the filename. File: web2c.info, Node: \input filename caveats, Prev: \input braced filename, Up: \input filenames -4.5.3 '\input' filename caveats +4.5.3 ‘\input’ filename caveats ------------------------------- The quoting mechanisms just described come into play _after_ TeX has tokenized and expanded the input. So, multiple spaces and tabs will -generally be seen as a single space, active characters such as '~' are +generally be seen as a single space, active characters such as ‘~’ are expanded first (generally causing an error), and so on. More examples below. @@ -967,22 +1008,22 @@ null byte (character code zero, ASCII NUL) to terminate strings. So filenames in Web2c cannot contain nulls, even though TeX itself does not treat NUL specially. - Finally, the present Web2c implementation does '~' and '$' expansion -on NAME, unlike Knuth's original implementation. Thus: + Finally, the present Web2c implementation does ‘~’ and ‘$’ expansion +on NAME, unlike Knuth’s original implementation. Thus: \input ~jsmith/$foo.bar will dereference the environment variable or Kpathsea config file -value 'foo' and read that file, extended with '.bar', in user 'jsmith''s +value ‘foo’ and read that file, extended with ‘.bar’, in user ‘jsmith’’s home directory. You can also use braces in the variable expansion, as -in '${foo}bar', if you want to follow the variable name with a letter, -numeral, or '_'. +in ‘${foo}bar’, if you want to follow the variable name with a letter, +numeral, or ‘_’. (So another way to get a program to read a filename containing whitespace is to define an environment variable and dereference it.) In all the common TeX formats (plain TeX, LaTeX, ConTeXt, AMSTeX, -...), the characters '~' and '$' have special category codes, so to +...), the characters ‘~’ and ‘$’ have special category codes, so to actually use these in a document you have to change their catcodes or -use '\string'. +use ‘\string’. File: web2c.info, Node: TeX, Next: Metafont, Prev: Three programs, Up: Top @@ -994,11 +1035,11 @@ TeX is a typesetting system: it was especially designed to handle complex mathematics, as well as most ordinary text typesetting. TeX is a batch language, like C or Pascal, and not an interactive -"word processor": you compile a TeX input file into a corresponding +“word processor”: you compile a TeX input file into a corresponding device-independent (DVI) file (and then translate the DVI file to the commands for a particular output device). This approach has both considerable disadvantages and considerable advantages. For a complete -description of the TeX language, see 'The TeXbook' (*note References::). +description of the TeX language, see ‘The TeXbook’ (*note References::). Many other books on TeX, introductory and otherwise, are available. * Menu: @@ -1014,14 +1055,14 @@ Many other books on TeX, introductory and otherwise, are available. File: web2c.info, Node: tex invocation, Next: Initial TeX, Up: TeX -5.1 'tex' invocation +5.1 ‘tex’ invocation ==================== -TeX (usually invoked as 'tex') formats the given text and commands, and +TeX (usually invoked as ‘tex’) formats the given text and commands, and outputs a corresponding device-independent representation of the typeset document. This section merely describes the options available in the Web2c implementation. For a complete description of the TeX typesetting -language, see 'The TeXbook' (*note References::). +language, see ‘The TeXbook’ (*note References::). TeX, Metafont, and MetaPost process the command line (described here) and determine their memory dump (fmt) file in the same way (*note Memory @@ -1032,20 +1073,20 @@ dumps::). Synopses: tex [OPTION]... &FMT ARGS TeX searches the usual places for the main input file TEXNAME (*note -(kpathsea)Supported file formats::), extending TEXNAME with '.tex' if +(kpathsea)Supported file formats::), extending TEXNAME with ‘.tex’ if necessary. To see all the relevant paths, set the environment variable -'KPATHSEA_DEBUG' to '-1' before running the program. +‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. After TEXNAME is read, TeX processes any remaining TEX-COMMANDS on the command line as regular TeX input. Also, if the first non-option -argument begins with a TeX escape character (usually '\'), TeX processes +argument begins with a TeX escape character (usually ‘\’), TeX processes all non-option command-line arguments as a line of regular TeX input. If no arguments or options are specified, TeX prompts for an input -file name with '**'. +filename with ‘**’. - TeX writes the main DVI output to the file 'BASETEXNAME.dvi', where -BASETEXNAME is the basename of TEXNAME, or 'texput' if no input file was + TeX writes the main DVI output to the file ‘BASETEXNAME.dvi’, where +BASETEXNAME is the basename of TEXNAME, or ‘texput’ if no input file was specified. A DVI file is a device-independent binary representation of your TeX document. The idea is that after running TeX, you translate the DVI file using a separate program to the commands for a particular @@ -1053,125 +1094,125 @@ output device, such as a PostScript printer (*note Introduction: (dvips)Top.) or an X Window System display (see xdvi(1)). TeX also reads TFM files for any fonts you load in your document with -the '\font' primitive. By default, it runs an external program named -'mktextfm' to create any nonexistent TFM files. You can disable this at +the ‘\font’ primitive. By default, it runs an external program named +‘mktextfm’ to create any nonexistent TFM files. You can disable this at configure-time or runtime (*note (kpathsea)mktex configuration::). This is enabled mostly for the sake of the EC fonts, which can be generated at any size. - TeX can write output files, via the '\openout' primitive; this opens + TeX can write output files, via the ‘\openout’ primitive; this opens a security hole vulnerable to Trojan horse attack: an unwitting user -could run a TeX program that overwrites, say, '~/.rhosts'. (MetaPost -has a 'write' primitive with similar implications). To alleviate this -and similar problems the functions 'kpathsea_out_name_ok' and -'kpathsea_in_name_ok' from the Kpathsea library (*note (kpathsea)Calling +could run a TeX program that overwrites, say, ‘~/.rhosts’. (MetaPost +has a ‘write’ primitive with similar implications). To alleviate this +and similar problems the functions ‘kpathsea_out_name_ok’ and +‘kpathsea_in_name_ok’ from the Kpathsea library (*note (kpathsea)Calling sequence::) are used to determine if a given filename is acceptable to be opened for output or input, depending on the setting of the -configuration variables 'openout_any' and 'openin_any': 'a' (for "any", -the default for 'openin_any'), 'r' (for "restricted"), or 'p' (for -"paranoid", the default for 'openout_any'). +configuration variables ‘openout_any’ and ‘openin_any’: ‘a’ (for “any”, +the default for ‘openin_any’), ‘r’ (for “restricted”), or ‘p’ (for +“paranoid”, the default for ‘openout_any’). - In any case, all '\openout' filenames are recorded in the log file, + In any case, all ‘\openout’ filenames are recorded in the log file, except those opened on the first line of input, which is processed when the log file has not yet been opened. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-enc' -'-[no]-file-line-error' -'-fmt=FMTNAME' -'-halt-on-error' -'-ini' -'-interaction=STRING' -'-ipc' -'-ipc-start' -'-jobname=STRING' -'-kpathsea-debug=NUMBER' -'-[no]parse-first-line' -'-output-directory' -'-progname=STRING' -'-recorder' -'-translate-file=TCXFILE' -'-8bit' +‘-help’ and ‘-version’ (*note Common options::): +‘-enc’ +‘-[no]-file-line-error’ +‘-fmt=FMTNAME’ +‘-halt-on-error’ +‘-ini’ +‘-interaction=STRING’ +‘-ipc’ +‘-ipc-start’ +‘-jobname=STRING’ +‘-kpathsea-debug=NUMBER’ +‘-[no]parse-first-line’ +‘-output-directory’ +‘-progname=STRING’ +‘-recorder’ +‘-translate-file=TCXFILE’ +‘-8bit’ These options are common to TeX, Metafont, and MetaPost. *Note Common options::. -'-enc' - Enable encTeX extensions, such as '\mubyte'. This can be used to +‘-enc’ + Enable encTeX extensions, such as ‘\mubyte’. This can be used to support the Unicode UTF-8 input encoding, although using an engine with native Unicode support is more common nowadays. <http://www.olsak.net/enctex.html>. -'-ipc' -'-ipc-start' +‘-ipc’ +‘-ipc-start’ With either option, TeX writes its DVI output to a socket as well - as to the usual '.dvi' file. With '-ipc-start', TeX also opens a + as to the usual ‘.dvi’ file. With ‘-ipc-start’, TeX also opens a server program at the other end to read the output. *Note IPC and TeX: IPC and TeX. - These options are available only if the '--enable-ipc' option was - specified to 'configure' during installation of Web2c. + These options are available only if the ‘--enable-ipc’ option was + specified to ‘configure’ during installation of Web2c. -'-mktex=FILETYPE' -'-no-mktex=FILETYPE' - Turn on or off the 'mktex' script associated with FILETYPE. For - TeX proper, FILETYPE can only be 'tex' and 'tfm', but for pdfTeX - and luaTeX, it can also be 'pk'. +‘-mktex=FILETYPE’ +‘-no-mktex=FILETYPE’ + Turn on or off the ‘mktex’ script associated with FILETYPE. For + TeX proper, FILETYPE can only be ‘tex’ and ‘tfm’, but for pdfTeX + and luaTeX, it can also be ‘pk’. -'-mltex' - If we are 'INITEX' (*note Initial and virgin::), enable MLTeX - extensions such as '\charsubdef'. Implicitly set if the program - name is 'mltex'. *Note MLTeX: MLTeX. +‘-mltex’ + If we are ‘INITEX’ (*note Initial and virgin::), enable MLTeX + extensions such as ‘\charsubdef’. Implicitly set if the program + name is ‘mltex’. *Note MLTeX: MLTeX. -'-output-comment=STRING' +‘-output-comment=STRING’ Use STRING as the DVI file comment. Ordinarily, this comment records the date and time of the TeX run, but if you are doing regression testing, you may not want the DVI file to have this spurious difference. This is also taken from the environment - variable and config file value 'output_comment'. + variable and config file value ‘output_comment’. -'-shell-escape' -'-no-shell-escape' -'-shell-restricted' +‘-shell-escape’ +‘-no-shell-escape’ +‘-shell-restricted’ Enable, or disable, or enable with restrictions the - '\write18{SHELL-COMMAND}' feature for external executing shell + ‘\write18{SHELL-COMMAND}’ feature for external executing shell commands. *Note Shell escapes::. -'-enable-write18' -'-disable-write18' - Synonyms for '-shell-escape' and '-no-shell-escape', for +‘-enable-write18’ +‘-disable-write18’ + Synonyms for ‘-shell-escape’ and ‘-no-shell-escape’, for compatibility with MiKTeX. (MiKTeX also accepts both pairs of options.) *Note Shell escapes::. -'-src-specials' -'-src-specials=STRING' +‘-src-specials’ +‘-src-specials=STRING’ This option makes TeX output specific source information using - '\special' commands in the DVI file. These '\special' track the - current file name and line number. + ‘\special’ commands in the DVI file. These ‘\special’ track the + current filename and line number. - Using the first form of this option, the '\special' commands are + Using the first form of this option, the ‘\special’ commands are inserted automatically. In the second form of the option, STRING is a comma separated list - of the following values: 'cr', 'display', 'hbox', 'math', 'par', - 'parend', 'vbox'. You can use this list to specify where you want - TeX to output such commands. For example, '-src-specials=cr,math' + of the following values: ‘cr’, ‘display’, ‘hbox’, ‘math’, ‘par’, + ‘parend’, ‘vbox’. You can use this list to specify where you want + TeX to output such commands. For example, ‘-src-specials=cr,math’ will output source information every line and every math formula. These commands can be used with the appropriate DVI viewer and text editor to switch from the current position in the editor to the same position in the viewer and back from the viewer to the editor. - This option works by inserting '\special' commands into the token + This option works by inserting ‘\special’ commands into the token stream, and thus in principle these additional tokens can be recovered or seen by the tricky-enough macros. If you run across a case, let us know, because this counts as a bug. However, such bugs are very hard to fix, requiring significant changes to TeX, so - please don't count on it. + please don’t count on it. - Redefining '\special' will not affect the functioning of this + Redefining ‘\special’ will not affect the functioning of this option. The commands inserted into the token stream are hard-coded - to always use the '\special' primitive. + to always use the ‘\special’ primitive. TeX does not pass the trip test when this option is enabled. @@ -1181,27 +1222,27 @@ File: web2c.info, Node: Initial TeX, Next: Formats, Prev: tex invocation, Up 5.2 Initial TeX =============== -The "initial" form of TeX is invoked by 'tex -ini'. It does lengthy -initializations avoided by the "virgin" ('vir') form, so as to be -capable of dumping '.fmt' files (*note Memory dumps::). For a detailed +The “initial” form of TeX is invoked by ‘tex -ini’. It does lengthy +initializations avoided by the “virgin” (‘vir’) form, so as to be +capable of dumping ‘.fmt’ files (*note Memory dumps::). For a detailed comparison of virgin and initial forms, *note Initial and virgin::. For a list of options and other information, *note tex invocation::. Unlike Metafont and MetaPost, many format files are commonly used with TeX. The standard one implementing the features described in the -'TeXbook' is 'plain.fmt', also known as 'tex.fmt' (again, *note Memory +‘TeXbook’ is ‘plain.fmt’, also known as ‘tex.fmt’ (again, *note Memory dumps::). It is created by default during installation, but you can -also do so by hand if necessary (e.g., if an update to 'plain.tex' is +also do so by hand if necessary (e.g., if an update to ‘plain.tex’ is issued): tex -ini '\input plain \dump' (The quotes prevent interpretation of the backslashes from the shell.) -Then install the resulting 'plain.fmt' in '$(fmtdir)' -('/usr/local/share/texmf/web2c' by default), and link 'tex.fmt' to it. +Then install the resulting ‘plain.fmt’ in ‘$(fmtdir)’ +(‘/usr/local/share/texmf/web2c’ by default), and link ‘tex.fmt’ to it. The necessary invocation for generating a format file differs for each format, so instructions that come with the format should explain. -The top-level 'web2c' Makefile has targets for making most common +The top-level ‘web2c’ Makefile has targets for making most common formats: plain latex amstex texinfo eplain. *Note Formats::, for more details on TeX formats. @@ -1211,25 +1252,25 @@ File: web2c.info, Node: Formats, Next: Languages and hyphenation, Prev: Initi 5.3 Formats =========== -TeX "formats" are large collections of macros, often dumped into a -'.fmt' file (*note Memory dumps::) by 'tex -ini' (*note Initial TeX::). +TeX “formats” are large collections of macros, often dumped into a +‘.fmt’ file (*note Memory dumps::) by ‘tex -ini’ (*note Initial TeX::). A number of formats are in reasonably widespread use, and the Web2c Makefile has targets to make the versions current at the time of release. You can change which formats are automatically built by -setting the 'fmts' Make variable; by default, only the 'plain' and -'latex' formats are made. +setting the ‘fmts’ Make variable; by default, only the ‘plain’ and +‘latex’ formats are made. Nowadays, the formats are generally installed and updated as part of a larger TeX distribution, such as TeX Live (<https://tug.org/texlive>). latex The most widely used format. The current release is named - 'LaTeX2e'; new versions are released approximately every six + ‘LaTeX2e’; new versions are released approximately every six months, with patches issued as needed. The old release was called - 'LaTeX 2.09', and is no longer maintained or supported. LaTeX + ‘LaTeX 2.09’, and is no longer maintained or supported. LaTeX attempts to provide generic markup instructions, such as - "emphasize", instead of specific typesetting instructions, such as - "use the 10pt Computer Modern italic font". The LaTeX home page: + “emphasize”, instead of specific typesetting instructions, such as + “use the 10pt Computer Modern italic font”. The LaTeX home page: <https://www.latex-project.org>. context @@ -1244,18 +1285,18 @@ amstex Society. Like LaTeX, it encourages generic markup commands. The AMS also provides many LaTeX packages for authors who prefer LaTeX. Taken together, they are used to produce nearly all AMS - publications, e.g., 'Mathematical Reviews'. The AMSTeX home page: + publications, e.g., ‘Mathematical Reviews’. The AMSTeX home page: <https://www.ams.org/tex>. texinfo The documentation system developed and maintained by the Free Software Foundation for their software manuals. It can be automatically converted into plain text, a machine-readable on-line - format called 'info', HTML, etc. The Texinfo home page: + format called ‘info’, HTML, etc. The Texinfo home page: <https://www.gnu.org/software/texinfo>. eplain - The "expanded plain" format provides various common features (e.g., + The “expanded plain” format provides various common features (e.g., symbolic cross-referencing, tables of contents, indexing, citations using BibTeX), for those authors who prefer to handle their own high-level formatting. The Eplain home page: @@ -1263,7 +1304,7 @@ eplain slitex An obsolete LaTeX 2.09 format for making slides. It is replaced by - the 'slides' document class, although the 'beamer' package is the + the ‘slides’ document class, although the ‘beamer’ package is the most commonly method for making slides nowadays. The Beamer page on CTAN: <https://ctan.org/pkg/beamer>. @@ -1288,7 +1329,7 @@ File: web2c.info, Node: MLTeX, Next: TCX files, Up: Languages and hyphenation 5.4.1 MLTeX: Multi-lingual TeX ------------------------------ -Multi-lingual TeX ('mltex') is an extension of TeX originally written by +Multi-lingual TeX (‘mltex’) is an extension of TeX originally written by Michael Ferguson and now updated and maintained by Bernd Raichle. With the advent of Unicode, it has become obsolete, though it is still supported in Web2c in the event of bugs or compilation bugs. @@ -1296,19 +1337,19 @@ supported in Web2c in the event of bugs or compilation bugs. MLTeX allows the use of non-existing glyphs in a font by declaring glyph substitutions. These are restricted to substitutions of an accented character glyph, which need not be defined in the current font, -by its appropriate '\accent' construction using a base and accent +by its appropriate ‘\accent’ construction using a base and accent character glyph, which do have to exist in the current font. This substitution is automatically done behind the scenes, if necessary, and thus MLTeX additionally supports hyphenation of words containing an accented character glyph for fonts missing this glyph (e.g., Computer Modern). Standard TeX suppresses hyphenation in this case. - MLTeX works at '.fmt'-creation time: the basic idea is to specify the -'-mltex' option to TeX when you '\dump' a format. Then, when you -subsequently invoke TeX and read that '.fmt' file, the MLTeX features + MLTeX works at ‘.fmt’-creation time: the basic idea is to specify the +‘-mltex’ option to TeX when you ‘\dump’ a format. Then, when you +subsequently invoke TeX and read that ‘.fmt’ file, the MLTeX features described below will be enabled. - Generally, you use special macro files to create an MLTeX '.fmt' + Generally, you use special macro files to create an MLTeX ‘.fmt’ file. The sections below describe the two new primitives that MLTeX @@ -1323,65 +1364,65 @@ TeX. File: web2c.info, Node: \charsubdef, Next: \tracingcharsubdef, Up: MLTeX -5.4.1.1 '\charsubdef': Character substitutions +5.4.1.1 ‘\charsubdef’: Character substitutions .............................................. -The most important primitive MLTeX adds is '\charsubdef', used in a way -reminiscent of '\chardef': +The most important primitive MLTeX adds is ‘\charsubdef’, used in a way +reminiscent of ‘\chardef’: \charsubdef COMPOSITE [=] ACCENT BASE Each of COMPOSITE, ACCENT, and BASE are font glyph numbers, expressed in the usual TeX syntax: `\e symbolically, '145 for octal, "65 for hex, 101 for decimal. - MLTeX's '\charsubdef' declares how to construct an accented character + MLTeX’s ‘\charsubdef’ declares how to construct an accented character glyph (not necessarily existing in the current font) using two character glyphs (that do exist). Thus it defines whether a character glyph code, -either typed as a single character or using the '\char' primitive, will -be mapped to a font glyph or to an '\accent' glyph construction. +either typed as a single character or using the ‘\char’ primitive, will +be mapped to a font glyph or to an ‘\accent’ glyph construction. For example, if you assume glyph code 138 (decimal) for an e-circumflex and you are using the Computer Modern fonts, which have the -circumflex accent in position 18 and lowercase 'e' in the usual ASCII -position 101 decimal, you would use '\charsubdef' as follows: +circumflex accent in position 18 and lowercase ‘e’ in the usual ASCII +position 101 decimal, you would use ‘\charsubdef’ as follows: \charsubdef 138 = 18 101 For the plain TeX format to make use of this substitution, you have -to redefine the circumflex accent macro '\^' in such a way that if its -argument is character 'e' the expansion '\char138 ' is used instead of -'\accent18 e'. Similar '\charsubdef' declaration and macro +to redefine the circumflex accent macro ‘\^’ in such a way that if its +argument is character ‘e’ the expansion ‘\char138 ’ is used instead of +‘\accent18 e’. Similar ‘\charsubdef’ declaration and macro redefinitions have to be done for all other accented characters. - To disable a previous '\charsubdef C', redefine C as a pair of zeros. + To disable a previous ‘\charsubdef C’, redefine C as a pair of zeros. For example: \charsubdef '321 = 0 0 % disable N tilde (Octal '321 is the ISO Latin-1 value for the Spanish N tilde.) - '\charsubdef' commands should only be given once. Although in -principle you can use '\charsubdef' at any time, the result is -unspecified. If '\charsubdef' declarations are changed, usually either + ‘\charsubdef’ commands should only be given once. Although in +principle you can use ‘\charsubdef’ at any time, the result is +unspecified. If ‘\charsubdef’ declarations are changed, usually either incorrect character dimensions will be used or MLTeX will output missing -character warnings. (The substitution of a '\charsubdef' is used by TeX +character warnings. (The substitution of a ‘\charsubdef’ is used by TeX when appending the character node to the current horizontal list, to compute the width of a horizontal box when the box gets packed, and when -building the '\accent' construction at '\shipout'-time. In summary, the +building the ‘\accent’ construction at ‘\shipout’-time. In summary, the substitution is accessed often, so changing it is not desirable, nor generally useful.) File: web2c.info, Node: \tracingcharsubdef, Prev: \charsubdef, Up: MLTeX -5.4.1.2 '\tracingcharsubdef': Substitution diagnostics +5.4.1.2 ‘\tracingcharsubdef’: Substitution diagnostics ...................................................... -To help diagnose problems with '\charsubdef', MLTeX provides a new -primitive parameter, '\tracingcharsubdef'. If positive, every use of -'\charsubdef' will be reported. This can help track down when a +To help diagnose problems with ‘\charsubdef’, MLTeX provides a new +primitive parameter, ‘\tracingcharsubdef’. If positive, every use of +‘\charsubdef’ will be reported. This can help track down when a character is redefined. - In addition, if the TeX parameter '\tracinglostchars' is 100 or more, -the character substitutions actually performed at '\shipout'-time will + In addition, if the TeX parameter ‘\tracinglostchars’ is 100 or more, +the character substitutions actually performed at ‘\shipout’-time will be recorded. @@ -1396,8 +1437,8 @@ being used. Specifically, they map an input (keyboard) character code to the internal TeX character code (a superset of ASCII). Of the various proposals for handling more than one input encoding, -TCX files were chosen because they follow Knuth's original ideas for the -use of the 'xchr' and 'xord' tables. He ventured that these would be +TCX files were chosen because they follow Knuth’s original ideas for the +use of the ‘xchr’ and ‘xord’ tables. He ventured that these would be changed in the WEB source in order to adjust the actual version to a given environment. It turns out, however, that recompiling the WEB sources is not as simple a task as Knuth may have imagined; therefore, @@ -1413,56 +1454,56 @@ typeset output. But we feel the benefits outweigh these disadvantages. This is entirely independent of the MLTeX extension (*note MLTeX::): whereas a TCX file defines how an input keyboard character is mapped to -TeX's internal code, MLTeX defines substitutions for a non-existing -character glyph in a font with a '\accent' construction made out of two +TeX’s internal code, MLTeX defines substitutions for a non-existing +character glyph in a font with a ‘\accent’ construction made out of two separate character glyphs. TCX files involve no new primitives; it is not possible to specify that an input (keyboard) character maps to more than one character. Information on specifying TCX files: - * The best way to specify a TCX file is to list it explicitly in the + • The best way to specify a TCX file is to list it explicitly in the first line of the main document: %& -translate-file=TCXFILE - * You can also specify a TCX file to be used on a particular TeX run - with the command-line option '-translate-file=TCXFILE'. + • You can also specify a TCX file to be used on a particular TeX run + with the command-line option ‘-translate-file=TCXFILE’. - * TCX files are searched for along the 'WEB2C' path. + • TCX files are searched for along the ‘WEB2C’ path. - * Initial TeX (*note Initial TeX: Initial TeX.) ignores TCX files. + • Initial TeX (*note Initial TeX: Initial TeX.) ignores TCX files. The Web2c distribution comes with a number of TCX files. Two -important ones are 'il1-t1.tcx' and 'il2-t1.tcx', which support ISO +important ones are ‘il1-t1.tcx’ and ‘il2-t1.tcx’, which support ISO Latin 1 and ISO Latin 2, respectively, with Cork-encoded fonts (a.k.a. the LaTeX T1 encoding). TCX files for Czech, Polish, and Slovak are also provided. - One other notable TCX file is 'empty.tcx', which is, well, empty. -Its purpose is to reset Web2C's behavior to the default (only visible + One other notable TCX file is ‘empty.tcx’, which is, well, empty. +Its purpose is to reset Web2C’s behavior to the default (only visible ASCII being printable, as described below) when a format was dumped with -another TCX being active--which is in fact the case for everything but +another TCX being active—which is in fact the case for everything but plain TeX in the TeX Live and other distributions. Thus: latex somefile8.tex - => terminal etc. output with 8-bit chars + ⇒ terminal etc. output with 8-bit chars latex --translate-file=empty.tcx somefile8.tex - => terminal etc. output with ^^ notation + ⇒ terminal etc. output with ^^ notation Syntax of TCX files: 1. Line-oriented. Blank lines are ignored. 2. Whitespace is ignored except as a separator. - 3. Comments start with '%' and continue to the end of the line. + 3. Comments start with ‘%’ and continue to the end of the line. 4. Otherwise, a line consists of one or two character codes, optionally followed by 0 or 1. The last number indicates whether DEST is considered printable. SRC [DEST [PRNT]] - 5. Each character code may be specified in octal with a leading '0', - hexadecimal with a leading '0x', or decimal otherwise. Values must + 5. Each character code may be specified in octal with a leading ‘0’, + hexadecimal with a leading ‘0x’, or decimal otherwise. Values must be between 0 and 255, inclusive (decimal). 6. If the DEST code is not specified, it is taken to be the same as @@ -1471,35 +1512,35 @@ plain TeX in the TeX Live and other distributions. Thus: 7. If the same SRC code is specified more than once, it is the last definition that counts. - Finally, here's what happens: when TeX sees an input character with + Finally, here’s what happens: when TeX sees an input character with code SRC, it 1) changes SRC to DEST; and 2) makes the DEST code -"printable", i.e., printed as-is in diagnostics and the log file rather -than in '^^' notation. +“printable”, i.e., printed as-is in diagnostics and the log file rather +than in ‘^^’ notation. By default, no characters are translated, and character codes between 32 and 126 inclusive (decimal) are printable. Specifying translations for the printable ASCII characters (codes -32-127) will yield unpredictable results. Additionally you shouldn't -make the following characters printable: '^^I' (TAB), '^^J' (line feed), -'^^M' (carriage return), and '^^?' (delete), since TeX uses them in +32–127) will yield unpredictable results. Additionally you shouldn’t +make the following characters printable: ‘^^I’ (TAB), ‘^^J’ (line feed), +‘^^M’ (carriage return), and ‘^^?’ (delete), since TeX uses them in various ways. Thus, the idea is to specify the input (keyboard) character code for SRC, and the output (font) character code for DEST. By default, only the printable ASCII characters are considered -printable by TeX. If you specify the '-8bit' option, all characters are -considered printable by default. If you specify both the '-8bit' option +printable by TeX. If you specify the ‘-8bit’ option, all characters are +considered printable by default. If you specify both the ‘-8bit’ option and a TCX file, then the TCX can set specific characters to be non-printable. Both the specified TCX encoding and whether characters are printable -are saved in the dump files (like 'tex.fmt'). So by giving these -options in combination with '-ini', you control the defaults seen by +are saved in the dump files (like ‘tex.fmt’). So by giving these +options in combination with ‘-ini’, you control the defaults seen by anyone who uses the resulting dump file. - When loading a dump, if the '-8bit' option was given, then all + When loading a dump, if the ‘-8bit’ option was given, then all characters become printable by default. When loading a dump, if a TCX file was specified, then the TCX data @@ -1521,10 +1562,10 @@ is written to the file OUTPUT. In addition, Patgen prompts interactively for other values. - For more information, see 'Word hy-phen-a-tion by com-put-er' by -Frank Liang (*note References::), and also the 'patgen.web' source file. + For more information, see ‘Word hy-phen-a-tion by com-put-er’ by +Frank Liang (*note References::), and also the ‘patgen.web’ source file. - The only options are '-help' and '-version' (*note Common options::). + The only options are ‘-help’ and ‘-version’ (*note Common options::). File: web2c.info, Node: Shell escapes, Next: IPC and TeX, Prev: Languages and hyphenation, Up: TeX @@ -1532,77 +1573,81 @@ File: web2c.info, Node: Shell escapes, Next: IPC and TeX, Prev: Languages and 5.5 Shell escapes ================= -TeX can execute "shell escapes", that is, arbitrary shell commands. +TeX can execute “shell escapes”, that is, arbitrary shell commands. Although tremendously useful, this also has obvious security -implications. Therefore, as of TeX Live 2009, a "restricted" mode for +implications. Therefore, as of TeX Live 2009, a “restricted” mode for shell escapes is the default mode of operation, which allows executing -only certain commands, as specified in the 'texmf.cnf' configuration +only certain commands, as specified in the ‘texmf.cnf’ configuration file. - * Unrestricted shell escapes are allowed if the option - '--shell-escape' is specified, or if the environment variable or - config file value 'shell_escape' is set to 't' or 'y' and '1'. + • Unrestricted shell escapes are allowed if the option + ‘--shell-escape’ is specified, or if the environment variable or + config file value ‘shell_escape’ is set to ‘t’ or ‘y’ and ‘1’. - * Restricted shell escapes are allowed if 'shell_escape' is set to - 'p'. This is the default. + • Restricted shell escapes are allowed if ‘shell_escape’ is set to + ‘p’. This is the default. - * Shell escapes are completely disabled if '--no-shell-escape' is - specified, or if 'shell_escape' is set to anything else. + • Shell escapes are completely disabled if ‘--no-shell-escape’ is + specified, or if ‘shell_escape’ is set to anything else. When enabled, the TeX construct to execute a system command is -'\write18{SHELL-COMMAND}'; for example: +‘\write18{SHELL-COMMAND}’; for example: \write18{echo "hello, world"} - From TeX's point of view, this is a normal '\write' command, and is + From TeX’s point of view, this is a normal ‘\write’ command, and is therefore subject to the usual TeX expansions. Also, the system call -either happens during the '\output' routine or right away, according to -the absence or presence of the '\immediate' prefix, as usual for -'\write'. +either happens during the ‘\output’ routine or right away, according to +the absence or presence of the ‘\immediate’ prefix, as usual for +‘\write’. The SHELL-COMMAND string is passed to the command shell (via the C -library function 'system'). The output of SHELL-COMMAND is not diverted +library function ‘system’). The output of SHELL-COMMAND is not diverted anywhere, so it will not appear in the log file, or anywhere but the terminal output. The exit status of the system call is also not available to TeX. In unrestricted mode, the argument is simply passed straight to -'system' unaltered. +‘system’ unaltered. In restricted mode, ASCII double quote characters (") should always -be used in the argument to '\write18' where quoting of arguments is +be used in the argument to ‘\write18’ where quoting of arguments is needed, as in the example above. This is to achieve some measure of system independence. On Unix systems, these are replaced with single -quote (') characters to avoid insecure further expansion. Care is also -taken on Windows to avoid additional expansions (from, e.g., `...`). +quote (') characters to avoid insecure further expansion (from, e.g., +`...`). Care is also taken on Windows to avoid additional expansions. Mismatched quotation marks in the command string result in a diagnostic -message in the log file; no execution is performed. +message in the log file, and no execution is performed. After quotation processing, if the first word (delimited by a space or tab) of the command is in the list specified by the -'shell_escape_commands' configuration value, the command is executed. +‘shell_escape_commands’ configuration value, the command is executed. Otherwise it is not. In any case, a message is written to the log file. - The 'shell_escape_commands' value is a comma-separated list of words. + The ‘shell_escape_commands’ value is a comma-separated list of words. Whitespace is significant, and typically should not be present. The -default definition in 'texmf.cnf' looks like this, but with more -commands included: +default definition in ‘texmf.cnf’ looks like this, with more commands +included: shell_escape_commands = bibtex,kpsewhich,repstopdf,... - pdfTeX and luaTeX support reading (via '\input' and '\openin') and -writing (via '\openout') from pipes if the first character is '|'. The + pdfTeX and luaTeX support reading (via ‘\input’ and ‘\openin’) and +writing (via ‘\openout’) from pipes if the first character is ‘|’. The following command is then treated exactly the same as the argument to -'\write18'. In these engines, the primitive variable '\pdfshellescape' +‘\write18’. In these engines, the primitive variable ‘\pdfshellescape’ is set to 0 if shell escapes are disabled, 1 if they are enabled, and 2 if they are enabled with restrictions. The purpose of this feature is to make it possible for TeX documents to perform useful external actions in the common case of an individual -user running a known document on his or her own machine. In such -environments as CGI scripts or wikis where the input has to be +user running a known document on his or her own machine. In +environments such as CGI scripts or wikis where the input has to be considered untrustworthy, shell escapes should be completely disabled. + Programs intended to be called from TeX in restricted should +implement the “paranoid” safety measures regarding output files that TeX +itself does. *Note (kpathsea)Calling sequence::. + File: web2c.info, Node: IPC and TeX, Next: TeX extensions, Prev: Shell escapes, Up: TeX @@ -1612,12 +1657,12 @@ File: web2c.info, Node: IPC and TeX, Next: TeX extensions, Prev: Shell escape (If anyone uses this feature and needs documentation, write <tex-k@tug.org>.) - This functionality is available only if the '--enable-ipc' option was -specified to 'configure' during installation of Web2c (*note + This functionality is available only if the ‘--enable-ipc’ option was +specified to ‘configure’ during installation of Web2c (*note Installation::). - If you define 'IPC_DEBUG' before compilation (e.g., with 'make -XCFLAGS=-DIPC_DEBUG'), TeX will print messages to standard error about + If you define ‘IPC_DEBUG’ before compilation (e.g., with ‘make +XCFLAGS=-DIPC_DEBUG’), TeX will print messages to standard error about its socket operations. This may be helpful if you are, well, debugging. @@ -1631,13 +1676,13 @@ The base TeX program has been extended in many ways. There has been a substantial effort to make a set of extended functionality available across all actively-updated engines, so that formats, notably LaTeX, can rely on it. A list of this common extended -functionality is in a 'LaTeX News' article, +functionality is in a ‘LaTeX News’ article, <https://www.latex-project.org/news/latex2e-news/ltnews31.pdf>. For engines in TeX Live, the detailed documentation for these primitives is mostly in the pdfTeX manual (<http://pdftex.org>). In addition, each engine (naturally) has its own particular features, -described in its own manual. Here's a partial list of the engines. +described in its own manual. Here’s a partial list of the engines. e-TeX Adds many new primitives, including right-to-left typesetting and @@ -1655,7 +1700,7 @@ pdfTeX Can produce PDF as well as DVI files. It also incorporates the e-TeX extensions, new primitives for hypertext and micro-typography, reading/writing from pipes, and much more. In - TeX Live, the command 'etex' invokes pdfTeX to make all these + TeX Live, the command ‘etex’ invokes pdfTeX to make all these additions available with DVI output. Home page: <http://pdftex.org>. @@ -1706,7 +1751,7 @@ drawing lines or curves. This approach has both considerable disadvantages (people unfamiliar with conventional programming languages will be unlikely to find it usable) and considerable advantages (you can make your design intentions specific and parameterizable). For a -complete description of the Metafont language, see 'The METAFONTbook' +complete description of the Metafont language, see ‘The METAFONTbook’ (*note References::). * Menu: @@ -1721,14 +1766,14 @@ complete description of the Metafont language, see 'The METAFONTbook' File: web2c.info, Node: mf invocation, Next: Initial Metafont, Up: Metafont -6.1 'mf' invocation +6.1 ‘mf’ invocation =================== -Metafont (usually invoked as 'mf') reads character definitions specified +Metafont (usually invoked as ‘mf’) reads character definitions specified in the Metafont programming language, and outputs the corresponding font. This section merely describes the options available in the Web2c implementation. For a complete description of the Metafont language, -see 'The Metafontbook' (*note References::). +see ‘The Metafontbook’ (*note References::). Metafont processes its command line and determines its memory dump (base) file in a way exactly analogous to MetaPost and TeX (*note tex @@ -1743,18 +1788,18 @@ invocation::, and *note Memory dumps::). Synopses: (The single quotes avoid unwanted interpretation by the shell.) Metafont searches the usual places for the main input file MFNAME -(*note (kpathsea)Supported file formats::), extending MFNAME with '.mf' +(*note (kpathsea)Supported file formats::), extending MFNAME with ‘.mf’ if necessary. To see all the relevant paths, set the environment -variable 'KPATHSEA_DEBUG' to '-1' before running the program. By -default, Metafont runs an external program named 'mktexmf' to create any +variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. By +default, Metafont runs an external program named ‘mktexmf’ to create any nonexistent Metafont source files you input. You can disable this at configure-time or runtime (*note (kpathsea)mktex configuration::). This is mostly for the sake of the EC fonts, which can be generated at any size. - Metafont writes the main GF output to the file 'BASEMFNAME.NNNgf', + Metafont writes the main GF output to the file ‘BASEMFNAME.NNNgf’, where NNN is the font resolution in pixels per inch, and BASEMFNAME is -the basename of MFNAME, or 'mfput' if no input file was specified. A GF +the basename of MFNAME, or ‘mfput’ if no input file was specified. A GF file contains bitmaps of the actual character shapes. Usually GF files are converted immediately to PK files with GFtoPK (*note gftopk invocation::), since PK files contain equivalent information, but are @@ -1762,23 +1807,23 @@ more compact. (Metafont output in GF format rather than PK for only historical reasons.) Metafont also usually writes a metric file in TFM format to -'BASEMFNAME.tfm'. A TFM file contains character dimensions, kerns, and +‘BASEMFNAME.tfm’. A TFM file contains character dimensions, kerns, and ligatures, and spacing parameters. TeX reads only this .tfm file, not the GF file. The MODE in the example command above is a name referring to a device -definition (*note Modes::); for example, 'localfont' or 'ljfour'. These +definition (*note Modes::); for example, ‘localfont’ or ‘ljfour’. These device definitions must generally be precompiled into the base file. If -you leave this out, the default is 'proof' mode, as stated in 'The -Metafontbook', in which Metafont outputs at a resolution of 2602dpi; +you leave this out, the default is ‘proof’ mode, as stated in ‘The +Metafontbook’, in which Metafont outputs at a resolution of 2602dpi; this is usually not what you want. The remedy is simply to assign a -different mode--'localfont', for example. +different mode—‘localfont’, for example. The MAGNIFICATION assignment in the example command above is a magnification factor; for example, if the device is 600dpi and you -specify 'mag:=2', Metafont will produce output at 1200dpi. Very often, -the MAGNIFICATION is an expression such as 'magstep(.5)', corresponding -to a TeX "magstep", which are factors of 1.2 * sqrt(2). +specify ‘mag:=2’, Metafont will produce output at 1200dpi. Very often, +the MAGNIFICATION is an expression such as ‘magstep(.5)’, corresponding +to a TeX “magstep”, which are factors of 1.2 * sqrt(2). After running Metafont, you can use the font in a TeX document as usual. For example: @@ -1786,27 +1831,27 @@ usual. For example: \myfont Now I am typesetting in my new font (minimum hamburgers). The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-[no]-file-line-error' -'-fmt=FMTNAME' -'-halt-on-error' -'-ini' -'-interaction=STRING' -'-jobname=STRING' -'-kpathsea-debug=NUMBER' -'-[no]parse-first-line' -'-output-directory' -'-progname=STRING' -'-recorder' -'-translate-file=TCXFILE' -'-8bit' +‘-help’ and ‘-version’ (*note Common options::): +‘-[no]-file-line-error’ +‘-fmt=FMTNAME’ +‘-halt-on-error’ +‘-ini’ +‘-interaction=STRING’ +‘-jobname=STRING’ +‘-kpathsea-debug=NUMBER’ +‘-[no]parse-first-line’ +‘-output-directory’ +‘-progname=STRING’ +‘-recorder’ +‘-translate-file=TCXFILE’ +‘-8bit’ These options are common to TeX, Metafont, and MetaPost. *Note Common options::. -'-mktex=FILETYPE' -'-no-mktex=FILETYPE' - Turn on or off the 'mktex' script associated with FILETYPE. The - only value that makes sense for FILETYPE is 'mf'. +‘-mktex=FILETYPE’ +‘-no-mktex=FILETYPE’ + Turn on or off the ‘mktex’ script associated with FILETYPE. The + only value that makes sense for FILETYPE is ‘mf’. File: web2c.info, Node: Initial Metafont, Next: Modes, Prev: mf invocation, Up: Metafont @@ -1814,32 +1859,32 @@ File: web2c.info, Node: Initial Metafont, Next: Modes, Prev: mf invocation, 6.2 Initial Metafont ==================== -'inimf' is the "initial" form of Metafont, which does lengthy -initializations avoided by the "virgin" ('vir') form, so as to be -capable of dumping '.base' files (*note Memory dumps::). For a detailed +‘inimf’ is the “initial” form of Metafont, which does lengthy +initializations avoided by the “virgin” (‘vir’) form, so as to be +capable of dumping ‘.base’ files (*note Memory dumps::). For a detailed comparison of virgin and initial forms, see *note Initial and virgin::. For a list of options and other information, see *note mf invocation::. The only memory dump file commonly used with Metafont is the default -'plain.base', also known as 'mf.base' (again, *note Memory dumps::). It +‘plain.base’, also known as ‘mf.base’ (again, *note Memory dumps::). It is created by default during installation, but you can also do so by hand if necessary (e.g., if a Metafont update is issued): mf -ini '\input plain; input modes; dump' (The quotes prevent interpretation of the backslashes from the shell.) -Then install the resulting 'plain.base' in '$(basedir)' -('/usr/local/share/texmf/web2c' by default), and link 'mf.base' to it. +Then install the resulting ‘plain.base’ in ‘$(basedir)’ +(‘/usr/local/share/texmf/web2c’ by default), and link ‘mf.base’ to it. - For an explanation of the additional 'modes.mf' file, see *note + For an explanation of the additional ‘modes.mf’ file, see *note Modes::. This file has no counterpart in TeX or MetaPost. In the past, it was sometimes useful to create a base file -'cmmf.base' (a.k.a. 'cm.base'), with the Computer Modern macros also +‘cmmf.base’ (a.k.a. ‘cm.base’), with the Computer Modern macros also included in the base file. Nowadays, however, the additional time -required to read 'cmbase.mf' is exceedingly small, usually not enough to -be worth the administrative hassle of updating the 'cmmf.base' file when -you install a new version of 'modes.mf'. People actually working on a +required to read ‘cmbase.mf’ is exceedingly small, usually not enough to +be worth the administrative hassle of updating the ‘cmmf.base’ file when +you install a new version of ‘modes.mf’. People actually working on a typeface may still find it worthwhile to create their own base file, of course. @@ -1850,38 +1895,38 @@ File: web2c.info, Node: Modes, Next: Online Metafont graphics, Prev: Initial ========================================== Running Metafont and creating Metafont base files requires information -that TeX and MetaPost do not: "mode" definitions which specify device +that TeX and MetaPost do not: “mode” definitions which specify device characteristics, so Metafont can properly rasterize the shapes. When making a base file, a file containing modes for -locally-available devices should be input after 'plain.mf'. One +locally-available devices should be input after ‘plain.mf’. One commonly used file is <ftp://ftp.tug.org/tex/modes.mf>; it includes all known definitions. If, however, for some reason you have decreased the memory available -in your Metafont, you may need to copy 'modes.mf' and remove the +in your Metafont, you may need to copy ‘modes.mf’ and remove the definitions irrelevant to you (probably most of them) instead of using -it directly. (Or, if you're a Metafont hacker, maybe you can suggest a -way to redefine 'mode_def' and/or 'mode_setup'; right now, the amount of +it directly. (Or, if you’re a Metafont hacker, maybe you can suggest a +way to redefine ‘mode_def’ and/or ‘mode_setup’; right now, the amount of memory used is approximately four times the total length of the -'mode_def' names, and that's a lot.) +‘mode_def’ names, and that’s a lot.) - If you have a device not included in 'modes.mf', please see comments + If you have a device not included in ‘modes.mf’, please see comments in that file for how to create the new definition, and please send the definition to <tex-fonts@math.utah.edu> to get it included in the next -release of 'modes.mf'. +release of ‘modes.mf’. Usually, when you run Metafont you must supply the name of a mode that was dumped in the base file. But you can also define the mode characteristics dynamically, by invoking Metafont with an assignment to -'smode' instead of 'mode', like this: +‘smode’ instead of ‘mode’, like this: mf '\smode:="newmode.mf"; mag:=MAGNIFICATION; input MFNAME' This is most useful when you are working on the definition of a new mode. The MAGNIFICATION and MFNAME arguments are explained in *note mf -invocation::. In the file 'newmode.mf', you should have the following -(with no 'mode_def' or 'enddef'), if you are using 'modes.mf' +invocation::. In the file ‘newmode.mf’, you should have the following +(with no ‘mode_def’ or ‘enddef’), if you are using ‘modes.mf’ conventions: mode_param (pixels_per_inch, DPI); mode_param (blacker, B); @@ -1890,8 +1935,8 @@ conventions: mode_common_setup_; (Of course, you should use real numbers for DPI, B, F, and O.) - For more information on the use of 'smode', or if you are not using -'modes.mf', see page 269 of 'The Metafontbook'. + For more information on the use of ‘smode’, or if you are not using +‘modes.mf’, see page 269 of ‘The Metafontbook’. File: web2c.info, Node: Online Metafont graphics, Next: gftodvi invocation, Prev: Modes, Up: Metafont @@ -1904,79 +1949,79 @@ number of devices. (See the Metafont manual for more information about how to draw on your screen.) By default, no graphics support is enabled. - Metafont examines the 'MFTERM' environment variable or config file -value at runtime, or the 'TERM' environment variable if 'MFTERM' is not + Metafont examines the ‘MFTERM’ environment variable or config file +value at runtime, or the ‘TERM’ environment variable if ‘MFTERM’ is not set, to determine the device support to use. Naturally, only the devices for which support has been compiled in can be selected. - Here is a table of the possibilities, showing the 'MFTERM' value and -the corresponding 'configure' option(s) in parentheses. + Here is a table of the possibilities, showing the ‘MFTERM’ value and +the corresponding ‘configure’ option(s) in parentheses. -'epsf' - ('--enable-epsfwin') Pseudo-window server for Encapsulated - PostScript (see 'web2c/window/epsf.c'). This device produces an +‘epsf’ + (‘--enable-epsfwin’) Pseudo-window server for Encapsulated + PostScript (see ‘web2c/window/epsf.c’). This device produces an EPS file containing the graphics which would be displayed online on other devices. The name of the EPS file defaults to metafont.eps but can be changed by setting the MFEPSF environment variable to the new filename. Contributed by Mathias Herberts. -'hp2627' - ('--enable-hp2627win') HP2627a color graphics terminals. +‘hp2627’ + (‘--enable-hp2627win’) HP2627a color graphics terminals. -'mftalk' - ('--enable-mftalkwin') Generic window server (see - 'web2c/window/mftalk.c'). +‘mftalk’ + (‘--enable-mftalkwin’) Generic window server (see + ‘web2c/window/mftalk.c’). -'next' - ('--enable-next') NeXT window system. This requires a separate - program, called 'DrawingServant', available separately. See the - 'web2c/window/next.c'. +‘next’ + (‘--enable-next’) NeXT window system. This requires a separate + program, called ‘DrawingServant’, available separately. See the + ‘web2c/window/next.c’. -'regis' - ('--enable-regiswin') Regis terminals. +‘regis’ + (‘--enable-regiswin’) Regis terminals. -'sun' - ('--enable-suntoolswin') The old Suntools (not any flavor of X) - window system. (You can get the even older SunWindows 'gfx' system - by using 'sun-gfx.c'.) +‘sun’ + (‘--enable-suntoolswin’) The old Suntools (not any flavor of X) + window system. (You can get the even older SunWindows ‘gfx’ system + by using ‘sun-gfx.c’.) -'tek' - ('--enable-tektronixwin') Tektronix terminals. +‘tek’ + (‘--enable-tektronixwin’) Tektronix terminals. -'uniterm' - ('--enable-unitermwin') Uniterm, Simon Poole's emulator of a smart +‘uniterm’ + (‘--enable-unitermwin’) Uniterm, Simon Poole’s emulator of a smart Tektronix 4014 terminal. This may work with regular Tektronix - terminals as well; it's faster than the driver - '--enable-tektronixwin' selects. + terminals as well; it’s faster than the driver + ‘--enable-tektronixwin’ selects. -'xterm' - '--with-x' The X window system (version 11). +‘xterm’ + ‘--with-x’ The X window system (version 11). There are two variants of the X11 support, one that works with the Xt toolkit, and another that works directly with Xlib. The Xt support is more efficient and has more functionality, so it is the - default. If you must use the Xlib support, use 'configure --with-x - --with-kf-x-toolkit=no'. + default. If you must use the Xlib support, use ‘configure --with-x + --with-kf-x-toolkit=no’. - Specify '--disable-mf-nowin' in order not to build a separate - non-windows-capable Metafont executable 'mf-nowin' (or - 'mf-nowin.exe'). + Specify ‘--disable-mf-nowin’ in order not to build a separate + non-windows-capable Metafont executable ‘mf-nowin’ (or + ‘mf-nowin.exe’). - You cannot specify any of the usual X options (e.g., '-geometry') + You cannot specify any of the usual X options (e.g., ‘-geometry’) on the Metafont command line, but you can specify X resources in - your '~/.Xdefaults' or '~/.Xresources' file. The class name is - 'Metafont'. If you're using the Xt support, all the usual X - toolkit resources are supported. If you're using the Xlib support, - only the 'geometry' resource is supported. + your ‘~/.Xdefaults’ or ‘~/.Xresources’ file. The class name is + ‘Metafont’. If you’re using the Xt support, all the usual X + toolkit resources are supported. If you’re using the Xlib support, + only the ‘geometry’ resource is supported. You specify the X display to which Metafont connects in the - 'DISPLAY' environment variable, as usual. + ‘DISPLAY’ environment variable, as usual. Writing support for a new device is straightforward. Aside from -defining the basic drawing routines that Metafont uses (see 'mf.web'), +defining the basic drawing routines that Metafont uses (see ‘mf.web’), you only have to add another entry to the tables on the last page of -'web2c/lib/texmfmp.c'. Or you can write an independent program and use -MFtalk (see 'web2c/window/mftalk.c'). +‘web2c/lib/texmfmp.c’. Or you can write an independent program and use +MFtalk (see ‘web2c/window/mftalk.c’). File: web2c.info, Node: gftodvi invocation, Next: mft invocation, Prev: Online Metafont graphics, Up: Metafont @@ -1984,7 +2029,7 @@ File: web2c.info, Node: gftodvi invocation, Next: mft invocation, Prev: Onlin 6.5 GFtoDVI: Character proofs of fonts ====================================== -GFtoDVI makes "proof sheets" from a GF bitmap file as output by, for +GFtoDVI makes “proof sheets” from a GF bitmap file as output by, for example, Metafont (*note Metafont::). This is an indispensable aid for font designers or Metafont hackers. Synopsis: @@ -1992,51 +2037,51 @@ font designers or Metafont hackers. Synopsis: The font GFNAME is searched for in the usual places (*note (kpathsea)Glyph lookup::). To see all the relevant paths, set the -environment variable 'KPATHSEA_DEBUG' to '-1' before running the +environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. - The suffix 'gf' is supplied if not already present. This suffix is -not an extension, no '.' precedes it; for instance, 'cmr10.600gf'. + The suffix ‘gf’ is supplied if not already present. This suffix is +not an extension, no ‘.’ precedes it; for instance, ‘cmr10.600gf’. - The output filename is the basename of GFNAME extended with '.dvi', -e.g., 'gftodvi /wherever/foo.600gf' creates './foo.dvi'. + The output filename is the basename of GFNAME extended with ‘.dvi’, +e.g., ‘gftodvi /wherever/foo.600gf’ creates ‘./foo.dvi’. The characters from GFNAME appear one per page in the DVI output, with labels, titles, and annotations, as specified in Appendix H -(Hardcopy Proofs) of 'The Metafontbook'. +(Hardcopy Proofs) of ‘The Metafontbook’. GFtoDVI uses several fonts besides GFNAME itself: - * "gray font" (default 'gray'): for the pixels that actually make up + • “gray font” (default ‘gray’): for the pixels that actually make up the character. Simply using black is not right, since then labels, key points, and other information could not be shown. - * "title font" (default 'cmr8'): for the header information at the + • “title font” (default ‘cmr8’): for the header information at the top of each output page. - * "label font" (default 'cmtt10'): for the labels on key points of + • “label font” (default ‘cmtt10’): for the labels on key points of the figure. - * "slant font" (no default): for diagonal lines, which are otherwise + • “slant font” (no default): for diagonal lines, which are otherwise simulated using horizontal and vertical rules. - To change the default fonts, you must use 'special' commands in your -Metafont source file, typically via commands like 'slantfont slantlj4'. + To change the default fonts, you must use ‘special’ commands in your +Metafont source file, typically via commands like ‘slantfont slantlj4’. There is no default slant font since no one printer is suitable as a default. You can make your own by copying one of the existing files, -such as '.../fonts/source/public/misc/slantlj4.mf' and then running 'mf' +such as ‘.../fonts/source/public/misc/slantlj4.mf’ and then running ‘mf’ on it. - For testing purposes, you may it useful to run 'mf-nowin rtest' (hit -RETURN when it stops) to get a 'gf' file of a thorn glyph. Or use 'mf' -instead of 'mf-nowin' to have the glyph(s) displayed on the screen. -After that, 'gftodvi rtest.2602gf' should produce 'rtest.dvi', which you + For testing purposes, you may it useful to run ‘mf-nowin rtest’ (hit +RETURN when it stops) to get a ‘gf’ file of a thorn glyph. Or use ‘mf’ +instead of ‘mf-nowin’ to have the glyph(s) displayed on the screen. +After that, ‘gftodvi rtest.2602gf’ should produce ‘rtest.dvi’, which you process as usual. The program accepts the following option, as well as the standard -'-verbose', '-help', and '-version' (*note Common options::): +‘-verbose’, ‘-help’, and ‘-version’ (*note Common options::): -'-overflow-label-offset=POINTS' +‘-overflow-label-offset=POINTS’ Typeset the so-called overflow labels, if any, POINTS TeX points from the right edge of the character bounding box. The default is a little over two inches (ten million scaled points, to be @@ -2051,15 +2096,15 @@ File: web2c.info, Node: mft invocation, Prev: gftodvi invocation, Up: Metafon MFT translates a Metafont program into a TeX document suitable for typesetting, with the aid of TeX macros defined in the file -'mftmac.tex'. Synopsis: +‘mftmac.tex’. Synopsis: mft [OPTION]... MFNAME[.mf] MFT searches the usual places for MFNAME (*note (kpathsea)Supported file formats::). To see all the relevant paths, set the environment -variable 'KPATHSEA_DEBUG' to '-1' before running the program. The -output goes to the basename of MFNAME extended with '.tex', e.g., 'mft -/wherever/foo.mf' creates './foo.tex'. +variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. The +output goes to the basename of MFNAME extended with ‘.tex’, e.g., ‘mft +/wherever/foo.mf’ creates ‘./foo.tex’. Line breaks in the input are carried over into the output; moreover, blank spaces at the beginning of a line are converted to quads of @@ -2068,57 +2113,57 @@ indentation and line breaks. Each line of input is translated independently of the others. Further control is allowed via Metafont comments: - * Metafont comments following a single '%' should be valid TeX input. + • Metafont comments following a single ‘%’ should be valid TeX input. But Metafont material can be included within vertical bars in a comment; this will be translated by MFT as if it were regular - Metafont code. For example, a comment like '% |x2r| is the tip of - the bowl' will be translated into the TeX '% $x_{2r}$ is the ...', - i.e., the 'x2r' is treated as an identifier. + Metafont code. For example, a comment like ‘% |x2r| is the tip of + the bowl’ will be translated into the TeX ‘% $x_{2r}$ is the ...’, + i.e., the ‘x2r’ is treated as an identifier. - * '%%' indicates that the remainder of an input line should be copied + • ‘%%’ indicates that the remainder of an input line should be copied verbatim to the output. This is typically used to introduce additional TeX material at the beginning or an MFT job, e.g. code to modify the standard layout or the formatting macros defined in - 'mftmac.tex', or to add a line saying '%%\bye' at the end of the - job. (MFT doesn't add this automatically in order to allow + ‘mftmac.tex’, or to add a line saying ‘%%\bye’ at the end of the + job. (MFT doesn’t add this automatically in order to allow processing several files produces by MFT in the same TeX job.) - * '%%% TOKEN1 OTHER-TOKENS' introduces a change in MFT's formatting + • ‘%%% TOKEN1 OTHER-TOKENS’ introduces a change in MFT’s formatting rules; all the OTHER-TOKENS will henceforth be translated according to the current conventions for TOKEN1. The tokens must be symbolic (i.e., not numeric or string tokens). For example, the input line %%% addto fill draw filldraw - says to format the 'fill', 'draw', and 'filldraw' operations of - plain Metafont just like the primitive token 'addto', i.e., in + says to format the ‘fill’, ‘draw’, and ‘filldraw’ operations of + plain Metafont just like the primitive token ‘addto’, i.e., in boldface type. Without such reformatting commands, MFT would treat - 'fill' like an ordinary tag or variable name. In fact, you need a - '%%%' command even to get parentheses to act like delimiters. + ‘fill’ like an ordinary tag or variable name. In fact, you need a + ‘%%%’ command even to get parentheses to act like delimiters. - * '%%%%' introduces an MFT comment, i.e., MFT ignores the remainder + • ‘%%%%’ introduces an MFT comment, i.e., MFT ignores the remainder of such a line. - * Five or more '%' signs should not be used. + • Five or more ‘%’ signs should not be used. - (The above description was edited from 'mft.web', written by + (The above description was edited from ‘mft.web’, written by D.E. Knuth.) The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-change=CHFILE[.ch]' +‘-help’ and ‘-version’ (*note Common options::): +‘-change=CHFILE[.ch]’ Apply the change file CHFILE as with Tangle and Weave (*note WEB::). -'-style=MFTFILE[.mft]' +‘-style=MFTFILE[.mft]’ Read MFTFILE before anything else; a MFT style file typically contains only MFT directives as described above. The default style - file is named 'plain.mft', which defines this properly for programs + file is named ‘plain.mft’, which defines this properly for programs using plain Metafont. The MFT files is searched along the - 'MFTINPUTS' path; see *note (kpathsea)Supported file formats::. + ‘MFTINPUTS’ path; see *note (kpathsea)Supported file formats::. - Other examples of MFT style files are 'cmbase.mft', which defines - formatting rules for the macros defined in 'cm.base', and 'e.mft', - which was used in the production of Knuth's Volume E, 'Computer - Modern Typefaces'. + Other examples of MFT style files are ‘cmbase.mft’, which defines + formatting rules for the macros defined in ‘cm.base’, and ‘e.mft’, + which was used in the production of Knuth’s Volume E, ‘Computer + Modern Typefaces’. Using an appropriate MFT style file, it is also possible to configure MFT for typesetting MetaPost sources. However, MFT does @@ -2135,8 +2180,8 @@ File: web2c.info, Node: MetaPost, Next: BibTeX, Prev: Metafont, Up: Top ********************************* MetaPost is a picture-drawing language similar to Metafont (*note -Metafont::), but instead of outputting bitmaps in a "font", it outputs -PostScript commands. It's primarily intended for creating technical +Metafont::), but instead of outputting bitmaps in a “font”, it outputs +PostScript commands. It’s primarily intended for creating technical illustrations, but can also be used to create PostScript or OpenType fonts (<https://ctan.org/pkg/metatype1>). @@ -2153,23 +2198,23 @@ supported) and a number of other subsidiary programs, described below. File: web2c.info, Node: mpost invocation, Next: Initial MetaPost, Up: MetaPost -7.1 'mpost' invocation +7.1 ‘mpost’ invocation ====================== -MetaPost (installed as 'mpost') reads a series of pictures specified in +MetaPost (installed as ‘mpost’) reads a series of pictures specified in the MetaPost programming language, and outputs corresponding PostScript code. This section merely describes the options available in the Web2c implementation. For a complete description of the MetaPost language, see AT&T technical report CSTR-162, generally available in -'TEXMF/doc/metapost/', where TEXMF is the root of TeX directory +‘TEXMF/doc/metapost/’, where TEXMF is the root of TeX directory structure. The MetaPost home page: <https://tug.org/metapost>. Also, a standard MetaPost package for drawing graphs is documented in -AT&T technical report CSTR-164, available as the file 'mpgraph.ps', -generally stored alongside 'mpman.ps'. +AT&T technical report CSTR-164, available as the file ‘mpgraph.ps’, +generally stored alongside ‘mpman.ps’. MetaPost processes its command line and determines its memory dump -(mem) file in a way analogous to Metafont and TeX (*note 'tex' +(mem) file in a way analogous to Metafont and TeX (*note ‘tex’ invocation: tex invocation, and *note Memory dumps::). Synopses: mpost [OPTION]... [MPNAME[.mp]] [MP-COMMANDS] @@ -2177,22 +2222,22 @@ invocation: tex invocation, and *note Memory dumps::). Synopses: mpost [OPTION]... &MEM ARGS MetaPost searches the usual places for the main input file MPNAME -(*note (kpathsea)Supported file formats::), extending MPNAME with '.mp' +(*note (kpathsea)Supported file formats::), extending MPNAME with ‘.mp’ if necessary. To see all the relevant paths, set the environment -variable 'KPATHSEA_DEBUG' to '-1' before running the program. +variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. MetaPost writes its PostScript output to a series of files -'BASEMPNAME.NNN' (or perhaps 'BASEMPNAME.ps', very occasionally -'BASEMPNAME.tfm'), where NNN are the figure numbers specified in the -input, typically to the 'beginfig' macro, and BASEMPNAME is the basename -of MPNAME, or 'mpout' if no input file was specified. MetaPost uses the -'.ps' extension when the figure number is out of range, e.g., if you say -'beginfig(-1)'. +‘BASEMPNAME.NNN’ (or perhaps ‘BASEMPNAME.ps’, very occasionally +‘BASEMPNAME.tfm’), where NNN are the figure numbers specified in the +input, typically to the ‘beginfig’ macro, and BASEMPNAME is the basename +of MPNAME, or ‘mpout’ if no input file was specified. MetaPost uses the +‘.ps’ extension when the figure number is out of range, e.g., if you say +‘beginfig(-1)’. You can use the output files as figures in a TeX document just as with any other PostScript figures. For example, with this TeX command: \special{psfile="FILENAME"} -or by using 'epsf.tex' (*note (dvips)EPSF macros::). +or by using ‘epsf.tex’ (*note (dvips)EPSF macros::). The MetaPost construct btex ... TEX-INPUT ... etex @@ -2201,18 +2246,18 @@ generates a MetaPost picture expression corresponding to TEX-INPUT. The construct verbatimtex ... TEX-INPUT ... etex simply passes the TEX-INPUT through to TeX. For example, if you are -using LaTeX, your MetaPost input file must start with a 'verbatimtex' -block that gives the necessary '\documentclass' (or '\documentstyle') -'\begin{document}' command. You will also need to set the environment -variable 'TEX' to 'latex'. +using LaTeX, your MetaPost input file must start with a ‘verbatimtex’ +block that gives the necessary ‘\documentclass’ (or ‘\documentstyle’) +‘\begin{document}’ command. You will also need to set the environment +variable ‘TEX’ to ‘latex’. TEX-INPUT need not be specifically TeX input; it could also be Troff. -In that case, you will need the '-m pictures' Troff macro package +In that case, you will need the ‘-m pictures’ Troff macro package (unfortunately absent from many Troff implementations), or an equivalent -such as the '-m pspic' macros from GNU groff described in grops(1). +such as the ‘-m pspic’ macros from GNU groff described in grops(1). Naturally, you must use fonts that are supported by the typesetter; -specifically, you'll probably want to use standard PostScript fonts with +specifically, you’ll probably want to use standard PostScript fonts with Troff. And only the TeX system understands Computer Modern or other Metafont fonts; you can also use PostScript fonts with TeX, of course. @@ -2221,49 +2266,49 @@ fonts for labels cannot be directly previewed or printed. Instead, you must include them in a TeX document and run the resulting DVI file through Dvips to arrange for the downloading of the required fonts (*note (dvips)Fonts in figures::). To help with this, the MetaPost -distribution provides a small TeX file 'mproof.tex' which is typically +distribution provides a small TeX file ‘mproof.tex’ which is typically called as: tex mproof MP-OUTPUT-FILES... ; dvips mproof -o -The resulting file 'mproof.ps' can then be printed or previewed. +The resulting file ‘mproof.ps’ can then be printed or previewed. To generate EPSF files, set the internal MetaPost variable -'prologues' positive. To make the output files self-contained, use only -standard PostScript fonts. MetaPost reads the same 'psfonts.map' file +‘prologues’ positive. To make the output files self-contained, use only +standard PostScript fonts. MetaPost reads the same ‘psfonts.map’ file as Dvips, to determine PostScript fonts that need to be downloaded (*note (dvips)psfonts.map::). It is possible for pdfTeX to read MetaPost output directly; this is in contrast to general EPSF files, which have to be converted for use with PDF output. The easiest way is to name the MetaPost output files -with the '.mps' extension. Then the LaTeX '\includegraphics' command, +with the ‘.mps’ extension. Then the LaTeX ‘\includegraphics’ command, for example, will be able to read them, even when outputting PDF. - MetaPost can write output files, via the 'write' primitive; this + MetaPost can write output files, via the ‘write’ primitive; this opens a security hole. *Note tex invocation::. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-[no]-file-line-error' -'-fmt=FMTNAME' -'-halt-on-error' -'-ini' -'-interaction=STRING' -'-jobname=STRING' -'-kpathsea-debug=NUMBER' -'-[no]parse-first-line' -'-output-directory' -'-progname=STRING' -'-recorder' -'-translate-file=TCXFILE' -'-8bit' +‘-help’ and ‘-version’ (*note Common options::): +‘-[no]-file-line-error’ +‘-fmt=FMTNAME’ +‘-halt-on-error’ +‘-ini’ +‘-interaction=STRING’ +‘-jobname=STRING’ +‘-kpathsea-debug=NUMBER’ +‘-[no]parse-first-line’ +‘-output-directory’ +‘-progname=STRING’ +‘-recorder’ +‘-translate-file=TCXFILE’ +‘-8bit’ These options are common to TeX, Metafont, and MetaPost. *Note Common options::. -'-T' -'-troff' - Set the 'prologues' internal variable to '1'. +‘-T’ +‘-troff’ + Set the ‘prologues’ internal variable to ‘1’. -'-tex=TEXPROGRAM' +‘-tex=TEXPROGRAM’ When this option is given, the program TEXPROGRAM is used to typeset the labels. @@ -2273,18 +2318,18 @@ File: web2c.info, Node: Initial MetaPost, Next: dvitomp invocation, Prev: mpo 7.2 Initial MetaPost ==================== -As of MetaPost 1.504 (TeX Live 2011), MetaPost no longer dumps '.mem' +As of MetaPost 1.504 (TeX Live 2011), MetaPost no longer dumps ‘.mem’ files (*note Memory dumps::) and does not distinguish virgin and initial -forms (*note Initial and virgin::). Instead, the "initial" file name is -read in its source form--that is, 'mpost.mp' when the program is invoked -as 'mpost'. +forms (*note Initial and virgin::). Instead, the “initial” file name is +read in its source form—that is, ‘mpost.mp’ when the program is invoked +as ‘mpost’. For a list of options and other information, see *note mpost invocation::. MetaPost provides a format with all the features of plain Metafont, -called 'mfplain'. You can use that in the same way; just run 'mfplain' -instead of 'mpost'. This lets you directly process Metafont source +called ‘mfplain’. You can use that in the same way; just run ‘mfplain’ +instead of ‘mpost’. This lets you directly process Metafont source files with MetaPost, producing character proofs (one file for each character) similar to those produced with Metafont in proof mode and GFtoDVI (*note gftodvi invocation::). @@ -2301,13 +2346,13 @@ so-called MPX file. Synopsis: dvitomp DVIFILE[.dvi] [MPXFILE[.mpx]] If MPXFILE is not specified, the output goes to the basename of DVIFILE -extended with '.mpx', e.g., 'dvitomp /wherever/foo.dvi' creates -'./foo.mpx'. +extended with ‘.mpx’, e.g., ‘dvitomp /wherever/foo.dvi’ creates +‘./foo.mpx’. - DVItoMP supports Dvips-style color specials, such as 'color push -NAME' and 'color pop', outputting them as 'withcolor' MetaPost commands. + DVItoMP supports Dvips-style color specials, such as ‘color push +NAME’ and ‘color pop’, outputting them as ‘withcolor’ MetaPost commands. - The only options are '-help' and '-version' (*note Common options::). + The only options are ‘-help’ and ‘-version’ (*note Common options::). File: web2c.info, Node: BibTeX, Next: WEB, Prev: MetaPost, Up: Top @@ -2329,33 +2374,33 @@ File: web2c.info, Node: bibtex invocation, Next: Basic BibTeX style files, Up 8.1 BibTeX invocation ===================== -BibTeX creates a printable bibliography ('.bbl') file from references in -a '.aux' file, generally written by TeX or LaTeX. The '.bbl' file is +BibTeX creates a printable bibliography (‘.bbl’) file from references in +a ‘.aux’ file, generally written by TeX or LaTeX. The ‘.bbl’ file is then incorporated on a subsequent run. The basic bibliographic -information comes from '.bib' files, and a BibTeX style ('.bst') file -controls the precise contents of the '.bbl' file. Synopsis: +information comes from ‘.bib’ files, and a BibTeX style (‘.bst’) file +controls the precise contents of the ‘.bbl’ file. Synopsis: bibtex [OPTION]... AUXFILE[.aux] -The output goes to the basename of AUXFILE extended with '.bbl'; for -example, 'bibtex /wherever/foo.aux' creates './foo.bbl'. BibTeX also -writes a log file to the basename of AUXFILE extended with '.blg'. +The output goes to the basename of AUXFILE extended with ‘.bbl’; for +example, ‘bibtex /wherever/foo.aux’ creates ‘./foo.bbl’. BibTeX also +writes a log file to the basename of AUXFILE extended with ‘.blg’. - The names of the '.bib' and '.bst' files are specified in the '.aux' -file as well, via the '\bibliography' and '\bibliographystyle' (La)TeX -macros. BibTeX searches for '.bib' files using the 'BIBINPUTS' and -'TEXBIB' paths, and for '.bst' files using 'BSTINPUTS' (*note + The names of the ‘.bib’ and ‘.bst’ files are specified in the ‘.aux’ +file as well, via the ‘\bibliography’ and ‘\bibliographystyle’ (La)TeX +macros. BibTeX searches for ‘.bib’ files using the ‘BIBINPUTS’ and +‘TEXBIB’ paths, and for ‘.bst’ files using ‘BSTINPUTS’ (*note (kpathsea)Supported file formats::). It does no path searching for -'.aux' files. +‘.aux’ files. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-terse' +‘-help’ and ‘-version’ (*note Common options::): +‘-terse’ Suppress the program banner and progress reports normally output. -'-min-crossrefs=N' +‘-min-crossrefs=N’ If at least N (2 by default) bibliography entries refer to another - entry E via their 'crossref' field, include E in the .bbl file, + entry E via their ‘crossref’ field, include E in the .bbl file, even if it was not explicitly referenced in the .aux file. For example, E might be a conference proceedings as a whole, with the cross-referencing entries being individual articles published in @@ -2368,20 +2413,20 @@ macros. BibTeX searches for '.bib' files using the 'BIBINPUTS' and .aux, and nothing will remove it. See also: -'btxdoc.tex' +‘btxdoc.tex’ Basic LaTeXable documentation for general BibTeX users. -'btxhak.tex' +‘btxhak.tex’ LaTeXable documentation for style designers. -'btxdoc.bib' +‘btxdoc.bib’ BibTeX database file for the two above documents. -'xampl.bib' +‘xampl.bib’ Example database file with all the standard entry types. -'<ftp://ftp.math.utah.edu/pub/tex/bib/>' - A very large '.bib' and '.bst' collection, including references for +‘<ftp://ftp.math.utah.edu/pub/tex/bib/>’ + A very large ‘.bib’ and ‘.bst’ collection, including references for all the standard TeX books and a complete bibliography for TUGboat. @@ -2391,41 +2436,41 @@ File: web2c.info, Node: Basic BibTeX style files, Prev: bibtex invocation, Up ============================ Here are descriptions of the four standard and four semi-standard basic -BibTeX styles. 'CTAN:/biblio/bibtex' contains these and many more (for +BibTeX styles. ‘CTAN:/biblio/bibtex’ contains these and many more (for CTAN info, *note (kpathsea)unixtex.ftp::). -'plain' +‘plain’ Sorts entries alphabetically, with numeric labels. Generally - formatted according to van Leunen's 'A Handbook for Scholars'. The - other style files listed here are based on 'plain'. + formatted according to van Leunen’s ‘A Handbook for Scholars’. The + other style files listed here are based on ‘plain’. -'abbrv' +‘abbrv’ First names, month names, and journal names are abbreviated. -'acm' +‘acm’ Names are printed in small caps. -'alpha' - Alphanumeric labels, e.g., 'Knu66'. +‘alpha’ + Alphanumeric labels, e.g., ‘Knu66’. -'apalike' +‘apalike’ No labels at all; instead, the year appears in parentheses after - the author. Use this in conjunction with 'apalike.tex' (plain TeX) - or 'apalike.sty' (LaTeX), which also changes the citations in the - text to be '(AUTHOR, YEAR)'. + the author. Use this in conjunction with ‘apalike.tex’ (plain TeX) + or ‘apalike.sty’ (LaTeX), which also changes the citations in the + text to be ‘(AUTHOR, YEAR)’. -'ieeetr' +‘ieeetr’ Numeric labels, entries in citation order, IEEE abbreviations, article titles in quotes. -'siam' - Numeric labels, alphabetic order, 'Math. Reviews' abbreviations, +‘siam’ + Numeric labels, alphabetic order, ‘Math. Reviews’ abbreviations, names in small caps. -'unsrt' +‘unsrt’ Lists entries in citation order, i.e., unsorted. -'btxbst.doc' +‘btxbst.doc’ The template file and documentation for the standard styles. @@ -2434,21 +2479,21 @@ File: web2c.info, Node: WEB, Next: DVI utilities, Prev: BibTeX, Up: Top 9 WEB: Literate programming *************************** -"WEB" languages allow you to write a single source file that can produce +“WEB” languages allow you to write a single source file that can produce both a compilable program and a well-formatted document describing the program in as much detail as you wish to prepare. Writing in this kind -of dual-purpose language is called "literate programming". (The Usenet -newsgroup 'comp.programming.literate' is devoted to this subject.) +of dual-purpose language is called “literate programming”. (The Usenet +newsgroup ‘comp.programming.literate’ is devoted to this subject.) WEB-like languages have been implemented with many pairs of base languages: Cweb provides C and Troff (*note References::); CWEB provides -C and TeX ('CTAN:/web/c_cpp/cweb'); Spiderweb provides C, C++, Awk, Ada, -many others, and TeX ('CTAN:/web/spiderweb'); and, of course, the +C and TeX (‘CTAN:/web/c_cpp/cweb’); Spiderweb provides C, C++, Awk, Ada, +many others, and TeX (‘CTAN:/web/spiderweb’); and, of course, the original WEB provides Pascal and TeX, the implementation languages for the original TeX, Metafont, MetaPost, and related programs to come from the TeX project at Stanford. - The original WEB language is documented in the file 'webman.tex', + The original WEB language is documented in the file ‘webman.tex’, which is included in the <ftp://ftp.tug.org/tex/lib.tar.gz> archive (and available in many other places, of course). @@ -2470,44 +2515,44 @@ WEB::). Synopsis: tangle [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]] The Pascal output is written to the basename of WEBFILE extended with -'.p'; for example, 'tangle /wherever/foo.web' creates './foo.p'. Tangle +‘.p’; for example, ‘tangle /wherever/foo.web’ creates ‘./foo.p’. Tangle applies CHANGEFILE to WEBFILE before writing the output; by default, there is no change file. If the program makes use of the WEB string facility, Tangle writes -the string pool to the basename of WEBFILE extended with '.pool'. +the string pool to the basename of WEBFILE extended with ‘.pool’. The Pascal output is packed into lines of 72 characters or less, with the only concession to readability being the termination of lines at semicolons when this can be done conveniently. The program accepts the following options, as well as the standard -'--help' and '--version' (*note Common options::): +‘--help’ and ‘--version’ (*note Common options::): -'-length=NUMBER' +‘-length=NUMBER’ The number of characters that are considered significant in an identifier. Whether underline characters are counted depends on - the '-underline' option. The default value is 32, the original + the ‘-underline’ option. The default value is 32, the original tangle used 7, but this proved too restrictive for use by Web2c. -'-lowercase' -'-mixedcase' -'-uppercase' +‘-lowercase’ +‘-mixedcase’ +‘-uppercase’ These options specify the case of identifiers in the output of - tangle. If '-uppercase' ('-lowercase') is specified, tangle will + tangle. If ‘-uppercase’ (‘-lowercase’) is specified, tangle will convert all identifiers to uppercase (lowercase). The default is - '-mixedcase', which specifies that the case will not be changed. + ‘-mixedcase’, which specifies that the case will not be changed. -'-underline' +‘-underline’ When this option is given, tangle does not strip underline characters from identifiers. -'-loose' -'-strict' +‘-loose’ +‘-strict’ These options specify how strict tangle must be when checking - identifiers for equality. The default is '-loose', which means + identifiers for equality. The default is ‘-loose’, which means that tangle will follow the rules set by the case-smashing and - underline options above. If '-strict' is set, then identifiers + underline options above. If ‘-strict’ is set, then identifiers will always be stripped of underlines and converted to uppercase before checking whether they collide. @@ -2518,29 +2563,29 @@ File: web2c.info, Node: weave invocation, Next: pooltype invocation, Prev: ta =============================== Weave creates a TeX document from a WEB source file (*note WEB::), -assuming various macros defined in 'webmac.tex'. It takes care of +assuming various macros defined in ‘webmac.tex’. It takes care of typographic details such as page layout, indentation, and italicizing identifiers. It also automatically gathers and outputs extensive cross-reference information. Synopsis: weave [OPTION]... WEBFILE[.web] [CHANGEFILE[.ch]] -The output is to the basename of WEBFILE extended with '.tex'; for -example, 'weave /wherever/foo.web' creates './foo.tex'. Weave applies +The output is to the basename of WEBFILE extended with ‘.tex’; for +example, ‘weave /wherever/foo.web’ creates ‘./foo.tex’. Weave applies CHANGEFILE to WEBFILE before writing the output; by default, there is no change file. The program accepts the following option, as well as the standard -'-verbose', '-help' and '-version' (*note Common options::): -'-x' +‘-verbose’, ‘-help’ and ‘-version’ (*note Common options::): +‘-x’ Omit the cross-reference information: the index, the list of WEB - module names, and the table of contents (an empty 'CONTENTS.tex' + module names, and the table of contents (an empty ‘CONTENTS.tex’ file will still be written when the Weave output file is processed - by TeX using the default 'webmac.tex', though). + by TeX using the default ‘webmac.tex’, though). - Conventionally, WEB programmers should define the TeX '\title' macro + Conventionally, WEB programmers should define the TeX ‘\title’ macro at the beginning of the source file. Also, to get output of only -changed modules, one can say '\let\maybe=\iffalse' (usually as the first +changed modules, one can say ‘\let\maybe=\iffalse’ (usually as the first change in the change file). @@ -2549,7 +2594,7 @@ File: web2c.info, Node: pooltype invocation, Prev: weave invocation, Up: WEB 9.3 Pooltype: Display WEB pool files ==================================== -Pooltype shows the so-called "string number" of each string in a WEB +Pooltype shows the so-called “string number” of each string in a WEB pool file (*note WEB::), as output by Tangle (*note tangle invocation::), including the first 256 strings corresponding to the possible input characters. Pooltype primarily serves as an example of @@ -2559,11 +2604,11 @@ WEB conventions to implementors of the TeX system. Synopsis: No path searching is done for POOLFILE. Output is to standard output. - The only options are '--help' and '--version' (*note Common + The only options are ‘--help’ and ‘--version’ (*note Common options::). As an example of the output, here is the (edited) output for -'tex.pool': +‘tex.pool’: 0: "^^@" 1: "^^A" ... @@ -2574,7 +2619,7 @@ options::). (23617 characters in all.) In Metafont and MetaPost, the first 256 characters are actually -represented as single bytes (i.e., themselves), not in the '^^' +represented as single bytes (i.e., themselves), not in the ‘^^’ notation. Consider Pooltype as showing the results after conversion for output. @@ -2584,16 +2629,16 @@ File: web2c.info, Node: DVI utilities, Next: Font utilities, Prev: WEB, Up: 10 DVI utilities **************** -TeX outputs a file in "DVI" (DeVice Independent) format as a compact +TeX outputs a file in “DVI” (DeVice Independent) format as a compact representation of the original document. DVI files can be translated to meet the requirements of a real physical device, such as PostScript printers (*note Introduction: (dvips)Top.), PCL printers (see dvilj(1)), and X displays (see xdvi(1)). In fact, DVI translators are available -for virtually all common devices: see 'CTAN:/dviware' (for CTAN info, +for virtually all common devices: see ‘CTAN:/dviware’ (for CTAN info, *note (kpathsea)unixtex.ftp::). For the precise definition of the DVI file format, see (for example) -the source file 'web2c/dvitype.web'. +the source file ‘web2c/dvitype.web’. The DVI-processing programs in the Web2c distribution are not device drivers; they perform generic utility functions. @@ -2621,20 +2666,20 @@ Synopsis: standard output if OUTDVI is not specified. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-magnification=INTEGER' +‘-help’ and ‘-version’ (*note Common options::): +‘-magnification=INTEGER’ Override existing magnification in INDVI with INTEGER; 1000 - specifies no magnification. This is equivalent to setting TeX's - '\mag' parameter. + specifies no magnification. This is equivalent to setting TeX’s + ‘\mag’ parameter. -'-max-pages=N' +‘-max-pages=N’ Process N pages; default is one million. -'-page-start=PAGE-SPEC' +‘-page-start=PAGE-SPEC’ Start at the first page matching PAGE-SPEC, which is one or more - (signed) integers separated by periods, corresponding to TeX's - '\count0...9' parameters at '\shipout' time; '*' matches anything. - Examples: '3', '1.*.-4'. + (signed) integers separated by periods, corresponding to TeX’s + ‘\count0...9’ parameters at ‘\shipout’ time; ‘*’ matches anything. + Examples: ‘3’, ‘1.*.-4’. File: web2c.info, Node: dvitype invocation, Prev: dvicopy invocation, Up: DVI utilities @@ -2644,7 +2689,7 @@ File: web2c.info, Node: dvitype invocation, Prev: dvicopy invocation, Up: DVI DVItype translates a DeVice Independent (DVI) file (as output by TeX, for example) to a plain text file that humans can read. It also serves -as a DVI-validating program, i.e., if DVItype can read a file, it's +as a DVI-validating program, i.e., if DVItype can read a file, it’s correct. Synopsis: dvitype [OPTION]... DVIFILE[.dvi] @@ -2652,46 +2697,46 @@ correct. Synopsis: DVItype does not read any bitmap files, but it does read TFM files for fonts referenced in DVIFILE. The usual places are searched (*note (kpathsea)Supported file formats::). To see all the relevant paths, set -the environment variable 'KPATHSEA_DEBUG' to '-1' before running the +the environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. Output goes to standard output. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-dpi=REAL' +‘-help’ and ‘-version’ (*note Common options::): +‘-dpi=REAL’ Do pixel movement calculations at REAL pixels per inch; default 300.0. -'-magnification=INTEGER' +‘-magnification=INTEGER’ Override existing magnification in INDVI with INTEGER; 1000 - specifies no magnification. This is equivalent to setting TeX's - '\mag' parameter. + specifies no magnification. This is equivalent to setting TeX’s + ‘\mag’ parameter. -'-max-pages=N' +‘-max-pages=N’ Process N pages; default is one million. -'-output-level=N' +‘-output-level=N’ Verbosity level of output, from 0 to 4 (default 4): - * 0: Global document information only. - * 1: Most DVI commands included, and typeset characters + • 0: Global document information only. + • 1: Most DVI commands included, and typeset characters summarized. - * 2: Character and movement commands explicitly included. - * 3: DVI stack and current position calculations included. - * 4: Same information as level 3, but DVItype does random + • 2: Character and movement commands explicitly included. + • 3: DVI stack and current position calculations included. + • 4: Same information as level 3, but DVItype does random positioning in the file, reading the DVI postamble first. -'-page-start=PAGE-SPEC' +‘-page-start=PAGE-SPEC’ Start at the first page matching PAGE-SPEC, which is one or more - (signed) integers separated by periods, corresponding to TeX's - '\count0...9' parameters at '\shipout' time; '*' matches anything. - Examples: '1', '5.*.-9'. + (signed) integers separated by periods, corresponding to TeX’s + ‘\count0...9’ parameters at ‘\shipout’ time; ‘*’ matches anything. + Examples: ‘1’, ‘5.*.-9’. -'-show-opcodes' +‘-show-opcodes’ Show numeric opcode values (in decimal) for DVI commands, in braces after the command name. This can help in debugging DVI utilities. We use decimal because in the DVI format documentation (in - 'dvitype.web', among others) the opcodes are shown in decimal. + ‘dvitype.web’, among others) the opcodes are shown in decimal. * Menu: @@ -2704,8 +2749,8 @@ File: web2c.info, Node: dvitype output example, Up: dvitype invocation ----------------------------- As an example of the output from DVItype (see section above), here is -its (abridged) translation of the 'story.dvi' resulting from running the -example in 'The TeXbook', with '-output-level=4' and '-show-opcodes' on. +its (abridged) translation of the ‘story.dvi’ resulting from running the +example in ‘The TeXbook’, with ‘-output-level=4’ and ‘-show-opcodes’ on. ... Options selected: @@ -2761,19 +2806,19 @@ example in 'The TeXbook', with '-output-level=4' and '-show-opcodes' on. Explanation: - * The DVItype options are recorded at the beginning, followed by + • The DVItype options are recorded at the beginning, followed by global information about the document, including fonts used. - * Each DVI command is preceded by its byte position in the file - ('42:', '87:', ...), and (because of the '-show-opcodes') followed - by its decimal opcode value in braces ('{141}', '{142}', ...). + • Each DVI command is preceded by its byte position in the file + (‘42:’, ‘87:’, ...), and (because of the ‘-show-opcodes’) followed + by its decimal opcode value in braces (‘{141}’, ‘{142}’, ...). - * The 'level' lines record information about the DVI stack; 'h' and - 'v' define the current position in DVI units, while 'hh' and 'vv' + • The ‘level’ lines record information about the DVI stack; ‘h’ and + ‘v’ define the current position in DVI units, while ‘hh’ and ‘vv’ are the same in pixels. - * Text sequences are summarized in brackets, as in '[A SHORT STORY]' - and the '[ 1]'. + • Text sequences are summarized in brackets, as in ‘[A SHORT STORY]’ + and the ‘[ 1]’. File: web2c.info, Node: Font utilities, Next: Legalisms, Prev: DVI utilities, Up: Top @@ -2784,11 +2829,11 @@ File: web2c.info, Node: Font utilities, Next: Legalisms, Prev: DVI utilities, The Web2c programs described here convert between various TeX-related font formats; the first section below briefly describes the formats. GFtoPK is the only one that is routinely used, as Metafont outputs GF -format, but it's most efficient for device drivers to use PK. +format, but it’s most efficient for device drivers to use PK. The precise definitions of the PK, GF, TFM, PL, VF, and VPL formats -mentioned below are in the source files that read them; 'pktype.web', -'gftype.web', 'tftopl.web', etc. +mentioned below are in the source files that read them; ‘pktype.web’, +‘gftype.web’, ‘tftopl.web’, etc. * Menu: @@ -2837,10 +2882,10 @@ source document. In order to print DVI files on real devices, you need font files defining digitized character shapes and other data. Then previewers and printer-driver programs can translate your DVI files into something usable by your monitor or printer. Bitmap fonts come with -suffixes such as '.600pk' or '.600gf' or '.3000pxl', where the '600' is +suffixes such as ‘.600pk’ or ‘.600gf’ or ‘.3000pxl’, where the ‘600’ is the horizontal dots-per-inch resolution at which the font was produced, -and the 'pk' or 'gf' or 'pxl' indicates the font format. Outline fonts -in PostScript Type 1 format have suffixes such as '.pfa' or '.pfb'. +and the ‘pk’ or ‘gf’ or ‘pxl’ indicates the font format. Outline fonts +in PostScript Type 1 format have suffixes such as ‘.pfa’ or ‘.pfb’. Fonts in pk (packed) format are in the tightly packed raster format that is pretty much the standard today. They take up less space than @@ -2849,20 +2894,20 @@ less space than fonts in pxl format. Fonts in pxl format take up gross amounts of disk space and permit only 128 characters. They are obsolete. - Font files with the '.pl' (property list) suffix are the plain text -(human-readable) analog of the binary '.tfm' files. The TFtoPL and + Font files with the ‘.pl’ (property list) suffix are the plain text +(human-readable) analog of the binary ‘.tfm’ files. The TFtoPL and PLtoTF programs convert between the two formats (*note tftopl invocation:: and *note pltotf invocation::). - Font files with the '.mf' suffix are in Metafont source format. + Font files with the ‘.mf’ suffix are in Metafont source format. These are the files used by Metafont to generate rastered fonts for specific typefaces at specific magnifications for the specific resolution and type of mapping used by your device. - The suffix '.vf' identifies "virtual font" files, for which '.vpl' is + The suffix ‘.vf’ identifies “virtual font” files, for which ‘.vpl’ is the human-readable analog. See *Note vftovp invocation::, and *note vptovf invocation::. For further discussion of virtual fonts, see -'CTAN:/doc/virtual-fonts.knuth', 'CTAN:/help/virtualfonts.txt', and +‘CTAN:/doc/virtual-fonts.knuth’, ‘CTAN:/help/virtualfonts.txt’, and *note (dvips)Virtual fonts::. (This section is based on documentation in the original Unix TeX @@ -2885,17 +2930,17 @@ Synopsis: The font GFNAME is searched for in the usual places (*note (kpathsea)Glyph lookup::). To see all the relevant paths, set the -environment variable 'KPATHSEA_DEBUG' to '-1' before running the +environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. - The suffix 'gf' is supplied if not already present. This suffix is -not an extension; no '.' precedes it: for instance, 'cmr10.600gf'. + The suffix ‘gf’ is supplied if not already present. This suffix is +not an extension; no ‘.’ precedes it: for instance, ‘cmr10.600gf’. If PKFILE is not specified, the output is written to the basename of -'GFNAME.DPIpk', e.g., 'gftopk /wherever/cmr10.600gf' creates -'./cmr10.600pk'. +‘GFNAME.DPIpk’, e.g., ‘gftopk /wherever/cmr10.600gf’ creates +‘./cmr10.600pk’. - The only options are '--verbose', '--help', and '--version' (*note + The only options are ‘--verbose’, ‘--help’, and ‘--version’ (*note Common options::). @@ -2914,17 +2959,17 @@ programs do not support PK format. Synopsis: The font PKNAME is searched for in the usual places (*note (kpathsea)Glyph lookup::). To see all the relevant paths, set the -environment variable 'KPATHSEA_DEBUG' to '-1' before running the +environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. - The suffix 'pk' is supplied if not already present. This suffix is -not an extension; no '.' precedes it: for instance, 'cmr10.600pk'. + The suffix ‘pk’ is supplied if not already present. This suffix is +not an extension; no ‘.’ precedes it: for instance, ‘cmr10.600pk’. If GFFILE is not specified, the output is written to the basename of -'PKNAME.DPIgf', e.g., 'pktogf /wherever/cmr10.600pk' creates -'./cmr10.600gf'. +‘PKNAME.DPIgf’, e.g., ‘pktogf /wherever/cmr10.600pk’ creates +‘./cmr10.600gf’. - The only options are '--verbose', '--help', and '--version' (*note + The only options are ‘--verbose’, ‘--help’, and ‘--version’ (*note Common options::). @@ -2935,26 +2980,26 @@ File: web2c.info, Node: pktype invocation, Next: gftype invocation, Prev: pkt PKtype translates a packed font (PK) bitmap file (as output by GFtoPK, for example) to a plain text file that humans can read. It also serves -as a PK-validating program, i.e., if PKtype can read a file, it's +as a PK-validating program, i.e., if PKtype can read a file, it’s correct. Synopsis: pktype PKNAME.DPI[pk] The font PKNAME is searched for in the usual places (*note (kpathsea)Glyph lookup::). To see all the relevant paths, set the -environment variable 'KPATHSEA_DEBUG' to '-1' before running the +environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. - The suffix 'pk' is supplied if not already present. This suffix is -not an extension; no '.' precedes it: for instance, 'cmr10.600pk'. + The suffix ‘pk’ is supplied if not already present. This suffix is +not an extension; no ‘.’ precedes it: for instance, ‘cmr10.600pk’. The translation is written to standard output. - The only options are '-help' and '-version' (*note Common options::). + The only options are ‘-help’ and ‘-version’ (*note Common options::). As an example of the output, here is the (abridged) translation of -the letter 'K' in 'cmr10', as rendered at 600dpi with the mode 'ljfour' -from <modes.mf> (available from 'ftp://ftp.tug.org/tex/modes.mf'). +the letter ‘K’ in ‘cmr10’, as rendered at 600dpi with the mode ‘ljfour’ +from <modes.mf> (available from ‘ftp://ftp.tug.org/tex/modes.mf’). 955: Flag byte = 184 Character = 75 Packet length = 174 Dynamic packing variable = 11 @@ -2966,43 +3011,43 @@ from <modes.mf> (available from 'ftp://ftp.tug.org/tex/modes.mf'). Explanation: -'955' +‘955’ The byte position in the file where this character starts. -'Flag byte' -'Dynamic packing variable' +‘Flag byte’ +‘Dynamic packing variable’ Related to the packing for this character; see the source code. -'Character' +‘Character’ The character code, in decimal. -'Packet length' +‘Packet length’ The total length of this character definition, in bytes. -'TFM width' +‘TFM width’ The device-independent (TFM) width of this character. It is 2^24 - times the ratio of the true width to the font's design size. + times the ratio of the true width to the font’s design size. -'dx' - The device-dependent width, in "scaled pixels", i.e., units of +‘dx’ + The device-dependent width, in “scaled pixels”, i.e., units of horizontal pixels times 2^16. -'Height' -'Width' +‘Height’ +‘Width’ The bitmap height and width, in pixels. -'X-offset' -'Y-offset' +‘X-offset’ +‘Y-offset’ Horizontal and vertical offset from the upper left pixel to the reference (origin) pixel for this character, in pixels (right and - down are positive). The "reference pixel" is the pixel that + down are positive). The “reference pixel” is the pixel that occupies the unit square in Metafont; the Metafont reference point is the lower left hand corner of this pixel. Put another way, the x-offset is the negative of the left side bearing; the right side bearing is the horizontal escapement minus the bitmap width plus the x-offset. -'[2]23(16)...' +‘[2]23(16)...’ Finally, run lengths of black pixels alternate with parenthesized run lengths of white pixels, and brackets indicate a repeated row. @@ -3015,32 +3060,32 @@ File: web2c.info, Node: gftype invocation, Next: tftopl invocation, Prev: pkt GFtype translates a generic font (GF) bitmap file (as output by Metafont, for example) to a plain text file that humans can read. It also serves as a GF-validating program, i.e., if GFtype can read a file, -it's correct. Synopsis: +it’s correct. Synopsis: gftype [OPTION]... GFNAME.DPI[gf] The font GFNAME is searched for in the usual places (*note (kpathsea)Glyph lookup::). To see all the relevant paths, set the -environment variable 'KPATHSEA_DEBUG' to '-1' before running the +environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the program. - The suffix 'gf' is supplied if not already present. This suffix is -not an extension; no '.' precedes it: for instance, 'cmr10.600gf'. + The suffix ‘gf’ is supplied if not already present. This suffix is +not an extension; no ‘.’ precedes it: for instance, ‘cmr10.600gf’. The translation is written to standard output. The program accepts the following options, as well as the standard -'-help' and '-version' (*note Common options::): -'-images' - Show the characters' bitmaps using asterisks and spaces. +‘-help’ and ‘-version’ (*note Common options::): +‘-images’ + Show the characters’ bitmaps using asterisks and spaces. -'-mnemonics' +‘-mnemonics’ Translate all commands in the GF file. As an example of the output, here is the (abridged) translation of -the letter 'K' in 'cmr10', as rendered at 600dpi with the mode 'ljfour' -from 'modes.mf' (available from <ftp://ftp.tug.org/tex/modes.mf>), with -both '-mnemonics' and '-images' enabled. +the letter ‘K’ in ‘cmr10’, as rendered at 600dpi with the mode ‘ljfour’ +from ‘modes.mf’ (available from <ftp://ftp.tug.org/tex/modes.mf>), with +both ‘-mnemonics’ and ‘-images’ enabled. GFtype outputs the information about a character in two places: a main definition and a one-line summary at the end. We show both. Here @@ -3079,30 +3124,30 @@ is the main definition: Explanation: -'2033' -'2043' -'...' +‘2033’ +‘2043’ +‘...’ The byte position in the file where each GF command starts. -'beginning of char 75' +‘beginning of char 75’ The character code, in decimal. -'3<=m<=60 0<=n<=56' - The character's bitmap lies between 3 and 60 (inclusive) +‘3<=m<=60 0<=n<=56’ + The character’s bitmap lies between 3 and 60 (inclusive) horizontally, and between 0 and 56 (inclusive) vertically. (m is a column position and n is a row position.) Thus, 3 is the left side bearing. The right side bearing is the horizontal escapement (given below) minus the maximum m. -'(initially n=56) paint (0)24(12)20' +‘(initially n=56) paint (0)24(12)20’ The first row of pixels: 0 white pixels, 24 black pixels, 12 white pixels, etc. -'newrow 0 (n=55) paint 24(12)20' +‘newrow 0 (n=55) paint 24(12)20’ The second row of pixels, with zero leading white pixels on the row. -'eoc' +‘eoc’ The end of the main character definition. Here is the GF postamble information that GFtype outputs at the end: @@ -3111,18 +3156,18 @@ Explanation: Explanation: -'dx' - The device-dependent width, in "scaled pixels", i.e., units of - horizontal pixels times 2^16. The '(65)' is simply the same number +‘dx’ + The device-dependent width, in “scaled pixels”, i.e., units of + horizontal pixels times 2^16. The ‘(65)’ is simply the same number rounded. If the vertical escapement is nonzero, it would appear - here as a 'dy' value. + here as a ‘dy’ value. -'width' +‘width’ The device-independent (TFM) width of this character. It is 2^24 - times the ratio of the true width to the font's design size. The - '64.57289' is the same number converted to pixels. + times the ratio of the true width to the font’s design size. The + ‘64.57289’ is the same number converted to pixels. -'loc' +‘loc’ The byte position in the file where this character starts. @@ -3132,44 +3177,44 @@ File: web2c.info, Node: tftopl invocation, Next: pltotf invocation, Prev: gft ======================================================== TFtoPL translates a TeX font metric (TFM, *note (dvips)Metric files::) -file (as output by Metafont, for example) to "property list format" (a +file (as output by Metafont, for example) to “property list format” (a list of parenthesized items describing the font) that humans can edit or read. This program is mostly used by people debugging TeX implementations, writing font utilities, etc. Synopsis: tftopl [OPTION]... TFMNAME[.tfm] [PLFILE[.pl]] - The font TFMNAME (extended with '.tfm' if necessary) is searched for + The font TFMNAME (extended with ‘.tfm’ if necessary) is searched for in the usual places (*note (kpathsea)Supported file formats::). To see -all the relevant paths, set the environment variable 'KPATHSEA_DEBUG' to -'-1' before running the program. +all the relevant paths, set the environment variable ‘KPATHSEA_DEBUG’ to +‘-1’ before running the program. - If PLFILE (which is extended with '.pl' if necessary) is not + If PLFILE (which is extended with ‘.pl’ if necessary) is not specified, the property list file is written to standard output. The property list file can be converted back to TFM format by the companion program TFtoPL (see the next section). The program accepts the following option, as well as the standard -'-verbose', '-help' and '-version' (*note Common options::): -'-charcode-format=TYPE' +‘-verbose’, ‘-help’ and ‘-version’ (*note Common options::): +‘-charcode-format=TYPE’ Output character codes in the PL file according to TYPE: either - 'octal' or 'ascii'. Default is 'ascii' for letters and digits, - octal for all other characters. Exception: if the font's coding - scheme starts with 'TeX math sy' or 'TeX math ex', all character + ‘octal’ or ‘ascii’. Default is ‘ascii’ for letters and digits, + octal for all other characters. Exception: if the font’s coding + scheme starts with ‘TeX math sy’ or ‘TeX math ex’, all character codes are output in octal. - In 'ascii' format, character codes that correspond to graphic + In ‘ascii’ format, character codes that correspond to graphic characters, except for left and right parentheses, are output as a - 'C' followed by the single character: 'C K', for example. In octal - format, character codes are output as the letter 'O' followed by - octal digits, as in 'O 113' for 'K'. + ‘C’ followed by the single character: ‘C K’, for example. In octal + format, character codes are output as the letter ‘O’ followed by + octal digits, as in ‘O 113’ for ‘K’. - 'octal' format is useful for symbol and other non-alphabetic fonts, + ‘octal’ format is useful for symbol and other non-alphabetic fonts, where using ASCII characters for the character codes is merely confusing. As an example of the output, here is the (abridged) property list -translation of 'cmr10.tfm': +translation of ‘cmr10.tfm’: (FAMILY CMR) (FACE O 352) @@ -3218,28 +3263,28 @@ translation of 'cmr10.tfm': ... As you can see, the general format is a list of parenthesized -"properties", nested where necessary. +“properties”, nested where necessary. - * The first few items ('FAMILY', 'FACE', and so on) are the so-called - "headerbyte" information from Metafont, giving general information + • The first few items (‘FAMILY’, ‘FACE’, and so on) are the so-called + “headerbyte” information from Metafont, giving general information about the font. - * The 'FONTDIMEN' property defines the TeX '\fontdimen' values. + • The ‘FONTDIMEN’ property defines the TeX ‘\fontdimen’ values. - * The 'LIGTABLE' property defines the ligature and kerning table. - 'LIG' properties define ligatures: in the example above, an 'f' (in - the 'LABEL') followed by an 'i' is a ligature, i.e., a typesetting + • The ‘LIGTABLE’ property defines the ligature and kerning table. + ‘LIG’ properties define ligatures: in the example above, an ‘f’ (in + the ‘LABEL’) followed by an ‘i’ is a ligature, i.e., a typesetting program like TeX replaces those two consecutive characters by the - character at position octal '014 in the current font--presumably - the 'fi' ligature. 'KRN' properties define kerns: if an 'f' is - followed by character octal '047 (an apostrophe), TeX inserts a + character at position octal ’014 in the current font—presumably the + ‘fi’ ligature. ‘KRN’ properties define kerns: if an ‘f’ is + followed by character octal ’047 (an apostrophe), TeX inserts a small amount of space between them: 0.077779 times the design size - the font was loaded at (about three-quarters of a printer's point + the font was loaded at (about three-quarters of a printer’s point by default in this case, or .001 inches). - * The 'CHARACTER' property defines the dimensions of a character: its + • The ‘CHARACTER’ property defines the dimensions of a character: its width, height, depth, and italic correction, also in design-size - units, as explained in the previous item. For our example 'f', the + units, as explained in the previous item. For our example ‘f’, the depth is zero, so that property is omitted. TFtoPL also inserts any kerns and ligatures for this character as a comment. @@ -3251,18 +3296,18 @@ File: web2c.info, Node: pltotf invocation, Next: vftovp invocation, Prev: tft PLtoTF translates a property list file (as output by TFtoPL, for example) to TeX font metric (TFM, *note (dvips)Metric files::) format. -It's much easier for both programs and humans to create the (plain text) +It’s much easier for both programs and humans to create the (plain text) property list files and let PLtoTF take care of creating the binary TFM equivalent than to output TFM files directly. Synopsis: pltotf [OPTION]... PLFILE[.pl] [TFMFILE[.tfm]] - If TFMFILE (extended with '.tfm' if necessary) is not specified, the -TFM file is written to the basename of 'PLFILE.tfm', e.g., 'pltotf -/wherever/cmr10.pl' creates './cmr10.tfm'. (Since TFM files are binary, + If TFMFILE (extended with ‘.tfm’ if necessary) is not specified, the +TFM file is written to the basename of ‘PLFILE.tfm’, e.g., ‘pltotf +/wherever/cmr10.pl’ creates ‘./cmr10.tfm’. (Since TFM files are binary, writing to standard output by default is undesirable.) - The only options are '-verbose', '-help', and '-version' (*note + The only options are ‘-verbose’, ‘-help’, and ‘-version’ (*note Common options::). For an example of property list format, see the previous section. @@ -3276,40 +3321,40 @@ File: web2c.info, Node: vftovp invocation, Next: vptovf invocation, Prev: plt VFtoVP translates a virtual font metric (VF, *note (dvips)Virtual fonts::) file and its accompanying TeX font metric (TFM, *note (dvips)Metric files::) file (as output by VPtoVF, for example) to -"virtual property list format" (a list of parenthesized items describing +“virtual property list format” (a list of parenthesized items describing the virtual font) that humans can edit or read. This program is mostly used by people debugging virtual font utilities. Synopsis: vftovp [OPTION]... VFNAME[.vf] [TFMNAME[.tfm] [VPLFILE[.vpl]]] - The fonts VFNAME and TFMNAME (extended with '.vf' and '.tfm' if + The fonts VFNAME and TFMNAME (extended with ‘.vf’ and ‘.tfm’ if necessary) are searched for in the usual places (*note (kpathsea)Supported file formats::). To see all the relevant paths, set -the environment variable 'KPATHSEA_DEBUG' to '-1' before running the -program. If TFMNAME is not specified, VFNAME (without a trailing '.vf') +the environment variable ‘KPATHSEA_DEBUG’ to ‘-1’ before running the +program. If TFMNAME is not specified, VFNAME (without a trailing ‘.vf’) is used. - If VPLFILE (extended with '.vpl' if necessary) is not specified, the + If VPLFILE (extended with ‘.vpl’ if necessary) is not specified, the property list file is written to standard output. The property list file can be converted back to VF and TFM format by the companion program VFtoVP (see the next section). The program accepts the following option, as well as the standard -'-verbose', '-help' and '-version' (*note Common options::): -'-charcode-format=TYPE' +‘-verbose’, ‘-help’ and ‘-version’ (*note Common options::): +‘-charcode-format=TYPE’ Output character codes in the PL file according to TYPE: either - 'octal' or 'ascii'. Default is 'ascii' for letters and digits, - octal for all other characters. Exception: if the font's coding - scheme starts with 'TeX math sy' or 'TeX math ex', all character + ‘octal’ or ‘ascii’. Default is ‘ascii’ for letters and digits, + octal for all other characters. Exception: if the font’s coding + scheme starts with ‘TeX math sy’ or ‘TeX math ex’, all character codes are output in octal. - In 'ascii' format, character codes that correspond to graphic + In ‘ascii’ format, character codes that correspond to graphic characters, except for left and right parentheses, are output as a - 'C' followed by the single character: 'C K', for example. In octal - format, character codes are output as the letter 'O' followed by - octal digits, as in 'O 113' for 'K'. + ‘C’ followed by the single character: ‘C K’, for example. In octal + format, character codes are output as the letter ‘O’ followed by + octal digits, as in ‘O 113’ for ‘K’. - 'octal' format is useful for symbol and other non-alphabetic fonts, + ‘octal’ format is useful for symbol and other non-alphabetic fonts, where using ASCII characters for the character codes is merely confusing. @@ -3321,19 +3366,19 @@ File: web2c.info, Node: vptovf invocation, Next: Font utilities available else VPtoVF translates a virtual property list file (as output by VFtoVP, for example) to virtual font (VF, *note (dvips)Virtual fonts::) and TeX font -metric (TFM, *note (dvips)Metric files::) files. It's much easier for +metric (TFM, *note (dvips)Metric files::) files. It’s much easier for both programs and humans to create the (plain text) property list files and let VPtoVF take care of creating the binary VF and TFM equivalents than to output them directly. Synopsis: vptovf [OPTION]... VPLFILE[.vpl] [VFFILE[.vf] [TFMFILE[.tfm]]] - If VFFILE (extended with '.vf' if necessary) is not specified, the VF -output is written to the basename of 'VPLFILE.vf'; similarly for -TFMFILE. For example, 'vptovf /wherever/ptmr.vpl' creates './ptmr.vf' -and './ptmr.tfm'. + If VFFILE (extended with ‘.vf’ if necessary) is not specified, the VF +output is written to the basename of ‘VPLFILE.vf’; similarly for +TFMFILE. For example, ‘vptovf /wherever/ptmr.vpl’ creates ‘./ptmr.vf’ +and ‘./ptmr.tfm’. - The only options are '-verbose', '-help', and '-version' (*note + The only options are ‘-verbose’, ‘-help’, and ‘-version’ (*note Common options::). @@ -3344,48 +3389,48 @@ File: web2c.info, Node: Font utilities available elsewhere, Prev: vptovf invoc The Web2c complement of font utilities merely implements a few basic conversions. Many other more sophisticated font utilities exist; most -are in 'CTAN:/fonts/utilities' (for CTAN info, *note +are in ‘CTAN:/fonts/utilities’ (for CTAN info, *note (kpathsea)unixtex.ftp::). Here are some of the most commonly-requested items: - * AFM (Adobe font metric) to TFM conversion: *note (dvips)Invoking - afm2tfm::, and 'CTAN:/fonts/utilities/afmtopl'. + • AFM (Adobe font metric) to TFM conversion: *note (dvips)Invoking + afm2tfm::, and ‘CTAN:/fonts/utilities/afmtopl’. - * BDF (the X bitmap format) conversion: + • BDF (the X bitmap format) conversion: <ftp://ftp.tug.org/tex/bdf.tar.gz>. - * Creating fonts using MetaPost: MetaType1. + • Creating fonts using MetaPost: MetaType1. <ftp://bop.eps.gda.pl/pub/metatype1>. This is used to create the - excellent Latin Modern font family ('CTAN:/fonts/lm'), which + excellent Latin Modern font family (‘CTAN:/fonts/lm’), which extends Computer Modern to a vast repertoire of scripts. - * Editing of bitmap fonts: Xbfe from the GNU font utilities mentioned + • Editing of bitmap fonts: Xbfe from the GNU font utilities mentioned below; the X BDF-editing programs available from <ftp://ftp.x.org/R5contrib/xfed.tar.Z> and <ftp://ftp.x.org/R5contrib/xfedor.tar.Z>; and finally, if your - fonts have only 128 characters, you can use the old 'gftopxl', - 'pxtoch', and 'chtopx' programs from <ftp://ftp.tug.org/tex/web>. + fonts have only 128 characters, you can use the old ‘gftopxl’, + ‘pxtoch’, and ‘chtopx’ programs from <ftp://ftp.tug.org/tex/web>. - * Editing of outline fonts: FontForge, <fontforge.sourceforge.net>. + • Editing of outline fonts: FontForge, <fontforge.sourceforge.net>. This is a very elaborate program with support for many outline formats (Type 1, OpenType, TrueType, ...), and many advanced font editing features. - * PK bitmaps from PostScript outline fonts: gsftopk from the 'xdvi' - distribution. Alternatively, 'ps2pk', from - 'CTAN:/fonts/utilities/ps2pk'. + • PK bitmaps from PostScript outline fonts: gsftopk from the ‘xdvi’ + distribution. Alternatively, ‘ps2pk’, from + ‘CTAN:/fonts/utilities/ps2pk’. - * PostScript Type 1 font format conversion (i.e., between PFA and PFB + • PostScript Type 1 font format conversion (i.e., between PFA and PFB formats): <https://www.lcdf.org/type>. - * Tracing bitmaps to fitted outlines: Autotrace + • Tracing bitmaps to fitted outlines: Autotrace (<http://autotrace.sourceforge.net>), Potrace (<http://potrace.sourceforge.net>). For Metafont fonts, either of - the two programs 'mftrace' (<http://www.xs4all.nl/~hanwen/mftrace>) - or 'textrace' (<http://textrace.sourceforge.net>) make the job + the two programs ‘mftrace’ (<http://www.xs4all.nl/~hanwen/mftrace>) + or ‘textrace’ (<http://textrace.sourceforge.net>) make the job easier. - * Virtual font creation: <https://ctan.org/pkg/fontinst>. + • Virtual font creation: <https://ctan.org/pkg/fontinst>. File: web2c.info, Node: Legalisms, Next: References, Prev: Font utilities, Up: Top @@ -3400,15 +3445,15 @@ permissions for that file. Following is a summary. domain (<https://tug.org/texlive/copying.html>). The sources may be copied verbatim, or used as the starting point of new software under different names; however, per the wishes of the authors, they should be -modified only through a '.ch' file, but this is in the nature of a +modified only through a ‘.ch’ file, but this is in the nature of a development request rather than a legal requirement. MLTeX, pdfTeX, LuaTeX, XeTeX, and all the other derived engines have used various license terms for their additions to the base code, often the GPL (see <https://www.gnu.org/licenses/#GPL>) or (for example) the -file 'web2c/pdftexdir/COPYINGv2'. They also mostly make use of +file ‘web2c/pdftexdir/COPYINGv2’. They also mostly make use of additional libraries with their own (compatible) terms. Please see each -program's sources. +program’s sources. The Kpathsea library is covered by the GNU Lesser General Public License (*note (kpathsea)Introduction::). Therefore, the _binaries_ @@ -3416,7 +3461,7 @@ resulting from a standard Web2c compilation are also covered by the LGPL; so if you (re)distribute the binaries, you must also (offer to) distribute the complete source that went into those binaries. See <https://gnu.org/licenses/#LGPL> or the file -'kpathsea/COPYING.LESSERv2'. +‘kpathsea/COPYING.LESSERv2’. File: web2c.info, Node: References, Next: Index, Prev: Legalisms, Up: Top @@ -3438,30 +3483,30 @@ Appendix B References <ftp://ftp.math.utah.edu/pub/tex/bib/texbook1.bib>. 6. For a bibliography of formal articles and technical reports on the - TeX project, see the books 'TeX: The Program' or 'Metafont: The - Program' cited below. + TeX project, see the books ‘TeX: The Program’ or ‘Metafont: The + Program’ cited below. 7. [Bil87] Neenie Billawala. Write-white printing engines and tuning - fonts with Metafont. 'TUGboat', 8(1):29-32, April 1987. + fonts with Metafont. ‘TUGboat’, 8(1):29–32, April 1987. <https://tug.org/TUGboat/tb08-1/tb17billawala.pdf>. 8. [Hob89] John D. Hobby. A Metafont-like system with PS output. - 'TUGboat', 10(4):505-512, December 1989. + ‘TUGboat’, 10(4):505–512, December 1989. <https://tug.org/metapost>. - 9. [Hob92] John D. Hobby. A User's Manual for MetaPost. Technical + 9. [Hob92] John D. Hobby. A User’s Manual for MetaPost. Technical Report CSTR-162, AT&T Bell Laboratories, 1992. 10. [Hob93] John D. Hobby. Drawing Graphs with MetaPost. Technical Report CSTR-164, AT&T Bell Laboratories, 1993. - 11. [HS91] Samuel P. Harbison and Guy L. Steele Jr. 'C--A Reference - Manual'. Prentice-Hall, Upper Saddle River, NJ 07458, USA, third + 11. [HS91] Samuel P. Harbison and Guy L. Steele Jr. ‘C—A Reference + Manual’. Prentice-Hall, Upper Saddle River, NJ 07458, USA, third edition, 1991. An authoritative reference to the C programming language, and a good companion to Kernighan and Ritchie. - 12. [KL93] Donald E. Knuth and Silvio Levy. 'The CWEB System of - Structured Documentation, Version 3.0'. Addison-Wesley, Reading, + 12. [KL93] Donald E. Knuth and Silvio Levy. ‘The CWEB System of + Structured Documentation, Version 3.0’. Addison-Wesley, Reading, MA, USA, 1993. <https://ctan.org/pkg/cweb>. 13. [Knu84] Donald E. Knuth. A torture test for TeX. Report No. @@ -3472,39 +3517,39 @@ Appendix B References STAN-CS-86-1095, Stanford University, Department of Computer Science, 1986. - 15. [Knu86b] Donald E. Knuth. 'The TeXbook', volume A of 'Computers - and Typesetting'. Addison-Wesley, Reading, MA, USA, 1986. + 15. [Knu86b] Donald E. Knuth. ‘The TeXbook’, volume A of ‘Computers + and Typesetting’. Addison-Wesley, Reading, MA, USA, 1986. - 16. [Knu86c] Donald E. Knuth. 'TeX: The Program', volume B of - 'Computers and Typesetting'. Addison-Wesley, Reading, MA, USA, + 16. [Knu86c] Donald E. Knuth. ‘TeX: The Program’, volume B of + ‘Computers and Typesetting’. Addison-Wesley, Reading, MA, USA, 1986. - 17. [Knu86d] Donald E. Knuth. 'The METAFONTbook', volume C of - 'Computers and Typesetting'. Addison-Wesley, Reading, MA, USA, + 17. [Knu86d] Donald E. Knuth. ‘The METAFONTbook’, volume C of + ‘Computers and Typesetting’. Addison-Wesley, Reading, MA, USA, 1986. - 18. [Knu86e] Donald E. Knuth. 'METAFONT: The Program', volume D of - 'Computers and Typesetting'. Addison-Wesley, Reading, MA, USA, + 18. [Knu86e] Donald E. Knuth. ‘METAFONT: The Program’, volume D of + ‘Computers and Typesetting’. Addison-Wesley, Reading, MA, USA, 1986. - 19. [Knu86f] Donald E. Knuth. 'Computer Modern Typefaces', volume E - of 'Computers and Typesetting'. Addison-Wesley, Reading, MA, USA, + 19. [Knu86f] Donald E. Knuth. ‘Computer Modern Typefaces’, volume E + of ‘Computers and Typesetting’. Addison-Wesley, Reading, MA, USA, 1986. - 20. [Knu89] Donald E. Knuth. The errors of TeX. 'Software--Practice - and Experience', 19(7):607-681, July 1989. This is an updated + 20. [Knu89] Donald E. Knuth. The errors of TeX. ‘Software—Practice + and Experience’, 19(7):607–681, July 1989. This is an updated version of Knuth:1988:ET. 21. [Knu90] Donald Knuth. Virtual Fonts: More Fun for Grand Wizards. - 'TUGboat', 11(1):13-23, April 1990. + ‘TUGboat’, 11(1):13–23, April 1990. <https://tug.org/TUGboat/tb11-1/tb27knut.pdf>. - 22. [Knu92] Donald E. Knuth. 'Literate Programming'. CSLI Lecture + 22. [Knu92] Donald E. Knuth. ‘Literate Programming’. CSLI Lecture Notes Number 27. Stanford University Center for the Study of Language and Information, Stanford, CA, USA, 1992. - 23. [Lam94] Leslie Lamport. 'LaTeX: A Document Preparation System: - User's Guide and Reference Manual'. Addison-Wesley, Reading, MA, + 23. [Lam94] Leslie Lamport. ‘LaTeX: A Document Preparation System: + User’s Guide and Reference Manual’. Addison-Wesley, Reading, MA, USA, second edition, 1994. Reprinted with corrections, 1996. 24. [Lia83] Franklin Mark Liang. Word hy-phen-a-tion by com-put-er. @@ -3513,9 +3558,9 @@ Appendix B References 25. [Mac91] Pierre A. MacKay. Looking at the pixels: Quality control for 300 dpi laser printer fonts, especially Metafonts. In Robert - A. Morris and Jacques Andre, editors, 'Raster Imaging and Digital - Typography II--Papers from the second RIDT meeting, held in Boston, - Oct. 14-16, 1991', pages 205-215, New York, 1991. Cambridge + A. Morris and Jacques Andre, editors, ‘Raster Imaging and Digital + Typography II—Papers from the second RIDT meeting, held in Boston, + Oct. 14–16, 1991’, pages 205–215, New York, 1991. Cambridge University Press. @@ -3566,11 +3611,11 @@ Index (line 59) * --with-x: Online Metafont graphics. (line 57) -* -8bit: Common options. (line 110) +* -8bit: Common options. (line 112) * -base=BASE: Determining the memory dump to use. (line 15) * -base=DUMPNAME: Common options. (line 39) -* -change=CHFILE: mft invocation. (line 63) +* -change=CHFILE: mft invocation. (line 62) * -charcode-format=TYPE: tftopl invocation. (line 27) * -charcode-format=TYPE <1>: vftovp invocation. (line 30) * -cnf-line: Common options. (line 25) @@ -3613,30 +3658,30 @@ Index * -no-file-line-error: Common options. (line 31) * -no-mktex=FILETYPE: tex invocation. (line 103) * -no-mktex=FILETYPE <1>: mf invocation. (line 87) -* -no-parse-first-line: Common options. (line 77) +* -no-parse-first-line: Common options. (line 79) * -no-shell-escape: tex invocation. (line 121) * -output-comment=STRING: tex invocation. (line 113) * -output-directory: Common options. (line 71) * -output-directory <1>: Output file location. - (line 15) + (line 24) * -output-level=N: dvitype invocation. (line 36) * -overflow-label-offset=POINTS: gftodvi invocation. (line 59) * -page-start=PAGE-SPEC: dvicopy invocation. (line 28) * -page-start=PAGE-SPEC <1>: dvitype invocation. (line 46) -* -parse-first-line: Common options. (line 76) -* -progname=STRING: Common options. (line 82) +* -parse-first-line: Common options. (line 78) +* -progname=STRING: Common options. (line 84) * -progname=STRING <1>: Determining the memory dump to use. (line 17) -* -recorder: Common options. (line 89) +* -recorder: Common options. (line 91) * -shell-escape: tex invocation. (line 120) * -shell-restricted: tex invocation. (line 122) * -show-opcodes: dvitype invocation. (line 52) * -strict: tangle invocation. (line 46) -* -style=MFTFILE: mft invocation. (line 67) +* -style=MFTFILE: mft invocation. (line 66) * -T: mpost invocation. (line 111) * -terse: bibtex invocation. (line 28) * -tex=TEXPROGRAM: mpost invocation. (line 114) -* -translate-file=TCXFILE: Common options. (line 103) +* -translate-file=TCXFILE: Common options. (line 105) * -troff: mpost invocation. (line 111) * -underline: tangle invocation. (line 41) * -uppercase: tangle invocation. (line 35) @@ -3655,7 +3700,7 @@ Index * .mps files and PDF: mpost invocation. (line 82) * .NNN PostScript figures: mpost invocation. (line 31) * .NNNgf generic fonts: mf invocation. (line 34) -* .tcx character translation files: Common options. (line 103) +* .tcx character translation files: Common options. (line 105) * .tcx character translation files <1>: TCX files. (line 6) * .tex: tex invocation. (line 20) * .tfm output: mf invocation. (line 43) @@ -3669,8 +3714,8 @@ Index (line 6) * 64-bit architecture: Hardware and memory dumps. (line 6) -* 8 bit clean: Common options. (line 110) -* 8 bit clean output, specifying: Common options. (line 110) +* 8 bit clean: Common options. (line 112) +* 8 bit clean output, specifying: Common options. (line 112) * 8-bit characters: TCX files. (line 6) * \bibliography: bibtex invocation. (line 18) * \bibliographystyle: bibtex invocation. (line 18) @@ -3700,6 +3745,8 @@ Index * \tracingcharsubdef and MLTeX: \tracingcharsubdef. (line 6) * \tracinglostchars and MLTeX: \tracingcharsubdef. (line 11) * \write18 shell escape extension: Shell escapes. (line 6) +* \write18, output location for: Output file location. + (line 31) * ^^ notation, avoiding: TCX files. (line 87) * ~ expansion in filenames: \input filename caveats. (line 17) @@ -3763,7 +3810,7 @@ Index (line 6) * BigEndian machines: Hardware and memory dumps. (line 6) -* binaries, linking: Common options. (line 82) +* binaries, linking: Common options. (line 84) * blank lines, in TCX files: TCX files. (line 66) * boxes, memory for: Runtime options. (line 20) * braced filename for \input: \input braced filename. @@ -3782,7 +3829,7 @@ Index * c-sources Makefile target: Additional targets. (line 12) * caveats for \input filenames: \input filename caveats. (line 6) -* change files, and MFT: mft invocation. (line 63) +* change files, and MFT: mft invocation. (line 62) * change files, and Tangle: tangle invocation. (line 11) * change files, and Weave: weave invocation. (line 14) * changing error messages style: Common options. (line 31) @@ -3802,7 +3849,7 @@ Index (line 69) * cm.base: Initial Metafont. (line 26) * cmbase.mf: Initial Metafont. (line 26) -* cmbase.mft: mft invocation. (line 73) +* cmbase.mft: mft invocation. (line 72) * cmmf.base not recommended: Initial Metafont. (line 26) * color, in DVItoMP: dvitomp invocation. (line 15) * comments, in TCX files: TCX files. (line 70) @@ -3815,7 +3862,7 @@ Index (line 6) * Computer Modern fonts, and Troff: mpost invocation. (line 61) * Computer Modern macros: Initial Metafont. (line 26) -* Computer Modern Typefaces, production of: mft invocation. (line 73) +* Computer Modern Typefaces, production of: mft invocation. (line 72) * configuration: Installation. (line 6) * configuration file reading: Path searching. (line 6) * configuration file values: Runtime options. (line 6) @@ -3888,7 +3935,7 @@ Index * e response at error prompt: Editor invocation. (line 6) * e-circumflex: \charsubdef. (line 20) * e-TeX: TeX extensions. (line 20) -* e.mft: mft invocation. (line 73) +* e.mft: mft invocation. (line 72) * EC fonts: tex invocation. (line 41) * EC fonts <1>: mf invocation. (line 24) * editing of bitmap fonts: Font utilities available elsewhere. @@ -3925,10 +3972,10 @@ Index * FAMILY property <1>: tftopl invocation. (line 99) * Ferguson, Michael: MLTeX. (line 6) * file formats for fonts: Font file formats. (line 6) -* file recorder: Common options. (line 89) +* file recorder: Common options. (line 91) * filename conventions, in input files: \input filenames. (line 6) * filenames starting with -: Option conventions. (line 19) -* first line of the main input file: Common options. (line 103) +* first line of the main input file: Common options. (line 105) * fixed-point arithmetic: Compile-time options. (line 21) * FIXPT: Compile-time options. @@ -4040,6 +4087,8 @@ Index * initial TeX: Initial TeX. (line 6) * initializations, lengthy: Initial and virgin. (line 19) * input filenames: \input filenames. (line 6) +* input from the output directory: Output file location. + (line 15) * install-bases Make target: Additional targets. (line 28) * install-fmts Make target: Additional targets. (line 24) * install-formats Make target: Additional targets. (line 17) @@ -4076,7 +4125,7 @@ Index * LIG property: tftopl invocation. (line 101) * ligature table, in TFM files: tftopl invocation. (line 101) * LIGTABLE property: tftopl invocation. (line 101) -* linking binaries: Common options. (line 82) +* linking binaries: Common options. (line 84) * links to binaries: Determining the memory dump to use. (line 30) * literate programming: WEB. (line 6) @@ -4140,7 +4189,7 @@ Index (line 15) * MetaPost input files: mpost invocation. (line 26) * MetaPost invocation: mpost invocation. (line 6) -* MetaPost source, prettyprinting: mft invocation. (line 79) +* MetaPost source, prettyprinting: mft invocation. (line 77) * MetaPost, initial: Initial MetaPost. (line 6) * MetaPost, TeX, and Metafont: Three programs. (line 6) * metatype1: Font utilities available elsewhere. @@ -4208,7 +4257,7 @@ Index * origin: pktype invocation. (line 66) * output directory, specifying: Common options. (line 71) * output directory, specifying <1>: Output file location. - (line 15) + (line 24) * output file location: Output file location. (line 6) * output files, written by TeX programs: tex invocation. (line 48) @@ -4218,7 +4267,7 @@ Index * packet length: pktype invocation. (line 50) * page, starting: dvicopy invocation. (line 28) * page, starting <1>: dvitype invocation. (line 46) -* parsing the first line: Common options. (line 77) +* parsing the first line: Common options. (line 79) * Pascal, creating from WEB: tangle invocation. (line 6) * patgen: patgen invocation. (line 6) * path searching: Path searching. (line 6) @@ -4257,7 +4306,7 @@ Index * plain.bst: Basic BibTeX style files. (line 11) * plain.fmt: Initial TeX. (line 13) -* plain.mft: mft invocation. (line 67) +* plain.mft: mft invocation. (line 66) * pltotf: pltotf invocation. (line 6) * pool file, writing: tangle invocation. (line 16) * Poole, Simon: Online Metafont graphics. @@ -4284,7 +4333,7 @@ Index * program name, determines memory dump: Determining the memory dump to use. (line 30) * program names, special: Common options. (line 50) -* program names, special <1>: Common options. (line 82) +* program names, special <1>: Common options. (line 84) * program names, special <2>: tex invocation. (line 108) * prologues: mpost invocation. (line 111) * prologues, and EPSF output: mpost invocation. (line 76) @@ -4303,11 +4352,13 @@ Index * quoted filename for \input: \input quoted filename. (line 6) * Raichle, Bernd: MLTeX. (line 6) -* reading, additional: Introduction. (line 72) -* readonly directory, running TeX in: Output file location. +* reading from the output directory: Output file location. (line 15) +* reading, additional: Introduction. (line 71) +* readonly directory, running TeX in: Output file location. + (line 53) * readonly directory, running TeX in <1>: Output file location. - (line 19) + (line 53) * reallocation of arrays: Runtime options. (line 45) * recursive expansion limit: Runtime options. (line 25) * redefined character substitutions: \tracingcharsubdef. (line 6) @@ -4366,7 +4417,7 @@ Index * string pool, writing: tangle invocation. (line 16) * string representation: pooltype invocation. (line 30) * style design, for BibTeX: bibtex invocation. (line 49) -* style files: mft invocation. (line 67) +* style files: mft invocation. (line 66) * substitutions of font glyphs: MLTeX. (line 6) * sun: Online Metafont graphics. (line 42) @@ -4425,11 +4476,11 @@ Index * texmf.cnf for shell escapes: Shell escapes. (line 6) * texmfmp.c: Online Metafont graphics. (line 79) -* TEXMFOUTPUT, used for reading: Output file location. - (line 25) * TEXMFOUTPUT, used if . unwritable: Output file location. - (line 19) + (line 53) * texmf_casefold_search: Runtime options. (line 42) +* TEXMF_OUTPUT_DIRECTORY: Output file location. + (line 31) * texput: tex invocation. (line 33) * TFM files, converting property lists to: pltotf invocation. (line 6) * TFM files, explained: Font file formats. (line 12) @@ -4449,7 +4500,7 @@ Index * toolkits, X: Online Metafont graphics. (line 59) * torture tests: Triptrap. (line 6) -* translation file for TeX, specifying: Common options. (line 103) +* translation file for TeX, specifying: Common options. (line 105) * translation from WEB to C: Introduction. (line 18) * trap Make target: Additional targets. (line 41) * trap test: Triptrap. (line 6) @@ -4552,78 +4603,83 @@ Index Tag Table: -Node: Top2759 -Node: Introduction3834 -Node: Installation7593 -Node: configure options9637 -Node: Compile-time options11659 -Node: Additional targets12761 -Node: Triptrap14038 -Node: Commonalities15541 -Node: Option conventions16198 -Node: Common options17421 -Node: Path searching22039 -Node: Output file location23011 -Node: Three programs24313 -Node: Runtime options25020 -Node: Initial and virgin28161 -Node: Memory dumps29110 -Node: Creating memory dumps29562 -Node: Determining the memory dump to use30769 -Node: Hardware and memory dumps32346 -Node: Editor invocation35096 -Node: \input filenames35959 -Node: \input quoted filename37510 -Node: \input braced filename38287 -Node: \input filename caveats39217 -Node: TeX40731 -Node: tex invocation41899 -Node: Initial TeX48885 -Node: Formats50249 -Node: Languages and hyphenation53066 -Node: MLTeX53496 -Node: \charsubdef55124 -Node: \tracingcharsubdef57447 -Node: TCX files58022 -Node: patgen invocation63462 -Node: Shell escapes64169 -Node: IPC and TeX67749 -Node: TeX extensions68319 -Node: Metafont71100 -Node: mf invocation72388 -Node: Initial Metafont76225 -Node: Modes77855 -Node: Online Metafont graphics80105 -Node: gftodvi invocation83530 -Node: mft invocation86350 -Node: MetaPost90348 -Node: mpost invocation91184 -Node: Initial MetaPost96220 -Node: dvitomp invocation97142 -Node: BibTeX97807 -Node: bibtex invocation98168 -Node: Basic BibTeX style files100642 -Node: WEB101972 -Node: tangle invocation103181 -Node: weave invocation105305 -Node: pooltype invocation106712 -Node: DVI utilities107842 -Node: dvicopy invocation108776 -Node: dvitype invocation110061 -Node: dvitype output example112392 -Node: Font utilities115445 -Node: Font file formats116625 -Node: gftopk invocation119892 -Node: pktogf invocation121083 -Node: pktype invocation122249 -Node: gftype invocation125072 -Node: tftopl invocation129575 -Node: pltotf invocation134168 -Node: vftovp invocation135219 -Node: vptovf invocation137454 -Node: Font utilities available elsewhere138481 -Node: Legalisms140686 -Node: References142133 -Node: Index146266 +Node: Top2764 +Node: Introduction3838 +Node: Installation7621 +Node: configure options9713 +Node: Compile-time options11871 +Node: Additional targets13009 +Node: Triptrap14382 +Node: Commonalities15963 +Node: Option conventions16636 +Node: Common options17919 +Node: Path searching22833 +Node: Output file location23829 +Node: Three programs27052 +Node: Runtime options27767 +Node: Initial and virgin30962 +Node: Memory dumps31943 +Node: Creating memory dumps32399 +Node: Determining the memory dump to use33618 +Node: Hardware and memory dumps35263 +Node: Editor invocation38079 +Node: \input filenames38990 +Node: \input quoted filename40601 +Node: \input braced filename41394 +Node: \input filename caveats42344 +Node: TeX43910 +Node: tex invocation45086 +Node: Initial TeX52432 +Node: Formats53852 +Node: Languages and hyphenation56729 +Node: MLTeX57159 +Node: \charsubdef58815 +Node: \tracingcharsubdef61220 +Node: TCX files61819 +Node: patgen invocation67370 +Node: Shell escapes68093 +Node: IPC and TeX71989 +Node: TeX extensions72575 +Node: Metafont75366 +Node: mf invocation76658 +Node: Initial Metafont80644 +Node: Modes82342 +Node: Online Metafont graphics84664 +Node: gftodvi invocation88269 +Node: mft invocation91221 +Node: MetaPost95367 +Node: mpost invocation96209 +Node: Initial MetaPost101455 +Node: dvitomp invocation102406 +Node: BibTeX103103 +Node: bibtex invocation103464 +Node: Basic BibTeX style files106070 +Node: WEB107470 +Node: tangle invocation108703 +Node: weave invocation110903 +Node: pooltype invocation112358 +Node: DVI utilities113508 +Node: dvicopy invocation114454 +Node: dvitype invocation115787 +Node: dvitype output example118202 +Node: Font utilities121327 +Node: Font file formats122521 +Node: gftopk invocation125856 +Node: pktogf invocation127091 +Node: pktype invocation128301 +Node: gftype invocation131228 +Node: tftopl invocation135859 +Node: pltotf invocation140621 +Node: vftovp invocation141702 +Node: vptovf invocation144031 +Node: Font utilities available elsewhere145092 +Node: Legalisms147359 +Node: References148820 +Node: Index153056 End Tag Table + + +Local Variables: +coding: utf-8 +End: |