1 package ExtUtils::Command::MM;
7 use vars qw($VERSION @ISA @EXPORT);
10 @EXPORT = qw(test_harness pod2man perllocal_install uninstall
11 warn_if_old_packlist);
14 my $Is_VMS = $^O eq 'VMS';
19 ExtUtils::Command::MM - Commands for the MM's to use in Makefiles
23 perl "-MExtUtils::Command::MM" -e "function" "--" arguments...
28 B<FOR INTERNAL USE ONLY!> The interface is not stable.
30 ExtUtils::Command::MM encapsulates code which would otherwise have to
31 be done with large "one" liners.
33 Any $(FOO) used in the examples are make variables, not Perl.
39 test_harness($verbose, @test_libs);
41 Runs the tests on @ARGV via Test::Harness passing through the $verbose
42 flag. Any @test_libs will be unshifted onto the test's @INC.
44 @test_libs are run in alphabetical order.
49 require Test::Harness;
52 $Test::Harness::verbose = shift;
54 # Because Windows doesn't do this for us and listing all the *.t files
55 # out on the command line can blow over its exec limit.
56 require ExtUtils::Command;
57 my @argv = ExtUtils::Command::expand_wildcards(@ARGV);
60 unshift @INC, map { File::Spec->rel2abs($_) } @_;
61 Test::Harness::runtests(sort { lc $a cmp lc $b } @argv);
68 pod2man( '--option=value',
69 $podfile1 => $manpage1,
70 $podfile2 => $manpage2,
76 pod2man() is a function performing most of the duties of the pod2man
77 program. Its arguments are exactly the same as pod2man as of 5.8.0
80 --perm_rw octal permission to set the resulting manpage to
87 If no arguments are given to pod2man it will read from @ARGV.
97 # We will cheat and just use Getopt::Long. We fool it by putting
98 # our arguments into @ARGV. Should be safe.
99 local @ARGV = @_ ? @_ : @ARGV;
100 Getopt::Long::config ('bundling_override');
101 Getopt::Long::GetOptions (\%options,
102 'section|s=s', 'release|r=s', 'center|c=s',
103 'date|d=s', 'fixed=s', 'fixedbold=s', 'fixeditalic=s',
104 'fixedbolditalic=s', 'official|o', 'quotes|q=s', 'lax|l',
105 'name|n=s', 'perm_rw:i'
108 # If there's no files, don't bother going further.
109 return 0 unless @ARGV;
111 # Official sets --center, but don't override things explicitly set.
112 if ($options{official} && !defined $options{center}) {
113 $options{center} = q[Perl Programmer's Reference Guide];
116 # This isn't a valid Pod::Man option and is only accepted for backwards
118 delete $options{lax};
120 my $parser = Pod::Man->new(%options);
122 do {{ # so 'next' works
123 my ($pod, $man) = splice(@ARGV, 0, 2);
125 next if ((-e $man) &&
126 (-M $man < -M $pod) &&
127 (-M $man < -M "Makefile"));
129 print "Manifying $man\n";
131 $parser->parse_from_file($pod, $man)
132 or do { warn("Could not install $man\n"); next };
134 if (length $options{perm_rw}) {
135 chmod(oct($options{perm_rw}), $man)
136 or do { warn("chmod $options{perm_rw} $man: $!\n"); next };
144 =item B<warn_if_old_packlist>
146 perl "-MExtUtils::Command::MM" -e warn_if_old_packlist <somefile>
148 Displays a warning that an old packlist file was found. Reads the
153 sub warn_if_old_packlist {
154 my $packlist = $ARGV[0];
156 return unless -f $packlist;
157 print <<"PACKLIST_WARNING";
158 WARNING: I have found an old package in
160 Please make sure the two installations are not conflicting
166 =item B<perllocal_install>
168 perl "-MExtUtils::Command::MM" -e perllocal_install
169 <type> <module name> <key> <value> ...
171 # VMS only, key|value pairs come on STDIN
172 perl "-MExtUtils::Command::MM" -e perllocal_install
173 <type> <module name> < <key>|<value> ...
175 Prints a fragment of POD suitable for appending to perllocal.pod.
176 Arguments are read from @ARGV.
178 'type' is the type of what you're installing. Usually 'Module'.
180 'module name' is simply the name of your module. (Foo::Bar)
182 Key/value pairs are extra information about the module. Fields include:
184 installed into which directory your module was out into
185 LINKTYPE dynamic or static linking
186 VERSION module version number
187 EXE_FILES any executables installed in a space seperated
192 sub perllocal_install {
193 my($type, $name) = splice(@ARGV, 0, 2);
195 # VMS feeds args as a piped file on STDIN since it usually can't
196 # fit all the args on a single command line.
197 @ARGV = split /\|/, <STDIN> if $Is_VMS;
200 $pod = sprintf <<POD, scalar localtime;
201 =head2 %s: C<$type> L<$name|$name>
208 my($key, $val) = splice(@ARGV, 0, 2);
228 perl "-MExtUtils::Command::MM" -e uninstall <packlist>
230 A wrapper around ExtUtils::Install::uninstall(). Warns that
231 uninstallation is deprecated and doesn't actually perform the
237 my($packlist) = shift @ARGV;
239 require ExtUtils::Install;
243 Uninstall is unsafe and deprecated, the uninstallation was not performed.
244 We will show what would have been done.
248 ExtUtils::Install::uninstall($packlist, 1, 1);
252 Uninstall is unsafe and deprecated, the uninstallation was not performed.
253 Please check the list above carefully, there may be errors.
254 Remove the appropriate files manually.
255 Sorry for the inconvenience.