mirror of
https://github.com/fish-shell/fish-shell
synced 2024-11-15 17:28:19 +00:00
28 lines
1.5 KiB
Text
28 lines
1.5 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. The `$argv` variable will not include the name of the sourced file.
|
|
|
|
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
|
|
|
|
\subsection Caveats
|
|
|
|
In fish versions prior to 2.3.0 the `$argv` variable would have a single element (the name of the sourced file) if no arguments are present. Otherwise it would contain arguments without the name of the sourced file. That behavior was very confusing and unlike other shells such as bash and zsh.
|