| Subject: | Update POD to reflect that -verbose => 0 shows SYNOPSIS|USAGE (patch attached) |
Hi Marek,
It seems that POD sections entitled "SYNOPSIS" *or* "USAGE" are included with 'pod2usage(-verbose => 0)', yet there is no mention of "USAGE" in the documentation.
The included patch (apply with 'patch -p1') makes the necessary correction to the Pod::Usage POD.
This is my first patch to any CPAN library, so I am open to coaching or any constructive criticism.
Cheers,
Kevin
| Subject: | synopsis_and_or_usage.patch |
diff -ru Pod-Usage-1.70.orig/lib/Pod/Usage.pm Pod-Usage-1.70/lib/Pod/Usage.pm
--- Pod-Usage-1.70.orig/lib/Pod/Usage.pm 2020-03-15 14:36:26.000000000 -0400
+++ Pod-Usage-1.70/lib/Pod/Usage.pm 2020-08-28 09:06:13.875169818 -0400
@@ -468,13 +468,13 @@
=item C<-verbose> I<value>
The desired level of "verboseness" to use when printing the usage message.
-If the value is 0, then only the "SYNOPSIS" section of the pod documentation
-is printed. If the value is 1, then the "SYNOPSIS" section, along with any
-section entitled "OPTIONS", "ARGUMENTS", or "OPTIONS AND ARGUMENTS" is
-printed. If the corresponding value is 2 or more then the entire manpage is
-printed, using L<perldoc> if available; otherwise L<Pod::Text> is used for
-the formatting. For better readability, the all-capital headings are
-downcased, e.g. C<SYNOPSIS> =E<gt> C<Synopsis>.
+If the value is 0, then only the "SYNOPSIS" and/or "USAGE" sections of the
+pod documentation are printed. If the value is 1, then the "SYNOPSIS" and/or
+"USAGE" sections, along with any section entitled "OPTIONS", "ARGUMENTS", or
+"OPTIONS AND ARGUMENTS" is printed. If the corresponding value is 2 or more
+then the entire manpage is printed, using L<perldoc> if available; otherwise
+L<Pod::Text> is used for the formatting. For better readability, the
+all-capital headings are downcased, e.g. C<SYNOPSIS> =E<gt> C<Synopsis>.
The special verbosity level 99 requires to also specify the -sections
parameter; then these sections are extracted and printed.