Add basic manpage and sync up README documentation

This commit is contained in:
Miles Alan
2020-06-13 21:25:27 -05:00
parent b4dd89ae3a
commit 51ecaea4e2
5 changed files with 105 additions and 16 deletions
+20 -13
View File
@@ -1,10 +1,11 @@
# lisgd
Lisgd (libinput **synthetic** gesture daemon) lets you bind gestures based on
Lisgd (libinput synthetic gesture daemon) lets you bind gestures based on
libinput touch events to run specific commands to execute. For example,
dragging left to right with one finger could execute a particular command
like launching a terminal. L-R, R-L, U-D, and D-U swipe gestures are
supported with 1 through n fingers.
like launching a terminal. Directional L-R, R-L, U-D, and D-U gestures and
diagnoal LD-RU, RD-LU, UR-DL, UL-DR gestures are supported with 1 through
n fingers.
Unlike other libinput gesture daemons, lisgd uses touch events to
recognize **synthetic swipe gestures** rather than using the *libinput*'s
@@ -31,16 +32,22 @@ Flags:
- **-d [devicenodepath]**: Defines the dev filesystem device to monitor
- Example: `lisgd -d /dev/input/input1`
- **-t [threshold_units]**: Number of libinput units (number) minimum to recognize a gesture
- **-t [threshold_units]**: Threshold in libinput units (pixels) after which a
gesture registers. Defaults to 300.
- Example: `lisgd -t 400`
- **-r [milli]**: Number of degrees offset each 45-degree interval may still
be recognized within. Maximum value is 45. Default value is 15. E.g. U-D
is a 180 degree gesture but with 15 degrees of leniency will be recognized
between 165-195 degrees.
- Example: `lisgd -r 20`
- **-m [timeoutms]**: Number of milliseconds gestures must be performed within
to be registered. After the timeoutms value; the gesture won't be registered.
- Example: `lisgd -m 1200`
- **-v**: Verbose mode, useful for debugging
- Example: `lisgd -v`
- **-g [fingers,start,end,command]**: Defines a gesture; wherein fingers is a integer, start/end are {l,r,d,u}, and command is the command to execute
- Single Gesture Example: `lisgd -g "1,l,r,notify-send swiped lr"`
- Multiple Gestures Example: `lisgd -g "1,l,r,notify-send swiped lr" -g "1,r,l,noitfy-send swiped rl"`
Full commandline-based configuration example:
```
lisgd -d /dev/input/input1 -g "1,l,r,notify-send swiped lr" -t 200 -v
```
- **-g [nfingers,gesture,command]**: Allows you to bind a gesture wherein
nfingers is an integer, gesture is one of {LR,RL,DU,UD,DLUR,URDL,ULDR,DLUR},
and command is the shell command to be executed. The -g option can be used
multiple times to bind multiple gestures.
- Single Gesture Example: `lisgd -g "1,LR,notify-send swiped lr"`
- Multiple Gestures Example: `lisgd -g "1,LR,notify-send swiped lr" -g "1,RL,noitfy-send swiped rl"`