p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document the TERMKEY_CHECK_VERSION macro

This commit is contained in:
Paul LeoNerd Evans 2008-11-18 12:19:29 +00:00
parent 297cec0681
commit c41763c60a
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
termkey_new.3
View File

@ -5,6 +5,8 @@ termkey_new, termkey_destroy \- create or destroy new termkey instance
.nf .nf
.B #include <termkey.h> .B #include <termkey.h>
.sp .sp
.BI "TERMKEY_CHECK_VERSION;"
.br
.BI "termkey_tk *termkey_new(int " fd ", int " flags ); .BI "termkey_tk *termkey_new(int " fd ", int " flags );
.br .br
.BI "void termkey_destroy(termkey_t *" tk ); .BI "void termkey_destroy(termkey_t *" tk );
@ -38,6 +40,8 @@ Even if the terminal file descriptor \fIfd\fP represents a
device, do not call the \fBtcsetattr\fP() \fBtermios\fP function on it to set it to canonical input mode. device, do not call the \fBtcsetattr\fP() \fBtermios\fP function on it to set it to canonical input mode.
.PP .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(). 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().
.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.
.SH "RETURN VALUE" .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. 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" .SH "SEE ALSO"