summaryrefslogtreecommitdiffstats
path: root/doc/lassign.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lassign.n')
-rw-r--r--doc/lassign.n32
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/lassign.n b/doc/lassign.n
index f27422d..4d1c3c8 100644
--- a/doc/lassign.n
+++ b/doc/lassign.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: lassign.n,v 1.1 2004/01/17 00:28:08 dkf Exp $
+'\" RCS: @(#) $Id: lassign.n,v 1.2 2007/10/25 09:31:52 dkf Exp $
'\"
.so man.macros
.TH lassign n 8.5 Tcl "Tcl Built-In Commands"
@@ -16,7 +16,6 @@ lassign \- Assign list elements to variables
.SH SYNOPSIS
\fBlassign \fIlist varName \fR?\fIvarName ...\fR?
.BE
-
.SH DESCRIPTION
.PP
This command treats the value \fIlist\fR as a list and assigns
@@ -29,27 +28,30 @@ unassigned elements is returned.
An illustration of how multiple assignment works, and what happens
when there are either too few or too many elements.
.CS
-lassign {a b c} x y z ;# Empty return
-puts $x ;# Prints "a"
-puts $y ;# Prints "b"
-puts $z ;# Prints "c"
+.ta 2.5i
+lassign {a b c} x y z \fB\(->\fI Empty return\fR
+puts $x \fB\(->\fI Prints "a"\fR
+puts $y \fB\(->\fI Prints "b"\fR
+puts $z \fB\(->\fI Prints "c"\fR
-lassign {d e} x y z ;# Empty return
-puts $x ;# Prints "d"
-puts $y ;# Prints "e"
-puts $z ;# Prints ""
+lassign {d e} x y z \fB\(->\fI Empty return\fR
+puts $x \fB\(->\fI Prints "d"\fR
+puts $y \fB\(->\fI Prints "e"\fR
+puts $z \fB\(->\fI Prints ""\fR
-lassign {f g h i} x y ;# Returns "h i"
-puts $x ;# Prints "f"
-puts $y ;# Prints "g"
+lassign {f g h i} x y \fB\(->\fI Returns "h i"\fR
+puts $x \fB\(->\fI Prints "f"\fR
+puts $y \fB\(->\fI Prints "g"\fR
.CE
+.PP
The \fBlassign\fR command has other uses. It can be used to create
-the analogue of the "shift" command in many shell languages like this:
+the analogue of the
+.QW shift
+command in many shell languages like this:
.CS
set ::argv [lassign $::argv argumentToReadOff]
.CE
.SH "SEE ALSO"
lindex(n), list(n), lset(n), set(n)
-
.SH KEYWORDS
assign, element, list, multiple, set, variable