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");
215 for (@ARCHPODS) { s/$/.pod/ }
216 @ARCHPODS{@ARCHPODS} = ();
218 for (@CJKPODS) { s/$/.pod/ }
219 @CJKPODS{@CJKPODS} = ();
221 for (@pods) { s/$/.pod/ }
225 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
227 if (m!^pod/([^.]+\.pod)\s+!i) {
232 @MANIPODS{@MANIPODS} = ();
234 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
236 if (/^For ease of access, /../^\(If you're intending /) {
237 if (/^\s+(perl\S*)\s+\w/) {
238 push @PERLPODS, "$1.pod";
243 die "$0: could not find the pod listing of perl.pod\n"
245 @PERLPODS{@PERLPODS} = ();
247 # Delete the CJK because we cannot mix their encodings.
248 delete @PERLPODS{@CJKPODS};
249 delete @PODS{@CJKPODS};
250 delete @pods{@CJKPODS};
252 # Cross-check against ourselves
253 # Cross-check against the MANIFEST
254 # Cross-check against the perl.pod
256 foreach my $i (sort keys %PODS) {
257 warn "$0: $i exists but is unknown by buildtoc\n"
258 unless exists $pods{$i};
259 warn "$0: $i exists but is unknown by ../MANIFEST\n"
260 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i} && !exists $CJKPODS{$i};
261 warn "$0: $i exists but is unknown by perl.pod\n"
262 unless exists $PERLPODS{$i};
264 foreach my $i (sort keys %pods) {
265 warn "$0: $i is known by buildtoc but does not exist\n"
266 unless exists $PODS{$i};
268 foreach my $i (sort keys %MANIPODS) {
269 warn "$0: $i is known by ../MANIFEST but does not exist\n"
270 unless exists $PODS{$i};
272 foreach my $i (sort keys %PERLPODS) {
273 warn "$0: $i is known by perl.pod but does not exist\n"
274 unless exists $PODS{$i};
277 # We are ready to rock.
278 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
283 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
287 perltoc - perl documentation table of contents
291 This page provides a brief table of contents for the rest of the Perl
292 documentation set. It is meant to be scanned quickly or grepped
293 through to locate the proper section you're looking for.
295 =head1 BASIC DOCUMENTATION
302 find \&getpods => qw(../lib ../ext);
306 my $file = $File::Find::name;
307 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
308 return if $file =~ m!lib/Attribute/Handlers/demo/!;
309 return if $file =~ m!lib/Net/FTP/.+\.pm!; # Hi, Graham! :-)
310 return if $file =~ m!lib/Math/BigInt/t/!;
311 return if $file =~ m!/Devel/PPPort/[Hh]arness|lib/Devel/Harness!i;
312 die "tut $name" if $file =~ /TUT/;
313 unless (open (F, "< $_\0")) {
314 warn "bogus <$file>: $!";
315 system "ls", "-l", $file;
319 while ($line = <F>) {
320 if ($line =~ /^=head1\s+NAME\b/) {
321 push @modpods, $file;
322 #warn "GOOD $file\n";
326 warn "$0: $file: cannot find =head1 NAME\n";
331 die "no pods" unless @modpods;
334 #($name) = /(\w+)\.p(m|od)$/;
335 $name = path2modname($_);
336 if ($name =~ /^[a-z]/) {
339 if ($done{$name}++) {
340 # warn "already did $_\n";
344 push @modname, $name;
348 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
352 =head1 PRAGMA DOCUMENTATION
356 podset(sort @pragmata);
358 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
362 =head1 MODULE DOCUMENTATION
366 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
368 ($_= <<EOPOD2B) =~ s/^\t//gm;
371 =head1 AUXILIARY DOCUMENTATION
373 Here should be listed all the extra programs' documentation, but they
374 don't all have manual pages yet:
400 Larry Wall <F<larry\@wall.org>>, with the help of oodles
406 output "\n"; # flush $LINE
413 if (s/^=head1 (NAME)\s*/=head2 /) {
414 $pod = path2modname($ARGV);
416 output "\n \n\n=head2 ";
418 if ( /^\s*$pod\b/ ) {
419 s/$pod\.pm/$pod/; # '.pm' in NAME !?
427 if (s/^=head1 (.*)/=item $1/) {
429 output "=over 4\n\n" unless $inhead1;
431 output $_; nl(); next;
433 if (s/^=head2 (.*)/=item $1/) {
435 output "=over 4\n\n" unless $inhead2;
437 output $_; nl(); next;
439 if (s/^=item ([^=].*)/$1/) {
440 next if $pod eq 'perldiag';
441 s/^\s*\*\s*$// && next;
446 next if $pod eq 'perlmodlib' && /^ftp:/;
447 ##print "=over 4\n\n" unless $initem;
448 output ", " if $initem;
454 if (s/^=cut\s*\n//) {
473 output "\n\n=back\n\n";
481 output "\n\n=back\n\n";
489 ##print "\n\n=back\n\n";
498 my $NEWLINE; # how many newlines have we seen recently
499 my $LINE; # what remains to be printed
502 for (split /(\n)/, shift) {
505 print OUT wrap('', '', $LINE);
513 elsif (/\S/ && length) {
522 close OUT or die "Can't close $file: $!";
523 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
524 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';