Package: sensible-utils
Version: 0.0.24
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 ' $' <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:<stdin>:19: 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.6-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 select-editor.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 select-editor.1": (shortened list)
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z select-editor.1": (shortened list)
1 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
1
-.-.
Put a subordinate sentence (after a comma) on a new line.
15:variable in \%\s+3~\s-3/.selected_editor, which is sourced and used by
-.-.
Remove quotes when there is no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
2:.TH SELECT-EDITOR 1 "21 May 2008" "Debian"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:19: warning: trailing space in the line
--- select-editor.1 2025-01-07 21:23:35.276372964 +0000
+++ select-editor.1.new 2025-01-07 21:28:05.038223756 +0000
@@ -1,22 +1,23 @@
.\" -*- nroff -*-
-.TH SELECT-EDITOR 1 "21 May 2008" "Debian"
+.TH SELECT-EDITOR 1 "21 May 2008" Debian
.SH NAME
select-editor \- select your default sensible-editor from all installed editors
.SH SYNOPSIS
.B select-editor
.SH DESCRIPTION
.B select-editor
-provides a coherent mechanism for selecting and storing a preferred
-sensible-editor on a per-user basis.
-It lists the available editors on a system and interactively prompts
-the user to select one.
+provides a coherent mechanism for selecting
+and storing a preferred sensible-editor on a per-user basis.
+It lists the available editors on a system
+and interactively prompts the user to select one.
The results are stored as
.B SELECTED_EDITOR
-variable in \%\s+3~\s-3/.selected_editor, which is sourced and used by
+variable in \%\s+3~\s-3/.selected_editor,
+which is sourced and used by
.BR sensible-editor (1)
command.
\%SELECTED_EDITOR
-variable is overridden by the
+variable is overridden by the
.B VISUAL
and
.B EDITOR
