installman

   1 #!./perl
   2 BEGIN { @INC = ('lib') }
   3 use Config;
   4 use Getopt::Long;
   5 use File::Find;
   6 use File::Copy;
   7 use File::Path qw(mkpath);
   8 use ExtUtils::Packlist;
   9 use subs qw(unlink chmod rename link);
  10 use vars qw($packlist);
  11 require Cwd;
  12
  13 umask 022;
  14 $ENV{SHELL} = 'sh' if $^O eq 'os2';
  15
  16 $ver = $];
  17 $release = substr($ver,0,3);   # Not used presently.
  18 $patchlevel = substr($ver,3,2);
  19 die "Patchlevel of perl ($patchlevel)",
  20     "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
  21         if $patchlevel != $Config{'PERL_VERSION'};
  22
  23 $usage =
  24 "Usage:  installman --man1dir=/usr/wherever --man1ext=1
  25                     --man3dir=/usr/wherever --man3ext=3
  26                     --notify --help
  27         Defaults are:
  28         man1dir = $Config{'installman1dir'};
  29         man1ext = $Config{'man1ext'};
  30         man3dir = $Config{'installman3dir'};
  31         man3ext = $Config{'man3ext'};
  32         --notify (or -n) just lists commands that would be executed.\n";
  33
  34 GetOptions( qw( man1dir=s man1ext=s man3dir=s man3ext=s notify n help))
  35         || die $usage;
  36 die $usage if $opt_help;
  37
  38 # These are written funny to avoid -w typo warnings.
  39 $man1dir = defined($opt_man1dir) ? $opt_man1dir : $Config{'installman1dir'};
  40 $man1ext = defined($opt_man1ext) ? $opt_man1ext : $Config{'man1ext'};
  41 $man3dir = defined($opt_man3dir) ? $opt_man3dir : $Config{'installman3dir'};
  42 $man3ext = defined($opt_man3ext) ? $opt_man3ext : $Config{'man3ext'};
  43
  44 $notify = $opt_notify || $opt_n;
  45
  46 #Sanity checks
  47
  48 -x  "./perl$Config{exe_ext}"
  49   or warn "./perl$Config{exe_ext} not found!  Have you run make?\n";
  50 -d  $Config{'installprivlib'}
  51         || warn "Perl library directory $Config{'installprivlib'} not found.
  52                 Have you run make install?.  (Installing anyway.)\n";
  53 -x "t/perl$Config{exe_ext}"             || warn "WARNING: You've never run 'make test'!!!",
  54         "  (Installing anyway.)\n";
  55
  56 $packlist = ExtUtils::Packlist->new("$Config{installarchlib}/.packlist");
  57
  58 # Install the main pod pages.
  59 runpod2man('pod', $man1dir, $man1ext);
  60
  61 # Install the pods for library modules.
  62 runpod2man('lib', $man3dir, $man3ext);
  63
  64 # Install the pods embedded in the installed scripts
  65 runpod2man('utils', $man1dir, $man1ext, 'c2ph');
  66 runpod2man('utils', $man1dir, $man1ext, 'h2ph');
  67 runpod2man('utils', $man1dir, $man1ext, 'h2xs');
  68 runpod2man('utils', $man1dir, $man1ext, 'perlcc');
  69 runpod2man('utils', $man1dir, $man1ext, 'perldoc');
  70 runpod2man('utils', $man1dir, $man1ext, 'perlbug');
  71 runpod2man('utils', $man1dir, $man1ext, 'pl2pm');
  72 runpod2man('utils', $man1dir, $man1ext, 'splain');
  73 runpod2man('utils', $man1dir, $man1ext, 'dprofpp');
  74 runpod2man('x2p', $man1dir, $man1ext, 's2p');
  75 runpod2man('x2p', $man1dir, $man1ext, 'a2p.pod');
  76 runpod2man('x2p', $man1dir, $man1ext, 'find2perl');
  77 runpod2man('pod', $man1dir, $man1ext, 'pod2man');
  78 runpod2man('pod', $man1dir, $man1ext, 'pod2html');
  79 runpod2man('pod', $man1dir, $man1ext, 'pod2text');
  80 runpod2man('pod', $man1dir, $man1ext, 'pod2usage');
  81 runpod2man('pod', $man1dir, $man1ext, 'podchecker');
  82 runpod2man('pod', $man1dir, $man1ext, 'podselect');
  83
  84 # It would probably be better to have this page linked
  85 # to the c2ph man page.  Or, this one could say ".so man1/c2ph.1",
  86 # but then it would have to pay attention to $man1dir and $man1ext.
  87 runpod2man('utils', $man1dir, $man1ext, 'pstruct');
  88
  89 runpod2man('lib/ExtUtils', $man1dir, $man1ext, 'xsubpp');
  90
  91 sub runpod2man {
  92     # $script is script name if we are installing a manpage embedded
  93     # in a script, undef otherwise
  94     my($poddir, $mandir, $manext, $script) = @_;
  95
  96     my($downdir); # can't just use .. when installing xsubpp manpage
  97
  98     $downdir = $poddir;
  99     $downdir =~ s:[^/]+:..:g;
 100     my($builddir) = Cwd::getcwd();
 101
 102     if ($mandir eq ' ' or $mandir eq '') {
 103         print STDERR "Skipping installation of ",
 104             ($script ? "$poddir/$script man page" : "$poddir man pages"), ".\n";
 105         return;
 106     }
 107
 108     print STDERR "chdir $poddir\n";
 109     chdir $poddir || die "Unable to cd to $poddir directory!\n$!\n";
 110
 111     # We insist on using the current version of pod2man in case there
 112     # are enhancements or changes from previous installed versions.
 113     # The error message doesn't include the '..' because the user
 114     # won't be aware that we've chdir to $poddir.
 115     -r  "$downdir/pod/pod2man" || die "Executable pod/pod2man not found.\n";
 116
 117     # We want to be sure to use the current perl.  We can't rely on
 118     # the installed perl because it might not be actually installed
 119     # yet. (The user may have set the $install* Configure variables
 120     # to point to some temporary home, from which the executable gets
 121     # installed by occult means.)
 122     $pod2man = "$downdir/perl -I $downdir/lib $downdir/pod/pod2man --section=$manext --official";
 123
 124     mkpath($mandir, 1, 0777) unless $notify;  # In File::Path
 125     # Make a list of all the .pm and .pod files in the directory.  We will
 126     # always run pod2man from the lib directory and feed it the full pathname
 127     # of the pod.  This might be useful for pod2man someday.
 128     if ($script) {
 129         @modpods = ($script);
 130     } else {
 131         @modpods = ();
 132         find(\&lsmodpods, '.');
 133     }
 134     foreach $mod (@modpods) {
 135         $manpage = $mod;
 136         my $tmp;
 137         # Skip .pm files that have corresponding .pod files, and Functions.pm.
 138         next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
 139         next if ($mod eq 'Pod/Functions.pm');   #### Used only by pod itself
 140
 141         # Convert name from  File/Basename.pm to File::Basename.3 format,
 142         # if necessary.
 143         $manpage =~ s#\.p(m|od)$##;
 144         if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O =~ /cygwin/) {
 145           $manpage =~ s#/#.#g;
 146         } else {
 147           $manpage =~ s#/#::#g;
 148         }
 149         $tmp = "${mandir}/${manpage}.tmp";
 150         $manpage = "${mandir}/${manpage}.${manext}";
 151         if (&cmd("$pod2man $mod > $tmp") == 0 && !$notify && -s $tmp) {
 152             rename($tmp, $manpage) && next;
 153         }
 154         unless ($notify) {
 155     unlink($tmp);
 156         }
 157     }
 158     chdir "$builddir" || die "Unable to cd back to $builddir directory!\n$!\n";
 159     print STDERR "chdir $builddir\n";
 160 }
 161
 162 sub lsmodpods {
 163     my $dir  = $File::Find::dir;
 164     my $name = $File::Find::name;
 165     if (-f $_) {
 166         $name =~ s#^\./##;
 167         push(@modpods, $name) if ($name =~ /\.p(m|od)$/);
 168     }
 169 }
 170
 171 $packlist->write() unless $notify;
 172 print STDERR "  Installation complete\n";
 173
 174 exit 0;
 175
 176
 177 ###############################################################################
 178 # Utility subroutines from installperl
 179
 180 sub cmd {
 181     local($cmd) = @_;
 182     print STDERR "  $cmd\n";
 183     unless ($notify) {
 184         if ($Config{d_fork}) {
 185             fork ? wait : exec $cmd;  # Allow user to ^C out of command.
 186         }
 187         else {
 188             system $cmd;
 189         }
 190         warn "Command failed!!\n" if $?;
 191     }
 192     return $? != 0;
 193 }
 194
 195 sub unlink {
 196     local(@names) = @_;
 197     my $cnt = 0;
 198
 199     foreach $name (@names) {
 200 next unless -e $name;
 201 chmod 0777, $name if $^O eq 'os2';
 202 print STDERR "  unlink $name\n";
 203 ( CORE::unlink($name) and ++$cnt
 204     or warn "Couldn't unlink $name: $!\n" ) unless $notify;
 205     }
 206     return $cnt;
 207 }
 208
 209 sub link {
 210     my($from,$to) = @_;
 211     my($success) = 0;
 212
 213     print STDERR "  ln $from $to\n";
 214     eval {
 215         CORE::link($from, $to)
 216             ? $success++
 217             : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
 218               ? die "AFS"  # okay inside eval {}
 219               : warn "Couldn't link $from to $to: $!\n"
 220           unless $notify;
 221         $packlist->{$to} = { type => 'file' };
 222     };
 223     if ($@) {
 224         File::Copy::copy($from, $to)
 225             ? $success++
 226             : warn "Couldn't copy $from to $to: $!\n"
 227           unless $notify;
 228         $packlist->{$to} = { type => 'file' };
 229     }
 230     $success;
 231 }
 232
 233 sub rename {
 234     local($from,$to) = @_;
 235     if (-f $to and not unlink($to)) {
 236 my($i);
 237 for ($i = 1; $i < 50; $i++) {
 238     last if CORE::rename($to, "$to.$i");
 239 }
 240 warn("Cannot rename to `$to.$i': $!"), return 0
 241     if $i >= 50;        # Give up!
 242     }
 243     link($from,$to) || return 0;
 244     unlink($from);
 245     $packlist->{$to} = { type => 'file' };
 246 }
 247
 248 sub chmod {
 249     local($mode,$name) = @_;
 250
 251     printf STDERR "  chmod %o %s\n", $mode, $name;
 252     CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
 253         unless $notify;
 254 }
 255
 256 sub samepath {
 257     local($p1, $p2) = @_;
 258     local($dev1, $ino1, $dev2, $ino2);
 259
 260     if ($p1 ne $p2) {
 261         ($dev1, $ino1) = stat($p1);
 262         ($dev2, $ino2) = stat($p2);
 263         ($dev1 == $dev2 && $ino1 == $ino2);
 264     }
 265     else {
 266         1;
 267     }
 268 }