installman

   1 #!./perl -w
   2 BEGIN {
   3     @INC = qw(lib);
   4
   5     # This needs to be at BEGIN time, before any use of Config
   6     require './install_lib.pl';
   7 }
   8 use strict;
   9
  10 use Getopt::Long;
  11 use File::Find;
  12 use File::Copy;
  13 use File::Path qw(mkpath);
  14 use ExtUtils::Packlist;
  15 use Pod::Man;
  16 use vars qw($Is_VMS $Is_W32 $Is_OS2 $Is_Cygwin $Is_Darwin $Is_NetWare
  17             %opts $packlist);
  18
  19 $ENV{SHELL} = 'sh' if $^O eq 'os2';
  20
  21 my $patchlevel = substr($],3,2);
  22 die "Patchlevel of perl ($patchlevel)",
  23     "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
  24         if $patchlevel != $Config{'PERL_VERSION'};
  25
  26 my $usage =
  27 "Usage:  installman --man1dir=/usr/wherever --man1ext=1
  28                    --man3dir=/usr/wherever --man3ext=3
  29                    --batchlimit=40
  30                    --notify --verbose --silent --help
  31         Defaults are:
  32         man1dir = $Config{'installman1dir'};
  33         man1ext = $Config{'man1ext'};
  34         man3dir = $Config{'installman3dir'};
  35         man3ext = $Config{'man3ext'};
  36         --notify  (or -n) just lists commands that would be executed.
  37         --verbose (or -V) report all progress.
  38         --silent  (or -S) be silent. Only report errors.\n";
  39
  40 GetOptions( \%opts,
  41             qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
  42                 destdir:s notify n help silent S verbose V))
  43         || die $usage;
  44 die $usage if $opts{help};
  45 $opts{destdir} //= '';
  46
  47 foreach my $pre (qw(man1 man3)) {
  48     $opts{"${pre}dir"} //= $opts{destdir} . $Config{"install${pre}dir"};
  49     $opts{"${pre}ext"} //= $Config{"${pre}ext"};
  50 }
  51 $opts{silent} ||= $opts{S};
  52 $opts{notify} ||= $opts{n};
  53 $opts{verbose} ||= $opts{V} || $opts{notify};
  54
  55 #Sanity checks
  56
  57 -x  "./perl$Config{exe_ext}"
  58   or warn "./perl$Config{exe_ext} not found!  Have you run make?\n";
  59 -d  "$opts{destdir}$Config{'installprivlib'}"
  60         || warn "Perl library directory $Config{'installprivlib'} not found.
  61                 Have you run make install?.  (Installing anyway.)\n";
  62 -x "t/perl$Config{exe_ext}"             || warn "WARNING: You've never run 'make test'!!!",
  63         "  (Installing anyway.)\n";
  64
  65 $packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
  66
  67 # manpages not to be installed
  68 my %do_not_install = map { ($_ => 1) } qw(
  69     Pod/Functions.pm
  70     XS/APItest.pm
  71     XS/APItest/KeywordRPN.pm
  72 );
  73
  74 # Install the main pod pages.
  75 pod2man('pod', $opts{man1dir}, $opts{man1ext});
  76
  77 # Install the pods for library modules.
  78 pod2man('lib', $opts{man3dir}, $opts{man3ext});
  79
  80 # Install the pods embedded in the installed scripts
  81 my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
  82 open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
  83 while (<UTILS>) {
  84     next if /^#/;
  85     chomp;
  86     $_ = $1 if /#.*pod\s*=\s*(\S+)/;
  87     my ($where, $what) = m|^(\S*)/(\S+)|;
  88     pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
  89     if ($has_man1dir) {
  90         if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
  91             my $old = "$opts{man1dir}/$what.$opts{man1ext}";
  92             my $new = "$opts{man1dir}/$what2.$opts{man1ext}";
  93             unlink($new);
  94             link($old, $new);
  95             my $xold = $old;
  96             $xold =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
  97             my $xnew = $new;
  98             $xnew =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
  99             $packlist->{$xnew} = { from => $xold, type => 'link' };
 100         }
 101     }
 102 }
 103
 104 sub pod2man {
 105     # @script is scripts names if we are installing manpages embedded
 106     # in scripts, () otherwise
 107     my($poddir, $mandir, $manext, @script) = @_;
 108     if ($mandir eq ' ' or $mandir eq '') {
 109         if (@script) {
 110             warn "Skipping installation of $poddir/$_ man page.\n"
 111                 foreach @script;
 112         } else {
 113             warn "Skipping installation of $poddir man pages.\n";
 114         }
 115         return;
 116     }
 117
 118     print "installing from $poddir\n" if $opts{verbose};
 119
 120     mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};  # In File::Path
 121     # Make a list of all the .pm and .pod files in the directory.  We avoid
 122     # chdir because we are running with @INC = '../lib', and modules may wish
 123     # to dynamically require Carp::Heavy or other diagnostics warnings.
 124     # Hash the names of files we find, keys are names relative to perl build
 125     # dir ('.'), values are names relative to $poddir.
 126     my %modpods;
 127     if (@script) {
 128         %modpods = (map {+"$poddir/$_", $_} @script);
 129     }
 130     else {
 131         File::Find::find({no_chdir=>1,
 132                           wanted => sub {
 133                               # $_ is $File::Find::name when using no_chdir
 134                               if (-f $_ and /\.p(?:m|od)$/) {
 135                                   my $fullname = $_;
 136                                   s!^\Q$poddir\E/!!;
 137                                   $modpods{$fullname} = $_;
 138                               }
 139                           }},
 140                          $poddir);
 141     }
 142     my @to_process;
 143     foreach my $mod (sort keys %modpods) {
 144         my $manpage = $modpods{$mod};
 145         my $tmp;
 146         # Skip .pm files that have corresponding .pod files, and Functions.pm.
 147         next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
 148         next if $mod =~ m:/t/:; # no pods from test directories
 149         next if $do_not_install{$manpage};
 150
 151         # Skip files without pod docs
 152         my $has_pod;
 153         if (open T, $mod)
 154         {
 155             local $_;
 156             while (<T>)
 157             {
 158                 ++$has_pod and last if /^=(?:head\d+|item|pod)\b/;
 159             }
 160
 161             close T;
 162         }
 163
 164         unless ($has_pod)
 165         {
 166             warn "no documentation in $mod\n";
 167             next;
 168         }
 169
 170         # Convert name from  File/Basename.pm to File::Basename.3 format,
 171         # if necessary.
 172         $manpage =~ s#\.p(m|od)$##;
 173         if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
 174           $manpage =~ s#/#.#g;
 175         }
 176         else {
 177           $manpage =~ s#/#::#g;
 178         }
 179         $tmp = "${mandir}/${manpage}.tmp";
 180         $manpage = "${mandir}/${manpage}.${manext}";
 181         push @to_process, [$mod, $tmp, $manpage];
 182     }
 183
 184     foreach my $page (@to_process) {
 185         my($pod, $tmp, $manpage) = @$page;
 186
 187         my $parser = Pod::Man->new( section => $manext,
 188                                     official=> 1,
 189                                     center  => 'Perl Programmers Reference Guide'
 190                                   );
 191         my $xmanpage = $manpage;
 192         $xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
 193         print "  $xmanpage\n";
 194         if (!$opts{notify} && $parser->parse_from_file($pod, $tmp)) {
 195             if (-s $tmp) {
 196                 if (rename($tmp, $manpage)) {
 197                     $packlist->{$xmanpage} = { type => 'file' };
 198                     next;
 199                 }
 200             }
 201             unlink($tmp);
 202         }
 203     }
 204 }
 205
 206 $packlist->write() unless $opts{notify};
 207 print "  Installation complete\n" if $opts{verbose};
 208
 209 exit 0;
 210
 211 sub rename {
 212     my($from,$to) = @_;
 213     if (-f $to and not unlink($to)) {
 214         my($i);
 215         for ($i = 1; $i < 50; $i++) {
 216             last if CORE::rename($to, "$to.$i");
 217         }
 218         warn("Cannot rename to `$to.$i': $!"), return 0
 219             if $i >= 50;        # Give up!
 220     }
 221     link($from,$to) || return 0;
 222     unlink($from);
 223 }