diff options
| author | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
|---|---|---|
| committer | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
| commit | 2b5738da524e944cda39e24c0a87b745a43bd8c3 (patch) | |
| tree | 6e8c9473978f6dab66c601e911721a7bd9d70b1b /doc/lindex.n | |
| parent | c6a259aeeca4814a97cf6694814c63e74e4e18fa (diff) | |
| download | tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.zip tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.gz tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.bz2 | |
Initial revision
Diffstat (limited to 'doc/lindex.n')
| -rw-r--r-- | doc/lindex.n | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/lindex.n b/doc/lindex.n new file mode 100644 index 0000000..cf0979c --- /dev/null +++ b/doc/lindex.n @@ -0,0 +1,35 @@ +'\" +'\" 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. +'\" +'\" SCCS: @(#) lindex.n 1.8 96/08/26 13:00:02 +'\" +.so man.macros +.TH lindex n 7.4 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +lindex \- Retrieve an element from a list +.SH SYNOPSIS +\fBlindex \fIlist index\fR +.BE + +.SH DESCRIPTION +.PP +This command treats \fIlist\fR as a Tcl list and returns the +\fIindex\fR'th element from it (0 refers to the first element of the list). +In extracting the element, \fIlindex\fR observes the same rules +concerning braces and quotes and backslashes as the Tcl command +interpreter; however, variable +substitution and command substitution do not occur. +If \fIindex\fR is negative or greater than or equal to the number +of elements in \fIvalue\fR, then an empty +string is returned. +If \fIindex\fR has the value \fBend\fR, it refers to the last element +in the list. + +.SH KEYWORDS +element, index, list |