fish-shell/doc_src/cmds/command.rst

.. _cmd-command:

command - run a program
=======================

Synopsis
--------

**command** [**OPTIONS**] [*COMMANDNAME* [ARG ...]]

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

**command** forces the shell to execute the program *COMMANDNAME* and ignore any functions or builtins with the same name.

The following options are available:

**-a** or **--all**
    Prints all *COMMAND* found in :envvar:`PATH`, in the order found.

**-q** or **--query**
    Silence output and print nothing, setting only exit status.
    Implies **--search**.
    For compatibility, this is also **--quiet** (deprecated).

**-v** (or **-s** or **--search**)
    Prints the external command that would be executed, or prints nothing if no file with the specified name could be found in :envvar:`PATH`.

With the **-v** option, ``command`` treats every argument as a separate command to look up and sets the exit status to 0 if any of the specified commands were found, or 127 if no commands could be found. **--quiet** used with **-v** prevents commands being printed, like ``type -q``.

Examples
--------

| ``command ls`` executes the ``ls`` program, even if an ``ls`` function also exists.
| ``command -s ls`` prints the path to the ``ls`` program.
| ``command -q git; and command git log`` runs ``git log`` only if ``git`` 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-command:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`command - run a program`
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: remove unconventional spaces inside [] and () We usually write "[a \| b]", not "[ a \| b ]". 2022-01-09 09:00:47 +00:00			`command [OPTIONS] [COMMANDNAME [ARG ...]]`
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
Harmonize some idiosyncrancies introduced For now, we are going with ``command`` for builtins and fish scripts, and keyword for parser keywords like if or and. 2021-12-17 23:20:46 +00:00			`command forces the shell to execute the program COMMANDNAME and ignore any functions or builtins with the same name.`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
			`The following options are available:`

cd, cdh, command, commandline Documentation. 2021-12-09 12:45:10 +00:00			`-a or --all`
			Prints all COMMAND found in :envvar:`PATH`, in the order found.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
cd, cdh, command, commandline Documentation. 2021-12-09 12:45:10 +00:00			`-q or --query`
			`Silence output and print nothing, setting only exit status.`
			`Implies --search.`
			`For compatibility, this is also --quiet (deprecated).`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
cd, cdh, command, commandline Documentation. 2021-12-09 12:45:10 +00:00			`-v (or -s or --search)`
			Prints the external command that would be executed, or prints nothing if no file with the specified name could be found in :envvar:`PATH`.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Update command.rst 2021-12-12 08:17:16 +00:00			With the -v option, ``command`` treats every argument as a separate command to look up and sets the exit status to 0 if any of the specified commands were found, or 127 if no commands could be found. --quiet used with -v prevents commands being printed, like ``type -q``.
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			`Examples`
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
Update command.rst 2021-12-12 08:17:16 +00:00			\| ``command ls`` executes the ``ls`` program, even if an ``ls`` function also exists.
			\| ``command -s ls`` prints the path to the ``ls`` program.
cd, cdh, command, commandline Documentation. 2021-12-09 12:45:10 +00:00			\| ``command -q git; and command git log`` runs ``git log`` only if ``git`` exists.