aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_keycmp.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 23:26:47 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 23:26:47 +0000
commit948e48d56a4449aa1a50d60cbd1c4e74c0e6135d (patch)
tree43ecd8760a928517823c6fbe553e5f7a11cb018d /man/termkey_keycmp.3
parentcfb0480c1a84ca8dff490d5ce5867e87b1d01fc1 (diff)
downloadtermo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.tar.gz
termo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.tar.xz
termo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.zip
Various other minor fixes to manpages
Diffstat (limited to 'man/termkey_keycmp.3')
-rw-r--r--man/termkey_keycmp.32
1 files changed, 1 insertions, 1 deletions
diff --git a/man/termkey_keycmp.3 b/man/termkey_keycmp.3
index 7aa660b..9001815 100644
--- a/man/termkey_keycmp.3
+++ b/man/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. Before comparison, copies of both referenced structures are taken, and canonicalised according to the rules for \fBtermkey_canonicalise\fP(3).
+\fBtermkey_keycmp\fP() compares two key structures and applies a total ordering, returning a value that is negative, zero, or positive, 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"