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");
185 for (@ARCHPODS) { s/$/.pod/ }
186 @ARCHPODS{@ARCHPODS} = ();
188 for (@pods) { s/$/.pod/ }
192 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
194 if (m!^pod/([^.]+\.pod)\s+!i) {
199 @MANIPODS{@MANIPODS} = ();
201 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
203 if (/^For ease of access, /../^\(If you're intending /) {
204 if (/^\s+(perl\S*)\s+\w/) {
205 push @PERLPODS, "$1.pod";
210 die "$0: could not find the pod listing of perl.pod\n"
212 @PERLPODS{@PERLPODS} = ();
214 # Cross-check against ourselves
215 # Cross-check against the MANIFEST
216 # Cross-check against the perl.pod
218 foreach my $i (sort keys %PODS) {
219 warn "$0: $i exists but is unknown by buildtoc\n"
220 unless exists $pods{$i};
221 warn "$0: $i exists but is unknown by ../MANIFEST\n"
222 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
223 warn "$0: $i exists but is unknown by perl.pod\n"
224 unless exists $PERLPODS{$i};
226 foreach my $i (sort keys %pods) {
227 warn "$0: $i is known by buildtoc but does not exist\n"
228 unless exists $PODS{$i};
230 foreach my $i (sort keys %MANIPODS) {
231 warn "$0: $i is known by ../MANIFEST but does not exist\n"
232 unless exists $PODS{$i};
234 foreach my $i (sort keys %PERLPODS) {
235 warn "$0: $i is known by perl.pod but does not exist\n"
236 unless exists $PODS{$i};
239 # We are ready to rock.
240 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
245 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
249 perltoc - perl documentation table of contents
253 This page provides a brief table of contents for the rest of the Perl
254 documentation set. It is meant to be scanned quickly or grepped
255 through to locate the proper section you're looking for.
257 =head1 BASIC DOCUMENTATION
264 find \&getpods => qw(../lib ../ext);
268 # Skip .pm files that have corresponding .pod files, and Functions.pm.
269 return if /(.*)\.pm$/ && -f "$1.pod";
270 my $file = $File::Find::name;
271 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
273 die "tut $name" if $file =~ /TUT/;
274 unless (open (F, "< $_\0")) {
275 warn "bogus <$file>: $!";
276 system "ls", "-l", $file;
280 while ($line = <F>) {
281 if ($line =~ /^=head1\s+NAME\b/) {
282 push @modpods, $file;
283 #warn "GOOD $file\n";
287 warn "$0: $file: cannot find =head1 NAME\n";
292 die "no pods" unless @modpods;
295 #($name) = /(\w+)\.p(m|od)$/;
296 $name = path2modname($_);
297 if ($name =~ /^[a-z]/) {
300 if ($done{$name}++) {
301 # warn "already did $_\n";
305 push @modname, $name;
309 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
313 =head1 PRAGMA DOCUMENTATION
317 podset(sort @pragmata);
319 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
323 =head1 MODULE DOCUMENTATION
327 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
329 ($_= <<EOPOD2B) =~ s/^\t//gm;
332 =head1 AUXILIARY DOCUMENTATION
334 Here should be listed all the extra programs' documentation, but they
335 don't all have manual pages yet:
361 Larry Wall <F<larry\@wall.org>>, with the help of oodles
367 output "\n"; # flush $LINE
374 if (s/^=head1 (NAME)\s*/=head2 /) {
375 $pod = path2modname($ARGV);
377 output "\n \n\n=head2 ";
379 if ( /^\s*$pod\b/ ) {
380 s/$pod\.pm/$pod/; # '.pm' in NAME !?
388 if (s/^=head1 (.*)/=item $1/) {
390 output "=over 4\n\n" unless $inhead1;
392 output $_; nl(); next;
394 if (s/^=head2 (.*)/=item $1/) {
396 output "=over 4\n\n" unless $inhead2;
398 output $_; nl(); next;
400 if (s/^=item ([^=].*)/$1/) {
401 next if $pod eq 'perldiag';
402 s/^\s*\*\s*$// && next;
407 next if $pod eq 'perlmodlib' && /^ftp:/;
408 ##print "=over 4\n\n" unless $initem;
409 output ", " if $initem;
415 if (s/^=cut\s*\n//) {
434 output "\n\n=back\n\n";
442 output "\n\n=back\n\n";
450 ##print "\n\n=back\n\n";
459 my $NEWLINE; # how many newlines have we seen recently
460 my $LINE; # what remains to be printed
463 for (split /(\n)/, shift) {
466 print OUT wrap('', '', $LINE);
474 elsif (/\S/ && length) {
483 close OUT or die "Can't close $file: $!";
484 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
485 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';