fish-shell/sphinx_doc_src/cmds/builtin.rst
David Adam 02d82dcf85 docs: update all command synopsis formatting
Adds synopses for those commands missing them.

Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as
fish code may not be the ideal appearance.
2019-09-17 17:59:04 +08:00

35 lines
583 B
ReStructuredText

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