From 06615534841390045c23aaa409dfae124f04383c Mon Sep 17 00:00:00 2001 From: Mike Meyer Date: Mon, 31 Aug 2015 11:11:09 -0400 Subject: [PATCH] Add suspend help page. --- doc_src/suspend.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 doc_src/suspend.txt diff --git a/doc_src/suspend.txt b/doc_src/suspend.txt new file mode 100644 index 000000000..8b5dc16a1 --- /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.