xqueryptr.c: Add new program to interrogate the pointer position.
[xtoys] / xqueryptr.1
diff --git a/xqueryptr.1 b/xqueryptr.1
new file mode 100644 (file)
index 0000000..b3970be
--- /dev/null
@@ -0,0 +1,38 @@
+.\" -*-nroff-*-
+.TH xqueryptr 1 "18 March 2022" "Straylight/Edgeware" "xtoys"
+.SH NAME
+xqueryptr \- query pointer state
+.SH SYNOPSIS
+.B xqueryptr
+.RB [ \-d
+.IR display ]
+.SH DESCRIPTION
+The
+.B xqueryptr
+reports the current state of the pointing device as four integers:
+.I screen
+.I x
+.I y
+.IR mask .
+.PP
+The
+.I screen
+identifies which screen (in the technical X11 sense) the pointer is on
+in decimal, and is nowadays almost always 0;
+.I x
+and
+.I y
+give the pointer position relative to the top left corner of the screen
+in decimal; and
+.I mask
+gives the button and modifier state in hexadecimal.
+.SS Options
+.TP 5
+.BI "\-d, \-\-display " display
+Choose which display to connect to.
+.SH BUGS
+Hopefully none.
+.SH SEE ALSO
+.BR XQueryPointer (3x).
+.SH AUTHOR
+Mark Wooding (mdw@distorted.org.uk).