test.pl tweaks from Rafael and Pudge (assuming I deciphered
[p5sagit/p5-mst-13.2.git] / utils / perldoc.PL
index e1dd783..565d033 100644 (file)
@@ -36,9 +36,15 @@ 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, "$Config{'pager'}" if -x "$Config{'pager'}";
-my \$bindir = "$Config{installscript}";
+push \@pagers, \$pager if -x \$pager;
+
+(my \$bindir = <<'/../') =~ s/\\s*\\z//;
+$Config{scriptdir}
+/../
 
 !GROK!THIS!
 
@@ -81,6 +87,7 @@ 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';
 
 sub usage{
     warn "@_\n" if @_;
@@ -149,7 +156,7 @@ usage if $opt_h;
 
 # refuse to run if we should be tainting and aren't
 # (but regular users deserve protection too, though!)
-if (!($Is_VMS || $Is_MSWin32 || $Is_Dos) && ($> == 0 || $< == 0)
+if (!($Is_VMS || $Is_MSWin32 || $Is_Dos || $Is_OS2) && ($> == 0 || $< == 0)
      && !am_taint_checking()) 
 {{
     if ($opt_U) {
@@ -353,50 +360,6 @@ sub filter_nroff {
   join "\n\n", @data;
 }
 
-sub printout {
-    my ($file, $tmp, $filter) = @_;
-    my $err;
-
-    if ($opt_t) {
-       # why was this append?
-       sysopen(OUT, $tmp, O_WRONLY | O_EXCL | O_CREAT, 0600)
-           or die ("Can't open $tmp: $!");
-       Pod::Text->new()->parse_from_file($file,\*OUT);
-       close OUT   or die "can't close $tmp: $!";
-    }
-    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 = $?)) {
-           # why was this append?
-           sysopen(TMP, $tmp, O_WRONLY | O_EXCL | O_CREAT, 0600)
-               or die "Can't open $tmp: $!";
-           print TMP $rslt
-               or die "Can't print $tmp: $!";
-           close TMP
-               or die "Can't close $tmp: $!";
-       }
-    }
-    if ($opt_u or $err or -z $tmp) {  # XXX: race with -z
-       # why was this append?
-       sysopen(OUT, $tmp, O_WRONLY | O_EXCL | O_CREAT, 0600)
-           or die "Can't open $tmp: $!";
-       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 OUT
-               or die "Can't print $tmp: $!";
-       }
-       close IN    or die "Can't close $file: $!";
-       close OUT   or die "Can't close $tmp: $!";
-    }
-}
-
 sub page {
     my ($tmp, $no_tty, @pagers) = @_;
     if ($no_tty) {
@@ -408,23 +371,20 @@ sub page {
        close TMP               or die "Can't close while $tmp: $!";
     }
     else {
-       foreach my $pager (@pagers) {
+        # 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;
+          }
        }
     }
 }
 
-sub cleanup {
-    my @files = @_;
-    for (@files) {
-       if ($Is_VMS) { 
-           1 while unlink($_);    # XXX: expect failure
-       } else {
-           unlink($_);            # or die "Can't unlink $_: $!";
-       } 
-    }
-}
-
 my @found;
 foreach (@pages) {
     if ($podidx && open(PODIDX, $podidx)) {
@@ -439,14 +399,14 @@ foreach (@pages) {
        next;
     }
     print STDERR "Searching for $_\n" if $opt_v;
-    # We must look both in @INC for library modules and in $bindir
-    # for executables, like h2xs or perldoc itself.
-    my @searchdirs = ($bindir, @INC);
     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);
@@ -505,58 +465,27 @@ my $no_tty;
 if (! -t STDOUT) { $no_tty = 1 }
 END { close(STDOUT) || die "Can't close STDOUT: $!" }
 
-# until here we could simply exit or die
-# now we create temporary files that we have to clean up
-# namely $tmp, $buffer
-# that's because you did it wrong, should be descriptor based --tchrist
-
-my $tmp;
-my $buffer;
 if ($Is_MSWin32) {
-    $tmp = "$ENV{TEMP}\\perldoc1.$$";
-    $buffer = "$ENV{TEMP}\\perldoc1.b$$";
     push @pagers, qw( more< less notepad );
     unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
     for (@found) { s,/,\\,g }
 }
 elsif ($Is_VMS) {
-    $tmp = 'Sys$Scratch:perldoc.tmp1_'.$$;
-    $buffer = 'Sys$Scratch:perldoc.tmp1_b'.$$;
     push @pagers, qw( most more less type/page );
 }
 elsif ($Is_Dos) {
-    $tmp = "$ENV{TEMP}/perldoc1.$$";
-    $buffer = "$ENV{TEMP}/perldoc1.b$$";
-    $tmp =~ tr!\\/!//!s;
-    $buffer =~ tr!\\/!//!s;
     push @pagers, qw( less.exe more.com< );
     unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
 }
 else {
     if ($^O eq 'os2') {
-      require POSIX;
-      $tmp = POSIX::tmpnam();
-      $buffer = POSIX::tmpnam();
       unshift @pagers, 'less', 'cmd /c more <';
     }
-    else {
-      # XXX: this is not secure, because it doesn't open it
-      ($tmp, $buffer) = eval { require POSIX } 
-           ? (POSIX::tmpnam(),    POSIX::tmpnam()     )
-           : ("/tmp/perldoc1.$$", "/tmp/perldoc1.b$$" );
-    }
     push @pagers, qw( more less pg view cat );
     unshift @pagers, $ENV{PAGER}  if $ENV{PAGER};
 }
 unshift @pagers, $ENV{PERLDOC_PAGER} if $ENV{PERLDOC_PAGER};
 
-# make sure cleanup called
-eval q{
-    sub END { cleanup($tmp, $buffer) } 
-    1;
-} || die;
-eval q{ use sigtrap qw(die INT TERM HUP QUIT) };
-
 if ($opt_m) {
     foreach my $pager (@pagers) {
        if (system($pager, @found) == 0) {
@@ -644,22 +573,54 @@ EOD
     }
 }
 
+require File::Temp;
+
+my ($tmpfd, $tmp) = File::Temp::tempfile(UNLINK => 1);
+
 my $filter;
 
 if (@pod) {
-    sysopen(TMP, $buffer, O_WRONLY | O_EXCL | O_CREAT)
-       or die("Can't open $buffer: $!");
-    print TMP "=over 8\n\n";
-    print TMP @pod     or die "Can't print $buffer: $!";
-    print TMP "=back\n";
-    close TMP          or die "Can't close $buffer: $!";
+    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) {
-    printout($_, $tmp, $filter);
+    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;
@@ -752,7 +713,7 @@ the regular expression.
 
 =item B<-X> use an index if present
 
-The B<-X> option looks for a entry whose basename matches the name given on the
+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.
 
@@ -762,7 +723,7 @@ Because B<perldoc> does not run properly tainted, and is known to
 have security issues, it will not normally execute as the superuser.
 If you use the B<-U> flag, it will do so, but only after setting
 the effective and real IDs to nobody's or nouser's account, or -2
-if unavailable.  If it cannot relinguish its privileges, it will not
+if unavailable.  If it cannot relinquish its privileges, it will not
 run.  
 
 =item B<PageName|ModuleName|ProgramName>