fish-shell/doc_src/cmds/builtin.rst

.. _cmd-builtin:

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

Synopsis
--------

| **builtin** [*OPTIONS*] *BUILTINNAME*
| **builtin** --query *BUILTINNAME* ...

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

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

The following parameters are available:

**-n** or **--names**
    List the names of all defined builtins
**-q** or **--query**
    Tests if any of the specified builtin(s) exist

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 synopses: use ellipsis with singular words We use plural "OPTIONS" more often than "OPTION...", so let's do that everywhere. In some other places where we do have an ellipsis, make sure to use singular, since the ellipsis already means repetition. This change is incomplete, and I'm not sure if this is worth it, since it's subjective, so I might drop it. 2022-01-09 08:42:36 +00:00			`\| builtin [OPTIONS] BUILTINNAME`
			`\| builtin --query BUILTINNAME ...`
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
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``builtin`` forces the shell to use a builtin command, rather than a function or program.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`The following parameters are available:`

More documentation work 2021-12-09 11:53:13 +00:00			`-n or --names`
			`List the names of all defined builtins`
			`-q or --query`
			`Tests if any of the specified builtin(s) exist`
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			`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`