diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-11-06 00:02:41 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2008-11-06 00:02:41 +0000 |
| commit | 388782b89be0bf8144ae3dc2a590b466c96d3d6d (patch) | |
| tree | e8d41f72cc32be131ea088ef1b0dc60d740a2a37 /termkey_get_keyname.3 | |
| parent | 6adbb40f6eb112b4a34b7696301421ec7aa212bb (diff) | |
| download | termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.tar.gz termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.tar.xz termo-388782b89be0bf8144ae3dc2a590b466c96d3d6d.zip | |
Added manpages for (most of) the external API functions
Diffstat (limited to 'termkey_get_keyname.3')
| -rw-r--r-- | termkey_get_keyname.3 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/termkey_get_keyname.3 b/termkey_get_keyname.3 new file mode 100644 index 0000000..cc46460 --- /dev/null +++ b/termkey_get_keyname.3 @@ -0,0 +1,20 @@ +.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) |