xref: /openbsd/gnu/usr.bin/perl/installman (revision 3d8817e4) 
1#!./perl -w
2BEGIN {
3    @INC = qw(lib);
4
5    # This needs to be at BEGIN time, before any use of Config
6    require './install_lib.pl';
7}
8use strict;
9
10use Getopt::Long;
11use File::Find;
12use File::Copy;
13use File::Path qw(mkpath);
14use ExtUtils::Packlist;
15use Pod::Man;
16use vars qw($Is_VMS $Is_W32 $Is_OS2 $Is_Cygwin $Is_Darwin $Is_NetWare
17	    %opts $packlist);
18
19$ENV{SHELL} = 'sh' if $^O eq 'os2';
20
21my $patchlevel = substr($],3,2);
22die "Patchlevel of perl ($patchlevel)",
23    "and patchlevel of config.sh ($Config{'PERL_VERSION'}) don't match\n"
24	if $patchlevel != $Config{'PERL_VERSION'};
25
26my $usage =
27"Usage:  installman --man1dir=/usr/wherever --man1ext=1
28                   --man3dir=/usr/wherever --man3ext=3
29		   --batchlimit=40
30	           --notify --verbose --silent --help
31	Defaults are:
32	man1dir = $Config{'installman1dir'};
33	man1ext = $Config{'man1ext'};
34	man3dir = $Config{'installman3dir'};
35	man3ext = $Config{'man3ext'};
36	--notify  (or -n) just lists commands that would be executed.
37        --verbose (or -V) report all progress.
38        --silent  (or -S) be silent. Only report errors.\n";
39
40GetOptions( \%opts,
41            qw( man1dir=s man1ext=s man3dir=s man3ext=s batchlimit=i
42                destdir:s notify n help silent S verbose V))
43	|| die $usage;
44die $usage if $opts{help};
45$opts{destdir} //= '';
46
47foreach my $pre (qw(man1 man3)) {
48    $opts{"${pre}dir"} //= $opts{destdir} . $Config{"install${pre}dir"};
49    $opts{"${pre}ext"} //= $Config{"${pre}ext"};
50}
51$opts{silent} ||= $opts{S};
52$opts{notify} ||= $opts{n};
53$opts{verbose} ||= $opts{V} || $opts{notify};
54
55#Sanity checks
56
57-x  "./perl$Config{exe_ext}"
58  or warn "./perl$Config{exe_ext} not found!  Have you run make?\n";
59-d  "$opts{destdir}$Config{'installprivlib'}"
60	|| warn "Perl library directory $Config{'installprivlib'} not found.
61		Have you run make install?.  (Installing anyway.)\n";
62-x "t/perl$Config{exe_ext}"		|| warn "WARNING: You've never run 'make test'!!!",
63	"  (Installing anyway.)\n";
64
65$packlist = ExtUtils::Packlist->new("$opts{destdir}$Config{installarchlib}/.packlist");
66
67
68# Install the main pod pages.
69pod2man('pod', $opts{man1dir}, $opts{man1ext});
70
71# Install the pods for library modules.
72pod2man('lib', $opts{man3dir}, $opts{man3ext});
73
74# Install the pods embedded in the installed scripts
75my $has_man1dir = $opts{man1dir} ne '' && -d $opts{man1dir};
76open UTILS, "utils.lst" or die "Can't open 'utils.lst': $!";
77while (<UTILS>) {
78    next if /^#/;
79    chomp;
80    $_ = $1 if /#.*pod\s*=\s*(\S+)/;
81    my ($where, $what) = m|^(\S*)/(\S+)|;
82    pod2man($where, $opts{man1dir}, $opts{man1ext}, $what);
83    if ($has_man1dir) {
84	if (my ($where2, $what2) = m|#.*link\s*=\s*(\S+)/(\S+)|) {
85	    my $old = "$opts{man1dir}/$what.$opts{man1ext}";
86	    my $new = "$opts{man1dir}/$what2.$opts{man1ext}";
87	    unlink($new);
88	    link($old, $new);
89	    my $xold = $old;
90	    $xold =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
91	    my $xnew = $new;
92	    $xnew =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
93	    $packlist->{$xnew} = { from => $xold, type => 'link' };
94	}
95    }
96}
97
98sub pod2man {
99    # @script is scripts names if we are installing manpages embedded
100    # in scripts, () otherwise
101    my($poddir, $mandir, $manext, @script) = @_;
102    if ($mandir eq ' ' or $mandir eq '') {
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	}
109	return;
110    }
111
112    print "installing from $poddir\n" if $opts{verbose};
113
114    mkpath($mandir, $opts{verbose}, 0777) unless $opts{notify};  # In File::Path
115    # Make a list of all the .pm and .pod files in the directory.  We avoid
116    # chdir because we are running with @INC = '../lib', and modules may wish
117    # to dynamically require Carp::Heavy or other diagnostics warnings.
118    # Hash the names of files we find, keys are names relative to perl build
119    # dir ('.'), values are names relative to $poddir.
120    my %modpods;
121    if (@script) {
122	%modpods = (map {+"$poddir/$_", $_} @script);
123    }
124    else {
125	File::Find::find({no_chdir=>1,
126                          wanted => sub {
127                              # $_ is $File::Find::name when using no_chdir
128                              if (-f $_ and /\.p(?:m|od)$/) {
129                                  my $fullname = $_;
130                                  s!^\Q$poddir\E/!!;
131                                  $modpods{$fullname} = $_;
132                              }
133                          }},
134                         $poddir);
135    }
136    my @to_process;
137    foreach my $mod (sort keys %modpods) {
138        my $manpage = $modpods{$mod};
139	my $tmp;
140	# Skip .pm files that have corresponding .pod files, and Functions.pm.
141	next if (($tmp = $mod) =~ s/\.pm$/.pod/ && -f $tmp);
142	next if $mod =~ m:/t/:; # no pods from test directories
143	next if ($manpage eq 'Pod/Functions.pm'); #### Used only by pod itself
144
145	# Skip files without pod docs
146	my $has_pod;
147	if (open T, $mod)
148	{
149	    local $_;
150	    while (<T>)
151	    {
152		++$has_pod and last if /^=(?:head\d+|item|pod)\b/;
153	    }
154
155	    close T;
156	}
157
158	unless ($has_pod)
159	{
160	    warn "no documentation in $mod\n";
161	    next;
162	}
163
164	# Convert name from  File/Basename.pm to File::Basename.3 format,
165	# if necessary.
166	$manpage =~ s#\.p(m|od)$##;
167	if ($^O eq 'os2' || $^O eq 'amigaos' || $^O eq 'uwin' || $^O eq 'cygwin') {
168	  $manpage =~ s#/#.#g;
169	}
170	else {
171	  $manpage =~ s#/#::#g;
172	}
173	$tmp = "${mandir}/${manpage}.tmp";
174	$manpage = "${mandir}/${manpage}.${manext}";
175	push @to_process, [$mod, $tmp, $manpage];
176    }
177
178    foreach my $page (@to_process) {
179	my($pod, $tmp, $manpage) = @$page;
180
181        my $parser = Pod::Man->new( section => $manext,
182                                    official=> 1,
183                                    center  => 'Perl Programmers Reference Guide'
184                                  );
185	my $xmanpage = $manpage;
186	$xmanpage =~ s/^\Q$opts{'destdir'}\E// if $opts{'destdir'};
187        print "  $xmanpage\n";
188	if (!$opts{notify} && $parser->parse_from_file($pod, $tmp)) {
189            if (-s $tmp) {
190                if (rename($tmp, $manpage)) {
191                    $packlist->{$xmanpage} = { type => 'file' };
192                    next;
193                }
194            }
195            unlink($tmp);
196	}
197    }
198}
199
200$packlist->write() unless $opts{notify};
201print "  Installation complete\n" if $opts{verbose};
202
203exit 0;
204
205sub rename {
206    my($from,$to) = @_;
207    if (-f $to and not unlink($to)) {
208	my($i);
209	for ($i = 1; $i < 50; $i++) {
210	    last if CORE::rename($to, "$to.$i");
211	}
212	warn("Cannot rename to `$to.$i': $!"), return 0
213	    if $i >= 50;	# Give up!
214    }
215    link($from,$to) || return 0;
216    unlink($from);
217}
218