From 082b49f0f8790e2cf98346a03c53f492d9d5dcba Mon Sep 17 00:00:00 2001 From: Paul LeoNerd Evans Date: Wed, 18 Jan 2012 12:01:38 +0000 Subject: Move the growing collection of manpages into their own man/ subdirectory --- man/termkey_get_keyname.3 | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 man/termkey_get_keyname.3 (limited to 'man/termkey_get_keyname.3') diff --git a/man/termkey_get_keyname.3 b/man/termkey_get_keyname.3 new file mode 100644 index 0000000..5f0119f --- /dev/null +++ b/man/termkey_get_keyname.3 @@ -0,0 +1,22 @@ +.TH TERMKEY_GET_KEYNAME 3 +.SH NAME +termkey_get_keyname \- return a string name for a symbolic key +.SH SYNOPSIS +.nf +.B #include +.sp +.BI "const char *termkey_get_keyname(TermKey *" tk ", TermKeySym " 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_destroy\fP(3). This function is the inverse of \fBtermkey_keyname2sym\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_lookup_keyname (3), +.BR termkey_keyname2sym (3), +.BR termkey_strfkey (3) -- cgit v1.2.3-70-g09d2