summaryrefslogtreecommitdiff
path: root/doc/en/weechat_user.en.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2019-03-31 23:53:54 +0200
committerSébastien Helleu <flashcode@flashtux.org>2019-03-31 23:53:54 +0200
commit413aa499cc61ee3ce18c57fc891ecc314b064a9f (patch)
treef94945c37faf0a7aa9ea77d45f0d552ec3d96b9b /doc/en/weechat_user.en.adoc
parentc469f30be595bcf70feee6e0982961c199f78583 (diff)
downloadweechat-413aa499cc61ee3ce18c57fc891ecc314b064a9f.zip
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.
Diffstat (limited to 'doc/en/weechat_user.en.adoc')
-rw-r--r--doc/en/weechat_user.en.adoc15
1 files changed, 11 insertions, 4 deletions
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