aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_canonicalise.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_canonicalise.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_canonicalise.3')
-rw-r--r--man/termkey_canonicalise.322
1 files changed, 0 insertions, 22 deletions
diff --git a/man/termkey_canonicalise.3 b/man/termkey_canonicalise.3
deleted file mode 100644
index 47fb21f..0000000
--- a/man/termkey_canonicalise.3
+++ /dev/null
@@ -1,22 +0,0 @@
-.TH TERMKEY_CANONICALISE 3
-.SH NAME
-termkey_canonicalise \- canonicalise a key event
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.sp
-.BI "void termkey_canonicalise(TermKey *" tk ", TermKeyKey *" key );
-.fi
-.sp
-Link with \fI-ltermkey\fP.
-.SH DESCRIPTION
-\fBtermkey_canonicalise\fP(3) modifies the key event structure given by \fIkey\fP according to the canonicalisation flags set on the given \fBtermkey\fP instance. This operation is performed implicitly by \fBtermkey_getkey\fP(3), \fBtermkey_waitkey\fP(3) and \fBtermkey_strpkey\fP(3), and is also provided explicitly by this function.
-.PP
-See \fBtermkey\fP(7) for a list of canonicalisation flags.
-.SH "RETURN VALUE"
-\fBtermkey_canonicalise\fP() returns no value.
-.SH "SEE ALSO"
-.BR termkey_set_canonflags (3),
-.BR termkey_waitkey (3),
-.BR termkey_strpkey (3),
-.BR termkey (7)