fish-shell/doc_src/cmds/block.rst

.. _cmd-block:

block - temporarily block delivery of events
============================================

Synopsis
--------

::

    block [OPTIONS...]


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

``block`` prevents events triggered by ``fish`` or the :ref:`emit <cmd-emit>` command from being delivered and acted upon while the block is in place.

In functions, ``block`` can be useful while performing work that should not be interrupted by the shell.

The block can be removed. Any events which triggered while the block was in place will then be delivered.

Event blocks should not be confused with code blocks, which are created with ``begin``, ``if``, ``while`` or ``for``

The following parameters are available:

- ``-l`` or ``--local`` Release the block automatically at the end of the current innermost code block scope

- ``-g`` or ``--global`` Never automatically release the lock

- ``-e`` or ``--erase`` Release global block


Example
-------

::

    # Create a function that listens for events
    function --on-event foo foo; echo 'foo fired'; end

    # Block the delivery of events
    block -g

    emit foo
    # No output will be produced

    block -e
    # 'foo fired' will now be printed


Notes
-----

Note that events are only received from the current fish process as there is no way to send events from one fish process to another.
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 17:05:09 +08:00			`.. _cmd-block:`

Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00			`block - temporarily block delivery of events`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`============================================`
Switch command docs from \section to reStructuredText 2018-12-17 09:39:33 +08:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08: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 17:59:04 +08:00			`::`

			`block [OPTIONS...]`
Migrate the 'synopsis' sections to .rst format 2018-12-18 09:58:24 +08:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Description`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
docs: Use command labels [ci skip] 2019-03-31 17:07:59 +08:00			``block`` prevents events triggered by ``fish`` or the :ref:`emit <cmd-emit>` command from being delivered and acted upon while the block is in place.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			In functions, ``block`` can be useful while performing work that should not be interrupted by the shell.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`The block can be removed. Any events which triggered while the block was in place will then be delivered.`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			Event blocks should not be confused with code blocks, which are created with ``begin``, ``if``, ``while`` or ``for``
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`The following parameters are available:`

Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-l`` or ``--local`` Release the block automatically at the end of the current innermost code block scope
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-g`` or ``--global`` Never automatically release the lock
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch backticks to double backticks for rst compatibility 2018-12-20 04:02:45 +08:00			- ``-e`` or ``--erase`` Release global block
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Example`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`::`

			`# Create a function that listens for events`
			`function --on-event foo foo; echo 'foo fired'; end`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`# Block the delivery of events`
			`block -g`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`emit foo`
			`# No output will be produced`
docs: whitespace cleanup in source Fixes some lint warnings. 2019-09-17 16:50:52 +08:00
Switch \fish sections to rst format 2018-12-19 11:14:04 +08:00			`block -e`
			`# 'foo fired' will now be printed`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00

Convert \\subsection sections into rst format 2018-12-19 10:44:30 +08:00			`Notes`
Fix command section separator line lengths 2019-01-03 12:10:47 +08:00			`-----`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-17 05:08:41 +08:00
			`Note that events are only received from the current fish process as there is no way to send events from one fish process to another.`