From 87714f12eeaa2e1b17828618522c18faaccbb8dc Mon Sep 17 00:00:00 2001
From: Tobi-wan Kenobi <github@tobi-wan-kenobi.at>
Date: Thu, 5 Jan 2017 04:55:14 +0100
Subject: [PATCH] [modules/*] Add required executables/commandline tools to
 help output

fixes #39
---
 bumblebee/modules/brightness.py | 4 ++++
 bumblebee/modules/caffeine.py   | 4 ++++
 bumblebee/modules/cmus.py       | 3 +++
 bumblebee/modules/dnf.py        | 3 +++
 bumblebee/modules/gpmdp.py      | 2 ++
 bumblebee/modules/layout.py     | 3 +++
 bumblebee/modules/pacman.py     | 4 ++++
 bumblebee/modules/ping.py       | 3 +++
 bumblebee/modules/pulseaudio.py | 3 +++
 bumblebee/modules/xrandr.py     | 2 ++
 10 files changed, 31 insertions(+)

diff --git a/bumblebee/modules/brightness.py b/bumblebee/modules/brightness.py
index 99712f0..716a734 100644
--- a/bumblebee/modules/brightness.py
+++ b/bumblebee/modules/brightness.py
@@ -2,8 +2,12 @@
 
 """Displays the brightness of a display
 
+Requires the following executable:
+    * xbacklight
+
 Parameters:
     * brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
+
 """
 
 import bumblebee.input
diff --git a/bumblebee/modules/caffeine.py b/bumblebee/modules/caffeine.py
index bf57be6..2354ed0 100644
--- a/bumblebee/modules/caffeine.py
+++ b/bumblebee/modules/caffeine.py
@@ -1,6 +1,10 @@
 # pylint: disable=C0111,R0903
 
 """Enable/disable automatic screen locking.
+
+Requires the following executables:
+    * xset
+    * notify-send
 """
 
 import bumblebee.input
diff --git a/bumblebee/modules/cmus.py b/bumblebee/modules/cmus.py
index 991a1a1..2bb46fa 100644
--- a/bumblebee/modules/cmus.py
+++ b/bumblebee/modules/cmus.py
@@ -2,6 +2,9 @@
 
 """Displays information about the current song in cmus.
 
+Requires the following executable:
+    * cmus-remote
+
 Parameters:
     * cmus.format: Format string for the song information. Tag values can be put in curly brackets (i.e. {artist})
 """
diff --git a/bumblebee/modules/dnf.py b/bumblebee/modules/dnf.py
index 2cb249b..8dc000f 100644
--- a/bumblebee/modules/dnf.py
+++ b/bumblebee/modules/dnf.py
@@ -2,6 +2,9 @@
 
 """Displays DNF package update information (<security>/<bugfixes>/<enhancements>/<other>)
 
+Requires the following executable:
+    * dnf
+
 Parameters:
     * dnf.interval: Time in seconds between two consecutive update checks (defaulst to 1800)
 
diff --git a/bumblebee/modules/gpmdp.py b/bumblebee/modules/gpmdp.py
index 57f3c1a..36988e8 100644
--- a/bumblebee/modules/gpmdp.py
+++ b/bumblebee/modules/gpmdp.py
@@ -2,6 +2,8 @@
 
 """Displays information about the current song in Google Play music player.
 
+Requires the following executable:
+    * gpmdp-remote
 """
 
 import string
diff --git a/bumblebee/modules/layout.py b/bumblebee/modules/layout.py
index cb4f87d..d9daadb 100644
--- a/bumblebee/modules/layout.py
+++ b/bumblebee/modules/layout.py
@@ -2,6 +2,9 @@
 
 """Displays and changes the current keyboard layout
 
+Requires the following executable:
+    * setxkbmap
+
 Parameters:
     * layout.lang: pipe-separated list of languages to cycle through (e.g. us|rs|de). Default: en
 """
diff --git a/bumblebee/modules/pacman.py b/bumblebee/modules/pacman.py
index da3e66f..4fd0cd8 100644
--- a/bumblebee/modules/pacman.py
+++ b/bumblebee/modules/pacman.py
@@ -1,6 +1,10 @@
 # pylint: disable=C0111,R0903
 
 """Displays update information per repository for pacman."
+
+Requires the following executables:
+    * fakeroot
+    * pacman
 """
 
 import os
diff --git a/bumblebee/modules/ping.py b/bumblebee/modules/ping.py
index 6217438..dd6f9cc 100644
--- a/bumblebee/modules/ping.py
+++ b/bumblebee/modules/ping.py
@@ -2,6 +2,9 @@
 
 """Periodically checks the RTT of a configurable host using ICMP echos
 
+Requires the following executable:
+    * ping
+
 Parameters:
     * ping.interval: Time in seconds between two RTT checks (defaults to 60)
     * ping.address : IP address to check
diff --git a/bumblebee/modules/pulseaudio.py b/bumblebee/modules/pulseaudio.py
index 07fbd8d..0bf88f4 100644
--- a/bumblebee/modules/pulseaudio.py
+++ b/bumblebee/modules/pulseaudio.py
@@ -3,6 +3,9 @@
 """Displays volume and mute status of PulseAudio devices.
 
 Aliases: pasink, pasource
+
+Requires the following executable:
+    * pactl
 """
 
 import re
diff --git a/bumblebee/modules/xrandr.py b/bumblebee/modules/xrandr.py
index def9235..e362e97 100644
--- a/bumblebee/modules/xrandr.py
+++ b/bumblebee/modules/xrandr.py
@@ -2,6 +2,8 @@
 
 """Shows a widget for each connected screen and allows the user to enable/disable screens.
 
+Requires the following executable:
+    * xrandr
 """
 
 import os