From 781c2160c3103a10d87e8d4fac474dd0076653e9 Mon Sep 17 00:00:00 2001
From: Paul LeoNerd Evans <leonerd@leonerd.org.uk>
Date: Mon, 10 Nov 2008 22:29:21 +0000
Subject: Added documentation on termkey_{get,set}_flags()

---
 termkey_set_flags.3 | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 termkey_set_flags.3

(limited to 'termkey_set_flags.3')

diff --git a/termkey_set_flags.3 b/termkey_set_flags.3
new file mode 100644
index 0000000..6365a91
--- /dev/null
+++ b/termkey_set_flags.3
@@ -0,0 +1,23 @@
+.TH TERMKEY_SET_FLAGS 3
+.SH NAME
+termkey_set_flags, termkey_get_flags \- control the operational flags
+.SH SYNOPSIS
+.nf
+.B #include <termkey.h>
+.sp
+.BI "void termkey_set_flags(termkey_t *" tk ", int " newflags );
+.br
+.BI "int termkey_get_flags(termkey_t *" tk );
+.fi
+.sp
+Link with \fI-ltermkey\fP.
+.SH DESCRIPTION
+\fBtermkey_set_flags\fP changes the set of operation flags in the termkey instance to those given by \fInewflags\fP.
+.PP
+\fBtermkey_get_flags\fP returns the value set by the last call to \fBtermkey_set_flags\fP(), or the value given to the constructor.
+.PP
+When the constructor is invoked, it attempts to detect if the current locale is UTF-8 aware or not, and sets either the \fBTERMKEY_FLAG_UTF8\fP or \fBTERMKEY_FLAG_RAW\fP flag. One of these two bits will always be returned by \fBtermkey_get_flags\fP().
+.SH "RETURN VALUE"
+\fBtermkey_set_flags\fP() returns no value. \fBtermkey_get_flags\fP() returns the current operational flags.
+.SH "SEE ALSO"
+.BR termkey_new (3),
-- 
cgit v1.2.3