diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2004-09-06 09:44:56 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2004-09-06 09:44:56 (GMT) |
| commit | 0e5952c887bd1c44ce8a13516659d6e763a2d381 (patch) | |
| tree | f3df18b7b55fef1a57dbdfd4b3b9d48ee8923f16 | |
| parent | e61f35c191941709a727ae6128a43b24a0ee5bff (diff) | |
| download | tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.zip tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.gz tcl-0e5952c887bd1c44ce8a13516659d6e763a2d381.tar.bz2 | |
More documentation fixes from Mikhail Kolesnitchenko. [Patch 1022527]
53 files changed, 195 insertions, 186 deletions
@@ -1,3 +1,17 @@ +2004-09-06 Donal K. Fellows <donal.k.fellows@man.ac.uk> + + * doc/tclvars.n, doc/tcltest.n, doc/tclsh.1, doc/safe.n, doc/expr.n: + * doc/WrongNumArgs.3, doc/Utf.3, doc/TraceVar.3, doc/Thread.3: + * doc/TCL_MEM_DEBUG.3, doc/SubstObj.3, doc/StdChannels.3: + * doc/SetResult.3, doc/RegExp.3, doc/RegConfig.3, doc/RecEvalObj.3: + * doc/PrintDbl.3, doc/ParseCmd.3, doc/Panic.3, doc/ObjectType.3: + * doc/Object.3, doc/Namespace.3, doc/Interp.3, doc/IntObj.3: + * doc/Hash.3, doc/GetOpnFl.3, doc/GetIndex.3, doc/Eval.3: + * doc/Encoding.3, doc/DoubleObj.3, doc/DictObj.3, doc/CrtTimerHdlr.3: + * doc/CrtObjCmd.3, doc/CrtMathFnc.3, doc/CrtCommand.3, doc/CrtChannel.3: + * doc/ChnlStack.3, doc/ByteArrObj.3, doc/AssocData.3, doc/Alloc.3: + More documentation fixes from Mikhail Kolesnitchenko. [Patch 1022527] + 2004-09-03 Donal K. Fellows <donal.k.fellows@man.ac.uk> * unix/tclUnixFCmd.c: Stop NULL interp arguments from triggering a diff --git a/doc/Alloc.3 b/doc/Alloc.3 index e016a6d..541f300 100644 --- a/doc/Alloc.3 +++ b/doc/Alloc.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: Alloc.3,v 1.8 2002/10/09 09:38:38 dkf Exp $ +'\" RCS: @(#) $Id: Alloc.3,v 1.9 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_Alloc 3 7.5 Tcl "Tcl Library Procedures" @@ -84,7 +84,7 @@ The procedures \fBckalloc\fR, \fBckfree\fR, \fBckrealloc\fR, as macros. Normally, they are synonyms for the corresponding procedures documented on this page. When Tcl and all modules calling Tcl are compiled with \fBTCL_MEM_DEBUG\fR defined, however, -these macros are redefined to be special debugging versions of +these macros are redefined to be special debugging versions of these procedures. To support Tcl's memory debugging within a module, use the macros rather than direct calls to \fBTcl_Alloc\fR, etc. diff --git a/doc/AssocData.3 b/doc/AssocData.3 index 74c130b..54d3b4e 100644 --- a/doc/AssocData.3 +++ b/doc/AssocData.3 @@ -5,14 +5,12 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" -'\" RCS: @(#) $Id: AssocData.3,v 1.4 2001/04/24 20:59:17 kennykb Exp $ +'\" RCS: @(#) $Id: AssocData.3,v 1.5 2004/09/06 09:44:56 dkf Exp $ .so man.macros .TH Tcl_SetAssocData 3 7.5 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_GetAssocData, Tcl_SetAssocData, Tcl_DeleteAssocData \- manage -associations of string keys and user specified data with Tcl -interpreters. +Tcl_GetAssocData, Tcl_SetAssocData, Tcl_DeleteAssocData \- manage associations of string keys and user specified data with Tcl interpreters .SH SYNOPSIS .nf \fB#include <tcl.h>\fR diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3 index f5471db..02d7f4f 100644 --- a/doc/ByteArrObj.3 +++ b/doc/ByteArrObj.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: ByteArrObj.3,v 1.3 2001/04/04 16:07:20 kennykb Exp $ +'\" RCS: @(#) $Id: ByteArrObj.3,v 1.4 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_ByteArrayObj 3 8.1 Tcl "Tcl Library Procedures" @@ -50,7 +50,7 @@ results of binary IO operations or data structures created with the \fBbinary\fR command. In Tcl, an array of bytes is not equivalent to a string. Conceptually, a string is an array of Unicode characters, while a byte-array is an array of 8-bit quantities with no implicit meaning. -Accesser functions are provided to get the string representation of a +Accessor functions are provided to get the string representation of a byte-array or to convert an arbitrary object to a byte-array. Obtaining the string representation of a byte-array object (by calling \fBTcl_GetStringFromObj\fR) produces a properly formed UTF-8 sequence with a diff --git a/doc/ChnlStack.3 b/doc/ChnlStack.3 index 0bbeb96..a713d0b 100644 --- a/doc/ChnlStack.3 +++ b/doc/ChnlStack.3 @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ChnlStack.3,v 1.5 2004/07/16 20:11:13 andreas_kupries Exp $ +'\" RCS: @(#) $Id: ChnlStack.3,v 1.6 2004/09/06 09:44:56 dkf Exp $ .so man.macros .TH Tcl_StackChannel 3 8.3 Tcl "Tcl Library Procedures" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- stack an I/O channel on top of another, and undo it +Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- manipulate stacked I/O channels .SH SYNOPSIS .nf .nf diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index e601a21..3356c9c 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.18 2004/09/01 09:50:45 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.19 2004/09/06 09:44:56 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -261,8 +261,9 @@ occurred on the channel. Channel drivers are responsible for invoking this function whenever the channel handlers need to be called for the channel. See \fBWATCHPROC\fR below for more details. .PP -\fBTcl_BadChannelOption\fR is called from driver specific set or get option -procs to generate a complete error message. +\fBTcl_BadChannelOption\fR is called from driver specific +\fIsetOptionProc\fR or \fIgetOptionProc\fR to generate a complete +error message. .PP \fBTcl_ChannelBuffered\fR returns the number of bytes of input currently buffered in the internal buffer (push back area) of the @@ -463,9 +464,9 @@ return a nonzero POSIX error code. In addition, if an error occurs and \fIinterp\fR is not NULL, the procedure should store an error message in the interpreter's result. .PP -These value can be retrieved with \fBTcl_ChannelCloseProc\fR or -\fBTcl_ChannelClose2Proc\fR, which returns a pointer to the respective -function. +The \fIcloseProc\fR and \fIclose2Proc\fR values can be retrieved with +\fBTcl_ChannelCloseProc\fR or \fBTcl_ChannelClose2Proc\fR, which +return a pointer to the respective function. .SH INPUTPROC .PP @@ -790,14 +791,14 @@ a pointer to the function. .PP This procedure generates a "bad option" error message in an (optional) interpreter. It is used by channel drivers when -a invalid Set/Get option is requested. Its purpose is to concatenate +an invalid Set/Get option is requested. Its purpose is to concatenate the generic options list to the specific ones and factorize the generic options error message string. .PP It always return \fBTCL_ERROR\fR .PP An error message is generated in \fIinterp\fR's result object to -indicate that a command was invoked with the a bad option +indicate that a command was invoked with a bad option. The message has the form .CS bad option "blah": should be one of diff --git a/doc/CrtCommand.3 b/doc/CrtCommand.3 index d5f0715..b1b2cae 100644 --- a/doc/CrtCommand.3 +++ b/doc/CrtCommand.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: CrtCommand.3,v 1.7 2004/07/16 20:46:33 andreas_kupries Exp $ +'\" RCS: @(#) $Id: CrtCommand.3,v 1.8 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_CreateCommand 3 "" Tcl "Tcl Library Procedures" @@ -108,8 +108,9 @@ Note that the argument strings are encoded in normalized UTF-8 since version 8.1 of Tcl. .VE .PP -\fIProc\fR must return an integer code that is either \fBTCL_OK\fR, \fBTCL_ERROR\fR, -\fBTCL_RETURN\fR, \fBTCL_BREAK\fR, or \fBTCL_CONTINUE\fR. See the Tcl overview man page +\fIProc\fR must return an integer code that is expected to be one of +\fBTCL_OK\fR, \fBTCL_ERROR\fR, \fBTCL_RETURN\fR, \fBTCL_BREAK\fR, or +\fBTCL_CONTINUE\fR. See the Tcl overview man page for details on what these codes mean. Most normal commands will only return \fBTCL_OK\fR or \fBTCL_ERROR\fR. In addition, \fIproc\fR must set the interpreter result to point to a string value; diff --git a/doc/CrtMathFnc.3 b/doc/CrtMathFnc.3 index ca3ce33..e456cab 100644 --- a/doc/CrtMathFnc.3 +++ b/doc/CrtMathFnc.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: CrtMathFnc.3,v 1.7 2003/04/16 22:29:20 dkf Exp $ +'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.8 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_CreateMathFunc 3 8.4 Tcl "Tcl Library Procedures" @@ -53,7 +53,7 @@ will need to be freed up using \fITcl_Free\fR. .AP Tcl_MathProc **procPtr out Points to a variable that will be set to contain a pointer to the implementation code for the function (or NULL if the function is -implemented directly in bytecode.) +implemented directly in bytecode). .AP ClientData *clientDataPtr out Points to a variable that will be set to contain the clientData argument passed to \fITcl_CreateMathFunc\fR when the function was diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3 index 73755f3..fbce5b2 100644 --- a/doc/CrtObjCmd.3 +++ b/doc/CrtObjCmd.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: CrtObjCmd.3,v 1.8 2004/05/05 20:52:32 dkf Exp $ +'\" RCS: @(#) $Id: CrtObjCmd.3,v 1.9 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_CreateObjCommand 3 8.0 Tcl "Tcl Library Procedures" @@ -290,7 +290,7 @@ owned by Tcl and is only guaranteed to retain its value as long as the command isn't deleted or renamed; callers should copy the string if they need to keep it for a long time. .PP -\fBTcl_GetCommandFullName\fR produces the fully-qualified name +\fBTcl_GetCommandFullName\fR produces the fully qualified name of a command from a command token. The name, including all namespace prefixes, is appended to the object specified by \fIobjPtr\fP. diff --git a/doc/CrtSlave.3 b/doc/CrtSlave.3 index a9abfe2..2052fd8 100644 --- a/doc/CrtSlave.3 +++ b/doc/CrtSlave.3 @@ -4,13 +4,13 @@ '\" 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.10 2003/07/18 15:21:39 dgp Exp $ +'\" RCS: @(#) $Id: CrtSlave.3,v 1.11 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_CreateSlave 3 7.6 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_IsSafe, Tcl_MakeSafe, Tcl_CreateSlave, Tcl_GetSlave, Tcl_GetMaster, Tcl_GetInterpPath, Tcl_CreateAlias, Tcl_CreateAliasObj, Tcl_GetAlias, Tcl_GetAliasObj, Tcl_ExposeCommand, Tcl_HideCommand \- manage multiple Tcl interpreters, aliases and hidden commands. +Tcl_IsSafe, Tcl_MakeSafe, Tcl_CreateSlave, Tcl_GetSlave, Tcl_GetMaster, Tcl_GetInterpPath, Tcl_CreateAlias, Tcl_CreateAliasObj, Tcl_GetAlias, Tcl_GetAliasObj, Tcl_ExposeCommand, Tcl_HideCommand \- manage multiple Tcl interpreters, aliases and hidden commands .SH SYNOPSIS .nf \fB#include <tcl.h>\fR diff --git a/doc/CrtTimerHdlr.3 b/doc/CrtTimerHdlr.3 index ecfa4c3..57a3a7f 100644 --- a/doc/CrtTimerHdlr.3 +++ b/doc/CrtTimerHdlr.3 @@ -5,14 +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: CrtTimerHdlr.3,v 1.2 1998/09/14 18:39:47 stanton Exp $ +'\" RCS: @(#) $Id: CrtTimerHdlr.3,v 1.3 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_CreateTimerHandler 3 7.5 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_CreateTimerHandler, Tcl_DeleteTimerHandler \- call a procedure at a -given time +Tcl_CreateTimerHandler, Tcl_DeleteTimerHandler \- call a procedure at a given time .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -30,7 +29,7 @@ Procedure to invoke after \fImilliseconds\fR have elapsed. .AP ClientData clientData in Arbitrary one-word value to pass to \fIproc\fR. .AP Tcl_TimerToken token in -Token for previously-created timer handler (the return value +Token for previously created timer handler (the return value from some previous call to \fBTcl_CreateTimerHandler\fR). .BE @@ -63,7 +62,7 @@ structure containing application-specific information about what to do in \fIproc\fR. .PP \fBTcl_DeleteTimerHandler\fR may be called to delete a -previously-created timer handler. It deletes the handler +previously created timer handler. It deletes the handler indicated by \fItoken\fR so that no call to \fIproc\fR will be made; if that handler no longer exists (e.g. because the time period has already elapsed and \fIproc\fR diff --git a/doc/DictObj.3 b/doc/DictObj.3 index fd5da1c..a8d19a4 100644 --- a/doc/DictObj.3 +++ b/doc/DictObj.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: DictObj.3,v 1.2 2004/04/26 09:47:18 dkf Exp $ +'\" RCS: @(#) $Id: DictObj.3,v 1.3 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_DictObj 3 8.5 Tcl "Tcl Library Procedures" @@ -77,7 +77,7 @@ contained within the dictionary placed within it. .AP Tcl_DictSearch *searchPtr in/out Pointer to record to use to keep track of progress in enumerating all key/value pairs in a dictionary. The contents of the record will be -initialised by the call to \fBTcl_DictObjFirst\fR. If the enumerating +initialized by the call to \fBTcl_DictObjFirst\fR. If the enumerating is to be terminated before all values in the dictionary have been returned, the search record \fImust\fR be passed to \fBTcl_DictObjDone\fR to enable the internal locks to be released. @@ -97,10 +97,11 @@ sub-dictionaries of the main dictionary object passed to them. .SH DESCRIPTION .PP -Tcl dict objects have an internal representation that supports -efficient mapping from keys to values. +Tcl dictionary objects have an internal representation that supports +efficient mapping from keys to values and which does not guarantee any +particular ordering of keys within the dictionary. The procedures described in this man page are used to -create, modify, index, and iterate over Tcl dict objects from C code. +create, modify, index, and iterate over dictionary objects from C code. .PP \fBTcl_NewDictObj\fR creates a new, empty dictionary object. The string representation of the object will be invalid, and the reference @@ -130,7 +131,7 @@ procedure is TCL_OK, or TCL_ERROR if the \fIdictPtr\fR cannot be converted to a dictionary. .PP \fBTcl_DictObjSize\fR updates the given variable with the number of -key/value pairs currently in the given dictionary.The result of this +key/value pairs currently in the given dictionary. The result of this procedure is TCL_OK, or TCL_ERROR if the \fIdictPtr\fR cannot be converted to a dictionary. .PP @@ -146,7 +147,7 @@ unless the dictionary is unshared, when this will trigger premature termination of the iteration instead (which Tcl scripts cannot trigger via the \fBdict\fR command.) The \fIsearchPtr\fR argument points to a piece of context that is used to identify which particular iteration -is being performed, and is initialised by the call to +is being performed, and is initialized by the call to \fBTcl_DictObjFirst\fR. The \fIdonePtr\fR argument points to a variable that is updated to be zero of there are further key/value pairs to be iterated over, or non-zero if the iteration is complete. @@ -226,4 +227,4 @@ return TCL_OK; .SH "SEE ALSO" Tcl_NewObj, Tcl_DecrRefCount, Tcl_IncrRefCount, Tcl_InitObjHashTable .SH KEYWORDS -dict, dict object, dictionary, hash table, iteration, object +dict, dict object, dictionary, dictionary object, hash table, iteration, object diff --git a/doc/DoubleObj.3 b/doc/DoubleObj.3 index 164d4c9..4af284d 100644 --- a/doc/DoubleObj.3 +++ b/doc/DoubleObj.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: DoubleObj.3,v 1.2 1998/09/14 18:39:48 stanton Exp $ +'\" RCS: @(#) $Id: DoubleObj.3,v 1.3 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_DoubleObj 3 8.0 Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ int .SH ARGUMENTS .AS Tcl_Interp doubleValue in/out .AP double doubleValue in -A double-precision floating point value used to initialize or set a double object. +A double-precision floating-point value used to initialize or set a double object. .AP Tcl_Obj *objPtr in/out For \fBTcl_SetDoubleObj\fR, this points to the object to be converted to double type. @@ -50,7 +50,7 @@ double Tcl objects from C code. will create a new object of double type or modify an existing object to have double type. Both of these procedures set the object to have the -double-precision floating point value given by \fIdoubleValue\fR; +double-precision floating-point value given by \fIdoubleValue\fR; \fBTcl_NewDoubleObj\fR returns a pointer to a newly created object with reference count zero. Both procedures set the object's type to be double diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3 index ee6d0e1..5d1bc14 100644 --- a/doc/DumpActiveMemory.3 +++ b/doc/DumpActiveMemory.3 @@ -3,13 +3,13 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.5 2001/12/28 23:36:31 dgp Exp $ +'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.6 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface. +Tcl_DumpActiveMemory, Tcl_InitMemory, Tcl_ValidateAllMemory \- Validated memory allocation interface .SH SYNOPSIS .nf \fB#include <tcl.h>\fR diff --git a/doc/Encoding.3 b/doc/Encoding.3 index 5884b45..bd24e0f 100644 --- a/doc/Encoding.3 +++ b/doc/Encoding.3 @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Encoding.3,v 1.15 2004/06/11 22:39:28 dgp Exp $ +'\" RCS: @(#) $Id: Encoding.3,v 1.16 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_GetEncoding, Tcl_FreeEncoding, Tcl_ExternalToUtfDString, Tcl_ExternalToUtf, Tcl_UtfToExternalDString, Tcl_UtfToExternal, Tcl_WinTCharToUtf, Tcl_WinUtfToTChar, Tcl_GetEncodingName, Tcl_SetSystemEncoding, Tcl_GetEncodingNames, Tcl_CreateEncoding, Tcl_GetDefaultEncodingDir, Tcl_SetDefaultEncodingDir \- procedures for creating and using encodings. +Tcl_GetEncoding, Tcl_FreeEncoding, Tcl_ExternalToUtfDString, Tcl_ExternalToUtf, Tcl_UtfToExternalDString, Tcl_UtfToExternal, Tcl_WinTCharToUtf, Tcl_WinUtfToTChar, Tcl_GetEncodingName, Tcl_SetSystemEncoding, Tcl_GetEncodingNames, Tcl_CreateEncoding, Tcl_GetDefaultEncodingDir, Tcl_SetDefaultEncodingDir \- procedures for creating and using encodings .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -99,7 +99,7 @@ the target encoding; otherwise a default fallback character will automatically be substituted. .AP Tcl_EncodingState *statePtr in/out Used when converting a (generally long or indefinite length) byte stream -in a piece by piece fashion. The conversion routine stores its current +in a piece-by-piece fashion. The conversion routine stores its current state in \fI*statePtr\fR after \fIsrc\fR (the buffer containing the current piece) has been converted; that state information must be passed back when converting the next piece of the stream so the conversion @@ -151,7 +151,7 @@ platform-independent manner. .SH DESCRIPTION .PP \fBTcl_GetEncoding\fR finds an encoding given its \fIname\fR. The name may -refer to a builtin Tcl encoding, a user-defined encoding registered by +refer to a built-in Tcl encoding, a user-defined encoding registered by calling \fBTcl_CreateEncoding\fR, or a dynamically-loadable encoding file. The return value is a token that represents the encoding and can be used in subsequent calls to procedures such as \fBTcl_GetEncodingName\fR, @@ -194,7 +194,7 @@ All bytes of \fIsrc\fR were converted. The destination buffer was not large enough for all of the converted data; as many characters as could fit were converted though. .IP \fBTCL_CONVERT_MULTIBYTE\fR 29 -The last fews bytes in the source buffer were the beginning of a multibyte +The last few bytes in the source buffer were the beginning of a multibyte sequence, but more bytes were needed to complete this sequence. A subsequent call to the conversion routine should pass a buffer containing the unconverted bytes that remained in \fIsrc\fR plus some further bytes @@ -406,7 +406,7 @@ A double-byte encoding, where one character is always two bytes long in the encoding. An example is \fBbig5\fR, used for Chinese text. .IP "[3] \fBM\fR" A multi-byte encoding, where one character may be either one or two bytes long. -Certain bytes are a lead bytes, indicating that another byte must follow +Certain bytes are lead bytes, indicating that another byte must follow and that together the two bytes represent one character. Other bytes are not lead bytes and represent themselves. An example is \fBshiftjis\fR, used by many Japanese computers. @@ -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: Eval.3,v 1.15 2003/07/18 16:56:41 dgp Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.16 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -71,7 +71,7 @@ Points to first byte of script to execute (null-terminated and UTF-8). .AP char *string in String forming part of a Tcl script. .AP va_list argList in -An argument list which must have been initialised using +An argument list which must have been initialized using \fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR. .BE @@ -118,7 +118,7 @@ a completion code and result just like \fBTcl_EvalObjEx\fR. be executed is supplied as a string instead of an object and no compilation 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 +to possibly contain upper ASCII characters whose 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 diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index 724fe34..ec43774 100644 --- a/doc/GetIndex.3 +++ b/doc/GetIndex.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: GetIndex.3,v 1.11 2003/07/18 16:56:41 dgp Exp $ +'\" RCS: @(#) $Id: GetIndex.3,v 1.12 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures" @@ -92,9 +92,12 @@ and return TCL_ERROR. .PP \fBTcl_GetIndexFromObjStruct\fR works just like \fBTcl_GetIndexFromObj\fR, except that instead of treating -\fItablePtr\fR as an array of string pointers, it treats it as the -first in a series of string ptrs that are spaced apart by \fIoffset\fR -bytes. This is particularly useful when processing things like +\fItablePtr\fR as an array of string pointers, it treats it as a +pointer to the first string in a series of strings that have +\fIoffset\fR bytes between them (i.e. that there is a pointer to the +first array of characters at \fItablePtr\fR, a pointer to the second +array of characters at \fItablePtr\fR+\fIoffset\fR bytes, etc.) +This is particularly useful when processing things like \fBTk_ConfigurationSpec\fR, whose string keys are in the same place in each of several array elements. .VE diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index e4cbf67..1f3c839 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.3 @@ -4,12 +4,12 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetOpnFl.3,v 1.4 2002/01/23 20:46:01 dgp Exp $ +'\" RCS: @(#) $Id: GetOpnFl.3,v 1.5 2004/09/06 09:44:56 dkf Exp $ .so man.macros .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_GetOpenFile \- Get a standard IO File * handle from a channel. (Unix only) +Tcl_GetOpenFile \- Return a FILE* for a channel registered in the given interpreter (Unix only) .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -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: Hash.3,v 1.13 2004/04/21 21:33:38 dkf Exp $ +'\" RCS: @(#) $Id: Hash.3,v 1.14 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH Tcl_Hash 3 "" Tcl "Tcl Library Procedures" @@ -255,7 +255,7 @@ The \fIflags\fR member is one or more of the following values OR'ed together: .IP \fBTCL_HASH_KEY_RANDOMIZE_HASH\fR 25 There are some things, pointers for example which don't hash well because they do not use the lower bits. If this flag is set then the -hash table will attempt to rectify this by randomising the bits and +hash table will attempt to rectify this by randomizing the bits and then using the upper N bits as the index into the table. .VS 8.5 br .IP \fBTCL_HASH_KEY_SYSTEM_HASH\fR 25 @@ -290,7 +290,7 @@ If the keys don't match then the function returns 0, otherwise it returns 1. .PP The \fIallocEntryProc\fR member contains the address of a function -called to allocate space for an entry and initialise the key. +called to allocate space for an entry and initialize the key. .CS typedef Tcl_HashEntry *(Tcl_AllocHashEntryProc) ( Tcl_HashTable *\fItablePtr\fR, VOID *\fIkeyPtr\fR); diff --git a/doc/IntObj.3 b/doc/IntObj.3 index 1dc5b0e..c9dabfb 100644 --- a/doc/IntObj.3 +++ b/doc/IntObj.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: IntObj.3,v 1.3 2002/02/15 14:28:47 dkf Exp $ +'\" RCS: @(#) $Id: IntObj.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_IntObj 3 8.0 Tcl "Tcl Library Procedures" @@ -63,7 +63,7 @@ integer type. For \fBTcl_GetIntFromObj\fR, \fBTcl_GetLongFromObj\fR, and \fBTcl_GetWideIntFromObj\fR, this refers to the object from which to get an integer or long integer value; if \fIobjPtr\fR does not already point to an integer object (or a wide integer object in the -case of \fBTcl_SetWideIntObj\fR and \fBTcl_GetWideIntFromObj\fR,) an +case of \fBTcl_SetWideIntObj\fR and \fBTcl_GetWideIntFromObj\fR), an .VE 8.4 attempt will be made to convert it to one. .AP Tcl_Interp *interp in/out diff --git a/doc/Interp.3 b/doc/Interp.3 index b6c2c0f..098d026 100644 --- a/doc/Interp.3 +++ b/doc/Interp.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: Interp.3,v 1.3 2000/04/14 23:01:51 hobbs Exp $ +'\" RCS: @(#) $Id: Interp.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures" @@ -30,7 +30,7 @@ typedef void Tcl_FreeProc(char *\fIblockPtr\fR); The \fBTcl_CreateInterp\fR procedure returns a pointer to a Tcl_Interp structure. This pointer is then passed into other Tcl procedures to process commands in the interpreter and perform other operations -on the interpreter. Interpreter structures contain many many fields +on the interpreter. Interpreter structures contain many fields that are used by Tcl, but only three that may be accessed by clients: \fIresult\fR, \fIfreeProc\fR, and \fIerrorLine\fR. .PP diff --git a/doc/Namespace.3 b/doc/Namespace.3 index 53da4eb..6133399 100644 --- a/doc/Namespace.3 +++ b/doc/Namespace.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: Namespace.3,v 1.3 2004/07/01 07:59:22 dkf Exp $ +'\" RCS: @(#) $Id: Namespace.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ '\" '\" Note that some of these functions do not seem to belong, but they '\" were all introduced with the same TIP (#139) @@ -76,7 +76,7 @@ Whether new commands created by this import action can overwrite existing commands. .AP Tcl_Namespace *contextNsPtr in The location in the namespace hierarchy where the search for a -namspace or command should be conducted relative to when the search +namespace or command should be conducted relative to when the search term is not rooted at the global namespace. NULL indicates the current namespace. .AP int flags in diff --git a/doc/Object.3 b/doc/Object.3 index d116b37..adce4c7 100644 --- a/doc/Object.3 +++ b/doc/Object.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: Object.3,v 1.6 2002/10/22 12:16:53 dkf Exp $ +'\" RCS: @(#) $Id: Object.3,v 1.7 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_Obj 3 8.1 Tcl "Tcl Library Procedures" @@ -153,7 +153,7 @@ the internal representation is invalid. .PP The \fIinternalRep\fR union member holds an object's internal representation. -This is either a (long) integer, a double-precision floating point number, +This is either a (long) integer, a double-precision floating-point number, a pointer to a value containing additional information needed by the object's type to represent the object, or two arbitrary pointers. @@ -264,7 +264,7 @@ no longer corresponds to the internal representation. .CE The string representation of \fIx\fR's object is needed and is recomputed. -The string representation is now \fB124\fR. +The string representation is now \fB124\fR and both representations are again valid. .SH "STORAGE MANAGEMENT OF OBJECTS" @@ -283,7 +283,7 @@ if the object's reference count drops to zero, frees its storage. An object shared by different code or data structures has \fIrefCount\fR greater than 1. Incrementing an object's reference count ensures that -it won't be freed too early or have its value change accidently. +it won't be freed too early or have its value change accidentally. .PP As an example, the bytecode interpreter shares argument objects between calling and called Tcl procedures to avoid having to copy objects. @@ -330,7 +330,7 @@ As another example, \fBincr\fR's command procedure must check whether the variable's object is shared before incrementing the integer in its internal representation. If it is shared, it needs to duplicate the object -in order to avoid accidently changing values in other data structures. +in order to avoid accidentally changing values in other data structures. .SH "SEE ALSO" Tcl_ConvertToType, Tcl_GetIntFromObj, Tcl_ListObjAppendElement, Tcl_ListObjIndex, Tcl_ListObjReplace, Tcl_RegisterObjType diff --git a/doc/ObjectType.3 b/doc/ObjectType.3 index df31e5f..2f7e37b 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.8 2004/06/18 15:17:58 dkf Exp $ +'\" RCS: @(#) $Id: ObjectType.3,v 1.9 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_ObjType 3 8.0 Tcl "Tcl Library Procedures" @@ -45,8 +45,7 @@ must have been the result of a previous call to \fBTcl_NewObj\fR. .SH DESCRIPTION .PP The procedures in this man page manage Tcl object types. -The are used to register new object types, -look up types, +They are used to register new object types, look up types, and force conversions from one type to another. .PP \fBTcl_RegisterObjType\fR registers a new Tcl object type @@ -126,7 +125,7 @@ the \fIsetFromAnyProc\fR must free any internal representation of \fIobjPtr\fR's old type; it does this by calling the old type's \fIfreeIntRepProc\fR if it is not NULL. -As an example, the \fIsetFromAnyProc\fR for the builtin Tcl integer type +As an example, the \fIsetFromAnyProc\fR for the built-in Tcl integer type gets an up-to-date string representation for \fIobjPtr\fR by calling \fBTcl_GetStringFromObj\fR. It parses the string to obtain an integer and, @@ -152,7 +151,7 @@ to be treated as conventional null character-terminated C strings. Storage for the byte array must be allocated in the heap by \fBTcl_Alloc\fR or \fBckalloc\fR. Note that \fIupdateStringProc\fRs must allocate enough storage for the string's bytes and the terminating null byte. -The \fIupdateStringProc\fR for Tcl's builtin list type, for example, +The \fIupdateStringProc\fR for Tcl's built-in list type, for example, builds an array of strings for each element object and then calls \fBTcl_Merge\fR to construct a string with proper Tcl list structure. @@ -171,7 +170,7 @@ Before the call, copying its internal representation means. For example, the \fIdupIntRepProc\fR for the Tcl integer type simply copies an integer. -The builtin list type's \fIdupIntRepProc\fR +The built-in list type's \fIdupIntRepProc\fR allocates a new array that points at the original element objects; the elements are shared between the two lists (and their reference counts are incremented to reflect the new references). diff --git a/doc/Panic.3 b/doc/Panic.3 index 5e1f0f0..e569a15 100644 --- a/doc/Panic.3 +++ b/doc/Panic.3 @@ -2,7 +2,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Panic.3,v 1.4 2004/01/22 03:03:16 davygrvy Exp $ +'\" RCS: @(#) $Id: Panic.3,v 1.5 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_Panic 3 8.4 Tcl "Tcl Library Procedures" @@ -47,7 +47,7 @@ to display a message describing the error and abort the process. The \fIformat\fR argument is a format string describing how to format the remaining arguments \fIarg\fR into an error message, according to the same formatting rules used by the \fBprintf\fR family of functions. The -same formatting rules are also used by the builtin Tcl command +same formatting rules are also used by the built-in Tcl command \fBformat\fR. .PP In a freshly loaded Tcl library, \fBTcl_Panic\fR prints the formatted diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3 index 3839b7c..97d6aeb 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.13 2004/03/09 12:59:04 vincentdarley Exp $ +'\" RCS: @(#) $Id: ParseCmd.3,v 1.14 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_ParseCommand 3 8.3 Tcl "Tcl Library Procedures" @@ -356,7 +356,7 @@ this includes the sub-tokens for any nested \fBTCL_TOKEN_SUB_EXPR\fR tokens. \fBTCL_TOKEN_OPERATOR\fR The token describes one operator of an expression such as \fB&&\fR or \fBhypot\fR. -An \fBTCL_TOKEN_OPERATOR\fR token is always preceded by a +A \fBTCL_TOKEN_OPERATOR\fR token is always preceded by a \fBTCL_TOKEN_SUB_EXPR\fR token that describes the operator and its operands; the \fBTCL_TOKEN_SUB_EXPR\fR token's \fInumComponents\fR field diff --git a/doc/PrintDbl.3 b/doc/PrintDbl.3 index 81af506..04e2c79 100644 --- a/doc/PrintDbl.3 +++ b/doc/PrintDbl.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: PrintDbl.3,v 1.2 1998/09/14 18:39:49 stanton Exp $ +'\" RCS: @(#) $Id: PrintDbl.3,v 1.3 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_PrintDouble 3 8.0 Tcl "Tcl Library Procedures" @@ -29,7 +29,7 @@ that is now shared by all interpreters. .AP double value in Floating-point value to be converted. .AP char *dst out -Where to store string representing \fIvalue\fR. Must have at +Where to store the string representing \fIvalue\fR. Must have at least TCL_DOUBLE_SPACE characters of storage. .BE diff --git a/doc/RecEvalObj.3 b/doc/RecEvalObj.3 index 6491135..19f292c 100644 --- a/doc/RecEvalObj.3 +++ b/doc/RecEvalObj.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: RecEvalObj.3,v 1.3 2000/07/24 00:03:02 jenglish Exp $ +'\" RCS: @(#) $Id: RecEvalObj.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_RecordAndEvalObj 3 8.0 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_RecordAndEvalObj \- save command on history list before evaluating int \fBTcl_RecordAndEvalObj\fR(\fIinterp, cmdPtr, flags\fR) .SH ARGUMENTS -.AS Tcl_Interp *interp; +.AS Tcl_Interp *interp .AP Tcl_Interp *interp in Tcl interpreter in which to evaluate command. .AP Tcl_Obj *cmdPtr in @@ -44,7 +44,7 @@ If you don't want the command recorded on the history list then you should invoke \fBTcl_EvalObjEx\fR instead of \fBTcl_RecordAndEvalObj\fR. Normally \fBTcl_RecordAndEvalObj\fR is only called with top-level commands typed by the user, since the purpose of history is to -allow the user to re-issue recently-invoked commands. +allow the user to re-issue recently invoked commands. If the \fIflags\fR argument contains the TCL_NO_EVAL bit then the command is recorded without being evaluated. diff --git a/doc/RegConfig.3 b/doc/RegConfig.3 index 9816573..f9d200a 100644 --- a/doc/RegConfig.3 +++ b/doc/RegConfig.3 @@ -4,45 +4,38 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RegConfig.3,v 1.3 2004/09/01 09:50:45 dkf Exp $ +'\" RCS: @(#) $Id: RegConfig.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ .so man.macros .TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Tcl_RegisterConfig \- procedures to register embedded configuration information. +Tcl_RegisterConfig \- procedures to register embedded configuration information .SH SYNOPSIS .nf \fB#include <tcl.h>\fR .sp void -\fBTcl_RegisterConfig\fR(\fIinterp,pkgName,configuration,valEncoding\fR) +\fBTcl_RegisterConfig\fR(\fIinterp, pkgName, configuration, valEncoding\fR) .sp .SH ARGUMENTS +.AS Tcl_Interp *interp .AP Tcl_Interp *interp in - Refers to the interpreter the embedded configuration information is registered for. Must not be NULL. - .AP "CONST char" *pkgName in - Contains the name of the package registering the embedded configuration as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. - .AP Tcl_Config *configuration in - Refers to an array of Tcl_Config entries containing the information embedded in the binary library. Must not be NULL. The end of the array -is signaled by either a key identical to NULL, or a key refering to +is signaled by either a key identical to NULL, or a key referring to the empty string. - .AP "CONST char" *valEncoding in - Contains the name of the encoding used to store the configuration values as ASCII string. This means that this information is in UTF-8 too. Must not be NULL. - .BE .SH DESCRIPTION @@ -50,7 +43,7 @@ too. Must not be NULL. The function described here has its base in TIP 59 and provides extensions with support for the embedding of configuration information into their binary library and the generation of a -tcl-level interface for querying this information. +Tcl-level interface for querying this information. .PP To embed configuration information into their binary library an extension has to define a non-volatile array of Tcl_Config entries in @@ -65,8 +58,8 @@ encoding used by the configuration values. .PP The string \fIvalEncoding\fR contains the name of an encoding known to Tcl. All these names are use only characters in the ASCII subset of -UTF-8 and are thus implicity in the UTF-8 encoding. It is expected -that keys are legible english text and therefore using the ASCII +UTF-8 and are thus implicitly in the UTF-8 encoding. It is expected +that keys are legible English text and therefore using the ASCII subset of UTF-8. In other words, they are expected to be in UTF-8 too. The values associated with the keys can be any string however. For these the contents of \fIvalEncoding\fR define which diff --git a/doc/RegExp.3 b/doc/RegExp.3 index 07cf6c8..6eb6fbb 100644 --- a/doc/RegExp.3 +++ b/doc/RegExp.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: RegExp.3,v 1.13 2002/11/13 22:11:40 vincentdarley Exp $ +'\" RCS: @(#) $Id: RegExp.3,v 1.14 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -192,15 +192,15 @@ occurs while compiling the regular expression then \fBTcl_GetRegExpFromObj\fR returns NULL and leaves an error message in the interpreter result. The regular expression token can be used as long as the internal representation of \fIpatObj\fR refers to the -compiled form. The \fIeflags\fR argument is a bitwise OR of +compiled form. The \fIeflags\fR argument is a bit-wise OR of zero or more of the following flags that control the compilation of \fIpatObj\fR: .RS 2 .TP \fBTCL_REG_ADVANCED\fR Compile advanced regular expressions (`AREs'). This mode corresponds to -the normal regular expression syntax accepted by the Tcl regexp and -regsub commands. +the normal regular expression syntax accepted by the Tcl \fBregexp\fR and +\fBregsub\fR commands. .TP \fBTCL_REG_EXTENDED\fR Compile extended regular expressions (`EREs'). This mode corresponds @@ -232,7 +232,7 @@ regular expressions or strings. With this flag, `[^' bracket expressions and `.' never match newline, `^' matches an empty string after any newline in addition to its normal function, and `$' matches an empty string before any newline in addition to its normal function. -\fBREG_NEWLINE\fR is the bitwise OR of \fBREG_NLSTOP\fR and +\fBREG_NEWLINE\fR is the bit-wise OR of \fBREG_NLSTOP\fR and \fBREG_NLANCH\fR. .TP \fBTCL_REG_NLSTOP\fR @@ -244,7 +244,7 @@ expressions and `.' never match newline. .TP \fBTCL_REG_NLANCH\fR Compile for inverse partial newline-sensitive matching, -with the behavior of +with the behavior of `^' and `$' (the ``anchors'') affected, but not the behavior of `[^' bracket expressions and `.'. In this mode `^' matches an empty string after any newline in addition to its normal function, and `$' matches @@ -281,7 +281,7 @@ of subexpressions will be remembered. Matching begins at the specified Unicode character index given by \fIoffset\fR. Unlike \fBTcl_RegExpExec\fR, the behavior of anchors is not affected by the offset value. Instead the behavior of the anchors is explicitly -controlled by the \fIeflags\fR argument, which is a bitwise OR of +controlled by the \fIeflags\fR argument, which is a bit-wise OR of zero or more of the following flags: .RS 2 .TP diff --git a/doc/SetResult.3 b/doc/SetResult.3 index 5a86be2..db1a5dc 100644 --- a/doc/SetResult.3 +++ b/doc/SetResult.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: SetResult.3,v 1.7 2002/01/25 20:40:55 dgp Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.8 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" @@ -49,7 +49,7 @@ Address of procedure to call to release storage at \fIstring\fR, or \fBTCL_STATIC\fR, \fBTCL_DYNAMIC\fR, or \fBTCL_VOLATILE\fR. .AP va_list argList in -An argument list which must have been initialised using +An argument list which must have been initialized using \fBTCL_VARARGS_START\fR, and cleared using \fBva_end\fR. .BE @@ -84,7 +84,7 @@ references to it remain. The object's reference count is not incremented; if the caller needs to retain a long-term pointer to the object they should use \fBTcl_IncrRefCount\fR to increment its reference count -in order to keep it from being freed too early or accidently changed. +in order to keep it from being freed too early or accidentally changed. .PP \fBTcl_SetResult\fR arranges for \fIstring\fR to be the result for the current Tcl diff --git a/doc/StdChannels.3 b/doc/StdChannels.3 index c8a8449..73a5776 100644 --- a/doc/StdChannels.3 +++ b/doc/StdChannels.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: StdChannels.3,v 1.8 2002/11/15 15:34:17 dkf Exp $ +'\" RCS: @(#) $Id: StdChannels.3,v 1.9 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH "Standard Channels" 3 7.5 Tcl "Tcl Library Procedures" @@ -49,7 +49,7 @@ Windows NT service.) .TP 1) A single standard channel is initialized when it is explicitly -specified in a call to \fBTcl_SetStdChannel\fR. The state of the +specified in a call to \fBTcl_SetStdChannel\fR. The states of the other standard channels are unaffected. .sp Missing platform-specific standard channels do not matter here. This diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index c90cbca..5aa3eda 100644 --- a/doc/SubstObj.3 +++ b/doc/SubstObj.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: SubstObj.3,v 1.1 2001/07/12 13:15:09 dkf Exp $ +'\" RCS: @(#) $Id: SubstObj.3,v 1.2 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures" @@ -53,12 +53,12 @@ When the \fBTCL_SUBST_VARIABLES\fR bit is set in \fIflags\fR, sequences that look like variable substitutions for Tcl commands are replaced by the contents of the named variable. .PP -When th \fBTCL_SUBST_COMMANDS\fR bit is set in \fIflags\fR, sequences +When the \fBTCL_SUBST_COMMANDS\fR bit is set in \fIflags\fR, sequences that look like command substitutions for Tcl commands are replaced by -the result of evaluating that script. Where an uncaught continue -exception occurs during the evaluation of a command substitution, an -empty string is substituted for the command. Where an uncaught break -exception occurs during the evaluation of a command substitution, the +the result of evaluating that script. Where an uncaught `continue +exception' occurs during the evaluation of a command substitution, an +empty string is substituted for the command. Where an uncaught `break +exception' occurs during the evaluation of a command substitution, the result of the whole substitution on \fIobjPtr\fR will be truncated at the point immediately before the start of the command substitution, and no characters will be added to the result or substitutions diff --git a/doc/TCL_MEM_DEBUG.3 b/doc/TCL_MEM_DEBUG.3 index eca4b40..6052238 100644 --- a/doc/TCL_MEM_DEBUG.3 +++ b/doc/TCL_MEM_DEBUG.3 @@ -3,18 +3,18 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.6 2002/11/15 15:34:17 dkf Exp $ +'\" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.7 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH TCL_MEM_DEBUG 3 8.1 Tcl "Tcl Library Procedures" .BS .SH NAME -TCL_MEM_DEBUG \- Compile-time flag to enable Tcl memory debugging. +TCL_MEM_DEBUG \- Compile-time flag to enable Tcl memory debugging .BE .SH DESCRIPTION When Tcl is compiled with \fBTCL_MEM_DEBUG\fR defined, a powerful set -of memory debugging aids are included in the compiled binary. This +of memory debugging aids is included in the compiled binary. This includes C and Tcl functions which can aid with debugging memory leaks, memory allocation overruns, and other memory related errors. @@ -22,12 +22,14 @@ errors. .SH "ENABLING MEMORY DEBUGGING" .PP To enable memory debugging, Tcl should be recompiled from scratch with -\fBTCL_MEM_DEBUG\fR defined. This will also compile in a non-stub +\fBTCL_MEM_DEBUG\fR defined (e.g. by passing the +\fI\-\-enable\-symbols=mem\fR flag to the \fIconfigure\fR script when +building). This will also compile in a non-stub version of \fBTcl_InitMemory\fR to add the \fBmemory\fR command to Tcl. .PP \fBTCL_MEM_DEBUG\fR must be either left defined for all modules or undefined for all modules that are going to be linked together. If they are not, link -errors will occur, with either \fBTclDbCkfree\fR and \fBTcl_DbCkalloc\fR or +errors will occur, with either \fBTcl_DbCkfree\fR and \fBTcl_DbCkalloc\fR or \fBTcl_Ckalloc\fR and \fBTcl_Ckfree\fR being undefined. .PP Once memory debugging support has been compiled into Tcl, the C diff --git a/doc/Thread.3 b/doc/Thread.3 index 72b572d..48b7d01 100644 --- a/doc/Thread.3 +++ b/doc/Thread.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: Thread.3,v 1.17 2004/04/26 09:16:50 dkf Exp $ +'\" RCS: @(#) $Id: Thread.3,v 1.18 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Threads 3 "8.1" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_ConditionNotify, Tcl_ConditionWait, Tcl_ConditionFinalize, Tcl_GetThreadData, Tcl_MutexLock, Tcl_MutexUnlock, Tcl_MutexFinalize, Tcl_CreateThread, Tcl_JoinThread \- Tcl thread support. +Tcl_ConditionNotify, Tcl_ConditionWait, Tcl_ConditionFinalize, Tcl_GetThreadData, Tcl_MutexLock, Tcl_MutexUnlock, Tcl_MutexFinalize, Tcl_CreateThread, Tcl_JoinThread \- Tcl thread support .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -103,9 +103,9 @@ specialties. Using the second value marks the new thread as \fIjoinable\fR. This means that another thread can wait for the such marked thread to exit and join it. .PP -Restrictions: On some unix systems the pthread-library does not -contain the functionality to specify the stacksize of a thread. The -specified value for the stacksize is ignored on these systems. +Restrictions: On some UNIX systems the pthread-library does not +contain the functionality to specify the stack size of a thread. The +specified value for the stack size is ignored on these systems. Windows currently does not support joinable threads. This flag value is therefore ignored on this platform. .PP @@ -133,7 +133,7 @@ allocated and initialized to all zeros the first time each thread asks for it. The storage is automatically deallocated by \fBTcl_FinalizeThread\fR. .SS "SYNCHRONIZATION AND COMMUNICATION" Tcl provides \fBTcl_ThreadQueueEvent\fR and \fBTcl_ThreadAlert\fR -for handling event queueing in multithreaded applications. See +for handling event queuing in multithreaded applications. See the \fBNotifier\fR manual page for more information on these procedures. .PP A mutex is a lock that is used to serialize all threads through a piece @@ -170,7 +170,7 @@ The \fBTcl_ConditionNotify\fR, \fBTcl_ConditionWait\fR and not compiling with threads enabled. .SS INITIALIZATION .PP -All of these synchronization objects are self initializing. +All of these synchronization objects are self-initializing. They are implemented as opaque pointers that should be NULL upon first use. The mutexes and condition variables are diff --git a/doc/ToUpper.3 b/doc/ToUpper.3 index 639dd61..15539ad 100644 --- a/doc/ToUpper.3 +++ b/doc/ToUpper.3 @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ToUpper.3,v 1.2 1999/04/16 00:46:33 stanton Exp $ +'\" RCS: @(#) $Id: ToUpper.3,v 1.3 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_UtfToUpper 3 "8.1" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_UniCharToUpper, Tcl_UniCharToLower, Tcl_UniCharToTitle, Tcl_UtfToUpper, Tcl_UtfToLower, Tcl_UtfToTitle \- routines for manipulating the case of Unicode characters and UTF-8 strings. +Tcl_UniCharToUpper, Tcl_UniCharToLower, Tcl_UniCharToTitle, Tcl_UtfToUpper, Tcl_UtfToLower, Tcl_UtfToTitle \- routines for manipulating the case of Unicode characters and UTF-8 strings .SH SYNOPSIS .nf \fB#include <tcl.h>\fR diff --git a/doc/TraceVar.3 b/doc/TraceVar.3 index 0807a7e..acaaad3 100644 --- a/doc/TraceVar.3 +++ b/doc/TraceVar.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: TraceVar.3,v 1.8 2002/08/05 03:24:39 dgp Exp $ +'\" RCS: @(#) $Id: TraceVar.3,v 1.9 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_TraceVar 3 7.4 Tcl "Tcl Library Procedures" @@ -346,7 +346,7 @@ trace procedures will always be invoked. .SH "RESTRICTIONS" .PP A trace procedure can be called at any time, even when there -is a partially-formed result in the interpreter's result area. If +is a partially formed result in the interpreter's result area. If the trace procedure does anything that could damage this result (such as calling \fBTcl_Eval\fR) then it must save the original values of the interpreter's \fBresult\fR and \fBfreeProc\fR fields and restore @@ -4,13 +4,13 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Utf.3,v 1.15 2003/07/18 22:17:35 dkf Exp $ +'\" RCS: @(#) $Id: Utf.3,v 1.16 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Utf 3 "8.1" Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_UniChar, Tcl_UniCharCaseMatch, Tcl_UniCharNcasecmp, Tcl_UniCharToUtf, Tcl_UtfToUniChar, Tcl_UniCharToUtfDString, Tcl_UtfToUniCharDString, Tcl_UniCharLen, Tcl_UniCharNcmp, Tcl_UtfCharComplete, Tcl_NumUtfChars, Tcl_UtfFindFirst, Tcl_UtfFindLast, Tcl_UtfNext, Tcl_UtfPrev, Tcl_UniCharAtIndex, Tcl_UtfAtIndex, Tcl_UtfBackslash \- routines for manipulating UTF-8 strings. +Tcl_UniChar, Tcl_UniCharCaseMatch, Tcl_UniCharNcasecmp, Tcl_UniCharToUtf, Tcl_UtfToUniChar, Tcl_UniCharToUtfDString, Tcl_UtfToUniCharDString, Tcl_UniCharLen, Tcl_UniCharNcmp, Tcl_UtfCharComplete, Tcl_NumUtfChars, Tcl_UtfFindFirst, Tcl_UtfFindLast, Tcl_UtfNext, Tcl_UtfPrev, Tcl_UniCharAtIndex, Tcl_UtfAtIndex, Tcl_UtfBackslash \- routines for manipulating UTF-8 strings .SH SYNOPSIS .nf \fB#include <tcl.h>\fR @@ -103,7 +103,7 @@ negative, all bytes up to the first null byte are used. The length of the Unicode string in characters. Must be greater than or equal to 0. .AP "Tcl_DString" *dstPtr in/out -A pointer to a previously-initialized \fBTcl_DString\fR. +A pointer to a previously initialized \fBTcl_DString\fR. .AP "unsigned long" num in The number of characters to compare. .AP "CONST char" *start in @@ -140,7 +140,7 @@ in \fIbuf\fR. .PP \fBTcl_UtfToUniChar\fR reads one UTF-8 character starting at \fIsrc\fR and stores it as a Tcl_UniChar in \fI*chPtr\fR. The return value is the -number of bytes read from \fIsrc\fR.. The caller must ensure that the +number of bytes read from \fIsrc\fR. The caller must ensure that the source buffer is long enough such that this routine does not run off the end and dereference non-existent or random memory; if the source buffer is known to be null-terminated, this will not happen. If the input is @@ -149,15 +149,15 @@ byte of \fIsrc\fR in \fI*chPtr\fR as a Tcl_UniChar between 0x0000 and 0x00ff and return 1. .PP \fBTcl_UniCharToUtfDString\fR converts the given Unicode string -to UTF-8, storing the result in a previously-initialized \fBTcl_DString\fR. +to UTF-8, storing the result in a previously initialized \fBTcl_DString\fR. You must specify the length of the given Unicode string. The return value is a pointer to the UTF-8 representation of the Unicode string. Storage for the return value is appended to the end of the \fBTcl_DString\fR. .PP \fBTcl_UtfToUniCharDString\fR converts the given UTF-8 string to Unicode, -storing the result in the previously-initialized \fBTcl_DString\fR. -you may either specify the length of the given UTF-8 string or "-1", +storing the result in the previously initialized \fBTcl_DString\fR. +You may either specify the length of the given UTF-8 string or "-1", in which case \fBTcl_UtfToUniCharDString\fR uses \fBstrlen\fR to calculate the length. The return value is a pointer to the Unicode representation of the UTF-8 string. Storage for the return value @@ -170,7 +170,7 @@ the number of Unicode characters (not bytes) in that string. .PP \fBTcl_UniCharNcmp\fR and \fBTcl_UniCharNcasecmp\fR correspond to \fBstrncmp\fR and \fBstrncasecmp\fR, respectively, for Unicode characters. -They accepts two null-terminated Unicode strings and the number of characters +They accept two null-terminated Unicode strings and the number of characters to compare. Both strings are assumed to be at least \fIlen\fR characters long. \fBTcl_UniCharNcmp\fR compares the two strings character-by-character according to the Unicode character ordering. It returns an integer greater diff --git a/doc/WrongNumArgs.3 b/doc/WrongNumArgs.3 index bf96206..8d60608 100644 --- a/doc/WrongNumArgs.3 +++ b/doc/WrongNumArgs.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: WrongNumArgs.3,v 1.5 2002/07/01 18:24:39 jenglish Exp $ +'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.6 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH Tcl_WrongNumArgs 3 8.0 Tcl "Tcl Library Procedures" @@ -63,7 +63,7 @@ subcommand we would like to use the full subcommand name rather than the abbreviation. If the \fBTcl_WrongNumArgs\fR command finds any \fIindexObjects\fR in the \fIobjv\fR array it will use the full subcommand name in the error message instead of the abbreviated name that was -originally passed in. Using the above example, lets assume that +originally passed in. Using the above example, let us assume that \fIbar\fR is actually an abbreviation for \fIbarfly\fR and the object is now an indexObject because it was passed to \fBTcl_GetIndexFromObj\fR. In this case the error message would be: diff --git a/doc/close.n b/doc/close.n index d5ba90b..78020b0 100644 --- a/doc/close.n +++ b/doc/close.n @@ -5,14 +5,14 @@ '\" 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.6 2004/05/25 20:42:43 dkf Exp $ +'\" RCS: @(#) $Id: close.n,v 1.7 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH close n 7.5 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -close \- Close an open channel. +close \- Close an open channel .SH SYNOPSIS \fBclose \fIchannelId\fR .BE @@ -4,14 +4,14 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: dict.n,v 1.4 2004/05/27 23:53:55 dkf Exp $ +'\" RCS: @(#) $Id: dict.n,v 1.5 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH dict n 8.5 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -dict \- Manipulate dictionaries. +dict \- Manipulate dictionaries .SH SYNOPSIS \fBdict \fIoption arg \fR?\fIarg ...\fR? .BE @@ -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: expr.n,v 1.13 2004/05/24 12:47:56 dkf Exp $ +'\" RCS: @(#) $Id: expr.n,v 1.14 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH expr n 8.5 Tcl "Tcl Built-In Commands" @@ -19,7 +19,7 @@ expr \- Evaluate an expression .SH DESCRIPTION .PP -Concatenates \fIarg\fR's (adding separator spaces between them), +Concatenates \fIarg\fRs (adding separator spaces between them), evaluates the result as a Tcl expression, and returns the value. The operators permitted in Tcl expressions are a subset of the operators permitted in C expressions, and they have the @@ -62,7 +62,7 @@ possible at all.) .PP Operands may be specified in any of the following ways: .IP [1] -As an numeric value, either integer or floating-point. +As a numeric value, either integer or floating-point. .IP [2] As a Tcl variable, using standard \fB$\fR notation. The variable's value will be used as the operand. @@ -84,11 +84,10 @@ As a mathematical function whose arguments have any of the above forms for operands, such as \fBsin($x)\fR. See below for a list of defined functions. .LP -Where substitutions occur above (e.g. inside quoted strings), they +Where the above substitutions occur (e.g. inside quoted strings), they are performed by the expression's instructions. -However, an additional layer of substitution may already have -been performed by the command parser before the expression -processor was called. +However, the command parser may already have performed one layer of +substitution before the expression processor was called. As discussed below, it is usually best to enclose expressions in braces to prevent the command parser from performing substitutions on the contents. diff --git a/doc/fcopy.n b/doc/fcopy.n index 30b8dfe..a90cc7b 100644 --- a/doc/fcopy.n +++ b/doc/fcopy.n @@ -5,14 +5,14 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fcopy.n,v 1.3 2001/05/19 16:59:04 andreas_kupries Exp $ +'\" RCS: @(#) $Id: fcopy.n,v 1.4 2004/09/06 09:44:56 dkf Exp $ '\" .so man.macros .TH fcopy n 8.0 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -fcopy \- Copy data from one channel to another. +fcopy \- Copy data from one channel to another .SH SYNOPSIS \fBfcopy \fIinchan\fR \fIoutchan\fR ?\fB\-size \fIsize\fR? ?\fB\-command \fIcallback\fR? .BE @@ -6,14 +6,14 @@ '\" 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.21 2004/08/31 15:19:36 dkf Exp $ +'\" RCS: @(#) $Id: http.n,v 1.22 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH "http" n 2.5 http "Tcl Bundled Packages" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -http \- Client-side implementation of the HTTP/1.0 protocol. +http \- Client-side implementation of the HTTP/1.0 protocol .SH SYNOPSIS \fBpackage require http ?2.5?\fR .sp @@ -4,14 +4,14 @@ '\" 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.10 2004/07/01 07:59:22 dkf Exp $ +'\" RCS: @(#) $Id: load.n,v 1.11 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH load n 7.5 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -load \- Load machine code and initialize new commands. +load \- Load machine code and initialize new commands .SH SYNOPSIS \fBload \fIfileName\fR .br diff --git a/doc/memory.n b/doc/memory.n index 7737705..034c41e 100644 --- a/doc/memory.n +++ b/doc/memory.n @@ -3,13 +3,13 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: memory.n,v 1.5 2002/11/15 15:34:17 dkf Exp $ +'\" RCS: @(#) $Id: memory.n,v 1.6 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH memory n 8.1 Tcl "Tcl Built-In Commands" .BS .SH NAME -memory \- Control Tcl memory debugging capabilities. +memory \- Control Tcl memory debugging capabilities .SH SYNOPSIS \fBmemory \fIoption \fR?\fIarg arg ...\fR? .BE diff --git a/doc/packagens.n b/doc/packagens.n index 92dd621..685ff48 100644 --- a/doc/packagens.n +++ b/doc/packagens.n @@ -2,15 +2,14 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: packagens.n,v 1.4 2002/07/01 18:24:39 jenglish Exp $ +'\" RCS: @(#) $Id: packagens.n,v 1.5 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH pkg::create n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -pkg::create \- Construct an appropriate \fBpackage ifneeded\fR -command for a given package specification +pkg::create \- Construct an appropriate `package ifneeded' command for a given package specification .SH SYNOPSIS \fB::pkg::create \fI\-name packageName\fR \fI\-version packageVersion\fR ?\fI\-load filespec\fR? ... ?\fI\-source filespec\fR? ... .BE diff --git a/doc/re_syntax.n b/doc/re_syntax.n index dece078..673e5b2 100644 --- a/doc/re_syntax.n +++ b/doc/re_syntax.n @@ -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: re_syntax.n,v 1.3 1999/07/14 19:09:36 jpeek Exp $ +'\" RCS: @(#) $Id: re_syntax.n,v 1.4 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH re_syntax n "8.1" Tcl "Tcl Built-In Commands" .BS .SH NAME -re_syntax \- Syntax of Tcl regular expressions. +re_syntax \- Syntax of Tcl regular expressions .BE .SH DESCRIPTION @@ -4,14 +4,14 @@ '\" 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.6 2004/09/01 09:50:45 dkf Exp $ +'\" RCS: @(#) $Id: safe.n,v 1.7 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH "Safe Tcl" n 8.0 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -Safe\ Base \- A mechanism for creating and manipulating safe interpreters. +Safe\ Base \- A mechanism for creating and manipulating safe interpreters .SH SYNOPSIS \fB::safe::interpCreate\fR ?\fIslave\fR? ?\fIoptions...\fR? .sp @@ -209,7 +209,7 @@ thus specifies the safe interpreter will be allowed to load packages into its own sub-interpreters. .TP \fB\-deleteHook\fR \fIscript\fR -When this option is given an non empty \fIscript\fR, it will be +When this option is given a non-empty \fIscript\fR, it will be evaluated in the master with the name of the safe interpreter as an additional argument just before actually deleting the safe interpreter. diff --git a/doc/tclsh.1 b/doc/tclsh.1 index ea3af4c..b8a73d8 100644 --- a/doc/tclsh.1 +++ b/doc/tclsh.1 @@ -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: tclsh.1,v 1.9 2003/09/05 21:52:11 dgp Exp $ +'\" RCS: @(#) $Id: tclsh.1,v 1.10 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH tclsh 1 "" Tcl "Tcl Applications" @@ -93,7 +93,7 @@ When \fBtclsh\fR starts up, it treats all three lines as comments, since the backslash at the end of the second line causes the third line to be treated as part of the comment on the second line. .PP -You should note that it is also common practise to install tclsh with +You should note that it is also common practice to install tclsh with its version number as part of the name. This has the advantage of allowing multiple versions of Tcl to exist on the same system at once, but also the disadvantage of making it harder to write scripts that diff --git a/doc/tcltest.n b/doc/tcltest.n index 1feedda..5a27864 100644 --- a/doc/tcltest.n +++ b/doc/tcltest.n @@ -8,7 +8,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tcltest.n,v 1.42 2004/02/18 01:41:42 dgp Exp $ +'\" RCS: @(#) $Id: tcltest.n,v 1.43 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH "tcltest" n 2.2 tcltest "Tcl Bundled Packages" @@ -683,7 +683,7 @@ that match any of the patterns in [\fBconfigure -file\fR] and match none of the patterns in [\fBconfigure -notfile\fR] is generated and sorted. Then each file will be evaluated in turn. If [\fBconfigure -singleproc\fR] is true, then each file will -be [\fBsource\fR]d in the caller's context. If if is false, +be [\fBsource\fR]d in the caller's context. If it is false, then a copy of [\fBinterpreter\fR] will be [\fBexec\fR]d to evaluate each file. The multi-process operation is useful when testing can cause errors so severe that a process diff --git a/doc/tclvars.n b/doc/tclvars.n index bacd39c..f3da299 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.15 2004/03/17 18:14:12 das Exp $ +'\" RCS: @(#) $Id: tclvars.n,v 1.16 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH tclvars n 8.0 Tcl "Tcl Built-In Commands" @@ -277,8 +277,8 @@ The value of this variable can be set to control how much tracing information is displayed during bytecode compilation. By default, tcl_traceCompile is zero and no information is displayed. -Setting tcl_traceCompile to 1 generates a one line summary in stdout -whenever a procedure or top level command is compiled. +Setting tcl_traceCompile to 1 generates a one-line summary in stdout +whenever a procedure or top-level command is compiled. Setting it to 2 generates a detailed listing in stdout of the bytecode instructions emitted during every compilation. This variable is useful in @@ -294,7 +294,7 @@ The value of this variable can be set to control how much tracing information is displayed during bytecode execution. By default, tcl_traceExec is zero and no information is displayed. -Setting tcl_traceExec to 1 generates a one line trace in stdout +Setting tcl_traceExec to 1 generates a one-line trace in stdout on each call to a Tcl procedure. Setting it to 2 generates a line of output whenever any Tcl command is invoked @@ -302,7 +302,7 @@ that contains the name of the command and its arguments. Setting it to 3 produces a detailed trace showing the result of executing each bytecode instruction. Note that when tcl_traceExec is 2 or 3, -commands such as set and incr +commands such as \fBset\fR and \fBincr\fR that have been entirely replaced by a sequence of bytecode instructions are not shown. Setting this variable is useful in diff --git a/doc/unload.n b/doc/unload.n index b0aab2e..8b860ee 100644 --- a/doc/unload.n +++ b/doc/unload.n @@ -4,14 +4,14 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: unload.n,v 1.4 2004/05/30 14:25:51 dkf Exp $ +'\" RCS: @(#) $Id: unload.n,v 1.5 2004/09/06 09:44:57 dkf Exp $ '\" .so man.macros .TH unload n 8.5 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -unload \- Unload machine code. +unload \- Unload machine code .SH SYNOPSIS \fBunload \fR?\fIswitches\fR? \fIfileName\fR .br |