find-cursor/README.markdown
2021-05-16 13:47:00 +08:00

72 lines
2.1 KiB
Markdown

[![This project is considered stable](https://img.shields.io/badge/Status-stable-green.svg)](https://arp242.net/status/stable)
Simple XLib program to highlight the cursor position. This is similar to the
feature found in Windows XP (and possibly later?)
![screenshot.gif](https://raw.githubusercontent.com/arp242/find-cursor/master/screenshot.gif)
Installation
------------
Compile it by typing `make`, install it with `make install`. There
[packages][pkg] for some platforms as well.
You'll need to install some X11 header files on some systems; e.g. on
Ubuntu/Debian: `libx11-dev`, `libxcomposite-dev`, `libxdamage-dev`, and
`libxrender-dev`.
There is also a Docker container at [klo2k/find-cursor][d] if you want it. Note
this is NOT maintained (or supported) by me. See #19.
[d]: https://hub.docker.com/r/klo2k/find-cursor
[pkg]: https://repology.org/project/find-cursor/versions
Usage
-----
See `find-cursor -h` to see some options for controlling the appearance.
Launching
---------
You will want to map a key in your window manager to run `find-cursor`. You can
also use [`xbindkeys`](xbindkeys), which should work with `$any` window manager.
I run it with [`xcape`][xcape]:
xcape -e 'Control_L=Escape;Shift_L=KP_Add'
When `Left Shift` is tapped a `Keypad Add` is sent; I configured my window
manager to launch `find-cursor` with that.
I don't have a numpad on my keyboard; you can also use `F13` or some other
unused key.
You can use a little wrapper script if you want a "toggle" switch for when
repeating forever:
#!/bin/sh
if pgrep find-cursor; then
pkill find-cursor
else
find-cursor -r0 &
fi
Compton
-------
You may want to disable shadows if you use compton or some other composite
manager; for example for compton start it with:
compton --shadow-exclude "class_g = 'find-cursor'"
Or, perhaps even better, disable it for all shaped windows:
compton --shadow-exclude 'bounding_shaped'
You can also put that in the compton config file. Other managers might have
different options/flags.
[xcape]: https://github.com/alols/xcape
[xbindkeys]: http://www.nongnu.org/xbindkeys/xbindkeys.html