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$//;
19 $file =~ s/\.pl$// if ($^O eq 'os2' or $^O eq 'dos'); # "case-forgiving"
20 $file =~ s/\.pl$/.com/ if ($^O eq 'VMS'); # "case-forgiving"
22 open OUT,">$file" or die "Can't create $file: $!";
24 print "Extracting $file (with variable substitutions)\n";
26 # In this section, perl variables will be expanded during extraction.
27 # You can use $Config{...} to use Configure variables.
29 print OUT <<"!GROK!THIS!";
31 eval 'exec perl -S \$0 "\$@"'
35 # In the following, perl variables are not expanded during extraction.
37 print OUT <<'!NO!SUBS!';
42 # !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
43 # This file is autogenerated by buildtoc.PL.
44 # Edit that file and run it to effect changes.
46 # Builds perltoc.pod and sanity checks the list of pods against all
47 # of the MANIFEST, perl.pod, and ourselves.
54 @PODS = glob("*.pod");
59 die "$0: failed to chdir('pod'): $!\n" unless chdir("pod");
190 for (@ARCHPODS) { s/$/.pod/ }
191 @ARCHPODS{@ARCHPODS} = ();
193 for (@pods) { s/$/.pod/ }
197 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
199 if (m!^pod/([^.]+\.pod)\s+!i) {
204 @MANIPODS{@MANIPODS} = ();
206 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
208 if (/^For ease of access, /../^\(If you're intending /) {
209 if (/^\s+(perl\S*)\s+\w/) {
210 push @PERLPODS, "$1.pod";
215 die "$0: could not find the pod listing of perl.pod\n"
217 @PERLPODS{@PERLPODS} = ();
219 # Cross-check against ourselves
220 # Cross-check against the MANIFEST
221 # Cross-check against the perl.pod
223 foreach my $i (sort keys %PODS) {
224 warn "$0: $i exists but is unknown by buildtoc\n"
225 unless exists $pods{$i};
226 warn "$0: $i exists but is unknown by ../MANIFEST\n"
227 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
228 warn "$0: $i exists but is unknown by perl.pod\n"
229 unless exists $PERLPODS{$i};
231 foreach my $i (sort keys %pods) {
232 warn "$0: $i is known by buildtoc but does not exist\n"
233 unless exists $PODS{$i};
235 foreach my $i (sort keys %MANIPODS) {
236 warn "$0: $i is known by ../MANIFEST but does not exist\n"
237 unless exists $PODS{$i};
239 foreach my $i (sort keys %PERLPODS) {
240 warn "$0: $i is known by perl.pod but does not exist\n"
241 unless exists $PODS{$i};
244 # We are ready to rock.
245 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
250 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
254 perltoc - perl documentation table of contents
258 This page provides a brief table of contents for the rest of the Perl
259 documentation set. It is meant to be scanned quickly or grepped
260 through to locate the proper section you're looking for.
262 =head1 BASIC DOCUMENTATION
269 find \&getpods => qw(../lib ../ext);
273 # Skip .pm files that have corresponding .pod files, and Functions.pm.
274 return if /(.*)\.pm$/ && -f "$1.pod";
275 my $file = $File::Find::name;
276 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
278 die "tut $name" if $file =~ /TUT/;
279 unless (open (F, "< $_\0")) {
280 warn "bogus <$file>: $!";
281 system "ls", "-l", $file;
285 while ($line = <F>) {
286 if ($line =~ /^=head1\s+NAME\b/) {
287 push @modpods, $file;
288 #warn "GOOD $file\n";
292 warn "$0: $file: cannot find =head1 NAME\n";
297 die "no pods" unless @modpods;
300 #($name) = /(\w+)\.p(m|od)$/;
301 $name = path2modname($_);
302 if ($name =~ /^[a-z]/) {
305 if ($done{$name}++) {
306 # warn "already did $_\n";
310 push @modname, $name;
314 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
318 =head1 PRAGMA DOCUMENTATION
322 podset(sort @pragmata);
324 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
328 =head1 MODULE DOCUMENTATION
332 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
334 ($_= <<EOPOD2B) =~ s/^\t//gm;
337 =head1 AUXILIARY DOCUMENTATION
339 Here should be listed all the extra programs' documentation, but they
340 don't all have manual pages yet:
366 Larry Wall <F<larry\@wall.org>>, with the help of oodles
372 output "\n"; # flush $LINE
379 if (s/^=head1 (NAME)\s*/=head2 /) {
380 $pod = path2modname($ARGV);
382 output "\n \n\n=head2 ";
384 if ( /^\s*$pod\b/ ) {
385 s/$pod\.pm/$pod/; # '.pm' in NAME !?
393 if (s/^=head1 (.*)/=item $1/) {
395 output "=over 4\n\n" unless $inhead1;
397 output $_; nl(); next;
399 if (s/^=head2 (.*)/=item $1/) {
401 output "=over 4\n\n" unless $inhead2;
403 output $_; nl(); next;
405 if (s/^=item ([^=].*)/$1/) {
406 next if $pod eq 'perldiag';
407 s/^\s*\*\s*$// && next;
412 next if $pod eq 'perlmodlib' && /^ftp:/;
413 ##print "=over 4\n\n" unless $initem;
414 output ", " if $initem;
420 if (s/^=cut\s*\n//) {
439 output "\n\n=back\n\n";
447 output "\n\n=back\n\n";
455 ##print "\n\n=back\n\n";
464 my $NEWLINE; # how many newlines have we seen recently
465 my $LINE; # what remains to be printed
468 for (split /(\n)/, shift) {
471 print OUT wrap('', '', $LINE);
479 elsif (/\S/ && length) {
488 close OUT or die "Can't close $file: $!";
489 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
490 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';