about summary refs log tree commit diff
path: root/Doc/Zsh/params.yo
diff options
context:
space:
mode:
authorPeter Stephenson <pws@zsh.org>2015-11-17 10:43:23 +0000
committerPeter Stephenson <pws@zsh.org>2015-11-17 10:43:23 +0000
commitbc543abbf6e90ea8678b97cc36732e6f94bbe199 (patch)
tree912e79226bb6695c40700a8518996c8f62b24929 /Doc/Zsh/params.yo
parent8d1e882b78e3ccc3d66cfc61e1d7e3e53f60d67f (diff)
downloadzsh-bc543abbf6e90ea8678b97cc36732e6f94bbe199.tar.gz
zsh-bc543abbf6e90ea8678b97cc36732e6f94bbe199.tar.xz
zsh-bc543abbf6e90ea8678b97cc36732e6f94bbe199.zip
37127: document indexing of $signals
Diffstat (limited to 'Doc/Zsh/params.yo')
-rw-r--r--Doc/Zsh/params.yo8
1 files changed, 7 insertions, 1 deletions
diff --git a/Doc/Zsh/params.yo b/Doc/Zsh/params.yo
index b896e2d70..eb31286e4 100644
--- a/Doc/Zsh/params.yo
+++ b/Doc/Zsh/params.yo
@@ -771,7 +771,13 @@ Incremented by one each time a new shell is started.
 )
 vindex(signals)
 item(tt(signals))(
-An array containing the names of the signals.
+An array containing the names of the signals.  Note that with
+the standard zsh numbering of array indices, where the first element
+has index 1, the signals are offset by 1 from the signal number
+used by the operating system.  For example, on typical Unix-like systems
+tt(HUP) is signal number 1, but is referred to as tt($signals[2]).  This
+is because of tt(EXIT) at position 1 in the array, which is used
+internally by zsh but is not known to the operating system.
 )
 vindex(TRY_BLOCK_ERROR)
 item(tt(TRY_BLOCK_ERROR) <S>)(