aboutsummaryrefslogtreecommitdiff
path: root/termkey_getkey.3.sh
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-04-03 18:44:48 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-04-03 18:44:48 +0100
commitf23a55ab8257987c1fdd49ba406f885bf78190b3 (patch)
tree03a17875d87e215ceafe1127c779d47c2f31a646 /termkey_getkey.3.sh
parent574754d5f108a92d77dc4e01022091ed42ca0020 (diff)
downloadtermo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.gz
termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.xz
termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.zip
Various minor neatenings to manpage formatting
Diffstat (limited to 'termkey_getkey.3.sh')
-rw-r--r--termkey_getkey.3.sh7
1 files changed, 3 insertions, 4 deletions
diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh
index a940906..ffc6d0e 100644
--- a/termkey_getkey.3.sh
+++ b/termkey_getkey.3.sh
@@ -8,20 +8,19 @@ termkey_getkey, termkey_getkey_force \- retrieve the next key event
.B #include <termkey.h>
.sp
.BI "TermKeyResult termkey_getkey(TermKey *" tk ", TermKeyKey *" key );
-.br
.BI "TermKeyResult termkey_getkey_force(TermKey *" tk ", TermKeyKey *" key );
.fi
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
-\fBtermkey_getkey\fP attempts to retrieve a single keypress event from the buffer, and put it in the structure referred to by \fIkey\fP. It returns one of the following values:
+\fBtermkey_getkey\fP() attempts to retrieve a single keypress event from the buffer, and put it in the structure referred to by \fIkey\fP. It returns one of the following values:
.in
.TP
.B TERMKEY_RES_KEY
a complete keypress was removed from the buffer, and has been placed in the \fIkey\fP structure.
.TP
.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(3)\fP 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(3) would return has been placed in the \fIkey\fP structure.
.TP
.B TERMKEY_RES_NONE
no bytes are waiting in the buffer.
@@ -29,7 +28,7 @@ no bytes are waiting in the buffer.
.B TERMKEY_RES_EOF
no bytes are ready and the input stream is now closed.
.PP
-\fBtermkey_getkey_force\fP is similar to \fBtermkey_getkey\fP but will not return \fBTERMKEY_RES_AGAIN\fP if a partial match is found. Instead, it will force an interpretation of the bytes, even if this means interpreting the start of an Escape-prefixed multi-byte sequence as a literal "Escape" key followed by normal letters.
+\fBtermkey_getkey_force\fP() is similar to \fBtermkey_getkey\fP() but will not return \fBTERMKEY_RES_AGAIN\fP if a partial match is found. Instead, it will force an interpretation of the bytes, even if this means interpreting the start of an Escape-prefixed multi-byte sequence as a literal "Escape" key followed by normal letters.
.PP
Neither of these functions will block or perform any IO operations on the underlying filehandle. To use the instance in an asynchronous program, see \fBtermkey_advisereadable\fP(3). For a blocking call suitable for use in a synchronous program, use \fBtermkey_waitkey\fP(3) instead of \fBtermkey_getkey\fP().
.PP