Skip to content

Commit

Permalink
update README formatting + boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua Hoblitt committed Dec 27, 2013
1 parent 3e91613 commit 3927cbe
Showing 1 changed file with 42 additions and 19 deletions.
61 changes: 42 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ Puppet policykit Module
3. [Usage](#usage)
4. [Limitations](#limitations)
* [Tested Platforms](#tested-platforms)
5. [Support](#support)
5. [Versioning](#versioning)
6. [Support](#support)
7. [See Also](#see-also)


Overview
--------
Expand All @@ -32,36 +35,43 @@ files.
This module was forked from [git://git.sans.ethz.ch/puppet-modules/policykit]
in order to update it's functionality and add basic tests.


Usage
-----

To only ensure that the policykit software package is installed. Note that
this isn't nessicary when using the `policykit::localauthority` defined type as
including the `policykit` class is implied.

include policykit
```puppet
include policykit
```

Create a new authority file.

policykit::localauthority { 'Disable suspend':
identity => 'unix-user:*',
action => 'org.freedesktop.upower.suspend',
result_active => 'no',
result_any => 'no',
result_inactive => 'no',
}
```puppet
policykit::localauthority { 'Disable suspend':
identity => 'unix-user:*',
action => 'org.freedesktop.upower.suspend',
result_active => 'no',
result_any => 'no',
result_inactive => 'no',
}
```

To remove an existing authority configuration. Note that all of the params are
still required. This is arguably a bug.

policykit::localauthority { 'Disable suspend':
ensure => absent,
identity => 'unix-user:*',
action => 'org.freedesktop.upower.suspend',
result_active => 'no',
result_any => 'no',
result_inactive => 'no',
}
```puppet
policykit::localauthority { 'Disable suspend':
ensure => absent,
identity => 'unix-user:*',
action => 'org.freedesktop.upower.suspend',
result_active => 'no',
result_any => 'no',
result_inactive => 'no',
}
```


Limitations
Expand All @@ -73,12 +83,25 @@ releases prior to el6.x.

### Tested on

* el6.x
* 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-module_skel/issues)
Please log tickets and issues at
[github](https://github.com/jhoblitt/puppet-policykit/issues)


See Also
--------

* [`polkit`](http://www.freedesktop.org/wiki/Software/polkit/)

0 comments on commit 3927cbe

Please sign in to comment.