core: add documentation on command line debug options (in --help and man pages)

Command line debug options are now documented:

* --no-dlclose: do not call the function dlclose after plugins are unloaded
* --no-gnutls: do not call the init and deinit functions of GnuTLS library
* --no-gcrypt: do not call the init and deinit functions of Gcrypt library

These options must not be used in production, they're for debug only and can be
used with tools like Valgrind or electric-fence.

5 files changed, 37 insertions, 5 deletions

diff --git a/doc/cs/CMakeLists.txt b/doc/cs/CMakeLists.txt
index fbfb764ff..7710e7bc3 100644
--- a/doc/cs/CMakeLists.txt
+++ b/doc/cs/CMakeLists.txt
@@ -25,6 +25,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.cs.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.cs.adoc
@@ -41,6 +42,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat-headless.1.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.cs.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.cs.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.cs.adoc
diff --git a/doc/cs/Makefile.am b/doc/cs/Makefile.am
index b9ab39d52..c6cec1621 100644
--- a/doc/cs/Makefile.am
+++ b/doc/cs/Makefile.am
@@ -24,6 +24,7 @@ EXTRA_DIST = CMakeLists.txt \
              weechat.1.cs.adoc \
              weechat-headless.1.cs.adoc \
              cmdline_options.cs.adoc \
+             cmdline_options_debug.cs.adoc \
              weechat_quickstart.cs.adoc \
              $(wildcard autogen/user/*.adoc) \
              $(wildcard autogen/plugin_api/*.adoc)
@@ -42,9 +43,9 @@ endif
 all-local: $(man_targets) $(doc_targets)
 
 # man pages
-weechat.1: weechat.1.cs.adoc cmdline_options.cs.adoc
+weechat.1: weechat.1.cs.adoc cmdline_options.cs.adoc cmdline_options_debug.cs.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat.1 $(abs_top_srcdir)/doc/cs/weechat.1.cs.adoc
-weechat-headless.1: weechat-headless.1.cs.adoc cmdline_options.cs.adoc
+weechat-headless.1: weechat-headless.1.cs.adoc cmdline_options.cs.adoc cmdline_options_debug.cs.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat-headless.1 $(abs_top_srcdir)/doc/cs/weechat-headless.1.cs.adoc
 
 # quickstart
diff --git a/doc/cs/cmdline_options_debug.cs.adoc b/doc/cs/cmdline_options_debug.cs.adoc
new file mode 100644
index 000000000..5e88ef3ae
--- /dev/null
+++ b/doc/cs/cmdline_options_debug.cs.adoc
@@ -0,0 +1,16 @@
+// TRANSLATION MISSING
+*--no-dlclose*::
+    Do not call the function dlclose after plugins are unloaded.
+    This is useful with tools like Valgrind to display stack for unloaded
+    plugins.
+
+// TRANSLATION MISSING
+*--no-gnutls*::
+    Do not call the init and deinit functions of GnuTLS library.
+    This is useful with tools like Valgrind and electric-fence, to prevent
+    GnuTLS memory errors.
+
+// TRANSLATION MISSING
+*--no-gcrypt*::
+    Do not call the init and deinit functions of Gcrypt library.
+    This is useful with tools like Valgrind, to prevent Gcrypt memory errors.
diff --git a/doc/cs/weechat-headless.1.cs.adoc b/doc/cs/weechat-headless.1.cs.adoc
index 74cef105d..4076c8b70 100644
--- a/doc/cs/weechat-headless.1.cs.adoc
+++ b/doc/cs/weechat-headless.1.cs.adoc
@@ -16,7 +16,7 @@ weechat-headless - the extensible chat client (headless version)
 
 // TRANSLATION MISSING
 [verse]
-*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-t|--temp-dir] [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [debug-option...] [plugin:option...]
 *weechat-headless* [-c|--colors]
 *weechat-headless* [-h|--help]
 *weechat-headless* [-l|--license]
@@ -32,11 +32,17 @@ v obvyklých sciptovacích jazycích.
 The command *weechat-headless* runs WeeChat in a headless mode (no interface).
 It can be used for tests or to daemonize WeeChat with the option "--daemon".
 
-
 == VOLBY
 
 include::cmdline_options.cs.adoc[]
 
+// TRANSLATION MISSING
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.cs.adoc[]
+
 == VOLBY PLUGINŮ
 
 include::man_plugin_options.cs.adoc[]
diff --git a/doc/cs/weechat.1.cs.adoc b/doc/cs/weechat.1.cs.adoc
index 04847d2f3..11824d84f 100644
--- a/doc/cs/weechat.1.cs.adoc
+++ b/doc/cs/weechat.1.cs.adoc
@@ -15,7 +15,7 @@ weechat - the extensible chat client
 
 // TRANSLATION MISSING
 [verse]
-*weechat* [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir]  [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+*weechat* [-a|--no-connect] [-d|--dir <path>] [-t|--temp-dir]  [-p|--no-plugin] [-P|--plugins <plugins>] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [debug-option...] [plugin:option...]
 *weechat* [-c|--colors]
 *weechat* [-h|--help]
 *weechat* [-l|--license]
@@ -31,6 +31,13 @@ v obvyklých sciptovacích jazycích.
 
 include::cmdline_options.cs.adoc[]
 
+// TRANSLATION MISSING
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.cs.adoc[]
+
 == VOLBY PLUGINŮ
 
 include::man_plugin_options.cs.adoc[]