add: environment vars to usage

Signed-off-by: Beau Hastings <[email protected]>
hastinbe · Nov 2, 2020 · 09010d2 · 09010d2
1 parent 58913df
commit 09010d2
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -59,14 +59,16 @@ Commands:
 
                                   examples:
                                       "Volume is %v" = Volume is 50%
-                                      "%i %v %p \n"  = 奔50% ██████████
+                                      "%i %v %p \n"  = 奔 50% ██████████
   outputs                     show available output formats
   notifications               show available notification methods
   help                        display help
 
 Options:
   -a                          use amixer
   -n                          enable notifications
+  -C                          use libcanberra for playing event sounds
+  -P                          play sound for volume changes
   -j <muted,high,low,medium>  specify custom volume emojis as a comma separated list
   -t <process_name>           process name of status bar (requires -u)
   -u <signal>                 signal to update status bar (requires -t)
@@ -88,6 +90,15 @@ Notification Options:
   -l                          use fullcolor instead of symbolic icons
   -S <suffix>                 append suffix to symbolic icon names
   -y                          use dunstify (default: notify-send)
+
+Environment Variables:
+  XOSD_PATH                   path to osd_cat
+  HERBE_PATH                  path to herbe
+  VOLNOTI_PATH                path to volnoti-show
+  DUNSTIFY_PATH               path to dunstify
+  CANBERRA_PATH               path to canberra-gtk-play
+  NOTIFY_SEND_PATH            path to notify-send or notify-send.py
+  USE_NOTIFY_SEND_PY          flag to use notify-send.py instead of notify-send
 ```
 
 ## Migrating

diff --git a/volume b/volume
@@ -465,6 +465,15 @@ ${COLOR_YELLOW}Notification Options:${COLOR_RESET}
   ${COLOR_GREEN}-l${COLOR_RESET}                          use fullcolor instead of symbolic icons
   ${COLOR_GREEN}-S <suffix>${COLOR_RESET}                 append suffix to symbolic icon names
   ${COLOR_GREEN}-y${COLOR_RESET}                          use dunstify (${COLOR_MAGENTA}default: notify-send${COLOR_RESET})
+
+${COLOR_YELLOW}Environment Variables:${COLOR_RESET}
+  ${COLOR_CYAN}XOSD_PATH${COLOR_RESET}                   path to osd_cat
+  ${COLOR_CYAN}HERBE_PATH${COLOR_RESET}                  path to herbe
+  ${COLOR_CYAN}VOLNOTI_PATH${COLOR_RESET}                path to volnoti-show
+  ${COLOR_CYAN}DUNSTIFY_PATH${COLOR_RESET}               path to dunstify
+  ${COLOR_CYAN}CANBERRA_PATH${COLOR_RESET}               path to canberra-gtk-play
+  ${COLOR_CYAN}NOTIFY_SEND_PATH${COLOR_RESET}            path to notify-send or notify-send.py
+  ${COLOR_CYAN}USE_NOTIFY_SEND_PY${COLOR_RESET}          flag to use notify-send.py instead of notify-send
 EOF
         exit "$EX_USAGE"
     }
@@ -941,6 +950,7 @@ setup_color() {
         COLOR_GREEN=$'\033[0;32m'
         COLOR_YELLOW=$'\033[0;33m'
         COLOR_MAGENTA=$'\033[0;35m'
+        COLOR_CYAN=$'\033[0;36m'
     fi
 }
 
@@ -1190,7 +1200,8 @@ main() {
         COLOR_RED \
         COLOR_GREEN \
         COLOR_YELLOW \
-        COLOR_MAGENTA
+        COLOR_MAGENTA \
+        COLOR_CYAN
 
     ###########################################################
     # Command line option variables