REF update readme

This commit is contained in:
Nathan Dwarshuis 2020-04-01 16:01:16 -04:00
parent 5fd087d0f0
commit 4ef3f2d654
2 changed files with 10 additions and 7 deletions

View File

@ -2,7 +2,9 @@
A daemon to manage [xcape](https://github.com/alols/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).
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
@ -13,13 +15,14 @@ on which apps have focus.
# Usage
```
xcape-hs KEYS REGEXP [REGEXP [REGEXP] ...]
xcape-hs BINDINGS 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.
Where `BINDINGS` 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