mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-28 13:53:10 +00:00
22 lines
1.1 KiB
ReStructuredText
22 lines
1.1 KiB
ReStructuredText
.. _cmd-funcsave:
|
|
|
|
funcsave - save the definition of a function to the user's autoload directory
|
|
=============================================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
::
|
|
|
|
funcsave FUNCTION_NAME
|
|
funcsave [(-d | --directory) where/to/save ] FUNCTION_NAME
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
``funcsave`` saves a function to a file in the fish configuration directory. This function will be :ref:`automatically loaded <syntax-function-autoloading>` by current and future fish sessions. This can be useful if you have interactively created a new function and wish to save it for later use.
|
|
|
|
Note that because fish loads functions on-demand, saved functions will not function as :ref:`event handlers <event>` until they are run or sourced otherwise. To activate an event handler for every new shell, add the function to your :ref:`shell initialization file <initialization>` instead of using ``funcsave``.
|
|
|
|
This is typically used together with :ref:`funced <cmd-funced>`, which will open the function in your editor and load it in the current seession afterwards.
|