fish-shell/doc_src/cmds/builtin.rst

.. _cmd-builtin:

builtin - run a builtin command
===============================

Synopsis
--------

.. synopsis::

    builtin [OPTIONS] BUILTINNAME
    builtin --query BUILTINNAME ...
    builtin --names

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

``builtin`` forces the shell to use a builtin command named *BUILTIN*, rather than a function or external program.

The following options are available:

**-n** or **--names**
    Lists the names of all defined builtins.

**-q** or **--query** *BUILTIN*
    Tests if any of the specified builtins exist. If any exist, it returns 0, 1 otherwise.

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

Example
-------

::

    builtin jobs
    # executes the jobs builtin, even if a function named jobs exists
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-builtin:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`builtin - run a builtin command`
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
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 14:09:46 +00:00			`.. synopsis::`

			`builtin [OPTIONS] BUILTINNAME`
			`builtin --query BUILTINNAME ...`
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-11 16:18:41 +00:00			`builtin --names`
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
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-11 16:18:41 +00:00			``builtin`` forces the shell to use a builtin command named BUILTIN, rather than a function or external program.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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 15:56:20 +00:00			`The following options are available:`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
More documentation work 2021-12-09 11:53:13 +00:00			`-n or --names`
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 15:56:20 +00:00			`Lists the names of all defined builtins.`

			`-q or --query BUILTIN`
docs: Document type/builtin exit status Fixes #9252 2022-09-30 16:50:14 +00:00			`Tests if any of the specified builtins exist. If any exist, it returns 0, 1 otherwise.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00: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-11 16:18:41 +00:00			`-h or --help`
			`Displays help about using this command.`

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
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
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`::`

			`builtin jobs`
			`# executes the jobs builtin, even if a function named jobs exists`