summaryrefslogtreecommitdiffstats
path: root/doc/variable.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/variable.n')
-rw-r--r--doc/variable.n20
1 files changed, 14 insertions, 6 deletions
diff --git a/doc/variable.n b/doc/variable.n
index 6400c23..8228859 100644
--- a/doc/variable.n
+++ b/doc/variable.n
@@ -4,7 +4,7 @@
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
+'\"
.TH variable n 8.0 Tcl "Tcl Built-In Commands"
.so man.macros
.BS
@@ -12,9 +12,10 @@
.SH NAME
variable \- create and initialize a namespace variable
.SH SYNOPSIS
-\fBvariable \fR?\fIname value...\fR? \fIname \fR?\fIvalue\fR?
+\fBvariable \fR\fIname\fR
+.sp
+\fBvariable \fR?\fIname value...\fR?
.BE
-
.SH DESCRIPTION
.PP
This command is normally used within a
@@ -44,7 +45,8 @@ linked to the corresponding namespace variables (and therefore these
variables are listed by \fBinfo vars\fR.)
In this way the \fBvariable\fR command resembles the \fBglobal\fR command,
although the \fBglobal\fR command
-only links to variables in the global namespace.
+resolves variable names with respect to the global namespace instead
+of the current namespace of the procedure.
If any \fIvalue\fRs are given,
they are used to modify the values of the associated namespace variables.
If a namespace variable does not exist,
@@ -57,7 +59,9 @@ After the variable has been declared,
elements within the array can be set using ordinary
\fBset\fR or \fBarray\fR commands.
.SH EXAMPLES
+.PP
Create a variable in a namespace:
+.PP
.CS
namespace eval foo {
\fBvariable\fR bar 12345
@@ -65,6 +69,7 @@ namespace eval foo {
.CE
.PP
Create an array in a namespace:
+.PP
.CS
namespace eval someNS {
\fBvariable\fR someAry
@@ -76,6 +81,7 @@ namespace eval someNS {
.CE
.PP
Access variables in namespaces from a procedure:
+.PP
.CS
namespace eval foo {
proc spong {} {
@@ -89,9 +95,11 @@ namespace eval foo {
}
}
.CE
-
.SH "SEE ALSO"
global(n), namespace(n), upvar(n)
-
.SH KEYWORDS
global, namespace, procedure, variable
+.\" Local variables:
+.\" mode: nroff
+.\" fill-column: 78
+.\" End: