aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2011-05-15 13:42:38 +0200
committerAndreas Schneider <asn@cryptomilk.org>2011-05-15 13:44:11 +0200
commit6a8cb38dd3f9a056efa435d337917a0ead1155ca (patch)
tree462347d2de459dba424ae0f177234d5d4badd762
parentbac2227ee294b5c271c165150413d7ceec35241d (diff)
downloadlibssh-6a8cb38dd3f9a056efa435d337917a0ead1155ca.tar.gz
libssh-6a8cb38dd3f9a056efa435d337917a0ead1155ca.tar.xz
libssh-6a8cb38dd3f9a056efa435d337917a0ead1155ca.zip
channel: Improve the request signal documentation.
(cherry picked from commit 32cd45612bd89714f5c597f6d9ac8c51510e3df4)
-rw-r--r--src/channels.c18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/channels.c b/src/channels.c
index 6f39b9c6..cf4b468d 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -2151,10 +2151,26 @@ error:
* In such a case this request will be silently ignored.
* Only SSH-v2 is supported (I'm not sure about SSH-v1).
*
+ * OpenSSH doesn't support signals yet, see:
+ * https://bugzilla.mindrot.org/show_bug.cgi?id=1424
+ *
* @param[in] channel The channel to send signal.
*
* @param[in] sig The signal to send (without SIG prefix)
- * (e.g. "TERM" or "KILL").
+ * \n\n
+ * SIGABRT -> ABRT \n
+ * SIGALRM -> ALRM \n
+ * SIGFPE -> FPE \n
+ * SIGHUP -> HUP \n
+ * SIGILL -> ILL \n
+ * SIGINT -> INT \n
+ * SIGKILL -> KILL \n
+ * SIGPIPE -> PIPE \n
+ * SIGQUIT -> QUIT \n
+ * SIGSEGV -> SEGV \n
+ * SIGTERM -> TERM \n
+ * SIGUSR1 -> USR1 \n
+ * SIGUSR2 -> USR2 \n
*
* @return SSH_OK on success, SSH_ERROR if an error occured
* (including attempts to send signal via SSH-v1 session).