diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-04 19:56:33 +0100 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-04 19:56:33 +0100 |
| commit | 3b2861fac9b80bc209c7597fc0e2dbd6d19d7652 (patch) | |
| tree | 58eaf49cfcf4244102194f2dc8606b3ca39581ea | |
| parent | 5b15abcd0168c63e57e061450cbbfd01942e43b9 (diff) | |
| download | termo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.tar.gz termo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.tar.xz termo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.zip | |
Refer to strfkey not snprint_key; add links to termkey_keycmp
| -rw-r--r-- | termkey_getkey.3.sh | 5 | ||||
| -rw-r--r-- | termkey_strpkey.3 | 3 | ||||
| -rw-r--r-- | termkey_waitkey.3.sh | 3 |
3 files changed, 7 insertions, 4 deletions
diff --git a/termkey_getkey.3.sh b/termkey_getkey.3.sh index ffc6d0e..55bfca1 100644 --- a/termkey_getkey.3.sh +++ b/termkey_getkey.3.sh @@ -68,7 +68,7 @@ The \fImodifiers\fP bitmask is composed of a bitwise-or of the constants \fBTERM .PP The \fIutf8\fP field is only set on events whose \fItype\fP is \fBTERMKEY_TYPE_UNICODE\fP. It should not be read for other events. .PP -To convert the \fIsym\fP to a symbolic name, see \fBtermkey_get_keyname\fP(3) function. It may instead be easier to convert the entire key event structure to a string, using \fBtermkey_snprint_key\fP(3). +To convert the \fIsym\fP to a symbolic name, see \fBtermkey_get_keyname\fP(3) function. It may instead be easier to convert the entire key event structure to a string, using \fBtermkey_strfkey\fP(3). .SH "RETURN VALUE" \fBtermkey_getkey\fP() returns an enumeration of one of \fBTERMKEY_RES_KEY\fP, \fBTEMRKEY_RES_AGAIN\fP, \fBTERMKEY_RES_NONE\fP or \fBTERMKEY_RES_EOF\fP. \fBtermkey_getkey_force\fP() returns one of the above, except for \fBTERMKEY_RES_AGAIN\fP. .SH EXAMPLE @@ -88,5 +88,6 @@ cat <<EOF .BR termkey_set_waittime (3), .BR termkey_get_keyname (3), .BR termkey_interpret_mouse (3), -.BR termkey_snprint_key (3) +.BR termkey_strfkey (3), +.BR termkey_keycmp (3) EOF diff --git a/termkey_strpkey.3 b/termkey_strpkey.3 index 4db431e..12e2d3a 100644 --- a/termkey_strpkey.3 +++ b/termkey_strpkey.3 @@ -29,4 +29,5 @@ The \fBTERMKEY_FORMAT_WRAPBRACKET\fP and \fBTERMKEY_FORMAT_MOUSE_POS\fP options After a successful parse, \fBtermkey_strpkey\fP() returns a pointer to the first character of the input it did not consume. If the input string contains more characters then this will point at the first character beyond. If the entire input string was consumed, then this will point at a null byte. If \fBtermkey_strpkey\fP() fails to parse, it returns \fBNULL\fP. After a failed parse, the \fIkey\fP structure may contain partial or invalid results. The structure will only be valid if the function returns a non-\fBNULL\fP result. .SH "SEE ALSO" .BR termkey_new (3), -.BR termkey_strfkey (3) +.BR termkey_strfkey (3), +.BR termkey_keycmp (3) diff --git a/termkey_waitkey.3.sh b/termkey_waitkey.3.sh index 54c532e..14f4f71 100644 --- a/termkey_waitkey.3.sh +++ b/termkey_waitkey.3.sh @@ -40,5 +40,6 @@ cat <<EOF .BR termkey_getkey (3), .BR termkey_set_waittime (3), .BR termkey_get_keyname (3), -.BR termkey_strfkey (3) +.BR termkey_strfkey (3), +.BR termkey_keycmp (3) EOF |