1CPANPLUS(3)           User Contributed Perl Documentation          CPANPLUS(3)
2
3
4

NAME

6       CPANPLUS - API & CLI access to the CPAN mirrors
7

SYNOPSIS

9           ### standard invocation from the command line
10           $ cpanp
11           $ cpanp -i Some::Module
12
13           $ perl -MCPANPLUS -eshell
14           $ perl -MCPANPLUS -e'fetch Some::Module'
15

DESCRIPTION

17       The "CPANPLUS" library is an API to the "CPAN" mirrors and a collection
18       of interactive shells, commandline programs, etc, that use this API.
19

GUIDE TO DOCUMENTATION

21       GENERAL USAGE
22
23       This is the document you are currently reading. It describes basic
24       usage and background information. Its main purpose is to assist the
25       user who wants to learn how to invoke CPANPLUS and install modules from
26       the commandline and to point you to more indepth reading if required.
27
28       API REFERENCE
29
30       The "CPANPLUS" API is meant to let you programmatically interact with
31       the "CPAN" mirrors. The documentation in CPANPLUS::Backend shows you
32       how to create an object capable of interacting with those mirrors, let‐
33       ting you create & retrieve module objects.  CPANPLUS::Module shows you
34       how you can use these module objects to perform actions like installing
35       and testing.
36
37       The default shell, documented in CPANPLUS::Shell::Default is also
38       scriptable. You can use its API to dispatch calls from your script to
39       the CPANPLUS Shell.
40

COMMANDLINE TOOLS

42       STARTING AN INTERACTIVE SHELL
43
44       You can start an interactive shell by running either of the two follow‐
45       ing commands:
46
47           $ cpanp
48
49           $ perl -MCPANPLUS -eshell
50
51       All commans available are listed in the interactive shells help menu.
52       See "cpanp -h" or CPANPLUS::Shell::Default for instructions on using
53       the default shell.
54
55       CHOOSE A SHELL
56
57       By running "cpanp" without arguments, you will start up the shell spec‐
58       ified in your config, which defaults to CPANPLUS::Shell::Default. There
59       are more shells available.  "CPANPLUS" itself ships with an emulation
60       shell called CPANPLUS::Shell::Classic that looks and feels just like
61       the old "CPAN.pm" shell.
62
63       You can start this shell by typing:
64
65           $ perl -MCPANPLUS -e'shell Classic'
66
67       Even more shells may be available from "CPAN".
68
69       Note that if you have changed your default shell in your configuration,
70       that shell will be used instead. If for some reason there was an error
71       with your specified shell, you will be given the default shell.
72
73       BUILDING PACKAGES
74
75       "cpan2dist" is a commandline tool to convert any distribution from
76       "CPAN" into a package in the format of your choice, like for example
77       ".deb" or "FreeBSD ports".
78
79       See "cpan2dist -h" for details.
80

FUNCTIONS

82       For quick access to common commands, you may use this module, "CPAN‐
83       PLUS" rather than the full programmatic API situated in "CPAN‐
84       PLUS::Backend". This module offers the following functions:
85
86       $bool = install( Module::Name ⎪ /A/AU/AUTHOR/Module-Name-1.tgz )
87
88       This function requires the full name of the module, which is case sen‐
89       sitive.  The module name can also be provided as a fully qualified file
90       name, beginning with a /, relative to the /authors/id directory on a
91       CPAN mirror.
92
93       It will download, extract and install the module.
94
95       $where = fetch( Module::Name ⎪ /A/AU/AUTHOR/Module-Name-1.tgz )
96
97       Like install, fetch needs the full name of a module or the fully quali‐
98       fied file name, and is case sensitive.
99
100       It will download the specified module to the current directory.
101
102       $where = get( Module::Name ⎪ /A/AU/AUTHOR/Module-Name-1.tgz )
103
104       Get is provided as an alias for fetch for compatibility with CPAN.pm.
105
106       shell()
107
108       Shell starts the default CPAN shell.  You can also start the shell by
109       using the "cpanp" command, which will be installed in your perl bin.
110

FAQ

112       For frequently asked questions and answers, please consult the "CPAN‐
113       PLUS::FAQ" manual.
114

BUG REPORTS

116       Please report bugs or other issues to <bug-cpanplus@rt.cpan.org<gt>.
117

AUTHOR

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

122       The CPAN++ interface (of which this module is a part of) is copyright
123       (c) 2001 - 2007, Jos Boumans <kane@cpan.org>. All rights reserved.
124
125       This library is free software; you may redistribute and/or modify it
126       under the same terms as Perl itself.
127

SEE ALSO

129       CPANPLUS::Shell::Default, CPANPLUS::FAQ, CPANPLUS::Backend, CPAN‐
130       PLUS::Module, cpanp, cpan2dist
131

CONTACT INFORMATION

133       * Bug reporting: bug-cpanplus@rt.cpan.org
134       * Questions & suggestions: cpanplus-devel@lists.sourceforge.net
135
136
137
138perl v5.8.8                       2007-03-31                       CPANPLUS(3)
Impressum