home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / tcl2-73c.zip / tcl7.3 / doc / list.n < prev    next >
Text File  |  1993-10-28  |  2KB  |  63 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/list.n,v 1.2 93/10/28 16:19:11 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS list tcl
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. list \- Create a list
  29. .SH SYNOPSIS
  30. .VS
  31. \fBlist \fR?\fIarg arg ...\fR?
  32. .VE
  33. .BE
  34.  
  35. .SH DESCRIPTION
  36. .PP
  37. This command returns a list comprised of all the \fIarg\fRs,
  38. .VS
  39. or an empty string if no \fIarg\fRs are specified.
  40. .VE
  41. Braces and backslashes get added as necessary, so that the \fBindex\fR command
  42. may be used on the result to re-extract the original arguments, and also
  43. so that \fBeval\fR may be used to execute the resulting list, with
  44. \fIarg1\fR comprising the command's name and the other \fIarg\fRs comprising
  45. its arguments.  \fBList\fR produces slightly different results than
  46. \fBconcat\fR:  \fBconcat\fR removes one level of grouping before forming
  47. the list, while \fBlist\fR works directly from the original arguments.
  48. For example, the command
  49. .DS
  50. \fBlist a b {c d e} {f {g h}}
  51. .DE
  52. will return
  53. .DS
  54. \fBa b {c d e} {f {g h}}
  55. .DE
  56. while \fBconcat\fR with the same arguments will return
  57. .DS
  58. \fBa b c d e f {g h}\fR
  59. .DE
  60.  
  61. .SH KEYWORDS
  62. element, list
  63.