Add new program `xwarpptr'.

[xtoys] / xwarpptr.1

diff --git a/xwarpptr.1 b/xwarpptr.1
new file mode 100644 (file)
index 0000000..3c35a9c
--- /dev/null
+++ b/xwarpptr.1
@@ -0,0 +1,60 @@
+.\" -*-nroff-*-
+.TH xwarpptr 1 "22 April 2022" "Straylight/Edgeware" "xtoys"
+.SH NAME
+xwarpptr \- warp pointer to a given location
+.SH SYNOPSIS
+.B xwarpptr
+.RB [ \-r ]
+.RB [ \-d
+.IR display ]
+.I x
+.I y
+.SH DESCRIPTION
+The
+.B xwarpptr
+warps (moves) the mouse pointer to position
+.RI ( x ,
+.IR y )
+on the screen.
+.PP
+Coordinates use the usual (left-handed) X11 convention: the origin in in
+the top left, with
+.IR x -
+and
+.IR y -coordinates
+increasing rightwards and downwards respectively.
+.PP
+If
+.I x
+or
+.I y
+is negative, then it is instead considered relative to the right or
+bottom edge, respectively.  Usually, a negative number would need to be
+preceded by a
+.RB ` \-\- '
+marker to prevent it from being misinterpreted as an option, but
+.B xwarpptr
+takes special care to handle this situation correctly.
+.PP
+With the
+.B \-r
+option,
+.I x
+and
+.I y
+are instead considered relative to the pointer's current position;
+coordinates still increase rightwards and downwards.
+.SS Options
+.TP 5
+.BI "\-d, \-\-display " display
+Choose which display to connect to.
+.TP 5
+.B \-r, \-\-relative
+Move the pointer relative to its current position, rather than to an
+absolute position.  (See above.)
+.SH BUGS
+Hopefully none.
+.SH SEE ALSO
+.BR XWarpPointer (3x).
+.SH AUTHOR
+Mark Wooding (mdw@distorted.org.uk).