xqueryptr.c: Add new program to interrogate the pointer position.
[xtoys] / xwarpptr.1
1 .\" -*-nroff-*-
2 .TH xwarpptr 1 "22 April 2022" "Straylight/Edgeware" "xtoys"
3 .SH NAME
4 xwarpptr \- warp pointer to a given location
5 .SH SYNOPSIS
6 .B xwarpptr
7 .RB [ \-r ]
8 .RB [ \-d
9 .IR display ]
10 .I x
11 .I y
12 .SH DESCRIPTION
13 The
14 .B xwarpptr
15 warps (moves) the mouse pointer to position
16 .RI ( x ,
17 .IR y )
18 on the screen.
19 .PP
20 Coordinates use the usual (left-handed) X11 convention: the origin in in
21 the top left, with
22 .IR x -
23 and
24 .IR y -coordinates
25 increasing rightwards and downwards respectively.
26 .PP
27 If
28 .I x
29 or
30 .I y
31 is negative, then it is instead considered relative to the right or
32 bottom edge, respectively. Usually, a negative number would need to be
33 preceded by a
34 .RB ` \-\- '
35 marker to prevent it from being misinterpreted as an option, but
36 .B xwarpptr
37 takes special care to handle this situation correctly.
38 .PP
39 With the
40 .B \-r
41 option,
42 .I x
43 and
44 .I y
45 are instead considered relative to the pointer's current position;
46 coordinates still increase rightwards and downwards.
47 .SS Options
48 .TP 5
49 .BI "\-d, \-\-display " display
50 Choose which display to connect to.
51 .TP 5
52 .B \-r, \-\-relative
53 Move the pointer relative to its current position, rather than to an
54 absolute position. (See above.)
55 .SH BUGS
56 Hopefully none.
57 .SH SEE ALSO
58 .BR XWarpPointer (3x).
59 .SH AUTHOR
60 Mark Wooding (mdw@distorted.org.uk).