about summary refs log tree commit diff
path: root/Doc/Zsh/params.yo
diff options
context:
space:
mode:
authorPeter Stephenson <p.w.stephenson@ntlworld.com>2014-12-07 20:21:49 +0000
committerPeter Stephenson <p.w.stephenson@ntlworld.com>2014-12-07 21:10:07 +0000
commit151b95cfd2098de3424923f898179142062ff818 (patch)
tree267ec48308a09a36e4526c58243f3facec633cd3 /Doc/Zsh/params.yo
parent20f694d101ae72d2ffecc28abe90144ffeeb27e4 (diff)
downloadzsh-151b95cfd2098de3424923f898179142062ff818.tar.gz
zsh-151b95cfd2098de3424923f898179142062ff818.tar.xz
zsh-151b95cfd2098de3424923f898179142062ff818.zip
33918: add TRY_BLOCK_INTERRUPT
This works the same as TRY_BLOCK_ERROR, but for a SIGINT, too.

Evena added documentation, like the professionals!  Amended along the
lines suggested by Bart in 33918.
Diffstat (limited to 'Doc/Zsh/params.yo')
-rw-r--r--Doc/Zsh/params.yo11
1 files changed, 11 insertions, 0 deletions
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index 5833d6be9..996f87c4f 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -754,6 +754,17 @@ It may be reset, clearing the error condition.  See
 ifzman(em(Complex Commands) in zmanref(zshmisc))\
 ifnzman(noderef(Complex Commands))
 )
+vinde(TRY_BLOCK_INTERRUPT)
+item(tt(TRY_BLOCK_INTERRUPT) <S>)(
+This variable works in a similar way to tt(TRY_BLOCK_ERROR), but
+represents the status of an interrupt from the signall SIGINT, which
+typically comes from the keyboard when the user types tt(^C).  If set to
+0, any such interrupt will be reset; otherwise, the interrupt is
+propagated after the tt(always) block.
+
+Note that it is possible that an interrupt arrives during the execution
+of the tt(always) block; this interrupt is also propagated.
+)
 vindex(TTY)
 item(tt(TTY))(
 The name of the tty associated with the shell, if any.