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");
205 for (@ARCHPODS) { s/$/.pod/ }
206 @ARCHPODS{@ARCHPODS} = ();
208 for (@pods) { s/$/.pod/ }
212 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
214 if (m!^pod/([^.]+\.pod)\s+!i) {
219 @MANIPODS{@MANIPODS} = ();
221 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
223 if (/^For ease of access, /../^\(If you're intending /) {
224 if (/^\s+(perl\S*)\s+\w/) {
225 push @PERLPODS, "$1.pod";
230 die "$0: could not find the pod listing of perl.pod\n"
232 @PERLPODS{@PERLPODS} = ();
234 # Cross-check against ourselves
235 # Cross-check against the MANIFEST
236 # Cross-check against the perl.pod
238 foreach my $i (sort keys %PODS) {
239 warn "$0: $i exists but is unknown by buildtoc\n"
240 unless exists $pods{$i};
241 warn "$0: $i exists but is unknown by ../MANIFEST\n"
242 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
243 warn "$0: $i exists but is unknown by perl.pod\n"
244 unless exists $PERLPODS{$i};
246 foreach my $i (sort keys %pods) {
247 warn "$0: $i is known by buildtoc but does not exist\n"
248 unless exists $PODS{$i};
250 foreach my $i (sort keys %MANIPODS) {
251 warn "$0: $i is known by ../MANIFEST but does not exist\n"
252 unless exists $PODS{$i};
254 foreach my $i (sort keys %PERLPODS) {
255 warn "$0: $i is known by perl.pod but does not exist\n"
256 unless exists $PODS{$i};
259 # We are ready to rock.
260 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
265 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
269 perltoc - perl documentation table of contents
273 This page provides a brief table of contents for the rest of the Perl
274 documentation set. It is meant to be scanned quickly or grepped
275 through to locate the proper section you're looking for.
277 =head1 BASIC DOCUMENTATION
284 find \&getpods => qw(../lib ../ext);
288 # Skip .pm files that have corresponding .pod files, and Functions.pm.
289 return if /(.*)\.pm$/ && -f "$1.pod";
290 my $file = $File::Find::name;
291 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
292 return if $file =~ m!lib/Attribute/Handlers/demo/!;
293 return if $file =~ m!lib/Net/FTP/.+\.pm!; # Hi, Graham! :-)
294 return if $file =~ m!lib/Math/BigInt/t/!;
295 return if $file =~ m!/Devel/PPPort/[Hh]arness|lib/Devel/Harness!i;
296 die "tut $name" if $file =~ /TUT/;
297 unless (open (F, "< $_\0")) {
298 warn "bogus <$file>: $!";
299 system "ls", "-l", $file;
303 while ($line = <F>) {
304 if ($line =~ /^=head1\s+NAME\b/) {
305 push @modpods, $file;
306 #warn "GOOD $file\n";
310 warn "$0: $file: cannot find =head1 NAME\n";
315 die "no pods" unless @modpods;
318 #($name) = /(\w+)\.p(m|od)$/;
319 $name = path2modname($_);
320 if ($name =~ /^[a-z]/) {
323 if ($done{$name}++) {
324 # warn "already did $_\n";
328 push @modname, $name;
332 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
336 =head1 PRAGMA DOCUMENTATION
340 podset(sort @pragmata);
342 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
346 =head1 MODULE DOCUMENTATION
350 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
352 ($_= <<EOPOD2B) =~ s/^\t//gm;
355 =head1 AUXILIARY DOCUMENTATION
357 Here should be listed all the extra programs' documentation, but they
358 don't all have manual pages yet:
384 Larry Wall <F<larry\@wall.org>>, with the help of oodles
390 output "\n"; # flush $LINE
397 if (s/^=head1 (NAME)\s*/=head2 /) {
398 $pod = path2modname($ARGV);
400 output "\n \n\n=head2 ";
402 if ( /^\s*$pod\b/ ) {
403 s/$pod\.pm/$pod/; # '.pm' in NAME !?
411 if (s/^=head1 (.*)/=item $1/) {
413 output "=over 4\n\n" unless $inhead1;
415 output $_; nl(); next;
417 if (s/^=head2 (.*)/=item $1/) {
419 output "=over 4\n\n" unless $inhead2;
421 output $_; nl(); next;
423 if (s/^=item ([^=].*)/$1/) {
424 next if $pod eq 'perldiag';
425 s/^\s*\*\s*$// && next;
430 next if $pod eq 'perlmodlib' && /^ftp:/;
431 ##print "=over 4\n\n" unless $initem;
432 output ", " if $initem;
438 if (s/^=cut\s*\n//) {
457 output "\n\n=back\n\n";
465 output "\n\n=back\n\n";
473 ##print "\n\n=back\n\n";
482 my $NEWLINE; # how many newlines have we seen recently
483 my $LINE; # what remains to be printed
486 for (split /(\n)/, shift) {
489 print OUT wrap('', '', $LINE);
497 elsif (/\S/ && length) {
506 close OUT or die "Can't close $file: $!";
507 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
508 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';