From 082b49f0f8790e2cf98346a03c53f492d9d5dcba Mon Sep 17 00:00:00 2001 From: Paul LeoNerd Evans Date: Wed, 18 Jan 2012 12:01:38 +0000 Subject: Move the growing collection of manpages into their own man/ subdirectory --- termkey_keycmp.3 | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 termkey_keycmp.3 (limited to 'termkey_keycmp.3') diff --git a/termkey_keycmp.3 b/termkey_keycmp.3 deleted file mode 100644 index 3eed66c..0000000 --- a/termkey_keycmp.3 +++ /dev/null @@ -1,25 +0,0 @@ -.TH TERMKEY_KEYCMP 3 -.SH NAME -termkey_keycmp \- compare two key events -.SH SYNOPSIS -.nf -.B #include -.sp -.BI "int termkey_keycmp(TermKey *" tk ", const TermKeyKey *" key1 ", -.BI " const TermKeyKey *" key2 ); -.fi -.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). -.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" -\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_new (3), -.BR termkey_getkey (3), -.BR termkey_strpkey (3), -.BR termkey_canonicalise (3) -- cgit v1.2.3-54-g00ecf