summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKevin Van Brunt <kmvanbrunt@gmail.com>2020-03-26 13:38:30 -0400
committerKevin Van Brunt <kmvanbrunt@gmail.com>2020-03-26 13:38:30 -0400
commit662a7842f93c3c89b95697e9a81f277f729e132d (patch)
treee78dfd9a7535ab7454ae786608cbcd3ea1394d15 /docs
parent990ec45e087aed2a9a6309db893c8a25cb3a89fd (diff)
downloadcmd2-git-662a7842f93c3c89b95697e9a81f277f729e132d.tar.gz
Ctrl-C now stops a running text script instead of just the current script command
Diffstat (limited to 'docs')
-rw-r--r--docs/features/initialization.rst4
-rw-r--r--docs/features/misc.rst8
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index b1ca4f05..d79b3818 100644
--- a/docs/features/initialization.rst
+++ b/docs/features/initialization.rst
@@ -146,8 +146,8 @@ override:
everything available with **self_in_py**)
- **quiet**: if ``True`` then completely suppress nonessential output (Default:
``False``)
-- **quit_on_sigint**: if ``True`` quit the main loop on interrupt instead of
- just resetting prompt
+- **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 0dc1939c..3825065f 100644
--- a/docs/features/misc.rst
+++ b/docs/features/misc.rst
@@ -104,10 +104,10 @@ method be called.
Quit on SIGINT
--------------
-On many shells, SIGINT (most often triggered by the user pressing Ctrl+C) only
-cancels the current line, not the entire command loop. By default, a ``cmd2``
-application will quit on receiving this signal. However, if ``quit_on_sigint``
-is set to ``False``, then the current line will simply be cancelled.
+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.
::