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