aboutsummaryrefslogtreecommitdiff
path: root/man/termkey.7
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-03-08 14:35:47 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-03-08 14:35:47 +0000
commitf7e498684911bd1be9ab915bff4f8190f014cf65 (patch)
tree170c0b9426117a07b56dba69d29c131b9f022d49 /man/termkey.7
parent8e4551571099047ff045ea01ff464082b220448e (diff)
downloadtermo-f7e498684911bd1be9ab915bff4f8190f014cf65.tar.gz
termo-f7e498684911bd1be9ab915bff4f8190f014cf65.tar.xz
termo-f7e498684911bd1be9ab915bff4f8190f014cf65.zip
Also link to termkey_{get,set}_buffer_size(3) from termkey(7)
Diffstat (limited to 'man/termkey.7')
-rw-r--r--man/termkey.72
1 files changed, 1 insertions, 1 deletions
diff --git a/man/termkey.7 b/man/termkey.7
index 780f840..9fa936c 100644
--- a/man/termkey.7
+++ b/man/termkey.7
@@ -14,7 +14,7 @@ To work with an asynchronous program, two other functions are used. \fBtermkey_a
.PP
Finally, bytes of input can be fed into the \fBtermkey\fP instance directly, by calling \fBtermkey_push_bytes\fP(3). This may be useful if the bytes have already been read from the terminal by the application, or even in situations that don't directly involve a terminal filehandle. Because of these situations, it is possible to construct a \fBtermkey\fP instance not associated with a file handle, by passing -1 as the file descriptor.
.PP
-A \fBtermkey\fP instance contains a buffer of pending bytes that have been read but not yet consumed by \fBtermkey_getkey\fP(3). \fBtermkey_get_buffer_remaining\fP(3) returns the number of bytes of buffer space currently free in the instance.
+A \fBtermkey\fP instance contains a buffer of pending bytes that have been read but not yet consumed by \fBtermkey_getkey\fP(3). \fBtermkey_get_buffer_remaining\fP(3) returns the number of bytes of buffer space currently free in the instance. \fBtermkey_set_buffer_size\fP(3) and \fBtermkey_get_buffer_size\fP(3) can be used to control and return the total size of this buffer.
.SS Key Events
Key events are stored in structures. Each structure holds details of one key event. This structure is defined as follows.
.PP