summaryrefslogtreecommitdiffstats
path: root/doc/split.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/split.n')
-rw-r--r--doc/split.n29
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/split.n b/doc/split.n
index c289be0..e3259df 100644
--- a/doc/split.n
+++ b/doc/split.n
@@ -14,7 +14,6 @@ split \- Split a string into a proper Tcl list
.SH SYNOPSIS
\fBsplit \fIstring \fR?\fIsplitChars\fR?
.BE
-
.SH DESCRIPTION
.PP
Returns a list created by splitting \fIstring\fR at each character
@@ -29,34 +28,41 @@ If \fIsplitChars\fR is an empty string then each character of
\fIstring\fR becomes a separate element of the result list.
\fISplitChars\fR defaults to the standard white-space characters.
.SH EXAMPLES
+.PP
Divide up a USENET group name into its hierarchical components:
+.PP
.CS
-\fBsplit\fR "comp.lang.tcl.announce" .
- \fI\(-> comp lang tcl announce\fR
+\fBsplit\fR "comp.lang.tcl" .
+ \fI\(-> comp lang tcl\fR
.CE
.PP
See how the \fBsplit\fR command splits on \fIevery\fR character in
\fIsplitChars\fR, which can result in information loss if you are not
careful:
+.PP
.CS
\fBsplit\fR "alpha beta gamma" "temp"
\fI\(-> al {ha b} {} {a ga} {} a\fR
.CE
.PP
Extract the list words from a string that is not a well-formed list:
+.PP
.CS
\fBsplit\fR "Example with {unbalanced brace character"
\fI\(-> Example with \e{unbalanced brace character\fR
.CE
.PP
Split a string into its constituent characters
+.PP
.CS
\fBsplit\fR "Hello world" {}
\fI\(-> H e l l o { } w o r l d\fR
.CE
.SS "PARSING RECORD-ORIENTED FILES"
+.PP
Parse a Unix /etc/passwd file, which consists of one entry per line,
with each line consisting of a colon-separated list of fields:
+.PP
.CS
## Read the file
set fid [open /etc/passwd]
@@ -69,18 +75,19 @@ set records [\fBsplit\fR $content "\en"]
## Iterate over the records
foreach rec $records {
- ## Split into fields on colons
- set fields [\fBsplit\fR $rec ":"]
+ ## Split into fields on colons
+ set fields [\fBsplit\fR $rec ":"]
- ## Assign fields to variables and print some out...
- lassign $fields \e
- userName password uid grp longName homeDir shell
- puts "$longName uses [file tail $shell] for a login shell"
+ ## Assign fields to variables and print some out...
+ lassign $fields \e
+ userName password uid grp longName homeDir shell
+ puts "$longName uses [file tail $shell] for a login shell"
}
.CE
-
.SH "SEE ALSO"
join(n), list(n), string(n)
-
.SH KEYWORDS
list, split, string
+'\" Local Variables:
+'\" mode: nroff
+'\" End: