clipnotify

commit fe54c842ca505ae4c8fc2c5cbc336cecbb8e7965
parent 493e4cd1f0cf831540454426d65b0509a8f32d75
Author: Chris Down <chris@chrisdown.name>
Date:   Mon,  5 Feb 2018 23:45:04 +0000

Add README

Diffstat:
A
README.md
 | 
19
+++++++++++++++++++

1 file changed, 19 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+clipnotify is a simple program that, using the
+[XFIXES](https://cgit.freedesktop.org/xorg/proto/fixesproto/plain/fixesproto.txt)
+extension to X11, waits until a new selection is available and then exits.
+
+It was primarily designed for [clipmenu](https://github.com/cdown/clipmenu), to
+avoid polling for new selections.
+
+Here's how it's intended to be used:
+
+    while true; do
+        clipnotify  # When clipnotify exists, a new selection event was detected.
+        [do something with the selection]
+    done
+
+clipnotify doesn't try to print anything about the contents of the selection,
+it just exists when it changes. This is intentional -- X11's selection API is
+verging on the insane, and there are plenty of others who have already lost
+their sanity to bring us xclip/xsel/etc. Use one of those tools to complement
+clipnotify.