From 52134ab8ceab9610552c92c0615cc8f2fcbab746 Mon Sep 17 00:00:00 2001 From: fwsmit Date: Thu, 21 Jan 2021 16:40:32 +0100 Subject: [PATCH] Add documentation for environment variables passed to scripts --- docs/dunst.5.pod | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/dunst.5.pod b/docs/dunst.5.pod index 09a7bf3..aff803b 100644 --- a/docs/dunst.5.pod +++ b/docs/dunst.5.pod @@ -869,11 +869,22 @@ Within rules you can specify a script to be run every time the rule is matched by assigning the 'script' option to the name of the script to be run. When the script is called details of the notification that triggered it will be -passed via command line parameters in the following order: appname, summary, -body, icon, urgency. +passed via environment variables. The following variables are available: +B, B, B, B, +B, B, B, B, +B, B, B, B +and B. -Where icon is the absolute path to the icon file if there is one and urgency is -one of "LOW", "NORMAL" or "CRITICAL". +Another, less recommended way to get notifcations details from a script is via +command line parameters. These are passed to the script in the following order: +B, B, B, B, B. + +Where B or B is the absolute path to the icon file +if there is one. B or B is one of "LOW", "NORMAL" or +"CRITICAL". B is a newline-separated list of urls associated with +the notification. + +Note that some variables may be empty. If the notification is suppressed, the script will not be run unless B is set to true.