mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-30 06:03:49 +08:00
c0d1e41313
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
84 lines
3.6 KiB
ReStructuredText
84 lines
3.6 KiB
ReStructuredText
.. _cmd-functions:
|
|
|
|
functions - print or erase functions
|
|
====================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
functions [-a | --all] [-n | --names]
|
|
functions [-D | --details] [-v] FUNCTION
|
|
functions -c OLDNAME NEWNAME
|
|
functions -d DESCRIPTION FUNCTION
|
|
functions [-e | -q] FUNCTION ...
|
|
|
|
Description
|
|
-----------
|
|
|
|
``functions`` prints or erases functions.
|
|
|
|
The following options are available:
|
|
|
|
- ``-a`` or ``--all`` lists all functions, even those whose name starts with an underscore.
|
|
|
|
- ``-c OLDNAME NEWNAME`` or ``--copy OLDNAME NEWNAME`` creates a new function named NEWNAME, using the definition of the OLDNAME function.
|
|
|
|
- ``-d DESCRIPTION`` or ``--description=DESCRIPTION`` changes the description of this function.
|
|
|
|
- ``-e`` or ``--erase`` causes the specified functions to be erased. This also means that it is prevented from autoloading in the current session. Use :ref:`funcsave <cmd-funcsave>` to remove the saved copy.
|
|
|
|
- ``-D`` or ``--details`` reports the path name where the specified function is defined or could be autoloaded, ``stdin`` if the function was defined interactively or on the command line or by reading stdin, ``-`` if the function was created via :ref:`source <cmd-source>`, and ``n/a`` if the function isn't available. (Functions created via :ref:`alias <cmd-alias>` will return ``-``, because ``alias`` uses ``source`` internally.) If the ``--verbose`` option is also specified then five lines are written:
|
|
|
|
- the pathname as already described,
|
|
- ``autoloaded``, ``not-autoloaded`` or ``n/a``,
|
|
- the line number within the file or zero if not applicable,
|
|
- ``scope-shadowing`` if the function shadows the vars in the calling function (the normal case if it wasn't defined with ``--no-scope-shadowing``), else ``no-scope-shadowing``, or ``n/a`` if the function isn't defined,
|
|
- the function description minimally escaped so it is a single line, or ``n/a`` if the function isn't defined or has no description.
|
|
|
|
You should not assume that only five lines will be written since we may add additional information to the output in the future.
|
|
|
|
- ``--no-details`` turns off function path reporting, so just the definition will be printed.
|
|
|
|
- ``-n`` or ``--names`` lists the names of all defined functions.
|
|
|
|
- ``-q`` or ``--query`` tests if the specified functions exist.
|
|
|
|
- ``-v`` or ``--verbose`` will make some output more verbose.
|
|
|
|
- ``-H`` or ``--handlers`` will show all event handlers.
|
|
|
|
- ``-t`` or ``--handlers-type TYPE`` will show all event handlers matching the given type
|
|
|
|
The default behavior of ``functions``, when called with no arguments, is to print the names of all defined functions. Unless the ``-a`` option is given, no functions starting with underscores are included in the output.
|
|
|
|
If any non-option parameters are given, the definition of the specified functions are printed.
|
|
|
|
Copying a function using ``-c`` copies only the body of the function, and does not attach any event notifications from the original function.
|
|
|
|
Only one function's description can be changed in a single invocation of ``functions -d``.
|
|
|
|
The exit status of ``functions`` is the number of functions specified in the argument list that do not exist, which can be used in concert with the ``-q`` option.
|
|
|
|
|
|
Examples
|
|
--------
|
|
|
|
|
|
::
|
|
|
|
functions -n
|
|
# Displays a list of currently-defined functions
|
|
|
|
functions -c foo bar
|
|
# Copies the 'foo' function to a new function called 'bar'
|
|
|
|
functions -e bar
|
|
# Erases the function ``bar``
|
|
|
|
See more
|
|
--------
|
|
|
|
For more explanation of how functions fit into fish, see :ref:`Functions <syntax-function>`.
|