Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samvv/evcape
A small tool for making the Control key act as an Escape-key on Linux/Wayland
https://github.com/samvv/evcape
Last synced: about 1 month ago
JSON representation
A small tool for making the Control key act as an Escape-key on Linux/Wayland
- Host: GitHub
- URL: https://github.com/samvv/evcape
- Owner: samvv
- License: mit
- Created: 2023-04-27T15:05:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-07T14:00:59.000Z (4 months ago)
- Last Synced: 2024-09-08T15:31:56.496Z (4 months ago)
- Language: C
- Homepage:
- Size: 105 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
evcape
======
This is a small utility that makes a short press of the Control-key act as a
press of the Escape-key. It can significantly ease the development workflow
when using a text editor such as Vim. Because it is written in C, this program
is also very performant with minimal memory overhead.
🚀 Now automatically detects hotplugging of keyboards!
## Installation
### Debian/Ubuntu
An APT repository will soon be avaialbe so that the latest version can be
easily installed.
### NixOS
Assuming your NixOS itself runs on [flakes], you need to add two lines to
your configuration.
**/etc/nixos/flake.nix**
```nix
{
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
inputs.evcape.url = "github:samvv/evcape"; # Add this line
outputs = { self, nixpkgs, evcape }: { # Modify this line
nixosConfigurations.xana = nixpkgs.lib.nixosSystem {
modules = [
./configuration.nix
evcape.nixosModules.default # Add this line
];
};
};
}
```
[flakes]: https://nixos.wiki/wiki/Flakes
### Building From Source
Make sure you have the right packages installed. On Debian/Ubuntu, this will
look something like this:
```sh
sudo apt install libudev-dev libevdev-dev
```
Ensure Meson is installed on your system.
```sh
python3 -m pip install -U --user meson
```
To install the package, simply run the following command:
> [!WARNING]
> This will install configuration files that are expected to run on standard
> Debian distros. When in doubt, build the service using the instructions below
> and review each file before installing it.
```sh
sudo make install
```
This will install the following files:
- `/etc/systemd/system/evcape.service`
- `/usr/local/bin/evcape`
You might want to run the following commands to activate `evcape` immediately
and on startup:
```
sudo systemctl enable --now evcape
```
If you just want the binary, run the following commands:
```sh
meson setup build
ninja -C build evcape
```
The binary will be available as `build/evcape`.
## Configuration
### Setting Up CapsLock
For GNOME, use the following command to copy Ctrl to CapsLock.
> [!WARNING]
> This command overrides existing configuration!
```bash
gsettings set org.gnome.desktop.input-sources xkb-options "['ctrl:nocaps']"
```
Alternatively, the following command might work when working on Xwayland or X11:
```bash
setxkbmap -option "ctrl:nocaps"
```
### Running Manually
Simply run `evcape` with sudo privileges and you're good to go!
evcape needs sudo privileges because it intercepts and then injects raw key
events from/to the keyboard subsystem. Because Wayland does not offer a
standard protocol to do the same, the driver is where we need to be.
The following environment variables can be set to influence the behavior of evcape:
| Name | |
|--------------------|------------------------------------------------------|
| `EVCAPE_LOG_LEVEL` | An integer from 0 (no logging) to 6 (log everything) |
## Related Work
- [A Python implementation of evcape](https://github.com/wbolster/evcape/)
- [Interception Tools](https://gitlab.com/interception/linux/tools) and in particular [caps2esc](https://gitlab.com/interception/linux/plugins/caps2esc)
## License
This code is generously licensed under the MIT license.