diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-03 18:44:48 +0100 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2011-04-03 18:44:48 +0100 |
| commit | f23a55ab8257987c1fdd49ba406f885bf78190b3 (patch) | |
| tree | 03a17875d87e215ceafe1127c779d47c2f31a646 /termkey_lookup_keyname.3 | |
| parent | 574754d5f108a92d77dc4e01022091ed42ca0020 (diff) | |
| download | termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.gz termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.tar.xz termo-f23a55ab8257987c1fdd49ba406f885bf78190b3.zip | |
Various minor neatenings to manpage formatting
Diffstat (limited to 'termkey_lookup_keyname.3')
| -rw-r--r-- | termkey_lookup_keyname.3 | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/termkey_lookup_keyname.3 b/termkey_lookup_keyname.3 index 4d763ff..bd44411 100644 --- a/termkey_lookup_keyname.3 +++ b/termkey_lookup_keyname.3 @@ -11,7 +11,7 @@ termkey_lookup_keyname \- look up a symbolic key value for a string name .sp Link with \fI-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_lookup_keyname\fP looks up the symbolic key value represented by the given string name. This is a case-sensitive comparison. The symbolic value is written to the variable addressed by \fIsym\fP. This function is a more general form of \fBtermkey_keyname2sym\fP(3) because it can recognise a symbolic key name within a longer string, returning a pointer to the remainder of the input after the key name. +\fBtermkey_lookup_keyname\fP() looks up the symbolic key value represented by the given string name. This is a case-sensitive comparison. The symbolic value is written to the variable addressed by \fIsym\fP. This function is a more general form of \fBtermkey_keyname2sym\fP(3) because it can recognise a symbolic key name within a longer string, returning a pointer to the remainder of the input after the key name. .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" |