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

NAME

6       CPANPLUS::Dist
7

SYNOPSIS

9           my $dist = CPANPLUS::Dist->new(
10                                       format  => 'build',
11                                       module  => $modobj,
12                                   );
13

DESCRIPTION

15       "CPANPLUS::Dist" is a base class for any type of "CPANPLUS::Dist::"
16       modules.
17

ACCESSORS

19       parent()
20           Returns the "CPANPLUS::Module" object that parented this object.
21
22       status()
23           Returns the "Object::Accessor" object that keeps the status for
24           this module.
25

STATUS ACCESSORS

27       All accessors can be accessed as follows:
28           $deb->status->ACCESSOR
29
30       created()
31           Boolean indicating whether the dist was created successfully.
32           Explicitly set to 0 when failed, so a value of "undef" may be
33           interpreted as "not yet attempted".
34
35       installed()
36           Boolean indicating whether the dist was installed successfully.
37           Explicitly set to 0 when failed, so a value of "undef" may be
38           interpreted as "not yet attempted".
39
40       uninstalled()
41           Boolean indicating whether the dist was uninstalled successfully.
42           Explicitly set to 0 when failed, so a value of "undef" may be
43           interpreted as "not yet attempted".
44
45       dist()
46           The location of the final distribution. This may be a file or
47           directory, depending on how your distribution plug in of choice
48           works. This will be set upon a successful create.
49
50       $dist = CPANPLUS::Dist->new( module => MODOBJ, [format => DIST_TYPE] );
51
52       Create a new "CPANPLUS::Dist" object based on the provided "MODOBJ".
53       The optional argument "format" is used to indicate what type of dist
54       you would like to create (like "makemaker" for a "CPANPLUS::Dist::MM"
55       object, "build" for a "CPANPLUS::Dist::Build" object, and so on ).  If
56       not provided, will default to the setting as specified by your config
57       "dist_type".
58
59       Returns a "CPANPLUS::Dist" object on success and false on failure.
60
61       @dists = CPANPLUS::Dist->dist_types;
62
63       Returns a list of the CPANPLUS::Dist::* classes available
64
65       prereq_satisfied( modobj => $modobj, version => $version_spec )
66
67       Returns true if this prereq is satisfied.  Returns false if it's not.
68       Also issues an error if it seems "unsatisfiable," i.e. if it can't be
69       found on CPAN or the latest CPAN version doesn't satisfy it.
70
71       _resolve_prereqs
72
73       Makes sure prerequisites are resolved
74
75       XXX Need docs, internal use only
76
77
78
79perl v5.8.8                       2007-03-31                 CPANPLUS::Dist(3)
Impressum