diff options
| author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 12:01:38 +0000 |
|---|---|---|
| committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-18 12:01:38 +0000 |
| commit | 082b49f0f8790e2cf98346a03c53f492d9d5dcba (patch) | |
| tree | 91d657db23e92b6b658dd4e73cecf1fb18c79188 /man/termkey_set_flags.3 | |
| parent | d64ba87edae62894ca74cfb9d6d8cdd88c213397 (diff) | |
| download | termo-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_set_flags.3')
| -rw-r--r-- | man/termkey_set_flags.3 | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/man/termkey_set_flags.3 b/man/termkey_set_flags.3 new file mode 100644 index 0000000..1d8f4e8 --- /dev/null +++ b/man/termkey_set_flags.3 @@ -0,0 +1,22 @@ +.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 *" tk ", int " newflags ); +.BI "int termkey_get_flags(TermKey *" 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) |