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