diff --git a/README.md b/README.md index a2ba97a..90bd28a 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,15 @@ It adds support for: ### What the sabayon module affects - * `operatingsystem` fact - This module overrides the operatingsystem fact to `Sabayon` on Sabayon - systems. - * `Service` provider - This module overrides the default provider for `service` resources to - force use of `systemd` - * `Package` provider - This module overrides the default provider for `package` resources to - force use of `entropy` +* `operatingsystem` fact + This module overrides the operatingsystem fact to `Sabayon` on Sabayon + systems. +* `Service` provider + This module overrides the default provider for `service` resources to + force use of `systemd` +* `Package` provider + This module overrides the default provider for `package` resources to + force use of `entropy` ### Beginning with sabayon @@ -42,7 +42,7 @@ setup, as long as the required packages are already installed. To let this module take care of installing the required packages, simply include the `sabayon` class. -``` +```puppet class { 'sabayon': } ``` @@ -55,7 +55,7 @@ so no special configuration is required. The provider supports package names in both the fully-qualified format, e.g. -``` +```puppet package { 'net-misc/openssh': ensure => installed, } @@ -63,7 +63,7 @@ package { 'net-misc/openssh': Or the more verbose format: -``` +```puppet package { 'ssh-server': ensure => installed, category => 'net-misc', @@ -78,7 +78,7 @@ not install 'mysql' since there's no way to disambiguate between ### Managing enman repositories -``` +```puppet enman_repo { 'community': ensure => present, } @@ -90,24 +90,26 @@ Entropy is very flexible in how to specify which packages can be masked, and supports some or all of the following in the atom specification. All of these parameters are optional, but at least one must be specified - * `package` (either fully qualified or unqualified package name) - * `operator` (`<`, `<=`, `=`, `>=`, `>`. applied to version) - * `version` - * `slot` - * `use` - * `tag` - * `repo` + +* `package` (either fully qualified or unqualified package name) +* `operator` (`<`, `<=`, `=`, `>=`, `>`. applied to version) +* `version` +* `slot` +* `use` +* `tag` +* `repo` The `entropy_mask` type also takes the following optional parameters: - * `target` (The path to the mask file, defaults to - `/etc/entropy/packages/package.mask`) + +* `target` (The path to the mask file, defaults to + `/etc/entropy/packages/package.mask`) #### Examples To mask all packages within the `community` repository by default and later unmask specific packages, you could use something like: -``` +```puppet entropy_mask { 'mask-community-by-default': repo => 'community', } @@ -115,7 +117,7 @@ entropy_mask { 'mask-community-by-default': Alternatively, you could mask newer versions of a package -``` +```puppet entropy_mask { 'mask-postgresql-9.5+': package => 'app-shells/bash', operator => '>=', @@ -127,7 +129,7 @@ Or mask a package with an undesirable set of use flags, e.g. to ensure any installed version of openssh supports ldap, mask all versions of openssh which don't include ldap support with: -``` +```puppet entropy_mask { 'openssh-without-ldap-support': package => 'net-misc/openssh', use => '-ldap', @@ -153,7 +155,7 @@ in the example above you have masked everything in the `community` repository you could enable installing a particular package from that repository again using: -``` +```puppet entropy_unmask { 'sublime': package => 'app-editors/sublime-text', } @@ -166,13 +168,13 @@ above. ### Classes - * `::sabayon` class to install required packages to support included types +* `::sabayon` class to install required packages to support included types ### Types - * `enman_repo` Manages SCR repositories using enman - * `entropy_mask` Manages entropy package masks - * `entropy_unmask` Manages entropy package unmasks +* `enman_repo` Manages SCR repositories using enman +* `entropy_mask` Manages entropy package masks +* `entropy_unmask` Manages entropy package unmasks ## Limitations