<commit_before># boost

[![Build Status](https://travis-ci.org/echoes-tech/puppet-boost.svg?branch=master)]
(https://travis-ci.org/echoes-tech/puppet-boost)
[![Flattr Button](https://api.flattr.com/button/flattr-badge-large.png "Flattr This!")]
(https://flattr.com/submit/auto?user_id=echoes&url=https://forge.puppetlabs.com/echoes/boost&title=Puppet%20module%20to%20manage%20Boost&description=This%20module%20installs%20Boost.&lang=en_GB&category=software "Puppet module to manage Boost installation")


#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with boost](#setup)
    * [Beginning with boost](#beginning-with-boost)
4. [Usage - Configuration options and additional functionality](#usage)
    * [Install header packages](#install-header-packages)
    * [Install all headers packages and the documentation](#install-all-headers-packages-and-the-documentation)
    * [Uninstall a Boost library](#uninstall-a-boost-library)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Contributors](#contributors)

## Overview

Puppet module to manage Boost installation.

## Module Description

This module installs [Boost](http://www.boost.org/) libraries.

## Setup

### Beginning with boost

```puppet
class { 'boost':
  packages => {
    'signals' => {},
    'system' => {},
  }
}
```

## Usage

### Install header packages

```puppet
class { 'boost':
  devel    => true,
  packages => {
    'signals' => {},
    'system' => {},
  }
}
```

### Install all headers packages and the documentation

```puppet
class { 'boost':
  all_devel => true,
  doc       => true,
}
```

### Uninstall a Boost library

```puppet
class { 'boost':
  packages => {
    'signals' => {
      ensure => 'absent',
    },
  }
}
```

## Reference

### Classes

#### Public Classes

* boost: Main class, includes all other classes.

#### Private Classes

* boost::install: Handles the packages.

#### Parameters

The following parameters are available in the `::boost` class:

##### `package_ensure`

Tells Puppet whether the Boost packages should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

##### `packages`

Tells Puppet which Boost libraries to install. Valid options: hash. Default value: {}

##### `prefix`

Tells Puppet what is the first part of Boost packages name. Valid options: string. Default value: varies by operating system

##### `suffix`

Tells Puppet what is the last part of Boost packages name. Valid options: string. Default value: varies by operating system

##### `suffix_dev`

Tells Puppet what is the last part of Boost header packages name. Valid options: string. Default value: varies by operating system

##### `version`

Tells Puppet what is the version part of the Boost packages name. Only needed for Debian family OSes. Valid options: string. Default value: varies by operating system

### Defines

#### Public defines

* boost::package: Adds a Boost librarie.

#### Parameters

The following parameters are available in the `::boost::package` define:

##### `devel`

Tells Puppet whether the Boost header package should be installed. Valid options: boolean. Default value: false

##### `ensure`

Tells Puppet whether the Boost package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

##### `prefix`

Tells Puppet what is the first part of the Boost package name. Valid options: string. Default value: undef

##### `suffix`

Tells Puppet what is the last part of the Boost package name. Valid options: string. Default value: undef

##### `suffix_dev`

Tells Puppet what is the last part of the Boost header package name. Valid options: string. Default value: undef

##### `version`

Tells Puppet what is the version part of the Boost package name. Only needed for Debian family OSes. Valid options: string. Default value: undef

## Limitations

RedHat and Debian family OSes are officially supported. Tested and built on Debian and CentOS.

## Development

[Echoes Technologies](https://www.echoes-tech.com) modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great.

[Fork this module on GitHub](https://github.com/echoes-tech/puppet-boost/fork)


## Contributors

The list of contributors can be found at: https://github.com/echoes-tech/puppet-boost/graphs/contributors<commit_msg>Fix wrong Echoes website URL<commit_after># boost

[![Build Status](https://travis-ci.org/echoes-tech/puppet-boost.svg?branch=master)]
(https://travis-ci.org/echoes-tech/puppet-boost)
[![Flattr Button](https://api.flattr.com/button/flattr-badge-large.png "Flattr This!")]
(https://flattr.com/submit/auto?user_id=echoes&url=https://forge.puppetlabs.com/echoes/boost&title=Puppet%20module%20to%20manage%20Boost&description=This%20module%20installs%20Boost.&lang=en_GB&category=software "Puppet module to manage Boost installation")


#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
3. [Setup - The basics of getting started with boost](#setup)
    * [Beginning with boost](#beginning-with-boost)
4. [Usage - Configuration options and additional functionality](#usage)
    * [Install header packages](#install-header-packages)
    * [Install all headers packages and the documentation](#install-all-headers-packages-and-the-documentation)
    * [Uninstall a Boost library](#uninstall-a-boost-library)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
8. [Contributors](#contributors)

## Overview

Puppet module to manage Boost installation.

## Module Description

This module installs [Boost](http://www.boost.org/) libraries.

## Setup

### Beginning with boost

```puppet
class { 'boost':
  packages => {
    'signals' => {},
    'system' => {},
  }
}
```

## Usage

### Install header packages

```puppet
class { 'boost':
  devel    => true,
  packages => {
    'signals' => {},
    'system' => {},
  }
}
```

### Install all headers packages and the documentation

```puppet
class { 'boost':
  all_devel => true,
  doc       => true,
}
```

### Uninstall a Boost library

```puppet
class { 'boost':
  packages => {
    'signals' => {
      ensure => 'absent',
    },
  }
}
```

## Reference

### Classes

#### Public Classes

* boost: Main class, includes all other classes.

#### Private Classes

* boost::install: Handles the packages.

#### Parameters

The following parameters are available in the `::boost` class:

##### `package_ensure`

Tells Puppet whether the Boost packages should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

##### `packages`

Tells Puppet which Boost libraries to install. Valid options: hash. Default value: {}

##### `prefix`

Tells Puppet what is the first part of Boost packages name. Valid options: string. Default value: varies by operating system

##### `suffix`

Tells Puppet what is the last part of Boost packages name. Valid options: string. Default value: varies by operating system

##### `suffix_dev`

Tells Puppet what is the last part of Boost header packages name. Valid options: string. Default value: varies by operating system

##### `version`

Tells Puppet what is the version part of the Boost packages name. Only needed for Debian family OSes. Valid options: string. Default value: varies by operating system

### Defines

#### Public defines

* boost::package: Adds a Boost librarie.

#### Parameters

The following parameters are available in the `::boost::package` define:

##### `devel`

Tells Puppet whether the Boost header package should be installed. Valid options: boolean. Default value: false

##### `ensure`

Tells Puppet whether the Boost package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'

##### `prefix`

Tells Puppet what is the first part of the Boost package name. Valid options: string. Default value: undef

##### `suffix`

Tells Puppet what is the last part of the Boost package name. Valid options: string. Default value: undef

##### `suffix_dev`

Tells Puppet what is the last part of the Boost header package name. Valid options: string. Default value: undef

##### `version`

Tells Puppet what is the version part of the Boost package name. Only needed for Debian family OSes. Valid options: string. Default value: undef

## Limitations

RedHat and Debian family OSes are officially supported. Tested and built on Debian and CentOS.

## Development

[Echoes Technologies](https://echoes.fr) modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great.

[Fork this module on GitHub](https://github.com/echoes-tech/puppet-boost/fork)


## Contributors

The list of contributors can be found at: https://github.com/echoes-tech/puppet-boost/graphs/contributors
{'fraction_non_alphanumeric': 0.12304749760918074, 'fraction_numerical': 0.004675379874614812, 'mean_word_length': 4.507314218841428, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 27, 'https://': 16, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '272302', 'n_tokens_mistral': 2865, 'n_tokens_neox': 2661, 'n_words': 1015}