summaryrefslogtreecommitdiffstats
path: root/doc/unset.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-29 01:42:18 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-29 01:42:18 (GMT)
commit71f78ed1de764f208d95b703744c7682d448c3e3 (patch)
tree8e72d3dd4068fc22320de66ab7145fa75119f54c /doc/unset.n
parentccacc920f9cd610a9a9d8e800f623c20bf43a702 (diff)
downloadtcl-71f78ed1de764f208d95b703744c7682d448c3e3.zip
tcl-71f78ed1de764f208d95b703744c7682d448c3e3.tar.gz
tcl-71f78ed1de764f208d95b703744c7682d448c3e3.tar.bz2
Next stage of doing GOOBE improvements to documentation now that the html generation works
Diffstat (limited to 'doc/unset.n')
-rw-r--r--doc/unset.n129
1 files changed, 63 insertions, 66 deletions
diff --git a/doc/unset.n b/doc/unset.n
index 036429f..655ec0f 100644
--- a/doc/unset.n
+++ b/doc/unset.n
@@ -1,66 +1,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.10 2005/05/10 18:34:03 kennykb 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 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 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
+'\"
+'\" 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