Package: console-setup
Version: 1.234
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>:160: warning: trailing space in the line
troff:<stdin>:420: 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.11-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 console-setup depends on:
ii console-setup-linux 1.234
ii debconf [debconf-2.0] 1.5.89
ii keyboard-configuration 1.234
ii xkb-data 2.42-1
console-setup recommends no packages.
Versions of packages console-setup suggests:
ii locales 2.40-6
ii lsb-base 11.6
ii sysvinit-utils [lsb-base] 3.13-1
Versions of packages keyboard-configuration depends on:
ii debconf [debconf-2.0] 1.5.89
ii liblocale-gettext-perl 1.07-7+b1
ii xkb-data 2.42-1
Versions of packages console-setup-linux depends on:
ii init-system-helpers 1.68
ii initscripts 3.13-1
ii kbd 2.7.1-2
ii keyboard-configuration 1.234
console-setup-linux suggests no packages.
Versions of packages console-setup is related to:
pn console-common <none>
pn console-data <none>
pn console-tools <none>
pn gnome-control-center <none>
ii kbd 2.7.1-2
ii systemd 257.2-3
-- debconf information excluded
Input file is console-setup.5
Output from "mandoc -T lint console-setup.5": (shortened list)
1 input text line longer than 80 bytes: This variable contro...
2 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z console-setup.5": (shortened list)
2 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
2
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
console-setup.5:69:.B /dev/tty[1-6]
console-setup.5:71:.BR /dev/ttyv[0-8] .
-.-.
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.
192:vidcontrol -i mode
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
254:When the screen is in text mode (i.e. framebuffer is not used) then
-.-.
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 "\&".
Too many lines do not begin on a new line.
-.-.
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 163, length 98
.BR Terminus " (sizes " 6x12 ", " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", "
14x28 " and " 16x32 ),
Line 164, length 92
.BR TerminusBold " (sizes " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", " 14x28 "
and " 16x32 ),
Line 228, length 87
This variable controls the style of the system beep on the console. When unset
or when
Line 296, length 152
.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
Line 302, length 97
.BR Fixed " (sizes " 8x15 " and " 8x18 "), " Goha " (all sizes) and "
GohaClassic " (all sizes)."
Line 321, length 104
.BR Fixed " (sizes " 8x13 ", " 8x15 ", " 8x16 " and " 8x18 ") and " VGA "
(sizes " 8x16 " and " 16x32 ).
Line 343, length 152
.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
Line 352, length 152
.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
Line 366, length 152
.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
Line 421, length 101
.BR Lat15 ", " Lat2 ", " Lat7 ", " CyrAsia ", " CyrKoi ", " CyrSlav ", " Greek
", " Uni2 " and " Uni3
-.-.
Use \(en (en-dash) for a dash at the beginning (en) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
console-setup.5:233:.B standard -
console-setup.5:235:.B short -
console-setup.5:237:.B shortest -
console-setup.5:239:.B polite -
console-setup.5:242:.B attention -
console-setup.5:245:.B annoying -
console-setup.5:248:.B off -
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:160: warning: trailing space in the line
troff:<stdin>:420: warning: trailing space in the line
--- console-setup.5 2025-02-08 19:17:48.229004281 +0000
+++ console-setup.5.new 2025-02-08 22:39:57.747988199 +0000
@@ -66,9 +66,9 @@ Specifies the device files in
of the virtual terminals to be configured. File name wild-cards
.RB ( * ",\ " ? )
are allowed. On Linux usually you can set this to
-.B /dev/tty[1-6]
+.B /dev/tty[1\(en6]
and on FreeBSD a sensible value is
-.BR /dev/ttyv[0-8] .
+.BR /dev/ttyv[0\(en8] .
You can assign to this variable also the special value
.BR guess .
It will cause
@@ -157,11 +157,13 @@ codesets.
.TP
.BR FONTFACE " and " FONTSIZE
-Valid font faces are:
+Valid font faces are:
.nh
.BR VGA " (sizes " 8x8 ", " 8x14 ", " 8x16 ", " 16x28 " and " 16x32 ),
-.BR Terminus " (sizes " 6x12 ", " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", "
14x28 " and " 16x32 ),
-.BR TerminusBold " (sizes " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", " 14x28 "
and " 16x32 ),
+.BR Terminus " (sizes " 6x12 ", " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", \
+" 14x28 " and " 16x32 ),
+.BR TerminusBold " (sizes " 8x14 ", " 8x16 ", " 10x20 ", " 12x24 ", " \
+14x28 " and " 16x32 ),
.BR TerminusBoldVGA " (sizes " 8x14 " and " 8x16 ),
and
.BR Fixed " (sizes " 8x13 ", " 8x14 ", " 8x15 ", " 8x16 " and " 8x18 ).
@@ -189,7 +191,7 @@ can run
.in +4n
.nf
-vidcontrol -i mode
+vidcontrol \-i mode
.fi
.in
@@ -225,33 +227,34 @@ resolution can display according to the
.TP
.B BEEP
-This variable controls the style of the system beep on the console. When
unset or when
+This variable controls the style of the system beep on the console.
+When unset or when
.B BEEP=default
no changes to the system beep will be made. Other possible values of
.B BEEP
are:
-.B standard -
+.B standard \(en
set a standard beep;
-.B short -
+.B short \(en
like the standard beep but somewhat shorter;
-.B shortest -
+.B shortest \(en
even more short, suitable when your work generates lots of beeps;
-.B polite -
+.B polite \(en
a very short beep with low frequency, suitable when there are other
people in the room;
-.B attention -
+.B attention \(en
a very long beep, suitable when you want to warn yourself about an
occurring event;
-.B annoying -
+.B annoying \(en
also a long beep, suitable when you want to warn somebody else about
an occurring event; and
-.B off -
+.B off \(en
disable the system beep on the console.
.SH CODESETS
-There are two kinds of codesets \- small (up to 256\ symbols) and big
+There are two kinds of codesets \(en small (up to 256\ symbols) and big
(up to 512\ symbols). Only small codesets can be used on FreeBSD.
-When the screen is in text mode (i.e. framebuffer is not used) then
+When the screen is in text mode (i.e., framebuffer is not used) then
fonts covering big codesets will reduce the number of available
foreground colors.
@@ -293,13 +296,16 @@ Russian, Serbian and Ukrainian. For Ser
Latin alphabets are supported.
.P
Completely covered by the following font faces:
-.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
+.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all \
+sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " \
+16x32 ).
.SS Ethiopian (a big codeset)
Supports Amharic, Ethiopic (Geez), Tigre and Tigrinya.
.P
This codeset is partially covered by the following font faces:
-.BR Fixed " (sizes " 8x15 " and " 8x18 "), " Goha " (all sizes) and "
GohaClassic " (all sizes)."
+.BR Fixed " (sizes " 8x15 " and " 8x18 "), " Goha " (all sizes) and " \
+GohaClassic " (all sizes)."
.SS Georgian
Supported language: Georgian.
@@ -318,7 +324,8 @@ Completely covered by the following font
Supported languages: Hebrew and Yiddish.
.P
Completely covered by the following font faces:
-.BR Fixed " (sizes " 8x13 ", " 8x15 ", " 8x16 " and " 8x18 ") and " VGA "
(sizes " 8x16 " and " 16x32 ).
+.BR Fixed " (sizes " 8x13 ", " 8x15 ", " 8x16 " and " 8x18 ") and " VGA " \
+(sizes " 8x16 " and " 16x32 ).
.SS Lao
Supported languages: Lao.
@@ -340,7 +347,9 @@ Swedish, Tswana, Turkish, Volapuk, Votic
Zulu.
.P
Completely covered by the following font faces:
-.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
+.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all \
+sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " \
+16x32 ).
.SS Lat2
Covers entirely ISO-8859-2. The Euro sign and the Romanian letters
@@ -349,7 +358,9 @@ Latin2 languages \- Bosnian, Croatian, C
Romanian, Slovak, Slovenian and Sorbian (lower and upper).
.P
Completely covered by the following font faces:
-.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
+.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all \
+sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " \
+16x32 ).
.SS Lat38
Covers entirely ISO-8859-3 and ISO-8859-14. Suitable for Chichewa
@@ -363,7 +374,9 @@ Covers entirely ISO-8859-13. Suitable f
and Marshallese.
.P
Completely covered by the following font faces:
-.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all
sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " 16x32 ).
+.BR Fixed " (all sizes), " Terminus " (all sizes), " TerminusBold " (all \
+sizes), " TerminusBoldVGA " (all sizes), " VGA " (sizes " 8x16 " and " \
+16x32 ).
.SS Thai
Supported language: Thai.
@@ -417,8 +430,9 @@ usually installed in
.SH NOTES
The aim of the Terminus font is to reduce the eyes-fatigue when one
has to read a lot. Currently this font supports only the Latin, the
-Cyrillic and the Greek scripts (the
-.BR Lat15 ", " Lat2 ", " Lat7 ", " CyrAsia ", " CyrKoi ", " CyrSlav ", " Greek
", " Uni2 " and " Uni3
+Cyrillic and the Greek scripts (the
+.BR Lat15 ", " Lat2 ", " Lat7 ", " CyrAsia ", " CyrKoi ", " CyrSlav ", " \
+Greek ", " Uni2 " and " Uni3
codesets).
.P
The fonts with font face
@@ -436,4 +450,3 @@ can be used in all video modes.
.BR keyboard (5),
.BR setfont (8),
.BR vidcontrol (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
-.-
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 -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)
-.-
