screen

install and configure GNU Screen

Geoff Williams

geoffwilliams

5,915 downloads

5,915 latest version

3.2 quality score

Version information

  • 0.1.0 (latest)
released Mar 26th 2017

Start using this module

Documentation

geoffwilliams/screen — version 0.1.0 Mar 26th 2017

Build Status

screen

Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Reference - An under-the-hood peek at what the module is doing and how
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

Install and configure GNU Screen

Usage

Default configuration

include screen

Install GNU Screen using the default configuration

Custom configuration

class { "screen":
  screenrc_source => "puppet:///modules/somemodule/screenrc",
}

Install GNU Screen with a screenrc file supplied in another module

Reference

Reference documentation is generated directly from source code using puppet-strings. You may regenerate the documentation by running:

bundle exec puppet strings

Or you may view the current generated documentation.

The documentation is no substitute for reading and understanding the module source code, and all users should ensure they are familiar and comfortable with the operations this module performs before using it.

Limitations

  • Does not install the screen package on Windows, only the configuration file
  • Not supported by Puppet, Inc.

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
bundle exec pdqtest all

See .travis.yml for a working CI example