Bug#1037553: luatex.1: some formatting fixes for the manual

2023-06-14 Thread Preuße

Control: forwarded 1037553 http://tracker.luatex.org/view.php?id=1025

On 14.06.2023 06:44, Bjarni Ingi Gislason wrote:

Hi,


here are some remarks and a fix for some formatting issues in the man
page of luatex(1).


Forwarded.

H.
--
sigfault



OpenPGP_0x0C871C4C653C1F59.asc
Description: OpenPGP public key


OpenPGP_signature
Description: OpenPGP digital signature


Bug#1037553: luatex.1: some formatting fixes for the manual

2023-06-14 Thread Preuße

On 14.06.2023 06:44, Bjarni Ingi Gislason wrote:

Hi,


Dear Maintainer,

here are some remarks and a fix for some formatting issues in the man
page of luatex(1).



I've pushed the changes to the repo. Thanks for the report!

Hilmar
--
sigfault



OpenPGP_0x0C871C4C653C1F59.asc
Description: OpenPGP public key


OpenPGP_signature
Description: OpenPGP digital signature


Bug#1037553: luatex.1: some formatting fixes for the manual

2023-06-13 Thread Bjarni Ingi Gislason
Package: texlive-binaries
Version: 2022.20220321.62855-5.1
Severity: minor
Tags: patch

Dear Maintainer,

here are some remarks and a fix for some formatting issues in the man
page of luatex(1).

Input file is luatex.1

#

Output from "mandoc  -T lint luatex.1"
mandoc: luatex.1:11:129: STYLE: input text line longer than 80 bytes: luatex, 
dviluatex, l...
mandoc: luatex.1:192:2: WARNING: line scope broken: TP breaks TP

#

Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-

85:in comparison to the standard web2c programs. The presence of \fB--lua\fR

#

Use the correct macro for the font change of a single argument or
split the argument into two.

104:.BI \-\-luaconly

#

Wrong distance between sentences.

  Separate the sentences and subordinate clauses;
each begins on a new line.
See man-pages(7) and "info groff".

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

47:next word is taken as the \fIFMT\fR to read, overriding all else. Any
83:similar fashion as in traditional pdf\*(TX and Aleph. But if the option
85:in comparison to the standard web2c programs. The presence of \fB--lua\fR
98:Start Lua\*(TX as a Lua interpreter. In this mode, it will set Lua's
101:just like the Lua interpreter. Lua\*(TX will exit immediately after
105:Start Lua\*(TX as a Lua byte compiler. In this mode, Lua\*(TX is exactly

#

Split lines longer than 100 characters into two or more lines with '\'.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

luatex.1: line 11   length 129
luatex, dviluatex, luahbtex, luajittex, texlua, texluac \- An extended version 
of TeX using Lua as an embedded scripting language

#

Do not use "\s0" but an absolute number, as the size of the string could
be changed.

8:.if t .ds WB W\s-2EB\s0

#

--- luatex.12023-06-14 04:02:56.0 +
+++ luatex.1.new2023-06-14 04:23:51.0 +
@@ -5,10 +5,11 @@
 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
 .if n .ds TX TeX
 .if n .ds WB Web
-.if t .ds WB W\s-2EB\s0
+.if t .ds WB W\s-2EB\s+2
 .\"=
 .SH NAME
-luatex, dviluatex, luahbtex, luajittex, texlua, texluac \- An extended version 
of TeX using Lua as an embedded scripting language
+luatex, dviluatex, luahbtex, luajittex, texlua, texluac \- \
+An extended version of TeX using Lua as an embedded scripting language
 .\"=
 .SH SYNOPSIS
 .B luatex
@@ -44,8 +45,9 @@ interpret all non\-option arguments as a
 
 Alternatively, if the first non\-option argument begins with a \fB&\fR,
 the
-next word is taken as the \fIFMT\fR to read, overriding all else. Any
-remaining arguments are processed as above.
+next word is taken as the \fIFMT\fR to read,
+overriding all else.
+Any remaining arguments are processed as above.
 
 If no arguments or options are specified, prompt for input.
 
@@ -68,7 +70,7 @@ the \*(TX engine.
 In \fIPDF\fR mode, Lua\*(TX can natively handle the \fIPDF\fR, \fIJPG\fR,
 \fIJBIG2\fR, and \fIPNG\fR graphics formats.  Lua\*(TX cannot include
 PostScript or Encapsulated PostScript (EPS) graphics files; first convert
-them to PDF using \fBepstopdf\fR (1).
+them to PDF using \fBepstopdf\fR(1).
 
 The luajittex variant includes the Lua just-in-time compiler.
 
@@ -79,11 +81,14 @@ instead of Lua\*(TX's built-in shaper.
 .SH "OPTIONS"
 When the Lua\*(TX executable starts, it looks for the \fB\-\-lua\fR
 command-line option.
-If there is no \fB\-\-lua\fR option, the command line is interpreted in a
-similar fashion as in traditional pdf\*(TX and Aleph. But if the option
-is present, Lua\*(TX will enter an alternative mode of command-line parsing
-in comparison to the standard web2c programs. The presence of \fB--lua\fR
-makes most of other options unreliable, because the lua initialization
+If there is no \fB\-\-lua\fR option,
+the command line is interpreted in a
+similar fashion as in traditional pdf\*(TX and Aleph.
+But if the option is present,
+Lua\*(TX will enter an alternative mode of command-line parsing
+in comparison to the standard web2c programs.
+The presence of \fB\-\-lua\fR makes most of other options unreliable,
+because the lua initialization
 file can disable kpathsea and/or hook functions into various callbacks.
 .ig
 Here is the list of possibly affected switches/functionality, and why:
@@ -95,16 +100,21 @@ The lua initialization file.
 The following two options alter the executable behaviour:
 .TP
 .B \-\-luaonly
-Start Lua\*(TX as a Lua interpreter.