diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-03-14 12:52:54 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-14 12:52:54 -0400 |
| commit | 9068d5f7b32a3c628861a60ca3b19fa1304f37c9 (patch) | |
| tree | 04360cac616adbdf77f01f97450f1f07e9efd2d3 | |
| parent | 7aafd5f10169ca06c0b7d3935586cdac2789f311 (diff) | |
| parent | 567883c75826af11272259314dbbcf73a84f262a (diff) | |
| download | cmd2-git-9068d5f7b32a3c628861a60ca3b19fa1304f37c9.tar.gz | |
Merge pull request #307 from MarkLalor/docs/quit_on_sigint
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 ====== |