diff options
Diffstat (limited to 'doc/concat.n')
| -rw-r--r-- | doc/concat.n | 51 |
1 files changed, 33 insertions, 18 deletions
diff --git a/doc/concat.n b/doc/concat.n index c04eaf0..575b9df 100644 --- a/doc/concat.n +++ b/doc/concat.n @@ -5,10 +5,8 @@ '\" 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.3 2000/09/07 14:27:46 poenitz Exp $ -'\" +.TH concat n 8.3 Tcl "Tcl Built-In Commands" .so man.macros -.TH concat n "" Tcl "Tcl Built-In Commands" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME @@ -16,28 +14,45 @@ concat \- Join lists together .SH SYNOPSIS \fBconcat\fI \fR?\fIarg arg ...\fR? .BE - .SH DESCRIPTION .PP -This command treats each argument as a list and concatenates them +This command joins each of its arguments together with spaces after +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 also eliminates leading and trailing spaces in the \fIarg\fR's -and adds a single separator space between \fIarg\fR's. -It permits any number of arguments. For example, -the command +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, flattening them in the process +(so giving the following interactive session): +.PP +.CS +\fI%\fR \fBconcat\fR a b {c d e} {f {g h}} +\fIa b c d e f {g h}\fR +.CE +.PP +it will also concatenate things that are not lists, as can be seen from this +session: +.PP .CS -\fBconcat a b {c d e} {f {g h}}\fR +\fI%\fR \fBconcat\fR " a b {c " d " e} f" +\fIa b {c d e} f\fR .CE -will return +.PP +Note also that the concatenation does not remove spaces from the middle of +values, as can be seen here: +.PP .CS -\fBa b c d e f {g h}\fR +\fI%\fR \fBconcat\fR "a b c" { d e f } +\fIa b c d e f\fR .CE -as its result. .PP -If no \fIarg\fRs are supplied, the result is an empty string. - +(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: |