fish-shell/doc_src/cmds/builtin.rst
David Adam 3a23fdf359 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-12 00:21:13 +08:00

38 lines
713 B
ReStructuredText

.. _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.
**-h** or **--help**
Displays help about using this command.
Example
-------
::
builtin jobs
# executes the jobs builtin, even if a function named jobs exists