diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/CMakeLists.txt | 13 | ||||
| -rw-r--r-- | doc/en/Makefile.am | 16 | ||||
| -rw-r--r-- | doc/en/cmdline_options.en.txt | 37 | ||||
| -rw-r--r-- | doc/en/weechat-curses.1.en.txt | 115 | ||||
| -rw-r--r-- | doc/en/weechat_dev.en.txt | 8 | ||||
| -rw-r--r-- | doc/en/weechat_user.en.txt | 36 |
6 files changed, 186 insertions, 39 deletions
diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt index 59b367ea2..9544f92c9 100644 --- a/doc/en/CMakeLists.txt +++ b/doc/en/CMakeLists.txt @@ -17,12 +17,25 @@ # along with WeeChat. If not, see <http://www.gnu.org/licenses/>. # +# man page +ADD_CUSTOM_COMMAND( + OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 + COMMAND ${A2X_EXECUTABLE} ARGS -a revision='WeeChat ${VERSION}' -d manpage -f manpage -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.en.txt + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.en.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt + COMMENT "Building weechat-curses.1 (en)" +) +ADD_CUSTOM_TARGET(doc-man-en ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1) +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/man1) + # user's guide ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.en.html COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a toc -a toclevels=4 -a date=`date "+%F"` -a revision="${VERSION}" -a stylesheet=${CMAKE_CURRENT_SOURCE_DIR}/../asciidoc.css -f ${CMAKE_CURRENT_SOURCE_DIR}/../asciidoc.conf -n -o ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.en.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.txt DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.en.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.en.txt ${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt COMMENT "Building weechat_user.en.html" ) diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index 4064fa114..8c492548a 100644 --- a/doc/en/Makefile.am +++ b/doc/en/Makefile.am @@ -21,6 +21,8 @@ docdir = $(datadir)/doc/$(PACKAGE) EXTRA_DIST = CMakeLists.txt \ + weechat-curses.1.en.txt \ + cmdline_options.en.txt \ weechat_user.en.txt \ weechat_plugin_api.en.txt \ weechat_scripting.en.txt \ @@ -32,7 +34,8 @@ EXTRA_DIST = CMakeLists.txt \ $(wildcard autogen/user/*.txt) \ $(wildcard autogen/plugin_api/*.txt) -all-local: weechat_user.en.html \ +all-local: weechat-curses.1 \ + weechat_user.en.html \ weechat_plugin_api.en.html \ weechat_scripting.en.html \ weechat_faq.en.html \ @@ -41,8 +44,12 @@ all-local: weechat_user.en.html \ weechat_dev.en.html \ weechat_relay_protocol.en.html +# man page +weechat-curses.1: weechat-curses.1.en.txt cmdline_options.en.txt + $(A2X) -a revision="WeeChat $(VERSION)" -d manpage -f manpage -D . $(abs_top_srcdir)/doc/en/weechat-curses.1.en.txt + # user's guide -weechat_user.en.html: weechat_user.en.txt $(wildcard autogen/user/*.txt) +weechat_user.en.html: weechat_user.en.txt cmdline_options.en.txt $(wildcard autogen/user/*.txt) $(ASCIIDOC) -a toc -a toclevels=4 -a date=`date "+%F"` -a revision="$(VERSION)" -a stylesheet=$(abs_top_srcdir)/doc/asciidoc.css -f $(abs_top_srcdir)/doc/asciidoc.conf -n -o weechat_user.en.html $(abs_top_srcdir)/doc/en/weechat_user.en.txt # plugin API reference @@ -76,16 +83,21 @@ weechat_relay_protocol.en.html: weechat_relay_protocol.en.txt # install docs install-data-hook: + $(mkinstalldirs) $(DESTDIR)$(mandir)/man1/ + $(INSTALL_DATA) *.1 $(DESTDIR)$(mandir)/man1/ $(mkinstalldirs) $(DESTDIR)$(docdir)/ $(INSTALL_DATA) *.html $(DESTDIR)$(docdir)/ # uninstall docs uninstall-hook: + $(RM) $(DESTDIR)$(mandir)/man1/weechat-curses.1 + -rmdir $(DESTDIR)$(mandir)/man1 $(RM) $(DESTDIR)$(docdir)/*.en.html -rmdir $(DESTDIR)$(docdir) # clean clean-local: + -rm -f weechat-curses.1 -rm -f *.html diff --git a/doc/en/cmdline_options.en.txt b/doc/en/cmdline_options.en.txt new file mode 100644 index 000000000..1e2668301 --- /dev/null +++ b/doc/en/cmdline_options.en.txt @@ -0,0 +1,37 @@ +*-a*, *--no-connect*:: + Disable auto-connect to servers when WeeChat is starting. + +*-c*, *--colors*:: + Display default colors in terminal. + +*-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). + +*-h*, *--help*:: + Display help. + +*-k*, *--keys*:: + Display WeeChat default keys. + +*-l*, *--license*:: + Display WeeChat license. + +*-p*, *--no-plugin*:: + Disable plugins auto-load. + +*-r*, *--run-command* '<command>':: + Run command(s) after startup (many commands can be separated by semicolons). + +*-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. diff --git a/doc/en/weechat-curses.1.en.txt b/doc/en/weechat-curses.1.en.txt new file mode 100644 index 000000000..ca7d7740e --- /dev/null +++ b/doc/en/weechat-curses.1.en.txt @@ -0,0 +1,115 @@ +WEECHAT-CURSES(1) +================= +:doctype: manpage + +NAME +---- + +weechat-curses - the extensible chat client (Curses version) + +SYNOPSIS +-------- + +[verse] +'weechat-curses' [-a|--no-connect] [-d|--dir <path>] [-p|--no-plugin] [-r|--run-command <command>] [-s|--no-script] [--upgrade] [plugin:option...] +'weechat-curses' [-c|--colors] +'weechat-curses' [-h|--help] +'weechat-curses' [-k|--keys] +'weechat-curses' [-l|--license] +'weechat-curses' [-v|--version] + +DESCRIPTION +----------- + +WeeChat is a fast, light and extensible chat client. + +It is modular (lightweight core with plugins), multi-protocols (IRC and Jabber), +extensible with C and scripts written in several languages. + +OPTIONS +------- + +include::cmdline_options.en.txt[] + +PLUGIN OPTIONS +-------------- + +For complete doc on plugin options, please look at plugins documentation in +http://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@irc.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 + +FILES +----- + +$HOME/.weechat/weechat.conf:: + main WeeChat configuration file + +$HOME/.weechat/plugins.conf:: + plugins configuration file + +$HOME/.weechat/alias.conf:: + configuration file for 'alias' plugin + +$HOME/.weechat/aspell.conf:: + configuration file for 'aspell' plugin + +$HOME/.weechat/charset.conf:: + configuration file for 'charset' plugin + +$HOME/.weechat/irc.conf:: + configuration file for 'irc' plugin + +$HOME/.weechat/logger.conf:: + configuration file for 'logger' plugin + +$HOME/.weechat/relay.conf:: + configuration file for 'relay' plugin + +$HOME/.weechat/rmodifier.conf:: + configuration file for 'rmodifier' plugin + +$HOME/.weechat/script.conf:: + configuration file for 'script' plugin + +$HOME/.weechat/xfer.conf:: + configuration file for 'xfer' plugin + +$HOME/.weechat/weechat.log:: + WeeChat log file + +AUTHORS +------- + +WeeChat is written by Sébastien Helleu and contributors (complete list is in +the AUTHORS file). + +Copyright (C) 2003-2013 Sébastien Helleu <flashcode@flashtux.org> + +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: <http://weechat.org/> + +REPORTING BUGS +-------------- + +Please report bugs or feature requests at Savannah website: + +* bugs: <http://savannah.nongnu.org/bugs/?group=weechat> +* feature requests: <http://savannah.nongnu.org/task/?group=weechat> diff --git a/doc/en/weechat_dev.en.txt b/doc/en/weechat_dev.en.txt index bbae71925..e892c8024 100644 --- a/doc/en/weechat_dev.en.txt +++ b/doc/en/weechat_dev.en.txt @@ -294,6 +294,7 @@ Documentation files: | docgen.py | Python script to build files in "autogen/" directory (see below) | weechat-curses.1 | Weechat man page | XX/ | Documentation for language XX (languages: en, fr, de, it, ...) +| weechat-curses.1.XX.txt | Man page | weechat_quickstart.XX.txt | Quickstart guide | weechat_user.XX.txt | User's guide | weechat_faq.XX.txt | FAQ @@ -301,10 +302,11 @@ Documentation files: | weechat_scripting.XX.txt | Scripting guide | weechat_tester.XX.txt | Tester's guide | weechat_dev.XX.txt | Developer's guide (this document) -| weechat_relay_protocol.en.txt | Relay protocol +| weechat_relay_protocol.XX.txt | Relay protocol +| cmdline_options.XX.txt | Command-line options (file included in man page and user's guide) | autogen/ | Files auto-built with script docgen.py (do *NEVER* update manually!) -| user/ | Files auto-built for user's guide -| plugin_api/ | Files auto-built for plugin API +| user/ | Files auto-built for user's guide (do *NEVER* update manually!) +| plugin_api/ | Files auto-built for plugin API (do *NEVER* update manually!) |======================================== Translations for WeeChat and plugins are done with gettext, files are in 'po/' directory: diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt index 7547155c5..3a8eec072 100644 --- a/doc/en/weechat_user.en.txt +++ b/doc/en/weechat_user.en.txt @@ -104,6 +104,7 @@ compile WeeChat. | guile-2.0-dev | ≥ 2.0 | | guile (scheme) plugin | asciidoc | ≥ 8.5.0 | | build documentation (HTML files) | source-highlight | | | syntax highlight for sources in HTML documentation +| docbook-xml, docbook-xsl | | | build man page |======================================== [NOTE] @@ -429,40 +430,7 @@ Running WeeChat Command line arguments: --a, --no-connect:: - Disable auto-connect to servers when WeeChat is starting. - --c, --colors:: - Display default colors in terminal. - --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). - --h, --help:: - Display help. - --k, --keys:: - Display WeeChat default keys. - --l, --license:: - Display WeeChat license. - --p, --no-plugin:: - Disable plugins auto-load. - --r, --run-command:: - Run command(s) after startup (many commands can be separated by semicolons). - --s, --no-script:: - Disable scripts auto-load. - --v, --version:: - Display WeeChat version. - -plugin:option:: - Option for plugin (see doc for each plugin). +include::cmdline_options.en.txt[] To start WeeChat, issue this command: |