Package: aspell
Version: 0.60.8.1-1+b2
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -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: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':324
troff:<stdin>:324: 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.11.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 aspell depends on:
ii dictionaries-common 1.30.2
ii libaspell15 0.60.8.1-1+b2
ii libc6 2.40-3
ii libncursesw6 6.5-2+b1
ii libstdc++6 14.2.0-8
ii libtinfo6 6.5-2+b1
Versions of packages aspell recommends:
ii aspell-de [aspell-dictionary] 20161207-14
ii aspell-en [aspell-dictionary] 2020.12.07-0-1
ii aspell-is [aspell-dictionary] 0.51.1-0-2
Versions of packages aspell suggests:
pn aspell-doc <none>
pn spellutils <none>
-- no debconf information
Input file is aspell.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 aspell.1 ": (shortened list)
3 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z aspell.1 ": (shortened list)
3 trailing space in the line
-.-.
Output from "mandoc -T lint aspell.1 ":
mandoc: aspell.1:24:17: STYLE: whitespace at end of input line
mandoc: aspell.1:26:51: STYLE: whitespace at end of input line
mandoc: aspell.1:324:6: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
24:Aspell Utility.
26:This manual page is maintained separately from the
324:where
-.-.
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 95, length 85
\fBdump\fR|\fBcreate\fR|\fBmerge master\fR|\fBpersonal\fR|\fBrepl\fR
\fI<wordlist>\fR
Line 170, length 84
\fB\-\-add\-filter\-path=\fR\fI<paths>\fR,
\fB\-\-rem\-filter\-path=\fR\fI<paths>\fR
Line 209, length 82
\fB\-\-add\-tex\-command=\fR\fI<list>\fR,
\fB\-\-rem\-tex\-command=\fR\fI<list>\fR
Line 212, length 88
\fB\-\-add\-texinfo\-ignore=\fR\fI<list>\fR,
\fB\-\-rem\-texinfo\-ignore=\fR\fI<list>\fR
Line 215, length 98
\fB\-\-add\-texinfo\-ignore\-env=\fR\fI<list>\fR,
\fB\-\-rem\-texinfo\-ignore\-env=\fR\fI<list>\fR
Line 221, length 96
\fB\-\-add\-context\-delimiters=\fR\fI<list>\fR,
\fB\-\-rem\-context\-delimiters=\fR\fI<list>\fR
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
aspell.1:89:\fBnorm\fR (\fI<norm\-map>\fR|\fI<from> <norm\-map> <to>\fR)
[\fI<norm-form>\fR]
aspell.1:313:directory (or another file specified by option
\fI\-\-per\-conf\fR) is
-.-.
Two or more space charaters between printable characters.
When the distance is between sentences,
start the beginning of the second one on a separate line
("semantic newline", see man-pages(7)).
18:spell checking to simple library calls. The default library does not
19:contain dictionary word lists. To add language dictionaries, please
27:official documentation so it may be out of date or incomplete. The
28:official documentation is maintained as a Texinfo manual. See the
38:Send a brief Aspell Utility usage message to standard output. This is
42:Send a detailed Aspell Utility help message to standard output. This is
102:Base name of the dictionary to use. If this option is specified then
109:Language to use. It follows the same format of the LANG environmental
110:variable on most systems. It consists of the two letter ISO 639 language
112:underscore. The default value is based on the value of the LC_MESSAGES
116:The preferred size of the dictionary word list. This consists of a two
127:better choice. \fIjargon\fR will be removed in the future.
174:Sets the filter mode. \fIMode\fR is one of none, url, email, html, tex
175:or nroff. The alternative shortcut options are '\-e' for email, '\-H'
179:encoding the document is expected to be in. The default depends on the
189:Add or remove a list of HTML attributes to always check. For example,
238:Main configuration file. This file overrides Aspell's global defaults.
247:Use this keyboard layout for suggesting possible words. These spelling
252:Alternative location of language data files. This directory is searched
259:Personal configuration file. This file overrides options found in the
269:to file name. This only applies when the command is
292:Suggest possible replacements in pipe mode. If false, Aspell will simply
300:options so that it can function as a drop in replacement for Ispell. If
305:that you do not need to specify them each time at the command line. The
327:dashes. For example the following line will set the default language to
336:name and the value. Comments may also be included by preceding them
337:with a '#' as anything from a '#' to a newline is ignored. Blank lines
338:are also allowed. The \fI/etc/aspell.conf\fR file is a good example of
346:Aspell is fully documented in its Texinfo manual. See the
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':324
troff:<stdin>:324: warning: trailing space in the line
-.-
Additional:
Set '[' and ']' in roman type.
--- aspell.1 2024-12-01 22:21:20.226361325 +0000
+++ aspell.1.new 2024-12-01 22:42:57.409906144 +0000
@@ -3,7 +3,7 @@
aspell \- interactive spell checker
.SH SYNOPSIS
.B aspell
-.I "[options] <command>"
+.RI [ options ] " <command>
.SH "DESCRIPTION"
.B aspell
is a utility program that connects to the Aspell library so that it can
@@ -21,9 +21,9 @@ check your distro first for modified dic
for base language dictionaries <http://aspell.net>.
.PP
The following information describes the commands and options used by the
-Aspell Utility.
+Aspell Utility.
.PP
-This manual page is maintained separately from the
+This manual page is maintained separately from the
official documentation so it may be out of date or incomplete. The
official documentation is maintained as a Texinfo manual. See the
.RB "`\|" aspell "\|'"
@@ -86,13 +86,15 @@ one encoding
.I <to>
another.
.TP
-\fBnorm\fR (\fI<norm\-map>\fR|\fI<from> <norm\-map> <to>\fR)
[\fI<norm-form>\fR]
+\fBnorm\fR (\fI<norm\-map>\fR|\fI<from> <norm\-map> <to>\fR) \
+[\fI<norm-form>\fR]
Perform Unicode normalization.
.TP
[\fBdump\fR] \fBdicts\fR|\fBfilters\fR|\fBmodes\fR
Lists available dictionaries, filters, or modes.
.TP
-\fBdump\fR|\fBcreate\fR|\fBmerge master\fR|\fBpersonal\fR|\fBrepl\fR
\fI<wordlist>\fR
+\fBdump\fR|\fBcreate\fR|\fBmerge master\fR|\fBpersonal\fR|\fBrepl\fR \
+\fI<wordlist>\fR
dump, create, or merge a master, personal, or replacement word list.
.SH DICTIONARY OPTIONS
The following options may be used to control which dictionaries to use
@@ -167,7 +169,8 @@ These options modify the behavior of the
\fB\-\-add\-filter=\fR\fI<list>\fR, \fB\-\-rem\-filter=\fR\fI<list>\fR
Add or remove a filter.
.TP
-\fB\-\-add\-filter\-path=\fR\fI<paths>\fR,
\fB\-\-rem\-filter\-path=\fR\fI<paths>\fR
+\fB\-\-add\-filter\-path=\fR\fI<paths>\fR, \
+\fB\-\-rem\-filter\-path=\fR\fI<paths>\fR
Add or remove paths searched for filters.
.TP
\fB\-\-mode=\fR\fI<string>\fR, \fB\-e\fR, \fB\-H\fR, \fB\-t\fR, \fB\-n\fR
@@ -206,19 +209,23 @@ SGML file extensions.
\fB\-\-tex\-check\-comments\fR, \fB\-\-dont\-tex\-check\-comments\fR
Check TeX comments.
.TP
-\fB\-\-add\-tex\-command=\fR\fI<list>\fR,
\fB\-\-rem\-tex\-command=\fR\fI<list>\fR
+\fB\-\-add\-tex\-command=\fR\fI<list>\fR, \
+\fB\-\-rem\-tex\-command=\fR\fI<list>\fR
Add or remove a list of TeX commands.
.TP
-\fB\-\-add\-texinfo\-ignore=\fR\fI<list>\fR,
\fB\-\-rem\-texinfo\-ignore=\fR\fI<list>\fR
+\fB\-\-add\-texinfo\-ignore=\fR\fI<list>\fR, \
+\fB\-\-rem\-texinfo\-ignore=\fR\fI<list>\fR
Add or remove a list of Texinfo commands.
.TP
-\fB\-\-add\-texinfo\-ignore\-env=\fR\fI<list>\fR,
\fB\-\-rem\-texinfo\-ignore\-env=\fR\fI<list>\fR
+\fB\-\-add\-texinfo\-ignore\-env=\fR\fI<list>\fR, \
+\fB\-\-rem\-texinfo\-ignore\-env=\fR\fI<list>\fR
Add or remove a list of Texinfo environments to ignore.
.TP
\fB\-\-context\-visible\-first, \fB\-\-dont\-context\-visible\-first
Switch the context which should be visible to Aspell.
.TP
-\fB\-\-add\-context\-delimiters=\fR\fI<list>\fR,
\fB\-\-rem\-context\-delimiters=\fR\fI<list>\fR
+\fB\-\-add\-context\-delimiters=\fR\fI<list>\fR, \
+\fB\-\-rem\-context\-delimiters=\fR\fI<list>\fR
Add or remove pairs of delimiters.
.SH RUN\-TOGETHER WORD OPTIONS
These may be used to control the behavior of run\-together words.
@@ -310,18 +317,20 @@ The default per user configuration file
.I "\%\(ti/.aspell.conf"
located in the
.B "$HOME"
-directory (or another file specified by option \fI\-\-per\-conf\fR) is
-checked next and overrides options set in the global config file.
+directory
+(or another file specified by option \fI\-\-per\-conf\fR)
+is checked next and overrides options set in the global config file.
Options specified at either the command line or via an environmental
variable override those specified by either configuration file.
.PP
Each line of the configuration file has the format:
.PP
.RS
-\fBoption\fR \fI[value]\fR
+\fBoption\fR
+.RI [ value ]
.RE
.PP
-where
+where
.B option
is any one of the standard library options above without the leading
dashes. For example the following line will set the default language to
