CPANPLUS::Module - CPAN module objects for CPANPLUS

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>CPANPLUS::Module - CPAN module objects for CPANPLUS - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/CPANPLUS::Module"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.18.3</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/CPANPLUS::Module">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/CPANPLUS::Module">5.40.1</a> <a class="dropdown-item" href="/5.40.0/CPANPLUS::Module">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/CPANPLUS::Module">5.38.3</a> <a class="dropdown-item" href="/5.38.2/CPANPLUS::Module">5.38.2</a> <a class="dropdown-item" href="/5.38.1/CPANPLUS::Module">5.38.1</a> <a class="dropdown-item" href="/5.38.0/CPANPLUS::Module">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/CPANPLUS::Module">5.36.3</a> <a class="dropdown-item" href="/5.36.2/CPANPLUS::Module">5.36.2</a> <a class="dropdown-item" href="/5.36.1/CPANPLUS::Module">5.36.1</a> <a class="dropdown-item" href="/5.36.0/CPANPLUS::Module">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/CPANPLUS::Module">5.34.3</a> <a class="dropdown-item" href="/5.34.2/CPANPLUS::Module">5.34.2</a> <a class="dropdown-item" href="/5.34.1/CPANPLUS::Module">5.34.1</a> <a class="dropdown-item" href="/5.34.0/CPANPLUS::Module">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/CPANPLUS::Module">5.32.1</a> <a class="dropdown-item" href="/5.32.0/CPANPLUS::Module">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/CPANPLUS::Module">5.30.3</a> <a class="dropdown-item" href="/5.30.2/CPANPLUS::Module">5.30.2</a> <a class="dropdown-item" href="/5.30.1/CPANPLUS::Module">5.30.1</a> <a class="dropdown-item" href="/5.30.0/CPANPLUS::Module">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/CPANPLUS::Module">5.28.3</a> <a class="dropdown-item" href="/5.28.2/CPANPLUS::Module">5.28.2</a> <a class="dropdown-item" href="/5.28.1/CPANPLUS::Module">5.28.1</a> <a class="dropdown-item" href="/5.28.0/CPANPLUS::Module">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/CPANPLUS::Module">5.26.3</a> <a class="dropdown-item" href="/5.26.2/CPANPLUS::Module">5.26.2</a> <a class="dropdown-item" href="/5.26.1/CPANPLUS::Module">5.26.1</a> <a class="dropdown-item" href="/5.26.0/CPANPLUS::Module">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/CPANPLUS::Module">5.24.4</a> <a class="dropdown-item" href="/5.24.3/CPANPLUS::Module">5.24.3</a> <a class="dropdown-item" href="/5.24.2/CPANPLUS::Module">5.24.2</a> <a class="dropdown-item" href="/5.24.1/CPANPLUS::Module">5.24.1</a> <a class="dropdown-item" href="/5.24.0/CPANPLUS::Module">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/CPANPLUS::Module">5.22.4</a> <a class="dropdown-item" href="/5.22.3/CPANPLUS::Module">5.22.3</a> <a class="dropdown-item" href="/5.22.2/CPANPLUS::Module">5.22.2</a> <a class="dropdown-item" href="/5.22.1/CPANPLUS::Module">5.22.1</a> <a class="dropdown-item" href="/5.22.0/CPANPLUS::Module">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/CPANPLUS::Module">5.20.3</a> <a class="dropdown-item" href="/5.20.2/CPANPLUS::Module">5.20.2</a> <a class="dropdown-item" href="/5.20.1/CPANPLUS::Module">5.20.1</a> <a class="dropdown-item" href="/5.20.0/CPANPLUS::Module">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/CPANPLUS::Module">5.18.4</a> <a class="dropdown-item active" href="/5.18.3/CPANPLUS::Module">5.18.3</a> <a class="dropdown-item" href="/5.18.2/CPANPLUS::Module">5.18.2</a> <a class="dropdown-item" href="/5.18.1/CPANPLUS::Module">5.18.1</a> <a class="dropdown-item" href="/5.18.0/CPANPLUS::Module">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/CPANPLUS::Module">5.16.3</a> <a class="dropdown-item" href="/5.16.2/CPANPLUS::Module">5.16.2</a> <a class="dropdown-item" href="/5.16.1/CPANPLUS::Module">5.16.1</a> <a class="dropdown-item" href="/5.16.0/CPANPLUS::Module">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/CPANPLUS::Module">5.14.4</a> <a class="dropdown-item" href="/5.14.3/CPANPLUS::Module">5.14.3</a> <a class="dropdown-item" href="/5.14.2/CPANPLUS::Module">5.14.2</a> <a class="dropdown-item" href="/5.14.1/CPANPLUS::Module">5.14.1</a> <a class="dropdown-item" href="/5.14.0/CPANPLUS::Module">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/CPANPLUS::Module">5.12.5</a> <a class="dropdown-item" href="/5.12.4/CPANPLUS::Module">5.12.4</a> <a class="dropdown-item" href="/5.12.3/CPANPLUS::Module">5.12.3</a> <a class="dropdown-item" href="/5.12.2/CPANPLUS::Module">5.12.2</a> <a class="dropdown-item" href="/5.12.1/CPANPLUS::Module">5.12.1</a> <a class="dropdown-item" href="/5.12.0/CPANPLUS::Module">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/CPANPLUS::Module">5.10.1</a> <a class="dropdown-item" href="/5.10.0/CPANPLUS::Module">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/CPANPLUS::Module">5.8.9</a> <a class="dropdown-item" href="/5.8.8/CPANPLUS::Module">5.8.8</a> <a class="dropdown-item" href="/5.8.7/CPANPLUS::Module">5.8.7</a> <a class="dropdown-item" href="/5.8.6/CPANPLUS::Module">5.8.6</a> <a class="dropdown-item" href="/5.8.5/CPANPLUS::Module">5.8.5</a> <a class="dropdown-item" href="/5.8.4/CPANPLUS::Module">5.8.4</a> <a class="dropdown-item" href="/5.8.3/CPANPLUS::Module">5.8.3</a> <a class="dropdown-item" href="/5.8.2/CPANPLUS::Module">5.8.2</a> <a class="dropdown-item" href="/5.8.1/CPANPLUS::Module">5.8.1</a> <a class="dropdown-item" href="/5.8.0/CPANPLUS::Module">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/CPANPLUS::Module">5.6.2</a> <a class="dropdown-item" href="/5.6.1/CPANPLUS::Module">5.6.1</a> <a class="dropdown-item" href="/5.6.0/CPANPLUS::Module">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/CPANPLUS::Module">5.005_04</a> <a class="dropdown-item" href="/5.005_03/CPANPLUS::Module">5.005_03</a> <a class="dropdown-item" href="/5.005_02/CPANPLUS::Module">5.005_02</a> <a class="dropdown-item" href="/5.005_01/CPANPLUS::Module">5.005_01</a> <a class="dropdown-item" href="/5.005/CPANPLUS::Module">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/CPANPLUS::Module">blead</a> <a class="dropdown-item" href="/5.41.10/CPANPLUS::Module">5.41.10</a> <a class="dropdown-item" href="/5.41.9/CPANPLUS::Module">5.41.9</a> <a class="dropdown-item" href="/5.41.8/CPANPLUS::Module">5.41.8</a> <a class="dropdown-item" href="/5.41.7/CPANPLUS::Module">5.41.7</a> <a class="dropdown-item" href="/5.41.6/CPANPLUS::Module">5.41.6</a> <a class="dropdown-item" href="/5.41.5/CPANPLUS::Module">5.41.5</a> <a class="dropdown-item" href="/5.41.4/CPANPLUS::Module">5.41.4</a> <a class="dropdown-item" href="/5.41.3/CPANPLUS::Module">5.41.3</a> <a class="dropdown-item" href="/5.41.2/CPANPLUS::Module">5.41.2</a> <a class="dropdown-item" href="/5.41.1/CPANPLUS::Module">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/CPANPLUS::Module">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/CPANPLUS::Module">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/CPANPLUS::Module">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/CPANPLUS::Module">5.39.10</a> <a class="dropdown-item" href="/5.39.9/CPANPLUS::Module">5.39.9</a> <a class="dropdown-item" href="/5.39.8/CPANPLUS::Module">5.39.8</a> <a class="dropdown-item" href="/5.39.7/CPANPLUS::Module">5.39.7</a> <a class="dropdown-item" href="/5.39.6/CPANPLUS::Module">5.39.6</a> <a class="dropdown-item" href="/5.39.5/CPANPLUS::Module">5.39.5</a> <a class="dropdown-item" href="/5.39.4/CPANPLUS::Module">5.39.4</a> <a class="dropdown-item" href="/5.39.3/CPANPLUS::Module">5.39.3</a> <a class="dropdown-item" href="/5.39.2/CPANPLUS::Module">5.39.2</a> <a class="dropdown-item" href="/5.39.1/CPANPLUS::Module">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/CPANPLUS::Module">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.18.3/perl">Perl</a> <a class="dropdown-item" href="/5.18.3/perlintro">Intro</a> <a class="dropdown-item" href="/5.18.3/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.18.3/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.18.3/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.3/perlop">Operators</a> <a class="dropdown-item" href="/5.18.3/functions">Functions</a> <a class="dropdown-item" href="/5.18.3/variables">Variables</a> <a class="dropdown-item" href="/5.18.3/modules">Modules</a> <a class="dropdown-item" href="/5.18.3/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.3/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.18.3/perlcommunity">Community</a> <a class="dropdown-item" href="/5.18.3/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.18.3/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.18.3/CPANPLUS::Module">CPANPLUS::Module</a> <div id="more"> (<a href="/5.18.3/CPANPLUS::Module.txt">source</a>, <a href="https://metacpan.org/pod/CPANPLUS::Module">CPAN</a>) </div> <div id="moduleversion">version 0.9135</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.18.3. <a href="/CPANPLUS::Module">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#CLASS-METHODS">CLASS METHODS</a> <ul> <li> <a class="text-decoration-none" href="#accessors-()">accessors ()</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#ACCESSORS">ACCESSORS</a> </li> <li> <a class="text-decoration-none" href="#STATUS-ACCESSORS">STATUS ACCESSORS</a> </li> <li> <a class="text-decoration-none" href="#METHODS">METHODS</a> <ul> <li> <a class="text-decoration-none" href="#$self-=-CPANPLUS::Module-%3Enew(-OPTIONS-)">$self = CPANPLUS::Module->new( OPTIONS )</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Epackage_name(-%5B$package_string%5D-)">$mod->package_name( [$package_string] )</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Epackage_version(-%5B$package_string%5D-)">$mod->package_version( [$package_string] )</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Epackage_extension(-%5B$package_string%5D-)">$mod->package_extension( [$package_string] )</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Epackage_is_perl_core">$mod->package_is_perl_core</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Emodule_is_supplied_with_perl_core(-%5Bversion-=%3E-$%5D%5D-)">$mod->module_is_supplied_with_perl_core( [version => $]] )</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Eis_bundle">$mod->is_bundle</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Eis_autobundle;">$mod->is_autobundle;</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Eis_third_party">$mod->is_third_party</a> </li> <li> <a class="text-decoration-none" href="#$mod-%3Ethird_party_information">$mod->third_party_information</a> </li> <li> <a class="text-decoration-none" href="#$clone-=-$self-%3Eclone">$clone = $self->clone</a> </li> <li> <a class="text-decoration-none" href="#$where-=-$self-%3Efetch">$where = $self->fetch</a> </li> <li> <a class="text-decoration-none" href="#$path-=-$self-%3Eextract">$path = $self->extract</a> </li> <li> <a class="text-decoration-none" href="#$type-=-$self-%3Eget_installer_type(%5Bprefer_makefile-=%3E-BOOL%5D)">$type = $self->get_installer_type([prefer_makefile => BOOL])</a> </li> <li> <a class="text-decoration-none" href="#$dist-=-$self-%3Edist(%5Btarget-=%3E-'prepare%7Ccreate',-format-=%3E-DISTRIBUTION_TYPE,-args-=%3E-%7Bkey-=%3E-val%7D%5D);">$dist = $self->dist([target => 'prepare|create', format => DISTRIBUTION_TYPE, args => {key => val}]);</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$mod-%3Eprepare(-)">$bool = $mod->prepare( )</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$mod-%3Ecreate(-)">$bool = $mod->create( )</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$mod-%3Etest(-)">$bool = $mod->test( )</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$self-%3Einstall(%5B-target-=%3E-'init%7Cprepare%7Ccreate%7Cinstall',-format-=%3E-FORMAT_TYPE,-extractdir-=%3E-DIRECTORY,-fetchdir-=%3E-DIRECTORY,-prefer_bin-=%3E-BOOL,-force-=%3E-BOOL,-verbose-=%3E-BOOL,-.....-%5D);">$bool = $self->install([ target => 'init|prepare|create|install', format => FORMAT_TYPE, extractdir => DIRECTORY, fetchdir => DIRECTORY, prefer_bin => BOOL, force => BOOL, verbose => BOOL, ..... ]);</a> </li> <li> <a class="text-decoration-none" href="#$text-=-$self-%3Ereadme">$text = $self->readme</a> </li> <li> <a class="text-decoration-none" href="#$version-=-$self-%3Einstalled_version()">$version = $self->installed_version()</a> </li> <li> <a class="text-decoration-none" href="#$where-=-$self-%3Einstalled_file()">$where = $self->installed_file()</a> </li> <li> <a class="text-decoration-none" href="#$dir-=-$self-%3Einstalled_dir()">$dir = $self->installed_dir()</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$self-%3Eis_uptodate(%5Bversion-=%3E-VERSION_NUMBER%5D)">$bool = $self->is_uptodate([version => VERSION_NUMBER])</a> </li> <li> <a class="text-decoration-none" href="#$href-=-$self-%3Edetails()">$href = $self->details()</a> </li> <li> <a class="text-decoration-none" href="#@list-=-$self-%3Econtains()">@list = $self->contains()</a> </li> <li> <a class="text-decoration-none" href="#@list_of_hrefs-=-$self-%3Efetch_report()">@list_of_hrefs = $self->fetch_report()</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$self-%3Euninstall(%5Btype-=%3E-%5Ball%7Cman%7Cprog%5D)">$bool = $self->uninstall([type => [all|man|prog])</a> </li> <li> <a class="text-decoration-none" href="#@modobj-=-$self-%3Edistributions()">@modobj = $self->distributions()</a> </li> <li> <a class="text-decoration-none" href="#@list-=-$self-%3Efiles-()">@list = $self->files ()</a> </li> <li> <a class="text-decoration-none" href="#@list-=-$self-%3Edirectory_tree-()">@list = $self->directory_tree ()</a> </li> <li> <a class="text-decoration-none" href="#@list-=-$self-%3Epacklist-()">@list = $self->packlist ()</a> </li> <li> <a class="text-decoration-none" href="#@list-=-$self-%3Evalidate-()">@list = $self->validate ()</a> </li> <li> <a class="text-decoration-none" href="#$bool-=-$self-%3Eadd_to_includepath;">$bool = $self->add_to_includepath;</a> </li> <li> <a class="text-decoration-none" href="#$path-=-$self-%3Ebest_path_to_module_build();">$path = $self->best_path_to_module_build();</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#BUG-REPORTS">BUG REPORTS</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT">COPYRIGHT</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>CPANPLUS::Module - CPAN module objects for CPANPLUS</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>### get a module object from the CPANPLUS::Backend object my $mod = $cb->module_tree('Some::Module'); ### accessors $mod->version; $mod->package; ### methods $mod->fetch; $mod->extract; $mod->install;</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><code>CPANPLUS::Module</code> creates objects from the information in the source files. These can then be used to query and perform actions on, like fetching or installing.</p> <p>These objects should only be created internally. For <code>fake</code> objects, there's the <code>CPANPLUS::Module::Fake</code> class. To obtain a module object consult the <code>CPANPLUS::Backend</code> documentation.</p> <h1 id="CLASS-METHODS"><a class="permalink" href="#CLASS-METHODS">#</a><a id="CLASS"></a>CLASS METHODS</h1> <h2 id="accessors-()"><a class="permalink" href="#accessors-()">#</a><a id="accessors"></a>accessors ()</h2> <p>Returns a list of all accessor methods to the object</p> <h1 id="ACCESSORS"><a class="permalink" href="#ACCESSORS">#</a>ACCESSORS</h1> <p>An objects of this class has the following accessors:</p> <dl> <dt id="name"><a class="permalink" href="#name">#</a>name</dt> <dd> <p>Name of the module.</p> </dd> <dt id="module"><a class="permalink" href="#module">#</a>module</dt> <dd> <p>Name of the module.</p> </dd> <dt id="version"><a class="permalink" href="#version">#</a>version</dt> <dd> <p>Version of the module. Defaults to '0.0' if none was provided.</p> </dd> <dt id="path"><a class="permalink" href="#path">#</a>path</dt> <dd> <p>Extended path on the mirror.</p> </dd> <dt id="comment"><a class="permalink" href="#comment">#</a>comment</dt> <dd> <p>Any comment about the module -- largely unused.</p> </dd> <dt id="package"><a class="permalink" href="#package">#</a>package</dt> <dd> <p>The name of the package.</p> </dd> <dt id="description"><a class="permalink" href="#description">#</a>description</dt> <dd> <p>Description of the module -- only registered modules have this.</p> </dd> <dt id="dslip"><a class="permalink" href="#dslip">#</a>dslip</dt> <dd> <p>The five character dslip string, that represents meta-data of the module -- again, only registered modules have this.</p> </dd> <dt id="status"><a class="permalink" href="#status">#</a>status</dt> <dd> <p>The <code>CPANPLUS::Module::Status</code> object associated with this object. (see below).</p> </dd> <dt id="author"><a class="permalink" href="#author">#</a>author</dt> <dd> <p>The <code>CPANPLUS::Module::Author</code> object associated with this object.</p> </dd> <dt id="parent"><a class="permalink" href="#parent">#</a>parent</dt> <dd> <p>The <code>CPANPLUS::Internals</code> object that spawned this module object.</p> </dd> </dl> <h1 id="STATUS-ACCESSORS"><a class="permalink" href="#STATUS-ACCESSORS">#</a><a id="STATUS"></a>STATUS ACCESSORS</h1> <p><code>CPANPLUS</code> caches a lot of results from method calls and saves data it collected along the road for later reuse.</p> <p><code>CPANPLUS</code> uses this internally, but it is also available for the end user. You can get a status object by calling:</p> <pre><code>$modobj->status</code></pre> <p>You can then query the object as follows:</p> <dl> <dt id="installer_type"><a class="permalink" href="#installer_type">#</a>installer_type</dt> <dd> <p>The installer type used for this distribution. Will be one of 'makemaker' or 'build'. This determines whether <code>CPANPLUS::Dist::MM</code> or <code>CPANPLUS::Dist::Build</code> will be used to build this distribution.</p> </dd> <dt id="dist_cpan"><a class="permalink" href="#dist_cpan">#</a>dist_cpan</dt> <dd> <p>The dist object used to do the CPAN-side of the installation. Either a <code>CPANPLUS::Dist::MM</code> or <code>CPANPLUS::Dist::Build</code> object.</p> </dd> <dt id="dist"><a class="permalink" href="#dist">#</a>dist</dt> <dd> <p>The custom dist object used to do the operating specific side of the installation, if you've chosen to use this. For example, if you've chosen to install using the <code>ports</code> format, this may be a <code>CPANPLUS::Dist::Ports</code> object.</p> <p>Undefined if you didn't specify a separate format to install through.</p> </dd> <dt id="prereqs-|-requires"><a class="permalink" href="#prereqs-%7C-requires">#</a><a id="prereqs"></a><a id="prereqs-requires"></a>prereqs | requires</dt> <dd> <p>A hashref of prereqs this distribution was found to have. Will look something like this:</p> <pre><code class="plaintext">{ Carp => 0.01, strict => 0 }</code></pre> <p>Might be undefined if the distribution didn't have any prerequisites.</p> </dd> <dt id="configure_requires"><a class="permalink" href="#configure_requires">#</a>configure_requires</dt> <dd> <p>Like prereqs, but these are necessary to be installed before the build process can even begin.</p> </dd> <dt id="signature"><a class="permalink" href="#signature">#</a>signature</dt> <dd> <p>Flag indicating, if a signature check was done, whether it was OK or not.</p> </dd> <dt id="extract"><a class="permalink" href="#extract">#</a>extract</dt> <dd> <p>The directory this distribution was extracted to.</p> </dd> <dt id="fetch"><a class="permalink" href="#fetch">#</a>fetch</dt> <dd> <p>The location this distribution was fetched to.</p> </dd> <dt id="readme"><a class="permalink" href="#readme">#</a>readme</dt> <dd> <p>The text of this distributions README file.</p> </dd> <dt id="uninstall"><a class="permalink" href="#uninstall">#</a>uninstall</dt> <dd> <p>Flag indicating if an uninstall call was done successfully.</p> </dd> <dt id="created"><a class="permalink" href="#created">#</a>created</dt> <dd> <p>Flag indicating if the <code>create</code> call to your dist object was done successfully.</p> </dd> <dt id="installed"><a class="permalink" href="#installed">#</a>installed</dt> <dd> <p>Flag indicating if the <code>install</code> call to your dist object was done successfully.</p> </dd> <dt id="checksums"><a class="permalink" href="#checksums">#</a>checksums</dt> <dd> <p>The location of this distributions CHECKSUMS file.</p> </dd> <dt id="checksum_ok"><a class="permalink" href="#checksum_ok">#</a>checksum_ok</dt> <dd> <p>Flag indicating if the checksums check was done successfully.</p> </dd> <dt id="checksum_value"><a class="permalink" href="#checksum_value">#</a>checksum_value</dt> <dd> <p>The checksum value this distribution is expected to have</p> </dd> </dl> <h1 id="METHODS"><a class="permalink" href="#METHODS">#</a>METHODS</h1> <h2 id="$self-=-CPANPLUS::Module->new(-OPTIONS-)"><a class="permalink" href="#$self-=-CPANPLUS::Module-%3Enew(-OPTIONS-)">#</a><a id="self-CPANPLUS::Module-new-OPTIONS"></a>$self = CPANPLUS::Module->new( OPTIONS )</h2> <p>This method returns a <code>CPANPLUS::Module</code> object. Normal users should never call this method directly, but instead use the <code>CPANPLUS::Backend</code> to obtain module objects.</p> <p>This example illustrates a <code>new()</code> call with all required arguments:</p> <pre><code>CPANPLUS::Module->new( module => 'Foo', path => 'authors/id/A/AA/AAA', package => 'Foo-1.0.tgz', author => $author_object, _id => INTERNALS_OBJECT_ID, );</code></pre> <p>Every accessor is also a valid option to pass to <code>new</code>.</p> <p>Returns a module object on success and false on failure.</p> <h2 id="$mod->package_name(-[$package_string]-)"><a class="permalink" href="#$mod-%3Epackage_name(-%5B$package_string%5D-)">#</a><a id="package_name"></a><a id="mod-package_name-package_string"></a>$mod->package_name( [$package_string] )</h2> <p>Returns the name of the package a module is in. For <code>Acme::Bleach</code> that might be <code>Acme-Bleach</code>.</p> <h2 id="$mod->package_version(-[$package_string]-)"><a class="permalink" href="#$mod-%3Epackage_version(-%5B$package_string%5D-)">#</a><a id="package_version"></a><a id="mod-package_version-package_string"></a>$mod->package_version( [$package_string] )</h2> <p>Returns the version of the package a module is in. For a module in the package <code>Acme-Bleach-1.1.tar.gz</code> this would be <code>1.1</code>.</p> <h2 id="$mod->package_extension(-[$package_string]-)"><a class="permalink" href="#$mod-%3Epackage_extension(-%5B$package_string%5D-)">#</a><a id="package_extension"></a><a id="mod-package_extension-package_string"></a>$mod->package_extension( [$package_string] )</h2> <p>Returns the suffix added by the compression method of a package a certain module is in. For a module in <code>Acme-Bleach-1.1.tar.gz</code>, this would be <code>tar.gz</code>.</p> <h2 id="$mod->package_is_perl_core"><a class="permalink" href="#$mod-%3Epackage_is_perl_core">#</a><a id="package_is_perl_core"></a><a id="mod-package_is_perl_core"></a>$mod->package_is_perl_core</h2> <p>Returns a boolean indicating of the package a particular module is in, is actually a core perl distribution.</p> <h2 id="$mod->module_is_supplied_with_perl_core(-[version-=>-$]]-)"><a class="permalink" href="#$mod-%3Emodule_is_supplied_with_perl_core(-%5Bversion-=%3E-$%5D%5D-)">#</a><a id="module_is_supplied_with_perl_core"></a><a id="mod-module_is_supplied_with_perl_core-version"></a>$mod->module_is_supplied_with_perl_core( [version => $]] )</h2> <p>Returns a boolean indicating whether <code>ANY VERSION</code> of this module was supplied with the current running perl's core package.</p> <h2 id="$mod->is_bundle"><a class="permalink" href="#$mod-%3Eis_bundle">#</a><a id="is_bundle"></a><a id="mod-is_bundle"></a>$mod->is_bundle</h2> <p>Returns a boolean indicating if the module you are looking at, is actually a bundle. Bundles are identified as modules whose name starts with <code>Bundle::</code>.</p> <h2 id="$mod->is_autobundle;"><a class="permalink" href="#$mod-%3Eis_autobundle;">#</a><a id="is_autobundle"></a><a id="mod-is_autobundle"></a>$mod->is_autobundle;</h2> <p>Returns a boolean indicating if the module you are looking at, is actually an autobundle as generated by <code>$cb->autobundle</code>.</p> <h2 id="$mod->is_third_party"><a class="permalink" href="#$mod-%3Eis_third_party">#</a><a id="is_third_party"></a><a id="mod-is_third_party"></a>$mod->is_third_party</h2> <p>Returns a boolean indicating whether the package is a known third-party module (i.e. it's not provided by the standard Perl distribution and is not available on the CPAN, but on a third party software provider). See <a href="/5.18.3/Module::ThirdParty">Module::ThirdParty</a> for more details.</p> <h2 id="$mod->third_party_information"><a class="permalink" href="#$mod-%3Ethird_party_information">#</a><a id="third_party_information"></a><a id="mod-third_party_information"></a>$mod->third_party_information</h2> <p>Returns a reference to a hash with more information about a third-party module. See the documentation about <code>module_information()</code> in <a href="/5.18.3/Module::ThirdParty">Module::ThirdParty</a> for more details.</p> <h2 id="$clone-=-$self->clone"><a class="permalink" href="#$clone-=-$self-%3Eclone">#</a><a id="clone-self-clone"></a>$clone = $self->clone</h2> <p>Clones the current module object for tinkering with. It will have a clean <code>CPANPLUS::Module::Status</code> object, as well as a fake <code>CPANPLUS::Module::Author</code> object.</p> <h2 id="$where-=-$self->fetch"><a class="permalink" href="#$where-=-$self-%3Efetch">#</a><a id="where-self-fetch"></a>$where = $self->fetch</h2> <p>Fetches the module from a CPAN mirror. Look at <a href="/5.18.3/CPANPLUS::Internals::Fetch::_fetch()">CPANPLUS::Internals::Fetch::_fetch()</a> for details on the options you can pass.</p> <h2 id="$path-=-$self->extract"><a class="permalink" href="#$path-=-$self-%3Eextract">#</a><a id="path-self-extract"></a>$path = $self->extract</h2> <p>Extracts the fetched module. Look at <a href="/5.18.3/CPANPLUS::Internals::Extract::_extract()">CPANPLUS::Internals::Extract::_extract()</a> for details on the options you can pass.</p> <h2 id="$type-=-$self->get_installer_type([prefer_makefile-=>-BOOL])"><a class="permalink" href="#$type-=-$self-%3Eget_installer_type(%5Bprefer_makefile-=%3E-BOOL%5D)">#</a><a id="type-self-get_installer_type-prefer_makefile-BOOL"></a>$type = $self->get_installer_type([prefer_makefile => BOOL])</h2> <p>Gets the installer type for this module. This may either be <code>build</code> or <code>makemaker</code>. If <code>Module::Build</code> is unavailable or no installer type is available, it will fall back to <code>makemaker</code>. If both are available, it will pick the one indicated by your config, or by the <code>prefer_makefile</code> option you can pass to this function.</p> <p>Returns the installer type on success, and false on error.</p> <h2 id="$dist-=-$self->dist([target-=>-'prepare|create',-format-=>-DISTRIBUTION_TYPE,-args-=>-{key-=>-val}]);"><a class="permalink" href="#$dist-=-$self-%3Edist(%5Btarget-=%3E-'prepare%7Ccreate',-format-=%3E-DISTRIBUTION_TYPE,-args-=%3E-%7Bkey-=%3E-val%7D%5D);">#</a><a id="dist-self-dist-target-prepare-create-format-DISTRIBUTION_TYPE-args-key-val"></a>$dist = $self->dist([target => 'prepare|create', format => DISTRIBUTION_TYPE, args => {key => val}]);</h2> <p>Create a distribution object, ready to be installed. Distribution type defaults to your config settings</p> <p>The optional <code>args</code> hashref is passed on to the specific distribution types' <code>create</code> method after being dereferenced.</p> <p>Returns a distribution object on success, false on failure.</p> <p>See <code>CPANPLUS::Dist</code> for details.</p> <h2 id="$bool-=-$mod->prepare(-)"><a class="permalink" href="#$bool-=-$mod-%3Eprepare(-)">#</a><a id="bool-mod-prepare"></a>$bool = $mod->prepare( )</h2> <p>Convenience method around <code>install()</code> that prepares a module without actually building it. This is equivalent to invoking <code>install</code> with <code>target</code> set to <code>prepare</code></p> <p>Returns true on success, false on failure.</p> <h2 id="$bool-=-$mod->create(-)"><a class="permalink" href="#$bool-=-$mod-%3Ecreate(-)">#</a><a id="bool-mod-create"></a>$bool = $mod->create( )</h2> <p>Convenience method around <code>install()</code> that creates a module. This is equivalent to invoking <code>install</code> with <code>target</code> set to <code>create</code></p> <p>Returns true on success, false on failure.</p> <h2 id="$bool-=-$mod->test(-)"><a class="permalink" href="#$bool-=-$mod-%3Etest(-)">#</a><a id="bool-mod-test"></a>$bool = $mod->test( )</h2> <p>Convenience wrapper around <code>install()</code> that tests a module, without installing it. It's the equivalent to invoking <code>install()</code> with <code>target</code> set to <code>create</code> and <code>skiptest</code> set to <code>0</code>.</p> <p>Returns true on success, false on failure.</p> <h2 id="$bool-=-$self->install([-target-=>-'init|prepare|create|install',-format-=>-FORMAT_TYPE,-extractdir-=>-DIRECTORY,-fetchdir-=>-DIRECTORY,-prefer_bin-=>-BOOL,-force-=>-BOOL,-verbose-=>-BOOL,-.....-]);"><a class="permalink" href="#$bool-=-$self-%3Einstall(%5B-target-=%3E-'init%7Cprepare%7Ccreate%7Cinstall',-format-=%3E-FORMAT_TYPE,-extractdir-=%3E-DIRECTORY,-fetchdir-=%3E-DIRECTORY,-prefer_bin-=%3E-BOOL,-force-=%3E-BOOL,-verbose-=%3E-BOOL,-.....-%5D);">#</a><a id="bool-self-install-target-init-prepare-create-install-format-FORMAT_TYPE-extractdir-DIRECTORY-fetchdir-DIRECTORY-prefer_bin-BOOL-force-BOOL-verbose-BOOL"></a>$bool = $self->install([ target => 'init|prepare|create|install', format => FORMAT_TYPE, extractdir => DIRECTORY, fetchdir => DIRECTORY, prefer_bin => BOOL, force => BOOL, verbose => BOOL, ..... ]);</h2> <p>Installs the current module. This includes fetching it and extracting it, if this hasn't been done yet, as well as creating a distribution object for it.</p> <p>This means you can pass it more arguments than described above, which will be passed on to the relevant methods as they are called.</p> <p>See <code>CPANPLUS::Internals::Fetch</code>, <code>CPANPLUS::Internals::Extract</code> and <code>CPANPLUS::Dist</code> for details.</p> <p>Returns true on success, false on failure.</p> <p>Returns a list of module objects the Bundle specifies.</p> <p>This requires you to have extracted the bundle already, using the <code>extract()</code> method.</p> <p>Returns false on error.</p> <h2 id="$text-=-$self->readme"><a class="permalink" href="#$text-=-$self-%3Ereadme">#</a><a id="text-self-readme"></a>$text = $self->readme</h2> <p>Fetches the readme belonging to this module and stores it under <code>$obj->status->readme</code>. Returns the readme as a string on success and returns false on failure.</p> <h2 id="$version-=-$self->installed_version()"><a class="permalink" href="#$version-=-$self-%3Einstalled_version()">#</a><a id="version-self-installed_version"></a>$version = $self->installed_version()</h2> <p>Returns the currently installed version of this module, if any.</p> <h2 id="$where-=-$self->installed_file()"><a class="permalink" href="#$where-=-$self-%3Einstalled_file()">#</a><a id="where-self-installed_file"></a>$where = $self->installed_file()</h2> <p>Returns the location of the currently installed file of this module, if any.</p> <h2 id="$dir-=-$self->installed_dir()"><a class="permalink" href="#$dir-=-$self-%3Einstalled_dir()">#</a><a id="dir-self-installed_dir"></a>$dir = $self->installed_dir()</h2> <p>Returns the directory (or more accurately, the <code>@INC</code> handle) from which this module was loaded, if any.</p> <h2 id="$bool-=-$self->is_uptodate([version-=>-VERSION_NUMBER])"><a class="permalink" href="#$bool-=-$self-%3Eis_uptodate(%5Bversion-=%3E-VERSION_NUMBER%5D)">#</a><a id="bool-self-is_uptodate-version-VERSION_NUMBER"></a>$bool = $self->is_uptodate([version => VERSION_NUMBER])</h2> <p>Returns a boolean indicating if this module is uptodate or not.</p> <h2 id="$href-=-$self->details()"><a class="permalink" href="#$href-=-$self-%3Edetails()">#</a><a id="href-self-details"></a>$href = $self->details()</h2> <p>Returns a hashref with key/value pairs offering more information about a particular module. For example, for <code>Time::HiRes</code> it might look like this:</p> <pre><code>Author Jarkko Hietaniemi (jhi@iki.fi) Description High resolution time, sleep, and alarm Development Stage Released Installed File /usr/local/perl/lib/Time/Hires.pm Interface Style plain Functions, no references used Language Used C and perl, a C compiler will be needed Package Time-HiRes-1.65.tar.gz Public License Unknown Support Level Developer Version Installed 1.52 Version on CPAN 1.65</code></pre> <h2 id="@list-=-$self->contains()"><a class="permalink" href="#@list-=-$self-%3Econtains()">#</a><a id="list-self-contains"></a>@list = $self->contains()</h2> <p>Returns a list of module objects that represent the modules also present in the package of this module.</p> <p>For example, for <code>Archive::Tar</code> this might return:</p> <pre><code class="plaintext">Archive::Tar Archive::Tar::Constant Archive::Tar::File</code></pre> <h2 id="@list_of_hrefs-=-$self->fetch_report()"><a class="permalink" href="#@list_of_hrefs-=-$self-%3Efetch_report()">#</a><a id="list_of_hrefs-self-fetch_report"></a>@list_of_hrefs = $self->fetch_report()</h2> <p>This function queries the CPAN testers database at <i>http://testers.cpan.org/</i> for test results of specified module objects, module names or distributions.</p> <p>Look at <a href="/5.18.3/CPANPLUS::Internals::Report::_query_report()">CPANPLUS::Internals::Report::_query_report()</a> for details on the options you can pass and the return value to expect.</p> <h2 id="$bool-=-$self->uninstall([type-=>-[all|man|prog])"><a class="permalink" href="#$bool-=-$self-%3Euninstall(%5Btype-=%3E-%5Ball%7Cman%7Cprog%5D)">#</a><a id="bool-self-uninstall-type-all-man-prog"></a>$bool = $self->uninstall([type => [all|man|prog])</h2> <p>This function uninstalls the specified module object.</p> <p>You can install 2 types of files, either <code>man</code> pages or <code>prog</code>ram files. Alternately you can specify <code>all</code> to uninstall both (which is the default).</p> <p>Returns true on success and false on failure.</p> <p>Do note that this does an uninstall via the so-called <code>.packlist</code>, so if you used a module installer like say, <code>ports</code> or <code>apt</code>, you should not use this, but use your package manager instead.</p> <h2 id="@modobj-=-$self->distributions()"><a class="permalink" href="#@modobj-=-$self-%3Edistributions()">#</a><a id="modobj-self-distributions"></a>@modobj = $self->distributions()</h2> <p>Returns a list of module objects representing all releases for this module on success, false on failure.</p> <h2 id="@list-=-$self->files-()"><a class="permalink" href="#@list-=-$self-%3Efiles-()">#</a><a id="list-self-files"></a>@list = $self->files ()</h2> <p>Returns a list of files used by this module, if it is installed.</p> <h2 id="@list-=-$self->directory_tree-()"><a class="permalink" href="#@list-=-$self-%3Edirectory_tree-()">#</a><a id="list-self-directory_tree"></a>@list = $self->directory_tree ()</h2> <p>Returns a list of directories used by this module.</p> <h2 id="@list-=-$self->packlist-()"><a class="permalink" href="#@list-=-$self-%3Epacklist-()">#</a><a id="list-self-packlist"></a>@list = $self->packlist ()</h2> <p>Returns the <code>ExtUtils::Packlist</code> object for this module.</p> <h2 id="@list-=-$self->validate-()"><a class="permalink" href="#@list-=-$self-%3Evalidate-()">#</a><a id="list-self-validate"></a>@list = $self->validate ()</h2> <p>Returns a list of files that are missing for this modules, but are present in the .packlist file.</p> <h2 id="$bool-=-$self->add_to_includepath;"><a class="permalink" href="#$bool-=-$self-%3Eadd_to_includepath;">#</a><a id="bool-self-add_to_includepath"></a>$bool = $self->add_to_includepath;</h2> <p>Adds the current modules path to <code>@INC</code> and <code>$PERL5LIB</code>. This allows you to add the module from its build dir to your path.</p> <p>It also adds the current modules <code>bin</code> and/or <code>script</code> paths to the PATH.</p> <p>You can reset <code>$PATH</code>, <code>@INC</code> and <code>$PERL5LIB</code> to their original state when you started the program, by calling:</p> <pre><code>$self->parent->flush('lib');</code></pre> <h2 id="$path-=-$self->best_path_to_module_build();"><a class="permalink" href="#$path-=-$self-%3Ebest_path_to_module_build();">#</a><a id="path-self-best_path_to_module_build"></a>$path = $self->best_path_to_module_build();</h2> <p><b>OBSOLETE</b></p> <p>If a newer version of Module::Build is found in your path, it will return this <code>special</code> path. If the newest version of <code>Module::Build</code> is found in your regular <code>@INC</code>, the method will return false. This indicates you do not need to add a special directory to your <code>@INC</code>.</p> <p>Note that this is only relevant if you're building your own <code>CPANPLUS::Dist::*</code> plugin -- the built-in dist types already have this taken care of.</p> <h1 id="BUG-REPORTS"><a class="permalink" href="#BUG-REPORTS">#</a><a id="BUG"></a>BUG REPORTS</h1> <p>Please report bugs or other issues to <bug-cpanplus@rt.cpan.org<gt>.</p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>This module by Jos Boumans <kane@cpan.org>.</p> <h1 id="COPYRIGHT"><a class="permalink" href="#COPYRIGHT">#</a>COPYRIGHT</h1> <p>The CPAN++ interface (of which this module is a part of) is copyright (c) 2001 - 2007, Jos Boumans <kane@cpan.org>. All rights reserved.</p> <p>This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

CPANPLUS::Module - CPAN module objects for CPANPLUS - Perldoc Browser