1CPANPLUS::Dist::Build(3U)ser Contributed Perl DocumentatiCoPnANPLUS::Dist::Build(3)
2
3
4

NAME

6       CPANPLUS::Dist::Build - CPANPLUS plugin to install packages that use
7       Build.PL
8

VERSION

10       version 0.90
11

SYNOPSIS

13           my $build = CPANPLUS::Dist->new(
14                                       format  => 'CPANPLUS::Dist::Build',
15                                       module  => $modobj,
16                                   );
17
18           $build->prepare;    # runs Build.PL
19           $build->create;     # runs build && build test
20           $build->install;    # runs build install
21

DESCRIPTION

23       "CPANPLUS::Dist::Build" is a distribution class for "Module::Build"
24       related modules.  Using this package, you can create, install and
25       uninstall perl modules. It inherits from "CPANPLUS::Dist".
26
27       Normal users won't have to worry about the interface to this module, as
28       it functions transparently as a plug-in to "CPANPLUS" and will just "Do
29       The Right Thing" when it's loaded.
30

ACCESSORS

32       "parent()"
33           Returns the "CPANPLUS::Module" object that parented this object.
34
35       "status()"
36           Returns the "Object::Accessor" object that keeps the status for
37           this module.
38

STATUS ACCESSORS

40       All accessors can be accessed as follows:
41           $build->status->ACCESSOR
42
43       "build_pl ()"
44           Location of the Build file.  Set to 0 explicitly if something went
45           wrong.
46
47       "build ()"
48           BOOL indicating if the "Build" command was successful.
49
50       "test ()"
51           BOOL indicating if the "Build test" command was successful.
52
53       "prepared ()"
54           BOOL indicating if the "prepare" call exited successfully This gets
55           set after "perl Build.PL"
56
57       "distdir ()"
58           Full path to the directory in which the "prepare" call took place,
59           set after a call to "prepare".
60
61       "created ()"
62           BOOL indicating if the "create" call exited successfully. This gets
63           set after "Build" and "Build test".
64
65       "installed ()"
66           BOOL indicating if the module was installed. This gets set after
67           "Build install" exits successfully.
68
69       uninstalled ()
70           BOOL indicating if the module was uninstalled properly.
71
72       "_create_args ()"
73           Storage of the arguments passed to "create" for this object. Used
74           for recursive calls when satisfying prerequisites.
75
76       "_install_args ()"
77           Storage of the arguments passed to "install" for this object. Used
78           for recursive calls when satisfying prerequisites.
79

METHODS

81   $bool = CPANPLUS::Dist::Build->format_available();
82       Returns a boolean indicating whether or not you can use this package to
83       create and install modules in your environment.
84
85   $bool = $dist->init();
86       Sets up the "CPANPLUS::Dist::Build" object for use.  Effectively
87       creates all the needed status accessors.
88
89       Called automatically whenever you create a new "CPANPLUS::Dist" object.
90
91   $bool = $dist->prepare([perl => '/path/to/perl', buildflags =>
92       'EXTRA=FLAGS', force => BOOL, verbose => BOOL])
93       "prepare" prepares a distribution, running "Build.PL" and establishing
94       any prerequisites this distribution has.
95
96       The variable "PERL5_CPANPLUS_IS_EXECUTING" will be set to the full path
97       of the "Build.PL" that is being executed. This enables any code inside
98       the "Build.PL" to know that it is being installed via CPANPLUS.
99
100       After a successful "prepare" you may call "create" to create the
101       distribution, followed by "install" to actually install it.
102
103       Returns true on success and false on failure.
104
105   $dist->create([perl => '/path/to/perl', buildflags => 'EXTRA=FLAGS',
106       prereq_target => TARGET, force => BOOL, verbose => BOOL, skiptest =>
107       BOOL])
108       "create" preps a distribution for installation. This means it will run
109       "Build" and "Build test".  This will also satisfy any prerequisites the
110       module may have.
111
112       If you set "skiptest" to true, it will skip the "Build test" stage.  If
113       you set "force" to true, it will go over all the stages of the "Build"
114       process again, ignoring any previously cached results. It will also
115       ignore a bad return value from "Build test" and still allow the
116       operation to return true.
117
118       Returns true on success and false on failure.
119
120       You may then call "$dist->install" on the object to actually install
121       it.
122
123   $dist->install([verbose => BOOL, perl => /path/to/perl])
124       Actually installs the created dist.
125
126       Returns true on success and false on failure.
127

PROMINENCE

129       Originally by Jos Boumans <kane@cpan.org>.  Brought to working
130       condition by Ken Williams <kwilliams@cpan.org>.
131
132       Other hackery and currently maintained by Chris "BinGOs" Williams ( no
133       relation ). <bingos@cpan.org>.
134

AUTHOR

136       Jos Boumans <kane[at]cpan.org>, Ken Williams <kwilliams@cpan.org>
137

139       This software is copyright (c) 2018 by Jos Boumans, Ken Williams, Chris
140       Williams and David Golden.
141
142       This is free software; you can redistribute it and/or modify it under
143       the same terms as the Perl 5 programming language system itself.
144
145
146
147perl v5.30.1                      2020-01-29          CPANPLUS::Dist::Build(3)
Impressum