X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=utils%2Fperldoc.PL;h=4fff93452f1e3e6fcbf0fd11878dd5c443afed8d;hb=041b774345efbca4380b50a1282029ce2362c5a0;hp=ee56e0206dd4a6eeba572a6a9651f3ae349e807e;hpb=09b7f37c58c6da6f4965b846b64eab7d9a205663;p=p5sagit%2Fp5-mst-13.2.git diff --git a/utils/perldoc.PL b/utils/perldoc.PL index ee56e02..4fff934 100644 --- a/utils/perldoc.PL +++ b/utils/perldoc.PL @@ -2,6 +2,7 @@ use Config; use File::Basename qw(&basename &dirname); +use Cwd; # List explicitly here the variables you want Configure to # generate. Metaconfig only looks for shell variables, so you @@ -12,6 +13,7 @@ use File::Basename qw(&basename &dirname); # This forces PL files to create target in same directory as PL file. # This is so that make depend always knows where to find PL derivatives. +$origdir = cwd; chdir dirname($0); $file = basename($0, '.PL'); $file .= '.com' if $^O eq 'VMS'; @@ -26,9 +28,10 @@ print "Extracting $file (with variable substitutions)\n"; print OUT <<"!GROK!THIS!"; $Config{startperl} eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' - if \$running_under_some_shell; + if 0; -\@pagers = (); +use strict; +my \@pagers = (); push \@pagers, "$Config{'pager'}" if -x "$Config{'pager'}"; !GROK!THIS! @@ -45,11 +48,12 @@ print OUT <<'!NO!SUBS!'; # the perl manuals, though it too is written in perl. if(@ARGV<1) { - $me = $0; # Editing $0 is unportable + my $me = $0; # Editing $0 is unportable $me =~ s,.*/,,; die < 7; +my $podidx; +if( $opt_X ) { + $podidx = "$Config{'archlib'}/pod.idx"; + $podidx = "" unless -f $podidx && -r _ && -M _ <= 7; +} -if ($opt_t + $opt_u + $opt_m + $opt_l > 1) { +if( (my $opts = do{ local $^W; $opt_t + $opt_u + $opt_m + $opt_l }) > 1) { usage("only one of -t, -u, -m or -l") } elsif ($Is_MSWin32 || $Is_Dos) { - $opt_t = 1 unless $opt_t + $opt_u + $opt_m + $opt_l; + $opt_t = 1 unless $opts } if ($opt_t) { require Pod::Text; import Pod::Text; } +my @pages; if ($opt_f) { @pages = ("perlfunc"); +} elsif ($opt_q) { + @pages = ("perlfaq1" .. "perlfaq9"); } else { @pages = @ARGV; } @@ -155,23 +182,26 @@ sub containspod { } sub minus_f_nocase { - my($file) = @_; - # on a case-forgiving file system we can simply use -f $file - if ($Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') { - return $file if -f $file and -r _; + my($dir,$file) = @_; + my $path = join('/',$dir,$file); + return $path if -f $path and -r _; + if (!$opt_i or $Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') { + # on a case-forgiving file system or if case is important + # that is it all we can do warn "Ignored $file: unreadable\n" if -f _; return ''; } local *DIR; local($")="/"; - my(@p,$p,$cip); + my @p = ($dir); + my($p,$cip); foreach $p (split(/\//, $file)){ my $try = "@p/$p"; stat $try; if (-d _){ push @p, $p; if ( $p eq $global_target) { - $tmp_path = join ('/', @p); + my $tmp_path = join ('/', @p); my $path_f = 0; for (@global_found) { $path_f = 1 if $_ eq $tmp_path; @@ -200,13 +230,19 @@ sub minus_f_nocase { warn "Ignored $file: unreadable\n" if -f _; } } - return; # is not a file + return ""; } sub check_file { - my($file) = @_; - return minus_f_nocase($file) && containspod($file) ? $file : ""; + my($dir,$file) = @_; + if ($opt_m) { + return minus_f_nocase($dir,$file); + } else { + my $path = minus_f_nocase($dir,$file); + return $path if length $path and containspod($path); + } + return ""; } @@ -223,17 +259,17 @@ sub searchfor { for ($i=0; $i<@dirs; $i++) { $dir = $dirs[$i]; ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS; - if ( ( $ret = check_file "$dir/$s.pod") - or ( $ret = check_file "$dir/$s.pm") - or ( $ret = check_file "$dir/$s") + if ( ( $ret = check_file $dir,"$s.pod") + or ( $ret = check_file $dir,"$s.pm") + or ( $ret = check_file $dir,$s) or ( $Is_VMS and - $ret = check_file "$dir/$s.com") + $ret = check_file $dir,"$s.com") or ( $^O eq 'os2' and - $ret = check_file "$dir/$s.cmd") + $ret = check_file $dir,"$s.cmd") or ( ($Is_MSWin32 or $Is_Dos or $^O eq 'os2') and - $ret = check_file "$dir/$s.bat") - or ( $ret = check_file "$dir/pod/$s.pod") - or ( $ret = check_file "$dir/pod/$s") + $ret = check_file $dir,"$s.bat") + or ( $ret = check_file "$dir/pod","$s.pod") + or ( $ret = check_file "$dir/pod",$s) ) { return $ret; } @@ -255,7 +291,7 @@ sub searchfor { return (); } - +my @found; foreach (@pages) { if ($podidx && open(PODIDX, $podidx)) { my $searchfor = $_; @@ -272,7 +308,7 @@ foreach (@pages) { print STDERR "Searching for $_\n" if $opt_v; # We must look both in @INC for library modules and in PATH # for executables, like h2xs or perldoc itself. - @searchdirs = @INC; + my @searchdirs = @INC; if ($opt_F) { next unless -r; push @found, $_ if $opt_m or containspod($_); @@ -284,13 +320,13 @@ foreach (@pages) { for ($i = 0; $trn = $ENV{'DCL$PATH'.$i}; $i++) { push(@searchdirs,$trn); } - push(@dirs,'perl_root:[lib.pod]') # installed pods + push(@searchdirs,'perl_root:[lib.pod]') # installed pods } else { push(@searchdirs, grep(-d, split($Config{path_sep}, $ENV{'PATH'}))); } - @files= searchfor(0,$_,@searchdirs); } + my @files = searchfor(0,$_,@searchdirs); if( @files ) { print STDERR "Found as @files\n" if $opt_v; } else { @@ -298,17 +334,16 @@ foreach (@pages) { @searchdirs = grep(!/^\.$/,@INC); - @files= searchfor(1,$_,@searchdirs); + @files= searchfor(1,$_,@searchdirs) if $opt_r; if( @files ) { print STDERR "Loosely found as @files\n" if $opt_v; } else { print STDERR "No documentation found for \"$_\".\n"; if (@global_found) { print STDERR "However, try\n"; - my $dir = $file = ""; - for $dir (@global_found) { + for my $dir (@global_found) { opendir(DIR, $dir) or die "$!"; - while ($file = readdir(DIR)) { + while (my $file = readdir(DIR)) { next if ($file =~ /^\./); $file =~ s/\.(pm|pod)$//; print STDERR "\tperldoc $_\::$file\n"; @@ -330,8 +365,12 @@ if ($opt_l) { exit; } +my $lines = $ENV{LINES} || 24; + +my $no_tty; if( ! -t STDOUT ) { $no_tty = 1 } +my $tmp; if ($Is_MSWin32) { $tmp = "$ENV{TEMP}\\perldoc1.$$"; push @pagers, qw( more< less notepad ); @@ -348,6 +387,7 @@ if ($Is_MSWin32) { if ($^O eq 'os2') { require POSIX; $tmp = POSIX::tmpnam(); + unshift @pagers, 'less', 'cmd /c more <'; } else { $tmp = "/tmp/perldoc1.$$"; } @@ -357,7 +397,7 @@ if ($Is_MSWin32) { unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER}; if ($opt_m) { - foreach $pager (@pagers) { + foreach my $pager (@pagers) { system("$pager @found") or exit; } if ($Is_VMS) { eval 'use vmsish qw(status exit); exit $?' } @@ -368,6 +408,9 @@ if ($opt_f) { my $perlfunc = shift @found; open(PFUNC, $perlfunc) or die "Can't open $perlfunc: $!"; + # Functions like -r, -e, etc. are listed under `-X'. + my $search_string = ($opt_f =~ /^-[rwxoRWXOeszfdlpSbctugkTBMAC]$/) ? 'I<-X' : $opt_f ; + # Skip introduction while () { last if /^=head2 Alphabetical Listing of Perl Functions/; @@ -377,7 +420,7 @@ if ($opt_f) { my $found = 0; my @pod; while () { - if (/^=item\s+\Q$opt_f\E\b/o) { + if (/^=item\s+\Q$search_string\E\b/o) { $found = 1; } elsif (/^=item/) { last if $found > 1; @@ -393,8 +436,15 @@ if ($opt_f) { print FORMATTER @pod; print FORMATTER "=back\n"; close(FORMATTER); - } else { + } elsif (@pod < $lines-2) { print @pod; + } else { + foreach my $pager (@pagers) { + open (PAGER, "| $pager") or next; + print PAGER @pod ; + close(PAGER) or next; + last; + } } } else { die "No documentation for perl function `$opt_f' found\n"; @@ -402,8 +452,49 @@ if ($opt_f) { exit; } +if ($opt_q) { + local @ARGV = @found; # I'm lazy, sue me. + my $found = 0; + my %found_in; + my @pod; + + while (<>) { + if (/^=head2\s+.*(?:$opt_q)/oi) { + $found = 1; + push @pod, "=head1 Found in $ARGV\n\n" unless $found_in{$ARGV}++; + } elsif (/^=head2/) { + $found = 0; + } + next unless $found; + push @pod, $_; + } + + if (@pod) { + if ($opt_t) { + open(FORMATTER, "| pod2text") || die "Can't start filter"; + print FORMATTER "=over 8\n\n"; + print FORMATTER @pod; + print FORMATTER "=back\n"; + close(FORMATTER); + } elsif (@pod < $lines-2) { + print @pod; + } else { + foreach my $pager (@pagers) { + open (PAGER, "| $pager") or next; + print PAGER @pod ; + close(PAGER) or next; + last; + } + } + } else { + die "No documentation for perl FAQ keyword `$opt_q' found\n"; + } + exit; +} + foreach (@found) { + my $err; if($opt_t) { open(TMP,">>$tmp"); Pod::Text::pod2text($_,*TMP); @@ -411,7 +502,7 @@ foreach (@found) { } elsif(not $opt_u) { my $cmd = "pod2man --lax $_ | nroff -man"; $cmd .= " | col -x" if $^O =~ /hpux/; - $rslt = `$cmd`; + my $rslt = `$cmd`; unless(($err = $?)) { open(TMP,">>$tmp"); print TMP $rslt; @@ -422,7 +513,7 @@ foreach (@found) { if( $opt_u or $err or -z $tmp) { open(OUT,">>$tmp"); open(IN,"<$_"); - $cut = 1; + my $cut = 1; while () { $cut = $1 eq 'cut' if /^=(\w+)/; next if $cut; @@ -438,7 +529,7 @@ if( $no_tty ) { print while ; close(TMP); } else { - foreach $pager (@pagers) { + foreach my $pager (@pagers) { system("$pager $tmp") or last; } } @@ -459,6 +550,8 @@ B [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-X>] Page B B<-f> BuiltinFunction +B B<-q> FAQ Keyword + =head1 DESCRIPTION I looks up a piece of documentation in .pod format that is embedded @@ -511,6 +604,12 @@ Consider arguments as file names, no search in directories will be performed. The B<-f> option followed by the name of a perl built in function will extract the documentation of this function from L. +=item B<-q> perlfaq + +The B<-q> option takes a regular expression as an argument. It will search +the question headings in perlfaq[1-9] and print the entries matching +the regular expression. + =item B<-X> use an index if present The B<-X> option looks for a entry whose basename matches the name given on the @@ -535,7 +634,10 @@ command line arguments. C also searches directories specified by the C (or C if C is not defined) and C environment variables. (The latter is so that embedded pods for executables, such as -C itself, are available.) +C itself, are available.) C will use, in order of +preference, the pager defined in C, C, or +C before trying to find a pager on its own. (C is not +used if C was told to display plain text or unformatted pod.) =head1 AUTHOR @@ -546,6 +648,9 @@ Minor updates by Andy Dougherty =cut # +# Version 1.14: Wed Jul 15 01:50:20 EST 1998 +# Robin Barker +# -strict, -w cleanups # Version 1.13: Fri Feb 27 16:20:50 EST 1997 # Gurusamy Sarathy # -doc tweaks for -F and -X options @@ -582,3 +687,4 @@ Minor updates by Andy Dougherty close OUT or die "Can't close $file: $!"; chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; +chdir $origdir;