diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 14:44:18 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2004-10-07 14:44:18 (GMT) |
| commit | 4c14cd729fc9965bddaace767c865ce4a9825e89 (patch) | |
| tree | 2554bc56f705b4ab6f4a91f5f13a5f0c5871e69b | |
| parent | d471dc2738812a90f3c3dc91a601a5d2daf9362a (diff) | |
| download | tcl-4c14cd729fc9965bddaace767c865ce4a9825e89.zip tcl-4c14cd729fc9965bddaace767c865ce4a9825e89.tar.gz tcl-4c14cd729fc9965bddaace767c865ce4a9825e89.tar.bz2 | |
Update the .AS macro definition and take advantage of it's new-found power.
72 files changed, 351 insertions, 387 deletions
@@ -1,5 +1,9 @@ 2004-10-07 Donal K. Fellows <donal.k.fellows@man.ac.uk> + * doc/man.macros, *.3: Update .AS macro so it can know how wide to + make the third column of the argument list. Update documentation + for C API (only users) to take advantage of this. + * doc/FileSystem.3: Formatting fixes for greater documentation clarity. diff --git a/doc/Access.3 b/doc/Access.3 index 82a17ef..c464caa 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.8 2002/07/01 18:24:38 jenglish Exp $ +'\" RCS: @(#) $Id: Access.3,v 1.9 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_Access 3 8.1 Tcl "Tcl Library Procedures" @@ -21,7 +21,7 @@ int int \fBTcl_Stat\fR(\fIpath\fR, \fIstatPtr\fR) .SH ARGUMENTS -.AS "struct stat" *statPtr in +.AS "struct stat" *statPtr out .AP char *path in Native name of the file to check the attributes of. .AP int mode in diff --git a/doc/AddErrInfo.3 b/doc/AddErrInfo.3 index e1a05b7..1ce977b 100644 --- a/doc/AddErrInfo.3 +++ b/doc/AddErrInfo.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: AddErrInfo.3,v 1.9 2003/07/18 16:56:41 dgp Exp $ +'\" RCS: @(#) $Id: AddErrInfo.3,v 1.10 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_AddErrorInfo 3 8.0 Tcl "Tcl Library Procedures" @@ -32,7 +32,7 @@ CONST char * void \fBTcl_LogCommandInfo\fR(\fIinterp, script, command, commandLength\fR) .SH ARGUMENTS -.AS Tcl_Interp *message +.AS Tcl_Interp commandLength .AP Tcl_Interp *interp in Interpreter in which to record information. .AP char *message in diff --git a/doc/AllowExc.3 b/doc/AllowExc.3 index e7eecfc..4e6be72 100644 --- a/doc/AllowExc.3 +++ b/doc/AllowExc.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: AllowExc.3,v 1.4 2004/09/18 17:01:04 dkf Exp $ +'\" RCS: @(#) $Id: AllowExc.3,v 1.5 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_AllowExceptions 3 7.4 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_AllowExceptions \- allow all exceptions in next script evaluation .sp \fBTcl_AllowExceptions\fR(\fIinterp\fR) .SH ARGUMENTS -.AS Tcl_Interp *doublePtr +.AS Tcl_Interp *interp .AP Tcl_Interp *interp in Interpreter in which script will be evaluated. .BE diff --git a/doc/AssocData.3 b/doc/AssocData.3 index 54d3b4e..edc91dc 100644 --- a/doc/AssocData.3 +++ b/doc/AssocData.3 @@ -5,7 +5,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" -'\" RCS: @(#) $Id: AssocData.3,v 1.5 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: AssocData.3,v 1.6 2004/10/07 14:44:31 dkf Exp $ .so man.macros .TH Tcl_SetAssocData 3 7.5 Tcl "Tcl Library Procedures" .BS @@ -22,12 +22,10 @@ ClientData .sp \fBTcl_DeleteAssocData\fR(\fIinterp, key\fR) .SH ARGUMENTS -.AS Tcl_InterpDeleteProc *delProcPtr +.AS Tcl_InterpDeleteProc **delProcPtr .AP Tcl_Interp *interp in Interpreter in which to execute the specified command. -.VS 8.4 .AP "CONST char" *key in -.VE Key for association with which to store data or from which to delete or retrieve data. Typically the module prefix for a package. .AP Tcl_InterpDeleteProc *delProc in @@ -67,8 +65,8 @@ is deleted. \fIDeleteProc\fR should have arguments and result that match the type \fBTcl_InterpDeleteProc\fR: .CS typedef void Tcl_InterpDeleteProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR); .CE When \fIdeleteProc\fR is invoked the \fIclientData\fR and \fIinterp\fR arguments will be the same as the corresponding arguments passed to diff --git a/doc/Async.3 b/doc/Async.3 index 60fdad4..3c40c44 100644 --- a/doc/Async.3 +++ b/doc/Async.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: Async.3,v 1.5 2000/07/26 01:29:00 davidg Exp $ +'\" RCS: @(#) $Id: Async.3,v 1.6 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures" @@ -85,9 +85,9 @@ the actions associated with the asynchronous event. type \fBTcl_AsyncProc\fR: .CS typedef int Tcl_AsyncProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - int \fIcode\fR); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + int \fIcode\fR); .CE The \fIclientData\fR will be the same as the \fIclientData\fR argument passed to \fBTcl_AsyncCreate\fR when the handler was diff --git a/doc/Backslash.3 b/doc/Backslash.3 index cebc25a..026a208 100644 --- a/doc/Backslash.3 +++ b/doc/Backslash.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: Backslash.3,v 1.4 2002/07/01 18:24:38 jenglish Exp $ +'\" RCS: @(#) $Id: Backslash.3,v 1.5 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_Backslash 3 "8.1" Tcl "Tcl Library Procedures" @@ -19,7 +19,7 @@ Tcl_Backslash \- parse a backslash sequence char \fBTcl_Backslash\fR(\fIsrc, countPtr\fR) .SH ARGUMENTS -.AS char *countPtr +.AS char *countPtr out .AP char *src in Pointer to a string starting with a backslash. .AP int *countPtr out diff --git a/doc/BoolObj.3 b/doc/BoolObj.3 index c6409dc..4fd2343 100644 --- a/doc/BoolObj.3 +++ b/doc/BoolObj.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: BoolObj.3,v 1.3 2002/08/07 17:13:56 msofer Exp $ +'\" RCS: @(#) $Id: BoolObj.3,v 1.4 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_BooleanObj 3 8.0 Tcl "Tcl Library Procedures" @@ -23,7 +23,7 @@ Tcl_Obj * int \fBTcl_GetBooleanFromObj\fR(\fIinterp, objPtr, boolPtr\fR) .SH ARGUMENTS -.AS Tcl_Interp *interp +.AS Tcl_Interp *interp in/out .AP int boolValue in Integer value used to initialize or set a boolean object. If the integer is nonzero, the boolean object is set to 1; diff --git a/doc/ByteArrObj.3 b/doc/ByteArrObj.3 index 02d7f4f..5e36416 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.4 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: ByteArrObj.3,v 1.5 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_ByteArrayObj 3 8.1 Tcl "Tcl Library Procedures" @@ -27,7 +27,7 @@ unsigned char * unsigned char * \fBTcl_SetByteArrayLength\fR(\fIobjPtr, length\fR) .SH ARGUMENTS -.AS "unsigned char" *lengthPtr in/out +.AS "CONST unsigned char" *lengthPtr in/out .AP "CONST unsigned char" *bytes in The array of bytes used to initialize or set a byte-array object. .AP int length in diff --git a/doc/CallDel.3 b/doc/CallDel.3 index 089a922..b72658a 100644 --- a/doc/CallDel.3 +++ b/doc/CallDel.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: CallDel.3,v 1.2 1998/09/14 18:39:46 stanton Exp $ +'\" RCS: @(#) $Id: CallDel.3,v 1.3 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_CallWhenDeleted 3 7.0 Tcl "Tcl Library Procedures" @@ -40,8 +40,8 @@ time of the call. type \fBTcl_InterpDeleteProc\fR: .CS typedef void Tcl_InterpDeleteProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR); .CE The \fIclientData\fR and \fIinterp\fR parameters are copies of the \fIclientData\fR and \fIinterp\fR arguments given diff --git a/doc/ChnlStack.3 b/doc/ChnlStack.3 index a713d0b..0a656a5 100644 --- a/doc/ChnlStack.3 +++ b/doc/ChnlStack.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: ChnlStack.3,v 1.6 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: ChnlStack.3,v 1.7 2004/10/07 14:44:31 dkf Exp $ .so man.macros .TH Tcl_StackChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -29,7 +29,7 @@ Tcl_Channel \fBTcl_GetTopChannel\fR(\fIchannel\fR) .sp .SH ARGUMENTS -.AS Tcl_ChannelType +.AS Tcl_ChannelType clientData .AP Tcl_Interp *interp in Interpreter for error reporting. .AP Tcl_ChannelType *typePtr in diff --git a/doc/Concat.3 b/doc/Concat.3 index 7c6df03..60fb044 100644 --- a/doc/Concat.3 +++ b/doc/Concat.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: Concat.3,v 1.5 2002/08/05 03:24:39 dgp Exp $ +'\" RCS: @(#) $Id: Concat.3,v 1.6 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_Concat 3 7.5 Tcl "Tcl Library Procedures" @@ -19,6 +19,7 @@ Tcl_Concat \- concatenate a collection of strings CONST char * \fBTcl_Concat\fR(\fIargc, argv\fR) .SH ARGUMENTS +.AS "CONST char * CONST" argv[] .AP int argc in Number of strings. .AP "CONST char * CONST" argv[] in diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index 8d6997d..a714638 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.20 2004/09/18 17:01:05 dkf Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.21 2004/10/07 14:44:31 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -117,7 +117,7 @@ Tcl_DriverHandlerProc * \fBTcl_ChannelHandlerProc\fR(\fItypePtr\fR) .sp .SH ARGUMENTS -.AS Tcl_ChannelType *channelName in +.AS Tcl_ChannelType *channelName .AP Tcl_ChannelType *typePtr in Points to a structure containing the addresses of procedures that can be called to perform I/O and other functions on the channel. @@ -296,7 +296,6 @@ Application to a channel registered in some interpreter is not allowed. scripts associated with the specified \fIchannel\fR, thus shutting down all event processing for this channel. .VE 8.4 - .SH TCL_CHANNELTYPE .PP A channel driver provides a \fBTcl_ChannelType\fR structure that contains @@ -309,21 +308,21 @@ details about the old structure. The \fBTcl_ChannelType\fR structure contains the following fields: .CS typedef struct Tcl_ChannelType { - char *\fItypeName\fR; - Tcl_ChannelTypeVersion \fIversion\fR; - Tcl_DriverCloseProc *\fIcloseProc\fR; - Tcl_DriverInputProc *\fIinputProc\fR; - Tcl_DriverOutputProc *\fIoutputProc\fR; - Tcl_DriverSeekProc *\fIseekProc\fR; - Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; - Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; - Tcl_DriverWatchProc *\fIwatchProc\fR; - Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; - Tcl_DriverClose2Proc *\fIclose2Proc\fR; - Tcl_DriverBlockModeProc *\fIblockModeProc\fR; - Tcl_DriverFlushProc *\fIflushProc\fR; - Tcl_DriverHandlerProc *\fIhandlerProc\fR; - Tcl_DriverWideSeekProc *\fIwideSeekProc\fR; + char *\fItypeName\fR; + Tcl_ChannelTypeVersion \fIversion\fR; + Tcl_DriverCloseProc *\fIcloseProc\fR; + Tcl_DriverInputProc *\fIinputProc\fR; + Tcl_DriverOutputProc *\fIoutputProc\fR; + Tcl_DriverSeekProc *\fIseekProc\fR; + Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; + Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; + Tcl_DriverWatchProc *\fIwatchProc\fR; + Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; + Tcl_DriverClose2Proc *\fIclose2Proc\fR; + Tcl_DriverBlockModeProc *\fIblockModeProc\fR; + Tcl_DriverFlushProc *\fIflushProc\fR; + Tcl_DriverHandlerProc *\fIhandlerProc\fR; + Tcl_DriverWideSeekProc *\fIwideSeekProc\fR; } Tcl_ChannelType; .CE .PP @@ -353,8 +352,7 @@ The change to the structures was made in such a way that standard channel types are binary compatible. However, channel types that use stacked channels (i.e. TLS, Trf) have new versions to correspond to the above change since the previous code for stacked channels had problems. - -.SH TYPENAME +.SS TYPENAME .PP The \fItypeName\fR field contains a null-terminated string that identifies the type of the device implemented by this driver, e.g. @@ -362,8 +360,7 @@ identifies the type of the device implemented by this driver, e.g. .PP This value can be retrieved with \fBTcl_ChannelName\fR, which returns a pointer to the string. - -.SH VERSION +.SS VERSION .PP The \fIversion\fR field should be set to \fBTCL_CHANNEL_VERSION_2\fR. If it is not set to this value \fBTCL_CHANNEL_VERSION_3\fR, then this @@ -377,8 +374,7 @@ This value can be retrieved with \fBTcl_ChannelVersion\fR, which returns one of \fBTCL_CHANNEL_VERSION_3\fR, .VE 8.4 \fBTCL_CHANNEL_VERSION_2\fR or \fBTCL_CHANNEL_VERSION_1\fR. - -.SH BLOCKMODEPROC +.SS BLOCKMODEPROC .PP The \fIblockModeProc\fR field contains the address of a function called by the generic layer to set blocking and nonblocking mode on the device. @@ -386,8 +382,8 @@ the generic layer to set blocking and nonblocking mode on the device. .PP .CS typedef int Tcl_DriverBlockModeProc( - ClientData \fIinstanceData\fR, - int \fImode\fR); + ClientData \fIinstanceData\fR, + int \fImode\fR); .CE .PP The \fIinstanceData\fR is the same as the value passed to @@ -413,8 +409,7 @@ blocking mode is acceptable to it, and should this also document for the user so that the blocking mode of the channel is not changed to an inacceptable value. Any confusion here may lead the interpreter into a (spurious and difficult to find) deadlock. - -.SH "CLOSEPROC AND CLOSE2PROC" +.SS "CLOSEPROC AND CLOSE2PROC" .PP The \fIcloseProc\fR field contains the address of a function called by the generic layer to clean up driver-related information when the channel is @@ -422,8 +417,8 @@ closed. \fICloseProc\fR must match the following prototype: .PP .CS typedef int Tcl_DriverCloseProc( - ClientData \fIinstanceData\fR, - Tcl_Interp *\fIinterp\fR); + ClientData \fIinstanceData\fR, + Tcl_Interp *\fIinterp\fR); .CE .PP The \fIinstanceData\fR argument is the same as the value provided to @@ -444,9 +439,9 @@ following prototype: .PP .CS typedef int Tcl_DriverClose2Proc( - ClientData \fIinstanceData\fR, - Tcl_Interp *\fIinterp\fR, - int \fIflags\fR); + ClientData \fIinstanceData\fR, + Tcl_Interp *\fIinterp\fR, + int \fIflags\fR); .CE .PP The \fIclose2Proc\fR will be called with \fIflags\fR set to an OR'ed @@ -467,8 +462,7 @@ in the interpreter's result. 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 +.SS INPUTPROC .PP The \fIinputProc\fR field contains the address of a function called by the generic layer to read data from the file or device and store it in an @@ -476,10 +470,10 @@ internal buffer. \fIInputProc\fR must match the following prototype: .PP .CS typedef int Tcl_DriverInputProc( - ClientData \fIinstanceData\fR, - char *\fIbuf\fR, - int \fIbufSize\fR, - int *\fIerrorCodePtr\fR); + ClientData \fIinstanceData\fR, + char *\fIbuf\fR, + int \fIbufSize\fR, + int *\fIerrorCodePtr\fR); .CE .PP \fIInstanceData\fR is the same as the value passed to @@ -512,8 +506,7 @@ blocking. .PP This value can be retrieved with \fBTcl_ChannelInputProc\fR, which returns a pointer to the function. - -.SH OUTPUTPROC +.SS OUTPUTPROC .PP The \fIoutputProc\fR field contains the address of a function called by the generic layer to transfer data from an internal buffer to the output device. @@ -521,10 +514,10 @@ generic layer to transfer data from an internal buffer to the output device. .PP .CS typedef int Tcl_DriverOutputProc( - ClientData \fIinstanceData\fR, - CONST char *\fIbuf\fR, - int \fItoWrite\fR, - int *\fIerrorCodePtr\fR); + ClientData \fIinstanceData\fR, + CONST char *\fIbuf\fR, + int \fItoWrite\fR, + int *\fIerrorCodePtr\fR); .CE .PP \fIInstanceData\fR is the same as the value passed to @@ -551,8 +544,7 @@ without writing any data. .PP This value can be retrieved with \fBTcl_ChannelOutputProc\fR, which returns a pointer to the function. - -.SH "SEEKPROC AND WIDESEEKPROC" +.SS "SEEKPROC AND WIDESEEKPROC" .PP The \fIseekProc\fR field contains the address of a function called by the generic layer to move the access point at which subsequent input or output @@ -561,10 +553,10 @@ prototype: .PP .CS typedef int Tcl_DriverSeekProc( - ClientData \fIinstanceData\fR, - long \fIoffset\fR, - int \fIseekMode\fR, - int *\fIerrorCodePtr\fR); + ClientData \fIinstanceData\fR, + long \fIoffset\fR, + int \fIseekMode\fR, + int *\fIerrorCodePtr\fR); .CE .PP The \fIinstanceData\fR argument is the same as the value given to @@ -592,10 +584,10 @@ following prototype: .PP .CS typedef Tcl_WideInt Tcl_DriverWideSeekProc( - ClientData \fIinstanceData\fR, - Tcl_WideInt \fIoffset\fR, - int \fIseekMode\fR, - int *\fIerrorCodePtr\fR); + ClientData \fIinstanceData\fR, + Tcl_WideInt \fIoffset\fR, + int \fIseekMode\fR, + int *\fIerrorCodePtr\fR); .CE .PP The arguments and return values mean the same thing as with @@ -607,8 +599,7 @@ The \fIseekProc\fR value can be retrieved with and similarly the \fIwideSeekProc\fR can be retrieved with \fBTcl_ChannelWideSeekProc\fR. .VE 8.4 - -.SH SETOPTIONPROC +.SS SETOPTIONPROC .PP The \fIsetOptionProc\fR field contains the address of a function called by the generic layer to set a channel type specific option on a channel. @@ -616,10 +607,10 @@ the generic layer to set a channel type specific option on a channel. .PP .CS typedef int Tcl_DriverSetOptionProc( - ClientData \fIinstanceData\fR, - Tcl_Interp *\fIinterp\fR, - CONST char *\fIoptionName\fR, - CONST char *\fInewValue\fR); + ClientData \fIinstanceData\fR, + Tcl_Interp *\fIinterp\fR, + CONST char *\fIoptionName\fR, + CONST char *\fInewValue\fR); .CE .PP \fIoptionName\fR is the name of an option to set, and \fInewValue\fR is @@ -649,8 +640,7 @@ error code. .PP This value can be retrieved with \fBTcl_ChannelSetOptionProc\fR, which returns a pointer to the function. - -.SH GETOPTIONPROC +.SS GETOPTIONPROC .PP The \fIgetOptionProc\fR field contains the address of a function called by the generic layer to get the value of a channel type specific option on a @@ -658,10 +648,10 @@ channel. \fIgetOptionProc\fR must match the following prototype: .PP .CS typedef int Tcl_DriverGetOptionProc( - ClientData \fIinstanceData\fR, - Tcl_Interp *\fIinterp\fR, - CONST char *\fIoptionName\fR, - Tcl_DString *\fIoptionValue\fR); + ClientData \fIinstanceData\fR, + Tcl_Interp *\fIinterp\fR, + CONST char *\fIoptionName\fR, + Tcl_DString *\fIoptionValue\fR); .CE .PP \fIOptionName\fR is the name of an option supported by this type of @@ -687,8 +677,7 @@ specific options. .PP This value can be retrieved with \fBTcl_ChannelGetOptionProc\fR, which returns a pointer to the function. - -.SH WATCHPROC +.SS WATCHPROC .PP The \fIwatchProc\fR field contains the address of a function called by the generic layer to initialize the event notification mechanism to @@ -697,8 +686,8 @@ notice events of interest on this channel. .PP .CS typedef void Tcl_DriverWatchProc( - ClientData \fIinstanceData\fR, - int \fImask\fR); + ClientData \fIinstanceData\fR, + int \fImask\fR); .CE .PP The \fIinstanceData\fR is the same as the value passed to @@ -720,8 +709,7 @@ details on how to queue an event. .PP This value can be retrieved with \fBTcl_ChannelWatchProc\fR, which returns a pointer to the function. - -.SH GETHANDLEPROC +.SS GETHANDLEPROC .PP The \fIgetHandleProc\fR field contains the address of a function called by the generic layer to retrieve a device-specific handle from the channel. @@ -729,9 +717,9 @@ the generic layer to retrieve a device-specific handle from the channel. .PP .CS typedef int Tcl_DriverGetHandleProc( - ClientData \fIinstanceData\fR, - int \fIdirection\fR, - ClientData *\fIhandlePtr\fR); + ClientData \fIinstanceData\fR, + int \fIdirection\fR, + ClientData *\fIhandlePtr\fR); .CE .PP \fIInstanceData\fR is the same as the value passed to @@ -750,8 +738,7 @@ device handles, the function should return \fBTCL_ERROR\fR. .PP This value can be retrieved with \fBTcl_ChannelGetHandleProc\fR, which returns a pointer to the function. - -.SH FLUSHPROC +.SS FLUSHPROC .PP The \fIflushProc\fR field is currently reserved for future use. It should be set to NULL. @@ -759,13 +746,12 @@ It should be set to NULL. .PP .CS typedef int Tcl_DriverFlushProc( - ClientData \fIinstanceData\fR); + ClientData \fIinstanceData\fR); .CE .PP This value can be retrieved with \fBTcl_ChannelFlushProc\fR, which returns a pointer to the function. - -.SH HANDLERPROC +.SS HANDLERPROC .PP The \fIhandlerProc\fR field contains the address of a function called by the generic layer to notify the channel that an event occurred. It should @@ -775,8 +761,8 @@ that occur on the underlying (stacked) channel. .PP .CS typedef int Tcl_DriverHandlerProc( - ClientData \fIinstanceData\fR, - int \fIinterestMask\fR); + ClientData \fIinstanceData\fR, + int \fIinterestMask\fR); .CE .PP \fIInstanceData\fR is the same as the value passed to \fBTcl_CreateChannel\fR @@ -786,7 +772,6 @@ type of event occurred on this channel. .PP This value can be retrieved with \fBTcl_ChannelHandlerProc\fR, which returns a pointer to the function. - .SH TCL_BADCHANNELOPTION .PP This procedure generates a "bad option" error message in an @@ -803,35 +788,36 @@ The message has the form .CS bad option "blah": should be one of <...generic options...>+<...specific options...> +.CE so you get for instance: +.CS bad option "-blah": should be one of -blocking, -buffering, -buffersize, -eofchar, -translation, -peername, or -sockname -when called with \fIoptionList\fR="peername sockname" .CE +when called with \fIoptionList\fR="peername sockname" +.PP ``blah'' is the \fIoptionName\fR argument and ``<specific options>'' is a space separated list of specific option words. The function takes good care of inserting minus signs before each option, commas after, and an ``or'' before the last option. - .SH "OLD CHANNEL TYPES" - The original (8.3.1 and below) \fBTcl_ChannelType\fR structure contains the following fields: .PP .CS typedef struct Tcl_ChannelType { - char *\fItypeName\fR; - Tcl_DriverBlockModeProc *\fIblockModeProc\fR; - Tcl_DriverCloseProc *\fIcloseProc\fR; - Tcl_DriverInputProc *\fIinputProc\fR; - Tcl_DriverOutputProc *\fIoutputProc\fR; - Tcl_DriverSeekProc *\fIseekProc\fR; - Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; - Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; - Tcl_DriverWatchProc *\fIwatchProc\fR; - Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; - Tcl_DriverClose2Proc *\fIclose2Proc\fR; + char *\fItypeName\fR; + Tcl_DriverBlockModeProc *\fIblockModeProc\fR; + Tcl_DriverCloseProc *\fIcloseProc\fR; + Tcl_DriverInputProc *\fIinputProc\fR; + Tcl_DriverOutputProc *\fIoutputProc\fR; + Tcl_DriverSeekProc *\fIseekProc\fR; + Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; + Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; + Tcl_DriverWatchProc *\fIwatchProc\fR; + Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; + Tcl_DriverClose2Proc *\fIclose2Proc\fR; } Tcl_ChannelType; .CE .PP @@ -848,20 +834,20 @@ contained the following fields: .PP .CS typedef struct Tcl_ChannelType { - char *\fItypeName\fR; - Tcl_ChannelTypeVersion \fIversion\fR; - Tcl_DriverCloseProc *\fIcloseProc\fR; - Tcl_DriverInputProc *\fIinputProc\fR; - Tcl_DriverOutputProc *\fIoutputProc\fR; - Tcl_DriverSeekProc *\fIseekProc\fR; - Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; - Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; - Tcl_DriverWatchProc *\fIwatchProc\fR; - Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; - Tcl_DriverClose2Proc *\fIclose2Proc\fR; - Tcl_DriverBlockModeProc *\fIblockModeProc\fR; - Tcl_DriverFlushProc *\fIflushProc\fR; - Tcl_DriverHandlerProc *\fIhandlerProc\fR; + char *\fItypeName\fR; + Tcl_ChannelTypeVersion \fIversion\fR; + Tcl_DriverCloseProc *\fIcloseProc\fR; + Tcl_DriverInputProc *\fIinputProc\fR; + Tcl_DriverOutputProc *\fIoutputProc\fR; + Tcl_DriverSeekProc *\fIseekProc\fR; + Tcl_DriverSetOptionProc *\fIsetOptionProc\fR; + Tcl_DriverGetOptionProc *\fIgetOptionProc\fR; + Tcl_DriverWatchProc *\fIwatchProc\fR; + Tcl_DriverGetHandleProc *\fIgetHandleProc\fR; + Tcl_DriverClose2Proc *\fIclose2Proc\fR; + Tcl_DriverBlockModeProc *\fIblockModeProc\fR; + Tcl_DriverFlushProc *\fIflushProc\fR; + Tcl_DriverHandlerProc *\fIhandlerProc\fR; } Tcl_ChannelType; .CE .PP diff --git a/doc/CrtChnlHdlr.3 b/doc/CrtChnlHdlr.3 index 4536ef6..8988c63 100644 --- a/doc/CrtChnlHdlr.3 +++ b/doc/CrtChnlHdlr.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: CrtChnlHdlr.3,v 1.2 1998/09/14 18:39:46 stanton Exp $ +'\" RCS: @(#) $Id: CrtChnlHdlr.3,v 1.3 2004/10/07 14:44:31 dkf Exp $ .so man.macros .TH Tcl_CreateChannelHandler 3 7.5 Tcl "Tcl Library Procedures" .BS @@ -49,8 +49,8 @@ what it means for a channel to be readable or writable. \fIProc\fR must conform to the following prototype: .CS typedef void Tcl_ChannelProc( - ClientData \fIclientData\fR, - int \fImask\fR); + ClientData \fIclientData\fR, + int \fImask\fR); .CE .PP The \fIclientData\fR argument is the same as the value passed to diff --git a/doc/CrtCloseHdlr.3 b/doc/CrtCloseHdlr.3 index 8f7b4ba..6d55d9d 100644 --- a/doc/CrtCloseHdlr.3 +++ b/doc/CrtCloseHdlr.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: CrtCloseHdlr.3,v 1.2 1998/09/14 18:39:47 stanton Exp $ +'\" RCS: @(#) $Id: CrtCloseHdlr.3,v 1.3 2004/10/07 14:44:31 dkf Exp $ .so man.macros .TH Tcl_CreateCloseHandler 3 7.5 Tcl "Tcl Library Procedures" .BS @@ -22,7 +22,7 @@ void \fBTcl_DeleteCloseHandler\fR(\fIchannel, proc, clientData\fR) .sp .SH ARGUMENTS -.AS Tcl_CloseProc callbackData in +.AS Tcl_CloseProc clientData .AP Tcl_Channel channel in The channel for which to create or delete a close callback. .AP Tcl_CloseProc *proc in @@ -40,7 +40,7 @@ Arbitrary one-word value to pass to \fIproc\fR. .PP .CS typedef void Tcl_CloseProc( - ClientData \fIclientData\fR); + ClientData \fIclientData\fR); .CE .PP The \fIclientData\fR is the same as the value provided in the call to diff --git a/doc/CrtCommand.3 b/doc/CrtCommand.3 index b1b2cae..9152b6b 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.8 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: CrtCommand.3,v 1.9 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_CreateCommand 3 "" Tcl "Tcl Library Procedures" @@ -19,12 +19,10 @@ Tcl_CreateCommand \- implement new commands in C Tcl_Command \fBTcl_CreateCommand\fR(\fIinterp, cmdName, proc, clientData, deleteProc\fR) .SH ARGUMENTS -.AS Tcl_CmdDeleteProc **deleteProcPtr +.AS Tcl_CmdDeleteProc *deleteProc .AP Tcl_Interp *interp in Interpreter in which to create new command. -.VS 8.4 .AP "CONST char" *cmdName in -.VE Name of command. .AP Tcl_CmdProc *proc in Implementation of new command: \fIproc\fR will be called whenever @@ -81,10 +79,10 @@ and it returns NULL. \fBTcl_CmdProc\fR: .CS typedef int Tcl_CmdProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - int \fIargc\fR, - CONST char *\fIargv\fR[]); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + int \fIargc\fR, + CONST char *\fIargv\fR[]); .CE When \fIproc\fR is invoked the \fIclientData\fR and \fIinterp\fR parameters will be copies of the \fIclientData\fR and \fIinterp\fR @@ -138,7 +136,8 @@ application an opportunity to release any structures associated with the command. \fIDeleteProc\fR should have arguments and result that match the type \fBTcl_CmdDeleteProc\fR: .CS -typedef void Tcl_CmdDeleteProc(ClientData \fIclientData\fR); +typedef void Tcl_CmdDeleteProc( + ClientData \fIclientData\fR); .CE The \fIclientData\fR argument will be the same as the \fIclientData\fR argument passed to \fBTcl_CreateCommand\fR. diff --git a/doc/CrtFileHdlr.3 b/doc/CrtFileHdlr.3 index b660170..5e6a925 100644 --- a/doc/CrtFileHdlr.3 +++ b/doc/CrtFileHdlr.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: CrtFileHdlr.3,v 1.2 1998/09/14 18:39:47 stanton Exp $ +'\" RCS: @(#) $Id: CrtFileHdlr.3,v 1.3 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_CreateFileHandler 3 8.0 Tcl "Tcl Library Procedures" @@ -23,10 +23,8 @@ Tcl_CreateFileHandler, Tcl_DeleteFileHandler \- associate procedure callbacks wi .VE .SH ARGUMENTS .AS Tcl_FileProc clientData -.VS .AP int fd in Unix file descriptor for an open file or device. -.VE .AP int mask in Conditions under which \fIproc\fR should be called: OR-ed combination of \fBTCL_READABLE\fR, \fBTCL_WRITABLE\fR, @@ -59,8 +57,8 @@ as \fBvwait\fR. type \fBTcl_FileProc\fR: .CS typedef void Tcl_FileProc( - ClientData \fIclientData\fR, - int \fImask\fR); + ClientData \fIclientData\fR, + int \fImask\fR); .CE The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR diff --git a/doc/CrtMathFnc.3 b/doc/CrtMathFnc.3 index 021129c..5c4d54e 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.9 2004/09/18 17:01:05 dkf Exp $ +'\" RCS: @(#) $Id: CrtMathFnc.3,v 1.10 2004/10/07 14:44:31 dkf Exp $ '\" .so man.macros .TH Tcl_CreateMathFunc 3 8.4 Tcl "Tcl Library Procedures" @@ -21,18 +21,17 @@ void .sp .VS 8.4 int -\fBTcl_GetMathFuncInfo\fR(\fIinterp, name, numArgsPtr, argTypesPtr, procPtr, clientDataPtr\fR) +\fBTcl_GetMathFuncInfo\fR(\fIinterp, name, numArgsPtr, argTypesPtr, procPtr, + clientDataPtr\fR) .sp Tcl_Obj * \fBTcl_ListMathFuncs\fR(\fIinterp, pattern\fR) .VE .SH ARGUMENTS -.AS Tcl_ValueType *clientDataPtr +.AS Tcl_ValueType *clientDataPtr out .AP Tcl_Interp *interp in Interpreter in which new function will be defined. -.VS 8.4 .AP "CONST char" *name in -.VE Name for new function. .AP int numArgs in Number of arguments to new function; also gives size of \fIargTypes\fR array. @@ -86,10 +85,10 @@ Whenever the function is invoked in an expression Tcl will invoke the type \fBTcl_MathProc\fR: .CS typedef int Tcl_MathProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - Tcl_Value *\fIargs\fR, - Tcl_Value *\fIresultPtr\fR); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + Tcl_Value *\fIargs\fR, + Tcl_Value *\fIresultPtr\fR); .CE .PP When \fIproc\fR is invoked the \fIclientData\fR and \fIinterp\fR @@ -99,10 +98,10 @@ which describe the actual arguments to the function: .VS 8.4 .CS typedef struct Tcl_Value { - Tcl_ValueType \fItype\fR; - long \fIintValue\fR; - double \fIdoubleValue\fR; - Tcl_WideInt \fIwideValue\fR; + Tcl_ValueType \fItype\fR; + long \fIintValue\fR; + double \fIdoubleValue\fR; + Tcl_WideInt \fIwideValue\fR; } Tcl_Value; .CE .PP diff --git a/doc/CrtObjCmd.3 b/doc/CrtObjCmd.3 index fbce5b2..0f44e1d 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.9 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: CrtObjCmd.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_CreateObjCommand 3 8.0 Tcl "Tcl Library Procedures" @@ -49,12 +49,10 @@ void Tcl_Command \fBTcl_GetCommandFromObj\fR(\fIinterp, objPtr\fR) .SH ARGUMENTS -.AS Tcl_ObjCmdProc *deleteProc in/out +.AS Tcl_CmdDeleteProc *deleteProc in/out .AP Tcl_Interp *interp in Interpreter in which to create a new command or that contains a command. -.VS 8.4 .AP char *cmdName in -.VE Name of command. .AP Tcl_ObjCmdProc *proc in Implementation of the new command: \fIproc\fR will be called whenever @@ -98,11 +96,11 @@ and it returns NULL. \fBTcl_ObjCmdProc\fR: .CS typedef int Tcl_ObjCmdProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - int \fIobjc\fR, + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + int \fIobjc\fR, .VS - Tcl_Obj *CONST \fIobjv\fR[]); + Tcl_Obj *CONST \fIobjv\fR[]); .CE When \fIproc\fR is invoked, the \fIclientData\fR and \fIinterp\fR parameters will be copies of the \fIclientData\fR and \fIinterp\fR arguments given to @@ -170,7 +168,8 @@ application an opportunity to release any structures associated with the command. \fIDeleteProc\fR should have arguments and result that match the type \fBTcl_CmdDeleteProc\fR: .CS -typedef void Tcl_CmdDeleteProc(ClientData \fIclientData\fR); +typedef void Tcl_CmdDeleteProc( + ClientData \fIclientData\fR); .CE The \fIclientData\fR argument will be the same as the \fIclientData\fR argument passed to \fBTcl_CreateObjCommand\fR. @@ -208,14 +207,14 @@ pointed to by \fIinfoPtr\fR and returns 1. A \fBTcl_CmdInfo\fR structure has the following fields: .CS typedef struct Tcl_CmdInfo { - int isNativeObjectProc; - Tcl_ObjCmdProc *objProc; - ClientData objClientData; - Tcl_CmdProc *proc; - ClientData clientData; - Tcl_CmdDeleteProc *deleteProc; - ClientData deleteData; - Tcl_Namespace *namespacePtr; + int \fIisNativeObjectProc\fR; + Tcl_ObjCmdProc *\fIobjProc\fR; + ClientData \fIobjClientData\fR; + Tcl_CmdProc *\fIproc\fR; + ClientData \fIclientData\fR; + Tcl_CmdDeleteProc *\fIdeleteProc\fR; + ClientData \fIdeleteData\fR; + Tcl_Namespace *\fInamespacePtr\fR; } Tcl_CmdInfo; .CE The \fIisNativeObjectProc\fR field has the value 1 diff --git a/doc/CrtSlave.3 b/doc/CrtSlave.3 index 2052fd8..58a6d27 100644 --- a/doc/CrtSlave.3 +++ b/doc/CrtSlave.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CrtSlave.3,v 1.11 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: CrtSlave.3,v 1.12 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_CreateSlave 3 7.6 Tcl "Tcl Library Procedures" @@ -33,20 +33,21 @@ Tcl_Interp * int \fBTcl_GetInterpPath\fR(\fIaskingInterp, slaveInterp\fR) .sp -.VS int -\fBTcl_CreateAlias\fR(\fIslaveInterp, slaveCmd, targetInterp, targetCmd, argc, argv\fR) +\fBTcl_CreateAlias\fR(\fIslaveInterp, slaveCmd, targetInterp, targetCmd, + argc, argv\fR) .sp int -\fBTcl_CreateAliasObj\fR(\fIslaveInterp, slaveCmd, targetInterp, targetCmd, objc, objv\fR) -.VE +\fBTcl_CreateAliasObj\fR(\fIslaveInterp, slaveCmd, targetInterp, targetCmd, + objc, objv\fR) .sp int -\fBTcl_GetAlias\fR(\fIinterp, slaveCmd, targetInterpPtr, targetCmdPtr, argcPtr, argvPtr\fR) +\fBTcl_GetAlias\fR(\fIinterp, slaveCmd, targetInterpPtr, targetCmdPtr, + argcPtr, argvPtr\fR) .sp -.VS int -\fBTcl_GetAliasObj\fR(\fIinterp, slaveCmd, targetInterpPtr, targetCmdPtr, objcPtr, objvPtr\fR) +\fBTcl_GetAliasObj\fR(\fIinterp, slaveCmd, targetInterpPtr, targetCmdPtr, + objcPtr, objvPtr\fR) .sp int \fBTcl_ExposeCommand\fR(\fIinterp, hiddenCmdName, cmdName\fR) @@ -54,7 +55,7 @@ int int \fBTcl_HideCommand\fR(\fIinterp, cmdName, hiddenCmdName\fR) .SH ARGUMENTS -.AS Tcl_InterpDeleteProc **hiddenCmdName +.AS Tcl_InterpDeleteProc **targetInterpPtr out .AP Tcl_Interp *interp in Interpreter in which to execute the specified command. .AP "CONST char" *slaveName in @@ -103,17 +104,11 @@ Pointer to location to store a vector of Tcl_Obj structures, the additional arguments to pass to an object alias command. The location is in storage owned by the caller, the vector of Tcl_Obj structures is owned by the called function. -.VS -.VS 8.4 .AP "CONST char" *cmdName in -.VE Name of an exposed command to hide or create. -.VS 8.4 .AP "CONST char" *hiddenCmdName in -.VE Name under which a hidden command is stored and with which it can be exposed or invoked. -.VE .BE .SH DESCRIPTION @@ -165,7 +160,6 @@ of the relative path succeeds, \fBTCL_OK\fR is returned, else \fBTCL_ERROR\fR is returned and the \fIresult\fR field in \fIaskingInterp\fR contains the error message. .PP -.VS \fBTcl_CreateAlias\fR creates an object command named \fIslaveCmd\fR in \fIslaveInterp\fR that when invoked, will cause the command \fItargetCmd\fR to be invoked in \fItargetInterp\fR. The arguments specified by the strings @@ -182,7 +176,6 @@ restrictions on how they are related. \fBTcl_CreateAliasObj\fR is similar to \fBTcl_CreateAlias\fR except that it takes a vector of objects to pass as additional arguments instead of a vector of strings. -.VE .PP \fBTcl_GetAlias\fR returns information about an alias \fIaliasName\fR in \fIinterp\fR. Any of the result fields can be \fBNULL\fR, in @@ -190,7 +183,6 @@ which case the corresponding datum is not returned. If a result field is non\-\fBNULL\fR, the address indicated is set to the corresponding datum. For example, if \fItargetNamePtr\fR is non\-\fBNULL\fR it is set to a pointer to the string containing the name of the target command. -.VS .PP \fBTcl_GetAliasObj\fR is similar to \fBTcl_GetAlias\fR except that it returns a pointer to a vector of Tcl_Obj structures instead of a vector of diff --git a/doc/CrtTrace.3 b/doc/CrtTrace.3 index 7495682..bf1c19d 100644 --- a/doc/CrtTrace.3 +++ b/doc/CrtTrace.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: CrtTrace.3,v 1.7 2003/07/18 16:56:41 dgp Exp $ +'\" RCS: @(#) $Id: CrtTrace.3,v 1.8 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_CreateTrace 3 "" Tcl "Tcl Library Procedures" @@ -45,7 +45,7 @@ Procedure to call for each command that's executed. See below for details on the calling sequence. .AP ClientData clientData in Arbitrary one-word value to pass to \fIobjProc\fR or \fIproc\fR. -.AP Tcl_CmdObjTraceDeleteProc *deleteProc +.AP Tcl_CmdObjTraceDeleteProc *deleteProc in Procedure to call when the trace is deleted. See below for details of the calling sequence. A NULL pointer is permissible and results in no callback when the trace is deleted. @@ -67,13 +67,13 @@ interpreter. \fBTcl_CmdObjTraceProc\fR: .CS typedef int \fBTcl_CmdObjTraceProc\fR( - \fBClientData\fR \fIclientData\fR, - \fBTcl_Interp\fR* \fIinterp\fR, - int \fIlevel\fR, - CONST char* \fIcommand\fR, - \fBTcl_Command\fR \fIcommandToken\fR, - int \fIobjc\fR, - \fBTcl_Obj\fR *CONST \fIobjv\fR[] ); + \fBClientData\fR \fIclientData\fR, + \fBTcl_Interp\fR* \fIinterp\fR, + int \fIlevel\fR, + CONST char* \fIcommand\fR, + \fBTcl_Command\fR \fIcommandToken\fR, + int \fIobjc\fR, + \fBTcl_Obj\fR *CONST \fIobjv\fR[] ); .CE The \fIclientData\fR and \fIinterp\fR parameters are copies of the corresponding arguments given to \fBTcl_CreateTrace\fR. @@ -143,8 +143,7 @@ When \fBTcl_DeleteTrace\fR is called, the interpreter invokes the \fBTcl_CmdObjTraceDeleteProc\fR: .CS typedef void \fBTcl_CmdObjTraceDeleteProc\fR( - \fBClientData\fR \fIclientData\fR -); + \fBClientData\fR \fIclientData\fR); .CE The \fIclientData\fR parameter will be the same as the \fIclientData\fR parameter that was originally passed to @@ -158,14 +157,14 @@ that its \fIproc\fR parameter should have arguments and result that match the type \fBTcl_CmdTraceProc\fR: .CS typedef void Tcl_CmdTraceProc( - ClientData \fIclientData\fR, - Tcl_Interp *\fIinterp\fR, - int \fIlevel\fR, - char *\fIcommand\fR, - Tcl_CmdProc *\fIcmdProc\fR, - ClientData \fIcmdClientData\fR, - int \fIargc\fR, - CONST char *\fIargv\fR[]); + ClientData \fIclientData\fR, + Tcl_Interp *\fIinterp\fR, + int \fIlevel\fR, + char *\fIcommand\fR, + Tcl_CmdProc *\fIcmdProc\fR, + ClientData \fIcmdClientData\fR, + int \fIargc\fR, + CONST char *\fIargv\fR[]); .CE The parameters to the \fIproc\fR callback are similar to those of the \fIobjProc\fR callback above. The \fIcommandToken\fR is diff --git a/doc/DString.3 b/doc/DString.3 index 2698696..ac37e0a 100644 --- a/doc/DString.3 +++ b/doc/DString.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: DString.3,v 1.9 2002/02/08 02:52:54 dgp Exp $ +'\" RCS: @(#) $Id: DString.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures" @@ -44,7 +44,7 @@ char * .sp \fBTcl_DStringGetResult\fR(\fIinterp, dsPtr\fR) .SH ARGUMENTS -.AS Tcl_DString newLength +.AS Tcl_DString newLength in/out .AP Tcl_DString *dsPtr in/out Pointer to structure that is used to manage a dynamic string. .AP "CONST char" *string in diff --git a/doc/DetachPids.3 b/doc/DetachPids.3 index 818fb32..91535a9 100644 --- a/doc/DetachPids.3 +++ b/doc/DetachPids.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: DetachPids.3,v 1.3 2001/04/03 14:53:45 andreas_kupries Exp $ +'\" RCS: @(#) $Id: DetachPids.3,v 1.4 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_DetachPids 3 "" Tcl "Tcl Library Procedures" @@ -21,18 +21,18 @@ Tcl_DetachPids, Tcl_ReapDetachedProcs, Tcl_WaitPid \- manage child processes in \fBTcl_ReapDetachedProcs\fR() .sp Tcl_Pid -\fBTcl_WaitPid\fR(\fIpid, statPtr, options\fR) +\fBTcl_WaitPid\fR(\fIpid, statusPtr, options\fR) .SH ARGUMENTS -.AS int *statusPtr +.AS Tcl_Pid *statusPtr out .AP int numPids in Number of process ids contained in the array pointed to by \fIpidPtr\fR. .AP int *pidPtr in Address of array containing \fInumPids\fR process ids. .AP Tcl_Pid pid in The id of the process (pipe) to wait for. -.AP int* statPtr out +.AP int *statusPtr out The result of waiting on a process (pipe). Either 0 or ECHILD. -.AP int options +.AP int options in The options controlling the wait. WNOHANG specifies not to wait when checking the process. .BE diff --git a/doc/DictObj.3 b/doc/DictObj.3 index f56d833..fd301bb 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.6 2004/10/04 13:06:34 dkf Exp $ +'\" RCS: @(#) $Id: DictObj.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_DictObj 3 8.5 Tcl "Tcl Library Procedures" @@ -32,7 +32,8 @@ int \fBTcl_DictObjSize\fR(\fIinterp, dictPtr, sizePtr\fR) .sp int -\fBTcl_DictObjFirst\fR(\fIinterp, dictPtr, searchPtr, keyPtrPtr, valuePtrPtr, donePtr\fR) +\fBTcl_DictObjFirst\fR(\fIinterp, dictPtr, searchPtr, + keyPtrPtr, valuePtrPtr, donePtr\fR) .sp void \fBTcl_DictObjNext\fR(\fIsearchPtr, keyPtrPtr, valuePtrPtr, donePtr\fR) @@ -46,7 +47,7 @@ int int \fBTcl_DictObjRemoveKeyList\fR(\fIinterp, dictPtr, keyc, keyv\fR) .SH ARGUMENTS -.AS Tcl_DictSearch "**valuePtrPtr" out +.AS Tcl_DictSearch "**valuePtrPtr" in/out .AP Tcl_Interp *interp in If an error occurs while converting an object to be a dictionary object, an error message is left in the interpreter's result object diff --git a/doc/DumpActiveMemory.3 b/doc/DumpActiveMemory.3 index 5d1bc14..9968fab 100644 --- a/doc/DumpActiveMemory.3 +++ b/doc/DumpActiveMemory.3 @@ -3,7 +3,7 @@ '\" Copyright (c) 2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.6 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: DumpActiveMemory.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH "Tcl_DumpActiveMemory" 3 8.1 Tcl "Tcl Library Procedures" @@ -24,6 +24,7 @@ void \fBTcl_ValidateAllMemory\fR(\fIfileName, line\fR) .SH ARGUMENTS +.AS Tcl_Interp *fileName .AP Tcl_Interp *interp in Tcl interpreter in which to add commands. .AP "CONST char" *fileName in diff --git a/doc/Encoding.3 b/doc/Encoding.3 index 0c423b4..99be49e 100644 --- a/doc/Encoding.3 +++ b/doc/Encoding.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: Encoding.3,v 1.17 2004/09/18 17:01:05 dkf Exp $ +'\" RCS: @(#) $Id: Encoding.3,v 1.18 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures" @@ -24,16 +24,16 @@ void char * \fBTcl_ExternalToUtfDString\fR(\fIencoding, src, srcLen, dstPtr\fR) .sp -int -\fBTcl_ExternalToUtf\fR(\fIinterp, encoding, src, srcLen, flags, statePtr, dst, dstLen, srcReadPtr, dstWrotePtr, - dstCharsPtr\fR) -.sp -char * +char * \fBTcl_UtfToExternalDString\fR(\fIencoding, src, srcLen, dstPtr\fR) .sp int -\fBTcl_UtfToExternal\fR(\fIinterp, encoding, src, srcLen, flags, statePtr, dst, dstLen, srcReadPtr, dstWrotePtr, - dstCharsPtr\fR) +\fBTcl_ExternalToUtf\fR(\fIinterp, encoding, src, srcLen, flags, statePtr, + dst, dstLen, srcReadPtr, dstWrotePtr, dstCharsPtr\fR) +.sp +int +\fBTcl_UtfToExternal\fR(\fIinterp, encoding, src, srcLen, flags, statePtr, + dst, dstLen, srcReadPtr, dstWrotePtr, dstCharsPtr\fR) .sp char * \fBTcl_WinTCharToUtf\fR(\fItsrc, srcLen, dstPtr\fR) @@ -59,9 +59,8 @@ CONST char * void \fBTcl_SetDefaultEncodingDir\fR(\fIpath\fR) - .SH ARGUMENTS -.AS Tcl_EncodingState *dstWrotePtr +.AS Tcl_EncodingState *dstWrotePtr in/out .AP Tcl_Interp *interp in Interpreter to use for error reporting, or NULL if no error reporting is desired. @@ -252,6 +251,7 @@ if (running NT) { Tcl_FreeEncoding(encoding); } else { nativeBuffer <- Tcl_UtfToExternal(NULL, utfBuffer); +} .CE \fBTcl_WinUtfToTChar\fR and \fBTcl_WinTCharToUtf\fR automatically handle this test and use the proper encoding based on the current @@ -303,12 +303,12 @@ convert between this encoding and UTF-8. It is defined as follows: .PP .CS typedef struct Tcl_EncodingType { - CONST char *\fIencodingName\fR; - Tcl_EncodingConvertProc *\fItoUtfProc\fR; - Tcl_EncodingConvertProc *\fIfromUtfProc\fR; - Tcl_EncodingFreeProc *\fIfreeProc\fR; - ClientData \fIclientData\fR; - int \fInullSize\fR; + CONST char *\fIencodingName\fR; + Tcl_EncodingConvertProc *\fItoUtfProc\fR; + Tcl_EncodingConvertProc *\fIfromUtfProc\fR; + Tcl_EncodingFreeProc *\fIfreeProc\fR; + ClientData \fIclientData\fR; + int \fInullSize\fR; } Tcl_EncodingType; .CE .PP @@ -398,19 +398,19 @@ initial line of the file, beginning with a ``#'' symbol, is a comment that provides a human-readable description of the file. The next line identifies the type of encoding file. It can be one of the following letters: -.IP "[1] \fBS\fR" +.IP "[1] \fBS\fR" A single-byte encoding, where one character is always one byte long in the encoding. An example is \fBiso8859-1\fR, used by many European languages. -.IP "[2] \fBD\fR" +.IP "[2] \fBD\fR" 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" +.IP "[3] \fBM\fR" A multi-byte encoding, where one character may be either one or two bytes long. 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. -.IP "[4] \fBE\fR" +.IP "[4] \fBE\fR" An escape-sequence encoding, specifying that certain sequences of bytes do not represent characters, but commands that describe how following bytes should be interpreted. diff --git a/doc/Environment.3 b/doc/Environment.3 index 13afd7c..68d725c 100644 --- a/doc/Environment.3 +++ b/doc/Environment.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: Environment.3,v 1.2 2004/09/01 09:50:45 dkf Exp $ +'\" RCS: @(#) $Id: Environment.3,v 1.3 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_PutEnv 3 "7.5" Tcl "Tcl Library Procedures" @@ -18,6 +18,7 @@ Tcl_PutEnv \- procedures to manipulate the environment int \fBTcl_PutEnv\fR(\fIstring\fR) .SH ARGUMENTS +.AS "CONST char" *string .AP "CONST char" *string in Info about environment variable in the form NAME=value. The string is in native format. @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Eval.3,v 1.16 2004/09/06 09:44:56 dkf Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.17 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -17,7 +17,6 @@ Tcl_EvalObjEx, Tcl_EvalFile, Tcl_EvalObjv, Tcl_Eval, Tcl_EvalEx, Tcl_GlobalEval, .nf \fB#include <tcl.h>\fR .sp -.VS int \fBTcl_EvalObjEx\fR(\fIinterp, objPtr, flags\fR) .sp @@ -45,7 +44,7 @@ int int \fBTcl_VarEvalVA\fR(\fIinterp, argList\fR) .SH ARGUMENTS -.AS Tcl_Interp **termPtr; +.AS Tcl_Interp **termPtr .AP Tcl_Interp *interp in Interpreter in which to execute the script. The interpreter's result is modified to hold the result or error message from the script. @@ -199,7 +198,6 @@ the \fBreturn\fR, \fBbreak\fR, or \fBcontinue\fR command was invoked in an inappropriate place. This means that top-level applications should never see a return code from \fBTcl_EvalObjEx\fR other then \fBTCL_OK\fR or \fBTCL_ERROR\fR. -.VE .SH KEYWORDS execute, file, global, object, result, script diff --git a/doc/ExprLong.3 b/doc/ExprLong.3 index 23f3a67..1c5b004 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.6 2002/08/05 03:24:39 dgp Exp $ +'\" RCS: @(#) $Id: ExprLong.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" @@ -28,7 +28,7 @@ int int \fBTcl_ExprString\fR(\fIinterp, string\fR) .SH ARGUMENTS -.AS Tcl_Interp *booleanPtr +.AS Tcl_Interp *booleanPtr out .AP Tcl_Interp *interp in Interpreter in whose context to evaluate \fIstring\fR or \fIobjPtr\fR. .VS 8.4 diff --git a/doc/FindExec.3 b/doc/FindExec.3 index 3e54acd..d6519bf 100644 --- a/doc/FindExec.3 +++ b/doc/FindExec.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: FindExec.3,v 1.5 2001/09/28 17:07:54 msofer Exp $ +'\" RCS: @(#) $Id: FindExec.3,v 1.6 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_FindExecutable 3 8.1 Tcl "Tcl Library Procedures" @@ -21,7 +21,7 @@ void CONST char * \fBTcl_GetNameOfExecutable\fR() .SH ARGUMENTS -.AS char *argv0 in +.AS char *argv0 .AP char *argv0 in The first command-line argument to the program, which gives the application's name. diff --git a/doc/GetCwd.3 b/doc/GetCwd.3 index f154124..554d6e3 100755 --- a/doc/GetCwd.3 +++ b/doc/GetCwd.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: GetCwd.3,v 1.5 2002/02/08 02:52:54 dgp Exp $ +'\" RCS: @(#) $Id: GetCwd.3,v 1.6 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetCwd 3 8.1 Tcl "Tcl Library Procedures" @@ -21,7 +21,7 @@ char * int \fBTcl_Chdir\fR(\fIpath\fR) .SH ARGUMENTS -.AS Tcl_DString *bufferPtr +.AS Tcl_DString *bufferPtr in/out .AP Tcl_Interp *interp in Interpreter in which to report an error, if any. .AP Tcl_DString *bufferPtr in/out diff --git a/doc/GetIndex.3 b/doc/GetIndex.3 index 3d67486..7c4ea50 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.13 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: GetIndex.3,v 1.14 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetIndexFromObj 3 8.1 Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ int msg, flags, indexPtr\fR) .VE .SH ARGUMENTS -.AS "CONST char" **tablePtr +.AS "CONST char" *structTablePtr in/out .AP Tcl_Interp *interp in Interpreter to use for error reporting; if NULL, then no message is provided on errors. diff --git a/doc/GetInt.3 b/doc/GetInt.3 index e036df7..a25fc42 100644 --- a/doc/GetInt.3 +++ b/doc/GetInt.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: GetInt.3,v 1.5 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: GetInt.3,v 1.6 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures" @@ -25,7 +25,7 @@ int int \fBTcl_GetBoolean\fR(\fIinterp, string, boolPtr\fR) .SH ARGUMENTS -.AS Tcl_Interp *doublePtr +.AS Tcl_Interp *doublePtr out .AP Tcl_Interp *interp in Interpreter to use for error reporting. .AP "CONST char" *string in diff --git a/doc/GetOpnFl.3 b/doc/GetOpnFl.3 index 6492870..15ed812 100644 --- a/doc/GetOpnFl.3 +++ b/doc/GetOpnFl.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: GetOpnFl.3,v 1.6 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: GetOpnFl.3,v 1.7 2004/10/07 14:44:32 dkf Exp $ .so man.macros .TH Tcl_GetOpenFile 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -18,7 +18,7 @@ int \fBTcl_GetOpenFile\fR(\fIinterp, string, write, checkUsage, filePtr\fR) .sp .SH ARGUMENTS -.AS Tcl_Interp checkUsage +.AS Tcl_Interp checkUsage out .AP Tcl_Interp *interp in Tcl interpreter from which file handle is to be obtained. .AP "CONST char" *string in diff --git a/doc/GetStdChan.3 b/doc/GetStdChan.3 index 09c65d9..cf17650 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.4 2001/12/10 15:50:46 dgp Exp $ +'\" RCS: @(#) $Id: GetStdChan.3,v 1.5 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetStdChannel 3 7.5 Tcl "Tcl Library Procedures" @@ -22,7 +22,7 @@ Tcl_Channel \fBTcl_SetStdChannel\fR(\fIchannel, type\fR) .sp .SH ARGUMENTS -.AS Tcl_Channel channel in +.AS Tcl_Channel channel .AP int type in The identifier for the standard channel to retrieve or modify. Must be one of \fBTCL_STDIN\fR, \fBTCL_STDOUT\fR, or \fBTCL_STDERR\fR. diff --git a/doc/GetTime.3 b/doc/GetTime.3 index f72175f..7941379 100644 --- a/doc/GetTime.3 +++ b/doc/GetTime.3 @@ -15,9 +15,9 @@ Tcl_GetTime \- get date and time .nf \fB#include <tcl.h>\fR .sp -\fBTcl_GetTime\fR(\fI timePtr \fR) +\fBTcl_GetTime\fR(\fItimePtr\fR) .SH ARGUMENTS -.AS "Tcl_Time *" timePtr +.AS "Tcl_Time *" timePtr out .AP "Tcl_Time *" timePtr out Points to memory in which to store the date and time information. .BE diff --git a/doc/GetVersion.3 b/doc/GetVersion.3 index f985d5f..8082425 100755 --- a/doc/GetVersion.3 +++ b/doc/GetVersion.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: GetVersion.3,v 1.3 2001/12/14 06:04:42 dgp Exp $ +'\" RCS: @(#) $Id: GetVersion.3,v 1.4 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_GetVersion 3 7.5 Tcl "Tcl Library Procedures" @@ -17,6 +17,7 @@ Tcl_GetVersion \- get the version of the library at runtime .sp \fBTcl_GetVersion\fR(\fImajor, minor, patchLevel, type\fR) .SH ARGUMENTS +.AS Tcl_ReleaseType *patchLevel out .AP int *major out Major version number of the Tcl library. .AP int *minor out @@ -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.15 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: Hash.3,v 1.16 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_Hash 3 "" Tcl "Tcl Library Procedures" @@ -49,7 +49,7 @@ Tcl_HashEntry * CONST char * \fBTcl_HashStats\fR(\fItablePtr\fR) .SH ARGUMENTS -.AS Tcl_HashSearch *searchPtr +.AS Tcl_HashKeyType *searchPtr out .AP Tcl_HashTable *tablePtr in Address of hash table structure (for all procedures but \fBTcl_InitHashTable\fR, this must have been initialized by diff --git a/doc/InitStubs.3 b/doc/InitStubs.3 index 584a7cb..46fab2a 100644 --- a/doc/InitStubs.3 +++ b/doc/InitStubs.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: InitStubs.3,v 1.9 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: InitStubs.3,v 1.10 2004/10/07 14:44:32 dkf Exp $ '\" .so man.macros .TH Tcl_InitStubs 3 8.1 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_InitStubs \- initialize the Tcl stubs mechanism CONST char * \fBTcl_InitStubs\fR(\fIinterp, version, exact\fR) .SH ARGUMENTS -.AS Tcl_Interp *interp in +.AS Tcl_Interp *interp .AP Tcl_Interp *interp in Tcl interpreter handle. .AP "CONST char" *version in diff --git a/doc/IntObj.3 b/doc/IntObj.3 index c9dabfb..f5eb92d 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.4 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: IntObj.3,v 1.5 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_IntObj 3 8.0 Tcl "Tcl Library Procedures" @@ -45,7 +45,7 @@ int \fBTcl_GetWideIntFromObj\fR(\fIinterp, objPtr, widePtr\fR) .VE 8.4 .SH ARGUMENTS -.AS Tcl_WideInt *interp +.AS Tcl_WideInt *interp in/out .AP int intValue in Integer value used to initialize or set an integer object. .AP long longValue in diff --git a/doc/Interp.3 b/doc/Interp.3 index 098d026..3862a9c 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.4 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: Interp.3,v 1.5 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_Interp 3 7.5 Tcl "Tcl Library Procedures" @@ -34,6 +34,9 @@ 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 +\fBNote that access to the \fIresult\fP and \fIfreeProc\fP fields is +deprecated.\fR Use \fBTcl_SetResult\fR and \fBTcl_GetResult\fR instead. +.PP The \fIresult\fR and \fIfreeProc\fR fields are used to return results or error messages from commands. This information is returned by command procedures back to \fBTcl_Eval\fR, diff --git a/doc/Limit.3 b/doc/Limit.3 index 2f18624..31b5b62 100644 --- a/doc/Limit.3 +++ b/doc/Limit.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: Limit.3,v 1.3 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: Limit.3,v 1.4 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_LimitCheck 3 8.5 Tcl "Tcl Library Procedures" @@ -60,7 +60,7 @@ void void \fBTcl_LimitRemoveHandler\fR(\fIinterp, type, handlerProc, clientData\fR) .SH ARGUMENTS -.AS Tcl_LimitHandlerDeleteProc commandLimit +.AS Tcl_LimitHandlerDeleteProc commandLimit in/out .AP Tcl_Interp *interp in Interpreter that the limit being managed applies to or that will have its limits checked. diff --git a/doc/ListObj.3 b/doc/ListObj.3 index 5b95d9b..98e7c3b 100644 --- a/doc/ListObj.3 +++ b/doc/ListObj.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: ListObj.3,v 1.5 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: ListObj.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_ListObj 3 8.0 Tcl "Tcl Library Procedures" @@ -38,7 +38,7 @@ int int \fBTcl_ListObjReplace\fR(\fIinterp, listPtr, first, count, objc, objv\fR) .SH ARGUMENTS -.AS Tcl_Interp "*CONST objv[]" out +.AS "Tcl_Obj *CONST" *elemListPtr in/out .AP Tcl_Interp *interp in If an error occurs while converting an object to be a list object, an error message is left in the interpreter's result object @@ -74,7 +74,7 @@ and \fBTcl_ListObjReplace\fR will insert into \fIlistPtr\fR. For \fBTcl_SetListObj\fR, the number of Tcl objects to insert into \fIobjPtr\fR. .VS -.AP Tcl_Obj "*CONST\ objv[]" in +.AP "Tcl_Obj *CONST" objv[] in An array of pointers to objects. \fBTcl_NewListObj\fR will insert these objects into a new list object and \fBTcl_ListObjReplace\fR will insert them into an existing \fIlistPtr\fR. diff --git a/doc/Namespace.3 b/doc/Namespace.3 index f76b421..fb87eb9 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.5 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: Namespace.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ '\" '\" Note that some of these functions do not seem to belong, but they '\" were all introduced with the same TIP (#139) @@ -47,7 +47,7 @@ Tcl_Namespace * Tcl_Command \fBTcl_FindCommand\fR(\fIinterp, name, contextNsPtr, flags\fR) .SH ARGUMENTS -.AS Tcl_NamespaceDeleteProc *allowOverwrite +.AS Tcl_NamespaceDeleteProc allowOverwrite in/out .AP Tcl_Interp *interp in/out The interpreter in which the namespace exists and where name lookups are performed. Also where error result messages are written. diff --git a/doc/Notifier.3 b/doc/Notifier.3 index d7e8b98..f57b96d 100644 --- a/doc/Notifier.3 +++ b/doc/Notifier.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: Notifier.3,v 1.9 2002/07/01 18:24:39 jenglish Exp $ +'\" RCS: @(#) $Id: Notifier.3,v 1.10 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Notifier 3 8.1 Tcl "Tcl Library Procedures" @@ -65,7 +65,7 @@ int int \fBTcl_GetServiceMode\fR() .sp -int +int \fBTcl_SetServiceMode\fR(\fImode\fR) .VE @@ -235,8 +235,8 @@ the event source. \fISetupProc\fR should match the following prototype: .CS typedef void Tcl_EventSetupProc( - ClientData \fIclientData\fR, - int \fIflags\fR); + ClientData \fIclientData\fR, + int \fIflags\fR); .CE The \fIclientData\fR argument will be the same as the \fIclientData\fR argument to \fBTcl_CreateEventSource\fR; it is typically used to @@ -276,8 +276,8 @@ a structure that describes a time interval in seconds and microseconds: .CS typedef struct Tcl_Time { - long \fIsec\fR; - long \fIusec\fR; + long \fIsec\fR; + long \fIusec\fR; } Tcl_Time; .CE The \fIusec\fR field should be less than 1000000. @@ -315,8 +315,8 @@ procedure, indicated by the \fIcheckProc\fR argument to following prototype: .CS typedef void Tcl_EventCheckProc( - ClientData \fIclientData\fR, - int \fIflags\fR); + ClientData \fIclientData\fR, + int \fIflags\fR); .CE The arguments to this procedure are the same as those for \fIsetupProc\fR. \fBCheckProc\fR is invoked by \fBTcl_DoOneEvent\fR after it has waited @@ -373,8 +373,8 @@ in the first queued \fBTcl_Event\fR structure. \fIProc\fR must match the following prototype: .CS typedef int Tcl_EventProc( - Tcl_Event *\fIevPtr\fR, - int \fIflags\fR); + Tcl_Event *\fIevPtr\fR, + int \fIflags\fR); .CE The first argument to \fIproc\fR is a pointer to the event, which will be the same as the first argument to the \fBTcl_QueueEvent\fR call that @@ -434,8 +434,8 @@ returns 1. Events for which the procedure returns 0 are left in the queue. \fIProc\fR should match the following prototype: .CS typedef int Tcl_EventDeleteProc( - Tcl_Event *\fIevPtr\fR, - ClientData \fIclientData\fR); + Tcl_Event *\fIevPtr\fR, + ClientData \fIclientData\fR); .CE The \fIclientData\fR argument will be the same as the \fIclientData\fR argument to \fBTcl_DeleteEvents\fR; it is typically used to point to diff --git a/doc/Object.3 b/doc/Object.3 index adce4c7..f6c8a21 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.7 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: Object.3,v 1.8 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_Obj 3 8.1 Tcl "Tcl Library Procedures" @@ -30,7 +30,7 @@ int .sp \fBTcl_InvalidateStringRep\fR(\fIobjPtr\fR) .SH ARGUMENTS -.AS Tcl_Obj *objPtr in +.AS Tcl_Obj *objPtr .AP Tcl_Obj *objPtr in Points to an object; must have been the result of a previous call to \fBTcl_NewObj\fR. diff --git a/doc/ObjectType.3 b/doc/ObjectType.3 index 2f7e37b..323e6b5 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.9 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: ObjectType.3,v 1.10 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_ObjType 3 8.0 Tcl "Tcl Library Procedures" @@ -26,7 +26,7 @@ int int \fBTcl_ConvertToType\fR(\fIinterp, objPtr, typePtr\fR) .SH ARGUMENTS -.AS Tcl_ObjType *typeName in +.AS Tcl_ObjType *typeName .AP Tcl_ObjType *typePtr in Points to the structure containing information about the Tcl object type. This storage must live forever, diff --git a/doc/OpenFileChnl.3 b/doc/OpenFileChnl.3 index e0bec62..c3992bc 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.26 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: OpenFileChnl.3,v 1.27 2004/10/07 14:44:33 dkf Exp $ .so man.macros .TH Tcl_OpenFileChannel 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -26,14 +26,12 @@ Tcl_Channel .sp Tcl_Channel \fBTcl_GetChannel\fR(\fIinterp, channelName, modePtr\fR) -.VS 8.3 .sp int \fBTcl_GetChannelNames\fR(\fIinterp\fR) .sp int \fBTcl_GetChannelNamesEx\fR(\fIinterp, pattern\fR) -.VE .sp void \fBTcl_RegisterChannel\fR(\fIinterp, channel\fR) @@ -50,7 +48,6 @@ int int \fBTcl_Close\fR(\fIinterp, channel\fR) .sp -.VS 8.1 int \fBTcl_ReadChars\fR(\fIchannel, readObjPtr, charsToRead, appendFlag\fR) .sp @@ -74,15 +71,12 @@ int .sp int \fBTcl_Write\fR(\fIchannel, byteBuf, bytesToWrite\fR) -.VE -.VS 8.3.2 .sp int \fBTcl_ReadRaw\fR(\fIchannel, readBuf, bytesToRead\fR) .sp int \fBTcl_WriteRaw\fR(\fIchannel, byteBuf, bytesToWrite\fR) -.VE .sp int \fBTcl_Eof\fR(\fIchannel\fR) @@ -114,7 +108,7 @@ int \fBTcl_SetChannelOption\fR(\fIinterp, channel, optionName, newValue\fR) .sp .SH ARGUMENTS -.AS Tcl_ChannelType newClientProcPtr in +.AS Tcl_ChannelType newClientProcPtr in/out .AP Tcl_Interp *interp in Used for error reporting and to look up a channel registered in it. .AP "CONST char" *fileName in @@ -152,14 +146,11 @@ The name of the channel. Points at an integer variable that will receive an OR-ed combination of \fBTCL_READABLE\fR and \fBTCL_WRITABLE\fR denoting whether the channel is open for reading and writing. -.VS 8.3 .AP "CONST char" *pattern in The pattern to match on, passed to Tcl_StringMatch, or NULL. -.VE .AP Tcl_Channel channel in A Tcl channel for input or output. Must have been the return value from a procedure such as \fBTcl_OpenFileChannel\fR. -.VS 8.1 br .AP Tcl_Obj *readObjPtr in/out A pointer to a Tcl Object in which to store the characters read from the channel. @@ -183,7 +174,6 @@ object. A pointer to a Tcl dynamic string in which to store the line read from the channel. Must have been initialized by the caller. The line read will be appended to any data already in the dynamic string. -.VS 8.3 .AP "CONST char" *input in The input to add to a channel buffer. .AP int inputLen in @@ -191,7 +181,6 @@ Length of the input .AP int addAtEnd in Flag indicating whether the input should be added to the end or beginning of the channel buffer. -.VE .AP Tcl_Obj *writeObjPtr in A pointer to a Tcl Object whose contents will be output to the channel. .AP "CONST char" *charBuf in @@ -201,7 +190,6 @@ A buffer containing the bytes to output to the channel. .AP int bytesToWrite in The number of bytes to consume from \fIcharBuf\fR or \fIbyteBuf\fR and output to the channel. -.VE .AP Tcl_WideInt offset in How far to move the access point in the channel at which the next input or output operation will be applied, measured in bytes from the position @@ -422,7 +410,6 @@ been given as the \fBchan\fR argument in a call to when all calls to \fBTcl_RegisterChannel\fR have been matched by corresponding calls to \fBTcl_UnregisterChannel\fR. -.VS 8.1 br .SH "TCL_READCHARS AND TCL_READ" .PP \fBTcl_ReadChars\fR consumes bytes from \fIchannel\fR, converting the bytes @@ -576,7 +563,6 @@ not. Thus this function is \fBonly\fR usable for transformational channel drivers, i.e. drivers used in the middle of a stack of channels, to move data from the transformation into the channel below it. -.VE .SH TCL_FLUSH .PP diff --git a/doc/OpenTcp.3 b/doc/OpenTcp.3 index 1da560d..aa95278 100644 --- a/doc/OpenTcp.3 +++ b/doc/OpenTcp.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: OpenTcp.3,v 1.5 2004/03/17 18:14:12 das Exp $ +'\" RCS: @(#) $Id: OpenTcp.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ .so man.macros .TH Tcl_OpenTcpClient 3 8.0 Tcl "Tcl Library Procedures" .BS @@ -25,7 +25,7 @@ Tcl_Channel \fBTcl_OpenTcpServer\fR(\fIinterp, port, myaddr, proc, clientData\fR) .sp .SH ARGUMENTS -.AS Tcl_ChannelType newClientProcPtr in +.AS Tcl_TcpAcceptProc clientData .AP Tcl_Interp *interp in Tcl interpreter to use for error reporting. If non-NULL and an error occurs, an error message is left in the interpreter's result. diff --git a/doc/ParseCmd.3 b/doc/ParseCmd.3 index 97d6aeb..9738790 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.14 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: ParseCmd.3,v 1.15 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_ParseCommand 3 8.3 Tcl "Tcl Library Procedures" @@ -41,7 +41,7 @@ Tcl_Obj * int \fBTcl_EvalTokensStandard\fR(\fIinterp, tokenPtr, numTokens\fR) .SH ARGUMENTS -.AS Tcl_Interp *usedParsePtr +.AS Tcl_Interp *usedParsePtr out .AP Tcl_Interp *interp out For procedures other than \fBTcl_FreeParse\fR, \fBTcl_EvalTokens\fR and \fBTcl_EvalTokensStandard\fR, used only for error reporting; diff --git a/doc/PkgRequire.3 b/doc/PkgRequire.3 index e2a4877..4259203 100644 --- a/doc/PkgRequire.3 +++ b/doc/PkgRequire.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: PkgRequire.3,v 1.7 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: PkgRequire.3,v 1.8 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_PkgRequire 3 7.5 Tcl "Tcl Library Procedures" @@ -33,7 +33,7 @@ int int \fBTcl_PkgProvideEx\fR(\fIinterp, name, version, clientData\fR) .SH ARGUMENTS -.AS ClientData clientDataPtr +.AS ClientData clientDataPtr out .AP Tcl_Interp *interp in Interpreter where package is needed or available. .AP "CONST char" *name in diff --git a/doc/PrintDbl.3 b/doc/PrintDbl.3 index 1a08c8e..29cacdb 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.4 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: PrintDbl.3,v 1.5 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_PrintDouble 3 8.0 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_PrintDouble \- Convert floating value to string .sp \fBTcl_PrintDouble\fR(\fIinterp, value, dst\fR) .SH ARGUMENTS -.AS Tcl_Interp *interp +.AS Tcl_Interp *interp out .AP Tcl_Interp *interp in .VS Before Tcl 8.0, the \fBtcl_precision\fR variable in this interpreter diff --git a/doc/RecordEval.3 b/doc/RecordEval.3 index 6301a82..3b169c4 100644 --- a/doc/RecordEval.3 +++ b/doc/RecordEval.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: RecordEval.3,v 1.5 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: RecordEval.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures" @@ -19,7 +19,7 @@ Tcl_RecordAndEval \- save command on history list before evaluating int \fBTcl_RecordAndEval\fR(\fIinterp, cmd, 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 "CONST char" *cmd in diff --git a/doc/RegConfig.3 b/doc/RegConfig.3 index f9d200a..2ebaef9 100644 --- a/doc/RegConfig.3 +++ b/doc/RegConfig.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: RegConfig.3,v 1.4 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: RegConfig.3,v 1.5 2004/10/07 14:44:33 dkf Exp $ .so man.macros .TH Tcl_RegisterConfig 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -19,7 +19,7 @@ void \fBTcl_RegisterConfig\fR(\fIinterp, pkgName, configuration, valEncoding\fR) .sp .SH ARGUMENTS -.AS Tcl_Interp *interp +.AS Tcl_Interp *configuration .AP Tcl_Interp *interp in Refers to the interpreter the embedded configuration information is registered for. Must not be NULL. diff --git a/doc/RegExp.3 b/doc/RegExp.3 index 836126d..31b8330 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.15 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: RegExp.3,v 1.16 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -30,7 +30,6 @@ int \fBTcl_RegExpExec\fR(\fIinterp\fR, \fIregexp\fR, \fIstring\fR, \fIstart\fR) .sp \fBTcl_RegExpRange\fR(\fIregexp\fR, \fIindex\fR, \fIstartPtr\fR, \fIendPtr\fR) -.VS 8.1 .sp Tcl_RegExp \fBTcl_GetRegExpFromObj\fR(\fIinterp\fR, \fIpatObj\fR, \fIcflags\fR) @@ -39,14 +38,12 @@ int \fBTcl_RegExpExecObj\fR(\fIinterp\fR, \fIregexp\fR, \fIobjPtr\fR, \fIoffset\fR, \fInmatches\fR, \fIeflags\fR) .sp \fBTcl_RegExpGetInfo\fR(\fIregexp\fR, \fIinfoPtr\fR) -.VE 8.1 .SH ARGUMENTS -.AS Tcl_Interp *interp +.AS Tcl_RegExpInfo *interp in/out .AP Tcl_Interp *interp in Tcl interpreter to use for error reporting. The interpreter may be NULL if no error reporting is desired. -.VS 8.1 .AP Tcl_Obj *strObj in/out Refers to the object from which to get the string to search. The internal representation of the object may be converted to a form that @@ -54,7 +51,6 @@ can be efficiently searched. .AP Tcl_Obj *patObj in/out Refers to the object from which to get a regular expression. The compiled regular expression is cached in the object. -.VE 8.1 .AP char *string in String to check for a match with a regular expression. .AP "CONST char" *pattern in @@ -79,7 +75,6 @@ NULL if there is no such range. The address of the character just after the last one in the range is stored here, or NULL if there is no such range. .VE 8.4 -.VS 8.1 .AP int cflags in OR-ed combination of compilation flags. See below for more information. .AP Tcl_Obj *objPtr in/out @@ -102,7 +97,6 @@ See below for more information. .AP Tcl_RegExpInfo *infoPtr out The address of the location where information about a previous match should be stored by \fBTcl_RegExpGetInfo\fR. -.VE 8.1 .BE .SH DESCRIPTION @@ -116,13 +110,11 @@ If there is no match then \fBTcl_RegExpMatch\fR returns 0. If an error occurs in the matching process (e.g. \fIpattern\fR is not a valid regular expression) then \fBTcl_RegExpMatch\fR returns \-1 and leaves an error message in the interpreter result. -.VS 8.1.2 \fBTcl_RegExpMatchObj\fR is similar to \fBTcl_RegExpMatch\fR except it operates on the Tcl objects \fIstrObj\fR and \fIpatObj\fR instead of UTF strings. \fBTcl_RegExpMatchObj\fR is generally more efficient than \fBTcl_RegExpMatch\fR, so it is the preferred interface. -.VE 8.1.2 .PP \fBTcl_RegExpCompile\fR, \fBTcl_RegExpExec\fR, and \fBTcl_RegExpRange\fR provide lower-level access to the regular expression pattern matcher. @@ -170,7 +162,6 @@ information is returned about the range of characters that matched the If there is no range corresponding to \fIindex\fR then NULL is stored in \fI*startPtr\fR and \fI*endPtr\fR. .PP -.VS 8.1 \fBTcl_GetRegExpFromObj\fR, \fBTcl_RegExpExecObj\fR, and \fBTcl_RegExpGetInfo\fR are object interfaces that provide the most direct control of Henry Spencer's regular expression library. For @@ -343,7 +334,7 @@ If no match was found, then it indicates the earliest point at which a match might occur if additional text is appended to the string. If it is no match is possible even with further text, this field will be set to -1. -.VE 8.1 + .SH "SEE ALSO" re_syntax(n) .SH KEYWORDS diff --git a/doc/SetErrno.3 b/doc/SetErrno.3 index d8eb1c1..5c24454 100644 --- a/doc/SetErrno.3 +++ b/doc/SetErrno.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: SetErrno.3,v 1.5 2002/01/15 21:47:27 dgp Exp $ +'\" RCS: @(#) $Id: SetErrno.3,v 1.6 2004/10/07 14:44:33 dkf Exp $ .so man.macros .TH Tcl_SetErrno 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -27,7 +27,7 @@ CONST char * \fBTcl_ErrnoMsg\fR(\fIerrorCode\fR) .sp .SH ARGUMENTS -.AS int errorCode in +.AS int errorCode .AP int errorCode in A POSIX error code such as \fBENOENT\fR. .BE diff --git a/doc/SetResult.3 b/doc/SetResult.3 index cf7f623..3ec367b 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.9 2004/10/05 23:21:27 dkf Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.10 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" @@ -36,7 +36,7 @@ CONST char * .sp \fBTcl_FreeResult\fR(\fIinterp\fR) .SH ARGUMENTS -.AS Tcl_FreeProc freeProc +.AS Tcl_FreeProc freeProc out .AP Tcl_Interp *interp out Interpreter whose result is to be modified or read. .AP Tcl_Obj *objPtr in diff --git a/doc/Signal.3 b/doc/Signal.3 index e11c944..cb6d040 100644 --- a/doc/Signal.3 +++ b/doc/Signal.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: Signal.3,v 1.2 2002/01/15 21:19:06 dgp Exp $ +'\" RCS: @(#) $Id: Signal.3,v 1.3 2004/10/07 14:44:33 dkf Exp $ .so man.macros .TH Tcl_SignalId 3 8.3 Tcl "Tcl Library Procedures" .BS @@ -21,6 +21,7 @@ CONST char * \fBTcl_SignalMsg\fR(\fIsig\fR) .sp .SH ARGUMENTS +.AS int sig .AP int sig in A POSIX signal number such as \fBSIGPIPE\fR. .BE diff --git a/doc/Sleep.3 b/doc/Sleep.3 index fcfed9b..a76d671 100644 --- a/doc/Sleep.3 +++ b/doc/Sleep.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: Sleep.3,v 1.2 1998/09/14 18:39:50 stanton Exp $ +'\" RCS: @(#) $Id: Sleep.3,v 1.3 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_Sleep 3 7.5 Tcl "Tcl Library Procedures" @@ -18,6 +18,7 @@ Tcl_Sleep \- delay execution for a given number of milliseconds .sp \fBTcl_Sleep\fR(\fIms\fR) .SH ARGUMENTS +.AS int ms .AP int ms in Number of milliseconds to sleep. .BE diff --git a/doc/SourceRCFile.3 b/doc/SourceRCFile.3 index a904fd7..a871fc0 100644 --- a/doc/SourceRCFile.3 +++ b/doc/SourceRCFile.3 @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: SourceRCFile.3,v 1.2 2004/03/17 18:14:12 das Exp $ +'\" RCS: @(#) $Id: SourceRCFile.3,v 1.3 2004/10/07 14:44:34 dkf Exp $ '\" '\" .so man.macros @@ -17,6 +17,7 @@ Tcl_SourceRCFile \- source the Tcl rc file void \fBTcl_SourceRCFile\fR(\fIinterp\fR) .SH ARGUMENTS +.AP Tcl_Interp *interp .AP Tcl_Interp *interp in Tcl interpreter to source rc file into. .BE diff --git a/doc/SplitList.3 b/doc/SplitList.3 index a237293..861e6f1 100644 --- a/doc/SplitList.3 +++ b/doc/SplitList.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: SplitList.3,v 1.7 2003/09/04 16:44:12 dgp Exp $ +'\" RCS: @(#) $Id: SplitList.3,v 1.8 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_SplitList 3 8.0 Tcl "Tcl Library Procedures" @@ -34,7 +34,7 @@ int int \fBTcl_ConvertCountedElement\fR(\fIsrc, length, dst, flags\fR) .SH ARGUMENTS -.AS "CONST char * CONST" ***argvPtr +.AS "CONST char * CONST" ***argvPtr out .AP Tcl_Interp *interp out Interpreter to use for error reporting. If NULL, then no error message is left. diff --git a/doc/SplitPath.3 b/doc/SplitPath.3 index acee4e4..9964f3a 100644 --- a/doc/SplitPath.3 +++ b/doc/SplitPath.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: SplitPath.3,v 1.7 2002/03/09 19:17:58 dgp Exp $ +'\" RCS: @(#) $Id: SplitPath.3,v 1.8 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_SplitPath 3 7.5 Tcl "Tcl Library Procedures" @@ -23,8 +23,8 @@ char * Tcl_PathType \fBTcl_GetPathType\fR(\fIpath\fR) .SH ARGUMENTS -.AS Tcl_DString ***argvPtr -.AP "CONST char * CONST" *argvPtr in +.AS "CONST char * CONST" ***argvPtr in/out +.AP "CONST char" *path in File path in a form appropriate for the current platform (see the \fBfilename\fR manual entry for acceptable forms for path names). .AP int *argcPtr out diff --git a/doc/StrMatch.3 b/doc/StrMatch.3 index 71c8a6b..6b009da 100644 --- a/doc/StrMatch.3 +++ b/doc/StrMatch.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: StrMatch.3,v 1.4 2000/05/08 22:05:00 hobbs Exp $ +'\" RCS: @(#) $Id: StrMatch.3,v 1.5 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_StringMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -22,9 +22,10 @@ int int \fBTcl_StringCaseMatch\fR(\fIstring\fR, \fIpattern\fR, \fInocase\fR) .SH ARGUMENTS -.AP char *string in +.AS "CONST char" *pattern +.AP "CONST char" *string in String to test. -.AP char *pattern in +.AP "CONST char" *pattern in Pattern to match against string. May contain special characters from the set *?\e[]. .AP int nocase in diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index 5aa3eda..5f39c15 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.2 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: SubstObj.3,v 1.3 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures" @@ -18,7 +18,7 @@ Tcl_SubstObj \- perform substitutions on Tcl objects Tcl_Obj * \fBTcl_SubstObj\fR(\fIinterp, objPtr, flags\fR) .SH ARGUMENTS -.AS Tcl_Interp **termPtr; +.AS Tcl_Interp **termPtr .AP Tcl_Interp *interp in Interpreter in which to execute Tcl scripts and lookup variables. If an error occurs, the interpreter's result is modified to hold an error diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index b0dc0da..6c02a9e 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.10 2003/09/05 22:55:32 dgp Exp $ +'\" RCS: @(#) $Id: Tcl_Main.3,v 1.11 2004/10/07 14:44:34 dkf Exp $ '\" .so man.macros .TH Tcl_Main 3 8.4 Tcl "Tcl Library Procedures" @@ -21,7 +21,7 @@ Tcl_Main, Tcl_SetMainLoop \- main program and event loop definition for Tcl-base .sp \fBTcl_SetMainLoop\fR(\fImainLoopProc\fR) .SH ARGUMENTS -.AS Tcl_AppInitProc *appInitProc +.AS Tcl_MainLoopProc *mainLoopProc .AP int argc in Number of elements in \fIargv\fR. .AP char *argv[] in diff --git a/doc/Thread.3 b/doc/Thread.3 index 48b7d01..d1962e4 100644 --- a/doc/Thread.3 +++ b/doc/Thread.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Thread.3,v 1.18 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: Thread.3,v 1.19 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Threads 3 "8.1" Tcl "Tcl Library Procedures" @@ -43,7 +43,7 @@ int int \fBTcl_JoinThread\fR(\fIid, result\fR) .SH ARGUMENTS -.AS Tcl_CreateThreadProc *keyPtr +.AS Tcl_CreateThreadProc threadProc out .AP Tcl_Condition *condPtr in A condition variable, which must be associated with a mutex lock. .AP Tcl_Mutex *mutexPtr in diff --git a/doc/Translate.3 b/doc/Translate.3 index 5602424..3f80f3a 100644 --- a/doc/Translate.3 +++ b/doc/Translate.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: Translate.3,v 1.7 2003/07/28 12:16:02 vincentdarley Exp $ +'\" RCS: @(#) $Id: Translate.3,v 1.8 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Tcl_TranslateFileName 3 8.1 Tcl "Tcl Library Procedures" @@ -19,7 +19,7 @@ Tcl_TranslateFileName \- convert file name to native form and replace tilde with char * \fBTcl_TranslateFileName\fR(\fIinterp\fR, \fIname\fR, \fIbufferPtr\fR) .SH ARGUMENTS -.AS Tcl_DString *bufferPtr +.AS Tcl_DString *bufferPtr in/out .AP Tcl_Interp *interp in Interpreter in which to report an error, if any. .AP "CONST char" *name in diff --git a/doc/UniCharIsAlpha.3 b/doc/UniCharIsAlpha.3 index 7c1af13..a53cacf 100644 --- a/doc/UniCharIsAlpha.3 +++ b/doc/UniCharIsAlpha.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: UniCharIsAlpha.3,v 1.2 2001/05/03 23:59:01 hobbs Exp $ +'\" RCS: @(#) $Id: UniCharIsAlpha.3,v 1.3 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Tcl_UniCharIsAlpha 3 "8.1" Tcl "Tcl Library Procedures" @@ -48,6 +48,7 @@ int int \fBTcl_UniCharIsWordChar\fR(\fIch\fR) .SH ARGUMENTS +.AS int ch .AP int ch in The Tcl_UniChar to be examined. .BE diff --git a/doc/UpVar.3 b/doc/UpVar.3 index ff43044..0c8beeb 100644 --- a/doc/UpVar.3 +++ b/doc/UpVar.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: UpVar.3,v 1.8 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: UpVar.3,v 1.9 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Tcl_UpVar 3 7.4 Tcl "Tcl Library Procedures" @@ -22,7 +22,7 @@ int int \fBTcl_UpVar2(\fIinterp, frameName, name1, name2, destName, flags\fB)\fR .SH ARGUMENTS -.AS Tcl_VarTraceProc prevClientData +.AS "CONST char" *sourceName .AP Tcl_Interp *interp in Interpreter containing variables; also used for error reporting. .AP "CONST char" *frameName in @@ -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.17 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: Utf.3,v 1.18 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Utf 3 "8.1" Tcl "Tcl Library Procedures" @@ -82,7 +82,7 @@ CONST char * int \fBTcl_UtfBackslash\fR(\fIsrc, readPtr, dst\fR) .SH ARGUMENTS -.AS "CONST Tcl_UniChar" numChars in/out +.AS "CONST Tcl_UniChar" *uniPattern in/out .AP char *buf out Buffer in which the UTF-8 representation of the Tcl_UniChar is stored. At most \fBTCL_UTF_MAX\fR bytes are stored in the buffer. diff --git a/doc/WrongNumArgs.3 b/doc/WrongNumArgs.3 index 8d60608..1113bc0 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.6 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.7 2004/10/07 14:44:35 dkf Exp $ '\" .so man.macros .TH Tcl_WrongNumArgs 3 8.0 Tcl "Tcl Library Procedures" @@ -17,14 +17,14 @@ Tcl_WrongNumArgs \- generate standard error message for wrong number of argument .sp \fBTcl_WrongNumArgs\fR(\fIinterp, objc, objv, message\fR) .SH ARGUMENTS -.AS Tcl_Interp "*CONST objv[]" +.AS "Tcl_Obj *CONST" *message .AP Tcl_Interp interp in Interpreter in which error will be reported: error message gets stored in its result object. .AP int objc in Number of leading arguments from \fIobjv\fR to include in error message. -.AP Tcl_Obj "*CONST\ objv[]" in +.AP "Tcl_Obj *CONST" objv[] in Arguments to command that had the wrong number of arguments. .AP "CONST char" *message in Additional error information to print after leading arguments diff --git a/doc/man.macros b/doc/man.macros index 81fbe2b..29b8a51 100644 --- a/doc/man.macros +++ b/doc/man.macros @@ -8,10 +8,11 @@ '\" and indent is equivalent to second arg of .IP (shouldn't ever be '\" needed; use .AS below instead) '\" -'\" .AS ?type? ?name? +'\" .AS ?type? ?name? ?in|out|in/out? '\" Give maximum sizes of arguments for setting tab stops. Type and '\" name are examples of largest possible arguments that will be passed -'\" to .AP later. If args are omitted, default tab stops are used. +'\" to .AP later. If args are omitted, default tab stops are used. If +'\" the third arg is not supplied, "in" is assumed. '\" '\" .BS '\" Start box enclosure. From here until next .BE, everything will be @@ -59,7 +60,7 @@ '\" .UL arg1 arg2 '\" Print arg1 underlined, then print arg2 normally. '\" -'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ +'\" RCS: @(#) $Id: man.macros,v 1.5 2004/10/07 14:44:35 dkf Exp $ '\" '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B @@ -90,11 +91,12 @@ '\" # define tabbing values for .AP .de AS .nr )A 10n -.if !"\\$1"" .nr )A \\w'\\$1'u+3n +.if !"\\$1"" .nr )A \\w'\\$1'u+1n .nr )B \\n()Au+15n .\" -.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n -.nr )C \\n()Bu+\\w'(in/out)'u+2n +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+2n +.ie !"\\$3"" .nr )C \\n()Bu+\\w'(\\$3)'u+2n +.el .nr )C \\n()Bu+\\w'(in)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out '\" # BS - start boxed text |