doc: move files cmdline_options.xx.adoc and man.xx.adoc into "includes" directory

2 files changed, 189 insertions, 0 deletions

diff --git a/doc/en/includes/cmdline_options.en.adoc b/doc/en/includes/cmdline_options.en.adoc
new file mode 100644
index 000000000..26f815ad1
--- /dev/null
+++ b/doc/en/includes/cmdline_options.en.adoc
@@ -0,0 +1,79 @@
+// tag::standard[]
+*-a*, *--no-connect*::
+    Disable auto-connect to servers when WeeChat is starting.
+
+*-c*, *--colors*::
+    Display default colors in terminal.
+
+*--daemon*::
+    Run WeeChat in background, as a daemon (works only with the command
+    *weechat-headless*).
+
+*--stdout*::
+    Display log messages on standard output instead of writing them in log file
+    (works only with the command *weechat-headless*, not compatible with option
+    "--daemon").
+
+*-d*, *--dir* _<path>_::
+    Set path as home for WeeChat (used for configuration files, logs, user
+    plugins and scripts), default value is "~/.weechat" (note: directory is
+    created if not found by WeeChat).
+    If this option is not given, the environment variable WEECHAT_HOME is used
+    (if not empty).
+
+*-t*, *--temp-dir*::
+    Create a temporary WeeChat home directory and delete it on exit
+    (incompatible with option "-d"). +
+    The name of the directory is automatically built by WeeChat, with this
+    template: "weechat_temp_XXXXXX" (where "XXXXXX" is random). It it created
+    in the first available directory in this list: environment variable "TMPDIR",
+    "/tmp" (may be different according to the operating system), environment
+    variable "HOME", current directory. +
+    The temporary home directory has permissions 0700 (only owner can read,
+    write and execute).
+
+*-h*, *--help*::
+    Display help.
+
+*-l*, *--license*::
+    Display WeeChat license.
+
+*-p*, *--no-plugin*::
+    Disable plugins auto-load.
+
+*-P*, *--plugins* _<plugins>_::
+    Load only these plugins at startup (see /help weechat.plugin.autoload).
+    If this option is given, the option weechat.plugin.autoload is not used.
+
+*-r*, *--run-command* _<command>_::
+    Run command(s) after startup; many commands can be separated by semicolons,
+    this option can be given multiple times.
+
+*-s*, *--no-script*::
+    Disable scripts auto-load.
+
+*--upgrade*::
+    Upgrade WeeChat using session files generated with command `/upgrade -quit`.
+
+*-v*, *--version*::
+    Display WeeChat version.
+
+*plugin:option*::
+    Option for a plugin.
+// end::standard[]
+
+// tag::debug[]
+*--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.
+// end::debug[]
diff --git a/doc/en/includes/man.en.adoc b/doc/en/includes/man.en.adoc
new file mode 100644
index 000000000..0e1dfd6b6
--- /dev/null
+++ b/doc/en/includes/man.en.adoc
@@ -0,0 +1,110 @@
+// tag::plugin_options[]
+For complete doc on plugin options, please look at plugins documentation in
+https://weechat.org/doc[WeeChat user's guide].
+
+With irc plugin, you can connect to temporary server with an URL like:
+
+    irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]]
+
+To join WeeChat IRC channel support with nick "mynick":
+
+    irc://mynick@chat.freenode.net/#weechat
+
+IPv6 address can be enclosed in brackets to add a port after address, for
+example:
+
+    irc://mynick@[2001:db8:0:85a3::ac1f:8001]:6668/#test
+// end::plugin_options[]
+
+// tag::files[]
+$HOME/.weechat/weechat.conf::
+    main WeeChat configuration file
+
+$HOME/.weechat/plugins.conf::
+    plugins configuration file
+
+$HOME/.weechat/sec.conf::
+    configuration file with secured data
+
+$HOME/.weechat/alias.conf::
+    configuration file for _alias_ plugin
+
+$HOME/.weechat/buflist.conf::
+    configuration file for _buflist_ plugin
+
+$HOME/.weechat/charset.conf::
+    configuration file for _charset_ plugin
+
+$HOME/.weechat/exec.conf::
+    configuration file for _exec_ plugin
+
+$HOME/.weechat/fifo.conf::
+    configuration file for _fifo_ plugin
+
+$HOME/.weechat/fset.conf::
+    configuration file for _fset_ plugin
+
+$HOME/.weechat/guile.conf::
+    configuration file for _guile_ plugin
+
+$HOME/.weechat/irc.conf::
+    configuration file for _irc_ plugin
+
+$HOME/.weechat/javascript.conf::
+    configuration file for _javascript_ plugin
+
+$HOME/.weechat/logger.conf::
+    configuration file for _logger_ plugin
+
+$HOME/.weechat/lua.conf::
+    configuration file for _lua_ plugin
+
+$HOME/.weechat/perl.conf::
+    configuration file for _perl_ plugin
+
+$HOME/.weechat/php.conf::
+    configuration file for _php_ plugin
+
+$HOME/.weechat/python.conf::
+    configuration file for _python_ plugin
+
+$HOME/.weechat/relay.conf::
+    configuration file for _relay_ plugin
+
+$HOME/.weechat/ruby.conf::
+    configuration file for _ruby_ plugin
+
+$HOME/.weechat/script.conf::
+    configuration file for _script_ plugin
+
+$HOME/.weechat/spell.conf::
+    configuration file for _spell_ plugin
+
+$HOME/.weechat/tcl.conf::
+    configuration file for _tcl_ plugin
+
+$HOME/.weechat/trigger.conf::
+    configuration file for _trigger_ plugin
+
+$HOME/.weechat/xfer.conf::
+    configuration file for _xfer_ plugin
+
+$HOME/.weechat/weechat.log::
+    WeeChat log file
+// end::files[]
+
+// tag::copyright[]
+WeeChat is written by Sébastien Helleu and contributors (complete list is in
+the AUTHORS.adoc file).
+
+Copyright (C) 2003-2020 {author}
+
+WeeChat is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or
+(at your option) any later version.
+
+Please read the COPYING file for more information.
+
+Web: https://weechat.org/
+// end::copyright[]