aboutsummaryrefslogtreecommitdiffstats
path: root/libterminput_read.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--libterminput_read.316
1 files changed, 11 insertions, 5 deletions
diff --git a/libterminput_read.3 b/libterminput_read.3
index 2c95be5..7a30072 100644
--- a/libterminput_read.3
+++ b/libterminput_read.3
@@ -137,6 +137,7 @@ union libterminput_input {
struct libterminput_keypress keypress;
struct libterminput_text text;
struct libterminput_mouseevent mouseevent;
+ struct libterminput_position position;
};
int libterminput_read(int \fIfd\fP, union libterminput_input *\fIinput\fP, struct libterminput_state *\fIctx\fP);
@@ -157,13 +158,15 @@ returns the result in the
.I ctx
must have been zero-initialised, e.g. with
.BR memset (3)
-function.
+function, and optionally with
+.BR libterminput_init (3)
+afterwards.
.PP
.I input
shall be the same pointer every time the
.BR libterminput_read ()
function is called with the same
-.I ctx ,
+.IR ctx ,
as should
.IR fd ,
except the user may choose to use a negative
@@ -410,7 +413,7 @@ OK response for a device status query.
Not-OK response for a device status query.
.TP
.B LIBTERMINPUT_CURSOR_POSITION
-Cursor position report even as a response to a
+Cursor position report event as a response to a
cursor position query. The line (indexed starting
with 1 at the top) the cursor is on will be
stored in
@@ -425,6 +428,7 @@ therefore the
flag must be set with the
.BR libterminput_set_flags (3)
function.
+
.SH RETURN VALUE
The
.BR libterminput_read ()
@@ -437,7 +441,7 @@ function returns
.B -1
and set
.I errno
-it indicate the error.
+to indicate the error.
.SH ERRORS
The
@@ -465,5 +469,7 @@ None.
None.
.SH SEE ALSO
+.BR libterminput_init (3),
.BR libterminput_is_ready (3),
-.BR libterminput_set_flags (3)
+.BR libterminput_set_flags (3),
+.BR libterminput_marshal_state (3)