The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
CPANPLUS-0.036
River stage two • 35 direct dependents • 40 total dependents
13 ++
/ CPANPLUS

NAME

CPANPLUS - Command-line access to the CPAN interface

NOTICE

Please note that CPANPLUS is intended to eventually be a full drop-in replacement for CPAN.pm. However, in early releases you should NOT expect complete compatibility.

SYNOPSIS

Command line:

    perl -MCPANPLUS -e 'install Net::SMTP'

    perl -MCPANPLUS -e 'fetch /K/KA/KANE/Acme-POE-Knee-1.10.zip'
    perl -MCPANPLUS -e 'get /K/KA/KANE/Acme-POE-Knee-1.10.zip'

    perl -MCPANPLUS -e 'shell'
    /perl/bin/cpanp

Scripts:

    use CPANPLUS;
    # This use is not recommended; use
    # CPANPLUS::Backend instead!

    install('Net::SMTP');
    get('Acme::POE::Knee');

DESCRIPTION

CPANPLUS provides command-line access to the CPAN interface. Three functions, fetch, install and shell are imported in to your namespace. get--an alias for fetch--is also provided.

Although CPANPLUS can also be used within scripts, it is highly recommended that you use CPANPLUS::Backend in such situations. In addition to providing an OO interface, CPANPLUS::Backend is more efficient than CPANPLUS for multiple operations. CPANPLUS is provided primarily for the command-line, in order to be backwards compatible with CPAN.pm.

The first time you run CPANPLUS you should be prompted to adjust your settings, if you haven't already done so. Your settings will determine treatment of dependencies, handling of errors, and so on.

FUNCTIONS

install(NAME);

This function requires the full name of the module, which is case sensitive. The module name can also be provided as a fully qualified file name, beginning with a /, relative to the /authors/id directory on a CPAN mirror.

It will download, extract and install the module.

fetch(NAME);

Like install, fetch needs the full name of a module or the fully qualified file name, and is case sensitive.

It will download the specified module to the current directory.

get(NAME);

Get is provided as an alias for fetch for compatibility with CPAN.pm.

shell

Shell starts the default CPAN shell. You can also start the shell by using the cpanp command, which will be installed in your perl bin.

See CPANPLUS::Shell::Default for instructions on using the default shell. Note that if you have changed your default shell in your configuration, that shell will be used instead.

The default shell is only designed to be used on the command-line; its use in a script is completely unsupported.

AUTHORS

This module by Jos Boumans <kane@cpan.org>.

This pod text by Ann Barcomb <kudra@cpan.org>.

COPYRIGHT

The CPAN++ interface (of which this module is a part of) is copyright (c) 2001, 2002 Jos Boumans <kane@cpan.org>. All rights reserved.

This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.

ACKNOWLEDGMENTS

Please see the AUTHORS file in the CPANPLUS distribution for a list of Credits and Contributors.

SEE ALSO

CPANPLUS::Backend, CPANPLUS::Shell::Default