exec-helper-plugins-sh.rst

Sh plugin

Description

The sh plugin is used for executing commands in the sh shell, rather than executing the command right away. This is very useful for executing command lines that need special shell characters like &&, |, ;, >.

Mandatory settings

Mandatory settings for all modes

.. program:: exec-helper-plugins-sh

.. describe:: command

    Command to execute in the shell, as a string. See the :code:`-c` option of :code:`sh` for more information.

Optional settings

The configuration of the sh plugin may contain the following additional settings:

.. program:: exec-helper-plugins-sh

Example

Configuration

.. literalinclude:: ../examples/sh.example
    :language: yaml

Usage

Save the example to an :program:`exec-helper` configuration file and execute in the same directory:

eh example

See also

See :ref:`exec-helper` (1) for information about the usage of :program:`exec-helper`.

See :ref:`exec-helper-config` (5) for information about the configuration file format.

See :ref:`exec-helper-plugins` (5) for information about the configuration file format.