aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_get_buffer_remaining.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 13:39:50 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 13:39:50 +0000
commit82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e (patch)
tree8c20d19ebbf277de41a1d89167576a4b087f6011 /man/termkey_get_buffer_remaining.3
parent082b49f0f8790e2cf98346a03c53f492d9d5dcba (diff)
downloadtermo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.tar.gz
termo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.tar.xz
termo-82ad14175cbcc7c0c660720c7a31f8e6f1cefe4e.zip
Added termkey_push_bytes(), a new API for providing input bytes
Diffstat (limited to 'man/termkey_get_buffer_remaining.3')
-rw-r--r--man/termkey_get_buffer_remaining.33
1 files changed, 2 insertions, 1 deletions
diff --git a/man/termkey_get_buffer_remaining.3 b/man/termkey_get_buffer_remaining.3
index a7f7885..6f85f99 100644
--- a/man/termkey_get_buffer_remaining.3
+++ b/man/termkey_get_buffer_remaining.3
@@ -10,11 +10,12 @@ termkey_get_buffer_remaining \- returns the free buffer space
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
-A termkey instance contains a buffer of pending bytes that have been read by \fBtermkey_advisereadable\fP(3) but not yet consumed by \fBtermkey_getkey\fP(3). \fBtermkey_get_buffer_remaining\fP() returns the number of bytes of buffer space currently free in the termkey instance.
+A termkey instance contains a buffer of pending bytes that have been read by \fBtermkey_advisereadable\fP(3) or provided by \fBtermkey_push_bytes\fP(3) but not yet consumed by \fBtermkey_getkey\fP(3). \fBtermkey_get_buffer_remaining\fP() returns the number of bytes of buffer space currently free in the termkey instance.
.PP
.SH "RETURN VALUE"
\fBtermkey_get_buffer_remaining\fP() returns a size in bytes.
.SH "SEE ALSO"
.BR termkey_new (3),
+.BR termkey_push_bytes (3),
.BR termkey_advisereadable (3),
.BR termkey_getkey (3)