fish-shell/sphinx_doc_src/cmds/suspend.rst
David Adam 02d82dcf85 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

16 lines
565 B
ReStructuredText

.. _cmd-suspend:
suspend - suspend the current shell
===================================
Synopsis
--------
::
suspend [--force]
Description
-----------
``suspend`` suspends execution of the current shell by sending it a SIGTSTP signal, returning to the controlling process. It can be resumed later by sending it a SIGCONT. In order to prevent suspending a shell that doesn't have a controlling process, it will not suspend the shell if it is a login shell. This requirement is bypassed if the ``--force`` option is given or the shell is not interactive.