aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_set_canonflags.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/termkey_set_canonflags.3')
-rw-r--r--man/termkey_set_canonflags.321
1 files changed, 21 insertions, 0 deletions
diff --git a/man/termkey_set_canonflags.3 b/man/termkey_set_canonflags.3
new file mode 100644
index 0000000..2bc125c
--- /dev/null
+++ b/man/termkey_set_canonflags.3
@@ -0,0 +1,21 @@
+.TH TERMKEY_SET_CANONFLAGS 3
+.SH NAME
+termkey_set_canonflags, termkey_get_canonflags \- control the canonicalisation flags
+.SH SYNOPSIS
+.nf
+.B #include <termkey.h>
+.sp
+.BI "void termkey_set_canonflags(TermKey *" tk ", int " newflags );
+.BI "int termkey_get_canonflags(TermKey *" tk );
+.fi
+.sp
+Link with \fI-ltermkey\fP.
+.SH DESCRIPTION
+\fBtermkey_set_canonflags\fP() changes the set of canonicalisation flags in the termkey instance to those given by \fInewflags\fP. For detail on the available flags and their meaning, see \fBtermkey_set_canonflags\fP(3).
+.PP
+\fBtermkey_get_canonflags\fP() returns the value set by the last call to \fBtermkey_canonicalise\fP().
+.SH "RETURN VALUE"
+\fBtermkey_set_flags\fP() returns no value. \fBtermkey_get_flags\fP() returns the current canonicalisation flags.
+.SH "SEE ALSO"
+.BR termkey_new (3),
+.BR termkey_canonicalise (3)