Bug#1037553: luatex.1: some formatting fixes for the manual
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.1 2023-06-14 04:02:56.000000000 +0000
+++ luatex.1.new 2023-06-14 04:23:51.000000000 +0000
@@ -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. In this mode, it will set Lua's
-\fIarg[0]\fR to the found script name, pushing preceding options in
+Start Lua\*(TX as a Lua interpreter.
+In this mode,
+it will set Lua's \fIarg[0]\fR to the found script name,
+pushing preceding options in
negative values and the rest of the command line in the positive values,
-just like the Lua interpreter. Lua\*(TX will exit immediately after
-executing the specified Lua script.
+just like the Lua interpreter.
+Lua\*(TX will exit immediately after executing the specified Lua script.
.TP
-.BI \-\-luaconly
-Start Lua\*(TX as a Lua byte compiler. In this mode, Lua\*(TX is exactly
-like \fBluac\fR from the standalone Lua distribution, except that it
-does not have the \fB\-l\fR switch, and that it accepts (but ignores)
+.B \-\-luaconly
+Start Lua\*(TX as a Lua byte compiler.
+In this mode,
+Lua\*(TX is exactly
+like \fBluac\fR from the standalone Lua distribution,
+except that it does not have the \fB\-l\fR switch,
+and that it accepts (but ignores)
the \fB\-\-luaconly\fR switch.
.PP
Then the regular web2c options:
@@ -190,7 +200,6 @@ or \fItfm\fR.
.B \-\-nosocket
Disable the luasocket (network) library.
.TP
-.TP
.BI "\-\-output\-comment=" STRING
In \fIDVI\fR mode, use \fISTRING\fR for the \fIDVI\fR file comment
instead of the date. This option is ignored in\fIPDF\fR mode.
-- System Information:
Debian Release: 12.0
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.1.27-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 12.2.0-14
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 12.2.0-14
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.4-2
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: