($file = basename($0)) =~ s/\.PL$//;
$file =~ s/\.pl$//
if ($^O eq 'VMS' or $^O eq 'os2' or $^O eq 'dos'); # "case-forgiving"
+$file .= '.com' if $^O eq 'VMS';
open OUT,">$file" or die "Can't create $file: $!";
#############################################################################
# podchecker -- command to invoke the podchecker function in Pod::Checker
#
-# Derived from Tom Christiansen's pod2text script.
-# (with extensive modifications)
-#
-# Copyright (c) 1998 Bradford Appleton. All rights reserved.
+# Copyright (c) 1998-2000 by Bradford Appleton. All rights reserved.
# This file is part of "PodParser". PodParser is free software;
# you can redistribute it and/or modify it under the same terms
# as Perl itself.
#############################################################################
use strict;
-use diagnostics;
+#use diagnostics;
=head1 NAME
=head1 SYNOPSIS
-B<podchecker> [B<-help>] [B<-man>] [I<file>S< >...]
+B<podchecker> [B<-help>] [B<-man>] [B<-(no)warnings>] [I<file>S< >...]
=head1 OPTIONS AND ARGUMENTS
Print the manual page and exit.
+=item B<-warnings> B<-nowarnings>
+
+Turn on/off printing of warnings. Repeating B<-warnings> increases the
+warning level, i.e. more warnings are printed. Currently increasing to
+level two causes flagging of unescaped "E<lt>,E<gt>" characters.
+
=item I<file>
The pathname of a POD file to syntax-check (defaults to standard input).
it find to STDERR. At the end, it will print a status message
indicating the number of errors found.
+Directories are ignored, an appropriate warning message is printed.
+
B<podchecker> invokes the B<podchecker()> function exported by B<Pod::Checker>
Please see L<Pod::Checker/podchecker()> for more details.
+=head1 RETURN VALUE
+
+B<podchecker> returns a 0 (zero) exit status if all specified
+POD files are ok.
+
+=head1 ERRORS
+
+B<podchecker> returns the exit status 1 if at least one of
+the given POD files has syntax errors.
+
+The status 2 indicates that at least one of the specified
+files does not contain I<any> POD commands.
+
+Status 1 overrides status 2. If you want unambigouus
+results, call B<podchecker> with one single argument only.
+
=head1 SEE ALSO
L<Pod::Parser> and L<Pod::Checker>
-=head1 AUTHOR
+=head1 AUTHORS
+
+Please report bugs using L<http://rt.cpan.org>.
-Brad Appleton E<lt>bradapp@enteract.comE<gt>
+Brad Appleton E<lt>bradapp@enteract.comE<gt>,
+Marek Rouchal E<lt>marekr@cpan.orgE<gt>
Based on code for B<Pod::Text::pod2text(1)> written by
Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>
use Getopt::Long;
## Define options
-my %options = (
- "help" => 0,
- "man" => 0,
-);
+my %options;
## Parse options
-GetOptions(\%options, "help", "man") || pod2usage(2);
+GetOptions(\%options, qw(help man warnings+ nowarnings)) || pod2usage(2);
pod2usage(1) if ($options{help});
pod2usage(-verbose => 2) if ($options{man});
+if($options{nowarnings}) {
+ $options{warnings} = 0;
+}
+elsif(!defined $options{warnings}) {
+ $options{warnings} = 1; # default is warnings on
+}
+
## Dont default to STDIN if connected to a terminal
pod2usage(2) if ((@ARGV == 0) && (-t STDIN));
## Invoke podchecker()
-if(@ARGV) {
- for (@ARGV) { podchecker($_) };
-} else {
- podchecker("<&STDIN");
+my $status = 0;
+@ARGV = qw(-) unless(@ARGV);
+for my $podfile (@ARGV) {
+ if($podfile eq '-') {
+ $podfile = "<&STDIN";
+ }
+ elsif(-d $podfile) {
+ warn "podchecker: Warning: Ignoring directory '$podfile'\n";
+ next;
+ }
+ my $errors = podchecker($podfile, undef, '-warnings' => $options{warnings});
+ if($errors > 0) {
+ # errors occurred
+ printf STDERR ("%s has %d pod syntax %s.\n",
+ $podfile, $errors, ($errors == 1) ? "error" : "errors");
+ $status = 1;
+ }
+ elsif($errors < 0) {
+ print STDERR "$podfile does not contain any pod commands.\n";
+ # no pod found
+ $status = 2 unless($status);
+ }
+ else {
+ print STDERR "$podfile pod syntax OK.\n";
+ }
}
+exit $status;
!NO!SUBS!