/ 
CPANPLUS-0.01
River stage two • 35 direct dependents • 40 total dependents
/ CPANPLUS::Shell::Default

NAME

CPANPLUS::Shell::Default - Default command-line interface for CPAN++

SYNOPSIS

To begin use one of these two commands. This will start your default shell, which, unless you modified it in your configuration, will be CPANPLUS::Shell::Default.

cpanp

perl -MCPANPLUS -e 'shell'

Shell commands:

CPAN Terminal>h

CPAN Terminal>s verbose 1
CPAN Terminal>e /home/kudra/perllib

CPAN Terminal>m simple tcp
CPAN Terminal>i 22 27 /K/KA/KANE/Acme-POE-Knee-1.10.zip

CPAN Terminal>a damian

CPAN Terminal>d XML::Twig

CPAN Terminal>l DBD::Unify

CPAN Terminal>f VROO?MANS$ DCROSS

CPAN Terminal>p /tmp/cpanplus/errors

CPAN Terminal>q

DESCRIPTION

CPANPLUS::Default::Shell is the default interactive shell for CPAN++. If command-line interaction isn't desired, use CPANPLUS::Backend instead.

You can also use CPANPLUS::Backend to create your own shell if this one doesn't suit your tastes.

COMMANDS

h|?

Help lists available commands and is also the default output if no valid command was given.

q

Quit exits the interactive shell.

m MODULE [MODULE]

This command performs a case-insensitive match for a module or modules. Either a string or a tailored regular expression can be used. For example:

  • m poe

    This will search for modules matching the regular expression /poe/i.

  • m poe acme

    This will search for modules matching /(poe)|(acme)/i.

  • m ^acme::.*

    This search would look for all Acme submodules.

The list of matching modules will be printed in four columns. For example:

0001    Acme::Pony    1.1     DCANTRELL
0002    Acme::DWIM    1.05    DCONWAY

These columns correspond to the assigned number, module name, version number and CPAN author identification. Assigned numbers can be used for a subsequent commands but are reassigned for each search. If no module version is listed, the third field will be undef.

a AUTHOR [AUTHOR]

The author command performs a case-insensitive search for an author or authors. A string or a regular expression may be specified; both CPAN author identifications and full names will be searched. For example:

  • a ingy bergman

  • a ^michael

This command gives the same output format as the module command. Sometimes the output may not be what you expected. For instance, if you searched for jos, the following listing would be included:

0001    Acme::POE::Knee    1.02    KANE

This is because while the CPAN author identification doesn't contain the string, it is found in the module author's full name (in this case, Jos Boumans). There is currently no command to display the author's full name.

i MODULE|NUMBER|FILENAME

This command installs a module by its case-sensitive name, by the path and filename on CPAN, or by the number returned from a previous search. For instance:

  • i CGI::FormBuilder

  • i /K/KA/KANE/Acme-POE-Knee-1.10.zip

  • i 16

    This example would install result 0016 from the previous match.

Install will search, fetch, extract and make the module.

d MODULE|NUMBER [MODULE|NUMBER]

This command will download the module or modules in the current directory. It is case sensitive. Like install, it can also accept a fully qualified file name from a CPAN mirror, relative to the /authors/id directory. All file names should begin with a /.

  • d CGI::FormBuilder

  • d /K/KA/KANE/Acme-POE-Knee-1.10.zip

e DIRECTORY [DIRECTORY]

This command adds directories to your @INC. CPAN++ will check to see if modules are already installed on your system, so if there is a custom library directory it should be specified. Examples:

  • e /home/ann/perl/lib

  • e 'C:\Perl Lib' C:\kane

l MODULE|NUMBER [MODULE|NUMBER]

This command lists detailed information about a module.

  • l Net::FTP

Example output from the list command:

Details for Net::FTP:
Description          Interface to File Transfer Protocol
Development Stage    Alpha testing
Interface Style      plain Functions, no references used
Language Used        Perl-only, no compiler needed
Package              libnet-1.09.tar.gz
Support Level        Developer
Version              2.61

f AUTHOR [AUTHOR]

This command gives a listing of distribution files by the author or authors specified. It accepts a case-insensitive regular expression.

  • f ^KANE$

Output from the previous command would look like this:

KANE         12230        Acme-POE-Knee-1.00.zip
KANE         14246        Acme-POE-Knee-1.01.zip
KANE         12324        Acme-POE-Knee-1.02.zip
KANE         6625         Acme-POE-Knee-1.10.zip

The first column is the CPAN author id, the second column is the filesize, and the third is the name of the distribution.

s OPTION VALUE

The set command can be used to override configuration settings for the current session. Available options:

  • debug 0|1

    Disable or enable debugging mode.

  • flush 0|1

    Flush will automatically flush the cache if enabled.

  • force 0|1

    If enabled, modules which fail make test will be forced to attempt installation.

  • makeflags FLAG [FLAG]

    Add flags to the make command. For example, /C on win32.

  • makemakerflags FLAG [FLAG]

    Add flags to the perl Makefile.PL command.

  • md5 0|1

    Disable or enable md5 checks.

  • prereqs 0|1|2

    Zero disallows prerequisites, 1 allows them, and 2 offers a decision prompt for each prerequisite.

  • storable 0|1

    Set to 1 to use storable.

  • verbose 0|1

    Suppress or inform of messages about actions being taken.

  • lib DIR [DIR]

    Allows directories to be added and used as 'use lib.'

p [FILE]

This allows the printing of stored errors, either to standard out or the specified file.

It is useful to include this output when reporting a bug.

AUTHORS

This module by Jos Boumans <kane@cpan.org> and Joshua Boschert <jambe@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

Andreas Koenig <andreas.koenig@anima.de> authored the original CPAN.pm module.

SEE ALSO

CPANPLUS::Backend, CPANPLUS