summaryrefslogtreecommitdiffstats
path: root/doc/CrtFileHdlr.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-10-15 10:43:37 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-10-15 10:43:37 (GMT)
commit89b27a8118e809ac322a0200fbda93fd65b03d15 (patch)
tree76a9fcf427bd66b39f4124071860e59744540d77 /doc/CrtFileHdlr.3
parent9621a454a0bde1f84cef51026947815d4eb244b6 (diff)
downloadtcl-89b27a8118e809ac322a0200fbda93fd65b03d15.zip
tcl-89b27a8118e809ac322a0200fbda93fd65b03d15.tar.gz
tcl-89b27a8118e809ac322a0200fbda93fd65b03d15.tar.bz2
Lots of very minor formatting fixes.
Diffstat (limited to 'doc/CrtFileHdlr.3')
-rw-r--r--doc/CrtFileHdlr.37
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/CrtFileHdlr.3 b/doc/CrtFileHdlr.3
index 4b352ba..00a6a48 100644
--- a/doc/CrtFileHdlr.3
+++ b/doc/CrtFileHdlr.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: CrtFileHdlr.3,v 1.9 2008/06/29 22:28:23 dkf Exp $
+'\" RCS: @(#) $Id: CrtFileHdlr.3,v 1.10 2008/10/15 10:43:37 dkf Exp $
'\"
.so man.macros
.TH Tcl_CreateFileHandler 3 8.0 Tcl "Tcl Library Procedures"
@@ -50,11 +50,13 @@ as \fBvwait\fR.
.PP
\fIProc\fR should have arguments and result that match the
type \fBTcl_FileProc\fR:
+.PP
.CS
typedef void \fBTcl_FileProc\fR(
ClientData \fIclientData\fR,
int \fImask\fR);
.CE
+.PP
The \fIclientData\fR parameter to \fIproc\fR is a copy
of the \fIclientData\fR
argument given to \fBTcl_CreateFileHandler\fR when the callback
@@ -65,7 +67,6 @@ of the requested conditions actually exists for the file; it
will contain a subset of the bits in the \fImask\fR argument
to \fBTcl_CreateFileHandler\fR.
.PP
-.PP
There may exist only one handler for a given file at a given time.
If \fBTcl_CreateFileHandler\fR is called when a handler already
exists for \fIfd\fR, then the new callback replaces the information
@@ -86,5 +87,7 @@ blocking or nonblocking mode as required.
.PP
Note that these interfaces are only supported by the Unix
implementation of the Tcl notifier.
+.SH "SEE ALSO"
+fileevent(n), Tcl_CreateTimerHandler(3), Tcl_DoWhenIdle(3)
.SH KEYWORDS
callback, file, handler