aboutsummaryrefslogtreecommitdiff
path: root/man/termkey_new.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 23:26:47 +0000
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-01-21 23:26:47 +0000
commit948e48d56a4449aa1a50d60cbd1c4e74c0e6135d (patch)
tree43ecd8760a928517823c6fbe553e5f7a11cb018d /man/termkey_new.3
parentcfb0480c1a84ca8dff490d5ce5867e87b1d01fc1 (diff)
downloadtermo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.tar.gz
termo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.tar.xz
termo-948e48d56a4449aa1a50d60cbd1c4e74c0e6135d.zip
Various other minor fixes to manpages
Diffstat (limited to 'man/termkey_new.3')
-rw-r--r--man/termkey_new.36
1 files changed, 3 insertions, 3 deletions
diff --git a/man/termkey_new.3 b/man/termkey_new.3
index 5e35ff1..dd188d6 100644
--- a/man/termkey_new.3
+++ b/man/termkey_new.3
@@ -16,11 +16,11 @@ Link with \fI\-ltermkey\fP.
.PP
\fBtermkey_destroy\fP() destroys the given instance and releases any resources controlled by it. It will not close the underlying filehandle given as the \fIfd\fP argument to \fBtermkey_new\fP().
.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 in effect. The current flags in effect can be obtained by \fBtermkey_get_flags\fP(3).
+The constructor 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 in effect. The current flags in effect can be obtained by \fBtermkey_get_flags\fP(3).
.PP
-If a file handle is provided, the terminfo driver may send a string to the terminal before \fBtermkey_new\fP() returns to initialise it, or set the state correctly. This will not be done if no file handle is provided, or if the file handle is a pipe (\fBS_ISFIFO\fP()). In this case it will be the caller's responsibility to ensure the terminal is in the correct mode.
+If a file handle is provided, the terminfo driver may send a string to initialise or set the state of the terminal before \fBtermkey_new\fP() returns. This will not be done if no file handle is provided, or if the file handle is a pipe (\fBS_ISFIFO\fP()). In this case it will be the caller's responsibility to ensure the terminal is in the correct mode.
.SH VERSION CHECK MACRO
-Before calling any functions in the \fItermkey\fP library, an application should use the \fBTERMKEY_CHECK_VERSION\fP macro to check that the loaded version of the library is compatible with the version it was compiled against. This should be done early on, ideally just after entering its \fBmain()\fP function.
+Before calling any functions in the \fBtermkey\fP library, an application should use the \fBTERMKEY_CHECK_VERSION\fP macro to check that the loaded version of the library is compatible with the version it was compiled against. This should be done early on, ideally just after entering its \fBmain\fP() function.
.SH "RETURN VALUE"
If successful, \fBtermkey_new\fP() returns a pointer to the new instance. On failure, \fBNULL\fP is returned. \fBtermkey_destroy\fP() returns no value.
.SH "SEE ALSO"