diff options
| author |  Mike Meyer <mwm@mired.org> | 2015-08-31 11:11:09 -0400 |
|---|---|---|
| committer |  Fabian Homborg <FHomborg@gmail.com> | 2015-09-02 13:40:43 +0200 |
| commit | 06615534841390045c23aaa409dfae124f04383c (patch) | |
| tree | c5e13baec4d5ef1eca91a41af0a5b8d073ea82e6 /doc_src | |
| parent | 5f080fcfc990ad6673f15c0382c7d6468c1b083e (diff) | |
Add suspend help page.
Diffstat (limited to 'doc_src')
| -rw-r--r-- | doc_src/suspend.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc_src/suspend.txt b/doc_src/suspend.txt new file mode 100644 index 00000000..8b5dc16a --- /dev/null +++ b/doc_src/suspend.txt @@ -0,0 +1,14 @@ +\section suspend suspend - suspend the current shell + +\subsection suspend-synopsis Synopsis +\fish{synopsis} +suspend [--force] +\endfish + +\subsection suspend-description Description + +`suspend` suspends the current shell. In order to prevent suspending a +shell that isn't a subshell, it will not suspend a shell if it is a +login shell, or of `$SHLVLV` is less `$suspend_minimum_SHLVL`, which +defaults to three. This test is skipped if the `--force` option is +given or the shell is not interactive. |