21 lines
784 B
Groff
21 lines
784 B
Groff
|
.TH TERMKEY_GET_KEYNAME 3
|
||
|
|
.SH NAME
|
||
|
|
termkey_get_keyname \- return a string name for a symbolic key
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
.B #include <termkey.h>
|
||
|
|
.sp
|
||
|
|
.BI "const char *termkey_get_keyname(termkey_t *" tk ", termkey_keysym " sym );
|
||
|
|
.fi
|
||
|
|
.sp
|
||
|
|
Link with \fI-ltermkey\fP.
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\fBtermkey_get_keyname\fP returns a human-readable string name for the symbolic key value given by \fBsym\fP. The returned string is owned by the termkey instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the termkey instance is released using \fBtermkey_free\fP(3).
|
||
|
|
.SH "RETURN VALUE"
|
||
|
|
\fBtermkey_get_key\fP() returns a pointer to a string.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR termkey_new (3),
|
||
|
|
.BR termkey_getkey (3),
|
||
|
|
.BR termkey_waitkey (3),
|
||
|
|
.BR termkey_snprint_key (3)
|