REF update documentation

This commit is contained in:
Nathan Dwarshuis 2020-04-01 16:51:28 -04:00
parent c4a7104469
commit ae92b0e8b3
2 changed files with 8 additions and 8 deletions

View File

@ -15,14 +15,14 @@ on which apps have focus.
# Usage
```
xcape-hs BINDINGS REGEXP [[REGEXP] ...]
xcape-hs [-t TIMEOUT] BINDINGS REGEXP [[REGEXP] ...]
```
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.
Where `TIMEOUT` and `BINDINGS` are the timeout argument and the key bindings to
be passed to the `-t` and `-b` flags respectively in `xcape` and `REGEXP` is a
POSIX-style regular expression matching a window app name for which xcape will
not be running when it is in focus. To find the app name for a window, use the
`xprop` program and look for the first member of the `WM_CLASS` atom.
# Dependencies

View File

@ -13,8 +13,8 @@
-- The process for doing this using Xlib:
-- 1) Listen for PropertyNotify events from the root window
-- 2) Of those events, filter those where the _NET_ACTIVE_WINDOW atom has changed
-- 3) Using the value of _NET_ACTIVE_WINDOW, get the title of the active window
-- 4) If active window matches a certain criteria, turn off xcape (vice versa)
-- 3) Using the value of _NET_ACTIVE_WINDOW, get the app name of the active window
-- 4) If the app name matches a certain criteria, turn off xcape (vice versa)
--
-- The matching criteria in (4) are POSIX regular expressions.
--