lillinput 0.1.0

Connect libinput gestures to i3 and others
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# lillinput

[![crates.io]](https://crates.io/crates/lillinput)
[![docs.rs]](https://docs.rs/lillinput)
[![license]](LICENSE)
[![build status]](https://github.com/diego-plan9/lillinput/actions/workflows/default.yml)


## About

`lillinput` is a small utility written in Rust for connecting [`libinput`]
gestures into:
* commands for the [`i3`] tiling window manager IPC interface
* shell commands

### Project status

Please be aware that this project is in beta, and was started for scratching
a specific itch - allowing three-finger swipe for changing between workspaces
in `i3` under a personal setup. It aims to stay small (hence the [name]) and
biased towards custom needs (and a bit of a Rust playground).

## Usage

Upon invocation, `lillinput` will listen to `libinput` events until stopped. By
default, the `i3` action will be enabled, with the `workspace next` configured
for the "three finger right swipe" gesture, and the `workspace prev` for the
"three finger left swipe" gesture.

The full list of options can be retrieved via:

```
lillinput --help
```

```
...
OPTIONS:
    -e, --enabled-action-types <enabled-action-types>...
            enabled action types [default: i3] [possible values: i3, command]

    -s, --seat <seat>                             libinput seat [default: seat0]
        --swipe-down-3 <swipe-down-3>...          actions the three-finger swipe down
        --swipe-left-3 <swipe-left-3>...          actions the three-finger swipe left
        --swipe-right-3 <swipe-right-3>...        actions the three-finger swipe right
        --swipe-up-3 <swipe-up-3>...              actions the three-finger swipe up
    -t, --threshold <threshold>
            minimum threshold for position changes [default: 20.0]
```

### Configuring the swipe actions

Each `--swipe-{foo}` argument accepts one or several "actions", in the form
`{type}:{command}`. For example, the following command specifies an action
for moving to the next workspace in `i3`, and an action for creating a file
when swiping up:

```
lillinput --swipe-up-3 "i3:workspace next" --swipe-up-3 "command:touch myfile"
```

Currently, the available action types are `i3` and `command`.

## Compiling

### Dependencies

The following system-level libraries are required by this crate dependencies:

```
sudo aptitude install libudev-dev libinput-dev
```

## Related projects

This create relies heavily on the wonderful work on the [`input`] and [`i3ipc`]
crates (among others) - kudos to their maintainers for making them available.

Outside rust, the following projects provide a more complete solution for using
`libinput` gestures:
* [`libinput-gestures`]
* [`fusuma`]
* [`geebar-libinput`]

## Contributing

Any contribution is welcome, please issue or PR away!

## License

This project is licensed under [BSD-3-Clause].

[BSD-3-Clause]: LICENSE.txt
[`i3`]: https://i3wm.org/
[`libinput`]: https://www.freedesktop.org/wiki/Software/libinput/
[name]: https://en.wikipedia.org/wiki/Lilliput_and_Blefuscu

[`i3ipc`]: https://github.com/tmerr/i3ipc-rs
[`input`]: https://github.com/Smithay/input.rs

[`libinput-gestures`]: https://github.com/bulletmark/libinput-gestures
[`fusuma`]: https://github.com/iberianpig/fusuma
[`geebar-libinput`]: https://github.com/Coffee2CodeNL/gebaar-libinput

[crates.io]: https://img.shields.io/crates/v/lillinput
[docs.rs]: https://img.shields.io/docsrs/lillinput
[license]: https://img.shields.io/crates/l/lillinput
[build status]: https://github.com/diego-plan9/lillinput/actions/workflows/default.yml/badge.svg