diff options
author | mig <mig> | 2013-01-15 22:57:48 (GMT) |
---|---|---|
committer | mig <mig> | 2013-01-15 22:57:48 (GMT) |
commit | 5d968e9a205abb7d1e05e07295591f158e3abf4d (patch) | |
tree | 923d5ef7e81a181bea2e2b5714e665a05abeec86 /doc/lrange.n | |
parent | ae96da6472b682fd5cd426ca2c96ff9638c07e30 (diff) | |
download | tcl-5d968e9a205abb7d1e05e07295591f158e3abf4d.zip tcl-5d968e9a205abb7d1e05e07295591f158e3abf4d.tar.gz tcl-5d968e9a205abb7d1e05e07295591f158e3abf4d.tar.bz2 |
adding back the docs and changes, now that the novem mess is (mostly?) cleaned
Diffstat (limited to 'doc/lrange.n')
-rw-r--r-- | doc/lrange.n | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/lrange.n b/doc/lrange.n new file mode 100644 index 0000000..4f4816a --- /dev/null +++ b/doc/lrange.n @@ -0,0 +1,78 @@ +'\" +'\" Copyright (c) 1993 The Regents of the University of California. +'\" Copyright (c) 1994-1996 Sun Microsystems, Inc. +'\" Copyright (c) 2001 Kevin B. Kenny <kennykb@acm.org>. All rights reserved. +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +.so man.macros +.TH lrange n 7.4 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +lrange \- Return one or more adjacent elements from a list +.SH SYNOPSIS +\fBlrange \fIlist first last\fR +.BE +.SH DESCRIPTION +.PP +\fIList\fR must be a valid Tcl list. This command will +return a new list consisting of elements +\fIfirst\fR through \fIlast\fR, inclusive. +The index values \fIfirst\fR and \fIlast\fR are interpreted +the same as index values for the command \fBstring index\fR, +supporting simple index arithmetic and indices relative to the +end of the list. +If \fIfirst\fR is less than zero, it is treated as if it were zero. +If \fIlast\fR is greater than or equal to the number of elements +in the list, then it is treated as if it were \fBend\fR. +If \fIfirst\fR is greater than \fIlast\fR then an empty string +is returned. +Note: +.QW "\fBlrange \fIlist first first\fR" +does not always produce the same result as +.QW "\fBlindex \fIlist first\fR" +(although it often does for simple fields that are not enclosed in +braces); it does, however, produce exactly the same results as +.QW "\fBlist [lindex \fIlist first\fB]\fR" +.SH EXAMPLES +.PP +Selecting the first two elements: +.PP +.CS +% \fBlrange\fR {a b c d e} 0 1 +a b +.CE +.PP +Selecting the last three elements: +.PP +.CS +% \fBlrange\fR {a b c d e} end-2 end +c d e +.CE +.PP +Selecting everything except the first and last element: +.PP +.CS +% \fBlrange\fR {a b c d e} 1 end-1 +b c d +.CE +.PP +Selecting a single element with \fBlrange\fR is not the same as doing +so with \fBlindex\fR: +.PP +.CS +% set var {some {elements to} select} +some {elements to} select +% lindex $var 1 +elements to +% \fBlrange\fR $var 1 1 +{elements to} +.CE +.SH "SEE ALSO" +list(n), lappend(n), lindex(n), linsert(n), llength(n), lsearch(n), +lset(n), lreplace(n), lsort(n), +string(n) +.SH KEYWORDS +element, list, range, sublist |