aboutsummaryrefslogtreecommitdiff
path: root/man/termkey.7
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-04-24 17:34:12 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-04-24 17:34:12 +0100
commitc944b95696aebf67bc023a17a10b6ec17bf6f0a5 (patch)
treec868d09fc5df0156375045dc1eb6ef0ea4a65ad7 /man/termkey.7
parentf5cbf9eb57b0dd38ed8054eff02defec1602f57a (diff)
downloadtermo-c944b95696aebf67bc023a17a10b6ec17bf6f0a5.tar.gz
termo-c944b95696aebf67bc023a17a10b6ec17bf6f0a5.tar.xz
termo-c944b95696aebf67bc023a17a10b6ec17bf6f0a5.zip
Documentation on new TERMKEY_TYPE_POSITION events
Diffstat (limited to 'man/termkey.7')
-rw-r--r--man/termkey.75
1 files changed, 5 insertions, 0 deletions
diff --git a/man/termkey.7 b/man/termkey.7
index bae9a36..33f267d 100644
--- a/man/termkey.7
+++ b/man/termkey.7
@@ -47,6 +47,9 @@ a symbolic key. This value indicates that \fIcode.sym\fP is valid, and contains
.TP
.B TERMKEY_TYPE_MOUSE
a mouse button press, release, or movement. The \fIcode.mouse\fP array should be considered opaque.
+.TP
+.B TERMKEY_TYPE_POSITION
+a cursor position report.
.PP
The \fImodifiers\fP bitmask is composed of a bitwise-or of the constants \fBTERMKEY_KEYMOD_SHIFT\fP, \fBTERMKEY_KEYMOD_CTRL\fP and \fBTERMKEY_KEYMOD_ALT\fP.
.PP
@@ -105,6 +108,8 @@ The amount of time that the \fBtermkey\fP instance will wait is set by \fBtermke
The \fBTERMKEY_TYPE_MOUSE\fP event type indicates a mouse event. The \fIcode\fP field of the event structure should be considered opaque, though \fImodifiers\fP will be valid. In order to obtain the details of the mouse event, call \fBtermkey_interpret_mouse\fP(3) passing the event structure and pointers to integers to store the result in.
.PP
\fBtermkey\fP recognises three mouse protocols: the original X10 protocol (\f(CWCSI M\fP followed by three bytes), SGR encoding (\f(CWCSI < ... M\fP, as requested by \f(CWCSI ? 1006 h\fP), and rxvt encoding (\f(CWCSI ... M\fP, as requested by \f(CWCSI ? 1015 h\fP). Which encoding is in use is inferred automatically by \fBtermkey\fP, and does not need to be specified explicitly.
+.SS Position Events
+The \fBTERMKEY_TYPE_POSITION\fP event type indicates a cursor position report. This is typically sent by a terminal in response to the Report Cursor Position command (\f(CWCSI 6n\fP). The event bytes are opaque, but can be obtained by calling \fBtermkey_interpret_position\fP(3) passing the event structure and pointers to integers to store the result in.
.SH "SEE ALSO"
.BR termkey_new (3),
.BR termkey_waitkey (3),