core: split man pages weechat and weechat-headless

6 files changed, 175 insertions, 111 deletions

diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt
index 068258762..c7b10287c 100644
--- a/doc/en/CMakeLists.txt
+++ b/doc/en/CMakeLists.txt
@@ -18,29 +18,34 @@
 #
 
 if(ENABLE_MAN)
-  # man page
+  # man page: weechat
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat.1
     COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS ${ASCIIDOCTOR_ARGS} -b manpage -o weechat.1 ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.adoc
     DEPENDS
     ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.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
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
     COMMENT "Building weechat.1 (en)"
   )
   add_custom_target(doc-man-weechat-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat.1)
   install(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat.1 DESTINATION ${MANDIR}/man1)
 
-  # symbolic link weechat-headless.1 -> weechat.1
+  # man page: weechat-headless
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat-headless.1
-    COMMAND ${CMAKE_COMMAND} -E remove -f "weechat-headless.1"
-    COMMAND ${CMAKE_COMMAND} -E create_symlink "weechat.1" "weechat-headless.1"
+    COMMAND ${ASCIIDOCTOR_EXECUTABLE} ARGS ${ASCIIDOCTOR_ARGS} -b manpage -o weechat-headless.1 ${CMAKE_CURRENT_SOURCE_DIR}/weechat-headless.1.en.adoc
     DEPENDS
-    ${CMAKE_CURRENT_SOURCE_DIR}/weechat.1.en.adoc
+    ${CMAKE_CURRENT_SOURCE_DIR}/weechat-headless.1.en.adoc
     ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.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
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-    COMMENT "Creating symbolic link weechat-headless.1 (en)"
+    COMMENT "Building weechat-headless.1 (en)"
   )
   add_custom_target(doc-man-weechat-headless-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-headless.1)
   install(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-headless.1 DESTINATION ${MANDIR}/man1)
diff --git a/doc/en/man_copyright.en.adoc b/doc/en/man_copyright.en.adoc
new file mode 100644
index 000000000..675e33b48
--- /dev/null
+++ b/doc/en/man_copyright.en.adoc
@@ -0,0 +1,13 @@
+WeeChat is written by Sébastien Helleu and contributors (complete list is in
+the AUTHORS.adoc file).
+
+Copyright (C) 2003-2018 {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/
diff --git a/doc/en/man_files.en.adoc b/doc/en/man_files.en.adoc
new file mode 100644
index 000000000..071cffdfc
--- /dev/null
+++ b/doc/en/man_files.en.adoc
@@ -0,0 +1,74 @@
+$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/aspell.conf::
+    configuration file for _aspell_ 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/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
diff --git a/doc/en/man_plugin_options.en.adoc b/doc/en/man_plugin_options.en.adoc
new file mode 100644
index 000000000..312c49984
--- /dev/null
+++ b/doc/en/man_plugin_options.en.adoc
@@ -0,0 +1,15 @@
+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
diff --git a/doc/en/weechat-headless.1.en.adoc b/doc/en/weechat-headless.1.en.adoc
new file mode 100644
index 000000000..900fd6361
--- /dev/null
+++ b/doc/en/weechat-headless.1.en.adoc
@@ -0,0 +1,57 @@
+= weechat-headless(1)
+:doctype: manpage
+:author: Sébastien Helleu
+:email: flashcode@flashtux.org
+:lang: en
+:man manual: WeeChat Manual
+:man source: WeeChat {revnumber}
+
+== NAME
+
+weechat-headless - the extensible chat client (headless version)
+
+== SYNOPSIS
+
+[verse]
+*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-p|--no-plugin] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
+*weechat-headless* [-c|--colors]
+*weechat-headless* [-h|--help]
+*weechat-headless* [-l|--license]
+*weechat-headless* [-v|--version]
+
+== DESCRIPTION
+
+WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and
+light, designed for many operating systems.
+It is highly customizable and extensible with scripts.
+
+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".
+
+== OPTIONS
+
+include::cmdline_options.en.adoc[]
+
+== PLUGIN OPTIONS
+
+include::man_plugin_options.en.adoc[]
+
+== FILES
+
+include::man_files.en.adoc[]
+
+== SEE ALSO
+
+*weechat*(1)
+
+== AUTHORS
+
+This manpage was written by {author}.
+
+== COPYRIGHT
+
+include::man_copyright.en.adoc[]
+
+== SUPPORT / REPORTING BUGS
+
+For help or a bug report: https://weechat.org/dev/support
diff --git a/doc/en/weechat.1.en.adoc b/doc/en/weechat.1.en.adoc
index 132022985..b5eeb1f14 100644
--- a/doc/en/weechat.1.en.adoc
+++ b/doc/en/weechat.1.en.adoc
@@ -19,115 +19,27 @@ weechat - the extensible chat client
 *weechat* [-l|--license]
 *weechat* [-v|--version]
 
-*weechat-headless* [-a|--no-connect] [--daemon] [-d|--dir <path>] [-p|--no-plugin] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...]
-
 == DESCRIPTION
 
 WeeChat (Wee Enhanced Environment for Chat) is a free chat client, fast and
 light, designed for many operating systems.
 It is highly customizable and extensible with scripts.
 
-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".
-
 == OPTIONS
 
 include::cmdline_options.en.adoc[]
 
 == 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
+include::man_plugin_options.en.adoc[]
 
 == 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/aspell.conf::
-    configuration file for _aspell_ 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
+include::man_files.en.adoc[]
 
-$HOME/.weechat/guile.conf::
-    configuration file for _guile_ plugin
+== SEE ALSO
 
-$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/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
+*weechat-headless*(1)
 
 == AUTHORS
 
@@ -135,19 +47,7 @@ This manpage was written by {author}.
 
 == COPYRIGHT
 
-WeeChat is written by Sébastien Helleu and contributors (complete list is in
-the AUTHORS.adoc file).
-
-Copyright (C) 2003-2018 {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/
+include::man_copyright.en.adoc[]
 
 == SUPPORT / REPORTING BUGS