diff options
author | Mark Lalor <markwlalor@gmail.com> | 2018-03-14 04:36:17 -0400 |
---|---|---|
committer | Mark Lalor <markwlalor@gmail.com> | 2018-03-14 04:36:17 -0400 |
commit | 567883c75826af11272259314dbbcf73a84f262a (patch) | |
tree | 96cd7565bf1bd2367aa90bb6a987c3636eb95ceb | |
parent | ece4ab4e8c02421efd467eebaa6b36d8b7dead00 (diff) | |
download | cmd2-git-567883c75826af11272259314dbbcf73a84f262a.tar.gz |
Added documentation for quit_on_sigint
-rw-r--r-- | docs/settingchanges.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/settingchanges.rst b/docs/settingchanges.rst index ab7254a3..67292a48 100644 --- a/docs/settingchanges.rst +++ b/docs/settingchanges.rst @@ -73,6 +73,21 @@ application's own ``default`` method be called. 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) 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. + +:: + + (Cmd) typing a comma^C + (Cmd) + + Timing ====== |