tlmgr.1: trailing whitespace; semantic newlines are missing
Bjarni Ingi Gislason <[email protected]> Thu, 30 Jul 2026 23:33:12 +0000
| Newsgroups | gmane.linux.debian.devel.tetex |
|---|---|
| Message-ID | <178545332310.4198.18182701197242620606.reportbug@kassi.invalid.is> |
--aGKSfAUfXAYMrpaL Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Package: texlive-base Version: 2026.20260711-2 Severity: minor Additional remarks. Mails from me to "[email protected]" are no longer acknowledged. A Debian maintainer told me, that he would contact the mail administrator about me not wanting to send bugs upstream. -.- Dear Maintainer, >From "/usr/share/doc/debian/bug-reporting.txt.gz": Don't file bugs upstream If you file a bug in Debian, don't send a copy to the upstream software maintainers yourself, as it is possible that the bug exists only in Debian. If necessary, the maintainer of the package will forward the bug upstream. -.- For forwarding bug reports to upstream see: https://www.debian.org/Bugs/Developer#forward -.- "Handling bug reports" in http://people.debian.org/~enrico/dcg/ch03s02.html -.- I do not send reports upstream if I have to get an account there. The Debian maintainers have one already. -.- * 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=0 -ww -z < "man page" [Use grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' -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? Output from "test-groff -mandoc -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ": troff:<stdin>:74: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:87: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:107: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:140: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:141: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:142: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:165: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:257: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:258: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:278: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:283: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:288: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:294: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:301: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:305: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:315: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:319: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:324: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:338: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:343: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:347: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:354: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:356: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:398: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:404: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:489: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:498: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:502: warning: trailing whitespace [-w trail] troff:<stdin>:503: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:505: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:518: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:524: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:536: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:541: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:604: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:610: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:612: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:623: warning: trailing whitespace [-w trail] troff:<stdin>:624: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:634: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:637: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:649: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:653: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:670: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:702: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:716: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:718: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:750: warning: trailing whitespace [-w trail] troff:<stdin>:786: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:790: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:794: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:802: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:808: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:811: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:816: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:818: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:819: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:824: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:836: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:837: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:839: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:895: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:900: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:924: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:931: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:935: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:940: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:945: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:947: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:958: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:959: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:960: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:961: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:962: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:971: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:979: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:981: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:983: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:985: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1017: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1024: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1026: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1100: warning: trailing whitespace [-w trail] troff:<stdin>:1101: warning: trailing whitespace [-w trail] troff:<stdin>:1109: warning: trailing whitespace [-w trail] troff:<stdin>:1143: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1147: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1149: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1168: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1170: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1171: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1183: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1196: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1197: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1228: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1278: warning: trailing whitespace [-w trail] troff:<stdin>:1282: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1348: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1367: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1397: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1416: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1417: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1430: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1432: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1437: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1438: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1444: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1444: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1478: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1482: warning: trailing whitespace [-w trail] troff:<stdin>:1494: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1498: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1509: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1512: warning: trailing whitespace [-w trail] troff:<stdin>:1525: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1531: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1568: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1580: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1596: warning: trailing whitespace [-w trail] troff:<stdin>:1597: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1603: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1619: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1620: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1625: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1629: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1689: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1691: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1703: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1706: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1714: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1719: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1736: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1742: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1743: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1747: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1748: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1752: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1753: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1757: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1767: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1769: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1780: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1781: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1790: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1797: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1816: warning: trailing whitespace [-w trail] troff:<stdin>:1833: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1833: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1837: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1843: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1845: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1855: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1867: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1926: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1927: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1946: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1956: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1956: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1965: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1969: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1970: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1974: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:1986: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2004: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2011: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2012: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2025: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2036: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2056: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2065: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2066: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2068: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2073: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2103: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2120: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2128: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2131: warning: trailing whitespace [-w trail] troff:<stdin>:2156: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2158: warning: trailing whitespace [-w trail] troff:<stdin>:2168: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2179: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2180: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2184: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2188: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2198: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2236: warning: end of sentence detected before end of text line [-w style] troff:<stdin>:2259: warning: end of sentence detected before end of text line [-w style] * 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: forky/sid APT prefers testing APT policy: (500, 'testing') Architecture: amd64 (x86_64) Kernel: Linux 7.1.3+deb14-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 texlive-base depends on: ii debconf [debconf-2.0] 1.5.92 ii libpaper-utils 2.2.5-0.4 ii sensible-utils 0.0.26 ii tex-common 6.20 ii texlive-binaries 2026.20260303.78225+ds-4 ii ucf 3.0056 ii xdg-utils 1.2.1-2 Versions of packages texlive-base recommends: ii lmodern 2.005-2 Versions of packages texlive-base suggests: ii ghostscript [postscript-viewer] 10.07.1~dfsg-1 ii gv [postscript-viewer] 1:3.7.4-3.2 ii mupdf [pdf-viewer] 1.27.0+ds1-6 pn perl-tk <none> ii xpdf [pdf-viewer] 3.04+git20260220-1+b1 pn xzdec <none> Versions of packages tex-common depends on: ii bzip2 1.0.8-6+b2 ii ucf 3.0056 Versions of packages tex-common suggests: ii debhelper 14.3 Versions of packages texlive-base is related to: ii tex-common 6.20 ii texlive-binaries 2026.20260303.78225+ds-4 -- debconf information excluded --aGKSfAUfXAYMrpaL Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename=chk_man.err.tlmgr.1 Input file is tlmgr.1 Output from "mandoc -T lint tlmgr.1": (shortened list) 279 STYLE: input text line longer than 80 bytes 13 STYLE: whitespace at end of input line 8 WARNING: empty block: RS Find trailing whitespace with: grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page> -.-. Output from test-groff mandoc -Kutf8 -ww -z tlmgr.1: (shortened list) 174 end of sentence detected before end of text line [-w style] 13 trailing whitespace [-w trail] Find trailing whitespace with: grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page> -.-. Show if Pod::Man generated this. A patch to a generated man page is to show where the generator failed to make a "clean" man page rendering (that is without warnings) and sometimes to show a better format for it. Generated files create bigger and more difficult to read/check patches when the generator creats long lines, instead of shorter ones or by postprocesing its output in such a way. 2:.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) Latest version in Debian testing: This is perl 5, version 40, subversion 1 (v5.40.1) built for x86_64-linux-gnu-thread-multi (with 60 registered patches, see perl -V for more detail) -.-. 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". See more information in the attachment "trailing whitespace". Number of lines affected is 13 -.-. Wrong distance (not two spaces, not a new line character (\n)) 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.] -.-. Test nr. 34: Split lines longer than 80 characters (fill completely an A4 sized page line on a terminal) into two or more lines. Appropriate break points are the end of a sentence and a subordinate clause; after punctuation marks. [List of affected lines removed.] Longest line is number 1670 with 509 characters .el .IP "\f(CWallowed\-actions =\fR \fIaction1\fR[,\fIaction2\fR,...] The value is a comma\-separated list (no spaces) of \f(CWtlmgr\fR actions which are allowed to be executed when \f(CWtlmgr\fR is invoked in system mode (that is, without \f(CW\-\-usermode\fR). This allows distributors to include \f(CWtlmgr\fR in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn\*(Aqt make sense to set this." 4 -.-. Remove unnecessary double font change (e.g., \fR\fI) in a row or (better) use a two-fonts macro. 143:\&\f(CW\*(C`\-\-\*(C'\fR\fIoption\fR and \f(CW\*(C`\-\*(C'\fR\fIoption\fR are equivalent, and an \f(CW\*(C`=\*(C'\fR is optional 366:.IP "\fBbackup [\fR\f(BIoption\fR\fB...] \-\-all\fR" 4 369:.IP "\fBbackup [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB...\fR" 4 482:.IP "\fBconf [texmf|tlmgr|updmap [\-\-conffile \fR\f(BIfile\fR\fB] [\-\-delete] [\fR\f(BIkey\fR\fB [\fR\f(BIvalue\fR\fB]]]\fR" 4 485:.IP "\fBconf auxtrees [\-\-conffile \fR\f(BIfile\fR\fB] [show|add|remove] [\fR\f(BIvalue\fR\fB]\fR" 4 573:.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language\fR" 4 576:.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.dat\fR" 4 578:.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.def\fR" 4 580:.IP "\fBgenerate [\fR\f(BIoption\fR\fB...] language.dat.lua\fR" 4 686:.IP "\fBinfo [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB...\fR" 4 689:.IP "\fBinfo [\fR\f(BIoption\fR\fB...] collections\fR" 4 691:.IP "\fBinfo [\fR\f(BIoption\fR\fB...] schemes\fR" 4 747:.ie n .IP "\fB\-\-data \fR\fB""item1,item2,...""\fR" 4 882:.IP "\fBoption \fR\f(BIkey\fR\fB [\fR\f(BIvalue\fR\fB]\fR" 4 991:.IP "\fB<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [\fR\f(BIpapersize\fR\fB|\-\-list]\fR>" 4 1085:.IP "\fBplatform list|add|remove \fR\f(BIplatform\fR\fB...\fR" 4 1125:.IP "\fBpostaction [\fR\f(BIoption\fR\fB...] install [shortcut|fileassoc|script] [\fR\f(BIpkg\fR\fB...]\fR" 4 1128:.IP "\fBpostaction [\fR\f(BIoption\fR\fB...] remove [shortcut|fileassoc|script] [\fR\f(BIpkg\fR\fB...]\fR" 4 1219:.IP "\fBrepository add \fR\f(BIpath\fR\fB [\fR\f(BItag\fR\fB]\fR" 4 1223:.IP "\fBrepository set \fR\f(BIpath\fR\fB[#\fR\f(BItag\fR\fB] [\fR\f(BIpath\fR\fB[#\fR\f(BItag\fR\fB] ...]\fR" 4 1270:.IP "\fBrestore [\fR\f(BIoption\fR\fB...] \fR\f(BIpkg\fR\fB [\fR\f(BIrev\fR\fB]\fR" 4 1273:.IP "\fBrestore [\fR\f(BIoption\fR\fB...] \-\-all\fR" 4 1321:.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \fR\f(BIwhat\fR" 4 1324:.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \-\-file \fR\f(BIwhat\fR" 4 1326:.IP "\fBsearch [\fR\f(BIoption\fR\fB...] \-\-all \fR\f(BIwhat\fR" 4 1505:any other \f(CW\*(C`a2ping.\*(C'\fR\fIARCH\fR package. 1607:\&\f(CW\*(C`tlpkg/texlive.tlpdb.main.\*(C'\fR\fIlong\-hash\-string\fR. Thus, even when many -.-. 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.] -.-. Only one space character is after a possible end of sentence (after a punctuation, that can end a sentence). Start a new sentence on a new line. [List of affected lines removed.] -.-. Add "\&" after an ellipsis, when it does not end a sentence. 745:\&\f(CW\*(C`tlmgr \-\-repo ... \-\-only\-remote info\*(C'\fR. Note that 1097:\&\f(CW\*(C`platform add\*(C'\fR \fIplatform\fR... adds the executables for each given platform 1100:\&\f(CW\*(C`platform remove\*(C'\fR \fIplatform\fR... removes the executables for each given 1473:\& # ... this last at your own risk, not recommended! 1621:\&\-var\-value=TEXMFSYSCONFIG\*(C'\fR or \f(CW\*(C`... TEXMFCONFIG ...\*(C'\fR to see the actual -.-. Change comment lines of type '.\" ====', '.\" ---', and an empty '.\"' line) to a single period, as they contain no information and waste work each time they are processed. 3:.\" 5:.\" ======================================================================== 28:.\" 32:.\" 37:.\" 55:.\" 58:.\" ======================================================================== 59:.\" -.-. Generally: Split (sometimes) lines after a punctuation mark; before a conjunction. Adjustment to both margins and hyphenation are unnecessary (and just waste resources) in nroff mode for man pages; add .if n \{\ . nh . nr HY 0 . ad l . ds AD l .\} -.- Tables: Use the preprocessor 'tbl' to make tables. Put data, that are wider than the header in the (centered) last column, in a "T{...\nT}" block(, when the table gets wider than the output line). Table headings, that are wider than any data in the corresponding column, do not need to be centered, so left adjustment (l, L) is sufficient. There is thereby no change in the standard output. --aGKSfAUfXAYMrpaL Content-Type: text/plain; charset=us-ascii Content-Disposition: attachment; filename=general.bugs Check the output from "lintian" in the Debian distribution. 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 most trailing spaces use grep -n -e ' $' -e ' \\f.$' -e ' \\"' -e ' "$' <man page> The same goes for man pages that are used as an input. -.- For a style guide use mandoc -T lint -.- For general input conventions consult the man page "nroff(7)" (item "Input conventions") or the Texinfo manual about the same item. -.- 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 when that has been fixed. 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) -.- --aGKSfAUfXAYMrpaL Content-Type: message/rfc822 Content-Disposition: attachment; filename=trailing.whitespace Subject: clean files of trailing whitespace Trailing whitespace is so unnecessary, that its presence may be removed before files containing it are distributed. Some programs have a tool to point out its presence, like gcc with option "-Wtrailing-whitespace" git with option "apply --whitespace=..." and in ".git/config" [core] whitespace=... grep with option -e '[[:blank:]]$' less with command "/ $" mandoc -T lint default action --aGKSfAUfXAYMrpaL--