summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2024-03-06 17:36:58 +0000
committerKarl Berry <karl@freefriends.org>2024-03-06 17:36:58 +0000
commite19bea259cb3b1f4da063befebe56f7baf98c9cd (patch)
tree0ca36f11fb2bd9a41cdbedc2440c5fee49d6af18
parent5f1160c5a13f0bb90cdf9c63bf2fb3bb5abb5986 (diff)
etex manual update for \interlinepenalties, etc.
git-svn-id: svn://tug.org/texlive/trunk@70440 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/texmf-dist/doc/etex/base/ChangeLog20
-rw-r--r--Master/texmf-dist/doc/etex/base/README18
-rw-r--r--Master/texmf-dist/doc/etex/base/etex_man.pdfbin297592 -> 257736 bytes
-rw-r--r--Master/texmf-dist/doc/etex/base/etex_man.tex83
-rw-r--r--Master/texmf-dist/doc/etex/base/legal.html6
-rwxr-xr-xMaster/tlpkg/bin/tl-update-news1
-rw-r--r--Master/tlpkg/doc/releng.txt4
7 files changed, 92 insertions, 40 deletions
diff --git a/Master/texmf-dist/doc/etex/base/ChangeLog b/Master/texmf-dist/doc/etex/base/ChangeLog
index 3a0e2816d25..2c9372e802e 100644
--- a/Master/texmf-dist/doc/etex/base/ChangeLog
+++ b/Master/texmf-dist/doc/etex/base/ChangeLog
@@ -1,3 +1,23 @@
+2022-03-06 Karl Berry <karl@tug.org>
+
+ * etex_man.tex: copyright attributions, tweak penalty array texts.
+
+2024-03-04 David Carlisle <David.Carlisle@latex-project.org>
+
+ * etex_man.tex: add hyperref
+ * etex_man.tex: Use Knuth license per legal.html.
+
+2022-03-03 Karl Berry <karl@tug.org>
+
+ * etex_man.tex, legal.html: editorial changes.
+
+2024-02-29 David Carlisle <David.Carlisle@latex-project.org>
+
+ * legal.html: Use ctan.org/pkg/etex url for e-tex reference site
+ (rhbnc.ac.uk domain no longer functional).
+ * etex_man.tex: Adjust introductory notes re NTS, mention pdftex
+ manual, document \interlinepenalties reset at \par.
+
2023-11-24 TANAKA Takuji <ttk@t-lab.opal.ne.jp>
* etriptest.test, etrip/etrip.{fot,log,typ}, etrip/etripin.log:
diff --git a/Master/texmf-dist/doc/etex/base/README b/Master/texmf-dist/doc/etex/base/README
new file mode 100644
index 00000000000..36d72b4914f
--- /dev/null
+++ b/Master/texmf-dist/doc/etex/base/README
@@ -0,0 +1,18 @@
+$Id: README 70439 2024-03-06 17:35:27Z karl $
+The e-TeX engine is an extended TeX developed under the auspices of the
+NTS Group and implemented by Peter Breitenlohner (deceased 2015).
+The extensions are enabled by a leading "*" character at initex time.
+
+Further cross-engine extensions to TeX have been developed in the pdfTeX
+and other engines, keeping e-TeX stable.
+
+The "etex" executable provided in most distributions is an incarnation
+of pdfTeX running in DVI mode, in order for those additional extensions
+to also be available.
+
+LaTeX requires the functionality of both e-TeX extensions and some of the
+extensions beyond e-TeX.
+
+For more info, see the package page on CTAN: https://ctan.org/pkg/etex.
+
+(This README is public domain. Originally written by Karl Berry, 2024.)
diff --git a/Master/texmf-dist/doc/etex/base/etex_man.pdf b/Master/texmf-dist/doc/etex/base/etex_man.pdf
index 24e89cd84f6..030d968db8d 100644
--- a/Master/texmf-dist/doc/etex/base/etex_man.pdf
+++ b/Master/texmf-dist/doc/etex/base/etex_man.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/etex/base/etex_man.tex b/Master/texmf-dist/doc/etex/base/etex_man.tex
index 7ce0d00110c..f83509eed32 100644
--- a/Master/texmf-dist/doc/etex/base/etex_man.tex
+++ b/Master/texmf-dist/doc/etex/base/etex_man.tex
@@ -1,37 +1,39 @@
-%&latex % english hyphenation
-
-\documentclass{article}
+% etex_man.tex
+% Copyright (c) 1994-2015 Peter Breitenlohner (deceased 2015)
+% Copyright (c) 2024 NTS Team and successors
+\documentclass[11pt]{article}
+\usepackage{fullpage} % fewer pages is better
\usepackage{etex_man}
+\usepackage[hidelinks]{hyperref}
\begin{document}
\begin{center}
-%% {\LARGE Draft, \today}\\[6pt]
-{\huge\bf The \eTeX\ manual}\\[6pt]
-{\sl Version 2, February 1998\/}\\[18pt]
-by The \NTS\ Team\\[6pt]
-Peter Breitenlohner, Max-Planck-Institut f\"ur Physik, M\"unchen\\[18pt]
-\small\noindent
-The preparation of this report was supported in part by {\sc Dante},\\
-Deutschsprachige Anwendervereinigung \TeX\ e.V.\\
-`\TeX' is a trademark of the American Mathematical Society.
+{\huge\bf The \eTeX\ manual\footnote{%
+ This document is released under the license used by Donald Knuth for
+ \TeX\ (\texttt{https://ctan.org/license/knuth}); the present source
+ filename is \texttt{etex\char`\_man.tex}).}}
+ \\[6pt]
+{\sl Version 2, February 1998 (updated March 2024)}
+ \\[18pt]
+%
+by The \NTS\ Team\footnote{%
+ The preparation of the original report was supported in part by
+ {\sc Dante}, Deutschsprachige Anwendervereinigung \TeX\ e.V.}
+ \\[6pt]
+Peter Breitenlohner, Max-Planck-Institut f\"ur Physik, M\"unchen\footnote{%
+ Peter Breitenlohner died in 2015. The March 2024 update was prepared
+ by David Carlisle and Karl Berry for \TeX\,Live, where \eTeX\ has been
+ maintained for many years.\raggedright}
\end{center}
\section{Introduction}
-The \NTS\ project intends to develop an `New Typesetting System' (\NTS)
-that will eventually replace today's \TeX3. The \NTS\ program will
-include many features missing in \TeX, but there will also exist a mode
-of operation that is 100\% compatible with \TeX3. It will, necessarily,
-require quite some time to develop \NTS\ to maturity and make it widely
-available.
-
-Meanwhile \eTeX\ intends to fill the gap between \TeX3 and the future
-\NTS. It consists of a series of features extending the capabilities of
-\TeX3.%
-\footnote{The \TeX3 program; for the moment there are no plans to extend
-the software related to \TeX.}
+The \eTeX\ program was intended to fill the gap between \TeX3 and the
+\NTS\ which was planned as the successor to \TeX3.
+It consists of a series of features extending the capabilities of
+\TeX3.
Since compatibility between \eTeX\ and \TeX3 has been a main concern,
\eTeX\ has two modes of operation:\\
@@ -42,7 +44,9 @@ That means in particular that \eTeX\ passes the \|TRIP| test
minor modifications that would be legitimate in any implementation of
\TeX.\\
(2)~In extended mode there are additional primitive commands and the
-extended features of \eTeX\ are available.
+extended features of \eTeX\ are available. This mode is triggered by the
+first non-blank input character to the extended \texttt{initex} being a
+\texttt{*}.
We have tried to make \eTeX\ as compatible with \TeX\ as possible
even in extended mode. In a few cases there are, however, some subtle
@@ -57,15 +61,21 @@ For each enhancement there is a state variable \|\...state|; an
enhancement is enabled or disabled by assigning a positive or
non-positive value respectively to that state variable.
-For \eTeX\ Versions~1 and~2 there is just one enhancement: mixed
-direction typesetting (\TeXXeT) with the state variable \|\TeXXeTstate|.
+For \eTeX\ Versions~1 and~2 there is just one such enhancement: mixed
+direction typesetting (\hbox{\TeXXeT}) with the state variable \|\TeXXeTstate|.
Version~1.1 of \eTeX\ was released in November 1996, Version~2.0 in
February 1998.
-It is expected that there will be about one \eTeX\ version per year,
-where each later version adds new features. It would be desirable if
-these \eTeX\ versions were incorporated into many of the existing
-implementations of \TeX3 without much delay.
+It was expected that there would be be about one \eTeX\ version per year,
+where each later version adds new features. However, nowadays, \eTeX\
+is considered completely stable and further changes are not planned.
+
+In practice most current \texttt{etex} programs are an incarnation of
+pdf\TeX\ running in DVI mode. As such, they include several additional
+commands that are documented in the pdf\TeX\ manual, not in this
+document. As a point of information: the \LaTeX\ format requires that
+the underlying \TeX\ implementation provide the functionality of some of
+these additional commands, beyond \eTeX.
With each \eTeX\ version there will be an \|e-TRIP| test \cite{etripman}
in order to help to verify that a particular implementation deserves the
@@ -552,7 +562,7 @@ of an error message continues beyond an input line from a pseudo-file until
an input line from a real file (or the terminal) is found.
When \eTeX's input mechanism attempts to read beyond the end of an \|\input|
-file or \|\scantokens| pseudo-file, and before checking for `runaway'
+file or a \|\scantokens| pseudo-file, and before checking for `runaway'
conditions and closing the file, it will first read a list of tokens that
has been predefined by the command \|\everyeof={|\<token list>\|}|.
@@ -638,6 +648,10 @@ length $m$;\\
the $i^{\rm th}$ display widow penalty value is used after line $m-i$ of a
partial paragraph of length $m$ that is followed by a displayed equation.
+Note that \|\interlinepenalties| is reset (like \|\parshape|)
+at any \|\par| (blank line) in the input. The other |\...penalties|
+arrays are not reset at \|\par|.
+
When used after \|\the| or in situations where \TeX\ expects to see a
number, the same four commands serve to retrieve the arrays of penalties.
Specifying, e.g., \|\clubpenalties|\<number> with a number $n$, returns~0
@@ -791,7 +805,7 @@ When \eTeX\ is absorbing the token list for \|\unexpanded|,
\item
Protected macros (defined with the \|\protected| prefix) are not
expanded when building an expanded token list (for \|\edef|, \|\xdef|,
-\|\message|,\\
+\|\message|,
\|\errmessage|, \|\special|, \|\mark|, \|\marks| or when writing the
token list for \|\write| to a file) or when looking ahead in an
alignment for \|\noalign| or \|\omit|.%
@@ -802,7 +816,7 @@ suppression of their expansion in alignments was introduced with Version~2.}
When building an expanded token list, the tokens resulting from the
expansion of \|\unexpanded| are not expanded further (this is the same
behaviour as is exhibited by the tokens resulting from the expansion of
-\|\the|\<token variable> in both \TeX\ and \eTeX).
+\|\the|\<token variable> in both \TeX\ and \eTeX).{\hfuzz=1.4pt\par}
\end{itemize}
@@ -1147,4 +1161,3 @@ by Donald~E. Knuth and Pierre MacKay,
\end{thebibliography}
\end{document}
-
diff --git a/Master/texmf-dist/doc/etex/base/legal.html b/Master/texmf-dist/doc/etex/base/legal.html
index 986bb351b63..762048cd9c8 100644
--- a/Master/texmf-dist/doc/etex/base/legal.html
+++ b/Master/texmf-dist/doc/etex/base/legal.html
@@ -35,10 +35,10 @@ official version.
Although it is <em>preferred</em> that e-TeX be distributed in
source form, it is recognised that there are systems for which
binary distributions are the norm. It is therefore
-<em>required</em> that any binary distribution of e-TeX be
+requested that any binary distribution of e-TeX be
accompanied by a clear statement that the definitive sources
for e-TeX are available free-of-charge at the
-<a href="http://www.rhbnc.ac.uk/e-TeX/">e-TeX reference site</a>.
+<a href="https://ctan.org/pkg/etex">e-TeX reference site</a>.
<p>
With the exception of anything specifically referred to above,
all components of the system known as "e-TeX" are
@@ -47,6 +47,6 @@ system known as "TeX".
<p>
Enjoy!
<hr>
-Release date: 11th November 1996
+Release date: 3 March 2024
</body>
</html>
diff --git a/Master/tlpkg/bin/tl-update-news b/Master/tlpkg/bin/tl-update-news
index 9cccb89a537..8c435b9b84c 100755
--- a/Master/tlpkg/bin/tl-update-news
+++ b/Master/tlpkg/bin/tl-update-news
@@ -39,6 +39,7 @@ $cp NEWS $xist_doc/web2c/
#
$cp alephdir/ChangeLog $xist_doc/aleph/base/
$cp etexdir/ChangeLog $xist_doc/etex/base/
+$cp etexdir/README $xist_doc/etex/base/
$cp luatexdir/NEWS $xist_doc/luatex/base/
$cp mplibdir/NEWS $xist_doc/metapost/base/
$cp pdftexdir/NEWS $xist_doc/pdftex/
diff --git a/Master/tlpkg/doc/releng.txt b/Master/tlpkg/doc/releng.txt
index 684fe910e73..32a0092c7f9 100644
--- a/Master/tlpkg/doc/releng.txt
+++ b/Master/tlpkg/doc/releng.txt
@@ -281,11 +281,11 @@ M. As pretest proceeds, update the doc:
any new people to thank,
and changes throughout if behavior has changed.
Engine/etc. doc updates:
- . run tl-update-news, which copies simple files to the runtime.
+ . run tl-update-news, which copies simple files to the runtime doc dir.
. pdftex/mpost/luatex maintainers should update their manuals
from their repositories (doc/manual/ and manual/ subdirs for the
first two) to the runtime.
- . consider updates of core man pages in Build/source/texk/web2c/man.
+ . update of core man pages in Build/source/texk/web2c/man.
Update tlbuild.texi text, then
xs=.../Build/source
W=$xs/Work