Package: texlive-extra-utils
Version: 2024.20241115-1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: empty left operand to '/' operator
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: expected numeric expression, got character ')'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: expected numeric expression, got character 'n'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':29
troff:<stdin>:29: warning: expected numeric expression, got character 'm'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: expected numeric expression, got character 'c'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: expected numeric expression, got character 'n'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':35
troff:<stdin>:35: warning: expected numeric expression, got character 'p'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':37
troff:<stdin>:37: warning: expected numeric expression, got character 'v'
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: warning: font name 'C' is deprecated
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':40
troff:<stdin>:40: warning: expected numeric expression, got character 's'
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.11.10-amd64 (SMP w/2 CPU threads; PREEMPT)
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-extra-utils depends on:
ii libfile-homedir-perl 1.006-2
ii libunicode-linebreak-perl 0.0.20190101-1+b8
ii libyaml-tiny-perl 1.74-1
ii python3 3.12.6-1
ii tex-common 6.18
ii texlive-base 2024.20241115-1
ii texlive-binaries 2024.20240313.70630+ds-5
ii texlive-latex-base 2024.20241115-1
ii texlive-luatex 2024.20241115-1
ii texlive-plain-generic 2024.20241115-1
Versions of packages texlive-extra-utils recommends:
ii ghostscript 10.04.0~dfsg-1
pn liblog-log4perl-perl <none>
ii ruby 1:3.1+nmu1
ii texlive-latex-recommended 2024.20241115-1
Versions of packages texlive-extra-utils suggests:
pn chktex <none>
pn default-jre-headless <none>
pn dvidvi <none>
pn dvipng <none>
pn fragmaster <none>
pn lacheck <none>
pn latexdiff <none>
pn latexmk <none>
pn purifyeps <none>
pn xindy <none>
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-extra-utils is related to:
ii tex-common 6.18
ii texlive-binaries 2024.20240313.70630+ds-5
-- no debconf information
Input file is arara.1
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output of 'diff -u' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint arara.1 ": (shortened list)
1 input text line longer than 80 bytes
-.-.
Output from "test-groff -mandoc -t -ww -b -z arara.1 ": (shortened list)
1 empty left operand to '/' operator
1 expected numeric expression, got character ')'
1 expected numeric expression, got character 'c'
1 expected numeric expression, got character 'm'
2 expected numeric expression, got character 'n'
1 expected numeric expression, got character 'p'
1 expected numeric expression, got character 's'
1 expected numeric expression, got character 'v'
1 font name 'C' is deprecated
-.-.
Output from "mandoc -T lint arara.1 ":
mandoc: arara.1:12:81: STYLE: input text line longer than 80 bytes: writers.
Users might...
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (begin of an option or end of options) then use
"\-\-".
arara.1:17:.IP \fB--log\fP
arara.1:19:.IP \fB--verbose\fP / \fB--silent\fP
arara.1:21:.IP \fB--dry-run\fP
arara.1:23:.IP \fB--safe-run\fP
arara.1:25:.IP \fB--whole-file\fP
arara.1:27:.IP \fB--preamble\fP name
arara.1:29:.IP \fB--timeout\fP milliseconds
arara.1:31:.IP \fB--language\fP code
arara.1:33:.IP \fB--max-loops\fP number
arara.1:35:.IP \fB--working-directory\fP path
arara.1:37:.IP \fB--call-property\fP value
arara.1:40:.IP \fB--generate-completion\fP shell
arara.1:42:.IP \fB--version\fP
arara.1:44:.IP \fB--help\fP
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
48:.UR https://gitlab.com/islandoftex/arara/-/issues
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
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.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
9:\fBarara\fP is a TeX automation tool based on rules and directives. It gives
10:you a way to enhance your TeX experience. The tool is an effort to provide a
12:writers. Users might write their own rules when the provided ones do not
suffice.
14:arara takes a list of documents as input. They will be processed according
15:to their directives. Options apply to the execution of all documents.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 12, length 81
writers. Users might write their own rules when the provided ones do not
suffice.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: empty left operand to '/' operator
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: expected numeric expression, got character ')'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: expected numeric expression, got character 'n'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':29
troff:<stdin>:29: warning: expected numeric expression, got character 'm'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: expected numeric expression, got character 'c'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: expected numeric expression, got character 'n'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':35
troff:<stdin>:35: warning: expected numeric expression, got character 'p'
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':37
troff:<stdin>:37: warning: expected numeric expression, got character 'v'
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: warning: font name 'C' is deprecated
troff: backtrace: 'an.tmac':604
troff: backtrace: 'an.tmac':583: macro 'TP'
troff: backtrace: 'an.tmac':604: macro 'IP'
troff: backtrace: file '<stdin>':40
troff:<stdin>:40: warning: expected numeric expression, got character 's'
-.-
Additional:
Change font 'C' to 'CR'.
--- arara.1 2024-11-30 02:15:21.760176862 +0000
+++ arara.1.new 2024-11-30 02:39:29.782119021 +0000
@@ -6,44 +6,48 @@ arara \- a TeX automation tool based on
.RI [ options ]
.IR documents ...
.SH DESCRIPTION
-\fBarara\fP is a TeX automation tool based on rules and directives. It gives
-you a way to enhance your TeX experience. The tool is an effort to provide a
-concise way to automate the daily TeX workflow for users and also package
-writers. Users might write their own rules when the provided ones do not
suffice.
+\fBarara\fP is a TeX automation tool based on rules and directives.
+It gives you a way to enhance your TeX experience.
+The tool is an effort to provide a concise way to automate the daily TeX
+workflow for users and also package writers.
+Users might write their own rules
+when the provided ones do not suffice.
.PP
-arara takes a list of documents as input. They will be processed according
-to their directives. Options apply to the execution of all documents.
+arara takes a list of documents as input.
+They will be processed according to their directives.
+Options apply to the execution of all documents.
.SH OPTIONS
-.IP \fB--log\fP
+.IP \fB\-\-log\fP
Generate a log output.
-.IP \fB--verbose\fP / \fB--silent\fP
+.IP "\fB\-\-verbose\fP / \fB\-\-silent\fP
Print or suppress command output.
-.IP \fB--dry-run\fP
-Go through all the motions of running a command but with no actual calls.
-.IP \fB--safe-run\fP
+.IP \fB\-\-dry-run\fP
+Go through all the motions of running a command
+but with no actual calls.
+.IP \fB\-\-safe-run\fP
Run in safe mode and disable potentially harmful features.
-.IP \fB--whole-file\fP
+.IP \fB\-\-whole-file\fP
Extract directives in the file, not only in the header.
-.IP \fB--preamble\fP name
+.IP "\fB\-\-preamble\fP name
Set the file preamble as named based on the configuration file.
-.IP \fB--timeout\fP milliseconds
+.IP "\fB\-\-timeout\fP milliseconds
Sets an execution timeout for spawned processes.
-.IP \fB--language\fP code
+.IP "\fB\-\-language\fP code
Set the localization to the language specified by code.
-.IP \fB--max-loops\fP number
+.IP "\fB\-\-max-loops\fP number
Set the number > 0 of loops for looping directives.
-.IP \fB--working-directory\fP path
+.IP "\fB\-\-working-directory\fP path
Set the working directory for the whole execution.
-.IP \fB--call-property\fP value
-Pass a property as \fCkey=value\fP parameter into the application
+.IP "\fB\-\-call-property\fP value
+Pass a property as \f(CRkey=value\fP parameter into the application
to be used within the session.
-.IP \fB--generate-completion\fP shell
+.IP "\fB\-\-generate-completion\fP shell
Generate a completion script for arara.
-.IP \fB--version\fP
+.IP \fB\-\-version\fP
Show the version and exit.
-.IP \fB--help\fP
+.IP \fB\-\-help\fP
Show a help message and exit.
.SH BUGS
Issue tracker at
-.UR https://gitlab.com/islandoftex/arara/-/issues
+.UR https://gitlab.com/islandoftex/arara/\-/issues
.UE .
