diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/CMakeLists.txt | 8 | ||||
| -rw-r--r-- | doc/en/Makefile.am | 5 | ||||
| -rw-r--r-- | doc/en/man.en.adoc (renamed from doc/en/man_files.en.adoc) | 36 | ||||
| -rw-r--r-- | doc/en/man_copyright.en.adoc | 13 | ||||
| -rw-r--r-- | doc/en/man_plugin_options.en.adoc | 15 | ||||
| -rw-r--r-- | doc/en/weechat-headless.1.en.adoc | 6 | ||||
| -rw-r--r-- | doc/en/weechat.1.en.adoc | 6 | ||||
| -rw-r--r-- | doc/en/weechat_dev.en.adoc | 1 |
8 files changed, 48 insertions, 42 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt index f092ceb1d..9b74bec6c 100644 --- a/doc/en/CMakeLists.txt +++ b/doc/en/CMakeLists.txt @@ -25,9 +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}/man_plugin_options.en.adoc - ${CMAKE_CURRENT_SOURCE_DIR}/man_files.en.adoc - ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.en.adoc + ${CMAKE_CURRENT_SOURCE_DIR}/man.en.adoc WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Building weechat.1 (en)" ) @@ -41,9 +39,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}/man_plugin_options.en.adoc - ${CMAKE_CURRENT_SOURCE_DIR}/man_files.en.adoc - ${CMAKE_CURRENT_SOURCE_DIR}/man_copyright.en.adoc + ${CMAKE_CURRENT_SOURCE_DIR}/man.en.adoc WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Building weechat-headless.1 (en)" ) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index cf71f7f9e..281d4cffb 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 \ + man.en.adoc \ weechat_user.en.adoc \ weechat_plugin_api.en.adoc \ weechat_scripting.en.adoc \ @@ -57,9 +58,9 @@ 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 man.en.adoc $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) -a revnumber="$(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 man.en.adoc $(ASCIIDOCTOR) $(ASCIIDOCTOR_ARGS) -a revnumber="$(VERSION)" -b manpage -o weechat-headless.1 $(abs_top_srcdir)/doc/en/weechat-headless.1.en.adoc # user's guide diff --git a/doc/en/man_files.en.adoc b/doc/en/man.en.adoc index c8722550d..0e1dfd6b6 100644 --- a/doc/en/man_files.en.adoc +++ b/doc/en/man.en.adoc @@ -1,3 +1,22 @@ +// 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 @@ -72,3 +91,20 @@ $HOME/.weechat/xfer.conf:: $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[] diff --git a/doc/en/man_copyright.en.adoc b/doc/en/man_copyright.en.adoc deleted file mode 100644 index f78bee8da..000000000 --- a/doc/en/man_copyright.en.adoc +++ /dev/null @@ -1,13 +0,0 @@ -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/ diff --git a/doc/en/man_plugin_options.en.adoc b/doc/en/man_plugin_options.en.adoc deleted file mode 100644 index 312c49984..000000000 --- a/doc/en/man_plugin_options.en.adoc +++ /dev/null @@ -1,15 +0,0 @@ -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 index 1c230e324..e232e69d2 100644 --- a/doc/en/weechat-headless.1.en.adoc +++ b/doc/en/weechat-headless.1.en.adoc @@ -40,11 +40,11 @@ include::cmdline_options.en.adoc[tag=debug] == PLUGIN OPTIONS -include::man_plugin_options.en.adoc[] +include::man.en.adoc[tag=plugin_options] == FILES -include::man_files.en.adoc[] +include::man.en.adoc[tag=files] == SEE ALSO @@ -56,7 +56,7 @@ This manpage was written by {author}. == COPYRIGHT -include::man_copyright.en.adoc[] +include::man.en.adoc[tag=copyright] == SUPPORT / REPORTING BUGS diff --git a/doc/en/weechat.1.en.adoc b/doc/en/weechat.1.en.adoc index 1c19edeae..c3be2bed0 100644 --- a/doc/en/weechat.1.en.adoc +++ b/doc/en/weechat.1.en.adoc @@ -37,11 +37,11 @@ include::cmdline_options.en.adoc[tag=debug] == PLUGIN OPTIONS -include::man_plugin_options.en.adoc[] +include::man.en.adoc[tag=plugin_options] == FILES -include::man_files.en.adoc[] +include::man.en.adoc[tag=files] == SEE ALSO @@ -53,7 +53,7 @@ This manpage was written by {author}. == COPYRIGHT -include::man_copyright.en.adoc[] +include::man.en.adoc[tag=copyright] == SUPPORT / REPORTING BUGS diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index c5581b1b1..a6dcd5143 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -436,6 +436,7 @@ Documentation files: | 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 pages and user's guide). +| man.XX.adoc | Part of man pages: plugin options, files and copyright. | 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]. |