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

COMMANDLINE TOOLS

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

FUNCTIONS

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

FAQ

103       For frequently asked questions and answers, please consult the
104       "CPANPLUS::FAQ" manual.
105

BUG REPORTS

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

AUTHOR

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

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

SEE ALSO

120       CPANPLUS::Shell::Default, CPANPLUS::FAQ, CPANPLUS::Backend,
121       CPANPLUS::Module, cpanp, cpan2dist
122

CONTACT INFORMATION

124       •   Bug reporting: bug-cpanplus@rt.cpan.org
125
126       •   Questions & suggestions: bug-cpanplus@rt.cpan.org
127
128
129
130perl v5.34.0                      2022-01-20                       CPANPLUS(3)
Impressum