Bug#1087172: exim_msgdate.8: Some remarks and editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sat Nov 9 10:48:21 GMT 2024
Package: exim4-base
Version: 4.98-2
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: '<stdin>':11: macro 'Vb'
troff: backtrace: file '<stdin>':64
troff:<stdin>:64: warning: font name 'CW' is deprecated
* 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.5-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 exim4-base depends on:
ii adduser 3.137
ii anacron 2.3-40
ii cron [cron-daemon] 3.0pl1-189
ii debconf [debconf-2.0] 1.5.87
ii exim4-config [exim4-config-2] 4.98-2
ii libc6 2.40-3
ii libdb5.3t64 5.3.28+dfsg2-9
ii libfile-fcntllock-perl 0.22-4+b4
ii netbase 6.4
ii perl 5.40.0-6
Versions of packages exim4-base recommends:
pn bsd-mailx | mailx <none>
ii psmisc 23.7-1
Versions of packages exim4-base suggests:
pn exim4-doc-html | exim4-doc-info <none>
pn eximon4 <none>
ii file 1:5.45-3+b1
ii mutt [mail-reader] 2.2.13-1
ii neomutt [mail-reader] 20241002+dfsg-1
ii openssl 3.3.2-2
pn spf-tools-perl <none>
pn swaks <none>
-- debconf information excluded
-------------- next part --------------
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 exim_msgdate.8": (possibly shortened list)
mandoc: exim_msgdate.8:84:90: STYLE: input text line longer than 80 bytes: In each case the 'X'...
mandoc: exim_msgdate.8:162:137: STYLE: input text line longer than 80 bytes: Exim spec.txt chapte...
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
exim_msgdate.8:149: in the local timezone.
-.-.
Find a repeated word
! 156 --> test
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)
162 Exim spec.txt chapter 4 <https://exim.org/exim-html-current/doc/html/spec_html/ch-how_exim_receives_and_delivers_mail.html#SECTmessiden>
-.-.
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.
141:the timer resolution will change (see the Exim Spec. for details).
157:or here the \f(CW\*(C`exim_msgdate\*(C'\fR being tested. Not currently used.
-.-.
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 65, length 89
\& exim_msgdate \- Utility to convert an exim message\-id to a human readable date+time
Line 69, length 88
\&\fBexim_msgdate\fR [ \-u|\-\-unix | \-\-GMT | \-\-z|\-Zulu | \-\-UTC | \-l|\-\-local ]
Line 70, length 81
[ \-\-base 36 | \-\-base 62 | \-\-base36 | \-\-base62 | \-\-b36 | \-\-b62 ]
Line 84, length 90
In each case the 'X's are taken from the base (see below) which depends upon the platform.
Line 142, length 91
\&\f(CW\*(C`Exim_msgdate\*(C'\fR reads the Exim config file (see \-\-C) to find this value,
Line 162, length 136
Exim spec.txt chapter 4 <https://exim.org/exim-html-current/doc/html/spec_html/ch-how_exim_receives_and_delivers_mail.html#SECTmessiden>
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of
a) an option in UTF-8 text
b) web addresses (URL).
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
162:Exim spec.txt chapter 4 <https://exim.org/exim-html-current/doc/html/spec_html/ch-how_exim_receives_and_delivers_mail.html#SECTmessiden>
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '<stdin>':11: macro 'Vb'
troff: backtrace: file '<stdin>':64
troff:<stdin>:64: warning: font name 'CW' is deprecated
-------------- next part --------------
--- exim_msgdate.8 2024-11-09 09:49:02.410581517 +0000
+++ exim_msgdate.8.new 2024-11-09 10:16:54.516096402 +0000
@@ -4,16 +4,25 @@
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
.de Vb \" Begin verbatim text
-.ft CW
+.ie \\n(.g \{\
+. ds prev-font \fP
+. ie t .ftr CW CR
+. el .ftr CW R
+.\}
+.el .ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
-.ft R
+.ie \\n(.g \{\
+. ft \\*[prev-font]
+. rm prev-font
+.\}
+.el .ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
@@ -62,11 +71,12 @@
.nh
.SH NAME
.Vb 1
-\& exim_msgdate \- Utility to convert an exim message\-id to a human readable date+time
+exim_msgdate \- Utility to convert an exim message\-id to a human readable \
+date+time
.Ve
.SH SYNOPSIS
.IX Header "SYNOPSIS"
-\&\fBexim_msgdate\fR [ \-u|\-\-unix | \-\-GMT | \-\-z|\-Zulu | \-\-UTC | \-l|\-\-local ]
+\fBexim_msgdate\fR [ \-u|\-\-unix | \-\-GMT | \-\-z|\-Zulu | \-\-UTC | \-l|\-\-local ]
[ \-\-base 36 | \-\-base 62 | \-\-base36 | \-\-base62 | \-\-b36 | \-\-b62 ]
[ \-\-pid ] [ \-\-debug ] [ \-\-localhost_number ]
[ \-c c<full path to exim cnfig file> ]
@@ -81,7 +91,8 @@ the process id as well.
.SH "Message IDs:"
.IX Header "Message IDs:"
Three exim message ID formats are recognized.
-In each case the 'X's are taken from the base (see below) which depends upon the platform.
+In each case the 'X's are taken from the base (see below) which depends upon
+the platform.
.IP XXXXXX-XXXXXX-XX 4
.IX Item "XXXXXX-XXXXXX-XX"
found in the exim logfile,
@@ -138,25 +149,28 @@ Report the process id as well as the dat
.IX Item "--localhost_number n"
If the Exim configuration option \fBlocalhost_number\fR has been set,
the third and final section of the message-id will include this and
-the timer resolution will change (see the Exim Spec. for details).
-\&\f(CW\*(C`Exim_msgdate\*(C'\fR reads the Exim config file (see \-\-C) to find this value,
+the timer resolution will change (see the Exim Spec.\& for details).
+\&\f(CW\*(C`Exim_msgdate\*(C'\fR reads the Exim config file (see \-\-C) to
+find this value,
but it can be overridden with this option.
.Sp
The value is an integer between 0 and 16, or the value "none" which
means there is no localhost_number.
.Sp
Do not confuse this with the \-\-local option, which displays times
- in the local timezone.
+in the local timezone.
.IP "\fB\-\-C\fR \fBfull path to exim configuration file\fR" 4
.IX Item "--C full path to exim configuration file"
This overrides the usual exim search path.
We set \f(CW\*(C`localhost_number\*(C'\fR from the exim configfile.
.IP \fB\-dexim_path\fR 4
.IX Item "-dexim_path"
-The test test harness passes the full path of the \f(CW\*(C`exim\*(C'\fR binary,
-or here the \f(CW\*(C`exim_msgdate\*(C'\fR being tested. Not currently used.
+The test harness passes the full path of the \f(CW\*(C`exim\*(C'\fR binary,
+or here the \f(CW\*(C`exim_msgdate\*(C'\fR being tested.
+Not currently used.
.SH "SEE ALSO:"
.IX Header "SEE ALSO:"
\&\fBexim\fR\|(8)
.PP
-Exim spec.txt chapter 4 <https://exim.org/exim-html-current/doc/html/spec_html/ch-how_exim_receives_and_delivers_mail.html#SECTmessiden>
+Exim spec.txt chapter 4
+<https://exim.org/exim\-html\-current/\:doc/\:html/\:spec_html/\:ch\-how_exim_receives_and_delivers_mail.html#SECTmessiden>
More information about the Pkg-exim4-maintainers
mailing list