diff options
Diffstat (limited to 'doc_src/if.txt')
| -rw-r--r-- | doc_src/if.txt | 38 |
1 files changed, 17 insertions, 21 deletions
diff --git a/doc_src/if.txt b/doc_src/if.txt index 94d2763a..0e9a7cb1 100644 --- a/doc_src/if.txt +++ b/doc_src/if.txt @@ -1,36 +1,32 @@ \section if if - conditionally execute a command \subsection if-synopsis Synopsis -<tt>if CONDITION; COMMANDS_TRUE...; [else if CONDITION2; COMMANDS_TRUE2...;] [else; COMMANDS_FALSE...;] end</tt> +\fish{synopsis} +if CONDITION; COMMANDS_TRUE...; +[else if CONDITION2; COMMANDS_TRUE2...;] +[else; COMMANDS_FALSE...;] +end +\endfish \subsection if-description Description -<tt>if</tt> will execute the command \c CONDITION. If the condition's -exit status is 0, the commands \c COMMANDS_TRUE will execute. If the -exit status is not 0 and <tt>else</tt> is given, \c COMMANDS_FALSE will -be executed. +`if` will execute the command `CONDITION`. If the condition's exit status is 0, the commands `COMMANDS_TRUE` will execute. If the exit status is not 0 and `else` is given, `COMMANDS_FALSE` will be executed. + +In order to use the exit status of multiple commands as the condition of an if block, use <a href="#begin">`begin; ...; end`</a> and the short circuit commands <a href="commands.html#and">`and`</a> and <a href="commands.html#or">`or`</a>. -In order to use the exit status of multiple commands as the condition -of an if block, use <a href="#begin"><tt>begin; ...; end</tt></a> and -the short circuit commands <a href="commands.html#and"><tt>and</tt></a> -and <a href="commands.html#or"><tt>or</tt></a>. +The exit status of the last foreground command to exit can always be accessed using the <a href="index.html#variables-status">$status</a> variable. -The exit status of the last foreground command to exit can always be -accessed using the <a href="index.html#variables-status">$status</a> -variable. \subsection if-example Example -<pre> +The following code will print `foo.txt exists` if the file foo.txt exists and is a regular file, otherwise it will print `bar.txt exists` if the file bar.txt exists and is a regular file, otherwise it will print `foo.txt and bar.txt do not exist`. + +\fish if test -f foo.txt - echo foo.txt exists + echo foo.txt exists else if test -f bar.txt - echo bar.txt exists + echo bar.txt exists else - echo foo.txt and bar.txt do not exist + echo foo.txt and bar.txt do not exist end -</pre>will print <tt>foo.txt exists</tt> if the file foo.txt -exists and is a regular file, otherwise it will print -<tt>bar.txt exists</tt> if the file bar.txt exists -and is a regular file, otherwise it will print -<tt>foo.txt and bar.txt do not exist</tt>. +\endfish |