ADD readme

This commit is contained in:
Nathan Dwarshuis 2020-03-31 23:27:28 -04:00
parent 4f1f1b3a7f
commit 4395f67fdf
1 changed files with 30 additions and 1 deletions

View File

@ -1 +1,30 @@
# xman-hs # XMan
A daemon to manage [[https://github.com/alols/xcape][xcape]] instances based on
which app is in focus.
Xcape allows one to configure any key to send an arbitrary key upon release (for instance, the Control key can function as itself on keypress and an Escape key on key release).
This works beautifully except when one tries to switch to a virtual machine
(VM), particularly a windows machine with an Autohotkey script to replicate the
keymap in the host machine. In this case, any xcape'd keys will be sent twice.
The obvious (and somewhat crude solution) is to start and stop xcape depending
on which apps have focus.
# Usage
```
xcape-hs KEYS REGEXP [REGEXP [REGEXP] ...]
```
Where `KEYS` are the keys supplied to the `-e` argument of `xcape` and `REGEXP`
is a POSIX-style regular expression matching a window title for which xcape will
not be running when it is in focus. To find a window title, use the `xprop`
program and look for the `WM_NAME` and `_NET_WM_NAME` atoms in the output.
# Dependencies
* xcape
# Installation
Clone this repo and run `stack install`.