summaryrefslogtreecommitdiffstats
path: root/doc/vwait.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vwait.n')
-rw-r--r--doc/vwait.n8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/vwait.n b/doc/vwait.n
index 1982c9a..89796c6 100644
--- a/doc/vwait.n
+++ b/doc/vwait.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: vwait.n,v 1.7 2008/01/09 08:09:56 georgeps Exp $
+'\" RCS: @(#) $Id: vwait.n,v 1.8 2008/10/17 10:22:25 dkf Exp $
'\"
.so man.macros
.TH vwait n 8.0 Tcl "Tcl Built-In Commands"
@@ -15,7 +15,6 @@ vwait \- Process events until a variable is written
.SH SYNOPSIS
\fBvwait\fR \fIvarName\fR
.BE
-
.SH DESCRIPTION
.PP
This command enters the Tcl event loop to process events, blocking
@@ -36,15 +35,18 @@ for a long time. During this time the top-level \fBvwait\fR is
blocked waiting for the event handler to complete, so it cannot
return either.
.SH EXAMPLES
+.PP
Run the event-loop continually until some event calls \fBexit\fR.
(You can use any variable not mentioned elsewhere, but the name
\fIforever\fR reminds you at a glance of the intent.)
+.PP
.CS
\fBvwait\fR forever
.CE
.PP
Wait five seconds for a connection to a server socket, otherwise
close the socket and continue running the script:
+.PP
.CS
# Initialise the state
after 5000 set state timeout
@@ -73,9 +75,7 @@ switch $state {
}
}
.CE
-
.SH "SEE ALSO"
global(n), update(n)
-
.SH KEYWORDS
event, variable, wait