fish-shell/doc_src/cmds/funced.rst

.. _cmd-funced:

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

Synopsis
--------

.. 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-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.

**-h** or **--help**
    Displays help about using this command.

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 :doc:`funcsave <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 17:05:09 +08:00			`.. _cmd-funced:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`funced - edit a function interactively`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`======================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the *, , and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/\|\| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [\|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750 2022-01-09 22:09:46 +08:00			`.. synopsis::`

			`funced [OPTIONS] NAME`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08: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-18 07:16:47 +08: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-17 05:08:41 +08:00
docs: use canonical key names in :kbd: tags This seems a bit better because it's what bind uses. To makes sure that something like :kbd:`ctrl-x` looks good in HTML, remove the border from the kbd style. Else both "ctrl" and "x" get small boxes which looks weird. 2024-04-14 02:30:07 +08: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-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-17 05:08:41 +08: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 21:46:00 +08: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-18 07:16:47 +08: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-17 05:08:41 +08:00
docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 23:56:20 +08: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-17 05:08:41 +08:00
docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 23:56:20 +08: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-17 05:08:41 +08:00
docs: standardise on definition lists for options Harmonizes the option listing including formatting in a similar manner to the synopsis of each entry. 2022-03-11 23:56:20 +08:00			`-s or --save`
			`Automatically save the function after successfully editing it.`
Document funced/funcsave harder [ci skip] 2020-03-20 00:59:25 +08:00
docs: omnibus cleanup 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. 2022-03-12 00:18:41 +08:00			`-h or --help`
			`Displays help about using this command.`

Document funced/funcsave harder [ci skip] 2020-03-20 00:59:25 +08: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`

docs: Use :doc: role when linking to commands This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands. 2022-09-24 01:57:49 +08:00			For more, see :doc:`funcsave <funcsave>`.