Package: ncurses-doc
Version: 6.5-2
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>:386: 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)
-- no debconf information
Input file is getch.3ncurses
Output from "mandoc -T lint getch.3ncurses": (shortened list)
1 input text line longer than 80 bytes: with \fB\%echo\fP(3N...
-.-.
Output from "test-groff -mandoc -t -ww -z getch.3ncurses": (shortened list)
1 trailing space in the line
-.-.
Find a repeated word
! 413 --> with
-.-.
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 540, length 90
with \fB\%echo\fP(3NCURSES) and neither \fB\%cbreak\fP(3NCURSES) nor
\fB\%raw\fP(3NCURSES)
-.-
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
getch.3ncurses:60:get (or push back) characters from \fIcurses\fR terminal
keyboard
-.-
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:386: warning: trailing space in the line
-.-.
Additionally:
Put data, that is wider than the header in a centered last column, in a
'T{...\nT}' block.
Generally:
Tables:
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.
--- getch.3ncurses 2025-01-31 02:51:48.898127431 +0000
+++ getch.3ncurses.new 2025-01-31 03:13:40.202734914 +0000
@@ -57,7 +57,9 @@
\fB\%mvwgetch\fP,
\fB\%ungetch\fP,
\fB\%has_key\fP \-
-get (or push back) characters from \fIcurses\fR terminal keyboard
+get
+(or push back)
+characters from \fIcurses\fR terminal keyboard
.SH SYNOPSIS
.nf
.B #include <curses.h>
@@ -410,7 +412,7 @@ to indicate that a mouse event is pendin
see \fB\%mouse\fP(3NCURSES).
Receipt of this code requires a window's keypad mode to be enabled,
because to interpret mouse input
-(as with with \fI\%xterm\fP(1)'s mouse prototocol),
+(as with \fI\%xterm\fP(1)'s mouse prototocol),
.I \%ncurses
must read an escape sequence,
as with a function key.
@@ -537,7 +539,9 @@ key stroke.
.PP
Use of
.B \%wgetch
-with \fB\%echo\fP(3NCURSES) and neither \fB\%cbreak\fP(3NCURSES) nor
\fB\%raw\fP(3NCURSES)
+with \fB\%echo\fP(3NCURSES)
+and neither \fB\%cbreak\fP(3NCURSES)
+nor \fB\%raw\fP(3NCURSES)
is not well-defined.
.PP
Historically,
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)
-.-
