diff options
| author | Lucas Hoffmann <l-m-h@web.de> | 2015-12-03 18:00:23 +0100 |
|---|---|---|
| committer | Lucas Hoffmann <l-m-h@web.de> | 2015-12-03 18:00:23 +0100 |
| commit | 2f15c5e5d86c62193a9d872331d16f8fdbd9f203 (patch) | |
| tree | e03a8d9ab27df6901eaabf609786d4897029bc2e /docs/source | |
| parent | 32de57fc1173684ce91880f3f5e134d4640d1506 (diff) | |
Update docs for global hooks.
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/configuration/hooks.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst index e364d6f3..dba5e6eb 100644 --- a/docs/source/configuration/hooks.rst +++ b/docs/source/configuration/hooks.rst @@ -7,9 +7,13 @@ config. Per default this points to :file:`~/.config/alot/hooks.py`. .. rubric:: Pre/Post Command Hooks -For every :ref:`COMMAND <usage.commands>` in mode :ref:`MODE <modes>`, the callables :func:`pre_MODE_COMMAND` and :func:`post_MODE_COMMAND` --- if defined -- will be called before and after the command is applied respectively. The signature for the -pre-`send` hook in envelope mode for example looks like this: +For every :ref:`COMMAND <usage.commands>` in mode :ref:`MODE <modes>`, the +callables :func:`pre_MODE_COMMAND` and :func:`post_MODE_COMMAND` -- if defined +-- will be called before and after the command is applied respectively. In +addition callables :func:`pre_global_COMMAND` and :func:`post_global_COMMAND` +can be used. They will be called if no specific hook function for a mode is +defined. The signature for the pre-`send` hook in envelope mode for example +looks like this: .. py:function:: pre_envelope_send(ui=None, dbm=None, cmd=None) |