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");
187 for (@ARCHPODS) { s/$/.pod/ }
188 @ARCHPODS{@ARCHPODS} = ();
190 for (@pods) { s/$/.pod/ }
194 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
196 if (m!^pod/([^.]+\.pod)\s+!i) {
201 @MANIPODS{@MANIPODS} = ();
203 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
205 if (/^For ease of access, /../^\(If you're intending /) {
206 if (/^\s+(perl\S*)\s+\w/) {
207 push @PERLPODS, "$1.pod";
212 die "$0: could not find the pod listing of perl.pod\n"
214 @PERLPODS{@PERLPODS} = ();
216 # Cross-check against ourselves
217 # Cross-check against the MANIFEST
218 # Cross-check against the perl.pod
220 foreach my $i (sort keys %PODS) {
221 warn "$0: $i exists but is unknown by buildtoc\n"
222 unless exists $pods{$i};
223 warn "$0: $i exists but is unknown by ../MANIFEST\n"
224 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
225 warn "$0: $i exists but is unknown by perl.pod\n"
226 unless exists $PERLPODS{$i};
228 foreach my $i (sort keys %pods) {
229 warn "$0: $i is known by buildtoc but does not exist\n"
230 unless exists $PODS{$i};
232 foreach my $i (sort keys %MANIPODS) {
233 warn "$0: $i is known by ../MANIFEST but does not exist\n"
234 unless exists $PODS{$i};
236 foreach my $i (sort keys %PERLPODS) {
237 warn "$0: $i is known by perl.pod but does not exist\n"
238 unless exists $PODS{$i};
241 # We are ready to rock.
242 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
247 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
251 perltoc - perl documentation table of contents
255 This page provides a brief table of contents for the rest of the Perl
256 documentation set. It is meant to be scanned quickly or grepped
257 through to locate the proper section you're looking for.
259 =head1 BASIC DOCUMENTATION
266 find \&getpods => qw(../lib ../ext);
270 # Skip .pm files that have corresponding .pod files, and Functions.pm.
271 return if /(.*)\.pm$/ && -f "$1.pod";
272 my $file = $File::Find::name;
273 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
275 die "tut $name" if $file =~ /TUT/;
276 unless (open (F, "< $_\0")) {
277 warn "bogus <$file>: $!";
278 system "ls", "-l", $file;
282 while ($line = <F>) {
283 if ($line =~ /^=head1\s+NAME\b/) {
284 push @modpods, $file;
285 #warn "GOOD $file\n";
289 warn "$0: $file: cannot find =head1 NAME\n";
294 die "no pods" unless @modpods;
297 #($name) = /(\w+)\.p(m|od)$/;
298 $name = path2modname($_);
299 if ($name =~ /^[a-z]/) {
302 if ($done{$name}++) {
303 # warn "already did $_\n";
307 push @modname, $name;
311 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
315 =head1 PRAGMA DOCUMENTATION
319 podset(sort @pragmata);
321 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
325 =head1 MODULE DOCUMENTATION
329 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
331 ($_= <<EOPOD2B) =~ s/^\t//gm;
334 =head1 AUXILIARY DOCUMENTATION
336 Here should be listed all the extra programs' documentation, but they
337 don't all have manual pages yet:
363 Larry Wall <F<larry\@wall.org>>, with the help of oodles
369 output "\n"; # flush $LINE
376 if (s/^=head1 (NAME)\s*/=head2 /) {
377 $pod = path2modname($ARGV);
379 output "\n \n\n=head2 ";
381 if ( /^\s*$pod\b/ ) {
382 s/$pod\.pm/$pod/; # '.pm' in NAME !?
390 if (s/^=head1 (.*)/=item $1/) {
392 output "=over 4\n\n" unless $inhead1;
394 output $_; nl(); next;
396 if (s/^=head2 (.*)/=item $1/) {
398 output "=over 4\n\n" unless $inhead2;
400 output $_; nl(); next;
402 if (s/^=item ([^=].*)/$1/) {
403 next if $pod eq 'perldiag';
404 s/^\s*\*\s*$// && next;
409 next if $pod eq 'perlmodlib' && /^ftp:/;
410 ##print "=over 4\n\n" unless $initem;
411 output ", " if $initem;
417 if (s/^=cut\s*\n//) {
436 output "\n\n=back\n\n";
444 output "\n\n=back\n\n";
452 ##print "\n\n=back\n\n";
461 my $NEWLINE; # how many newlines have we seen recently
462 my $LINE; # what remains to be printed
465 for (split /(\n)/, shift) {
468 print OUT wrap('', '', $LINE);
476 elsif (/\S/ && length) {
485 close OUT or die "Can't close $file: $!";
486 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
487 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';