mhameed/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

documentation cleanups

Browse source 
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
Nico Schottelius 2012-11-07 19:22:02 +01:00
parent 91eccc8920
commit 3d4bb3837f
15 changed files with 31 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
cdist/conf/type/__package/man.text
View file

@ -34,7 +34,7 @@ type::
__package_emerge for Gentoo __package_emerge for Gentoo
state:: state::
either "present" or "absent", defaults to "present" Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES

2
cdist/conf/type/__package_apt/man.text
View file

@ -25,7 +25,7 @@ name::
If supplied, use the name and not the object id as the package name. If supplied, use the name and not the object id as the package name.
state:: state::
The state the package should be in, either "present" or "absent" Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES

2
cdist/conf/type/__package_luarocks/man.text
View file

@ -24,7 +24,7 @@ name::
If supplied, use the name and not the object id as the package name. If supplied, use the name and not the object id as the package name.
state:: state::
The state the package should be in, either "present" or "absent" Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES

2
cdist/conf/type/__package_opkg/man.text
View file

@ -24,7 +24,7 @@ name::
If supplied, use the name and not the object id as the package name. If supplied, use the name and not the object id as the package name.
state:: state::
The state the package should be in, either "present" or "absent" Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES

5
cdist/conf/type/__package_pacman/man.text
View file

@ -10,8 +10,7 @@ cdist-type__package_pacman - Manage packages with pacman
DESCRIPTION DESCRIPTION
----------- -----------
Pacman is usually used on the Archlinux distribution to manage Pacman is usually used on the Archlinux distribution to manage packages.
packages.
REQUIRED PARAMETERS REQUIRED PARAMETERS
@ -25,7 +24,7 @@ name::
If supplied, use the name and not the object id as the package name. If supplied, use the name and not the object id as the package name.
state:: state::
The state the package should be in, either "present" or "absent" Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES

1
cdist/conf/type/__pf_ruleset/man.text
View file

@ -26,6 +26,7 @@ source::
Note that this type is almost useless without a ruleset defined, but it's technically not Note that this type is almost useless without a ruleset defined, but it's technically not
needed, e.g. for the case of disabling the firewall temporarily. needed, e.g. for the case of disabling the firewall temporarily.
EXAMPLES EXAMPLES
-------- --------

2
cdist/conf/type/__postgres_role/man.text
View file

@ -16,7 +16,7 @@ This cdist type allows you to create or drop postgres roles.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
state:: state::
either 'present' or 'absent' Either "present" or "absent", defaults to "present"
OPTIONAL PARAMETERS OPTIONAL PARAMETERS

14
cdist/conf/type/__process/man.text
View file

@ -16,23 +16,23 @@ This cdist type allows you to define the state of a process.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
state:: state::
State of the process: Either present or absent Either "present" or "absent", defaults to "present"
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
name:: name::
Process name to match on when using pgrep -f -x. Process name to match on when using pgrep -f -x.
This is useful, if the name starts with a "/", This is useful, if the name starts with a "/",
because the leading slash is stripped away from because the leading slash is stripped away from
the object id by cdist. the object id by cdist.
stop:: stop::
Executable to use for stopping the process. Executable to use for stopping the process.
start:: start::
Executable to use for starting the process. Executable to use for starting the process.
EXAMPLES EXAMPLES

3
cdist/conf/type/__qemu_img/man.text
View file

@ -24,8 +24,7 @@ size::
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
state:: state::
The state of the image file: either "present" or "absent". Either "present" or "absent", defaults to "present"
Defaults to "present".
EXAMPLES EXAMPLES

2
cdist/conf/type/__rvm/man.text
View file

@ -16,7 +16,7 @@ RVM is the Ruby enVironment Manager for the Ruby programming language.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
state:: state::
Either "present" or "absent". Either "present" or "absent".
EXAMPLES EXAMPLES

8
cdist/conf/type/__rvm_gem/man.text
View file

@ -16,16 +16,16 @@ RVM is the Ruby enVironment Manager for the Ruby programming language.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
user:: user::
The remote user account to use The remote user account to use
gemset:: gemset::
The gemset to use The gemset to use
state:: state::
Either "present" or "absent". Either "present" or "absent"
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
default:: default::
Make the selected gemset the default Make the selected gemset the default
EXAMPLES EXAMPLES
-------- --------

6
cdist/conf/type/__rvm_gemset/man.text
View file

@ -16,14 +16,14 @@ RVM is the Ruby enVironment Manager for the Ruby programming language.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
user:: user::
The remote user account to use The remote user account to use
state:: state::
Either "present" or "absent". Either "present" or "absent".
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
default:: default::
If set to anything but "no" (the default), set the given gemset as default. If set to anything but "no" (the default), set the given gemset as default.
EXAMPLES EXAMPLES
-------- --------

10
cdist/conf/type/__rvm_ruby/man.text
View file

@ -16,14 +16,14 @@ RVM is the Ruby enVironment Manager for the Ruby programming language.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
user:: user::
The remote user account to use The remote user account to use
state:: state::
Either "present" or "absent". Either "present" or "absent".
OPTIONAL PARAMETERS BOOLEAN PARAMETERS
------------------- ------------------
default: default:
If set to anything but "no" (the default), set the given version as default If set to anything but "no" (the default), set the given version as default
EXAMPLES EXAMPLES
-------- --------

2
cdist/conf/type/__start_on_boot/man.text
View file

@ -24,7 +24,7 @@ None.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
state:: state::
'present' or 'absent', defaults to 'present' Either "present" or "absent", defaults to "present"
EXAMPLES EXAMPLES