diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-12-02 00:56:43 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-12-02 00:56:43 +0000 |
| commit | 2fba93b6904e22e46de66648d5c98af7512e1e1e (patch) | |
| tree | 074c1f9f991127acbdad7724d3eccfe45d055ab8 /termkey_get_keyname.3 | |
| parent | f75bdf1516b031b0f975b77f289ea408e30cb9c9 (diff) | |
| download | termo-2fba93b6904e22e46de66648d5c98af7512e1e1e.tar.gz termo-2fba93b6904e22e46de66648d5c98af7512e1e1e.tar.xz termo-2fba93b6904e22e46de66648d5c98af7512e1e1e.zip | |
Added termkey_keyname2sym() to API
Diffstat (limited to 'termkey_get_keyname.3')
| -rw-r--r-- | termkey_get_keyname.3 | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/termkey_get_keyname.3 b/termkey_get_keyname.3 index c1f0d79..62dc1d2 100644 --- a/termkey_get_keyname.3 +++ b/termkey_get_keyname.3 @@ -10,11 +10,12 @@ termkey_get_keyname \- return a string name for a symbolic key .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). +\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_keyname2sym (3), .BR termkey_snprint_key (3) |