Update README and defaults.conf

This commit is contained in:
Rico Tiongson 2020-04-18 02:20:18 +08:00
parent 1e900945af
commit 435e46373f
3 changed files with 99 additions and 46 deletions

4
CHANGELOG Normal file
View File

@ -0,0 +1,4 @@
v1.1.0
* Added mouse hold gestures
* Added `hold3` configuration
* Added `hold4` configuration

View File

@ -2,8 +2,11 @@
[![comfortable-swipe version](https://img.shields.io/github/release/Hikari9/comfortable-swipe.svg?label=comfortable-swipe&color=orange)](https://github.com/Hikari9/comfortable-swipe/releases) [![comfortable-swipe version](https://img.shields.io/github/release/Hikari9/comfortable-swipe.svg?label=comfortable-swipe&color=orange)](https://github.com/Hikari9/comfortable-swipe/releases)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
> **_New in Version 1.1.0!_** Added mouse move gestures (eg. `hold3 = button1`)
Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures for Ubuntu 14.04 LTS and beyond. May work for other Linux distros that support `libinput`. Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures for Ubuntu 14.04 LTS and beyond. May work for other Linux distros that support `libinput`.
## Installation ## Installation
1. Install git, libinput, and g++ 1. Install git, libinput, and g++
@ -47,20 +50,19 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
comfortable-swipe status comfortable-swipe status
``` ```
## Configurations ## Swipe Configurations
Comfortable swipe makes use of keyboard shortcuts for configurations. Edit by running
Comfortable swipe makes use of keyboard shortcuts for configurations.
1. Edit by running
``` ```
gedit $(comfortable-swipe config) gedit $(comfortable-swipe config)
``` ```
Make sure to run after making changes: 1. List of possible configurations:
```
comfortable-swipe restart
```
Property | Description | Default Value | Default Behavior Property | Description | Default Value | Default Behavior
--------- | ----------- | -------------- | ----- --------- | :-----------: | -------------- | -----
threshold | mouse pixels to activate swipe; higher = less sensitive; floating-point (Note: Sky is the limit! Can be as large as 1000.0) | 0.0
left3 | 3-finger swipe left | ctrl+alt+Right | switch to right workspace left3 | 3-finger swipe left | ctrl+alt+Right | switch to right workspace
left4 | 4-finger swipe left | ctrl+alt+shift+Right | move window to right workspace left4 | 4-finger swipe left | ctrl+alt+shift+Right | move window to right workspace
right3 | 3-finger swipe right | ctrl+alt+Left | switch to left workspace right3 | 3-finger swipe right | ctrl+alt+Left | switch to left workspace
@ -69,6 +71,14 @@ up3 | 3-finger swipe up | ctrl+alt+Down | switch to bottom workspace
up4 | 4-finger swipe up | ctrl+alt+shift+Down | move window to bottom workspace up4 | 4-finger swipe up | ctrl+alt+shift+Down | move window to bottom workspace
down3 | 3-finger swipe down | ctrl+alt+Down | switch to above workspace down3 | 3-finger swipe down | ctrl+alt+Down | switch to above workspace
down4 | 4-finger swipe down | ctrl+alt+shift+Up | move window to above workpace down4 | 4-finger swipe down | ctrl+alt+shift+Up | move window to above workpace
threshold | mouse pixels to activate swipe | 0.0 | tweak this if you're having troubles with touchpad sensitivity (higher = less sensitive, values can be as large as 1000.0)
hold3 | holds a mouse button when 3 fingers are down | (none) | See [Mouse Gestures](#mouse-configurations)
hold4 | holds a mouse button when 4 fingers are down | (none) | See [Mouse Gestures](#mouse-configurations)
1. After making changes, make sure to restart the program:
```
comfortable-swipe restart
```
Taken from `man xdotool`: Taken from `man xdotool`:
@ -86,6 +96,48 @@ Taken from `man xdotool`:
Refer to https://www.linux.org/threads/xdotool-keyboard.10528/ for a complete list of keycodes you can use. Refer to https://www.linux.org/threads/xdotool-keyboard.10528/ for a complete list of keycodes you can use.
## Mouse Gestures
> **Note**: Setting hold3 or hold4 will ignore its corresponding up/right/down/left command.
We have included simple mouse gestures on swipe by setting `hold3` and `hold4`.
**Possible values**:
* move - just move the mouse
* button1 - left click
* button2 - middle click
* button3 - right click
* button4 - wheel up (experimental)
* button5 - wheel down (experimental)
## Example Configuration
Edit with `gedit $(comfortable-swipe config)`:
```conf
# File: comfortable-swipe.conf
# four-finger drag
hold4 = button1
# show desktop
down3 = super+d
# show workspaces
up3 = super+s
# switch workspace
left3 = ctrl+alt+Right
right3 = ctrl+alt+Left
# disabled because of hold4
left4 = ctrl+alt+shift+Right
right4 = ctrl+alt+shift+Left
# three-finger middle click (experimental)
# hold3 = button2
```
## Debugging ## Debugging

View File

@ -6,32 +6,6 @@
# Refer to https://www.linux.org/threads/xdotool-keyboard.10528/ for a list of # Refer to https://www.linux.org/threads/xdotool-keyboard.10528/ for a list of
# keycodes you can use. # keycodes you can use.
#############################
# Experimental: MOUSE HOLD #
#############################
# Uncomment to allow moving the mouse on 3/4 fingers
# hold3 = move
# hold4 = move
# Uncomment to hold a mouse button on 3/4 fingers
# (1: left click, 2: middle click, 3: right click, 4: wheel up, 5: wheel down)
# hold3 = button1
# hold4 = button1
#################
# MISCELLANEOUS #
#################
# Threshold
# Tweak this value depending on the sensitivity of your mousepad to perform
# gestures. A higher value means less sensitive.
#
# (Note: Sky is the limit! Can be as large as 1000.0)
#
# Default: threshold = 0.0
threshold = 0.0
############################# #############################
# THREE / FOUR FINGER SWIPE # # THREE / FOUR FINGER SWIPE #
############################# #############################
@ -75,3 +49,26 @@ down3 = ctrl+alt+Up
# The default shortcut is moving current window to the above workspace. # The default shortcut is moving current window to the above workspace.
# Default: ctrl+alt+shift+Up # Default: ctrl+alt+shift+Up
down4 = ctrl+alt+shift+Up down4 = ctrl+alt+shift+Up
#################
# MISCELLANEOUS #
#################
# Threshold
# Tweak this value depending on the sensitivity of your mousepad to perform
# gestures. A higher value means less sensitive (Sky is the limit! Can be as
# large as 1000.0).
# Default: threshold = 0.0
threshold = 0.0
#############################
# Experimental: MOUSE HOLD #
#############################
# (1: left click, 2: middle click, 3: right click, 4: wheel up, 5: wheel down)
# Uncomment to hold a mouse button on 3/4 fingers
# hold3 = button1
# hold4 = button1
# You can also set to just "move" the mouse
# hold3 = move