aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_canonicalise.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-18 12:01:38 +0000
commit082b49f0f8790e2cf98346a03c53f492d9d5dcba (patch)
tree91d657db23e92b6b658dd4e73cecf1fb18c79188 /man/termkey_canonicalise.3
parentd64ba87edae62894ca74cfb9d6d8cdd88c213397 (diff)
downloadtermo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.gz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.tar.xz
termo-082b49f0f8790e2cf98346a03c53f492d9d5dcba.zip
Move the growing collection of manpages into their own man/ subdirectory
Diffstat (limited to 'man/termkey_canonicalise.3')
-rw-r--r--man/termkey_canonicalise.327
1 files changed, 27 insertions, 0 deletions
diff --git a/man/termkey_canonicalise.3 b/man/termkey_canonicalise.3
new file mode 100644
index 0000000..980e400
--- /dev/null
+++ b/man/termkey_canonicalise.3
@@ -0,0 +1,27 @@
+.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 \fItk\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
+The canonicalisation operation is affected by the following flags:
+.TP
+.B TERMKEY_CANON_SPACESYMBOL
+If this flag is set then a Unicode space character is represented using the \fBTERMKEY_SYM_SPACE\fP symbol. If this flag is not set, it is represented by the U+0020 Unicode codepoint.
+.TP
+.B TERMKEY_CANON_DELBS
+If this flag is set then an ASCII DEL character is represented by the \fBTERMKEY_SYM_BACKSPACE\fP symbol. If not, it is represented by \fBTERMKEY_SYM_DEL\fP. An ASCII BS character is always represented by \fBTERMKEY_SYM_BACKSPACE\fP, regardless of this flag.
+.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)