RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: more documentation on mouse gestures

This commit is contained in:
Peter F. Patel-Schneider 2021-10-07 18:45:47 -04:00
parent a89a973419
commit b3c3ad02c8
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/capabilities.md
View File

@ -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 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. 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. Mouse gestures is an experimental feature.
Significant changes might be made to it in the future. Significant changes might be made to it in the future.

5
docs/rules.md
View File

@ -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`). Solaar reads rules from a YAML configuration file (normally `~/.config/solaar/rules.yaml`).
This file contains zero or more documents, each a rule. 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 %YAML 1.3
--- ---
- MouseGesture: [Mouse Up, Mouse Down]
- Execute: xflock4
...
- Feature: CROWN - Feature: CROWN
- Process: quodlibet - Process: quodlibet
- Rule: [ Test: crown_start_press, KeyPress: XF86_AudioMute ] - Rule: [ Test: crown_start_press, KeyPress: XF86_AudioMute ]