fish-shell/doc_src/switch.txt

\section switch switch - conditionally execute a block of commands

\subsection switch-synopsis Synopsis
\fish{synopsis}
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
\endfish

\subsection switch-description Description

`switch` performs one of several blocks of commands, depending on whether a specified value equals one of several wildcarded values. `case` is used together with the `switch` statement in order to determine which block should be executed.

Each `case` command is given one or more parameters. The first `case` command with a parameter that matches the string specified in the switch command will be evaluated. `case` parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames.

Note that fish does not fall through on case statements. Only the first matching case is executed.

Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter.


\subsection switch-example Example

If the variable \$animal contains the name of an animal, the following code would attempt to classify it:

\fish
switch $animal
    case cat
        echo evil
    case wolf dog human moose dolphin whale
        echo mammal
    case duck goose albatross
        echo bird
    case shark trout stingray
        echo fish
    case '*'
        echo I have no idea what a $animal is
end
\endfish

If the above code was run with `$animal` set to `whale`, the output
would be `mammal`.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`\section switch switch - conditionally execute a block of commands`

			`\subsection switch-synopsis Synopsis`
Simplify styling 2014-08-01 12:25:41 +00: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 02:37:32 +00:00			`switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end`
			`\endfish`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00
			`\subsection switch-description Description`

Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`switch` performs one of several blocks of commands, depending on whether a specified value equals one of several wildcarded values. `case` is used together with the `switch` statement in order to determine which block should be executed.
Expand the switch/case documentation darcs-hash:20060421083529-ac50b-f287424c0cc9377085b49492453d35a5512cbc90.gz 2006-04-21 08:35:29 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			Each `case` command is given one or more parameters. The first `case` command with a parameter that matches the string specified in the switch command will be evaluated. `case` parameters may contain wildcards. These need to be escaped or quoted in order to avoid regular wildcard expansion using filenames.
Expand the switch/case documentation darcs-hash:20060421083529-ac50b-f287424c0cc9377085b49492453d35a5512cbc90.gz 2006-04-21 08:35:29 +00:00
Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`Note that fish does not fall through on case statements. Only the first matching case is executed.`

			`Note that command substitutions in a case statement will be evaluated even if its body is not taken. All substitutions, including command substitutions, must be performed before the value can be compared against the parameter.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00
Documentation updates from Beni Cherniavsky darcs-hash:20060919145203-ac50b-bc87b8f5e6a18395e4bc3e364da4a40ad97850e7.gz 2006-09-19 14:52:03 +00:00
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`\subsection switch-example Example`

Make line length, wrapping and spacing consistent 2014-08-19 12:41:23 +00:00			`If the variable \$animal contains the name of an animal, the following code would attempt to classify it:`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00: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 02:37:32 +00:00			`\fish`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`switch $animal`
			`case cat`
			`echo evil`
			`case wolf dog human moose dolphin whale`
			`echo mammal`
Fixed various spelling mistakes. darcs-hash:20060123231706-35ec8-2a30db603eee503d944b06d101cc88ce59340309.gz 2006-01-23 23:17:06 +00:00			`case duck goose albatross`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00:00			`echo bird`
			`case shark trout stingray`
			`echo fish`
Expand the switch/case documentation darcs-hash:20060421083529-ac50b-f287424c0cc9377085b49492453d35a5512cbc90.gz 2006-04-21 08:35:29 +00:00			`case '*'`
			`echo I have no idea what a $animal is`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00: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 02:37:32 +00:00			`\endfish`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 13:31:55 +00: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 02:37:32 +00:00			If the above code was run with `$animal` set to `whale`, the output
			would be `mammal`.