Package: mutt
Version: 2.2.13-1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-][gn]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':97
troff:<stdin>:97: 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.10.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 mutt depends on:
ii libc6 2.40-2
ii libgnutls30t64 3.8.6-2
ii libgpg-error0 1.50-4
ii libgpgme11t64 1.18.0-6+b1
ii libgsasl18 2.2.1-1+b1
ii libgssapi-krb5-2 1.21.3-3
ii libidn2-0 2.3.7-2
ii libncursesw6 6.5-2
ii libtinfo6 6.5-2
ii libtokyocabinet9t64 1.4.48-15.1
ii zlib1g 1:1.3.dfsg+really1.3.1-1
Versions of packages mutt recommends:
ii locales 2.40-2
ii mailcap 3.72
ii sensible-utils 0.0.24
Versions of packages mutt suggests:
ii aspell 0.60.8.1-1+b1
ii ca-certificates 20240203
ii exim4-daemon-light [mail-transport-agent] 4.98-1
ii gnupg 2.2.43-8
ii ispell 3.4.06-1
ii openssl 3.3.2-1
pn urlview <none>
Versions of packages mutt is related to:
ii mutt 2.2.13-1
-- no debconf information
Any program (person), that produces man pages, should check the output for
defects by using
[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 outputs 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 mutt.1": (possibly shortened list)
mandoc: mutt.1:81:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mutt.1:82:87: STYLE: input text line longer than 80 bytes: Mutt is a
small but ...
mandoc: mutt.1:89:88: STYLE: input text line longer than 80 bytes: A copy of
the full m...
mandoc: mutt.1:270:81: STYLE: input text line longer than 80 bytes: Log files
are automa...
mandoc: mutt.1:291:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mutt.1:294:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mutt.1:315:2: WARNING: skipping paragraph macro: PP after SH
mandoc: mutt.1:337:2: WARNING: skipping paragraph macro: PP after SH
-.-.
Change - to \- if it shall be printed as a minus sign.
mutt.1:121:\fILevel\fP can range from -5 to 5 and affects verbosity. A value of
mutt.1:124:(-2) is recommended for most diagnosis.
-.-.
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.
131:specified by \fB-i\fP during message composition.
-.-.
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.
121:\fILevel\fP can range from -5 to 5 and affects verbosity. A value of
122:zero disables debugging. A value less than zero disables automatic log
123:file rotation; the log level is then its absolute value. A value of 2
-.-.
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 82, length 87
Mutt is a small but very powerful text based program for reading and sending
electronic
Line 89, length 88
A copy of the full manual is located in \fI/usr/share/doc/mutt\fP, in text,
HTML, and/or
Line 270, length 81
Log files are automatically rotated by \fBmutt\fP changing the number at the
end.
-.-.
FSF office address update. See
https://lists.gnu.org/archive/html/bug-gnulib/2024-09/msg00004.html
18:.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':97
troff:<stdin>:97: warning: trailing space in the line
-.-.
Additionally:
The web address "https://tools.ietf.org/rfcmarkup/5322"; is outdated.
-,-
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them as
such and not as an end of sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
--- mutt.1 2024-09-28 21:45:42.360470534 +0000
+++ mutt.1.new 2024-09-28 22:02:10.959876756 +0000
@@ -78,23 +78,23 @@ mutt \- The Mutt Mail User Agent
.B mutt
\fB\-D
.SH DESCRIPTION
-.PP
-Mutt is a small but very powerful text based program for reading and sending
electronic
-mail under unix operating systems, including support for color terminals, MIME,
-OpenPGP, and a threaded sorting mode.
+Mutt is a small but very powerful text based program for reading and
+sending electronic mail under unix operating systems,
+including support for color terminals, MIME, OpenPGP,
+and a threaded sorting mode.
.PP
.BR Note :
This manual page gives a brief overview of the \fBmutt\fP executable command
line options.
-A copy of the full manual is located in \fI/usr/share/doc/mutt\fP, in text,
HTML, and/or
-PDF format.
+A copy of the full manual is located in \fI/usr/share/doc/mutt\fP,
+in text, HTML, and/or PDF format.
Please refer to the manual to learn how to use and configure Mutt.
.SH OPTIONS
.TP
.BI \-A " alias"
Print an expanded version of the given \fIalias\fP and exit.
.TP
-.BI \-a " file ... "
+.BI \-a " file ..."
Attach a \fIfile\fP using MIME.
Separating \fIfile\fP and \fIto-addr\fP arguments with \*(lq\fB\-\-\fP\*(rq is
mandatory.
@@ -118,17 +118,18 @@ Specify a carbon copy (CC) address.
.BI \-d " level"
If Mutt was compiled with \fB+DEBUG\fP log debugging output to
\fI~/.muttdebug0\fP.
-\fILevel\fP can range from -5 to 5 and affects verbosity. A value of
-zero disables debugging. A value less than zero disables automatic log
-file rotation; the log level is then its absolute value. A value of 2
-(-2) is recommended for most diagnosis.
+\fILevel\fP can range from \-5 to 5 and affects verbosity.
+A value of zero disables debugging.
+A value less than zero disables automatic log file rotation;
+the log level is then its absolute value.
+A value of 2 (\-2) is recommended for most diagnosis.
.TP
.B \-D
Print the value of all configuration options to stdout.
.TP
.B \-E
Edit the \fIdraft\fP file specified by \fB\-H\fP or \fIinclude\fP file
-specified by \fB-i\fP during message composition.
+specified by \fB\-i\fP during message composition.
.TP
.BI \-e " command"
Specify a configuration \fIcommand\fP to be run after processing of
@@ -267,7 +268,8 @@ Temporary files created by Mutt.
.TP
.I ~/.muttdebug0
File containing debugging output.
-Log files are automatically rotated by \fBmutt\fP changing the number at the
end.
+Log files are automatically rotated by \fBmutt\fP changing the number at the
+end.
See \fB\-d\fP option above.
.TP
.I ~/.mailcap
@@ -288,10 +290,8 @@ The privileged dotlocking program.
.I "/usr/share/doc/mutt/manual.txt.gz"
The Mutt manual.
.SH BUGS
-.PP
None. Mutts have fleas, not bugs.
.SH FLEAS
-.PP
Suspend/resume while editing a file with an external editor does not work
under SunOS 4.x if you use the curses lib in /usr/5lib. It \fIdoes\fP work
with the S-Lang library, however.
@@ -312,7 +312,6 @@ but WITHOUT ANY WARRANTY; without even t
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.SH SEE ALSO
-.PP
.BR mutt_dotlock (1),
.BR mutt_pgpring (1),
.BR pgpewrap (1),
@@ -334,6 +333,5 @@ The Mutt manual
RFC5322 \(em Internet Message Format: https://tools.ietf.org/rfcmarkup/5322
(obsoletes RFC2822 and RFC822)
.SH AUTHOR
-.PP
Michael Elkins, and others.
Use <mutt-...@mutt.org> to contact the developers.
