Add configuration details to the README
This commit is contained in:
parent
fe64dafa09
commit
a48caabe5d
1 changed files with 37 additions and 0 deletions
37
README.rst
37
README.rst
|
@ -9,6 +9,7 @@ has completed.
|
|||
* Usage_
|
||||
* Requirements_
|
||||
* Installation_
|
||||
* Configuration_
|
||||
* `Temporarily Disabling Notifications`_
|
||||
* Contributing_
|
||||
* `Running Tests`_
|
||||
|
@ -73,6 +74,42 @@ Then add this line to your ``.zshrc``. Make sure it is **before** the line ``sou
|
|||
|
||||
plugins=(auto-notify $plugins)
|
||||
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
*Notification Threshold*
|
||||
|
||||
By default, ``auto-notify`` will send notifications for tasks that take longer than 10 seconds. You
|
||||
can configure this value by setting the environment variable ``AUTO_NOTIFY_THRESHOLD``:
|
||||
|
||||
..code:: shell
|
||||
|
||||
# Set threshold to 20seconds
|
||||
export AUTO_NOTIFY_THRESHOLD=20
|
||||
|
||||
|
||||
*Ignored Commands*
|
||||
|
||||
A number of commands do not get notifications for long running times due to their nature (e.g. ``watch`` or ``man``).
|
||||
The list of ignored commands is specified in the ``AUTO_NOTIFY_IGNORE`` environment variable. This can be modified
|
||||
or completely overwritten based on your use case.
|
||||
|
||||
..code:: shell
|
||||
|
||||
# Add docker to list of ignored commands
|
||||
AUTO_NOTIFY_NOTIFY+=("docker")
|
||||
|
||||
Make sure that you append to the array above *after* your plugin manager has been loaded in your ``zshrc``.
|
||||
|
||||
If you wish to completely redefine what is ignored and not ignored, then just set ``AUTO_NOTIFY_IGNORE`` to
|
||||
a new array.
|
||||
|
||||
..code:: shell
|
||||
|
||||
# redefine what is ignored by auto-notify
|
||||
export AUTO_NOTIFY_IGNORE=("docker" "man" "sleep")
|
||||
|
||||
Temporarily Disabling Notifications
|
||||
-----------------------------------
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue