ndwarshuis
/
xman
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -2,7 +2,9 @@
A daemon to manage [xcape](https://github.com/alols/xcape) instances based on A daemon to manage [xcape](https://github.com/alols/xcape) instances based on
which app is in focus. 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 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 (VM), particularly a windows machine with an Autohotkey script to replicate the
@ -13,13 +15,14 @@ on which apps have focus.
# Usage # 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` Where `BINDINGS` are the keys supplied to the `-e` argument of `xcape` and
is a POSIX-style regular expression matching a window title for which xcape will `REGEXP` is a POSIX-style regular expression matching a window title for which
not be running when it is in focus. To find a window title, use the `xprop` xcape will not be running when it is in focus. To find a window title, use the
program and look for the `WM_NAME` and `_NET_WM_NAME` atoms in the output. `xprop` program and look for the `WM_NAME` and `_NET_WM_NAME` atoms in the
output.
# Dependencies # Dependencies

2
app/Main.hs
View File

@ -94,7 +94,7 @@ parse _ = usage
-- | Print the usage and exit -- | Print the usage and exit
usage :: IO () usage :: IO ()
usage = putStrLn "xman BINDINGS REGEXP [[REGEXP]...]" usage = putStrLn "xman BINDINGS REGEXP [[REGEXP] ...]"
-- | Given xcape bindings and regular expression patterns to match the window -- | Given xcape bindings and regular expression patterns to match the window
-- titles we care about, initialize the XMan monad and run the main event loop -- titles we care about, initialize the XMan monad and run the main event loop