aboutsummaryrefslogtreecommitdiff
path: root/termkey_get_buffer_remaining.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
commit082b49f0f8790e2cf98346a03c53f492d9d5dcba (patch)
tree91d657db23e92b6b658dd4e73cecf1fb18c79188 /termkey_get_buffer_remaining.3
parentd64ba87edae62894ca74cfb9d6d8cdd88c213397 (diff)
downloadtermo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.gz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.xz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.zip
Move the growing collection of manpages into their own man/ subdirectory
Diffstat (limited to 'termkey_get_buffer_remaining.3')
-rw-r--r--termkey_get_buffer_remaining.320
1 files changed, 0 insertions, 20 deletions
diff --git a/termkey_get_buffer_remaining.3 b/termkey_get_buffer_remaining.3
deleted file mode 100644
index a7f7885..0000000
--- a/termkey_get_buffer_remaining.3
+++ /dev/null
@@ -1,20 +0,0 @@
-.TH TERMKEY_GET_BUFFER_REMAINING 3
-.SH NAME
-termkey_get_buffer_remaining \- returns the free buffer space
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.sp
-.BI "size_t termkey_get_buffer_remaining(TermKey *" tk ");
-.fi
-.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.
-.PP
-.SH "RETURN VALUE"
-\fBtermkey_get_buffer_remaining\fP() returns a size in bytes.
-.SH "SEE ALSO"
-.BR termkey_new (3),
-.BR termkey_advisereadable (3),
-.BR termkey_getkey (3)