aboutsummaryrefslogtreecommitdiff
path: root/termkey_canonicalise.3
diff options
context:
space:
mode:
Diffstat (limited to 'termkey_canonicalise.3')
-rw-r--r--termkey_canonicalise.36
1 files changed, 3 insertions, 3 deletions
diff --git a/termkey_canonicalise.3 b/termkey_canonicalise.3
index d208251..eda0fdc 100644
--- a/termkey_canonicalise.3
+++ b/termkey_canonicalise.3
@@ -10,15 +10,15 @@ termkey_canonicalise \- canonicalise a key event
.sp
Link with \fI-ltermkey\fP.
.SH DESCRIPTION
-\fBtermkey_canonicalise\fP(3) modifies the key event structure given by \fIkey\fP according to the 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.
+\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_FLAG_SPACESYMBOL
+.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.
.SH "RETURN VALUE"
\fBtermkey_canonicalise\fP() returns no value.
.SH "SEE ALSO"
-.BR termkey_new (3),
+.BR termkey_set_canonflags (3),
.BR termkey_waitkey (3),
.BR termkey_strpkey (3)