Bug#1099626: cpan5.40-x86_64-linux-gnu.1: Some remarks about this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Wed Mar 5 20:51:49 GMT 2025
Package: libperl5.40
Version: 5.40.1-2
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 "groff -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?
troff:<stdin>:262: warning [page 3, line 42]: cannot break line
troff:<stdin>:264: warning [page 3, line 45]: 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.12-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 libperl5.40 depends on:
ii libbz2-1.0 1.0.8-6
ii libc6 2.40-7
ii libcrypt1 1:4.4.38-1
ii libdb5.3t64 5.3.28+dfsg2-9
ii libgdbm-compat4t64 1.24-2
ii libgdbm6t64 1.24-2
ii perl-modules-5.40 5.40.1-2
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
libperl5.40 recommends no packages.
Versions of packages libperl5.40 suggests:
ii sensible-utils 0.0.24
-- no debconf information
-------------- next part --------------
Input file is cpan5.40-x86_64-linux-gnu.1
Output from "mandoc -T lint cpan5.40-x86_64-linux-gnu.1": (shortened list)
1 input text line longer than 80 bytes: A comma-separated li...
1 input text line longer than 80 bytes: As with \f(CW\*(C`PE...
1 input text line longer than 80 bytes: If you want this fea...
1 input text line longer than 80 bytes: Lancaster Consensus:...
1 input text line longer than 80 bytes: Load \f(CW\*(C`local...
1 input text line longer than 80 bytes: Oslo Consensus: <htt...
1 input text line longer than 80 bytes: Print a help message...
1 input text line longer than 80 bytes: The path to the \f(C...
1 input text line longer than 80 bytes: config with \f(CW\*(...
1 input text line longer than 80 bytes: the \f(CW\*(C`Log::L...
-.-.
Output from "test-nroff -mandoc -t -ww -z cpan5.40-x86_64-linux-gnu.1": (shortened list)
2 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)
-.-.
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)
262 Lancaster Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/lancaster\-consensus.md>
264 Oslo Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/oslo\-consensus.md>
-.-.
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 "\&".
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.]
69:\& cpan module_name [ module_name ... ]
72:\& cpan [\-cfFimtTw] module_name [ module_name ... ]
75:\& cpan \-I module_name [ module_name ... ]
92:This script provides a command interface (not a shell) to CPAN. At the
111:Show the module details. This prints one line for each out-of-date module
117:Force the specified action, when it normally would have failed. Use this
118:to install a module even if its tests fail. When you use this option,
126:Turn off CPAN.pm's attempts to lock anything. You should be careful with
128:same directory. This isn't so much of a concern if you're loading a special
145:Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
149:Install the specified modules. With no other switches, this switch
153:Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
157:Load the file that has the CPAN configuration data. This should have the
162:Dump the configuration in the same format that CPAN.pm uses. This is useful
176:A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
180:Do a dry run, but don't actually install anything. (unimplemented)
196:Drop in the CPAN.pm shell. This command does this automatically if you don't
203:Do not test modules. Simply install them.
206:Upgrade all installed modules. Blindly doing this can really break things,
218:Turn on cpan warnings. This checks various things, like directory permissions,
223:mistyped. This requires the optional installation of Text::Levenshtein or
259:while others matter to the levels above them. Some of these are specified
268:that do that correctly. \f(CWcpan(1)\fR sets this to \f(CW1\fR unless it already
272:Use the default answer for a prompted questions. \f(CWcpan(1)\fR sets this
281:Log::Log4perl if it is installed. Possible values are the same as
283:\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
286:The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
291:positive number if it thinks that something failed. Note, however, that
293:not control. For now, the exit codes are vague:
-.-.
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 129, length 84
config with \f(CW\*(C`\-j\*(C'\fR, and that config sets up its own work directories.
Line 141, length 88
If you want this feature, check out Yanick Champoux's \f(CW\*(C`Git::CPAN::Patch\*(C'\fR
Line 145, length 85
Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
Line 153, length 99
Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
Line 176, length 85
A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
Line 262, length 115
Lancaster Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/lancaster\-consensus.md>
Line 264, length 105
Oslo Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/oslo\-consensus.md>
Line 276, length 85
As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
Line 282, length 141
the \f(CW\*(C`Log::Log4perl\*(C'\fR levels: \f(CW\*(C`TRACE\*(C'\fR, \f(CW\*(C`DEBUG\*(C'\fR, \f(CW\*(C`INFO\*(C'\fR, \f(CW\*(C`WARN\*(C'\fR,
Line 283, length 94
\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
Line 286, length 85
The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
268:that do that correctly. \f(CWcpan(1)\fR sets this to \f(CW1\fR unless it already
272:Use the default answer for a prompted questions. \f(CWcpan(1)\fR sets this
276:As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
-.-.
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".
cpan5.40-x86_64-linux-gnu.1:92:This script provides a command interface (not a shell) to CPAN. At the
cpan5.40-x86_64-linux-gnu.1:153:Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
cpan5.40-x86_64-linux-gnu.1:246:\& # install modules ( sole \-i is optional )
cpan5.40-x86_64-linux-gnu.1:249:\& # force install modules ( must use \-i )
cpan5.40-x86_64-linux-gnu.1:269:has a value (even if that value is false).
cpan5.40-x86_64-linux-gnu.1:273:to \f(CW1\fR unless it already has a value (even if that value is false).
cpan5.40-x86_64-linux-gnu.1:276:As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
-.-.
Use a character "\(->" instead of plain "->" or "\->".
99:Creates a CPAN.pm autobundle with CPAN::Shell\->autobundle.
193:Recompiles dynamically loaded modules with CPAN::Shell\->recompile.
-.-.
Space after an end of sentence.
cpan5.40-x86_64-linux-gnu.1:69:\& cpan module_name [ module_name ... ]
cpan5.40-x86_64-linux-gnu.1:72:\& cpan [\-cfFimtTw] module_name [ module_name ... ]
cpan5.40-x86_64-linux-gnu.1:75:\& cpan \-I module_name [ module_name ... ]
cpan5.40-x86_64-linux-gnu.1:92:This script provides a command interface (not a shell) to CPAN. At the
cpan5.40-x86_64-linux-gnu.1:100:.IP "\-A module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:101:.IX Item "-A module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:106:.IP "\-C module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:107:.IX Item "-C module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:109:.IP "\-D module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:110:.IX Item "-D module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:111:Show the module details. This prints one line for each out-of-date module
cpan5.40-x86_64-linux-gnu.1:117:Force the specified action, when it normally would have failed. Use this
cpan5.40-x86_64-linux-gnu.1:118:to install a module even if its tests fail. When you use this option,
cpan5.40-x86_64-linux-gnu.1:126:Turn off CPAN.pm's attempts to lock anything. You should be careful with
cpan5.40-x86_64-linux-gnu.1:128:same directory. This isn't so much of a concern if you're loading a special
cpan5.40-x86_64-linux-gnu.1:130:.IP "\-g module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:131:.IX Item "-g module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:133:.IP "\-G module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:134:.IX Item "-G module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:145:Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
cpan5.40-x86_64-linux-gnu.1:147:.IP "\-i module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:148:.IX Item "-i module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:149:Install the specified modules. With no other switches, this switch
cpan5.40-x86_64-linux-gnu.1:153:Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
cpan5.40-x86_64-linux-gnu.1:157:Load the file that has the CPAN configuration data. This should have the
cpan5.40-x86_64-linux-gnu.1:162:Dump the configuration in the same format that CPAN.pm uses. This is useful
cpan5.40-x86_64-linux-gnu.1:168:.IP "\-L author [ author ... ]" 4
cpan5.40-x86_64-linux-gnu.1:169:.IX Item "-L author [ author ... ]"
cpan5.40-x86_64-linux-gnu.1:176:A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
cpan5.40-x86_64-linux-gnu.1:180:Do a dry run, but don't actually install anything. (unimplemented)
cpan5.40-x86_64-linux-gnu.1:196:Drop in the CPAN.pm shell. This command does this automatically if you don't
cpan5.40-x86_64-linux-gnu.1:198:.IP "\-t module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:199:.IX Item "-t module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:203:Do not test modules. Simply install them.
cpan5.40-x86_64-linux-gnu.1:206:Upgrade all installed modules. Blindly doing this can really break things,
cpan5.40-x86_64-linux-gnu.1:218:Turn on cpan warnings. This checks various things, like directory permissions,
cpan5.40-x86_64-linux-gnu.1:220:.IP "\-x module [ module ... ]" 4
cpan5.40-x86_64-linux-gnu.1:221:.IX Item "-x module [ module ... ]"
cpan5.40-x86_64-linux-gnu.1:223:mistyped. This requires the optional installation of Text::Levenshtein or
cpan5.40-x86_64-linux-gnu.1:259:while others matter to the levels above them. Some of these are specified
cpan5.40-x86_64-linux-gnu.1:268:that do that correctly. \f(CWcpan(1)\fR sets this to \f(CW1\fR unless it already
cpan5.40-x86_64-linux-gnu.1:272:Use the default answer for a prompted questions. \f(CWcpan(1)\fR sets this
cpan5.40-x86_64-linux-gnu.1:281:Log::Log4perl if it is installed. Possible values are the same as
cpan5.40-x86_64-linux-gnu.1:283:\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
cpan5.40-x86_64-linux-gnu.1:286:The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
cpan5.40-x86_64-linux-gnu.1:291:positive number if it thinks that something failed. Note, however, that
cpan5.40-x86_64-linux-gnu.1:293:not control. For now, the exit codes are vague:
-.-.
Put a subordinate sentence (after a comma) on a new line.
cpan5.40-x86_64-linux-gnu.1:68:\& # with arguments and no switches, installs specified modules
cpan5.40-x86_64-linux-gnu.1:71:\& # with switches, installs modules with extra behavior
cpan5.40-x86_64-linux-gnu.1:80:\& # with just the dot, install from the distribution in the
cpan5.40-x86_64-linux-gnu.1:84:\& # without arguments, starts CPAN.pm shell
cpan5.40-x86_64-linux-gnu.1:87:\& # without arguments, but some switches
cpan5.40-x86_64-linux-gnu.1:93:moment it uses CPAN.pm to do the work, but it is not a one-shot command
cpan5.40-x86_64-linux-gnu.1:112:(meaning, modules locally installed but have newer versions on CPAN).
cpan5.40-x86_64-linux-gnu.1:113:Each line has three columns: module name, local version, and CPAN
cpan5.40-x86_64-linux-gnu.1:117:Force the specified action, when it normally would have failed. Use this
cpan5.40-x86_64-linux-gnu.1:129:config with \f(CW\*(C`\-j\*(C'\fR, and that config sets up its own work directories.
cpan5.40-x86_64-linux-gnu.1:138:modules, unpack each distribution, and create a git repository for each
cpan5.40-x86_64-linux-gnu.1:141:If you want this feature, check out Yanick Champoux's \f(CW\*(C`Git::CPAN::Patch\*(C'\fR
cpan5.40-x86_64-linux-gnu.1:145:Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
cpan5.40-x86_64-linux-gnu.1:149:Install the specified modules. With no other switches, this switch
cpan5.40-x86_64-linux-gnu.1:158:same format as the standard \fICPAN/Config.pm\fR file, which defines
cpan5.40-x86_64-linux-gnu.1:164:for a new, custom configuration.
cpan5.40-x86_64-linux-gnu.1:180:Do a dry run, but don't actually install anything. (unimplemented)
cpan5.40-x86_64-linux-gnu.1:218:Turn on cpan warnings. This checks various things, like directory permissions,
cpan5.40-x86_64-linux-gnu.1:258:The build tools, ExtUtils::MakeMaker and Module::Build use some,
cpan5.40-x86_64-linux-gnu.1:276:As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
cpan5.40-x86_64-linux-gnu.1:280:The log level to use, with either the embedded, minimal logger or
cpan5.40-x86_64-linux-gnu.1:282:the \f(CW\*(C`Log::Log4perl\*(C'\fR levels: \f(CW\*(C`TRACE\*(C'\fR, \f(CW\*(C`DEBUG\*(C'\fR, \f(CW\*(C`INFO\*(C'\fR, \f(CW\*(C`WARN\*(C'\fR,
cpan5.40-x86_64-linux-gnu.1:283:\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
cpan5.40-x86_64-linux-gnu.1:290:The script exits with zero if it thinks that everything worked, or a
cpan5.40-x86_64-linux-gnu.1:291:positive number if it thinks that something failed. Note, however, that
cpan5.40-x86_64-linux-gnu.1:293:not control. For now, the exit codes are vague:
cpan5.40-x86_64-linux-gnu.1:312:Most behaviour, including environment variables and configuration,
cpan5.40-x86_64-linux-gnu.1:335:brian d foy, \f(CW\*(C`<bdfoy at cpan.org>\*(C'\fR
cpan5.40-x86_64-linux-gnu.1:338:Copyright (c) 2001\-2015, brian d foy, All Rights Reserved.
-.-.
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.
cpan5.40-x86_64-linux-gnu.1:66:.IX Header "SYNOPSIS"
cpan5.40-x86_64-linux-gnu.1:91:.IX Header "DESCRIPTION"
cpan5.40-x86_64-linux-gnu.1:96:.IX Subsection "Options"
cpan5.40-x86_64-linux-gnu.1:197:.IX Subsection "Examples"
cpan5.40-x86_64-linux-gnu.1:271:.IX Header "BUGS"
cpan5.40-x86_64-linux-gnu.1:288:.IX Header "CREDITS"
cpan5.40-x86_64-linux-gnu.1:297:.IX Header "AUTHOR"
cpan5.40-x86_64-linux-gnu.1:300:.IX Header "COPYRIGHT"
-.-.
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.
255:.SS "Environment variables"
288:.SH "EXIT VALUES"
304:.SH "TO DO"
310:.SH "SEE ALSO"
314:.SH "SOURCE AVAILABILITY"
-.-.
.\" Define a fallback for font CW with
.if t \{\
. ie \n(.g .ds fC \f(CR
. el .ds fC \f(CW
. \}
. ds fP \fP
.\}
More information about the Perl-maintainers
mailing list