diff options
| author | hobbs <hobbs@noemail.net> | 2001-04-03 22:06:43 (GMT) |
|---|---|---|
| committer | hobbs <hobbs@noemail.net> | 2001-04-03 22:06:43 (GMT) |
| commit | 29e8b2041a07e697465dc46779bd6220cb8f6c43 (patch) | |
| tree | e5c977635727978bac72395ee1d94de792d4bc7a | |
| parent | acf1c7e56c7cfe6354252c6300fa306644c0e8d7 (diff) | |
| download | tcl-29e8b2041a07e697465dc46779bd6220cb8f6c43.zip tcl-29e8b2041a07e697465dc46779bd6220cb8f6c43.tar.gz tcl-29e8b2041a07e697465dc46779bd6220cb8f6c43.tar.bz2 | |
doc clarifications and cleanup
FossilOrigin-Name: e18374f0688b3e7f87dedd55ac70dc41e9eaf264
| -rw-r--r-- | doc/CrtChannel.3 | 28 | ||||
| -rw-r--r-- | doc/CrtSlave.3 | 5 | ||||
| -rw-r--r-- | doc/DetachPids.3 | 21 | ||||
| -rw-r--r-- | doc/Eval.3 | 21 | ||||
| -rw-r--r-- | doc/ObjectType.3 | 4 | ||||
| -rw-r--r-- | doc/StrMatch.3 | 9 | ||||
| -rw-r--r-- | doc/after.n | 4 | ||||
| -rw-r--r-- | doc/append.n | 5 | ||||
| -rw-r--r-- | doc/bgerror.n | 67 | ||||
| -rw-r--r-- | doc/binary.n | 14 | ||||
| -rw-r--r-- | doc/break.n | 5 | ||||
| -rw-r--r-- | doc/case.n | 5 | ||||
| -rw-r--r-- | doc/cd.n | 5 | ||||
| -rw-r--r-- | doc/close.n | 5 | ||||
| -rw-r--r-- | doc/concat.n | 5 | ||||
| -rw-r--r-- | doc/continue.n | 5 | ||||
| -rw-r--r-- | doc/dde.n | 6 | ||||
| -rw-r--r-- | doc/encoding.n | 4 | ||||
| -rw-r--r-- | doc/eof.n | 5 | ||||
| -rw-r--r-- | doc/error.n | 5 | ||||
| -rw-r--r-- | doc/eval.n | 5 | ||||
| -rw-r--r-- | doc/exec.n | 6 | ||||
| -rw-r--r-- | doc/exit.n | 5 | ||||
| -rw-r--r-- | doc/fblocked.n | 5 | ||||
| -rw-r--r-- | doc/fileevent.n | 4 | ||||
| -rw-r--r-- | doc/filename.n | 5 | ||||
| -rw-r--r-- | doc/flush.n | 4 | ||||
| -rw-r--r-- | doc/for.n | 5 | ||||
| -rw-r--r-- | doc/foreach.n | 6 | ||||
| -rw-r--r-- | doc/format.n | 5 | ||||
| -rw-r--r-- | doc/gets.n | 4 | ||||
| -rw-r--r-- | doc/glob.n | 4 | ||||
| -rw-r--r-- | doc/global.n | 8 | ||||
| -rw-r--r-- | doc/http.n | 7 | ||||
| -rw-r--r-- | doc/if.n | 5 | ||||
| -rw-r--r-- | doc/incr.n | 5 | ||||
| -rw-r--r-- | doc/join.n | 5 | ||||
| -rw-r--r-- | doc/lappend.n | 5 | ||||
| -rw-r--r-- | doc/library.n | 4 | ||||
| -rw-r--r-- | doc/lindex.n | 5 | ||||
| -rw-r--r-- | doc/linsert.n | 5 | ||||
| -rw-r--r-- | doc/list.n | 6 | ||||
| -rw-r--r-- | doc/llength.n | 5 | ||||
| -rw-r--r-- | doc/load.n | 4 | ||||
| -rw-r--r-- | doc/lrange.n | 5 | ||||
| -rw-r--r-- | doc/lreplace.n | 6 | ||||
| -rw-r--r-- | doc/lsort.n | 90 | ||||
| -rw-r--r-- | doc/man.macros | 4 | ||||
| -rw-r--r-- | doc/memory.n | 4 | ||||
| -rw-r--r-- | doc/open.n | 20 | ||||
| -rw-r--r-- | doc/package.n | 5 | ||||
| -rw-r--r-- | doc/packagens.n | 5 | ||||
| -rw-r--r-- | doc/pid.n | 5 | ||||
| -rw-r--r-- | doc/pkgMkIndex.n | 5 | ||||
| -rw-r--r-- | doc/proc.n | 5 | ||||
| -rw-r--r-- | doc/puts.n | 4 | ||||
| -rw-r--r-- | doc/pwd.n | 5 | ||||
| -rw-r--r-- | doc/read.n | 4 | ||||
| -rw-r--r-- | doc/regexp.n | 4 | ||||
| -rw-r--r-- | doc/regsub.n | 5 | ||||
| -rw-r--r-- | doc/rename.n | 5 | ||||
| -rw-r--r-- | doc/resource.n | 4 | ||||
| -rw-r--r-- | doc/return.n | 5 | ||||
| -rw-r--r-- | doc/scan.n | 29 | ||||
| -rw-r--r-- | doc/seek.n | 5 | ||||
| -rw-r--r-- | doc/set.n | 5 | ||||
| -rw-r--r-- | doc/split.n | 5 | ||||
| -rw-r--r-- | doc/string.n | 5 | ||||
| -rw-r--r-- | doc/subst.n | 5 | ||||
| -rw-r--r-- | doc/switch.n | 5 | ||||
| -rw-r--r-- | doc/tclvars.n | 5 | ||||
| -rw-r--r-- | doc/tell.n | 5 | ||||
| -rw-r--r-- | doc/time.n | 5 | ||||
| -rw-r--r-- | doc/unknown.n | 5 | ||||
| -rw-r--r-- | doc/update.n | 5 | ||||
| -rw-r--r-- | doc/uplevel.n | 4 | ||||
| -rw-r--r-- | doc/upvar.n | 4 | ||||
| -rw-r--r-- | doc/variable.n | 7 | ||||
| -rw-r--r-- | doc/vwait.n | 5 | ||||
| -rw-r--r-- | doc/while.n | 5 |
80 files changed, 462 insertions, 187 deletions
diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 6feeac3..982f948 100644 --- a/doc/CrtChannel.3 +++ b/doc/CrtChannel.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: CrtChannel.3,v 1.5.2.1 2000/08/08 00:57:52 hobbs Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.5.2.2 2001/04/03 22:06:43 hobbs Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -283,7 +283,7 @@ identifies the type of the device implemented by this driver, e.g. \fBfile\fR or \fBsocket\fR. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelName\fR, which returns +This value can be retrieved with \fBTcl_ChannelName\fR, which returns a pointer to the string. .VE @@ -297,7 +297,7 @@ If it is not set to this value \fBTCL_CHANNEL_VERSION_2\fR, then this function with either structure, stacked channels must be of the newer style to function correctly. .PP -This value can be retried with \fBTcl_ChannelVersion\fR, which returns +This value can be retrieved with \fBTcl_ChannelVersion\fR, which returns either \fBTCL_CHANNEL_VERSION_2\fR or \fBTCL_CHANNEL_VERSION_1\fR. .VE @@ -328,7 +328,7 @@ implemented by the underlying operating system; for other device types, the behavior must be emulated in the channel driver. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelBlockModeProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelBlockModeProc\fR, which returns a pointer to the function. .VE @@ -383,7 +383,7 @@ return a nonzero POSIX error code. In addition, if an error occurs and in the interpreter's result. .PP .VS 8.3.2 -These value can be retried with \fBTcl_ChannelCloseProc\fR or +These value can be retrieved with \fBTcl_ChannelCloseProc\fR or \fBTcl_ChannelClose2Proc\fR, which returns a pointer to the respective function. .VE @@ -431,7 +431,7 @@ from the device; then, it should return as much data as it can read without blocking. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelInputProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelInputProc\fR, which returns a pointer to the function. .VE @@ -472,7 +472,7 @@ data whatsoever, the function should return -1 with an \fBEAGAIN\fR error without writing any data. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelOutputProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelOutputProc\fR, which returns a pointer to the function. .VE @@ -506,7 +506,7 @@ The return value is the new access point or -1 in case of error. If an error occurred, the function should not move the access point. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelSeekProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelSeekProc\fR, which returns a pointer to the function. .VE @@ -550,7 +550,7 @@ function should also call \fBTcl_SetErrno\fR to store an appropriate POSIX error code. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelSetOptionProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelSetOptionProc\fR, which returns a pointer to the function. .VE @@ -590,7 +590,7 @@ field can be NULL, which indicates that this channel type supports no type specific options. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelGetOptionProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelGetOptionProc\fR, which returns a pointer to the function. .VE @@ -625,7 +625,7 @@ with other events. See the description of \fBTcl_QueueEvent\fR for details on how to queue an event. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelWatchProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelWatchProc\fR, which returns a pointer to the function. .VE @@ -657,7 +657,7 @@ specified direction, or if the channel implementation does not use device handles, the function should return \fBTCL_ERROR\fR. .PP .VS 8.3.2 -This value can be retried with \fBTcl_ChannelGetHandleProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelGetHandleProc\fR, which returns a pointer to the function. .VE @@ -673,7 +673,7 @@ typedef int Tcl_DriverFlushProc( ClientData \fIinstanceData\fR); .CE .PP -This value can be retried with \fBTcl_ChannelFlushProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelFlushProc\fR, which returns a pointer to the function. .SH HANDLERPROC @@ -695,7 +695,7 @@ when this channel was created. The \fIinterestMask\fR is an OR-ed combination of \fBTCL_READABLE\fR or \fBTCL_WRITABLE\fR; it indicates what type of event occured on this channel. .PP -This value can be retried with \fBTcl_ChannelHandlerProc\fR, which returns +This value can be retrieved with \fBTcl_ChannelHandlerProc\fR, which returns a pointer to the function. .VE diff --git a/doc/CrtSlave.3 b/doc/CrtSlave.3 index bad9e81..3caecce 100644 --- a/doc/CrtSlave.3 +++ b/doc/CrtSlave.3 @@ -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: CrtSlave.3,v 1.3 1999/08/21 19:40:47 hobbs Exp $ +'\" RCS: @(#) $Id: CrtSlave.3,v 1.3.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH Tcl_CreateSlave 3 7.6 Tcl "Tcl Library Procedures" @@ -220,9 +220,10 @@ If the operation succeeds, it returns \fBTCL_OK\fR. After executing this command, attempts to use \fIcmdName\fR in a call to \fBTcl_Eval\fR or with the Tcl \fBeval\fR command will fail. .PP -.SH "SEE ALSO" For a description of the Tcl interface to multiple interpreters, see \fIinterp(n)\fR. +.SH "SEE ALSO" +interp .SH KEYWORDS alias, command, exposed commands, hidden commands, interpreter, invoke, diff --git a/doc/DetachPids.3 b/doc/DetachPids.3 index 23b16c5..9314f47 100644 --- a/doc/DetachPids.3 +++ b/doc/DetachPids.3 @@ -5,13 +5,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: DetachPids.3,v 1.2 1998/09/14 18:39:48 stanton Exp $ +'\" RCS: @(#) $Id: DetachPids.3,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH Tcl_DetachPids 3 "" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_DetachPids, Tcl_ReapDetachedProcs \- manage child processes in background +Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid \- manage child processes in background .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -19,14 +19,23 @@ Tcl_DetachPids, Tcl_ReapDetachedProcs \- manage child processes in background \fBTcl_DetachPids\fR(\fInumPids, pidPtr\fR) .sp \fBTcl_ReapDetachedProcs\fR() +.sp +Tcl_Pid +\fBTcl_WaitPid\fR(\fIpid, statPtr, options\fR) .SH ARGUMENTS .AS int *statusPtr .AP int numPids in Number of process ids contained in the array pointed to by \fIpidPtr\fR. .AP int *pidPtr in Address of array containing \fInumPids\fR process ids. +.AP Tcl_Pid pid in +The id of the process (pipe) to wait for. +.AP int* statPtr out +The result of waiting on a process (pipe). Either 0 or ECHILD. +.AP int options +The options controlling the wait. WNOHANG specifies not to wait when +checking the process. .BE - .SH DESCRIPTION .PP \fBTcl_DetachPids\fR and \fBTcl_ReapDetachedProcs\fR provide a @@ -57,6 +66,12 @@ However, if you call \fBTcl_DetachPids\fR in situations where the \fBexec\fR command may never get executed, you may wish to call \fBTcl_ReapDetachedProcs\fR from time to time so that background processes can be cleaned up. +.PP +\fBTcl_WaitPid\fR is a thin wrapper around the facilities provided by +the operating system to wait on the end of a spawned process and to +check a whether spawned process is still running. It is used by +\fBTcl_ReapDetachedProcs\fR and the channel system to portably access +the operating system. .SH KEYWORDS background, child, detach, process, wait @@ -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: Eval.3,v 1.6 2000/04/14 23:01:50 hobbs Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.6.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -66,9 +66,9 @@ The number of bytes in \fIscript\fR, not including any null terminating character. If \-1, then all characters up to the first null byte are used. .AP char *script in -Points to first byte of script to execute. This script must be in -writable memory: temporary modifications are made to it during -parsing. +Points to first byte of script to execute (NULL terminated and UTF-8). +This script must be in writable memory: temporary modifications are made +to it during parsing. .AP char *string in String forming part of a Tcl script. .AP va_list argList in @@ -110,11 +110,14 @@ a completion code and result just like \fBTcl_EvalObjEx\fR. .PP \fBTcl_Eval\fR is similar to \fBTcl_EvalObjEx\fR except that the script to be executed is supplied as a string instead of an object and no compilation -occurs. The string is parsed and executed directly (using -\fBTcl_EvalObjv\fR) instead of compiling it and executing the bytecodes. -In situations where it is known that the script will never be executed -again, \fBTcl_Eval\fR may be faster than \fBTcl_EvalObjEx\fR. -\fBTcl_Eval\fR returns a completion code and result just like +occurs. The string should be a proper UTF-8 string as converted by +\fBTcl_ExternalToUtfDString\fR or \fBTcl_ExternalToUtf\fR when it is known +to possibly contain upper ascii characters who's possible combinations +might be a UTF-8 special code. The string is parsed and executed directly +(using \fBTcl_EvalObjv\fR) instead of compiling it and executing the +bytecodes. In situations where it is known that the script will never be +executed again, \fBTcl_Eval\fR may be faster than \fBTcl_EvalObjEx\fR. +\fBTcl_Eval\fR returns a completion code and result just like \fBTcl_EvalObjEx\fR. Note: for backward compatibility with versions before Tcl 8.0, \fBTcl_Eval\fR copies the object result in \fIinterp\fR to \fIinterp->result\fR (use is deprecated) where it can be accessed directly. diff --git a/doc/ObjectType.3 b/doc/ObjectType.3 index df79219..ca0e1fd 100644 --- a/doc/ObjectType.3 +++ b/doc/ObjectType.3 @@ -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: ObjectType.3,v 1.2 1998/09/14 18:39:49 stanton Exp $ +'\" RCS: @(#) $Id: ObjectType.3,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH Tcl_ObjType 3 8.0 Tcl "Tcl Library Procedures" @@ -55,7 +55,7 @@ The argument \fItypePtr\fR points to a Tcl_ObjType structure that describes the new type by giving its name and by supplying pointers to four procedures that implement the type. -If the type table already containes a type +If the type table already contains a type with the same name as in \fItypePtr\fR, it is replaced with the new type. The Tcl_ObjType structure is described diff --git a/doc/StrMatch.3 b/doc/StrMatch.3 index 4d13379..a8bf5fc 100644 --- a/doc/StrMatch.3 +++ b/doc/StrMatch.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: StrMatch.3,v 1.3 1999/05/22 01:20:11 stanton Exp $ +'\" RCS: @(#) $Id: StrMatch.3,v 1.3.10.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH Tcl_StringMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -18,21 +18,18 @@ Tcl_StringMatch, Tcl_StringCaseMatch \- test whether a string matches a pattern .sp int \fBTcl_StringMatch\fR(\fIstring\fR, \fIpattern\fR) -.VS 8.1 .sp -\fBTcl_StringCaseMatch\fR(\fIstring, pattern, nocase\fR) -.VE 8.1 +int +\fBTcl_StringCaseMatch\fR(\fIstring\fR, \fIpattern\fR, \fInocase\fR) .SH ARGUMENTS .AP char *string in String to test. .AP char *pattern in Pattern to match against string. May contain special characters from the set *?\e[]. -.VS 8.1 .AP int nocase in Specifies whether the match should be done case-sensitive (0) or case-insensitive (1). -.VE 8.1 .BE .SH DESCRIPTION diff --git a/doc/after.n b/doc/after.n index 17fcf7f..b9d961e 100644 --- a/doc/after.n +++ b/doc/after.n @@ -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: after.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: after.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH after n 7.5 Tcl "Tcl Built-In Commands" @@ -103,7 +103,7 @@ In applications that are not normally event-driven, such as and \fBupdate\fR commands. .SH "SEE ALSO" -bgerror +bgerror(n), concat(n), update(n), vwait(n) .SH KEYWORDS cancel, delay, idle callback, sleep, time diff --git a/doc/append.n b/doc/append.n index 1a28065..d2385bc 100644 --- a/doc/append.n +++ b/doc/append.n @@ -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: append.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: append.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH append n "" Tcl "Tcl Built-In Commands" @@ -28,5 +28,8 @@ variables incrementally. For example, ``\fBappend a $b\fR'' is much more efficient than ``\fBset a $a$b\fR'' if \fB$a\fR is long. +.SH "SEE ALSO" +concat(n), lappend(n) + .SH KEYWORDS append, variable diff --git a/doc/bgerror.n b/doc/bgerror.n index 3f946c3..1dfb650 100644 --- a/doc/bgerror.n +++ b/doc/bgerror.n @@ -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: bgerror.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: bgerror.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH bgerror n 7.5 Tcl "Tcl Built-In Commands" @@ -31,38 +31,49 @@ with the \fBafter\fR command, then it is a background error. For a non-background error, the error can simply be returned up through nested Tcl command evaluations until it reaches the top-level code in the application; then the application can report the error -in whatever way it wishes. -When a background error occurs, the unwinding ends in -the Tcl library and there is no obvious way for Tcl to report -the error. +in whatever way it wishes. When a background error occurs, the +unwinding ends in the Tcl library and there is no obvious way for Tcl +to report the error. .PP When Tcl detects a background error, it saves information about the -error and invokes the \fBbgerror\fR command later as an idle event handler. -Before invoking \fBbgerror\fR, Tcl restores the \fBerrorInfo\fR -and \fBerrorCode\fR variables to their values at the time the -error occurred, then it invokes \fBbgerror\fR with -the error message as its only argument. -Tcl assumes that the application has implemented the \fBbgerror\fR -command, and that the command will report the error in a way that -makes sense for the application. Tcl will ignore any result returned -by the \fBbgerror\fR command as long as no error is generated. +error and invokes the \fBbgerror\fR command later as an idle event +handler. Before invoking \fBbgerror\fR, Tcl restores the +\fBerrorInfo\fR and \fBerrorCode\fR variables to their values at the +time the error occurred, then it invokes \fBbgerror\fR with the error +message as its only argument. Tcl assumes that the application has +implemented the \fBbgerror\fR command, and that the command will +report the error in a way that makes sense for the application. Tcl +will ignore any result returned by the \fBbgerror\fR command as long +as no error is generated. .PP -If another Tcl error occurs within the \fBbgerror\fR command -(for example, because no \fBbgerror\fR command has been defined) -then Tcl reports the error itself by writing a message to stderr. +If another Tcl error occurs within the \fBbgerror\fR command (for +example, because no \fBbgerror\fR command has been defined) then Tcl +reports the error itself by writing a message to stderr. .PP -If several background errors accumulate before \fBbgerror\fR -is invoked to process them, \fBbgerror\fR will be invoked once -for each error, in the order they occurred. -However, if \fBbgerror\fR returns with a break exception, then -any remaining errors are skipped without calling \fBbgerror\fR. +If several background errors accumulate before \fBbgerror\fR is +invoked to process them, \fBbgerror\fR will be invoked once for each +error, in the order they occurred. However, if \fBbgerror\fR returns +with a break exception, then any remaining errors are skipped without +calling \fBbgerror\fR. .PP -Tcl has no default implementation for \fBbgerror\fR. -However, in applications using Tk there is a default -\fBbgerror\fR procedure -which posts a dialog box containing -the error message and offers the user a chance to see a stack -trace showing where the error occurred. +Tcl has no default implementation for \fBbgerror\fR. However, in +applications using Tk there is a default \fBbgerror\fR procedure which +posts a dialog box containing the error message and offers the user a +chance to see a stack trace showing where the error occurred. In +addition to allowing the user to view the stack trace, the dialog +provides an additional application configurable button which may be +used, for example, to save the stack trace to a file. By default, +this is the behavior associated with that button. This behavior can +be redefined by setting the option database values +\fB*ErrorDialog.function.text\fR, to specify the caption for the +function button, and \fB*ErrorDialog.function.command\fR, to specify +the command to be run. The text of the stack trace is appended to the +command when it is evaluated. If either of these options is set to +the empty string, then the additional button will not be displayed in +the dialog. + +.SH "SEE ALSO" +after(n), tclvars(n) .SH KEYWORDS background error, reporting diff --git a/doc/binary.n b/doc/binary.n index 6609775..95ac090 100644 --- a/doc/binary.n +++ b/doc/binary.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: binary.n,v 1.4 2000/04/08 02:35:17 hobbs Exp $ +'\" RCS: @(#) $Id: binary.n,v 1.4.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH binary n 8.0 Tcl "Tcl Built-In Commands" @@ -22,11 +22,11 @@ binary \- Insert and extract fields from binary strings .PP This command provides facilities for manipulating binary data. The first form, \fBbinary format\fR, creates a binary string from normal -Tcl values. For example, given the values 16 and 22, it might produce -an 8-byte binary string consisting of two 4-byte integers, one for -each of the numbers. The second form of the command, -\fBbinary scan\fR, does the opposite: it extracts data from a binary -string and returns it as ordinary Tcl string values. +Tcl values. For example, given the values 16 and 22, on a 32 bit +architecture, it might produce an 8-byte binary string consisting of +two 4-byte integers, one for each of the numbers. The second form of +the command, \fBbinary scan\fR, does the opposite: it extracts data +from a binary string and returns it as ordinary Tcl string values. .SH "BINARY FORMAT" .PP @@ -542,7 +542,7 @@ element of the \fBtcl_platform\fR array to decide which type character to use when formatting or scanning integers. .SH "SEE ALSO" -format, scan, tclvars +format(n), scan(n), tclvars(n) .SH KEYWORDS binary, format, scan diff --git a/doc/break.n b/doc/break.n index 86d0d8b..65c7a68 100644 --- a/doc/break.n +++ b/doc/break.n @@ -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: break.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: break.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH break n "" Tcl "Tcl Built-In Commands" @@ -30,5 +30,8 @@ Break exceptions are also handled in a few other situations, such as the \fBcatch\fR command, Tk event bindings, and the outermost scripts of procedure bodies. +.SH "SEE ALSO" +catch(n), continue(n), for(n), foreach(n), while(n) + .SH KEYWORDS abort, break, loop @@ -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: case.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: case.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH case n 7.0 Tcl "Tcl Built-In Commands" @@ -55,5 +55,8 @@ no command or variable substitutions are performed on them; this makes the behavior of the second form different than the first form in some cases. +.SH "SEE ALSO" +switch(n) + .SH KEYWORDS case, match, regular expression @@ -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: cd.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: cd.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH cd n "" Tcl "Tcl Built-In Commands" @@ -24,5 +24,8 @@ home directory (as specified in the HOME environment variable) if \fIdirName\fR is not given. Returns an empty string. +.SH "SEE ALSO" +filename(n), glob(n), pwd(n) + .SH KEYWORDS working directory diff --git a/doc/close.n b/doc/close.n index 2097e04..088a634 100644 --- a/doc/close.n +++ b/doc/close.n @@ -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: close.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: close.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH close n 7.5 Tcl "Tcl Built-In Commands" @@ -55,5 +55,8 @@ that all output is correctly flushed before the process exits. The command returns an empty string, and may generate an error if an error occurs while flushing output. +.SH "SEE ALSO" +file(n), open(n), socket(n), eof(n) + .SH KEYWORDS blocking, channel, close, nonblocking diff --git a/doc/concat.n b/doc/concat.n index a2f9c1e..6449007 100644 --- a/doc/concat.n +++ b/doc/concat.n @@ -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: concat.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: concat.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH concat n "" Tcl "Tcl Built-In Commands" @@ -36,5 +36,8 @@ as its result. .PP If no \fIarg\fRs are supplied, the result is an empty string. +.SH "SEE ALSO" +append(n), eval(n) + .SH KEYWORDS concatenate, join, lists diff --git a/doc/continue.n b/doc/continue.n index 2faddd1..e6afc1c 100644 --- a/doc/continue.n +++ b/doc/continue.n @@ -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: continue.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: continue.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH continue n "" Tcl "Tcl Built-In Commands" @@ -30,5 +30,8 @@ Catch exceptions are also handled in a few other situations, such as the \fBcatch\fR command and the outermost scripts of procedure bodies. +.SH "SEE ALSO" +break(n), for(n), foreach(n), while(n) + .SH KEYWORDS continue, iteration, loop @@ -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: dde.n,v 1.5 2000/04/12 18:41:54 hobbs Exp $ +'\" RCS: @(#) $Id: dde.n,v 1.5.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH dde n 8.1 Tcl "Tcl Built-In Commands" @@ -128,7 +128,9 @@ without adding the \fB&\fR to place the process in the background). If for any reason the event queue is not flushed, DDE commands may hang until the event queue is flushed. This can create a deadlock situation. + .SH "SEE ALSO" -tk, winfo, send +tk(n), winfo(n), send(n) + .SH KEYWORDS application, dde, name, remote execution diff --git a/doc/encoding.n b/doc/encoding.n index fc6d4f7..dea43ed 100644 --- a/doc/encoding.n +++ b/doc/encoding.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: encoding.n,v 1.2 1999/04/16 00:46:34 stanton Exp $ +'\" RCS: @(#) $Id: encoding.n,v 1.2.12.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH encoding n "8.1" Tcl "Tcl Built-In Commands" @@ -73,7 +73,7 @@ would return the Unicode string "\\u306F", which is the Hiragana letter HA. .SH "SEE ALSO" -Tcl_GetEncoding +Tcl_GetEncoding(3) .SH KEYWORDS encoding @@ -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: eof.n,v 1.2 1998/09/14 18:39:51 stanton Exp $ +'\" RCS: @(#) $Id: eof.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH eof n 7.5 Tcl "Tcl Built-In Commands" @@ -23,5 +23,8 @@ Returns 1 if an end of file condition occurred during the most recent input operation on \fIchannelId\fR (such as \fBgets\fR), 0 otherwise. +.SH "SEE ALSO" +file(n), open(n), close(n), fblocked(n) + .SH KEYWORDS channel, end of file diff --git a/doc/error.n b/doc/error.n index 347e26e..9690f21 100644 --- a/doc/error.n +++ b/doc/error.n @@ -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: error.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: error.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH error n "" Tcl "Tcl Built-In Commands" @@ -54,5 +54,8 @@ present, then \fBerrorCode\fR is automatically reset to ``NONE'' by the Tcl interpreter as part of processing the error generated by the command. +.SH "SEE ALSO" +catch(n), tclvars(n) + .SH KEYWORDS error, errorCode, errorInfo @@ -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: eval.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: eval.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH eval n "" Tcl "Tcl Built-In Commands" @@ -28,3 +28,6 @@ evaluation (or any error generated by it). .SH KEYWORDS concatenate, evaluate, script + +.SH "SEE ALSO" +catch(n), concat(n), error(n), subs(n), tclvars(n) @@ -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: exec.n,v 1.4 1999/12/09 14:43:47 hobbs Exp $ +'\" RCS: @(#) $Id: exec.n,v 1.4.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH exec n 7.6 Tcl "Tcl Built-In Commands" @@ -301,9 +301,7 @@ The \fBexec\fR command is not implemented and does not exist under Macintosh. The \fBexec\fR command is fully functional and works as described. .SH "SEE ALSO" -open(n) -.VE +error(n), open(n) .SH KEYWORDS execute, pipeline, redirection, subprocess - @@ -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: exit.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: exit.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH exit n "" Tcl "Tcl Built-In Commands" @@ -24,5 +24,8 @@ system as the exit status. If \fIreturnCode\fR isn't specified then it defaults to 0. +.SH "SEE ALSO" +exec(n), tclvars(n) + .SH KEYWORDS exit, process diff --git a/doc/fblocked.n b/doc/fblocked.n index 3481c7d..300c562 100644 --- a/doc/fblocked.n +++ b/doc/fblocked.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: fblocked.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: fblocked.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ .so man.macros .TH fblocked n 7.5 Tcl "Tcl Built-In Commands" .BS @@ -25,8 +25,9 @@ characters available for input and no end-of-line sequence, \fBgets\fR returns an empty string and a subsequent call to \fBfblocked\fR will return 1. .PP + .SH "SEE ALSO" -gets(n), read(n) +gets(n), open(n), read(n) .SH KEYWORDS blocking, nonblocking diff --git a/doc/fileevent.n b/doc/fileevent.n index 99051ee..fb80025 100644 --- a/doc/fileevent.n +++ b/doc/fileevent.n @@ -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: fileevent.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: fileevent.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH fileevent n 7.5 Tcl "Tcl Built-In Commands" @@ -102,7 +102,7 @@ buggy handlers. by Mark Diekhans. .SH "SEE ALSO" -bgerror, fconfigure, gets, puts, read +bgerror(n), fconfigure(n), gets(n), puts(n), read(n) .SH KEYWORDS asynchronous I/O, blocking, channel, event handler, nonblocking, readable, diff --git a/doc/filename.n b/doc/filename.n index 9d36214..0253fd6 100644 --- a/doc/filename.n +++ b/doc/filename.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: filename.n,v 1.3 1999/08/21 19:40:48 hobbs Exp $ +'\" RCS: @(#) $Id: filename.n,v 1.3.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH filename n 7.5 Tcl "Tcl Built-In Commands" @@ -195,3 +195,6 @@ more than 3 characters. .SH KEYWORDS current directory, absolute file name, relative file name, volume-relative file name, portability + +.SH "SEE ALSO" +file(n), glob(n) diff --git a/doc/flush.n b/doc/flush.n index d88ccec..23b5c9e 100644 --- a/doc/flush.n +++ b/doc/flush.n @@ -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: flush.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: flush.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH flush n 7.5 Tcl "Tcl Built-In Commands" @@ -29,7 +29,7 @@ flushed; the remainder will be flushed in the background as fast as the underlying file or device is able to absorb it. .SH "SEE ALSO" -open(n), socket(n) +file(n), open(n), socket(n) .SH KEYWORDS blocking, buffer, channel, flush, nonblocking, output @@ -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: for.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: for.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH for n "" Tcl "Tcl Built-In Commands" @@ -56,5 +56,8 @@ for {set x 0} {$x<10} {incr x} { } .CE +.SH "SEE ALSO" +break, continue, foreach, while + .SH KEYWORDS for, iteration, looping diff --git a/doc/foreach.n b/doc/foreach.n index 213a6fc..6229566 100644 --- a/doc/foreach.n +++ b/doc/foreach.n @@ -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: foreach.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: foreach.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH foreach n "" Tcl "Tcl Built-In Commands" @@ -82,5 +82,9 @@ foreach i {a b c} {j k} {d e f g} { # The value of x is "a d e b f g c {} {}" # There are 3 iterations of the loop. .DE + +.SH "SEE ALSO" +for(n), while(n), break(n), continue(n) + .SH KEYWORDS foreach, iteration, list, looping diff --git a/doc/format.n b/doc/format.n index b22cef8..05a57a1 100644 --- a/doc/format.n +++ b/doc/format.n @@ -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: format.n,v 1.4 1999/11/19 06:33:58 hobbs Exp $ +'\" RCS: @(#) $Id: format.n,v 1.4.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH format n 8.1 Tcl "Tcl Built-In Commands" @@ -210,5 +210,8 @@ converted as if the \fBl\fR modifier were present (i.e. type If the \fBh\fR modifier is specified then integer values are truncated to \fBshort\fR before conversion. +.SH "SEE ALSO" +sprintf(3), string(n) + .SH KEYWORDS conversion specifier, format, sprintf, string, substitution @@ -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: gets.n,v 1.2 1998/09/14 18:39:52 stanton Exp $ +'\" RCS: @(#) $Id: gets.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH gets n 7.5 Tcl "Tcl Built-In Commands" @@ -44,7 +44,7 @@ The \fBeof\fR and \fBfblocked\fR commands can be used to distinguish these three cases. .SH "SEE ALSO" -eof(n), fblocked(n) +file(n), eof(n), fblocked(n) .SH KEYWORDS blocking, channel, end of file, end of line, line, nonblocking, read @@ -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: glob.n,v 1.7 2000/01/26 03:37:30 hobbs Exp $ +'\" RCS: @(#) $Id: glob.n,v 1.7.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH glob n 8.3 Tcl "Tcl Built-In Commands" @@ -154,6 +154,8 @@ assumes the directory separator for the entire pattern is the standard ``:''. When not using these options, glob examines each pattern argument and uses ``/'' unless the pattern contains a ``:''. +.SH "SEE ALSO" +file(n) .SH KEYWORDS exist, file, glob, pattern diff --git a/doc/global.n b/doc/global.n index 252cbfb..afff5ca 100644 --- a/doc/global.n +++ b/doc/global.n @@ -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: global.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: global.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH global n "" Tcl "Tcl Built-In Commands" @@ -27,9 +27,13 @@ For the duration of the current procedure (and only while executing in the current procedure), any reference to any of the \fIvarname\fRs will refer to the global variable by the same name. +.PP +Please note that this is done by creating local variables that are +linked to the global variables, and therefore that these variables +will be listed by \fBinfo locals\fR like all other local variables. .SH "SEE ALSO" -namespace(n), variable(n) +namespace(n), upvar(n), variable(n) .SH KEYWORDS global, namespace, procedure, variable @@ -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: http.n,v 1.10.2.1 2000/05/31 01:28:56 sandeep Exp $ +'\" RCS: @(#) $Id: http.n,v 1.10.2.2 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH "Http" n 8.3 Tcl "Tcl Built-In Commands" @@ -505,11 +505,10 @@ proc ::http::copy { url file {chunk 4096} } { proc ::http::Progress {args} { puts -nonewline stderr . ; flush stderr } - .DE + .SH "SEE ALSO" safe(n), socket(n), safesock(n) + .SH KEYWORDS security policy, socket - - @@ -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: if.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: if.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH if n "" Tcl "Tcl Built-In Commands" @@ -39,5 +39,8 @@ The return value from the command is the result of the body script that was executed, or an empty string if none of the expressions was non-zero and there was no \fIbodyN\fR. +.SH "SEE ALSO" +expr(n), for(n), foreach(n) + .SH KEYWORDS boolean, conditional, else, false, if, true @@ -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: incr.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: incr.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH incr n "" Tcl "Tcl Built-In Commands" @@ -27,5 +27,8 @@ integer) is added to the value of variable \fIvarName\fR; otherwise The new value is stored as a decimal string in variable \fIvarName\fR and also returned as result. +.SH "SEE ALSO" +expr(n) + .SH KEYWORDS add, increment, variable, value @@ -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: join.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: join.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH join n "" Tcl "Tcl Built-In Commands" @@ -25,5 +25,8 @@ formed by joining all of the elements of \fIlist\fR together with \fIjoinString\fR separating each adjacent pair of elements. The \fIjoinString\fR argument defaults to a space character. +.SH "SEE ALSO" +list(n), lappend(n) + .SH KEYWORDS element, join, list, separator diff --git a/doc/lappend.n b/doc/lappend.n index c4af6e3..8384abe 100644 --- a/doc/lappend.n +++ b/doc/lappend.n @@ -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: lappend.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: lappend.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH lappend n "" Tcl "Tcl Built-In Commands" @@ -31,5 +31,8 @@ large lists. For example, ``\fBlappend a $b\fR'' is much more efficient than ``\fBset a [concat $a [list $b]]\fR'' when \fB$a\fR is long. +.SH "SEE ALSO" +list(n), lindex(n), linsert(n), llength(n), lsort(n), lrange(n) + .SH KEYWORDS append, element, list, variable diff --git a/doc/library.n b/doc/library.n index a4c9818..16746c6 100644 --- a/doc/library.n +++ b/doc/library.n @@ -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: library.n,v 1.11.2.1 2000/08/07 21:29:39 hobbs Exp $ +'\" RCS: @(#) $Id: library.n,v 1.11.2.2 2001/04/03 22:06:43 hobbs Exp $ .so man.macros .TH library n "8.0" Tcl "Tcl Built-In Commands" .BS @@ -304,7 +304,7 @@ infinitely. The variable is unset before \fBunknown\fR returns. .SH "SEE ALSO" -re_syntax(n) +info(n), re_syntax(n) .SH KEYWORDS auto-exec, auto-load, library, unknown, word, whitespace diff --git a/doc/lindex.n b/doc/lindex.n index 70cf1cf..af3dd55 100644 --- a/doc/lindex.n +++ b/doc/lindex.n @@ -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: lindex.n,v 1.4 1999/09/21 04:20:36 hobbs Exp $ +'\" RCS: @(#) $Id: lindex.n,v 1.4.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH lindex n 8.2 Tcl "Tcl Built-In Commands" @@ -32,6 +32,9 @@ If \fIindex\fR has the value \fBend\fR, it refers to the last element in the list, and \fBend\-\fIinteger\fR refers to the last element in the list minus the specified integer offset. +.SH "SEE ALSO" +list(n), lappend(n), linsert(n), llength(n), lsearch(n), lsort(n), +lrange(n), lreplace(n) .SH KEYWORDS element, index, list diff --git a/doc/linsert.n b/doc/linsert.n index 69d7f4a..03b97e6 100644 --- a/doc/linsert.n +++ b/doc/linsert.n @@ -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: linsert.n,v 1.3 1999/09/21 04:20:36 hobbs Exp $ +'\" RCS: @(#) $Id: linsert.n,v 1.3.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH linsert n 8.2 Tcl "Tcl Built-In Commands" @@ -29,5 +29,8 @@ elements in the list, then the new elements are appended to the list. \fBend\-\fIinteger\fR refers to the last element in the list minus the specified integer offset. +.SH "SEE ALSO" +list(n), lappend(n), llength(n) + .SH KEYWORDS element, insert, list @@ -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: list.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: list.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH list n "" Tcl "Tcl Built-In Commands" @@ -41,5 +41,9 @@ while \fBconcat\fR with the same arguments will return \fBa b c d e f {g h}\fR .CE +.SH "SEE ALSO" +lappend(n), lindex(n), linsert(n), llength(n), lsearch(n), lsort(n), +lrange(n), lreplace(n) + .SH KEYWORDS element, list diff --git a/doc/llength.n b/doc/llength.n index 1a58fb7..6f8561b 100644 --- a/doc/llength.n +++ b/doc/llength.n @@ -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: llength.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: llength.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH llength n "" Tcl "Tcl Built-In Commands" @@ -22,5 +22,8 @@ llength \- Count the number of elements in a list Treats \fIlist\fR as a list and returns a decimal string giving the number of elements in it. +.SH "SEE ALSO" +list(n), lindex(n), lrange(n) + .SH KEYWORDS element, list, length @@ -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: load.n,v 1.5 2000/04/14 23:01:55 hobbs Exp $ +'\" RCS: @(#) $Id: load.n,v 1.5.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH load n 7.5 Tcl "Tcl Built-In Commands" @@ -129,7 +129,7 @@ behavior of this varies from system to system (some systems may detect the redundant loads, others may not). .SH "SEE ALSO" -\fBinfo sharedlibextension\fR, Tcl_StaticPackage, safe(n) +\fBinfo sharedlibextension\fR, Tcl_StaticPackage(3), safe(n) .SH KEYWORDS binary code, loading, safe interpreter, shared library diff --git a/doc/lrange.n b/doc/lrange.n index 45d671d..520b190 100644 --- a/doc/lrange.n +++ b/doc/lrange.n @@ -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: lrange.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: lrange.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH lrange n 7.4 Tcl "Tcl Built-In Commands" @@ -35,5 +35,8 @@ same result as ``\fBlindex \fIlist first\fR'' (although it often does for simple fields that aren't enclosed in braces); it does, however, produce exactly the same results as ``\fBlist [lindex \fIlist first\fB]\fR'' +.SH "SEE ALSO" +lappend(n), lindex(n), linsert(n), list(n), llength(n), lreplace(n) + .SH KEYWORDS element, list, range, sublist diff --git a/doc/lreplace.n b/doc/lreplace.n index bb32aaa..86086e2 100644 --- a/doc/lreplace.n +++ b/doc/lreplace.n @@ -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: lreplace.n,v 1.4 2000/01/21 18:24:06 ericm Exp $ +'\" RCS: @(#) $Id: lreplace.n,v 1.4.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH lreplace n 7.4 Tcl "Tcl Built-In Commands" @@ -43,5 +43,9 @@ the list. If no \fIelement\fR arguments are specified, then the elements between \fIfirst\fR and \fIlast\fR are simply deleted. If \fIlist\fR is empty, any \fIelement\fR arguments are added to the end of the list. +.SH "SEE ALSO" +lappend(n), lindex(n), linsert(n), list(n), llength(n), lrange(n), +lsearch(n), lsort(n) + .SH KEYWORDS element, list, replace diff --git a/doc/lsort.n b/doc/lsort.n index 8d326fc..761eada 100644 --- a/doc/lsort.n +++ b/doc/lsort.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lsort.n,v 1.5 1999/12/21 23:57:33 hobbs Exp $ +'\" RCS: @(#) $Id: lsort.n,v 1.5.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH lsort n 8.3 Tcl "Tcl Built-In Commands" @@ -77,7 +77,6 @@ returns \fB{Second 18} {First 24} {Third 30}\fR. This option is much more efficient than using \fB\-command\fR to achieve the same effect. .RE -.VS 8.3 .TP 20 \fB\-unique\fR If this option is specified, then only the last set of duplicate @@ -86,7 +85,92 @@ determined relative to the comparison used in the sort. Thus if \fI-index 0\fR is used, \fB{1 a}\fR and \fB{1 b}\fR would be considered duplicates and only the second element, \fB{1 b}\fR, would be retained. -.VE + +.SH "NOTES" +.PP +The options to \fBlsort\fR only control what sort of comparison is +used, and do not necessarily constrain what the values themselves +actually are. This distinction is only noticeable when the list to be +sorted has fewer than two elements. +.PP +The \fBlsort\fR command is reentrant, meaning it is safe to use as +part of the implementation of a command used in the \fB\-command\fR +option. + +.SH "EXAMPLES" + +.PP +Sorting a list using ASCII sorting: +.CS +% lsort {a10 B2 b1 a1 a2} +B2 a1 a10 a2 b1 +.CE + +.PP +Sorting a list using Dictionary sorting: +.CS +% lsort -dictionary {a10 B2 b1 a1 a2} +a1 a2 a10 b1 B2 +.CE + +.PP +Sorting lists of integers: +.CS +% lsort -integer {5 3 1 2 11 4} +1 2 3 4 5 11 +% lsort -integer {1 2 0x5 7 0 4 -1} +-1 0 1 2 4 0x5 7 +.CE + +.PP +Sorting lists of floating-point numbers: +.CS +% lsort -real {5 3 1 2 11 4} +1 2 3 4 5 11 +% lsort -real {.5 0.07e1 0.4 6e-1} +0.4 .5 6e-1 0.07e1 +.CE + +.PP +Sorting using indices: +.CS +% # Note the space character before the c +% lsort {{a 5} { c 3} {b 4} {e 1} {d 2}} +{ c 3} {a 5} {b 4} {d 2} {e 1} +% lsort -index 0 {{a 5} { c 3} {b 4} {e 1} {d 2}} +{a 5} {b 4} { c 3} {d 2} {e 1} +% lsort -index 1 {{a 5} { c 3} {b 4} {e 1} {d 2}} +{e 1} {d 2} { c 3} {b 4} {a 5} +.CE + +.PP +Stripping duplicate values using sorting: +.CS +% lsort -unique {a b c a b c a b c} +a b c +.CE + +.PP +More complex sorting using a comparison function: +.CS +% proc compare {a b} { + set a0 [lindex $a 0] + set b0 [lindex $b 0] + if {$a0 < $b0} { + return -1 + } elseif {$a0 > $b0} { + return 1 + } + return [string compare [lindex $a 1] [lindex $b 1]] +} +% lsort -command compare \\ + {{3 apple} {0x2 carrot} {1 dingo} {2 banana}} +{1 dingo} {2 banana} {0x2 carrot} {3 apple} +.CE + +.SH "SEE ALSO" +lappend(n), lindex(n), linsert(n), list(n), llength(n), lrange(n), +lreplace(n), lsearch(n) .SH KEYWORDS element, list, order, sort diff --git a/doc/man.macros b/doc/man.macros index bdf69ff..4b46796 100644 --- a/doc/man.macros +++ b/doc/man.macros @@ -59,7 +59,7 @@ '\" .UL arg1 arg2 '\" Print arg1 underlined, then print arg2 normally. '\" -'\" RCS: @(#) $Id: man.macros,v 1.3 1999/04/16 00:46:35 stanton Exp $ +'\" RCS: @(#) $Id: man.macros,v 1.3.12.1 2001/04/03 22:06:43 hobbs Exp $ '\" '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B @@ -199,7 +199,7 @@ .SH "STANDARD OPTIONS" .LP .nf -.ta 4c 8c 12c +.ta 5.5c 11c .ft B .. '\" # SE - end of list of standard options diff --git a/doc/memory.n b/doc/memory.n index 3f7ca66..86fa7c0 100644 --- a/doc/memory.n +++ b/doc/memory.n @@ -3,7 +3,7 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: memory.n,v 1.2 2000/04/28 00:47:49 ericm Exp $ +'\" RCS: @(#) $Id: memory.n,v 1.2.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH memory n 8.1 Tcl "Tcl Built-In Commands" @@ -78,5 +78,3 @@ ckalloc, ckfree, Tcl_ValidateAllMemory, Tcl_DumpActiveMemory, TCL_MEM_DEBUG .SH KEYWORDS memory, debug - - @@ -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: open.n,v 1.9 1999/12/21 23:57:33 hobbs Exp $ +'\" RCS: @(#) $Id: open.n,v 1.9.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH open n 7.6 Tcl "Tcl Built-In Commands" @@ -108,6 +108,18 @@ If a new file is created as part of opening it, \fIpermissions\fR (an integer) is used to set the permissions for the new file in conjunction with the process's file mode creation mask. \fIPermissions\fR defaults to 0666. +.PP +'\" Not versioned as advice applies to all recent versions of Tcl. +'\" Prior to that, Tcl didn't really support binary files anyway... +.VS +Note that if you are going to be reading or writing binary data from +the channel created by this command, you should use the +\fBfconfigure\fR command to change the \fB-translation\fR option of +the channel to \fBbinary\fR before transferring any binary data. This +is in contrast to the ``b'' character passed as part of the equivalent +of the \fIaccess\fR parameter to some versions of the C library +\fIfopen()\fR function. +.VE .SH "COMMAND PIPELINES" .PP If the first character of \fIfileName\fR is ``|'' then the @@ -251,9 +263,11 @@ input, but is redirected from a file, then the above problem does not occur. See the PORTABILITY ISSUES section of the \fBexec\fR command for additional information not specific to command pipelines about executing applications on the various platforms + .SH "SEE ALSO" -close(n), filename(n), gets(n), read(n), puts(n), exec(n) -.VE +file(n), close(n), filename(n), fconfigure(n), gets(n), read(n), +puts(n), exec(n), fopen(1) + .SH KEYWORDS access mode, append, create, file, non-blocking, open, permissions, pipeline, process, serial diff --git a/doc/package.n b/doc/package.n index a8f8a18..9ca1ec5 100644 --- a/doc/package.n +++ b/doc/package.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: package.n,v 1.3.14.1 2000/08/07 21:29:39 hobbs Exp $ +'\" RCS: @(#) $Id: package.n,v 1.3.14.2 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH package n 7.5 Tcl "Tcl Built-In Commands" @@ -189,5 +189,8 @@ Once you've done this, packages will be loaded automatically in response to \fBpackage require\fR commands. See the documentation for \fBpkg_mkIndex\fR for details. +.SH "SEE ALSO" +msgcat(n), packagens(n), pkgMkIndex(n) + .SH KEYWORDS package, version diff --git a/doc/packagens.n b/doc/packagens.n index c02b705..e1f7618 100644 --- a/doc/packagens.n +++ b/doc/packagens.n @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: packagens.n,v 1.2 2000/02/10 10:09:18 hobbs Exp $ +'\" RCS: @(#) $Id: packagens.n,v 1.2.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH pkg::create n 8.3 Tcl "Tcl Built-In Commands" @@ -48,5 +48,8 @@ specified. .PP At least one \fB\-load\fR or \fB\-source\fR paramter must be given. +.SH "SEE ALSO" +package(n) + .SH KEYWORDS auto-load, index, package, version @@ -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: pid.n,v 1.2 1998/09/14 18:39:54 stanton Exp $ +'\" RCS: @(#) $Id: pid.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH pid n 7.0 Tcl "Tcl Built-In Commands" @@ -30,5 +30,8 @@ If no \fIfileId\fR argument is given then \fBpid\fR returns the process identifier of the current process. All process identifiers are returned as decimal strings. +.SH "SEE ALSO" +exec(n), open(n) + .SH KEYWORDS file, pipeline, process identifier diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n index 95c8e8a..0c60659 100644 --- a/doc/pkgMkIndex.n +++ b/doc/pkgMkIndex.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: pkgMkIndex.n,v 1.9 2000/02/10 10:09:18 hobbs Exp $ +'\" RCS: @(#) $Id: pkgMkIndex.n,v 1.9.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH pkg_mkIndex n 8.3 Tcl "Tcl Built-In Commands" @@ -232,5 +232,8 @@ If you must use \fB\-load\fP, then you must specify the scripts first; otherwise the package loaded from the binary file may mask the package defined by the scripts. +.SH "SEE ALSO" +package(n) + .SH KEYWORDS auto-load, index, package, version @@ -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: proc.n,v 1.2 1998/09/14 18:39:54 stanton Exp $ +'\" RCS: @(#) $Id: proc.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH proc n "" Tcl "Tcl Built-In Commands" @@ -70,5 +70,8 @@ executed in the procedure's body. If an error occurs while executing the procedure body, then the procedure-as-a-whole will return that same error. +.SH "SEE ALSO" +info(n), unknown(n) + .SH KEYWORDS argument, procedure @@ -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: puts.n,v 1.3 1999/04/16 00:46:35 stanton Exp $ +'\" RCS: @(#) $Id: puts.n,v 1.3.12.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH puts n 7.5 Tcl "Tcl Built-In Commands" @@ -63,7 +63,7 @@ be used in an event-driven fashion with the \fBfileevent\fR command via a file event that the channel is ready for more output data). .SH "SEE ALSO" -fileevent(n) +file(n), fileevent(n) .SH KEYWORDS channel, newline, output, write @@ -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: pwd.n,v 1.2 1998/09/14 18:39:54 stanton Exp $ +'\" RCS: @(#) $Id: pwd.n,v 1.2.18.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH pwd n "" Tcl "Tcl Built-In Commands" @@ -21,5 +21,8 @@ pwd \- Return the current working directory .PP Returns the path name of the current working directory. +.SH "SEE ALSO" +file(n), cd(n), glob(n), filename(n) + .SH KEYWORDS working directory @@ -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: read.n,v 1.4 1999/05/05 01:19:42 stanton Exp $ +'\" RCS: @(#) $Id: read.n,v 1.4.12.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH read n 8.1 Tcl "Tcl Built-In Commands" @@ -52,7 +52,7 @@ See the \fBfconfigure\fR manual entry for a discussion on ways in which \fBfconfigure\fR will alter input. .SH "SEE ALSO" -eof(n), fblocked(n), fconfigure(n) +file(n), eof(n), fblocked(n), fconfigure(n) .SH KEYWORDS blocking, channel, end of line, end of file, nonblocking, read, translation, encoding diff --git a/doc/regexp.n b/doc/regexp.n index 23140f5..87fcdd5 100644 --- a/doc/regexp.n +++ b/doc/regexp.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: regexp.n,v 1.9 2000/04/14 06:42:32 hobbs Exp $ +'\" RCS: @(#) $Id: regexp.n,v 1.9.2.1 2001/04/03 22:06:43 hobbs Exp $ '\" .so man.macros .TH regexp n 8.3 Tcl "Tcl Built-In Commands" @@ -127,7 +127,7 @@ portion of the expression that wasn't matched), then the corresponding has been specified or to an empty string otherwise. .SH "SEE ALSO" -re_syntax(n) +re_syntax(n), regsub(n) .SH KEYWORDS match, regular expression, string diff --git a/doc/regsub.n b/doc/regsub.n index 502cb1b..d160159 100644 --- a/doc/regsub.n +++ b/doc/regsub.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: regsub.n,v 1.4.2.1 2000/08/07 21:29:39 hobbs Exp $ +'\" RCS: @(#) $Id: regsub.n,v 1.4.2.2 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH regsub n 8.3 Tcl "Tcl Built-In Commands" @@ -105,5 +105,8 @@ were found and replaced. See the manual entry for \fBregexp\fR for details on the interpretation of regular expressions. +.SH "SEE ALSO" +regexp(n), re_syntax(n) + .SH KEYWORDS match, pattern, regular expression, substitute diff --git a/doc/rename.n b/doc/rename.n index d7617e3..280871e 100644 --- a/doc/rename.n +++ b/doc/rename.n @@ -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: rename.n,v 1.2 1998/09/14 18:39:54 stanton Exp $ +'\" RCS: @(#) $Id: rename.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH rename n "" Tcl "Tcl Built-In Commands" @@ -28,5 +28,8 @@ If a command is renamed into a different namespace, future invocations of it will execute in the new namespace. The \fBrename\fR command returns an empty string as result. +.SH "SEE ALSO" +namespace(n), proc(n) + .SH KEYWORDS command, delete, namespace, rename diff --git a/doc/resource.n b/doc/resource.n index 292d62d..75a39a4 100644 --- a/doc/resource.n +++ b/doc/resource.n @@ -3,7 +3,7 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" RCS: @(#) $Id: resource.n,v 1.5 1999/08/21 19:40:48 hobbs Exp $ +'\" RCS: @(#) $Id: resource.n,v 1.5.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH resource n 8.0 Tcl "Tcl Built-In Commands" @@ -149,7 +149,7 @@ numbers if the name is NULL. The resource command is only available on Macintosh. .SH "SEE ALSO" -open +open(n) .SH KEYWORDS open, resource diff --git a/doc/return.n b/doc/return.n index d3a3635..45feb8d 100644 --- a/doc/return.n +++ b/doc/return.n @@ -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: return.n,v 1.2 1998/09/14 18:39:54 stanton Exp $ +'\" RCS: @(#) $Id: return.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH return n 7.0 Tcl "Tcl Built-In Commands" @@ -85,5 +85,8 @@ a value for the \fBerrorCode\fR variable. If the option is not specified then \fBerrorCode\fR will default to \fBNONE\fR. +.SH "SEE ALSO" +break(n), continue(n), error(n), proc(n) + .SH KEYWORDS break, continue, error, procedure, return @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: scan.n,v 1.4.2.2 2000/08/07 21:29:39 hobbs Exp $ +'\" RCS: @(#) $Id: scan.n,v 1.4.2.3 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH scan n 8.3 Tcl "Tcl Built-In Commands" @@ -48,9 +48,7 @@ When a \fB%\fR is encountered in \fIformat\fR, it indicates the start of a conversion specifier. A conversion specifier contains up to four fields after the \fB%\fR: a \fB*\fR, which indicates that the converted value is to be discarded -.VS 8.1 instead of assigned to a variable; a XPG3 position specifier; a number -.VE 8.1 indicating a maximum field width; and a conversion character. All of these fields are optional except for the conversion character. The fields that are present must appear in the order given above. @@ -61,7 +59,6 @@ specifier is \fB[\fR or \fBc\fR). Then it converts the next input characters according to the conversion specifier and stores the result in the variable given by the next argument to \fBscan\fR. -.VS 8.1 .PP If the \fB%\fR is followed by a decimal number and a \fB$\fR, as in ``\fB%2$d\fR'', then the variable to use is not taken from the next @@ -72,7 +69,6 @@ specifiers must be positional. Every \fIvarName\fR on the argument list must correspond to exactly one conversion specifier or an error is generated, or in the inline case, any position can be specified at most once and the empty positions will be filled in with empty strings. -.VE 8.1 .PP The following conversion characters are supported: .TP 10 @@ -83,11 +79,20 @@ It is read in and the value is stored in the variable as a decimal string. \fBo\fR The input field must be an octal integer. It is read in and the value is stored in the variable as a decimal string. +.VS 8.4 +If the value exceeds MAX_INT (017777777777 on platforms using 32-bit +integers), it will be truncated to a signed integer. Hence, 037777777777 +will appear as -1 on a 32-bit machine. +.VE 8.4 .TP 10 \fBx\fR The input field must be a hexadecimal integer. It is read in and the value is stored in the variable as a decimal string. -.VS 8.1 +.VS 8.4 +If the value exceeds MAX_INT (0x7FFFFFFF on platforms using 32-bit +integers), it will be truncated to a signed integer. Hence, 0xFFFFFFFF +will appear as -1 on a 32-bit machine. +.VE 8.4 .TP 10 \fBu\fR The input field must be a decimal integer. The value is stored in the @@ -97,7 +102,6 @@ variable as an unsigned decimal integer string. The input field must be an integer. The base (i.e. decimal, octal, or hexadecimal) is determined in the same fashion as described in \fBexpr\fR. The value is stored in the variable as a decimal string. -.VE 8.1 .TP 10 \fBc\fR A single character is read in and its binary value is stored in @@ -127,13 +131,11 @@ The matching string is stored in the variable. If the first character between the brackets is a \fB]\fR then it is treated as part of \fIchars\fR rather than the closing bracket for the set. -.VS 8.1 If \fIchars\fR contains a sequence of the form \fIa\fB\-\fIb\fR then any character between \fIa\fR and \fIb\fR (inclusive) will match. If the first or last character between the brackets is a \fB\-\fR, then it is treated as part of \fIchars\fR rather than indicating a range. -.VE 8.1 .TP 10 \fB[^\fIchars\fB]\fR The input field consists of any number of characters not in @@ -142,7 +144,6 @@ The matching string is stored in the variable. If the character immediately following the \fB^\fR is a \fB]\fR then it is treated as part of the set rather than the closing bracket for the set. -.VS 8.1 If \fIchars\fR contains a sequence of the form \fIa\fB\-\fIb\fR then any character between \fIa\fR and \fIb\fR (inclusive) will be excluded @@ -153,7 +154,6 @@ it is treated as part of \fIchars\fR rather than indicating a range. \fBn\fR No input is consumed from the input string. Instead, the total number of chacters scanned from the input string so far is stored in the variable. -.VE 8.1 .LP The number of characters read from the input for a conversion is the largest number that makes sense for that particular conversion (e.g. @@ -169,10 +169,8 @@ then no variable is assigned and the next scan argument is not consumed. .PP The behavior of the \fBscan\fR command is the same as the behavior of the ANSI C \fBsscanf\fR procedure except for the following differences: -.VS 8.1 .IP [1] \fB%p\fR conversion specifier is not currently supported. -.VE 8.1 .IP [2] For \fB%c\fR conversions a single character value is converted to a decimal string, which is then assigned to the @@ -184,11 +182,14 @@ values are always converted as if there were no modifier present and real values are always converted as if the \fBl\fR modifier were present (i.e. type \fBdouble\fR is used for the internal representation). -.VS 8.3 .IP [4] +.VS 8.3 If the end of the input string is reached before any conversions have been performed and no variables are given, and empty string is returned. .VE 8.3 +.SH "SEE ALSO" +format(n), sscanf(3) + .SH KEYWORDS conversion specifier, parse, scan @@ -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: seek.n,v 1.3 1999/05/05 01:19:43 stanton Exp $ +'\" RCS: @(#) $Id: seek.n,v 1.3.12.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH seek n 8.1 Tcl "Tcl Built-In Commands" @@ -57,5 +57,8 @@ offsets. Both \fBseek\fR and \fBtell\fR operate in terms of bytes, not characters, unlike \fBread\fR. .VE 8.1 +.SH "SEE ALSO" +file(n), open(n), close(n), gets(n), tell(n) + .SH KEYWORDS access position, file, seek @@ -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: set.n,v 1.2 1998/09/14 18:39:55 stanton Exp $ +'\" RCS: @(#) $Id: set.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH set n "" Tcl "Tcl Built-In Commands" @@ -44,5 +44,8 @@ was invoked to declare \fIvarName\fR to be global, or unless a \fBvariable\fR command was invoked to declare \fIvarName\fR to be a namespace variable. +.SH "SEE ALSO" +expr(n), proc(n), trace(n), unset(n) + .SH KEYWORDS read, write, variable diff --git a/doc/split.n b/doc/split.n index 04773b0..cf5609f 100644 --- a/doc/split.n +++ b/doc/split.n @@ -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: split.n,v 1.2 1998/09/14 18:39:55 stanton Exp $ +'\" RCS: @(#) $Id: split.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH split n "" Tcl "Tcl Built-In Commands" @@ -40,5 +40,8 @@ returns \fB"comp unix misc"\fR and .CE returns \fB"H e l l o { } w o r l d"\fR. +.SH "SEE ALSO" +join(n), list(n), string(n) + .SH KEYWORDS list, split, string diff --git a/doc/string.n b/doc/string.n index afa59d3..8a1dea2 100644 --- a/doc/string.n +++ b/doc/string.n @@ -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: string.n,v 1.13 1999/12/21 23:57:34 hobbs Exp $ +'\" RCS: @(#) $Id: string.n,v 1.13.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH string n 8.1 Tcl "Tcl Built-In Commands" @@ -334,5 +334,8 @@ or underscore (Unicode connector punctuation) characters, or any single character other than these. .VE 8.1 +.SH "SEE ALSO" +expr(n), list(n) + .SH KEYWORDS case conversion, compare, index, match, pattern, string, word, equal, ctype diff --git a/doc/subst.n b/doc/subst.n index 8675c22..e0c39a2 100644 --- a/doc/subst.n +++ b/doc/subst.n @@ -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: subst.n,v 1.2 1998/09/14 18:39:55 stanton Exp $ +'\" RCS: @(#) $Id: subst.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH subst n 7.4 Tcl "Tcl Built-In Commands" @@ -44,5 +44,8 @@ subst {xyz {$a}}\fR .CE returns ``\fBxyz {44}\fR'', not ``\fBxyz {$a}\fR''. +.SH "SEE ALSO" +eval(n) + .SH KEYWORDS backslash substitution, command substitution, variable substitution diff --git a/doc/switch.n b/doc/switch.n index c454a3d..42c4551 100644 --- a/doc/switch.n +++ b/doc/switch.n @@ -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: switch.n,v 1.4 1999/09/21 04:20:36 hobbs Exp $ +'\" RCS: @(#) $Id: switch.n,v 1.4.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH switch n 7.0 Tcl "Tcl Built-In Commands" @@ -110,5 +110,8 @@ will return \fB1\fR, and .CE will return \fB3\fR. +.SH "SEE ALSO" +for(n), if(n), regexp(n) + .SH KEYWORDS switch, match, regular expression diff --git a/doc/tclvars.n b/doc/tclvars.n index 2d3b4e0..1471130 100644 --- a/doc/tclvars.n +++ b/doc/tclvars.n @@ -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: tclvars.n,v 1.7 2000/01/21 02:25:06 hobbs Exp $ +'\" RCS: @(#) $Id: tclvars.n,v 1.7.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH tclvars n 8.0 Tcl "Tcl Built-In Commands" @@ -394,5 +394,8 @@ bug fixes that retain backward compatibility. The value of this variable is returned by the \fBinfo tclversion\fR command. +.SH "SEE ALSO" +eval(n) + .SH KEYWORDS arithmetic, bytecode, compiler, error, environment, POSIX, precision, subprocess, variables @@ -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: tell.n,v 1.3 1999/05/05 01:19:43 stanton Exp $ +'\" RCS: @(#) $Id: tell.n,v 1.3.12.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH tell n 8.1 Tcl "Tcl Built-In Commands" @@ -28,5 +28,8 @@ that this value is in terms of bytes, not characters like \fBread\fR. The value returned is -1 for channels that do not support seeking. +.SH "SEE ALSO" +file(n), open(n), close(n), gets(n), seek(n) + .SH KEYWORDS access position, channel, seeking @@ -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: time.n,v 1.2 1998/09/14 18:39:56 stanton Exp $ +'\" RCS: @(#) $Id: time.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH time n "" Tcl "Tcl Built-In Commands" @@ -29,5 +29,8 @@ which indicates the average amount of time required per iteration, in microseconds. Time is measured in elapsed time, not CPU time. +.SH "SEE ALSO" +clock(n) + .SH KEYWORDS script, time diff --git a/doc/unknown.n b/doc/unknown.n index 19f5ac1..6683564 100644 --- a/doc/unknown.n +++ b/doc/unknown.n @@ -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: unknown.n,v 1.2 1998/09/14 18:39:56 stanton Exp $ +'\" RCS: @(#) $Id: unknown.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH unknown n "" Tcl "Tcl Built-In Commands" @@ -71,5 +71,8 @@ Under normal circumstances the return value from \fBunknown\fR is the return value from the command that was eventually executed. +.SH "SEE ALSO" +info(n), proc(n) + .SH KEYWORDS error, non-existent command diff --git a/doc/update.n b/doc/update.n index 066a0b8..3074ffe 100644 --- a/doc/update.n +++ b/doc/update.n @@ -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: update.n,v 1.3 2000/04/14 06:42:32 hobbs Exp $ +'\" RCS: @(#) $Id: update.n,v 1.3.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH update n 7.5 Tcl "Tcl Built-In Commands" @@ -44,5 +44,8 @@ the application to respond to events such as user interactions; if you occasionally call \fBupdate\fR then user input will be processed during the next call to \fBupdate\fR. +.SH "SEE ALSO" +after(n), bgerror(n) + .SH KEYWORDS event, flush, handler, idle, update diff --git a/doc/uplevel.n b/doc/uplevel.n index 83290d3..1288c29 100644 --- a/doc/uplevel.n +++ b/doc/uplevel.n @@ -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: uplevel.n,v 1.2 1998/09/14 18:39:56 stanton Exp $ +'\" RCS: @(#) $Id: uplevel.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH uplevel n "" Tcl "Tcl Built-In Commands" @@ -74,7 +74,7 @@ Also, \fBuplevel #0\fR evaluates a script at top-level in the outermost namespace (the global namespace). .SH "SEE ALSO" -namespace(n) +namespace(n), upvar(n) .SH KEYWORDS context, level, namespace, stack frame, variables diff --git a/doc/upvar.n b/doc/upvar.n index 3f6792c..0631178 100644 --- a/doc/upvar.n +++ b/doc/upvar.n @@ -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: upvar.n,v 1.3 2000/01/21 03:29:13 ericm Exp $ +'\" RCS: @(#) $Id: upvar.n,v 1.3.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH upvar n "" Tcl "Tcl Built-In Commands" @@ -106,7 +106,7 @@ made to \fImyVar\fR will not be passed to subprocesses correctly. .VE .SH "SEE ALSO" -namespace(n) +global(n), namespace(n), uplevel(n), variable(n) .SH KEYWORDS context, frame, global, level, namespace, procedure, variable diff --git a/doc/variable.n b/doc/variable.n index 417cd24..82dd62b 100644 --- a/doc/variable.n +++ b/doc/variable.n @@ -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: variable.n,v 1.3 2000/01/26 21:36:35 ericm Exp $ +'\" RCS: @(#) $Id: variable.n,v 1.3.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH variable n 8.0 Tcl "Tcl Built-In Commands" @@ -42,7 +42,8 @@ command, but not to the \fBinfo exists\fR command. .PP If the \fBvariable\fR command is executed inside a Tcl procedure, it creates local variables -linked to the corresponding namespace variables. +linked to the corresponding namespace variables (and therefore these +variables are listed by \fBinfo locals\fR.) In this way the \fBvariable\fR command resembles the \fBglobal\fR command, although the \fBglobal\fR command only links to variables in the global namespace. @@ -59,7 +60,7 @@ elements within the array can be set using ordinary \fBset\fR or \fBarray\fR commands. .SH "SEE ALSO" -global(n), namespace(n) +global(n), namespace(n), upvar(n) .SH KEYWORDS global, namespace, procedure, variable diff --git a/doc/vwait.n b/doc/vwait.n index b8864e1..dac1681 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.3 2000/01/21 02:25:06 hobbs Exp $ +'\" RCS: @(#) $Id: vwait.n,v 1.3.2.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH vwait n 8.0 Tcl "Tcl Built-In Commands" @@ -36,5 +36,8 @@ 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 "SEE ALSO" +global(n) + .SH KEYWORDS event, variable, wait diff --git a/doc/while.n b/doc/while.n index dabe116..5f58883 100644 --- a/doc/while.n +++ b/doc/while.n @@ -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: while.n,v 1.2 1998/09/14 18:39:56 stanton Exp $ +'\" RCS: @(#) $Id: while.n,v 1.2.18.1 2001/04/03 22:06:44 hobbs Exp $ '\" .so man.macros .TH while n "" Tcl "Tcl Built-In Commands" @@ -51,5 +51,8 @@ while {$x<10} { } .CE +.SH "SEE ALSO" +break(n), continue(n), for(n), foreach(n) + .SH KEYWORDS boolean value, loop, test, while |