| 1 |
This is the README file for CPANPLUS, Ameliorated interface to |
| 2 |
the Comprehensive Perl Archive Network, by Jos Boumans. |
| 3 |
|
| 4 |
Please type "perldoc CPANPLUS" after installation to see the |
| 5 |
module usage information. For shell usage, please consult |
| 6 |
"perldoc cpanp"; the FAQ is available as "perldoc CPANPLUS::FAQ". |
| 7 |
|
| 8 |
You may also want to read the 'ChangeLog' file, which describes new |
| 9 |
features, bugfixes and additional notes for this release. |
| 10 |
|
| 11 |
################################################################### |
| 12 |
### |
| 13 |
### Installation |
| 14 |
### |
| 15 |
################################################################### |
| 16 |
|
| 17 |
CPANPLUS uses the standard perl module install process: |
| 18 |
|
| 19 |
$ perl Makefile.PL |
| 20 |
$ make # or 'nmake' on Windows |
| 21 |
$ make test |
| 22 |
$ make install |
| 23 |
|
| 24 |
After installation you can start CPANPLUS' interactive client |
| 25 |
by running one of the following commands: |
| 26 |
|
| 27 |
$ cpanp |
| 28 |
$ perl -MCPANPLUS -eshell |
| 29 |
|
| 30 |
CPANPLUS also ships a 'boxed' cpanp client, so you can run it |
| 31 |
out of it's extraction dir, by typing: |
| 32 |
|
| 33 |
$ perl bin/cpanp-boxed |
| 34 |
|
| 35 |
This may help you with bootstrap issues, or other situations |
| 36 |
where you need to use CPANPLUS but can not use a system installation. |
| 37 |
|
| 38 |
You can install all of CPANPLUS' dependencies like this, before |
| 39 |
installing CPANPLUS itself by running: |
| 40 |
|
| 41 |
$ perl bin/cpanp-boxed -s selfupdate dependencies |
| 42 |
|
| 43 |
All the modules bundled are found in the 'inc/bundle' directory. If |
| 44 |
you, for whatever reason, wish to not install these from cpan, you |
| 45 |
could include them into your environment as such (using tcsh): |
| 46 |
|
| 47 |
$ setenv PERL5LIB `pwd`/inc/bundle |
| 48 |
|
| 49 |
|
| 50 |
################################################################### |
| 51 |
### |
| 52 |
### Notes for windows users |
| 53 |
### |
| 54 |
################################################################### |
| 55 |
|
| 56 |
If you are using Microsoft Windows, you will probably need the 'nmake' |
| 57 |
utility before installation. It's available at: |
| 58 |
|
| 59 |
http://download.microsoft.com/download/vc15/Patch/1.52/W95/EN-US/nmake15.exe |
| 60 |
|
| 61 |
If you are connected to the internet, "perl Makefile.PL" is capable |
| 62 |
of automatically fetch it, and install into your Perl/bin directory. |
| 63 |
You will see a message like this: |
| 64 |
|
| 65 |
The required 'nmake' executable not found, fetching it... |
| 66 |
|
| 67 |
However, if you are not yet online, or wish to install 'nmake' into |
| 68 |
another directory, then please download the file manually, save it to |
| 69 |
a directory in %PATH (e.g. C:\WINDOWS\COMMAND), then launch the MS-DOS |
| 70 |
command line shell, "cd" to that directory, and run "nmake15.exe" from |
| 71 |
there; that will create the 'nmake.exe' file. |
| 72 |
|
| 73 |
You may then resume the installation process above, but replace 'make' |
| 74 |
with 'nmake' in the last three lines. |
| 75 |
|
| 76 |
|
| 77 |
################################################################### |
| 78 |
### |
| 79 |
### Notes on CPAN testing |
| 80 |
### |
| 81 |
################################################################### |
| 82 |
|
| 83 |
CPANPLUS offers several features to query and report module testing results. |
| 84 |
|
| 85 |
For example, typing "cpanp -c DBI" in the command line (or "c DBI" in |
| 86 |
the CPANPLUS default shell) will display the test results of latest |
| 87 |
DBI package. |
| 88 |
|
| 89 |
If you wish to report module test results as part of installation process, |
| 90 |
please answer "Y" to the 'Report tests results? [y/N]:' question during |
| 91 |
the interactive configuration. You can also type "s edit" in the CPANPLUS |
| 92 |
Default Shell to edit the config file manually, or just enter "s conf |
| 93 |
cpantest 1" and "s save" to save the settings. |
| 94 |
|
| 95 |
Please consult the CPAN Tester's Website (http://testers.cpan.org/) for |
| 96 |
detailed information. |
| 97 |
|
| 98 |
|
| 99 |
################################################################### |
| 100 |
### |
| 101 |
### Contact |
| 102 |
### |
| 103 |
################################################################### |
| 104 |
|
| 105 |
CPANPLUS has several mailing lists you can write to: |
| 106 |
|
| 107 |
- Questions/suggestions: <[email protected]> |
| 108 |
- Bug reporting: <[email protected]> |
| 109 |
|
| 110 |
################################################################### |
| 111 |
### |
| 112 |
### License |
| 113 |
### |
| 114 |
################################################################### |
| 115 |
|
| 116 |
Copyright 2001-2006 by Jos Boumans <[email protected]>. |
| 117 |
|
| 118 |
All rights reserved. You can redistribute and/or modify |
| 119 |
this bundle under the same terms as Perl itself. |
| 120 |
|
| 121 |
See <http://www.perl.com/perl/misc/Artistic.html>. |
| 122 |
|