aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/contains.txt
blob: 3671c8a31389342eac6a45473d5ceb845d19f222 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
\section contains contains - test if a word is present in a list

\subsection contains-synopsis Synopsis
\fish{syn}
contains [OPTIONS] KEY [VALUES...]
\endfish

\subsection contains-description Description

`contains` tests whether the set `VALUES` contains the string
`KEY`. If so, `contains` exits with status 0; if not, it exits
with status 1.

The following options are available:

- `-i` or `--index` print the word index
- `-h` or `--help` display this message

\subsection contains-example Example

\fish
for i in ~/bin /usr/local/bin
    if not contains $i $PATH
        set PATH $PATH $i
    end
end
\endfish

The above code tests if `~/bin` and `/usr/local/bin` are in the path and adds them if not.