summaryrefslogtreecommitdiffstats
path: root/doc/unset.n
blob: 655ec0ffb84878ed0036f18d5b7e2f3b9cd466af (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
'\"

'\" 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.

'\" 
'\" RCS: @(#) $Id: unset.n,v 1.11 2007/10/29 01:42:19 dkf Exp $

'\" 
.so man.macros
.TH unset n 8.4 Tcl "Tcl Built-In Commands"
.BS
'\" Note:  do not modify the .SH NAME line immediately below!

.SH NAME

unset \- Delete variables

.SH SYNOPSIS

\fBunset \fR?\fI\-nocomplain\fR? ?\fI\-\-\fR? ?\fIname name name ...\fR?

.BE

.SH DESCRIPTION

.PP

This command removes one or more variables.

Each \fIname\fR is a variable name, specified in any of the

ways acceptable to the \fBset\fR command.

If a \fIname\fR refers to an element of an array then that

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.

If \fI\-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 \fI\-\-\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, any variables after the named one causing the error 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

Create an array containing a mapping from some numbers to their

squares and remove the array elements for non-prime numbers:

.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