aboutsummaryrefslogtreecommitdiff
path: root/termkey_getkey.3.sh
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-04-04 19:56:33 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-04-04 19:56:33 +0100
commit3b2861fac9b80bc209c7597fc0e2dbd6d19d7652 (patch)
tree58eaf49cfcf4244102194f2dc8606b3ca39581ea /termkey_getkey.3.sh
parent5b15abcd0168c63e57e061450cbbfd01942e43b9 (diff)
downloadtermo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.tar.gz
termo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.tar.xz
termo-3b2861fac9b80bc209c7597fc0e2dbd6d19d7652.zip
Refer to strfkey not snprint_key; add links to termkey_keycmp
Diffstat (limited to 'termkey_getkey.3.sh')
-rw-r--r--termkey_getkey.3.sh5
1 files changed, 3 insertions, 2 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