describe how __process should work

Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-03-27 00:05:30 +01:00
parent 06fe371b1d
commit e4467de8fd
1 changed files with 16 additions and 1 deletions

View File

@ -21,13 +21,28 @@ state::
OPTIONAL PARAMETERS
-------------------
None
stop::
Executable to use for stopping the process.
start::
Executable to use for starting the process.
EXAMPLES
--------
--------------------------------------------------------------------------------
# Start /usr/sbin/sshd if not running
__process /usr/sbin/sshd --state running
# Start /usr/sbin/sshd if not running with a different binary
__process /usr/sbin/sshd --state running --start "/etc/rc.d/sshd start"
# Stop the process using kill (the type default)
__process /usr/sbin/sshd --state stopped
# Stop the process using /etc/rc.d/sshd stop
__process /usr/sbin/sshd --state stopped --stop "/etc/rc.d/sshd stop"
--------------------------------------------------------------------------------