texlive[55618] Build/source/texk/web2c/tiedir: [TIE] Add info about

[commits+ascherer at tug.org]

Revision: 55618
          http://tug.org/svn/texlive?view=revision&revision=55618
Author:   ascherer
Date:     2020-06-21 16:03:27 +0200 (Sun, 21 Jun 2020)
Log Message:
-----------
[TIE] Add info about KPSE and WEBINPUTS.

Modified Paths:
--------------
    trunk/Build/source/texk/web2c/tiedir/ChangeLog
    trunk/Build/source/texk/web2c/tiedir/tie-w2c.ch

Modified: trunk/Build/source/texk/web2c/tiedir/ChangeLog
===================================================================
--- trunk/Build/source/texk/web2c/tiedir/ChangeLog	2020-06-21 12:10:18 UTC (rev 55617)
+++ trunk/Build/source/texk/web2c/tiedir/ChangeLog	2020-06-21 14:03:27 UTC (rev 55618)
@@ -1,3 +1,7 @@
+2020-06-21  Andreas Scherer  <https://ascherer.github.io>
+
+	* tie-w2c.ch: Mention WEBINPUTS environment variable in \S59.
+
 2020-06-20  Andreas Scherer  <https://ascherer.github.io>
 
 	* tie-w2c.ch: Minor change in section 1

Modified: trunk/Build/source/texk/web2c/tiedir/tie-w2c.ch
===================================================================
--- trunk/Build/source/texk/web2c/tiedir/tie-w2c.ch	2020-06-21 12:10:18 UTC (rev 55617)
+++ trunk/Build/source/texk/web2c/tiedir/tie-w2c.ch	2020-06-21 14:03:27 UTC (rev 55618)
@@ -396,6 +396,35 @@
 
 Section 59
 
+ at x l.1233
+\noindent Here is where \.{TIE} starts, and where it ends.
+ at y
+\noindent Here is where \.{TIE} starts, and where it ends.
+\def\Kpathsea/{{\mc KPATHSEA\spacefactor1000}}
+
+This version of the \.{TIE} program uses the \Kpathsea/ library for searching
+files.  Firstly, we use the |kpse_web_format| when opening input files, which
+triggers the inspection of the \.{WEBINPUTS} environment variable.  Secondly,
+we set |kpse_program_name| to `\.{tie}'.  This means if the variable
+\.{WEBINPUTS.tie} is present in \.{texmf.cnf} (or \.{WEBINPUTS\_tie} in the
+environment) its value will be used as the search path for filenames.  This
+allows different flavors of \.{TIE} (or other \.{WEB} programs) to have
+different search paths. at .WEBINPUTS@> In all, the directories to be searched for
+come from at least two sources:
+\smallskip
+{\parindent1.5em
+\item{(a)} a user-set environment variable \.{WEBINPUTS}
+    (overridden by \.{WEBINPUTS\_tie});
+\item{(b)} a line in \Kpathsea/ configuration file \.{texmf.cnf},\hfil\break
+    e.g., \.{WEBINPUTS=\$TEXMFDOTDIR:\$TEXMF/texmf/web//}\hfil\break
+    or \.{WEBINPUTS.tie=\$TEXMFDOTDIR:\$TEXMF/texmf/web//}.\par}
+\smallskip
+Note that, although \.{WEBINPUTS} might suggest otherwise, \.{TIE} is more or
+less language-agnostic and that it is perfectly capable of handling \.{CWEB}
+files as input as well, as long as the ``change files'' adhere to the general
+\.{@@x}, \.{@@y}, \.{@@z} convention.
+ at z
+
 @x l.1236
 main(argc,argv)
         int argc; string *argv;