fish-shell/sphinx_doc_src/cmds/builtin.rst

.. _cmd-builtin:

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

Synopsis
--------

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


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 builtins exists


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
Incorporate most new doc changes since branch Adds most documentation changes since 72c0213d42b77b2f01223b5515669840110ea9b9 2019-02-24 23:01:16 +00:00			`builtin [OPTIONS...] BUILTINNAME`
			`builtin --query BUILTINNAMES...`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
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:`

Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			- ``-n`` or ``--names`` List the names of all defined builtins
Incorporate most new doc changes since branch Adds most documentation changes since 72c0213d42b77b2f01223b5515669840110ea9b9 2019-02-24 23:01:16 +00:00			- ``-q`` or ``--query`` tests if any of the specified builtins exists
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`