diff options
Diffstat (limited to 'doc')
29 files changed, 949 insertions, 340 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index cc9a4e384..1c3d31c78 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -34,5 +34,3 @@ IF(ENABLE_DOC) ENDIF(ASCIIDOC_FOUND AND SOURCEHIGHLIGHT_FOUND) ENDIF(ENABLE_DOC) - -INSTALL(FILES ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/man1) diff --git a/doc/Makefile.am b/doc/Makefile.am index 7b9e8ff64..51adadbba 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -20,9 +20,7 @@ SUBDIRS = . en fr it de pl es ru ja -man_MANS = weechat-curses.1 - -EXTRA_DIST = $(man_MANS) docgen.py CMakeLists.txt asciidoc.conf asciidoc.css +EXTRA_DIST = docgen.py CMakeLists.txt asciidoc.conf asciidoc.css uninstall-hook: -rmdir $(DESTDIR)$(datadir)/doc/$(PACKAGE) diff --git a/doc/de/CMakeLists.txt b/doc/de/CMakeLists.txt index d8ddd366f..35d6ebd2f 100644 --- a/doc/de/CMakeLists.txt +++ b/doc/de/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 lang=de -a revision='WeeChat ${VERSION}' -d manpage -f manpage -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.de.txt + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.de.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.txt + COMMENT "Building weechat-curses.1 (de)" +) +ADD_CUSTOM_TARGET(doc-man-de ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1) +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/de/man1) + # user's guide ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.de.html COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a lang=de -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.de.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.txt DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.de.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.de.txt ${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt COMMENT "Building weechat_user.de.html" ) diff --git a/doc/de/Makefile.am b/doc/de/Makefile.am index 1d57bb1c8..048f5e366 100644 --- a/doc/de/Makefile.am +++ b/doc/de/Makefile.am @@ -21,6 +21,8 @@ docdir = $(datadir)/doc/$(PACKAGE) EXTRA_DIST = CMakeLists.txt \ + weechat-curses.1.de.txt \ + cmdline_options.de.txt \ weechat_user.de.txt \ weechat_scripting.de.txt \ weechat_faq.de.txt \ @@ -28,14 +30,19 @@ EXTRA_DIST = CMakeLists.txt \ weechat_tester.de.txt \ $(wildcard autogen/user/*.txt) -all-local: weechat_user.de.html \ +all-local: weechat-curses.1 \ + weechat_user.de.html \ weechat_scripting.de.html \ weechat_faq.de.html \ weechat_quickstart.de.html \ weechat_tester.de.html +# man page +weechat-curses.1: weechat-curses.1.de.txt cmdline_options.de.txt + $(A2X) -a lang=de -a revision="WeeChat $(VERSION)" -d manpage -f manpage -D . $(abs_top_srcdir)/doc/de/weechat-curses.1.de.txt + # user's guide -weechat_user.de.html: weechat_user.de.txt $(wildcard autogen/user/*.txt) +weechat_user.de.html: weechat_user.de.txt cmdline_options.de.txt $(wildcard autogen/user/*.txt) $(ASCIIDOC) -a lang=de -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.de.html $(abs_top_srcdir)/doc/de/weechat_user.de.txt # scripting guide @@ -57,16 +64,21 @@ weechat_tester.de.html: weechat_tester.de.txt # install docs install-data-hook: + $(mkinstalldirs) $(DESTDIR)$(mandir)/de/man1/ + $(INSTALL_DATA) *.1 $(DESTDIR)$(mandir)/de/man1/ $(mkinstalldirs) $(DESTDIR)$(docdir)/ $(INSTALL_DATA) *.html $(DESTDIR)$(docdir)/ # uninstall docs uninstall-hook: + $(RM) $(DESTDIR)$(mandir)/de/man1/weechat-curses.1 + -rmdir $(DESTDIR)$(mandir)/de/man1 $(RM) $(DESTDIR)$(docdir)/*.de.html -rmdir $(DESTDIR)$(docdir) # clean clean-local: + -rm -f weechat-curses.1 -rm -f *.html diff --git a/doc/de/cmdline_options.de.txt b/doc/de/cmdline_options.de.txt new file mode 100644 index 000000000..ef218aec5 --- /dev/null +++ b/doc/de/cmdline_options.de.txt @@ -0,0 +1,40 @@ +*-a*, *--no-connect*:: + deaktiviert das automatische Verbinden mit den Servern beim Start von WeeChat. + +*-c*, *--colors*:: + Zeigt die Standardfarben im Terminal an. + +*-d*, *--dir* '<path>':: + legt den Konfigurationsordner für WeeChat fest (Voreinstellung: ~/.weechat) in + dem die Erweiterungen, Skripten, Protokolldateien etc.pp. gesichert werden. + Sollte das Verzeichnis nicht existieren wird es beim Start angelegt. + +*-h*, *--help*:: + zeigt einen Hilfstext an. + +*-k*, *--keys*:: + zeigt die Standard-Tastaturbelegung an. + +*-l*, *--license*:: + zeigt die Lizenz von WeeChat an. + +*-p*, *--no-plugin*:: + unterbindet das Laden der Erweiterungen beim Programmstart. + +// TRANSLATION MISSING +*-r*, *--run-command* '<command>':: + startet einen oder mehrere Befehle, nachdem WeeChat gestartet wurde + (mehrere Befehle müssen durch Kommata voneinander getrennt werden). + +*-s*, *--no-script*:: + Skripten werden beim Programmstart nicht geladen. + +// TRANSLATION MISSING +*--upgrade*:: + Upgrade WeeChat using session files generated with command `/upgrade -quit`. + +*-v*, *--version*:: + zeigt die Version von WeeChat an. + +*plugin:option*:: + Option für Erweiterung. diff --git a/doc/de/weechat-curses.1.de.txt b/doc/de/weechat-curses.1.de.txt new file mode 100644 index 000000000..5b25a6890 --- /dev/null +++ b/doc/de/weechat-curses.1.de.txt @@ -0,0 +1,116 @@ +// TRANSLATION MISSING (WHOLE FILE) +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.de.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/de/weechat_user.de.txt b/doc/de/weechat_user.de.txt index 1fea9ad92..47d830d35 100644 --- a/doc/de/weechat_user.de.txt +++ b/doc/de/weechat_user.de.txt @@ -104,6 +104,8 @@ welche Pakete optional genutzt werden können. | guile-2.0-dev | ≥ 2.0 | | guile (scheme) Erweiterung | asciidoc | ≥ 8.5.0 | | erstellt Dokumentation (HTML Dateien) | source-highlight | | | Syntax Highlight für Quelltext in HTML Dokumentation +// TRANSLATION MISSING +| docbook-xml, docbook-xsl | | | build man page |======================================== [NOTE] @@ -433,41 +435,7 @@ WeeChat starten Befehlszeile: --a, --no-connect:: - deaktiviert das automatische Verbinden mit den Servern beim Start von WeeChat. - --c, --colors:: - Zeigt die Standardfarben im Terminal an. - --d, --dir 'path':: - legt den Konfigurationsordner für WeeChat fest (Voreinstellung: ~/.weechat) in - dem die Erweiterungen, Skripten, Protokolldateien etc.pp. gesichert werden. - Sollte das Verzeichnis nicht existieren wird es beim Start angelegt. - --h, --help:: - zeigt einen Hilfstext an. - --k, --keys:: - zeigt die Standard-Tastaturbelegung an. - --l, --license:: - zeigt die Lizenz von WeeChat an. - --p, --no-plugin:: - unterbindet das Laden der Erweiterungen beim Programmstart. - --r, --run-command:: - startet einen oder mehrere Befehle, nachdem WeeChat gestartet wurde - (mehrere Befehle müssen durch Kommata voneinander getrennt werden). - --s, --no-script:: - Skripten werden beim Programmstart nicht geladen. - --v, --version:: - zeigt die Version von WeeChat an. - -plugin:option:: - Option für Erweiterung (siehe Dokumentation für weitere Einzelheiten). +include::cmdline_options.de.txt[] Um WeeChat zu starten muss folgender Befehl ausgeführt werden: 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: diff --git a/doc/fr/CMakeLists.txt b/doc/fr/CMakeLists.txt index d82d6d1c9..dcec5915f 100644 --- a/doc/fr/CMakeLists.txt +++ b/doc/fr/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 lang=fr -a revision='WeeChat ${VERSION}' -d manpage -f manpage -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.fr.txt + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.fr.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.txt + COMMENT "Building weechat-curses.1 (fr)" +) +ADD_CUSTOM_TARGET(doc-man-fr ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1) +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/fr/man1) + # user's guide ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.fr.html COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a lang=fr -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.fr.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.txt DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.fr.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.fr.txt ${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt COMMENT "Building weechat_user.fr.html" ) diff --git a/doc/fr/Makefile.am b/doc/fr/Makefile.am index a8745f31a..15fe07767 100644 --- a/doc/fr/Makefile.am +++ b/doc/fr/Makefile.am @@ -21,6 +21,8 @@ docdir = $(datadir)/doc/$(PACKAGE) EXTRA_DIST = CMakeLists.txt \ + weechat-curses.1.fr.txt \ + cmdline_options.fr.txt \ weechat_user.fr.txt \ weechat_plugin_api.fr.txt \ weechat_scripting.fr.txt \ @@ -30,15 +32,20 @@ EXTRA_DIST = CMakeLists.txt \ $(wildcard autogen/user/*.txt) \ $(wildcard autogen/plugin_api/*.txt) -all-local: weechat_user.fr.html \ +all-local: weechat-curses.1 \ + weechat_user.fr.html \ weechat_plugin_api.fr.html \ weechat_scripting.fr.html \ weechat_faq.fr.html \ weechat_quickstart.fr.html \ weechat_tester.fr.html +# man page +weechat-curses.1: weechat-curses.1.fr.txt cmdline_options.fr.txt + $(A2X) -a lang=fr -a revision="WeeChat $(VERSION)" -d manpage -f manpage -D . $(abs_top_srcdir)/doc/fr/weechat-curses.1.fr.txt + # user's guide -weechat_user.fr.html: weechat_user.fr.txt $(wildcard autogen/user/*.txt) +weechat_user.fr.html: weechat_user.fr.txt cmdline_options.fr.txt $(wildcard autogen/user/*.txt) $(ASCIIDOC) -a lang=fr -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.fr.html $(abs_top_srcdir)/doc/fr/weechat_user.fr.txt # plugin API reference @@ -64,16 +71,21 @@ weechat_tester.fr.html: weechat_tester.fr.txt # install docs install-data-hook: + $(mkinstalldirs) $(DESTDIR)$(mandir)/fr/man1/ + $(INSTALL_DATA) *.1 $(DESTDIR)$(mandir)/fr/man1/ $(mkinstalldirs) $(DESTDIR)$(docdir)/ $(INSTALL_DATA) *.html $(DESTDIR)$(docdir)/ # uninstall docs uninstall-hook: + $(RM) $(DESTDIR)$(mandir)/fr/man1/weechat-curses.1 + -rmdir $(DESTDIR)$(mandir)/fr/man1 $(RM) $(DESTDIR)$(docdir)/*.fr.html -rmdir $(DESTDIR)$(docdir) # clean clean-local: + -rm -f weechat-curses.1 -rm -f *.html diff --git a/doc/fr/cmdline_options.fr.txt b/doc/fr/cmdline_options.fr.txt new file mode 100644 index 000000000..b70a107dc --- /dev/null +++ b/doc/fr/cmdline_options.fr.txt @@ -0,0 +1,40 @@ +*-a*, *--no-connect*:: + Supprimer la connexion automatique aux serveurs lors du démarrage. + +*-c*, *--colors*:: + Afficher les couleurs par défaut du terminal. + +*-d*, *--dir* '<répertoire>':: + Définir le répertoire comme étant la base de WeeChat + (utilisé pour les fichiers de configuration, logs, extensions + et scripts de l'utilisateur), la valeur par défaut est '~/.weechat' (note : + le répertoire est créé s'il n'est pas trouvé par WeeChat). + +*-h*, *--help*:: + Afficher l'aide. + +*-k*, *--keys*:: + Afficher les touches par défaut de WeeChat. + +*-l*, *--license*:: + Afficher la licence de WeeChat. + +*-p*, *--no-plugin*:: + Supprimer le chargement automatique des extensions au démarrage. + +*-r*, *--run-command* '<commande>':: + Lancer la/les commande(s) après le démarrage (plusieurs commandes peuvent + être séparées par des points-virgules). + +*-s*, *--no-script*:: + Supprimer le chargement automatique des scripts au démarrage. + +*--upgrade*:: + Mettre à jour WeeChat en utilisant les fichiers de session générés avec la + commande `/upgrade -quit`. + +*-v*, *--version*:: + Afficher la version de WeeChat. + +*extension:option*:: + Option pour une extension. diff --git a/doc/fr/weechat-curses.1.fr.txt b/doc/fr/weechat-curses.1.fr.txt new file mode 100644 index 000000000..0bb2cd3ac --- /dev/null +++ b/doc/fr/weechat-curses.1.fr.txt @@ -0,0 +1,118 @@ +WEECHAT-CURSES(1) +================= +:doctype: manpage + +NOM +--- + +weechat-curses - le client de discussion extensible (version Curses) + +SYNOPSIS +-------- + +[verse] +'weechat-curses' [-a|--no-connect] [-d|--dir <répertoire>] [-p|--no-plugin] [-r|--run-command <commande>] [-s|--no-script] [--upgrade] [extension:option...] +'weechat-curses' [-c|--colors] +'weechat-curses' [-h|--help] +'weechat-curses' [-k|--keys] +'weechat-curses' [-l|--license] +'weechat-curses' [-v|--version] + +DESCRIPTION +----------- + +WeeChat est un client de discussion rapide, léger et extensible. + +Il est modulaire (cœur léger avec des extensions), multi-protocoles (IRC et +Jabber), extensible avec du C et des scripts écrits en différents langages. + +OPTIONS +------- + +include::cmdline_options.fr.txt[] + +OPTIONS D'EXTENSION +------------------- + +Pour une documentation complète sur les options des extensions, merci de +consulter la documentation des extensions dans le +http://weechat.org/doc[guide utilisateur de WeeChat]. + +Avec l'extension irc, vous pouvez vous connecter à un serveur de manière +temporaire avec une URL, comme ceci : + + irc[6][s]://[[pseudo][:motdepasse]@]serveur[:port][/#canal1[,#canal2...]] + +Pour rejoindre le canal IRC de support WeeChat avec le pseudo "monpseudo" : + + irc://monpseudo@irc.freenode.net/#weechat + +Les adresses IPv6 peuvent être entourées par des crochets pour ajouter un port +après, par exemple : + + irc://monpseudo@[2001:db8:0:85a3::ac1f:8001]:6668/#test + +FICHIERS +-------- + +$HOME/.weechat/weechat.conf:: + fichier de configuration principal de WeeChat + +$HOME/.weechat/plugins.conf:: + fichier de configuration des extensions + +$HOME/.weechat/alias.conf:: + fichier de configuration pour l'extension 'alias' + +$HOME/.weechat/aspell.conf:: + fichier de configuration pour l'extension 'aspell' + +$HOME/.weechat/charset.conf:: + fichier de configuration pour l'extension 'charset' + +$HOME/.weechat/irc.conf:: + fichier de configuration pour l'extension 'irc' + +$HOME/.weechat/logger.conf:: + fichier de configuration pour l'extension 'logger' + +$HOME/.weechat/relay.conf:: + fichier de configuration pour l'extension 'relay' + +$HOME/.weechat/rmodifier.conf:: + fichier de configuration pour l'extension 'rmodifier' + +$HOME/.weechat/script.conf:: + fichier de configuration pour l'extension 'script' + +$HOME/.weechat/xfer.conf:: + fichier de configuration pour l'extension 'xfer' + +$HOME/.weechat/weechat.log:: + fichier de log de WeeChat + +AUTEURS +------- + +WeeChat est écrit par Sébastien Helleu et des contributeurs (la liste complète +est dans le fichier AUTHORS). + +Copyright (C) 2003-2013 Sébastien Helleu <flashcode@flashtux.org> + +WeeChat est un logiciel libre; vous pouvez le redistribuer et/ou le modifier +sous les termes de la GNU General Public License telle que publiée par la +Free Software Foundation; soit la version 3 de la licence, ou (selon votre +choix) toute version ultérieure. + +Merci de consulter le fichier COPYING pour plus d'informations. + +Site web : <http://weechat.org/> + +SIGNALER DES BUGS +----------------- + +Merci de signaler les bugs ou demandes de nouvelles fonctionnalités sur le site +Savannah : + +* bugs : <http://savannah.nongnu.org/bugs/?group=weechat> +* demandes de nouvelles fonctionnalités : <http://savannah.nongnu.org/task/?group=weechat> diff --git a/doc/fr/weechat_user.fr.txt b/doc/fr/weechat_user.fr.txt index 2ff74a5bd..64cf0fd4a 100644 --- a/doc/fr/weechat_user.fr.txt +++ b/doc/fr/weechat_user.fr.txt @@ -106,6 +106,7 @@ compiler WeeChat. | guile-2.0-dev | ≥ 2.0 | | extension guile (scheme) | asciidoc | ≥ 8.5.0 | | construction de la documentation (fichiers HTML) | source-highlight | | | coloration des sources dans la documentation HTML +| docbook-xml, docbook-xsl | | | construction de la page de manuel |======================================== [NOTE] @@ -438,42 +439,7 @@ Lancer WeeChat Paramètres de ligne de commande : --a, --no-connect:: - Supprimer la connexion automatique aux serveurs lors du démarrage. - --c, --colors:: - Afficher les couleurs par défaut du terminal. - --d, --dir 'path':: - Définir le répertoire comme étant la base de WeeChat - (utilisé pour les fichiers de configuration, logs, extensions - et scripts de l'utilisateur), la valeur par défaut est '~/.weechat' (note : - le répertoire est créé s'il n'est pas trouvé par WeeChat). - --h, --help:: - Afficher l'aide. - --k, --keys:: - Afficher les touches par défaut de WeeChat. - --l, --license:: - Afficher la licence de WeeChat. - --p, --no-plugin:: - Supprimer le chargement automatique des extensions au démarrage. - --r, --run-command:: - Lancer la/les commande(s) après le démarrage (plusieurs commandes peuvent - être séparées par des points-virgules). - --s, --no-script:: - Supprimer le chargement automatique des scripts au démarrage. - --v, --version:: - Afficher la version de WeeChat. - -plugin:option:: - Option pour l'extension (voir la documentation de chaque extension). +include::cmdline_options.fr.txt[] Pour lancer WeeChat, tapez cette commande : diff --git a/doc/it/CMakeLists.txt b/doc/it/CMakeLists.txt index 36aa62a6a..4c6bc401e 100644 --- a/doc/it/CMakeLists.txt +++ b/doc/it/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 lang=it -a revision='WeeChat ${VERSION}' -d manpage -f manpage -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.it.txt + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.it.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.it.txt + COMMENT "Building weechat-curses.1 (it)" +) +ADD_CUSTOM_TARGET(doc-man-it ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1) +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/it/man1) + # user's guide ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.it.html COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a lang=it -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.it.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.it.txt DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.it.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.it.txt ${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt COMMENT "Building weechat_user.it.html" ) diff --git a/doc/it/Makefile.am b/doc/it/Makefile.am index 7381bce86..a1d616c3c 100644 --- a/doc/it/Makefile.am +++ b/doc/it/Makefile.am @@ -20,6 +20,8 @@ docdir = $(datadir)/doc/$(PACKAGE) EXTRA_DIST = CMakeLists.txt \ + weechat-curses.1.it.txt \ + cmdline_options.it.txt \ weechat_user.it.txt \ weechat_plugin_api.it.txt \ weechat_scripting.it.txt \ @@ -29,15 +31,20 @@ EXTRA_DIST = CMakeLists.txt \ $(wildcard autogen/user/*.txt) \ $(wildcard autogen/plugin_api/*.txt) -all-local: weechat_user.it.html \ +all-local: weechat-curses.1 \ + weechat_user.it.html \ weechat_plugin_api.it.html \ weechat_scripting.it.html \ weechat_faq.it.html \ weechat_quickstart.it.html \ weechat_tester.it.html +# man page +weechat-curses.1: weechat-curses.1.it.txt cmdline_options.it.txt + $(A2X) -a lang=it -a revision="WeeChat $(VERSION)" -d manpage -f manpage -D . $(abs_top_srcdir)/doc/it/weechat-curses.1.it.txt + # user's guide -weechat_user.it.html: weechat_user.it.txt $(wildcard autogen/user/*.txt) +weechat_user.it.html: weechat_user.it.txt cmdline_options.it.txt $(wildcard autogen/user/*.txt) $(ASCIIDOC) -a lang=it -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.it.html $(abs_top_srcdir)/doc/it/weechat_user.it.txt # plugin API reference @@ -63,16 +70,21 @@ weechat_tester.it.html: weechat_tester.it.txt # install docs install-data-hook: + $(mkinstalldirs) $(DESTDIR)$(mandir)/it/man1/ + $(INSTALL_DATA) *.1 $(DESTDIR)$(mandir)/it/man1/ $(mkinstalldirs) $(DESTDIR)$(docdir)/ $(INSTALL_DATA) *.html $(DESTDIR)$(docdir)/ # uninstall docs uninstall-hook: + $(RM) $(DESTDIR)$(mandir)/it/man1/weechat-curses.1 + -rmdir $(DESTDIR)$(mandir)/it/man1 $(RM) $(DESTDIR)$(docdir)/*.it.html -rmdir $(DESTDIR)$(docdir) # clean clean-local: + -rm -f weechat-curses.1 -rm -f *.html diff --git a/doc/it/cmdline_options.it.txt b/doc/it/cmdline_options.it.txt new file mode 100644 index 000000000..9ca71066c --- /dev/null +++ b/doc/it/cmdline_options.it.txt @@ -0,0 +1,40 @@ +*-a*, *--no-connect*:: + Disabilita la connessione automatica ai server all'avvio di WeeChat. + +*-c*, *--colors*:: + Mostra i colori prefefiniti nel terminale. + +*-d*, *--dir* '<path>':: + Imposta una directory come home per WeeChat (utilizzata per i file di + configurazione, log, plugin e script dell'utente), il valore predefinito + è ~/.weechat (nota: directory viene creata se non trovata da WeeChat). + +*-h*, *--help*:: + Mostra l'aiuto. + +*-k*, *--keys*:: + Mostra i tasti predefiniti di WeeChat. + +*-l*, *--license*:: + Mostra la licenza di WeeChat. + +*-p*, *--no-plugin*:: + Disabilita il caricamento automatico dei plugin. + +// TRANSLATION MISSING +*-r*, *--run-command* '<command>':: + Esegue un comando(i) dopo l'avvio (più comandi possono essere separati da + punto e virgola). + +*-s*, *--no-script*:: + Disabilita il caricamento automatico dei script. + +// TRANSLATION MISSING +*--upgrade*:: + Upgrade WeeChat using session files generated with command `/upgrade -quit`. + +*-v*, *--version*:: + Mostra la versione di WeeChat. + +*plugin:option*:: + Opzione per il plugin. diff --git a/doc/it/weechat-curses.1.it.txt b/doc/it/weechat-curses.1.it.txt new file mode 100644 index 000000000..f08dad3da --- /dev/null +++ b/doc/it/weechat-curses.1.it.txt @@ -0,0 +1,116 @@ +// TRANSLATION MISSING (WHOLE FILE) +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.it.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/it/weechat_user.it.txt b/doc/it/weechat_user.it.txt index cac7d2af5..edbc10c3c 100644 --- a/doc/it/weechat_user.it.txt +++ b/doc/it/weechat_user.it.txt @@ -111,6 +111,8 @@ compilare WeeChat. | guile-2.0-dev | ≥ 2.0 | | plugin guile (scheme) | asciidoc | ≥ 8.5.0 | | compilazione della documentazione (file HTML) | source-highlight | | | evidenziazione della sintassi per i sorgenti nella documentazione HTML +// TRANSLATION MISSING +| docbook-xml, docbook-xsl | | | build man page |======================================== [NOTE] @@ -447,41 +449,7 @@ Esecuzione di WeeChat Argomenti a riga di comando: --a, --no-connect:: - Disabilita la connessione automatica ai server all'avvio di WeeChat. - --c, --colors:: - Mostra i colori prefefiniti nel terminale. - --d, --dir 'path':: - Imposta una directory come home per WeeChat (utilizzata per i file di - configurazione, log, plugin e script dell'utente), il valore predefinito - è ~/.weechat (nota: directory viene creata se non trovata da WeeChat). - --h, --help:: - Mostra l'aiuto. - --k, --keys:: - Mostra i tasti predefiniti di WeeChat. - --l, --license:: - Mostra la licenza di WeeChat. - --p, --no-plugin:: - Disabilita il caricamento automatico dei plugin. - --r, --run-command:: - Esegue un comando(i) dopo l'avvio (più comandi possono essere separati da - punto e virgola). - --s, --no-script:: - Disabilita il caricamento automatico dei script. - --v, --version:: - Mostra la versione di WeeChat. - -plugin:option:: - Opzione per il plugin (consultare la documentazione per ogni plugin). +include::cmdline_options.it.txt[] Per avviare WeeChat, digitare questo comando: diff --git a/doc/ja/CMakeLists.txt b/doc/ja/CMakeLists.txt index 7a4d33172..67a033f7a 100644 --- a/doc/ja/CMakeLists.txt +++ b/doc/ja/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 lang=ja -a revision='WeeChat ${VERSION}' -d manpage -f manpage -D ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.ja.txt + DEPENDS + ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1.ja.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.ja.txt + COMMENT "Building weechat-curses.1 (ja)" +) +ADD_CUSTOM_TARGET(doc-man-ja ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1) +INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/weechat-curses.1 DESTINATION ${MANDIR}/ja/man1) + # user's guide ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/weechat_user.ja.html COMMAND ${ASCIIDOC_EXECUTABLE} ARGS -a toc -a toclevels=4 -a toc-title='目次' -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.ja.html ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.ja.txt DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/weechat_user.ja.txt + ${CMAKE_CURRENT_SOURCE_DIR}/cmdline_options.ja.txt ${CMAKE_CURRENT_SOURCE_DIR}/autogen/user/*.txt COMMENT "Building weechat_user.ja.html" ) diff --git a/doc/ja/Makefile.am b/doc/ja/Makefile.am index c69c4500d..4c6887a23 100644 --- a/doc/ja/Makefile.am +++ b/doc/ja/Makefile.am @@ -20,6 +20,8 @@ docdir = $(datadir)/doc/$(PACKAGE) EXTRA_DIST = CMakeLists.txt \ + weechat-curses.1.ja.txt \ + cmdline_options.ja.txt \ weechat_user.ja.txt \ weechat_scripting.ja.txt \ weechat_faq.ja.txt \ @@ -28,14 +30,19 @@ EXTRA_DIST = CMakeLists.txt \ $(wildcard autogen/user/*.txt) \ $(wildcard autogen/plugin_api/*.txt) -all-local: weechat_user.ja.html \ +all-local: weechat-curses.1 \ + weechat_user.ja.html \ weechat_scripting.ja.html \ weechat_faq.ja.html \ weechat_quickstart.ja.html \ weechat_tester.ja.html +# man page +weechat-curses.1: weechat-curses.1.ja.txt cmdline_options.ja.txt + $(A2X) -a lang=ja -a revision="WeeChat $(VERSION)" -d manpage -f manpage -D . $(abs_top_srcdir)/doc/ja/weechat-curses.1.ja.txt + # user's guide -weechat_user.ja.html: weechat_user.ja.txt $(wildcard autogen/user/*.txt) +weechat_user.ja.html: weechat_user.ja.txt cmdline_options.ja.txt $(wildcard autogen/user/*.txt) $(ASCIIDOC) -a toc -a toclevels=4 -a toc-title='目次' -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.ja.html $(abs_top_srcdir)/doc/ja/weechat_user.ja.txt # scripting guide @@ -57,16 +64,21 @@ weechat_tester.ja.html: weechat_tester.ja.txt # install docs install-data-hook: + $(mkinstalldirs) $(DESTDIR)$(mandir)/ja/man1/ + $(INSTALL_DATA) *.1 $(DESTDIR)$(mandir)/ja/man1/ $(mkinstalldirs) $(DESTDIR)$(docdir)/ $(INSTALL_DATA) *.html $(DESTDIR)$(docdir)/ # uninstall docs uninstall-hook: + $(RM) $(DESTDIR)$(mandir)/ja/man1/weechat-curses.1 + -rmdir $(DESTDIR)$(mandir)/ja/man1 $(RM) $(DESTDIR)$(docdir)/*.ja.html -rmdir $(DESTDIR)$(docdir) # clean clean-local: + -rm -f weechat-curses.1 -rm -f *.html diff --git a/doc/ja/cmdline_options.ja.txt b/doc/ja/cmdline_options.ja.txt new file mode 100644 index 000000000..41ccae8ea --- /dev/null +++ b/doc/ja/cmdline_options.ja.txt @@ -0,0 +1,39 @@ +*-a*, *--no-connect*:: + WeeChat の起動時にサーバへの自動接続を行わない + +*-c*, *--colors*:: + ターミナルにデフォルトカラーを表示 + +*-d*, *--dir* '<path>':: + WeeChat のホームディレクトリを path に設定 (設定ファイル、ログ、 + ユーザプラグイン、スクリプトに利用される)、初期値は '~/.weechat' 。 + (注意: パスが存在しない場合は WeeChat がディレクトリを作成します) + +*-h*, *--help*:: + ヘルプを表示 + +*-k*, *--keys*:: + WeeChat の デフォルトキーを表示 + +*-l*, *--license*:: + WeeChat ライセンスを表示 + +*-p*, *--no-plugin*:: + プラグインの自動ロードを止める + +// TRANSLATION MISSING +*-r*, *--run-command* '<command>':: + 起動後にコマンドを実行 (複数のコマンドを指定するにはセミコロンで各コマンドを区切る) + +*-s*, *--no-script*:: + スクリプトの自動ロードを止める + +// TRANSLATION MISSING +*--upgrade*:: + Upgrade WeeChat using session files generated with command `/upgrade -quit`. + +*-v*, *--version*:: + WeeChat のバージョンを表示 + +*plugin:option*:: + プラグインに渡すオプション diff --git a/doc/ja/weechat-curses.1.ja.txt b/doc/ja/weechat-curses.1.ja.txt new file mode 100644 index 000000000..b4622baa9 --- /dev/null +++ b/doc/ja/weechat-curses.1.ja.txt @@ -0,0 +1,116 @@ +// TRANSLATION MISSING (WHOLE FILE) +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.ja.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/ja/weechat_user.ja.txt b/doc/ja/weechat_user.ja.txt index 67128f452..270182fbd 100644 --- a/doc/ja/weechat_user.ja.txt +++ b/doc/ja/weechat_user.ja.txt @@ -78,25 +78,27 @@ WeeChat は cmake または autotools を使ってコンパイルできます (c [width="100%",cols="5,^3,^3,13",options="header"] |======================================== -| パッケージ ^(1)^ | バージョン | 必須 | 機能 -| cmake | | *yes* | ビルド (autotools でも可能ですが、cmake を推奨します) -| libncursesw5-dev ^(2)^ | | *yes* | ncurses インターフェイス -| libcurl4-gnutls-dev | | *yes* | URL 転送 -| zlib1g-dev | | *yes* | relay プラグインでパケットを圧縮 (weechat プロトコル)、スクリプトプラグイン -| libgcrypt11-dev | | *yes* | IRC SASL 認証 (DH-BLOWFISH/DH-AES)、スクリプトプラグイン -| libgnutls-dev | ≥ 2.2.0 | | IRC サーバへの SSL 接続 -| gettext | | | 国際化 (メッセージの翻訳; ベース言語は英語です) -| ca-certificates | | | SSL 接続に必要な証明書、relay プラグインで SSL サポート +| パッケージ ^(1)^ | バージョン | 必須 | 機能 +| cmake | | *yes* | ビルド (autotools でも可能ですが、cmake を推奨します) +| libncursesw5-dev ^(2)^ | | *yes* | ncurses インターフェイス +| libcurl4-gnutls-dev | | *yes* | URL 転送 +| zlib1g-dev | | *yes* | relay プラグインでパケットを圧縮 (weechat プロトコル)、スクリプトプラグイン +| libgcrypt11-dev | | *yes* | IRC SASL 認証 (DH-BLOWFISH/DH-AES)、スクリプトプラグイン +| libgnutls-dev | ≥ 2.2.0 | | IRC サーバへの SSL 接続 +| gettext | | | 国際化 (メッセージの翻訳; ベース言語は英語です) +| ca-certificates | | | SSL 接続に必要な証明書、relay プラグインで SSL サポート // TRANSLATION MISSING -| libaspell-dev or libenchant-dev | | | aspell プラグイン -| python-dev | ≥ 2.5 ^(3)^ | | python プラグイン -| libperl-dev | | | perl プラグイン -| ruby1.9.1-dev | ≥ 1.8 | | ruby プラグイン -| liblua5.1-0-dev | | | lua プラグイン -| tcl-dev | ≥ 8.5 | | tcl プラグイン -| guile-2.0-dev | ≥ 2.0 | | guile (scheme) プラグイン -| asciidoc | ≥ 8.5.0 | | 文書の生成 (HTML ファイル) -| source-highlight | | | HTML 文書に含まれるソースコードのシンタックスハイライト +| libaspell-dev or libenchant-dev | | | aspell プラグイン +| python-dev | ≥ 2.5 ^(3)^ | | python プラグイン +| libperl-dev | | | perl プラグイン +| ruby1.9.1-dev | ≥ 1.8 | | ruby プラグイン +| liblua5.1-0-dev | | | lua プラグイン +| tcl-dev | ≥ 8.5 | | tcl プラグイン +| guile-2.0-dev | ≥ 2.0 | | guile (scheme) プラグイン +| asciidoc | ≥ 8.5.0 | | 文書の生成 (HTML ファイル) +| source-highlight | | | HTML 文書に含まれるソースコードのシンタックスハイライト +// TRANSLATION MISSING +| docbook-xml, docbook-xsl | | | build man page |======================================== [NOTE] @@ -416,40 +418,7 @@ gdb /usr/bin/weechat-curses 12345 コマンドライン引数: --a, --no-connect:: - WeeChat の起動時にサーバへの自動接続を行わない - --c, --colors:: - ターミナルにデフォルトカラーを表示 - --d, --dir 'path':: - WeeChat のホームディレクトリを path に設定 (設定ファイル、ログ、 - ユーザプラグイン、スクリプトに利用される)、初期値は '~/.weechat' 。 - (注意: パスが存在しない場合は WeeChat がディレクトリを作成します) - --h, --help:: - ヘルプを表示 - --k, --keys:: - WeeChat の デフォルトキーを表示 - --l, --license:: - WeeChat ライセンスを表示 - --p, --no-plugin:: - プラグインの自動ロードを止める - --r, --run-command:: - 起動後にコマンドを実行 (複数のコマンドを指定するにはセミコロンで各コマンドを区切る) - --s, --no-script:: - スクリプトの自動ロードを止める - --v, --version:: - WeeChat のバージョンを表示 - -plugin:option:: - プラグインに渡すオプション (各プラグインのドキュメントを参照) +include::cmdline_options.ja.txt[] WeeChat を起動させるには、以下コマンドを実行: diff --git a/doc/weechat-curses.1 b/doc/weechat-curses.1 deleted file mode 100644 index 8ac48f009..000000000 --- a/doc/weechat-curses.1 +++ /dev/null @@ -1,130 +0,0 @@ -.TH WEECHAT 1 "May 2013" "Sebastien Helleu" - -.SH NAME -weechat-curses \- Wee Enhanced Environment for Chat (Curses version) - -.SH SYNOPSIS -.B weechat-curses -.RI [ option... ] -.RI [ plugin:option... ] -.br - -.SH DESCRIPTION -Fast, light and extensible chat client for many operating systems. -.br -Everything can be done with a keyboard. It is customizable and extensible with scripts. -.br -It is compliant with IRC RFCs 1459, 2810, 2811, 2812, and 2813. - -.SH OPTIONS -.TP -.B \-a, \-\-no\-connect -.br -disable auto-connect to servers at startup -.TP -.B \-c, \-\-colors -.br -display default colors in terminal -.TP -.B \-d, \-\-dir <dir> -.br -set WeeChat home dir -.TP -.B \-h, \-\-help -.br -display summary of options -.TP -.B \-k, \-\-keys -.br -display default keys -.TP -.B \-l, \-\-license -.br -display program license -.TP -.B \-p, \-\-no\-plugin -.br -don't load any plugin at startup -.TP -.B \-r, \-\-run\-command -.br -run command(s) after startup (many commands can be separated by semicolons) -.TP -.B \-s, \-\-no\-script -.br -don't load any script at startup -.TP -.B \-v, \-\-version -.br -display WeeChat version - -.SH PLUGIN OPTIONS -Options for plugins depend on plugins, you can look at plugins documentation on WeeChat website for more information. -.TP -For example, with irc plugin, you can connect to temporary server with an url like: -.B irc[6][s]://[[nickname][:password]@]server[:port][/#channel1[,#channel2...]] -.TP -To join WeeChat IRC channel support with nick "mynick": -irc://mynick@irc.freenode.net/#weechat -.TP -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 - -.SH FILES -.TP -.B $HOME/.weechat/weechat.conf -main WeeChat configuration file -.TP -.B $HOME/.weechat/plugins.conf -plugins configuration file -.TP -.B $HOME/.weechat/alias.conf -configuration file for alias plugin -.TP -.B $HOME/.weechat/aspell.conf -configuration file for aspell plugin -.TP -.B $HOME/.weechat/charset.conf -configuration file for charset plugin -.TP -.B $HOME/.weechat/irc.conf -configuration file for IRC plugin -.TP -.B $HOME/.weechat/logger.conf -configuration file for logger plugin -.TP -.B $HOME/.weechat/relay.conf -configuration file for relay plugin -.TP -.B $HOME/.weechat/rmodifier.conf -configuration file for rmodifier plugin -.TP -.B $HOME/.weechat/xfer.conf -configuration file for xfer plugin -.TP -.B $HOME/.weechat/weechat.log -WeeChat log file - -.SH LICENSE -Copyright (C) 2003-2013 Sebastien Helleu <flashcode@flashtux.org> -.br -WeeChat is distributed under the GNU General Public License, version 3. -Please read the COPYING file for more information. - -.SH BUGS -Please report bugs or feature requests at Savannah website: -.br -- Bugs: -.UR -http://savannah.nongnu.org/bugs/?group=weechat -.br -- Feature requests: -.UR -http://savannah.nongnu.org/task/?group=weechat - -.SH AUTHOR -WeeChat is written by Sebastien Helleu <flashcode@flashtux.org> -.br -Web: -.UR -http://www.weechat.org/ |