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, '.PL');
17 $file .= '.com' if $^O eq 'VMS';
19 open OUT,">$file" or die "Can't create $file: $!";
21 print "Extracting $file (with variable substitutions)\n";
23 # In this section, perl variables will be expanded during extraction.
24 # You can use $Config{...} to use Configure variables.
26 print OUT <<"!GROK!THIS!";
28 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
29 if \$running_under_some_shell;
32 push \@pagers, "$Config{'pager'}" if -x "$Config{'pager'}";
35 # In the following, perl variables are not expanded during extraction.
37 print OUT <<'!NO!SUBS!';
40 # Perldoc revision #1 -- look up a piece of documentation in .pod format that
41 # is embedded in the perl installation tree.
43 # This is not to be confused with Tom Christianson's perlman, which is a
44 # man replacement, written in perl. This perldoc is strictly for reading
45 # the perl manuals, though it too is written in perl.
49 Usage: $0 [-h] [-v] [-t] [-u] [-m] [-l] PageName|ModuleName|ProgramName
51 We suggest you use "perldoc perldoc" to get aquainted
57 $Is_VMS = $^O eq 'VMS';
61 # Make sure exit status is success under VMS, so shell doesn't
62 # display error messages left over from startup.
63 ($! = 0, $^E = 1) if $^O eq 'VMS';
65 perldoc [-h] [-v] [-u] PageName|ModuleName|ProgramName...
66 -h Display this help message.
67 -t Display pod using pod2text instead of pod2man and nroff.
68 -u Display unformatted pod text
69 -m Display modules file in its entirety
70 -l Display the modules file name
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("mhtluv") || usage;
92 usage if $opt_h || $opt_h; # avoid -w warning
94 usage("only one of -t, -u, -m or -l") if $opt_t + $opt_u + $opt_m + $opt_l > 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 return $s if -f $s && containspod($s);
154 printf STDERR "looking for $s in @dirs\n" if $opt_v;
158 for ($i=0;$i<@dirs;$i++) {
160 ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS;
161 if (( $ret = minus_f_nocase "$dir/$s.pod")
162 or ( $ret = minus_f_nocase "$dir/$s.pm" and containspod($ret))
163 or ( $ret = minus_f_nocase "$dir/$s" and containspod($ret))
165 $ret = minus_f_nocase "$dir/$s.com" and containspod($ret))
166 or ( $ret = minus_f_nocase "$dir/pod/$s.pod")
167 or ( $ret = minus_f_nocase "$dir/pod/$s" and containspod($ret)))
172 my(@newdirs) = grep(-d,map("$dir/$_",grep(!/^\.\.?$/,readdir(D))));
174 @newdirs = map((s/.dir$//,$_)[1],@newdirs) if $Is_VMS;
175 next unless @newdirs;
176 print STDERR "Also looking in @newdirs\n" if $opt_v;
177 push(@dirs,@newdirs);
185 print STDERR "Searching for $_\n" if $opt_v;
186 # We must look both in @INC for library modules and in PATH
187 # for executables, like h2xs or perldoc itself.
192 for ($i = 0; $trn = $ENV{'DCL$PATH'.$i}; $i++) {
193 push(@searchdirs,$trn);
196 push(@searchdirs, grep(-d, split(':', $ENV{'PATH'})));
198 @files= searchfor(0,$_,@searchdirs);
201 print STDERR "Found as @files\n" if $opt_v;
203 # no match, try recursive search
205 @searchdirs = grep(!/^\.$/,@INC);
208 @files= searchfor(1,$_,@searchdirs);
210 print STDERR "Loosely found as @files\n" if $opt_v;
212 print STDERR "No documentation found for '$_'\n";
219 exit ($Is_VMS ? 98962 : 1);
223 print join("\n", @found), "\n";
227 if( ! -t STDOUT ) { $opt_f = 1 }
230 $tmp = "/tmp/perldoc1.$$";
231 push @pagers, qw( more less pg view cat );
232 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
234 $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
235 push @pagers, qw( most more less type/page );
237 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
240 foreach $pager (@pagers) {
241 my($sts) = system("$pager @found");
242 exit 0 if ($Is_VMS ? ($sts & 1) : !$sts);
244 exit $Is_VMS ? $sts : 1;
251 Pod::Text::pod2text($_,*TMP);
253 } elsif(not $opt_u) {
256 $rslt = `pod2man $_ | nroff -man | col -x`;
258 $rslt = `pod2man $_ | nroff -man`;
260 if ($Is_VMS) { $err = !($? % 2) || $rslt =~ /IVVERB/; }
262 print TMP $rslt unless $err;
266 if( $opt_u or $err or -z $tmp) {
271 $cut = $1 eq 'cut' if /^=(\w+)/;
285 foreach $pager (@pagers) {
286 $sts = system("$pager $tmp");
287 last if $Is_VMS && ($sts & 1);
292 1 while unlink($tmp); #Possibly pointless VMSism
300 perldoc - Look up Perl documentation in pod format.
304 B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] PageName|ModuleName|ProgramName
308 I<perldoc> looks up a piece of documentation in .pod format that is embedded
309 in the perl installation tree or in a perl script, and displays it via
310 C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
311 C<col -x> will be used.) This is primarily used for the documentation for
312 the perl library modules.
314 Your system may also have man pages installed for those modules, in
315 which case you can probably just use the man(1) command.
323 Prints out a brief help message.
327 Describes search for the item in detail.
329 =item B<-t> text output
331 Display docs using plain text converter, instead of nroff. This may be faster,
332 but it won't look as nice.
334 =item B<-u> unformatted
336 Find docs only; skip reformatting by pod2*
340 Display the entire module: both code and unformatted pod documentation.
341 This may be useful if the docs don't explain a function in the detail
342 you need, and you'd like to inspect the code directly; perldoc will find
343 the file for you and simply hand it off for display.
345 =item B<-l> file name only
347 Display the file name of the module found.
349 =item B<PageName|ModuleName|ProgramName>
351 The item you want to look up. Nested modules (such as C<File::Basename>)
352 are specified either as C<File::Basename> or C<File/Basename>. You may also
353 give a descriptive name of a page, such as C<perlfunc>. You make also give a
354 partial or wrong-case name, such as "basename" for "File::Basename", but
355 this will be slower, if there is more then one page with the same partial
356 name, you will only get the first one.
362 Any switches in the C<PERLDOC> environment variable will be used before the
363 command line arguments. C<perldoc> also searches directories
364 specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
365 defined) and C<PATH> environment variables.
366 (The latter is so that embedded pods for executables, such as
367 C<perldoc> itself, are available.)
371 Kenneth Albanowski <kjahds@kjahds.com>
373 Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
378 # Version 1.11: Tue Dec 26 09:54:33 EST 1995
379 # Kenneth Albanowski <kjahds@kjahds.com>
380 # -added Charles Bailey's further VMS patches, and -u switch
381 # -added -t switch, with pod2text support
383 # Version 1.10: Thu Nov 9 07:23:47 EST 1995
384 # Kenneth Albanowski <kjahds@kjahds.com>
386 # -added better error recognition (on no found pages, just exit. On
387 # missing nroff/pod2man, just display raw pod.)
388 # -added recursive/case-insensitive matching (thanks, Andreas). This
389 # slows things down a bit, unfortunately. Give a precise name, and
392 # Version 1.01: Tue May 30 14:47:34 EDT 1995
393 # Andy Dougherty <doughera@lafcol.lafayette.edu>
394 # -added pod documentation.
395 # -added PATH searching.
396 # -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
402 # Cache directories read during sloppy match
405 close OUT or die "Can't close $file: $!";
406 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
407 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';