fish-shell/doc_src/cmds/funcsave.rst

.. _cmd-funcsave:

funcsave - save the definition of a function to the user's autoload directory
=============================================================================

Synopsis
--------

| ``funcsave`` *FUNCTION_NAME*
| ``funcsave`` [**-q**] [(**-d** | **--directory**) *DIR*] *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 to commit functions created interactively for permanent use.

If you have erased a function using :ref:`functions <cmd-functions>`'s ``--erase`` option, ``funcsave`` will remove the saved function definition.

Because fish loads functions on-demand, saved functions cannot serve as :ref:`event handlers <event>` until they are run or otherwise sourced. To activate an event handler for every new shell, add the function to the :ref:`configuration file <configuration>` instead of using ``funcsave``.

This is often used after :ref:`funced <cmd-funced>`, which opens the function in ``$EDITOR`` or ``$VISUAL`` and loads it into the current session afterwards.
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-funcsave:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`funcsave - save the definition of a function to the user's autoload directory`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`=============================================================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
doc_src: Continue the slog through the letter F. We are using only :: in a synopsis for fishscript examples given of the command being documented. 2021-12-17 23:16:47 +00:00			\| ``funcsave`` FUNCTION_NAME
			\| ``funcsave`` [-q] [(-d \| --directory) DIR] FUNCTION_NAME
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Update docs, completions for funcsave Remove long opt for -q, funcsave does not have so many options that it's any help. 2021-09-29 10:08:10 +00:00			``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 to commit functions created interactively for permanent use.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
funcsave: add documentation for feature added in 3a402b19b 2022-01-03 15:03:29 +00:00			If you have erased a function using :ref:`functions <cmd-functions>`'s ``--erase`` option, ``funcsave`` will remove the saved function definition.

Update docs, completions for funcsave Remove long opt for -q, funcsave does not have so many options that it's any help. 2021-09-29 10:08:10 +00:00			Because fish loads functions on-demand, saved functions cannot serve as :ref:`event handlers <event>` until they are run or otherwise sourced. To activate an event handler for every new shell, add the function to the :ref:`configuration file <configuration>` instead of using ``funcsave``.
Document funced/funcsave harder [ci skip] 2020-03-19 16:59:25 +00:00
Update docs, completions for funcsave Remove long opt for -q, funcsave does not have so many options that it's any help. 2021-09-29 10:08:10 +00:00			This is often used after :ref:`funced <cmd-funced>`, which opens the function in ``$EDITOR`` or ``$VISUAL`` and loads it into the current session afterwards.