texlive[68508] Build/source/texk: support new envvar
commits+karl at tug.org
commits+karl at tug.org
Wed Oct 11 00:01:41 CEST 2023
Revision: 68508
https://tug.org/svn/texlive?view=revision&revision=68508
Author: karl
Date: 2023-10-11 00:01:41 +0200 (Wed, 11 Oct 2023)
Log Message:
-----------
support new envvar TEXMF_OUTPUT_DIRECTORY
Modified Paths:
--------------
trunk/Build/source/texk/kpathsea/ChangeLog
trunk/Build/source/texk/kpathsea/doc/kpathsea.info
trunk/Build/source/texk/kpathsea/doc/kpathsea.texi
trunk/Build/source/texk/kpathsea/tex-file.c
trunk/Build/source/texk/kpathsea/tex-make.c
trunk/Build/source/texk/kpathsea/texmf.cnf
trunk/Build/source/texk/web2c/ChangeLog
trunk/Build/source/texk/web2c/Makefile.in
trunk/Build/source/texk/web2c/NEWS
trunk/Build/source/texk/web2c/am/texmf.am
trunk/Build/source/texk/web2c/bibtex.ch
trunk/Build/source/texk/web2c/doc/web2c.info
trunk/Build/source/texk/web2c/doc/web2c.texi
trunk/Build/source/texk/web2c/lib/texmfmp.c
trunk/Build/source/texk/web2c/tests/tex-closeout.test
Added Paths:
-----------
trunk/Build/source/texk/web2c/tests/outputdir.test
Modified: trunk/Build/source/texk/kpathsea/ChangeLog
===================================================================
--- trunk/Build/source/texk/kpathsea/ChangeLog 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/ChangeLog 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,3 +1,19 @@
+2023-10-09 Karl Berry <karl at freefriends.org>
+
+ * tex-file.c (kpathsea_name_ok): also allow files under
+ the TEXMF_OUTPUT_DIRECTORY envvar.
+ * tex-make.c (misstex): first try writing missfont.log in
+ TEXMF_OUTPUT_DIRECTORY, if it's set. Update unit test.
+ * doc/kpathsea.texi (mktex script names): mention
+ TEXMF_OUTPUT_DIRECTORY as new first location for missfont.log.
+ (Calling sequence) <kpathsea_out_name_ok>: also mention
+ TEXMF_OUTPUT_DIRECTORY, and kpsewhich's --safe-{in,out}-name options.
+ * texmf.cnf: mention that TEXMF_OUTPUT_DIRECTORY must be set in
+ the environment, and emphasize caveats.
+
+ * doc/kpathsea.texi (Specially-recognized files): reword
+ to avoid underfull line.
+
2023-08-11 TANAKA Takuji <ttk at t-lab.opal.ne.jp>
* tests/{cnfline,cnfnewline,cnfnull,cnfprog,kpsestat,kpsewhich}.test:
Modified: trunk/Build/source/texk/kpathsea/doc/kpathsea.info
===================================================================
--- trunk/Build/source/texk/kpathsea/doc/kpathsea.info 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/doc/kpathsea.info 2023-10-10 22:01:41 UTC (rev 68508)
@@ -37,7 +37,7 @@
****************
This manual documents the Kpathsea library for path searching. It
-corresponds to version 6.3.5, released in February 2023.
+corresponds to version 6.3.5, released in October 2023.
* Menu:
@@ -62,7 +62,7 @@
**************
This manual corresponds to version 6.3.5 of the Kpathsea library,
-released in February 2023.
+released in October 2023.
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
@@ -1235,9 +1235,10 @@
'-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.
+ 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',
@@ -1473,9 +1474,9 @@
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
@@ -2289,18 +2290,21 @@
('.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.
+'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
@@ -2482,31 +2486,49 @@
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.
+ 9. TeX can write output files, via the '\openout' primitive. This
+ opens a security vulnerability: an unwitting user could run a TeX
+ document that overwrites, say, '~/.profile'. Analogous
+ vulnerabilities exist for almost any program that can write files,
+ but since users expect TeX to typeset documents, not overwrite
+ personal files, it's desirable to handle this. To alleviate it,
+ there is a configuration variable 'openout_any', which selects one
+ of three levels of security:
+ * 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. 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. Second, any attempt to go up a
+ directory level is forbidden; that is, paths may not contain a
+ '..' component.
+
+ * For backwards compatibility, 'y' and '1' are synonyms of 'a',
+ while 'n' and '0' are synonyms for 'r'.
+
+ 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::.
+
+ 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
+ options '--safe-in-name' and '--safe-out-name' to provide a command
+ line interface for the checking.
+
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).
+ the configuration variable 'openin_any' (with 'a' as default; too
+ many system directories are involved to make 'p' feasible).
- 11. To close the kpathsea library instance you are using, call
+ 11. 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.
@@ -3054,30 +3076,30 @@
* --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)
+ (line 181)
* --safe-in-name=NAME: Auxiliary tasks. (line 48)
* --safe-out-name=NAME: Auxiliary tasks. (line 48)
* --show-path=NAME: Auxiliary tasks. (line 54)
* --subdir=STRING: Path searching options.
- (line 185)
+ (line 186)
* --var-brace-value=VARIABLE: Auxiliary tasks. (line 60)
* --var-value=VARIABLE: Auxiliary tasks. (line 74)
* --version: Standard options. (line 11)
@@ -3255,7 +3277,7 @@
* 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 135)
* automounter, and ls-R: ls-R. (line 46)
* auxiliary tasks: Auxiliary tasks. (line 6)
* Bach, Johann Sebastian: Default expansion. (line 41)
@@ -3279,7 +3301,7 @@
* 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 135)
* c-auto.h: Programming overview.
(line 35)
* cache of fonts, local: Security. (line 22)
@@ -3482,7 +3504,7 @@
* group-writable directories: Security. (line 40)
* 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 128)
* hash_summary_only variable for debugging: Debugging. (line 105)
* history of Kpathsea: History. (line 6)
* Hoekwater, Taco: History. (line 78)
@@ -3492,9 +3514,9 @@
* 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 128)
* interactive query: Path searching options.
- (line 151)
+ (line 152)
* interface, not frozen: Introduction. (line 29)
* introduction: Introduction. (line 6)
* kdebug:: Debugging. (line 105)
@@ -3511,10 +3533,10 @@
* kpathsea_find_file: File lookup. (line 38)
* kpathsea_find_file <1>: Calling sequence. (line 62)
* kpathsea_find_glyph: Glyph lookup. (line 26)
-* kpathsea_finish: Calling sequence. (line 106)
+* kpathsea_finish: Calling sequence. (line 124)
* kpathsea_init_prog: Fallback font. (line 15)
* kpathsea_init_prog <1>: Calling sequence. (line 53)
-* kpathsea_in_name_ok: Calling sequence. (line 101)
+* kpathsea_in_name_ok: Calling sequence. (line 118)
* kpathsea_new: Calling sequence. (line 9)
* kpathsea_open_file: Calling sequence. (line 74)
* kpathsea_out_name_ok: Calling sequence. (line 82)
@@ -3551,7 +3573,7 @@
* 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 128)
* Linux File System Standard: mktex configuration. (line 113)
* local cache of fonts: Security. (line 22)
* log file: Logging. (line 6)
@@ -3574,7 +3596,7 @@
* 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 128)
* metafont driver files: mktex configuration. (line 93)
* Metafont failures: TeX or Metafont failing.
(line 6)
@@ -3597,7 +3619,7 @@
* mismatched checksum warnings: Suppressing warnings.
(line 17)
* missfont.log: mktex script names. (line 35)
-* MISSFONT_LOG: mktex script names. (line 40)
+* MISSFONT_LOG: mktex script names. (line 45)
* missing character warnings: Suppressing warnings.
(line 20)
* mkocp: mktex script names. (line 18)
@@ -3651,6 +3673,7 @@
(line 145)
* online Metafont display, spurious: Unable to generate fonts.
(line 36)
+* openout_any: Calling sequence. (line 82)
* OPENTYPEFONTS: Supported file formats.
(line 149)
* optimization caveat: TeX or Metafont failing.
@@ -3665,6 +3688,7 @@
(line 158)
* OVPFONTS: Supported file formats.
(line 161)
+* paranoid mode, for output files: Calling sequence. (line 97)
* path expansion: Path expansion. (line 6)
* path searching: Path searching. (line 6)
* path searching options: Path searching options.
@@ -3713,7 +3737,7 @@
(line 16)
* readable: Suppressing warnings.
(line 26)
-* reading arbitrary-length lines: Calling sequence. (line 110)
+* reading arbitrary-length lines: Calling sequence. (line 128)
* recording successful searches: Logging. (line 6)
* relative filenames: Searching overview. (line 58)
* reporting bugs: Reporting bugs. (line 6)
@@ -3721,6 +3745,7 @@
* resolution, setting: Path searching options.
(line 49)
* resolutions, last-resort: Fallback font. (line 6)
+* restricted mode, for output files: Calling sequence. (line 93)
* retrieving TeX: unixtex.ftp. (line 6)
* right-hand side of variable assignments: Config files. (line 57)
* RISINPUTS: Supported file formats.
@@ -3763,7 +3788,7 @@
* 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 128)
* strip: mktex configuration. (line 107)
* stripsupplier: mktex configuration. (line 101)
* striptypeface: mktex configuration. (line 104)
@@ -3867,12 +3892,17 @@
* 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: Calling sequence. (line 97)
* TEXMFSCRIPTS: Supported file formats.
(line 195)
* texmfvar: mktex configuration. (line 122)
* TEXMFVAR: mktex configuration. (line 123)
* 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: Calling sequence.
+ (line 97)
* TEXPICTS: Supported file formats.
(line 79)
* TEXPKS: Supported file formats.
@@ -3921,6 +3951,7 @@
* unreadable file warnings: Suppressing warnings.
(line 27)
* unreadable files: Searching overview. (line 63)
+* unrestricted mode, for output files: Calling sequence. (line 91)
* unusable ls-R warning: ls-R. (line 51)
* usage patterns, finding: Logging. (line 6)
* USERPROFILE, as ~ expansion: Tilde expansion. (line 6)
@@ -3967,61 +3998,62 @@
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: Introduction2262
+Node: History4331
+Node: unixtex.ftp8927
+Node: Security10397
+Node: TeX directory structure12901
+Node: Path searching16940
+Node: Searching overview17898
+Node: Path sources21717
+Node: Config files22943
+Node: Path expansion27815
+Node: Default expansion28768
+Node: Variable expansion30838
+Node: Tilde expansion32239
+Node: Brace expansion33219
+Node: KPSE_DOT expansion34158
+Node: Subdirectory expansion34671
+Node: Casefolding search37019
+Node: Casefolding rationale37788
+Node: Casefolding examples39134
+Node: Filename database44180
+Node: ls-R45162
+Node: Filename aliases48838
+Node: Database format50016
+Node: Invoking kpsewhich51029
+Node: Path searching options51984
+Node: Specially-recognized files61654
+Node: Auxiliary tasks63025
+Node: Standard options66750
+Node: TeX support67106
+Node: Supported file formats68460
+Node: File lookup76279
+Node: Glyph lookup78028
+Node: Basic glyph lookup79152
+Node: Fontmap80032
+Node: Fallback font82542
+Node: Suppressing warnings83454
+Node: mktex scripts84581
+Node: mktex configuration85796
+Node: mktex script names91599
+Node: mktex script arguments93170
+Node: Programming94049
+Node: Programming overview94622
+Node: Calling sequence97483
+Ref: openout_any101641
+Node: Program-specific files104692
+Node: Programming with config files105715
+Node: Reporting bugs107302
+Node: Bug checklist107980
+Node: Mailing lists111449
+Node: Debugging112126
+Node: Logging117203
+Node: Common problems119070
+Node: Unable to find files119547
+Node: Slow path searching121957
+Node: Unable to generate fonts123332
+Node: TeX or Metafont failing125804
+Node: Index127006
End Tag Table
Modified: trunk/Build/source/texk/kpathsea/doc/kpathsea.texi
===================================================================
--- trunk/Build/source/texk/kpathsea/doc/kpathsea.texi 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/doc/kpathsea.texi 2023-10-10 22:01:41 UTC (rev 68508)
@@ -3,7 +3,7 @@
@settitle Kpathsea: A library for path searching
@set version 6.3.5
- at set month-year February 2023
+ at set month-year October 2023
@copying
This file documents the Kpathsea library for path searching.
@@ -1535,9 +1535,10 @@
@item --engine=@var{name}
@opindex --engine=@var{name}
@cindex engine name
-Set the engine name to @var{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.
+Set the engine name to @var{name}. By default it is not set in
+ at code{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
(@file{.fmt}/@file{.base}/@file{.mem}) are now stored in
@@ -1822,9 +1823,10 @@
A user-specified format will override the above defaults.
@flindex tcfmgr.map
-Another useful configuration file in this regard is @file{tcfmgr.map},
-found in @file{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
+ at file{tcfmgr.map}, found in @file{texmf/texconfig/tcfmgr.map}, which
+records various information about the above configuration files (among
+others).
@node Auxiliary tasks
@@ -3018,23 +3020,28 @@
@vindex XDVIMAKEPK
@vindex DVILJMAKEPK
@noindent These names can be overridden by an environment variable specific
-to the program---for example, @code{DVIPSMAKEPK} for Dvipsk.
+to the program; for example, @code{DVIPSMAKEPK} for Dvipsk.
@comment next two paragraphs are repeated in dvips.texi
@flindex missfont.log
@cindex failed @code{mktex at dots{}} script invocation
If a @code{mktex at dots{}} script fails, the invocation is appended to a
-file @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.
+file @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.
- at vindex TEXMFOUTPUT
+ at vindex TEXMF_OUTPUT_DIRECTORY at r{, and @file{missfont.log}}
+ at vindex TEXMFOUTPUT at r{, and @file{missfont.log}}
+If the environment variable @code{TEXMF_OUTPUT_DIRECTORY} is set,
+ at file{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
+ at code{TEXMFOUTPUT} is set, we try to write @file{missfont.log} there.
+Otherwise nothing is written.
+
@vindex MISSFONT_LOG
-If the current directory is not writable and the environment variable or
-configuration file value @code{TEXMFOUTPUT} is set, its value is
-used. Otherwise, nothing is written. The name @samp{missfont.log} is
-overridden by the @code{MISSFONT_LOG} environment variable or
-configuration file value.
+The base filename @samp{missfont.log} is overridden by the
+ at code{MISSFONT_LOG} environment variable or configuration file value.
@node mktex script arguments
@@ -3261,34 +3268,67 @@
@item
@findex kpathsea_out_name_ok
- at TeX{} can write output files, via the @code{\openout} primitive; this opens
-a security hole vulnerable to Trojan horse attack: an unwitting user could
-run a @TeX{} program that overwrites, say, @file{~/.rhosts}. Analogous
-security holes exist for many other programs. To alleviate this, there is a
-configuration variable @code{openout_any}, which selects one of three levels
-of security. When it is set to @samp{a} (for ``any''), no restrictions are
-imposed. When it is set to @samp{r} (for ``restricted''), filenames
-beginning with @samp{.} are disallowed (except @file{.tex} because @LaTeX{}
-needs it). When it is set to @samp{p} (for ``paranoid'') additional
-restrictions are imposed: an absolute filename must refer to a file in (a
-subdirectory) of @code{TEXMFOUTPUT}, and any attempt to go up a directory
-level is forbidden (that is, paths may not contain a @samp{..} component).
-The paranoid setting is the default. (For backwards compatibility, @samp{y}
-and @samp{1} are synonyms of @samp{a}, while @samp{n} and @samp{0} are
-synonyms for @samp{r}.) The function @code{kpathsea_out_name_ok}, with a
-filename as second argument, returns @code{true} if that filename is
-acceptable to be opend for output or @code{false} otherwise.
+ at vindex openout_any
+ at anchor{openout_any}
+ at TeX{} can write output files, via the @code{\openout} primitive. This
+opens a security vulnerability: an unwitting user could run a @TeX{}
+document that overwrites, say, @file{~/.profile}. Analogous
+vulnerabilities exist for almost any program that can write files, but
+since users expect @TeX{} to typeset documents, not overwrite personal
+files, it's desirable to handle this. To alleviate it, there is a
+configuration variable @code{openout_any}, which selects one of three
+levels of security:
+ at itemize
@item
+ at cindex unrestricted mode, for output files
+When set to @samp{a} (for ``any''), no restrictions are imposed.
+
+ at item
+ at cindex restricted mode, for output files
+When is set to @samp{r} (for ``restricted''), filenames beginning
+with @samp{.} are disallowed (except @file{.tex}, because @LaTeX{}
+needs it).
+
+ at item
+ at cindex paranoid mode, for output files
+ at vindex TEXMF_OUTPUT_DIRECTORY at r{, and paranoid output files}
+ at vindex TEXMFOUTPUT at r{, and paranoid output files}
+When set to @samp{p} (for ``paranoid''), additional restrictions are
+imposed. First, an absolute filename must refer to a file in (or in a
+subdirectory of) either the @code{TEXMF_OUTPUT_DIRECTORY} environment
+variable or the @code{TEXMFOUTPUT} environment variable or
+configuration file setting. Second, any attempt to go up a directory
+level is forbidden; that is, paths may not contain a @samp{..}
+component.
+
+ at item
+For backwards compatibility, @samp{y} and @samp{1} are synonyms of
+ at samp{a}, while @samp{n} and @samp{0} are synonyms for @samp{r}.
+
+ at end itemize
+
+The paranoid setting is the default. Any program intended to be safely
+called from @TeX{} should implement the same measures, one way or
+another. @xref{Shell escapes,,, web2c, Web2c}.
+
+The function @code{kpathsea_out_name_ok}, with a filename as second
+argument, returns @code{true} if that filename is acceptable to be
+opened for output or @code{false} otherwise. The Kpsewhich program
+has options @samp{--safe-in-name} and @samp{--safe-out-name} to
+provide a command line interface for the checking.
+
+ at item
@findex kpathsea_in_name_ok
Similarly, the function @code{kpathsea_in_name_ok}, with a filename as
second argument, returns @code{true} if that filename is acceptable to be
opend for input or @code{false} otherwise, depending on the value of the
-configuration variable @code{openin_any} (with @samp{a} as default).
+configuration variable @code{openin_any} (with @samp{a} as default;
+too many system directories are involved to make @samp{p} feasible).
@item
@findex kpathsea_finish
-To close the kpathsea library instance you are using, call
+To close the Kpathsea library instance you are using, call
@code{kpathsea_finish}. This function closes any open log files and
frees the memory used by the instance.
Modified: trunk/Build/source/texk/kpathsea/tex-file.c
===================================================================
--- trunk/Build/source/texk/kpathsea/tex-file.c 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/tex-file.c 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,7 +1,7 @@
/* tex-file.c: high-level file searching by format.
Copyright 1993, 1994, 1995, 1996, 1997, 2007, 2008, 2009, 2010, 2011
- 2012, 2014, 2016, 2017, 2019 Karl Berry.
+ 2012, 2014, 2016, 2017, 2019, 2023 Karl Berry.
Copyright 1998-2005 Olaf Weber.
This library is free software; you can redistribute it and/or
@@ -1194,11 +1194,14 @@
'r' (restricted) means disallowing special file names.
'p' (paranoid) means being really paranoid: disallowing special file
names and restricting output files to be in or below
- the working directory or $TEXMFOUTPUT, while input files
- must be below the current directory, $TEXMFOUTPUT, or
- (implicitly) in the system areas.
+ the working directory or $TEXMFOUTPUT or
+ $TEXMF_OUTPUT_DIRECTORY, while input files
+ must be below the current directory, the envvars, or
+ (only implicitly) in the system areas.
We default to "paranoid". The error messages from TeX may be puzzling.
- This function contains several return and goto statements, be careful. */
+ This function contains several return and goto statements, be careful.
+
+ Paranoia originally supplied by Charles Karney. */
const_string open_choice = kpathsea_var_value (kpse, check_var);
@@ -1231,16 +1234,31 @@
if (*open_choice == 'r' || *open_choice == 'n' || *open_choice == '0')
return true;
- /* Paranoia originally supplied by Charles Karney. */
if (kpathsea_absolute_p (kpse, fname, false)) {
- const_string texmfoutput = kpathsea_var_value (kpse, "TEXMFOUTPUT");
- /* Absolute pathname is only OK if TEXMFOUTPUT is set, it's not empty,
- fname begins the TEXMFOUTPUT, and is followed by / */
- if (!texmfoutput || *texmfoutput == '\0'
- || fname != strstr (fname, texmfoutput)
- || !IS_DIR_SEP (fname[strlen (texmfoutput)]))
- goto not_ok;
+
+ /* fname can be an absolute pathname only if one of the TEXMF*
+ variables is set, is non-empty, the value is the beginning of
+ fname, and the next character in fname is a directory separator. */
+
+ /* We'll check TEXMF_OUTPUT_DIRECTORY first. This must be an
+ environment variable, not a configuration file setting. */
+ const_string texmfoutdir = getenv ("TEXMF_OUTPUT_DIRECTORY");
+ if (!texmfoutdir || *texmfoutdir == '\0'
+ || fname != strstr (fname, texmfoutdir)
+ || !IS_DIR_SEP (fname[strlen (texmfoutdir)])) {
+
+ /* Ok, that didn't work. Check TEXMFOUTPUT in exactly the same
+ way, except it can be in the configuration file. */
+ const_string texmfoutput
+ = kpathsea_var_value (kpse, "TEXMFOUTPUT");
+ if (!texmfoutput || *texmfoutput == '\0'
+ || fname != strstr (fname, texmfoutput)
+ || !IS_DIR_SEP (fname[strlen (texmfoutput)])) {
+ goto not_ok;
+ }
+ }
}
+
/* For all pathnames, we disallow "../" at the beginning or "/../"
anywhere. */
if (fname[0] == '.' && fname[1] == '.' && IS_DIR_SEP(fname[2]))
Modified: trunk/Build/source/texk/kpathsea/tex-make.c
===================================================================
--- trunk/Build/source/texk/kpathsea/tex-make.c 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/tex-make.c 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,6 +1,6 @@
/* tex-make.c: run external programs to make TeX-related files.
- Copyright 1993, 1994, 1995, 1996, 1997, 2008-2020 Karl Berry.
+ Copyright 1993, 1994, 1995, 1996, 1997, 2008-2023 Karl Berry.
Copyright 1997, 1998, 2001-05 Olaf Weber.
This library is free software; you can redistribute it and/or
@@ -18,6 +18,7 @@
#include <kpathsea/config.h>
+#include <kpathsea/absolute.h>
#include <kpathsea/c-fopen.h>
#include <kpathsea/c-pathch.h>
#include <kpathsea/db.h>
@@ -106,7 +107,9 @@
/* If this is the first time, have to open the log file. But don't
bother logging anything if they were discarding errors. */
if (!kpse->missfont && !kpse->make_tex_discard_errors) {
+ string first_name;
const_string missfont_name = kpathsea_var_value (kpse, "MISSFONT_LOG");
+
if (!missfont_name || *missfont_name == '1') {
missfont_name = "missfont.log"; /* take default name */
} else if (missfont_name
@@ -114,9 +117,25 @@
missfont_name = NULL; /* user requested no missfont.log */
} /* else use user's name */
+ /* If the given name is not already absolute,
+ and TEXMF_OUTPUT_DIRECTORY is set, use that instead of cwd.
+ This is only an envvar, not a config file value. */
+ if (!kpathsea_absolute_p (kpse, missfont_name, false)
+ && getenv ("TEXMF_OUTPUT_DIRECTORY")) {
+ first_name = concat3 (getenv ("TEXMF_OUTPUT_DIRECTORY"),
+ DIR_SEP_STRING, missfont_name);
+ } else {
+ first_name = xstrdup (missfont_name);
+ }
kpse->missfont
- = missfont_name ? fopen (missfont_name, FOPEN_A_MODE) : NULL;
- if (!kpse->missfont && kpathsea_var_value (kpse, "TEXMFOUTPUT")) {
+ = missfont_name ? fopen (first_name, FOPEN_A_MODE) : NULL;
+
+ /* If that succeeded, save the name for output below. */
+ if (kpse->missfont) {
+ missfont_name = first_name;
+
+ /* If that failed, try TEXMFOUTPUT. */
+ } else if (kpathsea_var_value (kpse, "TEXMFOUTPUT")) {
missfont_name = concat3 (kpathsea_var_value (kpse, "TEXMFOUTPUT"),
DIR_SEP_STRING, missfont_name);
kpse->missfont = fopen (missfont_name, FOPEN_A_MODE);
@@ -125,6 +144,9 @@
if (kpse->missfont)
fprintf (stderr, "kpathsea: Appending font creation commands to %s.\n",
missfont_name);
+
+ /* Uselessly save memory. */
+ free (first_name);
}
/* Write the command if we have a log file. */
@@ -530,16 +552,24 @@
main (int argc, char **argv)
{
kpathsea kpse = xcalloc(1, sizeof(kpathsea_instance));
- kpathsea_set_program_name(kpse, argv[0], NULL);
+ kpathsea_set_program_name (kpse, argv[0], NULL);
kpathsea_xputenv (kpse, "KPATHSEA_DPI", "781"); /* call mktexpk */
kpathsea_xputenv (kpse,"MAKETEX_BASE_DPI", "300"); /* call mktexpk */
- kpathsea_set_program_enabled(kpse, kpse_pk_format, 1, kpse_src_env);
+ kpathsea_set_program_enabled (kpse, kpse_pk_format, 1, kpse_src_env);
+
+ /* Succeed. */
test_make_tex (kpse, kpse_pk_format, "cmr10");
- /* Fail with mktextfm. */
- kpathsea_set_program_enabled(kpse, kpse_tfm_format, 1, kpse_src_env);
- test_make_tex (kpse, kpse_tfm_format, "foozler99");
+ /* Fail with mktextfm, writing missfont.log to a different directory. */
+ kpathsea_set_program_enabled (kpse, kpse_tfm_format, 1, kpse_src_env);
+ kpathsea_xputenv (kpse,"TEXMF_OUTPUT_DIRECTORY", "/tmp");
+ test_make_tex (kpse, kpse_tfm_format, "foozout99");
+ /* Since the missfont.log descriptor is cached, can only save in one
+ place in a given run, so don't bother doing it twice.
+ test_make_tex (kpse, kpse_tfm_format, "foozler98");
+ */
+
/* Call something disabled. */
test_make_tex (kpse, kpse_bst_format, "no-way");
@@ -551,6 +581,6 @@
/*
Local variables:
-standalone-compile-command: "gcc -g -I. -I.. -DTEST tex-make.c kpathsea.a"
+standalone-compile-command: "gcc -g -I. -I.. -I$wk/.. -DTEST -DMAKE_KPSE_DLL tex-make.c $wk/.libs/libkpathsea.a && ./a.out"
End:
*/
Modified: trunk/Build/source/texk/kpathsea/texmf.cnf
===================================================================
--- trunk/Build/source/texk/kpathsea/texmf.cnf 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/kpathsea/texmf.cnf 2023-10-10 22:01:41 UTC (rev 68508)
@@ -688,8 +688,18 @@
openin_any = a
openout_any = p
-% Write .log/.dvi/.aux/etc. files here, if the current directory is unwritable.
+% Write .log/.dvi/.aux/etc. files here, if they can't be written in the
+% current directory.
+%
+% Best to use this only when a particular job requires it, not set
+% globally in a configuration file or the environment.
%TEXMFOUTPUT = /tmp
+%
+% A related environment variable is TEXMF_OUTPUT_DIRECTORY. It
+% overrides the current directory for all output files in TeX and the other
+% engines. It cannot be set in a configuration file. And it's even more
+% important to use it only temporarily, when required, to avoid massive
+% confusion about where the output files are ending up.
% If a dynamic file creation fails, log the command to this file, in
% either the current directory or TEXMFOUTPUT. Set to the
Modified: trunk/Build/source/texk/web2c/ChangeLog
===================================================================
--- trunk/Build/source/texk/web2c/ChangeLog 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/ChangeLog 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,5 +1,22 @@
2023-10-09 Karl Berry <karl at freefriends.org>
+ * lib/texmfmp.c (parse_options): if --output-directory was
+ specified, putenv the value to TEXMF_OUTPUT_DIRECTORY.
+ If --output-directory was not specified, and
+ TEXMF_OUTPUT_DIRECTORY is set in the environment (not config file),
+ set the output_directory variable to its value.
+ * tests/outputdir.test: new test.
+ * am/texmf.am (tex_tests): add it.
+ * doc/web2c.texi (Output file location),
+ * NEWS: document this.
+ * bibtex.ch: mention failure to implement TEXMF_OUTPUT_DIRECTORY.
+
+ * doc/web2c.texi (Shell escape commands): xref kpathsea doc
+ on output paranoia.
+ * tests/tex-closeout.test: tweak description.
+
+2023-10-09 Karl Berry <karl at freefriends.org>
+
* cpascal.h: typo.
2023-09-24 Andreas Scherer <https://ascherer.github.io>
Modified: trunk/Build/source/texk/web2c/Makefile.in
===================================================================
--- trunk/Build/source/texk/web2c/Makefile.in 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/Makefile.in 2023-10-10 22:01:41 UTC (rev 68508)
@@ -3851,7 +3851,9 @@
# TeX tests
#
-tex_tests = triptest.test tests/write18-quote-test.pl tests/tex-closeout.test
+tex_tests = triptest.test tests/outputdir.test tests/tex-closeout.test \
+ tests/write18-quote-test.pl
+
call_mf_CPPFLAGS = -DEXEPROG=\"mf.exe\"
nodist_call_mf_SOURCES = callexe.c
call_mf_LDADD =
@@ -21597,7 +21599,8 @@
tex-final.ch: tie$(EXEEXT) $(tex_ch_srcs)
$(tie_c) $(tex_ch_srcs)
triptest.log: tex$(EXEEXT) dvitype$(EXEEXT) pltotf$(EXEEXT) tftopl$(EXEEXT)
-tests/write18-quote-test.log tests/tex-closeout.test: tex$(EXEEXT)
+tests/outputdir.log tests/tex-closeout.log \
+ tests/write18-quote-test.log: tex$(EXEEXT)
trip.diffs: tex$(EXEEXT) dvitype$(EXEEXT) pltotf$(EXEEXT) tftopl$(EXEEXT)
$(triptrap_diffs) $@
Modified: trunk/Build/source/texk/web2c/NEWS
===================================================================
--- trunk/Build/source/texk/web2c/NEWS 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/NEWS 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,6 +1,16 @@
This file records noteworthy changes. (Public domain.)
See also */NEWS, */ChangeLog, etc.
+* For all engines: If the --output-directory option is given, its value
+ is saved in the enviroment variable TEXMF_OUTPUT_DIRECTORY, for the
+ benefit of subprograms (called with \write18).
+
+ Furthermore, if the --output-directory option is not given, but
+ the TEXMF_OUTPUT_DIRECTORY environment variable is set, that is used
+ for all output files, as if it had been the value given to the
+ --output-directory option. More details:
+ https://tug.org/texinfohtml/web2c.html#Output-file-location
+
2023 (for TeX Live 2023, 9 March 2023)
Modified: trunk/Build/source/texk/web2c/am/texmf.am
===================================================================
--- trunk/Build/source/texk/web2c/am/texmf.am 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/am/texmf.am 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,7 +1,7 @@
## $Id$
## texk/web2c/am/texmf.am: Makefile fragment for TeX and MF.
##
-## Copyright 2015-2022 Karl Berry <tex-live at tug.org>
+## Copyright 2015-2023 Karl Berry <tex-live at tug.org>
## Copyright 2009-2015 Peter Breitenlohner <tex-live at tug.org>
## You may freely use, modify and/or distribute this file.
@@ -77,9 +77,11 @@
# TeX tests
#
-tex_tests = triptest.test tests/write18-quote-test.pl tests/tex-closeout.test
+tex_tests = triptest.test tests/outputdir.test tests/tex-closeout.test \
+ tests/write18-quote-test.pl
triptest.log: tex$(EXEEXT) dvitype$(EXEEXT) pltotf$(EXEEXT) tftopl$(EXEEXT)
-tests/write18-quote-test.log tests/tex-closeout.test: tex$(EXEEXT)
+tests/outputdir.log tests/tex-closeout.log \
+ tests/write18-quote-test.log: tex$(EXEEXT)
EXTRA_DIST += $(tex_tests)
EXTRA_DIST += tests/write18-quote.tex
if TEX
Modified: trunk/Build/source/texk/web2c/bibtex.ch
===================================================================
--- trunk/Build/source/texk/web2c/bibtex.ch 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/bibtex.ch 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1055,11 +1055,20 @@
% Don't use a path to search for subsidiary aux files,
% but do check the directory of the main .aux file.
%
-% This last is useful, for example, when --output-dir is used and the
+% This last is useful, for example, when --output-dir is used with TeX and the
% .aux file has an \@input directive resulting from a LaTeX \include;
% see bibtex-auxinclude.test. It's necessary because BibTeX itself does
-% not have --output-directory. Maybe it would be (have been?) better to
-% add it, but seems too intrusive now? Different bbl location.
+% not have --output-directory.
+%
+% We should probably implement the --output-directory option and
+% TEXMF_OUTPUT_DIRECTORY envvar in BibTeX. What this amounts to is
+% changing the add_extension function to look for those overrides to the
+% aux file dirname, so that when we call kpse_*_name_ok below, we're
+% calling it on the actual file that will be used.
+%
+% And we need to call kpse_*_name_ok because bibtex is included in the
+% shell_escape_commands list that can be invoked by TeX in restricted mode.
+%
@x
while (name_ptr <= file_name_size) do {pad with blanks}
begin
Modified: trunk/Build/source/texk/web2c/doc/web2c.info
===================================================================
--- trunk/Build/source/texk/web2c/doc/web2c.info 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/doc/web2c.info 2023-10-10 22:01:41 UTC (rev 68508)
@@ -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 @@
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 @@
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 @@
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 @@
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 @@
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,22 +156,22 @@
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
@@ -178,25 +178,25 @@
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.
@@ -203,62 +203,62 @@
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 @@
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 @@
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 @@
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 @@
* 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 @@
======================
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 @@
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,18 +433,18 @@
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.
@@ -451,64 +451,66 @@
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'.
+ 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
+‘-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
@@ -515,30 +517,30 @@
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 @@
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,30 +570,69 @@
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.
+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', for example, the output will
-be in './foo.dvi' and './foo.log', not '/tmp/foo.dvi' and
-'/tmp/foo.log'.
+ 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’.
- 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::.
+ 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.
- 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.
+Override 1: ‘-output-directory’ option
+--------------------------------------
- '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.
+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 @@
* 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 @@
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 @@
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 @@
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 @@
======================
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 @@
================
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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
\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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
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,109 +1094,109 @@
(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
@@ -1162,16 +1203,16 @@
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,9 +1222,9 @@
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::.
@@ -1190,18 +1231,18 @@
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,13 +1252,13 @@
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>).
@@ -1224,12 +1265,12 @@
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,7 +1285,7 @@
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
@@ -1251,11 +1292,11 @@
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 @@
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 @@
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,7 +1337,7 @@
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
@@ -1303,12 +1344,12 @@
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,11 +1364,11 @@
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
@@ -1334,38 +1375,38 @@
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.)
@@ -1372,16 +1413,16 @@
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 @@
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,8 +1454,8 @@
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.
@@ -1421,33 +1462,33 @@
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.
@@ -1454,7 +1495,7 @@
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
@@ -1461,8 +1502,8 @@
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,18 +1512,18 @@
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
@@ -1489,17 +1530,17 @@
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 @@
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 @@
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 @@
(If anyone uses this feature and needs documentation, write
<tex-k at 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 @@
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 @@
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 @@
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 @@
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 @@
(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 @@
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 @@
\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,9 +1859,9 @@
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
@@ -1823,23 +1868,23 @@
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 @@
==========================================
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 at 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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
*********************************
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 @@
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 @@
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 @@
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,14 +2266,14 @@
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::).
@@ -2235,35 +2280,35 @@
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 @@
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 @@
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 @@
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 @@
.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 @@
============================
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 @@
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,12 +2515,12 @@
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
@@ -2482,32 +2527,32 @@
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,7 +2563,7 @@
===============================
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:
@@ -2525,22 +2570,22 @@
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 @@
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 @@
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 @@
(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 @@
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 @@
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 @@
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 @@
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 @@
-----------------------------
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 @@
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 @@
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 @@
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 @@
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 @@
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 @@
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,7 +2980,7 @@
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]
@@ -2942,19 +2987,19 @@
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,36 +3011,36 @@
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
@@ -3002,7 +3047,7 @@
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 @@
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 @@
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:
-'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,7 +3177,7 @@
========================================================
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:
@@ -3139,37 +3184,37 @@
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 @@
...
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 @@
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 @@
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,7 +3366,7 @@
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:
@@ -3328,12 +3373,12 @@
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 @@
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 @@
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 @@
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 @@
<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 @@
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 @@
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 @@
(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 @@
* -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 @@
* .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 @@
(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 @@
* \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 @@
(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 @@
* 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 @@
(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 @@
(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 @@
* 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 @@
* 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 @@
* 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 @@
* 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 @@
(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 @@
* 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 @@
* 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 @@
* 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 @@
* 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 @@
* quoted filename for \input: \input quoted filename.
(line 6)
* Raichle, Bernd: MLTeX. (line 6)
-* reading, additional: Introduction. (line 72)
+* reading from the output directory: Output file location.
+ (line 15)
+* reading, additional: Introduction. (line 71)
* readonly directory, running TeX in: Output file location.
- (line 15)
+ (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 @@
* 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 @@
* 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 @@
* 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 @@
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:
Modified: trunk/Build/source/texk/web2c/doc/web2c.texi
===================================================================
--- trunk/Build/source/texk/web2c/doc/web2c.texi 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/doc/web2c.texi 2023-10-10 22:01:41 UTC (rev 68508)
@@ -12,7 +12,7 @@
@end tex
@set version 2023
- at set month-year February 2022
+ at set month-year October 2023
@c Define new indices for commands in auxiliary files, filenames, and options.
@defcodeindex cm
@@ -63,7 +63,7 @@
an implementation of Donald Knuth's TeX system.
Copyright @copyright{} 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
-2004, 2005, 2007, 2008, 2009, 2010-2022 Karl Berry & Olaf Weber.
+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
@@ -399,7 +399,8 @@
@cindex output directory, specifying
Specify the directory @var{dirname} to which output files are written.
Also look for input files in @var{dirname} first, before looking along
-the normal search path. @xref{Output file location}.
+the normal search path. Input files are only looked for as specified;
+no default extension is added. @xref{Output file location}.
@item -parse-first-line
@opindex -parse-first-line
@@ -494,38 +495,82 @@
@cindex output file location
@cindex current directory, used for output
@flindex . at r{, used for output}
-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.
+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. The main programs (@TeX{},
+Metafont, MetaPost) provide several ways to override this, as
+explained below.
-For example, if you run @samp{tex /tmp/foo}, for example, the output
+For example, if you run @samp{tex /tmp/foo}, by default the output
will be in @file{./foo.dvi} and @file{./foo.log}, not
@file{/tmp/foo.dvi} and @file{/tmp/foo.log}.
+ at cindex input from the output directory
+ at cindex reading from the output directory
+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 @samp{.tex}, are added by default, and no exhaustive
+path searching is done.
+
+ at subheading Override 1: @samp{-output-directory} option
+
@opindex -output-directory
@cindex output directory, specifying
- at cindex readonly directory, running @TeX{} in
-You can use the @samp{-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. @xref{Common options}.
+If the @samp{-output-directory} option is specified, all output files
+that would normally be written in the current directory are written in
+the specified directory instead. @xref{Common options}.
+ at subheading Override 2: @code{TEXMF_OUTPUT_DIRECTORY} environment variable
+
+ at vindex TEXMF_OUTPUT_DIRECTORY
+ at findex \write18 at r{, output location for}
+
+Furthermore, if the @samp{-output-directory} option is specified, its
+argument is saved in the environment variable
+ at code{TEXMF_OUTPUT_DIRECTORY}. This is for the benefit of any
+subprograms that might be called via @code{\write18} (@pxref{Shell
+escapes}), such as @command{kpsewhich} (@pxref{Invoking
+kpsewhich,,,kpathsea,Kpathsea}). (This feature was added in @TeX{}
+Live 2024.)
+
+If the @samp{-output-directory} option is not specified, but the
+environment variable @code{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
+ at code{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,
+ at code{TEXMF_OUTPUT_DIRECTORY} must be set in the environment, not a
+configuration file.
+
+ at subheading Override 3: @code{TEXMFOUTPUT} environment variable
+
@vindex TEXMFOUTPUT at r{, used if @samp{.} unwritable}
@cindex readonly directory, running @TeX{} in
-If the current directory is not writable, and @samp{-output-directory}
-is not specified, the main programs (@TeX{}, Metafont, MetaPost, and
-Bib at TeX{}) make an exception: if the config file or environment
-variable value @code{TEXMFOUTPUT} is set (it is not by default),
-output files are written to the directory specified.
+ at cindex readonly directory, running @TeX{} in
- at vindex TEXMFOUTPUT at r{, used for reading}
- at code{TEXMFOUTPUT} is also checked for input files, as @TeX{} often
-generates files that need to be subsequently read; for input, no
-suffixes (such as @samp{.tex}) are added by default and no exhaustive
-path searching is done, the input name is
-simply checked as given.
+Finally, if neither @samp{-output-directory} nor
+ at code{TEXMF_OUTPUT_DIRECTORY} is set, @emph{and} an output file is not
+writable, then the main programs (@TeX{}, Metafont, MetaPost), plus
+Bib at TeX{} for this one case, make an exception: if the config file or
+environment variable value @code{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 @code{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@*
+ at code{tex --output-directory=/nonesuch \\end}@*
+won't generate an error until @TeX{} tries to write the log file:@*
+ at samp{! I can't write on file `texput.log'.}.
+
@node Three programs
@chapter Three programs: Metafont, MetaPost, and @TeX{}
@@ -1131,7 +1176,7 @@
arguments as a line of regular @TeX{} input.
If no arguments or options are specified, @TeX{} prompts for an
-input file name with @samp{**}.
+input filename with @samp{**}.
@flindex texput
@TeX{} writes the main DVI output to the file
@@ -1271,7 +1316,7 @@
@cindex generating source specials
This option makes @TeX{} output specific source information using
@samp{\special} commands in the DVI file. These @samp{\special} track
-the current file name and line number.
+the current filename and line number.
Using the first form of this option, the @samp{\special} commands are
inserted automatically.
@@ -1845,10 +1890,10 @@
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 (@verb{|'|}) characters to avoid insecure further
-expansion. Care is also taken on Windows to avoid additional
-expansions (from, e.g., @verb{|`...`|}). Mismatched quotation marks
-in the command string result in a diagnostic message in the log file;
-no execution is performed.
+expansion (from, e.g., @verb{|`...`|}). 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, and no
+execution is performed.
@findex shell_escape_commands
After quotation processing, if the first word (delimited by a space or
@@ -1860,7 +1905,7 @@
The @code{shell_escape_commands} value is a comma-separated list of
words. Whitespace is significant, and typically should not be
present. The default definition in @file{texmf.cnf} looks like this,
-but with more commands included:
+with more commands included:
@example
shell_escape_commands = bibtex,kpsewhich,repstopdf,...
@@ -1883,9 +1928,12 @@
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
+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
+ at TeX{} itself does. @xref{Calling sequence,,, kpathsea, Kpathsea}.
@node IPC and TeX
@section IPC and @TeX{}
@@ -2319,7 +2367,10 @@
@item mftalk
@opindex --enable-mftalkwin
(@samp{--enable-mftalkwin}) Generic window server (see
- at file{web2c/window/mftalk.c}).
+ at file{web2c/window/mftalk.c}). @c insignificantly overfull:
+ at tex
+\hfuzz=1.7pt\par
+ at end tex
@item next
@pindex DrawingServant
Modified: trunk/Build/source/texk/web2c/lib/texmfmp.c
===================================================================
--- trunk/Build/source/texk/web2c/lib/texmfmp.c 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/lib/texmfmp.c 2023-10-10 22:01:41 UTC (rev 68508)
@@ -2048,6 +2048,19 @@
} /* Else it was a flag; getopt has already done the assignment. */
}
+
+ if (output_directory) {
+ /* If they specified --output-directory, save it in an envvar
+ so that subprocesses called with \write18 can get the value. */
+ xputenv ("TEXMF_OUTPUT_DIRECTORY", output_directory);
+
+ } else if (getenv ("TEXMF_OUTPUT_DIRECTORY")) {
+ /* If the option wasn't specified, but the envvar is set (i.e., by
+ the user), save the envvar value in our global variable so the
+ rest of our code will use it. */
+ output_directory = getenv ("TEXMF_OUTPUT_DIRECTORY");
+
+ } /* Else neither option nor envvar was set; do nothing. */
}
#if defined(TeX)
Added: trunk/Build/source/texk/web2c/tests/outputdir.test
===================================================================
--- trunk/Build/source/texk/web2c/tests/outputdir.test (rev 0)
+++ trunk/Build/source/texk/web2c/tests/outputdir.test 2023-10-10 22:01:41 UTC (rev 68508)
@@ -0,0 +1,63 @@
+#! /bin/sh -vx
+# qqq also check propagated to subprog
+# $Id$
+# outputdir.test - check that TEXMF_OUTPUT_DIRECTORY works.
+# Public domain. Originally written by Karl Berry, 2023.
+
+BinDir=${BinDir:-..} # ordinarily run from the web2c/tests subdir in build
+ExeExt=${ExeExt:-}
+
+# in case we're invoked standalone instead of from make.
+test -z "$srcdir" && srcdir=`cd \`dirname $0\`/.. && pwd` # web2c/
+TEXMFCNF=$srcdir/../kpathsea; export TEXMFCNF
+
+(
+# We have to cd so we can make an output directory
+# that would normally be disallowed.
+cd tests || exit 1
+pwd
+
+outdir=../outdirtest
+TEXMF_OUTPUT_DIRECTORY=$outdir; export TEXMF_OUTPUT_DIRECTORY
+
+outfile=outfile.tex
+rm -rf $outdir $outfile # don't let previous runs interfere
+mkdir $outdir || exit 1
+
+for engine in tex; do # luatex mpost
+ _engine=$BinDir/$engine$ExeExt
+
+ # The output file should be written to outdir (not .), because of the
+ # envvar. Ordinarily a .. path would be rejected for writing.
+ $_engine -ini '\immediate\openout1='$outfile'\end' || exit 3
+
+ set -x
+ ls -l $outdir/$outfile || exit 5 # ensure it got written,
+ ls -l $outfile && exit 7 # and not to cwd.
+
+ # Then we should be able to read it back in TeX, implicitly from outdir.
+ $_engine -ini '\input '$outfile' \end' || exit 9
+
+ # The log file should also have been written to outdir.
+ ls -l $outdir/`basename $outfile .tex`.log || exit 11
+done
+
+) # end subshell in tests subdir
+exit $? # must be the next line to propagate status
+
+# We could test that it propagates to subprograms with something like
+# tex -ini --shell-restricted '\catcode123=1 \catcode125=2 \immediate\write18{kpsewhich --var-value TEXMF_OUTPUT_DIRECTORY}\end'
+# but since it requires so much config file stuff, let's not bother.
+
+# In theory we should run this with all the tex engines + mf,
+# but it just doesn't seem worth the time or trouble. After it's
+# implemented in LuaTeX and MetaPost, would be worth it there since it's
+# independent code.
+
+# BibTeX requires implementing the output directory stuff; see bibtex.ch.
+# If that's ever done, a test invocation, within the subshell above,
+# could look like:
+# TEXMFCNF=$srcdir/../kpathsea \
+# BSTINPUTS=$srcdir/tests \
+# BIBINPUTS=$srcdir/tests \
+# $_bibtex $srcdir/tests/exampl.aux || exit 1
Property changes on: trunk/Build/source/texk/web2c/tests/outputdir.test
___________________________________________________________________
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Added: svn:keywords
## -0,0 +1 ##
+Date Author Id Revision
\ No newline at end of property
Modified: trunk/Build/source/texk/web2c/tests/tex-closeout.test
===================================================================
--- trunk/Build/source/texk/web2c/tests/tex-closeout.test 2023-10-10 20:27:00 UTC (rev 68507)
+++ trunk/Build/source/texk/web2c/tests/tex-closeout.test 2023-10-10 22:01:41 UTC (rev 68508)
@@ -1,7 +1,8 @@
#! /bin/sh -vx
# $Id$
-# Copyright 2019 Karl Berry <tex-live at tug.org>
+# Copyright 2019-2023 Karl Berry <tex-live at tug.org>
# You may freely use, modify and/or distribute this file.
+# Check for a double free bug.
BinDir=${BinDir:-.}
ExeExt=${ExeExt:-}
@@ -11,8 +12,9 @@
test -z "$srcdir" && srcdir=`cd \`dirname $0\`/.. && pwd` # web2c/
TEXMFCNF=$srcdir/../kpathsea; export TEXMFCNF
-# Resulted in a double free with glibc on x86_64-linux.
-fail=2
+# Resulted in a double free with glibc on x86_64-linux ca.2019.
+# We expect TeX to exit with bad status since the \openout
+# of /tmp/a should not be allowed.
$_tex -ini '\batchmode \immediate\openout1=b \openout1=/tmp/a \end'
# If TeX crashed, we won't get here. The exit status will be something
@@ -20,4 +22,3 @@
fail=0
exit $fail
-
More information about the tex-live-commits
mailing list.