fish-shell/doc_src/source.txt

\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.
Document source command. 2013-08-14 23:55:15 +08:00			`\section source source - evaluate contents of file.`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
			`\subsection source-synopsis Synopsis`
Simplify styling 2014-08-01 20:25:41 +08:00			`\fish{synopsis}`
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. 2014-08-01 10:37:32 +08:00			`source FILENAME [ARGUMENTS...]`
			`\endfish`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
remove trialing spaces #2 2010-09-18 10:18:26 +08:00			`\subsection source-description Description`
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
clarify documentation for the `source` command Make it clear that fish 2.3.0 changed how `$argv` is initialized. 2016-04-07 08:18:06 +08:00			`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.
Make the . (source) builtin able to read commands from stdin darcs-hash:20070422211947-ac50b-b8d33d81fcef5e0b7e76a8d2a9f0bcbcf3ac67b7.gz 2007-04-23 05:19:47 +08:00
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			If no file is specified, or if the file name '`-`' is used, stdin will be read.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00			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.
Make the . builtin have a more useful (and posix-compatible) exit status darcs-hash:20071005145808-75c98-17100c1e321b8bca06f75e900db1386451232f98.gz 2007-10-05 22:58:08 +08:00
add completions for source and document the move away from '.' Closes: #310 2013-10-28 09:57:36 +08:00
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz 2005-09-20 21:31:55 +08:00			`\subsection source-example Example`
Make line length, wrapping and spacing consistent 2014-08-19 20:41:23 +08:00
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-08-08 10:44:37 +08:00			`\fish`
			`source ~/.config/fish/config.fish`
			`# Causes fish to re-read its initialization file.`
			`\endfish`
clarify documentation for the `source` command Make it clear that fish 2.3.0 changed how `$argv` is initialized. 2016-04-07 08:18:06 +08:00
			`\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.