2 '\" Copyright (c
) 1990-1992 The Regents of the University of California
.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of
this file
, and for a DISCLAIMER OF ALL WARRANTIES
.
8 '\" RCS
: @
(#) $Id: update.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
10 '\" The definitions below are
for supplemental macros used
in Tcl
/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure
.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or
"in/out" to describe whether procedure reads or modifies arg
,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments
for setting tab stops
. Type
and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to
.AP later
. If args are omitted
, default tab stops are used
.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed
in one large box
.
30 '\" End of box enclosure.
33 '\" Begin code excerpt
.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar
, for use
in marking newly
-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version
when the
.VS was added
, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present
, then a line break is forced before starting the sidebar
.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display
.
52 '\" End of indented unfilled display.
55 '\" Start of
list of standard options
for a Tk widget
. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option
. cmdName gives the
64 '\" option's name
as specified
in the
class command
, dbName gives
65 '\" the option's name
in the option database
, and dbClass gives
66 '\" the option's
class in the option database
.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: update.n,v 1.1 2003/12/20 03:31:54 bbbush Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2
"" .TP
\\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1
'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2
'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l
'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\
(ul
'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box
if the box started on an earlier page
.
131 \h
'-1.5n'\L
'|\\n(^yu-1v'\l
'\\n(^lu+3n\(ul'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
134 \h
'-1.5n'\L
'|\\n(^yu-1v'\h
'\\n(^lu+3n'\L
'\\n(^tu+1v-\\n(^yu'\l
'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter
)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS
"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH update n 7.5 Tcl "Tcl Built
-In Commands
"
248 '\" Note: do not modify the .SH NAME line immediately below!
250 update \- Process pending events and idle callbacks
252 \fBupdate\fR ?\fBidletasks\fR?
257 This command is used to bring the application ``up to date''
258 by entering the event loop repeatedly until all pending events
259 (including idle callbacks) have been processed.
261 If the \fBidletasks\fR keyword is specified as an argument to the
262 command, then no new events or errors are processed; only idle
263 callbacks are invoked.
264 This causes operations that are normally deferred, such as display
265 updates and window layout calculations, to be performed immediately.
267 The \fBupdate idletasks\fR command is useful in scripts where
268 changes have been made to the application's state and you want those
269 changes to appear on the display immediately, rather than waiting
270 for the script to complete. Most display updates are performed as
271 idle callbacks, so \fBupdate idletasks\fR will cause them to run.
272 However, there are some kinds of updates that only happen in
273 response to events, such as those triggered by window size changes;
274 these updates will not occur in \fBupdate idletasks\fR.
276 The \fBupdate\fR command with no options is useful in scripts where
277 you are performing a long-running computation but you still want
278 the application to respond to events such as user interactions; if
279 you occasionally call \fBupdate\fR then user input will be processed
280 during the next call to \fBupdate\fR.
286 event, flush, handler, idle, update