Bug#1039976: detex.1: some remarks and editorial fixes in a patch for the manual

2023-07-02 Thread Preuße

On 30.06.2023 22:48, Preuße...@buxtehude.debian.org, Hilmar wrote:

Hi,

It would be nice if you could provide your content as attachment, this 
would help me to extract the content, even if it is just text.
Further consider to submit your suggestions directly to the upstream 
maintainer of the software, if possible.


For that one I've created an PR: 
https://github.com/pkubowicz/opendetex/pull/83


H.


OpenPGP_0x0C871C4C653C1F59.asc
Description: OpenPGP public key


OpenPGP_signature
Description: OpenPGP digital signature


Bug#1039976: detex.1: some remarks and editorial fixes in a patch for the manual

2023-06-30 Thread Preuße

On 30.06.2023 01:46, Bjarni Ingi Gislason wrote:

Dear Bjarni,


here are some notes and a patch for the manual.


Many thanks for your patches: they are heavily appreciated.

It would be nice if you could provide your content as attachment, this 
would help me to extract the content, even if it is just text.
Further consider to submit your suggestions directly to the upstream 
maintainer of the software, if possible.


Many thanks,
  Hilmar
--
sigfault



OpenPGP_0x0C871C4C653C1F59.asc
Description: OpenPGP public key


OpenPGP_signature
Description: OpenPGP digital signature


Bug#1039976: detex.1: some remarks and editorial fixes in a patch for the manual

2023-06-30 Thread Bjarni Ingi Gislason
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  > 
  nroff -man  > 
  diff -u  

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.0 +
+++ detex.1.new 2023-06-29 23:23:28.0 +
@@ -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