Merge branch 'fix/__systemd_service/manpage' into 'master'
__systemd_service: fix manpage typos See merge request ungleich-public/cdist!931
This commit is contained in:
		
				commit
				
					
						a20ab63e60
					
				
			
		
					 1 changed files with 16 additions and 9 deletions
				
			
		| 
						 | 
				
			
			@ -1,9 +1,10 @@
 | 
			
		|||
cdist-type__systemd-service(7)
 | 
			
		||||
cdist-type__systemd_service(7)
 | 
			
		||||
==============================
 | 
			
		||||
 | 
			
		||||
NAME
 | 
			
		||||
----
 | 
			
		||||
cdist-type__systemd-service - Controls a systemd service state
 | 
			
		||||
cdist-type__systemd_service - Controls a systemd service state
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
DESCRIPTION
 | 
			
		||||
-----------
 | 
			
		||||
| 
						 | 
				
			
			@ -14,11 +15,12 @@ service after configuration applied or shutdown one service.
 | 
			
		|||
The activation or deactivation is out of scope. Look for the
 | 
			
		||||
:strong:`cdist-type__systemd_util`\ (7) type instead.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
REQUIRED PARAMETERS
 | 
			
		||||
-------------------
 | 
			
		||||
 | 
			
		||||
None.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
OPTIONAL PARAMETERS
 | 
			
		||||
-------------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -31,12 +33,12 @@ state
 | 
			
		|||
    running
 | 
			
		||||
        Service should run (default)
 | 
			
		||||
 | 
			
		||||
    stoppend
 | 
			
		||||
        Service should stopped
 | 
			
		||||
    stopped
 | 
			
		||||
        Service should be stopped
 | 
			
		||||
 | 
			
		||||
action
 | 
			
		||||
    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
 | 
			
		||||
        Reloads the service
 | 
			
		||||
| 
						 | 
				
			
			@ -48,11 +50,12 @@ BOOLEAN PARAMETERS
 | 
			
		|||
------------------
 | 
			
		||||
 | 
			
		||||
if-required
 | 
			
		||||
    Only execute the action if minimum one required type outputs a message to
 | 
			
		||||
    **$__messages_out**. Through this, the action should only executed if a
 | 
			
		||||
    Only execute the action if at minimum one required type outputs a message
 | 
			
		||||
    to ``$__messages_out``. Through this, the action should only executed if a
 | 
			
		||||
    dependency did something. The action will not executed if no dependencies
 | 
			
		||||
    given.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
MESSAGES
 | 
			
		||||
--------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -68,12 +71,14 @@ restart
 | 
			
		|||
reload
 | 
			
		||||
    Reloaded the service
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
ABORTS
 | 
			
		||||
------
 | 
			
		||||
Aborts in following cases:
 | 
			
		||||
 | 
			
		||||
systemd or the service does not exist
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
EXAMPLES
 | 
			
		||||
--------
 | 
			
		||||
.. code-block:: sh
 | 
			
		||||
| 
						 | 
				
			
			@ -95,13 +100,15 @@ EXAMPLES
 | 
			
		|||
 | 
			
		||||
    # reload the service for a modified configuration file
 | 
			
		||||
    # 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
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
AUTHORS
 | 
			
		||||
-------
 | 
			
		||||
Matthias Stecher <matthiasstecher at gmx.de>
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
COPYRIGHT
 | 
			
		||||
---------
 | 
			
		||||
Copyright \(C) 2020 Matthias Stecher. You can redistribute it
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue