4 use File::Basename qw(&basename &dirname);
7 # List explicitly here the variables you want Configure to
8 # generate. Metaconfig only looks for shell variables, so you
9 # have to mention them as if they were shell variables, not
10 # %Config entries. Thus you write
12 # to ensure Configure will look for $Config{startperl}.
14 # This forces PL files to create target in same directory as PL file.
15 # This is so that make depend always knows where to find PL derivatives.
18 $file = basename($0, '.PL');
19 $file .= '.com' if $^O eq 'VMS';
21 open OUT,">$file" or die "Can't create $file: $!";
23 print "Extracting $file (with variable substitutions)\n";
25 # In this section, perl variables will be expanded during extraction.
26 # You can use $Config{...} to use Configure variables.
28 print OUT <<"!GROK!THIS!";
30 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
35 push \@pagers, "$Config{'pager'}" if -x "$Config{'pager'}";
38 # In the following, perl variables are not expanded during extraction.
40 print OUT <<'!NO!SUBS!';
43 # Perldoc revision #1 -- look up a piece of documentation in .pod format that
44 # is embedded in the perl installation tree.
46 # This is not to be confused with Tom Christianson's perlman, which is a
47 # man replacement, written in perl. This perldoc is strictly for reading
48 # the perl manuals, though it too is written in perl.
51 my $me = $0; # Editing $0 is unportable
54 Usage: $me [-h] [-r] [-i] [-v] [-t] [-u] [-m] [-l] [-F] [-X] PageName|ModuleName|ProgramName
58 The -h option prints more help. Also try "perldoc perldoc" to get
59 aquainted with the system.
66 my @global_found = ();
67 my $global_target = "";
69 my $Is_VMS = $^O eq 'VMS';
70 my $Is_MSWin32 = $^O eq 'MSWin32';
71 my $Is_Dos = $^O eq 'dos';
75 # Erase evidence of previous errors (if any), so exit status is simple.
78 perldoc [options] PageName|ModuleName|ProgramName...
79 perldoc [options] -f BuiltinFunction
80 perldoc [options] -q FAQRegex
83 -h Display this help message
84 -r Recursive search (slow)
86 -t Display pod using pod2text instead of pod2man and nroff
87 (-t is the default on win32)
88 -u Display unformatted pod text
89 -m Display module's file in its entirety
90 -l Display the module's file name
91 -F Arguments are file names, not modules
92 -v Verbosely describe what's going on
93 -X use index if present (looks for pod.idx at $Config{archlib})
94 -q Search the text of questions (not answers) in perlfaq[1-9]
96 PageName|ModuleName...
97 is the name of a piece of documentation that you want to look at. You
98 may either give a descriptive name of the page (as in the case of
99 `perlfunc') the name of a module, either like `Term::Info',
100 `Term/Info', the partial name of a module, like `info', or
101 `makemaker', or the name of a program, like `perldoc'.
104 is the name of a perl function. Will extract documentation from
108 is a regex. Will search perlfaq[1-9] for and extract any
109 questions that match.
111 Any switches in the PERLDOC environment variable will be used before the
112 command line arguments. The optional pod index file contains a list of
113 filenames, one per line.
118 if (defined $ENV{"PERLDOC"}) {
119 require Text::ParseWords;
120 unshift(@ARGV, Text::ParseWords::shellwords($ENV{"PERLDOC"}));
124 my $getopts = "mhtluvriFf:Xq:";
125 print OUT <<"!GET!OPTS!";
127 use vars qw( @{[map "\$opt_$_", ($getopts =~ /\w/g)]} );
129 getopts("$getopts") || usage;
132 print OUT <<'!NO!SUBS!';
138 $podidx = "$Config{'archlib'}/pod.idx";
139 $podidx = "" unless -f $podidx && -r _ && -M _ <= 7;
142 if ((my $opts = do{ local $^W; $opt_t + $opt_u + $opt_m + $opt_l }) > 1) {
143 usage("only one of -t, -u, -m or -l")
147 || !(exists $ENV{TERM} && $ENV{TERM} !~ /dumb|emacs|none|unknown/i))
149 $opt_t = 1 unless $opts
152 if ($opt_t) { require Pod::Text; import Pod::Text; }
156 @pages = ("perlfunc");
159 @pages = ("perlfaq1" .. "perlfaq9");
165 # Does this look like a module or extension directory?
166 if (-f "Makefile.PL") {
167 # Add ., lib and blib/* libs to @INC (if they exist)
169 unshift(@INC, 'lib') if -d 'lib';
170 require ExtUtils::testlib;
174 my($file, $readit) = @_;
175 return 1 if !$readit && $file =~ /\.pod$/i;
190 my $path = join('/',$dir,$file);
191 return $path if -f $path and -r _;
192 if (!$opt_i or $Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') {
193 # on a case-forgiving file system or if case is important
194 # that is it all we can do
195 warn "Ignored $path: unreadable\n" if -f _;
202 foreach $p (split(/\//, $file)){
207 if ( $p eq $global_target) {
208 my $tmp_path = join ('/', @p);
210 for (@global_found) {
211 $path_f = 1 if $_ eq $tmp_path;
213 push (@global_found, $tmp_path) unless $path_f;
214 print STDERR "Found as @p but directory\n" if $opt_v;
217 elsif (-f _ && -r _) {
221 warn "Ignored $try: unreadable\n";
227 while ($cip=readdir(DIR)) {
228 if (lc $cip eq $lcp){
234 return "" unless $found;
236 return "@p" if -f "@p" and -r _;
237 warn "Ignored @p: unreadable\n" if -f _;
247 return minus_f_nocase($dir,$file);
250 my $path = minus_f_nocase($dir,$file);
251 return $path if length $path and containspod($path);
258 my($recurse,$s,@dirs) = @_;
260 $s = VMS::Filespec::unixify($s) if $Is_VMS;
261 return $s if -f $s && containspod($s);
262 printf STDERR "Looking for $s in @dirs\n" if $opt_v;
266 $global_target = (split('/', $s))[-1];
267 for ($i=0; $i<@dirs; $i++) {
269 ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS;
270 if ( ( $ret = check_file $dir,"$s.pod")
271 or ( $ret = check_file $dir,"$s.pm")
272 or ( $ret = check_file $dir,$s)
274 $ret = check_file $dir,"$s.com")
275 or ( $^O eq 'os2' and
276 $ret = check_file $dir,"$s.cmd")
277 or ( ($Is_MSWin32 or $Is_Dos or $^O eq 'os2') and
278 $ret = check_file $dir,"$s.bat")
279 or ( $ret = check_file "$dir/pod","$s.pod")
280 or ( $ret = check_file "$dir/pod",$s)
287 my @newdirs = map "$dir/$_", grep {
289 not /^auto$/ and # save time! don't search auto dirs
293 next unless @newdirs;
294 @newdirs = map((s/.dir$//,$_)[1],@newdirs) if $Is_VMS;
295 print STDERR "Also looking in @newdirs\n" if $opt_v;
296 push(@dirs,@newdirs);
303 my @data = split /\n{2,}/, shift;
304 shift @data while @data and $data[0] !~ /\S/; # Go to header
305 shift @data if @data and $data[0] =~ /Contributed\s+Perl/; # Skip header
306 pop @data if @data and $data[-1] =~ /^\w/; # Skip footer, like
307 # 28/Jan/99 perl 5.005, patch 53 1
312 my ($file, $tmp, $filter) = @_;
317 or warn("Can't open $tmp: $!"), return;
318 Pod::Text::pod2text($file,*TMP);
322 my $cmd = "pod2man --lax $file | nroff -man";
323 $cmd .= " | col -x" if $^O =~ /hpux/;
325 $rslt = filter_nroff($rslt) if $filter;
326 unless (($err = $?)) {
327 open(TMP,">>$tmp") or warn("Can't open $tmp: $!"), return;
332 if ($opt_u or $err or -z $tmp) {
333 open(OUT,">>$tmp") or warn("Can't open $tmp: $!"), return;
334 open(IN,"<$file") or warn("Can't open $file: $!"), return;
337 $cut = $1 eq 'cut' if /^=(\w+)/;
347 my ($tmp, $no_tty, @pagers) = @_;
349 open(TMP,"<$tmp") or warn("Can't open $tmp: $!"), return;
354 foreach my $pager (@pagers) {
355 system("$pager $tmp") or last;
363 1 while unlink($_); #Possibly pointless VMSism
368 my ($val, @files) = @_;
374 my ($msg, @files) = @_;
381 if ($podidx && open(PODIDX, $podidx)) {
384 $searchfor =~ s,::,/,g;
385 print STDERR "Searching for '$searchfor' in $podidx\n" if $opt_v;
388 push(@found, $_) if m,/$searchfor(?:\.(?:pod|pm))?$,i;
393 print STDERR "Searching for $_\n" if $opt_v;
394 # We must look both in @INC for library modules and in PATH
395 # for executables, like h2xs or perldoc itself.
396 my @searchdirs = @INC;
399 push @found, $_ if $opt_m or containspod($_);
405 for ($i = 0; $trn = $ENV{'DCL$PATH;'.$i}; $i++) {
406 push(@searchdirs,$trn);
408 push(@searchdirs,'perl_root:[lib.pod]') # installed pods
411 push(@searchdirs, grep(-d, split($Config{path_sep},
415 my @files = searchfor(0,$_,@searchdirs);
417 print STDERR "Found as @files\n" if $opt_v;
420 # no match, try recursive search
421 @searchdirs = grep(!/^\.$/,@INC);
422 @files= searchfor(1,$_,@searchdirs) if $opt_r;
424 print STDERR "Loosely found as @files\n" if $opt_v;
427 print STDERR "No documentation found for \"$_\".\n";
429 print STDERR "However, try\n";
430 for my $dir (@global_found) {
431 opendir(DIR, $dir) or die "$!";
432 while (my $file = readdir(DIR)) {
433 next if ($file =~ /^\./);
434 $file =~ s/\.(pm|pod)$//;
435 print STDERR "\tperldoc $_\::$file\n";
446 exit ($Is_VMS ? 98962 : 1);
450 print join("\n", @found), "\n";
454 my $lines = $ENV{LINES} || 24;
457 if (! -t STDOUT) { $no_tty = 1 }
459 # until here we could simply exit or die
460 # now we create temporary files that we have to clean up
461 # namely $tmp, $buffer
466 $tmp = "$ENV{TEMP}\\perldoc1.$$";
467 $buffer = "$ENV{TEMP}\\perldoc1.b$$";
468 push @pagers, qw( more< less notepad );
469 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
470 for (@found) { s,/,\\,g }
473 $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
474 $buffer = 'Sys$Scratch:perldoc.tmp1_b'.$$;
475 push @pagers, qw( most more less type/page );
478 $tmp = "$ENV{TEMP}/perldoc1.$$";
479 $buffer = "$ENV{TEMP}/perldoc1.b$$";
481 $buffer =~ tr!\\/!//!s;
482 push @pagers, qw( less.exe more.com< );
483 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
488 $tmp = POSIX::tmpnam();
489 $buffer = POSIX::tmpnam();
490 unshift @pagers, 'less', 'cmd /c more <';
493 $tmp = "/tmp/perldoc1.$$";
494 $buffer = "/tmp/perldoc1.b$$";
496 push @pagers, qw( more less pg view cat );
497 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
499 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
501 # all exit calls from here on have to be safe_exit calls (see above)
502 # and all die calls safe_die calls to guarantee removal of files and
506 foreach my $pager (@pagers) {
507 system("$pager @found") or safe_exit(0, $tmp, $buffer);
509 if ($Is_VMS) { eval 'use vmsish qw(status exit); exit $?' }
510 # I don't get the line above. Please patch yourself as needed.
511 safe_exit(1, $tmp, $buffer);
516 my $perlfunc = shift @found;
517 open(PFUNC, $perlfunc)
518 or safe_die("Can't open $perlfunc: $!", $tmp, $buffer);
520 # Functions like -r, -e, etc. are listed under `-X'.
521 my $search_string = ($opt_f =~ /^-[rwxoRWXOeszfdlpSbctugkTBMAC]$/)
526 last if /^=head2 Alphabetical Listing of Perl Functions/;
529 # Look for our function
533 if (/^=item\s+\Q$search_string\E\b/o) {
537 last if $found > 1 and not $inlist;
547 ++$found if /^\w/; # found descriptive text
550 die "No documentation for perl function `$opt_f' found\n";
555 local @ARGV = @found; # I'm lazy, sue me.
560 if (/^=head2\s+.*(?:$opt_q)/oi) {
562 push @pod, "=head1 Found in $ARGV\n\n" unless $found_in{$ARGV}++;
571 safe_die("No documentation for perl FAQ keyword `$opt_q' found\n",
579 open(TMP,">$buffer") or safe_die("Can't open '$buffer': $!", $tmp, $buffer);
580 print TMP "=over 8\n\n";
589 printout($_, $tmp, $filter);
591 page($tmp, $no_tty, @pagers);
593 safe_exit(0, $tmp, $buffer);
599 perldoc - Look up Perl documentation in pod format.
603 B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-X>] PageName|ModuleName|ProgramName
605 B<perldoc> B<-f> BuiltinFunction
607 B<perldoc> B<-q> FAQ Keyword
611 I<perldoc> looks up a piece of documentation in .pod format that is embedded
612 in the perl installation tree or in a perl script, and displays it via
613 C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
614 C<col -x> will be used.) This is primarily used for the documentation for
615 the perl library modules.
617 Your system may also have man pages installed for those modules, in
618 which case you can probably just use the man(1) command.
626 Prints out a brief help message.
630 Describes search for the item in detail.
632 =item B<-t> text output
634 Display docs using plain text converter, instead of nroff. This may be faster,
635 but it won't look as nice.
637 =item B<-u> unformatted
639 Find docs only; skip reformatting by pod2*
643 Display the entire module: both code and unformatted pod documentation.
644 This may be useful if the docs don't explain a function in the detail
645 you need, and you'd like to inspect the code directly; perldoc will find
646 the file for you and simply hand it off for display.
648 =item B<-l> file name only
650 Display the file name of the module found.
652 =item B<-F> file names
654 Consider arguments as file names, no search in directories will be performed.
658 The B<-f> option followed by the name of a perl built in function will
659 extract the documentation of this function from L<perlfunc>.
663 The B<-q> option takes a regular expression as an argument. It will search
664 the question headings in perlfaq[1-9] and print the entries matching
665 the regular expression.
667 =item B<-X> use an index if present
669 The B<-X> option looks for a entry whose basename matches the name given on the
670 command line in the file C<$Config{archlib}/pod.idx>. The pod.idx file should
671 contain fully qualified filenames, one per line.
673 =item B<PageName|ModuleName|ProgramName>
675 The item you want to look up. Nested modules (such as C<File::Basename>)
676 are specified either as C<File::Basename> or C<File/Basename>. You may also
677 give a descriptive name of a page, such as C<perlfunc>. You may also give a
678 partial or wrong-case name, such as "basename" for "File::Basename", but
679 this will be slower, if there is more then one page with the same partial
680 name, you will only get the first one.
686 Any switches in the C<PERLDOC> environment variable will be used before the
687 command line arguments. C<perldoc> also searches directories
688 specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
689 defined) and C<PATH> environment variables.
690 (The latter is so that embedded pods for executables, such as
691 C<perldoc> itself, are available.) C<perldoc> will use, in order of
692 preference, the pager defined in C<PERLDOC_PAGER>, C<MANPAGER>, or
693 C<PAGER> before trying to find a pager on its own. (C<MANPAGER> is not
694 used if C<perldoc> was told to display plain text or unformatted pod.)
696 One useful value for C<PERLDOC_PAGER> is C<less -+C -E>.
700 This is perldoc v2.0.
704 Kenneth Albanowski <kjahds@kjahds.com>
706 Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>,
712 # Version 1.14: Wed Jul 15 01:50:20 EST 1998
713 # Robin Barker <rmb1@cise.npl.co.uk>
714 # -strict, -w cleanups
715 # Version 1.13: Fri Feb 27 16:20:50 EST 1997
716 # Gurusamy Sarathy <gsar@umich.edu>
717 # -doc tweaks for -F and -X options
718 # Version 1.12: Sat Apr 12 22:41:09 EST 1997
719 # Gurusamy Sarathy <gsar@umich.edu>
720 # -various fixes for win32
721 # Version 1.11: Tue Dec 26 09:54:33 EST 1995
722 # Kenneth Albanowski <kjahds@kjahds.com>
723 # -added Charles Bailey's further VMS patches, and -u switch
724 # -added -t switch, with pod2text support
726 # Version 1.10: Thu Nov 9 07:23:47 EST 1995
727 # Kenneth Albanowski <kjahds@kjahds.com>
729 # -added better error recognition (on no found pages, just exit. On
730 # missing nroff/pod2man, just display raw pod.)
731 # -added recursive/case-insensitive matching (thanks, Andreas). This
732 # slows things down a bit, unfortunately. Give a precise name, and
735 # Version 1.01: Tue May 30 14:47:34 EDT 1995
736 # Andy Dougherty <doughera@lafcol.lafayette.edu>
737 # -added pod documentation.
738 # -added PATH searching.
739 # -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
745 # Cache directories read during sloppy match
748 close OUT or die "Can't close $file: $!";
749 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
750 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';