Chris Williams > Module-Install > Module::Install::Can

Download:
Module-Install-1.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  41
Open  27
Stalled  1
View/Report Bugs
Module Version: 1.10   Source  

NAME ^

Module::Install::Can - Utility functions for capability detection

DESCRIPTION ^

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.

COMMANDS ^

can_use

  can_use('Module::Name');
  can_use('Module::Name', 1.23);

The 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.

can_run

  can_run('cvs');

The 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.

can_cc

  can_cc();

The can_cc function tests the ability to locate a functioning 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.

can_xs

  can_xs();

The can_xs function tests for a functioning C compiler and the correct headers to build XS modules against the current instance of Perl.

TO DO ^

Currently, the use of a can_foo command in a single problem domain (for example can_use) results in the inclusion of additional functionality from different problem domains (for example can_run).

This module should ultimately be broken up, and the individual functions redistributed to different domain-specific extensions.

AUTHORS ^

Audrey Tang <autrijus@autrijus.org>

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

Module::Install, Class::Inspector

COPYRIGHT ^

Copyright 2006 - 2012 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 http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: