From 2fba93b6904e22e46de66648d5c98af7512e1e1e Mon Sep 17 00:00:00 2001
From: Paul LeoNerd Evans <leonerd@leonerd.org.uk>
Date: Tue, 2 Dec 2008 00:56:43 +0000
Subject: Added termkey_keyname2sym() to API

---
 termkey_keyname2sym.3 | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 termkey_keyname2sym.3

(limited to 'termkey_keyname2sym.3')

diff --git a/termkey_keyname2sym.3 b/termkey_keyname2sym.3
new file mode 100644
index 0000000..aba22f4
--- /dev/null
+++ b/termkey_keyname2sym.3
@@ -0,0 +1,21 @@
+.TH TERMKEY_KEYNAME2SYM 3
+.SH NAME
+termkey_keyname2sym \- look up a symbolic key value for a string name
+.SH SYNOPSIS
+.nf
+.B #include <termkey.h>
+.sp
+.BI "termkey_keysym termkey_keyname2sym(termkey_t *" tk ", const char *" keyname );
+.fi
+.sp
+Link with \fI-ltermkey\fP.
+.SH DESCRIPTION
+\fBtermkey_keyname2sym\fP looks up the symbolic key value represented by the given string name. This is a case-sensitive comparison. If the given name is not found, \fBTERMKEY_SYM_UNKNOWN\fP is returned instead. This function is the inverse of \fBtermkey_get_keyname\fP(3).
+.PP
+Because the key names are stored in an array indexed by the symbol number, this function has to perform a linear search of the names. Use of this function should be restricted to converting key names into symbolic values during a program's initialisation, so that efficient comparisons can be done while it is running.
+.SH "RETURN VALUE"
+\fBtermkey_get_key\fP() returns a pointer to a string.
+.SH "SEE ALSO"
+.BR termkey_new (3),
+.BR termkey_get_keyname (3),
+.BR termkey_snprint_key (3)
-- 
cgit v1.2.3