diff options
| author |  axel <axel@liljencrantz.se> | 2006-07-20 23:33:19 +1000 |
|---|---|---|
| committer | axel <axel@liljencrantz.se> | 2006-07-20 23:33:19 +1000 |
| commit | 4ba9ac28bb4ee6e370e273263579e3a3e2e0ba9f (patch) | |
| tree | f99a46f9c8434b106d8f38e7e908dbedcf82d5e4 | |
| parent | 4664d65af73795f8631653d0823aae99c5aa1588 (diff) | |
Minor documentation tweaks and additions
darcs-hash:20060720133319-ac50b-ea71dc172f0c60de0d6f1effa2092ebb8d8ca2d9.gz
| -rw-r--r-- | doc_src/begin.txt | 25 | ||||
| -rw-r--r-- | doc_src/end.txt | 2 | ||||
| -rw-r--r-- | doc_src/function.txt | 4 |
3 files changed, 23 insertions, 8 deletions
diff --git a/doc_src/begin.txt b/doc_src/begin.txt index 07ef10e0..62bb3810 100644 --- a/doc_src/begin.txt +++ b/doc_src/begin.txt @@ -7,11 +7,12 @@ \subsection begin-description Description The \c begin builtin is used to create a new block of code. The block -is unconditionally executed. Begin is equivalent to <tt>if -true</tt>. The begin command is used to group any number of commands -into a block. The reason for this is usually either to introduce a new -variable scope or to redirect the input to output of this set of -commands as a group. +is unconditionally executed. <code>begin; ...; end</tt> is equivalent +to <tt>if true; ...; end</tt>. The begin command is used to group any +number of commands into a block. The reason for doing so is usually +either to introduce a new variable scope, to redirect the input or +output of a set of commands as a group, or to specify precedence when +using the conditional commands like \c and. The \c begin command does not change the current exit status. @@ -30,3 +31,17 @@ end # the block and was killed echo $PIRATE </pre> + +In the following code, all output is redirected to the file out.html. + +<pre> +begin + echo $xml_header + echo $html_header + if test -e $file + ... + end + ... + +end > out.html +</pre> diff --git a/doc_src/end.txt b/doc_src/end.txt index 3b61e9d3..4e891fb3 100644 --- a/doc_src/end.txt +++ b/doc_src/end.txt @@ -10,7 +10,7 @@ begin; [COMMANDS...] end \subsection end-description Description <tt>end</tt> ends a block of commands. For more information, read the -documentation for the block constructs, such as \c if, \c for and \ +documentation for the block constructs, such as \c if, \c for and \c while. The \c end command does not change the current exit status. diff --git a/doc_src/function.txt b/doc_src/function.txt index 62dd41e0..51225f55 100644 --- a/doc_src/function.txt +++ b/doc_src/function.txt @@ -12,7 +12,7 @@ - <code>-s</code> or <code>--on-signal SIGSPEC</code> tells fish to run this function when the signal SIGSPEC is delivered. SIGSPEC can be a signal number, or the signal name, such as SIGHUP (or just HUP) - <code>-v</code> or <code>--on-variable VARIABLE_NAME</code> tells fish to run this function when the variable VARIABLE_NAME changes value -This builtin command is used to create a new function. A Function is a +This builtin command is used to create a new function. A function is a list of commands that will be executed when the name of the function is entered. The function @@ -25,7 +25,7 @@ end will write <code>hello</code> whenever the user enters \c hi. If the user enters any additional arguments after the function, they -are inserted into the environment variable <a href="index.html#variables-arrays">array</a> argv. +are inserted into the environment <a href="index.html#variables-arrays">variable array</a> argv. \subsection function-example Example |