Document tls-exit option mainly as test option

Change-Id: I93afff2372c4150d6bddc8c07fd4ebc8bfb0cc3e Signed-off-by: Arne Schwabe <[email protected]> Acked-by: Frank Lichtenheld <[email protected]> Message-Id: <[email protected]> URL: https://www.mail-archive.com/[email protected]/msg27626.html Signed-off-by: Gert Doering <[email protected]> (cherry picked from commit ee6417e)
OpenVPN · Dec 2, 2023 · 350bdd8 · 350bdd8
1 parent 1a6aef3
commit 350bdd8
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
@@ -537,7 +537,9 @@ certificates and keys: https://github.com/OpenVPN/easy-rsa
   code.
 
 --tls-exit
-  Exit on TLS negotiation failure.
+  Exit on TLS negotiation failure. This option can be useful when you only
+  want to make one attempt at connecting, e.g. in a test or monitoring script.
+  (OpenVPN's own test suite uses it this way.)
 
 --tls-export-cert directory
   Store the certificates the clients use upon connection to this