diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-24 14:29:35 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-24 14:29:35 (GMT) |
| commit | f78fd9556a52ef9c7737df64e1d37f1ab5ba9746 (patch) | |
| tree | fec73cd4bb84dace903da378ecd214cb13da4181 | |
| parent | a796f06789efc26f57bf30fd83ed98762f97ad30 (diff) | |
| download | tcl-f78fd9556a52ef9c7737df64e1d37f1ab5ba9746.zip tcl-f78fd9556a52ef9c7737df64e1d37f1ab5ba9746.tar.gz tcl-f78fd9556a52ef9c7737df64e1d37f1ab5ba9746.tar.bz2 | |
Lots of improvements to look and feel of manual pages
| -rw-r--r-- | ChangeLog | 7 | ||||
| -rw-r--r-- | doc/AppInit.3 | 6 | ||||
| -rw-r--r-- | doc/BackgdErr.3 | 5 | ||||
| -rw-r--r-- | doc/CrtChannel.3 | 10 | ||||
| -rw-r--r-- | doc/CrtSlave.3 | 23 | ||||
| -rw-r--r-- | doc/DString.3 | 8 | ||||
| -rw-r--r-- | doc/Encoding.3 | 18 | ||||
| -rw-r--r-- | doc/Eval.3 | 13 | ||||
| -rw-r--r-- | doc/ExprLong.3 | 9 | ||||
| -rw-r--r-- | doc/ExprLongObj.3 | 9 | ||||
| -rw-r--r-- | doc/FileSystem.3 | 18 | ||||
| -rw-r--r-- | doc/GetInt.3 | 19 | ||||
| -rw-r--r-- | doc/Hash.3 | 34 | ||||
| -rw-r--r-- | doc/LinkVar.3 | 11 | ||||
| -rw-r--r-- | doc/Notifier.3 | 6 | ||||
| -rw-r--r-- | doc/PrintDbl.3 | 13 | ||||
| -rw-r--r-- | doc/RegExp.3 | 95 | ||||
| -rw-r--r-- | doc/SetResult.3 | 9 | ||||
| -rw-r--r-- | doc/SetVar.3 | 7 | ||||
| -rw-r--r-- | doc/SplitList.3 | 6 | ||||
| -rw-r--r-- | doc/StdChannels.3 | 9 | ||||
| -rw-r--r-- | doc/StrMatch.3 | 5 | ||||
| -rw-r--r-- | doc/SubstObj.3 | 12 | ||||
| -rw-r--r-- | doc/TCL_MEM_DEBUG.3 | 15 | ||||
| -rw-r--r-- | doc/Tcl.n | 56 | ||||
| -rw-r--r-- | doc/Tcl_Main.3 | 12 | ||||
| -rw-r--r-- | doc/TraceVar.3 | 7 | ||||
| -rw-r--r-- | doc/Translate.3 | 5 | ||||
| -rw-r--r-- | doc/WrongNumArgs.3 | 5 | ||||
| -rw-r--r-- | doc/after.n | 4 | ||||
| -rw-r--r-- | doc/append.n | 11 | ||||
| -rw-r--r-- | doc/array.n | 4 | ||||
| -rw-r--r-- | doc/bgerror.n | 4 | ||||
| -rw-r--r-- | doc/binary.n | 17 | ||||
| -rw-r--r-- | doc/break.n | 4 | ||||
| -rw-r--r-- | doc/catch.n | 4 | ||||
| -rw-r--r-- | doc/cd.n | 4 | ||||
| -rw-r--r-- | doc/chan.n | 6 | ||||
| -rw-r--r-- | doc/close.n | 4 | ||||
| -rw-r--r-- | doc/concat.n | 4 | ||||
| -rw-r--r-- | doc/continue.n | 4 | ||||
| -rw-r--r-- | doc/dde.n | 10 | ||||
| -rw-r--r-- | doc/dict.n | 6 | ||||
| -rw-r--r-- | doc/encoding.n | 6 | ||||
| -rw-r--r-- | doc/eof.n | 4 | ||||
| -rw-r--r-- | doc/exec.n | 54 | ||||
| -rw-r--r-- | doc/expr.n | 33 | ||||
| -rw-r--r-- | doc/fcopy.n | 5 | ||||
| -rw-r--r-- | doc/file.n | 48 | ||||
| -rw-r--r-- | doc/fileevent.n | 9 | ||||
| -rw-r--r-- | doc/for.n | 4 | ||||
| -rw-r--r-- | doc/format.n | 11 | ||||
| -rw-r--r-- | doc/glob.n | 83 | ||||
| -rw-r--r-- | doc/history.n | 10 | ||||
| -rw-r--r-- | doc/http.n | 15 | ||||
| -rw-r--r-- | doc/if.n | 5 | ||||
| -rw-r--r-- | doc/interp.n | 11 | ||||
| -rw-r--r-- | doc/lappend.n | 10 | ||||
| -rw-r--r-- | doc/library.n | 18 | ||||
| -rw-r--r-- | doc/llength.n | 6 | ||||
| -rw-r--r-- | doc/load.n | 17 | ||||
| -rw-r--r-- | doc/lrange.n | 12 | ||||
| -rw-r--r-- | doc/lreplace.n | 12 | ||||
| -rwxr-xr-x | doc/lset.n | 4 | ||||
| -rw-r--r-- | doc/lsort.n | 11 | ||||
| -rw-r--r-- | doc/man.macros | 216 | ||||
| -rw-r--r-- | doc/msgcat.n | 51 | ||||
| -rw-r--r-- | doc/namespace.n | 21 | ||||
| -rw-r--r-- | doc/open.n | 71 | ||||
| -rw-r--r-- | doc/package.n | 7 | ||||
| -rw-r--r-- | doc/packagens.n | 5 | ||||
| -rw-r--r-- | doc/pkgMkIndex.n | 18 | ||||
| -rw-r--r-- | doc/re_syntax.n | 546 | ||||
| -rw-r--r-- | doc/read.n | 8 | ||||
| -rw-r--r-- | doc/regexp.n | 39 | ||||
| -rw-r--r-- | doc/regsub.n | 56 | ||||
| -rw-r--r-- | doc/scan.n | 5 | ||||
| -rw-r--r-- | doc/source.n | 14 | ||||
| -rw-r--r-- | doc/subst.n | 50 | ||||
| -rw-r--r-- | doc/switch.n | 9 | ||||
| -rw-r--r-- | doc/tclsh.1 | 12 | ||||
| -rw-r--r-- | doc/tcltest.n | 148 | ||||
| -rw-r--r-- | doc/tclvars.n | 30 | ||||
| -rw-r--r-- | doc/tm.n | 57 | ||||
| -rw-r--r-- | doc/update.n | 5 | ||||
| -rw-r--r-- | doc/uplevel.n | 9 |
86 files changed, 1459 insertions, 844 deletions
@@ -1,3 +1,10 @@ +2007-10-24 Donal K. Fellows <donal.k.fellows@man.ac.uk> + + * doc/man.macros (QW,PQ,QR,MT): New macros that hide the ugly mess + needed to get proper GOOBE quoting in the manual pages. + * doc/*.n, doc/*.3, doc/*.1: Lots of changes to take advantage of the + new macros. + 2007-10-20 Miguel Sofer <msofer@users.sf.net> * generic/tclCompile.c: Fix comments. diff --git a/doc/AppInit.3 b/doc/AppInit.3 index 3120b63..0ac4f94 100644 --- a/doc/AppInit.3 +++ b/doc/AppInit.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: AppInit.3,v 1.5 2006/07/30 16:18:59 jenglish Exp $ +'\" RCS: @(#) $Id: AppInit.3,v 1.6 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_AppInit 3 7.0 Tcl "Tcl Library Procedures" @@ -26,7 +26,9 @@ Interpreter for the application. .SH DESCRIPTION .PP -\fBTcl_AppInit\fR is a ``hook'' procedure that is invoked by +\fBTcl_AppInit\fR is a +.QW hook +procedure that is invoked by the main programs for Tcl applications such as \fBtclsh\fR and \fBwish\fR. Its purpose is to allow new Tcl applications to be created without modifying the main programs provided as part of Tcl and Tk. diff --git a/doc/BackgdErr.3 b/doc/BackgdErr.3 index 315e3b9..f8a516f 100644 --- a/doc/BackgdErr.3 +++ b/doc/BackgdErr.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: BackgdErr.3,v 1.4 2004/11/20 00:17:31 dgp Exp $ +'\" RCS: @(#) $Id: BackgdErr.3,v 1.5 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_BackgroundError 3 7.5 Tcl "Tcl Library Procedures" @@ -26,7 +26,8 @@ Interpreter in which the error occurred. .SH DESCRIPTION .PP This procedure is typically invoked when a Tcl error occurs during -``background processing'' such as executing an event handler. +.QW "background processing" +such as executing an event handler. When such an error occurs, the error condition is reported to Tcl or to a widget or some other C code, and there is not usually any obvious way for that code to report the error to the user. diff --git a/doc/CrtChannel.3 b/doc/CrtChannel.3 index b05ce47..c4c61f4 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.35 2007/02/24 18:29:23 dgp Exp $ +'\" RCS: @(#) $Id: CrtChannel.3,v 1.36 2007/10/24 14:29:37 dkf Exp $ .so man.macros .TH Tcl_CreateChannel 3 8.4 Tcl "Tcl Library Procedures" .BS @@ -873,10 +873,14 @@ so you get for instance: .CE when called with \fIoptionList\fR="peername sockname" .PP -``blah'' is the \fIoptionName\fR argument and ``<specific options>'' +.QW blah +is the \fIoptionName\fR argument and +.QW "<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. +each option, commas after, and an +.QW or +before the last option. .SH "OLD CHANNEL TYPES" The original (8.3.1 and below) \fBTcl_ChannelType\fR structure contains the following fields: diff --git a/doc/CrtSlave.3 b/doc/CrtSlave.3 index 1ee41b0..4322825 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.16 2005/05/10 18:33:54 kennykb Exp $ +'\" RCS: @(#) $Id: CrtSlave.3,v 1.17 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_CreateSlave 3 7.6 Tcl "Tcl Library Procedures" @@ -61,7 +61,9 @@ Interpreter in which to execute the specified command. .AP "const char" *slaveName in Name of slave interpreter to create or manipulate. .AP int isSafe in -If non-zero, a ``safe'' slave that is suitable for running untrusted code +If non-zero, a +.QW safe +slave that is suitable for running untrusted code is created, otherwise a trusted slave is created. .AP Tcl_Interp *slaveInterp in Interpreter to use for creating the source command for an alias (see @@ -126,16 +128,21 @@ It also creates a slave command named \fIslaveName\fR in \fIinterp\fR which allows \fIinterp\fR to manipulate the new slave. If \fIisSafe\fR is zero, the command creates a trusted slave in which Tcl code has access to all the Tcl commands. -If it is \fB1\fR, the command creates a ``safe'' slave in which Tcl code -has access only to set of Tcl commands defined as ``Safe Tcl''; see the -manual entry for the Tcl \fBinterp\fR command for details. +If it is \fB1\fR, the command creates a +.QW safe +slave in which Tcl code has access only to set of Tcl commands defined as +.QW "Safe Tcl" ; +see the manual entry for the Tcl \fBinterp\fR command for details. If the creation of the new slave interpreter failed, \fBNULL\fR is returned. .PP -\fBTcl_IsSafe\fR returns \fB1\fR if \fIinterp\fR is ``safe'' (was created -with the \fBTCL_SAFE_INTERPRETER\fR flag specified), +\fBTcl_IsSafe\fR returns \fB1\fR if \fIinterp\fR is +.QW safe +(was created with the \fBTCL_SAFE_INTERPRETER\fR flag specified), \fB0\fR otherwise. .PP -\fBTcl_MakeSafe\fR marks \fIinterp\fR as ``safe'', so that future +\fBTcl_MakeSafe\fR marks \fIinterp\fR as +.QW safe , +so that future calls to \fBTcl_IsSafe\fR will return 1. It also removes all known potentially-unsafe core functionality (both commands and variables) from \fIinterp\fR. However, it cannot know what parts of an extension diff --git a/doc/DString.3 b/doc/DString.3 index 8c44bb2..6b3c4c4 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.13 2005/05/10 18:33:54 kennykb Exp $ +'\" RCS: @(#) $Id: DString.3,v 1.14 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_DString 3 7.4 Tcl "Tcl Library Procedures" @@ -93,8 +93,10 @@ before appending. \fBTcl_DStringAppendElement\fR adds a separator space before the new list element unless the new list element is the first in a list or sub-list (i.e. either the current string is empty, or it -contains the single character ``{'', or the last two characters of -the current string are `` {''). +contains the single character +.QW { , +or the last two characters of the current string are +.QW " {" ). \fBTcl_DStringAppendElement\fR returns a pointer to the characters of the new string. .PP diff --git a/doc/Encoding.3 b/doc/Encoding.3 index f18ea47..85f7600 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.25 2006/10/18 18:46:59 dgp Exp $ +'\" RCS: @(#) $Id: Encoding.3,v 1.26 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_GetEncoding 3 "8.1" Tcl "Tcl Library Procedures" @@ -457,8 +457,9 @@ are obsolete interfaces best replaced with calls to \fBTcl_GetEncodingSearchPath\fR and \fBTcl_SetEncodingSearchPath\fR. They are called to access and set the first element of the \fIsearchPath\fR list. Since Tcl searches \fIsearchPath\fR for encoding data files in -list order, these routines establish the ``default'' directory in which -to find encoding data files. +list order, these routines establish the +.QW default +directory in which to find encoding data files. .VE 8.5 .SH "ENCODING FILES" Space would prohibit precompiling into Tcl every possible encoding @@ -471,7 +472,9 @@ external encoding may consist of single-byte, multi-byte, or double-byte characters. .PP Each dynamically-loadable encoding is represented as a text file. The -initial line of the file, beginning with a ``#'' symbol, is a comment +initial line of the file, beginning with a +.QW # +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: @@ -584,8 +587,11 @@ the first character is converted, while \fBfinal\fR is a string to emit or expect after the last character. All other options are names of table-based encodings; the associated value is the escape-sequence that marks that encoding. Tcl syntax is used for the values; in the above -example, for instance, ``\fB{}\fR'' represents the empty string and -``\fB\\x1b\fR'' represents character 27. +example, for instance, +.QW \fB{}\fR +represents the empty string and +.QW \fB\ex1b\fR +represents character 27. .PP When \fBTcl_GetEncoding\fR encounters an encoding \fIname\fR that has not been loaded, it attempts to load an encoding file called \fIname\fB.enc\fR @@ -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.23 2006/10/01 13:33:22 msofer Exp $ +'\" RCS: @(#) $Id: Eval.3,v 1.24 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_Eval 3 8.1 Tcl "Tcl Library Procedures" @@ -101,9 +101,14 @@ its contents as a Tcl script. It returns the same information as If the file couldn't be read then a Tcl error is returned to describe why the file couldn't be read. The eofchar for files is '\\32' (^Z) for all platforms. -If you require a ``^Z'' in code for string comparison, you can use -``\\032'' or ``\\u001a'', which will be safely substituted by the Tcl -interpreter into ``^Z''. +If you require a +.QW ^Z +in code for string comparison, you can use +.QW \e032 +or +.QW \eu001a , +which will be safely substituted by the Tcl interpreter into +.QW ^Z . .PP \fBTcl_EvalObjv\fR executes a single pre-parsed command instead of a script. The \fIobjc\fR and \fIobjv\fR arguments contain the values diff --git a/doc/ExprLong.3 b/doc/ExprLong.3 index 0600330..6de4cc4 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.11 2005/05/10 18:33:55 kennykb Exp $ +'\" RCS: @(#) $Id: ExprLong.3,v 1.12 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_ExprLong 3 7.0 Tcl "Tcl Library Procedures" @@ -91,8 +91,11 @@ If the expression's actual value is an integer or floating-point number, then they store 0 at \fI*booleanPtr\fR if the value was zero and 1 otherwise. If the expression's actual value is a non-numeric string then -it must be one of the values accepted by \fBTcl_GetBoolean\fR -such as ``yes'' or ``no'', or else an error occurs. +it must be one of the values accepted by \fBTcl_GetBoolean\fR such as +.QW yes +or +.QW no , +or else an error occurs. .PP \fBTcl_ExprString\fR returns the value of the expression as a string stored in the interpreter's result. diff --git a/doc/ExprLongObj.3 b/doc/ExprLongObj.3 index 82aabe7..bb72d38 100644 --- a/doc/ExprLongObj.3 +++ b/doc/ExprLongObj.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: ExprLongObj.3,v 1.5 2005/05/10 18:33:55 kennykb Exp $ +'\" RCS: @(#) $Id: ExprLongObj.3,v 1.6 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Tcl_ExprLongObj 3 8.0 Tcl "Tcl Library Procedures" @@ -87,8 +87,11 @@ If the expression's actual value is an integer or floating-point number, then they store 0 at \fI*booleanPtr\fR if the value was zero and 1 otherwise. If the expression's actual value is a non-numeric string then -it must be one of the values accepted by \fBTcl_GetBoolean\fR -such as ``yes'' or ``no'', or else an error occurs. +it must be one of the values accepted by \fBTcl_GetBoolean\fR such as +.QW yes +or +.QW no , +or else an error occurs. .PP If \fBTcl_ExprObj\fR successfully evaluates the expression, it stores a pointer to the Tcl object diff --git a/doc/FileSystem.3 b/doc/FileSystem.3 index 97e556a..25fb868 100644 --- a/doc/FileSystem.3 +++ b/doc/FileSystem.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: FileSystem.3,v 1.57 2006/10/18 18:46:59 dgp Exp $ +'\" RCS: @(#) $Id: FileSystem.3,v 1.58 2007/10/24 14:29:37 dkf Exp $ '\" .so man.macros .TH Filesystem 3 8.4 Tcl "Tcl Library Procedures" @@ -352,9 +352,14 @@ reading the file contents. If the file couldn't be read then a Tcl error is returned to describe why the file couldn't be read. The eofchar for files is '\\32' (^Z) for all platforms. -If you require a ``^Z'' in code for string comparison, you can use -``\\032'' or ``\\u001a'', which will be safely substituted by the Tcl -interpreter into ``^Z''. +If you require a +.QW ^Z +in code for string comparison, you can use +.QW \e032 +or +.QW \eu001a , +which will be safely substituted by the Tcl interpreter into +.QW ^Z . \fBTcl_FSEvalFile\fR is a simpler version of \fBTcl_FSEvalFileEx\fR that always uses the system encoding when reading the file. @@ -845,7 +850,10 @@ representations. .PP The \fItypeName\fR field contains a null-terminated string that identifies the type of the filesystem implemented, e.g. -``native'' or ``zip'' or ```vfs''. +.QW native , +.QW zip +or +.QW vfs . .SS "STRUCTURE LENGTH" .PP The \fIstructureLength\fR field is generally implemented as diff --git a/doc/GetInt.3 b/doc/GetInt.3 index 83cd2d6..6329b14 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.10 2005/05/10 18:33:56 kennykb Exp $ +'\" RCS: @(#) $Id: GetInt.3,v 1.11 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_GetInt 3 "" Tcl "Tcl Library Procedures" @@ -55,20 +55,25 @@ or *\fIdoublePtr\fR or *\fIboolPtr\fR. \fBTcl_GetInt\fR expects \fIsrc\fR to consist of a collection of integer digits, optionally signed and optionally preceded by white space. If the first two characters of \fIsrc\fR -after the optional white space and sign are ``0x'' +after the optional white space and sign are +.QW 0x then \fIsrc\fR is expected to be in hexadecimal form; otherwise, -if the first such character is ``0'' then \fIsrc\fR +if the first such character is +.QW 0 +then \fIsrc\fR is expected to be in octal form; otherwise, \fIsrc\fR is expected to be in decimal form. .PP \fBTcl_GetDouble\fR expects \fIsrc\fR to consist of a floating-point number, which is: white space; a sign; a sequence of digits; a -decimal point; a sequence of digits; the letter ``e''; a -signed decimal exponent ; and more white space. +decimal point; a sequence of digits; the letter +.QW e ; +a signed decimal exponent ; and more white space. Any of the fields may be omitted, except that the digits either before or after the decimal point must be present -and if the ``e'' is present then it must be followed by the -exponent number. +and if the +.QW e +is present then it must be followed by the exponent number. .PP \fBTcl_GetBoolean\fR expects \fIsrc\fR to specify a boolean value. If \fIsrc\fR is any of \fB0\fR, \fBfalse\fR, @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Hash.3,v 1.21 2007/10/08 19:55:55 georgeps Exp $ +'\" RCS: @(#) $Id: Hash.3,v 1.22 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_Hash 3 "" Tcl "Tcl Library Procedures" @@ -88,7 +88,9 @@ STRUCTURE\fR below). All of the keys in a given table have the same form, which is specified when the table is initialized. .PP The value of a hash table entry can be anything that fits in the same -space as a ``char *'' pointer. Values for hash table entries are +space as a +.QW "char *" +pointer. Values for hash table entries are managed entirely by clients, not by the hash module itself. Typically each entry's value is a pointer to a data structure managed by client code. @@ -124,7 +126,9 @@ They are passed to hashing routines using the address of the first character of the string. .IP \fBTCL_ONE_WORD_KEYS\fR 25 Keys are single-word values; they are passed to hashing routines -and stored in hash table entries as ``char *'' values. +and stored in hash table entries as +.QW "char *" +values. The pointer value is the key; it need not (and usually doesn't) actually point to a string. .IP \fBTCL_CUSTOM_TYPE_KEYS\fR 25 @@ -140,8 +144,9 @@ structure is described in the section .IP \fIother\fR 25 If \fIkeyType\fR is not one of the above, then it must be an integer value greater than 1. -In this case the keys will be arrays of ``int'' values, where -\fIkeyType\fR gives the number of ints in each key. +In this case the keys will be arrays of +.QW int +values, where \fIkeyType\fR gives the number of ints in each key. This allows structures to be used as keys. All keys must have the same size. Array keys are passed into hashing functions using the address @@ -182,25 +187,28 @@ instead, it returns NULL as result. .PP \fBTcl_GetHashValue\fR and \fBTcl_SetHashValue\fR are used to read and write an entry's value, respectively. -Values are stored and retrieved as type ``ClientData'', which is +Values are stored and retrieved as type +.QW ClientData , +which is large enough to hold a pointer value. On almost all machines this is large enough to hold an integer value too. .PP \fBTcl_GetHashKey\fR returns the key for a given hash table entry, -either as a pointer to a string, a one-word (``char *'') key, or -as a pointer to the first word of an array of integers, depending +either as a pointer to a string, a one-word (e.g. +.QW "char *" ) +key, or as a pointer to the first word of an array of integers, depending on the \fIkeyType\fR used to create a hash table. In all cases \fBTcl_GetHashKey\fR returns a result with type -``char *''. +.QW "char *" . When the key is a string or array, the result of \fBTcl_GetHashKey\fR points to information in the table entry; this information will remain valid until the entry is deleted or its table is deleted. .PP \fBTcl_FirstHashEntry\fR and \fBTcl_NextHashEntry\fR may be used -to scan all of the entries in a hash table. -A structure of type ``Tcl_HashSearch'', provided by the client, -is used to keep track of progress through the table. -\fBTcl_FirstHashEntry\fR initializes the search record and +to scan all of the entries in a hash table. A structure of type +.QW Tcl_HashSearch , +provided by the client, is used to keep track of progress through the +table. \fBTcl_FirstHashEntry\fR initializes the search record and returns the first entry in the table (or NULL if the table is empty). Each subsequent call to \fBTcl_NextHashEntry\fR returns the diff --git a/doc/LinkVar.3 b/doc/LinkVar.3 index 042d242..a107fe6 100644 --- a/doc/LinkVar.3 +++ b/doc/LinkVar.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: LinkVar.3,v 1.12 2005/09/08 10:49:19 dkf Exp $ +'\" RCS: @(#) $Id: LinkVar.3,v 1.13 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_LinkVar 3 7.5 Tcl "Tcl Library Procedures" @@ -166,8 +166,10 @@ rejected with Tcl errors. .TP \fBTCL_LINK_BOOLEAN\fR The C variable is of type \fBint\fR. -If its value is zero then it will read from Tcl as ``0''; -otherwise it will read from Tcl as ``1''. +If its value is zero then it will read from Tcl as +.QW 0 ; +otherwise it will read from Tcl as +.QW 1 . Whenever \fIvarName\fR is modified, the C variable will be set to a 0 or 1 value. Any value written into the Tcl variable must have a proper boolean @@ -183,7 +185,8 @@ Whenever the Tcl variable is modified the current C string will be freed and new memory will be allocated to hold a copy of the variable's new value. If the C variable contains a NULL pointer then the Tcl variable -will read as ``NULL''. +will read as +.QW NULL . .PP If the \fBTCL_LINK_READ_ONLY\fR flag is present in \fItype\fR then the variable will be read-only from Tcl, so that its value can only be diff --git a/doc/Notifier.3 b/doc/Notifier.3 index cf4d474..60e8bb9 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.17 2007/04/22 06:17:45 hobbs Exp $ +'\" RCS: @(#) $Id: Notifier.3,v 1.18 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Notifier 3 8.1 Tcl "Tcl Library Procedures" @@ -454,7 +454,9 @@ procedure when initializing a Tcl interpreter. Similarly, called by \fBTcl_Finalize\fR when shutting down a Tcl interpreter. .PP \fBTcl_WaitForEvent\fR is the lowest-level procedure in the notifier; -it is responsible for waiting for an ``interesting'' event to occur or +it is responsible for waiting for an +.QW interesting +event to occur or for a given time to elapse. Before \fBTcl_WaitForEvent\fR is invoked, each of the event sources' setup procedure will have been invoked. The \fItimePtr\fR argument to diff --git a/doc/PrintDbl.3 b/doc/PrintDbl.3 index 4588126..a4c7dc1 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.7 2005/05/10 18:33:57 kennykb Exp $ +'\" RCS: @(#) $Id: PrintDbl.3,v 1.8 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_PrintDouble 3 8.0 Tcl "Tcl Library Procedures" @@ -36,10 +36,13 @@ least \fBTCL_DOUBLE_SPACE\fR characters of storage. \fBTcl_PrintDouble\fR generates a string that represents the value of \fIvalue\fR and stores it in memory at the location given by \fIdst\fR. It uses \fB%g\fR format to generate the string, with one -special twist: the string is guaranteed to contain either -a ``.'' or an ``e'' so that it doesn't look like an integer. Where -\fB%g\fR would generate an integer with no decimal point, \fBTcl_PrintDouble\fR -adds ``.0''. +special twist: the string is guaranteed to contain either a +.QW . +or an +.QW e +so that it doesn't look like an integer. Where \fB%g\fR would generate +an integer with no decimal point, \fBTcl_PrintDouble\fR adds +.QW .0 . .VS 8.5 .PP If the \fBtcl_precision\fR value is non-zero, the result will have diff --git a/doc/RegExp.3 b/doc/RegExp.3 index 48cbd65..54a5357 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.23 2005/05/10 18:33:57 kennykb Exp $ +'\" RCS: @(#) $Id: RegExp.3,v 1.24 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -186,20 +186,23 @@ zero or more of the following flags that control the compilation of .RS 2 .TP \fBTCL_REG_ADVANCED\fR -Compile advanced regular expressions (`AREs'). This mode corresponds to -the normal regular expression syntax accepted by the Tcl \fBregexp\fR and -\fBregsub\fR commands. +Compile advanced regular expressions +.PQ ARE s . +This mode corresponds to the normal regular expression syntax accepted by the +Tcl \fBregexp\fR and \fBregsub\fR commands. .TP \fBTCL_REG_EXTENDED\fR -Compile extended regular expressions (`EREs'). This mode corresponds -to the regular expression syntax recognized by Tcl 8.0 and earlier -versions. +Compile extended regular expressions +.PQ ERE s . +This mode corresponds to the regular expression syntax recognized by Tcl 8.0 +and earlier versions. .TP \fBTCL_REG_BASIC\fR -Compile basic regular expressions (`BREs'). This mode corresponds -to the regular expression syntax recognized by common Unix utilities -like \fBsed\fR and \fBgrep\fR. This is the default if no flags are -specified. +Compile basic regular expressions +.PQ BRE s . +This mode corresponds to the regular expression syntax recognized by common +Unix utilities like \fBsed\fR and \fBgrep\fR. This is the default if no flags +are specified. .TP \fBTCL_REG_EXPANDED\fR Compile the regular expression (basic, extended, or advanced) using an @@ -216,27 +219,51 @@ Compile for matching that ignores upper/lower case distinctions. \fBTCL_REG_NEWLINE\fR Compile for newline-sensitive matching. By default, newline is a completely ordinary character with no special meaning in either -regular expressions or strings. With this flag, `[^' bracket -expressions and `.' never match newline, `^' matches an empty string -after any newline in addition to its normal function, and `$' matches -an empty string before any newline in addition to its normal function. -\fBREG_NEWLINE\fR is the bit-wise OR of \fBREG_NLSTOP\fR and +regular expressions or strings. With this flag, +.QW [^ +bracket expressions and +.QW . +never match newline, +.QW ^ +matches an empty string +after any newline in addition to its normal function, and +.QW $ +matches an empty string before any newline in addition to its normal +function. \fBREG_NEWLINE\fR is the bit-wise OR of \fBREG_NLSTOP\fR and \fBREG_NLANCH\fR. .TP \fBTCL_REG_NLSTOP\fR -Compile for partial newline-sensitive matching, -with the behavior of -`[^' bracket expressions and `.' affected, -but not the behavior of `^' and `$'. In this mode, `[^' bracket -expressions and `.' never match newline. +Compile for partial newline-sensitive matching, with the behavior of +.QW [^ +bracket expressions and +.QW . +affected, but not the behavior of +.QW ^ +and +.QW $ . +In this mode, +.QW [^ +bracket expressions and +.QW . +never match newline. .TP \fBTCL_REG_NLANCH\fR -Compile for inverse partial newline-sensitive matching, -with the behavior -of `^' and `$' (the ``anchors'') affected, but not the behavior of -`[^' bracket expressions and `.'. In this mode `^' matches an empty string -after any newline in addition to its normal function, and `$' matches -an empty string before any newline in addition to its normal function. +Compile for inverse partial newline-sensitive matching, with the behavior of +.QW ^ +and +.QW $ +(the +.QW anchors ) +affected, but not the behavior of +.QW [^ +bracket expressions and +.QW . . +In this mode +.QW ^ +matches an empty string after any newline in addition to its normal function, +and +.QW $ +matches an empty string before any newline in addition to its normal function. .TP \fBTCL_REG_NOSUB\fR Compile for matching that reports only success or failure, @@ -275,13 +302,19 @@ zero or more of the following flags: .TP \fBTCL_REG_NOTBOL\fR The starting character will not be treated as the beginning of a -line or the beginning of the string, so `^' will not match there. -Note that this flag has no effect on how `\fB\eA\fR' matches. +line or the beginning of the string, so +.QW ^ +will not match there. Note that this flag has no effect on how +.QW \fB\eA\fR +matches. .TP \fBTCL_REG_NOTEOL\fR The last character in the string will not be treated as the end of a -line or the end of the string, so '$' will not match there. -Note that this flag has no effect on how `\fB\eZ\fR' matches. +line or the end of the string, so +.QW $ +will not match there. Note that this flag has no effect on how +.QW \fB\eZ\fR +matches. .RE .PP \fBTcl_RegExpGetInfo\fR retrieves information about the last match diff --git a/doc/SetResult.3 b/doc/SetResult.3 index 99aaff2..fc306da 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.14 2005/09/13 21:23:51 dgp Exp $ +'\" RCS: @(#) $Id: SetResult.3,v 1.15 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_SetResult 3 8.0 Tcl "Tcl Library Procedures" @@ -163,8 +163,11 @@ list element, so that the list elements in the result are properly separated. However if the new list element is the first in a list or sub-list (i.e. \fIinterp\fR's current result is empty, or consists of the -single character ``{'', or ends in the characters `` {'') then no -space is added. +single character +.QW { , +or ends in the characters +.QW " {" ) +then no space is added. .PP \fBTcl_FreeResult\fR performs part of the work of \fBTcl_ResetResult\fR. diff --git a/doc/SetVar.3 b/doc/SetVar.3 index dc43c54..8985cce 100644 --- a/doc/SetVar.3 +++ b/doc/SetVar.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: SetVar.3,v 1.12 2004/10/07 16:05:15 dkf Exp $ +'\" RCS: @(#) $Id: SetVar.3,v 1.13 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_SetVar 3 8.1 Tcl "Tcl Library Procedures" @@ -207,7 +207,10 @@ Tcl list element before setting (or appending to) the variable. A separator space is appended before the new list element unless the list element is going to be the first element in a list or sublist (i.e. the variable's current value is empty, or contains -the single character ``{'', or ends in `` }''). +the single character +.QW { , +or ends in +.QW " }" ). When appending, the original value of the variable must also be a valid list, so that the operation is the appending of a new list element onto a list. diff --git a/doc/SplitList.3 b/doc/SplitList.3 index 5726f86..a8de7cc 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.9 2004/10/07 15:15:48 dkf Exp $ +'\" RCS: @(#) $Id: SplitList.3,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_SplitList 3 8.0 Tcl "Tcl Library Procedures" @@ -169,7 +169,9 @@ the command not to be parsed correctly. .VS 8.5 By default, \fBTcl_ConvertElement\fR will use quoting in its output to be sure the first character of an element is not the hash -character (``#''). This is to be sure the first element of any list +character (i.e. +.QW # ). +This is to be sure the first element of any list passed to \fBeval\fR is not mis-parsed as the beginning of a comment. When a list element is not the first element of a list, this quoting is not necessary. When the caller can be sure that the element is diff --git a/doc/StdChannels.3 b/doc/StdChannels.3 index 63d0e8b..482196b 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.10 2007/07/04 13:51:29 dkf Exp $ +'\" RCS: @(#) $Id: StdChannels.3,v 1.11 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH "Standard Channels" 3 7.5 Tcl "Tcl Library Procedures" @@ -42,9 +42,10 @@ channel information, or when implicitly required during registration of a new channel. .PP These cases differ in how they handle unavailable platform- specific -standard channels. (A channel is not ``available'' if it could not be -successfully opened; for example, in a Tcl application run as a -Windows NT service.) +standard channels. (A channel is not +.QW available +if it could not be successfully opened; for example, in a Tcl +application run as a Windows NT service.) .TP 1) A single standard channel is initialized when it is explicitly diff --git a/doc/StrMatch.3 b/doc/StrMatch.3 index e09a2d6..27f581e 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.9 2005/05/10 18:33:57 kennykb Exp $ +'\" RCS: @(#) $Id: StrMatch.3,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_StringMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -38,7 +38,8 @@ case-insensitive (1). This utility procedure determines whether a string matches a given pattern. If it does, then \fBTcl_StringMatch\fR returns 1. Otherwise \fBTcl_StringMatch\fR returns 0. The algorithm -used for matching is the same algorithm used in the ``string match'' +used for matching is the same algorithm used in the +.QW "string match" Tcl command and is similar to the algorithm used by the C-shell for file name matching; see the Tcl manual entry for details. .PP diff --git a/doc/SubstObj.3 b/doc/SubstObj.3 index 5f39c15..9b6a6eb 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.3 2004/10/07 14:44:34 dkf Exp $ +'\" RCS: @(#) $Id: SubstObj.3,v 1.4 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_SubstObj 3 8.4 Tcl "Tcl Library Procedures" @@ -55,10 +55,12 @@ replaced by the contents of the named variable. .PP When the \fBTCL_SUBST_COMMANDS\fR bit is set in \fIflags\fR, sequences that look like command substitutions for Tcl commands are replaced by -the result of evaluating that script. Where an uncaught `continue -exception' occurs during the evaluation of a command substitution, an -empty string is substituted for the command. Where an uncaught `break -exception' occurs during the evaluation of a command substitution, the +the result of evaluating that script. Where an uncaught +.QW "continue exception" +occurs during the evaluation of a command substitution, an +empty string is substituted for the command. Where an uncaught +.QW "break exception" +occurs during the evaluation of a command substitution, the result of the whole substitution on \fIobjPtr\fR will be truncated at the point immediately before the start of the command substitution, and no characters will be added to the result or substitutions diff --git a/doc/TCL_MEM_DEBUG.3 b/doc/TCL_MEM_DEBUG.3 index 6052238..eddd082 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.7 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: TCL_MEM_DEBUG.3,v 1.8 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH TCL_MEM_DEBUG 3 8.1 Tcl "Tcl Library Procedures" @@ -41,8 +41,9 @@ memory usage. .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 -code can keep track of the allocated memory, and eight-byte ``guard -zones'' are placed in front of and behind the space that will be +code can keep track of the allocated memory, and eight-byte +.QW "guard zones" +are placed in front of and behind the space that will be returned to the caller. (The sizes of the guard zones are defined by the C #define \fBLOW_GUARD_SIZE\fR and #define \fBHIGH_GUARD_SIZE\fR in the file \fIgeneric/tclCkalloc.c\fR -- it can @@ -51,8 +52,12 @@ performance.) A known pattern is written into the guard zones and, on a call to \fBckfree\fR, the guard zones of the space being freed are checked to see if either zone has been modified in any way. If one has been, the guard bytes and their new contents are identified, and a -``low guard failed'' or ``high guard failed'' message is issued. The -``guard failed'' message includes the address of the memory packet and +.QW "low guard failed" +or +.QW "high guard failed" +message is issued. The +.QW "guard failed" +message includes the address of the memory packet and the file name and line number of the code that called \fBckfree\fR. This allows you to detect the common sorts of one-off problems, where not enough space was allocated to contain the data written, for @@ -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: Tcl.n,v 1.14 2006/11/03 00:34:51 hobbs Exp $ +'\" RCS: @(#) $Id: Tcl.n,v 1.15 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl n "8.5" Tcl "Tcl Built-In Commands" @@ -41,8 +41,9 @@ Different commands interpret their words differently. Words of a command are separated by white space (except for newlines, which are command separators). .IP "[4] \fBDouble quotes.\fR" -If the first character of a word is double-quote (``"'') then -the word is terminated by the next double-quote character. +If the first character of a word is double-quote +.PQ \N'34' +then the word is terminated by the next double-quote character. If semi-colons, close brackets, or white space characters (including newlines) appear between the quotes then they are treated as ordinary characters and included in the word. @@ -51,18 +52,24 @@ are performed on the characters between the quotes as described below. The double-quotes are not retained as part of the word. .VS 8.5 br .IP "[5] \fBArgument expansion.\fR" -If a word starts with the string ``{*}'' followed by a -non-whitespace character, then the leading ``{*}'' is removed -and the rest of the word is parsed and substituted as any other -word. After substitution, the word is parsed again without +If a word starts with the string +.QW {*} +followed by a non-whitespace character, then the leading +.QW {*} +is removed and the rest of the word is parsed and substituted as any +other word. After substitution, the word is parsed again without substitutions, and its words are added to the command being -substituted. For instance, ``cmd a {*}{b c} d {*}{e f}'' is -equivalent to ``cmd a b c d e f''. +substituted. For instance, +.QW "cmd a {*}{b c} d {*}{e f}" +is equivalent to +.QW "cmd a b c d e f" . .VE 8.5 .IP "[6] \fBBraces.\fR" -If the first character of a word is an open brace (``{'') and -rule [5] does not apply, then -the word is terminated by the matching close brace (``}''). +If the first character of a word is an open brace +.PQ { +and rule [5] does not apply, then +the word is terminated by the matching close brace +.PQ } "" . Braces nest within the word: for each additional open brace there must be an additional close brace (however, if an open brace or close brace within the word is @@ -75,20 +82,23 @@ or white space receive any special interpretation. The word will consist of exactly the characters between the outer braces, not including the braces themselves. .IP "[7] \fBCommand substitution.\fR" -If a word contains an open bracket (``['') then Tcl performs -\fIcommand substitution\fR. +If a word contains an open bracket +.PQ [ +then Tcl performs \fIcommand substitution\fR. To do this it invokes the Tcl interpreter recursively to process the characters following the open bracket as a Tcl script. The script may contain any number of commands and must be terminated -by a close bracket (``]''). +by a close bracket +.PQ ] "" . The result of the script (i.e. the result of its last command) is substituted into the word in place of the brackets and all of the characters between them. There may be any number of command substitutions in a single word. Command substitution is not performed on words enclosed in braces. .IP "[8] \fBVariable substitution.\fR" -If a word contains a dollar-sign (``$'') followed by one of the forms -described below, then Tcl performs \fIvariable +If a word contains a dollar-sign +.PQ $ +followed by one of the forms described below, then Tcl performs \fIvariable substitution\fR: the dollar-sign and the following characters are replaced in the word by the value of a variable. Variable substitution may take any of the following forms: @@ -115,8 +125,9 @@ There may be any number of variable substitutions in a single word. Variable substitution is not performed on words enclosed in braces. .RE .IP "[9] \fBBackslash substitution.\fR" -If a backslash (``\e'') appears within a word then -\fIbackslash substitution\fR occurs. +If a backslash +.PQ \e +appears within a word then \fIbackslash substitution\fR occurs. In all cases but those described below the backslash is dropped and the following character is treated as an ordinary character and included in the word. @@ -158,7 +169,8 @@ and the resulting space will be treated as a word separator if it isn't in braces or quotes. .TP 7 \e\e -Backslash (``\e''). +Backslash +.PQ \e "" . .TP 7 \e\fIooo\fR . @@ -184,7 +196,9 @@ Backslash substitution is not performed on words enclosed in braces, except for backslash-newline as described above. .RE .IP "[10] \fBComments.\fR" -If a hash character (``#'') appears at a point where Tcl is +If a hash character +.PQ # +appears at a point where Tcl is expecting the first character of the first word of a command, then the hash character and the characters that follow it, up through the next newline, are treated as a comment and ignored. diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3 index 6c02a9e..35251a2 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.11 2004/10/07 14:44:34 dkf Exp $ +'\" RCS: @(#) $Id: Tcl_Main.3,v 1.12 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_Main 3 8.4 Tcl "Tcl Library Procedures" @@ -36,8 +36,9 @@ Address of an application-specific event loop procedure. .SH DESCRIPTION .PP \fBTcl_Main\fR can serve as the main program for Tcl-based shell -applications. A ``shell application'' is a program -like tclsh or wish that supports both interactive interpretation +applications. A +.QW "shell application" +is a program like tclsh or wish that supports both interactive interpretation of Tcl and evaluation of a script contained in a file given as a command line argument. \fBTcl_Main\fR is offered as a convenience to developers of shell applications, so they do not have to @@ -91,8 +92,9 @@ the Tcl variables \fIargc\fR, \fIargv\fR, \fIargv0\fR, and .PP When it has finished its own initialization, but before it processes commands, \fBTcl_Main\fR calls the procedure given by the -\fIappInitProc\fR argument. This procedure provides a ``hook'' for -the application to perform its own initialization of the interpreter +\fIappInitProc\fR argument. This procedure provides a +.QW hook +for the application to perform its own initialization of the interpreter created by \fBTcl_Main\fR, such as defining application-specific commands. The procedure must have an interface that matches the type \fBTcl_AppInitProc\fR: diff --git a/doc/TraceVar.3 b/doc/TraceVar.3 index a659f03..2567c3a 100644 --- a/doc/TraceVar.3 +++ b/doc/TraceVar.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: TraceVar.3,v 1.15 2005/05/10 18:33:57 kennykb Exp $ +'\" RCS: @(#) $Id: TraceVar.3,v 1.16 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_TraceVar 3 7.4 Tcl "Tcl Library Procedures" @@ -353,8 +353,9 @@ It is legal to set a trace on an undefined variable. The variable will still appear to be undefined until the first time its value is set. If an undefined variable is traced and then unset, the unset will fail -with an error (``no such variable''), but the trace -procedure will still be invoked. +with an error, +.QW "no such variable" , +but the trace procedure will still be invoked. .SH "TCL_TRACE_DESTROYED FLAG" .PP diff --git a/doc/Translate.3 b/doc/Translate.3 index f496e6f..12cccde 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.9 2004/10/07 15:15:48 dkf Exp $ +'\" RCS: @(#) $Id: Translate.3,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_TranslateFileName 3 8.1 Tcl "Tcl Library Procedures" @@ -23,7 +23,8 @@ char * .AP Tcl_Interp *interp in Interpreter in which to report an error, if any. .AP "const char" *name in -File name, which may start with a ``~''. +File name, which may start with a +.QW ~ . .AP Tcl_DString *bufferPtr in/out If needed, this dynamic string is used to store the new file name. At the time of the call it should be uninitialized or free. The diff --git a/doc/WrongNumArgs.3 b/doc/WrongNumArgs.3 index 2a9adc2..afee7b3 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.8 2004/10/07 15:15:48 dkf Exp $ +'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.9 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH Tcl_WrongNumArgs 3 8.0 Tcl "Tcl Library Procedures" @@ -41,7 +41,8 @@ standard error message and stores it in the result object of \fIinterp\fR. The message includes the \fIobjc\fR initial elements of \fIobjv\fR plus \fImessage\fR. For example, if \fIobjv\fR consists of the values \fBfoo\fR and \fBbar\fR, -\fIobjc\fR is 1, and \fImessage\fR is ``\fBfileName count\fR'' +\fIobjc\fR is 1, and \fImessage\fR is +.QW "\fBfileName count\fR" then \fIinterp\fR's result object will be set to the following string: .CS diff --git a/doc/after.n b/doc/after.n index bd778dc..740a09f 100644 --- a/doc/after.n +++ b/doc/after.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: after.n,v 1.7 2004/11/20 00:17:31 dgp Exp $ +'\" RCS: @(#) $Id: after.n,v 1.8 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH after n 7.5 Tcl "Tcl Built-In Commands" @@ -136,9 +136,7 @@ proc doOneStep {} { } doOneStep .CE - .SH "SEE ALSO" concat(n), interp(n), update(n), vwait(n) - .SH KEYWORDS cancel, delay, idle callback, sleep, time diff --git a/doc/append.n b/doc/append.n index cf03418..83f0735 100644 --- a/doc/append.n +++ b/doc/append.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: append.n,v 1.6 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: append.n,v 1.7 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH append n "" Tcl "Tcl Built-In Commands" @@ -27,8 +27,11 @@ The result of this command is the new value stored in variable \fIvarName\fR. This command provides an efficient way to build up long variables incrementally. -For example, ``\fBappend a $b\fR'' is much more efficient than -``\fBset a $a$b\fR'' if \fB$a\fR is long. +For example, +.QW "\fBappend a $b\fR" +is much more efficient than +.QW "\fBset a $a$b\fR" , +especially when \fB$a\fR is long. .SH EXAMPLE Building a string of comma-separated numbers piecemeal using a loop. .CS @@ -39,9 +42,7 @@ for {set i 1} {$i<=10} {incr i} { puts $var # Prints 0,1,2,3,4,5,6,7,8,9,10 .CE - .SH "SEE ALSO" concat(n), lappend(n) - .SH KEYWORDS append, variable diff --git a/doc/array.n b/doc/array.n index 1a39b7b..7857615 100644 --- a/doc/array.n +++ b/doc/array.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: array.n,v 1.15 2005/05/10 18:33:59 kennykb Exp $ +'\" RCS: @(#) $Id: array.n,v 1.16 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH array n 8.3 Tcl "Tcl Built-In Commands" @@ -184,9 +184,7 @@ foreach color [lsort [\fBarray names\fR colorcount]] { number of buckets with 10 or more entries: 0 average search distance for entry: 1.2 .CE - .SH "SEE ALSO" list(n), string(n), variable(n), trace(n), foreach(n) - .SH KEYWORDS array, element names, search diff --git a/doc/bgerror.n b/doc/bgerror.n index 88922c0..e64106a 100644 --- a/doc/bgerror.n +++ b/doc/bgerror.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: bgerror.n,v 1.9 2004/11/20 00:17:31 dgp Exp $ +'\" RCS: @(#) $Id: bgerror.n,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH bgerror n 7.5 Tcl "Tcl Built-In Commands" @@ -86,9 +86,7 @@ proc bgerror {message} { close $fl } .CE - .SH "SEE ALSO" after(n), interp(n), tclvars(n) - .SH KEYWORDS background error, reporting diff --git a/doc/binary.n b/doc/binary.n index 4cac04d..f6598a4 100644 --- a/doc/binary.n +++ b/doc/binary.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: binary.n,v 1.29 2006/10/06 13:37:20 patthoyts Exp $ +'\" RCS: @(#) $Id: binary.n,v 1.30 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH binary n 8.0 Tcl "Tcl Built-In Commands" @@ -129,8 +129,9 @@ will return a string equivalent to \fB\\xe0\\xe1\\xa0\fR. .IP \fBh\fR 5 Stores a string of \fIcount\fR hexadecimal digits in low-to-high within each byte in the output string. \fIArg\fR must contain a -sequence of characters in the set ``0123456789abcdefABCDEF''. The -resulting bytes are emitted in first to last order with the hex digits +sequence of characters in the set +.QW 0123456789abcdefABCDEF . +The resulting bytes are emitted in first to last order with the hex digits being formatted in low-to-high order within each byte. If \fIarg\fR has fewer than \fIcount\fR digits, then zeros will be used for the remaining digits. If \fIarg\fR has more than the specified number of @@ -472,7 +473,10 @@ will return \fB1\fR with \fBabc efghi\fR stored in \fIvar1\fR. .RE .IP \fBb\fR 5 The data is turned into a string of \fIcount\fR binary digits in -low-to-high order represented as a sequence of ``1'' and ``0'' +low-to-high order represented as a sequence of +.QW 1 +and +.QW 0 characters. The data bytes are scanned in first to last order with the bits being taken in low-to-high order within each byte. Any extra bits in the last byte are ignored. If \fIcount\fR is \fB*\fR, then @@ -498,7 +502,8 @@ will return \fB2\fR with \fB01110\fR stored in \fIvar1\fR and .IP \fBH\fR 5 The data is turned into a string of \fIcount\fR hexadecimal digits in high-to-low order represented as a sequence of characters in the set -``0123456789abcdef''. The data bytes are scanned in first to last +.QW 0123456789abcdef . +The data bytes are scanned in first to last order with the hex digits being taken in high-to-low order within each byte. Any extra bits in the last byte are ignored. If \fIcount\fR is \fB*\fR, then all of the remaining hex digits in \fIstring\fR will be @@ -783,9 +788,7 @@ proc \fIreadString\fR {channel} { return [encoding convertfrom utf-8 $data] } .CE - .SH "SEE ALSO" format(n), scan(n), tclvars(n) - .SH KEYWORDS binary, format, scan diff --git a/doc/break.n b/doc/break.n index 53cae77..83e68ac 100644 --- a/doc/break.n +++ b/doc/break.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: break.n,v 1.7 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: break.n,v 1.8 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH break n "" Tcl "Tcl Built-In Commands" @@ -39,9 +39,7 @@ for {set x 0} {$x<10} {incr x} { puts "x is $x" } .CE - .SH "SEE ALSO" catch(n), continue(n), for(n), foreach(n), return(n), while(n) - .SH KEYWORDS abort, break, loop diff --git a/doc/catch.n b/doc/catch.n index 4b346cb..de7207f 100644 --- a/doc/catch.n +++ b/doc/catch.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: catch.n,v 1.13 2004/11/09 10:02:16 dkf Exp $ +'\" RCS: @(#) $Id: catch.n,v 1.14 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH catch n "8.5" Tcl "Tcl Built-In Commands" @@ -90,9 +90,7 @@ if { [\fBcatch\fR {open $someFile w} fid] } { .PP There are more complex examples of \fBcatch\fR usage in the documentation for the \fBreturn\fR command. - .SH "SEE ALSO" break(n), continue(n), dict(n), error(n), return(n), tclvars(n) - .SH KEYWORDS catch, error @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: cd.n,v 1.6 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: cd.n,v 1.7 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH cd n "" Tcl "Tcl Built-In Commands" @@ -37,9 +37,7 @@ current one: .CS \fBcd\fR ../lib .CE - .SH "SEE ALSO" filename(n), glob(n), pwd(n) - .SH KEYWORDS working directory @@ -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: chan.n,v 1.10 2007/07/03 09:36:26 dkf Exp $ +'\" RCS: @(#) $Id: chan.n,v 1.11 2007/10/24 14:29:38 dkf Exp $ .so man.macros .TH chan n 8.5 Tcl "Tcl Built-In Commands" .BS @@ -411,7 +411,9 @@ while waiting for the data to arrive. If an application invokes \fBchan gets\fR or \fBchan read\fR on a blocking channel when there is no input data available, the process will block; until the input data arrives, it will not be able to service other events, so it will -appear to the user to ``freeze up''. With \fBchan event\fR, the +appear to the user to +.QW "freeze up" . +With \fBchan event\fR, the process can tell when data is present and only invoke \fBchan gets\fR or \fBchan read\fR when they won't block. .PP diff --git a/doc/close.n b/doc/close.n index 23aae91..f701640 100644 --- a/doc/close.n +++ b/doc/close.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: close.n,v 1.10 2005/05/10 18:33:59 kennykb Exp $ +'\" RCS: @(#) $Id: close.n,v 1.11 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH close n 7.5 Tcl "Tcl Built-In Commands" @@ -71,9 +71,7 @@ proc withOpenFile {filename channelVar script} { return -options $options $result } .CE - .SH "SEE ALSO" file(n), open(n), socket(n), eof(n), Tcl_StandardChannels(3) - .SH KEYWORDS blocking, channel, close, nonblocking diff --git a/doc/concat.n b/doc/concat.n index 882ebbc..db7081f 100644 --- a/doc/concat.n +++ b/doc/concat.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: concat.n,v 1.6 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: concat.n,v 1.7 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH concat n 8.3 Tcl "Tcl Built-In Commands" @@ -44,9 +44,7 @@ its arguments, so the command: .CE will return "\fBa b c d e f\fR" (i.e. with three spaces between the \fBa\fR, the \fBb\fR and the \fBc\fR). - .SH "SEE ALSO" append(n), eval(n) - .SH KEYWORDS concatenate, join, lists diff --git a/doc/continue.n b/doc/continue.n index d2240b5..93e7d1c 100644 --- a/doc/continue.n +++ b/doc/continue.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: continue.n,v 1.7 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: continue.n,v 1.8 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH continue n "" Tcl "Tcl Built-In Commands" @@ -39,9 +39,7 @@ for {set x 0} {$x<10} {incr x} { puts "x is $x" } .CE - .SH "SEE ALSO" break(n), for(n), foreach(n), return(n), while(n) - .SH KEYWORDS continue, iteration, loop @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: dde.n,v 1.17 2004/11/25 11:28:22 dkf Exp $ +'\" RCS: @(#) $Id: dde.n,v 1.18 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH dde n 1.3 dde "Tcl Bundled Packages" @@ -48,6 +48,7 @@ The following commands are a subset of the full Dynamic Data Exchange set of commands. .TP \fBdde servername \fR?\fB-force\fR? ?\fB-handler \fIproc\fR? ?\fB--\fR? ?\fItopic\fR? +. \fBdde servername\fR registers the interpreter as a DDE server with the service name \fBTclEval\fR and the topic name specified by \fItopic\fR. If no \fItopic\fR is given, \fBdde servername\fR returns the name @@ -65,6 +66,7 @@ procedure is called with all the arguments provided by the remote call. .TP \fBdde execute\fR ?\fB\-async\fR? \fIservice topic data\fR +. \fBdde execute\fR takes the \fIdata\fR and sends it to the server indicated by \fIservice\fR with the topic indicated by \fItopic\fR. Typically, \fIservice\fR is the name of an application, and \fItopic\fR is a file to @@ -76,6 +78,7 @@ script did not run, unless the \fB\-async\fR flag was used, in which case the command returns immediately with no error. .TP \fBdde poke \fIservice topic item data\fR +. \fBdde poke\fR passes the \fIdata\fR to the server indicated by \fIservice\fR using the \fItopic\fR and \fIitem\fR specified. Typically, \fIservice\fR is the name of an application. \fItopic\fR is application @@ -85,6 +88,7 @@ it must always be non-null. The \fIdata\fR field is given to the remote application. .TP \fBdde request\fR ?\fB\-binary\fR? \fIservice topic item\fR +. \fBdde request\fR is typically used to get the value of something; the value of a cell in Microsoft Excel or the text of a selection in Microsoft Word. \fIservice\fR is typically the name of an application, @@ -95,6 +99,7 @@ string with terminating null. If \fB\-binary\fR is specified, the result is returned as a byte array. .TP \fBdde services \fIservice topic\fR +. \fBdde services\fR returns a list of service-topic pairs that currently exist on the machine. If \fIservice\fR and \fItopic\fR are both empty strings ({}), then all service-topic pairs currently @@ -106,6 +111,7 @@ service-topic pair currently exists, it is returned; otherwise, an empty string is returned. .TP \fBdde eval\fR ?\fB\-async\fR? \fItopic cmd \fR?\fIarg arg ...\fR? +. \fBdde eval\fR evaluates a command and its arguments using the interpreter specified by \fItopic\fR. The DDE service must be the \fBTclEval\fR service. The \fB\-async\fR option requests asynchronous invocation. The @@ -151,9 +157,7 @@ particularly important website: package require dde \fBdde execute\fR iexplore WWW_OpenURL http://www.tcl.tk/ .CE - .SH "SEE ALSO" tk(n), winfo(n), send(n) - .SH KEYWORDS application, dde, name, remote execution @@ -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: dict.n,v 1.12 2006/01/26 23:21:06 dkf Exp $ +'\" RCS: @(#) $Id: dict.n,v 1.13 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH dict n 8.5 Tcl "Tcl Built-In Commands" @@ -257,7 +257,7 @@ foreach id [\fBdict keys\fR $employeeInfo] { puts "Hello, [\fBdict get\fR $employeeInfo $id forenames]!" } .CE - +.PP A localizable version of \fBstring toupper\fR: .CS # Set up the basic C locale @@ -277,9 +277,7 @@ foreach c [split {abcdefghijklmnopqrstuvwxyz} ""] { set upperCaseMap [\fBdict get\fR $capital $env(LANG)] set upperCase [string map $upperCaseMap $string] .CE - .SH "SEE ALSO" append(n), array(n), foreach(n), incr(n), list(n), lappend(n), set(n) - .SH KEYWORDS dictionary, create, update, lookup, iterate, filter diff --git a/doc/encoding.n b/doc/encoding.n index a5563b6..8dfa254 100644 --- a/doc/encoding.n +++ b/doc/encoding.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: encoding.n,v 1.8 2006/02/08 22:27:16 dkf Exp $ +'\" RCS: @(#) $Id: encoding.n,v 1.9 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH encoding n "8.1" Tcl "Tcl Built-In Commands" @@ -86,9 +86,7 @@ set s [\fBencoding convertfrom\fR euc-jp "\\xA4\\xCF"] .CE would return the Unicode string "\\u306F", which is the Hiragana letter HA. - .SH "SEE ALSO" -Tcl_GetEncoding(3) - +fconfigure(n), Tcl_GetEncoding(3) .SH KEYWORDS encoding @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: eof.n,v 1.6 2004/10/27 09:36:58 dkf Exp $ +'\" RCS: @(#) $Id: eof.n,v 1.7 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH eof n 7.5 Tcl "Tcl Built-In Commands" @@ -55,9 +55,7 @@ while {1} { puts "Read record: $record" } .CE - .SH "SEE ALSO" file(n), open(n), close(n), fblocked(n), Tcl_StandardChannels(3) - .SH KEYWORDS channel, end of file @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: exec.n,v 1.16 2007/07/04 13:51:29 dkf Exp $ +'\" RCS: @(#) $Id: exec.n,v 1.17 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH exec n 8.5 Tcl "Tcl Built-In Commands" @@ -49,9 +49,12 @@ If an \fIarg\fR (or pair of \fIarg\fRs) has one of the forms described below then it is used by \fBexec\fR to control the flow of input and output among the subprocess(es). Such arguments will not be passed to the subprocess(es). In forms -such as ``< \fIfileName\fR'' \fIfileName\fR may either be in a -separate argument from ``<'' or in the same argument with no -intervening space (i.e. ``<\fIfileName\fR''). +such as +.QW "< \fIfileName\fR" , +\fIfileName\fR may either be in a separate argument from +.QW < +or in the same argument with no intervening space (i.e. +.QW <\fIfileName\fR ). .TP 15 | Separates distinct commands in the pipeline. The standard output @@ -134,8 +137,9 @@ If standard output has not been redirected then the \fBexec\fR command returns the standard output from the last command in the pipeline, .VS 8.5 -unless ``2>@1'' was specified, in which case -standard error is included as well. +unless +.QW 2>@1 +was specified, in which case standard error is included as well. .VE 8.5 If any of the commands in the pipeline exit abnormally or are killed or suspended, then \fBexec\fR will return an error @@ -161,12 +165,17 @@ normally end with newlines. However, if \fB\-keepnewline\fR is specified then the trailing newline is retained. .PP -If standard input isn't redirected with ``<'' or ``<<'' -or ``<@'' then the standard input for the first command in the +If standard input isn't redirected with +.QW < , +.QW << +or +.QW <@ +then the standard input for the first command in the pipeline is taken from the application's current standard input. .PP -If the last \fIarg\fR is ``&'' then the pipeline will be -executed in background. +If the last \fIarg\fR is +.QW & +then the pipeline will be executed in background. In this case the \fBexec\fR command will return a list whose elements are the process identifiers for all of the subprocesses in the pipeline. @@ -182,14 +191,16 @@ no slashes then the directories in the PATH environment variable are searched for an executable by the given name. If the name contains a slash then it must refer to an executable -reachable from the current directory. -No ``glob'' expansion or other shell-like substitutions +reachable from the current directory. No +.QW glob +expansion or other shell-like substitutions are performed on the arguments to commands. .SH "PORTABILITY ISSUES" .TP \fBWindows\fR (all versions) . -Reading from or writing to a socket, using the ``\fB@\0\fIfileId\fR'' +Reading from or writing to a socket, using the +.QW \fB@\0\fIfileId\fR notation, does not work. When reading from a socket, a 16-bit DOS application will hang and a 32-bit application will return immediately with end-of-file. When either type of application writes to a socket, the @@ -214,8 +225,11 @@ path separator, it may or may not be recognized as a path name, depending on the program. .PP Additionally, when calling a 16-bit DOS or Windows 3.X application, all path -names must use the short, cryptic, path format (e.g., using ``applba~1.def'' -instead of ``applbakery.default''), which can be obtained with the +names must use the short, cryptic, path format (e.g., using +.QW applba~1.def +instead of +.QW applbakery.default ), +which can be obtained with the \fBfile attributes $fileName -shortname\fR command. .PP Two or more forward or backward slashes in a row in a path refer to a @@ -274,7 +288,8 @@ The Windows NT home directory. The directories listed in the path. .PP In order to execute shell built-in commands like \fBdir\fR and \fBcopy\fR, -the caller must prepend the desired command with ``\fBcmd.exe /c\0\fR'' +the caller must prepend the desired command with +.QW "\fBcmd.exe /c\0\fR" because built-in commands are not implemented using executables. .RE .TP @@ -299,7 +314,8 @@ The Windows 9x home directory. The directories listed in the path. .PP In order to execute shell built-in commands like \fBdir\fR and \fBcopy\fR, -the caller must prepend the desired command with ``\fBcommand.com /c\0\fR'' +the caller must prepend the desired command with +.QW "\fBcommand.com /c\0\fR" because built-in commands are not implemented using executables. .PP Once a 16-bit DOS application has read standard input from a console and @@ -311,7 +327,9 @@ at this time. .PP Redirection between the \fBNUL:\fR device and a 16-bit application does not always work. When redirecting from \fBNUL:\fR, some applications may hang, -others will get an infinite stream of ``0x01'' bytes, and some will actually +others will get an infinite stream of +.QW 0x01 +bytes, and some will actually correctly get an immediate end-of-file; the behavior seems to depend upon something compiled into the application itself. When redirecting greater than 4K or so to \fBNUL:\fR, some applications will hang. The above problems do not @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: expr.n,v 1.24 2007/02/18 18:42:54 dkf Exp $ +'\" RCS: @(#) $Id: expr.n,v 1.25 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH expr n 8.5 Tcl "Tcl Built-In Commands" @@ -203,9 +203,9 @@ precedence level. For example, the command .CE returns 0. .PP -The \fB&&\fR, \fB||\fR, and \fB?:\fR operators have ``lazy -evaluation'', just as in C, -which means that operands are not evaluated if they are +The \fB&&\fR, \fB||\fR, and \fB?:\fR operators have +.QW "lazy evaluation" , +just as in C, which means that operands are not evaluated if they are not needed to determine the outcome. For example, in the command .CS \fBexpr {$v ? [a] : [b]}\fR @@ -273,8 +273,8 @@ returns 1, while \fBexpr\fR {5 / 4.0} \fBexpr\fR {5 / ( [string length "abcd"] + 0.0 )} .CE -both return 1.25. -Floating-point values are always returned with a ``\fB.\fR'' +both return 1.25. Floating-point values are always returned with a +.QW \fB.\fR or an \fBe\fR so that they will not look like integer values. For example, .CS @@ -338,8 +338,9 @@ unbraced expressions that contain command substitutions. These expressions must be implemented by generating new code each time the expression is executed. .SH EXAMPLES -Define a procedure that computes an "interesting" mathematical -function: +Define a procedure that computes an +.QW "interesting" +mathematical function: .CS proc tcl::mathfunc::calc {x y} { \fBexpr\fR { ($x**2 - $y**2) / exp($x**2 + $y**2) } @@ -379,16 +380,14 @@ Generate a random integer in the range 0..99 inclusive: .CS set randNum [\fBexpr\fR { int(100 * rand()) }] .CE - .SH "SEE ALSO" -array(n), for(n), if(n), mathfunc(n), namespace(n), proc(n), string(n), Tcl(n), while(n) - +array(n), for(n), if(n), mathfunc(n), namespace(n), proc(n), string(n), +Tcl(n), while(n) .SH KEYWORDS arithmetic, boolean, compare, expression, fuzzy comparison - .SH COPYRIGHT -Copyright (c) 1993 The Regents of the University of California. -.br -Copyright (c) 1994-2000 Sun Microsystems Incorporated. -.br -Copyright (c) 2005 by Kevin B. Kenny <kennykb@acm.org>. All rights reserved. +.nf +Copyright \(co 1993 The Regents of the University of California. +Copyright \(co 1994-2000 Sun Microsystems Incorporated. +Copyright \(co 2005 by Kevin B. Kenny. All rights reserved. +.fi diff --git a/doc/fcopy.n b/doc/fcopy.n index 81ea603..69e6016 100644 --- a/doc/fcopy.n +++ b/doc/fcopy.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fcopy.n,v 1.11 2007/10/17 17:31:58 dkf Exp $ +'\" RCS: @(#) $Id: fcopy.n,v 1.12 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH fcopy n 8.0 Tcl "Tcl Built-In Commands" @@ -87,7 +87,6 @@ is set to encoding "binary" the system will assume that the incoming bytes are valid UTF-8 characters and convert them according to the output encoding. The behaviour of the system for bytes which are not valid UTF-8 characters is undefined in this case. - .SH EXAMPLES .PP The first example transfers the contents of one channel exactly to @@ -144,9 +143,7 @@ set total 0 -command [list CopyMore $in $out $chunk] vwait done .CE - .SH "SEE ALSO" eof(n), fblocked(n), fconfigure(n), file(n) - .SH KEYWORDS blocking, channel, end of line, end of file, nonblocking, read, translation @@ -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.44 2007/07/04 13:25:53 dkf Exp $ +'\" RCS: @(#) $Id: file.n,v 1.45 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH file n 8.3 Tcl "Tcl Built-In Commands" @@ -122,7 +122,9 @@ Trying to delete a non-existent file is not considered an error. Trying to delete a read-only file will cause the file to be deleted, even if the \fB\-force\fR flags is not specified. If the \fB\-force\fR option is specified on a directory, Tcl will attempt both to change -permissions and move the current directory 'pwd' out of the given path +permissions and move the current directory +.QW pwd +out of the given path if that is necessary to allow the deletion to proceed. Arguments are processed in the order specified, halting at the first error, if any. A \fB\-\|\-\fR marks the end of switches; the argument following the @@ -132,9 +134,10 @@ a \fB\-\fR. \fBfile dirname \fIname\fR Returns a name comprised of all of the path components in \fIname\fR excluding the last element. If \fIname\fR is a relative file name and -only contains one path element, then returns ``\fB.\fR''. If \fIname\fR -refers to a root directory, then the root directory is returned. For -example, +only contains one path element, then returns +.QW \fB.\fR . +If \fIname\fR refers to a root directory, then the root directory is +returned. For example, .RS .CS \fBfile dirname c:/\fR @@ -272,16 +275,20 @@ under Windows. Returns a unique normalized path representation for the file-system object (file, directory, link, etc), whose string value can be used as a unique identifier for it. A normalized path is an absolute path which has -all '../', './' removed. Also it is one which is in the ``standard'' +all +.QW ../ , +.QW ./ +removed. Also it is one which is in the +.QW standard format for the native platform. On Unix, this means the segments leading up to the path must be free of symbolic links/aliases (but the very last path component may be a symbolic link), and on Windows it also means we want the long form with that form's case-dependence (which gives us a unique, case-dependent path). The one exception concerning the last link in the path is necessary, because Tcl or the user may wish to -operate on the actual symbolic link itself (for example 'file delete', 'file -rename', 'file copy' are defined to operate on symbolic links, not on the -things that they point to). +operate on the actual symbolic link itself (for example \fBfile +delete\fR, \fBfile rename\fR, \fBfile copy\fR are defined to operate +on symbolic links, not on the things that they point to). .RE .TP \fBfile owned \fIname\fR @@ -334,7 +341,9 @@ switches; the argument following the \fB\-\|\-\fR will be treated as a \fBfile rootname \fIname\fR . Returns all of the characters in \fIname\fR up to but not including the -last ``.'' character in the last component of name. If the last +last +.QW . +character in the last component of name. If the last component of \fIname\fR doesn't contain a dot, then returns \fIname\fR. .TP \fBfile separator\fR ?\fIname\fR? @@ -388,12 +397,19 @@ the filesystem to use for the file, and the second, if given, an arbitrary string representing the filesystem-specific nature or type of the location within that filesystem. If a filesystem only supports one type of file, the second element may not be supplied. For example the -native files have a first element 'native', and a second element which +native files have a first element +.QW native , +and a second element which when given is a platform-specific type name for the file's system -(e.g. 'NTFS', 'FAT', on Windows). A generic virtual file system might return -the list 'vfs ftp' to represent a file on a remote ftp site mounted as a -virtual filesystem through an extension called 'vfs'. If the file does -not belong to any filesystem, an error is generated. +(e.g. +.QW NTFS , +.QW FAT , +on Windows). A generic virtual file system might return the list +.QW "vfs ftp" +to represent a file on a remote ftp site mounted as a virtual +filesystem through an extension called +.QW vfs . +If the file does not belong to any filesystem, an error is generated. .TP \fBfile tail \fIname\fR . @@ -464,7 +480,7 @@ set oldName foobar.txt set newName foo/bar.txt # Make sure that where we're going to move to exists... if {![\fBfile isdirectory\fR [\fBfile dirname\fR $newName]]} { - \fBfile mkdir\fR [\fBfile dirname\fR $newName] + \fBfile mkdir\fR [\fBfile dirname\fR $newName] } \fBfile rename\fR $oldName $newName \fBfile link\fR -symbolic $oldName $newName diff --git a/doc/fileevent.n b/doc/fileevent.n index 62ce6b4..385d5ec 100644 --- a/doc/fileevent.n +++ b/doc/fileevent.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fileevent.n,v 1.9 2005/05/10 18:34:00 kennykb Exp $ +'\" RCS: @(#) $Id: fileevent.n,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH fileevent n 7.5 Tcl "Tcl Built-In Commands" @@ -30,7 +30,9 @@ interact with the user while waiting for the data to arrive. If an application invokes \fBgets\fR or \fBread\fR on a blocking channel when there is no input data available, the process will block; until the input data arrives, it will not be able to service other events, so it will -appear to the user to ``freeze up''. With \fBfileevent\fR, the process can +appear to the user to +.QW "freeze up" . +With \fBfileevent\fR, the process can tell when data is present and only invoke \fBgets\fR or \fBread\fR when they won't block. .PP @@ -110,15 +112,12 @@ proc GetData {chan} { \fBfileevent\fR $chan readable [list GetData $chan] .CE - .SH CREDITS .PP \fBfileevent\fR is based on the \fBaddinput\fR command created by Mark Diekhans. - .SH "SEE ALSO" fconfigure(n), gets(n), interp(n), puts(n), read(n), Tcl_StandardChannels(3) - .SH KEYWORDS asynchronous I/O, blocking, channel, event handler, nonblocking, readable, script, writable. @@ -5,14 +5,14 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: for.n,v 1.5 2004/10/27 12:53:22 dkf Exp $ +'\" RCS: @(#) $Id: for.n,v 1.6 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH for n "" Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME -for \- ``For'' loop +for \- `For' loop .SH SYNOPSIS \fBfor \fIstart test next body\fR .BE diff --git a/doc/format.n b/doc/format.n index 7050ee3..3c6178d 100644 --- a/doc/format.n +++ b/doc/format.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: format.n,v 1.14 2006/06/14 14:59:03 dkf Exp $ +'\" RCS: @(#) $Id: format.n,v 1.15 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH format n 8.1 Tcl "Tcl Built-In Commands" @@ -50,8 +50,8 @@ The fields that are present must appear in the order given above. The paragraphs below discuss each of these fields in turn. .PP If the \fB%\fR is followed by a decimal number and a \fB$\fR, as in -``\fB%2$d\fR'', then the value to convert is not taken from the -next sequential argument. +.QW \fB%2$d\fR , +then the value to convert is not taken from the next sequential argument. Instead, it is taken from the argument indicated by the number, where 1 corresponds to the first \fIarg\fR. If the conversion specifier requires multiple arguments because @@ -156,7 +156,10 @@ Convert integer to unsigned octal string. .TP 10 \fBx\fR or \fBX\fR Convert integer to unsigned hexadecimal string, using digits -``0123456789abcdef'' for \fBx\fR and ``0123456789ABCDEF'' for \fBX\fR). +.QW 0123456789abcdef +for \fBx\fR and +.QW 0123456789ABCDEF +for \fBX\fR). .TP 10 \fBc\fR Convert integer to the Unicode character it represents. @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: glob.n,v 1.18 2005/06/09 16:24:47 vincentdarley Exp $ +'\" RCS: @(#) $Id: glob.n,v 1.19 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH glob n 8.3 Tcl "Tcl Built-In Commands" @@ -19,7 +19,9 @@ glob \- Return names of files that match patterns .SH DESCRIPTION .PP -This command performs file name ``globbing'' in a fashion similar to +This command performs file name +.QW globbing +in a fashion similar to the csh shell. It returns a list of the files whose names match any of the \fIpattern\fR arguments. No particular order is guaranteed in the list, so if a sorted list is required the caller should use @@ -101,8 +103,9 @@ The following are equivalent: \fBglob */\fR .CE .RE -except that the first case doesn't return the trailing ``/'' and -is more platform independent. +except that the first case doesn't return the trailing +.QW / +and is more platform independent. .RE .TP \fB\-\|\-\fR @@ -129,20 +132,38 @@ Matches the character \fIx\fR. \fB{\fIa\fB,\fIb\fB,\fI...\fR} Matches any of the strings \fIa\fR, \fIb\fR, etc. .LP -On Unix, as with csh, a ``.'' at the beginning of a file's name or just -after a ``/'' must be matched explicitly or with a {} construct, -unless the ``-types hidden'' flag is given (since ``.'' at the beginning +On Unix, as with csh, a +.QW . +at the beginning of a file's name or just after a +.QW / +must be matched explicitly or with a {} construct, unless the +.QW "-types hidden" +flag is given (since +.QW . +at the beginning of a file's name indicates that it is hidden). On other platforms, -files beginning with a ``.'' are handled no differently to any others, -except the special directories ``.'' and ``..'' which must be matched -explicitly (this is to avoid a recursive pattern like ``glob -join * * -* *'' from recursing up the directory hierarchy as well as down). -In addition, all ``/'' characters must be matched explicitly. +files beginning with a +.QW . +are handled no differently to any others, +except the special directories +.QW . +and +.QW .. +which must be matched explicitly (this is to avoid a recursive pattern like +.QW "glob -join * * * *" +from recursing up the directory hierarchy as well as down). In addition, all +.QW / +characters must be matched explicitly. .LP -If the first character in a \fIpattern\fR is ``~'' then it refers -to the home directory for the user whose name follows the ``~''. -If the ``~'' is followed immediately by ``/'' then the value of -the HOME environment variable is used. +If the first character in a \fIpattern\fR is +.QW ~ +then it refers to the home directory for the user whose name follows the +.QW ~ . +If the +.QW ~ +is followed immediately by +.QW / +then the value of the HOME environment variable is used. .LP The \fBglob\fR command differs from csh globbing in two ways. First, it does not sort its result list (use the \fBlsort\fR @@ -152,24 +173,33 @@ exist; in csh no check for existence is made unless a pattern contains a ?, *, or [] construct. .LP When the \fBglob\fR command returns relative paths whose filenames -start with a tilde ``~'' (for example through \fBglob *\fR or +start with a tilde +.QW ~ +(for example through \fBglob *\fR or \fBglob -tails\fR, the returned list will not quote the tilde with -``./''. This means care must be taken if those names are later to +.QW ./ . +This means care must be taken if those names are later to be used with \fBfile join\fR, to avoid them being interpreted as absolute paths pointing to a given user's home directory. .SH "PORTABILITY ISSUES" -.PP +.TP \fBWindows\fR . For Windows UNC names, the servername and sharename components of the path may not contain ?, *, or [] constructs. On Windows NT, if \fIpattern\fR is -of the form ``\fB~\fIusername\fB@\fIdomain\fR'' it refers to the home +of the form +.QW \fB~\fIusername\fB@\fIdomain\fR +it refers to the home directory of the user whose account information resides on the specified NT domain server. Otherwise, user account information is obtained from the local computer. On Windows 95 and 98, \fBglob\fR accepts patterns -like ``.../'' and ``..../'' for successively higher up parent directories. - -. +like +.QW .../ +and +.QW ..../ +for successively higher up parent directories. +.RS +.PP Since the backslash character has a special meaning to the glob command, glob patterns containing Windows style path separators need special care. The pattern \fIC:\e\efoo\e\e*\fR is interpreted as @@ -196,7 +226,12 @@ Find all subdirectories of the current directory: \fBglob\fR \-type d * .CE .PP -Find all files whose name contains an "a", a "b" or the sequence "cde": +Find all files whose name contains an +.QW a , +a +.QW b +or the sequence +.QW cde : .CS \fBglob\fR \-type f *{a,b,cde}* .CE diff --git a/doc/history.n b/doc/history.n index 3236046..e796575 100644 --- a/doc/history.n +++ b/doc/history.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: history.n,v 1.4 2006/11/15 09:23:01 dkf Exp $ +'\" RCS: @(#) $Id: history.n,v 1.5 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH history n "" Tcl "Tcl Built-In Commands" @@ -21,8 +21,9 @@ history \- Manipulate the history list .PP The \fBhistory\fR command performs one of several operations related to recently-executed commands recorded in a history list. Each of -these recorded commands is referred to as an ``event''. When -specifying an event to the \fBhistory\fR command, the following +these recorded commands is referred to as an +.QW event . +When specifying an event to the \fBhistory\fR command, the following forms may be used: .IP [1] A number: if positive, it refers to the event with @@ -92,7 +93,8 @@ The current mechanism is more limited, and the old history operations \fBsubstitute\fR and \fBwords\fR have been removed. (As a consolation, the \fBclear\fR operation was added.) .PP -The history option \fBredo\fR results in much simpler ``history revision''. +The history option \fBredo\fR results in much simpler +.QW "history revision" . When this option is invoked then the most recent event is modified to eliminate the history command and replace it with the result of the history command. @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: http.n,v 1.25 2007/07/04 14:45:19 dkf Exp $ +'\" RCS: @(#) $Id: http.n,v 1.26 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH "http" n 2.5 http "Tcl Bundled Packages" @@ -89,7 +89,8 @@ flags and values that define the configuration: The Accept header of the request. The default is */*, which means that all types of documents are accepted. Otherwise you can supply a comma-separated list of mime type patterns that you are -willing to receive. For example, "image/gif, image/jpeg, text/*". +willing to receive. For example, +.QW "image/gif, image/jpeg, text/*" . .TP \fB\-proxyhost\fR \fIhostname\fR The name of the proxy host, if any. If this value is the @@ -120,7 +121,8 @@ characters. .TP \fB\-useragent\fR \fIstring\fR The value of the User-Agent header in the HTTP request. The default -is \fB"Tcl http client package 2.4."\fR +is +.QW "\fBTcl http client package 2.5\fR" . .RE .TP \fB::http::geturl\fR \fIurl\fR ?\fIoptions\fR? @@ -340,7 +342,6 @@ set token [::http::geturl https://my.secure.site/] \fB::http::unregister\fR \fIproto\fR This procedure unregisters a protocol handler that was previously registered via \fB::http::register\fR. - .SH "ERRORS" The \fB::http::geturl\fR procedure will raise errors in the following cases: invalid command line options, @@ -385,7 +386,8 @@ If the HTTP transaction completes entirely, then status will be \fBok\fR. However, you should still check the \fB::http::code\fR value to get the HTTP status. The \fB::http::ncode\fR procedure provides just the numeric error (e.g., 200, 404 or 500) while the \fB::http::code\fR -procedure returns a value like "HTTP 404 File not found". +procedure returns a value like +.QW "HTTP 404 File not found" . .TP eof If the server closes the socket without replying, then no error @@ -404,7 +406,6 @@ transaction. If it can read the server's response it will end up with an \fBok\fR status, otherwise it will have an \fBeof\fR status. - .SH "STATE ARRAY" The \fB::http::geturl\fR procedure returns a \fItoken\fR that can be used to get to the state of the HTTP transaction in the form of a Tcl array. @@ -534,9 +535,7 @@ proc httpCopyProgress {args} { flush stderr } .CE - .SH "SEE ALSO" safe(n), socket(n), safesock(n) - .SH KEYWORDS security policy, socket @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: if.n,v 1.5 2004/10/27 12:53:22 dkf Exp $ +'\" RCS: @(#) $Id: if.n,v 1.6 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH if n "" Tcl "Tcl Built-In Commands" @@ -32,7 +32,8 @@ then \fBbody2\fR is executed, and so on. If none of the expressions evaluates to true then \fIbodyN\fR is executed. The \fBthen\fR and \fBelse\fR arguments are optional -``noise words'' to make the command easier to read. +.QW noise words +to make the command easier to read. There may be any number of \fBelseif\fR clauses, including zero. \fIBodyN\fR may also be omitted as long as \fBelse\fR is omitted too. The return value from the command is the result of the body script diff --git a/doc/interp.n b/doc/interp.n index 26a60f1..c7fbf18 100644 --- a/doc/interp.n +++ b/doc/interp.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: interp.n,v 1.29 2007/10/17 17:31:58 dkf Exp $ +'\" RCS: @(#) $Id: interp.n,v 1.30 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH interp n 7.6 Tcl "Tcl Built-In Commands" @@ -107,7 +107,9 @@ may be anywhere in the hierarchy of interpreters under the interpreter invoking the command. \fISrcPath\fR and \fIsrcCmd\fR identify the source of the alias. \fISrcPath\fR is a Tcl list whose elements select a particular -interpreter. For example, ``\fBa b\fR'' identifies an interpreter +interpreter. For example, +.QW "\fBa b\fR" +identifies an interpreter \fBb\fR, which is a slave of interpreter \fBa\fR, which is a slave of the invoking interpreter. An empty list specifies the interpreter invoking the command. \fIsrcCmd\fR gives the name of a new @@ -568,9 +570,10 @@ as they would be for any other command invoked in that interpreter. The command procedure for the source command takes its arguments and merges them with the \fItargetCmd\fR and \fIarg\fRs for the alias to create a new array of arguments. If the words -of \fIsrcCmd\fR were ``\fIsrcCmd arg1 arg2 ... argN\fR'', +of \fIsrcCmd\fR were +.QW "\fIsrcCmd arg1 arg2 ... argN\fR" , the new set of words will be -``\fItargetCmd arg arg ... arg arg1 arg2 ... argN\fR'', +.QW "\fItargetCmd arg arg ... arg arg1 arg2 ... argN\fR" , where \fItargetCmd\fR and \fIarg\fRs are the values supplied when the alias was created. \fITargetCmd\fR is then used to locate a command procedure in the target interpreter, and that command procedure diff --git a/doc/lappend.n b/doc/lappend.n index 38c52e5..d8d669a 100644 --- a/doc/lappend.n +++ b/doc/lappend.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lappend.n,v 1.11 2005/05/10 18:34:00 kennykb Exp $ +'\" RCS: @(#) $Id: lappend.n,v 1.12 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH lappend n "" Tcl "Tcl Built-In Commands" @@ -28,9 +28,11 @@ given by the \fIvalue\fR arguments. \fBLappend\fR is similar to \fBappend\fR except that the \fIvalue\fRs are appended as list elements rather than raw text. This command provides a relatively efficient way to build up -large lists. For example, ``\fBlappend a $b\fR'' is much -more efficient than ``\fBset a [concat $a [list $b]]\fR'' when -\fB$a\fR is long. +large lists. For example, +.QW "\fBlappend a $b\fR" +is much more efficient than +.QW "\fBset a [concat $a [list $b]]\fR" , +especially when \fB$a\fR is long. .SH EXAMPLE Using \fBlappend\fR to build up a list of numbers. .CS diff --git a/doc/library.n b/doc/library.n index d4ba1d8..83fe0fd 100644 --- a/doc/library.n +++ b/doc/library.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: library.n,v 1.18 2006/11/15 09:23:01 dkf Exp $ +'\" RCS: @(#) $Id: library.n,v 1.19 2007/10/24 14:29:38 dkf Exp $ .so man.macros .TH library n "8.0" Tcl "Tcl Built-In Commands" .BS @@ -54,7 +54,6 @@ If the library procedure \fBTcl_Init\fR is invoked from an application's The code in \fBinit.tcl\fR will define the \fBunknown\fR procedure and arrange for the other procedures to be loaded on-demand using the auto-load mechanism defined below. - .SH "COMMAND PROCEDURES" .PP The following procedures are provided in the Tcl library: @@ -137,7 +136,9 @@ definition and the next word of the line is taken as the procedure's name. Procedure definitions that don't appear in this way (e.g. they have spaces before the \fBproc\fR) will not be indexed. If your -script contains "dangerous" code, such as global initialization +script contains +.QW dangerous +code, such as global initialization code or procedure names with special characters like \fB$\fR, \fB*\fR, \fB[\fR or \fB]\fR, you are safer using auto_mkindex_old. .RE @@ -174,7 +175,9 @@ their initialization. They call this procedure to look for their script library in several standard directories. The last component of the name of the library directory is normally \fIbasenameversion\fR -(e.g., tk8.0), but it might be "library" when in the build hierarchies. +(e.g., tk8.0), but it might be +.QW library +when in the build hierarchies. The \fIinitScript\fR file will be sourced into the interpreter once it is found. The directory in which this file is found is stored into the global variable \fIvarName\fR. @@ -230,7 +233,6 @@ Returns the index of the first word boundary before the starting index boundaries before the starting point in the given string. The index returned refers to the second character of the pair that comprises a boundary. - .SH "VARIABLES" .PP The following global variables are defined or used by the procedures in @@ -271,7 +273,9 @@ a default value is used. \fBenv(TCLLIBPATH)\fR If set, then it must contain a valid Tcl list giving directories to search during auto-load operations. Directories must be specified in -Tcl format, using "/" as the path separator, regardless of platform. +Tcl format, using +.QW / +as the path separator, regardless of platform. This variable is only used when initializing the \fBauto_path\fR variable. .TP \fBtcl_nonwordchars\fR @@ -290,9 +294,7 @@ word or not. If the pattern matches a character, the character is considered to be a word character. On Windows platforms, words are comprised of any character that is not a space, tab, or newline. Under Unix, words are comprised of numbers, letters or underscores. - .SH "SEE ALSO" info(n), re_syntax(n) - .SH KEYWORDS auto-exec, auto-load, library, unknown, word, whitespace diff --git a/doc/llength.n b/doc/llength.n index 201d50e..47884a3 100644 --- a/doc/llength.n +++ b/doc/llength.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: llength.n,v 1.10 2005/05/10 18:34:00 kennykb Exp $ +'\" RCS: @(#) $Id: llength.n,v 1.11 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH llength n "" Tcl "Tcl Built-In Commands" @@ -17,12 +17,10 @@ llength \- Count the number of elements in a list .SH SYNOPSIS \fBllength \fIlist\fR .BE - .SH DESCRIPTION .PP Treats \fIlist\fR as a list and returns a decimal string giving the number of elements in it. - .SH EXAMPLES The result is the number of elements: .CS @@ -48,10 +46,8 @@ An empty list is not necessarily an empty string: % set var { }; puts "[string length $var],[\fBllength\fR $var]" 1,0 .CE - .SH "SEE ALSO" list(n), lappend(n), lindex(n), linsert(n), lsearch(n), lset(n), lsort(n), lrange(n), lreplace(n) - .SH KEYWORDS element, list, length @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: load.n,v 1.17 2007/09/20 16:26:22 dgp Exp $ +'\" RCS: @(#) $Id: load.n,v 1.18 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH load n 7.5 Tcl "Tcl Built-In Commands" @@ -110,12 +110,15 @@ the package, Tcl picks the file that was loaded first. .TP \fBWindows\fR\0\0\0\0\0 . -When a load fails with "library not found" error, it is also possible -that a dependent library was not found. To see the dependent libraries, -type ``dumpbin -imports <dllname>'' in a DOS console to see what the -library must import. -When loading a DLL in the current directory, Windows will ignore ``./'' as -a path specifier and use a search heuristic to find the DLL instead. +When a load fails with a +.QW "library not found" +error, it is also possible that a dependent library was not found. To +see the dependent libraries, type +.QW "dumpbin -imports <dllname>" +in a DOS console to see what the library must import. +When loading a DLL in the current directory, Windows will ignore +.QW ./ +as a path specifier and use a search heuristic to find the DLL instead. To avoid this, load the DLL with: .CS \fBload\fR [file join [pwd] mylib.DLL] diff --git a/doc/lrange.n b/doc/lrange.n index cb01071..e1ce35a 100644 --- a/doc/lrange.n +++ b/doc/lrange.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lrange.n,v 1.12 2005/05/10 18:34:01 kennykb Exp $ +'\" RCS: @(#) $Id: lrange.n,v 1.13 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH lrange n 7.4 Tcl "Tcl Built-In Commands" @@ -34,10 +34,14 @@ If \fIlast\fR is greater than or equal to the number of elements in the list, then it is treated as if it were \fBend\fR. If \fIfirst\fR is greater than \fIlast\fR then an empty string is returned. -Note: ``\fBlrange \fIlist first first\fR'' does not always produce the -same result as ``\fBlindex \fIlist first\fR'' (although it often does +Note: +.QW "\fBlrange \fIlist first first\fR" +does not always produce the same result as +.QW "\fBlindex \fIlist first\fR" +(although it often does for simple fields that aren't enclosed in braces); it does, however, -produce exactly the same results as ``\fBlist [lindex \fIlist first\fB]\fR'' +produce exactly the same results as +.QW "\fBlist [lindex \fIlist first\fB]\fR" . .SH EXAMPLES Selecting the first two elements: .CS diff --git a/doc/lreplace.n b/doc/lreplace.n index 4c9f8c9..652a9a9 100644 --- a/doc/lreplace.n +++ b/doc/lreplace.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lreplace.n,v 1.13 2005/05/10 18:34:01 kennykb Exp $ +'\" RCS: @(#) $Id: lreplace.n,v 1.14 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH lreplace n 7.4 Tcl "Tcl Built-In Commands" @@ -17,7 +17,6 @@ lreplace \- Replace elements in a list with new elements .SH SYNOPSIS \fBlreplace \fIlist first last \fR?\fIelement element ...\fR? .BE - .SH DESCRIPTION .PP \fBlreplace\fR returns a new list formed by replacing one or more elements of @@ -33,16 +32,16 @@ end of the list. list, and \fBend\fR refers to the last element of the list. If \fIlist\fR is empty, then \fIfirst\fR and \fIlast\fR are ignored. .VE - +.PP If \fIfirst\fR is less than zero, it is considered to refer to the first element of the list. For non-empty lists, the element indicated by \fIfirst\fR must exist. - +.PP If \fIlast\fR is less than zero but greater than \fIfirst\fR, then any specified elements will be prepended to the list. If \fIlast\fR is less than \fIfirst\fR then no elements are deleted; the new elements are simply inserted before \fIfirst\fR. - +.PP The \fIelement\fR arguments specify zero or more new arguments to be added to the list in place of those that were deleted. Each \fIelement\fR argument will become a separate element of @@ -69,14 +68,11 @@ a b c d e % set var [\fBlreplace\fR $var end end] a b c d .CE - .SH "SEE ALSO" list(n), lappend(n), lindex(n), linsert(n), llength(n), lsearch(n), lset(n), lrange(n), lsort(n), .VS 8.5 string(n) .VE - - .SH KEYWORDS element, list, replace @@ -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: lset.n,v 1.9 2005/05/10 18:34:02 kennykb Exp $ +'\" RCS: @(#) $Id: lset.n,v 1.10 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH lset n 8.4 Tcl "Tcl Built-In Commands" @@ -113,7 +113,5 @@ lsort(n), lrange(n), lreplace(n), .VS 8.5 string(n) .VE - - .SH KEYWORDS element, index, list, replace, set diff --git a/doc/lsort.n b/doc/lsort.n index 5eda016..6fc96ae 100644 --- a/doc/lsort.n +++ b/doc/lsort.n @@ -7,7 +7,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lsort.n,v 1.22 2007/07/04 14:45:19 dkf Exp $ +'\" RCS: @(#) $Id: lsort.n,v 1.23 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH lsort n 8.5 Tcl "Tcl Built-In Commands" @@ -59,11 +59,14 @@ be considered less than, equal to, or greater than the second, respectively. .TP 20 \fB\-increasing\fR -Sort the list in increasing order (``smallest'' items first). -This is the default. +Sort the list in increasing order (i.e. +.QW smallest +items first). This is the default. .TP 20 \fB\-decreasing\fR -Sort the list in decreasing order (``largest'' items first). +Sort the list in decreasing order (i.e. +.QW largest +items first). .TP 20 \fB\-indices\fR .VS "8.5 (TIP#217)" diff --git a/doc/man.macros b/doc/man.macros index 29b8a51..3243939 100644 --- a/doc/man.macros +++ b/doc/man.macros @@ -1,72 +1,80 @@ -'\" The definitions below are for supplemental macros used in Tcl/Tk -'\" manual entries. -'\" -'\" .AP type name in/out ?indent? -'\" Start paragraph describing an argument to a library procedure. -'\" type is type of argument (int, etc.), in/out is either "in", "out", -'\" or "in/out" to describe whether procedure reads or modifies arg, -'\" and indent is equivalent to second arg of .IP (shouldn't ever be -'\" needed; use .AS below instead) -'\" -'\" .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. If -'\" the third arg is not supplied, "in" is assumed. -'\" -'\" .BS -'\" Start box enclosure. From here until next .BE, everything will be -'\" enclosed in one large box. -'\" -'\" .BE -'\" End of box enclosure. -'\" -'\" .CS -'\" Begin code excerpt. -'\" -'\" .CE -'\" End code excerpt. -'\" -'\" .VS ?version? ?br? -'\" Begin vertical sidebar, for use in marking newly-changed parts -'\" of man pages. The first argument is ignored and used for recording -'\" the version when the .VS was added, so that the sidebars can be -'\" found and removed when they reach a certain age. If another argument -'\" is present, then a line break is forced before starting the sidebar. -'\" -'\" .VE -'\" End of vertical sidebar. -'\" -'\" .DS -'\" Begin an indented unfilled display. -'\" -'\" .DE -'\" End of indented unfilled display. -'\" -'\" .SO -'\" Start of list of standard options for a Tk widget. The -'\" options follow on successive lines, in four columns separated -'\" by tabs. -'\" -'\" .SE -'\" End of list of standard options for a Tk widget. -'\" -'\" .OP cmdName dbName dbClass -'\" Start of description of a specific option. cmdName gives the -'\" option's name as specified in the class command, dbName gives -'\" the option's name in the option database, and dbClass gives -'\" the option's class in the option database. -'\" -'\" .UL arg1 arg2 -'\" Print arg1 underlined, then print arg2 normally. -'\" -'\" 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. +.\" The -*- nroff -*- definitions below are for supplemental macros used +.\" in Tcl/Tk manual entries. +.\" +.\" .AP type name in/out ?indent? +.\" Start paragraph describing an argument to a library procedure. +.\" type is type of argument (int, etc.), in/out is either "in", "out", +.\" or "in/out" to describe whether procedure reads or modifies arg, +.\" and indent is equivalent to second arg of .IP (shouldn't ever be +.\" needed; use .AS below instead) +.\" +.\" .AS ?type? ?name? +.\" 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. +.\" +.\" .BS +.\" Start box enclosure. From here until next .BE, everything will be +.\" enclosed in one large box. +.\" +.\" .BE +.\" End of box enclosure. +.\" +.\" .CS +.\" Begin code excerpt. +.\" +.\" .CE +.\" End code excerpt. +.\" +.\" .VS ?version? ?br? +.\" Begin vertical sidebar, for use in marking newly-changed parts +.\" of man pages. The first argument is ignored and used for recording +.\" the version when the .VS was added, so that the sidebars can be +.\" found and removed when they reach a certain age. If another argument +.\" is present, then a line break is forced before starting the sidebar. +.\" +.\" .VE +.\" End of vertical sidebar. +.\" +.\" .DS +.\" Begin an indented unfilled display. +.\" +.\" .DE +.\" End of indented unfilled display. +.\" +.\" .SO +.\" Start of list of standard options for a Tk widget. The +.\" options follow on successive lines, in three columns separated +.\" by tabs. +.\" +.\" .SE ?manpage? +.\" End of list of standard options for a Tk widget. The manpage +.\" argument defines where to look up the standard options; if +.\" omitted, defaults to "options". +.\" +.\" .OP cmdName dbName dbClass +.\" Start of description of a specific option. cmdName gives the +.\" option's name as specified in the class command, dbName gives +.\" the option's name in the option database, and dbClass gives +.\" the option's class in the option database. +.\" +.\" .UL arg1 arg2 +.\" Print arg1 underlined, then print arg2 normally. +.\" +.\" .QW arg1 ?arg2? +.\" Print arg1 in quotes, then arg2 normally (for trailing punctuation). +.\" +.\" .PQ arg1 ?arg2? +.\" Print an open parenthesis, arg1 in quotes, then arg2 normally +.\" (for trailing punctuation) and then a closing parenthesis. +.\" +.\" RCS: @(#) $Id: man.macros,v 1.6 2007/10/24 14:29:38 dkf Exp $ +.\" +.\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. .if t .wh -1.3i ^B .nr ^l \n(.l .ad b -'\" # Start an argument description +.\" # Start an argument description .de AP .ie !"\\$4"" .TP \\$4 .el \{\ @@ -88,20 +96,19 @@ .\} .\} .. -'\" # define tabbing values for .AP +.\" # define tabbing values for .AP .de AS .nr )A 10n -.if !"\\$1"" .nr )A \\w'\\$1'u+1n +.if !"\\$1"" .nr )A \\w'\\$1'u+3n .nr )B \\n()Au+15n .\" -.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 +.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n +.nr )C \\n()Bu+\\w'(in/out)'u+2n .. .AS Tcl_Interp Tcl_CreateInterp in/out -'\" # BS - start boxed text -'\" # ^y = starting y location -'\" # ^b = 1 +.\" # BS - start boxed text +.\" # ^y = starting y location +.\" # ^b = 1 .de BS .br .mk ^y @@ -111,7 +118,7 @@ .if n \l'\\n(.lu\(ul' .if n .fi .. -'\" # BE - end boxed text (draw box now) +.\" # BE - end boxed text (draw box now) .de BE .nf .ti 0 @@ -131,16 +138,16 @@ .br .nr ^b 0 .. -'\" # VS - start vertical sidebar -'\" # ^Y = starting y location -'\" # ^v = 1 (for troff; for nroff this doesn't matter) +.\" # VS - start vertical sidebar +.\" # ^Y = starting y location +.\" # ^v = 1 (for troff; for nroff this doesn't matter) .de VS .if !"\\$2"" .br .mk ^Y .ie n 'mc \s12\(br\s0 .el .nr ^v 1u .. -'\" # VE - end of vertical sidebar +.\" # VE - end of vertical sidebar .de VE .ie n 'mc .el \{\ @@ -155,9 +162,9 @@ .\} .nr ^v 0 .. -'\" # Special macro to handle page bottom: finish off current -'\" # box/sidebar if in box/sidebar mode, then invoked standard -'\" # page bottom macro. +.\" # Special macro to handle page bottom: finish off current +.\" # box/sidebar if in box/sidebar mode, then invoked standard +.\" # page bottom macro. .de ^B .ev 2 'ti 0 @@ -184,19 +191,19 @@ .mk ^Y .\} .. -'\" # DS - begin display +.\" # DS - begin display .de DS .RS .nf .sp .. -'\" # DE - end display +.\" # DE - end display .de DE .fi .RE .sp .. -'\" # SO - start of list of standard options +.\" # SO - start of list of standard options .de SO .SH "STANDARD OPTIONS" .LP @@ -204,14 +211,17 @@ .ta 5.5c 11c .ft B .. -'\" # SE - end of list of standard options +.\" # SE - end of list of standard options .de SE .fi .ft R .LP -See the \\fBoptions\\fR manual entry for details on the standard options. +See the +.ie '\\$1'' \\fBoptions\\fR +.el \\fB\\$1\\fR +manual entry for details on the standard options. .. -'\" # OP - start of full description for a single option +.\" # OP - start of full description for a single option .de OP .LP .nf @@ -222,17 +232,43 @@ Database Class: \\fB\\$3\\fR .fi .IP .. -'\" # CS - begin code excerpt +.\" # CS - begin code excerpt .de CS .RS .nf .ta .25i .5i .75i 1i .. -'\" # CE - end code excerpt +.\" # CE - end code excerpt .de CE .fi .RE .. +.\" # UL - underline word .de UL \\$1\l'|0\(ul'\\$2 .. +.\" # QW - apply quotation marks to word +.de QW +.ie '\\*(lq'"' ``\\$1''\\$2 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\$2 +.. +.\" # PQ - apply parens and quotation marks to word +.de PQ +.ie '\\*(lq'"' (``\\$1''\\$2)\\$3 +.\"" fix emacs highlighting +.el (\\*(lq\\$1\\*(rq\\$2)\\$3 +.. +.\" # QR - quoted range +.de QR +.\".QW \fB0\fR\*(rq-\*(lq\fB9\fR , +.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3 +.\"" fix emacs highlighting +.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3 +.. +.\" # MT - "empty" string +.de MT +.ie '\\*(lq'"' ``'' +.\"" fix emacs highlighting +.el \*(lq\*(rq +.. diff --git a/doc/msgcat.n b/doc/msgcat.n index 7bff211..d5aa1c9 100644 --- a/doc/msgcat.n +++ b/doc/msgcat.n @@ -38,8 +38,9 @@ msgcat \- Tcl message catalog .PP The \fBmsgcat\fR package provides a set of functions that can be used to manage multi-lingual user interfaces. -Text strings are defined in a ``message catalog'' which -is independent from the application, and +Text strings are defined in a +.QW "message catalog" +which is independent from the application, and which can be edited or localized without modifying the application source code. New languages or locales are provided by adding a new file to @@ -100,8 +101,9 @@ returns \fB{en_US_funky en_US en {}}\fR. \fB::msgcat::mcload \fIdirname\fR Searches the specified directory for files that match the language specifications returned by \fB::msgcat::mcpreferences\fR -(note that these are all lowercase), extended by the file -extension ``.msg''. Each matching file is +(note that these are all lowercase), extended by the file extension +.QW .msg . +Each matching file is read in order, assuming a UTF-8 encoding. The file contents are then evaluated as a Tcl script. This means that Unicode characters may be present in the message file either directly in their UTF-8 @@ -141,10 +143,15 @@ The locale is specified to \fBmsgcat\fR by a locale string passed to \fB::msgcat::mclocale\fR. The locale string consists of a language code, an optional country code, and an optional -system-specific code, each separated by ``_''. The country and language +system-specific code, each separated by +.QW _ . +The country and language codes are specified in standards ISO-639 and ISO-3166. -For example, the locale ``en'' specifies English and ``en_US'' specifies -U.S. English. +For example, the locale +.QW en +specifies English and +.QW en_US +specifies U.S. English. .PP When the msgcat package is first loaded, the locale is initialized according to the user's environment. The variables \fBenv(LC_ALL)\fR, @@ -163,12 +170,20 @@ On Windows, if none of those environment variables is set, msgcat will attempt to extract locale information from the registry. If all these attempts to discover an initial locale from the user's environment fail, msgcat defaults to an initial -locale of ``C''. +locale of +.QW C . .PP -When a locale is specified by the user, a ``best match'' search is +When a locale is specified by the user, a +.QW "best match" +search is performed during string translation. For example, if a user specifies .VS 1.4 -en_GB_Funky, the locales ``en_GB_Funky'', ``en_GB'', ``en'' and ``'' +en_GB_Funky, the locales +.QW en_GB_Funky , +.QW en_GB , +.QW en +and +.MT (the empty string) .VE 1.4 are searched in order until a matching translation @@ -204,7 +219,9 @@ then the parent of the current namespace, and so on until the global namespace is reached. This allows child namespaces to "inherit" messages from their parent namespace. .PP -For example, executing (in the ``en'' locale) the code +For example, executing (in the +.QW en +locale) the code .CS \fB::msgcat::mcset\fR en m1 ":: message1" \fB::msgcat::mcset\fR en m2 ":: message2" @@ -235,16 +252,20 @@ to the following conditions: All message files for a package are in the same directory. .IP [2] The message file name is a msgcat locale specifier (all lowercase) -followed by ``.msg''. For example: +followed by +.QW .msg . +For example: .CS es.msg -- spanish en_gb.msg -- United Kingdom English .CE .VS 1.4 -\fIException:\fR The message file for the root locale ``'' is -called \fBROOT.msg\fR. This exception is made so as not to +\fIException:\fR The message file for the root locale +.MT +is called \fBROOT.msg\fR. This exception is made so as not to cause peculiar behavior, such as marking the message file as -``hidden'' on Unix file systems. +.QW hidden +on Unix file systems. .VE 1.4 .IP [3] The file contains a series of calls to \fBmcset\fR and diff --git a/doc/namespace.n b/doc/namespace.n index 99d885c..09fa371 100644 --- a/doc/namespace.n +++ b/doc/namespace.n @@ -7,12 +7,12 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: namespace.n,v 1.21 2006/08/26 13:00:38 msofer Exp $ +'\" RCS: @(#) $Id: namespace.n,v 1.22 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH namespace n 8.5 Tcl "Tcl Built-In Commands" .BS -'\" Note: do not modify the .SH NAME line immediately below! +.\" Note: do not modify the .SH NAME line immediately below! .SH NAME namespace \- create and manipulate contexts for commands and variables .SH SYNOPSIS @@ -55,9 +55,10 @@ First, it can be evaluated in any namespace and will cause Second, additional arguments can be appended to the resulting script and they will be passed to \fIscript\fR as additional arguments. For example, suppose the command -\fBset script [namespace code {foo bar}]\fR +.QW "\fBset script [namespace code {foo bar}]\fR" is invoked in namespace \fB::a::b\fR. -Then \fBeval "$script x y"\fR +Then +.QW \fBeval\0"$script\0x\0y"\fR can be executed in any namespace (assuming the value of \fBscript\fR has been passed in properly) and will have the same effect as the command @@ -72,7 +73,8 @@ of how this is used to create callback scripts. .TP \fBnamespace current\fR Returns the fully-qualified name for the current namespace. -The actual name of the global namespace is ``'' +The actual name of the global namespace is +.MT (i.e., an empty string), but this command returns \fB::\fR for the global namespace as a convenience to programmers. @@ -218,7 +220,7 @@ If \fInamespace\fR is not specified, the fully-qualified name of the current namespace's parent is returned. .TP \fBnamespace path\fR ?\fInamespaceList\fR? -'\" Should really have the .TP inside the .VS, but that triggers a groff bug +.\" Should really have the .TP inside the .VS, but that triggers a groff bug .VS 8.5 Returns the command resolution path of the current namespace. If \fInamespaceList\fR is specified as a list of named namespaces, the @@ -359,8 +361,9 @@ Qualified names are similar to the hierarchical path names for Unix files or Tk widgets, except that \fB::\fR is used as the separator instead of \fB/\fR or \fB.\fR. -The topmost or global namespace has the name ``'' (i.e., an empty string), -although \fB::\fR is a synonym. +The topmost or global namespace has the name +.MT +(i.e., an empty string), although \fB::\fR is a synonym. As an example, the name \fB::safe::interp::create\fR refers to the command \fBcreate\fR in the namespace \fBinterp\fR that is a child of namespace \fB::safe\fR, @@ -831,9 +834,7 @@ Look up where the command imported in the previous example came from: .CS puts "grill came from [\fBnamespace origin\fR grill]" .CE - .SH "SEE ALSO" interp(n), upvar(n), variable(n) - .SH KEYWORDS command, ensemble, exported, internal, variable @@ -5,12 +5,12 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: open.n,v 1.28 2007/02/18 18:42:55 dkf Exp $ +'\" RCS: @(#) $Id: open.n,v 1.29 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH open n 8.3 Tcl "Tcl Built-In Commands" .BS -'\" Note: do not modify the .SH NAME line immediately below! +.\" Note: do not modify the .SH NAME line immediately below! .SH NAME open \- Open a file-based or command pipeline channel .SH SYNOPSIS @@ -66,7 +66,7 @@ Set the initial access position to the end of the file. All of the legal \fIaccess\fR values above may have the character \fBb\fR added as the second or third character in the value to indicate that the opened channel should be configured with the -\fB-translation binary\fR option, making the channel suitable for +\fB\-translation binary\fR option, making the channel suitable for reading or writing of binary data. .VE 8.5 .PP @@ -88,7 +88,7 @@ Set the file pointer to the end of the file prior to each write. .VS 8.5 .TP 15 \fBBINARY\fR -Configure the opened channel with the \fB-translation binary\fR option. +Configure the opened channel with the \fB\-translation binary\fR option. .VE 8.5 .TP 15 \fBCREAT\fR @@ -119,12 +119,12 @@ If a new file is created as part of opening it, \fIpermissions\fR (an integer) is used to set the permissions for the new file in conjunction with the process's file mode creation mask. \fIPermissions\fR defaults to 0666. - .SH "COMMAND PIPELINES" .PP -If the first character of \fIfileName\fR is ``|'' then the -remaining characters of \fIfileName\fR are treated as a list of arguments -that describe a command pipeline to invoke, in the same style as the +If the first character of \fIfileName\fR is +.QW | +then the remaining characters of \fIfileName\fR are treated as a list of +arguments that describe a command pipeline to invoke, in the same style as the arguments for \fBexec\fR. In this case, the channel identifier returned by \fBopen\fR may be used to write to the command's input pipe or read from its output pipe, @@ -162,10 +162,15 @@ This option is a set of 4 comma-separated values: the baud rate, parity, number of data bits, and number of stop bits for this serial port. The \fIbaud\fR rate is a simple integer that specifies the connection speed. \fIParity\fR is one of the following letters: \fBn\fR, \fBo\fR, \fBe\fR, -\fBm\fR, \fBs\fR; respectively signifying the parity options of ``none'', -``odd'', ``even'', ``mark'', or ``space''. \fIData\fR is the number of -data bits and should be an integer from 5 to 8, while \fIstop\fR is the -number of stop bits and should be the integer 1 or 2. +\fBm\fR, \fBs\fR; respectively signifying the parity options of +.QW none , +.QW odd , +.QW even , +.QW mark , +or +.QW space . +\fIData\fR is the number of data bits and should be an integer from 5 to 8, +while \fIstop\fR is the number of stop bits and should be the integer 1 or 2. .TP \fB\-handshake\fR \fItype\fR (Windows and Unix). This option is used to setup automatic handshake @@ -176,14 +181,14 @@ If \fItype\fR is \fBnone\fR then any handshake is switched off. \fBrtscts\fR activates hardware handshake. Hardware handshake signals are described below. For software handshake \fBxonxoff\fR the handshake characters can be redefined -with \fB-xchar\fR. +with \fB\-xchar\fR. An additional hardware handshake \fBdtrdsr\fR is available only under Windows. There is no default handshake configuration, the initial value depends on your operating system settings. -The \fB-handshake\fR option cannot be queried. +The \fB\-handshake\fR option cannot be queried. .TP \fB\-queue\fR -(Windows and Unix). The \fB-queue\fR option can only be queried. +(Windows and Unix). The \fB\-queue\fR option can only be queried. It returns a list of two integers representing the current number of bytes in the input and output queue respectively. .TP @@ -192,7 +197,7 @@ of bytes in the input and output queue respectively. read operations. It specifies the maximum interval between the reception of two bytes in milliseconds. For Unix systems the granularity is 100 milliseconds. -The \fB-timeout\fR option does not affect write operations or +The \fB\-timeout\fR option does not affect write operations or nonblocking reads. This option cannot be queried. .TP @@ -206,10 +211,10 @@ The BREAK condition (see below) is enabled and disabled with \fB{BREAK 1}\fR and It's not a good idea to change the \fBRTS\fR (or \fBDTR\fR) signal with active hardware handshake \fBrtscts\fR (or \fBdtrdsr\fR). The result is unpredictable. -The \fB-ttycontrol\fR option cannot be queried. +The \fB\-ttycontrol\fR option cannot be queried. .TP \fB\-ttystatus\fR -(Windows and Unix). The \fB-ttystatus\fR option can only be +(Windows and Unix). The \fB\-ttystatus\fR option can only be queried. It returns the current modem status and handshake input signals (see below). The result is a list of signal,value pairs with a fixed order, @@ -245,7 +250,6 @@ In case of a serial communication error, \fBread\fR or \fBputs\fR returns a general Tcl file I/O error. \fBfconfigure -lasterror\fR can be called to get a list of error details. See below for an explanation of the various error codes. - .SH "SERIAL PORT SIGNALS" .PP RS-232 is the most commonly used standard electrical interface for serial @@ -276,8 +280,9 @@ serial port is opened. \fBData Set Ready:\fR The complement to DTR. Tells the workstation that the modem is ready to establish a link. .IP \fBDCD(input)\fR -\fBData Carrier Detect:\fR This line becomes active when a modem detects -a "Carrier" signal. +\fBData Carrier Detect:\fR This line becomes active when a modem detects a +.QW Carrier +signal. .IP \fBRI(input)\fR \fBRing Indicator:\fR Goes active when the modem detects an incoming call. .IP \fBBREAK\fR @@ -287,7 +292,6 @@ milliseconds. Normally a receive or transmit data signal stays at the mark (on=1) voltage until the next character is transferred. A BREAK is sometimes used to reset the communications line or change the operating mode of communications hardware. - .SH "ERROR CODES (Windows only)" .PP A lot of different errors may occur during serial read operations or during @@ -326,10 +330,10 @@ may cause this error. .TP 10 \fBBREAK\fR A BREAK condition has been detected by your UART (see above). - .SH "PORTABILITY ISSUES" .TP \fBWindows \fR(all versions) +. Valid values for \fIfileName\fR to open a serial port are of the form \fBcom\fIX\fB:\fR, where \fIX\fR is a number, generally from 1 to 4. This notation only works for serial ports from 1 to 9, if the system @@ -340,6 +344,7 @@ where X is any number that corresponds to a serial port; please note that this method is considerably slower on Windows 95 and Windows 98. .TP \fBWindows NT\fR +. When running Tcl interactively, there may be some strange interactions between the real console, if one is present, and a command pipeline that uses standard input or output. If a command pipeline is opened for reading, some @@ -354,14 +359,16 @@ is not accessing the console, or if the command pipeline does not use standard input or output, but is redirected from or to a file, then the above problems do not occur. .TP -\fBWindows 95\fR +\fBWindows 95\fR +. A command pipeline that executes a 16-bit DOS application cannot be opened for both reading and writing, since 16-bit DOS applications that receive standard input from a pipe and send standard output to a pipe run synchronously. Command pipelines that do not execute 16-bit DOS applications run asynchronously and can be opened for both reading and writing. -.sp +.RS +.PP When running Tcl interactively, there may be some strange interactions between the real console, if one is present, and a command pipeline that uses standard input or output. If a command pipeline is opened for reading from @@ -374,7 +381,7 @@ console at the same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input or output, but is redirected from or to a file, then the above problems do not occur. -.sp +.PP Whether or not Tcl is running interactively, if a command pipeline is opened for reading from a 16-bit DOS application, the call to \fBopen\fR will not return until end-of-file has been received from the command pipeline's @@ -382,14 +389,17 @@ standard output. If a command pipeline is opened for writing to a 16-bit DOS application, no data will be sent to the command pipeline's standard output until the pipe is actually closed. This problem occurs because 16-bit DOS applications are run synchronously, as described above. +.RE .TP \fBUnix\fR\0\0\0\0\0\0\0 +. Valid values for \fIfileName\fR to open a serial port are generally of the form \fB/dev/tty\fIX\fR, where \fIX\fR is \fBa\fR or \fBb\fR, but the name of any pseudo-file that maps to a serial port may be used. Advanced configuration options are only supported for serial ports when Tcl is built to use the POSIX serial interface. -.sp +.RS +.PP When running Tcl interactively, there may be some strange interactions between the console, if one is present, and a command pipeline that uses standard input. If a command pipeline is opened for reading, some @@ -399,6 +409,7 @@ both Tcl and the child application are competing for the console at the same time. If the command pipeline is started from a script, so that Tcl is not accessing the console, or if the command pipeline does not use standard input, but is redirected from a file, then the above problem does not occur. +.RE .LP See the PORTABILITY ISSUES section of the \fBexec\fR command for additional information not specific to command pipelines about executing @@ -412,11 +423,9 @@ if {[catch {close $fl} err]} { puts "ls command failed: $err" } .CE - .SH "SEE ALSO" -file(n), close(n), filename(n), fconfigure(n), gets(n), read(n), -puts(n), exec(n), pid(n), fopen(3) - +chan(n), close(n), exec(n), fconfigure(n), file(n), filename(n), gets(n), +pid(n), puts(n), read(n), fopen(3) .SH KEYWORDS access mode, append, create, file, non-blocking, open, permissions, pipeline, process, serial diff --git a/doc/package.n b/doc/package.n index 5db0f2f..6c08f70 100644 --- a/doc/package.n +++ b/doc/package.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: package.n,v 1.17 2007/09/11 17:46:07 dgp Exp $ +'\" RCS: @(#) $Id: package.n,v 1.18 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH package n 7.5 Tcl "Tcl Built-In Commands" @@ -143,7 +143,10 @@ of \fIpackage\fR is acceptable to the caller. This command is equivalent to \fBpackage require \fIpackage version\fR-\fIversion\fR. .TP \fBpackage unknown \fR?\fIcommand\fR? -This command supplies a ``last resort'' command to invoke during +. +This command supplies a +.QW "last resort" +command to invoke during \fBpackage require\fR if no suitable version of a package can be found in the \fBpackage ifneeded\fR database. If the \fIcommand\fR argument is supplied, it contains the first part diff --git a/doc/packagens.n b/doc/packagens.n index 685ff48..5376efa 100644 --- a/doc/packagens.n +++ b/doc/packagens.n @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: packagens.n,v 1.5 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: packagens.n,v 1.6 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH pkg::create n 8.3 Tcl "Tcl Built-In Commands" @@ -20,7 +20,6 @@ pkg::create \- Construct an appropriate `package ifneeded' command for a given p library. It is used to create an appropriate \fBpackage ifneeded\fR command for a given package specification. It can be used to construct a \fBpkgIndex.tcl\fR file for use with the \fBpackage\fR mechanism. - .SH OPTIONS The parameters supported are: .TP @@ -46,9 +45,7 @@ specifies a Tcl library that must be loaded with the specified. .PP At least one \fB\-load\fR or \fB\-source\fR parameter must be given. - .SH "SEE ALSO" package(n) - .SH KEYWORDS auto-load, index, package, version diff --git a/doc/pkgMkIndex.n b/doc/pkgMkIndex.n index 6be6de5..957906f 100644 --- a/doc/pkgMkIndex.n +++ b/doc/pkgMkIndex.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: pkgMkIndex.n,v 1.18 2006/11/15 09:23:02 dkf Exp $ +'\" RCS: @(#) $Id: pkgMkIndex.n,v 1.19 2007/10/24 14:29:38 dkf Exp $ '\" .so man.macros .TH pkg_mkIndex n 8.3 Tcl "Tcl Built-In Commands" @@ -40,7 +40,8 @@ The \fIdir\fR argument gives the name of a directory and each \fIpattern\fR argument is a \fBglob\fR-style pattern that selects script or binary files in \fIdir\fR. The default pattern is \fB*.tcl\fR and \fB*.[info sharedlibextension]\fR. -.br +.RS +.PP \fBPkg_mkIndex\fR will create a file \fBpkgIndex.tcl\fR in \fIdir\fR with package information about all the files given by the \fIpattern\fR arguments. @@ -54,7 +55,7 @@ or if you have dependencies among files, you may have to use the \fB\-load\fR option or adjust the order in which \fBpkg_mkIndex\fR processes the files. See COMPLEX CASES below. - +.RE .IP [3] Install the package as a subdirectory of one of the directories given by the \fBtcl_pkgPath\fR variable. If \fB$tcl_pkgPath\fR contains more @@ -68,7 +69,8 @@ the package's script and/or binary files as well as the \fBpkgIndex.tcl\fR file. As long as the package is installed as a subdirectory of a directory in \fB$tcl_pkgPath\fR it will automatically be found during \fBpackage require\fR commands. -.br +.RS +.PP If you install the package anywhere else, then you must ensure that the directory containing the package is in the \fBauto_path\fR global variable or an immediate subdirectory of one of the directories in \fBauto_path\fR. @@ -81,6 +83,7 @@ You can add a directory to \fBauto_path\fR explicitly in your application, or you can add the directory to your \fBTCLLIBPATH\fR environment variable: if this environment variable is present, Tcl initializes \fBauto_path\fR from it during application startup. +.RE .IP [4] Once the above steps have been taken, all you need to do to use a package is to invoke \fBpackage require\fR. @@ -94,7 +97,6 @@ in \fBauto_path\fR, but only one will actually be loaded in a given interpreter, based on the first call to \fBpackage require\fR. Different versions of a package may be loaded in different interpreters. - .SH OPTIONS The optional switches are: .TP 15 @@ -121,7 +123,6 @@ the \fBtclLog\fR procedure, which by default prints to stderr. .TP 15 \fB\-\-\fR End of the flags, in case \fIdir\fR begins with a dash. - .SH "PACKAGES AND THE AUTO-LOADER" .PP The package management facilities overlap somewhat with the auto-loader, @@ -141,7 +142,6 @@ If you use \fBpkg_mkIndex\fR to index a package, its commands cannot be invoked until \fBpackage require\fR has been used to select a version; in contrast, packages indexed with \fBauto_mkindex\fR can be used immediately since there is no version control. - .SH "HOW IT WORKS" .PP \fBPkg_mkIndex\fR depends on the \fBpackage unknown\fR command, @@ -164,7 +164,6 @@ is invoked. Thus, after invoking \fBpackage require\fR you may not see the package's commands in the interpreter, but you will be able to invoke the commands and they will be auto-loaded. - .SH "DIRECT LOADING" .PP Some packages, for instance packages which use namespaces and export @@ -173,7 +172,6 @@ that their package files be loaded immediately upon \fBpackage require\fR instead of delaying the actual loading to the first use of one of the package's command. This is the default mode when generating the package index. It can be overridden by specifying the \fI\-lazy\fR argument. - .SH "COMPLEX CASES" Most complex cases of dependencies among scripts and binary files, and packages being split among scripts and @@ -229,9 +227,7 @@ other files that provide part of the same package. If you must use \fB\-load\fR, then you must specify the scripts first; otherwise the package loaded from the binary file may mask the package defined by the scripts. - .SH "SEE ALSO" package(n) - .SH KEYWORDS auto-load, index, package, version diff --git a/doc/re_syntax.n b/doc/re_syntax.n index bba917b..3ceeb53 100644 --- a/doc/re_syntax.n +++ b/doc/re_syntax.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: re_syntax.n,v 1.10 2007/02/13 14:48:55 dkf Exp $ +'\" RCS: @(#) $Id: re_syntax.n,v 1.11 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH re_syntax n "8.1" Tcl "Tcl Built-In Commands" @@ -19,12 +19,17 @@ re_syntax \- Syntax of Tcl regular expressions A \fIregular expression\fR describes strings of characters. It's a pattern that matches certain strings and doesn't match others. .SH "DIFFERENT FLAVORS OF REs" -Regular expressions (``RE''s), as defined by POSIX, come in two -flavors: \fIextended\fR REs (``EREs'') and \fIbasic\fR REs (``BREs''). +Regular expressions +.PQ RE s , +as defined by POSIX, come in two flavors: \fIextended\fR REs +.PQ ERE s +and \fIbasic\fR REs +.PQ BRE s . EREs are roughly those of the traditional \fIegrep\fR, while BREs are roughly those of the traditional \fIed\fR. This implementation adds -a third flavor, \fIadvanced\fR REs (``AREs''), basically EREs with -some significant extensions. +a third flavor, \fIadvanced\fR REs +.PQ ARE s , +basically EREs with some significant extensions. .PP This manual page primarily describes AREs. BREs mostly exist for backward compatibility in some old programs; they will be discussed at @@ -38,7 +43,8 @@ the Perl5 extensions (thanks, Henry!). Much of the description of regular expressions below is copied verbatim from his manual entry. .PP An ARE is one or more \fIbranches\fR, -separated by `\fB|\fR', +separated by +.QW \fB|\fR , matching anything that matches any of the branches. .PP A branch is zero or more \fIconstraints\fR or \fIquantified atoms\fR, @@ -89,8 +95,9 @@ An atom is one of: matches a match for \fIre\fR (\fIre\fR is any regular expression) with the match noted for possible reporting .IP \fB(?:\fIre\fB)\fR -as previous, but does no reporting (a ``non-capturing'' set of -parentheses) +as previous, but does no reporting (a +.QW non-capturing +set of parentheses) .IP \fB()\fR matches an empty string, noted for possible reporting .IP \fB(?:)\fR @@ -102,15 +109,17 @@ a \fIbracket expression\fR, matching any one of the \fIchars\fR (see matches any single character .IP \fB\e\fIk\fR matches the non-alphanumeric character \fIk\fR -taken as an ordinary character, e.g. \fB\e\e\fR matches a backslash -character +taken as an ordinary character, e.g. +.QW \fB\e\e\fR +matches a backslash character .IP \fB\e\fIc\fR where \fIc\fR is alphanumeric (possibly followed by other characters), an \fIescape\fR (AREs only), see \fBESCAPES\fR below .IP \fB{\fR when followed by a character other than a digit, matches the -left-brace character `\fB{\fR'; when followed by a digit, it is the -beginning of a \fIbound\fR (see above) +left-brace character +.QW \fB{\fR ; +when followed by a digit, it is the beginning of a \fIbound\fR (see above) .IP \fIx\fR where \fIx\fR is a single character with no other significance, matches that character. @@ -140,67 +149,122 @@ substring matching \fIre\fR begins The lookahead constraints may not contain back references (see later), and all parentheses within them are considered non-capturing. .PP -An RE may not end with `\fB\e\fR'. +An RE may not end with +.QW \fB\e\fR . .SH "BRACKET EXPRESSIONS" A \fIbracket expression\fR is a list of characters enclosed in -`\fB[\|]\fR'. It normally matches any single character from the list -(but see below). If the list begins with `\fB^\fR', it matches any -single character (but see below) \fInot\fR from the rest of the list. -.PP -If two characters in the list are separated by `\fB\-\fR', this is -shorthand for the full \fIrange\fR of characters between those two -(inclusive) in the collating sequence, e.g. \fB[0\-9]\fR in Unicode -matches any conventional decimal digit. Two ranges may not share an -endpoint, so e.g. \fBa\-c\-e\fR is illegal. Ranges are very -collating-sequence-dependent, and portable programs should avoid -relying on them. -.PP -To include a literal \fB]\fR or \fB\-\fR in the list, the simplest -method is to enclose it in \fB[.\fR and \fB.]\fR to make it a -collating element (see below). Alternatively, make it the first -character (following a possible `\fB^\fR'), or (AREs only) precede it -with `\fB\e\fR'. Alternatively, for `\fB\-\fR', make it the last -character, or the second endpoint of a range. To use a literal -\fB\-\fR as the first endpoint of a range, make it a collating element -or (AREs only) precede it with `\fB\e\fR'. With the exception of -these, some combinations using \fB[\fR (see next paragraphs), and -escapes, all other special characters lose their special significance -within a bracket expression. +.QW \fB[\|]\fR . +It normally matches any single character from the list (but see +below). If the list begins with +.QW \fB^\fR , +it matches any single character (but see below) \fInot\fR from the +rest of the list. +.PP +If two characters in the list are separated by +.QW \fB\-\fR , +this is shorthand for the full \fIrange\fR of characters between those two +(inclusive) in the collating sequence, e.g. +.QW \fB[0\-9]\fR +in Unicode matches any conventional decimal digit. Two ranges may not share an +endpoint, so e.g. +.QW \fBa\-c\-e\fR +is illegal. Ranges are very collating-sequence-dependent, and portable +programs should avoid relying on them. +.PP +To include a literal +.QW \fB]\fR +or +.QW \fB\-\fR +in the list, the simplest method is to enclose it in +.QW \fB[.\fR +and +.QW \fB.]\fR +to make it a collating element (see below). Alternatively, make it the first +character (following a possible +.QW \fB^\fR ), +or (AREs only) precede it with +.QW \fB\e\fR . +Alternatively, for +.QW \fB\-\fR , +make it the last character, or the second endpoint of a range. To use a +literal +.QW \fB\-\fR +as the first endpoint of a range, make it a collating element +or (AREs only) precede it with +.QW \fB\e\fR . +With the exception of these, some combinations using +.QW \fB[\fR +(see next paragraphs), and escapes, all other special characters lose their +special significance within a bracket expression. .PP Within a bracket expression, a collating element (a character, a multi-character sequence that collates as if it were a single character, or a collating-sequence name for either) enclosed in -\fB[.\fR and \fB.]\fR stands for the sequence of characters of that -collating element. The sequence is a single element of the bracket +.QW \fB[.\fR +and +.QW \fB.]\fR +stands for the sequence of characters of that collating element. +The sequence is a single element of the bracket expression's list. A bracket expression in a locale that has multi-character collating elements can thus match more than one character. So (insidiously), a bracket expression that starts with -\fB^\fR can match multi-character collating elements even if none of +.QW \fB^\fR +can match multi-character collating elements even if none of them appear in the bracket expression! (\fINote:\fR Tcl currently has no multi-character collating elements. This information is only for illustration.) .PP -For example, assume the collating sequence includes a \fBch\fR -multi-character collating element. Then the RE \fB[[.ch.]]*c\fR (zero -or more \fBch\fR's followed by \fBc\fR) matches the first five -characters of `\fBchchcc\fR'. Also, the RE \fB[^c]b\fR matches all of -`\fBchb\fR' (because \fB[^c]\fR matches the multi-character \fBch\fR). -.PP -Within a bracket expression, a collating element enclosed in \fB[=\fR -and \fB=]\fR is an equivalence class, standing for the sequences of +For example, assume the collating sequence includes a +.QW \fBch\fR +multi-character collating element. Then the RE +.QW \fB[[.ch.]]*c\fR +(zero or more +.QW \fBch\fR 's +followed by +.QW \fBc\fR ) +matches the first five characters of +.QW \fBchchcc\fR . +Also, the RE +.QW \fB[^c]b\fR +matches all of +.QW \fBchb\fR +(because +.QW \fB[^c]\fR +matches the multi-character +.QW \fBch\fR ). +.PP +Within a bracket expression, a collating element enclosed in +.QW \fB[=\fR +and +.QW \fB=]\fR +is an equivalence class, standing for the sequences of characters of all collating elements equivalent to that one, including itself. (If there are no other equivalent collating elements, the -treatment is as if the enclosing delimiters were `\fB[.\fR'\& and -`\fB.]\fR'.) For example, if \fBo\fR and \fB\o'o^'\fR are the members -of an equivalence class, then `\fB[[=o=]]\fR', `\fB[[=\o'o^'=]]\fR', -and `\fB[o\o'o^']\fR'\& are all synonymous. An equivalence class may +treatment is as if the enclosing delimiters were +.QW \fB[.\fR \& +and +.QW \fB.]\fR .) +For example, if +.QW \fBo\fR +and +.QW \fB\o'o^'\fR +are the members of an equivalence class, then +.QW \fB[[=o=]]\fR , +.QW \fB[[=\o'o^'=]]\fR , +and +.QW \fB[o\o'o^']\fR \& +are all synonymous. An equivalence class may not be an endpoint of a range. (\fINote:\fR Tcl currently implements only the Unicode locale. It doesn't define any equivalence classes. The examples above are just illustrations.) .PP Within a bracket expression, the name of a \fIcharacter class\fR -enclosed in \fB[:\fR and \fB:]\fR stands for the list of all -characters (not all collating elements!) belonging to that class. +enclosed in +.QW \fB[:\fR +and +.QW \fB:]\fR +stands for the list of all +characters (not all collating elements!) belonging to that class. Standard character classes are: .IP \fBalpha\fR 8 A letter. @@ -215,7 +279,9 @@ A hexadecimal digit. .IP \fBalnum\fR 8 An alphanumeric (letter or digit). .IP \fBprint\fR 8 -A "printable" (same as graph, except also including space). +A +.QW "printable" +(same as graph, except also including space). .IP \fBblank\fR 8 A space or tab character. .IP \fBspace\fR 8 @@ -232,23 +298,35 @@ implementation has only one locale: the Unicode locale.) A character class may not be used as an endpoint of a range. .PP There are two special cases of bracket expressions: the bracket -expressions \fB[[:<:]]\fR and \fB[[:>:]]\fR are constraints, matching +expressions +.QW \fB[[:<:]]\fR +and +.QW \fB[[:>:]]\fR +are constraints, matching empty strings at the beginning and end of a word respectively. -'\" note, discussion of escapes below references this definition of word +.\" note, discussion of escapes below references this definition of word A word is defined as a sequence of word characters that is neither preceded nor followed by word characters. A word character is an -\fIalnum\fR character or an underscore (\fB_\fR). These special -bracket expressions are deprecated; users of AREs should use +\fIalnum\fR character or an underscore +.PQ \fB_\fR "" . +These special bracket expressions are deprecated; users of AREs should use constraint escapes instead (see below). .SH ESCAPES -Escapes (AREs only), which begin with a \fB\e\fR followed by an +Escapes (AREs only), which begin with a +.QW \fB\e\fR +followed by an alphanumeric character, come in several varieties: character entry, -class shorthands, constraint escapes, and back references. A \fB\e\fR +class shorthands, constraint escapes, and back references. A +.QW \fB\e\fR followed by an alphanumeric character but not constituting a valid escape is illegal in AREs. In EREs, there are no escapes: outside a -bracket expression, a \fB\e\fR followed by an alphanumeric character +bracket expression, a +.QW \fB\e\fR +followed by an alphanumeric character merely stands for that character as an ordinary character, and inside -a bracket expression, \fB\e\fR is an ordinary character. (The latter +a bracket expression, +.QW \fB\e\fR +is an ordinary character. (The latter is the one actual incompatibility between EREs and AREs.) .PP Character-entry escapes (AREs only) exist to make it easier to specify @@ -270,8 +348,9 @@ applications where there are multiple levels of backslash processing are the same as those of \fIX\fR, and whose other bits are all zero .TP \fB\ee\fR -the character whose collating-sequence name is `\fBESC\fR', or failing -that, the character with octal value 033 +the character whose collating-sequence name is +.QW \fBESC\fR , +or failing that, the character with octal value 033 .TP \fB\ef\fR formfeed, as in C @@ -315,16 +394,27 @@ reference (see below)) the character whose octal value is \fB0\fIxyz\fR .RE .PP -Hexadecimal digits are `\fB0\fR'-`\fB9\fR', `\fBa\fR'-`\fBf\fR', and -`\fBA\fR'-`\fBF\fR'. Octal digits are `\fB0\fR'-`\fB7\fR'. +Hexadecimal digits are +.QR 0 9 , +.QR a f , +and +.QR A F . +Octal digits are +.QR 0 7 . .PP The character-entry escapes are always taken as ordinary characters. -For example, \fB\e135\fR is \fB]\fR in Unicode, but \fB\e135\fR does -not terminate a bracket expression. Beware, however, that some +For example, +.QW \fB\e135\fR +is +.QW \fB]\fR +in Unicode, but +.QW \fB\e135\fR +does not terminate a bracket expression. Beware, however, that some applications (e.g., C compilers and the Tcl interpreter if the regular expression is not quoted with braces) interpret such sequences themselves before the regular-expression package gets to see them, -which may require doubling (quadrupling, etc.) the `\fB\e\fR'. +which may require doubling (quadrupling, etc.) the +.QW \fB\e\fR . .PP Class-shorthand escapes (AREs only) provide shorthands for certain commonly-used character classes: @@ -349,11 +439,25 @@ commonly-used character classes: \fB[^[:alnum:]_]\fR (note underscore) .RE .PP -Within bracket expressions, `\fB\ed\fR', `\fB\es\fR', and -`\fB\ew\fR'\& lose their outer brackets, and `\fB\eD\fR', `\fB\eS\fR', -and `\fB\eW\fR'\& are illegal. (So, for example, \fB[a-c\ed]\fR is -equivalent to \fB[a-c[:digit:]]\fR. Also, \fB[a-c\eD]\fR, which is -equivalent to \fB[a-c^[:digit:]]\fR, is illegal.) +Within bracket expressions, +.QW \fB\ed\fR , +.QW \fB\es\fR , +and +.QW \fB\ew\fR \& +lose their outer brackets, and +.QW \fB\eD\fR , +.QW \fB\eS\fR , +and +.QW \fB\eW\fR \& +are illegal. (So, for example, +.QW \fB[a-c\ed]\fR +is equivalent to +.QW \fB[a-c[:digit:]]\fR . +Also, +.QW \fB[a-c\eD]\fR , +which is equivalent to +.QW \fB[a-c^[:digit:]]\fR , +is illegal.) .PP A constraint escape (AREs only) is a constraint, matching the empty string if specific conditions are met, written as an escape: @@ -361,7 +465,8 @@ string if specific conditions are met, written as an escape: .TP 6 \fB\eA\fR matches only at the beginning of the string (see \fBMATCHING\fR, -below, for how this differs from `\fB^\fR') +below, for how this differs from +.QW \fB^\fR ) .TP \fB\em\fR matches only at the beginning of a word @@ -377,7 +482,8 @@ matches only at a point that is not the beginning or end of a word .TP \fB\eZ\fR matches only at the end of the string (see \fBMATCHING\fR, below, for -how this differs from `\fB$\fR') +how this differs from +.QW \fB$\fR ) .TP \fB\e\fIm\fR (where \fIm\fR is a nonzero digit) a \fIback reference\fR, see below @@ -389,14 +495,22 @@ closing capturing parentheses seen so far) a \fIback reference\fR, see below .RE .PP -A word is defined as in the specification of \fB[[:<:]]\fR and -\fB[[:>:]]\fR above. Constraint escapes are illegal within bracket -expressions. +A word is defined as in the specification of +.QW \fB[[:<:]]\fR +and +.QW \fB[[:>:]]\fR +above. Constraint escapes are illegal within bracket expressions. .PP A back reference (AREs only) matches the same string matched by the parenthesized subexpression specified by the number, so that (e.g.) -\fB([bc])\e1\fR matches \fBbb\fR or \fBcc\fR but not `\fBbc\fR'. The -subexpression must entirely precede the back reference in the RE. +.QW \fB([bc])\e1\fR +matches +.QW \fBbb\fR +or +.QW \fBcc\fR +but not +.QW \fBbc\fR . +The subexpression must entirely precede the back reference in the RE. Subexpressions are numbered in the order of their leading parentheses. Non-capturing parentheses do not define subexpressions. .PP @@ -414,15 +528,19 @@ forms and miscellaneous syntactic facilities available. .PP Normally the flavor of RE being used is specified by application-dependent means. However, this can be overridden by a -\fIdirector\fR. If an RE of any flavor begins with `\fB***:\fR', the -rest of the RE is an ARE. If an RE of any flavor begins with -`\fB***=\fR', the rest of the RE is taken to be a literal string, with +\fIdirector\fR. If an RE of any flavor begins with +.QW \fB***:\fR , +the rest of the RE is an ARE. If an RE of any flavor begins with +.QW \fB***=\fR , +the rest of the RE is taken to be a literal string, with all characters considered ordinary characters. .PP An ARE may begin with \fIembedded options\fR: a sequence -\fB(?\fIxyz\fB)\fR (where \fIxyz\fR is one or more alphabetic -characters) specifies options affecting the rest of the RE. These -supplement, and can override, any options specified by the +.QW \fB(?\fIxyz\fB)\fR +where +.QW \fIxyz\fR +is one or more alphabetic characters) specifies options affecting the rest of +the RE. These supplement, and can override, any options specified by the application. The available option letters are: .RS 2 .TP 3 @@ -448,7 +566,9 @@ newline-sensitive matching (see \fBMATCHING\fR, below) partial newline-sensitive matching (see \fBMATCHING\fR, below) .TP 3 \fBq\fR -rest of RE is a literal (``quoted'') string, all ordinary characters +rest of RE is a literal +.PQ quoted +string, all ordinary characters .TP 3 \fBs\fR non-newline-sensitive matching (usual default) @@ -457,16 +577,18 @@ non-newline-sensitive matching (usual default) tight syntax (usual default; see below) .TP 3 \fBw\fR -inverse partial newline-sensitive (``weird'') matching (see -\fBMATCHING\fR, below) +inverse partial newline-sensitive +.PQ weird +matching (see \fBMATCHING\fR, below) .TP 3 \fBx\fR expanded syntax (see below) .RE .PP -Embedded options take effect at the \fB)\fR terminating the sequence. -They are available only at the start of an ARE, and may not be used -later within it. +Embedded options take effect at the +.QW \fB)\fR +terminating the sequence. They are available only at the start of an ARE, and +may not be used later within it. .PP In addition to the usual (\fItight\fR) RE syntax, in which all characters are significant, there is an \fIexpanded\fR syntax, @@ -477,27 +599,40 @@ following newline (or the end of the RE) are ignored, permitting paragraphing and commenting a complex RE. There are three exceptions to that basic rule: .IP \(bu 3 -a white-space character or `\fB#\fR' preceded by `\fB\e\fR' is -retained +a white-space character or +.QW \fB#\fR +preceded by +.QW \fB\e\fR +is retained .IP \(bu 3 -white space or `\fB#\fR' within a bracket expression is retained +white space or +.QW \fB#\fR +within a bracket expression is retained .IP \(bu 3 white space and comments are illegal within multi-character symbols -like the ARE `\fB(?:\fR' or the BRE `\fB\e(\fR' +like the ARE +.QW \fB(?:\fR +or the BRE +.QW \fB\e(\fR .PP Expanded-syntax white-space characters are blank, tab, newline, and any character that belongs to the \fIspace\fR character class. .PP Finally, in an ARE, outside bracket expressions, the sequence -`\fB(?#\fIttt\fB)\fR' (where \fIttt\fR is any text not containing a -`\fB)\fR') is a comment, completely ignored. Again, this is not -allowed between the characters of multi-character symbols like -`\fB(?:\fR'. Such comments are more a historical artifact than a +.QW \fB(?#\fIttt\fB)\fR +(where \fIttt\fR is any text not containing a +.QW \fB)\fR ) +is a comment, completely ignored. Again, this is not allowed between the +characters of multi-character symbols like +.QW \fB(?:\fR . +Such comments are more a historical artifact than a useful facility, and their use is deprecated; use the expanded syntax instead. .PP \fINone\fR of these metasyntax extensions is available if the -application (or an initial \fB***=\fR director) has specified that the +application (or an initial +.QW \fB***=\fR +director) has specified that the user's input be treated as a literal string rather than as an RE. .SH MATCHING In the event that an RE could match more than one substring of a given @@ -508,15 +643,22 @@ substring, or the shortest. .PP Most atoms, and all constraints, have no preference. A parenthesized RE has the same preference (possibly none) as the RE. A quantified -atom with quantifier \fB{\fIm\fB}\fR or \fB{\fIm\fB}?\fR has the same +atom with quantifier +.QW \fB{\fIm\fB}\fR +or +.QW \fB{\fIm\fB}?\fR +has the same preference (possibly none) as the atom itself. A quantified atom with -other normal quantifiers (including \fB{\fIm\fB,\fIn\fB}\fR with -\fIm\fR equal to \fIn\fR) prefers longest match. A quantified atom -with other non-greedy quantifiers (including \fB{\fIm\fB,\fIn\fB}?\fR +other normal quantifiers (including +.QW \fB{\fIm\fB,\fIn\fB}\fR +with \fIm\fR equal to \fIn\fR) prefers longest match. A quantified atom +with other non-greedy quantifiers (including +.QW \fB{\fIm\fB,\fIn\fB}?\fR with \fIm\fR equal to \fIn\fR) prefers shortest match. A branch has the same preference as the first quantified atom in it which has a preference. An RE consisting of two or more branches connected by the -\fB|\fR operator prefers longest match. +.QW \fB|\fR +operator prefers longest match. .PP Subject to the constraints imposed by the rules for matching the whole RE, subexpressions also match the longest or shortest possible @@ -525,44 +667,85 @@ earlier in the RE taking priority over ones starting later. Note that outer subexpressions thus take priority over their component subexpressions. .PP -Note that the quantifiers \fB{1,1}\fR and \fB{1,1}?\fR can be used to -force longest and shortest preference, respectively, on a +Note that the quantifiers +.QW \fB{1,1}\fR +and +.QW \fB{1,1}?\fR +can be used to force longest and shortest preference, respectively, on a subexpression or a whole RE. .PP Match lengths are measured in characters, not collating elements. An empty string is considered longer than no match at all. For example, -\fBbb*\fR matches the three middle characters of `\fBabbbc\fR', -\fB(week|wee)(night|knights)\fR matches all ten characters of -`\fBweeknights\fR', when \fB(.*).*\fR is matched against \fBabc\fR the +.QW \fBbb*\fR +matches the three middle characters of +.QW \fBabbbc\fR , +.QW \fB(week|wee)(night|knights)\fR +matches all ten characters of +.QW \fBweeknights\fR , +when +.QW \fB(.*).*\fR +is matched against +.QW \fBabc\fR +the parenthesized subexpression matches all three characters, and when -\fB(a*)*\fR is matched against \fBbc\fR both the whole RE and the +.QW \fB(a*)*\fR +is matched against +.QW \fBbc\fR +both the whole RE and the parenthesized subexpression match an empty string. .PP If case-independent matching is specified, the effect is much as if all case distinctions had vanished from the alphabet. When an alphabetic that exists in multiple cases appears as an ordinary character outside a bracket expression, it is effectively transformed -into a bracket expression containing both cases, so that \fBx\fR -becomes `\fB[xX]\fR'. When it appears inside a bracket expression, +into a bracket expression containing both cases, so that +.QW \fBx\fR +becomes +.QW \fB[xX]\fR . +When it appears inside a bracket expression, all case counterparts of it are added to the bracket expression, so -that \fB[x]\fR becomes \fB[xX]\fR and \fB[^x]\fR becomes -`\fB[^xX]\fR'. -.PP -If newline-sensitive matching is specified, \fB.\fR and bracket -expressions using \fB^\fR will never match the newline character (so +that +.QW \fB[x]\fR +becomes +.QW \fB[xX]\fR +and +.QW \fB[^x]\fR +becomes +.QW \fB[^xX]\fR. +.PP +If newline-sensitive matching is specified, +.QW \fB.\fR +and bracket expressions using +.QW \fB^\fR +will never match the newline character (so that matches will never cross newlines unless the RE explicitly -arranges it) and \fB^\fR and \fB$\fR will match the empty string after +arranges it) and +.QW \fB^\fR +and +.QW \fB$\fR +will match the empty string after and before a newline respectively, in addition to matching at -beginning and end of string respectively. ARE \fB\eA\fR and \fB\eZ\fR +beginning and end of string respectively. ARE +.QW \fB\eA\fR +and +.QW \fB\eZ\fR continue to match beginning or end of string \fIonly\fR. .PP If partial newline-sensitive matching is specified, this affects -\fB.\fR and bracket expressions as with newline-sensitive matching, -but not \fB^\fR and `\fB$\fR'. +.QW \fB.\fR +and bracket expressions as with newline-sensitive matching, but not +.QW \fB^\fR +and +.QW \fB$\fR. .PP If inverse partial newline-sensitive matching is specified, this -affects \fB^\fR and \fB$\fR as with newline-sensitive matching, but -not \fB.\fR and bracket expressions. This isn't very useful but is +affects +.QW \fB^\fR +and +.QW \fB$\fR +as with newline-sensitive matching, but not +.QW \fB.\fR +and bracket expressions. This isn't very useful but is provided for symmetry. .SH "LIMITS AND COMPATIBILITY" No particular limit is imposed on the length of REs. Programs @@ -571,16 +754,21 @@ bytes, as a POSIX-compliant implementation can refuse to accept such REs. .PP The only feature of AREs that is actually incompatible with POSIX EREs -is that \fB\e\fR does not lose its special significance inside bracket +is that +.QW \fB\e\fR +does not lose its special significance inside bracket expressions. All other ARE features use syntax which is illegal or -has undefined or unspecified effects in POSIX EREs; the \fB***\fR +has undefined or unspecified effects in POSIX EREs; the +.QW \fB***\fR syntax of directors likewise is outside the POSIX syntax for both BREs and EREs. .PP Many of the ARE extensions are borrowed from Perl, but some have been changed to clean them up, and a few Perl extensions are not present. -Incompatibilities of note include `\fB\eb\fR', `\fB\eB\fR', the lack -of special treatment for a trailing newline, the addition of +Incompatibilities of note include +.QW \fB\eb\fR , +.QW \fB\eB\fR , +the lack of special treatment for a trailing newline, the addition of complemented bracket expressions to the things affected by newline-sensitive matching, the restrictions on parentheses and back references in lookahead constraints, and the longest/shortest-match @@ -594,23 +782,41 @@ as hard at guessing the user's real intentions.) Henry Spencer's original 1986 \fIregexp\fR package, still in widespread use (e.g., in pre-8.1 releases of Tcl), implemented an early version of today's EREs. There are four incompatibilities -between \fIregexp\fR's near-EREs (`RREs' for short) and AREs. In -roughly increasing order of significance: +between \fIregexp\fR's near-EREs +.PQ RRE "s for short" +and AREs. In roughly increasing order of significance: .IP \(bu 3 -In AREs, \fB\e\fR followed by an alphanumeric character is either an +In AREs, +.QW \fB\e\fR +followed by an alphanumeric character is either an escape or an error, while in RREs, it was just another way of writing the alphanumeric. This should not be a problem because there was no reason to write such a sequence in RREs. .IP \(bu 3 -\fB{\fR followed by a digit in an ARE is the beginning of a bound, -while in RREs, \fB{\fR was always an ordinary character. Such +.QW \fB{\fR +followed by a digit in an ARE is the beginning of a bound, +while in RREs, +.QW \fB{\fR +was always an ordinary character. Such sequences should be rare, and will often result in an error because following characters will not look like a valid bound. .IP \(bu 3 -In AREs, \fB\e\fR remains a special character within `\fB[\|]\fR', so -a literal \fB\e\fR within \fB[\|]\fR must be written `\fB\e\e\fR'. -\fB\e\e\fR also gives a literal \fB\e\fR within \fB[\|]\fR in RREs, -but only truly paranoid programmers routinely doubled the backslash. +In AREs, +.QW \fB\e\fR +remains a special character within +.QW \fB[\|]\fR , +so a literal +.QW \fB\e\fR +within +.QW \fB[\|]\fR +must be written +.QW \fB\e\e\fR . +.QW \fB\e\e\fR +also gives a literal +.QW \fB\e\fR +within +.QW \fB[\|]\fR +in RREs, but only truly paranoid programmers routinely doubled the backslash. .IP \(bu 3 AREs report the longest/shortest match for the RE, rather than the first found in a specified search order. This may affect some RREs @@ -622,28 +828,54 @@ complexity) but cases where the search order was exploited to deliberately find a match which was \fInot\fR the longest/shortest will need rewriting.) .SH "BASIC REGULAR EXPRESSIONS" -BREs differ from EREs in several respects. `\fB|\fR', `\fB+\fR', and -\fB?\fR are ordinary characters and there is no equivalent for their -functionality. The delimiters for bounds are \fB\e{\fR and -`\fB\e}\fR', with \fB{\fR and \fB}\fR by themselves ordinary -characters. The parentheses for nested subexpressions are \fB\e(\fR -and `\fB\e)\fR', with \fB(\fR and \fB)\fR by themselves ordinary -characters. \fB^\fR is an ordinary character except at the beginning -of the RE or the beginning of a parenthesized subexpression, \fB$\fR +BREs differ from EREs in several respects. +.QW \fB|\fR , +.QW \fB+\fR , +and +.QW \fB?\fR +are ordinary characters and there is no equivalent for their +functionality. The delimiters for bounds are +.QW \fB\e{\fR +and +.QW \fB\e}\fR , +with +.QW \fB{\fR +and +.QW \fB}\fR +by themselves ordinary characters. The parentheses for nested subexpressions +are +.QW \fB\e(\fR +and +.QW \fB\e)\fR , +with +.QW \fB(\fR +and +.QW \fB)\fR +by themselves ordinary characters. +.QW \fB^\fR +is an ordinary character except at the beginning +of the RE or the beginning of a parenthesized subexpression, +.QW \fB$\fR is an ordinary character except at the end of the RE or the end of a -parenthesized subexpression, and \fB*\fR is an ordinary character if +parenthesized subexpression, and +.QW \fB*\fR +is an ordinary character if it appears at the beginning of the RE or the beginning of a -parenthesized subexpression (after a possible leading `\fB^\fR'). -Finally, single-digit back references are available, and \fB\e<\fR and -\fB\e>\fR are synonyms for \fB[[:<:]]\fR and \fB[[:>:]]\fR +parenthesized subexpression (after a possible leading +.QW \fB^\fR ). +Finally, single-digit back references are available, and +.QW \fB\e<\fR +and +.QW \fB\e>\fR +are synonyms for +.QW \fB[[:<:]]\fR +and +.QW \fB[[:>:]]\fR respectively; no other escapes are available. - .SH "SEE ALSO" RegExp(3), regexp(n), regsub(n), lsearch(n), switch(n), text(n) - .SH KEYWORDS match, regular expression, string - -'\" Local Variables: -'\" mode: nroff -'\" End: +.\" Local Variables: +.\" mode: nroff +.\" End: @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: read.n,v 1.11 2005/05/10 18:34:02 kennykb Exp $ +'\" RCS: @(#) $Id: read.n,v 1.12 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH read n 8.1 Tcl "Tcl Built-In Commands" @@ -53,10 +53,8 @@ newline characters according to the \fB\-translation\fR option for the channel. See the \fBfconfigure\fR manual entry for a discussion on ways in which \fBfconfigure\fR will alter input. - .SH "USE WITH SERIAL PORTS" -'\" Note: this advice actually applies to many versions of Tcl - +.\" Note: this advice actually applies to many versions of Tcl For most applications a channel connected to a serial port should be configured to be nonblocking: \fBfconfigure \fIchannelId \fB\-blocking \fI0\fR. Then \fBread\fR behaves much like described above. Care @@ -80,9 +78,7 @@ set data [\fBread\fR $fl] close $fl set lines [split $data \\n] .CE - .SH "SEE ALSO" file(n), eof(n), fblocked(n), fconfigure(n), Tcl_StandardChannels(3) - .SH KEYWORDS blocking, channel, end of line, end of file, nonblocking, read, translation, encoding diff --git a/doc/regexp.n b/doc/regexp.n index 3e4ecce..99e75f3 100644 --- a/doc/regexp.n +++ b/doc/regexp.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: regexp.n,v 1.19 2005/05/10 18:34:02 kennykb Exp $ +'\" RCS: @(#) $Id: regexp.n,v 1.20 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH regexp n 8.3 Tcl "Tcl Built-In Commands" @@ -12,7 +12,6 @@ '\" Note: do not modify the .SH NAME line immediately below! .SH NAME regexp \- Match a regular expression against a string - .SH SYNOPSIS \fBregexp \fR?\fIswitches\fR? \fIexp string \fR?\fImatchVar\fR? ?\fIsubMatchVar subMatchVar ...\fR? .BE @@ -62,20 +61,37 @@ range of characters. \fB\-line\fR Enables newline-sensitive matching. By default, newline is a completely ordinary character with no special meaning. With this -flag, `[^' bracket expressions and `.' never match newline, `^' +flag, +.QW [^ +bracket expressions and +.QW . +never match newline, +.QW ^ matches an empty string after any newline in addition to its normal -function, and `$' matches an empty string before any newline in +function, and +.QW $ +matches an empty string before any newline in addition to its normal function. This flag is equivalent to specifying both \fB\-linestop\fR and \fB\-lineanchor\fR, or the \fB(?n)\fR embedded option (see the \fBre_syntax\fR manual page). .TP 15 \fB\-linestop\fR -Changes the behavior of `[^' bracket expressions and `.' so that they +Changes the behavior of +.QW [^ +bracket expressions and +.QW . +so that they stop at newlines. This is the same as specifying the \fB(?p)\fR embedded option (see the \fBre_syntax\fR manual page). .TP 15 \fB\-lineanchor\fR -Changes the behavior of `^' and `$' (the ``anchors'') so they match the +Changes the behavior of +.QW ^ +and +.QW $ +(the +.QW anchors ) +so they match the beginning and end of a line respectively. This is the same as specifying the \fB(?w)\fR embedded option (see the \fBre_syntax\fR manual page). @@ -112,7 +128,8 @@ matching the regular expression at. The \fIindex\fR value is interpreted in the same manner as the \fIindex\fR argument to \fBstring index\fR. .VE 8.5 -When using this switch, `^' +When using this switch, +.QW ^ will not match the beginning of the line, and \\A will still match the start of the string at \fIindex\fR. If \fB\-indices\fR is specified, the indices will be indexed starting from the @@ -127,8 +144,9 @@ If there are more \fIsubMatchVar\fR's than parenthesized subexpressions within \fIexp\fR, or if a particular subexpression in \fIexp\fR doesn't match the string (e.g. because it was in a portion of the expression that wasn't matched), then the corresponding -\fIsubMatchVar\fR will be set to ``\fB\-1 \-1\fR'' if \fB\-indices\fR -has been specified or to an empty string otherwise. +\fIsubMatchVar\fR will be set to +.QW "\fB\-1 \-1\fR" +if \fB\-indices\fR has been specified or to an empty string otherwise. .SH EXAMPLES Find the first occurrence of a word starting with \fBfoo\fR in a string that is not actually an instance of \fBfoobar\fR, and get the @@ -156,13 +174,10 @@ characters) in a string: .CS \fBregexp\fR \-all \-inline {\\S+} $string .CE - .SH "SEE ALSO" re_syntax(n), regsub(n), .VS 8.5 string(n) .VE - - .SH KEYWORDS match, regular expression, string diff --git a/doc/regsub.n b/doc/regsub.n index 30fd5b1..4cb8a7b 100644 --- a/doc/regsub.n +++ b/doc/regsub.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: regsub.n,v 1.17 2007/03/19 11:50:50 dkf Exp $ +'\" RCS: @(#) $Id: regsub.n,v 1.18 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH regsub n 8.3 Tcl "Tcl Built-In Commands" @@ -31,16 +31,26 @@ If there is a match, then while copying \fIstring\fR to \fIvarName\fR (or to the result of this command if \fIvarName\fR is not present) the portion of \fIstring\fR that matched \fIexp\fR is replaced with \fIsubSpec\fR. -If \fIsubSpec\fR contains a ``&'' or ``\e0'', then it is replaced -in the substitution with the portion of \fIstring\fR that +If \fIsubSpec\fR contains a +.QW & +or +.QW \e0 , +then it is replaced in the substitution with the portion of \fIstring\fR that matched \fIexp\fR. -If \fIsubSpec\fR contains a ``\e\fIn\fR'', where \fIn\fR is a digit +If \fIsubSpec\fR contains a +.QW \e\fIn\fR , +where \fIn\fR is a digit between 1 and 9, then it is replaced in the substitution with the portion of \fIstring\fR that matched the \fIn\fR-th parenthesized subexpression of \fIexp\fR. Additional backslashes may be used in \fIsubSpec\fR to prevent special -interpretation of ``&'' or ``\e0'' or ``\e\fIn\fR'' or -backslash. +interpretation of +.QW & +or +.QW \e0 +or +.QW \e\fIn\fR +or backslash. The use of backslashes in \fIsubSpec\fR tends to interact badly with the Tcl parser's use of backslashes, so it's generally safest to enclose \fIsubSpec\fR in braces if it includes @@ -55,7 +65,10 @@ All ranges in \fIstring\fR that match \fIexp\fR are found and substitution is performed for each of these ranges. Without this switch only the first matching range is found and substituted. -If \fB\-all\fR is specified, then ``&'' and ``\e\fIn\fR'' +If \fB\-all\fR is specified, then +.QW & +and +.QW \e\fIn\fR sequences are handled for each substitution using the information from the corresponding match. .TP 15 @@ -67,20 +80,36 @@ the \fB(?x)\fR embedded option (see the \fBre_syntax\fR manual page). \fB\-line\fR Enables newline-sensitive matching. By default, newline is a completely ordinary character with no special meaning. With this -flag, `[^' bracket expressions and `.' never match newline, `^' +flag, +.QW [^ +bracket expressions and +.QW . +never match newline, +.QW ^ matches an empty string after any newline in addition to its normal -function, and `$' matches an empty string before any newline in +function, and +.QW $ +matches an empty string before any newline in addition to its normal function. This flag is equivalent to specifying both \fB\-linestop\fR and \fB\-lineanchor\fR, or the \fB(?n)\fR embedded option (see the \fBre_syntax\fR manual page). .TP 15 \fB\-linestop\fR -Changes the behavior of `[^' bracket expressions and `.' so that they -stop at newlines. This is the same as specifying the \fB(?p)\fR +Changes the behavior of +.QW [^ +bracket expressions and +.QW . +so that they stop at newlines. This is the same as specifying the \fB(?p)\fR embedded option (see the \fBre_syntax\fR manual page). .TP 15 \fB\-lineanchor\fR -Changes the behavior of `^' and `$' (the ``anchors'') so they match the +Changes the behavior of +.QW ^ +and +.QW $ +(the +.QW anchors ) +so they match the beginning and end of a line respectively. This is the same as specifying the \fB(?w)\fR embedded option (see the \fBre_syntax\fR manual page). @@ -97,7 +126,8 @@ matching the regular expression at. The \fIindex\fR value is interpreted in the same manner as the \fIindex\fR argument to \fBstring index\fR. .VE 8.5 -When using this switch, `^' +When using this switch, +.QW ^ will not match the beginning of the line, and \\A will still match the start of the string at \fIindex\fR. \fIindex\fR will be constrained to the bounds of the input string. @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: scan.n,v 1.19 2007/02/18 18:42:55 dkf Exp $ +'\" RCS: @(#) $Id: scan.n,v 1.20 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH scan n 8.4 Tcl "Tcl Built-In Commands" @@ -60,7 +60,8 @@ conversion specifier and stores the result in the variable given by the next argument to \fBscan\fR. .PP If the \fB%\fR is followed by a decimal number and a \fB$\fR, as in -``\fB%2$d\fR'', then the variable to use is not taken from the next +.QW \fB%2$d\fR , +then the variable to use is not taken from the next sequential argument. Instead, it is taken from the argument indicated by the number, where 1 corresponds to the first \fIvarName\fR. If there are any positional specifiers in \fIformat\fR then all of the diff --git a/doc/source.n b/doc/source.n index 6469286..353beb3 100644 --- a/doc/source.n +++ b/doc/source.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: source.n,v 1.10 2004/10/27 14:24:37 dkf Exp $ +'\" RCS: @(#) $Id: source.n,v 1.11 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH source n "" Tcl "Tcl Built-In Commands" @@ -37,9 +37,15 @@ The end-of-file character for files is '\\32' (^Z) for all platforms. The source command will read files up to this character. This restriction does not exist for the \fBread\fR or \fBgets\fR commands, allowing for files containing code and data segments (scripted documents). -If you require a ``^Z'' in code for string comparison, you can use -``\\032'' or ``\\u001a'', which will be safely substituted by the Tcl -interpreter into ``^Z''. +If you require a +.QW ^Z +in code for string comparison, you can use +.QW \e032 +or +.QW \eu001a , +which will be safely substituted by the Tcl +interpreter into +.QW ^Z . .PP .VS 8.5 The \fB-encoding\fR option is used to specify the encoding of diff --git a/doc/subst.n b/doc/subst.n index 02f621c..b28cc18 100644 --- a/doc/subst.n +++ b/doc/subst.n @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: subst.n,v 1.9 2006/08/09 10:06:28 dkf Exp $ +'\" RCS: @(#) $Id: subst.n,v 1.10 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH subst n 7.4 Tcl "Tcl Built-In Commands" @@ -56,7 +56,9 @@ will be substituted for that entire command or variable substitution or any other return code is returned during command or variable substitution, then the returned value is substituted for that substitution. See the EXAMPLES below. In this way, all exceptional -return codes are ``caught'' by \fBsubst\fR. The \fBsubst\fR command +return codes are +.QW caught +by \fBsubst\fR. The \fBsubst\fR command itself will either return an error, or will complete successfully. .SH EXAMPLES .PP @@ -67,13 +69,19 @@ command substitutions) so the script set a 44 \fBsubst\fR {xyz {$a}} .CE -returns ``\fBxyz {44}\fR'', not ``\fBxyz {$a}\fR'' +returns +.QW "\fBxyz {44}\fR" , +not +.QW "\fBxyz {$a}\fR" and the script .CS set a "p\\} q \\{r" \fBsubst\fR {xyz {$a}} .CE -return ``\fBxyz {p} q {r}\fR'', not ``\fBxyz {p\\} q \\{r}\fR''. +return +.QW "\fBxyz {p} q {r}\fR" , +not +.QW "\fBxyz {p\\} q \\{r}\fR" . .PP When command substitution is performed, it includes any variable substitution necessary to evaluate the script. @@ -81,7 +89,11 @@ substitution necessary to evaluate the script. set a 44 \fBsubst\fR -novariables {$a [format $a]} .CE -returns ``\fB$a 44\fR'', not ``\fB$a $a\fR''. Similarly, when +returns +.QW "\fB$a 44\fR" , +not +.QW "\fB$a $a\fR" . +Similarly, when variable substitution is performed, it includes any command substitution necessary to retrieve the value of the variable. .CS @@ -89,7 +101,10 @@ proc b {} {return c} array set a {c c [b] tricky} \fBsubst\fR -nocommands {[b] $a([b])} .CE -returns ``\fB[b] c\fR'', not ``\fB[b] tricky\fR''. +returns +.QW "\fB[b] c\fR" , +not +.QW "\fB[b] tricky\fR". .PP The continue and break exceptions allow command substitutions to prevent substitution of the rest of the command substitution and the @@ -98,22 +113,35 @@ when processing text using \fIsubst\fR. For example, the script .CS \fBsubst\fR {abc,[break],def} .CE -returns ``\fBabc,\fR'', not ``\fBabc,,def\fR'' and the script +returns +.QW \fBabc,\fR , +not +.QW \fBabc,,def\fR +and the script .CS \fBsubst\fR {abc,[continue;expr {1+2}],def} .CE -returns ``\fBabc,,def\fR'', not ``\fBabc,3,def\fR''. +returns +.QW \fBabc,,def\fR , +not +.QW \fBabc,3,def\fR . .PP Other exceptional return codes substitute the returned value .CS \fBsubst\fR {abc,[return foo;expr {1+2}],def} .CE -returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR'' and +returns +.QW \fBabc,foo,def\fR , +not +.QW \fBabc,3,def\fR +and .CS \fBsubst\fR {abc,[return -code 10 foo;expr {1+2}],def} .CE -also returns ``\fBabc,foo,def\fR'', not ``\fBabc,3,def\fR''. - +also returns +.QW \fBabc,foo,def\fR , +not +.QW \fBabc,3,def\fR . .SH "SEE ALSO" Tcl(n), eval(n), break(n), continue(n) diff --git a/doc/switch.n b/doc/switch.n index bcab863..cdd15aa 100644 --- a/doc/switch.n +++ b/doc/switch.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: switch.n,v 1.10 2006/08/09 10:06:28 dkf Exp $ +'\" RCS: @(#) $Id: switch.n,v 1.11 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH switch n 8.5 Tcl "Tcl Built-In Commands" @@ -102,9 +102,12 @@ no command or variable substitutions are performed on them; this makes the behavior of the second form different than the first form in some cases. .PP -If a \fIbody\fR is specified as ``\fB\-\fR'' it means that the \fIbody\fR +If a \fIbody\fR is specified as +.QW \fB\-\fR +it means that the \fIbody\fR for the next pattern should also be used as the body for this -pattern (if the next pattern also has a body of ``\fB\-\fR'' +pattern (if the next pattern also has a body of +.QW \fB\-\fR then the body after that is used, and so on). This feature makes it possible to share a single \fIbody\fR among several patterns. diff --git a/doc/tclsh.1 b/doc/tclsh.1 index b8a73d8..cdb0ee3 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.10 2004/09/06 09:44:57 dkf Exp $ +'\" RCS: @(#) $Id: tclsh.1,v 1.11 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH tclsh 1 "" Tcl "Tcl Applications" @@ -48,7 +48,11 @@ the medium, or by the character, '\\032' ('\\u001a', control-Z). If this character is present in the file, the \fBtclsh\fR application will read text up to but not including the character. An application that requires this character in the file may safely encode it as -``\\032'', ``\\x1a'', or ``\\u001a''; or may generate it by use of commands +.QW \e032 , +.QW \ex1a , +or +.QW \eu001a ; +or may generate it by use of commands such as \fBformat\fR or \fBbinary\fR. There is no automatic evaluation of \fB.tclshrc\fR when the name of a script file is presented on the \fBtclsh\fR command @@ -123,7 +127,9 @@ device), 0 otherwise. .SH PROMPTS .PP When \fBtclsh\fR is invoked interactively it normally prompts for each -command with ``\fB% \fR''. You can change the prompt by setting the +command with +.QW "\fB% \fR" . +You can change the prompt by setting the variables \fBtcl_prompt1\fR and \fBtcl_prompt2\fR. If variable \fBtcl_prompt1\fR exists then it must consist of a Tcl script to output a prompt; instead of outputting a prompt \fBtclsh\fR diff --git a/doc/tcltest.n b/doc/tcltest.n index fb3a184..72e16ab 100644 --- a/doc/tcltest.n +++ b/doc/tcltest.n @@ -8,7 +8,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tcltest.n,v 1.48 2007/07/04 14:45:19 dkf Exp $ +'\" RCS: @(#) $Id: tcltest.n,v 1.49 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH "tcltest" n 2.3 tcltest "Tcl Bundled Packages" @@ -113,7 +113,8 @@ interface for a common usage. It is the same as \fIbody\fB -result \fIresult\fR]. All other options to [\fBtest\fR] take their default values. When \fIconstraints\fR is omitted, this form of [\fBtest\fR] can be distinguished from the first because -all \fIoption\fRs begin with ``-''. +all \fIoption\fRs begin with +.QW \- . .TP \fBloadTestedCommands\fR Evaluates in the caller's context the script specified by @@ -224,8 +225,8 @@ This allows the default values of the configuration options to be set by the environment. .TP \fBcustomMatch \fImode script\fR -Registers \fImode\fR as a new legal value of the \fB-match\fR option -to [\fBtest\fR]. When the \fB-match \fImode\fR option is +Registers \fImode\fR as a new legal value of the \fB\-match\fR option +to [\fBtest\fR]. When the \fB\-match \fImode\fR option is passed to [\fBtest\fR], the script \fIscript\fR will be evaluated to compare the actual result of evaluating the body of the test to the expected result. @@ -328,8 +329,11 @@ to [\fBtest\fR]. However, these values are not passed directly, as in the alternate forms of [\fBswitch\fR]. Instead, this form makes an unfortunate attempt to overthrow Tcl's substitution rules by performing substitutions on some of the list elements as an attempt to -implement a ``do what I mean'' interpretation of a brace-enclosed -``block''. The result is nearly impossible to document clearly, and +implement a +.QW "do what I mean" +interpretation of a brace-enclosed +.QW block . +The result is nearly impossible to document clearly, and for that reason this form is not recommended. See the examples in \fBCREATING TEST SUITES WITH TCLTEST\fR below to see that this form is really not necessary to avoid backslash-quoted newlines. @@ -345,8 +349,11 @@ which the test suite was launched. The Tcl commands [\fBcd\fR] and [\fBpwd\fR] are sufficient replacements. .TP \fBnormalizeMsg\fR \fImsg\fR -Returns the result of removing the ``extra'' newlines from \fImsg\fR, -where ``extra'' is rather imprecise. Tcl offers plenty of string +Returns the result of removing the +.QW extra +newlines from \fImsg\fR, where +.QW extra +is rather imprecise. Tcl offers plenty of string processing commands to modify strings as you wish, and [\fBcustomMatch\fR] allows flexible matching of actual and expected results. @@ -394,7 +401,7 @@ The \fIname\fR may be any string. It is conventional to choose a \fIname\fR according to the pattern: .PP .CS -\fItarget\fR-\fImajorNum\fR.\fIminorNum\fR +\fItarget\fR\-\fImajorNum\fR.\fIminorNum\fR .CE .PP For white-box (regression) tests, the target should be the name of the @@ -403,9 +410,8 @@ target should be the name of the feature being tested. Some conventions call for the names of black-box tests to have the suffix \fB_bb\fR. Related tests should share a major number. As a test suite evolves, it is best to have the same test name continue to correspond to the -same test, so that it remains meaningful to say things like ``Test -foo-1.3 passed in all releases up to 3.4, but began failing in -release 3.5.'' +same test, so that it remains meaningful to say things like +.QW "Test foo-1.3 passed in all releases up to 3.4, but began failing in release 3.5." .PP During evaluation of [\fBtest\fR], the \fIname\fR will be compared to the lists of string matching patterns returned by @@ -424,20 +430,20 @@ a bug, include the bug ID in the description. .PP Valid attributes and associated values are: .TP -\fB-constraints \fIkeywordList|expression\fR -The optional \fB-constraints\fR attribute can be list of one or more -keywords or an expression. If the \fB-constraints\fR value is a list of +\fB\-constraints \fIkeywordList|expression\fR +The optional \fB\-constraints\fR attribute can be list of one or more +keywords or an expression. If the \fB\-constraints\fR value is a list of keywords, each of these keywords should be the name of a constraint defined by a call to [\fBtestConstraint\fR]. If any of the listed constraints is false or does not exist, the test is skipped. If the -\fB-constraints\fR value is an expression, that expression +\fB\-constraints\fR value is an expression, that expression is evaluated. If the expression evaluates to true, then the test is run. -Note that the expression form of \fB-constraints\fR may interfere with the +Note that the expression form of \fB\-constraints\fR may interfere with the operation of [\fBconfigure -constraints\fR] and [\fBconfigure -limitconstraints\fR], and is not recommended. Appropriate constraints should be added to any tests that should not always be run. That is, conditional evaluation of a test -should be accomplished by the \fB-constraints\fR option, not by +should be accomplished by the \fB\-constraints\fR option, not by conditional evaluation of [\fBtest\fR]. In that way, the same number of tests are always reported by the test suite, though the number skipped may change based on the testing environment. @@ -445,65 +451,65 @@ The default value is an empty list. See \fBTEST CONSTRAINTS\fR below for a list of built-in constraints and information on how to add your own constraints. .TP -\fB-setup \fIscript\fR -The optional \fB-setup\fR attribute indicates a \fIscript\fR that will be run -before the script indicated by the \fB-body\fR attribute. If evaluation +\fB\-setup \fIscript\fR +The optional \fB\-setup\fR attribute indicates a \fIscript\fR that will be run +before the script indicated by the \fB\-body\fR attribute. If evaluation of \fIscript\fR raises an error, the test will fail. The default value is an empty script. .TP -\fB-body \fIscript\fR -The \fB-body\fR attribute indicates the \fIscript\fR to run to carry out the +\fB\-body \fIscript\fR +The \fB\-body\fR attribute indicates the \fIscript\fR to run to carry out the test. It must return a result that can be checked for correctness. If evaluation of \fIscript\fR raises an error, the test will fail. The default value is an empty script. .TP -\fB-cleanup \fIscript\fR -The optional \fB-cleanup\fR attribute indicates a \fIscript\fR that will be -run after the script indicated by the \fB-body\fR attribute. +\fB\-cleanup \fIscript\fR +The optional \fB\-cleanup\fR attribute indicates a \fIscript\fR that will be +run after the script indicated by the \fB\-body\fR attribute. If evaluation of \fIscript\fR raises an error, the test will fail. The default value is an empty script. .TP -\fB-match \fImode\fR -The \fB-match\fR attribute determines how expected answers supplied by -\fB-result\fR, \fB-output\fR, and \fB-errorOutput\fR are compared. Valid +\fB\-match \fImode\fR +The \fB\-match\fR attribute determines how expected answers supplied by +\fB\-result\fR, \fB\-output\fR, and \fB\-errorOutput\fR are compared. Valid values for \fImode\fR are \fBregexp\fR, \fBglob\fR, \fBexact\fR, and any value registered by a prior call to [\fBcustomMatch\fR]. The default value is \fBexact\fR. .TP -\fB-result \fIexpectedValue\fR -The \fB-result\fR attribute supplies the \fIexpectedValue\fR against which +\fB\-result \fIexpectedValue\fR +The \fB\-result\fR attribute supplies the \fIexpectedValue\fR against which the return value from script will be compared. The default value is an empty string. .TP -\fB-output \fIexpectedValue\fR -The \fB-output\fR attribute supplies the \fIexpectedValue\fR against which +\fB\-output \fIexpectedValue\fR +The \fB\-output\fR attribute supplies the \fIexpectedValue\fR against which any output sent to \fBstdout\fR or [\fBoutputChannel\fR] during evaluation of the script(s) will be compared. Note that only output printed using -[\fB::puts\fR] is used for comparison. If \fB-output\fR is not specified, +[\fB::puts\fR] is used for comparison. If \fB\-output\fR is not specified, output sent to \fBstdout\fR and [\fBoutputChannel\fR] is not processed for comparison. .TP -\fB-errorOutput \fIexpectedValue\fR -The \fB-errorOutput\fR attribute supplies the \fIexpectedValue\fR against +\fB\-errorOutput \fIexpectedValue\fR +The \fB\-errorOutput\fR attribute supplies the \fIexpectedValue\fR against which any output sent to \fBstderr\fR or [\fBerrorChannel\fR] during evaluation of the script(s) will be compared. Note that only output -printed using [\fB::puts\fR] is used for comparison. If \fB-errorOutput\fR +printed using [\fB::puts\fR] is used for comparison. If \fB\-errorOutput\fR is not specified, output sent to \fBstderr\fR and [\fBerrorChannel\fR] is not processed for comparison. .TP -\fB-returnCodes \fIexpectedCodeList\fR -The optional \fB-returnCodes\fR attribute supplies \fIexpectedCodeList\fR, +\fB\-returnCodes \fIexpectedCodeList\fR +The optional \fB\-returnCodes\fR attribute supplies \fIexpectedCodeList\fR, a list of return codes that may be accepted from evaluation of the -\fB-body\fR script. If evaluation of the \fB-body\fR script returns +\fB\-body\fR script. If evaluation of the \fB\-body\fR script returns a code not in the \fIexpectedCodeList\fR, the test fails. All return codes known to [\fBreturn\fR], in both numeric and symbolic form, including extended return codes, are acceptable elements in the \fIexpectedCodeList\fR. Default value is \fB{ok return}\fR. .PP -To pass, a test must successfully evaluate its \fB-setup\fR, \fB-body\fR, -and \fB-cleanup\fR scripts. The return code of the \fB-body\fR script and +To pass, a test must successfully evaluate its \fB\-setup\fR, \fB\-body\fR, +and \fB\-cleanup\fR scripts. The return code of the \fB\-body\fR script and its result must match expected values, and if specified, output and error -data from the test must match expected \fB-output\fR and \fB-errorOutput\fR +data from the test must match expected \fB\-output\fR and \fB\-errorOutput\fR values. If any of these conditions are not met, then the test fails. Note that all scripts are evaluated in the context of the caller of [\fBtest\fR]. @@ -518,24 +524,24 @@ below. Any output produced by the test scripts themselves should be produced using [\fB::puts\fR] to [\fBoutputChannel\fR] or [\fBerrorChannel\fR], so that users of the test suite may easily capture output with the [\fBconfigure -outfile\fR] and -[\fBconfigure -errfile\fR] options, and so that the \fB-output\fR -and \fB-errorOutput\fR attributes work properly. +[\fBconfigure -errfile\fR] options, and so that the \fB\-output\fR +and \fB\-errorOutput\fR attributes work properly. .SH "TEST CONSTRAINTS" .PP Constraints are used to determine whether or not a test should be skipped. Each constraint has a name, which may be any string, and a boolean -value. Each [\fBtest\fR] has a \fB-constraints\fR value which is a +value. Each [\fBtest\fR] has a \fB\-constraints\fR value which is a list of constraint names. There are two modes of constraint control. Most frequently, the default mode is used, indicated by a setting of [\fBconfigure -limitconstraints\fR] to false. The test will run only if all constraints in the list are true-valued. Thus, -the \fB-constraints\fR option of [\fBtest\fR] is a convenient, symbolic +the \fB\-constraints\fR option of [\fBtest\fR] is a convenient, symbolic way to define any conditions required for the test to be possible or -meaningful. For example, a [\fBtest\fR] with \fB-constraints unix\fR +meaningful. For example, a [\fBtest\fR] with \fB\-constraints unix\fR will only be run if the constraint \fBunix\fR is true, which indicates the test suite is being run on a Unix platform. .PP -Each [\fBtest\fR] should include whatever \fB-constraints\fR are +Each [\fBtest\fR] should include whatever \fB\-constraints\fR are required to constrain it to run only where appropriate. Several constraints are pre-defined in the \fBtcltest\fR package, listed below. The registration of user-defined constraints is performed @@ -736,12 +742,12 @@ command. The [\fBconfigure\fR] command is used to set and query the configurable options of \fBtcltest\fR. The valid options are: .TP -\fB-singleproc \fIboolean\fR +\fB\-singleproc \fIboolean\fR Controls whether or not [\fBrunAllTests\fR] spawns a child process for each test file. No spawning when \fIboolean\fR is true. Default value is false. .TP -\fB-debug \fIlevel\fR +\fB\-debug \fIlevel\fR Sets the debug level to \fIlevel\fR, an integer value indicating how much debugging information should be printed to stdout. Note that debug messages always go to stdout, independent of the value of @@ -765,7 +771,7 @@ Display information regarding what individual procs in the test harness are doing. .RE .TP -\fB-verbose \fIlevel\fR +\fB\-verbose \fIlevel\fR Sets the type of output verbosity desired to \fIlevel\fR, a list of zero or more of the elements \fBbody\fR, \fBpass\fR, \fBskip\fR, \fBstart\fR, \fBerror\fR and \fBline\fR. Default value @@ -790,7 +796,7 @@ The single letter abbreviations noted above are also recognized so that [\fBconfigure -verbose pt\fR] is the same as [\fBconfigure -verbose {pass start}\fR]. .TP -\fB-preservecore \fIlevel\fR +\fB\-preservecore \fIlevel\fR Sets the core preservation level to \fIlevel\fR. This level determines how stringent checks for core files are. Default value is 0. Levels are defined as: @@ -806,69 +812,69 @@ Check for core files at all times described above, and save a copy of each core file produced in [\fBconfigure -tmpdir\fR]. .RE .TP -\fB-limitconstraints \fIboolean\fR +\fB\-limitconstraints \fIboolean\fR Sets the mode by which [\fBtest\fR] honors constraints as described in \fBTESTS\fR above. Default value is false. .TP -\fB-constraints \fIlist\fR +\fB\-constraints \fIlist\fR Sets all the constraints in \fIlist\fR to true. Also used in combination with [\fBconfigure -limitconstraints true\fR] to control an alternative constraint mode as described in \fBTESTS\fR above. Default value is an empty list. .TP -\fB-tmpdir \fIdirectory\fR +\fB\-tmpdir \fIdirectory\fR Sets the temporary directory to be used by [\fBmakeFile\fR], [\fBmakeDirectory\fR], [\fBviewFile\fR], [\fBremoveFile\fR], and [\fBremoveDirectory\fR] as the default directory where temporary files and directories created by test files should be created. Default value is [\fBworkingDirectory\fR]. .TP -\fB-testdir \fIdirectory\fR +\fB\-testdir \fIdirectory\fR Sets the directory searched by [\fBrunAllTests\fR] for test files and subdirectories. Default value is [\fBworkingDirectory\fR]. .TP -\fB-file \fIpatternList\fR +\fB\-file \fIpatternList\fR Sets the list of patterns used by [\fBrunAllTests\fR] to determine what test files to evaluate. Default value is \fB*.test\fR. .TP -\fB-notfile \fIpatternList\fR +\fB\-notfile \fIpatternList\fR Sets the list of patterns used by [\fBrunAllTests\fR] to determine what test files to skip. Default value is \fBl.*.test\fR, so that any SCCS lock files are skipped. .TP -\fB-relateddir \fIpatternList\fR +\fB\-relateddir \fIpatternList\fR Sets the list of patterns used by [\fBrunAllTests\fR] to determine what subdirectories to search for an \fBall.tcl\fR file. Default value is \fB*\fR. .TP -\fB-asidefromdir \fIpatternList\fR +\fB\-asidefromdir \fIpatternList\fR Sets the list of patterns used by [\fBrunAllTests\fR] to determine what subdirectories to skip when searching for an \fBall.tcl\fR file. Default value is an empty list. .TP -\fB-match \fIpatternList\fR +\fB\-match \fIpatternList\fR Set the list of patterns used by [\fBtest\fR] to determine whether a test should be run. Default value is \fB*\fR. .TP -\fB-skip \fIpatternList\fR +\fB\-skip \fIpatternList\fR Set the list of patterns used by [\fBtest\fR] to determine whether a test should be skipped. Default value is an empty list. .TP -\fB-load \fIscript\fR +\fB\-load \fIscript\fR Sets a script to be evaluated by [\fBloadTestedCommands\fR]. Default value is an empty script. .TP -\fB-loadfile \fIfilename\fR +\fB\-loadfile \fIfilename\fR Sets the filename from which to read a script to be evaluated by [\fBloadTestedCommands\fR]. This is an alternative to -\fB-load\fR. They cannot be used together. +\fB\-load\fR. They cannot be used together. .TP -\fB-outfile \fIfilename\fR +\fB\-outfile \fIfilename\fR Sets the file to which all output produced by tcltest should be written. A file named \fIfilename\fR will be [\fBopen\fR]ed for writing, and the resulting channel will be set as the value of [\fBoutputChannel\fR]. .TP -\fB-errfile \fIfilename\fR +\fB\-errfile \fIfilename\fR Sets the file to which all error output produced by tcltest should be written. A file named \fIfilename\fR will be [\fBopen\fR]ed for writing, and the resulting channel will be set as the value @@ -966,12 +972,12 @@ if $myRequirement { .CE .RE .PP -Use the \fB-setup\fR and \fB-cleanup\fR options to establish and release +Use the \fB\-setup\fR and \fB\-cleanup\fR options to establish and release all context requirements of the test body. Do not make tests depend on prior tests in the file. Those prior tests might be skipped. If several consecutive tests require the same context, the appropriate setup and cleanup scripts may be stored in variable for passing to each tests -\fB-setup\fR and \fB-cleanup\fR options. This is a better solution than +\fB\-setup\fR and \fB\-cleanup\fR options. This is a better solution than performing setup outside of [\fBtest\fR] commands, because the setup will only be done if necessary, and any errors during setup will be reported, and not cause the test file to abort. @@ -1093,7 +1099,7 @@ depends on usage of ::puts in your application code. Output is intercepted by redefining the ::puts command while the defined test script is being run. Errors thrown by C procedures or printed directly from C applications will not be caught by the test command. -Therefore, usage of the \fB-output\fR and \fB-errorOutput\fR +Therefore, usage of the \fB\-output\fR and \fB\-errorOutput\fR options to [\fBtest\fR] is useful only for pure Tcl applications that use [\fB::puts\fR] to produce output. .SH KEYWORDS diff --git a/doc/tclvars.n b/doc/tclvars.n index 6b59a3a..16f684e 100644 --- a/doc/tclvars.n +++ b/doc/tclvars.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tclvars.n,v 1.27 2007/02/18 18:42:55 dkf Exp $ +'\" RCS: @(#) $Id: tclvars.n,v 1.28 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH tclvars n 8.0 Tcl "Tcl Built-In Commands" @@ -39,8 +39,11 @@ variables. .RS Under Windows, the environment variables PATH and COMSPEC in any capitalization are converted automatically to upper case. For instance, the -PATH variable could be exported by the operating system as ``path'', -``Path'', ``PaTh'', etc., causing otherwise simple Tcl code to have to +PATH variable could be exported by the operating system as +.QW path , +.QW Path , +.QW PaTh , +etc., causing otherwise simple Tcl code to have to support many special cases. All other environment variables inherited by Tcl are left unmodified. Setting an env array variable to blank is the same as unsetting it as this is the behavior of the underlying Windows OS. @@ -78,7 +81,8 @@ The \fIsigName\fR element will be the symbolic name of the signal that caused the process to terminate; it will be one of the names from the include file signal.h, such as \fBSIGPIPE\fR. The \fImsg\fR element will be a short human-readable message -describing the signal, such as ``write on pipe with no readers'' +describing the signal, such as +.QW "write on pipe with no readers" for \fBSIGPIPE\fR. .TP \fBCHILDSTATUS\fI pid code\fR @@ -95,7 +99,8 @@ The \fIsigName\fR element will be the symbolic name of the signal that caused the process to suspend; this will be one of the names from the include file signal.h, such as \fBSIGTTIN\fR. The \fImsg\fR element will be a short human-readable message -describing the signal, such as ``background tty read'' +describing the signal, such as +.QW "background tty read" for \fBSIGTTIN\fR. .TP \fBNONE\fR @@ -113,7 +118,8 @@ of the error that occurred, such as \fBENOENT\fR; this will be one of the values defined in the include file errno.h. The \fImsg\fR element will be a human-readable message corresponding to \fIerrName\fR, such as -``no such file or directory'' for the \fBENOENT\fR case. +.QW "no such file or directory" +for the \fBENOENT\fR case. .PP To set the \fB-errorcode\fR return option, applications should use library procedures such as \fBTcl_SetObjErrorCode\fR, \fBTcl_SetReturnOptions\fR, @@ -263,7 +269,9 @@ binary number. .VE 8.5 .PP .RS -17 digits is ``perfect'' for IEEE floating-point in that it allows +17 digits is +.QW perfect +for IEEE floating-point in that it allows double-precision values to be converted to strings and back to binary with no loss of information. However, using 17 digits prevents any rounding, which produces longer, less intuitive results. For example, @@ -334,7 +342,9 @@ This variable and functionality only exist if .TP \fBtcl_wordchars\fR The value of this variable is a regular expression that can be set to -control what are considered ``word'' characters, for instances like +control what are considered +.QW word +characters, for instances like selecting a word by double-clicking in text in Tk. It is platform dependent. On Windows, it defaults to \fB\\S\fR, meaning anything but a Unicode space character. Otherwise it defaults to \fB\\w\fR, @@ -342,7 +352,9 @@ which is any Unicode word character (number, letter, or underscore). .TP \fBtcl_nonwordchars\fR The value of this variable is a regular expression that can be set to -control what are considered ``non-word'' characters, for instances like +control what are considered +.QW non-word +characters, for instances like selecting a word by double-clicking in text in Tk. It is platform dependent. On Windows, it defaults to \fB\\s\fR, meaning any Unicode space character. Otherwise it defaults to \fB\\W\fR, which is anything but a @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: tm.n,v 1.6 2007/02/18 18:42:55 dkf Exp $ +'\" RCS: @(#) $Id: tm.n,v 1.7 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH tm n 8.5 Tcl "Tcl Built-In Commands" @@ -56,8 +56,11 @@ that they are searched for modules. .TP \fB::tcl::tm::roots\fR \fIpath\fR... Similar to \fBpath add\fR, and layered on top of it. This command -takes a list of paths, extends each with "\fBtcl\fIX\fB/site-tcl\fR", -and "\fBtcl\fIX\fB/\fIX\fB.\fIy\fR", for major version \fIX\fR of the +takes a list of paths, extends each with +.QW "\fBtcl\fIX\fB/site-tcl\fR" , +and +.QW "\fBtcl\fIX\fB/\fIX\fB.\fIy\fR" , +for major version \fIX\fR of the Tcl interpreter and minor version \fIy\fR less than or equal to the minor version of the interpreter, and adds the resulting set of paths to the list of paths to search. @@ -112,22 +115,37 @@ For any two directories, neither is an ancestor directory of the other. .PP This is required to avoid ambiguities in package naming. If for -example the two directories "\fIfoo/\fR" and "\fIfoo/cool\fR" were on -the path a package named \fBcool::ice\fR could be found via the -names \fBcool::ice\fR or \fBice\fR, the latter potentially -obscuring a package named \fBice\fR, unqualified. +example the two directories +.QW \fIfoo/\fR +and +.QW \fIfoo/cool\fR +were on +the path a package named +.QW \fBcool::ice\fR +could be found via the names +.QW \fBcool::ice\fR +or +.QW \fBice\fR , +the latter potentially obscuring a package named +.QW \fBice\fR , +unqualified. .PP Before the search is started, the name of the requested package is translated into a partial path, using the following algorithm: .IP -All occurrences of "\fB::\fR" in the package name are replaced by -the appropriate directory separator character for the platform we are -on. On Unix, for example, this is "\fB/\fR". +All occurrences of +.QW \fB::\fR +in the package name are replaced by the appropriate directory +separator character for the platform we are on. On Unix, for example, +this is +.QW \fB/\fR . .PP Example: .IP -The requested package is \fBencoding::base64\fR. The generated -partial path is "\fIencoding/base64\fR" +The requested package is +.QW \fBencoding::base64\fR . +The generated partial path is +.QW \fIencoding/base64\fR .PP After this translation the package is looked for in all module paths, by combining them one-by-one, first to last with the partial path to @@ -162,7 +180,8 @@ below: .PP Where \fBPNAME'\fR is the partial path of the module as defined in section \fBFINDING MODULES\fR, and translated into \fB\fRPNAME by -changing all directory separators to "\fB::\fR", +changing all directory separators to +.QW \fB::\fR , and \fBmodule_path\fR is the path (from the list of paths to search) that we found the module file under. .PP @@ -253,13 +272,11 @@ environment variables: \fB$::env(TCL8.0_TM_PATH)\fR .CE .RE - .SH "SEE ALSO" -package(n), Tcl Improvement Proposal #189 "\fITcl Modules\fR" (online -at http://tip.tcl.tk/189.html), Tcl Improvement Proposal #190 -"\fIImplementation Choices for Tcl Modules\fR" (online at -http://tip.tcl.tk/190.html) - - +package(n), Tcl Improvement Proposal #189 +.QW "\fITcl Modules\fR" +(online at http://tip.tcl.tk/189.html), Tcl Improvement Proposal #190 +.QW "\fIImplementation Choices for Tcl Modules\fR" +(online at http://tip.tcl.tk/190.html) .SH "KEYWORDS" modules, package diff --git a/doc/update.n b/doc/update.n index ebe89d4..76f3188 100644 --- a/doc/update.n +++ b/doc/update.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: update.n,v 1.6 2004/11/20 00:17:32 dgp Exp $ +'\" RCS: @(#) $Id: update.n,v 1.7 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH update n 7.5 Tcl "Tcl Built-In Commands" @@ -19,7 +19,8 @@ update \- Process pending events and idle callbacks .SH DESCRIPTION .PP -This command is used to bring the application ``up to date'' +This command is used to bring the application +.QW "up to date" by entering the event loop repeatedly until all pending events (including idle callbacks) have been processed. .PP diff --git a/doc/uplevel.n b/doc/uplevel.n index 506b713..3de309a 100644 --- a/doc/uplevel.n +++ b/doc/uplevel.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: uplevel.n,v 1.6 2006/02/01 19:26:01 dgp Exp $ +'\" RCS: @(#) $Id: uplevel.n,v 1.7 2007/10/24 14:29:39 dkf Exp $ '\" .so man.macros .TH uplevel n "" Tcl "Tcl Built-In Commands" @@ -55,8 +55,9 @@ the command .CE then the \fBset\fR command will modify the same variable \fBx\fR in \fBb\fR's context: the procedure \fBc\fR does not appear to be on the call stack -when \fBd\fR is executing. The command ``\fBinfo level\fR'' may -be used to obtain the level of the current procedure. +when \fBd\fR is executing. The command +.QW "\fBinfo level\fR" +may be used to obtain the level of the current procedure. .PP \fBUplevel\fR makes it possible to implement new control constructs as Tcl procedures (for example, \fBuplevel\fR could @@ -92,9 +93,7 @@ proc do {body while condition} { } } .CE - .SH "SEE ALSO" apply(n), namespace(n), upvar(n) - .SH KEYWORDS context, level, namespace, stack frame, variables |