This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Some tidying in installman.
[perl5.git] / installman
CommitLineData
f0512cd0 1#!./perl -w
be61d08e 2BEGIN {
9e6fc21f 3 @INC = qw(lib);
ae5391ad 4
9e6fc21f
NC
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;
3301e5d1 11require File::Path;
354f3b56 12use ExtUtils::Packlist;
a2743834 13use Pod::Man;
d0265671 14use vars qw(%opts $packlist);
791b4ad3 15
d6a39ee2 16require './Porting/pod_lib.pl';
1cb2462d 17my %man1 = (map {($_->[0], $_->[1])} @{get_pod_metadata()->{master}});
d6a39ee2 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
GS
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
eabd589f 29 --notify --verbose --silent --help
16d20bd9
AD
30 Defaults are:
31 man1dir = $Config{'installman1dir'};
32 man1ext = $Config{'man1ext'};
33 man3dir = $Config{'installman3dir'};
34 man3ext = $Config{'man3ext'};
eabd589f
A
35 --notify (or -n) just lists commands that would be executed.
36 --verbose (or -V) report all progress.
37 --silent (or -S) be silent. Only report errors.\n";
16d20bd9 38
f0512cd0 39GetOptions( \%opts,
d0265671 40 qw( man1dir=s man1ext=s man3dir=s man3ext=s
ae5391ad 41 destdir:s notify n help silent S verbose V))
16d20bd9 42 || die $usage;
f0512cd0 43die $usage if $opts{help};
02bc0c09 44$opts{destdir} //= '';
16d20bd9 45
3cc5758c
NC
46foreach my $pre (qw(man1 man3)) {
47 $opts{"${pre}dir"} //= $opts{destdir} . $Config{"install${pre}dir"};
48 $opts{"${pre}ext"} //= $Config{"${pre}ext"};
49}
f0512cd0 50$opts{silent} ||= $opts{S};
f0512cd0 51$opts{notify} ||= $opts{n};
4ad019ef 52$opts{verbose} ||= $opts{V} || $opts{notify};
16d20bd9
AD
53
54#Sanity checks
55
ae5391ad 56-x "./perl$Config{exe_ext}"
cd8bccb5 57 or warn "./perl$Config{exe_ext} not found! Have you run make?\n";
5a9231b0 58-d "$opts{destdir}$Config{'installprivlib'}"
16d20bd9
AD
59 || warn "Perl library directory $Config{'installprivlib'} not found.
60 Have you run make install?. (Installing anyway.)\n";
cd8bccb5 61-x "t/perl$Config{exe_ext}" || warn "WARNING: You've never run 'make test'!!!",
16d20bd9
AD
62 " (Installing anyway.)\n";
63
1ef57a5c 64$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
354f3b56 65
16d20bd9 66# Install the main pod pages.
1cb2462d 67pod2man(\%man1, $opts{man1dir}, $opts{man1ext}, 'pod');
16d20bd9
AD
68
69# Install the pods for library modules.
45a365ec 70{
9bbb230a
NC
71 my $found = pods_to_install();
72 pod2man($found->{$_}, $opts{man3dir}, $opts{man3ext}, 'lib')
73 foreach qw(MODULE PRAGMA);
45a365ec 74}
16d20bd9 75
1fef88e7 76# Install the pods embedded in the installed scripts
bf1ee2ba 77my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
3301e5d1
NC
78my $fh = open_or_die('utils.lst');
79while (<$fh>) {
21dae8a0
SC
80 next if /^#/;
81 chomp;
b3e335c2 82 my ($path, $leaf) = m|^(\S*/(\S+))|;
e1aae8e4 83 # Have we already installed the manpage for this? (eg perldoc, a2p)
1cb2462d 84 next if $man1{$leaf};
b3e335c2 85 pod2man({$leaf, $path}, $opts{man1dir}, $opts{man1ext});
bf1ee2ba 86 if ($has_man1dir) {
b3e335c2
NC
87 if (my ($link) = m|#.*link\s*=\s*\S+/(\S+)|) {
88 my $old = "$opts{man1dir}/$leaf.$opts{man1ext}";
89 my $new = "$opts{man1dir}/$link.$opts{man1ext}";
bf1ee2ba
JH
90 unlink($new);
91 link($old, $new);
3301e5d1
NC
92 $old =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
93 $new =~ s/^\Q$opts{destdir}\E// if $opts{destdir};
94 $packlist->{$new} = { from => $old, type => 'link' };
bf1ee2ba 95 }
21dae8a0
SC
96 }
97}
3301e5d1 98close $fh or my_die("close 'utils.lst': $!");
1fef88e7 99
a2743834 100sub pod2man {
45a365ec 101 my($modpods, $mandir, $manext, $where) = @_;
16d20bd9 102 if ($mandir eq ' ' or $mandir eq '') {
45a365ec
NC
103 if ($where) {
104 warn "Skipping installation of $where man pages.\n"
105 } else {
b3e335c2 106 warn "Skipping installation of $_ man page.\n"
45a365ec
NC
107 foreach values %$modpods;
108 }
109 return;
16d20bd9
AD
110 }
111
b3e335c2 112 if ($opts{verbose}) {
45a365ec
NC
113 if ($where) {
114 print "installing from $where\n";
b3e335c2 115 } else {
45a365ec
NC
116 print "installing $_\n"
117 foreach sort keys %$modpods;
b3e335c2
NC
118 }
119 }
16d20bd9 120
3301e5d1 121 File::Path::mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};
b3e335c2 122
b3e335c2
NC
123 foreach my $manpage (sort keys %$modpods) {
124 my $mod = $modpods->{$manpage};
cd8bccb5 125
63fae907
AT
126 # Skip files without pod docs
127 my $has_pod;
3301e5d1
NC
128 my $fh = open_or_die($mod);
129 while (my $line = <$fh>) {
130 if ($line =~ /^=head1\b/) {
131 ++$has_pod;
132 last;
133 }
134 }
135 close $fh or my_die("close '$mod': $!");
136 # Sadly it doesn't seem possible to re-use this handle for the call
137 # to parse_from_file() below, as Pod::Man relies on source_filename(),
138 # which Pod::Simple only sets accurately if it opens the file itself.
63fae907
AT
139
140 unless ($has_pod)
141 {
142 warn "no documentation in $mod\n";
143 next;
144 }
145
4fabb596 146 if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
107ea3f3 147 $manpage =~ s#::#.#g;
cd8bccb5 148 }
d0265671 149 my $tmp = "${mandir}/${manpage}.tmp";
16d20bd9 150 $manpage = "${mandir}/${manpage}.${manext}";
a2743834 151
571afc3f
SP
152 my $parser = Pod::Man->new( section => $manext,
153 official=> 1,
154 center => 'Perl Programmers Reference Guide'
155 );
5a9231b0
MS
156 my $xmanpage = $manpage;
157 $xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
158 print " $xmanpage\n";
d0265671 159 if (!$opts{notify} && $parser->parse_from_file($mod, $tmp)) {
a2743834
MS
160 if (-s $tmp) {
161 if (rename($tmp, $manpage)) {
5a9231b0 162 $packlist->{$xmanpage} = { type => 'file' };
a2743834
MS
163 next;
164 }
165 }
166 unlink($tmp);
6d64b06f 167 }
16d20bd9 168 }
16d20bd9
AD
169}
170
f0512cd0
DC
171$packlist->write() unless $opts{notify};
172print " Installation complete\n" if $opts{verbose};
16d20bd9 173
cd8bccb5 174sub rename {
f0512cd0 175 my($from,$to) = @_;
55a105fd 176 if (-f $to and not unlink($to)) {
72b3d9b4
GS
177 my($i);
178 for ($i = 1; $i < 50; $i++) {
179 last if CORE::rename($to, "$to.$i");
180 }
19f4563d 181 warn("Cannot rename to '$to.$i': $!"), return 0
72b3d9b4 182 if $i >= 50; # Give up!
cd8bccb5 183 }
55a105fd
NC
184 link($from,$to) || return 0;
185 unlink($from);
16d20bd9 186}
5a6ebf5f
NC
187
188# Local variables:
189# cperl-indent-level: 4
190# indent-tabs-mode: nil
191# End:
192#
193# ex: set ts=8 sts=4 sw=4 et: