fish-shell/sphinx_doc_src/cmds/eval.rst

.. _cmd-eval:

eval - evaluate the specified commands
======================================

Synopsis
--------

::

    eval [COMMANDS...]


Description
-----------
``eval`` evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator.

If your command does not need access to stdin, consider using ``source`` instead.

If no piping or other compound shell constructs are required, variable-expansion-as-command, as in  ``set cmd ls -la; $cmd``, is also an option.


Example
-------

The following code will call the ls command and truncate each filename to the first 12 characters.

::

    set cmd ls \| cut -c 1-12
    eval $cmd
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-eval:`

Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00			`eval - evaluate the specified commands`
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: 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 09:59:04 +00:00			`::`

			`eval [COMMANDS...]`
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			`-----------`
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``eval`` evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator.
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			If your command does not need access to stdin, consider using ``source`` instead.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
"eval" example to use $cmd as an array Signed-off-by: Osamu Aoki <osamu@debian.org> 2019-11-18 15:02:21 +00:00			If no piping or other compound shell constructs are required, variable-expansion-as-command, as in ``set cmd ls -la; $cmd``, is also an option.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Variables as commands are in fact supported, eval docs should not claim otherwise. (#5819) Provide an example that somewhat justifies eval's existence in light of this change. Also correct similar misinformation found in a comment. 2019-04-26 13:30:13 +00:00			`Example`
			`-------`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
Variables as commands are in fact supported, eval docs should not claim otherwise. (#5819) Provide an example that somewhat justifies eval's existence in light of this change. Also correct similar misinformation found in a comment. 2019-04-26 13:30:13 +00:00			`The following code will call the ls command and truncate each filename to the first 12 characters.`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
			`::`

Variables as commands are in fact supported, eval docs should not claim otherwise. (#5819) Provide an example that somewhat justifies eval's existence in light of this change. Also correct similar misinformation found in a comment. 2019-04-26 13:30:13 +00:00			`set cmd ls \\| cut -c 1-12`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00			`eval $cmd`

Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00