summaryrefslogtreecommitdiff
path: root/docs/features
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2021-04-30 12:41:02 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2021-04-30 13:12:23 -0400
commit79bf87d1e333ea5fe0dfeb61c707eb9bddfd0255 (patch)
tree1e04c689b17f752732c67a10bcc76cb4cf4bee1a /docs/features
parent37d415b4bbfd6efd383a20062df68f627451ccf7 (diff)
downloadcmd2-git-79bf87d1e333ea5fe0dfeb61c707eb9bddfd0255.tar.gz
Removed cmd2.Cmd.quit_on_sigint.
Diffstat (limited to 'docs/features')
-rw-r--r--docs/features/initialization.rst2
-rw-r--r--docs/features/misc.rst18
2 files changed, 0 insertions, 20 deletions
diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index ab792c2c..e3acf859 100644
--- a/docs/features/initialization.rst
+++ b/docs/features/initialization.rst
@@ -146,8 +146,6 @@ override:
everything available with **self_in_py**)
- **quiet**: if ``True`` then completely suppress nonessential output (Default:
``False``)
-- **quit_on_sigint**: if ``True`` Ctrl-C at the prompt will quit the program
- instead of just resetting prompt
- **settable**: dictionary that controls which of these instance attributes
are settable at runtime using the *set* command
- **timing**: if ``True`` display execution time for each command (Default:
diff --git a/docs/features/misc.rst b/docs/features/misc.rst
index 3825065f..c2f14b5b 100644
--- a/docs/features/misc.rst
+++ b/docs/features/misc.rst
@@ -99,21 +99,3 @@ method be called.
(Cmd) my dog has fleas
sh: my: not found
*** Unknown syntax: my dog has fleas
-
-
-Quit on SIGINT
---------------
-
-On many shells, SIGINT (most often triggered by the user pressing Ctrl+C)
-while at the prompt only cancels the current line, not the entire command
-loop. By default, a ``cmd2`` application matches this behavior. However, if
-``quit_on_sigint`` is set to ``True``, the command loop will quit instead.
-
-::
-
- (Cmd) typing a comma^C
- (Cmd)
-
-.. warning::
- The default SIGINT behavior will only function properly if **cmdloop** is running
- in the main thread.