<commit_before># perlbrew

[![Build Status](https://travis-ci.org/walkamongus/puppet-perlbrew.svg)](https://travis-ci.org/walkamongus/puppet-perlbrew)

#### Table of Contents

1. [Overview](#overview)
2. [Module Description](#module-description)
3. [Setup - The basics of getting started with perlbrew](#setup)
    * [What perlbrew affects](#what-perlbrew-affects)
    * [Beginning with perlbrew](#beginning-with-perlbrew)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)

## Overview

This module installs and configures Perlbrew.  It also includes optional classes 
to install Perl and CPAN modules via Perlbew.

## Module Description

This module primarily focuses on installing and configuring Perlbrew. There are
optional classes that may be declared for installing a spcific version of Perl
as well as installing CPAN modules for a Perl installed with Perlbrew.

Perlbrew configuration is currently limited. Perl compile-time options may be 
passed to the perlbrew::perl class. CPAN installation options may be 
passed to the perlbrew::cpan::module class. Future versions of the
perlbrew::cpan::module class will allow for installing from a **cpanfile**.

## Setup

### What perlbrew affects

* Installs curl package if necessary
* Installs Perlbrew into $perlbrew_root
* Optionally install a specific Perl version via Perlbrew
* Optionaly install CPAN modules using Perlbrew-ed Perl

### Beginning with perlbrew

Install and configure Perlbrew with defaults:

    include ::perlbrew

## Usage

Install Perlbrew to a custom directory:

    class {'::perlbrew':
      perlbrew_root => '/usr/local/perlbrew',
    }

Install a Perl version using Perlbrew:

    perlbrew::perl{'my_perl_install':
      version         => '5.12.3',
      compile_options => ['-Duseshrplib', '-Dusethreads']
    }

Install a CPAN module:

    perlbrew::cpan::module {'Class::DBI': }

Install a CPAN module from a URL with install options:

    perlbrew::cpan::module {'Class::C3':
      url     => 'https://cpan.metacpan.org/authors/id/F/FL/FLORA/Class-C3-0.23.tar.gz',
      options => [
        '--notest',
        '--force',
      ]
    }<commit_msg>README documentation<commit_after># perlbrew

[![Build Status](https://travis-ci.org/walkamongus/puppet-perlbrew.svg)](https://travis-ci.org/walkamongus/puppet-perlbrew)

#### Table of Contents

1. [Overview](#overview)
2. [Module Description](#module-description)
3. [Setup - The basics of getting started with perlbrew](#setup)
    * [What perlbrew affects](#what-perlbrew-affects)
    * [Beginning with perlbrew](#beginning-with-perlbrew)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)

## Overview

This module installs and configures Perlbrew.  It also includes optional classes 
to install Perl and CPAN modules via Perlbew.

## Module Description

This module primarily focuses on installing and configuring Perlbrew. There are
optional classes that may be declared for installing a spcific version of Perl
as well as installing CPAN modules for a Perl installed with Perlbrew.

Perlbrew configuration is currently limited. Perl compile-time options may be 
passed to the perlbrew::perl class. CPAN installation options may be 
passed to the perlbrew::cpan::module class. Future versions of the
perlbrew::cpan::module class will allow for installing from a **cpanfile**.

## Setup

### What perlbrew affects

* Installs curl package if necessary
* Installs Perlbrew into $perlbrew_root
* Optionally install a specific Perl version via Perlbrew
* Optionaly install CPAN modules using Perlbrew-ed Perl

### Beginning with perlbrew

Install and configure Perlbrew with defaults:

    include ::perlbrew

## Usage

Install Perlbrew to a custom directory:

    class {'::perlbrew':
      perlbrew_root => '/usr/local/perlbrew',
    }

Install default Perl version 5.16.3 with defaults:

    perlbrew::perl {'my_perl_install': }

Install a different customized Perl version using Perlbrew:

    perlbrew::perl {'my_perl_install':
      version         => '5.12.3',
      compile_options => ['-Duseshrplib', '-Dusethreads']
    }

Install a CPAN module:

    perlbrew::cpan::module {'Class::DBI': }

Install a CPAN module from a URL with install options:

    perlbrew::cpan::module {'Class::C3':
      url     => 'https://cpan.metacpan.org/authors/id/F/FL/FLORA/Class-C3-0.23.tar.gz',
      options => [
        '--notest',
        '--force',
      ]
    }
{'fraction_non_alphanumeric': 0.1044618312539649, 'fraction_numerical': 0.007189680693592726, 'mean_word_length': 4.015906680805939, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1250839', 'n_tokens_mistral': 1493, 'n_tokens_neox': 1355, 'n_words': 479}