Package: tin
Version: 1:2.6.4-1
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?
an.tmac:<stdin>:3575: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
troff:<stdin>:3780: 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.9-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 tin depends on:
ii debconf [debconf-2.0] 1.5.89
ii libc6 2.40-5
ii libcanlock3 3.3.0-1+b2
ii libgsasl18 2.2.1-1+b2
ii libicu72 72.1-6
ii libidn2-0 2.3.7-2+b1
ii libncursesw6 6.5-2+b1
ii libpcre2-8-0 10.44-5
ii libssl3t64 3.4.0-2
ii libtinfo6 6.5-2+b1
ii liburiparser1 0.9.8+dfsg-2
ii libuu0 0.5.20+20241111-1
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages tin recommends:
ii exim4-daemon-light [mail-transport-agent] 4.98-3
Versions of packages tin suggests:
ii gnupg 2.2.46-1
ii ispell 3.4.06-1
-- debconf information excluded
Input file is tin.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 tin.1": (shortened list)
2 input text line longer than 80 bytes
35 skipping paragraph macro: sp after PP
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z tin.1": (shortened list)
1 Use macro '.I' for one argument or split argument.
1 .IR is for at least 2 arguments, got 1
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
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
3575:.IR /etc/nntpserver
-.-.
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.
3874:the systems default editor (i.e.
-.-.
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.
Mark a final abbreviation point as such by suffixing it with "\&".
N.B.
The number of lines affected can be too large to be in a patch.
55:is a full-screen easy to use Usenet newsreader. It can read news locally
58:NNTPS (\fBRFC\%8143\fP) server. It will automatically utilize NOV
65:Thread level and Article level. Use the \fBHelp\fP ('\fBh\fP')
70:\fI${TIN_HOMEDIR:\-"$HOME"}/.newsrc\fR. An arrow '\(->' or highlighted
71:bar will point to the first newsgroup. Move to a group by using the
73:and \fBUp\fP ('\fBk\fP'). Use PgUp/PgDn (terminal dependent) or
75:(CTRL-D) to page up/down. Enter a newsgroup by pressing '\fB<CR>\fP'.
85:Successful program execution. No unread news available in batch mode.
[...]
4119:versions between 2.6.1 and 2.7.1 (both incl.) may cause \fBtin\fP to hang
4120:and later timeout when posting. This has been fixed in
4122:version 2.7.2. As a workaround simply don't use ''\fB\-C\fP''.
4126:first! Have a look at the doc/TODO file for known bugs. If you still
4128:function and write in English. Please do NOT enclose a core-file in
4140:Kolstad in 1982. For a version overview see
-.-.
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 2261, length 94
\fBNFKC_CF\fP: Compatibility Decomposition, followed by Canonical Composition
and Case Folding
Line 3193, length 102
.ta \w'%G 'uC +\w'\fBselect_format\fP 'uC +\w'\fBgroup_format\fP 'uC
+\w'\fBthread_format\fP'uC
Line 3343, length 107
.ta \w'%G 'uC +\w'\fBattachment_format\fP 'uC +\w'\fBpage_mime_format\fP 'uC
+\w'\fBpage_uue_format\fP'uC
Line 3614, length 94
.I
${TIN_INDEX_NEWSDIR:\-"${TIN_HOMEDIR:\-"$HOME"}/.tin"}/.news${NNTPSERVER:+"\-$NNTPSERVER"}/
Line 3637, length 155
.I
${TIN_HOMEDIR:\-"$HOME"}/.tin/keymap${${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}:+".${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}"}
Line 3639, length 134
.I
/etc/tin/keymap${${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}:+".${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}"}
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
tin.1:57:option) via an NNTP (Network News Transport Protocol, \fBRFC\%3977\fP)
or
tin.1:72:terminal arrow keys (terminal dependent) or \fBDown\fP ('\fBj\fP')
tin.1:73:and \fBUp\fP ('\fBk\fP'). Use PgUp/PgDn (terminal dependent) or
tin.1:91:Unread news available (batch mode (''\fB\-Z\fP'') only).
[...]
tin.1:4073:If \fBtin\fP is started in debug mode (''\fB\-D n\fP'') it will
create
tin.1:4075:like the users NNTP password in cleartext (if running verbose). On
tin.1:4077:starting \fBtin\fP in (verbose) debug mode (e.g., \fBTMPDIR=$HOME
tin \-vD 1\fP).
tin.1:4092:12, Utility Conventions (Utility Argument Syntax, Utility Syntax
Guidelines).
tin.1:4119:versions between 2.6.1 and 2.7.1 (both incl.) may cause \fBtin\fP to
hang
-.-.
Use a hyphen between a number and the unit (name) "bit",
see "man-pages(7)", item "Terms to avoid".
2062:.B Use 8bit characters in mail headers (mail_8bit_header)
2063:Allows 8bit characters unencoded in the header of mail message. Default is
2065:to 8bit. Leaving it OFF is safe for most users and compliant to Internet
2281:.B Use 8bit characters in news headers (post_8bit_header)
2282:Allows 8bit characters unencoded in the header of a news article, if
2285:\fBpost_mime_encoding\fP is also set to 8bit. In a number of local
2286:hierarchies where 8bit characters are used, using unencoded (raw)
2287:8bit characters in header is acceptable and sometimes even
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:3575: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
troff:<stdin>:3780: warning: trailing space in the line
-.-
Use table (tbl).
--- tin.1 2025-01-17 23:23:43.464893146 +0000
+++ tin.1.new 2025-01-18 01:35:53.323537904 +0000
@@ -1,4 +1,4 @@
-.\"
+'\" t
.\" Project : tin - a Usenet newsreader
.\" Module : tin.1
.\" Author : I. Lea, U. Janssen
@@ -134,18 +134,18 @@ below. Use comma to give multiple levels
be performed at startup and on normal termination (that is the files are
only available while tin is running).
.in +.3i
-.nf
-.ta \w'%128 'u +\w'ATTRIBUTES 'u +\w'ATTRIBUTES 'u +\w'ATTRIBUTES'u
-\fI 1 NNTP NNTPS\fP
-\fI 2 FILTER ARTS\fP
-\fI 4 NEWSRC BITMAP\fP
-\fI 8 THREADING REFS\fP
-\fI 16 MEMORY MALLOC\fP
-\fI 32 ATTRIBUTES\fP
-\fI 64 MISC GNKSA ACTIVE\fP
-\fI127 ALL EVERYTHING\fP
-\fI128 REMOVE DELETE\fP
-.fi
+.TS
+rI LI LI LI.
+1 NNTP NNTPS
+2 FILTER ARTS
+4 NEWSRC BITMAP
+8 THREADING REFS
+16 MEMORY MALLOC
+32 ATTRIBUTES
+64 MISC GNKSA ACTIVE
+127 ALL EVERYTHING
+128 REMOVE DELETE
+.TE
.in -0.3i
For NNTP-level ''\fB\-v\fP'' controls the verbosity of the output.
Depending on the debug-level various files may be written to \fI$TMPDIR\fR
@@ -469,7 +469,6 @@ used) looks like this, but can be custom
2 [ 12] +\(-> Sephan Wagner <s
3 [ 230] | `\(->Tin thread-level (was: What is Bob Johnson <bob
4 [ 22] `\(->tin threading menu Brian Richardson
-
.fi
.PP
At the Article level the page header has the following format:
@@ -2059,10 +2058,10 @@ articles simply does not get displayed a
.RE
Default is 0 (\fBKill only unread arts\fP).
.TP
-.B Use 8bit characters in mail headers (mail_8bit_header)
-Allows 8bit characters unencoded in the header of mail message. Default is
+.B Use 8-bit characters in mail headers (mail_8bit_header)
+Allows 8-bit characters unencoded in the header of mail message. Default is
OFF. Turning it ON is effective only if \fBmail_mime_encoding\fP is also set
-to 8bit. Leaving it OFF is safe for most users and compliant to Internet
+to 8-bit. Leaving it OFF is safe for most users and compliant to Internet
Mail Standard (\fBRFC\%5322\fP and \fBRFC\%2047\fP). Default is OFF.
.TP
.B Mail address (mail_address)
@@ -2278,20 +2277,20 @@ Default is "[\-\- %T%S%*n%I%!d%*e \-\-]"
If ON put cursor at first unread article in group otherwise at last
article. Default is ON.
.TP
-.B Use 8bit characters in news headers (post_8bit_header)
-Allows 8bit characters unencoded in the header of a news article, if
+.B Use 8-bit characters in news headers (post_8bit_header)
+Allows 8-bit characters unencoded in the header of a news article, if
set this also disables the generation of MIME-headers when they are
usually required. Default is OFF. Only enacted if
-\fBpost_mime_encoding\fP is also set to 8bit. In a number of local
-hierarchies where 8bit characters are used, using unencoded (raw)
-8bit characters in header is acceptable and sometimes even
+\fBpost_mime_encoding\fP is also set to 8-bit. In a number of local
+hierarchies where 8-bit characters are used, using unencoded (raw)
+8-bit characters in header is acceptable and sometimes even
recommended so that you need to check the convention adopted in the
local hierarchy of your interest to determine what to do with this
and \fBpost_mime_encoding\fP.
.TP
.B MIME encoding in news messages (post_mime_encoding)
MIME encoding of the body in news message, if necessary. (8bit, base64,
-quoted\-printable, 7bit). Default is 8bit, which leads to no encoding.
+quoted\-printable, 7bit). Default is 8-bit, which leads to no encoding.
base64 and quoted\-printable are usually undesired on usenet.
.TP
.B View post-processed files (post_process_view)
@@ -3571,137 +3570,103 @@ For a detailed description see
.br
.I /etc/mail/mailcap
.PP
-
-.IR /etc/nntpserver
+.
+.I /etc/nntpserver
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.cancelsecret
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.mime.types
.br
.I /etc/mime.types
.br
.I /etc/tin/mime.types
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.newsauth
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.newsrc
.PP
-
.nf
.I
${TIN_HOMEDIR:\-"$HOME"}/.tin/$NNTPSERVER${NNTPPORT:+":$NNTPPORT"}/.oldnewsrc
.fi
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.signature
.br
.I ${TIN_HOMEDIR:\-"$HOME"}/.Sig
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.sigfixed
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/.inputhistory
.PP
-
.I ${TIN_INDEX_MAILDIR:\-"${TIN_HOMEDIR:\-"$HOME"}/.tin"}/.mail/
.PP
-
.nf
.I
${TIN_INDEX_NEWSDIR:\-"${TIN_HOMEDIR:\-"$HOME"}/.tin"}/.news${NNTPSERVER:+"\-$NNTPSERVER"}/
.fi
.PP
-
.I ${TIN_INDEX_SAVEDIR:\-"${TIN_HOMEDIR:\-"$HOME"}/.tin"}/.save/
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/active.mail
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/active.save
.PP
-
.\" .I ${TIN_LIBDIR:\-NEWSLIBDIR}/attributes
.I /etc/tin/attributes
.br
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/attributes
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/filter
.PP
-
.nf
.I
${TIN_HOMEDIR:\-"$HOME"}/.tin/keymap${${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}:+".${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}"}
.br
.I
/etc/tin/keymap${${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}:+".${LC_ALL:\-"${LC_MESSAGES:\-"${LC_CTYPE:\-"$LANG"}"}"}"}
.fi
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/mailgroups
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/newsrctable
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/posted
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/Mail/posted
.PP
-
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/postponed.articles
.PP
-
.nf
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/$NNTPSERVER${NNTPPORT:+":$NNTPPORT"}/motd
.fi
.PP
-
.nf
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/$NNTPSERVER${NNTPPORT:+":$NNTPPORT"}/msglog
.fi
.PP
-
.nf
.I
${TIN_HOMEDIR:\-"$HOME"}/.tin/$NNTPSERVER${NNTPPORT:+":$NNTPPORT"}/newsgroups
.fi
.PP
-
.nf
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/$NNTPSERVER${NNTPPORT:+":$NNTPPORT"}/serverrc
.fi
.PP
-
.\" .I ${TIN_LIBDIR:\-NEWSLIBDIR}/tinrc
.I /etc/tin/tinrc
.br
.I ${TIN_HOMEDIR:\-"$HOME"}/.tin/tinrc
.PP
-
.I /etc/tin/tin.defaults
.PP
-
.I /usr/local/share/locale/${LC_MESSAGES}/LC_MESSAGES/tin.mo
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}"/"${TIN_ACTIVEFILE:\-active}
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}/active.times
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}/newsgroups
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}/organization
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}/overview.fmt
.PP
-
.I ${TIN_LIBDIR:\-NEWSLIBDIR}/subscriptions
.\"
.\"
@@ -3777,7 +3742,7 @@ line option overrides $\fBNNTPSERVER\fP.
.TP
.B NNTPPORT
The NNTP TCP-port to read news from. This variable only needs to be set if
-the TCP-port is not 119 (the default). The ''\fB\-p\fP'' command-line
+the TCP-port is not 119 (the default). The ''\fB\-p\fP'' command-line
option does override $\fBNNTPPORT\fP.
.TP
.B NNTPSPORT
@@ -3871,7 +3836,7 @@ for more info.
.B EDITOR
If $\fBVISUAL\fP is unset, then this variable is looked up for a default
editor. If $\fBEDITOR\fP and $\fBVISUAL\fP are both unset, \fBtin\fP uses
-the systems default editor (i.e.
+the systems default editor (i.e.,
.BR \%vi (1)
on UNIX-systems). See
.BR \%environ (5)
