doc: document relative path support for source.

[ci skip]
This commit is contained in:
Mark Stosberg 2019-10-14 12:00:12 -04:00 committed by Fabian Homborg
parent d1970c7f2e
commit 087500e7b9

View file

@ -17,6 +17,8 @@ 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. ``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.
fish will search the working directory to resolve relative paths but will not search ``$PATH``.
If no file is specified and stdin is not the terminal, or if the file name '``-``' is used, stdin will be read. If no file is specified and stdin is not the terminal, or if the file name '``-``' is used, stdin will be read.
The exit status of ``source`` is the exit status of the last job to execute. If something goes wrong while opening or reading the file, ``source`` exits with a non-zero status. The exit status of ``source`` is the exit status of the last job to execute. If something goes wrong while opening or reading the file, ``source`` exits with a non-zero status.