diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/AddErrInfo.3 | 58 | ||||
| -rw-r--r-- | doc/CrtChannel.3 | 6 | ||||
| -rw-r--r-- | doc/OpenFileChnl.3 | 4 | ||||
| -rw-r--r-- | doc/ParseCmd.3 | 6 | ||||
| -rw-r--r-- | doc/SaveResult.3 | 8 | ||||
| -rw-r--r-- | doc/Tcl_Main.3 | 6 | ||||
| -rw-r--r-- | doc/Thread.3 | 4 | ||||
| -rw-r--r-- | doc/array.n | 6 | ||||
| -rw-r--r-- | doc/binary.n | 14 | ||||
| -rw-r--r-- | doc/catch.n | 24 | ||||
| -rw-r--r-- | doc/dde.n | 12 | ||||
| -rw-r--r-- | doc/error.n | 10 | ||||
| -rw-r--r-- | doc/exec.n | 6 | ||||
| -rw-r--r-- | doc/expr.n | 6 | ||||
| -rw-r--r-- | doc/file.n | 38 | ||||
| -rw-r--r-- | doc/http.n | 28 | ||||
| -rw-r--r-- | doc/interp.n | 30 | ||||
| -rw-r--r-- | doc/lsearch.n | 4 | ||||
| -rw-r--r-- | doc/lsort.n | 4 | ||||
| -rw-r--r-- | doc/mathfunc.n | 14 | ||||
| -rw-r--r-- | doc/msgcat.n | 4 | ||||
| -rw-r--r-- | doc/open.n | 20 | ||||
| -rw-r--r-- | doc/regexp.n | 8 | ||||
| -rw-r--r-- | doc/registry.n | 11 | ||||
| -rw-r--r-- | doc/return.n | 67 | ||||
| -rw-r--r-- | doc/safe.n | 6 | ||||
| -rw-r--r-- | doc/source.n | 6 | ||||
| -rw-r--r-- | doc/string.n | 4 | ||||
| -rw-r--r-- | doc/subst.n | 10 | ||||
| -rw-r--r-- | doc/tclvars.n | 16 | ||||
| -rw-r--r-- | doc/tm.n | 4 |
31 files changed, 224 insertions, 220 deletions
diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3 index d5f6b5f..6fa5851 100644 --- a/doc/AddErrInfo.3 +++ b/doc/AddErrInfo.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: AddErrInfo.3,v 1.17 2007/10/28 14:17:38 dkf Exp $ +'\" RCS: @(#) $Id: AddErrInfo.3,v 1.18 2007/10/29 11:28:49 dkf Exp $ '\" .so man.macros .TH Tcl_AddErrorInfo 3 8.5 Tcl "Tcl Library Procedures" @@ -49,20 +49,20 @@ The code returned from script evaluation. A dictionary of return options. .AP char *message in For \fBTcl_AddErrorInfo\fR, -this is a conventional C string to append to the \fB-errorinfo\fR return option. +this is a conventional C string to append to the \fB\-errorinfo\fR return option. For \fBTcl_AddObjErrorInfo\fR, this points to the first byte of an array of \fIlength\fR bytes -containing a string to append to the \fB-errorinfo\fR return option. +containing a string to append to the \fB\-errorinfo\fR return option. This byte array may contain embedded null bytes unless \fIlength\fR is negative. .AP int length in The number of bytes to copy from \fImessage\fR when -appending to the \fB-errorinfo\fR return option. +appending to the \fB\-errorinfo\fR return option. If negative, all bytes up to the first null byte are used. .AP Tcl_Obj *errorObjPtr in -The \fB-errorcode\fR return option will be set to this value. +The \fB\-errorcode\fR return option will be set to this value. .AP char *element in -String to record as one element of the \fB-errorcode\fR return option. +String to record as one element of the \fB\-errorcode\fR return option. Last \fIelement\fR argument must be NULL. .AP va_list argList in An argument list which must have been initialized using @@ -94,10 +94,10 @@ of return options. The integer completion code should be passed as the \fIcode\fR argument to \fBTcl_GetReturnOptions\fR so that all required options will be present in the dictionary. Specifically, a \fIcode\fR value of \fBTCL_ERROR\fR will -ensure that entries for the keys \fB-errorinfo\fR, -\fB-errorcode\fR, and \fB-errorline\fR will appear in the -dictionary. Also, the entries for the keys \fB-code\fR -and \fB-level\fR will be adjusted if necessary to agree +ensure that entries for the keys \fB\-errorinfo\fR, +\fB\-errorcode\fR, and \fB\-errorline\fR will appear in the +dictionary. Also, the entries for the keys \fB\-code\fR +and \fB\-level\fR will be adjusted if necessary to agree with the value of \fIcode\fR. The \fB(Tcl_Obj *)\fR returned by \fBTcl_GetReturnOptions\fR points to an unshared \fBTcl_Obj\fR with reference count of zero. The dictionary @@ -125,7 +125,7 @@ of \fIinterp\fR to be \fIoptions\fR. If \fIoptions\fR contains any invalid value for any key, TCL_ERROR will be returned, and the interp result will be set to an appropriate error message. Otherwise, a completion code -in agreement with the \fB-code\fR and \fB-level\fR +in agreement with the \fB\-code\fR and \fB\-level\fR keys in \fIoptions\fR will be returned. .PP As an example, Tcl's \fBreturn\fR command itself could @@ -150,43 +150,43 @@ to any reference counting. This is analogous to While \fBTcl_SetReturnOptions\fR provides a general interface to set any collection of return options, there are a handful of return options that are very frequently used. Most -notably the \fB-errorinfo\fR and \fB-errorcode\fR return +notably the \fB\-errorinfo\fR and \fB\-errorcode\fR return options should be set properly when the command procedure of a command returns \fBTCL_ERROR\fR. Tcl provides several simpler interfaces to more directly set these return options. .VE 8.5 .PP -The \fB-errorinfo\fR option holds a stack trace of the +The \fB\-errorinfo\fR option holds a stack trace of the operations that were in progress when an error occurred, and is intended to be human-readable. -The \fB-errorcode\fR option holds a list of items that +The \fB\-errorcode\fR option holds a list of items that are intended to be machine-readable. -The first item in the \fB-errorcode\fR value identifies the class of +The first item in the \fB\-errorcode\fR value identifies the class of error that occurred (e.g. POSIX means an error occurred in a POSIX system call) and additional elements hold additional pieces of information that depend on the class. See the tclvars manual entry for details on the various -formats for the \fB-errorcode\fR option used by +formats for the \fB\-errorcode\fR option used by Tcl's built-in commands. .PP -The \fB-errorinfo\fR option value is gradually built up as an +The \fB\-errorinfo\fR option value is gradually built up as an error unwinds through the nested operations. Each time an error code is returned to \fBTcl_Eval\fR, or any of the routines that performs script evaluation, the procedure \fBTcl_AddErrorInfo\fR is called to add -additional text to the \fB-errorinfo\fR value describing the +additional text to the \fB\-errorinfo\fR value describing the command that was being executed when the error occurred. By the time the error has been passed all the way back to the application, it will contain a complete trace of the activity in progress when the error occurred. .PP It is sometimes useful to add additional information to -the \fB-errorinfo\fR value beyond what can be supplied automatically +the \fB\-errorinfo\fR value beyond what can be supplied automatically by the script evaluation routines. \fBTcl_AddErrorInfo\fR may be used for this purpose: its \fImessage\fR argument is an additional -string to be appended to the \fB-errorinfo\fR option. +string to be appended to the \fB\-errorinfo\fR option. For example, when an error arises during the \fBsource\fR command, the procedure \fBTcl_AddErrorInfo\fR is called to record the name of the file being processed and the @@ -196,7 +196,7 @@ Tcl procedures, the procedure name and line number within the procedure are recorded, and so on. The best time to call \fBTcl_AddErrorInfo\fR is just after a script evaluation routine has returned \fBTCL_ERROR\fR. -The value of the \fB-errorline\fR return option (retrieved +The value of the \fB\-errorline\fR return option (retrieved via a call to \fBTcl_GetReturnOptions\fR) often makes up a useful part of the \fImessage\fR passed to \fBTcl_AddErrorInfo\fR. .PP @@ -210,16 +210,16 @@ the need for a null byte. If the \fBTcl_AddObjErrorInfo\fR interface is used at all, it should be with a negative \fIlength\fR value. .PP The procedure \fBTcl_SetObjErrorCode\fR is used to set the -\fB-errorcode\fR return option to the list object \fIerrorObjPtr\fR +\fB\-errorcode\fR return option to the list object \fIerrorObjPtr\fR built up by the caller. \fBTcl_SetObjErrorCode\fR is typically invoked just before returning an error. If an error is returned without calling \fBTcl_SetObjErrorCode\fR or \fBTcl_SetErrorCode\fR the Tcl interpreter automatically sets -the \fB-errorcode\fR return option to \fBNONE\fR. +the \fB\-errorcode\fR return option to \fBNONE\fR. .PP The procedure \fBTcl_SetErrorCode\fR is also used to set the -\fB-errorcode\fR return option. However, it takes one or more strings to +\fB\-errorcode\fR return option. However, it takes one or more strings to record instead of an object. Otherwise, it is similar to \fBTcl_SetObjErrorCode\fR in behavior. .PP @@ -227,9 +227,9 @@ record instead of an object. Otherwise, it is similar to instead of taking a variable number of arguments it takes an argument list. .PP \fBTcl_PosixError\fR -sets the \fB-errorcode\fR variable after an error in a POSIX kernel call. +sets the \fB\-errorcode\fR variable after an error in a POSIX kernel call. It reads the value of the \fBerrno\fR C variable and calls -\fBTcl_SetErrorCode\fR to set the \fB-errorcode\fR return +\fBTcl_SetErrorCode\fR to set the \fB\-errorcode\fR return option in the \fBPOSIX\fR format. The caller must previously have called \fBTcl_SetErrno\fR to set \fBerrno\fR; this is necessary on some platforms (e.g. Windows) where Tcl @@ -240,14 +240,14 @@ occurs in a dynamically loaded extension. See the manual entry for \fBTcl_PosixError\fR returns a human-readable diagnostic message for the error (this is the same value that will appear as the third element -in the \fB-errorcode\fR value). +in the \fB\-errorcode\fR value). It may be convenient to include this string as part of the error message returned to the application in the interpreter's result. .PP \fBTcl_LogCommandInfo\fR is invoked after an error occurs in an interpreter. It adds information about the command that was being -executed when the error occurred to the \fB-errorinfo\fR value, and +executed when the error occurred to the \fB\-errorinfo\fR value, and the line number stored internally in the interpreter is set. .PP In older releases of Tcl, there was no \fBTcl_GetReturnOptions\fR @@ -269,7 +269,7 @@ setting \fBerrorInfo\fR or \fBerrorCode\fR directly with If the procedure \fBTcl_ResetResult\fR is called, it clears all of the state of the interpreter associated with script evaluation, including the entire return options dictionary. -In particular, the \fB-errorinfo\fR and \fB-errorcode\fR options +In particular, the \fB\-errorinfo\fR and \fB\-errorcode\fR options are reset. If an error had occurred, the \fBTcl_ResetResult\fR call will clear the error state to make it appear as if no error had diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 42c2cbd..31dbc5f 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.38 2007/10/28 14:17:38 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.39 2007/10/29 11:28:50 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -650,7 +650,7 @@ created. The function should do whatever channel type specific action is required to implement the new value of the option. .PP Some options are handled by the generic code and this function is never -called to set them, e.g. \fB-blockmode\fR. Other options are specific to +called to set them, e.g. \fB\-blockmode\fR. Other options are specific to each channel type and the \fIsetOptionProc\fR procedure of the channel driver will get called to implement them. The \fIsetOptionProc\fR field can be NULL, which indicates that this channel type supports no type specific @@ -699,7 +699,7 @@ function should also call \fBTcl_SetErrno\fR to store an appropriate POSIX error code. .PP Some options are handled by the generic code and this function is never -called to retrieve their value, e.g. \fB-blockmode\fR. Other options are +called to retrieve their value, e.g. \fB\-blockmode\fR. Other options are specific to each channel type and the \fIgetOptionProc\fR procedure of the channel driver will get called to implement them. The \fIgetOptionProc\fR field can be NULL, which indicates that this channel type supports no type diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index ebd4d8d..83e5e05 100644 --- a/doc/OpenFileChnl.3 +++ b/doc/OpenFileChnl.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: OpenFileChnl.3,v 1.33 2007/10/28 14:17:39 dkf Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.34 2007/10/29 11:28:50 dkf Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -425,7 +425,7 @@ that were stored in \fIreadObjPtr\fR. If an error occurs while reading, the return value is \-1 and \fBTcl_ReadChars\fR records a POSIX error code that can be retrieved with \fBTcl_GetErrno\fR. .PP -Setting \fIcharsToRead\fR to \fB-1\fR will cause the command to read +Setting \fIcharsToRead\fR to \fB\-1\fR will cause the command to read all characters currently available (non-blocking) or everything until eof (blocking mode). .PP diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3 index aac5cf7..c3a9aef 100644 --- a/doc/ParseCmd.3 +++ b/doc/ParseCmd.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: ParseCmd.3,v 1.25 2007/10/28 14:17:39 dkf Exp $ +'\" RCS: @(#) $Id: ParseCmd.3,v 1.26 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH Tcl_ParseCommand 3 8.3 Tcl "Tcl Library Procedures" @@ -159,7 +159,7 @@ returns \fBTCL_OK\fR and fills in the structure pointed to by \fIparsePtr\fR with information about the structure of the variable name (see below for details). If an error occurs while parsing the command then \fBTCL_ERROR\fR is returned, an -error message is left in \fIinterp\fR's result (if \fIinterp\fR isn't +error message is left in \fIinterp\fR's result (if \fIinterp\fR is not NULL), and no information is left at \fI*parsePtr\fR. .PP \fBTcl_ParseVar\fR parse a Tcl variable reference such as \fB$abc\fR @@ -364,7 +364,7 @@ can be used to determine the number of operands. A binary operator such as \fB*\fR is followed by two \fBTCL_TOKEN_SUB_EXPR\fR tokens that describe its operands. -A unary operator like \fB-\fR +A unary operator like \fB\-\fR is followed by a single \fBTCL_TOKEN_SUB_EXPR\fR token for its operand. If the operator is a math function such as \fBlog10\fR, diff --git a/doc/SaveResult.3 b/doc/SaveResult.3 index a8af63e..f769d1c 100644 --- a/doc/SaveResult.3 +++ b/doc/SaveResult.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: SaveResult.3,v 1.7 2005/05/10 18:33:57 kennykb Exp $ +'\" RCS: @(#) $Id: SaveResult.3,v 1.8 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH Tcl_SaveResult 3 8.1 Tcl "Tcl Library Procedures" @@ -62,8 +62,8 @@ These routines are passed a pointer to a \fBTcl_SavedResult\fR structure that is used to store enough information to restore the interpreter result. This structure can be allocated on the stack of the calling procedure. These routines do not save the state of any error -information in the interpreter (e.g. the \fB-errorcode\fR or -\fB-errorinfo\fR return options, when an error is in progress). +information in the interpreter (e.g. the \fB\-errorcode\fR or +\fB\-errorinfo\fR return options, when an error is in progress). .PP Because the routines \fBTcl_SaveInterpState\fR, \fBTcl_RestoreInterpState\fR, and \fBTcl_DiscardInterpState\fR perform @@ -77,7 +77,7 @@ of existing programs that may already be using them. interpreter state that make up the full result of script evaluation. This include the interpreter result, the return code (passed in as the \fIstatus\fR argument, and any return options, including -\fB-errorinfo\fR and \fB-errorcode\fR when an error is in progress. +\fB\-errorinfo\fR and \fB\-errorcode\fR when an error is in progress. This snapshot is returned as an opaque token of type \fBTcl_InterpState\fR. The call to \fBTcl_SaveInterpState\fR does not itself change the state of the interpreter. Unlike \fBTcl_SaveResult\fR, it does diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index cc8ffe3..6114d6f 100644 --- a/doc/Tcl_Main.3 +++ b/doc/Tcl_Main.3 @@ -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: Tcl_Main.3,v 1.14 2007/10/28 14:17:39 dkf Exp $ +'\" RCS: @(#) $Id: Tcl_Main.3,v 1.15 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH Tcl_Main 3 8.4 Tcl "Tcl Library Procedures" @@ -79,8 +79,8 @@ more information. .PP \fBTcl_Main\fR supports two modes of operation, depending on the values of \fIargc\fR and \fIargv\fR. If the first few arguments -in \fIargv\fR match ?\fB-encoding \fIname\fR? ?\fIfileName\fR?, -where \fIfileName\fR does not begin with the character \fI-\fR, +in \fIargv\fR match ?\fB\-encoding \fIname\fR? ?\fIfileName\fR?, +where \fIfileName\fR does not begin with the character \fI\-\fR, then \fIfileName\fR is taken to be the name of a file containing a \fIstartup script\fR, and \fIname\fR is taken to be the name of the encoding of the contents of that file, which \fBTcl_Main\fR diff --git a/doc/Thread.3 b/doc/Thread.3 index 6ed54b0..28aa635 100644 --- a/doc/Thread.3 +++ b/doc/Thread.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: Thread.3,v 1.25 2007/10/28 14:17:39 dkf Exp $
+'\" RCS: @(#) $Id: Thread.3,v 1.26 2007/10/29 11:28:50 dkf Exp $
'\"
.so man.macros
.TH Threads 3 "8.1" Tcl "Tcl Library Procedures"
@@ -82,7 +82,7 @@ waited upon into it. Beginning with the 8.1 release, the Tcl core is thread safe, which
allows you to incorporate Tcl into multithreaded applications without
customizing the Tcl core. To enable Tcl multithreading support,
-you must include the \fB--enable-threads\fR option to \fBconfigure\fR
+you must include the \fB\-\|\-enable-threads\fR option to \fBconfigure\fR
when you configure and compile your Tcl core.
.PP
An important constraint of the Tcl threads implementation is that
diff --git a/doc/array.n b/doc/array.n index 669f17e..275006e 100644 --- a/doc/array.n +++ b/doc/array.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: array.n,v 1.19 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: array.n,v 1.20 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH array n 8.3 Tcl "Tcl Built-In Commands" @@ -68,10 +68,10 @@ returned are those that exist both before and after the call to \fBarray names \fIarrayName\fR ?\fImode\fR? ?\fIpattern\fR? Returns a list containing the names of all of the elements in the array that match \fIpattern\fR. \fIMode\fR may be one of -\fB-exact\fR, \fB-glob\fR, or \fB-regexp\fR. If specified, \fImode\fR +\fB\-exact\fR, \fB\-glob\fR, or \fB\-regexp\fR. If specified, \fImode\fR designates which matching rules to use to match \fIpattern\fR against the names of the elements in the array. If not specified, \fImode\fR -defaults to \fB-glob\fR. See the documentation for \fBstring match\fR +defaults to \fB\-glob\fR. See the documentation for \fBstring match\fR for information on glob style matching, and the documentation for \fBregexp\fR for information on regexp matching. If \fIpattern\fR is omitted then the command returns all of diff --git a/doc/binary.n b/doc/binary.n index 62a7b87..0f33bfc 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.34 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: binary.n,v 1.35 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH binary n 8.0 Tcl "Tcl Built-In Commands" @@ -560,7 +560,7 @@ example, .CS \fBbinary scan\fR \ex05\ex00\ex07\ex00\exf0\exff s2s* var1 var2 .CE -will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB-16\fR +will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB\-16\fR stored in \fIvar2\fR. Note that the integers returned are signed, but they can be converted to unsigned 16-bit quantities using an expression like: @@ -576,7 +576,7 @@ order. For example, .CS \fBbinary scan\fR \ex00\ex05\ex00\ex07\exff\exf0 S2S* var1 var2 .CE -will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB-16\fR +will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB\-16\fR stored in \fIvar2\fR. .RE .IP \fBt\fR 5 @@ -599,7 +599,7 @@ example, set str \ex05\ex00\ex00\ex00\ex07\ex00\ex00\ex00\exf0\exff\exff\exff \fBbinary scan\fR $str i2i* var1 var2 .CE -will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB-16\fR +will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB\-16\fR stored in \fIvar2\fR. Note that the integers returned are signed, but they can be converted to unsigned 32-bit quantities using an expression like: @@ -616,7 +616,7 @@ order. For example, set str \ex00\ex00\ex00\ex05\ex00\ex00\ex00\ex07\exff\exff\exff\exf0 \fBbinary scan\fR $str I2I* var1 var2 .CE -will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB-16\fR +will return \fB2\fR with \fB5 7\fR stored in \fIvar1\fR and \fB\-16\fR stored in \fIvar2\fR. .RE .IP \fBn\fR 5 @@ -640,7 +640,7 @@ set str \ex05\ex00\ex00\ex00\ex07\ex00\ex00\ex00\exf0\exff\exff\exff \fBbinary scan\fR $str wi* var1 var2 .CE will return \fB2\fR with \fB30064771077\fR stored in \fIvar1\fR and -\fB-16\fR stored in \fIvar2\fR. Note that the integers returned are +\fB\-16\fR stored in \fIvar2\fR. Note that the integers returned are signed and cannot be represented by Tcl as unsigned values. .RE .IP \fBW\fR 5 @@ -652,7 +652,7 @@ order. For example, set str \ex00\ex00\ex00\ex05\ex00\ex00\ex00\ex07\exff\exff\exff\exf0 \fBbinary scan\fR $str WI* var1 var2 .CE -will return \fB2\fR with \fB21474836487\fR stored in \fIvar1\fR and \fB-16\fR +will return \fB2\fR with \fB21474836487\fR stored in \fIvar1\fR and \fB\-16\fR stored in \fIvar2\fR. .RE .IP \fBm\fR 5 diff --git a/doc/catch.n b/doc/catch.n index ddadd34..9592d4c 100644 --- a/doc/catch.n +++ b/doc/catch.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: catch.n,v 1.16 2007/10/28 14:17:40 dkf Exp $ +'\" RCS: @(#) $Id: catch.n,v 1.17 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH catch n "8.5" Tcl "Tcl Built-In Commands" @@ -48,28 +48,28 @@ stored in \fIresultVarName\fR is the value returned from \fIscript\fR. If the \fIoptionsVarName\fR argument is given, then the variable it names is set to a dictionary of return options returned by evaluation of \fIscript\fR. Tcl specifies two entries that are always -defined in the dictionary: \fB-code\fR and \fB-level\fR. When +defined in the dictionary: \fB\-code\fR and \fB\-level\fR. When the return code from evaluation of \fIscript\fR is not \fBTCL_RETURN\fR, -the value of the \fB-level\fR entry will be 0, and the value -of the \fB-code\fR entry will be the same as the return code. +the value of the \fB\-level\fR entry will be 0, and the value +of the \fB\-code\fR entry will be the same as the return code. Only when the return code is \fBTCL_RETURN\fR will the values of -the \fB-level\fR and \fB-code\fR entries be something else, as +the \fB\-level\fR and \fB\-code\fR entries be something else, as further described in the documentation for the \fBreturn\fR command. .PP When the return code from evaluation of \fIscript\fR is \fBTCL_ERROR\fR, three additional entries are defined in the dictionary of return options -stored in \fIoptionsVarName\fR: \fB-errorinfo\fR, \fB-errorcode\fR, -and \fB-errorline\fR. The value of the \fB-errorinfo\fR entry +stored in \fIoptionsVarName\fR: \fB\-errorinfo\fR, \fB\-errorcode\fR, +and \fB\-errorline\fR. The value of the \fB\-errorinfo\fR entry is a formatted stack trace containing more information about the context in which the error happened. The formatted stack trace is meant to be read by a person. The value of -the \fB-errorcode\fR entry is additional information about the -error stored as a list. The \fB-errorcode\fR value is meant to +the \fB\-errorcode\fR entry is additional information about the +error stored as a list. The \fB\-errorcode\fR value is meant to be further processed by programs, and may not be particularly -readable by people. The value of the \fB-errorline\fR entry +readable by people. The value of the \fB\-errorline\fR entry is an integer indicating which line of \fIscript\fR was being -evaluated when the error occurred. The values of the \fB-errorinfo\fR -and \fB-errorcode\fR entries of the most recent error are also +evaluated when the error occurred. The values of the \fB\-errorinfo\fR +and \fB\-errorcode\fR entries of the most recent error are also available as values of the global variables \fB::errorInfo\fR and \fB::errorCode\fR respectively. .PP @@ -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: dde.n,v 1.21 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: dde.n,v 1.22 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH dde n 1.3 dde "Tcl Bundled Packages" @@ -17,7 +17,7 @@ dde \- Execute a Dynamic Data Exchange command .sp \fBpackage require dde 1.3\fR .sp -\fBdde servername\fR ?\fB-force\fR? ?\fB-handler \fIproc\fR? ?\fB--\fR? ?\fItopic\fR? +\fBdde servername\fR ?\fB\-force\fR? ?\fB\-handler \fIproc\fR? ?\fB\-\|\-\fR? ?\fItopic\fR? .sp \fBdde execute\fR ?\fB\-async\fR? \fIservice topic data\fR .sp @@ -47,7 +47,7 @@ has the service name \fBExcel\fR. The following commands are a subset of the full Dynamic Data Exchange set of commands. .TP -\fBdde servername \fR?\fB-force\fR? ?\fB-handler \fIproc\fR? ?\fB--\fR? ?\fItopic\fR? +\fBdde servername \fR?\fB\-force\fR? ?\fB\-handler \fIproc\fR? ?\fB\-\|\-\fR? ?\fItopic\fR? \fBdde servername\fR registers the interpreter as a DDE server with the service name \fBTclEval\fR and the topic name specified by \fItopic\fR. If no \fItopic\fR is given, \fBdde servername\fR returns the name @@ -59,12 +59,12 @@ or .QW " #3" is appended to the name to make it unique. The command's result will be the name actually used. The -\fB-force\fR option is used to force registration of precisely the +\fB\-force\fR option is used to force registration of precisely the given \fItopic\fR name. .IP -The \fB-handler\fR option specifies a Tcl procedure that will be called to +The \fB\-handler\fR option specifies a Tcl procedure that will be called to process calls to the dde server. If the package has been loaded into a -safe interpreter then a \fB-handler\fR procedure must be defined. The +safe interpreter then a \fB\-handler\fR procedure must be defined. The procedure is called with all the arguments provided by the remote call. .TP diff --git a/doc/error.n b/doc/error.n index 20bdbfe..d7ef30c 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.9 2005/05/10 18:33:59 kennykb Exp $ +'\" RCS: @(#) $Id: error.n,v 1.10 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH error n "" Tcl "Tcl Built-In Commands" @@ -23,12 +23,12 @@ Returns a \fBTCL_ERROR\fR code, which causes command interpretation to be unwound. \fIMessage\fR is a string that is returned to the application to indicate what went wrong. .PP -The \fB-errorinfo\fR return option of an interpreter is used +The \fB\-errorinfo\fR return option of an interpreter is used to accumulate a stack trace of what was in progress when an error occurred; as nested commands unwind, -the Tcl interpreter adds information to the \fB-errorinfo\fR +the Tcl interpreter adds information to the \fB\-errorinfo\fR return option. If the \fIinfo\fR argument is present, it is -used to initialize the \fB-errorinfo\fR return options and +used to initialize the \fB\-errorinfo\fR return options and the first increment of unwind information will not be added by the Tcl interpreter. In other @@ -54,7 +54,7 @@ return -options $options $errMsg\fR .CE .PP If the \fIcode\fR argument is present, then its value is stored -in the \fB-errorcode\fR return option. The \fB-errorcode\fR +in the \fB\-errorcode\fR return option. The \fB\-errorcode\fR return option is intended to hold a machine-readable description of the error in cases where such information is available; see the \fBreturn\fR manual page for information on the proper format @@ -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: exec.n,v 1.20 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: exec.n,v 1.21 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH exec n 8.5 Tcl "Tcl Built-In Commands" @@ -145,7 +145,7 @@ If any of the commands in the pipeline exit abnormally or are killed or suspended, then \fBexec\fR will return an error and the error message will include the pipeline's output followed by error messages describing the abnormal terminations; the -\fB-errorcode\fR return option will contain additional information +\fB\-errorcode\fR return option will contain additional information about the last abnormal termination encountered. If any of the commands writes to its standard error file and that standard error is not redirected @@ -366,7 +366,7 @@ To execute a simple program and get its result: .PP To execute a program that can return a non-zero result, you should wrap the call to \fBexec\fR in \fBcatch\fR and check the contents -of the \fB-errorcode\fR return option if you have an error: +of the \fB\-errorcode\fR return option if you have an error: .CS set status 0 if {[catch {\fBexec\fR grep foo bar.txt} results options]} { @@ -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: expr.n,v 1.28 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: expr.n,v 1.29 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH expr n 8.5 Tcl "Tcl Built-In Commands" @@ -57,7 +57,7 @@ above, then it is treated as a floating-point number if that is possible. Floating-point numbers may be specified in any of several common formats making use of the decimal digits, the decimal point \fB.\fR, the characters \fBe\fR or \fBE\fR indicating scientific notation, and -the sign characters \fB+\fR or \fB-\fR. For example, all of the +the sign characters \fB+\fR or \fB\-\fR. For example, all of the following are valid floating-point numbers: 2.1, 3., 6e4, 7.91e+16. Also recognized as floating point values are the strings \fBInf\fR and \fBNaN\fR making use of any case for each character. @@ -256,7 +256,7 @@ All internal computations involving floating-point are done with the C type \fIdouble\fR. When converting a string to floating-point, exponent overflow is detected and results in the \fIdouble\fR value of \fBInf\fR or -\fB-Inf\fR as appropriate. Floating-point overflow and underflow +\fB\-Inf\fR as appropriate. Floating-point overflow and underflow are detected to the degree supported by the hardware, which is generally pretty reliable. .PP @@ -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: file.n,v 1.48 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: file.n,v 1.49 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH file n 8.3 Tcl "Tcl Built-In Commands" @@ -47,11 +47,11 @@ flags and their values. The second form returns the value for the specific option. The third form sets one or more of the values. The values are as follows: .PP -On Unix, \fB-group\fR gets or sets the group name for the file. A group id -can be given to the command, but it returns a group name. \fB-owner\fR gets +On Unix, \fB\-group\fR gets or sets the group name for the file. A group id +can be given to the command, but it returns a group name. \fB\-owner\fR gets or sets the user name of the owner of the file. The command returns the owner name, but the numerical id can be passed when setting the -owner. \fB-permissions\fR sets or retrieves the octal code that chmod(1) +owner. \fB\-permissions\fR sets or retrieves the octal code that chmod(1) uses. This command does also has limited support for setting using the symbolic attributes for chmod(1), of the form [ugo]?[[+\-=][rwxst],[...]], where multiple symbolic attributes can be separated by commas (example: @@ -59,24 +59,24 @@ where multiple symbolic attributes can be separated by commas (example: permissions for group and other). A simplified \fBls\fR style string, of the form rwxrwxrwx (must be 9 characters), is also supported (example: \fBrwxr\-xr\-t\fR is equivalent to 01755). -On versions of Unix supporting file flags, \fB-readonly\fR gives the +On versions of Unix supporting file flags, \fB\-readonly\fR gives the value or sets or clears the readonly attribute of the file, i.e. the user immutable flag \fBuchg\fR to chflags(1). .PP -On Windows, \fB-archive\fR gives the value or sets or clears the -archive attribute of the file. \fB-hidden\fR gives the value or sets -or clears the hidden attribute of the file. \fB-longname\fR will -expand each path element to its long version. This attribute cannot be -set. \fB-readonly\fR gives the value or sets or clears the readonly -attribute of the file. \fB-shortname\fR gives a string where every -path element is replaced with its short (8.3) version of the -name. This attribute cannot be set. \fB-system\fR gives or sets or -clears the value of the system attribute of the file. +On Windows, \fB\-archive\fR gives the value or sets or clears the +archive attribute of the file. \fB\-hidden\fR gives the value or sets +or clears the hidden attribute of the file. \fB\-readonly\fR gives the +value or sets or clears the readonly attribute of the file. +\fB\-system\fR gives or sets or clears the value of the system +attribute of the file. \fB\-longname\fR will expand each path element +to its long version. \fB\-shortname\fR gives a string where every +path element is replaced with its short (8.3) version of the name. The +\fB\-longname\fR and \fB\-shortname\fR attributes cannot be set. .PP -On Mac OS X and Darwin, \fB-creator\fR gives or sets the -Finder creator type of the file. \fB-hidden\fR gives or sets or clears -the hidden attribute of the file. \fB-readonly\fR gives or sets or -clears the readonly attribute of the file. \fB-rsrclength\fR gives +On Mac OS X and Darwin, \fB\-creator\fR gives or sets the +Finder creator type of the file. \fB\-hidden\fR gives or sets or clears +the hidden attribute of the file. \fB\-readonly\fR gives or sets or +clears the readonly attribute of the file. \fB\-rsrclength\fR gives the length of the resource fork of the file, this attribute can only be set to the value 0, which results in the resource fork being stripped off the file. @@ -199,7 +199,7 @@ is always canonical for the current platform: \fB/\fR for Unix and Windows. .RE .TP -\fBfile link ?\fI-linktype\fR? \fIlinkName\fR ?\fItarget\fR? +\fBfile link ?\fI\-linktype\fR? \fIlinkName\fR ?\fItarget\fR? . If only one argument is given, that argument is assumed to be \fIlinkName\fR, and this command returns the value of the link given by @@ -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: http.n,v 1.29 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: http.n,v 1.30 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH "http" n 2.5 http "Tcl Bundled Packages" @@ -63,9 +63,9 @@ is performed. The return value of \fB::http::geturl\fR is a token for the transaction. The value is also the name of an array in the ::http namespace that contains state information about the transaction. The elements -of this array are described in the STATE ARRAY section. +of this array are described in the \fBSTATE ARRAY\fR section. .PP -If the \fB-command\fR option is specified, then +If the \fB\-command\fR option is specified, then the HTTP operation is done in the background. \fB::http::geturl\fR returns immediately after generating the HTTP request and the callback is invoked @@ -130,7 +130,8 @@ The \fB\-query\fR option causes a POST operation and the \fB\-validate\fR option causes a HEAD operation; otherwise, a GET operation is performed. The \fB::http::geturl\fR command returns a \fItoken\fR value that can be used to get -information about the transaction. See the STATE ARRAY and ERRORS section for +information about the transaction. See the \fBSTATE ARRAY\fR and +\fBERRORS\fR section for details. The \fB::http::geturl\fR command blocks until the operation completes, unless the \fB\-command\fR option specifies a callback that is invoked when the HTTP transaction completes. @@ -157,7 +158,7 @@ Invoke \fIcallback\fR after the HTTP transaction completes. This option causes \fB::http::geturl\fR to return immediately. The \fIcallback\fR gets an additional argument that is the \fItoken\fR returned from \fB::http::geturl\fR. This token is the name of an array that is -described in the STATE ARRAY section. Here is a template for the +described in the \fBSTATE ARRAY\fR section. Here is a template for the callback: .RS .CS @@ -172,9 +173,10 @@ proc httpCallback {token} { Invoke \fIcallback\fR whenever HTTP data is available; if present, nothing else will be done with the HTTP data. This procedure gets two additional arguments: the socket for the HTTP data and the \fItoken\fR returned from -\fB::http::geturl\fR. The token is the name of a global array that is described -in the STATE ARRAY section. The procedure is expected to return the number -of bytes read from the socket. Here is a template for the callback: +\fB::http::geturl\fR. The token is the name of a global array that is +described in the \fBSTATE ARRAY\fR section. The procedure is expected +to return the number of bytes read from the socket. Here is a +template for the callback: .RS .CS proc httpHandlerCallback {socket token} { @@ -251,7 +253,7 @@ callback format is the same). If \fImilliseconds\fR is non-zero, then \fB::http::geturl\fR sets up a timeout to occur after the specified number of milliseconds. A timeout results in a call to \fB::http::reset\fR and to -the \fB-command\fR callback, if specified. +the \fB\-command\fR callback, if specified. The return value of \fB::http::status\fR is \fBtimeout\fR after a timeout has occurred. .TP @@ -264,8 +266,8 @@ POST operation. If \fIboolean\fR is non-zero, then \fB::http::geturl\fR does an HTTP HEAD request. This request returns meta information about the URL, but the contents are not returned. The meta information is available in the -\fBstate(meta) \fR variable after the transaction. See the STATE -ARRAY section for details. +\fBstate(meta) \fR variable after the transaction. See the +\fBSTATE ARRAY\fR section for details. .RE .TP \fB::http::formatQuery\fR \fIkey value\fR ?\fIkey value\fR ...? @@ -283,7 +285,7 @@ any. This sets the \fBstate(status)\fR value to \fIwhy\fR, which defaults to \f This is a convenience procedure that blocks and waits for the transaction to complete. This only works in trusted code because it uses \fBvwait\fR. Also, it is not useful for the case where -\fB::http::geturl\fR is called \fIwithout\fR the \fB-command\fR option +\fB::http::geturl\fR is called \fIwithout\fR the \fB\-command\fR option because in this case the \fB::http::geturl\fR call does not return until the HTTP transaction is complete, and thus there is nothing to wait for. @@ -351,7 +353,7 @@ These errors mean that it cannot even start the network transaction. It will also raise an error if it gets an I/O error while writing out the HTTP request header. -For synchronous \fB::http::geturl\fR calls (where \fB-command\fR is +For synchronous \fB::http::geturl\fR calls (where \fB\-command\fR is not specified), it will raise an error if it gets an I/O error while reading the HTTP reply headers or data. Because \fB::http::geturl\fR does not return a token in these cases, it does all the required diff --git a/doc/interp.n b/doc/interp.n index 3a48cfd..93ef1c8 100644 --- a/doc/interp.n +++ b/doc/interp.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: interp.n,v 1.32 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: interp.n,v 1.33 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH interp n 7.6 Tcl "Tcl Built-In Commands" @@ -180,8 +180,8 @@ This command concatenates all of the \fIarg\fR arguments in the same fashion as the \fBconcat\fR command, then evaluates the resulting string as a Tcl script in the slave interpreter identified by \fIpath\fR. The result of this evaluation (including all \fBreturn\fR options, -such as \fB-errorinfo\fR and \fB-errorcode\fR information, if an error occurs) -is returned to the invoking interpreter. +such as \fB\-errorinfo\fR and \fB\-errorcode\fR information, if an +error occurs) is returned to the invoking interpreter. Note that the script will be executed in the current context stack frame of the \fIpath\fR interpreter; this is so that the implementations (in a master interpreter) of aliases in a slave interpreter can execute scripts in @@ -222,18 +222,18 @@ Hidden commands are explained in more detail in \fBHIDDEN COMMANDS\fR, below. Returns a list of the names of all hidden commands in the interpreter identified by \fIpath\fR. .TP -\fBinterp\fR \fBinvokehidden\fR \fIpath\fR ?\fB-namespace\fR \fInamespace\fR? ?\fB-global\fR? ?\fB\-\|\-\fR? \fIhiddenCmdName\fR ?\fIarg ...\fR? +\fBinterp\fR \fBinvokehidden\fR \fIpath\fR ?\fB\-namespace\fR \fInamespace\fR? ?\fB\-global\fR? ?\fB\-\|\-\fR? \fIhiddenCmdName\fR ?\fIarg ...\fR? Invokes the hidden command \fIhiddenCmdName\fR with the arguments supplied in the interpreter denoted by \fIpath\fR. No substitutions or evaluation are applied to the arguments. -If the \fB-namespace\fR flag is present, the hidden command is invoked in +If the \fB\-namespace\fR flag is present, the hidden command is invoked in the specified namespace in the target interpreter. -If the \fB-global\fR flag is present, the hidden command is invoked at the +If the \fB\-global\fR flag is present, the hidden command is invoked at the global level in the target interpreter; otherwise it is invoked at the current call frame and can access local variables in that and outer call frames. -If both the \fB-namespace\fR and \fB-global\fR flags are present, the -\fB-namespace\fR flag is ignored. +If both the \fB\-namespace\fR and \fB\-global\fR flags are present, the +\fB\-namespace\fR flag is ignored. Note that the hidden command will be executed (by default) in the current context stack frame of the \fIpath\fR interpreter. Hidden commands are explained in more detail in \fBHIDDEN COMMANDS\fR, below. @@ -364,8 +364,8 @@ This command concatenates all of the \fIarg\fR arguments in the same fashion as the \fBconcat\fR command, then evaluates the resulting string as a Tcl script in \fIslave\fR. The result of this evaluation (including all \fBreturn\fR options, -such as \fB-errorinfo\fR and \fB-errorcode\fR information, if an error occurs) -is returned to the invoking interpreter. +such as \fB\-errorinfo\fR and \fB\-errorcode\fR information, if an +error occurs) is returned to the invoking interpreter. Note that the script will be executed in the current context stack frame of \fIslave\fR; this is so that the implementations (in a master interpreter) of aliases in a slave interpreter can execute scripts in @@ -398,17 +398,17 @@ For more details on hidden commands, see \fBHIDDEN COMMANDS\fR, below. \fIslave \fBhidden\fR Returns a list of the names of all hidden commands in \fIslave\fR. .TP -\fIslave \fBinvokehidden\fR ?\fB-namespace\fR \fInamespace\fR? ?\fB-global\fR ?\fB\-\|\-\fR? \fIhiddenName \fR?\fIarg ..\fR? +\fIslave \fBinvokehidden\fR ?\fB\-namespace\fR \fInamespace\fR? ?\fB\-global\fR ?\fB\-\|\-\fR? \fIhiddenName \fR?\fIarg ..\fR? This command invokes the hidden command \fIhiddenName\fR with the supplied arguments, in \fIslave\fR. No substitutions or evaluations are applied to the arguments. -If the \fB-namespace\fR flag is given, the hidden command is invoked in +If the \fB\-namespace\fR flag is given, the hidden command is invoked in the specified namespace in the slave. -If the \fB-global\fR flag is given, the command is invoked at the global +If the \fB\-global\fR flag is given, the command is invoked at the global level in the slave; otherwise it is invoked at the current call frame and can access local variables in that or outer call frames. -If both the \fB-namespace\fR and \fB-global\fR flags are given, the -\fB-namespace\fR flag is ignored. +If both the \fB\-namespace\fR and \fB\-global\fR flags are given, the +\fB\-namespace\fR flag is ignored. Note that the hidden command will be executed (by default) in the current context stack frame of \fIslave\fR. For more details on hidden commands, diff --git a/doc/lsearch.n b/doc/lsearch.n index 0ee3697..897a207 100644 --- a/doc/lsearch.n +++ b/doc/lsearch.n @@ -7,7 +7,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lsearch.n,v 1.30 2007/10/29 01:42:18 dkf Exp $ +'\" RCS: @(#) $Id: lsearch.n,v 1.31 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH lsearch n 8.5 Tcl "Tcl Built-In Commands" @@ -52,7 +52,7 @@ The list elements are in sorted order. If this option is specified, \fIlist\fR. If no other options are specified, \fIlist\fR is assumed to be sorted in increasing order, and to contain ASCII strings. This option is mutually exclusive with \fB\-glob\fR and \fB\-regexp\fR, and -is treated exactly like \fB-exact\fR when either \fB\-all\fR or +is treated exactly like \fB\-exact\fR when either \fB\-all\fR or \fB\-not\fR are specified. .SS "GENERAL MODIFIER OPTIONS" These options may be given with all matching styles. diff --git a/doc/lsort.n b/doc/lsort.n index 2567c55..0cf4fb5 100644 --- a/doc/lsort.n +++ b/doc/lsort.n @@ -7,7 +7,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.26 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: lsort.n,v 1.27 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH lsort n 8.5 Tcl "Tcl Built-In Commands" @@ -124,7 +124,7 @@ effect if combined with the \fB\-dictionary\fR, \fB\-integer\fR, or If this option is specified, then only the last set of duplicate elements found in the list will be retained. Note that duplicates are 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 +\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. .SH "NOTES" diff --git a/doc/mathfunc.n b/doc/mathfunc.n index 53b3747..6fe9162 100644 --- a/doc/mathfunc.n +++ b/doc/mathfunc.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: mathfunc.n,v 1.15 2007/10/26 20:11:53 dgp Exp $ +'\" RCS: @(#) $Id: mathfunc.n,v 1.16 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH mathfunc n 8.5 Tcl "Tcl Mathematical Functions" @@ -114,18 +114,18 @@ integer or floating-point, and the result is returned in the same form. .TP \fBacos(\fIarg\fB)\fR Returns the arc cosine of \fIarg\fR, in the range [\fI0\fR,\fIpi\fR] -radians. \fIArg\fR should be in the range [\fI-1\fR,\fI1\fR]. +radians. \fIArg\fR should be in the range [\fI\-1\fR,\fI1\fR]. .TP \fBasin(\fIarg\fB)\fR -Returns the arc sine of \fIarg\fR, in the range [\fI-pi/2\fR,\fIpi/2\fR] -radians. \fIArg\fR should be in the range [\fI-1\fR,\fI1\fR]. +Returns the arc sine of \fIarg\fR, in the range [\fI\-pi/2\fR,\fIpi/2\fR] +radians. \fIArg\fR should be in the range [\fI\-1\fR,\fI1\fR]. .TP \fBatan(\fIarg\fB)\fR -Returns the arc tangent of \fIarg\fR, in the range [\fI-pi/2\fR,\fIpi/2\fR] +Returns the arc tangent of \fIarg\fR, in the range [\fI\-pi/2\fR,\fIpi/2\fR] radians. .TP \fBatan2(\fIy, x\fB)\fR -Returns the arc tangent of \fIy\fR/\fIx\fR, in the range [\fI-pi\fR,\fIpi\fR] +Returns the arc tangent of \fIy\fR/\fIx\fR, in the range [\fI\-pi\fR,\fIpi\fR] radians. \fIx\fR and \fIy\fR cannot both be 0. If \fIx\fR is greater than \fI0\fR, this is equivalent to \fBatan(\fIy/x\fB)\fR. .TP @@ -152,7 +152,7 @@ an overflow, an error is returned. The argument may be any numeric value, If \fIarg\fR is a floating-point value, returns \fIarg\fR, otherwise converts \fIarg\fR to floating-point and returns the converted value. May return -\fBInf\fR or \fB-Inf\fR when the argument is a numeric value that exceeds +\fBInf\fR or \fB\-Inf\fR when the argument is a numeric value that exceeds the floating-point range. .TP \fBentier(\fIarg\fB)\fR diff --git a/doc/msgcat.n b/doc/msgcat.n index a00de1d..72101d7 100644 --- a/doc/msgcat.n +++ b/doc/msgcat.n @@ -261,7 +261,9 @@ en_gb.msg \(em United Kingdom English .VS 1.4 \fIException:\fR The message file for the root locale .MT -is called \fBROOT.msg\fR. This exception is made so as not to +is called +.QW \fBROOT.msg\fR . +This exception is made so as not to cause peculiar behavior, such as marking the message file as .QW hidden on Unix file systems. @@ -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.31 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: open.n,v 1.32 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH open n 8.3 Tcl "Tcl Built-In Commands" @@ -65,7 +65,7 @@ Set the initial access position to the end of the file. All of the legal \fIaccess\fR values above may have the character \fBb\fR added as the second or third character in the value to indicate that the opened channel should be configured with the -\fB-translation binary\fR option, making the channel suitable for +\fB\-translation binary\fR option, making the channel suitable for reading or writing of binary data. .VE 8.5 .PP @@ -87,7 +87,7 @@ Set the file pointer to the end of the file prior to each write. .VS 8.5 .TP 15 \fBBINARY\fR -Configure the opened channel with the \fB-translation binary\fR option. +Configure the opened channel with the \fB\-translation binary\fR option. .VE 8.5 .TP 15 \fBCREAT\fR @@ -182,14 +182,14 @@ If \fItype\fR is \fBnone\fR then any handshake is switched off. \fBrtscts\fR activates hardware handshake. Hardware handshake signals are described below. For software handshake \fBxonxoff\fR the handshake characters can be redefined -with \fB-xchar\fR. +with \fB\-xchar\fR. An additional hardware handshake \fBdtrdsr\fR is available only under Windows. There is no default handshake configuration, the initial value depends on your operating system settings. -The \fB-handshake\fR option cannot be queried. +The \fB\-handshake\fR option cannot be queried. .TP \fB\-queue\fR -(Windows and Unix). The \fB-queue\fR option can only be queried. +(Windows and Unix). The \fB\-queue\fR option can only be queried. It returns a list of two integers representing the current number of bytes in the input and output queue respectively. .TP @@ -198,7 +198,7 @@ of bytes in the input and output queue respectively. read operations. It specifies the maximum interval between the reception of two bytes in milliseconds. For Unix systems the granularity is 100 milliseconds. -The \fB-timeout\fR option does not affect write operations or +The \fB\-timeout\fR option does not affect write operations or nonblocking reads. This option cannot be queried. .TP @@ -215,7 +215,7 @@ The result is unpredictable. The \fB\-ttycontrol\fR option cannot be queried. .TP \fB\-ttystatus\fR -(Windows and Unix). The \fB-ttystatus\fR option can only be +(Windows and Unix). The \fB\-ttystatus\fR option can only be queried. It returns the current modem status and handshake input signals (see below). The result is a list of signal,value pairs with a fixed order, @@ -402,8 +402,8 @@ same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input, but is redirected from a file, then the above problem does not occur. .LP -See the PORTABILITY ISSUES section of the \fBexec\fR command for additional -information not specific to command pipelines about executing +See the \fBPORTABILITY ISSUES\fR section of the \fBexec\fR command for +additional information not specific to command pipelines about executing applications on the various platforms .SH "EXAMPLE" Open a command pipeline and catch any errors: diff --git a/doc/regexp.n b/doc/regexp.n index f7baefa..5523ce6 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.25 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: regexp.n,v 1.26 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH regexp n 8.3 Tcl "Tcl Built-In Commands" @@ -21,7 +21,7 @@ regexp \- Match a regular expression against a string .PP Determines whether the regular expression \fIexp\fR matches part or all of \fIstring\fR and returns 1 if it does, 0 if it does not, unless -\fB-inline\fR is specified (see below). +\fB\-inline\fR is specified (see below). (Regular expression matching is described in the \fBre_syntax\fR reference page.) .LP @@ -109,8 +109,8 @@ the last match only. .TP 15 \fB\-inline\fR Causes the command to return, as a list, the data that would otherwise -be placed in match variables. When using \fB-inline\fR, -match variables may not be specified. If used with \fB-all\fR, the +be placed in match variables. When using \fB\-inline\fR, +match variables may not be specified. If used with \fB\-all\fR, the list will be concatenated at each iteration, such that a flat list is always returned. For each match iteration, the command will append the overall match data, plus one element for each subexpression in the diff --git a/doc/registry.n b/doc/registry.n index f66b369..c66860c 100644 --- a/doc/registry.n +++ b/doc/registry.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: registry.n,v 1.19 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: registry.n,v 1.20 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH registry n 1.1 registry "Tcl Bundled Packages" @@ -19,7 +19,6 @@ registry \- Manipulate the Windows registry .sp \fBregistry \fIoption\fR \fIkeyName\fR ?\fIarg arg ...\fR? .BE - .SH DESCRIPTION .PP The \fBregistry\fR package provides a general set of operations for @@ -49,7 +48,7 @@ registry key names separated by backslash (\fB\e\fR) characters. unique abbreviation for \fIoption\fR is acceptable. The valid options are: .TP -\fBregistry broadcast \fIkeyName\fR ?\fI-timeout milliseconds\fR? +\fBregistry broadcast \fIkeyName\fR ?\fB\-timeout \fImilliseconds\fR? . Sends a broadcast message to the system and running programs to notify them of certain updates. This is necessary to propagate changes to key registry @@ -89,7 +88,7 @@ did not exist, the command has no effect. Returns the data associated with the value \fIvalueName\fR under the key \fIkeyName\fR. If either the key or the value does not exist, then an error is generated. For more details on the format of the returned -data, see SUPPORTED TYPES, below. +data, see \fBSUPPORTED TYPES\fR, below. .TP \fBregistry keys \fIkeyName\fR ?\fIpattern\fR? . @@ -107,13 +106,13 @@ the key \fIkeyName\fR and value \fIvalueName\fR if necessary. The contents of \fIvalueName\fR are set to \fIdata\fR with the type indicated by \fItype\fR. If \fItype\fR is not specified, the type \fBsz\fR is assumed. For more details on the data and type arguments, -see SUPPORTED TYPES below. +see \fBSUPPORTED TYPES\fR below. .TP \fBregistry type \fIkeyName valueName\fR . Returns the type of the value \fIvalueName\fR in the key \fIkeyName\fR. For more information on the possible types, see -SUPPORTED TYPES, below. +\fBSUPPORTED TYPES\fR, below. .TP \fBregistry values \fIkeyName\fR ?\fIpattern\fR? . diff --git a/doc/return.n b/doc/return.n index efa5c0c..6e6ba03 100644 --- a/doc/return.n +++ b/doc/return.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: return.n,v 1.16 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: return.n,v 1.17 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH return n 8.5 Tcl "Tcl Built-In Commands" @@ -17,7 +17,7 @@ return \- Return from a procedure, or set return code of a script .SH SYNOPSIS \fBreturn \fR?\fIresult\fR? .sp -\fBreturn \fR?\fB-code \fIcode\fR? ?\fIresult\fR? +\fBreturn \fR?\fB\-code \fIcode\fR? ?\fIresult\fR? .sp \fBreturn \fR?\fIoption value \fR...? ?\fIresult\fR? .BE @@ -40,7 +40,7 @@ will be returned as the result of the \fBsource\fR command. .PP In addition to the result of a procedure, the return code of a procedure may also be set by \fBreturn\fR -through use of the \fB-code\fR option. +through use of the \fB\-code\fR option. In the usual case where the \fB\-code\fR option is not specified the procedure will return normally. However, the \fB\-code\fR option may be used to generate an @@ -95,56 +95,57 @@ in Tcl also produces a dictionary of return options. In general usage, all \fIoption value\fR pairs given as arguments to \fBreturn\fR become entries in the return options dictionary, and any values at all are acceptable except as noted below. The \fBcatch\fR command may be -used to capture all of this information -- the return code, the result, -and the return options dictionary -- that arise from evaluation of a script. +used to capture all of this information \(em the return code, the result, +and the return options dictionary \(em that arise from evaluation of a +script. .VE 8.5 .PP -As documented above, the \fB-code\fR entry in the return options dictionary +As documented above, the \fB\-code\fR entry in the return options dictionary receives special treatment by Tcl. There are other return options also recognized and treated specially by Tcl. They are: .TP -\fB-errorcode \fIlist\fR -The \fB-errorcode\fR option receives special treatment only when the value -of the \fB-code\fR option is \fBTCL_ERROR\fR. Then the \fIlist\fR value +\fB\-errorcode \fIlist\fR +The \fB\-errorcode\fR option receives special treatment only when the value +of the \fB\-code\fR option is \fBTCL_ERROR\fR. Then the \fIlist\fR value is meant to be additional information about the error, presented as a Tcl list for further processing by programs. -If no \fB-errorcode\fR option is provided to \fBreturn\fR when -the \fB-code error\fR option is provided, Tcl will set the value -of the \fB-errorcode\fR entry in the return options dictionary -to the default value of \fBNONE\fR. The \fB-errorcode\fR return +If no \fB\-errorcode\fR option is provided to \fBreturn\fR when +the \fB\-code error\fR option is provided, Tcl will set the value +of the \fB\-errorcode\fR entry in the return options dictionary +to the default value of \fBNONE\fR. The \fB\-errorcode\fR return option will also be stored in the global variable \fBerrorCode\fR. .TP -\fB-errorinfo \fIinfo\fR -The \fB-errorinfo\fR option receives special treatment only when the value -of the \fB-code\fR option is \fBTCL_ERROR\fR. Then \fIinfo\fR is the initial +\fB\-errorinfo \fIinfo\fR +The \fB\-errorinfo\fR option receives special treatment only when the value +of the \fB\-code\fR option is \fBTCL_ERROR\fR. Then \fIinfo\fR is the initial stack trace, meant to provide to a human reader additional information about the context in which the error occurred. The stack trace will also be stored in the global variable \fBerrorInfo\fR. -If no \fB-errorinfo\fR option is provided to \fBreturn\fR when -the \fB-code error\fR option is provided, Tcl will provide its own -initial stack trace value in the entry for \fB-errorinfo\fR. Tcl's +If no \fB\-errorinfo\fR option is provided to \fBreturn\fR when +the \fB\-code error\fR option is provided, Tcl will provide its own +initial stack trace value in the entry for \fB\-errorinfo\fR. Tcl's initial stack trace will include only the call to the procedure, and stack unwinding will append information about higher stack levels, but there will be no information about the context of the error within the procedure. Typically the \fIinfo\fR value is supplied from -the value of \fB-errorinfo\fR in a return options dictionary captured +the value of \fB\-errorinfo\fR in a return options dictionary captured by the \fBcatch\fR command (or from the copy of that information stored in the global variable \fBerrorInfo\fR). .TP -\fB-level \fIlevel\fR +\fB\-level \fIlevel\fR .VS 8.5 -The \fB-level\fR and \fB-code\fR options work together to set the return +The \fB\-level\fR and \fB\-code\fR options work together to set the return code to be returned by one of the commands currently being evaluated. The \fIlevel\fR value must be a non-negative integer representing a number of levels on the call stack. It defines the number of levels up the stack at which the return code of a command currently being evaluated should -be \fIcode\fR. If no \fB-level\fR option is provided, the default value +be \fIcode\fR. If no \fB\-level\fR option is provided, the default value of \fIlevel\fR is 1, so that \fBreturn\fR sets the return code that the current procedure returns to its caller, 1 level up the call stack. The mechanism by which these options work is described in more detail below. .VE 8.5 .TP -\fB-options \fIoptions\fR +\fB\-options \fIoptions\fR .VS 8.5 The value \fIoptions\fR must be a valid dictionary. The entries of that dictionary are treated as additional \fIoption value\fR pairs for the @@ -179,16 +180,16 @@ their documented interpretation in loops. Procedure invocation also involves evaluation of a script, the body of the procedure. Procedure invocation provides special treatment when evaluation of the procedure body returns the return code -\fBTCL_RETURN\fR. In that circumstance, the \fB-level\fR entry in the +\fBTCL_RETURN\fR. In that circumstance, the \fB\-level\fR entry in the return options dictionary is decremented. If after decrementing, -the value of the \fB-level\fR entry is 0, then the value of -the \fB-code\fR entry becomes the return code of the procedure. -If after decrementing, the value of the \fB-level\fR entry is +the value of the \fB\-level\fR entry is 0, then the value of +the \fB\-code\fR entry becomes the return code of the procedure. +If after decrementing, the value of the \fB\-level\fR entry is greater than zero, then the return code of the procedure is \fBTCL_RETURN\fR. If the procedure invocation occurred during the evaluation of the body of another procedure, the process will repeat itself up the call stack, decrementing the value of the -\fB-level\fR entry at each level, so that the \fIcode\fR will +\fB\-level\fR entry at each level, so that the \fIcode\fR will be the return code of the current command \fIlevel\fR levels up the call stack. The \fBsource\fR command performs the same handling of the \fBTCL_RETURN\fR return code, which explains @@ -197,10 +198,10 @@ to \fBreturn\fR invocation within a procedure. .PP The return code of the \fBreturn\fR command itself triggers this special handling by procedure invocation. If \fBreturn\fR -is provided the option \fB-level 0\fR, then the return code +is provided the option \fB\-level 0\fR, then the return code of the \fBreturn\fR command itself will be the value \fIcode\fR -of the \fB-code\fR option (or \fBTCL_OK\fR by default). Any other value -for the \fB-level\fR option (including the default value of 1) +of the \fB\-code\fR option (or \fBTCL_OK\fR by default). Any other value +for the \fB\-level\fR option (including the default value of 1) will cause the return code of the \fBreturn\fR command itself to be \fBTCL_RETURN\fR, triggering a return from the enclosing procedure. .VE 8.5 @@ -256,7 +257,7 @@ proc myBreak {} { .CE .PP .VS 8.5 -With the \fB-level 0\fR option, \fBreturn\fR itself can serve +With the \fB\-level 0\fR option, \fBreturn\fR itself can serve as a replacement for \fBbreak\fR. .CS interp alias {} Break {} \fBreturn\fR -level 0 -code break @@ -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: safe.n,v 1.10 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: safe.n,v 1.11 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH "Safe Tcl" n 8.0 Tcl "Tcl Built-In Commands" @@ -200,7 +200,7 @@ The default value is \fBtrue\fR : safe interpreters are allowed to load statically linked packages. .TP \fB\-noStatics\fR -This option is a convenience shortcut for \fB-statics false\fR and +This option is a convenience shortcut for \fB\-statics false\fR and thus specifies that the safe interpreter will not be allowed to load statically linked packages. .TP @@ -212,7 +212,7 @@ safe interpreters are not allowed to load packages into their own sub-interpreters. .TP \fB\-nestedLoadOk\fR -This option is a convenience shortcut for \fB-nested true\fR and +This option is a convenience shortcut for \fB\-nested true\fR and thus specifies the safe interpreter will be allowed to load packages into its own sub-interpreters. .TP diff --git a/doc/source.n b/doc/source.n index 34c7913..dfc64fa 100644 --- a/doc/source.n +++ b/doc/source.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: source.n,v 1.16 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: source.n,v 1.17 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH source n "" Tcl "Tcl Built-In Commands" @@ -48,8 +48,8 @@ which will be safely substituted by the Tcl interpreter into .QW ^Z . .PP .VS 8.5 -The \fB-encoding\fR option is used to specify the encoding of -the data stored in \fIfileName\fR. When the \fB-encoding\fR option +The \fB\-encoding\fR option is used to specify the encoding of +the data stored in \fIfileName\fR. When the \fB\-encoding\fR option is omitted, the system encoding is assumed. .VE 8.5 .SH EXAMPLE diff --git a/doc/string.n b/doc/string.n index e9f8e2c..4e769eb 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.40 2007/10/29 01:42:19 dkf Exp $ +.\" RCS: @(#) $Id: string.n,v 1.41 2007/10/29 11:28:50 dkf Exp $ .\" .so man.macros .TH string n 8.1 Tcl "Tcl Built-In Commands" @@ -41,7 +41,7 @@ first \fIlength\fR characters are used in the comparison. If \fB\-length\fR is negative, it is ignored. If \fB\-nocase\fR is specified, then the strings are compared in a case-insensitive manner. .TP -\fBstring equal\fR ?\fB\-nocase\fR? ?\fB-length int\fR? \fIstring1 string2\fR +\fBstring equal\fR ?\fB\-nocase\fR? ?\fB\-length int\fR? \fIstring1 string2\fR Perform a character-by-character comparison of strings \fIstring1\fR and \fIstring2\fR. Returns 1 if \fIstring1\fR and \fIstring2\fR are identical, or 0 when not. If \fB\-length\fR is specified, then only diff --git a/doc/subst.n b/doc/subst.n index 8f4cb91..d1c1194 100644 --- a/doc/subst.n +++ b/doc/subst.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: subst.n,v 1.14 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: subst.n,v 1.15 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH subst n 7.4 Tcl "Tcl Built-In Commands" @@ -36,13 +36,13 @@ is not performed: open and close brackets are treated as ordinary characters with no special interpretation. .PP Note that the substitution of one kind can include substitution of -other kinds. For example, even when the \fB-novariables\fR option +other kinds. For example, even when the \fB\-novariables\fR option is specified, command substitution is performed without restriction. This means that any variable substitution necessary to complete the command substitution will still take place. Likewise, any command substitution necessary to complete a variable substitution will -take place, even when \fB-nocommands\fR is specified. See the -EXAMPLES below. +take place, even when \fB\-nocommands\fR is specified. See the +\fBEXAMPLES\fR below. .PP If an error occurs during substitution, then \fBsubst\fR will return that error. If a break exception occurs during command or variable @@ -54,7 +54,7 @@ will be substituted for that entire command or variable substitution (as long as it is well-formed Tcl.) If a return exception occurs, or any other return code is returned during command or variable substitution, then the returned value is substituted for that -substitution. See the EXAMPLES below. In this way, all exceptional +substitution. See the \fBEXAMPLES\fR below. In this way, all exceptional return codes are .QW caught by \fBsubst\fR. The \fBsubst\fR command diff --git a/doc/tclvars.n b/doc/tclvars.n index 4317436..8c8eff4 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.31 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: tclvars.n,v 1.32 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH tclvars n 8.0 Tcl "Tcl Built-In Commands" @@ -51,13 +51,13 @@ will not work on Windows and is discouraged for cross-platform usage. .RE .TP \fBerrorCode\fR -This variable holds the value of the \fB-errorcode\fR return option +This variable holds the value of the \fB\-errorcode\fR return option set by the most recent error that occurred in this interpreter. This list value represents additional information about the error in a form that is easy to process with programs. The first element of the list identifies a general class of errors, and determines the format of the rest of the list. -The following formats for \fB-errorcode\fR return options +The following formats for \fB\-errorcode\fR return options are used by the Tcl core; individual applications may define additional formats. .RS @@ -105,7 +105,7 @@ for \fBSIGTTIN\fR. \fBNONE\fR This format is used for errors where no additional information is available for an error besides the message returned with the -error. In these cases the \fB-errorcode\fR return option +error. In these cases the \fB\-errorcode\fR return option will consist of a list containing a single element whose contents are \fBNONE\fR. .TP @@ -117,12 +117,12 @@ of the error that occurred, such as \fBENOENT\fR; this will be one of the values defined in the include file errno.h. The \fImsg\fR element will be a human-readable message corresponding to \fIerrName\fR, such as -"no such file or directory" +.QW "no such file or directory" for the \fBENOENT\fR case. .PP -To set the \fB-errorcode\fR return option, applications should use library +To set the \fB\-errorcode\fR return option, applications should use library procedures such as \fBTcl_SetObjErrorCode\fR, \fBTcl_SetReturnOptions\fR, -and \fBTcl_PosixError\fR, or they may invoke the \fB-errorcode\fR +and \fBTcl_PosixError\fR, or they may invoke the \fB\-errorcode\fR option of the \fBreturn\fR command. If one of these methods has not been used, then the Tcl interpreter will reset the variable to \fBNONE\fR after @@ -130,7 +130,7 @@ the next error. .RE .TP \fBerrorInfo\fR -This variable holds the value of the \fB-errorinfo\fR return option +This variable holds the value of the \fB\-errorinfo\fR return option set by the most recent error that occurred in this interpreter. This string value will contain one or more lines identifying the Tcl commands and procedures that were being executed @@ -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: tm.n,v 1.11 2007/10/29 01:42:19 dkf Exp $ +'\" RCS: @(#) $Id: tm.n,v 1.12 2007/10/29 11:28:50 dkf Exp $ '\" .so man.macros .TH tm n 8.5 Tcl "Tcl Built-In Commands" @@ -171,7 +171,7 @@ below: .CE .PP Where \fBPNAME\(fm\fR is the partial path of the module as defined in -section \fBFINDING MODULES\fR, and translated into \fB\fRPNAME by +section \fBFINDING MODULES\fR, and translated into \fBPNAME\fR by changing all directory separators to .QW "\fB::\fR" , and \fBmodule_path\fR is the path (from the list of paths to search) |