summaryrefslogtreecommitdiffstats
path: root/doc/concat.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/concat.n')
-rw-r--r--doc/concat.n38
1 files changed, 17 insertions, 21 deletions
diff --git a/doc/concat.n b/doc/concat.n
index d34d48c..23ecb2d 100644
--- a/doc/concat.n
+++ b/doc/concat.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: concat.n,v 1.12 2008/10/17 10:22:25 dkf Exp $
+'\" RCS: @(#) $Id: concat.n,v 1.13 2009/04/27 12:31:38 dkf Exp $
'\"
.so man.macros
.TH concat n 8.3 Tcl "Tcl Built-In Commands"
@@ -19,44 +19,40 @@ concat \- Join lists together
.SH DESCRIPTION
.PP
This command joins each of its arguments together with spaces after
-trimming leading and trailing white-space from each of them. If all the
+trimming leading and trailing white-space from each of them. If all of the
arguments are lists, this has the same effect as concatenating them
into a single list.
It permits any number of arguments;
if no \fIarg\fRs are supplied, the result is an empty string.
.SH EXAMPLES
-Although \fBconcat\fR will concatenate lists (so the command:
+Although \fBconcat\fR will concatenate lists, flattening them in the process
+(so giving the following interactive session):
.PP
.CS
-\fBconcat\fR a b {c d e} {f {g h}}
+\fI%\fR \fBconcat\fR a b {c d e} {f {g h}}
+\fIa b c d e f {g h}\fR
.CE
.PP
-will return
-.QW "\fBa b c d e f {g h}\fR"
-as its result), it will also
-concatenate things that are not lists, and hence the command:
+it will also concatenate things that are not lists, as can be seen from this
+session:
.PP
.CS
-\fBconcat\fR " a b {c " d " e} f"
+\fI%\fR \fBconcat\fR " a b {c " d " e} f"
+\fIa b {c d e} f\fR
.CE
.PP
-will return
-.QW "\fBa b {c d e} f\fR"
-as its result.
-.PP
-Note that the concatenation does not remove spaces from the middle of
-its arguments, so the command:
+Note also that the concatenation does not remove spaces from the middle of
+values, as can be seen here:
.PP
.CS
-\fBconcat\fR "a b c" { d e f }
+\fI%\fR \fBconcat\fR "a b c" { d e f }
+\fIa b c d e f\fR
.CE
.PP
-will return
-.QW "\fBa b c d e f\fR"
-(i.e. with three spaces between
-the \fBa\fR, the \fBb\fR and the \fBc\fR).
+(i.e., there are three spaces between each of the \fBa\fR, the \fBb\fR and the
+\fBc\fR).
.SH "SEE ALSO"
-append(n), eval(n)
+append(n), eval(n), join(n)
.SH KEYWORDS
concatenate, join, lists
'\" Local Variables: