Forge Home

locales

System locales configuration

9,616 downloads

9,616 latest version

2.4 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.0 (latest)
released Jul 20th 2014
This version is compatible with:
  • Debian, Ubuntu

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'rlenglet-locales', '0.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add rlenglet-locales
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install rlenglet-locales --version 0.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

rlenglet/locales — version 0.1.0 Jul 20th 2014

#locales

####Table of Contents

  1. Overview - What is the locales module?
  2. Module Description - What does the locales module do?
  3. Setup - The basics of getting started with locales
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module
  7. License

##Overview

Configures the system locales.

##Module Description

The locales class configures the system locales on Debian/Ubuntu.

##Setup

###What locales affects

  • locales Debian package.
  • /etc/locale.gen locales configuration files.

###Beginning with locales

Just include the locales class, or optionally pass the default_environment_locale locale name, which defaults to None, and the locales list of names and encodings of locales to enable.

class { locales:
  default_environment_locale => "en_US.UTF-8",
  locales => ["en_US ISO-8859-1",
              "en_US.UTF-8 UTF-8",
              "fr_FR ISO-8859-1",
              "fr_FR.UTF-8 UTF-8",
              "fr_FR@euro ISO-8859-15"],
}

##Usage

###Class: locales

####Parameters

#####default_environment_locale

The name of the default locale set in the environment. If not specified, defaults to None. See /etc/locale.gen for the list of valid locale names.

#####locales

The array of combinations of locale names and encodings to enable. See /etc/locale.gen for the list of valid combinations.

##Limitations

This module is compatible only with Debian and Ubuntu.

##Development

Feedback and contributions are appreciated, in the form of issues or pull requests on the Github project page.

##License

Copyright 2014 Romain Lenglet

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.