home *** CD-ROM | disk | FTP | other *** search
/ PC World 2004 November / PCWorld_2004-11_cd.bin / software / topware / activeperl / ActivePerl-5.8.4.810-MSWin32-x86.exe / ActivePerl-5.8.4.810 / Perl / bin / podchecker.bat < prev    next >
DOS Batch File  |  2004-06-01  |  4KB  |  160 lines
  1. @rem = '--*-Perl-*--
  2. @echo off
  3. if "%OS%" == "Windows_NT" goto WinNT
  4. perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
  5. goto endofperl
  6. :WinNT
  7. perl -x -S %0 %*
  8. if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
  9. if %errorlevel% == 9009 echo You do not have Perl in your PATH.
  10. if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
  11. goto endofperl
  12. @rem ';
  13. #!perl
  14. #line 15
  15.     eval 'exec perl -S $0 "$@"'
  16.         if 0;
  17. #############################################################################
  18. # podchecker -- command to invoke the podchecker function in Pod::Checker
  19. #
  20. # Copyright (c) 1998-2000 by Bradford Appleton. All rights reserved.
  21. # This file is part of "PodParser". PodParser is free software;
  22. # you can redistribute it and/or modify it under the same terms
  23. # as Perl itself.
  24. #############################################################################
  25.  
  26. use strict;
  27. #use diagnostics;
  28.  
  29. =head1 NAME
  30.  
  31. podchecker - check the syntax of POD format documentation files
  32.  
  33. =head1 SYNOPSIS
  34.  
  35. B<podchecker> [B<-help>] [B<-man>] [B<-(no)warnings>] [I<file>S< >...]
  36.  
  37. =head1 OPTIONS AND ARGUMENTS
  38.  
  39. =over 8
  40.  
  41. =item B<-help>
  42.  
  43. Print a brief help message and exit.
  44.  
  45. =item B<-man>
  46.  
  47. Print the manual page and exit.
  48.  
  49. =item B<-warnings> B<-nowarnings>
  50.  
  51. Turn on/off printing of warnings. Repeating B<-warnings> increases the
  52. warning level, i.e. more warnings are printed. Currently increasing to
  53. level two causes flagging of unescaped "E<lt>,E<gt>" characters.
  54.  
  55. =item I<file>
  56.  
  57. The pathname of a POD file to syntax-check (defaults to standard input).
  58.  
  59. =back
  60.  
  61. =head1 DESCRIPTION
  62.  
  63. B<podchecker> will read the given input files looking for POD
  64. syntax errors in the POD documentation and will print any errors
  65. it find to STDERR. At the end, it will print a status message
  66. indicating the number of errors found.
  67.  
  68. Directories are ignored, an appropriate warning message is printed.
  69.  
  70. B<podchecker> invokes the B<podchecker()> function exported by B<Pod::Checker>
  71. Please see L<Pod::Checker/podchecker()> for more details.
  72.  
  73. =head1 RETURN VALUE
  74.  
  75. B<podchecker> returns a 0 (zero) exit status if all specified
  76. POD files are ok.
  77.  
  78. =head1 ERRORS
  79.  
  80. B<podchecker> returns the exit status 1 if at least one of
  81. the given POD files has syntax errors.
  82.  
  83. The status 2 indicates that at least one of the specified 
  84. files does not contain I<any> POD commands.
  85.  
  86. Status 1 overrides status 2. If you want unambigouus
  87. results, call B<podchecker> with one single argument only.
  88.  
  89. =head1 SEE ALSO
  90.  
  91. L<Pod::Parser> and L<Pod::Checker>
  92.  
  93. =head1 AUTHORS
  94.  
  95. Brad Appleton E<lt>bradapp@enteract.comE<gt>,
  96. Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>
  97.  
  98. Based on code for B<Pod::Text::pod2text(1)> written by
  99. Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>
  100.  
  101. =cut
  102.  
  103.  
  104. use Pod::Checker;
  105. use Pod::Usage;
  106. use Getopt::Long;
  107.  
  108. ## Define options
  109. my %options;
  110.  
  111. ## Parse options
  112. GetOptions(\%options, qw(help man warnings+ nowarnings))  ||  pod2usage(2);
  113. pod2usage(1)  if ($options{help});
  114. pod2usage(-verbose => 2)  if ($options{man});
  115.  
  116. if($options{nowarnings}) {
  117.   $options{warnings} = 0;
  118. }
  119. elsif(!defined $options{warnings}) {
  120.   $options{warnings} = 1; # default is warnings on
  121. }
  122.  
  123. ## Dont default to STDIN if connected to a terminal
  124. pod2usage(2) if ((@ARGV == 0) && (-t STDIN));
  125.  
  126. ## Invoke podchecker()
  127. my $status = 0;
  128. @ARGV = qw(-) unless(@ARGV);
  129. for my $podfile (@ARGV) {
  130.     if($podfile eq '-') {
  131.       $podfile = "<&STDIN";
  132.     }
  133.     elsif(-d $podfile) {
  134.       warn "podchecker: Warning: Ignoring directory '$podfile'\n";
  135.       next;
  136.     }
  137.     my $errors = 
  138.       podchecker($podfile, undef, '-warnings' => $options{warnings});
  139.     if($errors > 0) {
  140.         # errors occurred
  141.         $status = 1;
  142.         printf STDERR ("%s has %d pod syntax %s.\n",
  143.                        $podfile, $errors,
  144.                        ($errors == 1) ? "error" : "errors");
  145.     }
  146.     elsif($errors < 0) {
  147.         # no pod found
  148.         $status = 2 unless($status);
  149.         print STDERR "$podfile does not contain any pod commands.\n";
  150.     }
  151.     else {
  152.         print STDERR "$podfile pod syntax OK.\n";
  153.     }
  154. }
  155. exit $status;
  156.  
  157.  
  158. __END__
  159. :endofperl
  160.