Cherrypick some trivial doc changes from tip-700 branch
This commit is contained in:
+1
-1
@@ -70,7 +70,7 @@ was created. Typically, \fIclientData\fR points to a data
|
||||
structure containing application-specific information about
|
||||
what to do in \fIproc\fR.
|
||||
.PP
|
||||
Both functions return a \fBtolken\fR.
|
||||
Both functions return a \fBtoken\fR.
|
||||
In case of \fBTcl_CreateTimerHandlerMicroSeconds\fR, the return value is \fBNULL\fR,
|
||||
if the given time interval is to much in the future and may not be
|
||||
represented. This is a theoretical case, as it is in around 26 thousand years.
|
||||
|
||||
+3
-3
@@ -12,7 +12,7 @@
|
||||
.SH NAME
|
||||
global \- Access global variables
|
||||
.SH SYNOPSIS
|
||||
\fBglobal \fR?\fIvarname ...\fR?
|
||||
\fBglobal \fR?\fIvarName ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
@@ -22,11 +22,11 @@ creates local variables linked to the corresponding global variables (though
|
||||
these linked variables, like those created by \fBupvar\fR, are not included
|
||||
in the list returned by \fBinfo locals\fR).
|
||||
.PP
|
||||
If \fIvarname\fR contains namespace qualifiers, the local variable's name is
|
||||
If \fIvarName\fR contains namespace qualifiers, the local variable's name is
|
||||
the unqualified name of the global variable, as determined by the
|
||||
\fBnamespace tail\fR command.
|
||||
.PP
|
||||
\fIvarname\fR is always treated as the name of a variable, not an
|
||||
\fIvarName\fR is always treated as the name of a variable, not an
|
||||
array element. An error is returned if the name looks like an array element,
|
||||
such as \fBa(b)\fR.
|
||||
.SH EXAMPLES
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
.SH NAME
|
||||
history \- Manipulate the history list
|
||||
.SH SYNOPSIS
|
||||
\fBhistory \fR?\fIoption\fR? ?\fIarg arg ...\fR?
|
||||
\fBhistory \fR?\fIoption\fR? ?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+9
-9
@@ -15,7 +15,7 @@
|
||||
.SH NAME
|
||||
info \- Information about the state of the Tcl interpreter
|
||||
.SH SYNOPSIS
|
||||
\fBinfo \fIoption \fR?\fIarg arg ...\fR?
|
||||
\fBinfo \fIoption \fR?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
@@ -32,7 +32,7 @@ Returns the names of the parameters to the procedure named \fIprocname\fR.
|
||||
Returns the body of the procedure named \fIprocname\fR.
|
||||
.\" METHOD: class
|
||||
.TP
|
||||
\fBinfo class\fI subcommand class\fR ?\fIarg ...\fR
|
||||
\fBinfo class\fI subcommand class\fR ?\fIarg ...\fR?
|
||||
.
|
||||
Returns information about the class named \fIclass\fR.
|
||||
See \fBCLASS INTROSPECTION\fR below.
|
||||
@@ -83,7 +83,7 @@ Returns the names of all commands visible in the current namespace. If
|
||||
\fIpattern\fR is given, returns only those names that match according to
|
||||
\fBstring match\fR. Only the last component of \fIpattern\fR is a pattern.
|
||||
Other components identify a namespace. See \fBNAMESPACE RESOLUTION\fR in the
|
||||
\fBnamespace\fR(n) documentation.
|
||||
manual page for the \fBnamespace\fR command.
|
||||
.\" METHOD: complete
|
||||
.TP
|
||||
\fBinfo complete \fIcommand\fR
|
||||
@@ -161,7 +161,7 @@ defined, and \fB0\fR otherwise.
|
||||
Returns the depth of the call to \fBinfo frame\fR itself. Otherwise, returns a
|
||||
dictionary describing the active command at the \fIdepth\fR, which counts all
|
||||
commands visible to \fBinfo level\fR, plus commands that don't create a new
|
||||
level, such as \fBeval\fR, \fBsource\fR, or \fIuplevel\fR. The frame depth is
|
||||
level, such as \fBeval\fR, \fBsource\fR, or \fBuplevel\fR. The frame depth is
|
||||
always greater than the current level.
|
||||
.RS
|
||||
.PP
|
||||
@@ -305,7 +305,7 @@ Returns the absolute pathname of the program for the current interpreter. If
|
||||
such a file can not be identified an empty string is returned.
|
||||
.\" METHOD: object
|
||||
.TP
|
||||
\fBinfo object\fI subcommand object\fR ?\fIarg ...\fR
|
||||
\fBinfo object\fI subcommand object\fR ?\fIarg ...\fR?
|
||||
.
|
||||
Returns information about the object named \fIobject\fR. \fIsubcommand\fR is
|
||||
described \fBOBJECT INTROSPECTION\fR below.
|
||||
@@ -323,7 +323,7 @@ Returns the names of all visible procedures. If \fIpattern\fR is given, returns
|
||||
only those names that match according to \fBstring match\fR. Only the final
|
||||
component in \fIpattern\fR is actually considered a pattern. Any qualifying
|
||||
components simply select a namespace. See \fBNAMESPACE RESOLUTION\fR in the
|
||||
\fBnamespace\fR(n) documentation.
|
||||
manual page of the \fBnamespace\fR command.
|
||||
.\" METHOD: script
|
||||
.TP
|
||||
\fBinfo script\fR ?\fIfilename\fR?
|
||||
@@ -354,7 +354,7 @@ If \fIpattern\fR is not given, returns the names of all visible variables. If
|
||||
\fIpattern\fR is given, returns only those names that match according to
|
||||
\fBstring match\fR. Only the last component of \fIpattern\fR is a pattern.
|
||||
Other components identify a namespace. See \fBNAMESPACE RESOLUTION\fR in the
|
||||
\fBnamespace\fR(n) documentation. When \fIpattern\fR is a qualified name,
|
||||
manual page for the \fBnamespace\fR command. When \fIpattern\fR is a qualified name,
|
||||
results are fully qualified.
|
||||
.RS
|
||||
.PP
|
||||
@@ -528,7 +528,7 @@ This subcommand returns a list of all classes that have been mixed into the
|
||||
class named \fIclass\fR.
|
||||
.\" METHOD: properties
|
||||
.TP
|
||||
\fBinfo class properties\fI class\fR ?\fIoptions...\fR
|
||||
\fBinfo class properties\fI class\fR ?\fIoptions ...\fR?
|
||||
.VS TIP558
|
||||
This subcommand returns a sorted list of properties defined on the class named
|
||||
\fIclass\fR. The \fIoptions\fR define exactly which properties are returned:
|
||||
@@ -761,7 +761,7 @@ This subcommand returns the name of the internal namespace of the object named
|
||||
\fIobject\fR.
|
||||
.\" METHOD: properties
|
||||
.TP
|
||||
\fBinfo object properties\fI object\fR ?\fIoptions...\fR
|
||||
\fBinfo object properties\fI object\fR ?\fIoptions...\fR?
|
||||
.VS TIP558
|
||||
This subcommand returns a sorted list of properties defined on the object
|
||||
named \fIobject\fR. The \fIoptions\fR define exactly which properties are
|
||||
|
||||
+12
-10
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
interp \- Create and manipulate Tcl interpreters
|
||||
.SH SYNOPSIS
|
||||
\fBinterp \fIsubcommand \fR?\fIarg arg ...\fR?
|
||||
\fBinterp \fIsubcommand \fR?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
@@ -105,7 +105,7 @@ Deletes the alias for \fIsrcToken\fR in the child interpreter identified by
|
||||
was created; if the source command has been renamed, the renamed
|
||||
command will be deleted.
|
||||
.TP
|
||||
\fBinterp alias\fI srcPath srcCmd targetPath targetCmd \fR?\fIarg arg ...\fR?
|
||||
\fBinterp alias\fI srcPath srcCmd targetPath targetCmd \fR?\fIarg ...\fR?
|
||||
.
|
||||
This command creates an alias between one child and another (see the
|
||||
\fBalias\fR child command below for creating aliases between a child
|
||||
@@ -206,13 +206,15 @@ The initial recursion limit of the child interpreter is set to the
|
||||
current recursion limit of its parent interpreter.
|
||||
.\" METHOD: debug
|
||||
.TP
|
||||
\fBinterp debug \fIpath\fR ?\fB\-frame\fR ?\fIbool\fR??
|
||||
\fBinterp debug \fIpath\fR ?\fB\-frame\fR?
|
||||
.TP
|
||||
\fBinterp debug \fIpath\fR ?\fB\-frame\fR \fIboolean\fR?
|
||||
.
|
||||
Controls whether frame-level stack information is captured in the
|
||||
child interpreter identified by \fIpath\fR. If no arguments are
|
||||
given, option and current setting are returned. If \fB\-frame\fR
|
||||
is given, the debug setting is set to the given boolean if provided
|
||||
and the current setting is returned.
|
||||
specified, the option and its current setting are returned. If \fB\-frame\fR
|
||||
is specified, the current setting is returned. If \fIboolean\fR if provided as well,
|
||||
the debug setting is set to the specified value.
|
||||
This only affects the output of \fBinfo frame\fR, in that exact
|
||||
frame-level information for command invocation at the bytecode level
|
||||
is only captured with this setting on.
|
||||
@@ -470,7 +472,7 @@ Deletes the alias for \fIsrcToken\fR in the child interpreter.
|
||||
was created; if the source command has been renamed, the renamed
|
||||
command will be deleted.
|
||||
.TP
|
||||
\fIchild \fBalias \fIsrcCmd targetCmd \fR?\fIarg ..\fR?
|
||||
\fIchild \fBalias \fIsrcCmd targetCmd \fR?\fIarg ...\fR?
|
||||
.
|
||||
Creates an alias such that whenever \fIsrcCmd\fR is invoked
|
||||
in \fIchild\fR, \fItargetCmd\fR is invoked in the parent.
|
||||
@@ -493,7 +495,7 @@ what to set the interpreter's background exception handler to. See the
|
||||
\fBBACKGROUND EXCEPTION HANDLING\fR section for more details.
|
||||
.\" METHOD: eval
|
||||
.TP
|
||||
\fIchild \fBeval \fIarg \fR?\fIarg ..\fR?
|
||||
\fIchild \fBeval \fIarg \fR?\fIarg ...\fR?
|
||||
.
|
||||
This command concatenates all of the \fIarg\fR arguments in
|
||||
the same fashion as the \fBconcat\fR command, then evaluates
|
||||
@@ -543,7 +545,7 @@ For more details on hidden commands, see \fBHIDDEN COMMANDS\fR, below.
|
||||
Returns a list of the names of all hidden commands in \fIchild\fR.
|
||||
.\" METHOD: invokehidden
|
||||
.TP
|
||||
\fIchild \fBinvokehidden\fR ?\fI\-option ...\fR? \fIhiddenName \fR?\fIarg ..\fR?
|
||||
\fIchild \fBinvokehidden\fR ?\fI\-option ...\fR? \fIhiddenName \fR?\fIarg ...\fR?
|
||||
.
|
||||
This command invokes the hidden command \fIhiddenName\fR with the
|
||||
supplied arguments, in \fIchild\fR. No substitutions or evaluations are
|
||||
@@ -597,7 +599,7 @@ is already trusted.
|
||||
.
|
||||
Returns the maximum allowable nesting depth for the \fIchild\fR interpreter.
|
||||
If \fInewlimit\fR is specified, the recursion limit in \fIchild\fR will be
|
||||
set so that nesting of more than \fInewlimit\fR calls to \fBTcl_Eval()\fR
|
||||
set so that nesting of more than \fInewlimit\fR calls to \fBTcl_Eval\fR
|
||||
and related procedures in \fIchild\fR will return an error.
|
||||
The \fInewlimit\fR value is also returned.
|
||||
The \fInewlimit\fR value must be a positive integer between 1 and the
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
lappend \- Append list elements onto a variable
|
||||
.SH SYNOPSIS
|
||||
\fBlappend \fIvarName \fR?\fIvalue value value ...\fR?
|
||||
\fBlappend \fIvarName \fR?\fIvalue ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@
|
||||
.SH NAME
|
||||
ledit \- Replace elements of a list stored in variable
|
||||
.SH SYNOPSIS
|
||||
\fBledit \fIlistVar first last \fR?\fIvalue value ...\fR?
|
||||
\fBledit \fIlistVar first last \fR?\fIvalue ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+8
-8
@@ -15,7 +15,7 @@ auto_execok, auto_import, auto_load, auto_mkindex, auto_qualify, auto_reset, for
|
||||
\fBauto_execok \fIcmd\fR
|
||||
\fBauto_import \fIpattern\fR
|
||||
\fBauto_load \fIcmd\fR
|
||||
\fBauto_mkindex \fIdir pattern pattern ...\fR
|
||||
\fBauto_mkindex\fR \fIdir\fR ?\fIpattern ...\fR?
|
||||
\fBauto_qualify \fIcommand namespace\fR
|
||||
\fBauto_reset\fR
|
||||
\fBtcl_findLibrary \fIbasename version patch initScript enVarName varName\fR
|
||||
@@ -148,7 +148,7 @@ set mayFrob [expr {[llength [\fBauto_execok\fR frobnicate]] > 0}]
|
||||
.TP
|
||||
\fBauto_import \fIpattern\fR
|
||||
.
|
||||
\fBAuto_import\fR is invoked during \fBnamespace import\fR to see if
|
||||
\fBauto_import\fR is invoked during \fBnamespace import\fR to see if
|
||||
the imported commands specified by \fIpattern\fR reside in an
|
||||
autoloaded library. If so, the commands are loaded so that they will
|
||||
be available to the interpreter for creating the import links. If the
|
||||
@@ -181,7 +181,7 @@ successfully created. The command returns 0 if there was no index
|
||||
entry for \fIcmd\fR or if the script did not actually define \fIcmd\fR
|
||||
(e.g. because index information is out of date). If an error occurs
|
||||
while processing the script, then that error is returned.
|
||||
\fBAuto_load\fR only reads the index information once and saves it in
|
||||
\fBauto_load\fR only reads the index information once and saves it in
|
||||
the array \fBauto_index\fR; future calls to \fBauto_load\fR check for
|
||||
\fIcmd\fR in the array rather than re-reading the index files. The
|
||||
cached index information may be deleted with the command
|
||||
@@ -194,7 +194,7 @@ default \fBunknown\fR handler will do so.
|
||||
.RE
|
||||
.\" COMMAND: auto_mkindex
|
||||
.TP
|
||||
\fBauto_mkindex \fIdir pattern pattern ...\fR
|
||||
\fBauto_mkindex \fIdir\fR ?\fIpattern ...\fR?
|
||||
.
|
||||
Generates an index suitable for use by \fBauto_load\fR. The command
|
||||
searches \fIdir\fR for all files whose names match any of the
|
||||
@@ -212,14 +212,14 @@ named \fBtclIndex\fR in \fIdir\fR. If no pattern is given a pattern of
|
||||
will read all the \fB.tcl\fR files in subdirectory \fBfoo\fR and
|
||||
generate a new index file \fBfoo/tclIndex\fR.
|
||||
.PP
|
||||
\fBAuto_mkindex\fR parses the Tcl scripts by sourcing them into a
|
||||
\fBauto_mkindex\fR parses the Tcl scripts by sourcing them into a
|
||||
child interpreter and monitoring the proc and namespace commands that
|
||||
are executed. Extensions can use the (undocumented)
|
||||
auto_mkindex_parser package to register other commands that can
|
||||
contribute to the auto_load index. You will have to read through
|
||||
auto.tcl to see how this works.
|
||||
.PP
|
||||
\fBAuto_mkindex_old\fR
|
||||
\fBauto_mkindex_old\fR
|
||||
(which has the same syntax as \fBauto_mkindex\fR)
|
||||
parses the Tcl scripts in a relatively
|
||||
unsophisticated way: if any line contains the word
|
||||
@@ -241,7 +241,7 @@ code or procedure names with special characters like \fB$\fR,
|
||||
.
|
||||
Destroys all the information cached by \fBauto_execok\fR and
|
||||
\fBauto_load\fR. This information will be re-read from disk the next
|
||||
time it is needed. \fBAuto_reset\fR also deletes any procedures
|
||||
time it is needed. \fBauto_reset\fR also deletes any procedures
|
||||
listed in the auto-load index, so that fresh copies of them will be
|
||||
loaded the next time that they are used.
|
||||
.\" COMMAND: auto_qualify
|
||||
@@ -261,7 +261,7 @@ were a command in the global namespace. Otherwise, if either
|
||||
if it were a command in the global namespace.
|
||||
.RS
|
||||
.PP
|
||||
\fBAuto_qualify\fR is used by the auto-loading facilities in Tcl, both
|
||||
\fBauto_qualify\fR is used by the auto-loading facilities in Tcl, both
|
||||
for producing auto-loading indexes such as \fIpkgIndex.tcl\fR, and for
|
||||
performing the actual auto-loading of functions at runtime.
|
||||
.RE
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
linsert \- Insert elements into a list
|
||||
.SH SYNOPSIS
|
||||
\fBlinsert \fIlist index \fR?\fIelement element ...\fR?
|
||||
\fBlinsert \fIlist index \fR?\fIelement ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
list \- Create a list
|
||||
.SH SYNOPSIS
|
||||
\fBlist \fR?\fIarg arg ...\fR?
|
||||
\fBlist \fR?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@
|
||||
.SH NAME
|
||||
lpop \- Get and remove an element in a list
|
||||
.SH SYNOPSIS
|
||||
\fBlpop \fIvarName ?index ...\fR?
|
||||
\fBlpop \fIvarName\fR ?\fIindex ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
lreplace \- Replace elements in a list with new elements
|
||||
.SH SYNOPSIS
|
||||
\fBlreplace \fIlist first last \fR?\fIelement element ...\fR?
|
||||
\fBlreplace \fIlist first last \fR?\fIelement ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+3
-3
@@ -35,19 +35,19 @@ last matching style given takes precedence.
|
||||
.TP
|
||||
\fB\-exact\fR
|
||||
.
|
||||
\fIPattern\fR is a literal string that is compared for exact equality
|
||||
\fIpattern\fR is a literal string that is compared for exact equality
|
||||
against each list element.
|
||||
.\" OPTION: -glob
|
||||
.TP
|
||||
\fB\-glob\fR
|
||||
.
|
||||
\fIPattern\fR is a glob-style pattern which is matched against each list
|
||||
\fIpattern\fR is a glob-style pattern which is matched against each list
|
||||
element using the same rules as the \fBstring match\fR command.
|
||||
.\" OPTION: -regexp
|
||||
.TP
|
||||
\fB\-regexp\fR
|
||||
.
|
||||
\fIPattern\fR is treated as a regular expression and matched against
|
||||
\fIpattern\fR is treated as a regular expression and matched against
|
||||
each list element using the rules described in the \fBre_syntax\fR
|
||||
reference page.
|
||||
.\" OPTION: -sorted
|
||||
|
||||
+4
-4
@@ -9,7 +9,7 @@
|
||||
.SH NAME
|
||||
memory \- Control Tcl memory debugging capabilities
|
||||
.SH SYNOPSIS
|
||||
\fBmemory \fIoption \fR?\fIarg arg ...\fR?
|
||||
\fBmemory \fIoption \fR?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
@@ -43,7 +43,7 @@ to \fBTcl_Free\fR), the current bytes allocated, and the maximum number
|
||||
of packets and bytes allocated.
|
||||
.\" METHOD: init
|
||||
.TP
|
||||
\fBmemory init \fR[\fBon\fR|\fBoff\fR]
|
||||
\fBmemory init on\fR|\fBoff\fR
|
||||
.
|
||||
Turn on or off the preinitialization of all allocated memory
|
||||
with bogus bytes. Useful for detecting the use of uninitialized
|
||||
@@ -74,7 +74,7 @@ is printed along with other information about the packet. The
|
||||
to \fBTcl_Alloc\fR to be \fIstring\fR.
|
||||
.\" METHOD: trace
|
||||
.TP
|
||||
\fBmemory trace \fR[\fBon\fR|\fBoff\fR]
|
||||
\fBmemory trace on\fR|\fBoff\fR
|
||||
.
|
||||
Turns memory tracing on or off. When memory tracing is on, every call
|
||||
to \fBTcl_Alloc\fR causes a line of trace information to be written to
|
||||
@@ -104,7 +104,7 @@ the problem sets in. The current number of memory allocations that have
|
||||
occurred since Tcl started is printed on a guard zone failure.
|
||||
.\" METHOD: validate
|
||||
.TP
|
||||
\fBmemory validate \fR[\fBon\fR|\fBoff\fR]
|
||||
\fBmemory validate on\fR|\fBoff\fR
|
||||
.
|
||||
Turns memory validation on or off. When memory validation is enabled,
|
||||
on every call to \fBTcl_Alloc\fR or \fBTcl_Free\fR, the guard zones are
|
||||
|
||||
+4
-2
@@ -15,7 +15,7 @@ registry \- Manipulate the Windows registry
|
||||
.nf
|
||||
\fBtcl::registry \fR?\fI\-mode\fR? \fIoption keyName\fR ?\fIarg arg ...\fR?
|
||||
\fBpackage require registry 1.4\fR
|
||||
\fBregistry \fR?\fI\-mode\fR? \fIoption keyName\fR ?\fIarg arg ...\fR?
|
||||
\fBregistry \fR?\fI\-mode\fR? \fIoption keyName\fR ?\fIarg ...\fR?
|
||||
.fi
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
@@ -113,7 +113,9 @@ using the same rules as for \fBstring match\fR. If the
|
||||
specified \fIkeyName\fR does not exist, then an error is generated.
|
||||
.\" METHOD: set
|
||||
.TP
|
||||
\fBregistry set \fIkeyName\fR ?\fIvalueName data \fR?\fItype\fR??
|
||||
\fBregistry set \fIkeyName\fR ?\fIvalueName data\fR?
|
||||
.TP
|
||||
\fBregistry set \fIkeyName\fR ?\fIvalueName data type\fR?
|
||||
.
|
||||
If \fIvalueName\fR is not specified, creates the key \fIkeyName\fR if
|
||||
it does not already exist. If \fIvalueName\fR is specified, creates
|
||||
|
||||
+6
-2
@@ -48,9 +48,11 @@ to cancel the delayed command using \fBtimer cancel\fR or \fBafter cancel\fR.
|
||||
A \fIdelay\fR value of 0 (or negative) queues the event immediately with
|
||||
priority over other event types (if not installed with an event proc,
|
||||
which will wait for next round of events).
|
||||
.TP
|
||||
.RS
|
||||
.PP
|
||||
The command \fBafter ms script\fR may also be used to register monotonic clock timer events.
|
||||
They are handled by the same queue as this form of the \fBtimer\fR command.
|
||||
.RE
|
||||
.\" METHOD: at
|
||||
.TP
|
||||
\fBtimer at \fItimepoint\fR \fIunit\fR \fIscript\fR
|
||||
@@ -58,9 +60,11 @@ They are handled by the same queue as this form of the \fBtimer\fR command.
|
||||
Same as \fBtimer in\fR, but specifying a wall clock time point (epoc).
|
||||
A typical use-case is to pass result of a \fBclock scan\fR as time point.
|
||||
See example below.
|
||||
.TP
|
||||
.RS
|
||||
.PP
|
||||
Wall clock events have second priority after monotonic clock events.
|
||||
If both fire the same instant, the monotonic clock command is always handled first.
|
||||
.RE
|
||||
.\" METHOD: idle
|
||||
.TP
|
||||
\fBtimer idle \fIscript\fR
|
||||
|
||||
@@ -95,7 +95,7 @@ an actual limitation, as some may believe.
|
||||
Ever since 8.4 the Tcl \fBsource\fR command reads only until the first
|
||||
^Z character. This allows us to combine an arbitrary Tcl script with
|
||||
arbitrary binary data into one file, where the script processes the
|
||||
attached data in any it chooses to fully import and activate the
|
||||
attached data in any way it chooses to fully import and activate the
|
||||
package.
|
||||
.PP
|
||||
The name of a module file has to match the regular expression:
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
trace \- Monitor variable accesses, command usages and command executions
|
||||
.SH SYNOPSIS
|
||||
\fBtrace \fIoption\fR ?\fIarg arg ...\fR?
|
||||
\fBtrace \fIoption\fR ?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
.SH NAME
|
||||
unknown \- Handle attempts to use non-existent commands
|
||||
.SH SYNOPSIS
|
||||
\fBunknown \fIcmdName \fR?\fIarg arg ...\fR?
|
||||
\fBunknown \fIcmdName \fR?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@
|
||||
.SH NAME
|
||||
unset \- Delete variables
|
||||
.SH SYNOPSIS
|
||||
\fBunset \fR?\fB\-nocomplain\fR? ?\fB\-\-\fR? ?\fIname name name ...\fR?
|
||||
\fBunset \fR?\fB\-nocomplain\fR? ?\fB\-\-\fR? ?\fIname ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
|
||||
+2
-2
@@ -12,13 +12,13 @@
|
||||
.SH NAME
|
||||
uplevel \- Execute a script in a different stack frame
|
||||
.SH SYNOPSIS
|
||||
\fBuplevel \fR?\fIlevel\fR?\fI arg \fR?\fIarg ...\fR?
|
||||
\fBuplevel\fR ?\fIlevel\fR? \fIarg\fR ?\fIarg ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
All of the \fIarg\fR arguments are concatenated as if they had
|
||||
been passed to \fBconcat\fR; the result is then evaluated in the
|
||||
variable context indicated by \fIlevel\fR. \fBUplevel\fR returns
|
||||
variable context indicated by \fIlevel\fR. \fBuplevel\fR returns
|
||||
the result of that evaluation.
|
||||
.PP
|
||||
If \fIlevel\fR is an integer then
|
||||
|
||||
+2
-2
@@ -14,7 +14,7 @@ variable \- Create and initialize a namespace variable
|
||||
.SH SYNOPSIS
|
||||
\fBvariable \fR\fIname\fR
|
||||
.sp
|
||||
\fBvariable \fR?\fIname value...\fR?
|
||||
\fBvariable \fR?\fIname value ...\fR?
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
@@ -42,7 +42,7 @@ command, but not to the \fBinfo exists\fR command.
|
||||
If the \fBvariable\fR command is executed inside a Tcl procedure,
|
||||
it creates local variables
|
||||
linked to the corresponding namespace variables (and therefore these
|
||||
variables are listed by \fBinfo vars\fR.)
|
||||
variables are listed by \fBinfo vars\fR).
|
||||
In this way the \fBvariable\fR command resembles the \fBglobal\fR command,
|
||||
although the \fBglobal\fR command
|
||||
resolves variable names with respect to the global namespace instead
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@ value; if it is a true value
|
||||
then \fIbody\fR is executed by passing it to the Tcl interpreter.
|
||||
Once \fIbody\fR has been executed then \fItest\fR is evaluated
|
||||
again, and the process repeats until eventually \fItest\fR
|
||||
evaluates to a false boolean value. \fBContinue\fR
|
||||
evaluates to a false boolean value. \fBcontinue\fR
|
||||
commands may be executed inside \fIbody\fR to terminate the current
|
||||
iteration of the loop, and \fBbreak\fR
|
||||
commands may be executed inside \fIbody\fR to cause immediate
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@
|
||||
zlib \- Compression and decompression operations
|
||||
.SH SYNOPSIS
|
||||
.nf
|
||||
\fBzlib \fIsubcommand arg ...\fR
|
||||
\fBzlib \fIsubcommand arg\fR ?\fIarg ...\fR?
|
||||
.fi
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
|
||||
Reference in New Issue
Block a user