Add some doc about Signal.QUIT which can not be caught by the JVM (fixes

#912)
jline · Dec 22, 2023 · 8c9a4ab · 8c9a4ab
1 parent 0365a9c
commit 8c9a4ab
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/terminal/src/main/java/org/jline/terminal/Terminal.java b/terminal/src/main/java/org/jline/terminal/Terminal.java
@@ -60,6 +60,16 @@ interface SignalHandler {
         void handle(Signal signal);
     }
 
+    /**
+     * Registers a handler for the given {@link Signal}.
+     * <p>
+     * Note that the JVM does not easily allow catching the {@link Signal#QUIT} signal, which causes a thread dump
+     * to be displayed.  This signal is mainly used when connecting through an SSH socket to a virtual terminal.
+     *
+     * @param signal the signal to register a handler for
+     * @param handler the handler
+     * @return the previous signal handler
+     */
     SignalHandler handle(Signal signal, SignalHandler handler);
 
     void raise(Signal signal);