diff options
author | dgp <dgp@noemail.net> | 2001-12-10 15:50:46 (GMT) |
---|---|---|
committer | dgp <dgp@noemail.net> | 2001-12-10 15:50:46 (GMT) |
commit | 781cfa55c59f46794e4ef55a6ac751b27ace541e (patch) | |
tree | 14f39e6f616fa7c6e1322285b7513c0ea2df1327 | |
parent | 5c5fa24ee38cd45d00384839700e032be25a3ddd (diff) | |
download | tcl-781cfa55c59f46794e4ef55a6ac751b27ace541e.zip tcl-781cfa55c59f46794e4ef55a6ac751b27ace541e.tar.gz tcl-781cfa55c59f46794e4ef55a6ac751b27ace541e.tar.bz2 |
* Several typo and formatting corrections discovered
during conversion to TMML. Thanks to Joe English. [Patch 490514]
FossilOrigin-Name: c6a543090c1786c744bc8ec7be936816cdffb5ea
-rw-r--r-- | ChangeLog | 20 | ||||
-rw-r--r-- | doc/Access.3 | 4 | ||||
-rw-r--r-- | doc/CrtChannel.3 | 4 | ||||
-rw-r--r-- | doc/DString.3 | 4 | ||||
-rw-r--r-- | doc/ExprLong.3 | 4 | ||||
-rw-r--r-- | doc/FileSystem.3 | 43 | ||||
-rw-r--r-- | doc/GetStdChan.3 | 4 | ||||
-rw-r--r-- | doc/OpenFileChnl.3 | 4 | ||||
-rw-r--r-- | doc/StdChannels.3 | 6 | ||||
-rw-r--r-- | doc/TCL_MEM_DEBUG.3 | 8 | ||||
-rw-r--r-- | doc/Tcl_Main.3 | 4 | ||||
-rw-r--r-- | doc/Utf.3 | 4 | ||||
-rw-r--r-- | doc/file.n | 6 | ||||
-rw-r--r-- | doc/tclsh.1 | 4 |
14 files changed, 51 insertions, 68 deletions
@@ -1,4 +1,21 @@ -2001-12-07 Miguel Sofer <msofer@users.sourceforge.net> +2001-12-10 Don Porter <dgp@users.sourceforge.net> + + * doc/Access.3: + * doc/CrtChannel.3: + * doc/DString.3: + * doc/ExprLong.3: + * doc/FileSystem.3: + * doc/GetStdChan.3: + * doc/OpenFileChnl.3: + * doc/StdChannels.3: + * doc/TCL_MEM_DEBUG.3: + * doc/Tcl_Main.3: + * doc/Utf.3: + * doc/file.n: + * doc/tclsh.1: Several typo and formatting corrections discovered + during conversion to TMML. Thanks to Joe English. [Patch 490514] + +2001-12-10 Miguel Sofer <msofer@users.sourceforge.net> * generic/tclCompCmds.c: * generic/tclCompExpr.c: @@ -8,7 +25,6 @@ * generic/tclProc.c: fixed the calculation of the maximal stack depth required by bytecodes [Bug 483611]. - 2001-12-07 Miguel Sofer <msofer@users.sourceforge.net> * generic/tclVar.c: diff --git a/doc/Access.3 b/doc/Access.3 index daa4f53..a04d243 100644 --- a/doc/Access.3 +++ b/doc/Access.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: Access.3,v 1.4 2001/07/31 19:12:05 vincentdarley Exp $ +'\" RCS: @(#) $Id: Access.3,v 1.5 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH Tcl_Access 3 8.1 Tcl "Tcl Library Procedures" @@ -72,4 +72,4 @@ is filled with data. Otherwise, -1 is returned, and no stat info is given. .SH KEYWORDS -stat access +stat, access diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 5178f93..3ca35b5 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.11 2001/09/11 18:29:56 andreas_kupries Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.12 2001/12/10 15:50:46 dgp Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -211,7 +211,7 @@ channels. Once a standard channel was initialized either through a call to \fBTcl_GetStdChannel\fR or a call to \fBTcl_SetStdChannel\fR closing this standard channel will cause the next call to \fBTcl_CreateChannel\fR to make the new channel the new standard -channel too. See \fBTcl_StandardChannel\fR for a general treatise +channel too. See \fBTcl_StandardChannels\fR for a general treatise about standard channels and the behaviour of the Tcl library with regard to them. .PP diff --git a/doc/DString.3 b/doc/DString.3 index 65e66fd..348a674 100644 --- a/doc/DString.3 +++ b/doc/DString.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: DString.3,v 1.6 2001/09/24 21:10:32 dgp Exp $ +'\" RCS: @(#) $Id: DString.3,v 1.7 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures" .BS .SH NAME -Tcl_DStringInit, Tcl_DStringAppend, Tcl_DStringAppendElement, Tcl_DStringStartSublist, Tcl_DStringEndSublist, Tcl_DStringLength, Tcl_DStringValue, Tcl_DStringSetLength, Tcl_DStringFree, Tcl_DStringResult, Tcl_DStringGetResult \- manipulate dynamic strings +Tcl_DStringInit, Tcl_DStringAppend, Tcl_DStringAppendElement, Tcl_DStringStartSublist, Tcl_DStringEndSublist, Tcl_DStringLength, Tcl_DStringValue, Tcl_DStringSetLength, Tcl_DStringTrunc, Tcl_DStringFree, Tcl_DStringResult, Tcl_DStringGetResult \- manipulate dynamic strings .SH SYNOPSIS .nf \fB#include <tcl.h>\fR diff --git a/doc/ExprLong.3 b/doc/ExprLong.3 index 03ad358..9cc3900 100644 --- a/doc/ExprLong.3 +++ b/doc/ExprLong.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: ExprLong.3,v 1.4 2001/04/24 20:59:17 kennykb Exp $ +'\" RCS: @(#) $Id: ExprLong.3,v 1.5 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" @@ -56,7 +56,7 @@ and return the result in one of four different forms. The expression can have any of the forms accepted by the \fBexpr\fR command. Note that these procedures have been largely replaced by the object-based procedures \fBTcl_ExprLongObj\fR, \fBTcl_ExprDoubleObj\fR, -\fBTcl_ExprBooleanObj\fR, and \fBTcl_ExprStringObj\fR. +\fBTcl_ExprBooleanObj\fR, and \fBTcl_ExprObj\fR. Those object-based procedures evaluate an expression held in a Tcl object instead of a string. The object argument can retain an internal representation diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index 018f81e..7e2ee6f 100644 --- a/doc/FileSystem.3 +++ b/doc/FileSystem.3 @@ -4,10 +4,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: FileSystem.3,v 1.12 2001/11/19 17:45:12 vincentdarley Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.13 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros -.TH Tcl_FSCopyFile 3 8.4 Tcl "Tcl Library Procedures" +.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" .BS .SH NAME Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSLoadFile, Tcl_FSMatchInDirectory, Tcl_FSLink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo \- procedures to interact with any filesystem @@ -543,8 +543,6 @@ further categorization of files. .PP A valid list object is returned, unless the path object is not recognized, when NULL will be returned. -.PP - .SH TCL_FILESYSTEM .PP A filesystem provides a \fBTcl_Filesystem\fR structure that contains @@ -636,7 +634,6 @@ Any functions which take path names in Tcl_Obj form take those names in UTF\-8 form. The filesystem infrastructure API is designed to support efficient, cached conversion of these UTF\-8 paths to other native representations. -.PP .SH TYPENAME .PP The \fItypeName\fR field contains a null-terminated string that @@ -649,18 +646,15 @@ The \fIstructureLength\fR field is generally implemented as \fIsizeof(Tcl_Filesystem)\fR, and is there to allow easier binary backwards compatibility if the size of the structure changes in a future Tcl release. -.PP .SH VERSION .PP The \fIversion\fR field should be set to \fBTCL_FILESYSTEM_VERSION_1\fR. -.PP -.SH FILESYSTEM INFRASTRUCTURE +.SH "FILESYSTEM INFRASTRUCTURE" .PP These fields contain addresses of functions which are used to associate a particular filesystem with a file path, and deal with the internal handling of path representations, for example copying and freeing such representations. -.PP .SH PATHINFILESYSTEMPROC .PP The \fIpathInFilesystemProc\fR field contains the address of a function @@ -682,7 +676,6 @@ typedef int Tcl_FSPathInFilesystemProc( Tcl_Obj *\fIpathPtr\fR, ClientData *\fIclientDataPtr\fR); .CE -.PP .SH DUPINTERNALREPPROC .PP This function makes a copy of a path's internal representation, and is @@ -694,7 +687,6 @@ regenerated later. typedef ClientData Tcl_FSDupInternalRepProc( ClientData \fIclientData\fR); .CE -.PP .SH FREEINTERNALREPPROC Free the internal representation. This must be implemented if internal representations need freeing (i.e. if some memory is allocated when an @@ -704,7 +696,6 @@ internal representation is generated), but may otherwise be NULL. typedef void Tcl_FSFreeInternalRepProc( ClientData \fIclientData\fR); .CE -.PP .SH INTERNALTONORMALIZEDPROC .PP Function to convert internal representation to a normalized path. Only @@ -716,7 +707,6 @@ representation is the normalized path. typedef Tcl_Obj* Tcl_FSInternalToNormalizedProc( ClientData \fIclientData\fR); .CE -.PP .SH CREATEINTERNALREPPROC .PP Function to take a path object, and calculate an internal @@ -729,7 +719,6 @@ immediately creates an internal representation for paths it accepts. typedef ClientData Tcl_FSCreateInternalRepProc( Tcl_Obj *\fIpathPtr\fR); .CE -.PP .SH NORMALIZEPATHPROC .PP Function to normalize a path. Should be implemented for all @@ -747,8 +736,7 @@ typedef int Tcl_FSNormalizePathProc( Tcl_Obj *\fIpathPtr\fR, int \fInextCheckpoint\fR); .CE -.PP -.SH FILESYSTEM OPERATIONS +.SH "FILESYSTEM OPERATIONS" .PP The fields in this section of the structure contain addresses of functions which are called to carry out the basic filesystem @@ -760,7 +748,6 @@ this may be desirable (for example, a read-only filesystem should not implement the last four functions, and a filesystem which does not support symbolic links need not implement the \fBreadlink\fR function, etc. The Tcl core expects filesystems to behave in this way). -.PP .SH FILESYSTEMPATHTYPEPROC .PP Function to determine the type of a path in this filesystem. May be @@ -774,7 +761,6 @@ or "ftp". typedef Tcl_Obj* Tcl_FSFilesystemPathTypeProc( Tcl_Obj *\fIpathPtr\fR); .CE -.PP .SH FILESYSTEMSEPARATORPROC .PP Function to return the separator character(s) for this filesystem. @@ -786,7 +772,6 @@ containing the string "/". typedef Tcl_Obj* Tcl_FSFilesystemSeparatorProc( Tcl_Obj *\fIpathPtr\fR); .CE -.PP .SH STATPROC .PP Function to process a \fBTcl_FSStat()\fR call. Must be implemented for any @@ -813,7 +798,6 @@ time. If the file represented by \fIpathPtr\fR exists, the \fBTcl_FSStatProc\fR returns 0 and the stat structure is filled with data. Otherwise, -1 is returned, and no stat info is given. -.PP .SH ACCESSPROC .PP Function to process a \fBTcl_FSAccess()\fR call. Must be implemented for @@ -867,7 +851,6 @@ interpreter; to register it, use \fBTcl_RegisterChannel\fR. If one of the standard channels, \fBstdin, stdout\fR or \fBstderr\fR was previously closed, the act of creating the new channel also assigns it as a replacement for the standard channel. -.PP .SH MATCHINDIRECTORYPROC .PP Function to process a \fBTcl_FSMatchInDirectory()\fR call. If not @@ -897,7 +880,6 @@ rather results should be added to the \fIresult\fR object given (which can be assumed to be a valid Tcl list). The matches added to \fIresult\fR should include any path prefix given in \fIpathPtr\fR (this usually means they will be absolute path specifications). - .PP .SH UTIMEPROC .PP Function to process a \fBTcl_FSUtime()\fR call. Required to allow setting @@ -915,7 +897,6 @@ should be changed to the values given in the \fItval\fR structure. .PP The return value is a standard Tcl result indicating whether an error occurred in the process. -.PP .SH LINKPROC .PP Function to process a \fBTcl_FSLink()\fR call. Should be implemented @@ -935,7 +916,6 @@ Tcl_DecrRefCount when the result is no longer needed. If \fItoPtr\fR is not NULL, the function should attempt to create a link. The result in this case should be \fItoPtr\fR if the link was successful and NULL otherwise. In this case the result is not owned by the caller. -.PP .SH LISTVOLUMESPROC .PP Function to list any filesystem volumes added by this filesystem. @@ -982,7 +962,6 @@ On completion of that use, Tcl will decrement its refCount. Hence if the list should be disposed of by Tcl when done, it should have a refCount of zero, and if the list should not be disposed of, the filesystem should ensure it retains a refCount on the object. -.PP .SH FILEATTRSGETPROC .PP Function to process a \fBTcl_FSFileAttrsGet()\fR call, used by 'file @@ -1002,7 +981,6 @@ the Tcl_FSFileAttrStringsProc, is a Tcl_Obj placed in objPtrRef (if TCL_OK was returned) and is likely to have a refCount of zero. Either way we must either store it somewhere (e.g. the Tcl result), or Incr/Decr its refCount to ensure it is properly freed. -.PP .SH FILEATTRSSETPROC .PP Function to process a \fBTcl_FSFileAttrsSet()\fR call, used by 'file @@ -1019,7 +997,6 @@ typedef int Tcl_FSFileAttrsSetProc( .PP The attribute value of the \fIindex\fR'th element in the list returned by the Tcl_FSFileAttrStringsProc should be set to the \fIobjPtr\fR given. -.PP .SH CREATEDIRECTORYPROC .PP Function to process a \fBTcl_FSCreateDirectory()\fR call. Should be @@ -1034,7 +1011,6 @@ The return value is a standard Tcl result indicating whether an error occurred in the process. If successful, a new directory should have been added to the filesystem in the location specified by \fIpathPtr\fR. -.PP .SH REMOVEDIRECTORYPROC .PP Function to process a 'Tcl_FSRemoveDirectory()' call. Should be @@ -1054,7 +1030,6 @@ occurred in the process. If successful, the directory specified by be deleted without error. If an error does occur, the name of the file or directory which caused the error should be placed in \fIerrorPtr\fR. -.PP .SH DELETEFILEPROC .PP Function to process a \fBTcl_FSDeleteFile()\fR call. Should be implemented @@ -1068,8 +1043,7 @@ typedef int Tcl_FSDeleteFileProc( The return value is a standard Tcl result indicating whether an error occurred in the process. If successful, the file specified by \fIpathPtr\fR should have been removed from the filesystem. -.PP -.SH FILESYSTEM EFFICIENCY +.SH "FILESYSTEM EFFICIENCY" .PP .SH LSTATPROC .PP @@ -1108,7 +1082,6 @@ name of the file which should become the copy of \fIsrcPathPtr\fR. It is never the name of a directory into which \fIsrcPathPtr\fR could be copied (i.e. the function is much simpler than the Tcl level 'file copy' subcommand). -.PP .SH RENAMEFILEPROC .PP Function to process a \fBTcl_FSRenameFile()\fR call. If not implemented, @@ -1124,7 +1097,6 @@ typedef int Tcl_FSRenameFileProc( .PP The return value is a standard Tcl result indicating whether an error occurred in the renaming process. -.PP .SH COPYDIRECTORYPROC .PP Function to process a \fBTcl_FSCopyDirectory()\fR call. If not @@ -1147,7 +1119,6 @@ directory-name which should become the mirror-image of \fIsrcPathPtr\fR. It is not the name of a directory into which \fIsrcPathPtr\fR should be copied (i.e. the function is much simpler than the Tcl level 'file copy' subcommand). -.PP .SH LOADFILEPROC .PP Function to process a \fBTcl_FSLoadFile()\fR call. If not implemented, Tcl @@ -1177,7 +1148,6 @@ the dynamically loaded file, and the \fIunloadProcPtr\fR should be filled in with the address of a procedure. The procedure will be called with the given clientData as its only parameter when Tcl needs to unload the file. -.PP .SH UNLOADFILEPROC .PP Function to unload a previously successfully loaded file. If load was @@ -1188,7 +1158,6 @@ cleanup action required. typedef void Tcl_FSUnloadFileProc( ClientData \fIclientData\fR); .CE -.PP .SH GETCWDPROC .PP Function to process a \fBTcl_FSGetCwd()\fR call. Most filesystems need not @@ -1227,8 +1196,6 @@ typedef int Tcl_FSChdirProc( The \fBTcl_FSChdirProc\fR changes the applications current working directory to the value specified in \fIpathPtr\fR. The function returns -1 on error or 0 on success. -.PP - .SH KEYWORDS stat access filesystem vfs diff --git a/doc/GetStdChan.3 b/doc/GetStdChan.3 index c78bc96..09c65d9 100644 --- a/doc/GetStdChan.3 +++ b/doc/GetStdChan.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: GetStdChan.3,v 1.3 2001/09/10 21:49:37 andreas_kupries Exp $ +'\" RCS: @(#) $Id: GetStdChan.3,v 1.4 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH Tcl_GetStdChannel 3 7.5 Tcl "Tcl Library Procedures" @@ -66,7 +66,7 @@ more than one standard channel is NULL, then the standard channels will be assigned starting with standard input, followed by standard output, with standard error being last. .PP -See \fBTcl_StandardChannel\fR for a general treatise about standard +See \fBTcl_StandardChannels\fR for a general treatise about standard channels and the behaviour of the Tcl library with regard to them. .PP diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index 321ed79..d778007 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.14 2001/12/07 17:38:33 dgp Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.15 2001/12/10 15:50:46 dgp Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -350,7 +350,7 @@ reference to a channel that is also registered in a Tcl interpreter. This procedure interacts with the code managing the standard channels. If no standard channels were initialized before the first call to \fBTcl_RegisterChannel\fR they will get initialized by that -call. See \fBTcl_StandardChannel\fR for a general treatise about +call. See \fBTcl_StandardChannels\fR for a general treatise about standard channels and the behaviour of the Tcl library with regard to them. diff --git a/doc/StdChannels.3 b/doc/StdChannels.3 index c3eb8bd..7d1f25b 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.6 2001/11/14 23:38:39 hobbs Exp $ +'\" RCS: @(#) $Id: StdChannels.3,v 1.7 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH "Standard Channels" 3 7.5 Tcl "Tcl Library Procedures" @@ -34,7 +34,7 @@ The public API procedures dealing directly with standard channels are \fBTcl_GetStdChannel\fR and \fBTcl_SetStdChannel\fR. Additional public APIs to consider are \fBTcl_RegisterChannel\fR, \fBTcl_CreateChannel\fR and \fBTcl_GetChannel\fR. -.SH Initialization of Tcl standard channels +.SH "INITIALIZATION OF TCL STANDARD CHANNELS" .PP Standard channels are initialized by the Tcl library in three cases: when explicitly requested, when implicitly required before returning @@ -89,7 +89,7 @@ application are designated as the Tcl standard channels. In other words, of the first four Tcl channels opened by the application the second to fourth are designated as the Tcl standard channels. .PP -.SH Re-initialization of Tcl standard channels +.SH "RE-INITIALIZATION OF TCL STANDARD CHANNELS" .PP Once a Tcl standard channel is initialized through one of the methods above, closing this Tcl standard channel will cause the next call to diff --git a/doc/TCL_MEM_DEBUG.3 b/doc/TCL_MEM_DEBUG.3 index 9092661..8d5646b 100644 --- a/doc/TCL_MEM_DEBUG.3 +++ b/doc/TCL_MEM_DEBUG.3 @@ -3,7 +3,7 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.3 2001/09/27 22:25:45 dgp Exp $ +'\" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.4 2001/12/10 15:50:46 dgp Exp $ '\" .so man.macros .TH TCL_MEM_DEBUG 3 8.1 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ includes C and Tcl functions which can aid with debugging memory leaks, memory allocation overruns, and other memory related errors. -.SH ENABLING MEMORY DEBUGGING +.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 @@ -34,7 +34,7 @@ functions \fBTcl_ValidateAllMemory\fR, and \fBTcl_DumpActiveMemory\fR, and the Tcl \fBmemory\fR command can be used to validate and examine memory usage. -.SH GUARD ZONES +.SH "GUARD ZONES" .PP When memory debugging is enabled, whenever a call to \fBckalloc\fR is made, slightly more memory than requested is allocated so the memory debugging @@ -55,7 +55,7 @@ This allows you to detect the common sorts of one-off problems, where not enough space was allocated to contain the data written, for example. -.SH DEBUGGING DIFFICULT MEMORY CORRUPTION PROBLEMS +.SH "DEBUGGING DIFFICULT MEMORY CORRUPTION PROBLEMS" .PP Normally, Tcl compiled with memory debugging enabled will make it easy to isolate a corruption problem. Turning on memory validation with diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index 388c70f..038eff9 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.4 2001/09/10 21:49:37 andreas_kupries Exp $ +'\" RCS: @(#) $Id: Tcl_Main.3,v 1.5 2001/12/10 15:50:47 dgp Exp $ '\" .so man.macros .TH Tcl_Main 3 8.4 Tcl "Tcl Library Procedures" @@ -80,7 +80,7 @@ typedef void Tcl_MainLoopProc(void); .PP \fBTcl_Main\fR and therefore all applications based upon it, like \fBtclsh\fR, use \fBTcl_GetStdChannel\fR to initialize the standard -channels to their default values. See \fBTcl_StandardChannel\fR for +channels to their default values. See \fBTcl_StandardChannels\fR for more information. .SH "SEE ALSO" @@ -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: Utf.3,v 1.9 2001/04/06 23:14:08 andreas_kupries Exp $ +'\" RCS: @(#) $Id: Utf.3,v 1.10 2001/12/10 15:50:47 dgp Exp $ '\" .so man.macros .TH Utf 3 "8.1" Tcl "Tcl Library Procedures" @@ -150,7 +150,7 @@ Unicode string. Storage for the return value is appended to the end of the \fBTcl_DString\fR. .PP \fBTcl_UtfToUniCharDString\fR coverts the given UTF-8 string to Unicode, -storing the result in the previously-initialized \fBTcl_Dstring\fR. +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 @@ -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.12 2001/11/19 17:45:12 vincentdarley Exp $ +'\" RCS: @(#) $Id: file.n,v 1.13 2001/12/10 15:50:47 dgp Exp $ '\" .so man.macros .TH file n 8.3 Tcl "Tcl Built-In Commands" @@ -259,9 +259,9 @@ Returns the value of the symbolic link given by \fIname\fR (i.e. the name of the file it points to). If \fIname\fR isn't a symbolic link or its value cannot be read, then an error is returned. On systems that don't support symbolic links this option is undefined. -.PP +.TP \fBfile rename \fR?\fB\-force\fR? ?\fB\-\|\-\fR? \fIsource\fR \fItarget\fR -.br +.TP \fBfile rename \fR?\fB\-force\fR? ?\fB\-\|\-\fR? \fIsource\fR ?\fIsource\fR ...? \fItargetDir\fR .RS The first form takes the file or directory specified by pathname diff --git a/doc/tclsh.1 b/doc/tclsh.1 index ebaba05..8341c3d 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.5 2001/09/10 21:49:37 andreas_kupries Exp $ +'\" RCS: @(#) $Id: tclsh.1,v 1.6 2001/12/10 15:50:47 dgp Exp $ '\" .so man.macros .TH tclsh 1 "" Tcl "Tcl Applications" @@ -125,7 +125,7 @@ incomplete commands. .SH "STANDARD CHANNELS" .PP -See \fBTcl_StandardChannel\fR for more explanations. +See \fBTcl_StandardChannels\fR for more explanations. .SH "SEE ALSO" fconfigure(1), tclvars(1) |