diff options
| author |  Mark Griffiths <mark@thebespokepixel.com> | 2014-08-01 03:37:32 +0100 |
|---|---|---|
| committer | Mark Griffiths <mark@thebespokepixel.com> | 2014-09-03 14:43:24 +0100 |
| commit | d282bc462578a6e47747c78d2d42883530f0d11e (patch) | |
| tree | a6515e908d4fc1c400cb6cebaf79b1590b005804 /doc_src/source.txt | |
| parent | 1c4223889bd729ee83aa21a3450dc28f92ade641 (diff) | |
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.
Diffstat (limited to 'doc_src/source.txt')
| -rw-r--r-- | doc_src/source.txt | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/doc_src/source.txt b/doc_src/source.txt index 8798e9d9..bb32e30a 100644 --- a/doc_src/source.txt +++ b/doc_src/source.txt @@ -1,30 +1,32 @@ \section source source - evaluate contents of file. \subsection source-synopsis Synopsis -<tt>source FILENAME [ARGUMENTS...]</tt> +\fish{syn} +source FILENAME [ARGUMENTS...] +\endfish \subsection source-description Description -\c source evaluates the commands of the specified file in the current +`source` evaluates the commands of the specified file in the current shell. This is different from starting a new process to perform the -commands (i.e. <tt>fish < FILENAME</tt>) since the commands will be +commands (i.e. `fish < FILENAME`) since the commands will be evaluated by the current shell, which means that changes in shell variables will affect the current shell. If additional arguments are specified after the file name, they will be inserted into the $argv variable. -If no file is specified, or if the file name '-' is used, stdin will +If no file is specified, or if the file name '`-`' is used, stdin will be read. -The return status of \c source is the return status of the last job to +The return status of `source` is the return status of the last job to execute. If something goes wrong while opening or reading the file, -\c source exits with a non-zero status. +`source` exits with a non-zero status. -\c . (a single period) is an alias for the \c source command. The use of \c . -is deprecated in favour of \c source, and \c . will be removed in a future +`.` (a single period) is an alias for the `source` command. The use of `.` +is deprecated in favour of `source`, and `.` will be removed in a future version of fish. \subsection source-example Example -<tt>source ~/.config/fish/config.fish</tt> causes fish to re-read its initialization file. +`source ~/.config/fish/config.fish` causes fish to re-read its initialization file. |