Subversion Repositories or1k

'\"

'\" Copyright (c) 1993 The Regents of the University of California.

'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.

'\"

'\" See the file "license.terms" for information on usage and redistribution

'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.

'\"

'\" RCS: @(#) $Id: split.n,v 1.1.1.1 2002-01-16 10:25:25 markom Exp $

'\"

.so man.macros

.TH split n "" Tcl "Tcl Built-In Commands"

.BS

'\" Note:  do not modify the .SH NAME line immediately below!

.SH NAME

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

that is in the \fIsplitChars\fR argument.

Each element of the result list will consist of the

characters from \fIstring\fR that lie between instances of the

characters in \fIsplitChars\fR.

Empty list elements will be generated if \fIstring\fR contains

adjacent characters in \fIsplitChars\fR, or if the first or last

character of \fIstring\fR is in \fIsplitChars\fR.

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.

For example,

.CS

\fBsplit "comp.unix.misc" .\fR

.CE

returns \fB"comp unix misc"\fR and

.CS

\fBsplit "Hello world" {}\fR

.CE

returns \fB"H e l l o { } w o r l d"\fR.

.SH KEYWORDS

list, split, string