Package: shellcheck
Version: 0.10.0-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 "grep -e ' $' -e '\\~$' <file>" to find obvious 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-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:17: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:43: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:47: warning: cannot select font 'V'
troff:<stdin>:48: warning: cannot select font 'V'
troff:<stdin>:51: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:58: warning: cannot select font 'V'
troff:<stdin>:112: warning: cannot select font 'V'
troff:<stdin>:113: warning: cannot select font 'V'
troff:<stdin>:114: warning: cannot select font 'V'
troff:<stdin>:120: warning: cannot select font 'V'
troff:<stdin>:121: warning: cannot select font 'V'
troff:<stdin>:123: warning: cannot select font 'V'
troff:<stdin>:141: warning: cannot select font 'V'
troff:<stdin>:143: warning: cannot select font 'V'
troff:<stdin>:144: warning: cannot select font 'V'
troff:<stdin>:145: warning: cannot select font 'V'
troff:<stdin>:148: warning: cannot select font 'V'
troff:<stdin>:149: warning: cannot select font 'V'
troff:<stdin>:167: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:272: warning: cannot select font 'V'
troff:<stdin>:309: warning: cannot select font 'V'
troff:<stdin>:312: warning: cannot select font 'V'
troff:<stdin>:313: warning: cannot select font 'V'
troff:<stdin>:318: warning: cannot select font 'V'
troff:<stdin>:322: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:333: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:343: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:350: warning: cannot select font 'V'
troff:<stdin>:352: warning: cannot select font 'V'
troff:<stdin>:353: warning: cannot select font 'V'
troff:<stdin>:354: warning: cannot select font 'V'
troff:<stdin>:363: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:366: warning: cannot select font 'V'
troff:<stdin>:369: warning: cannot select font 'V'
troff:<stdin>:395: warning: cannot select font 'V'
troff:<stdin>:396: warning: cannot select font 'V'
troff:<stdin>:397: warning: cannot select font 'V'
troff:<stdin>:398: warning: cannot select font 'V'
troff:<stdin>:402: warning: cannot select font 'V'
troff:<stdin>:405: warning: cannot select font 'V'
troff:<stdin>:409: warning: cannot select font 'V'
troff:<stdin>:441: warning: cannot select font 'V'
troff:<stdin>:442: warning: cannot select font 'V'
troff:<stdin>:445: warning: cannot select font 'V'
troff:<stdin>:446: warning: cannot select font 'V'
troff:<stdin>:453: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:455: warning: cannot select font 'V'
troff:<stdin>:467: warning: cannot select font 'V'
troff:<stdin>:469: warning: cannot select font 'V'
troff:<stdin>:471: warning: cannot select font 'V'
troff:<stdin>:474: warning: cannot select font 'V'
troff:<stdin>:475: warning: cannot select font 'V'
troff:<stdin>:477: warning: cannot select font 'V'
troff:<stdin>:479: warning: cannot select font 'V'
troff:<stdin>:481: warning: cannot select font 'V'
troff:<stdin>:482: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'
* 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.19-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 shellcheck depends on:
ii libc6 2.41-6
ii libffi8 3.4.7-1
ii libgmp10 2:6.3.0+dfsg-3
shellcheck recommends no packages.
shellcheck suggests no packages.
-- no debconf information
Input file is shellcheck.1
Output from "mandoc -T lint shellcheck.1": (shortened list)
1 missing date, using "": TH
13 skipping paragraph macro: PP after SH
-.-.
Output from "test-nroff -mandoc -t -ww -z shellcheck.1": (shortened list)
75 cannot select font 'V'
-.-.
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.
shellcheck.1:495:Copyright 2012-2024, Vidar Holen and contributors.
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
shellcheck.1:56:\f[B]-a\f[R],\ \f[B]--check-sourced\f[R]
shellcheck.1:62:\f[B]-C\f[R][\f[I]WHEN\f[R]],\
\f[B]--color\f[R][=\f[I]WHEN\f[R]]
shellcheck.1:66:\f[B]--color\f[R] without an argument is equivalent to
shellcheck.1:67:\f[B]--color=always\f[R].
shellcheck.1:69:\f[B]-i\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--include=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
shellcheck.1:75:\f[B]-e\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--exclude=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
shellcheck.1:80:\f[B]--extended-analysis=true/false\f[R]
shellcheck.1:87:\f[B]-f\f[R] \f[I]FORMAT\f[R],
\f[B]--format=\f[R]\f[I]FORMAT\f[R]
shellcheck.1:93:\f[B]--list-optional\f[R]
shellcheck.1:98:\f[B]--norc\f[R]
shellcheck.1:101:--rcfile\ RCFILE
shellcheck.1:105:\f[B]-o\f[R]\ \f[I]NAME1\f[R][,\f[I]NAME2\f[R]...],\
\f[B]--enable=\f[R]\f[I]NAME1\f[R][,\f[I]NAME2\f[R]...]
shellcheck.1:111:\f[B]-P\f[R]\ \f[I]SOURCEPATH\f[R],\
\f[B]--source-path=\f[R]\f[I]SOURCEPATH\f[R]
shellcheck.1:116:\f[B]-s\f[R]\ \f[I]shell\f[R],\
\f[B]--shell=\f[R]\f[I]shell\f[R]
shellcheck.1:126:\f[B]-S\f[R]\ \f[I]SEVERITY\f[R],\
\f[B]--severity=\f[R]\f[I]severity\f[R]
shellcheck.1:132:\f[B]-V\f[R],\ \f[B]--version\f[R]
shellcheck.1:135:\f[B]-W\f[R] \f[I]NUM\f[R],\ \f[B]--wiki-link-count=NUM\f[R]
shellcheck.1:140:\f[B]-x\f[R],\ \f[B]--external-sources\f[R]
shellcheck.1:211:--- a/test.sh
shellcheck.1:317:\f[B]--list-optional\f[R].
shellcheck.1:363:Unless \f[V]--norc\f[R] is used, ShellCheck will look for a
file
shellcheck.1:414:export SHELLCHECK_OPTS=\[aq]--shell=bash --exclude=SC2016\[aq]
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
414:export SHELLCHECK_OPTS=\[aq]--shell=bash --exclude=SC2016\[aq]
-.-.
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.
21:shellcheck - Shell script analysis tool
44:\f[V]-s sh\f[R]), ShellCheck will warn that \f[V](( .. ))\f[R] is not
48:\f[V]-s bash\f[R]), ShellCheck will warn that decimals are not
52:\f[V]-s ksh\f[R]), ShellCheck will not warn at all, as \f[V]ksh\f[R]
56:\f[B]-a\f[R],\ \f[B]--check-sourced\f[R]
62:\f[B]-C\f[R][\f[I]WHEN\f[R]],\ \f[B]--color\f[R][=\f[I]WHEN\f[R]]
66:\f[B]--color\f[R] without an argument is equivalent to
67:\f[B]--color=always\f[R].
69:\f[B]-i\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--include=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
71:Subsequent \f[B]-i\f[R] options are cumulative, but all the codes can be
75:\f[B]-e\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--exclude=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
77:Subsequent \f[B]-e\f[R] options are cumulative, but all the codes can be
80:\f[B]--extended-analysis=true/false\f[R]
87:\f[B]-f\f[R] \f[I]FORMAT\f[R], \f[B]--format=\f[R]\f[I]FORMAT\f[R]
90:Subsequent \f[B]-f\f[R] options are ignored, see \f[B]FORMATS\f[R] below
93:\f[B]--list-optional\f[R]
95:These can be enabled with \f[B]-o\f[R] flags or \f[B]enable\f[R]
98:\f[B]--norc\f[R]
101:--rcfile\ RCFILE
105:\f[B]-o\f[R]\ \f[I]NAME1\f[R][,\f[I]NAME2\f[R]...],\
\f[B]--enable=\f[R]\f[I]NAME1\f[R][,\f[I]NAME2\f[R]...]
108:Subsequent \f[B]-o\f[R] options accumulate.
111:\f[B]-P\f[R]\ \f[I]SOURCEPATH\f[R],\
\f[B]--source-path=\f[R]\f[I]SOURCEPATH\f[R]
116:\f[B]-s\f[R]\ \f[I]shell\f[R],\ \f[B]--shell=\f[R]\f[I]shell\f[R]
126:\f[B]-S\f[R]\ \f[I]SEVERITY\f[R],\ \f[B]--severity=\f[R]\f[I]severity\f[R]
132:\f[B]-V\f[R],\ \f[B]--version\f[R]
135:\f[B]-W\f[R] \f[I]NUM\f[R],\ \f[B]--wiki-link-count=NUM\f[R]
140:\f[B]-x\f[R],\ \f[B]--external-sources\f[R]
154:One or more script files to check, or \[dq]-\[dq] for standard input.
167:\f[V]:set makeprg=shellcheck\[rs] -f\[rs] gcc\[rs] %\f[R] will allow
205:Can be piped to \f[V]git apply\f[R] or \f[V]patch -p1\f[R] to
211:--- a/test.sh
213:\[at]\[at] -2,6 +2,6 \[at]\[at]
217:- grep -qi hq.*mp3 $f \[rs]
218:+ grep -qi hq.*mp3 \[dq]$f\[dq] \[rs]
219: && echo -e \[aq]Playlist $f contains a HQ file in mp3 format\[aq]
317:\f[B]--list-optional\f[R].
354:Multiple paths accumulate, and \f[V]-P\f[R] takes precedence over them.
363:Unless \f[V]--norc\f[R] is used, ShellCheck will look for a file
390:# Allow [ ! -z foo ] instead of suggesting -n
414:export SHELLCHECK_OPTS=\[aq]--shell=bash --exclude=SC2016\[aq]
-.-.
Find a repeated word
! 311 --> be
-.-.
Check for the font name "C" as that is not standard in "groff"
Add
.if \n(.g .ftr C CR"
before ".TH"
38:\f[C]
172:\f[C]
185:\f[C]
210:\f[C]
233:\f[C]
266:\f[C]
275:\f[C]
285:\f[C]
295:\f[C]
372:\f[C]
413:\f[C]
461:\f[C]
-.-.
Three full stops (periods) are used for an ellipsis
44:\f[V]-s sh\f[R]), ShellCheck will warn that \f[V](( .. ))\f[R] is not
-.-.
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.
311:A range can be be specified with a dash, e.g.
428:2: Some files could not be processed (e.g.
431:3: ShellCheck was invoked with bad syntax (e.g.
434:4: ShellCheck was invoked with bad options (e.g.
-.-.
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"
44:\f[V]-s sh\f[R]), ShellCheck will warn that \f[V](( .. ))\f[R] is not
390:# Allow [ ! -z foo ] instead of suggesting -n
-.-.
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.
Line 69, length 109
\f[B]-i\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--include=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
Line 75, length 109
\f[B]-e\f[R]\ \f[I]CODE1\f[R][,\f[I]CODE2\f[R]...],\
\f[B]--exclude=\f[R]\f[I]CODE1\f[R][,\f[I]CODE2\f[R]...]
Line 105, length 108
\f[B]-o\f[R]\ \f[I]NAME1\f[R][,\f[I]NAME2\f[R]...],\
\f[B]--enable=\f[R]\f[I]NAME1\f[R][,\f[I]NAME2\f[R]...]
Line 111, length 81
\f[B]-P\f[R]\ \f[I]SOURCEPATH\f[R],\
\f[B]--source-path=\f[R]\f[I]SOURCEPATH\f[R]
Line 378, length 81
# Since 0.9.0, values can be quoted with \[aq]\[aq] or \[dq]\[dq] to allow
spaces
Longest line is number 69 with 109 characters
-.-.
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.
shellcheck.1:21:shellcheck - Shell script analysis tool
shellcheck.1:217:- grep -qi hq.*mp3 $f \[rs]
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
500:sh(1) bash(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
shellcheck.1:45:POSIX compliant (similar to checkbashisms).
shellcheck.1:81:Enable/disable Dataflow Analysis to identify more issues
(default true).
shellcheck.1:123:\f[I]sh\f[R] refers to POSIX \f[V]sh\f[R] (not the
system\[aq]s), and
shellcheck.1:144:command line (plus \f[V]/dev/null\f[R]).
shellcheck.1:323:particularly large (2000+ line) auto-generated scripts will
reduce
shellcheck.1:397:XDG config directory (usually
\f[V]\[ti]/.config/shellcheckrc\f[R]) on
shellcheck.1:442:locales where encoding is unspecified (such as the \f[V]C\f[R]
locale).
shellcheck.1:445:\f[V]commitBuffer: invalid argument (invalid character)\f[R]
should set
shellcheck.1:454:\f[V]( subshells )\f[R], and function names containing
\f[V][]*=!\f[R]
-.-.
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.
shellcheck.1:5:.ie "\f[CB]x\f[]"x" \{\
shellcheck.1:17:.TH "SHELLCHECK" "1" "" "Shell script analysis tool" ""
-.-.
Do not use hyphenattion except in troff mode.
18:.hy
-.-.
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.
488:https://github.com/koalaman/shellcheck/issues
497:https://gnu.org/licenses/gpl.html
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:17: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
troff:<stdin>:43: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:44: warning: cannot select font 'V'
troff:<stdin>:47: warning: cannot select font 'V'
troff:<stdin>:48: warning: cannot select font 'V'
troff:<stdin>:51: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:52: warning: cannot select font 'V'
troff:<stdin>:58: warning: cannot select font 'V'
troff:<stdin>:112: warning: cannot select font 'V'
troff:<stdin>:113: warning: cannot select font 'V'
troff:<stdin>:114: warning: cannot select font 'V'
troff:<stdin>:120: warning: cannot select font 'V'
troff:<stdin>:121: warning: cannot select font 'V'
troff:<stdin>:123: warning: cannot select font 'V'
troff:<stdin>:141: warning: cannot select font 'V'
troff:<stdin>:143: warning: cannot select font 'V'
troff:<stdin>:144: warning: cannot select font 'V'
troff:<stdin>:145: warning: cannot select font 'V'
troff:<stdin>:148: warning: cannot select font 'V'
troff:<stdin>:149: warning: cannot select font 'V'
troff:<stdin>:167: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:168: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:205: warning: cannot select font 'V'
troff:<stdin>:272: warning: cannot select font 'V'
troff:<stdin>:309: warning: cannot select font 'V'
troff:<stdin>:312: warning: cannot select font 'V'
troff:<stdin>:313: warning: cannot select font 'V'
troff:<stdin>:318: warning: cannot select font 'V'
troff:<stdin>:322: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:328: warning: cannot select font 'V'
troff:<stdin>:333: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:339: warning: cannot select font 'V'
troff:<stdin>:343: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:346: warning: cannot select font 'V'
troff:<stdin>:350: warning: cannot select font 'V'
troff:<stdin>:352: warning: cannot select font 'V'
troff:<stdin>:353: warning: cannot select font 'V'
troff:<stdin>:354: warning: cannot select font 'V'
troff:<stdin>:363: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:364: warning: cannot select font 'V'
troff:<stdin>:366: warning: cannot select font 'V'
troff:<stdin>:369: warning: cannot select font 'V'
troff:<stdin>:395: warning: cannot select font 'V'
troff:<stdin>:396: warning: cannot select font 'V'
troff:<stdin>:397: warning: cannot select font 'V'
troff:<stdin>:398: warning: cannot select font 'V'
troff:<stdin>:402: warning: cannot select font 'V'
troff:<stdin>:405: warning: cannot select font 'V'
troff:<stdin>:409: warning: cannot select font 'V'
troff:<stdin>:441: warning: cannot select font 'V'
troff:<stdin>:442: warning: cannot select font 'V'
troff:<stdin>:445: warning: cannot select font 'V'
troff:<stdin>:446: warning: cannot select font 'V'
troff:<stdin>:453: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:454: warning: cannot select font 'V'
troff:<stdin>:455: warning: cannot select font 'V'
troff:<stdin>:467: warning: cannot select font 'V'
troff:<stdin>:469: warning: cannot select font 'V'
troff:<stdin>:471: warning: cannot select font 'V'
troff:<stdin>:474: warning: cannot select font 'V'
troff:<stdin>:475: warning: cannot select font 'V'
troff:<stdin>:477: warning: cannot select font 'V'
troff:<stdin>:479: warning: cannot select font 'V'
troff:<stdin>:481: warning: cannot select font 'V'
troff:<stdin>:482: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'
troff:<stdin>:483: warning: cannot select font 'V'
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- shellcheck.1 2025-03-28 10:04:24.854042941 +0000
+++ shellcheck.1.new 2025-03-28 16:38:21.646759812 +0000
@@ -2,13 +2,15 @@
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
-.ie "\f[CB]x\f[]"x" \{\
+.\".ie "\f[CB]x\f[]"x" \{\
+.ie n \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
+. ftr C CR
. ftr V CR
. ftr VI CI
. ftr VB CB
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
-.-
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)
-.-
