fish-shell/doc_src/contains.txt

\section contains contains - test if a word is present in a list

\subsection contains-synopsis Synopsis
\fish{synopsis}
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

Note that, like GNU tools and most of fish's builtins, `contains` interprets all arguments starting with a `-` as options to contains, until it reaches an argument that is `--` (two dashes). See the examples below.

\subsection contains-example Example

If $animals is a list of animals, the following will test if it contains a cat:

\fish
if contains cat $animals
   echo Your animal list is evil!
end
\endfish

This code will add some directories to $PATH if they aren't yet included:

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

While this will check if `hasargs` was run with the `-q` option:

\fish
function hasargs
    if contains -- -q $argv
        echo '$argv contains a -q option'
    end
end
\endfish

The `--` here stops `contains` from treating `-q` to an option to itself. Instead it treats it as a normal string to check.
Fix casing and other minor issues in documentation darcs-hash:20061031152316-ac50b-e68db9853d6e9461a0c054f1ea290704ccfc0a31.gz 2006-10-31 23:23:16 +08:00			`\section contains contains - test if a word is present in a list`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
			`\subsection contains-synopsis Synopsis`
Simplify styling 2014-08-01 20:25:41 +08:00			`\fish{synopsis}`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`contains [OPTIONS] KEY [VALUES...]`
			`\endfish`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
			`\subsection contains-description Description`

Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			`contains` tests whether the set `VALUES` contains the string `KEY`. If so, `contains` exits with status 0; if not, it exits with status 1.
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while. 2013-05-12 15:56:01 +08:00			`The following options are available:`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			- `-i` or `--index` print the word index
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
[docs] Some rewording to the builtins Plus some additional examples. 2018-05-14 06:36:49 +08:00			Note that, like GNU tools and most of fish's builtins, `contains` interprets all arguments starting with a `-` as options to contains, until it reaches an argument that is `--` (two dashes). See the examples below.
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00			`\subsection contains-example Example`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00
[docs] Some rewording to the builtins Plus some additional examples. 2018-05-14 06:36:49 +08:00			`If $animals is a list of animals, the following will test if it contains a cat:`

			`\fish`
			`if contains cat $animals`
			`echo Your animal list is evil!`
			`end`
			`\endfish`

			`This code will add some directories to $PATH if they aren't yet included:`

Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`\fish`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00			`for i in ~/bin /usr/local/bin`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`if not contains $i $PATH`
			`set PATH $PATH $i`
			`end`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00			`end`
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. 2014-08-01 10:37:32 +08:00			`\endfish`
shellscript functions should use the help command to display help darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz 2006-01-27 01:34:37 +08:00
[docs] Some rewording to the builtins Plus some additional examples. 2018-05-14 06:36:49 +08:00			While this will check if `hasargs` was run with the `-q` option:
contains: add documentation regarding the use of `--` Closes #1194. [skip ci] 2014-10-26 19:01:22 +08:00
			`\fish`
			`function hasargs`
			`if contains -- -q $argv`
			`echo '$argv contains a -q option'`
			`end`
			`end`
			`\endfish`

[docs] Some rewording to the builtins Plus some additional examples. 2018-05-14 06:36:49 +08:00			The `--` here stops `contains` from treating `-q` to an option to itself. Instead it treats it as a normal string to check.