From e81d5622b4e74be2ba94389e4fcfb1104d638839 Mon Sep 17 00:00:00 2001 From: niraami Date: Mon, 6 Nov 2023 00:29:19 +0100 Subject: [PATCH] Add urgency level documentation to README --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.rst b/README.rst index 70ea746..5cfb125 100644 --- a/README.rst +++ b/README.rst @@ -129,6 +129,17 @@ NOTE: This configuration option currently only works for Linux. # Set notification expiry to 10 seconds export AUTO_NOTIFY_EXPIRE_TIME=10000 +**Notification Urgency Level** + +By default, commands that exit successfully (with code 0) will send out a notification with the urgency level of "normal", while commands that exit with an error (code > 0), will use level "critical". +On some systems (e.g. KDE or Gnome) critical notifications are not desirable as they might never expire. +You can override notification urgency levels by setting the appropriate environment variables ``AUTO_NOTIFY_URGENCY_ON_SUCCESS`` or ``AUTO_NOTIFY_URGENCY_ON_ERROR`` to either ``low``, ``normal``, or ``critical``. +NOTE: This configuration option currently only works for Linux. + +:: + + # Set notification urgency level on error to normal + export AUTO_NOTIFY_URGENCY_ON_ERROR="normal" **Ignored Commands**