Docs + changelog re #823, fixes #823

fabric · Jan 29, 2013 · bcf2d40 · bcf2d40
1 parent 83919d3
commit bcf2d40
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -25,6 +25,10 @@ would have also been included in the 1.2 line.
 Changelog
 =========
 
+* :feature:`823` Add :ref:`env.remote_interrupt <remote-interrupt>` which
+  controls whether Ctrl-C is forwarded to the remote end or is captured locally
+  (previously, only the latter behavior was implemented). Thanks to Geert
+  Jansen for the patch.
 * :release:`1.5.3 <2013-01-28>`
 * :bug:`806` Force strings given to ``getpass`` during password prompts to be
   ASCII, to prevent issues on some platforms when Unicode is encountered.

diff --git a/docs/usage/env.rst b/docs/usage/env.rst
@@ -523,6 +523,27 @@ far. For informational purposes only.
 
 .. seealso:: :doc:`fab`
 
+
+.. _remote-interrupt:
+
+``remote_interrupt``
+--------------------
+
+**Default:** ``None``
+
+Controls whether Ctrl-C triggers an interrupt remotely or is captured locally,
+as follows:
+
+* ``None`` (the default): only `~fabric.operations.open_shell` will exhibit
+  remote interrupt behavior, and
+  `~fabric.operations.run`/`~fabric.operations.sudo` will capture interrupts
+  locally.
+* ``False``: even `~fabric.operations.open_shell` captures locally.
+* ``True``: all functions will send the interrupt to the remote end.
+
+.. versionadded:: 1.6
+
+
 .. _rcfile:
 
 ``rcfile``