Bug#1102335: Net::SSLeay.3pm: Some remarks about this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Tue Apr 8 00:05:07 BST 2025
Package: libnet-ssleay-perl
Version: 1.94-3
Severity: minor
Tags: upstream
* 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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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>:12543: warning: [page 169, 8.2i]: cannot break line
troff:<stdin>:12586: warning: [page 170, 3.6i]: cannot break line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:1282: warning [page 17, line 28]: cannot break line
[...]
troff:<stdin>:12586: warning [page 94, line 47]: cannot break 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.21-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 libnet-ssleay-perl depends on:
ii libc6 2.41-6
ii libssl3t64 3.4.1-1
ii perl 5.40.1-2
ii perl-base [perlapi-5.40.1] 5.40.1-2
ii perl-openssl-defaults [perl-openssl-abi-3] 7+b2
libnet-ssleay-perl recommends no packages.
libnet-ssleay-perl suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is Net::SSLeay.3pm
Output from "mandoc -T lint Net::SSLeay.3pm": (shortened list)
1 : Net::SSLeay.3pm:10018:92: STYLE: input text line longer than 80 bytes: Check openssl doc <h...
[...]
1 : Net::SSLeay.3pm:9953:109: STYLE: input text line longer than 80 bytes: Note that some of th...
-.-.
Output from
test-nroff -mandoc -t -ww -z Net::SSLeay.3pm: (shortened list)
186 cannot break line
-.-.
Show if Pod::Man generated this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
2:.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
-.-.
Change '-' (\-) to '\(en' (en-dash) for a (numeric) range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
Net::SSLeay.3pm:12370:An OpenSSL bug CVE\-2015\-0290 "OpenSSL Multiblock Corrupted Pointer Issue"
Net::SSLeay.3pm:12624:Copyright (c) 1996\-2003 Sampo Kellom??ki <sampo at iki.fi>
Net::SSLeay.3pm:12626:Copyright (c) 2005\-2010 Florian Ragwitz <rafl at debian.org>
Net::SSLeay.3pm:12628:Copyright (c) 2005\-2018 Mike McCauley <mikem at airspayce.com>
-.-.
12326:\&\f(CWNet::SSLeay::read()\fR uses an internal buffer of 32KB, thus no single read
12371:can cause POST requests of over 90kB to fail or crash. This bug is reported to be fixed in
-.-.
a)
Use a no-filling text block with .nf/.fi instead of beginning each line
with '\&'.
b) Use indent macro .RS/.RE for text blocks
Net::SSLeay.3pm:68:\& use Net::SSLeay qw(get_https post_https sslcat make_headers make_form);
[...]
Net::SSLeay.3pm:12656:\& perldoc ~openssl/doc/ssl/SSL_CTX_set_verify.pod
-.-.
Add a (no-break, "\ " or "\~") space between a number and a unit,
as these are not one entity.
Use the word (in)valid instead of (il)legal,
if not related to legal matters.
See "www.gnu.org/prep/standards".
Think about translations into other languages!
Net::SSLeay.3pm:11762:\& AD_ILLEGAL_PARAMETER OP_COOKIE_EXCHANGE
-.-.
Find a repeated word
! 5882 --> and
! 6644 --> see
! 11599 --> the
! 11672 --> the
! 11709 --> the
-.-.
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 URL (web address)
This is a groff extension.
1179 Check openssl doc <https://www.openssl.org/docs/manmaster/man3/OpenSSL_version_num.html>
[...]
12600 create a new issue <https://github.com/radiator-software/p5-net-ssleay/issues/new>
-.-.
Add a "\&" (or a comma (Oxford comma)) after an abbreviation
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
203:the HTTP protocol specifications for further details (e.g. RFC\-2617).
[...]
12483:able to check the certificate after the fact, i.e. you already sent
-.-.
Wrong distance (not two spaces) 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 "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
Longest line is number 8941 with 249 characters
Unicode note: when passing non-ascii (unicode) string in \f(CW$bytes\fR do not forget to set \f(CW\*(C`$flags = &Net::SSLeay::MBSTRING_UTF8\*(C'\fR and encode the perl \f(CW$string\fR via \f(CW\*(C`$bytes = encode(\*(Aqutf\-8\*(Aq, $string)\*(C'\fR.
-.-.
Use \(en (en-dash) for a dash at the beginning (end) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
Net::SSLeay.3pm:12517:.IX Item "msg 123: 1 - error:140770F8:SSL routines:SSL23_GET_SERVER_HELLO:unknown proto"
Net::SSLeay.3pm:12522:.IX Item "msg 123: 1 - error:02001002::lib :func :reason"
-.-.
Remove unnecessary double font change (e.g., \fR\fI) in a row or (better)
use a two-fonts macro.
9442:in the format \fIhash.N\fR or crls with filenames in the format \fIhash.\fR\fBr\fR\fIN\fR
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-
Use "\(en" (en-dash) to indicate a range, not a minus (\-);
this is not a substraction
105:Any stable release of OpenSSL <https://www.openssl.org> in the 0.9.8 \- 3.2
106:branches, except for OpenSSL 0.9.8 \- 0.9.8b.
108:Any stable release of LibreSSL <https://www.libressl.org> in the 2.0 \- 3.8
12359:LibreSSL versions in the 3.1 \- 3.3 series contain a TLS 1.3 implementation that
-.-.
Use a hyphen between a number and the unit (name) "bit",
see "man-pages(7)", item "Terms to avoid".
6567:Prints: \f(CW080304030303020301\fR where the first octet 0x08 is the extension length and the following four 16bit values correspond to TLS versions 1.3, 1.2, 1.1 and 1.0.
6941:in 'long' type (usually 32bit but may vary according to platform) then this function will return \-1.
7076:is dependent on the size of time_t structure (32bit time_t has problem with 2038).
7297:The result is not a full hash (e.g. sha\-1), it is kind-of-a-hash truncated to the size of 'unsigned long' (32 bits).
7312:The result is not a full hash (e.g. sha\-1), it is kind-of-a-hash truncated to the size of 'unsigned long' (32 bits).
7327:The result is not a full hash (e.g. sha\-1), it is kind-of-a-hash truncated to the size of 'unsigned long' (32 bits).
7697:system (32bit time_t does not work after 2038). Consider using "P_ASN1_TIME_set_isotime" instead).
8909:The result is not a full hash (e.g. sha\-1), it is kind-of-a-hash truncated to the size of 'unsigned long' (32 bits).
-.-.
Use a character "\(->" instead of plain "->" or "\->".
[List of affected lines removed.]
-.-
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Put a subordinate sentence (after a comma) on a new line.
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
Net::SSLeay.3pm:66:.IX Header "SYNOPSIS"
Net::SSLeay.3pm:98:.IX Header "DESCRIPTION"
Net::SSLeay.3pm:102:.IX Header "COMPATIBILITY"
Net::SSLeay.3pm:142:.IX Header "OVERVIEW"
Net::SSLeay.3pm:701:.IX Subsection "Initialization"
Net::SSLeay.3pm:920:.IX Subsection "Initialization"
Net::SSLeay.3pm:958:.IX Subsection "Sockets"
Net::SSLeay.3pm:978:.IX Subsection "Callbacks"
Net::SSLeay.3pm:11714:.IX Subsection "Constants"
Net::SSLeay.3pm:12143:.IX Header "EXAMPLES"
Net::SSLeay.3pm:12322:.IX Header "INSTALLATION"
Net::SSLeay.3pm:12325:.IX Header "LIMITATIONS"
Net::SSLeay.3pm:12503:.IX Header "DIAGNOSTICS"
Net::SSLeay.3pm:12532:.IX Header "SECURITY"
Net::SSLeay.3pm:12592:.IX Header "BUGS"
Net::SSLeay.3pm:12606:.IX Header "AUTHOR"
Net::SSLeay.3pm:12617:.IX Header "COPYRIGHT"
Net::SSLeay.3pm:12632:.IX Header "LICENSE"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
61:.if n .ad l
-.-.
Add lines to use the CR font for groff instead of CW.
.if t \{\
. ie \\n(.g .ft CR
. el .ft CW
.\}
11:.ft CW
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
154:.SS "High level functions for accessing web servers"
450:.SS "Certificate verification and Certificate Revocation Lists (CRLs)"
518:.SS "Certificate verification and Online Status Revocation Protocol (OCSP)"
689:.SS "Using Net::SSLeay in multi-threaded applications"
849:.SS "Convenience routines"
932:.SS "Error handling functions"
1034:.SS "Low level API"
12130:.SS "INTERNAL ONLY functions (do not use these)"
12357:.SH "KNOWN BUGS AND CAVEATS"
12540:.SS "BEAST Attack"
12566:.SS "Session Resumption"
12583:.SS "Secure Renegotiation and DoS Attack"
12641:.SH "SEE ALSO"
-.-.
.\" Define a fallback for font CW with
.if t \{\
. ie \n(.g .ds fC \f(CR
. el .ds fC \f(CW
.\}
.
.if n \{\
. ds fC \fR
.\}
Change \f(CW to \*(fC
[List of affected lines removed.]
-.-.
Use "\-" instead of "-" in web addresses.
12600:create a new issue <https://github.com/radiator-software/p5-net-ssleay/issues/new>
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
[List of affected lines removed.]
-.-.
Add "\&" after an ellipsis, when it does not end a sentence
[List of affected lines removed.]
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:12543: warning: [page 169, 8.2i]: cannot break line
troff:<stdin>:12586: warning: [page 170, 3.6i]: cannot break line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:1282: warning [page 17, line 28]: cannot break line
troff:<stdin>:1298: warning [page 17, line 44]: cannot break line
troff:<stdin>:1314: warning [page 17, line 61]: cannot break line
troff:<stdin>:1368: warning [page 18, line 30]: cannot break line
troff:<stdin>:1380: warning [page 18, line 42]: cannot break line
troff:<stdin>:1414: warning [page 18, line 73]: cannot break line
troff:<stdin>:1538: warning [page 20, line 34]: cannot break line
troff:<stdin>:1555: warning [page 20, line 50]: cannot break line
troff:<stdin>:1572: warning [page 20, line 66]: cannot break line
troff:<stdin>:1659: warning [page 21, line 71]: cannot break line
troff:<stdin>:1672: warning [page 22, line 2]: cannot break line
troff:<stdin>:1685: warning [page 22, line 15]: cannot break line
troff:<stdin>:1698: warning [page 22, line 27]: cannot break line
troff:<stdin>:1954: warning [page 25, line 38]: cannot break line
troff:<stdin>:2426: warning [page 30, line 2]: cannot break line
troff:<stdin>:2477: warning [page 30, line 46]: cannot break line
troff:<stdin>:2492: warning [page 30, line 61]: cannot break line
troff:<stdin>:2509: warning [page 30, line 77]: cannot break line
troff:<stdin>:2545: warning [page 31, line 16]: cannot break line
troff:<stdin>:2576: warning [page 31, line 46]: cannot break line
troff:<stdin>:2592: warning [page 31, line 62]: cannot break line
troff:<stdin>:2607: warning [page 31, line 78]: cannot break line
troff:<stdin>:2771: warning [page 33, line 27]: cannot break line
troff:<stdin>:2785: warning [page 33, line 42]: cannot break line
troff:<stdin>:2827: warning [page 33, line 82]: cannot break line
troff:<stdin>:2957: warning [page 35, line 10]: cannot break line
troff:<stdin>:3021: warning [page 35, line 68]: cannot break line
troff:<stdin>:3034: warning [page 35, line 81]: cannot break line
troff:<stdin>:3048: warning [page 35, line 94]: cannot break line
troff:<stdin>:3065: warning [page 36, line 2]: cannot break line
troff:<stdin>:3165: warning [page 36, line 97]: cannot break line
troff:<stdin>:3203: warning [page 37, line 22]: cannot break line
troff:<stdin>:3219: warning [page 37, line 38]: cannot break line
troff:<stdin>:3245: warning [page 37, line 64]: cannot break line
troff:<stdin>:3260: warning [page 37, line 78]: cannot break line
troff:<stdin>:3291: warning [page 38, line 2]: cannot break line
troff:<stdin>:3306: warning [page 38, line 18]: cannot break line
troff:<stdin>:3439: warning [page 39, line 36]: cannot break line
troff:<stdin>:3454: warning [page 39, line 52]: cannot break line
troff:<stdin>:3569: warning [page 40, line 44]: cannot break line
troff:<stdin>:3616: warning [page 40, line 87]: cannot break line
troff:<stdin>:3646: warning [page 41, line 2]: cannot break line
troff:<stdin>:3662: warning [page 41, line 18]: cannot break line
troff:<stdin>:3705: warning [page 41, line 60]: cannot break line
troff:<stdin>:3721: warning [page 41, line 76]: cannot break line
troff:<stdin>:3738: warning [page 41, line 94]: cannot break line
troff:<stdin>:3754: warning [page 41, line 110]: cannot break line
troff:<stdin>:3768: warning [page 42, line 8]: cannot break line
troff:<stdin>:3782: warning [page 42, line 22]: cannot break line
troff:<stdin>:3796: warning [page 42, line 36]: cannot break line
troff:<stdin>:3822: warning [page 42, line 60]: cannot break line
troff:<stdin>:3862: warning [page 42, line 99]: cannot break line
troff:<stdin>:3887: warning [page 43, line 2]: cannot break line
troff:<stdin>:3903: warning [page 43, line 17]: cannot break line
troff:<stdin>:3931: warning [page 43, line 45]: cannot break line
troff:<stdin>:3945: warning [page 43, line 59]: cannot break line
troff:<stdin>:3959: warning [page 43, line 72]: cannot break line
troff:<stdin>:3977: warning [page 43, line 90]: cannot break line
troff:<stdin>:4050: warning [page 44, line 39]: cannot break line
troff:<stdin>:4065: warning [page 44, line 53]: cannot break line
troff:<stdin>:4079: warning [page 44, line 66]: cannot break line
troff:<stdin>:4106: warning [page 44, line 90]: cannot break line
troff:<stdin>:4122: warning [page 44, line 107]: cannot break line
troff:<stdin>:4137: warning [page 45, line 1]: cannot break line
troff:<stdin>:4152: warning [page 45, line 16]: cannot break line
troff:<stdin>:4168: warning [page 45, line 32]: cannot break line
troff:<stdin>:4186: warning [page 45, line 50]: cannot break line
troff:<stdin>:4201: warning [page 45, line 65]: cannot break line
troff:<stdin>:4225: warning [page 45, line 87]: cannot break line
troff:<stdin>:4240: warning [page 45, line 102]: cannot break line
troff:<stdin>:4272: warning [page 46, line 13]: cannot break line
troff:<stdin>:4322: warning [page 46, line 62]: cannot break line
troff:<stdin>:4350: warning [page 46, line 89]: cannot break line
troff:<stdin>:4536: warning [page 48, line 8]: cannot break line
troff:<stdin>:4549: warning [page 48, line 20]: cannot break line
troff:<stdin>:4615: warning [page 48, line 84]: cannot break line
troff:<stdin>:4628: warning [page 48, line 96]: cannot break line
troff:<stdin>:4641: warning [page 48, line 109]: cannot break line
troff:<stdin>:4844: warning [page 50, line 47]: cannot break line
troff:<stdin>:4866: warning [page 50, line 66]: cannot break line
troff:<stdin>:4879: warning [page 50, line 78]: cannot break line
troff:<stdin>:4926: warning [page 50, line 120]: cannot break line
troff:<stdin>:4942: warning [page 51, line 2]: cannot break line
troff:<stdin>:5018: warning [page 51, line 73]: cannot break line
troff:<stdin>:5094: warning [page 52, line 8]: cannot break line
troff:<stdin>:5158: warning [page 52, line 68]: cannot break line
troff:<stdin>:5187: warning [page 52, line 97]: cannot break line
troff:<stdin>:5220: warning [page 52, line 132]: cannot break line
troff:<stdin>:5235: warning [page 53, line 12]: cannot break line
troff:<stdin>:5281: warning [page 53, line 58]: cannot break line
troff:<stdin>:5297: warning [page 53, line 73]: cannot break line
troff:<stdin>:5323: warning [page 53, line 97]: cannot break line
troff:<stdin>:5544: warning [page 55, line 26]: cannot break line
troff:<stdin>:5573: warning [page 55, line 54]: cannot break line
troff:<stdin>:5604: warning [page 55, line 85]: cannot break line
troff:<stdin>:5617: warning [page 55, line 97]: cannot break line
troff:<stdin>:5648: warning [page 55, line 127]: cannot break line
troff:<stdin>:5689: warning [page 56, line 28]: cannot break line
troff:<stdin>:5704: warning [page 56, line 43]: cannot break line
troff:<stdin>:5736: warning [page 56, line 77]: cannot break line
troff:<stdin>:5750: warning [page 56, line 91]: cannot break line
troff:<stdin>:5766: warning [page 56, line 106]: cannot break line
troff:<stdin>:5792: warning [page 56, line 130]: cannot break line
troff:<stdin>:5821: warning [page 57, line 17]: cannot break line
troff:<stdin>:5926: warning [page 57, line 115]: cannot break line
troff:<stdin>:6007: warning [page 58, line 47]: cannot break line
troff:<stdin>:6021: warning [page 58, line 60]: cannot break line
troff:<stdin>:6037: warning [page 58, line 76]: cannot break line
troff:<stdin>:6059: warning [page 58, line 95]: cannot break line
troff:<stdin>:6075: warning [page 58, line 111]: cannot break line
troff:<stdin>:6144: warning [page 59, line 37]: cannot break line
troff:<stdin>:6160: warning [page 59, line 54]: cannot break line
troff:<stdin>:6174: warning [page 59, line 67]: cannot break line
troff:<stdin>:6190: warning [page 59, line 82]: cannot break line
troff:<stdin>:6205: warning [page 59, line 96]: cannot break line
troff:<stdin>:6219: warning [page 59, line 109]: cannot break line
troff:<stdin>:6234: warning [page 59, line 123]: cannot break line
troff:<stdin>:6249: warning [page 59, line 137]: cannot break line
troff:<stdin>:6263: warning [page 60, line 9]: cannot break line
troff:<stdin>:6278: warning [page 60, line 23]: cannot break line
troff:<stdin>:6296: warning [page 60, line 43]: cannot break line
troff:<stdin>:6311: warning [page 60, line 57]: cannot break line
troff:<stdin>:6473: warning [page 61, line 68]: cannot break line
troff:<stdin>:6490: warning [page 61, line 86]: cannot break line
troff:<stdin>:6510: warning [page 61, line 108]: cannot break line
troff:<stdin>:6539: warning [page 61, line 139]: cannot break line
troff:<stdin>:6569: warning [page 62, line 23]: cannot break line
troff:<stdin>:7882: warning [page 69, line 142]: cannot break line
troff:<stdin>:8573: warning [page 73, line 113]: cannot break line
troff:<stdin>:8590: warning [page 73, line 132]: cannot break line
troff:<stdin>:8635: warning [page 74, line 5]: cannot break line
troff:<stdin>:8653: warning [page 74, line 25]: cannot break line
troff:<stdin>:8874: warning [page 75, line 51]: cannot break line
troff:<stdin>:8889: warning [page 75, line 65]: cannot break line
troff:<stdin>:8943: warning [page 75, line 118]: cannot break line
troff:<stdin>:8963: warning [page 75, line 138]: cannot break line
troff:<stdin>:8983: warning [page 75, line 158]: cannot break line
troff:<stdin>:9029: warning [page 76, line 29]: cannot break line
troff:<stdin>:9046: warning [page 76, line 47]: cannot break line
troff:<stdin>:9117: warning [page 76, line 113]: cannot break line
troff:<stdin>:9254: warning [page 77, line 61]: cannot break line
troff:<stdin>:9269: warning [page 77, line 77]: cannot break line
troff:<stdin>:9282: warning [page 77, line 90]: cannot break line
troff:<stdin>:9297: warning [page 77, line 105]: cannot break line
troff:<stdin>:9313: warning [page 77, line 120]: cannot break line
troff:<stdin>:9386: warning [page 78, line 2]: cannot break line
troff:<stdin>:9400: warning [page 78, line 16]: cannot break line
troff:<stdin>:9558: warning [page 78, line 152]: cannot break line
troff:<stdin>:9589: warning [page 79, line 1]: cannot break line
troff:<stdin>:9605: warning [page 79, line 17]: cannot break line
troff:<stdin>:9631: warning [page 79, line 42]: cannot break line
troff:<stdin>:9644: warning [page 79, line 54]: cannot break line
troff:<stdin>:9659: warning [page 79, line 69]: cannot break line
troff:<stdin>:9676: warning [page 79, line 85]: cannot break line
troff:<stdin>:9738: warning [page 79, line 139]: cannot break line
troff:<stdin>:9758: warning [page 79, line 160]: cannot break line
troff:<stdin>:9774: warning [page 79, line 176]: cannot break line
troff:<stdin>:9790: warning [page 80, line 11]: cannot break line
troff:<stdin>:9817: warning [page 80, line 36]: cannot break line
troff:<stdin>:9831: warning [page 80, line 50]: cannot break line
troff:<stdin>:9848: warning [page 80, line 69]: cannot break line
troff:<stdin>:9865: warning [page 80, line 86]: cannot break line
troff:<stdin>:9879: warning [page 80, line 100]: cannot break line
troff:<stdin>:9895: warning [page 80, line 115]: cannot break line
troff:<stdin>:9937: warning [page 80, line 151]: cannot break line
troff:<stdin>:10018: warning [page 81, line 47]: cannot break line
troff:<stdin>:10344: warning [page 82, line 158]: cannot break line
troff:<stdin>:10387: warning [page 83, line 13]: cannot break line
troff:<stdin>:11229: warning [page 87, line 62]: cannot break line
troff:<stdin>:11342: warning [page 87, line 163]: cannot break line
troff:<stdin>:11377: warning [page 88, line 9]: cannot break line
troff:<stdin>:11404: warning [page 88, line 34]: cannot break line
troff:<stdin>:11451: warning [page 88, line 78]: cannot break line
troff:<stdin>:11465: warning [page 88, line 91]: cannot break line
troff:<stdin>:11490: warning [page 88, line 115]: cannot break line
troff:<stdin>:11510: warning [page 88, line 133]: cannot break line
troff:<stdin>:11545: warning [page 88, line 168]: cannot break line
troff:<stdin>:11565: warning [page 89, line 1]: cannot break line
troff:<stdin>:11602: warning [page 89, line 37]: cannot break line
troff:<stdin>:11619: warning [page 89, line 53]: cannot break line
troff:<stdin>:11675: warning [page 89, line 108]: cannot break line
troff:<stdin>:11712: warning [page 89, line 144]: cannot break line
troff:<stdin>:12543: warning [page 94, line 7]: cannot break line
troff:<stdin>:12545: warning [page 94, line 9]: cannot break line
troff:<stdin>:12547: warning [page 94, line 11]: cannot break line
troff:<stdin>:12586: warning [page 94, line 47]: cannot break line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-------------- 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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 -d -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 from 'diff -d -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)
-.-
More information about the pkg-perl-maintainers
mailing list