-#!./perl
-BEGIN { @INC = ('lib') }
-use Config;
+#!./perl -w
+
+BEGIN {
+ @INC = qw(lib);
+
+ # This needs to be at BEGIN time, before any use of Config
+ # install_lib itself loads and imports Config into main::
+ require './install_lib.pl';
+}
+
+use strict;
+
use Getopt::Long;
-use File::Find;
-use File::Copy;
-use File::Path qw(mkpath);
use ExtUtils::Packlist;
-use subs qw(unlink chmod rename link);
-use vars qw($packlist);
-require Cwd;
+use Pod::Man;
+use vars qw(%opts $packlist);
+
+require './Porting/pod_lib.pl';
+my %man1 = (map {($_->[0], $_->[1])} @{get_pod_metadata()->{master}});
$ENV{SHELL} = 'sh' if $^O eq 'os2';
-$ver = $Config{version};
-$release = substr($],0,3); # Not used presently.
-$patchlevel = substr($],3,2);
+my $patchlevel = substr($],3,2);
die "Patchlevel of perl ($patchlevel)",
"and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
if $patchlevel != $Config{'PERL_VERSION'};
-$usage =
+my $usage =
"Usage: installman --man1dir=/usr/wherever --man1ext=1
- --man3dir=/usr/wherever --man3ext=3
- --notify --help
+ --man3dir=/usr/wherever --man3ext=3
+ --notify --verbose --silent --help
Defaults are:
man1dir = $Config{'installman1dir'};
man1ext = $Config{'man1ext'};
man3dir = $Config{'installman3dir'};
man3ext = $Config{'man3ext'};
- --notify (or -n) just lists commands that would be executed.\n";
-
-GetOptions( qw( man1dir=s man1ext=s man3dir=s man3ext=s notify n help silent S))
+ --notify (or -n) just lists commands that would be executed.
+ --verbose (or -V) report all progress.
+ --silent (or -S) be silent. Only report errors.\n";
+
+# --strip intentionally does nothing. By permitting installman to accept it
+# without error, the Makefile can pass the same options to installperl and
+# installman, which permits more simplification there than this comment costs.
+GetOptions( \%opts,
+ qw( man1dir=s man1ext=s man3dir=s man3ext=s
+ destdir:s notify|n help|h|? silent|S verbose|V strip))
|| die $usage;
-die $usage if $opt_help;
+die $usage if $opts{help};
+$opts{destdir} //= '';
-# These are written funny to avoid -w typo warnings.
-$man1dir = defined($opt_man1dir) ? $opt_man1dir : $Config{'installman1dir'};
-$man1ext = defined($opt_man1ext) ? $opt_man1ext : $Config{'man1ext'};
-$man3dir = defined($opt_man3dir) ? $opt_man3dir : $Config{'installman3dir'};
-$man3ext = defined($opt_man3ext) ? $opt_man3ext : $Config{'man3ext'};
-$silent = $opt_silent || $opt_s;
-
-$notify = $opt_notify || $opt_n;
+foreach my $pre (qw(man1 man3)) {
+ $opts{"${pre}dir"} //= $opts{destdir} . $Config{"install${pre}dir"};
+ $opts{"${pre}ext"} //= $Config{"${pre}ext"};
+}
+$opts{verbose} ||= $opts{notify};
#Sanity checks
--x "./perl$Config{exe_ext}"
+-x "./perl$Config{exe_ext}"
or warn "./perl$Config{exe_ext} not found! Have you run make?\n";
--d $Config{'installprivlib'}
+-d "$opts{destdir}$Config{'installprivlib'}"
|| warn "Perl library directory $Config{'installprivlib'} not found.
Have you run make install?. (Installing anyway.)\n";
-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!",
" (Installing anyway.)\n";
-$packlist = ExtUtils::Packlist->new("$Config{installarchlib}/.packlist");
+$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
# Install the main pod pages.
-runpod2man('pod', $man1dir, $man1ext);
+pod2man(\%man1, $opts{man1dir}, $opts{man1ext}, 'pod');
# Install the pods for library modules.
-runpod2man('lib', $man3dir, $man3ext);
+{
+ my $found = pods_to_install();
+ pod2man($found->{$_}, $opts{man3dir}, $opts{man3ext}, 'lib')
+ foreach qw(MODULE PRAGMA);
+}
# Install the pods embedded in the installed scripts
-runpod2man('utils', $man1dir, $man1ext, 'c2ph');
-runpod2man('utils', $man1dir, $man1ext, 'h2ph');
-runpod2man('utils', $man1dir, $man1ext, 'h2xs');
-runpod2man('utils', $man1dir, $man1ext, 'perlcc');
-runpod2man('utils', $man1dir, $man1ext, 'perldoc');
-runpod2man('utils', $man1dir, $man1ext, 'perlbug');
-runpod2man('utils', $man1dir, $man1ext, 'pl2pm');
-runpod2man('utils', $man1dir, $man1ext, 'splain');
-runpod2man('utils', $man1dir, $man1ext, 'dprofpp');
-runpod2man('x2p', $man1dir, $man1ext, 's2p');
-runpod2man('x2p', $man1dir, $man1ext, 'a2p.pod');
-runpod2man('x2p', $man1dir, $man1ext, 'find2perl');
-runpod2man('pod', $man1dir, $man1ext, 'pod2man');
-runpod2man('pod', $man1dir, $man1ext, 'pod2html');
-runpod2man('pod', $man1dir, $man1ext, 'pod2text');
-runpod2man('pod', $man1dir, $man1ext, 'pod2usage');
-runpod2man('pod', $man1dir, $man1ext, 'podchecker');
-runpod2man('pod', $man1dir, $man1ext, 'podselect');
-
-# It would probably be better to have this page linked
-# to the c2ph man page. Or, this one could say ".so man1/c2ph.1",
-# but then it would have to pay attention to $man1dir and $man1ext.
-runpod2man('utils', $man1dir, $man1ext, 'pstruct');
-
-runpod2man('lib/ExtUtils', $man1dir, $man1ext, 'xsubpp');
-
-sub runpod2man {
- # $script is script name if we are installing a manpage embedded
- # in a script, undef otherwise
- my($poddir, $mandir, $manext, $script) = @_;
-
- my($downdir); # can't just use .. when installing xsubpp manpage
-
- $downdir = $poddir;
- $downdir =~ s:[^/]+:..:g;
- my($builddir) = Cwd::getcwd();
-
- if ($mandir eq ' ' or $mandir eq '') {
- warn "Skipping installation of ",
- ($script ? "$poddir/$script man page" : "$poddir man pages"), ".\n";
- return;
- }
-
- warn "chdir $poddir\n" unless $silent;
- chdir $poddir || die "Unable to cd to $poddir directory!\n$!\n";
-
- # We insist on using the current version of pod2man in case there
- # are enhancements or changes from previous installed versions.
- # The error message doesn't include the '..' because the user
- # won't be aware that we've chdir to $poddir.
- -r "$downdir/pod/pod2man" || die "Executable pod/pod2man not found.\n";
-
- # We want to be sure to use the current perl. We can't rely on
- # the installed perl because it might not be actually installed
- # yet. (The user may have set the $install* Configure variables
- # to point to some temporary home, from which the executable gets
- # installed by occult means.)
- $pod2man = "$downdir/perl -I $downdir/lib $downdir/pod/pod2man --section=$manext --official";
-
- mkpath($mandir, 1, 0777) unless $notify; # In File::Path
- # Make a list of all the .pm and .pod files in the directory. We will
- # always run pod2man from the lib directory and feed it the full pathname
- # of the pod. This might be useful for pod2man someday.
- if ($script) {
- @modpods = ($script);
- }
- else {
- @modpods = ();
- find(\&lsmodpods, '.');
- }
- foreach $mod (@modpods) {
- $manpage = $mod;
- my $tmp;
- # Skip .pm files that have corresponding .pod files, and Functions.pm.
- next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
- next if ($mod eq 'Pod/Functions.pm'); #### Used only by pod itself
-
- # Convert name from File/Basename.pm to File::Basename.3 format,
- # if necessary.
- $manpage =~ s#\.p(m|od)$##;
- if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
- $manpage =~ s#/#.#g;
- }
- else {
- $manpage =~ s#/#::#g;
- }
- $tmp = "${mandir}/${manpage}.tmp";
- $manpage = "${mandir}/${manpage}.${manext}";
- if (&cmd("$pod2man $mod > $tmp") == 0 && !$notify && -s $tmp) {
- if (rename($tmp, $manpage)) {
- $packlist->{$manpage} = { type => 'file' };
- next;
- }
- }
- unless ($notify) {
- unlink($tmp);
+my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
+my $fh = open_or_die('utils.lst');
+while (<$fh>) {
+ next if /^#/;
+ chomp;
+ my ($path, $leaf) = m|^(\S*/(\S+))|;
+ # Have we already installed the manpage for this? (eg perldoc, a2p)
+ next if $man1{$leaf};
+ pod2man({$leaf, $path}, $opts{man1dir}, $opts{man1ext});
+ if ($has_man1dir) {
+ if (my ($link) = m|#.*link\s*=\s*\S+/(\S+)|) {
+ my $old = "$opts{man1dir}/$leaf.$opts{man1ext}";
+ my $new = "$opts{man1dir}/$link.$opts{man1ext}";
+ unlink($new);
+ link($old, $new);
+ $old =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
+ $new =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
+ $packlist->{$new} = { from => $old, type => 'link' };
}
}
- chdir "$builddir" || die "Unable to cd back to $builddir directory!\n$!\n";
- warn "chdir $builddir\n" unless $silent;
}
+close $fh or my_die("close 'utils.lst': $!");
-sub lsmodpods {
- my $dir = $File::Find::dir;
- my $name = $File::Find::name;
- if (-f $_) {
- $name =~ s#^\./##;
- push(@modpods, $name) if ($name =~ /\.p(m|od)$/);
+sub pod2man {
+ my($modpods, $mandir, $manext, $where) = @_;
+ if ($mandir eq ' ' or $mandir eq '') {
+ if ($where) {
+ warn "Skipping installation of $where man pages.\n"
+ } else {
+ warn "Skipping installation of $_ man page.\n"
+ foreach values %$modpods;
+ }
+ return;
}
-}
-
-$packlist->write() unless $notify;
-warn " Installation complete\n";
-
-exit 0;
-
-###############################################################################
-# Utility subroutines from installperl
-
-sub cmd {
- local($cmd) = @_;
- warn " $cmd\n" unless $cmd;
- unless ($notify) {
- if ($Config{d_fork}) {
- fork ? wait : exec $cmd; # Allow user to ^C out of command.
- }
- else {
- system $cmd;
- }
- warn "Command failed!!\n" if $?;
+ if ($opts{verbose}) {
+ if ($where) {
+ print "installing from $where\n";
+ } else {
+ print "installing $_\n"
+ foreach sort keys %$modpods;
+ }
}
- return $? != 0;
-}
-sub unlink {
- local(@names) = @_;
- my $cnt = 0;
-
- foreach $name (@names) {
- next unless -e $name;
- chmod 0777, $name if $^O eq 'os2';
- warn " unlink $name\n" unless $silent;
- ( CORE::unlink($name) and ++$cnt
- or warn "Couldn't unlink $name: $!\n" ) unless $notify;
- }
- return $cnt;
-}
-
-sub link {
- my($from,$to) = @_;
- my($success) = 0;
+ mkpath($mandir);
+
+ foreach my $manpage (sort keys %$modpods) {
+ my $mod = $modpods->{$manpage};
+
+ # Skip files without pod docs
+ my $has_pod;
+ my $fh = open_or_die($mod);
+ while (my $line = <$fh>) {
+ if ($line =~ /^=head1\b/) {
+ ++$has_pod;
+ last;
+ }
+ }
+ close $fh or my_die("close '$mod': $!");
+ # Sadly it doesn't seem possible to re-use this handle for the call
+ # to parse_from_file() below, as Pod::Man relies on source_filename(),
+ # which Pod::Simple only sets accurately if it opens the file itself.
+
+ unless ($has_pod)
+ {
+ warn "no documentation in $mod\n" unless $opts{silent};
+ next;
+ }
- warn $silent ? " $to\n" : " ln $from $to\n";
- eval {
- CORE::link($from, $to)
- ? $success++
- : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
- ? die "AFS" # okay inside eval {}
- : warn "Couldn't link $from to $to: $!\n"
- unless $notify;
- };
- if ($@) {
- File::Copy::copy($from, $to)
- ? $success++
- : warn "Couldn't copy $from to $to: $!\n"
- unless $notify;
- }
- $success;
-}
+ if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
+ $manpage =~ s#::#.#g;
+ }
+ my $tmp = "${mandir}/${manpage}.tmp";
+ $manpage = "${mandir}/${manpage}.${manext}";
-sub rename {
- local($from,$to) = @_;
- if (-f $to and not unlink($to)) {
- my($i);
- for ($i = 1; $i < 50; $i++) {
- last if CORE::rename($to, "$to.$i");
+ my $parser = Pod::Man->new( section => $manext,
+ official=> 1,
+ center => 'Perl Programmers Reference Guide'
+ );
+ my $xmanpage = $manpage;
+ $xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
+ print " $xmanpage\n" unless $opts{silent};
+ if (!$opts{notify} && $parser->parse_from_file($mod, $tmp)) {
+ if (-s $tmp) {
+ if (safe_rename($tmp, $manpage)) {
+ $packlist->{$xmanpage} = { type => 'file' };
+ next;
+ }
+ }
+ unlink($tmp);
}
- warn("Cannot rename to `$to.$i': $!"), return 0
- if $i >= 50; # Give up!
}
- link($from,$to) || return 0;
- unlink($from);
}
-sub chmod {
- local($mode,$name) = @_;
+$packlist->write() unless $opts{notify};
+print " Installation complete\n" if $opts{verbose};
- warn( " chmod %o %s\n", $mode, $name) unless $silent;
- CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
- unless $notify;
-}
-
-sub samepath {
- local($p1, $p2) = @_;
- local($dev1, $ino1, $dev2, $ino2);
-
- if ($p1 ne $p2) {
- ($dev1, $ino1) = stat($p1);
- ($dev2, $ino2) = stat($p2);
- ($dev1 == $dev2 && $ino1 == $ino2);
- }
- else {
- 1;
- }
-}
+# Local variables:
+# cperl-indent-level: 4
+# indent-tabs-mode: nil
+# End:
+#
+# ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blobdiff