fish-shell/doc_src/source.txt
Mark Griffiths 509d152e54 Tutorial auto colouring, Man page and Make fixes
Completely fixes #1557 and the underlying Doxygen changes that caused
it. Should make fish docs simpler and more robust, more consistent and
generally prettier.

todo:
- trap unmarked text as arguments in context
- test & fix sed portability - see in particular. (so far tested on BSD
(Mac) and GNU sed).
- test Makefile changes
- last round of aesthetic changes and getting that ascii fish in there…
2014-09-03 14:43:26 +01:00

33 lines
1.1 KiB
Text

\section source source - evaluate contents of file.
\subsection source-synopsis Synopsis
\fish{synopsis}
source FILENAME [ARGUMENTS...]
\endfish
\subsection source-description Description
`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. `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
be read.
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,
`source` exits with a non-zero status.
`.` (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
\fish
source ~/.config/fish/config.fish
# Causes fish to re-read its initialization file.
\endfish