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.
48 $me = $0; # Editing $0 is unportable
51 Usage: $me [-h] [-v] [-t] [-u] [-m] [-l] [-F] [-X] PageName|ModuleName|ProgramName
54 The -h option prints more help. Also try "perldoc perldoc" to get
55 aquainted with the system.
65 $Is_VMS = $^O eq 'VMS';
66 $Is_MSWin32 = $^O eq 'MSWin32';
67 $Is_Dos = $^O eq 'dos';
71 # Erase evidence of previous errors (if any), so exit status is simple.
74 perldoc [options] PageName|ModuleName|ProgramName...
75 perldoc [options] -f BuiltinFunction
78 -h Display this help message
79 -t Display pod using pod2text instead of pod2man and nroff
80 (-t is the default on win32)
81 -u Display unformatted pod text
82 -m Display modules file in its entirety
83 -l Display the modules file name
84 -F Arguments are file names, not modules
85 -v Verbosely describe what's going on
86 -X use index if present (looks for pod.idx at $Config{archlib})
88 PageName|ModuleName...
89 is the name of a piece of documentation that you want to look at. You
90 may either give a descriptive name of the page (as in the case of
91 `perlfunc') the name of a module, either like `Term::Info',
92 `Term/Info', the partial name of a module, like `info', or
93 `makemaker', or the name of a program, like `perldoc'.
96 is the name of a perl function. Will extract documentation from
99 Any switches in the PERLDOC environment variable will be used before the
100 command line arguments. The optional pod index file contains a list of
101 filenames, one per line.
106 use Text::ParseWords;
109 unshift(@ARGV,shellwords($ENV{"PERLDOC"}));
111 getopts("mhtluvFf:X") || usage;
113 usage if $opt_h || $opt_h; # avoid -w warning
115 $podidx = "$Config{'archlib'}/pod.idx";
116 $podidx = "" if $opt_X || !-f "pod.idx" && !-r _ && -M _ > 7;
118 if ($opt_t + $opt_u + $opt_m + $opt_l > 1) {
119 usage("only one of -t, -u, -m or -l")
120 } elsif ($Is_MSWin32 || $Is_Dos) {
121 $opt_t = 1 unless $opt_t + $opt_u + $opt_m + $opt_l;
124 if ($opt_t) { require Pod::Text; import Pod::Text; }
127 @pages = ("perlfunc");
132 # Does this look like a module or extension directory?
133 if (-f "Makefile.PL") {
134 # Add ., lib and blib/* libs to @INC (if they exist)
136 unshift(@INC, 'lib') if -d 'lib';
137 require ExtUtils::testlib;
143 my($file, $readit) = @_;
144 return 1 if !$readit && $file =~ /\.pod$/i;
159 # on a case-forgiving file system we can simply use -f $file
160 if ($Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') {
161 return $file if -f $file and -r _;
162 warn "Ignored $file: unreadable\n" if -f _;
168 foreach $p (split(/\//, $file)){
173 if ( $p eq $global_target) {
174 $tmp_path = join ('/', @p);
176 for (@global_found) {
177 $path_f = 1 if $_ eq $tmp_path;
179 push (@global_found, $tmp_path) unless $path_f;
180 print STDERR "Found as @p but directory\n" if $opt_v;
182 } elsif (-f _ && -r _) {
185 warn "Ignored $try: unreadable\n";
190 while ($cip=readdir(DIR)) {
191 if (lc $cip eq $lcp){
197 return "" unless $found;
199 return "@p" if -f "@p" and -r _;
200 warn "Ignored $file: unreadable\n" if -f _;
203 return; # is not a file
209 return minus_f_nocase($file) && containspod($file) ? $file : "";
214 my($recurse,$s,@dirs) = @_;
216 $s = VMS::Filespec::unixify($s) if $Is_VMS;
217 return $s if -f $s && containspod($s);
218 printf STDERR "Looking for $s in @dirs\n" if $opt_v;
222 $global_target = (split('/', $s))[-1];
223 for ($i=0; $i<@dirs; $i++) {
225 ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS;
226 if ( ( $ret = check_file "$dir/$s.pod")
227 or ( $ret = check_file "$dir/$s.pm")
228 or ( $ret = check_file "$dir/$s")
230 $ret = check_file "$dir/$s.com")
231 or ( $^O eq 'os2' and
232 $ret = check_file "$dir/$s.cmd")
233 or ( ($Is_MSWin32 or $Is_Dos or $^O eq 'os2') and
234 $ret = check_file "$dir/$s.bat")
235 or ( $ret = check_file "$dir/pod/$s.pod")
236 or ( $ret = check_file "$dir/pod/$s")
243 my @newdirs = map "$dir/$_", grep {
245 not /^auto$/ and # save time! don't search auto dirs
249 next unless @newdirs;
250 @newdirs = map((s/.dir$//,$_)[1],@newdirs) if $Is_VMS;
251 print STDERR "Also looking in @newdirs\n" if $opt_v;
252 push(@dirs,@newdirs);
260 if ($podidx && open(PODIDX, $podidx)) {
263 $searchfor =~ s,::,/,g;
264 print STDERR "Searching for '$searchfor' in $podidx\n" if $opt_v;
267 push(@found, $_) if m,/$searchfor(?:\.(?:pod|pm))?$,i;
272 print STDERR "Searching for $_\n" if $opt_v;
273 # We must look both in @INC for library modules and in PATH
274 # for executables, like h2xs or perldoc itself.
278 push @found, $_ if $opt_m or containspod($_);
284 for ($i = 0; $trn = $ENV{'DCL$PATH'.$i}; $i++) {
285 push(@searchdirs,$trn);
288 push(@searchdirs, grep(-d, split($Config{path_sep},
291 @files= searchfor(0,$_,@searchdirs);
294 print STDERR "Found as @files\n" if $opt_v;
296 # no match, try recursive search
298 @searchdirs = grep(!/^\.$/,@INC);
300 @files= searchfor(1,$_,@searchdirs);
302 print STDERR "Loosely found as @files\n" if $opt_v;
304 print STDERR "No documentation found for \"$_\".\n";
306 print STDERR "However, try\n";
307 my $dir = $file = "";
308 for $dir (@global_found) {
309 opendir(DIR, $dir) or die "$!";
310 while ($file = readdir(DIR)) {
311 next if ($file =~ /^\./);
312 $file =~ s/\.(pm|pod)$//;
313 print STDERR "\tperldoc $_\::$file\n";
324 exit ($Is_VMS ? 98962 : 1);
328 print join("\n", @found), "\n";
332 if( ! -t STDOUT ) { $no_tty = 1 }
335 $tmp = "$ENV{TEMP}\\perldoc1.$$";
336 push @pagers, qw( more< less notepad );
337 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
339 $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
340 push @pagers, qw( most more less type/page );
342 $tmp = "$ENV{TEMP}/perldoc1.$$";
344 push @pagers, qw( less.exe more.com< );
345 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
349 $tmp = POSIX::tmpnam();
351 $tmp = "/tmp/perldoc1.$$";
353 push @pagers, qw( more less pg view cat );
354 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
356 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
359 foreach $pager (@pagers) {
360 system("$pager @found") or exit;
362 if ($Is_VMS) { eval 'use vmsish qw(status exit); exit $?' }
367 my $perlfunc = shift @found;
368 open(PFUNC, $perlfunc) or die "Can't open $perlfunc: $!";
372 last if /^=head2 Alphabetical Listing of Perl Functions/;
375 # Look for our function
379 if (/^=item\s+\Q$opt_f\E\b/o) {
386 ++$found if /^\w/; # found descriptive text
390 open(FORMATTER, "| pod2text") || die "Can't start filter";
391 print FORMATTER "=over 8\n\n";
392 print FORMATTER @pod;
393 print FORMATTER "=back\n";
399 die "No documentation for perl function `$opt_f' found\n";
408 Pod::Text::pod2text($_,*TMP);
410 } elsif(not $opt_u) {
411 my $cmd = "pod2man --lax $_ | nroff -man";
412 $cmd .= " | col -x" if $^O =~ /hpux/;
414 unless(($err = $?)) {
421 if( $opt_u or $err or -z $tmp) {
426 $cut = $1 eq 'cut' if /^=(\w+)/;
440 foreach $pager (@pagers) {
441 system("$pager $tmp") or last;
445 1 while unlink($tmp); #Possibly pointless VMSism
453 perldoc - Look up Perl documentation in pod format.
457 B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-X>] PageName|ModuleName|ProgramName
459 B<perldoc> B<-f> BuiltinFunction
463 I<perldoc> looks up a piece of documentation in .pod format that is embedded
464 in the perl installation tree or in a perl script, and displays it via
465 C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
466 C<col -x> will be used.) This is primarily used for the documentation for
467 the perl library modules.
469 Your system may also have man pages installed for those modules, in
470 which case you can probably just use the man(1) command.
478 Prints out a brief help message.
482 Describes search for the item in detail.
484 =item B<-t> text output
486 Display docs using plain text converter, instead of nroff. This may be faster,
487 but it won't look as nice.
489 =item B<-u> unformatted
491 Find docs only; skip reformatting by pod2*
495 Display the entire module: both code and unformatted pod documentation.
496 This may be useful if the docs don't explain a function in the detail
497 you need, and you'd like to inspect the code directly; perldoc will find
498 the file for you and simply hand it off for display.
500 =item B<-l> file name only
502 Display the file name of the module found.
504 =item B<-F> file names
506 Consider arguments as file names, no search in directories will be performed.
510 The B<-f> option followed by the name of a perl built in function will
511 extract the documentation of this function from L<perlfunc>.
513 =item B<-X> use an index if present
515 The B<-X> option looks for a entry whose basename matches the name given on the
516 command line in the file C<$Config{archlib}/pod.idx>. The pod.idx file should
517 contain fully qualified filenames, one per line.
519 =item B<PageName|ModuleName|ProgramName>
521 The item you want to look up. Nested modules (such as C<File::Basename>)
522 are specified either as C<File::Basename> or C<File/Basename>. You may also
523 give a descriptive name of a page, such as C<perlfunc>. You make also give a
524 partial or wrong-case name, such as "basename" for "File::Basename", but
525 this will be slower, if there is more then one page with the same partial
526 name, you will only get the first one.
532 Any switches in the C<PERLDOC> environment variable will be used before the
533 command line arguments. C<perldoc> also searches directories
534 specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
535 defined) and C<PATH> environment variables.
536 (The latter is so that embedded pods for executables, such as
537 C<perldoc> itself, are available.)
541 Kenneth Albanowski <kjahds@kjahds.com>
543 Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
548 # Version 1.13: Fri Feb 27 16:20:50 EST 1997
549 # Gurusamy Sarathy <gsar@umich.edu>
550 # -doc tweaks for -F and -X options
551 # Version 1.12: Sat Apr 12 22:41:09 EST 1997
552 # Gurusamy Sarathy <gsar@umich.edu>
553 # -various fixes for win32
554 # Version 1.11: Tue Dec 26 09:54:33 EST 1995
555 # Kenneth Albanowski <kjahds@kjahds.com>
556 # -added Charles Bailey's further VMS patches, and -u switch
557 # -added -t switch, with pod2text support
559 # Version 1.10: Thu Nov 9 07:23:47 EST 1995
560 # Kenneth Albanowski <kjahds@kjahds.com>
562 # -added better error recognition (on no found pages, just exit. On
563 # missing nroff/pod2man, just display raw pod.)
564 # -added recursive/case-insensitive matching (thanks, Andreas). This
565 # slows things down a bit, unfortunately. Give a precise name, and
568 # Version 1.01: Tue May 30 14:47:34 EDT 1995
569 # Andy Dougherty <doughera@lafcol.lafayette.edu>
570 # -added pod documentation.
571 # -added PATH searching.
572 # -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
578 # Cache directories read during sloppy match
581 close OUT or die "Can't close $file: $!";
582 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
583 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';