diff options
Diffstat (limited to 'doc/unset.n')
| -rw-r--r-- | doc/unset.n | 48 |
1 files changed, 41 insertions, 7 deletions
diff --git a/doc/unset.n b/doc/unset.n index 6073256..8b63959 100644 --- a/doc/unset.n +++ b/doc/unset.n @@ -1,22 +1,20 @@ '\" '\" Copyright (c) 1993 The Regents of the University of California. '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. +'\" Copyright (c) 2000 Ajuba Solutions. '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" SCCS: @(#) unset.n 1.5 96/03/25 20:26:21 -'\" +.TH unset n 8.4 Tcl "Tcl Built-In Commands" .so man.macros -.TH unset n "" Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME unset \- Delete variables .SH SYNOPSIS -\fBunset \fIname \fR?\fIname name ...\fR? +\fBunset \fR?\fB\-nocomplain\fR? ?\fB\-\-\fR? ?\fIname name name ...\fR? .BE - .SH DESCRIPTION .PP This command removes one or more variables. @@ -27,8 +25,44 @@ element is removed without affecting the rest of the array. If a \fIname\fR consists of an array name with no parenthesized index, then the entire array is deleted. The \fBunset\fR command returns an empty string as result. -An error occurs if any of the variables doesn't exist, and any variables -after the non-existent one are not deleted. +If \fB\-nocomplain\fR is specified as the first argument, any possible +errors are suppressed. The option may not be abbreviated, in order to +disambiguate it from possible variable names. The option \fB\-\-\fR +indicates the end of the options, and should be used if you wish to +remove a variable with the same name as any of the options. +If an error occurs during variable deletion, any variables after the named one +causing the error are not +deleted. An error can occur when the named variable does not exist, or the +name refers to an array element but the variable is a scalar, or the name +refers to a variable in a non-existent namespace. +.SH EXAMPLE +.PP +Create an array containing a mapping from some numbers to their +squares and remove the array elements for non-prime numbers: +.PP +.CS +array set squares { + 1 1 6 36 + 2 4 7 49 + 3 9 8 64 + 4 16 9 81 + 5 25 10 100 +} + +puts "The squares are:" +parray squares + +\fBunset\fR squares(1) squares(4) squares(6) +\fBunset\fR squares(8) squares(9) squares(10) +puts "The prime squares are:" +parray squares +.CE +.SH "SEE ALSO" +set(n), trace(n), upvar(n) .SH KEYWORDS remove, variable +'\" Local Variables: +'\" mode: nroff +'\" fill-column: 78 +'\" End: |