From f23a55ab8257987c1fdd49ba406f885bf78190b3 Mon Sep 17 00:00:00 2001 From: Paul LeoNerd Evans Date: Sun, 3 Apr 2011 18:44:48 +0100 Subject: Various minor neatenings to manpage formatting --- termkey_keyname2sym.3 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'termkey_keyname2sym.3') diff --git a/termkey_keyname2sym.3 b/termkey_keyname2sym.3 index c9224bc..095a465 100644 --- a/termkey_keyname2sym.3 +++ b/termkey_keyname2sym.3 @@ -10,7 +10,7 @@ termkey_keyname2sym \- look up a symbolic key value for a string name .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), and is a more specific form of \fBtermkey_lookup_keyname\fP(3) which only recognises names as complete strings. +\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), and is a more specific form of \fBtermkey_lookup_keyname\fP(3) which only recognises names as complete strings. .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" -- cgit v1.2.3