aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b40254f1c861392c2e32830c4e5e6388617fb406 (plain) (blame)
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
# SHotKey
A Suckless Hot Key daemon for X inspired by the suckless philosophy with configurable custom modes.

~200 LOC. ~20KB binary.


<a href="https://liberapay.com/phenax/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a>


## Installation
Clone the repo and run
```bash
sudo make install
```


## Configuring
Fork this repo and configure it to your likings.
You can edit `config.h` to configure key bindings.

* `shell` - Configure the shell used for executing the commands
* `modes` - A mapping defining all mode keys bindings
* `keys` - All normal mode key bindings
* `on_mode_change` - Hook script to listen to mode changes. Useful for status bar integration
* `mode_properties` - Some meta information about mode. (Label is useful for `on_mode_change`)

You can checkout the [personal branch](https://github.com/phenax/shotkey/tree/personal) for my personal config.

Read the man page for more details.