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");
183 for (@ARCHPODS) { s/$/.pod/ }
184 @ARCHPODS{@ARCHPODS} = ();
186 for (@pods) { s/$/.pod/ }
190 open(MANI, "../MANIFEST") || die "$0: opening ../MANIFEST failed: $!";
192 if (m!^pod/([^.]+\.pod)\s+!i) {
197 @MANIPODS{@MANIPODS} = ();
199 open(PERLPOD, "perl.pod") || die "$0: opening perl.pod failed: $!\n";
201 if (/^For ease of access, /../^\(If you're intending /) {
202 if (/^\s+(perl\S*)\s+\w/) {
203 push @PERLPODS, "$1.pod";
208 die "$0: could not find the pod listing of perl.pod\n"
210 @PERLPODS{@PERLPODS} = ();
212 # Cross-check against ourselves
213 # Cross-check against the MANIFEST
214 # Cross-check against the perl.pod
216 foreach my $i (sort keys %PODS) {
217 warn "$0: $i exists but is unknown by buildtoc\n"
218 unless exists $pods{$i};
219 warn "$0: $i exists but is unknown by ../MANIFEST\n"
220 if !exists $MANIPODS{$i} && !exists $ARCHPODS{$i};
221 warn "$0: $i exists but is unknown by perl.pod\n"
222 unless exists $PERLPODS{$i};
224 foreach my $i (sort keys %pods) {
225 warn "$0: $i is known by buildtoc but does not exist\n"
226 unless exists $PODS{$i};
228 foreach my $i (sort keys %MANIPODS) {
229 warn "$0: $i is known by ../MANIFEST but does not exist\n"
230 unless exists $PODS{$i};
232 foreach my $i (sort keys %PERLPODS) {
233 warn "$0: $i is known by perl.pod but does not exist\n"
234 unless exists $PODS{$i};
237 # We are ready to rock.
238 open(OUT, ">perltoc.pod") || die "$0: creating perltoc.pod failed: $!";
243 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
247 perltoc - perl documentation table of contents
251 This page provides a brief table of contents for the rest of the Perl
252 documentation set. It is meant to be scanned quickly or grepped
253 through to locate the proper section you're looking for.
255 =head1 BASIC DOCUMENTATION
262 find \&getpods => qw(../lib ../ext);
266 # Skip .pm files that have corresponding .pod files, and Functions.pm.
267 return if /(.*)\.pm$/ && -f "$1.pod";
268 my $file = $File::Find::name;
269 return if $file eq '../lib/Pod/Functions.pm'; # Used only by pod itself
271 die "tut $name" if $file =~ /TUT/;
272 unless (open (F, "< $_\0")) {
273 warn "bogus <$file>: $!";
274 system "ls", "-l", $file;
278 while ($line = <F>) {
279 if ($line =~ /^=head1\s+NAME\b/) {
280 push @modpods, $file;
281 #warn "GOOD $file\n";
285 warn "$0: $file: cannot find =head1 NAME\n";
290 die "no pods" unless @modpods;
293 #($name) = /(\w+)\.p(m|od)$/;
294 $name = path2modname($_);
295 if ($name =~ /^[a-z]/) {
298 if ($done{$name}++) {
299 # warn "already did $_\n";
303 push @modname, $name;
307 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
311 =head1 PRAGMA DOCUMENTATION
315 podset(sort @pragmata);
317 ($_= <<EOPOD2B) =~ s/^\t//gm && output($_);
321 =head1 MODULE DOCUMENTATION
325 podset( @modules[ sort { $modname[$a] cmp $modname[$b] } 0 .. $#modules ] );
327 ($_= <<EOPOD2B) =~ s/^\t//gm;
330 =head1 AUXILIARY DOCUMENTATION
332 Here should be listed all the extra programs' documentation, but they
333 don't all have manual pages yet:
359 Larry Wall <F<larry\@wall.org>>, with the help of oodles
365 output "\n"; # flush $LINE
372 if (s/^=head1 (NAME)\s*/=head2 /) {
373 $pod = path2modname($ARGV);
375 output "\n \n\n=head2 ";
377 if ( /^\s*$pod\b/ ) {
378 s/$pod\.pm/$pod/; # '.pm' in NAME !?
386 if (s/^=head1 (.*)/=item $1/) {
388 output "=over 4\n\n" unless $inhead1;
390 output $_; nl(); next;
392 if (s/^=head2 (.*)/=item $1/) {
394 output "=over 4\n\n" unless $inhead2;
396 output $_; nl(); next;
398 if (s/^=item ([^=].*)/$1/) {
399 next if $pod eq 'perldiag';
400 s/^\s*\*\s*$// && next;
405 next if $pod eq 'perlmodlib' && /^ftp:/;
406 ##print "=over 4\n\n" unless $initem;
407 output ", " if $initem;
413 if (s/^=cut\s*\n//) {
432 output "\n\n=back\n\n";
440 output "\n\n=back\n\n";
448 ##print "\n\n=back\n\n";
457 my $NEWLINE; # how many newlines have we seen recently
458 my $LINE; # what remains to be printed
461 for (split /(\n)/, shift) {
464 print OUT wrap('', '', $LINE);
472 elsif (/\S/ && length) {
481 close OUT or die "Can't close $file: $!";
482 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
483 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';