diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/array.n | 13 | ||||
| -rw-r--r-- | doc/clock.n | 13 | ||||
| -rw-r--r-- | doc/lindex.n | 4 | ||||
| -rw-r--r-- | doc/linsert.n | 22 | ||||
| -rw-r--r-- | doc/msgcat.n | 4 | ||||
| -rw-r--r-- | doc/regexp.n | 15 | ||||
| -rw-r--r-- | doc/regsub.n | 15 | ||||
| -rw-r--r-- | doc/switch.n | 11 |
8 files changed, 70 insertions, 27 deletions
diff --git a/doc/array.n b/doc/array.n index 42fc193..2a5b1fc 100644 --- a/doc/array.n +++ b/doc/array.n @@ -5,10 +5,10 @@ '\" 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.3 1999/08/09 16:30:35 hobbs Exp $ +'\" RCS: @(#) $Id: array.n,v 1.4 1999/09/21 04:20:35 hobbs Exp $ '\" .so man.macros -.TH array n 7.4 Tcl "Tcl Built-In Commands" +.TH array n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -111,6 +111,15 @@ The return value is a search identifier that must be used in \fBarray nextelement\fR and \fBarray donesearch\fR commands; it allows multiple searches to be underway simultaneously for the same array. +.VS 8.3 +.TP +\fBarray unset \fIarrayName\fR ?\fIpattern\fR? +Unsets all of the elements in the array that match \fIpattern\fR (using the +matching rules of \fBstring match\fR). If \fIarrayName\fR isn't the name +of an array variable or there are no matching elements in the array, then +an empty string is returned. If \fIpattern\fR is omitted and is it an +array variable, then the command unsets the entire array. +.VE 8.3 .SH KEYWORDS array, element names, search diff --git a/doc/clock.n b/doc/clock.n index 168d0c0..ed3daa9 100644 --- a/doc/clock.n +++ b/doc/clock.n @@ -1,6 +1,7 @@ '\" '\" Copyright (c) 1992-1995 Karl Lehenbauer and Mark Diekhans. '\" Copyright (c) 1995-1997 Sun Microsystems, Inc. +'\" Copyright (c) 1998-1999 Scriptics Corporation '\" '\" This documentation is derived from the time and date facilities of '\" TclX, by Mark Diekhans and Karl Lehenbauer. @@ -8,10 +9,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: clock.n,v 1.3 1999/08/09 16:30:35 hobbs Exp $ +'\" RCS: @(#) $Id: clock.n,v 1.4 1999/09/21 04:20:35 hobbs Exp $ '\" .so man.macros -.TH clock n 7.4 Tcl "Tcl Built-In Commands" +.TH clock n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -28,12 +29,16 @@ time. The \fIoption\fR argument determines what action is carried out by the command. The legal \fIoptions\fR (which may be abbreviated) are: .TP -\fBclock clicks\fR +.VS 8.3 +\fBclock clicks\fR ?\fB\-milliseconds\fR? Return a high-resolution time value as a system-dependent integer value. The unit of the value is system-dependent but should be the highest resolution clock available on the system such as a CPU cycle -counter. This value should only be used for the relative measurement +counter. If \fB\-milliseconds\fR is specified, then the value is +guaranteed to be of millisecond granularity. +This value should only be used for the relative measurement of elapsed time. +.VE 8.3 .TP \fBclock format \fIclockValue\fR ?\fB\-format \fIstring\fR? ?\fB\-gmt \fIboolean\fR? Converts an integer time value, typically returned by diff --git a/doc/lindex.n b/doc/lindex.n index 58bc2b5..70cf1cf 100644 --- a/doc/lindex.n +++ b/doc/lindex.n @@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: lindex.n,v 1.3 1999/08/09 16:30:35 hobbs Exp $ +'\" RCS: @(#) $Id: lindex.n,v 1.4 1999/09/21 04:20:36 hobbs Exp $ '\" .so man.macros -.TH lindex n 7.4 Tcl "Tcl Built-In Commands" +.TH lindex n 8.2 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME diff --git a/doc/linsert.n b/doc/linsert.n index 4877e03..69d7f4a 100644 --- a/doc/linsert.n +++ b/doc/linsert.n @@ -5,10 +5,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: linsert.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ +'\" RCS: @(#) $Id: linsert.n,v 1.3 1999/09/21 04:20:36 hobbs Exp $ '\" .so man.macros -.TH linsert n 7.4 Tcl "Tcl Built-In Commands" +.TH linsert n 8.2 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -19,15 +19,15 @@ linsert \- Insert elements into a list .SH DESCRIPTION .PP -This command produces a new list from \fIlist\fR by inserting all -of the \fIelement\fR arguments just before the \fIindex\fRth -element of \fIlist\fR. Each \fIelement\fR argument will become -a separate element of the new list. If \fIindex\fR is less than -or equal to zero, then the new elements are inserted at the -beginning of the list. If \fIindex\fR -has the value \fBend\fR, -or if it is greater than or equal to the number of elements in the list, -then the new elements are appended to the list. +This command produces a new list from \fIlist\fR by inserting all of the +\fIelement\fR arguments just before the \fIindex\fRth element of +\fIlist\fR. Each \fIelement\fR argument will become a separate element of +the new list. If \fIindex\fR is less than or equal to zero, then the new +elements are inserted at the beginning of the list. If \fIindex\fR has the +value \fBend\fR, or if it is greater than or equal to the number of +elements in the list, then the new elements are appended to the list. +\fBend\-\fIinteger\fR refers to the last element in the list minus the +specified integer offset. .SH KEYWORDS element, insert, list diff --git a/doc/msgcat.n b/doc/msgcat.n index 02f4085..748d023 100644 --- a/doc/msgcat.n +++ b/doc/msgcat.n @@ -191,8 +191,8 @@ format "In location %s we produced %d units" $city $num This can be handled by using the positional parameters: .CS -format "We produced %1\\\\$d units in location %2\\\\$s" $num $city -format "In location %2\\\\$s we produced %1\\\\$d units" $num $city +format "We produced %1\\$d units in location %2\\$s" $num $city +format "In location %2\\$s we produced %1\\$d units" $num $city .CE .PP Similarly, positional parameters can be used with \fBscan\fR to diff --git a/doc/regexp.n b/doc/regexp.n index 03010e3..3b19420 100644 --- a/doc/regexp.n +++ b/doc/regexp.n @@ -4,10 +4,10 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: regexp.n,v 1.6 1999/06/24 21:15:13 jpeek Exp $ +'\" RCS: @(#) $Id: regexp.n,v 1.7 1999/09/21 04:20:36 hobbs Exp $ '\" .so man.macros -.TH regexp n 8.1 Tcl "Tcl Built-In Commands" +.TH regexp n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -83,6 +83,17 @@ element of the list is a subexpression count. The second element is a list of property names that describe various attributes of the regular expression. This switch is primarily intended for debugging purposes. .VE 8.1 +.VS 8.3 +.TP 15 +\fB\-start\fR \fIindex\fR +Specifies a character index offset into the string to start +matching the regular expression at. When using this switch, `^' +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 +absolute beginning of the input string. +\fIindex\fR will be constrained to the bounds of the input string. +.VE 8.3 .TP 15 \fB\-\|\-\fR Marks the end of switches. The argument following this one will diff --git a/doc/regsub.n b/doc/regsub.n index 65c22a6..b895bdb 100644 --- a/doc/regsub.n +++ b/doc/regsub.n @@ -5,10 +5,10 @@ '\" 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.3 1999/06/24 21:15:13 jpeek Exp $ +'\" RCS: @(#) $Id: regsub.n,v 1.4 1999/09/21 04:20:36 hobbs Exp $ '\" .so man.macros -.TH regsub n 7.4 Tcl "Tcl Built-In Commands" +.TH regsub n 8.3 Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -60,6 +60,17 @@ from the corresponding match. Upper-case characters in \fIstring\fR will be converted to lower-case before matching against \fIexp\fR; however, substitutions specified by \fIsubSpec\fR use the original unconverted form of \fIstring\fR. +.VS 8.3 +.TP 10 +\fB\-start\fR \fIindex\fR +Specifies a character index offset into the string to start +matching the regular expression at. When using this switch, `^' +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 +absolute beginning of the input string. +\fIindex\fR will be constrained to the bounds of the input string. +.VE 8.3 .TP 10 \fB\-\|\-\fR Marks the end of switches. The argument following this one will diff --git a/doc/switch.n b/doc/switch.n index fb7ac60..c454a3d 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.3 1999/06/24 21:15:14 jpeek Exp $ +'\" RCS: @(#) $Id: switch.n,v 1.4 1999/09/21 04:20:36 hobbs Exp $ '\" .so man.macros .TH switch n 7.0 Tcl "Tcl Built-In Commands" @@ -75,6 +75,10 @@ then the body after that is used, and so on). This feature makes it possible to share a single \fIbody\fR among several patterns. .PP +Beware of how you place comments in \fBswitch\fR commands. Comments +should only be placed \fBinside\fR the execution body of one of the +patterns, and not intermingled with the patterns. +.PP Below are some examples of \fBswitch\fR commands: .CS \fBswitch\0abc\0a\0\-\0b\0{format 1}\0abc\0{format 2}\0default\0{format 3}\fR @@ -94,7 +98,10 @@ will return \fB1\fR, and a \- b - {format 1} + { + # Correct Comment Placement + format 1 + } a* {format 2} default |