[[email protected]: arara.1: Some remarks and a patch with editorial changes for this man page]
Bjarni Ingi Gislason <[email protected]> Tue, 19 May 2026 23:15:28 +0000
| Newsgroups | gmane.linux.debian.devel.tetex |
|---|---|
| Message-ID | <[email protected]> |
Additional remarks: Mails from me to "[email protected]" are no longer acknowledged. A Debian maintainer told me, that he would contact the mail administrator about me not wanting to send bugs upstream. ----- Forwarded message from Bjarni Ingi Gislason <[email protected]> ----- Date: Mon, 18 May 2026 02:14:12 +0000 From: Bjarni Ingi Gislason <[email protected]> To: Debian Bug Tracking System <[email protected]> Subject: arara.1: Some remarks and a patch with editorial changes for this man page X-Mailer: reportbug 13.2.0 Package: texlive-extra-utils Version: 2026.20260328-5 Severity: normal Tags: patch upstream Dear Maintainer, >From "/usr/share/doc/debian/bug-reporting.txt.gz": Don't file bugs upstream If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream. -.- For forwarding bug reports to upstream see: https://www.debian.org/Bugs/Developer#forward -.- "Handling bug reports" in http://people.debian.org/~enrico/dcg/ch03s02.html -.- I do not send reports upstream if I have to get an account there. The Debian maintainers have one already. If I get a negative (or no) response from upstream, I send henceforth bugs to Debian. -.- * What led up to the situation? Checking for defects with a new version test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z < "man page" [Use grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file> to find (most) 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? Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ": troff:<stdin>:19: warning: empty left operand to '/' operator [-w syntax] troff:<stdin>:19: error: ignoring invalid numeric expression containing character ')' troff:<stdin>:27: error: ignoring invalid numeric expression containing character 'n' troff:<stdin>:29: error: ignoring invalid numeric expression containing character 'm' troff:<stdin>:31: error: ignoring invalid numeric expression containing character 'c' troff:<stdin>:33: error: ignoring invalid numeric expression containing character 'n' troff:<stdin>:35: error: ignoring invalid numeric expression containing character 'p' troff:<stdin>:37: error: ignoring invalid numeric expression containing character 'v' troff:<stdin>:40: error: ignoring invalid numeric expression containing character 'v' troff:<stdin>:42: error: ignoring invalid numeric expression containing 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: forky/sid APT prefers testing APT policy: (500, 'testing') Architecture: amd64 (x86_64) Kernel: Linux 7.0.4+deb14-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-3 ii libyaml-tiny-perl 1.76-1 ii python3 3.13.9-3 ii tex-common 6.20 ii texlive-base 2026.20260328-4 ii texlive-binaries 2026.20260303.78225+ds-3 ii texlive-latex-base 2026.20260328-4 ii texlive-luatex 2026.20260328-4 ii texlive-plain-generic 2026.20260328-5 Versions of packages texlive-extra-utils recommends: ii ghostscript 10.07.0~dfsg-2 pn liblog-log4perl-perl <none> ii ruby 1:3.3+b1 ii texlive-latex-recommended 2026.20260328-4 Versions of packages texlive-extra-utils suggests: pn chktex <none> pn default-jre-headless <none> pn dvipng <none> pn fragmaster <none> pn lacheck <none> pn latexdiff <none> pn latexmk <none> pn purifyeps <none> ii texlive-binaries [dvidvi] 2026.20260303.78225+ds-3 pn xindy <none> Versions of packages tex-common depends on: ii bzip2 1.0.8-6+b2 ii ucf 3.0053 Versions of packages tex-common suggests: pn debhelper <none> Versions of packages texlive-extra-utils is related to: ii tex-common 6.20 ii texlive-binaries 2026.20260303.78225+ds-3 -- no debconf information Input file is arara.1 Output from "mandoc -T lint arara.1": (shortened list) 1 STYLE: input text line longer than 80 bytes: -.-. Output from test-nroff -mandoc -t -Kutf8 -ww -z arara.1: (shortened list) 1 empty left operand to '/' operator [-w syntax] 1 ignoring invalid numeric expression containing character ')' 1 ignoring invalid numeric expression containing character 'c' 1 ignoring invalid numeric expression containing character 'm' 2 ignoring invalid numeric expression containing character 'n' 1 ignoring invalid numeric expression containing character 'p' 1 ignoring invalid numeric expression containing character 's' 2 ignoring invalid numeric expression containing character 'v' -.-. 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. 17:.IP \fB--log\fP 19:.IP \fB--verbose\fP / \fB--silent\fP 21:.IP \fB--dry-run\fP 23:.IP \fB--safe-run\fP 25:.IP \fB--whole-file\fP 27:.IP \fB--preamble\fP name 29:.IP \fB--timeout\fP milliseconds 31:.IP \fB--language\fP code 33:.IP \fB--max-loops\fP number 35:.IP \fB--working-directory\fP path 37:.IP \fB--call-property\fP value 40:.IP \fB--properties-file\fP value 42:.IP \fB--generate-completion\fP shell 44:.IP \fB--version\fP 46:.IP \fB--help\fP 50:.UR https://gitlab.com/islandoftex/arara/-/issues -.-. Wrong distance (not two spaces, not a new line character (\n)) 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. Mark a final abbreviation point as such by suffixing it with "\&". Some sentences (etc.) do not begin on a new line. Split (sometimes) lines after a punctuation mark; before a conjunction. Lines with only one (or two) space(s) between sentences could be split, so latter sentences begin on a new line. Use #!/usr/bin/sh sed -e '/^\./n' \ -e 's/\([[:alpha:]]\)\. */\1.\n/g' $1 to split lines after a sentence period. Check result with the difference between the formatted outputs. See also the attachment "general.bugs" 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. -.-. Remove quotes when there is a printable but no space character between them and the quotes are not for emphasis (markup), for example as an argument to a macro. arara.1:1:.TH ARARA 1 "30 June 2025" "v7.2.0" -.-. Use "\-" instead of "-" (rendered as a hyphen (u2010) in UTF-8 encoding) in web addresses. 50:.UR https://gitlab.com/islandoftex/arara/-/issues -.- Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ": troff:<stdin>:19: warning: empty left operand to '/' operator [-w syntax] troff:<stdin>:19: error: ignoring invalid numeric expression containing character ')' troff:<stdin>:27: error: ignoring invalid numeric expression containing character 'n' troff:<stdin>:29: error: ignoring invalid numeric expression containing character 'm' troff:<stdin>:31: error: ignoring invalid numeric expression containing character 'c' troff:<stdin>:33: error: ignoring invalid numeric expression containing character 'n' troff:<stdin>:35: error: ignoring invalid numeric expression containing character 'p' troff:<stdin>:37: error: ignoring invalid numeric expression containing character 'v' troff:<stdin>:40: error: ignoring invalid numeric expression containing character 'v' troff:<stdin>:42: error: ignoring invalid numeric expression containing character 's' -.- Generally: Split (sometimes) lines after a punctuation mark; before a conjunction. -.- Tables: Use the preprocessor 'tbl' to make tables. Put data, that are wider than the header in the (centered) last column, in a "T{...\nT}" block(, when the table gets wider than the output line). Table headers, that are wider than any data in the corresponding column, do not need to be centered, so left adjustment (l, L) is sufficient. --- arara.1 2026-05-18 01:45:15.865802934 +0000 +++ arara.1.new 2026-05-18 02:01:25.571124157 +0000 @@ -1,4 +1,4 @@ -.TH ARARA 1 "30 June 2025" "v7.2.0" +.TH ARARA 1 "30 June 2025" v7.2.0 .SH NAME arara \- a TeX automation tool based on rules and directives. .SH SYNOPSIS @@ -6,46 +6,46 @@ 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 +\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. +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 +.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\-\-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 +.IP "\fB\-\-call-property\fP value" Pass a property as \fCkey=value\fP parameter into the application to be used within the session. -.IP \fB--properties-file\fP value +.IP "\fB\-\-properties-file\fP value" Pass a properties file to 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 . 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> To find most trailing spaces use grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page> The same goes for man pages that are used as an input. -.- For a style guide use mandoc -T lint -.- For general input conventions consult the man page "nroff(7)" (item "Input conventions") or the Texinfo manual about the same item. -.- Any "autogenerator" should check its products with the above mentioned 'groff', 'mandoc', and additionally with 'nroff ...'. It should also check its input files for too long (> 80) lines. This is just a simple quality control measure. The "autogenerator" may have to be corrected to get a better man page, the source file may, and any additional file may. -.- Common defects: Not removing trailing spaces (in in- and output). The reason for these trailing spaces should be found and eliminated. "git" has a "tool" to point out whitespace, see for example "git-apply(1)" and git-config(1)") -.- Not beginning each input sentence on a new line. Line length and patch size should thus be reduced when that has been fixed. The script "reportbug" uses 'quoted-printable' encoding when a line is longer than 1024 characters in an 'ascii' file. 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 -d -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 from 'diff -d -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) -.- ----- End forwarded message -----