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");
206 for (@ARCHPODS) { s/$/.pod/ }
207 @ARCHPODS{@ARCHPODS} = ();
209 for (@pods) { s/$/.pod/ }
213 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
215 if (m!^pod/([^.]+\.pod)\s+!i) {
220 @MANIPODS{@MANIPODS} = ();
222 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
224 if (/^For ease of access, /../^\(If you're intending /) {
225 if (/^\s+(perl\S*)\s+\w/) {
226 push @PERLPODS, "$1.pod";
231 die "$0: could not find the pod listing of perl.pod\n"
233 @PERLPODS{@PERLPODS} = ();
235 # Cross-check against ourselves
236 # Cross-check against the MANIFEST
237 # Cross-check against the perl.pod
239 foreach my $i (sort keys %PODS) {
240 warn "$0: $i exists but is unknown by buildtoc\n"
241 unless exists $pods{$i};
242 warn "$0: $i exists but is unknown by ../MANIFEST\n"
243 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
244 warn "$0: $i exists but is unknown by perl.pod\n"
245 unless exists $PERLPODS{$i};
247 foreach my $i (sort keys %pods) {
248 warn "$0: $i is known by buildtoc but does not exist\n"
249 unless exists $PODS{$i};
251 foreach my $i (sort keys %MANIPODS) {
252 warn "$0: $i is known by ../MANIFEST but does not exist\n"
253 unless exists $PODS{$i};
255 foreach my $i (sort keys %PERLPODS) {
256 warn "$0: $i is known by perl.pod but does not exist\n"
257 unless exists $PODS{$i};
260 # We are ready to rock.
261 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
266 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
270 perltoc - perl documentation table of contents
274 This page provides a brief table of contents for the rest of the Perl
275 documentation set. It is meant to be scanned quickly or grepped
276 through to locate the proper section you're looking for.
278 =head1 BASIC DOCUMENTATION
285 find \&getpods => qw(../lib ../ext);
289 # Skip .pm files that have corresponding .pod files, and Functions.pm.
290 return if /(.*)\.pm$/ && -f "$1.pod";
291 my $file = $File::Find::name;
292 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
293 return if $file =~ m!lib/Attribute/Handlers/demo/!;
294 return if $file =~ m!lib/Net/FTP/.+\.pm!; # Hi, Graham! :-)
295 return if $file =~ m!lib/Math/BigInt/t/!;
296 return if $file =~ m!/Devel/PPPort/[Hh]arness|lib/Devel/Harness!i;
297 die "tut $name" if $file =~ /TUT/;
298 unless (open (F, "< $_\0")) {
299 warn "bogus <$file>: $!";
300 system "ls", "-l", $file;
304 while ($line = <F>) {
305 if ($line =~ /^=head1\s+NAME\b/) {
306 push @modpods, $file;
307 #warn "GOOD $file\n";
311 warn "$0: $file: cannot find =head1 NAME\n";
316 die "no pods" unless @modpods;
319 #($name) = /(\w+)\.p(m|od)$/;
320 $name = path2modname($_);
321 if ($name =~ /^[a-z]/) {
324 if ($done{$name}++) {
325 # warn "already did $_\n";
329 push @modname, $name;
333 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
337 =head1 PRAGMA DOCUMENTATION
341 podset(sort @pragmata);
343 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
347 =head1 MODULE DOCUMENTATION
351 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
353 ($_= <<EOPOD2B) =~ s/^\t//gm;
356 =head1 AUXILIARY DOCUMENTATION
358 Here should be listed all the extra programs' documentation, but they
359 don't all have manual pages yet:
385 Larry Wall <F<larry\@wall.org>>, with the help of oodles
391 output "\n"; # flush $LINE
398 if (s/^=head1 (NAME)\s*/=head2 /) {
399 $pod = path2modname($ARGV);
401 output "\n \n\n=head2 ";
403 if ( /^\s*$pod\b/ ) {
404 s/$pod\.pm/$pod/; # '.pm' in NAME !?
412 if (s/^=head1 (.*)/=item $1/) {
414 output "=over 4\n\n" unless $inhead1;
416 output $_; nl(); next;
418 if (s/^=head2 (.*)/=item $1/) {
420 output "=over 4\n\n" unless $inhead2;
422 output $_; nl(); next;
424 if (s/^=item ([^=].*)/$1/) {
425 next if $pod eq 'perldiag';
426 s/^\s*\*\s*$// && next;
431 next if $pod eq 'perlmodlib' && /^ftp:/;
432 ##print "=over 4\n\n" unless $initem;
433 output ", " if $initem;
439 if (s/^=cut\s*\n//) {
458 output "\n\n=back\n\n";
466 output "\n\n=back\n\n";
474 ##print "\n\n=back\n\n";
483 my $NEWLINE; # how many newlines have we seen recently
484 my $LINE; # what remains to be printed
487 for (split /(\n)/, shift) {
490 print OUT wrap('', '', $LINE);
498 elsif (/\S/ && length) {
507 close OUT or die "Can't close $file: $!";
508 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
509 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';