diff options
author | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-26 12:55:16 +0000 |
---|---|---|
committer | Paul LeoNerd Evans <leonerd@leonerd.org.uk> | 2012-01-26 12:55:16 +0000 |
commit | ea2d3073ac177d95fc14c310178aa2b7455b060a (patch) | |
tree | 28f36380bd0e1a6c21c2fe8e4d56f388e87dc3e4 /man | |
parent | 63f37cecd6c68914016451eae714a163cf988db3 (diff) | |
download | termo-ea2d3073ac177d95fc14c310178aa2b7455b060a.tar.gz termo-ea2d3073ac177d95fc14c310178aa2b7455b060a.tar.xz termo-ea2d3073ac177d95fc14c310178aa2b7455b060a.zip |
Created termkey_new_abstract()
Diffstat (limited to 'man')
-rw-r--r-- | man/termkey_new.3 | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/man/termkey_new.3 b/man/termkey_new.3 index dd188d6..c727d22 100644 --- a/man/termkey_new.3 +++ b/man/termkey_new.3 @@ -7,12 +7,15 @@ termkey_new, termkey_destroy \- create or destroy new termkey instance .sp .BI "TERMKEY_CHECK_VERSION;" .BI "TermKey *termkey_new(int " fd ", int " flags ); +.BI "TermKey *termkey_new_abstract(const char *" term ", int " flags ); .BI "void termkey_destroy(TermKey *" tk ); .fi .sp Link with \fI\-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_new\fP() creates a new \fBtermkey\fP(7) instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fITermKey\fP structure should be considered opaque; its contents are not intended for use outside of the library. If \fIfd\fP is given the value -1, then no file handle will be associated. +\fBtermkey_new\fP() creates a new \fBtermkey\fP(7) instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fITermKey\fP structure should be considered opaque; its contents are not intended for use outside of the library. +.PP +\fBtermkey_new_abstract\fP() creates a new \fBtermkey\fP() instance with no file handle associated. As this is usually done for handling other sources of terminal byte input, it also takes a string indicating the termtype to use. .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 |