summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorhobbs <hobbs>2000-06-01 00:33:27 (GMT)
committerhobbs <hobbs>2000-06-01 00:33:27 (GMT)
commit58476f96744cb7143b4129af3d1978f949d8b474 (patch)
tree27af8e10e0015c6de9e8f5eafcd39254d32ca5b9 /doc
parentfb987e05c7e3613f4a27e0f9262e29cbda36e51a (diff)
downloadtcl-58476f96744cb7143b4129af3d1978f949d8b474.zip
tcl-58476f96744cb7143b4129af3d1978f949d8b474.tar.gz
tcl-58476f96744cb7143b4129af3d1978f949d8b474.tar.bz2
* tests/set-old.test:
* doc/unset.n: * generic/tclVar.c (Tcl_UnsetObjCmd): added -nocomplain and -- options to unset, to allow for a silent unset operation.
Diffstat (limited to 'doc')
-rw-r--r--doc/unset.n20
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/unset.n b/doc/unset.n
index ef93132..6aca9d3 100644
--- a/doc/unset.n
+++ b/doc/unset.n
@@ -1,20 +1,21 @@
'\"
'\" 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.2 1998/09/14 18:39:56 stanton Exp $
+'\" RCS: @(#) $Id: unset.n,v 1.3 2000/06/01 00:33:27 hobbs Exp $
'\"
.so man.macros
-.TH unset n "" Tcl "Tcl Built-In Commands"
+.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 \fIname \fR?\fIname name ...\fR?
+\fBunset \fR?\fI\-\-\fR? ?\fI\-nocomplain\fR? ?\fIname name name ...\fR?
.BE
.SH DESCRIPTION
@@ -27,8 +28,17 @@ 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.
+.VS 8.4
+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. \fI\-\-\fR may be specified
+prior to \fI\-nocomplain\fR to prevent it from being interpreted as an
+option.
+.VE 8.4
+If an error occurs, any variables after the named one causing the error not
+deleted. An error can occur when the named variable doesn't 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 KEYWORDS
remove, variable