diff options
Diffstat (limited to 'doc/global.n')
-rw-r--r-- | doc/global.n | 118 |
1 files changed, 59 insertions, 59 deletions
diff --git a/doc/global.n b/doc/global.n index 2294dee..198bc88 100644 --- a/doc/global.n +++ b/doc/global.n @@ -1,59 +1,59 @@ -'\"
-'\" Copyright (c) 1993 The Regents of the University of California.
-'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
-'\"
-'\" See the file "license.terms" for information on usage and redistribution
-'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
-'\"
-'\" RCS: @(#) $Id: global.n,v 1.10 2007/10/28 14:17:40 dkf Exp $
-'\"
-.so man.macros
-.TH global n "" Tcl "Tcl Built-In Commands"
-.BS
-'\" Note: do not modify the .SH NAME line immediately below!
-.SH NAME
-global \- Access global variables
-.SH SYNOPSIS
-\fBglobal \fIvarname \fR?\fIvarname ...\fR?
-.BE
-
-.SH DESCRIPTION
-.PP
-This command has no effect unless executed in the context of a proc body.
-If the \fBglobal\fR command is executed in the context of a proc body, it
-creates local variables linked to the corresponding global variables (and
-therefore these variables are listed by info locals).
-.PP
-If \fIvarname\fR contains namespace qualifiers, the local variable's name is
-the unqualified name of the global variable, as determined by the
-\fBnamespace tail\fR command.
-.PP
-\fIvarname\fR is always treated as the name of a variable, not an
-array element. An error is returned if the name looks like an array element,
-such as \fBa(b)\fR.
-.SH EXAMPLES
-This procedure sets the namespace variable \fI::a::x\fR
-.CS
-proc reset {} {
- \fBglobal\fR a::x
- set x 0
-}
-.CE
-.PP
-This procedure accumulates the strings passed to it in a global
-buffer, separated by newlines. It is useful for situations when you
-want to build a message piece-by-piece (as if with \fBputs\fR) but
-send that full message in a single piece (e.g. over a connection
-opened with \fBsocket\fR or as part of a counted HTTP response).
-.CS
-proc accum {string} {
- \fBglobal\fR accumulator
- append accumulator $string \en
-}
-.CE
-
-.SH "SEE ALSO"
-namespace(n), upvar(n), variable(n)
-
-.SH KEYWORDS
-global, namespace, procedure, variable
+'\" +'\" Copyright (c) 1993 The Regents of the University of California. +'\" Copyright (c) 1994-1997 Sun Microsystems, Inc. +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: global.n,v 1.11 2007/10/29 17:17:54 dgp Exp $ +'\" +.so man.macros +.TH global n "" Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +global \- Access global variables +.SH SYNOPSIS +\fBglobal \fIvarname \fR?\fIvarname ...\fR? +.BE + +.SH DESCRIPTION +.PP +This command has no effect unless executed in the context of a proc body. +If the \fBglobal\fR command is executed in the context of a proc body, it +creates local variables linked to the corresponding global variables (and +therefore these variables are listed by info locals). +.PP +If \fIvarname\fR contains namespace qualifiers, the local variable's name is +the unqualified name of the global variable, as determined by the +\fBnamespace tail\fR command. +.PP +\fIvarname\fR is always treated as the name of a variable, not an +array element. An error is returned if the name looks like an array element, +such as \fBa(b)\fR. +.SH EXAMPLES +This procedure sets the namespace variable \fI::a::x\fR +.CS +proc reset {} { + \fBglobal\fR a::x + set x 0 +} +.CE +.PP +This procedure accumulates the strings passed to it in a global +buffer, separated by newlines. It is useful for situations when you +want to build a message piece-by-piece (as if with \fBputs\fR) but +send that full message in a single piece (e.g. over a connection +opened with \fBsocket\fR or as part of a counted HTTP response). +.CS +proc accum {string} { + \fBglobal\fR accumulator + append accumulator $string \en +} +.CE + +.SH "SEE ALSO" +namespace(n), upvar(n), variable(n) + +.SH KEYWORDS +global, namespace, procedure, variable |