fish-shell/doc_src/cmds/funced.rst

.. _cmd-funced:

funced - edit a function interactively
======================================

Synopsis
--------

``funced`` [**OPTIONS**] *NAME*

Description
-----------

``funced`` provides an interface to edit the definition of the function *NAME*.

If the ``$VISUAL`` environment variable is set, it will be used as the program to edit the function. If ``$VISUAL`` is unset but ``$EDITOR`` is set, that will be used. Otherwise, a built-in editor will be used. Note that to enter a literal newline using the built-in editor you should press :kbd:`Alt`\ +\ :kbd:`Enter`. Pressing :kbd:`Enter` signals that you are done editing the function. This does not apply to an external editor like emacs or vim.

``funced`` will try to edit the original file that a function is defined in, which might include variable definitions or helper functions as well. If changes cannot be saved to the original file, a copy will be created in the user's function directory.

If there is no function called *NAME*, a new function will be created with the specified name.

- ``-e command`` or ``--editor command`` Open the function body inside the text editor given by the command (for example, ``-e vi``). The special command ``fish`` will use the built-in editor (same as specifying ``-i``).

- ``-i`` or ``--interactive`` Force opening the function body in the built-in editor even if ``$VISUAL`` or ``$EDITOR`` is defined.

- ``-s`` or ``--save`` Automatically save the function after successfully editing it.

Example
-------

Say you want to modify your prompt.

Run::

  >_ funced fish_prompt

This will open up your editor, allowing you to modify the function. When you're done, save and quit. Fish will reload the function, so you should see the changes right away.

When you're done, use::

  >_ funcsave fish_prompt

For more, see :ref:`funcsave <cmd-funcsave>`.
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-funced:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`funced - edit a function interactively`
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			``funced`` [OPTIONS] NAME
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
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			``funced`` provides an interface to edit the definition of the function NAME.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: Fix spacing on key combinations 2020-03-20 05:47:22 +00:00			If the ``$VISUAL`` environment variable is set, it will be used as the program to edit the function. If ``$VISUAL`` is unset but ``$EDITOR`` is set, that will be used. Otherwise, a built-in editor will be used. Note that to enter a literal newline using the built-in editor you should press :kbd:`Alt`\ +\ :kbd:`Enter`. Pressing :kbd:`Enter` signals that you are done editing the function. This does not apply to an external editor like emacs or vim.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
funcsave: edit the whole file containing a function Many functions ship in files with helper functions, and it is useful to edit those too. Closes #391. 2021-08-10 13:46:00 +00:00			``funced`` will try to edit the original file that a function is defined in, which might include variable definitions or helper functions as well. If changes cannot be saved to the original file, a copy will be created in the user's function directory.

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			`If there is no function called NAME, a new function will be created with the specified name.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-e command`` or ``--editor command`` Open the function body inside the text editor given by the command (for example, ``-e vi``). The special command ``fish`` will use the built-in editor (same as specifying ``-i``).
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-i`` or ``--interactive`` Force opening the function body in the built-in editor even if ``$VISUAL`` or ``$EDITOR`` is defined.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-s`` or ``--save`` Automatically save the function after successfully editing it.
Document funced/funcsave harder [ci skip] 2020-03-19 16:59:25 +00:00
			`Example`
			`-------`

			`Say you want to modify your prompt.`

			`Run::`

			`>_ funced fish_prompt`

			`This will open up your editor, allowing you to modify the function. When you're done, save and quit. Fish will reload the function, so you should see the changes right away.`

			`When you're done, use::`

			`>_ funcsave fish_prompt`

			For more, see :ref:`funcsave <cmd-funcsave>`.