From a9bd1d61b87e13d3aed7e2f9b110248fe4b05f6a Mon Sep 17 00:00:00 2001 From: pseudometa <73286100+chrisgrieser@users.noreply.github.com> Date: Sat, 29 Apr 2023 12:23:02 +0200 Subject: [PATCH] docs: add info on sound setting --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index 70ea746..cabb8d6 100644 --- a/README.rst +++ b/README.rst @@ -118,6 +118,15 @@ An example of how these values can be set is shown below: export AUTO_NOTIFY_TITLE="Hey! %command has just finished" export AUTO_NOTIFY_BODY="It completed in %elapsed seconds with exit code %exit_code" +**Notificaton Sound** + +The notification can also trigger playing a short sound by changing ``AUTO_NOTIFY_USE_SOUND``. +NOTE: This configuration option currently only works for macOS. + +:: +   # Enable using sound (default: 0) +   export AUTO_NOTIFY_USE_SOUND=1 + **Notification Expiration Time** You can set how long a notification sent by ``auto-notify`` will remain showing by setting the environment