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

Add more examples to README

Browse Source
This commit is contained in:
Rico Tiongson 2020-05-07 23:44:16 +08:00
parent 57a6e4f217
commit 6bd7603694
1 changed files with 46 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
README.md
View File

@ -63,6 +63,51 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
Comfortable swipe is RUNNING in the background Comfortable swipe is RUNNING in the background
``` ```
1. **Stop the Program**
```
comfortable-swipe stop
```
1. **Toggle Autostart** (optional)
```bash
comfortable-swipe autostart
comfortable-swipe autostart on
comfortable-swipe autostart off
comfortable-swipe autostart toggle
comfortable-swipe autostart status
comfortable-swipe autostart path
```
1. **Program status**
```bash
comfortable-swipe status
```
Example:
```
$ comfortable-swipe status
Autostart is ON
Program is RUNNING
--------------------
Configuration: /home/user/.config/comfortable-swipe.conf
left3 is VALID (ctrl+super+Right)
left4 is VALID (ctrl+super+shift+Right)
right3 is VALID (ctrl+super+Left)
right4 is VALID (ctrl+super+shift+Left)
up3 is VALID (ctrl+F12)
up4 is VALID (super+d)
down3 is VALID (ctrl+F12)
down4 is VALID (super+d)
threshold is VALID (1.0)
mouse3 is NOTSET
mouse4 is NOTSET
```
1. **Get config** 1. **Get config**
``` ```
@ -97,17 +142,6 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
comfortable-swipe up3 = ctrl+shift+Up comfortable-swipe up3 = ctrl+shift+Up
``` ```
1. **Toggle Autostart**
```bash
comfortable-swipe autostart
comfortable-swipe autostart on
comfortable-swipe autostart off
comfortable-swipe autostart toggle
comfortable-swipe autostart status
comfortable-swipe autostart path
```
<details> <details>
<summary><b>Other Commands</b></summary> <summary><b>Other Commands</b></summary>
@ -177,17 +211,11 @@ Comfortable, seamless, and fast 3-finger (and 4-finger) touchpad swipe gestures
</details> </details>
## Swipe Gesture Configurations ## Gesture Configurations
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`.
List all properties with:
```
comfortable-swipe config list
```
Set a property directly with: Set a property directly with:
``` ```