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