aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 00:56:08 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 00:56:08 +0000
commit107587744c6e9be29d7c3cc9e9e73925e97f8a1e (patch)
treed9acce5ef61fc121fb628f0d7c9cee9b1cb9bfdb
parent61e304c6b4b86f23cba1b2f59dae45411ab8bdfd (diff)
downloadtermo-107587744c6e9be29d7c3cc9e9e73925e97f8a1e.tar.gz
termo-107587744c6e9be29d7c3cc9e9e73925e97f8a1e.tar.xz
termo-107587744c6e9be29d7c3cc9e9e73925e97f8a1e.zip
Removed note about termkey_keycmp() not canonicalising key structures, since it does in fact do exactly that
-rw-r--r--man/termkey_keycmp.32
1 files changed, 0 insertions, 2 deletions
diff --git a/man/termkey_keycmp.3 b/man/termkey_keycmp.3
index 2993f2b..7aa660b 100644
--- a/man/termkey_keycmp.3
+++ b/man/termkey_keycmp.3
@@ -16,8 +16,6 @@ Link with \fI-ltermkey\fP.
Two structures of differing type are ordered \fBTERMKEY_TYPE_UNICODE\fP, \fBTERMKEY_TYPE_KEYSYM\fP, \fBTERMKEY_TYPE_FUNCTION\fP, \fBTERMKEY_TYPE_MOUSE\fP. Unicode structures are ordered by codepoint, keysym structures are ordered by keysym number, function structures are ordered by function key number, and mouse structures are ordered opaquely by an unspecified but consistent ordering. Within these values, keys different in modifier bits are ordered by the modifiers.
.SH "RETURN VALUE"
\fBtermkey_keycmp\fP() returns an integer greater than, equal to, or less than zero to indicate the relation between the two given key structures.
-.SH NOTES
-This function does not perform any canonicalisation of the key structures, and performs a simple comparison of the fields in the structures. In particular, it will not consider as equal \fBTERMKEY_TYPE_UNICODE\fP containing the Space codepoint (U+0020) vs. \fBTERMKEY_TYPE_KEYSYM\fP containing \fBTERMKEY_SYM_SPACE\fP.
.SH "SEE ALSO"
.BR termkey_strpkey (3),
.BR termkey_canonicalise (3),