#!/usr/bin/perl eval 'exec perl -S $0 "$@"' if 0; ############################################################################# # podchecker -- command to invoke the podchecker function in Pod::Checker # # Copyright (c) 1998-2000 by Bradford Appleton. All rights reserved. # This is free software; you can redistribute it and/or modify it under the # same terms as Perl itself. ############################################################################# use strict; #use diagnostics; =head1 NAME podchecker - check the syntax of POD format documentation files =head1 SYNOPSIS B [B<-help>] [B<-man>] [B<-(no)warnings>] [IS< >...] =head1 OPTIONS AND ARGUMENTS =over 8 =item B<-help> Print a brief help message and exit. =item B<-man> 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,E" characters. =item I The pathname of a POD file to syntax-check (defaults to standard input). =back =head1 DESCRIPTION B will read the given input files looking for POD syntax errors in the POD documentation and will print any errors 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 invokes the B function exported by B Please see L for more details. =head1 RETURN VALUE B returns a 0 (zero) exit status if all specified POD files are ok. =head1 ERRORS B 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 POD commands. Status 1 overrides status 2. If you want unambiguous results, call B with one single argument only. =head1 SEE ALSO L and L =head1 AUTHORS Please report bugs using L. Brad Appleton Ebradapp@enteract.comE, Marek Rouchal Emarekr@cpan.orgE Based on code for B written by Tom Christiansen Etchrist@mox.perl.comE =cut use Pod::Checker; use Pod::Usage; use Getopt::Long; ## Define options my %options; ## Parse options 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() 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 $status = 1; printf STDERR ("%s has %d pod syntax %s.\n", $podfile, $errors, ($errors == 1) ? 'error' : 'errors'); } elsif($errors < 0) { # no pod found $status = 2 unless($status); print STDERR "$podfile does not contain any pod commands.\n"; } else { print STDERR "$podfile pod syntax OK.\n"; } } exit $status;