From 388782b89be0bf8144ae3dc2a590b466c96d3d6d Mon Sep 17 00:00:00 2001
From: Paul LeoNerd Evans <leonerd@leonerd.org.uk>
Date: Thu, 6 Nov 2008 00:02:41 +0000
Subject: Added manpages for (most of) the external API functions

---
 termkey_get_keyname.3 | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 termkey_get_keyname.3

(limited to 'termkey_get_keyname.3')

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)
-- 
cgit v1.2.3-54-g00ecf