p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

More minor docs updates

This commit is contained in:
Paul LeoNerd Evans 2012-01-18 14:31:25 +00:00
parent 14d6bb736c
commit 0486ca8212
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
man/termkey_getkey.3.sh
View File

@ -20,7 +20,7 @@ Link with \fI-ltermkey\fP.
a complete keypress was removed from the buffer, and has been placed in the \fIkey\fP structure. a complete keypress was removed from the buffer, and has been placed in the \fIkey\fP structure.
.TP .TP
.B TERMKEY_RES_AGAIN .B TERMKEY_RES_AGAIN
a partial keypress event was found in the buffer, but it does not yet contain all the bytes required. An indication of what \fBtermkey_getkey_force\fP(3) would return has been placed in the \fIkey\fP structure. a partial keypress event was found in the buffer, but it does not yet contain all the bytes required. An indication of what \fBtermkey_getkey_force\fP() would return has been placed in the \fIkey\fP structure.
.TP .TP
.B TERMKEY_RES_NONE .B TERMKEY_RES_NONE
no bytes are waiting in the buffer. no bytes are waiting in the buffer.

2
man/termkey_push_bytes.3
View File

@ -16,7 +16,7 @@ This function, along with \fBtermkey_getkey\fP(3), makes it possible to use the
.PP .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). 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" .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. \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" .SH "SEE ALSO"
.BR termkey_new (3), .BR termkey_new (3),
.BR termkey_getkey (3), .BR termkey_getkey (3),