marcoduif/cdist
1
0
Fork 0
forked from ungleich-public/cdist
Code Issues Pull requests 1 Projects Releases Wiki Activity

Merge branch 'fix/__systemd_service/manpage' into 'master'

Browse source 
__systemd_service: fix manpage typos

See merge request ungleich-public/cdist!931
This commit is contained in:
poljakowski 2020-09-10 13:21:19 +02:00
commit a20ab63e60
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
cdist/conf/type/__systemd_service/man.rst
View file

@ -1,9 +1,10 @@
cdist-type__systemd-service(7) cdist-type__systemd_service(7)
============================== ==============================
NAME NAME
---- ----
cdist-type__systemd-service - Controls a systemd service state cdist-type__systemd_service - Controls a systemd service state
DESCRIPTION DESCRIPTION
----------- -----------
@ -14,11 +15,12 @@ service after configuration applied or shutdown one service.
The activation or deactivation is out of scope. Look for the The activation or deactivation is out of scope. Look for the
:strong:`cdist-type__systemd_util`\ (7) type instead. :strong:`cdist-type__systemd_util`\ (7) type instead.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
None. None.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
@ -31,12 +33,12 @@ state
running running
Service should run (default) Service should run (default)
stoppend stopped
Service should stopped Service should be stopped
action action
Executes an action on on the service. It will only execute it if the Executes an action on on the service. It will only execute it if the
service keeps the state **running**. There are following actions, where: service keeps the state ``running``. There are following actions, where:
reload reload
Reloads the service Reloads the service
@ -48,11 +50,12 @@ BOOLEAN PARAMETERS
------------------ ------------------
if-required if-required
Only execute the action if minimum one required type outputs a message to Only execute the action if at minimum one required type outputs a message
**$__messages_out**. Through this, the action should only executed if a to ``$__messages_out``. Through this, the action should only executed if a
dependency did something. The action will not executed if no dependencies dependency did something. The action will not executed if no dependencies
given. given.
MESSAGES MESSAGES
-------- --------
@ -68,12 +71,14 @@ restart
reload reload
Reloaded the service Reloaded the service
ABORTS ABORTS
------ ------
Aborts in following cases: Aborts in following cases:
systemd or the service does not exist systemd or the service does not exist
EXAMPLES EXAMPLES
-------- --------
.. code-block:: sh .. code-block:: sh
@ -95,13 +100,15 @@ EXAMPLES
# reload the service for a modified configuration file # reload the service for a modified configuration file
# only reloads the service if the file really changed # only reloads the service if the file really changed
require="__config_file/etc/foo.conf" __systemd_service foo \ require="__file/etc/foo.conf" __systemd_service foo \
--action reload --if-required --action reload --if-required
AUTHORS AUTHORS
------- -------
Matthias Stecher <matthiasstecher at gmx.de> Matthias Stecher <matthiasstecher at gmx.de>
COPYRIGHT COPYRIGHT
--------- ---------
Copyright \(C) 2020 Matthias Stecher. You can redistribute it Copyright \(C) 2020 Matthias Stecher. You can redistribute it