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");
193 for (@ARCHPODS) { s/$/.pod/ }
194 @ARCHPODS{@ARCHPODS} = ();
196 for (@pods) { s/$/.pod/ }
200 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
202 if (m!^pod/([^.]+\.pod)\s+!i) {
207 @MANIPODS{@MANIPODS} = ();
209 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
211 if (/^For ease of access, /../^\(If you're intending /) {
212 if (/^\s+(perl\S*)\s+\w/) {
213 push @PERLPODS, "$1.pod";
218 die "$0: could not find the pod listing of perl.pod\n"
220 @PERLPODS{@PERLPODS} = ();
222 # Cross-check against ourselves
223 # Cross-check against the MANIFEST
224 # Cross-check against the perl.pod
226 foreach my $i (sort keys %PODS) {
227 warn "$0: $i exists but is unknown by buildtoc\n"
228 unless exists $pods{$i};
229 warn "$0: $i exists but is unknown by ../MANIFEST\n"
230 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
231 warn "$0: $i exists but is unknown by perl.pod\n"
232 unless exists $PERLPODS{$i};
234 foreach my $i (sort keys %pods) {
235 warn "$0: $i is known by buildtoc but does not exist\n"
236 unless exists $PODS{$i};
238 foreach my $i (sort keys %MANIPODS) {
239 warn "$0: $i is known by ../MANIFEST but does not exist\n"
240 unless exists $PODS{$i};
242 foreach my $i (sort keys %PERLPODS) {
243 warn "$0: $i is known by perl.pod but does not exist\n"
244 unless exists $PODS{$i};
247 # We are ready to rock.
248 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
253 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
257 perltoc - perl documentation table of contents
261 This page provides a brief table of contents for the rest of the Perl
262 documentation set. It is meant to be scanned quickly or grepped
263 through to locate the proper section you're looking for.
265 =head1 BASIC DOCUMENTATION
272 find \&getpods => qw(../lib ../ext);
276 # Skip .pm files that have corresponding .pod files, and Functions.pm.
277 return if /(.*)\.pm$/ && -f "$1.pod";
278 my $file = $File::Find::name;
279 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
281 die "tut $name" if $file =~ /TUT/;
282 unless (open (F, "< $_\0")) {
283 warn "bogus <$file>: $!";
284 system "ls", "-l", $file;
288 while ($line = <F>) {
289 if ($line =~ /^=head1\s+NAME\b/) {
290 push @modpods, $file;
291 #warn "GOOD $file\n";
295 warn "$0: $file: cannot find =head1 NAME\n";
300 die "no pods" unless @modpods;
303 #($name) = /(\w+)\.p(m|od)$/;
304 $name = path2modname($_);
305 if ($name =~ /^[a-z]/) {
308 if ($done{$name}++) {
309 # warn "already did $_\n";
313 push @modname, $name;
317 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
321 =head1 PRAGMA DOCUMENTATION
325 podset(sort @pragmata);
327 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
331 =head1 MODULE DOCUMENTATION
335 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
337 ($_= <<EOPOD2B) =~ s/^\t//gm;
340 =head1 AUXILIARY DOCUMENTATION
342 Here should be listed all the extra programs' documentation, but they
343 don't all have manual pages yet:
369 Larry Wall <F<larry\@wall.org>>, with the help of oodles
375 output "\n"; # flush $LINE
382 if (s/^=head1 (NAME)\s*/=head2 /) {
383 $pod = path2modname($ARGV);
385 output "\n \n\n=head2 ";
387 if ( /^\s*$pod\b/ ) {
388 s/$pod\.pm/$pod/; # '.pm' in NAME !?
396 if (s/^=head1 (.*)/=item $1/) {
398 output "=over 4\n\n" unless $inhead1;
400 output $_; nl(); next;
402 if (s/^=head2 (.*)/=item $1/) {
404 output "=over 4\n\n" unless $inhead2;
406 output $_; nl(); next;
408 if (s/^=item ([^=].*)/$1/) {
409 next if $pod eq 'perldiag';
410 s/^\s*\*\s*$// && next;
415 next if $pod eq 'perlmodlib' && /^ftp:/;
416 ##print "=over 4\n\n" unless $initem;
417 output ", " if $initem;
423 if (s/^=cut\s*\n//) {
442 output "\n\n=back\n\n";
450 output "\n\n=back\n\n";
458 ##print "\n\n=back\n\n";
467 my $NEWLINE; # how many newlines have we seen recently
468 my $LINE; # what remains to be printed
471 for (split /(\n)/, shift) {
474 print OUT wrap('', '', $LINE);
482 elsif (/\S/ && length) {
491 close OUT or die "Can't close $file: $!";
492 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
493 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';