Bug#1039976: detex.1: some remarks and editorial fixes in a patch for the manual
Package: texlive-binaries
Version: 2022.20220321.62855-5.1
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and a patch for the manual.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff using
"groff -man -Z" instead of "nroff -man"
-.-.
Output from "mandoc -T lint detex.1":
mandoc: detex.1:6:81: STYLE: input text line longer than 80 bytes: [ \fB\-clnstw\fR ] [...
mandoc: detex.1:89:4: STYLE: whitespace at end of input line
mandoc: detex.1:96:82: STYLE: input text line longer than 80 bytes: TEXINPUTS. It does ...
mandoc: detex.1:123:84: STYLE: input text line longer than 80 bytes: Originally written b...
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
16:follows \\input commands.
21:option is used, no \\input or \\include commands will be processed.
27:If the magic sequence ``\\begin{document}'' appears in the text,
35:These include the \\include and \\includeonly commands.
60:mode to have detex echo the arguments to \\cite,
61:\\ref, and \\pageref macros. This can be useful when sending the output to
75:option tries to naively replace $..$, $$..$$, \\(..\\) and \\[..\\]
94:The TEXINPUTS environment variable is used to find \\input and \\include
101:\\aa, \\ae, \\oe, \\ss, \\o, \\l (and their upper-case
102:equivalents). The special "dotless" characters \\i and \\j are also
118:Nesting of \\input is allowed but the number of opened files must not
134:source without a ``\\begin{document}''
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
116:tex(1)
-.-.
--- detex.1 2023-06-29 22:54:43.000000000 +0000
+++ detex.1.new 2023-06-29 23:23:28.000000000 +0000
@@ -13,18 +13,18 @@ and writes the remainder on the standard
All text in math mode and display mode is removed.
By default,
.I detex
-follows \\input commands.
+follows \einput commands.
If a file cannot be opened, a warning message is
printed and the command is ignored.
If the
.B \-n
-option is used, no \\input or \\include commands will be processed.
+option is used, no \einput or \einclude commands will be processed.
This allows single file processing.
If no input file is given on the command line,
.I detex
reads from standard input.
.PP
-If the magic sequence ``\\begin{document}'' appears in the text,
+If the magic sequence ``\ebegin{document}'' appears in the text,
.I detex
assumes it is dealing with
.I LaTeX
@@ -32,7 +32,7 @@ source and
.I detex
recognizes additional constructs used in
.IR LaTeX .
-These include the \\include and \\includeonly commands.
+These include the \einclude and \eincludeonly commands.
The
.B \-l
option can be used to force
@@ -57,8 +57,8 @@ The
.B \-c
option can be used in
.I LaTeX
-mode to have detex echo the arguments to \\cite,
-\\ref, and \\pageref macros. This can be useful when sending the output to
+mode to have detex echo the arguments to \ecite,
+\eref, and \epageref macros. This can be useful when sending the output to
a style checker.
.PP
.I Detex
@@ -72,7 +72,7 @@ environments.
.PP
The
.B \-r
-option tries to naively replace $..$, $$..$$, \\(..\\) and \\[..\\]
+option tries to naively replace $..$, $$..$$, \e(..\e) and \e[..\e]
with nouns and verbs (in particular, "noun" and "verbs")
in a way that keeps sentences readable.
.PP
@@ -86,20 +86,21 @@ with the deletions mentioned above. New
preserved where possible
so that the lines of output match the input as closely as possible.
.PP
-The
+The
.B \-1
option will prefix each printed line with `filename:linenumber:` indicating
where that line is coming from in terms of the original (La)TeX document.
.PP
-The TEXINPUTS environment variable is used to find \\input and \\include
+The TEXINPUTS environment variable is used to find \einput and \einclude
files. Like \fITeX\fP, it interprets a leading or trailing `:' as the default
-TEXINPUTS. It does \fInot\fP support the `//' directory expansion magic sequence.
+TEXINPUTS.
+It does \fInot\fP support the `//' directory expansion magic sequence.
.PP
Detex now handles the basic \fITeX\fP ligatures as a special case, replacing the
ligatures with acceptable character substitutes. This eliminates
spelling errors introduced by merely removing them. The ligatures are
-\\aa, \\ae, \\oe, \\ss, \\o, \\l (and their upper-case
-equivalents). The special "dotless" characters \\i and \\j are also
+\eaa, \eae, \eoe, \ess, \eo, \el (and their upper-case
+equivalents). The special "dotless" characters \ei and \ej are also
replaced with i and j respectively.
.PP
Note that previous versions of
@@ -113,14 +114,15 @@ The old functionality can be essentially
.B \-s
option.
.SH SEE ALSO
-tex(1)
+.BR tex (1)
.SH DIAGNOSTICS
-Nesting of \\input is allowed but the number of opened files must not
+Nesting of \einput is allowed but the number of opened files must not
exceed the system's limit on the number of simultaneously opened files.
.I Detex
ignores unrecognized option characters after printing a warning message.
.SH AUTHOR
-Originally written by Daniel Trinkle, Computer Science Department, Purdue University
+Originally written by Daniel Trinkle,
+Computer Science Department, Purdue University
.PP
Maintained by Piotr Kubowicz <https://github.com/pkubowicz/opendetex>.
.SH BUGS
@@ -131,7 +133,7 @@ interpreter, so it can be confused by so
Most errors result in too much rather than too little output.
.PP
Running \fILaTeX\fR
-source without a ``\\begin{document}''
+source without a ``\ebegin{document}''
through \fIdetex\fR may produce
errors.
.PP
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages texlive-binaries depends on:
ii libc6 2.36-9
ii libcairo2 1.16.0-7
ii libfontconfig1 2.14.1-4
ii libfreetype6 2.12.1+dfsg-5
ii libgcc-s1 13.1.0-6
ii libgraphite2-3 1.3.14-1
ii libharfbuzz0b 6.0.0+dfsg-3
ii libicu72 72.1-3
ii libkpathsea6 2022.20220321.62855-5.1
ii libmpfr6 4.2.0-1
ii libpaper1 1.1.29
ii libpixman-1-0 0.42.2-1
ii libpng16-16 1.6.39-2
ii libptexenc1 2022.20220321.62855-5.1
ii libstdc++6 13.1.0-6
ii libsynctex2 2022.20220321.62855-5.1
ii libteckit0 2.5.11+ds1-1+b1
ii libtexlua53-5 2022.20220321.62855-5.1
ii libtexluajit2 2022.20220321.62855-5.1
ii libx11-6 2:1.8.6-1
ii libxaw7 2:1.0.14-1
ii libxi6 2:1.8-1+b1
ii libxmu6 2:1.1.3-3
ii libxpm4 1:3.5.12-1.1
ii libxt6 1:1.2.1-1.1
ii libzzip-0-13 0.13.72+dfsg.1-1.1
ii perl 5.36.0-7
ii t1utils 1.41-4
ii tex-common 6.18
ii zlib1g 1:1.2.13.dfsg-1
Versions of packages texlive-binaries recommends:
pn dvisvgm <none>
ii texlive-base 2022.20230122-3
texlive-binaries suggests no packages.
Versions of packages tex-common depends on:
ii ucf 3.0043+nmu1
Versions of packages tex-common suggests:
pn debhelper <none>
Versions of packages texlive-binaries is related to:
ii tex-common 6.18
ii texlive-base 2022.20230122-3
-- no debconf information
Reply to: