termo/man/termkey_get_keyname.3

.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 *" 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 \fIsym\fP. The returned string is owned by the \fBtermkey\fP(7) instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the 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_lookup_keyname (3),
.BR termkey_keyname2sym (3),
.BR termkey_strfkey (3),
.BR termkey (7)
Added manpages for (most of) the external API functions 2008-11-06 01:02:41 +01:00			`.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`
Renamed all type names to CamelCaseNames for visual distinctness, separate from variables/functions 2009-07-15 21:40:44 +02:00			`.BI "const char termkey_get_keyname(TermKey " tk ", TermKeySym " sym );`
Added manpages for (most of) the external API functions 2008-11-06 01:02:41 +01:00			`.fi`
			`.sp`
			`Link with \fI-ltermkey\fP.`
			`.SH DESCRIPTION`
Various other minor fixes to manpages 2012-01-22 00:26:47 +01:00			`\fBtermkey_get_keyname\fP() returns a human-readable string name for the symbolic key value given by \fIsym\fP. The returned string is owned by the \fBtermkey\fP(7) instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the instance is released using \fBtermkey_destroy\fP(3). This function is the inverse of \fBtermkey_keyname2sym\fP(3).`
Added manpages for (most of) the external API functions 2008-11-06 01:02:41 +01:00			`.SH "RETURN VALUE"`
			`\fBtermkey_get_key\fP() returns a pointer to a string.`
			`.SH "SEE ALSO"`
Provide a termkey_lookup_keyname that can do partial buffer parsing 2011-04-01 14:26:54 +02:00			`.BR termkey_lookup_keyname (3),`
Added termkey_keyname2sym() to API 2008-12-02 01:56:43 +01:00			`.BR termkey_keyname2sym (3),`
Link to termkey(7) from other manpages, delete some of the duplicated sections 2012-01-21 01:52:13 +01:00			`.BR termkey_strfkey (3),`
			`.BR termkey (7)`