integrate Pod-Perldoc-3.07. This replaces the original inline perldoc

with a module-driven version, and separates out its docs.

p4raw-id: //depot/perl@18228

1 files changed, 20 insertions, 811 deletions

diff --git a/utils/perldoc.PL b/utils/perldoc.PL
index e2c65369d9..a4d8872187 100644
--- a/utils/perldoc.PL
+++ b/utils/perldoc.PL
@@ -1,5 +1,11 @@
 #!/usr/local/bin/perl
 
+# This is for generating the perldoc executable.
+# It may eventually be expanded to generate many executables, as
+# explained in the preface of /Programming Perl/ 3e.
+
+require 5;
+use strict;
 use Config;
 use File::Basename qw(&basename &dirname);
 use Cwd;
@@ -13,837 +19,40 @@ use Cwd;
 
 # This forces PL files to create target in same directory as PL file.
 # This is so that make depend always knows where to find PL derivatives.
-$origdir = cwd;
+
+my $origdir = cwd;
 chdir dirname($0);
-$file = basename($0, '.PL');
+my $file = basename($0, '.PL');
+my $file_shortname = $file;  # should be like "perldoc", maybe "perlsyn", etc.
+warn "How odd, I'm going to generate $file_shortname?!"
+ unless $file_shortname =~ m/^\w+$/;
+
 $file .= '.com' if $^O eq 'VMS';
 
 open OUT,">$file" or die "Can't create $file: $!";
 
-print "Extracting $file (with variable substitutions)\n";
+print "Extracting \"$file\" (with variable substitutions)\n";
 
 # In this section, perl variables will be expanded during extraction.
 # You can use $Config{...} to use Configure variables.
 
-my $versiononly = $Config{versiononly} ? $Config{version} : '';
-
 print OUT <<"!GROK!THIS!";
 $Config{startperl}
     eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
 	if 0;
 
-use warnings;
-use strict;
-
-# make sure creat()s are neither too much nor too little
-INIT { eval { umask(0077) } }   # doubtless someone has no mask
-
-(my \$pager = <<'/../') =~ s/\\s*\\z//;
-$Config{pager}
-/../
-my \@pagers = ();
-push \@pagers, \$pager if -x (split /\\s+/, \$pager)[0];
+# This "$file" file was generated by "$0"
 
-(my \$bindir = <<'/../') =~ s/\\s*\\z//;
-$Config{scriptdirexp}
-/../
-
-(my \$pod2man = <<'/../') =~ s/\\s*\\z//;
-pod2man$versiononly
-/../
+require 5;
+use Pod::Perldoc;
+BEGIN { \$^W = 1 if \$ENV{'PERLDOCDEBUG'} }
+exit( Pod::Perldoc->run() );
 
 !GROK!THIS!
 
-# In the following, perl variables are not expanded during extraction.
-
-print OUT <<'!NO!SUBS!';
-
-use Fcntl;    # for sysopen
-use Getopt::Std;
-use Config '%Config';
-use File::Spec::Functions qw(catfile splitdir);
-
-#
-# Perldoc revision #1 -- look up a piece of documentation in .pod format that
-# is embedded in the perl installation tree.
-#
-# This is not to be confused with Tom Christiansen's perlman, which is a
-# man replacement, written in perl. This perldoc is strictly for reading
-# the perl manuals, though it too is written in perl.
-# 
-# Massive security and correctness patches applied to this
-# noisome program by Tom Christiansen Sat Mar 11 15:22:33 MST 2000 
-
-if (@ARGV<1) {
-	my $me = $0;		# Editing $0 is unportable
-	$me =~ s,.*/,,;
-	die <<EOF;
-Usage: $me [-h] [-r] [-i] [-v] [-t] [-u] [-m] [-n program] [-l] [-F] [-X] PageName|ModuleName|ProgramName
-       $me -f PerlFunc
-       $me -q FAQKeywords
-
-The -h option prints more help.  Also try "perldoc perldoc" to get
-acquainted with the system.
-EOF
-}
-
-my @global_found = ();
-my $global_target = "";
-
-my $Is_VMS = $^O eq 'VMS';
-my $Is_MSWin32 = $^O eq 'MSWin32';
-my $Is_Dos = $^O eq 'dos';
-my $Is_OS2 = $^O eq 'os2';
-my $Is_BeOS = $^O eq 'beos';
-
-sub usage{
-    warn "@_\n" if @_;
-    # Erase evidence of previous errors (if any), so exit status is simple.
-    $! = 0;
-    die <<EOF;
-perldoc [options] PageName|ModuleName|ProgramName...
-perldoc [options] -f BuiltinFunction
-perldoc [options] -q FAQRegex
-
-Options:
-    -h   Display this help message
-    -r   Recursive search (slow)
-    -i   Ignore case
-    -t   Display pod using pod2text instead of pod2man and nroff
-             (-t is the default on win32 unless -n is specified)
-    -u	 Display unformatted pod text
-    -m   Display module's file in its entirety
-    -n   Specify replacement for nroff
-    -l   Display the module's file name
-    -F   Arguments are file names, not modules
-    -v	 Verbosely describe what's going on
-    -X	 use index if present (looks for pod.idx at $Config{archlib})
-    -q   Search the text of questions (not answers) in perlfaq[1-9]
-
-PageName|ModuleName...
-         is the name of a piece of documentation that you want to look at. You
-         may either give a descriptive name of the page (as in the case of
-         `perlfunc') the name of a module, either like `Term::Info' or like
-         `Term/Info', or the name of a program, like `perldoc'.
-
-BuiltinFunction
-         is the name of a perl function.  Will extract documentation from
-         `perlfunc'.
-
-FAQRegex
-         is a regex. Will search perlfaq[1-9] for and extract any
-         questions that match.
-
-Any switches in the PERLDOC environment variable will be used before the
-command line arguments.  The optional pod index file contains a list of
-filenames, one per line.
-
-EOF
-}
-
-if (defined $ENV{"PERLDOC"}) {
-    require Text::ParseWords;
-    unshift(@ARGV, Text::ParseWords::shellwords($ENV{"PERLDOC"}));
-}
-!NO!SUBS!
-
-my $getopts = "mhtluvriFf:Xq:n:";
-print OUT <<"!GET!OPTS!";
-
-use vars qw( @{[map "\$opt_$_", ($getopts =~ /\w/g)]} );
-
-getopts("$getopts") || usage;
-!GET!OPTS!
-
-print OUT <<'!NO!SUBS!';
-
-usage if $opt_h;
-
-# attempt to drop privs if we should be tainting and aren't
-if (!($Is_VMS || $Is_MSWin32 || $Is_Dos || $Is_OS2 || $Is_BeOS)
-    && ($> == 0 || $< == 0) && !am_taint_checking()) 
-{
-    my $id = eval { getpwnam("nobody") };
-    $id = eval { getpwnam("nouser") } unless defined $id;
-    $id = -2 unless defined $id;
-	#
-	# According to Stevens' APUE and various
-	# (BSD, Solaris, HP-UX) man pages setting
-	# the real uid first and effective uid second
-	# is the way to go if one wants to drop privileges,
-	# because if one changes into an effective uid of
-	# non-zero, one cannot change the real uid any more.
-	#
-	# Actually, it gets even messier.  There is
-	# a third uid, called the saved uid, and as
-	# long as that is zero, one can get back to
-	# uid of zero.  Setting the real-effective *twice*
-	# helps in *most* systems (FreeBSD and Solaris)
-	# but apparently in HP-UX even this doesn't help:
-	# the saved uid stays zero (apparently the only way
-	# in HP-UX to change saved uid is to call setuid()
-	# when the effective uid is zero).
-	#
-    eval {
-	$< = $id; # real uid
-	$> = $id; # effective uid
-	$< = $id; # real uid
-	$> = $id; # effective uid
-    };
-    die "Superuser must not run $0 without security audit and taint checks.\n"
-	    unless !$@ && $< && $>;
-}
-
-my $podidx;
-if ($opt_X) {
-    $podidx = "$Config{'archlib'}/pod.idx";
-    $podidx = "" unless -f $podidx && -r _ && -M _ <= 7;
-}
-
-if ((my $opts = do{ no warnings; $opt_t + $opt_u + $opt_m + $opt_l }) > 1) {
-    usage("only one of -t, -u, -m or -l")
-}
-elsif ($Is_MSWin32 || $Is_Dos || $Is_BeOS
-    || !($ENV{TERM} && $ENV{TERM} !~ /dumb|emacs|none|unknown/i))
-{
-    $opt_t = 1 unless ( $opts || $opt_n );
-}
-
-if ($opt_t) { require Pod::Text; import Pod::Text; }
-
-$opt_n = "nroff" if !$opt_n;
-
-my @pages;
-if ($opt_f) {
-    @pages = ("perlfunc");
-}
-elsif ($opt_q) {
-    @pages = ("perlfaq1" .. "perlfaq9");
-}
-else {
-    @pages = @ARGV;
-}
-
-# Does this look like a module or extension directory?
-if (-f "Makefile.PL") {
-
-    # Add ., lib to @INC (if they exist)
-    eval q{ use lib qw(. lib); 1; } or die;
-
-    # don't add if superuser
-    if ($< && $> && -f "blib") {   # don't be looking too hard now!
-	eval q{ use blib; 1 };
-	warn $@ if $@ && $opt_v;
-    }
-}
-
-sub containspod {
-    my($file, $readit) = @_;
-    return 1 if !$readit && $file =~ /\.pod\z/i;
-    local($_);
-    open(TEST,"<", $file) 	or die "Can't open $file: $!";
-    while (<TEST>) {
-	if (/^=head/) {
-	    close(TEST) 	or die "Can't close $file: $!";
-	    return 1;
-	}
-    }
-    close(TEST) 		or die "Can't close $file: $!";
-    return 0;
-}
-
-sub minus_f_nocase {
-     my($dir,$file) = @_;
-     my $path = catfile($dir,$file);
-     return $path if -f $path and -r _;
-     if (!$opt_i or $Is_VMS or $Is_MSWin32 or $Is_Dos or $^O eq 'os2') {
-        # on a case-forgiving file system or if case is important
-	# that is it all we can do
-	warn "Ignored $path: unreadable\n" if -f _;
-	return '';
-     }
-     local *DIR;
-     # this is completely wicked.  don't mess with $", and if 
-     # you do, don't assume / is the dirsep!
-     local($")="/";
-     my @p = ($dir);
-     my($p,$cip);
-     foreach $p (splitdir $file){
-	my $try = catfile @p, $p;
-	stat $try;
- 	if (-d _) {
- 	    push @p, $p;
-	    if ( $p eq $global_target) {
-		my $tmp_path = catfile @p;
-		my $path_f = 0;
-		for (@global_found) {
-		    $path_f = 1 if $_ eq $tmp_path;
-		}
-		push (@global_found, $tmp_path) unless $path_f;
-		print STDERR "Found as @p but directory\n" if $opt_v;
-	    }
- 	}
-	elsif (-f _ && -r _) {
- 	    return $try;
- 	}
-	elsif (-f _) {
-	    warn "Ignored $try: unreadable\n";
- 	}
-	elsif (-d "@p") {
- 	    my $found=0;
- 	    my $lcp = lc $p;
- 	    opendir DIR, "@p" 	    or die "opendir @p: $!";
- 	    while ($cip=readdir(DIR)) {
- 		if (lc $cip eq $lcp){
- 		    $found++;
- 		    last;
- 		}
- 	    }
- 	    closedir DIR	    or die "closedir @p: $!";
- 	    return "" unless $found;
- 	    push @p, $cip;
- 	    return "@p" if -f "@p" and -r _;
-	    warn "Ignored @p: unreadable\n" if -f _;
- 	}
-     }
-     return "";
-}
-
-
-sub check_file {
-    my($dir,$file) = @_;
-    return "" if length $dir and not -d $dir;
-    if ($opt_m) {
-	return minus_f_nocase($dir,$file);
-    }
-    else {
-	my $path = minus_f_nocase($dir,$file);
-        return $path if length $path and containspod($path);
-    }
-    return "";
-}
-
-
-sub searchfor {
-    my($recurse,$s,@dirs) = @_;
-    $s =~ s!::!/!g;
-    $s = VMS::Filespec::unixify($s) if $Is_VMS;
-    return $s if -f $s && containspod($s);
-    printf STDERR "Looking for $s in @dirs\n" if $opt_v;
-    my $ret;
-    my $i;
-    my $dir;
-    $global_target = (splitdir $s)[-1];   # XXX: why not use File::Basename?
-    for ($i=0; $i<@dirs; $i++) {
-	$dir = $dirs[$i];
-	($dir = VMS::Filespec::unixpath($dir)) =~ s!/\z!! if $Is_VMS;
-	if (       (! $opt_m && ( $ret = check_file $dir,"$s.pod"))
-		or ( $ret = check_file $dir,"$s.pm")
-		or ( $ret = check_file $dir,$s)
-		or ( $Is_VMS and
-		     $ret = check_file $dir,"$s.com")
-		or ( $^O eq 'os2' and
-		     $ret = check_file $dir,"$s.cmd")
-		or ( ($Is_MSWin32 or $Is_Dos or $^O eq 'os2') and
-		     $ret = check_file $dir,"$s.bat")
-		or ( $ret = check_file "$dir/pod","$s.pod")
-		or ( $ret = check_file "$dir/pod",$s)
-		or ( $ret = check_file "$dir/pods","$s.pod")
-		or ( $ret = check_file "$dir/pods",$s)
-	) {
-	    return $ret;
-	}
-
-	if ($recurse) {
-	    opendir(D,$dir)	or die "Can't opendir $dir: $!";
-	    my @newdirs = map catfile($dir, $_), grep {
-		not /^\.\.?\z/s and
-		not /^auto\z/s  and   # save time! don't search auto dirs
-		-d  catfile($dir, $_)
-	    } readdir D;
-	    closedir(D)		or die "Can't closedir $dir: $!";
-	    next unless @newdirs;
-	    # what a wicked map!
-	    @newdirs = map((s/\.dir\z//,$_)[1],@newdirs) if $Is_VMS;
-	    print STDERR "Also looking in @newdirs\n" if $opt_v;
-	    push(@dirs,@newdirs);
-	}
-    }
-    return ();
-}
-
-sub filter_nroff {
-  my @data = split /\n{2,}/, shift;
-  shift @data while @data and $data[0] !~ /\S/; # Go to header
-  shift @data if @data and $data[0] =~ /Contributed\s+Perl/; # Skip header
-  pop @data if @data and $data[-1] =~ /^\w/; # Skip footer, like
-				# 28/Jan/99 perl 5.005, patch 53 1
-  join "\n\n", @data;
-}
-
-sub page {
-    my ($tmp, $no_tty, @pagers) = @_;
-    if ($no_tty) {
-	open(TMP,"<", $tmp) 	or die "Can't open $tmp: $!";
-	local $_;
-	while (<TMP>) {
-	    print or die "Can't print to stdout: $!";
-	} 
-	close TMP		or die "Can't close while $tmp: $!";
-    }
-    else {
-        # On VMS, quoting prevents logical expansion, and temp files with no
-        # extension get the wrong default extension (such as .LIS for TYPE)
-
-        $tmp = VMS::Filespec::rmsexpand($tmp, '.') if ($Is_VMS);
-        foreach my $pager (@pagers) {
-          if ($Is_VMS) {
-            last if system("$pager $tmp") == 0;
-          } else {
-	    last if system("$pager \"$tmp\"") == 0;
-          }
-	}
-    }
-}
-
-my @found;
-foreach (@pages) {
-    if ($podidx && open(PODIDX, $podidx)) {
-	my $searchfor = catfile split '::';
-	print STDERR "Searching for '$searchfor' in $podidx\n" if $opt_v;
-	local $_;
-	while (<PODIDX>) {
-	    chomp;
-	    push(@found, $_) if m,/$searchfor(?:\.(?:pod|pm))?\z,i;
-	}
-	close(PODIDX)	    or die "Can't close $podidx: $!";
-	next;
-    }
-    print STDERR "Searching for $_\n" if $opt_v;
-    if ($opt_F) {
-	next unless -r;
-	push @found, $_ if $opt_m or containspod($_);
-	next;
-    }
-    # We must look both in @INC for library modules and in $bindir
-    # for executables, like h2xs or perldoc itself.
-    my @searchdirs = ($bindir, @INC);
-    unless ($opt_m) {
-	if ($Is_VMS) {
-	    my($i,$trn);
-	    for ($i = 0; $trn = $ENV{'DCL$PATH;'.$i}; $i++) {
-		push(@searchdirs,$trn);
-	    }
-	    push(@searchdirs,'perl_root:[lib.pod]')  # installed pods
-	}
-	else {
-	    push(@searchdirs, grep(-d, split($Config{path_sep},
-					     $ENV{'PATH'})));
-	}
-    }
-    my @files = searchfor(0,$_,@searchdirs);
-    if (@files) {
-	print STDERR "Found as @files\n" if $opt_v;
-    }
-    else {
-	# no match, try recursive search
-	@searchdirs = grep(!/^\.\z/s,@INC);
-	@files= searchfor(1,$_,@searchdirs) if $opt_r;
-	if (@files) {
-	    print STDERR "Loosely found as @files\n" if $opt_v;
-	}
-	else {
-	    print STDERR "No " .
-		($opt_m ? "module" : "documentation") . " found for \"$_\".\n";
-	    if (@global_found) {
-		print STDERR "However, try\n";
-		for my $dir (@global_found) {
-		    opendir(DIR, $dir) or die "opendir $dir: $!";
-		    while (my $file = readdir(DIR)) {
-			next if ($file =~ /^\./s);
-			$file =~ s/\.(pm|pod)\z//;  # XXX: badfs
-			print STDERR "\tperldoc $_\::$file\n";
-		    }
-		    closedir DIR    or die "closedir $dir: $!";
-		}
-	    }
-	}
-    }
-    push(@found,@files);
-}
-
-if (!@found) {
-    exit ($Is_VMS ? 98962 : 1);
-}
-
-if ($opt_l) {
-    print join("\n", @found), "\n";
-    exit;
-}
-
-my $lines = $ENV{LINES} || 24;
-
-my $no_tty;
-if (! -t STDOUT) { $no_tty = 1 }
-END { close(STDOUT) || die "Can't close STDOUT: $!" }
-
-if ($Is_MSWin32) {
-    push @pagers, qw( more< less notepad );
-    unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
-    for (@found) { s,/,\\,g }
-}
-elsif ($Is_VMS) {
-    push @pagers, qw( most more less type/page );
-}
-elsif ($Is_Dos) {
-    push @pagers, qw( less.exe more.com< );
-    unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
-}
-else {
-    if ($^O eq 'os2') {
-      unshift @pagers, 'less', 'cmd /c more <';
-    }
-    push @pagers, qw( more less pg view cat );
-    unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
-}
-unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
-
-if ($opt_m) {
-    foreach my $pager (@pagers) {
-	if (system($pager, @found) == 0) {
-	    exit;
-    }
-    }
-    if ($Is_VMS) { 
-	eval q{
-	    use vmsish qw(status exit); 
-	    exit $?;
-	    1;
-	} or die;
-    }
-    exit(1);
-}
-
-my @pod;
-if ($opt_f) {
-    my $perlfunc = shift @found;
-    open(PFUNC, "<", $perlfunc)
-	or die("Can't open $perlfunc: $!");
-
-    # Functions like -r, -e, etc. are listed under `-X'.
-    my $search_string = ($opt_f =~ /^-[rwxoRWXOeszfdlpSbctugkTBMAC]$/)
-			? 'I<-X' : $opt_f ;
-
-    # Skip introduction
-    local $_;
-    while (<PFUNC>) {
-	last if /^=head2 Alphabetical Listing of Perl Functions/;
-    }
-
-    # Look for our function
-    my $found = 0;
-    my $inlist = 0;
-    while (<PFUNC>) {
-	if (/^=item\s+\Q$search_string\E\b/o)  {
-	    $found = 1;
-	}
-	elsif (/^=item/) {
-	    last if $found > 1 and not $inlist;
-	}
-	next unless $found;
-	if (/^=over/) {
-	    ++$inlist;
-	}
-	elsif (/^=back/) {
-	    --$inlist;
-	}
-	push @pod, $_;
-	++$found if /^\w/;	# found descriptive text
-    }
-    if (!@pod) {
-	die "No documentation for perl function `$opt_f' found\n";
-    }
-    close PFUNC		or die "Can't open $perlfunc: $!";
-}
-
-if ($opt_q) {
-    local @ARGV = @found;	# I'm lazy, sue me.
-    my $found = 0;
-    my %found_in;
-    my $rx = eval { qr/$opt_q/ } or die <<EOD;
-Invalid regular expression '$opt_q' given as -q pattern:
-  $@
-Did you mean \\Q$opt_q ?
-
-EOD
-
-    for (@found) { die "invalid file spec: $!" if /[<>|]/ } 
-    local $_;
-    while (<>) {
-	if (/^=head2\s+.*(?:$opt_q)/oi) {
-	    $found = 1;
-	    push @pod, "=head1 Found in $ARGV\n\n" unless $found_in{$ARGV}++;
-	}
-	elsif (/^=head[12]/) {
-	    $found = 0;
-	}
-	next unless $found;
-	push @pod, $_;
-    }
-    if (!@pod) {
-	die("No documentation for perl FAQ keyword `$opt_q' found\n");
-    }
-}
-
-require File::Temp;
-
-my ($tmpfd, $tmp) = File::Temp::tempfile(UNLINK => 1);
-
-my $filter;
-
-if (@pod) {
-    my ($buffd, $buffer) = File::Temp::tempfile(UNLINK => 1);
-    print $buffd "=over 8\n\n";
-    print $buffd @pod	or die "Can't print $buffer: $!";
-    print $buffd "=back\n";
-    close $buffd	or die "Can't close $buffer: $!";
-    @found = $buffer;
-    $filter = 1;
-}
-
-foreach (@found) {
-    my $file = $_;
-    my $err;
-
-    if ($opt_t) {
-	Pod::Text->new()->parse_from_file($file, $tmpfd);
-    }
-    elsif (not $opt_u) {
-	my $cmd = catfile($bindir, $pod2man) . " --lax $file | $opt_n -man";
-	$cmd .= " | col -x" if $^O =~ /hpux/;
-	my $rslt = `$cmd`;
-	$rslt = filter_nroff($rslt) if $filter;
-	unless (($err = $?)) {
-	    print $tmpfd $rslt
-		or die "Can't print $tmp: $!";
-	}
-    }
-    if ($opt_u or $err) {
-	open(IN,"<", $file)   or die("Can't open $file: $!");
-	my $cut = 1;
-	local $_;
-	while (<IN>) {
-	    $cut = $1 eq 'cut' if /^=(\w+)/;
-	    next if $cut;
-	    print $tmpfd $_
-		or die "Can't print $tmp: $!";
-	}
-	close IN    or die "Can't close $file: $!";
-    }
-}
-close $tmpfd
-    or die "Can't close $tmp: $!";
-page($tmp, $no_tty, @pagers);
-
-exit;
-
-sub is_tainted {
-    my $arg = shift;
-    my $nada = substr($arg, 0, 0);  # zero-length
-    local $@;  # preserve caller's version
-    eval { eval "# $nada" };
-    return length($@) != 0;
-}
-
-sub am_taint_checking {
-    my($k,$v) = each %ENV;
-    return is_tainted($v);  
-}
-
-
-__END__
-
-=head1 NAME
-
-perldoc - Look up Perl documentation in pod format.
-
-=head1 SYNOPSIS
-
-B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>]  [B<-X>] PageName|ModuleName|ProgramName
-
-B<perldoc> B<-f> BuiltinFunction
-
-B<perldoc> B<-q> FAQ Keyword
-
-=head1 DESCRIPTION
-
-I<perldoc> looks up a piece of documentation in .pod format that is embedded
-in the perl installation tree or in a perl script, and displays it via
-C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
-C<col -x> will be used.) This is primarily used for the documentation for
-the perl library modules.
-
-Your system may also have man pages installed for those modules, in
-which case you can probably just use the man(1) command.
-
-If you are looking for a table of contents to the Perl library modules
-documentation, see the L<perltoc> page.
-
-=head1 OPTIONS
-
-=over 5
-
-=item B<-h> help
-
-Prints out a brief help message.
-
-=item B<-v> verbose
-
-Describes search for the item in detail.
-
-=item B<-t> text output
-
-Display docs using plain text converter, instead of nroff. This may be faster,
-but it won't look as nice.
-
-=item B<-u> unformatted
-
-Find docs only; skip reformatting by pod2*
-
-=item B<-m> module
-
-Display the entire module: both code and unformatted pod documentation.
-This may be useful if the docs don't explain a function in the detail
-you need, and you'd like to inspect the code directly; perldoc will find
-the file for you and simply hand it off for display.
-
-=item B<-l> file name only
-
-Display the file name of the module found.
-
-=item B<-F> file names
-
-Consider arguments as file names, no search in directories will be performed.
-
-=item B<-f> perlfunc
-
-The B<-f> option followed by the name of a perl built in function will
-extract the documentation of this function from L<perlfunc>.
-
-=item B<-q> perlfaq
-
-The B<-q> option takes a regular expression as an argument.  It will search
-the question headings in perlfaq[1-9] and print the entries matching
-the regular expression.
-
-=item B<-X> use an index if present
-
-The B<-X> option looks for an entry whose basename matches the name given on the
-command line in the file C<$Config{archlib}/pod.idx>.  The pod.idx file should
-contain fully qualified filenames, one per line.
-
-=item B<PageName|ModuleName|ProgramName>
-
-The item you want to look up.  Nested modules (such as C<File::Basename>)
-are specified either as C<File::Basename> or C<File/Basename>.  You may also
-give a descriptive name of a page, such as C<perlfunc>.
-
-=back
-
-=head1 SECURITY
-
-Because B<perldoc> does not run properly tainted, and is known to
-have security issues, when run as the superuser it will attempt to
-drop privileges by setting the effective and real IDs to nobody's
-or nouser's account, or -2 if unavailable.  If it cannot relinquish
-its privileges, it will not run.  
-
-=head1 ENVIRONMENT
-
-Any switches in the C<PERLDOC> environment variable will be used before the
-command line arguments.  C<perldoc> also searches directories
-specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
-defined) and C<PATH> environment variables.
-(The latter is so that embedded pods for executables, such as
-C<perldoc> itself, are available.)  C<perldoc> will use, in order of
-preference, the pager defined in C<PERLDOC_PAGER>, C<MANPAGER>, or
-C<PAGER> before trying to find a pager on its own.  (C<MANPAGER> is not
-used if C<perldoc> was told to display plain text or unformatted pod.)
-
-One useful value for C<PERLDOC_PAGER> is C<less -+C -E>.
-
-=head1 VERSION
-
-This is perldoc v2.05.
-
-=head1 AUTHOR
-
-Kenneth Albanowski <kjahds@kjahds.com>
-
-Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>,
-and others.
-
-=cut
-
-#
-# Version 2.05: Sat Oct 12 16:09:00 CEST 2002
-#	Hugo van der Sanden <hv@crypt.org>
-#	Made -U the default, based on patch from Simon Cozens
-# Version 2.04: Sun Aug 18 13:27:12 BST 2002
-#	Randy W. Sims <RandyS@ThePierianSpring.org>
-#	allow -n to enable nroff under Win32
-# Version 2.03: Sun Apr 23 16:56:34 BST 2000
-#	Hugo van der Sanden <hv@crypt.org>
-#	don't die when 'use blib' fails
-# Version 2.02: Mon Mar 13 18:03:04 MST 2000
-#       Tom Christiansen <tchrist@perl.com>
-#	Added -U insecurity option
-# Version 2.01: Sat Mar 11 15:22:33 MST 2000 
-#       Tom Christiansen <tchrist@perl.com>, querulously.
-#       Security and correctness patches.
-#       What a twisted bit of distasteful spaghetti code.
-# Version 2.0: ????
-# Version 1.15: Tue Aug 24 01:50:20 EST 1999
-#       Charles Wilson <cwilson@ece.gatech.edu>
-#	changed /pod/ directory to /pods/ for cygwin
-#         to support cygwin/win32
-# Version 1.14: Wed Jul 15 01:50:20 EST 1998
-#       Robin Barker <rmb1@cise.npl.co.uk>
-#	-strict, -w cleanups
-# Version 1.13: Fri Feb 27 16:20:50 EST 1997
-#       Gurusamy Sarathy <gsar@activestate.com>
-#	-doc tweaks for -F and -X options
-# Version 1.12: Sat Apr 12 22:41:09 EST 1997
-#       Gurusamy Sarathy <gsar@activestate.com>
-#	-various fixes for win32
-# Version 1.11: Tue Dec 26 09:54:33 EST 1995
-#       Kenneth Albanowski <kjahds@kjahds.com>
-#   -added Charles Bailey's further VMS patches, and -u switch
-#   -added -t switch, with pod2text support
-#
-# Version 1.10: Thu Nov  9 07:23:47 EST 1995
-#		Kenneth Albanowski <kjahds@kjahds.com>
-#	-added VMS support
-#	-added better error recognition (on no found pages, just exit. On
-#	 missing nroff/pod2man, just display raw pod.)
-#	-added recursive/case-insensitive matching (thanks, Andreas). This
-#	 slows things down a bit, unfortunately. Give a precise name, and
-#	 it'll run faster.
-#
-# Version 1.01:	Tue May 30 14:47:34 EDT 1995
-#		Andy Dougherty  <doughera@lafcol.lafayette.edu>
-#   -added pod documentation.
-#   -added PATH searching.
-#   -added searching pod/ subdirectory (mainly to pick up perlfunc.pod
-#    and friends.
-#
-#
-# TODO:
-#
-#	Cache directories read during sloppy match
-!NO!SUBS!
 
 close OUT or die "Can't close $file: $!";
 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';
 chdir $origdir;
+