NAME
Module.pm - Module tree for CPAN++
DESCRIPTION
Module.pm is a module used internally to store information about CPAN modules.
METHODS
Because the only Module objects that should be used are returned by Backend methods, Module methods are documented in CPANPLUS::Backend under the function module_tree.
OBJECT
Here is a sample dump of the module object for Acme::Buffy:
'Acme::Buffy' => bless( {
'path' => 'L/LB/LBROCARD',
'description' => 'An encoding scheme for Buffy fans',
'dslip' => 'Rdph',
'status' => '',
'prereqs' => {},
'module' => 'Acme::Buffy',
'comment' => '',
'author' => 'LBROCARD',
'_id' => 6,
'package' => 'Acme-Buffy-1.2.tar.gz',
'version' => 'undef'
}, 'CPANPLUS::Internals::Module' )The module object contains the following information:
author
The CPAN identification for the module author.
comment
This is any comment which appears in the source files; it is largely unused.
description
The description of the module.
dslip
Information on development stage, support level, language used, interface style and public license.
The dslip consists of single-letter codes which can be expanded with the details method from either Backend or Modules, both of which are documented in CPANPLUS::Backend.
module
The name of the module.
package
The file name of the module on CPAN.
path
The path of the module on CPAN, starting from the CPAN author id directory. For example, if a module was found in /pub/mirror/CPAN/authors/id/I/IR/IROBERTS/Crypt-OpenSSL-RSA-0.12.tar.gz the value for path would be just I/IR/IROBERTS.
prereqs
Currently not in use.
status
Currently not in use.
version The version of the module.
_id
An internal identification number.
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.