home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / split.n < prev    next >
Text File  |  1993-06-16  |  2KB  |  58 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/split.n,v 1.1 93/06/16 16:48:25 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS split tcl
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. split \- Split a string into a proper Tcl list
  29. .SH SYNOPSIS
  30. \fBsplit \fIstring \fR?\fIsplitChars\fR?
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. Returns a list created by splitting \fIstring\fR at each character
  36. that is in the \fIsplitChars\fR argument.
  37. Each element of the result list will consist of the
  38. characters from \fIstring\fR that lie between instances of the
  39. characters in \fIsplitChars\fR.
  40. Empty list elements will be generated if \fIstring\fR contains
  41. adjacent characters in \fIsplitChars\fR, or if the first or last
  42. character of \fIstring\fR is in \fIsplitChars\fR.
  43. If \fIsplitChars\fR is an empty string then each character of
  44. \fIstring\fR becomes a separate element of the result list.
  45. \fISplitChars\fR defaults to the standard white-space characters.
  46. For example,
  47. .DS
  48. \fBsplit "comp.unix.misc" .\fR
  49. .DE
  50. returns \fB"comp unix misc"\fR and
  51. .DS
  52. \fBsplit "Hello world" {}\fR
  53. .DE
  54. returns \fB"H e l l o { } w o r l d"\fR.
  55.  
  56. .SH KEYWORDS
  57. list, split, string
  58.