From 51f68ff3829859a4de81d6f0580caa93684bb88b Mon Sep 17 00:00:00 2001 From: Tobias Witek Date: Mon, 23 Oct 2017 17:14:00 +0200 Subject: [PATCH] [README] Add note on event handling fixes #195 --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index aaf0e30..a9e9fe8 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,37 @@ bar { Restart i3wm and - that's it! +## Events +By default, the following events are handled: + +- Mouse-Wheel on any module moves to the next/previous i3 workspace +- Left-click on the "disk" module opens the specified path in nautilus +- Left-click on either "memory" or "cpu" opens gnome-system-monitor +- Left-click on a "pulseaudio" (or pasource/pasink) module toggles the mute state +- Right-click on a "pulseaudio" module opens pavucontrol +- Mouse-Wheel up/down on a "pulseaudio" module raises/lowers the volume +- By default, the Mouse-Wheel wraps for the current output. You can disable this behavior by providing the parameter engine.workspacewrap=false (starting with version 1.4.5). Also, you can completely disable output switching by using engine.workspacewheel=false. + +You can provide your own handlers to any module by using the following "special" configuration parameters: + +- left-click +- right-click +- middle-click +- wheel-up +- wheel-down +For example, to execute "pavucontrol" whenever you left-click on the nic module, you could write: + +`$ bumblebee-status -p nic.left-click="pavucontrol"` + +In the string, you can use the following format identifiers: +- name +- instance +- button + +For example: + +`$ bumblebee-status -p disk.left-click="nautilus {instance}"` + ## Errors If errors occur, you should see them in the i3bar itself. If that does not work, or you need more information for troubleshooting, you can activate a debug log using the `-d` or `--debug` switch: