From b3c3ad02c8f00c685b77ad85a3ac907d204d60a2 Mon Sep 17 00:00:00 2001 From: "Peter F. Patel-Schneider" Date: Thu, 7 Oct 2021 18:45:47 -0400 Subject: [PATCH] doc: more documentation on mouse gestures --- docs/capabilities.md | 4 ++++ docs/rules.md | 5 ++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/capabilities.md b/docs/capabilities.md index d251b9cb..25e64198 100644 --- a/docs/capabilities.md +++ b/docs/capabilities.md @@ -164,6 +164,10 @@ Pressing the button, if the button is diverted, causes the mouse pointer to stop When the button is released a MOUSE_GESTURE notification with the total mouse movement while the button was pressed is sent to the Solaar rule system. +MOUSE_GESTURE notifications trigger mouse gesture conditions in Solaar rules. +For more information on mouse gesture rules conditions see +[the rules page](https://pwr-solaar.github.io/Solaar/rules). + Mouse gestures is an experimental feature. Significant changes might be made to it in the future. diff --git a/docs/rules.md b/docs/rules.md index acf32a43..7fb05a62 100644 --- a/docs/rules.md +++ b/docs/rules.md @@ -125,11 +125,14 @@ All of these rules are only active if the key or feature is diverted, of course. Solaar reads rules from a YAML configuration file (normally `~/.config/solaar/rules.yaml`). This file contains zero or more documents, each a rule. -Here is a file with three rules: +Here is a file with four rules: ``` %YAML 1.3 --- +- MouseGesture: [Mouse Up, Mouse Down] +- Execute: xflock4 +... - Feature: CROWN - Process: quodlibet - Rule: [ Test: crown_start_press, KeyPress: XF86_AudioMute ]