x/cathead
Code Issues Proposed changes

Fix README formatting

Browse Source
This commit is contained in:
Tom Cammann 2015-03-30 19:00:11 +01:00
parent c153a3a749
commit d202dce683
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.rst
View File

@ -67,26 +67,26 @@ Running
The *actions* section contains actions to perform on different events. So The *actions* section contains actions to perform on different events. So
far the possible events are far the possible events are
- Successful refresh of a certificate - Successful refresh of a certificate
- Failure to refresh a certificate - Failure to refresh a certificate
Actions can either by system calls or python calls. Actions can either by system calls or python calls.
name name
Name of the action, used to associate with a certificate event callback. Name of the action, used to associate with a certificate event callback.
type type
The type of action, either ``'system'`` for a system call (e.g. ``reboot``) The type of action, either ``'system'`` for a system call (e.g. ``reboot``)
or ``'python'`` which allows executing a python callable. or ``'python'`` which allows executing a python callable.
module module
Use this when using type of ``python`` to select which module the Use this when using type of ``python`` to select which module the
callable is in. callable is in.
command command
Specify the command or callable to be run. Specify the command or callable to be run.
args args
Specify the arguments to the command or callable. This should be a list. Specify the arguments to the command or callable. This should be a list.
4. Run cathead with your requirements file. :: 4. Run cathead with your requirements file. ::
@ -102,11 +102,11 @@ with. This can be done using ::
Known Issues Known Issues
""""""""""" """""""""""
Ctrl-C doens't work Ctrl-C doesn't work
Currently you cannot interrupt the cathead process due to APScheduler not Currently you cannot interrupt the cathead process due running the process
supporting this. When you run ``cathead config.py`` in the terminal you have to from the APScheduler thread. When you run ``cathead config.py`` in the
termiate the process with ``Ctrl-z`` and ``kill %1`` (or whatever job it was). terminal you have to terminate the process with ``Ctrl-z`` and ``kill %1``.
Naming Naming
"""""" """"""