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.

7 files changed, 47 insertions, 10 deletions

diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
index 7db38512d..a2f11dfe0 100644
--- a/doc/en/CMakeLists.txt
+++ b/doc/en/CMakeLists.txt
@@ -25,6 +25,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.en.adoc
@@ -41,6 +42,7 @@ if(ENABLE_MAN)
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat-headless.1.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_plugin_options.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_files.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.en.adoc
@@ -64,6 +66,7 @@ if(ENABLE_DOC)
     ${CMAKE_CURRENT_SOURCE_DIR}/../docinfo.html
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options_debug.en.adoc
     ${AUTOGEN_USER}
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Building weechat_user.en.html"
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
index b45d18c61..7a5acbb25 100644
--- a/doc/en/Makefile.am
+++ b/doc/en/Makefile.am
@@ -25,6 +25,7 @@ EXTRA_DIST = CMakeLists.txt \
              weechat.1.en.adoc \
              weechat-headless.1.en.adoc \
              cmdline_options.en.adoc \
+             cmdline_options_debug.en.adoc \
              weechat_user.en.adoc \
              weechat_plugin_api.en.adoc \
              weechat_scripting.en.adoc \
@@ -57,13 +58,13 @@ endif
 all-local: $(man_targets) $(doc_targets)
 
 # man pages
-weechat.1: weechat.1.en.adoc cmdline_options.en.adoc
+weechat.1: weechat.1.en.adoc cmdline_options.en.adoc cmdline_options_debug.en.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat.1 $(abs_top_srcdir)/doc/en/weechat.1.en.adoc
-weechat-headless.1: weechat-headless.1.en.adoc cmdline_options.en.adoc
+weechat-headless.1: weechat-headless.1.en.adoc cmdline_options.en.adoc cmdline_options_debug.en.adoc
 	$(ASCIIDOCTOR) -a revision="WeeChat $(VERSION)" -b manpage -o weechat-headless.1 $(abs_top_srcdir)/doc/en/weechat-headless.1.en.adoc
 
 # user's guide
-weechat_user.en.html: weechat_user.en.adoc cmdline_options.en.adoc $(wildcard autogen/user/*.adoc) $(abs_top_srcdir)/doc/docinfo.html
+weechat_user.en.html: weechat_user.en.adoc cmdline_options.en.adoc cmdline_options_debug.en.adoc $(wildcard autogen/user/*.adoc) $(abs_top_srcdir)/doc/docinfo.html
 	$(ASCIIDOCTOR) -a revision="$(VERSION)" -a sectanchors -a source-highlighter=prettify -o weechat_user.en.html $(abs_top_srcdir)/doc/en/weechat_user.en.adoc
 
 # plugin API reference
diff --git a/doc/en/cmdline_options_debug.en.adoc b/doc/en/cmdline_options_debug.en.adoc
new file mode 100644
index 000000000..d0f9df152
--- /dev/null
+++ b/doc/en/cmdline_options_debug.en.adoc
@@ -0,0 +1,13 @@
+*--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.
+
+*--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.
+
+*--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/en/weechat-headless.1.en.adoc b/doc/en/weechat-headless.1.en.adoc
index 49f875157..0dab42ecb 100644
--- a/doc/en/weechat-headless.1.en.adoc
+++ b/doc/en/weechat-headless.1.en.adoc
@@ -13,7 +13,7 @@ weechat-headless - the extensible chat client (headless version)
 == SYNOPSIS
 
 [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,6 +32,12 @@ It can be used for tests or to daemonize WeeChat with the option "--daemon".
 
 include::cmdline_options.en.adoc[]
 
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.en.adoc[]
+
 == PLUGIN OPTIONS
 
 include::man_plugin_options.en.adoc[]
diff --git a/doc/en/weechat.1.en.adoc b/doc/en/weechat.1.en.adoc
index 3b3237e5d..0b21fdf7d 100644
--- a/doc/en/weechat.1.en.adoc
+++ b/doc/en/weechat.1.en.adoc
@@ -13,7 +13,7 @@ weechat - the extensible chat client
 == SYNOPSIS
 
 [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]
@@ -29,6 +29,12 @@ It is highly customizable and extensible with scripts.
 
 include::cmdline_options.en.adoc[]
 
+== DEBUG OPTIONS
+
+*WARNING:* these options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.en.adoc[]
+
 == PLUGIN OPTIONS
 
 include::man_plugin_options.en.adoc[]
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc
index 0132e4876..6f8b0b40f 100644
--- a/doc/en/weechat_dev.en.adoc
+++ b/doc/en/weechat_dev.en.adoc
@@ -419,7 +419,8 @@ Documentation files:
 |    docinfo.html                      | Asciidoctor style.
 |    docgen.py                         | Python script to build files in _autogen/_ directory (see below).
 |    XX/                               | Documentation for language XX (languages: en, fr, de, it, ...).
-|       cmdline_options.XX.adoc        | Command-line options (file included in man page and user's guide).
+|       cmdline_options.XX.adoc        | Command-line general options (file included in man pages and user's guide).
+|       cmdline_options_debug.XX.adoc  | Command-line debug options (file included in man pages and user's guide).
 |       weechat.1.XX.adoc              | Man page (`man weechat`).
 |       weechat_dev.XX.adoc            | link:weechat_dev.en.html[Developer's guide] (this document).
 |       weechat_faq.XX.adoc            | link:weechat_faq.en.html[FAQ].
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 57e09bf58..cdad32134 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -504,14 +504,21 @@ To start WeeChat, issue this command:
 $ weechat
 ----
 
-Command line arguments:
-
-include::cmdline_options.en.adoc[]
-
 When you run WeeChat for the first time, the default configuration files are
 created in _~/.weechat_ with default options and values
 (see <<files_and_directories,Files and directories>>).
 
+==== Command line options
+
+include::cmdline_options.en.adoc[]
+
+==== Extra debug options
+
+[WARNING]
+These options are for debug purposes only, *DO NOT USE IN PRODUCTION!*
+
+include::cmdline_options_debug.en.adoc[]
+
 [[environment_variables]]
 === Environment variables