Merge pull request #230 from torvitas/patch-2

updates documentation so next time I do not have to read the source code
This commit is contained in:
tobi-wan-kenobi 2018-02-14 18:23:41 +01:00 committed by GitHub
commit f2b3d874cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,14 +1,17 @@
# pylint: disable=C0111,R0903
"""Displays volume and mute status of PulseAudio devices.
"""Displays volume and mute status and controls for PulseAudio devices. Use wheel up and down to change volume, left click mutes, right click opens pavucontrol.
Aliases: pasink, pasource
Aliases: pasink (use this to control output instead of input), pasource
Parameters:
* pulseaudio.autostart: If set to "true" (default is "false"), automatically starts the pulseaudio daemon if it is not running
Requires the following executable:
* pulseaudio
* pactl
* pavucontrol
* pacmd
"""
import re