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