diff options
Diffstat (limited to 'README')
-rw-r--r-- | README | 20 |
1 files changed, 18 insertions, 2 deletions
@@ -1,2 +1,18 @@ -The vlm script helps the user to easily set keyboard shortcuts to -control pulseaudio volume, mute and switch pulseaudio output.
\ No newline at end of file +The vlm script provides elementary sound control actions to set +pulseaudio volume, mute or unmute sound and cycle through pulseaudio +outputs, such that actions performed through this script will probably +achieve sane results on all systems using pulseaudio. The script does +not need any configuration from the user to perform its actions. + +It is provided so that the user can bind the script's actions to +keyboard shortcuts of his choosing, and have those shortcuts trigger +easy and consistent sound control actions. + +Because the script's capabilities are not exhaustive, and because it +does not provide any output about their effects, it can not replace a +full-blown sound mixer program. + +The script uses the pactl program to determine the currently active +pulseaudio sink, then uses the same command again to perform its action. + +For usage information, type the command vlm without any argument. |