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");
201 for (@ARCHPODS) { s/$/.pod/ }
202 @ARCHPODS{@ARCHPODS} = ();
204 for (@pods) { s/$/.pod/ }
208 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
210 if (m!^pod/([^.]+\.pod)\s+!i) {
215 @MANIPODS{@MANIPODS} = ();
217 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
219 if (/^For ease of access, /../^\(If you're intending /) {
220 if (/^\s+(perl\S*)\s+\w/) {
221 push @PERLPODS, "$1.pod";
226 die "$0: could not find the pod listing of perl.pod\n"
228 @PERLPODS{@PERLPODS} = ();
230 # Cross-check against ourselves
231 # Cross-check against the MANIFEST
232 # Cross-check against the perl.pod
234 foreach my $i (sort keys %PODS) {
235 warn "$0: $i exists but is unknown by buildtoc\n"
236 unless exists $pods{$i};
237 warn "$0: $i exists but is unknown by ../MANIFEST\n"
238 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
239 warn "$0: $i exists but is unknown by perl.pod\n"
240 unless exists $PERLPODS{$i};
242 foreach my $i (sort keys %pods) {
243 warn "$0: $i is known by buildtoc but does not exist\n"
244 unless exists $PODS{$i};
246 foreach my $i (sort keys %MANIPODS) {
247 warn "$0: $i is known by ../MANIFEST but does not exist\n"
248 unless exists $PODS{$i};
250 foreach my $i (sort keys %PERLPODS) {
251 warn "$0: $i is known by perl.pod but does not exist\n"
252 unless exists $PODS{$i};
255 # We are ready to rock.
256 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
261 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
265 perltoc - perl documentation table of contents
269 This page provides a brief table of contents for the rest of the Perl
270 documentation set. It is meant to be scanned quickly or grepped
271 through to locate the proper section you're looking for.
273 =head1 BASIC DOCUMENTATION
280 find \&getpods => qw(../lib ../ext);
284 # Skip .pm files that have corresponding .pod files, and Functions.pm.
285 return if /(.*)\.pm$/ && -f "$1.pod";
286 my $file = $File::Find::name;
287 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
288 return if $file =~ m!lib/Attribute/Handlers/demo/!;
290 die "tut $name" if $file =~ /TUT/;
291 unless (open (F, "< $_\0")) {
292 warn "bogus <$file>: $!";
293 system "ls", "-l", $file;
297 while ($line = <F>) {
298 if ($line =~ /^=head1\s+NAME\b/) {
299 push @modpods, $file;
300 #warn "GOOD $file\n";
304 warn "$0: $file: cannot find =head1 NAME\n";
309 die "no pods" unless @modpods;
312 #($name) = /(\w+)\.p(m|od)$/;
313 $name = path2modname($_);
314 if ($name =~ /^[a-z]/) {
317 if ($done{$name}++) {
318 # warn "already did $_\n";
322 push @modname, $name;
326 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
330 =head1 PRAGMA DOCUMENTATION
334 podset(sort @pragmata);
336 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
340 =head1 MODULE DOCUMENTATION
344 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
346 ($_= <<EOPOD2B) =~ s/^\t//gm;
349 =head1 AUXILIARY DOCUMENTATION
351 Here should be listed all the extra programs' documentation, but they
352 don't all have manual pages yet:
378 Larry Wall <F<larry\@wall.org>>, with the help of oodles
384 output "\n"; # flush $LINE
391 if (s/^=head1 (NAME)\s*/=head2 /) {
392 $pod = path2modname($ARGV);
394 output "\n \n\n=head2 ";
396 if ( /^\s*$pod\b/ ) {
397 s/$pod\.pm/$pod/; # '.pm' in NAME !?
405 if (s/^=head1 (.*)/=item $1/) {
407 output "=over 4\n\n" unless $inhead1;
409 output $_; nl(); next;
411 if (s/^=head2 (.*)/=item $1/) {
413 output "=over 4\n\n" unless $inhead2;
415 output $_; nl(); next;
417 if (s/^=item ([^=].*)/$1/) {
418 next if $pod eq 'perldiag';
419 s/^\s*\*\s*$// && next;
424 next if $pod eq 'perlmodlib' && /^ftp:/;
425 ##print "=over 4\n\n" unless $initem;
426 output ", " if $initem;
432 if (s/^=cut\s*\n//) {
451 output "\n\n=back\n\n";
459 output "\n\n=back\n\n";
467 ##print "\n\n=back\n\n";
476 my $NEWLINE; # how many newlines have we seen recently
477 my $LINE; # what remains to be printed
480 for (split /(\n)/, shift) {
483 print OUT wrap('', '', $LINE);
491 elsif (/\S/ && length) {
500 close OUT or die "Can't close $file: $!";
501 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
502 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';