aboutsummaryrefslogtreecommitdiff
path: root/termkey_getkey.3.sh
diff options
context:
space:
mode:
Diffstat (limited to 'termkey_getkey.3.sh')
-rw-r--r--termkey_getkey.3.sh2
1 files changed, 2 insertions, 0 deletions
diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh
index 55bfca1..022f209 100644
--- a/termkey_getkey.3.sh
+++ b/termkey_getkey.3.sh
@@ -32,6 +32,8 @@ no bytes are waiting in the buffer.
.PP
Neither of these functions will block or perform any IO operations on the underlying filehandle. To use the instance in an asynchronous program, see \fBtermkey_advisereadable\fP(3). For a blocking call suitable for use in a synchronous program, use \fBtermkey_waitkey\fP(3) instead of \fBtermkey_getkey\fP().
.PP
+Before returning, this function canonicalises the \fIkey\fP structure according to the rules given for \fBtermkey_canonicalise\fP(3).
+.PP
The \fITermKeyKey\fP structure is defined as follows:
.PP
.in +4n