aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_keycmp.3
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2014-09-23 01:38:08 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2014-09-23 03:05:01 +0200
commitb630bf7a5f5ec85317db04f770ffc90664ac28f0 (patch)
tree52a0f40045809e71bc6fcac40d52e570f2fb2b59 /man/termkey_keycmp.3
parent7909067ac05e885211dafa255da0526543bb87bf (diff)
downloadtermo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.tar.gz
termo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.tar.xz
termo-b630bf7a5f5ec85317db04f770ffc90664ac28f0.zip
WIP: Is mine now (^3^)
Seriously though, I've got some issues with how this thing is designed, as well as with its formatting, and when you add the fact that the original author wants to merge this thing into his bigger library that also handles terminal output, which I'll kindly leave to ncurses, it kind of makes sense for me to do this. Manpages have been removed as they are going to become obsolete and they're rather difficult to maintain. If anything, there will be Doxygen-generated documentation. The plan is to throw away any direct UTF-8 support and support all uni- and multibyte character encodings. However some unrelated refactoring is about to come first.
Diffstat (limited to 'man/termkey_keycmp.3')
-rw-r--r--man/termkey_keycmp.322
1 files changed, 0 insertions, 22 deletions
diff --git a/man/termkey_keycmp.3 b/man/termkey_keycmp.3
deleted file mode 100644
index 9001815..0000000
--- a/man/termkey_keycmp.3
+++ /dev/null
@@ -1,22 +0,0 @@
-.TH TERMKEY_KEYCMP 3
-.SH NAME
-termkey_keycmp \- compare two key events
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.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 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"
-\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 "SEE ALSO"
-.BR termkey_strpkey (3),
-.BR termkey_canonicalise (3),
-.BR termkey (7)