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")
144 } elsif ($Is_MSWin32 || $Is_Dos) {
145 $opt_t = 1 unless $opts
148 if ($opt_t) { require Pod::Text; import Pod::Text; }
152 @pages = ("perlfunc");
154 @pages = ("perlfaq1" .. "perlfaq9");
159 # Does this look like a module or extension directory?
160 if (-f "Makefile.PL") {
161 # Add ., lib and blib/* libs to @INC (if they exist)
163 unshift(@INC, 'lib') if -d 'lib';
164 require ExtUtils::testlib;
170 my($file, $readit) = @_;
171 return 1 if !$readit && $file =~ /\.pod$/i;
186 my $path = join('/',$dir,$file);
187 return $path if -f $path and -r _;
188 if (!$opt_i or $Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') {
189 # on a case-forgiving file system or if case is important
190 # that is it all we can do
191 warn "Ignored $path: unreadable\n" if -f _;
198 foreach $p (split(/\//, $file)){
203 if ( $p eq $global_target) {
204 my $tmp_path = join ('/', @p);
206 for (@global_found) {
207 $path_f = 1 if $_ eq $tmp_path;
209 push (@global_found, $tmp_path) unless $path_f;
210 print STDERR "Found as @p but directory\n" if $opt_v;
212 } elsif (-f _ && -r _) {
215 warn "Ignored $try: unreadable\n";
220 while ($cip=readdir(DIR)) {
221 if (lc $cip eq $lcp){
227 return "" unless $found;
229 return "@p" if -f "@p" and -r _;
230 warn "Ignored @p: unreadable\n" if -f _;
240 return minus_f_nocase($dir,$file);
242 my $path = minus_f_nocase($dir,$file);
243 return $path if length $path and containspod($path);
250 my($recurse,$s,@dirs) = @_;
252 $s = VMS::Filespec::unixify($s) if $Is_VMS;
253 return $s if -f $s && containspod($s);
254 printf STDERR "Looking for $s in @dirs\n" if $opt_v;
258 $global_target = (split('/', $s))[-1];
259 for ($i=0; $i<@dirs; $i++) {
261 ($dir = VMS::Filespec::unixpath($dir)) =~ s!/$!! if $Is_VMS;
262 if ( ( $ret = check_file $dir,"$s.pod")
263 or ( $ret = check_file $dir,"$s.pm")
264 or ( $ret = check_file $dir,$s)
266 $ret = check_file $dir,"$s.com")
267 or ( $^O eq 'os2' and
268 $ret = check_file $dir,"$s.cmd")
269 or ( ($Is_MSWin32 or $Is_Dos or $^O eq 'os2') and
270 $ret = check_file $dir,"$s.bat")
271 or ( $ret = check_file "$dir/pod","$s.pod")
272 or ( $ret = check_file "$dir/pod",$s)
279 my @newdirs = map "$dir/$_", grep {
281 not /^auto$/ and # save time! don't search auto dirs
285 next unless @newdirs;
286 @newdirs = map((s/.dir$//,$_)[1],@newdirs) if $Is_VMS;
287 print STDERR "Also looking in @newdirs\n" if $opt_v;
288 push(@dirs,@newdirs);
296 if ($podidx && open(PODIDX, $podidx)) {
299 $searchfor =~ s,::,/,g;
300 print STDERR "Searching for '$searchfor' in $podidx\n" if $opt_v;
303 push(@found, $_) if m,/$searchfor(?:\.(?:pod|pm))?$,i;
308 print STDERR "Searching for $_\n" if $opt_v;
309 # We must look both in @INC for library modules and in PATH
310 # for executables, like h2xs or perldoc itself.
311 my @searchdirs = @INC;
314 push @found, $_ if $opt_m or containspod($_);
320 for ($i = 0; $trn = $ENV{'DCL$PATH'.$i}; $i++) {
321 push(@searchdirs,$trn);
323 push(@searchdirs,'perl_root:[lib.pod]') # installed pods
325 push(@searchdirs, grep(-d, split($Config{path_sep},
329 my @files = searchfor(0,$_,@searchdirs);
331 print STDERR "Found as @files\n" if $opt_v;
333 # no match, try recursive search
335 @searchdirs = grep(!/^\.$/,@INC);
337 @files= searchfor(1,$_,@searchdirs) if $opt_r;
339 print STDERR "Loosely found as @files\n" if $opt_v;
341 print STDERR "No documentation found for \"$_\".\n";
343 print STDERR "However, try\n";
344 for my $dir (@global_found) {
345 opendir(DIR, $dir) or die "$!";
346 while (my $file = readdir(DIR)) {
347 next if ($file =~ /^\./);
348 $file =~ s/\.(pm|pod)$//;
349 print STDERR "\tperldoc $_\::$file\n";
360 exit ($Is_VMS ? 98962 : 1);
364 print join("\n", @found), "\n";
368 my $lines = $ENV{LINES} || 24;
371 if( ! -t STDOUT ) { $no_tty = 1 }
375 $tmp = "$ENV{TEMP}\\perldoc1.$$";
376 push @pagers, qw( more< less notepad );
377 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
379 $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
380 push @pagers, qw( most more less type/page );
382 $tmp = "$ENV{TEMP}/perldoc1.$$";
384 push @pagers, qw( less.exe more.com< );
385 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
389 $tmp = POSIX::tmpnam();
390 unshift @pagers, 'less', 'cmd /c more <';
392 $tmp = "/tmp/perldoc1.$$";
394 push @pagers, qw( more less pg view cat );
395 unshift @pagers, $ENV{PAGER} if $ENV{PAGER};
397 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
400 foreach my $pager (@pagers) {
401 system("$pager @found") or exit;
403 if ($Is_VMS) { eval 'use vmsish qw(status exit); exit $?' }
408 my $perlfunc = shift @found;
409 open(PFUNC, $perlfunc) or die "Can't open $perlfunc: $!";
411 # Functions like -r, -e, etc. are listed under `-X'.
412 my $search_string = ($opt_f =~ /^-[rwxoRWXOeszfdlpSbctugkTBMAC]$/) ? 'I<-X' : $opt_f ;
416 last if /^=head2 Alphabetical Listing of Perl Functions/;
419 # Look for our function
423 if (/^=item\s+\Q$search_string\E\b/o) {
430 ++$found if /^\w/; # found descriptive text
434 open(FORMATTER, "| pod2text") || die "Can't start filter";
435 print FORMATTER "=over 8\n\n";
436 print FORMATTER @pod;
437 print FORMATTER "=back\n";
439 } elsif (@pod < $lines-2) {
442 foreach my $pager (@pagers) {
443 open (PAGER, "| $pager") or next;
445 close(PAGER) or next;
450 die "No documentation for perl function `$opt_f' found\n";
456 local @ARGV = @found; # I'm lazy, sue me.
462 if (/^=head2\s+.*(?:$opt_q)/oi) {
464 push @pod, "=head1 Found in $ARGV\n\n" unless $found_in{$ARGV}++;
465 } elsif (/^=head2/) {
474 open(FORMATTER, "| pod2text") || die "Can't start filter";
475 print FORMATTER "=over 8\n\n";
476 print FORMATTER @pod;
477 print FORMATTER "=back\n";
479 } elsif (@pod < $lines-2) {
482 foreach my $pager (@pagers) {
483 open (PAGER, "| $pager") or next;
485 close(PAGER) or next;
490 die "No documentation for perl FAQ keyword `$opt_q' found\n";
500 Pod::Text::pod2text($_,*TMP);
502 } elsif(not $opt_u) {
503 my $cmd = "pod2man --lax $_ | nroff -man";
504 $cmd .= " | col -x" if $^O =~ /hpux/;
506 unless(($err = $?)) {
513 if( $opt_u or $err or -z $tmp) {
518 $cut = $1 eq 'cut' if /^=(\w+)/;
532 foreach my $pager (@pagers) {
533 system("$pager $tmp") or last;
537 1 while unlink($tmp); #Possibly pointless VMSism
545 perldoc - Look up Perl documentation in pod format.
549 B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>] [B<-X>] PageName|ModuleName|ProgramName
551 B<perldoc> B<-f> BuiltinFunction
553 B<perldoc> B<-q> FAQ Keyword
557 I<perldoc> looks up a piece of documentation in .pod format that is embedded
558 in the perl installation tree or in a perl script, and displays it via
559 C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
560 C<col -x> will be used.) This is primarily used for the documentation for
561 the perl library modules.
563 Your system may also have man pages installed for those modules, in
564 which case you can probably just use the man(1) command.
572 Prints out a brief help message.
576 Describes search for the item in detail.
578 =item B<-t> text output
580 Display docs using plain text converter, instead of nroff. This may be faster,
581 but it won't look as nice.
583 =item B<-u> unformatted
585 Find docs only; skip reformatting by pod2*
589 Display the entire module: both code and unformatted pod documentation.
590 This may be useful if the docs don't explain a function in the detail
591 you need, and you'd like to inspect the code directly; perldoc will find
592 the file for you and simply hand it off for display.
594 =item B<-l> file name only
596 Display the file name of the module found.
598 =item B<-F> file names
600 Consider arguments as file names, no search in directories will be performed.
604 The B<-f> option followed by the name of a perl built in function will
605 extract the documentation of this function from L<perlfunc>.
609 The B<-q> option takes a regular expression as an argument. It will search
610 the question headings in perlfaq[1-9] and print the entries matching
611 the regular expression.
613 =item B<-X> use an index if present
615 The B<-X> option looks for a entry whose basename matches the name given on the
616 command line in the file C<$Config{archlib}/pod.idx>. The pod.idx file should
617 contain fully qualified filenames, one per line.
619 =item B<PageName|ModuleName|ProgramName>
621 The item you want to look up. Nested modules (such as C<File::Basename>)
622 are specified either as C<File::Basename> or C<File/Basename>. You may also
623 give a descriptive name of a page, such as C<perlfunc>. You make also give a
624 partial or wrong-case name, such as "basename" for "File::Basename", but
625 this will be slower, if there is more then one page with the same partial
626 name, you will only get the first one.
632 Any switches in the C<PERLDOC> environment variable will be used before the
633 command line arguments. C<perldoc> also searches directories
634 specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
635 defined) and C<PATH> environment variables.
636 (The latter is so that embedded pods for executables, such as
637 C<perldoc> itself, are available.) C<perldoc> will use, in order of
638 preference, the pager defined in C<PERLDOC_PAGER>, C<MANPAGER>, or
639 C<PAGER> before trying to find a pager on its own. (C<MANPAGER> is not
640 used if C<perldoc> was told to display plain text or unformatted pod.)
644 Kenneth Albanowski <kjahds@kjahds.com>
646 Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
651 # Version 1.14: Wed Jul 15 01:50:20 EST 1998
652 # Robin Barker <rmb1@cise.npl.co.uk>
653 # -strict, -w cleanups
654 # Version 1.13: Fri Feb 27 16:20:50 EST 1997
655 # Gurusamy Sarathy <gsar@umich.edu>
656 # -doc tweaks for -F and -X options
657 # Version 1.12: Sat Apr 12 22:41:09 EST 1997
658 # Gurusamy Sarathy <gsar@umich.edu>
659 # -various fixes for win32
660 # Version 1.11: Tue Dec 26 09:54:33 EST 1995
661 # Kenneth Albanowski <kjahds@kjahds.com>
662 # -added Charles Bailey's further VMS patches, and -u switch
663 # -added -t switch, with pod2text support
665 # Version 1.10: Thu Nov 9 07:23:47 EST 1995
666 # Kenneth Albanowski <kjahds@kjahds.com>
668 # -added better error recognition (on no found pages, just exit. On
669 # missing nroff/pod2man, just display raw pod.)
670 # -added recursive/case-insensitive matching (thanks, Andreas). This
671 # slows things down a bit, unfortunately. Give a precise name, and
674 # Version 1.01: Tue May 30 14:47:34 EDT 1995
675 # Andy Dougherty <doughera@lafcol.lafayette.edu>
676 # -added pod documentation.
677 # -added PATH searching.
678 # -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
684 # Cache directories read during sloppy match
687 close OUT or die "Can't close $file: $!";
688 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
689 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';