[tor-commits] [torspec/master] Control-spec: document which signals have POSIX equivalents

[nickm at torproject.org]

commit 4c383824b8b120a3289d0d94bc8ff1545046c216
Author: Nick Mathewson <nickm at torproject.org>
Date:   Mon Oct 30 13:01:51 2017 -0400

    Control-spec: document which signals have POSIX equivalents
---
 control-spec.txt | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/control-spec.txt b/control-spec.txt
index 19eabcf..aea406c 100644
--- a/control-spec.txt
+++ b/control-spec.txt
@@ -428,14 +428,14 @@
 
   The meaning of the signals are:
 
-      RELOAD    -- Reload: reload config items. (like HUP)
+      RELOAD    -- Reload: reload config items.
       SHUTDOWN  -- Controlled shutdown: if server is an OP, exit immediately.
                    If it's an OR, close listeners and exit after
-                   ShutdownWaitLength seconds. (like INT)
+                   ShutdownWaitLength seconds.
       DUMP      -- Dump stats: log information about open connections and
-                   circuits. (like USR1)
-      DEBUG     -- Debug: switch all open logs to loglevel debug. (like USR2)
-      HALT      -- Immediate shutdown: clean up and exit now. (like TERM)
+                   circuits.
+      DEBUG     -- Debug: switch all open logs to loglevel debug.
+      HALT      -- Immediate shutdown: clean up and exit now.
       CLEARDNSCACHE -- Forget the client-side cached IPs for all hostnames.
       NEWNYM    -- Switch to clean circuits, so new application requests
                    don't share any circuits with old ones.  Also clears
@@ -447,6 +447,16 @@
   closes the socket if it was asked to close immediately), or "552
   Unrecognized signal" if the signal is unrecognized.
 
+  Note that not all of these signals have POSIX signal equivalents.  The
+  ones that do are as below.  You may also use these POSIX names for the
+  signal that have them.
+
+      RELOAD: HUP
+      SHUTDOWN: INT
+      HALT: TERM
+      DUMP: USR1
+      DEBUG: USR2
+
 3.8. MAPADDRESS
 
   Sent from the client to the server.  The syntax is: