diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-03 18:44:48 +0100 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-03 18:44:48 +0100 |
| commit | f23a55ab8257987c1fdd49ba406f885bf78190b3 (patch) | |
| tree | 03a17875d87e215ceafe1127c779d47c2f31a646 /termkey_advisereadable.3 | |
| parent | 574754d5f108a92d77dc4e01022091ed42ca0020 (diff) | |
| download | termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.gz termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.xz termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.zip | |
Various minor neatenings to manpage formatting
Diffstat (limited to 'termkey_advisereadable.3')
| -rw-r--r-- | termkey_advisereadable.3 | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/termkey_advisereadable.3 b/termkey_advisereadable.3 index ee434f6..8b4b6af 100644 --- a/termkey_advisereadable.3 +++ b/termkey_advisereadable.3 @@ -10,7 +10,7 @@ termkey_advisereadable \- read more bytes from the underlying terminal .sp Link with \fI-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_advisereadable\fP informs the instance that new input may be available on the underlying file descriptor and so it should call \fBread\fP(2) to obtain it. If at least one more byte was read it will return \fBTERMKEY_RES_AGAIN\fP to indicate it may be useful to call \fBtermkey_getkey\fP(3) again. If no more input was read then \fBTERMKEY_RES_NONE\fP is returned. +\fBtermkey_advisereadable\fP() informs the instance that new input may be available on the underlying file descriptor and so it should call \fBread\fP(2) to obtain it. If at least one more byte was read it will return \fBTERMKEY_RES_AGAIN\fP to indicate it may be useful to call \fBtermkey_getkey\fP(3) again. If no more input was read then \fBTERMKEY_RES_NONE\fP is returned. .PP This function, along with \fBtermkey_getkey\fP(3) make it possible to use the termkey instance in an asynchronous program. .PP |