aboutsummaryrefslogtreecommitdiff
path: root/termkey_new.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2009-07-15 20:40:44 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2009-07-15 20:40:44 +0100
commitbe998cef1b8a46391956dc212ef3bf1351da0f3a (patch)
treeb5634e51fc74ca524f94a05ece2ddc430994ec58 /termkey_new.3
parentaf50967d12929b5745e868796ba50e4ee9b54f6d (diff)
downloadtermo-be998cef1b8a46391956dc212ef3bf1351da0f3a.tar.gz
termo-be998cef1b8a46391956dc212ef3bf1351da0f3a.tar.xz
termo-be998cef1b8a46391956dc212ef3bf1351da0f3a.zip
Renamed all type names to CamelCaseNames for visual distinctness, separate from variables/functions
Diffstat (limited to 'termkey_new.3')
-rw-r--r--termkey_new.36
1 files changed, 3 insertions, 3 deletions
diff --git a/termkey_new.3 b/termkey_new.3
index 4d099ff..4a7f774 100644
--- a/termkey_new.3
+++ b/termkey_new.3
@@ -7,14 +7,14 @@ termkey_new, termkey_destroy \- create or destroy new termkey instance
.sp
.BI "TERMKEY_CHECK_VERSION;"
.br
-.BI "termkey_tk *termkey_new(int " fd ", int " flags );
+.BI "TermKey *termkey_new(int " fd ", int " flags );
.br
-.BI "void termkey_destroy(termkey_t *" tk );
+.BI "void termkey_destroy(TermKey *" tk );
.fi
.sp
Link with \fI\-ltermkey\fP.
.SH DESCRIPTION
-\fBtermkey_new\fP() creates a new termkey instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fBtermkey_tk\fP structure should be considered opaque; its contents are not intended for use outside of the library.
+\fBtermkey_new\fP() creates a new termkey instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fBTermKey\fP structure should be considered opaque; its contents are not intended for use outside of the library.
.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