r8619@datura: manu | 2008-05-05 16:49:49 +0200

[manu/RT-Extension-SearchResults-XLS.git] / inc / Module / Install / Can.pm

diff --git a/inc/Module/Install/Can.pm b/inc/Module/Install/Can.pm
index 1c01e22..002869f 100644 (file)
--- a/inc/Module/Install/Can.pm
+++ b/inc/Module/Install/Can.pm
@@ -1,4 +1,3 @@
-#line 1
 package Module::Install::Can;
 
 use strict;
@@ -11,7 +10,7 @@ use ExtUtils::MakeMaker ();
 
 use vars qw{$VERSION $ISCORE @ISA};
 BEGIN {
-       $VERSION = '0.64';
+       $VERSION = '0.72';
        $ISCORE  = 1;
        @ISA     = qw{Module::Install::Base};
 }
@@ -79,4 +78,80 @@ if ( $^O eq 'cygwin' ) {
 
 __END__
 
-#line 157
+=pod
+
+=head1 NAME
+
+Module::Install::Can - Utility functions for capability detection
+
+=head1 DESCRIPTION
+
+C<Module::Install::Can> contains a number of functions for authors to use
+when creating customised smarter installers. The functions simplify
+standard tests so that you can express your dependencies and conditions
+much more simply, and make your installer much easier to maintain.
+
+=head1 COMMANDS
+
+=head2 can_use
+
+  can_use('Module::Name');
+  can_use('Module::Name', 1.23);
+
+The C<can_use> function tests the ability to load a specific named
+module. Currently it will also actually load the module in the
+process, although this may change in the future.
+
+Takes an optional second param of a version number. The currently
+installed version of the module will be tested to make sure it is
+equal to or greater than the specified version.
+
+Returns true if the module can be loaded, or false (in both scalar or
+list context) if not.
+
+=head2 can_run
+
+  can_run('cvs');
+
+The C<can_run> function tests the ability to run a named command or
+program on the local system.
+
+Returns true if so, or false (both in scalar and list context) if not.
+
+=head2 can_cc
+
+  can_cc();
+
+The C<can_cc> function test the ability to locate a C compiler on the
+local system. Returns true if the C compiler can be found, or false
+(both in scalar and list context) if not.
+
+=head1 TO DO
+
+Currently, the use of a C<can_foo> command in a single problem domain
+(for example C<can_use>) results in the inclusion of additional
+functionality from different problem domains (for example C<can_run>).
+
+This module should ultimately be broken up, and the individual
+functions redestributed to different domain-specific extensions.
+
+=head1 AUTHORS
+
+Audrey Tang E<lt>autrijus@autrijus.orgE<gt>
+
+Adam Kennedy E<lt>adamk@cpan.orgE<gt>
+
+=head1 SEE ALSO
+
+L<Module::Install>, L<Class::Inspector>
+
+=head1 COPYRIGHT
+
+Copyright 2006 Audrey Tang, Adam Kennedy.
+
+This program is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+
+See L<http://www.perl.com/perl/misc/Artistic.html>
+
+=cut