61 lines
2.3 KiB
Plaintext
61 lines
2.3 KiB
Plaintext
|
'\"
|
||
|
|
'\" Copyright (c) 1993 The Regents of the University of California.
|
||
|
|
'\" All rights reserved.
|
||
|
|
'\"
|
||
|
|
'\" Permission is hereby granted, without written agreement and without
|
||
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
||
|
|
'\" documentation for any purpose, provided that the above copyright
|
||
|
|
'\" notice and the following two paragraphs appear in all copies.
|
||
|
|
'\"
|
||
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
||
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
||
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
||
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
'\"
|
||
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
||
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
||
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
||
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
||
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
||
|
|
'\"
|
||
|
|
'\" $Header: /user6/ouster/tcl/man/RCS/lsearch.n,v 1.2 93/05/07 14:27:07 ouster Exp $ SPRITE (Berkeley)
|
||
|
|
'\"
|
||
|
|
.so man.macros
|
||
|
|
.HS lsearch tcl 7.0
|
||
|
|
.BS
|
||
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
||
|
|
.SH NAME
|
||
|
|
lsearch \- See if a list contains a particular element
|
||
|
|
.SH SYNOPSIS
|
||
|
|
\fBlsearch \fR?\fImode\fR? \fIlist pattern\fR
|
||
|
|
.BE
|
||
|
|
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
This command searches the elements of \fIlist\fR to see if one
|
||
|
|
of them matches \fIpattern\fR.
|
||
|
|
If so, the command returns the index of the first matching
|
||
|
|
element.
|
||
|
|
If not, the command returns \fB\-1\fR.
|
||
|
|
.VS
|
||
|
|
The \fImode\fR argument indicates how the elements of the list are to
|
||
|
|
be matched against \fIpattern\fR and it must have one of the following
|
||
|
|
values:
|
||
|
|
.TP
|
||
|
|
\fB\-exact\fR
|
||
|
|
The list element must contain exactly the same string as \fIpattern\fR.
|
||
|
|
.TP
|
||
|
|
\fB\-glob\fR
|
||
|
|
\fIPattern\fR is a glob-style pattern which is matched against each list
|
||
|
|
element using the same rules as the \fBstring match\fR command.
|
||
|
|
.TP
|
||
|
|
\fB\-regexp\fR
|
||
|
|
\fIPattern\fR is treated as a regular expression and matched against
|
||
|
|
each list element using the same rules as the \fBregexp\fR command.
|
||
|
|
.PP
|
||
|
|
If \fImode\fR is omitted then it defaults to \fB\-glob\fR.
|
||
|
|
.VE
|
||
|
|
|
||
|
|
.SH KEYWORDS
|
||
|
|
list, match, pattern, regular expression, search, string
|