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");
196 for (@ARCHPODS) { s/$/.pod/ }
197 @ARCHPODS{@ARCHPODS} = ();
199 for (@pods) { s/$/.pod/ }
203 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
205 if (m!^pod/([^.]+\.pod)\s+!i) {
210 @MANIPODS{@MANIPODS} = ();
212 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
214 if (/^For ease of access, /../^\(If you're intending /) {
215 if (/^\s+(perl\S*)\s+\w/) {
216 push @PERLPODS, "$1.pod";
221 die "$0: could not find the pod listing of perl.pod\n"
223 @PERLPODS{@PERLPODS} = ();
225 # Cross-check against ourselves
226 # Cross-check against the MANIFEST
227 # Cross-check against the perl.pod
229 foreach my $i (sort keys %PODS) {
230 warn "$0: $i exists but is unknown by buildtoc\n"
231 unless exists $pods{$i};
232 warn "$0: $i exists but is unknown by ../MANIFEST\n"
233 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
234 warn "$0: $i exists but is unknown by perl.pod\n"
235 unless exists $PERLPODS{$i};
237 foreach my $i (sort keys %pods) {
238 warn "$0: $i is known by buildtoc but does not exist\n"
239 unless exists $PODS{$i};
241 foreach my $i (sort keys %MANIPODS) {
242 warn "$0: $i is known by ../MANIFEST but does not exist\n"
243 unless exists $PODS{$i};
245 foreach my $i (sort keys %PERLPODS) {
246 warn "$0: $i is known by perl.pod but does not exist\n"
247 unless exists $PODS{$i};
250 # We are ready to rock.
251 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
256 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
260 perltoc - perl documentation table of contents
264 This page provides a brief table of contents for the rest of the Perl
265 documentation set. It is meant to be scanned quickly or grepped
266 through to locate the proper section you're looking for.
268 =head1 BASIC DOCUMENTATION
275 find \&getpods => qw(../lib ../ext);
279 # Skip .pm files that have corresponding .pod files, and Functions.pm.
280 return if /(.*)\.pm$/ && -f "$1.pod";
281 my $file = $File::Find::name;
282 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
283 return if $file =~ m!lib/Attribute/Handlers/demo/!;
285 die "tut $name" if $file =~ /TUT/;
286 unless (open (F, "< $_\0")) {
287 warn "bogus <$file>: $!";
288 system "ls", "-l", $file;
292 while ($line = <F>) {
293 if ($line =~ /^=head1\s+NAME\b/) {
294 push @modpods, $file;
295 #warn "GOOD $file\n";
299 warn "$0: $file: cannot find =head1 NAME\n";
304 die "no pods" unless @modpods;
307 #($name) = /(\w+)\.p(m|od)$/;
308 $name = path2modname($_);
309 if ($name =~ /^[a-z]/) {
312 if ($done{$name}++) {
313 # warn "already did $_\n";
317 push @modname, $name;
321 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
325 =head1 PRAGMA DOCUMENTATION
329 podset(sort @pragmata);
331 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
335 =head1 MODULE DOCUMENTATION
339 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
341 ($_= <<EOPOD2B) =~ s/^\t//gm;
344 =head1 AUXILIARY DOCUMENTATION
346 Here should be listed all the extra programs' documentation, but they
347 don't all have manual pages yet:
373 Larry Wall <F<larry\@wall.org>>, with the help of oodles
379 output "\n"; # flush $LINE
386 if (s/^=head1 (NAME)\s*/=head2 /) {
387 $pod = path2modname($ARGV);
389 output "\n \n\n=head2 ";
391 if ( /^\s*$pod\b/ ) {
392 s/$pod\.pm/$pod/; # '.pm' in NAME !?
400 if (s/^=head1 (.*)/=item $1/) {
402 output "=over 4\n\n" unless $inhead1;
404 output $_; nl(); next;
406 if (s/^=head2 (.*)/=item $1/) {
408 output "=over 4\n\n" unless $inhead2;
410 output $_; nl(); next;
412 if (s/^=item ([^=].*)/$1/) {
413 next if $pod eq 'perldiag';
414 s/^\s*\*\s*$// && next;
419 next if $pod eq 'perlmodlib' && /^ftp:/;
420 ##print "=over 4\n\n" unless $initem;
421 output ", " if $initem;
427 if (s/^=cut\s*\n//) {
446 output "\n\n=back\n\n";
454 output "\n\n=back\n\n";
462 ##print "\n\n=back\n\n";
471 my $NEWLINE; # how many newlines have we seen recently
472 my $LINE; # what remains to be printed
475 for (split /(\n)/, shift) {
478 print OUT wrap('', '', $LINE);
486 elsif (/\S/ && length) {
495 close OUT or die "Can't close $file: $!";
496 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
497 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';