diff --git a/README.md b/README.md index 5dc12fc..9abee11 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ Puppet udev Module -========================= +================== [![Build Status](https://travis-ci.org/jhoblitt/puppet-udev.png)](https://travis-ci.org/jhoblitt/puppet-udev) @@ -8,9 +8,15 @@ Puppet udev Module 1. [Overview](#overview) 2. [Description](#description) 3. [Usage](#usage) + * [Simple](#simple) + * [Managing `udev` syslog verbosity] (#managing-udev-syslog-verbosity) + * [Managing `udev` rules](#managing-udev-rules) + * [Manually triggering a `udev` device rules reload](#manually-triggering-a-udev-device-rules-reload) 4. [Limitations](#limitations) * [Tested Platforms](#tested-platforms) -5. [Support](#support) +5. [Versioning](#versioning) +6. [Support](#support) +7. [See Also](#see-also) Overview @@ -25,16 +31,17 @@ Description This module installs and manages the [`udev`](http://www.freedesktop.org/software/systemd/man/udev.html) package. + Usage ----- -### Basic Example +### Simple This class does not need to be manually included in the manifest when using the `udev::rule` defined type. ```puppet - include udev +include udev ``` ### Managing `udev` syslog verbosity @@ -43,7 +50,7 @@ Controls the value of `udev_log` in `udev.conf` and change the runtime syslog verbosity of the daemon. ```puppet - class { 'udev': udev_log => 'debug' } +class { 'udev': udev_log => 'debug' } ``` ### Managing `udev` rules @@ -53,42 +60,41 @@ Note that either the `content` or `source` parameter must be specified unless not specify both. ```puppet - udev::rule { '60-raw.rules': - ensure => present, - content => 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"', - } +udev::rule { '60-raw.rules': + ensure => present, + content => 'ACTION=="add", KERNEL=="sda", RUN+="/bin/raw /dev/raw/raw1 %N"', +} ``` As is commonly done with the `file` type, you can pass the output of the `template()` function to `content`. ```puppet - udev::rule { '99-foo.rules': - ensure => present, - content => template('mymodule/foo.rules.erb'), - } +udev::rule { '99-foo.rules': + ensure => present, + content => template('mymodule/foo.rules.erb'), +} ``` ```puppet - udev::rule { '99-foo.rules': - ensure => present, - source => "puppet:///modules/${module_name}/foo.rules", - } +udev::rule { '99-foo.rules': + ensure => present, + source => "puppet:///modules/${module_name}/foo.rules", +} ``` ```puppet - udev::rule { '99-foo.rules': - ensure => absent, - } +udev::rule { '99-foo.rules': + ensure => absent, +} ``` - ### Manually triggering a `udev` device rules reload ```puppet - file { '/etc/etc/udev/rules.d/99-myfrobnicator.rules': - ... - notify => Class['udev::udevadm::trigger'], - } +file { '/etc/etc/udev/rules.d/99-myfrobnicator.rules': + ... + notify => Class['udev::udevadm::trigger'], +} ``` @@ -107,9 +113,22 @@ file (one without any fragments). * el6.x +Versioning +---------- + +This module is versioned according to the [Semantic Versioning +2.0.0](http://semver.org/spec/v2.0.0.html) specification. + + Support ------- Please log tickets and issues at [github](https://github.com/jhoblitt/puppet-udev/issues) + +See Also +-------- + +* [`udev` manpage](http://www.freedesktop.org/software/systemd/man/udev.html) +