4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 ($file = basename($0)) =~ s/\.PL$//;
20 if ($^O eq 'VMS' or $^O eq 'os2' or $^O eq 'dos'); # "case-forgiving"
21 $file .= '.com' if $^O eq 'VMS';
23 open OUT,">$file" or die "Can't create $file: $!";
25 print "Extracting $file (with variable substitutions)\n";
27 # In this section, perl variables will be expanded during extraction.
28 # You can use $Config{...} to use Configure variables.
30 print OUT <<"!GROK!THIS!";
32 eval 'exec perl -S \$0 "\$@"'
36 # In the following, perl variables are not expanded during extraction.
38 print OUT <<'!NO!SUBS!';
39 #############################################################################
40 # podchecker -- command to invoke the podchecker function in Pod::Checker
42 # Copyright (c) 1998-1999 by Bradford Appleton. All rights reserved.
43 # This file is part of "PodParser". PodParser is free software;
44 # you can redistribute it and/or modify it under the same terms
46 #############################################################################
53 podchecker - check the syntax of POD format documentation files
57 B<podchecker> [B<-help>] [B<-man>] [B<-(no)warnings>] [I<file>S< >...]
59 =head1 OPTIONS AND ARGUMENTS
65 Print a brief help message and exit.
69 Print the manual page and exit.
71 =item B<-warnings> B<-nowarnings>
73 Turn on/off printing of warnings.
77 The pathname of a POD file to syntax-check (defaults to standard input).
83 B<podchecker> will read the given input files looking for POD
84 syntax errors in the POD documentation and will print any errors
85 it find to STDERR. At the end, it will print a status message
86 indicating the number of errors found.
88 B<podchecker> invokes the B<podchecker()> function exported by B<Pod::Checker>
89 Please see L<Pod::Checker/podchecker()> for more details.
93 B<podchecker> returns a 0 (zero) exit status if all specified
98 B<podchecker> returns the exit status 1 if at least one of
99 the given POD files has syntax errors.
101 The status 2 indicates that at least one of the specified
102 files does not contain I<any> POD commands.
104 Status 1 overrides status 2. If you want unambigouus
105 results, call B<podchecker> with one single argument only.
109 L<Pod::Parser> and L<Pod::Checker>
113 Brad Appleton E<lt>bradapp@enteract.comE<gt>,
114 Marek Rouchal E<lt>marek@saftsack.fs.uni-bayreuth.deE<gt>
116 Based on code for B<Pod::Text::pod2text(1)> written by
117 Tom Christiansen E<lt>tchrist@mox.perl.comE<gt>
134 GetOptions(\%options, "help", "man", "warnings!") || pod2usage(2);
135 pod2usage(1) if ($options{help});
136 pod2usage(-verbose => 2) if ($options{man});
138 ## Dont default to STDIN if connected to a terminal
139 pod2usage(2) if ((@ARGV == 0) && (-t STDIN));
141 ## Invoke podchecker()
143 @ARGV = ("<&STDIN") unless(@ARGV);
145 my $s = podchecker($_, undef, '-warnings' => $options{warnings});
152 $status = 2 unless($status);
159 close OUT or die "Can't close $file: $!";
160 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
161 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';