4 use File::Basename qw(&basename &dirname);
6 # List explicitly here the variables you want Configure to
7 # generate. Metaconfig only looks for shell variables, so you
8 # have to mention them as if they were shell variables, not
9 # %Config entries. Thus you write
11 # to ensure Configure will look for $Config{startperl}.
13 # This forces PL files to create target in same directory as PL file.
14 # This is so that make depend always knows where to find PL derivatives.
16 ($file = basename($0)) =~ s/\.PL$//;
18 if ($^O eq 'VMS' or $^O eq 'os2'); # "case-forgiving"
20 open OUT,">$file" or die "Can't create $file: $!";
22 print "Extracting $file (with variable substitutions)\n";
24 # In this section, perl variables will be expanded during extraction.
25 # You can use $Config{...} to use Configure variables.
27 print OUT <<"!GROK!THIS!";
29 eval 'exec perl -S \$0 "\$@"'
33 push \@pagers, "$Config{'pager'}" if -x "$Config{'pager'}";
36 # In the following, perl variables are not expanded during extraction.
38 print OUT <<'!NO!SUBS!';
41 # Perldoc revision #1 -- look up a piece of documentation in .pod format that
42 # is embedded in the perl installation tree.
44 # This is not to be confused with Tom Christianson's perlman, which is a
45 # man replacement, written in perl. This perldoc is strictly for reading
46 # the perl manuals, though it too is written in perl.
50 Usage: $0 [-h] [-v] [-t] [-u] [-m] PageName|ModuleName|ProgramName
52 We suggest you use "perldoc perldoc" to get aquainted
58 $Is_VMS = $^O eq 'VMS';
62 # Make sure exit status is success under VMS, so shell doesn't
63 # display error messages left over from startup.
64 ($! = 0, $^E = 1) if $^O eq 'VMS';
66 perldoc [-h] [-v] [-u] PageName|ModuleName|ProgramName...
67 -h Display this help message.
68 -t Display pod using pod2text instead of pod2man and nroff.
69 -u Display unformatted pod text
70 -m Display modules file in its entirety
71 -v Verbosely describe what's going on.
72 PageName|ModuleName...
73 is the name of a piece of documentation that you want to look at. You
74 may either give a descriptive name of the page (as in the case of
75 `perlfunc') the name of a module, either like `Term::Info',
76 `Term/Info', the partial name of a module, like `info', or
77 `makemaker', or the name of a program, like `perldoc'.
79 Any switches in the PERLDOC environment variable will be used before the
80 command line arguments.
88 unshift(@ARGV,shellwords($ENV{"PERLDOC"}));
90 getopts("mhtuv") || usage;
92 usage if $opt_h || $opt_h; # avoid -w warning
94 usage("only one of -t, -u, or -m") if $opt_t + $opt_u + $opt_m > 1;
96 if ($opt_t) { require Pod::Text; import Pod::Text; }
119 foreach $p (split(/\//, $file)){
120 if (($Is_VMS or $^O eq 'os2') and not scalar @p) {
121 # VMSish filesystems don't begin at '/'
127 } elsif (-f ("@p/$p")) {
133 while ($cip=readdir(DIR)) {
134 $cip =~ s/\.dir$// if $Is_VMS;
135 if (lc $cip eq $lcp){
141 return "" unless $found;
143 return "@p" if -f "@p";
146 return; # is not a file
150 my($recurse,$s,@dirs) = @_;
152 $s = VMS::Filespec::unixify($s) if $Is_VMS;
153 printf STDERR "looking for $s in @dirs\n" if $opt_v;
157 for ($i=0;$i<@dirs;$i++) {
159 ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS;
160 if (( $ret = minus_f_nocase "$dir/$s.pod")
161 or ( $ret = minus_f_nocase "$dir/$s.pm" and containspod($ret))
162 or ( $ret = minus_f_nocase "$dir/$s" and containspod($ret))
164 $ret = minus_f_nocase "$dir/$s.com" and containspod($ret))
165 or ( $ret = minus_f_nocase "$dir/pod/$s.pod")
166 or ( $ret = minus_f_nocase "$dir/pod/$s" and containspod($ret)))
171 my(@newdirs) = grep(-d,map("$dir/$_",grep(!/^\.\.?$/,readdir(D))));
173 @newdirs = map((s/.dir$//,$_)[1],@newdirs) if $Is_VMS;
174 next unless @newdirs;
175 print STDERR "Also looking in @newdirs\n" if $opt_v;
176 push(@dirs,@newdirs);
184 print STDERR "Searching for $_\n" if $opt_v;
185 # We must look both in @INC for library modules and in PATH
186 # for executables, like h2xs or perldoc itself.
191 for ($i = 0; $trn = $ENV{'DCL$PATH'.$i}; $i++) {
192 push(@searchdirs,$trn);
195 push(@searchdirs, grep(-d, split(':', $ENV{'PATH'})));
197 @files= searchfor(0,$_,@searchdirs);
200 print STDERR "Found as @files\n" if $opt_v;
202 # no match, try recursive search
204 @searchdirs = grep(!/^\.$/,@INC);
207 @files= searchfor(1,$_,@searchdirs);
209 print STDERR "Loosely found as @files\n" if $opt_v;
211 print STDERR "No documentation found for '$_'\n";
218 exit ($Is_VMS ? 98962 : 1);
221 if( ! -t STDOUT ) { $opt_f = 1 }
224 $tmp = "/tmp/perldoc1.$$";
225 push @pagers, qw( more less pg view cat );
226 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
229 $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
230 push @pagers, qw( most more less type/page );
231 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
236 foreach $pager (@pagers) {
237 my($sts) = system("$pager @found");
238 exit 0 if ($Is_VMS ? ($sts & 1) : !$sts);
240 exit $Is_VMS ? $sts : 1;
247 Pod::Text::pod2text($_,*TMP);
249 } elsif(not $opt_u) {
252 $rslt = `pod2man $_ | nroff -man | col -x`;
254 $rslt = `pod2man $_ | nroff -man`;
256 if ($Is_VMS) { $err = !($? % 2) || $rslt =~ /IVVERB/; }
258 print TMP $rslt unless $err;
262 if( $opt_u or $err or -z $tmp) {
267 $cut = $1 eq 'cut' if /^=(\w+)/;
281 foreach $pager (@pagers) {
282 $sts = system("$pager $tmp");
283 last if $Is_VMS && ($sts & 1);
288 1 while unlink($tmp); #Possibly pointless VMSism
296 perldoc - Look up Perl documentation in pod format.
300 B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] PageName|ModuleName|ProgramName
304 I<perldoc> looks up a piece of documentation in .pod format that is embedded
305 in the perl installation tree or in a perl script, and displays it via
306 C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
307 C<col -x> will be used.) This is primarily used for the documentation for
308 the perl library modules.
310 Your system may also have man pages installed for those modules, in
311 which case you can probably just use the man(1) command.
319 Prints out a brief help message.
323 Describes search for the item in detail.
325 =item B<-t> text output
327 Display docs using plain text converter, instead of nroff. This may be faster,
328 but it won't look as nice.
330 =item B<-u> unformatted
332 Find docs only; skip reformatting by pod2*
336 Display the entire module: both code and unformatted pod documentation.
337 This may be useful if the docs don't explain a function in the detail
338 you need, and you'd like to inspect the code directly; perldoc will find
339 the file for you and simply hand it off for display.
341 =item B<PageName|ModuleName|ProgramName>
343 The item you want to look up. Nested modules (such as C<File::Basename>)
344 are specified either as C<File::Basename> or C<File/Basename>. You may also
345 give a descriptive name of a page, such as C<perlfunc>. You make also give a
346 partial or wrong-case name, such as "basename" for "File::Basename", but
347 this will be slower, if there is more then one page with the same partial
348 name, you will only get the first one.
354 Any switches in the C<PERLDOC> environment variable will be used before the
355 command line arguments. C<perldoc> also searches directories
356 specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
357 defined) and C<PATH> environment variables.
358 (The latter is so that embedded pods for executables, such as
359 C<perldoc> itself, are available.)
363 Kenneth Albanowski <kjahds@kjahds.com>
365 Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
374 # Version 1.11: Tue Dec 26 09:54:33 EST 1995
375 # Kenneth Albanowski <kjahds@kjahds.com>
376 # -added Charles Bailey's further VMS patches, and -u switch
377 # -added -t switch, with pod2text support
379 # Version 1.10: Thu Nov 9 07:23:47 EST 1995
380 # Kenneth Albanowski <kjahds@kjahds.com>
382 # -added better error recognition (on no found pages, just exit. On
383 # missing nroff/pod2man, just display raw pod.)
384 # -added recursive/case-insensitive matching (thanks, Andreas). This
385 # slows things down a bit, unfortunately. Give a precise name, and
388 # Version 1.01: Tue May 30 14:47:34 EDT 1995
389 # Andy Dougherty <doughera@lafcol.lafayette.edu>
390 # -added pod documentation.
391 # -added PATH searching.
392 # -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
398 # Cache directories read during sloppy match
401 close OUT or die "Can't close $file: $!";
402 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
403 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';