This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
change#3373 introduced a handle leak in backticks and piped open()s
[perl5.git] / installman
CommitLineData
f0512cd0 1#!./perl -w
e8fcf3b9 2BEGIN { @INC = qw(lib) }
f0512cd0 3use strict;
16d20bd9
AD
4use Config;
5use Getopt::Long;
6use File::Find;
354f3b56 7use File::Copy;
356fc125 8use File::Path qw(mkpath);
354f3b56 9use ExtUtils::Packlist;
a2743834 10use Pod::Man;
cd8bccb5 11use subs qw(unlink chmod rename link);
b48e406f 12use vars qw($packlist);
16d20bd9 13
791b4ad3
A
14if ($Config{d_umask}) {
15 umask(022); # umasks like 077 aren't that useful for installations
16}
17
cd8bccb5 18$ENV{SHELL} = 'sh' if $^O eq 'os2';
16d20bd9 19
f0512cd0
DC
20my $ver = $Config{version}; # Not used presently.
21my $release = substr($],0,3); # Not used presently.
22my $patchlevel = substr($],3,2);
16d20bd9 23die "Patchlevel of perl ($patchlevel)",
cceca5ed
GS
24 "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
25 if $patchlevel != $Config{'PERL_VERSION'};
16d20bd9 26
f0512cd0 27my $usage =
16d20bd9 28"Usage: installman --man1dir=/usr/wherever --man1ext=1
b5f05010 29 --man3dir=/usr/wherever --man3ext=3
f1745d4f 30 --batchlimit=40
eabd589f 31 --notify --verbose --silent --help
16d20bd9
AD
32 Defaults are:
33 man1dir = $Config{'installman1dir'};
34 man1ext = $Config{'man1ext'};
35 man3dir = $Config{'installman3dir'};
36 man3ext = $Config{'man3ext'};
eabd589f
A
37 --notify (or -n) just lists commands that would be executed.
38 --verbose (or -V) report all progress.
39 --silent (or -S) be silent. Only report errors.\n";
16d20bd9 40
f0512cd0
DC
41my %opts;
42GetOptions( \%opts,
f1745d4f 43 qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
f0512cd0 44 notify n help silent S verbose V))
16d20bd9 45 || die $usage;
f0512cd0 46die $usage if $opts{help};
16d20bd9 47
f0512cd0
DC
48$opts{man1dir} = $Config{'installman1dir'}
49 unless defined($opts{man1dir});
50$opts{man1ext} = $Config{'man1ext'}
51 unless defined($opts{man1ext});
52$opts{man3dir} = $Config{'installman3dir'}
53 unless defined($opts{man3dir});
54$opts{man3ext} = $Config{'man3ext'}
55 unless defined($opts{man3ext});
56$opts{silent} ||= $opts{S};
f0512cd0 57$opts{notify} ||= $opts{n};
4ad019ef 58$opts{verbose} ||= $opts{V} || $opts{notify};
16d20bd9
AD
59
60#Sanity checks
61
cd8bccb5
PP
62-x "./perl$Config{exe_ext}"
63 or warn "./perl$Config{exe_ext} not found! Have you run make?\n";
16d20bd9
AD
64-d $Config{'installprivlib'}
65 || warn "Perl library directory $Config{'installprivlib'} not found.
66 Have you run make install?. (Installing anyway.)\n";
cd8bccb5 67-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!",
16d20bd9
AD
68 " (Installing anyway.)\n";
69
354f3b56
AB
70$packlist = ExtUtils::Packlist->new("$Config{installarchlib}/.packlist");
71
21dae8a0 72
16d20bd9 73# Install the main pod pages.
a2743834 74pod2man('pod', $opts{man1dir}, $opts{man1ext});
16d20bd9
AD
75
76# Install the pods for library modules.
a2743834 77pod2man('lib', $opts{man3dir}, $opts{man3ext});
16d20bd9 78
1fef88e7 79# Install the pods embedded in the installed scripts
21dae8a0
SC
80open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
81while (<UTILS>) {
82 next if /^#/;
83 chomp;
84 $_ = $1 if /#.*pod\s*=\s*(\S+)/;
7feaa10c 85 my ($where, $what) = m|^(.*?)/(\S+)|;
a2743834 86 pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
e8fcf3b9
JH
87 if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
88 my $old = "$opts{man1dir}/$what.$opts{man1ext}";
89 my $new = "$opts{man1dir}/$what2.$opts{man1ext}";
90 unlink($new);
91 link($old, $new);
21dae8a0
SC
92 }
93}
1fef88e7 94
a2743834 95sub pod2man {
f1745d4f
JH
96 # @script is scripts names if we are installing manpages embedded
97 # in scripts, () otherwise
98 my($poddir, $mandir, $manext, @script) = @_;
16d20bd9 99 if ($mandir eq ' ' or $mandir eq '') {
f1745d4f
JH
100 if (@script) {
101 warn "Skipping installation of $poddir/$_ man page.\n"
102 foreach @script;
103 } else {
104 warn "Skipping installation of $poddir man pages.\n";
105 }
16d20bd9
AD
106 return;
107 }
108
b48e406f 109 print "installing from $poddir\n" if $opts{verbose};
16d20bd9 110
418918ac 111 mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify}; # In File::Path
b48e406f
NC
112 # Make a list of all the .pm and .pod files in the directory. We avoid
113 # chdir because we are running with @INC = '../lib', and modules may wish
114 # to dynamically require Carp::Heavy or other diagnostics warnings.
115 # Hash the names of files we find, keys are names relative to perl build
116 # dir ('.'), values are names relative to $poddir.
117 my %modpods;
f1745d4f 118 if (@script) {
b48e406f 119 %modpods = (map {+"$poddir/$_", $_} @script);
72b3d9b4
GS
120 }
121 else {
b48e406f
NC
122 File::Find::find({no_chdir=>1,
123 wanted => sub {
124 # $_ is $File::Find::name when using no_chdir
125 if (-f $_ and /\.p(?:m|od)$/) {
126 my $fullname = $_;
127 s!^\Q$poddir\E/!!;
128 $modpods{$fullname} = $_;
129 }
130 }},
131 $poddir);
1fef88e7 132 }
f1745d4f 133 my @to_process;
b48e406f
NC
134 foreach my $mod (sort keys %modpods) {
135 my $manpage = $modpods{$mod};
cd8bccb5
PP
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);
b48e406f 139 next if ($manpage eq 'Pod/Functions.pm'); #### Used only by pod itself
cd8bccb5 140
16d20bd9
AD
141 # Convert name from File/Basename.pm to File::Basename.3 format,
142 # if necessary.
143 $manpage =~ s#\.p(m|od)$##;
4fabb596 144 if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
cd8bccb5 145 $manpage =~ s#/#.#g;
72b3d9b4
GS
146 }
147 else {
cd8bccb5
PP
148 $manpage =~ s#/#::#g;
149 }
150 $tmp = "${mandir}/${manpage}.tmp";
16d20bd9 151 $manpage = "${mandir}/${manpage}.${manext}";
f1745d4f
JH
152 push @to_process, [$mod, $tmp, $manpage];
153 }
a2743834
MS
154
155 my $parser = Pod::Man->new( section => $manext,
156 official=> 1,
157 center => 'Perl Programmers Reference Guide'
158 );
159 foreach my $page (@to_process) {
160 my($pod, $tmp, $manpage) = @$page;
161
162 print " $manpage\n";
163 if (!$opts{notify} && $parser->parse_from_file($pod, $tmp)) {
164 if (-s $tmp) {
165 if (rename($tmp, $manpage)) {
166 $packlist->{$manpage} = { type => 'file' };
167 next;
168 }
169 }
170 unlink($tmp);
6d64b06f 171 }
16d20bd9 172 }
16d20bd9
AD
173}
174
f0512cd0
DC
175$packlist->write() unless $opts{notify};
176print " Installation complete\n" if $opts{verbose};
16d20bd9
AD
177
178exit 0;
179
180
181###############################################################################
182# Utility subroutines from installperl
183
cd8bccb5 184sub unlink {
f0512cd0 185 my(@names) = @_;
cd8bccb5
PP
186 my $cnt = 0;
187
f0512cd0 188 foreach my $name (@names) {
72b3d9b4
GS
189 next unless -e $name;
190 chmod 0777, $name if $^O eq 'os2';
f0512cd0 191 print " unlink $name\n" if $opts{verbose};
72b3d9b4 192 ( CORE::unlink($name) and ++$cnt
f0512cd0 193 or warn "Couldn't unlink $name: $!\n" ) unless $opts{notify};
cd8bccb5
PP
194 }
195 return $cnt;
196}
197
16d20bd9 198sub link {
354f3b56
AB
199 my($from,$to) = @_;
200 my($success) = 0;
16d20bd9 201
a2743834 202 print " ln $from $to\n" if $opts{verbose};
354f3b56
AB
203 eval {
204 CORE::link($from, $to)
205 ? $success++
206 : ($from =~ m#^/afs/# || $to =~ m#^/afs/#)
207 ? die "AFS" # okay inside eval {}
208 : warn "Couldn't link $from to $to: $!\n"
f0512cd0 209 unless $opts{notify};
354f3b56
AB
210 };
211 if ($@) {
212 File::Copy::copy($from, $to)
213 ? $success++
214 : warn "Couldn't copy $from to $to: $!\n"
f0512cd0 215 unless $opts{notify};
354f3b56
AB
216 }
217 $success;
cd8bccb5
PP
218}
219
220sub rename {
f0512cd0 221 my($from,$to) = @_;
55a105fd 222 if (-f $to and not unlink($to)) {
72b3d9b4
GS
223 my($i);
224 for ($i = 1; $i < 50; $i++) {
225 last if CORE::rename($to, "$to.$i");
226 }
227 warn("Cannot rename to `$to.$i': $!"), return 0
228 if $i >= 50; # Give up!
cd8bccb5 229 }
55a105fd 230 link($from,$to) || return 0;
231 unlink($from);
16d20bd9
AD
232}
233
234sub chmod {
f0512cd0 235 my($mode,$name) = @_;
16d20bd9 236
f0512cd0 237 printf " chmod %o %s\n", $mode, $name if $opts{verbose};
cd8bccb5 238 CORE::chmod($mode,$name) || warn sprintf("Couldn't chmod %o %s: $!\n",$mode,$name)
f0512cd0 239 unless $opts{notify};
16d20bd9
AD
240}
241
16d20bd9 242sub samepath {
f0512cd0
DC
243 my($p1, $p2) = @_;
244 my($dev1, $ino1, $dev2, $ino2);
16d20bd9
AD
245
246 if ($p1 ne $p2) {
247 ($dev1, $ino1) = stat($p1);
248 ($dev2, $ino2) = stat($p2);
249 ($dev1 == $dev2 && $ino1 == $ino2);
250 }
251 else {
252 1;
253 }
254}