CPANPLUS::Dist::MM



CPANPLUS::Dist::MM

NAME
SYNOPSIS
DESCRIPTION
ACCESSORS
STATUS ACCESSORS
METHODS

NAME

CPANPLUS::Dist::MM

SYNOPSIS

    $mm = CPANPLUS::Dist::MM−>new( module => $modobj );
    $mm−>create;        # runs make && make test
    $mm−>install;       # runs make install

DESCRIPTION

"CPANPLUS::Dist::MM" is a distribution class for MakeMaker related modules. Using this package, you can create, install and uninstall perl modules. It inherits from "CPANPLUS::Dist".

ACCESSORS

parent()

Returns the "CPANPLUS::Module" object that parented this object.

status()

Returns the "Object::Accessor" object that keeps the status for this module.

STATUS ACCESSORS

All accessors can be accessed as follows:
$mm
−>status−> ACCESSOR
makefile ()

Location of the Makefile (or Build file). Set to 0 explicitly if something went wrong.

make ()

BOOL indicating if the "make" (or "Build") command was successful.

test ()

BOOL indicating if the "make test" (or "Build test") command was successful.

prepared ()

BOOL indicating if the "prepare" call exited successfully This gets set after "perl Makefile.PL"

distdir ()

Full path to the directory in which the "prepare" call took place, set after a call to "prepare".

created ()

BOOL indicating if the "create" call exited successfully. This gets set after "make" and "make test".

installed ()

BOOL indicating if the module was installed. This gets set after "make install" (or "Build install") exits successfully.

uninstalled ()

BOOL indicating if the module was uninstalled properly.

_create_args ()

Storage of the arguments passed to "create" for this object. Used for recursive calls when satisfying prerequisites.

_install_args ()

Storage of the arguments passed to "install" for this object. Used for recursive calls when satisfying prerequisites.

METHODS

$bool = $dist−>format_available();
Returns a boolean indicating whether or not you can use this package to create and install modules in your environment.

$bool = $dist−>init();
Sets up the "CPANPLUS::Dist::MM" object for use. Effectively creates all the needed status accessors.

Called automatically whenever you create a new "CPANPLUS::Dist" object.

$bool = $dist−>prepare([perl => ’/path/to/perl’, makemakerflags => ’EXTRA=FLAGS’, force => BOOL , verbose => BOOL ])
"prepare"
preps a distribution for installation. This means it will run "perl Makefile.PL" and determine what prerequisites this distribution declared.

If you set "force" to true, it will go over all the stages of the "prepare" process again, ignoring any previously cached results.

When running "perl Makefile.PL", the environment variable "PERL5_CPANPLUS_IS_EXECUTING" will be set to the full path of the "Makefile.PL" that is being executed. This enables any code inside the "Makefile.PL" to know that it is being installed via CPANPLUS .

Returns true on success and false on failure.

You may then call "$dist−>create" on the object to create the installable files.

$href = $dist−>_find_prereqs( file => ’/path/to/Makefile’, [verbose => BOOL ])
Parses a "Makefile" for "PREREQ_PM" entries and distills from that any prerequisites mentioned in the "Makefile"

Returns a hash with module-version pairs on success and false on failure.

$bool = $dist−>create([perl => ’/path/to/perl’, make => ’/path/to/make’, makeflags => ’EXTRA=FLAGS’, prereq_target => TARGET , skiptest => BOOL , force => BOOL , verbose => BOOL ])
"create"
creates the files necessary for installation. This means it will run "make" and "make test". This will also scan for and attempt to satisfy any prerequisites the module may have.

If you set "skiptest" to true, it will skip the "make test" stage. If you set "force" to true, it will go over all the stages of the "make" process again, ignoring any previously cached results. It will also ignore a bad return value from "make test" and still allow the operation to return true.

Returns true on success and false on failure.

You may then call "$dist−>install" on the object to actually install it.

$bool = $dist−>install([make => ’/path/to/make’, makemakerflags => ’EXTRA=FLAGS’, force => BOOL , verbose => BOOL ])
"install"
runs the following command:
make install

Returns true on success, false on failure.

$bool = $dist−>write_makefile_pl([force => BOOL , verbose => BOOL ])
This routine can write a "Makefile.PL" from the information in a module object. It is used to write a "Makefile.PL" when the original author forgot it (!!).

Returns 1 on success and false on failure.

The file gets written to the directory the module’s been extracted to.



More Linux Commands

manpages/NextRequest.3.html
NextRequest(3) - Display macros and functions (Man Page)....
The AllPlanes macro returns a value with all bits set to 1 suitable for use in a plane argument to a procedure. The BlackPixel macro returns the black pixel val

manpages/Tcl_SetSystemEncoding.3.html
Tcl_SetSystemEncoding(3) - procedures for creating and using
Tcl_GetEncoding finds an encoding given its name. The name may refer to a built-in Tcl encoding, a user-defined encoding registered by calling Tcl_CreateEncodin

manpages/glRenderMode.3gl.html
glRenderMode(3gl) - set rasterization mode - Linux man page
glRenderMode sets the rasterization mode. It takes one argument, mode, which can assume one of three predefined values: GL_RENDER Render mode. Primitives are ra

manpages/vgcfgbackup.8.html
vgcfgbackup(8) - backup volume group descriptor area........
vgcfgbackup allows you to backup the metadata of your volume groups. If you dont name any volume groups on the command line, all of them will be backed up. In a

manpages/log2l.3.html
log2l(3) - base-2 logarithmic function - Linux manual page
The log2() function returns the base 2 logarithm of x. RETURN VALUE On success, these functions return the base 2 logarithm of x. For special cases, including w

manpages/Tk_FindPhoto.3.html
Tk_FindPhoto(3) - manipulate the image data stored in a phot
Tk_FindPhoto returns an opaque handle that is used to identify a particular photo image to the other procedures. The parameter is the name of the image, that is

manpages/XSubImage.3.html
XSubImage(3) - image utilities (Library - Linux man page)...
The XInitImage function initializes the internal image manipulation routines of an image structure, based on the values of the various structure members. All fi

manpages/XML::LibXML::NodeList.3pm.html
XML::LibXML::NodeList(3pm) - a list of XML document nodes...
An XML::LibXML::NodeList object contains an ordered list of nodes, as detailed by the W3C DOM documentation of Node Lists. SYNOPSIS my $results = $dom->findnode

manpages/vlock.1.html
vlock(1) Virtual Console lock program - Linux manual page...
vlock is a program to lock one or more sessions on the Linux console. This is especially useful for Linux machines which have multiple users with access to the

manpages/gst-discoverer-1.0.1.html
gst-discoverer-1.0(1) Display file metadata and stream infor
gst-discoverer-1.0 is a tool that can be used to print basic metadata and stream information about a media file. It can be run on individual files or whole dire

manpages/panel_window.3curses.html
panel_window(3curses) - panel stack extension for curses....
Panels are ncurses(3NCURSES) windows with the added feature of depth. Panel functions allow the use of stacked windows and ensure the proper portions of each wi

manpages/ldap_delete_ext.3.html
ldap_delete_ext(3) - Perform an LDAP delete operation.......
The ldap_delete_s() routine is used to perform an LDAP delete operation synchronously. It takes dn, the DN of the entry to be deleted. It returns an LDAP error





We can't live, work or learn in freedom unless the software we use is free.