diff options
Diffstat (limited to 'utils/perldoc.PL')
| -rw-r--r-- | utils/perldoc.PL | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/utils/perldoc.PL b/utils/perldoc.PL index e0f8a43b86..28bb464f85 100644 --- a/utils/perldoc.PL +++ b/utils/perldoc.PL @@ -12,10 +12,8 @@ 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. -chdir(dirname($0)); -($file = basename($0)) =~ s/\.PL$//; -$file =~ s/\.pl$// - if ($^O eq 'VMS' or $^O eq 'os2'); # "case-forgiving" +chdir dirname($0); +$file = basename($0, '.PL'); open OUT,">$file" or die "Can't create $file: $!"; @@ -47,7 +45,7 @@ print OUT <<'!NO!SUBS!'; if(@ARGV<1) { die <<EOF; -Usage: $0 [-h] [-v] [-t] [-u] [-m] PageName|ModuleName|ProgramName +Usage: $0 [-h] [-v] [-t] [-u] [-m] [-l] PageName|ModuleName|ProgramName We suggest you use "perldoc perldoc" to get aquainted with the system. @@ -68,6 +66,7 @@ perldoc [-h] [-v] [-u] PageName|ModuleName|ProgramName... -t Display pod using pod2text instead of pod2man and nroff. -u Display unformatted pod text -m Display modules file in its entirety + -l Display the modules file name -v Verbosely describe what's going on. PageName|ModuleName... is the name of a piece of documentation that you want to look at. You @@ -87,11 +86,11 @@ use Text::ParseWords; unshift(@ARGV,shellwords($ENV{"PERLDOC"})); -getopts("mhtuv") || usage; +getopts("mhtluv") || usage; usage if $opt_h || $opt_h; # avoid -w warning -usage("only one of -t, -u, or -m") if $opt_t + $opt_u + $opt_m > 1; +usage("only one of -t, -u, -m or -l") if $opt_t + $opt_u + $opt_m + $opt_l > 1; if ($opt_t) { require Pod::Text; import Pod::Text; } @@ -150,6 +149,7 @@ sub containspod { my($recurse,$s,@dirs) = @_; $s =~ s!::!/!g; $s = VMS::Filespec::unixify($s) if $Is_VMS; + return $s if -f $s && containspod($s); printf STDERR "looking for $s in @dirs\n" if $opt_v; my $ret; my $i; @@ -218,19 +218,22 @@ if(!@found) { exit ($Is_VMS ? 98962 : 1); } +if ($opt_l) { + print join("\n", @found), "\n"; + exit; +} + if( ! -t STDOUT ) { $opt_f = 1 } unless($Is_VMS) { $tmp = "/tmp/perldoc1.$$"; push @pagers, qw( more less pg view cat ); unshift @pagers, $ENV{PAGER} if $ENV{PAGER}; - $goodresult = 0; } else { $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$; push @pagers, qw( most more less type/page ); - unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER}; - $goodresult = 1; } +unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER}; if ($opt_m) { foreach $pager (@pagers) { @@ -297,7 +300,7 @@ perldoc - Look up Perl documentation in pod format. =head1 SYNOPSIS -B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] PageName|ModuleName|ProgramName +B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] PageName|ModuleName|ProgramName =head1 DESCRIPTION @@ -338,6 +341,10 @@ This may be useful if the docs don't explain a function in the detail you need, and you'd like to inspect the code directly; perldoc will find the file for you and simply hand it off for display. +=item B<-l> file name only + +Display the file name of the module found. + =item B<PageName|ModuleName|ProgramName> The item you want to look up. Nested modules (such as C<File::Basename>) @@ -364,10 +371,6 @@ Kenneth Albanowski <kjahds@kjahds.com> Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu> -=head1 SEE ALSO - -=head1 DIAGNOSTICS - =cut # |