ervin/comfortable-swipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Rico Tiongson 2020-05-07 23:33:13 +08:00
parent 548199bc38
commit b2d1674ba4
1 changed files with 116 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

189
README.md
View File

@ -11,7 +11,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
## Installation ## Installation
1. Install git and g++ 1. Install git and g++ ≥ 7.5
```bash ```bash
sudo apt install git g++ sudo apt install git g++
@ -69,7 +69,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
comfortable-swipe config list comfortable-swipe config list
``` ```
Example: <details> <summary> Example: </summary>
```bash ```bash
$ comfortable-swipe config list $ comfortable-swipe config list
@ -85,13 +85,15 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
left3 = ctrl+super+Right left3 = ctrl+super+Right
``` ```
</details>
1) Get config 1) Get config
``` ```
comfortable-swipe <PROPERTY> comfortable-swipe <PROPERTY>
``` ```
Examples: <details> <summary> Examples: </summary>
```bash ```bash
$ comfortable-swipe left3 $ comfortable-swipe left3
@ -108,19 +110,19 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
1.0 1.0
``` ```
</details>
1) Set config 1) Set config
```bash ```bash
comfortable-swipe <PROPERTY> [=] <VALUES> comfortable-swipe <PROPERTY> [=] <VALUES>
``` ```
Examples:
```bash ```bash
comfortable-swipe left3 super+Right comfortable-swipe left3 = super+Right
comfortable-swipe right3 super+Left comfortable-swipe right3 = super+Left
comfortable-swipe right4 ctrl alt + Left comfortable-swipe right4 = ctrl+alt+Left
comfortable-swipe down4 super+d comfortable-swipe down4 = super+d
comfortable-swipe up3 = ctrl+shift+Up comfortable-swipe up3 = ctrl+shift+Up
``` ```
@ -131,10 +133,7 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
/home/hikari9/.config/comfortable-swipe.conf /home/hikari9/.config/comfortable-swipe.conf
``` ```
<details> 1) Autostart
<summary>Other Commands</summary>
1. Autostart
```bash ```bash
comfortable-swipe autostart comfortable-swipe autostart
@ -145,6 +144,9 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
comfortable-swipe autostart path comfortable-swipe autostart path
``` ```
<details>
<summary><b>Other Commands</b></summary>
1. Configurations 1. Configurations
```bash ```bash
@ -184,17 +186,25 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
The default configuration file is located at `~/.config/comfortable-swipe.conf`. The default configuration file is located at `~/.config/comfortable-swipe.conf`.
Comfortable swipe makes use of **keyboard shortcuts** to perform swipes, through `xdotool`. Comfortable swipe makes use of **keyboard shortcuts** to perform swipes, through `xdotool`.
Edit the configuration file by running: List all properties with:
```
comfortable-swipe config list
```
Set a property directly with:
```
comfortable-swipe <PROPERTY> [=] <VALUE>
```
Or edit the configuration file manually:
``` ```
gedit ~/.config/comfortable-swipe.conf gedit ~/.config/comfortable-swipe.conf
``` ```
After making changes, make sure to restart the program: After editing, make sure to restart with `comfortable-swipe start`.
```
comfortable-swipe start
```
> **Warning**: For v1.1.0 below, the configuration file is located at > **Warning**: For v1.1.0 below, the configuration file is located at
> `/usr/local/share/comfortable-swipe/comfortable-swipe.conf` > `/usr/local/share/comfortable-swipe/comfortable-swipe.conf`
@ -203,19 +213,19 @@ comfortable-swipe start
## Configuration Reference ## Configuration Reference
| Key | Value | Defaults | | Property | Value | Examples |
| --------- | :--------------------------------------------------------------------: | ----------------------------------------------------------------- | | --------- | :--------------------------------------------------------------------: | ---------------------------------------------------------------------------------- |
| left3 | 3-finger swipe left | ctrl+alt+Right | | left3 | 3-finger swipe left | ctrl+alt+Right |
| left4 | 4-finger swipe left | ctrl+alt+shift+Right | | left4 | 4-finger swipe left | ctrl+alt+shift+Right |
| right3 | 3-finger swipe right | ctrl+alt+Left | | right3 | 3-finger swipe right | ctrl+alt+Left |
| right4 | 4-finger swipe right | ctrl+alt+shift+Left | | right4 | 4-finger swipe right | ctrl+alt+shift+Left |
| up3 | 3-finger swipe up | ctrl+alt+Down | | up3 | 3-finger swipe up | ctrl+alt+Down |
| up4 | 4-finger swipe up | ctrl+alt+shift+Down | | up4 | 4-finger swipe up | ctrl+alt+shift+Down |
| down3 | 3-finger swipe down | ctrl+alt+Up | | down3 | 3-finger swipe down | ctrl+alt+Up |
| down4 | 4-finger swipe down | ctrl+alt+shift+Up | | down4 | 4-finger swipe down | ctrl+alt+shift+Up |
| threshold | mouse movement pixels that trigger a swipe (can be as large as 1000.0) | 0.0, 240.0, 1000.0 | | threshold | mouse movement pixels that trigger a swipe (can be as large as 1000.0) | 0.0 / 240.0 / 1000.0 |
| mouse3 | mouses a mouse button when 3 fingers are down | button1 <br> (see [Mouse Gestures](#mouse-gestures-experimental)) | | | mouse3 | mouses a mouse button when 3 fingers are down | button1 / move / scroll<br> _(see [Mouse Gestures](#mouse-gestures-experimental))_ | |
| mouse4 | mouses a mouse button when 4 fingers are down | button1 <br> (see [Mouse Gestures](#mouse-gestures-experimental) | | mouse4 | mouses a mouse button when 4 fingers are down | button1 / move / scroll <br> _(see [Mouse Gestures](#mouse-gestures-experimental)_ |
### Keystrokes ### Keystrokes
@ -235,11 +245,11 @@ 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.
Keyboard shortcuts: - [DEFKEY - All Linux keyboard shortcuts](https://defkey.com/)
- [Unity Keyboard Shortcuts](https://cheatography.com/sapemeg/cheat-sheets/ubuntu-unity-16-04/) - [Unity Keyboard Shortcuts](https://cheatography.com/sapemeg/cheat-sheets/ubuntu-unity-16-04/)
- [GNOME Keyboard Shortcuts](https://wiki.gnome.org/Design/OS/KeyboardShortcuts) - [GNOME Keyboard Shortcuts](https://wiki.gnome.org/Design/OS/KeyboardShortcuts)
- [KDE Keyboard Shortcuts](https://community.linuxmint.com/tutorial/view/47) - [KDE Keyboard Shortcuts](https://community.linuxmint.com/tutorial/view/47)
- [PopOS Keyboard Shortcuts](https://support.system76.com/articles/pop-keyboard-shortcuts/)
## Example Configurations ## Example Configurations
@ -248,92 +258,118 @@ This section includes some example configurations which you can use for your swi
1. Switch workspace (horizontal) 1. Switch workspace (horizontal)
```bash ```bash
comfortable-swipe config set left3 = ctrl+alt+Right # Ubuntu flavors + GNOME
comfortable-swipe config set right3 = ctrl+alt+Left comfortable-swipe left3 = ctrl+alt+Right
comfortable-swipe right3 = ctrl+alt+Left
``` ```
1. Switch workspace (vertical) 1. Switch workspace (vertical)
``` ```bash
up3 = ctrl+alt+Down # Ubuntu flavors + GNOME
down3 = ctrl+alt+Up comfortable-swipe up3 = ctrl+alt+Down
comfortable-swipe down3 = ctrl+alt+Up
``` ```
```bash ```bash
up3 = super+PgDown # GNOME alt.
down3 = super+PgUp comfortable-swipe up3 = super+PgDown
comfortable-swipe down3 = super+PgUp
```
```bash
# Pop OS
comfortable-swipe up3 = ctrl+super+Down
comfortable-swipe down3 = ctrl+super+Up
``` ```
1. Move window to workspace (horizontal) 1. Move window to workspace (horizontal)
```bash ```bash
left4 = ctrl+alt+shift+Right # Ubuntu flavors + GNOME + Kali
right4 = ctrl+alt+shift+Left comfortable-swipe left4 = ctrl+alt+shift+Right
comfortable-swipe right4 = ctrl+alt+shift+Left
```
```bash
# Elementary OS
comfortable-swipe left4 = super+alt+Right
comfortable-swipe right4 = super+alt+Left
``` ```
1. Move window to workspace (vertical) 1. Move window to workspace (vertical)
```bash ```bash
up4 = ctrl+alt+shift+Down # Ubuntu flavors + GNOME + Kali
down4 = ctrl+alt+shift+Up comfortable-swipe up4 = ctrl+alt+shift+Down
comfortable-swipe down4 = ctrl+alt+shift+Up
``` ```
```bash ```bash
up4 = super+shift+PgDown # GNOME alt.
down4 = super+shift+PgUp comfortable-swipe up4 = super+shift+PgDown
comfortable-swipe down4 = super+shift+PgUp
``` ```
1. Move window to other monitor 1. Move window to other monitor
```bash ```bash
left4 = super+shift+Right # Ubuntu flavors + GNOME
right4 = super+shift+Left comfortable-swipe left4 = super+shift+Right
comfortable-swipe right4 = super+shift+Left
``` ```
1. Toggle workspace overview 1. Toggle workspace overview
```bash ```bash
up3 = super+s # Ubuntu flavors + Elementary OS
comfortable-swipe up3 = super+s
```
```bash
# Elementary OS (all workspaces)
comfortable-swipe up4 = super+a
``` ```
1. Show desktop 1. Show desktop
```bash ```bash
down3 = super+d # Ubuntu flavors
comfortable-swipe down3 = ctrl+super+d
``` ```
```bash ```bash
down3 = ctrl+super+d # Linux Mint
comfortable-swipe down3 = super+d
``` ```
```bash ```bash
down3 = ctrl+alt+d # Kali
comfortable-swipe down3 = ctrl+alt+d
```
```bash
# KDE
comfortable-swipe down3 = ctrl+F12
``` ```
1. Snap windows to the left/right 1. Snap windows to the left/right
```bash ```bash
left3 = super+Left comfortable-swipe left3 = super+Left
right3 = super+Right comfortable-swipe right3 = super+Right
``` ```
1. Toggle maximize 1. Toggle maximize
```bash ```bash
up3 = super+Up comfortable-swipe up3 = super+Up
``` ```
1. Toggle minimize 1. Toggle minimize
```bash ```bash
down3 = super+Down comfortable-swipe down3 = super+Down
```
1. Alt+Tab switch application (experimental)
```bash
left3 = alt+Tab
right3 = alt+shift+Tab
``` ```
## Mouse Gestures (Experimental) ## Mouse Gestures (Experimental)
@ -363,42 +399,42 @@ Examples:
- 3/4-finger drag - 3/4-finger drag
```bash ```bash
mouse3 = button1 comfortable-swipe mouse3 = button1
``` ```
```bash ```bash
mouse4 = button1 comfortable-swipe mouse4 = button1
``` ```
- 3/4-finger natural scroll - 3/4-finger natural scroll
```bash ```bash
mouse3 = scroll comfortable-swipe mouse3 = scroll
``` ```
```bash ```bash
mouse4 = scroll comfortable-swipe mouse4 = scroll
``` ```
- 3/4-finger reverse scroll - 3/4-finger reverse scroll
```bash ```bash
mouse3 = scroll_reverse comfortable-swipe mouse3 = scroll_reverse
``` ```
```bash ```bash
mouse4 = scroll_reverse comfortable-swipe mouse4 = scroll_reverse
``` ```
- Move 3/4-fingers with the cursor - Move 3/4-fingers with the cursor
```bash ```bash
mouse3 = move comfortable-swipe mouse3 = move
``` ```
```bash ```bash
mouse4 = move mcomfortable-swipe ouse4 = move
``` ```
**Note**: Applying any mouse-mouse configuration may disable up/left/right/down behavior to avoid gesture conflicts. The logic of this will be improved in the future. > **Warning**: Applying any mouse-mouse configuration will **disable up/left/right/down behavior** to avoid gesture conflicts. The logic of this will be improved in the future.
## Debugging ## Debugging
@ -457,8 +493,13 @@ done with the default bash tools.
Running shell commands our **NOT** part of the core features of comfortable-swipe, Running shell commands our **NOT** part of the core features of comfortable-swipe,
but through the default bash tools you can _mimic_ this functionality via our program output. but through the default bash tools you can _mimic_ this functionality via our program output.
<details>
<summary>
**Use Case**: _"I want to run `gnome-terminal` if I swipe up with 3 fingers."_ **Use Case**: _"I want to run `gnome-terminal` if I swipe up with 3 fingers."_
</summary>
1. Attach the program to the shell: 1. Attach the program to the shell:
```bash ```bash
@ -559,6 +600,8 @@ but through the default bash tools you can _mimic_ this functionality via our pr
Substitute `<COMMAND>` with the shell command of your choice. Substitute `<COMMAND>` with the shell command of your choice.
</details>
## Uninstall ## Uninstall
Run the following script: Run the following script: