h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-31 03:51:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse Source 
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.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc_src/switch.txt
View File

@@ -1,18 +1,20 @@
\section switch switch - conditionally execute a block of commands
\subsection switch-synopsis Synopsis
<tt>switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end</tt>
\fish{syn}
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
\endfish
\subsection switch-description Description
\c switch performs one of several blocks of commands, depending on whether
a specified value equals one of several wildcarded values. \c case is used
together with the \c switch statement in order to determine which block should
`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 \c case command is given one or more parameters. The first \c case
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. \c case parameters may contain
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.
@@ -29,7 +31,7 @@ against the parameter.
If the variable \$animal contains the name of an animal, the following
code would attempt to classify it:
<pre>
\fish
switch $animal
case cat
echo evil
@@ -42,8 +44,8 @@ switch $animal
case '*'
echo I have no idea what a $animal is
end
</pre>
\endfish
If the above code was run with \c \$animal set to \c whale, the output
would be \c mammal.
If the above code was run with `$animal` set to `whale`, the output
would be `mammal`.