[modules/*] Add required executables/commandline tools to help output

fixes #39
This commit is contained in:
Tobi-wan Kenobi 2017-01-05 04:55:14 +01:00
parent d3fc5094f8
commit 87714f12ee
10 changed files with 31 additions and 0 deletions

View file

@ -2,8 +2,12 @@
"""Displays the brightness of a display """Displays the brightness of a display
Requires the following executable:
* xbacklight
Parameters: Parameters:
* brightness.step: The amount of increase/decrease on scroll in % (defaults to 2) * brightness.step: The amount of increase/decrease on scroll in % (defaults to 2)
""" """
import bumblebee.input import bumblebee.input

View file

@ -1,6 +1,10 @@
# pylint: disable=C0111,R0903 # pylint: disable=C0111,R0903
"""Enable/disable automatic screen locking. """Enable/disable automatic screen locking.
Requires the following executables:
* xset
* notify-send
""" """
import bumblebee.input import bumblebee.input

View file

@ -2,6 +2,9 @@
"""Displays information about the current song in cmus. """Displays information about the current song in cmus.
Requires the following executable:
* cmus-remote
Parameters: Parameters:
* cmus.format: Format string for the song information. Tag values can be put in curly brackets (i.e. {artist}) * cmus.format: Format string for the song information. Tag values can be put in curly brackets (i.e. {artist})
""" """

View file

@ -2,6 +2,9 @@
"""Displays DNF package update information (<security>/<bugfixes>/<enhancements>/<other>) """Displays DNF package update information (<security>/<bugfixes>/<enhancements>/<other>)
Requires the following executable:
* dnf
Parameters: Parameters:
* dnf.interval: Time in seconds between two consecutive update checks (defaulst to 1800) * dnf.interval: Time in seconds between two consecutive update checks (defaulst to 1800)

View file

@ -2,6 +2,8 @@
"""Displays information about the current song in Google Play music player. """Displays information about the current song in Google Play music player.
Requires the following executable:
* gpmdp-remote
""" """
import string import string

View file

@ -2,6 +2,9 @@
"""Displays and changes the current keyboard layout """Displays and changes the current keyboard layout
Requires the following executable:
* setxkbmap
Parameters: Parameters:
* layout.lang: pipe-separated list of languages to cycle through (e.g. us|rs|de). Default: en * layout.lang: pipe-separated list of languages to cycle through (e.g. us|rs|de). Default: en
""" """

View file

@ -1,6 +1,10 @@
# pylint: disable=C0111,R0903 # pylint: disable=C0111,R0903
"""Displays update information per repository for pacman." """Displays update information per repository for pacman."
Requires the following executables:
* fakeroot
* pacman
""" """
import os import os

View file

@ -2,6 +2,9 @@
"""Periodically checks the RTT of a configurable host using ICMP echos """Periodically checks the RTT of a configurable host using ICMP echos
Requires the following executable:
* ping
Parameters: Parameters:
* ping.interval: Time in seconds between two RTT checks (defaults to 60) * ping.interval: Time in seconds between two RTT checks (defaults to 60)
* ping.address : IP address to check * ping.address : IP address to check

View file

@ -3,6 +3,9 @@
"""Displays volume and mute status of PulseAudio devices. """Displays volume and mute status of PulseAudio devices.
Aliases: pasink, pasource Aliases: pasink, pasource
Requires the following executable:
* pactl
""" """
import re import re

View file

@ -2,6 +2,8 @@
"""Shows a widget for each connected screen and allows the user to enable/disable screens. """Shows a widget for each connected screen and allows the user to enable/disable screens.
Requires the following executable:
* xrandr
""" """
import os import os