diff options
Diffstat (limited to 'termkey_keycmp.3')
| -rw-r--r-- | termkey_keycmp.3 | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/termkey_keycmp.3 b/termkey_keycmp.3 index d2a0c9b..3eed66c 100644 --- a/termkey_keycmp.3 +++ b/termkey_keycmp.3 @@ -11,7 +11,7 @@ termkey_keycmp \- compare two key events .sp Link with \fI-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_keycmp\fP() compares two key structures and applies a total ordering, returning a value that is positive, zero, or negative, to indicate if the given structures are increasing, identical, or decreasing. +\fBtermkey_keycmp\fP() compares two key structures and applies a total ordering, returning a value that is positive, zero, or negative, to indicate if the given structures are increasing, identical, or decreasing. Before comparison, copies of both referenced structures are taken, and canonicalised according to the rules for \fBtermkey_canonicalise\fP(3). .PP 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" @@ -21,4 +21,5 @@ This function does not perform any canonicalisation of the key structures, and p .SH "SEE ALSO" .BR termkey_new (3), .BR termkey_getkey (3), -.BR termkey_strpkey (3) +.BR termkey_strpkey (3), +.BR termkey_canonicalise (3) |