Back to Top

NAME

Parse::CPAN::Modlist::Module - object representation of a single module in the 03modlist.data file

Back to Top

SYNOPSIS

    use Parse::CPAN::Modlist;

    my $p = Parse::CPAN::Modlist->new("t/data/03modlist.data");

    foreach my $name ($p->modules) {
        my $module = $p->module($name);
        print " The module '".$module->name."'".
              " is written by ".$module->author.
              " and is described as '".$module->description.
              "'\n";
    }

Back to Top

METHODS

The methods are automatically generated from the columns in 03modlist.data so it's possible that this documentation amy actually be wrong. Please let me know if this happens.

name

The name of this module (an alias to modid - the actual column name).

author

The author's CPAN id (an alias to userid - the actual column name).

description

A description of the module

chapter

The category that this module falls under (an alias to chapterid - the actual column name).

See http://www.cpan.org/modules/by-category/ for the categories.

Back to Top

DSLIP methods

DSLIP characters are intended to convey information about the current state of the module.

See http://www.cpan.org/modules/00modlist.long.html#ID1_ModuleListi for details

d - Development Stage (Note: *NO IMPLIED TIMESCALES*):

i

Idea, listed to gain consensus or as a placeholder

c

under construction but pre-alpha (not yet released)

a/b

Alpha/Beta testing

R

Released

M

Mature (no rigorous definition)

S

Standard, supplied with Perl 5

s - Support Level:

m

Mailing-list

d

Developer

u

Usenet newsgroup comp.lang.perl.modules

n

None known, try comp.lang.perl.modules

l - Language Used:

=over 4

p

Perl-only, no compiler needed, should be platform independent

c

C and perl, a C compiler will be needed

h

Hybrid, written in perl with optional C code, no compiler needed

+

C++ and perl, a C++ compiler will be needed

o

perl and another language other than C or C++

i - Interface Style

=over 4

f

plain Functions, no references used

h

hybrid, object and function interfaces available

n

no interface at all (huh?)

r

some use of unblessed References or ties

O

Object oriented using blessed references and/or inheritance

p - Public License

=over 4

p

Standard-Perl: user may choose between GPL and Artistic

g

GPL: GNU General Public License

l

LGPL: "GNU Lesser General Public License" (previously known as "GNU Library General Public License")

b

BSD: The BSD License

a

Artistic license alone

o

other (but distribution allowed without restrictions)

Back to Top

BUGS

None that I know of.

Back to Top

COPYING

Distributed under the same terms as Perl itself.

Back to Top

AUTHOR

Copyright (c) 2004,

Simon Wistow <simon@thegestalt.org>

Back to Top