tcl/doc/unset.n

   1 '\"
   2 '\" Copyright (c) 1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\" Copyright (c) 2000 Ajuba Solutions.
   5 '\"
   6 '\" See the file "license.terms" for information on usage and redistribution
   7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   8 '\"
   9 '\" RCS: @(#) $Id$
  10 '\"
  11 .so man.macros
  12 .TH unset n 8.4 Tcl "Tcl Built-In Commands"
  13 .BS
  14 '\" Note:  do not modify the .SH NAME line immediately below!
  15 .SH NAME
  16 unset \- Delete variables
  17 .SH SYNOPSIS
  18 \fBunset \fR?\fI\-nocomplain\fR? ?\fI\-\-\fR? ?\fIname name name ...\fR?
  19 .BE
  20
  21 .SH DESCRIPTION
  22 .PP
  23 This command removes one or more variables.
  24 Each \fIname\fR is a variable name, specified in any of the
  25 ways acceptable to the \fBset\fR command.
  26 If a \fIname\fR refers to an element of an array then that
  27 element is removed without affecting the rest of the array.
  28 If a \fIname\fR consists of an array name with no parenthesized
  29 index, then the entire array is deleted.
  30 The \fBunset\fR command returns an empty string as result.
  31 .VS 8.4
  32 If \fI\-nocomplain\fR is specified as the first argument, any possible
  33 errors are suppressed.  The option may not be abbreviated, in order to
  34 disambiguate it from possible variable names.  The option \fI\-\-\fR
  35 indicates the end of the options, and should be used if you wish to
  36 remove a variable with the same name as any of the options.
  37 .VE 8.4
  38 If an error occurs, any variables after the named one causing the error not
  39 deleted.  An error can occur when the named variable doesn't exist, or the
  40 name refers to an array element but the variable is a scalar, or the name
  41 refers to a variable in a non-existent namespace.
  42
  43 .SH "SEE ALSO"
  44 set(n), trace(n)
  45
  46 .SH KEYWORDS
  47 remove, variable