aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_push_bytes.3
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2014-09-23 01:38:08 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2014-09-23 03:05:01 +0200
commitb630bf7a5f5ec85317db04f770ffc90664ac28f0 (patch)
tree52a0f40045809e71bc6fcac40d52e570f2fb2b59 /man/termkey_push_bytes.3
parent7909067ac05e885211dafa255da0526543bb87bf (diff)
downloadtermo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.tar.gz
termo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.tar.xz
termo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.zip
WIP: Is mine now (^3^)
Seriously though, I've got some issues with how this thing is designed, as well as with its formatting, and when you add the fact that the original author wants to merge this thing into his bigger library that also handles terminal output, which I'll kindly leave to ncurses, it kind of makes sense for me to do this. Manpages have been removed as they are going to become obsolete and they're rather difficult to maintain. If anything, there will be Doxygen-generated documentation. The plan is to throw away any direct UTF-8 support and support all uni- and multibyte character encodings. However some unrelated refactoring is about to come first.
Diffstat (limited to 'man/termkey_push_bytes.3')
-rw-r--r--man/termkey_push_bytes.323
1 files changed, 0 insertions, 23 deletions
diff --git a/man/termkey_push_bytes.3 b/man/termkey_push_bytes.3
deleted file mode 100644
index 3761034..0000000
--- a/man/termkey_push_bytes.3
+++ /dev/null
@@ -1,23 +0,0 @@
-.TH TERMKEY_PUSH_BYTES 3
-.SH NAME
-termkey_push_bytes \- supply more bytes to the input buffer
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.sp
-.BI "size_t termkey_push_bytes(TermKey *" tk ", const char *" bytes ", size_t " len ");
-.fi
-.sp
-Link with \fI-ltermkey\fP.
-.SH DESCRIPTION
-\fBtermkey_push_bytes\fP() allows more bytes of input to be supplied directly into the input buffer of the \fBtermkey\fP(7) instance. If there was no buffer space remaining then -1 is returned with \fIerrno\fP set to \fBENOMEM\fP.
-.PP
-This function, along with \fBtermkey_getkey\fP(3), makes it possible to use the \fBtermkey\fP instance with a source of bytes other than from reading a filehandle.
-.PP
-For synchronous usage, \fBtermkey_waitkey\fP(3) performs the input blocking task. For use against a regular stream filehandle that supports \fBread\fP(2), see \fBtermkey_advisereadable\fP(3).
-.SH "RETURN VALUE"
-\fBtermkey_push_bytes\fP() the number of bytes consumed from the input (which may be smaller than the length provided, if the buffer runs out of space) or -1 cast to \fBsize_t\fP if an error occurs, in which case \fIerrno\fP is set accordingly.
-.SH "SEE ALSO"
-.BR termkey_getkey (3),
-.BR termkey_advisereadable (3),
-.BR termkey (7)