mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-23 01:36:39 +08:00
3a23fdf359
Includes harmonizing the display of options and arguments, standardising terminology, using the envvar directive more broadly, adding help options to all commands that support them, simplifying some language, and tidying up multiple formatting issues. string documentation is not changed.
47 lines
1.9 KiB
ReStructuredText
47 lines
1.9 KiB
ReStructuredText
.. _cmd-source:
|
|
|
|
source - evaluate contents of file
|
|
==================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
source FILE [ARGUMENTS ...]
|
|
SOMECOMMAND | source
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
``source`` evaluates the commands of the specified *FILE* in the current shell as a new block of code. This is different from starting a new process to perform the commands (i.e. ``fish < FILE``) 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 :envvar:`argv` variable. The :envvar:`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 :envvar:`PATH` .
|
|
|
|
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.
|
|
|
|
**.** (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.
|
|
|
|
``source`` creates a new :ref:`local scope<variables-scope>`; ``set --local`` within a sourced block will not affect variables in the enclosing scope.
|
|
|
|
The **-h** or **--help** option displays help about using this command.
|
|
|
|
Example
|
|
-------
|
|
|
|
|
|
|
|
::
|
|
|
|
source ~/.config/fish/config.fish
|
|
# Causes fish to re-read its initialization file.
|
|
|
|
|
|
Caveats
|
|
-------
|
|
|
|
In fish versions prior to 2.3.0, the :envvar:`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.
|