diff options
Diffstat (limited to 'doc/concat.n')
| -rw-r--r-- | doc/concat.n | 49 |
1 files changed, 28 insertions, 21 deletions
diff --git a/doc/concat.n b/doc/concat.n index 882ebbc..d10f092 100644 --- a/doc/concat.n +++ b/doc/concat.n @@ -4,11 +4,9 @@ '\" '\" 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.6 2004/10/27 09:36:58 dkf Exp $ -'\" -.so man.macros +'\" .TH concat n 8.3 Tcl "Tcl Built-In Commands" +.so man.macros .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -16,37 +14,46 @@ concat \- Join lists together .SH SYNOPSIS \fBconcat\fI \fR?\fIarg arg ...\fR? .BE - .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. +Arguments that are empty (after trimming) are ignored entirely. 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 -will return "\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: +.PP +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 -will return "\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 -will return "\fBa b c d e f\fR" (i.e. with three spaces between -the \fBa\fR, the \fBb\fR and the \fBc\fR). - +.PP +(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 +concatenate, join, list +'\" Local Variables: +'\" mode: nroff +'\" End: |