Merge branch 'master' into next

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 804877d5dcf2e433a0936ac304bab6edb6f25b25..e752ec82f197a95e5bf3dff32c1759d5370ec095 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -1104,6 +1104,27 @@ bar {
 
 Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
 
+=== Mouse button commands
+
+Specifies a command to run when a button was pressed on i3bar to override the
+default behavior. Currently only the mouse wheel buttons are supported. This is
+useful for disabling the scroll wheel action or running scripts that implement
+custom behavior for these buttons.
+
+*Syntax*:
+---------------------
+wheel_up_cmd <command>
+wheel_down_cmd <command>
+---------------------
+
+*Example*:
+---------------------
+bar {
+    wheel_up_cmd nop
+    wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down
+}
+---------------------
+
 === Bar ID
 
 Specifies the bar ID for the configured bar instance. If this option is missing,