Package: xmltoman
Version: 0.6-1
Severity: minor
Tags: patch
* 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=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious 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:<stdin>:6: warning: trailing space in the line
* 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.12.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 xmltoman depends on:
ii libxml-parser-perl 2.47-1+b3
xmltoman recommends no packages.
xmltoman suggests no packages.
-- no debconf information
Input file is xmlmantohtml.1
Output from "mandoc -T lint xmlmantohtml.1": (shortened list)
1 input text line longer than 80 bytes: This man page was wr...
1 input text line longer than 80 bytes: You will find the DT...
-.-.
Output from "test-groff -mandoc -t -ww -z xmlmantohtml.1": (shortened list)
1 trailing space in the line
-.-.
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.
Mark a final abbreviation point as such by suffixing it with "\&".
The number of lines affected can be too large to be in a patch.
10:You will find the DTD in \fI/usr/share/xmltoman/\f1 on a Debian GNU/Linux
system. There is also an XSL file to generate HTML using \fBxsltproc(1)\f1.
-.-.
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 10, length 149
You will find the DTD in \fI/usr/share/xmltoman/\f1 on a Debian GNU/Linux
system. There is also an XSL file to generate HTML using \fBxsltproc(1)\f1.
Line 18, length 89
This man page was written using \fBxmltoman(1)\f1 by the same author and / or
maintainer.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:6: warning: trailing space in the line
-.-
Additionally:
Change '\f1' to '\fR'.
--- xmlmantohtml.1 2025-01-27 19:36:01.603958456 +0000
+++ xmlmantohtml.1.new 2025-01-27 19:44:07.588200732 +0000
@@ -2,17 +2,19 @@
.SH NAME
xmlmantohtml \- xml to html converter
.SH SYNOPSIS
-\fBxmlmantohtml \fIfile.1.xml\fB > file.1.html
-\f1
+\fBxmlmantohtml \fIfile.1.xml\fB > file.1.html\fR
.SH DESCRIPTION
xmlmantohtml is a small script to convert XML/MAN(GROFF) to HTML.
-You will find the DTD in \fI/usr/share/xmltoman/\f1 on a Debian GNU/Linux
system. There is also an XSL file to generate HTML using \fBxsltproc(1)\f1.
+You will find the DTD in \fI/usr/share/xmltoman/\fR on a Debian GNU/Linux
+system.
+There is also an XSL file to generate HTML using \fBxsltproc(1)\fR.
.SH AUTHOR
xmltoman was written by Oliver Kurth <o...@masqmail.cx>
.SH MAINTAINER
xmltoman is currently maintained by Adam Bilbrough
.SH SEE ALSO
-\fBxmlmantohtml(1)\f1
+\fBxmlmantohtml(1)\fR
.SH COMMENTS
-This man page was written using \fBxmltoman(1)\f1 by the same author and / or
maintainer.
+This man page was written using \fBxmltoman(1)\fR by the same author
+and / or maintainer.
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
-.-
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.
Not beginning each input sentence on a new line.
Line length should thus be reduced.
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 -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 -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)
-.-
