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

Refer to strfkey not snprint_key; add links to termkey_keycmp

This commit is contained in:
Paul LeoNerd Evans 2011-04-04 19:56:33 +01:00
parent 5b15abcd01
commit 3b2861fac9
3 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
termkey_getkey.3.sh
View File

@ -68,7 +68,7 @@ The \fImodifiers\fP bitmask is composed of a bitwise-or of the constants \fBTERM
.PP .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. 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 .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" .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. \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 .SH EXAMPLE
@ -88,5 +88,6 @@ cat <<EOF
.BR termkey_set_waittime (3), .BR termkey_set_waittime (3),
.BR termkey_get_keyname (3), .BR termkey_get_keyname (3),
.BR termkey_interpret_mouse (3), .BR termkey_interpret_mouse (3),
.BR termkey_snprint_key (3) .BR termkey_strfkey (3),
.BR termkey_keycmp (3)
EOF EOF

3
termkey_strpkey.3
View File

@ -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. 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" .SH "SEE ALSO"
.BR termkey_new (3), .BR termkey_new (3),
.BR termkey_strfkey (3) .BR termkey_strfkey (3),
.BR termkey_keycmp (3)

3
termkey_waitkey.3.sh
View File

@ -40,5 +40,6 @@ cat <<EOF
.BR termkey_getkey (3), .BR termkey_getkey (3),
.BR termkey_set_waittime (3), .BR termkey_set_waittime (3),
.BR termkey_get_keyname (3), .BR termkey_get_keyname (3),
.BR termkey_strfkey (3) .BR termkey_strfkey (3),
.BR termkey_keycmp (3)
EOF EOF