diff options
Diffstat (limited to 'weechat/doc')
41 files changed, 0 insertions, 33069 deletions
diff --git a/weechat/doc/CMakeLists.txt b/weechat/doc/CMakeLists.txt deleted file mode 100644 index a2b192b01..000000000 --- a/weechat/doc/CMakeLists.txt +++ /dev/null @@ -1,167 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -SET(DOC_LANGS - cs - de - en - fr - pl - ru - sco - sv - ) - -FIND_PROGRAM( - COPY cp - PATHS /bin /usr/bin /usr/local/bin /usr/pkg/bin -) - -FIND_PROGRAM( - XSLTPROC xsltproc - PATHS /bin /usr/bin /usr/local/bin /usr/pkg/bin -) - -FIND_PROGRAM( - DBLATEX dblatex - PATHS /bin /usr/bin /usr/local/bin /usr/pkg/bin - ) - -FIND_FILE(DOC_XSL_PREFIX chunk.xsl PATHS - /usr/share/xml/docbook/stylesheet/nwalsh/ - /usr/share/xml/docbook/xsl-stylesheets-1.69/ - PATH_SUFFIXES html - DOC "Path to nwalsh xsl stylesheet" - ) -STRING(REPLACE "/html/chunk.xsl" "" DOC_XSL_PREFIX "${DOC_XSL_PREFIX}") - -IF(XSLTPROC AND DOC_XSL_PREFIX AND COPY) - SET(BUILD_HTML TRUE) -ENDIF(XSLTPROC AND DOC_XSL_PREFIX AND COPY) - -IF(DBLATEX AND COPY) - SET(BUILD_PDF TRUE) -ENDIF(DBLATEX AND COPY) - -IF(BUILD_HTML) - CONFIGURE_FILE( - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html.xsl.in - ${CMAKE_CURRENT_BINARY_DIR}/weechat-html.xsl - @ONLY - ) - - CONFIGURE_FILE( - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in - ${CMAKE_CURRENT_BINARY_DIR}/weechat-html-one.xsl - @ONLY - ) -ENDIF(BUILD_HTML) - - -IF(BUILD_HTML OR BUILD_PDF) - EXECUTE_PROCESS( - COMMAND date "+%F %T" - OUTPUT_VARIABLE DOC_DATE - ) - STRING(REPLACE "\n" "" DOC_DATE "${DOC_DATE}") - - CONFIGURE_FILE( - ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in - ${CMAKE_CURRENT_BINARY_DIR}/date.xml - @ONLY - ) - - FOREACH(dlang ${DOC_LANGS}) - IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml) - - IF(BUILD_HTML) - FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}) - FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build) - FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}) - - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}/index.html ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}/weechat.${dlang}.html - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/config.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/irc_commands.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/key_functions.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_commands.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_BINARY_DIR}/date.xml" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/weechat-doc.css" "${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/weechat-doc.css" "${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}" - COMMAND ${XSLTPROC} ARGS -o ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}/ ${CMAKE_CURRENT_BINARY_DIR}/weechat-html.xsl ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build/weechat.${dlang}.xml - COMMAND ${XSLTPROC} ARGS -o ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}/weechat.${dlang}.html ${CMAKE_CURRENT_BINARY_DIR}/weechat-html-one.xsl ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}-build/weechat.${dlang}.xml - DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/config.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/irc_commands.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/key_functions.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_commands.xml - ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html.xsl.in - ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-doc.css - COMMENT "Building html doc (${dlang})" - ) - ADD_CUSTOM_TARGET(doc-html-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang}/index.html) - ADD_CUSTOM_TARGET(doc-html-one-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html-one/${dlang}/weechat.${dlang}.html) - INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/${dlang} DESTINATION share/doc/${PROJECT_NAME}/html) - - ENDIF(BUILD_HTML) - - IF(BUILD_PDF) - FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}) - FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build) - - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/weechat.${dlang}.pdf - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/config.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/irc_commands.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/key_functions.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_commands.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${COPY} ARGS "${CMAKE_CURRENT_BINARY_DIR}/date.xml" "${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build" - COMMAND ${DBLATEX} ARGS -c ${CMAKE_CURRENT_SOURCE_DIR}/dblatex.conf -o ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/weechat.${dlang}.pdf ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}-build/weechat.${dlang}.xml - DEPENDS - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/config.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/irc_commands.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/key_functions.xml - ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_commands.xml - ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in - ${CMAKE_CURRENT_SOURCE_DIR}/weechat-html-one.xsl.in - ${CMAKE_CURRENT_SOURCE_DIR}/date.xml.in - COMMENT "Building pdf doc (${dlang})" - ) - ADD_CUSTOM_TARGET(doc-pdf-${dlang} ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/weechat.${dlang}.pdf) - INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/pdf/${dlang}/weechat.${dlang}.pdf DESTINATION share/doc/${PROJECT_NAME}) - - ENDIF(BUILD_PDF) - - ENDIF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat.${dlang}.xml) - - ENDFOREACH(dlang ${DOC_LANGS}) - -ENDIF(BUILD_HTML OR BUILD_PDF) - -FOREACH(dlang ${DOC_LANGS}) - IF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_quickstart.${dlang}.txt) - INSTALL(FILES ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_quickstart.${dlang}.txt DESTINATION share/doc/${PROJECT_NAME}) - ENDIF(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${dlang}/weechat_quickstart.${dlang}.txt) -ENDFOREACH(dlang ${DOC_LANGS}) - -INSTALL(FILES ${CMAKE_CURRENT_SOURCE_DIR}/weechat-curses.1 DESTINATION share/man/man1) diff --git a/weechat/doc/Makefile.am b/weechat/doc/Makefile.am deleted file mode 100644 index 7e1116951..000000000 --- a/weechat/doc/Makefile.am +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -SUBDIRS = . en fr de ru pl cs sco sv - -man_MANS = weechat-curses.1 - -EXTRA_DIST = $(man_MANS) weechat-doc.css weechat-html-one.xsl.in weechat-html.xsl.in weechat-pdf.xsl dblatex.conf - -all-local: weechat-html.xsl weechat-html-one.xsl - -weechat-html.xsl: weechat-html.xsl.in - sed -e 's,\@DOC_XSL_PREFIX\@,$(DOC_XSL_PREFIX),g' < weechat-html.xsl.in > weechat-html.xsl - -weechat-html-one.xsl: weechat-html-one.xsl.in - sed -e 's,\@DOC_XSL_PREFIX\@,$(DOC_XSL_PREFIX),g' < weechat-html-one.xsl.in > weechat-html-one.xsl - -clean-local: - -rm -f weechat-html.xsl weechat-html-one.xsl diff --git a/weechat/doc/buildxml.pl b/weechat/doc/buildxml.pl deleted file mode 100755 index 918542487..000000000 --- a/weechat/doc/buildxml.pl +++ /dev/null @@ -1,188 +0,0 @@ -#!/usr/bin/perl -# -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -# -# Build some XML code for WeeChat doc -# with weechat-curses command -# - -@all_lang = ("fr_FR", "en_US", "de_DE"); -%all_encodings = ("fr_FR" => "iso-8859-1", - "en_US" => "iso-8859-1", - "de_DE" => "iso-8859-1"); -%all_types = ("fr_FR" => "type", - "en_US" => "type", - "de_DE" => "Typ", - "es_ES" => "tipo"); -%all_values = ("fr_FR" => "valeurs", - "en_US" => "values", - "de_DE" => "Werte", - "es_ES" => "valores"); -%all_default = ("fr_FR" => "valeur par d�faut", - "en_US" => "default value", - "de_DE" => "Standardwert", - "es_ES" => "valor por defecto"); -%all_desc = ("fr_FR" => "description", - "en_US" => "description", - "de_DE" => "Beschreibung", - "es_ES" => "descripci�n"); -$warning_do_not_edit = "\n<!-- ********* WARNING! *********\n\n" - ." This file is automatically built with a Perl script. DO NOT EDIT!\n" - ."-->\n\n"; - -foreach $lng (@all_lang) -{ - create_commands ($lng, $all_encodings{$lng}, - "weechat-curses -w | sed 1,2d", "weechat_commands"); - create_commands ($lng, $all_encodings{$lng}, - "weechat-curses -i | sed 1,2d", "irc_commands"); - create_key_func ($lng, $all_encodings{$lng}, - "weechat-curses -f | sed 1,2d", "key_functions"); - create_config ($lng, $all_encodings{$lng}, - "weechat-curses -c | sed 1,2d", "config"); - print "\n"; -} - -sub toxml -{ - $_ = $_[0]; - $_ =~ s/&/&/g; - $_ =~ s/</</g; - $_ =~ s/>/>/g; - return $_; -} - -sub create_commands -{ - $lang = $_[0]; - $lang2 = substr ($lang, 0, 2); - $encoding = $_[1]; - $command = $_[2]; - $file = $_[3]; - print "Creating $lang2/$file.xml ($lang)...\n"; - open XML, ">$lang2/$file.xml" or die "Error: can't write file!"; - print XML "<?xml version=\"1.0\" encoding=\"$encoding\"?>\n"; - print XML $warning_do_not_edit; - - $started = 0; - $ENV{"LANG"} = $lang; - foreach (`$command`) - { - if (/\* (.*)/) - { - print XML "</programlisting>\n" if ($started == 1); - $started = 1; - print XML "<command>".toxml($1)."</command>\n"; - print XML "<programlisting>"; - } - else - { - chomp ($_); - print XML toxml($_)."\n"; - } - } - print XML "</programlisting>\n"; - close XML; - iconv_file ($lang2."/".$file, $encoding); -} - -sub create_key_func -{ - $lang = $_[0]; - $lang2 = substr ($lang, 0, 2); - $encoding = $_[1]; - $command = $_[2]; - $file = $_[3]; - print "Creating $lang2/$file.xml ($lang)...\n"; - open XML, ">$lang2/$file.xml" or die "Error: can't write file!"; - print XML "<?xml version=\"1.0\" encoding=\"$encoding\"?>\n"; - print XML $warning_do_not_edit; - - $ENV{"LANG"} = $lang; - foreach (`$command`) - { - if (/\* (.*): (.*)/) - { - print XML "<row>\n"; - print XML " <entry><literal>$1</literal></entry>\n"; - print XML " <entry>$2</entry>\n"; - print XML "</row>\n"; - } - } - close XML; - iconv_file ($lang2."/".$file, $encoding); -} - -sub create_config -{ - $lang = $_[0]; - $lang2 = substr ($lang, 0, 2); - $encoding = $_[1]; - $command = $_[2]; - $file = $_[3]; - print "Creating $lang2/$file.xml ($lang)...\n"; - open XML, ">$lang2/$file.xml" or die "Error: can't write file!"; - print XML "<?xml version=\"1.0\" encoding=\"$encoding\"?>\n"; - print XML $warning_do_not_edit; - $type = ""; - $values = ""; - $default = ""; - $desc = ""; - - $ENV{"LANG"} = $lang; - foreach (`weechat-curses -c`) - { - if (/\* (.*):/) - { - print XML "<row>\n"; - print XML " <entry><option>$1</option></entry>\n"; - } - elsif (/ \. $all_types{$lang}: (.*)/) - { - $type = $1; - } - elsif (/ \. $all_values{$lang}: (.*)/) - { - $values = $1; - } - elsif (/ \. $all_default{$lang}: (.*)/) - { - $default = $1; - } - elsif (/ \. $all_desc{$lang}: (.*)/) - { - $_ = $1; - s/(.*)/\u$1/; - $desc = $_; - print XML " <entry>".toxml($type)."</entry>\n"; - print XML " <entry>".toxml($values)."</entry>\n"; - print XML " <entry>".toxml($default)."</entry>\n"; - print XML " <entry>".toxml($desc)."</entry>\n"; - print XML "</row>\n"; - } - } - close XML; - iconv_file ($lang2."/".$file, $encoding); -} - -sub iconv_file -{ - print "Converting $_[0].xml to $_[1]...\n"; - system ("iconv -t $encoding -o $_[0].xml.$_[1] $_[0].xml"); - system ("mv $_[0].xml.$_[1] $_[0].xml"); -} diff --git a/weechat/doc/cs/Makefile.am b/weechat/doc/cs/Makefile.am deleted file mode 100644 index 4a4617aff..000000000 --- a/weechat/doc/cs/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = cs -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(QUICKSTART) - -docdir = $(datadir)/doc/$(PACKAGE) - -# install docs - -install-data-hook: - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ diff --git a/weechat/doc/cs/weechat_quickstart.cs.txt b/weechat/doc/cs/weechat_quickstart.cs.txt deleted file mode 100644 index 6e7bc713a..000000000 --- a/weechat/doc/cs/weechat_quickstart.cs.txt +++ /dev/null @@ -1,104 +0,0 @@ -WeeChat (česká verze) -========================= - -1. Spuštění weechat - Podle požadovaného GUI je třeba spustit: - - weechat-curses pro Curses GUI - - weechat-gtk pro GTK GUI (vyvíjí se) - - weechat-qt pro Qt GUI (není vyvíjeno) - - weechat-wxwidgets pro WxWidgets GUI (není vyvíjeno) - -2. Online nápověda / možnosti - - WeeChat má nápovědu pro všechny příkazy (/help příkaz) - Pro získání nápovědy k příkazu se používá /help příkaz - - Pro nastavení voleb použijte /set volba = hodnota - Lze použít /set volba s částečným jménem (zobrazí všechny možnosti - obsahující písmena), nebo pouze s celým jménem volby bez hodnoty - (pro zobrazení dlouhé nápovědy k volbě). - - Důležitá poznámka: nastavení je ukládáno při skončení WeeChat - (nebo pomocí příkazu /save). NEEDITUJTE kontiguracni soubor za - běhu WeeChat, protože do něj můŽe WeeChat kdykoliv zapsat - a není možné jej znovu načíst. Pro změnu jakýchkoliv voleb - použijte příkaz /set, WeeChat okamžitě použije nové nastavení. - -3. Vytvoření serveru - - Například irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (pro kompletní nápovědu použijte /help server) - -4. Nastavení vlastních voleb serveru - - Přezdívky: - /set quakenet.server_nick1 = "mujeprezdivka" - /set quakenet.server_nick2 = "mujeprezdivka2" - /set quakenet.server_nick3 = "mujeprezdivka3" - - Uživatelské jméno / skutečné jméno: - /set quakenet.server_username = "moje uživatelské jméno" - /set quakenet.server_realname = "moje skutečné jméno" - - Automatické připojení k serveru: - /set quakenet.server_autoconnect = on - - Ostatní volby: - Pro zobrazení voleb serveru a jejich hodnot použijte /set quakenet - Pro nastavení volby použijte /set quakenet.volba_serveru = hodnota - -5. Připojení k serveru a automatické připojení ke kanálům - - /connect quakenet - -6. Příchod/odchod na/z kanálu - - Příchod na kanál: - /join #kanál - Odchod z kanálu: - /part [ukončovací zpráva] - Odchod z kanálu a zavření bufferu: - /close [ukončovací zpráva] - (/close je alias na /buffer close) - -7. Správa bufferů/oken - - Buffery lze spravovat pomocí příkazu "/buffer" a okna pomocí - příkazu "/window". - Například pro rozdělení okna vertikálně na malé okno (1/3 šíčky) - a velké (2/3) použijte příkaz: - /window splitv 33 - -8. Klávesové zkratky - - Podle Vaší klávesnice a/nebo potřeb si můžete změnit jakoukoliv - klávesu pomocí příkazu "/key". - Užitečná klávesa je meta-k (alt-k) pro nalezení klávesového kódu. - - Například pro napojení meta-y (alt-y) na příkaz "/buffer close"" - /key (stiskněte meta-k) (stiskněte meta-y) /buffer close - Dostanete řádek podobný tomuto: - /key meta-y /buffer close - -9. Pluginy/skripty - - Na některých distibucích jako Debian, jsou pluginy dostupné v samostatném - balíčku (jako weechat-plugins). - Pluginy jsou automatikcy načteny při nalezení. - Pro WeeChat je dostupných spousta pluginů/skriptů, více na: - http://weechat.flashtux.org/plugins.php - Pro načítání/rušení pluginů/skriptů se podívejde do dokumentace WeeChat. - -10. Další dokumentace - - Nyní můžete používat WeeChat a číst FAQ/dokumentaci v případě dalších dotazů: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Uživejte si WeeChat! - --- -(c) 2006-05-31, napsal FlashCode <flashcode@flashtux.org>, přeložil GolemJ <golemj@gmail.com> -This document is part of WeeChat and is distributed under GPL licence. -Tento dokunet je součástí WeeChat a je distribuován pod licencí GPL. diff --git a/weechat/doc/date.xml.in b/weechat/doc/date.xml.in deleted file mode 100644 index 7181cc6ff..000000000 --- a/weechat/doc/date.xml.in +++ /dev/null @@ -1 +0,0 @@ -<pubdate>@DOC_DATE@</pubdate> diff --git a/weechat/doc/dblatex.conf b/weechat/doc/dblatex.conf deleted file mode 100644 index 7820adbd9..000000000 --- a/weechat/doc/dblatex.conf +++ /dev/null @@ -1 +0,0 @@ -XslParam: weechat-pdf.xsl diff --git a/weechat/doc/de/Makefile.am b/weechat/doc/de/Makefile.am deleted file mode 100644 index 4e6d8ed9c..000000000 --- a/weechat/doc/de/Makefile.am +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = de -BOOK = weechat.$(LANGCODE) -BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART) - -if DBLATEX_FOUND -PDF = pdf-stamp -endif - -docdir = $(datadir)/doc/$(PACKAGE) - -all-local: html-stamp $(PDF) - -# HTML output with chunks (many pages) - -html: html-stamp - -html-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html/ - xsltproc -o html/ ../weechat-html.xsl $(BOOK).xml || true - cp ../weechat-doc.css html/ - touch html-stamp - -# HTML output, all in one page - -html1: html1-stamp - -html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html1/ - xsltproc -o html1/$(BOOK).html ../weechat-html-one.xsl $(BOOK).xml || true - cp ../weechat-doc.css html1/ - touch html1-stamp - -# PDF output - -pdf: pdf-stamp - -pdf-stamp: $(BOOK).xml $(BOOK_INCLUDE) - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - dblatex -c ../dblatex.conf $(BOOK).xml || true - touch pdf-stamp - -# install docs - -install-data-hook: - $(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ -if DBLATEX_FOUND - $(INSTALL_DATA) $(BOOK).pdf $(DESTDIR)$(docdir)/ -endif - -# clean - -clean-local: - -rm -f $(BOOK).html $(BOOK).pdf $(BOOK).txt date.xml - -rm -rf html/ html1/ - -rm -f html-stamp html1-stamp pdf-stamp diff --git a/weechat/doc/de/config.xml b/weechat/doc/de/config.xml deleted file mode 100644 index a0c140527..000000000 --- a/weechat/doc/de/config.xml +++ /dev/null @@ -1,1281 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><option>look_save_on_exit</option></entry> - <entry>Boolean</entry> - <entry></entry> - <entry>'on'</entry> - <entry>Konfiguration beim Verlassen abspeichern</entry> -</row> -<row> - <entry><option>look_set_title</option></entry> - <entry>Boolean</entry> - <entry></entry> - <entry>'on'</entry> - <entry>Fenstertitel setzen (oder Terminaltitel im Curses-GUI) mit Name und Version</entry> -</row> -<row> - <entry><option>look_startup_logo</option></entry> - <entry>Boolean</entry> - <entry></entry> - <entry>'on'</entry> - <entry>WeeChat-Logo beim Start anzeigen</entry> -</row> -<row> - <entry><option>look_startup_version</option></entry> - <entry>Boolean</entry> - <entry></entry> - <entry>'on'</entry> - <entry>WeeChat-Version beim Start anzeigen</entry> -</row> -<row> - <entry><option>look_weechat_slogan</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'the geekest IRC client!'</entry> - <entry>WeeChat-Slogan (wenn leer, wird keiner benutzt)</entry> -</row> -<row> - <entry><option>look_one_server_buffer</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>Benutze den gleichen Puffer f�r alle Server</entry> -</row> -<row> - <entry><option>look_open_near_server</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>�ffne neue Channels oder private Nachrichten neben dem Server-Puffer</entry> -</row> -<row> - <entry><option>look_scroll_amount</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 1 und 2147483647</entry> - <entry>3</entry> - <entry>Anzahl der zu scrollenden Zeilen bei Bild-Hoch- und Bild-Runter-Taste</entry> -</row> -<row> - <entry><option>look_buffer_timestamp</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'[%H:%M:%S]'</entry> - <entry>Timestamp f�r Puffer</entry> -</row> -<row> - <entry><option>look_color_nicks_number</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 1 und 10</entry> - <entry>10</entry> - <entry>Anzahl der f�r Nicknames zu benutzenden Farben</entry> -</row> -<row> - <entry><option>look_color_actions</option></entry> - <entry>Boolean</entry> - <entry>zwischen 1 und 10</entry> - <entry>'on'</entry> - <entry>Actions mit verschiedenen Farbe anzeigen</entry> -</row> -<row> - <entry><option>look_nicklist</option></entry> - <entry>Boolean</entry> - <entry>zwischen 1 und 10</entry> - <entry>'on'</entry> - <entry>Nicklisten-Fenster in Channelfenstern anzeigen</entry> -</row> -<row> - <entry><option>look_nicklist_position</option></entry> - <entry>Zeichenfolge</entry> - <entry>'left', 'right', 'top', 'bottom'</entry> - <entry>'right'</entry> - <entry>Nicklisten-Position (top, left, right (Standard), bottom)</entry> -</row> -<row> - <entry><option>look_nicklist_min_size</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 100</entry> - <entry>0</entry> - <entry>Minimale Gr��e der Nicklist (Breite oder H�he, je nach look_nicklist_position (0: kein Minimum)</entry> -</row> -<row> - <entry><option>look_nicklist_max_size</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 100</entry> - <entry>0</entry> - <entry>Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min = max and > 0, then size is fixed))</entry> -</row> -<row> - <entry><option>look_nicklist_separator</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 100</entry> - <entry>'on'</entry> - <entry>Trennzeichen zwischen Chatfenster und Nickliste</entry> -</row> -<row> - <entry><option>look_no_nickname</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'-cmd-'</entry> - <entry>Text, der statt Nickname erscheinen soll, wenn keine Verbindung besteht</entry> -</row> -<row> - <entry><option>look_nickmode</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Nickmode (@%+) vorm Nickname anzeigen</entry> -</row> -<row> - <entry><option>look_nickmode_empty</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>Leerzeichen anzeigen wenn Nickmode nicht @%+ ist</entry> -</row> -<row> - <entry><option>look_nick_prefix</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Text, der im Chatfenster vor dem Nickname erscheinen soll</entry> -</row> -<row> - <entry><option>look_nick_suffix</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>' |'</entry> - <entry>Text, der im Chatfenster nach dem Nickname erscheinen soll</entry> -</row> -<row> - <entry><option>look_align_nick</option></entry> - <entry>Zeichenfolge</entry> - <entry>'none', 'left', 'right'</entry> - <entry>'right'</entry> - <entry>Ausrichtung des Nicknamens (feste Gr��e bei Nicks im Chatfenster (none, left, right))</entry> -</row> -<row> - <entry><option>look_align_other</option></entry> - <entry>Boolean</entry> - <entry>'none', 'left', 'right'</entry> - <entry>'on'</entry> - <entry>Ausrichtung f�r andere Nachrichten, die nicht mit einem Nicknamen beginnen</entry> -</row> -<row> - <entry><option>look_align_size</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 8 und 64</entry> - <entry>14</entry> - <entry>Gr��e zum Ausrichten von Nicknamen und anderen Nachrichten</entry> -</row> -<row> - <entry><option>look_align_size_max</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 8 und 64</entry> - <entry>20</entry> - <entry>Maximale Gr��e zum Ausrichten von Nicknamen und anderen Nachrichten (sollte >= look_align_size sein)</entry> -</row> -<row> - <entry><option>look_nick_completor</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>':'</entry> - <entry>Nach Nickvervollst�ndigung anzuf�gende Zeichenfolge</entry> -</row> -<row> - <entry><option>look_nick_completion_ignore</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'[]-^'</entry> - <entry>Zeichen, die bei der Nickvervollst�ndigung ignoriert werden</entry> -</row> -<row> - <entry><option>look_nick_completion_smart</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Intelligente vervollst�ndigung der Nicknamen (vervollst�ndigt zuerst mit dem letzten Nick, der einen angesprochen hat)</entry> -</row> -<row> - <entry><option>look_nick_complete_first</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>Nur mit dem ersten, passenden Nicknamen vervollst�ndigen</entry> -</row> -<row> - <entry><option>look_infobar</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Infoleiste aktivieren</entry> -</row> -<row> - <entry><option>look_infobar_timestamp</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%B, %A %d %Y'</entry> - <entry>Timestamp in der Infobar</entry> -</row> -<row> - <entry><option>look_infobar_seconds</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Sekunden in der Infobar-Zeit anzeigen</entry> -</row> -<row> - <entry><option>look_infobar_delay_highlight</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>7</entry> - <entry>Anzeigezeit in Sekunden f�r Highlight-Messages in der Infobar (0: gar nicht erst anzeigen)</entry> -</row> -<row> - <entry><option>look_hotlist_names_count</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 32</entry> - <entry>3</entry> - <entry>Maximale Anzahl an Namen in der Hotlist (0 = keine Namen, nur Puffernummern)</entry> -</row> -<row> - <entry><option>look_hotlist_names_level</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 1 und 15</entry> - <entry>12</entry> - <entry>Level f�r Namensanzeige in der Hotlist (Kombination von: 1=join/part, 2=Nachricht, 4=Query, 8=Highlight, z.B. 12=Query+Highlight)</entry> -</row> -<row> - <entry><option>look_hotlist_names_length</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 32</entry> - <entry>0</entry> - <entry>Maximale L�nge der Namen in der Hotlist (0: kein Limit)</entry> -</row> -<row> - <entry><option>look_hotlist_sort</option></entry> - <entry>Zeichenfolge</entry> - <entry>'group_time_asc', 'group_time_desc', 'group_number_asc', 'group_number_desc', 'number_asc', 'number_desc'</entry> - <entry>'group_time_asc'</entry> - <entry>Hotlist sort type (group_time_asc (default), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)</entry> -</row> -<row> - <entry><option>look_day_change</option></entry> - <entry>Boolean</entry> - <entry>'group_time_asc', 'group_time_desc', 'group_number_asc', 'group_number_desc', 'number_asc', 'number_desc'</entry> - <entry>'on'</entry> - <entry>Spezielle Nachricht anzeigen, wenn ein neuer Tag beginnt</entry> -</row> -<row> - <entry><option>look_day_change_timestamp</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%a, %d %b %Y'</entry> - <entry>Zeitstempel f�r das Datum, das beim Tageswechsel angezeigt wird</entry> -</row> -<row> - <entry><option>look_read_marker</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>' '</entry> - <entry>Markiere die erste, ungelesene Zeile bei Server- und Channel-Puffern</entry> -</row> -<row> - <entry><option>look_input_format</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'[%n(%m)] '</entry> - <entry>Format der Eingabezeile ('%c' wird durch den Channel- oder Servernamen ersetzt, '%n' durch den Nicknamen und '%m' durch die Nick-Modi)</entry> -</row> -<row> - <entry><option>look_paste_max_lines</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>3</entry> - <entry>Max number of lines for paste without asking user (0 = disable this feature)</entry> -</row> -<row> - <entry><option>col_real_white</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>'off'</entry> - <entry>Wenn gesetzt, benutze echtes Wei�, als Voreinstellung jedoch f�r Terminals mit wei�em Hintergrund deaktiviert (solltest du niemals einen wei�en Hintergrund benutzen, solltest du diese Option aktivieren um ein echtes Wei� anstelle der voreingestellten Terminal Vordergrundfarbe zu bekommen)</entry> -</row> -<row> - <entry><option>col_separator</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Farbe der Fenster-Separatoren im Chatfenster (bei geteiltem Bildschirm)</entry> -</row> -<row> - <entry><option>col_title</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Textfarbe der Titelleiste</entry> -</row> -<row> - <entry><option>col_title_more</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightmagenta'</entry> - <entry>Farbe des '+' beim Scrolling des Topics</entry> -</row> -<row> - <entry><option>col_title_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Hintergrundfarbe der Titelleiste</entry> -</row> -<row> - <entry><option>col_chat</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe vom Chat-Text</entry> -</row> -<row> - <entry><option>col_chat_time</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe der Zeit im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_time_sep</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'brown'</entry> - <entry>Farbe f�r den Zeit-Separator im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_prefix1</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightcyan'</entry> - <entry>Farbe des 1. und 3. Pr�fixzeichens</entry> -</row> -<row> - <entry><option>col_chat_prefix2</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe des 2. Pr�fixzeichens</entry> -</row> -<row> - <entry><option>col_chat_server</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'brown'</entry> - <entry>Farbe des Servernamens</entry> -</row> -<row> - <entry><option>col_chat_join</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe des join-Pfeiles (Pr�fix)</entry> -</row> -<row> - <entry><option>col_chat_part</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightred'</entry> - <entry>Farbe des quit-Pfeiles (Pr�fix)</entry> -</row> -<row> - <entry><option>col_chat_nick</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightcyan'</entry> - <entry>Farbe der Nicknames in ACTIONs im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_host</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Farbe der Hostnames im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_channel</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe der Channelnamen in ACTIONs im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_dark</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'green'</entry> - <entry>Farbe der dunklen Separatoren im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_highlight</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'yellow'</entry> - <entry>Farbe der hervorgehobenen Nicknames im Chatfenster</entry> -</row> -<row> - <entry><option>col_chat_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Hintergrund des Chatfensters</entry> -</row> -<row> - <entry><option>col_chat_read_marker</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'yellow'</entry> - <entry>Farbe der Ungelesenenmarkierung</entry> -</row> -<row> - <entry><option>col_chat_read_marker_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'magenta'</entry> - <entry>Hintergrundfarbe der Ungelesenenmarkierung</entry> -</row> -<row> - <entry><option>col_status</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_delimiters</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Farbe der Statuszeilen-Separatoren</entry> -</row> -<row> - <entry><option>col_status_channel</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe des aktuellen Channels in der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_data_msg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'yellow'</entry> - <entry>Farbe eines Fensters mit neuen Messages in der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_private</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightmagenta'</entry> - <entry>Farbe eines Fensters mit Privatnachrichten in der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_highlight</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightred'</entry> - <entry>Farbe eines Fensters mit Highlights in der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_data_other</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe eines Fensters mit neuen Daten (nicht Nachrichten in der Statuszeile)</entry> -</row> -<row> - <entry><option>col_status_more</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe eines Fensters mit neuen Daten in der Statuszeile</entry> -</row> -<row> - <entry><option>col_status_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Hintergrund des Statusfensters</entry> -</row> -<row> - <entry><option>col_infobar</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'black'</entry> - <entry>Farbe des Infobar-Textes</entry> -</row> -<row> - <entry><option>col_infobar_delimiters</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Farbe der Infobar-Trennzeichen</entry> -</row> -<row> - <entry><option>col_infobar_highlight</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe der Infobar-Highlight-Notifikation</entry> -</row> -<row> - <entry><option>col_infobar_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Hintergrund des Infobar-Fensters</entry> -</row> -<row> - <entry><option>col_input</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe der Eingabezeile</entry> -</row> -<row> - <entry><option>col_input_server</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'brown'</entry> - <entry>Farbe des Eingabetextes (Servername)</entry> -</row> -<row> - <entry><option>col_input_channel</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe des Channelnamens in der Eingabezeile</entry> -</row> -<row> - <entry><option>col_input_nick</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightcyan'</entry> - <entry>Farbe des Nicknames in der Eingabezeile</entry> -</row> -<row> - <entry><option>col_input_delimiters</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Farbe des Trennzeichens in der Eingabezeile</entry> -</row> -<row> - <entry><option>col_input_text_not_found</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'red'</entry> - <entry>Farbe f�r den Text nicht gefunden</entry> -</row> -<row> - <entry><option>col_input_actions</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Color for actions in input window</entry> -</row> -<row> - <entry><option>col_input_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Hintergrundfarbe der Eingabezeile</entry> -</row> -<row> - <entry><option>col_nick</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_away</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Farbe von abwesenden Nicknames</entry> -</row> -<row> - <entry><option>col_nick_chanowner</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe des Channel-Owner-Symbols von unrealircd</entry> -</row> -<row> - <entry><option>col_nick_chanadmin</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe des Channel-Admin-Symbols von unrealircd</entry> -</row> -<row> - <entry><option>col_nick_op</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe des Operator-Symbols</entry> -</row> -<row> - <entry><option>col_nick_halfop</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightmagenta'</entry> - <entry>Farbe des Halb-Operator-Symbols</entry> -</row> -<row> - <entry><option>col_nick_voice</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'yellow'</entry> - <entry>Farbe des Voice-Symbols</entry> -</row> -<row> - <entry><option>col_nick_user</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Color for user symbol</entry> -</row> -<row> - <entry><option>col_nick_more</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightmagenta'</entry> - <entry>Farbe des '+' beim Scrolling von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_sep</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Farbe der Nicknamefenster-Trennlinie</entry> -</row> -<row> - <entry><option>col_nick_self</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe des eigenen Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color1</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'cyan'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color2</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'magenta'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color3</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'green'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color4</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'brown'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color5</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightblue'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color6</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color7</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightcyan'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color8</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightmagenta'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color9</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_color10</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'blue'</entry> - <entry>Farbe von Nicknames</entry> -</row> -<row> - <entry><option>col_nick_private</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Farbe des anderen Nicknames in Query-Fenstern</entry> -</row> -<row> - <entry><option>col_nick_bg</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'default'</entry> - <entry>Hintergrundfarbe der Nicknames</entry> -</row> -<row> - <entry><option>col_chat_dcc_selected</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'white'</entry> - <entry>Farbe des ausgew�hlten DCCs im Chatfenster</entry> -</row> -<row> - <entry><option>col_dcc_waiting</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightcyan'</entry> - <entry>Farbe des DCC-Status 'warten'</entry> -</row> -<row> - <entry><option>col_dcc_connecting</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'yellow'</entry> - <entry>Farbe des DCC-Status 'verbinden'</entry> -</row> -<row> - <entry><option>col_dcc_active</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightblue'</entry> - <entry>Farbe des DCC-Status 'aktiv'</entry> -</row> -<row> - <entry><option>col_dcc_done</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightgreen'</entry> - <entry>Farbe des DCC-Status 'fertig'</entry> -</row> -<row> - <entry><option>col_dcc_failed</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightred'</entry> - <entry>Farbe des DCC-Status 'fehlgeschlagen'</entry> -</row> -<row> - <entry><option>col_dcc_aborted</option></entry> - <entry>Farbe</entry> - <entry>Curses- oder Gtk-Farben</entry> - <entry>'lightred'</entry> - <entry>Farbe des DCC-Status 'abgebrochen'</entry> -</row> -<row> - <entry><option>history_max_lines</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>4096</entry> - <entry>Maximale Anzahl der Zeilen im Verlauf eines Server-, Channel- oder Queryfensters (0: kein Limit)</entry> -</row> -<row> - <entry><option>history_max_commands</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>100</entry> - <entry>Maximale Anzahl an Befehlen im Verlauf (0: kein Limit)</entry> -</row> -<row> - <entry><option>history_display_default</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>5</entry> - <entry>Maximale Anzahl der angezeigten Befehle im Verlauf (0: unbegrenzt)</entry> -</row> -<row> - <entry><option>log_auto_server</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>'off'</entry> - <entry>Automatisches Logging von Servermessages</entry> -</row> -<row> - <entry><option>log_auto_channel</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>'off'</entry> - <entry>Automatisches Logging von Channels</entry> -</row> -<row> - <entry><option>log_auto_private</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>'off'</entry> - <entry>Automatisches Logging von Queries</entry> -</row> -<row> - <entry><option>log_plugin_msg</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>'off'</entry> - <entry>Nachrichten von Skripten loggen</entry> -</row> -<row> - <entry><option>log_path</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%h/logs/'</entry> - <entry>Pfad f�r die WeeChat-Log-Dateien ('%h' wird durch WeeChat-Basisverzeichnis ersetztz, Voreinstellung ist ~/.weechat)</entry> -</row> -<row> - <entry><option>log_timestamp</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%Y %b %d %H:%M:%S'</entry> - <entry>Timestamp der Logdateien (siehe man strftime f�r die Syntax der Datum/Uhrzeit-Angaben)</entry> -</row> -<row> - <entry><option>log_hide_nickserv_pwd</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Von NickServ angezeigte Passw�rter verstecken</entry> -</row> -<row> - <entry><option>irc_display_away</option></entry> - <entry>Zeichenfolge</entry> - <entry>'off', 'local', 'channel'</entry> - <entry>'off'</entry> - <entry>Bei Abwesenheit und R�ckkehr eine Nachricht anzeigen</entry> -</row> -<row> - <entry><option>irc_show_away_once</option></entry> - <entry>Boolean</entry> - <entry>'off', 'local', 'channel'</entry> - <entry>'on'</entry> - <entry>In privaten Unterhaltungen nur einmalig eine Abwesenheitsnachricht anzeigen</entry> -</row> -<row> - <entry><option>irc_default_msg_part</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'WeeChat %v'</entry> - <entry>Standardnachricht beim Verlasseb eines Channels ('%v' wird durch die WeeChat-Version ersetzt)</entry> -</row> -<row> - <entry><option>irc_default_msg_quit</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'WeeChat %v'</entry> - <entry>Standardnachricht beim Beenden ('%v' wird durch die WeeChat-Version ersetzt)</entry> -</row> -<row> - <entry><option>irc_notice_as_pv</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>NOTICEs als Queries anzeigen</entry> -</row> -<row> - <entry><option>irc_away_check</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>0</entry> - <entry>Intervall zwischen zwei Away-Checks (in Minuten, 0 = nie �berpr�fen)</entry> -</row> -<row> - <entry><option>irc_away_check_max_nicks</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>0</entry> - <entry>�berpr�fe Abwesenheitsnachrichten nur in Channels mit maximal dieser Anzahl an Nicknamen (0 = unbegrenzt)</entry> -</row> -<row> - <entry><option>irc_lag_check</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 30 und 2147483647</entry> - <entry>60</entry> - <entry>Intervall zwischen zwei Lag-Messungen in Sekunden</entry> -</row> -<row> - <entry><option>irc_lag_min_show</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>1</entry> - <entry>Mindest-Lag, der angezeigt werden soll, in Sekunden</entry> -</row> -<row> - <entry><option>irc_lag_disconnect</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 2147483647</entry> - <entry>5</entry> - <entry>Maximal-Lag bis zum Trennen der Verbindung (in Minuten - 0: nie trennen)</entry> -</row> -<row> - <entry><option>irc_anti_flood</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 5</entry> - <entry>2</entry> - <entry>Anti-flood: # Sekunden zwischen zwei Benutzernachrichten (0 = kein anti-flood)</entry> -</row> -<row> - <entry><option>irc_fifo_pipe</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 5</entry> - <entry>'off'</entry> - <entry>Einen FIFO zur Fernsteuerung des Clients von anderen Prozessen �ffnen</entry> -</row> -<row> - <entry><option>irc_highlight</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Durch Kommata getrennte Liste der hervorzuhebenden W�rter (Gro�-/Kleinschreibung wird nicht beachtet, die W�rter k�nnen mit "*" als Joker beginnen oder enden)</entry> -</row> -<row> - <entry><option>irc_colors_receive</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Wenn der Schalter deaktiviert ist, werden die Farben von eingehenden Nachrichten entfernt</entry> -</row> -<row> - <entry><option>irc_colors_send</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Allow user to send colors with special codes (^Cb=bold, ^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, ^Cr=reverse)</entry> -</row> -<row> - <entry><option>irc_send_unknown_commands</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>Sende unbekannte Befehle an den IRC-Server</entry> -</row> -<row> - <entry><option>dcc_auto_accept_files</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>DCC-Datei�bertragungen automatisch annehmen</entry> -</row> -<row> - <entry><option>dcc_auto_accept_chats</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>DCC-CHats automatisch annehmen (Vorsicht!)</entry> -</row> -<row> - <entry><option>dcc_timeout</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 5 und 2147483647</entry> - <entry>300</entry> - <entry>DCC-Timeout in Sekunden</entry> -</row> -<row> - <entry><option>dcc_blocksize</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 1024 und 102400</entry> - <entry>65536</entry> - <entry>Blockgr��e f�r DCCs</entry> -</row> -<row> - <entry><option>dcc_fast_send</option></entry> - <entry>Boolean</entry> - <entry>zwischen 1024 und 102400</entry> - <entry>'on'</entry> - <entry>Warte beim Veschicken von Dateien nicht auf das ACK-Signal</entry> -</row> -<row> - <entry><option>dcc_port_range</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Beschr�nkt ausgehenden DCC auf die ausschlie�liche Benutzung von Ports in einem vorgegebenen Bereich (hilfreich bei NAT) (Syntax: ein einzelner Port, z.B. 5000, oder eine Port-Bereich, z.B. 5000-5015,wenn kein Bereich angegeben ist, ist jeder Port m�glich)</entry> -</row> -<row> - <entry><option>dcc_own_ip</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>IP- oder DNS-Adresse f�r ausgehenden DCC (wenn kein Wert angegeben wird, wird die IP des lokalen Interfaces benutzt)</entry> -</row> -<row> - <entry><option>dcc_download_path</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%h/dcc'</entry> - <entry>Pfad f�r per DCC eingehende Dateien (Standardwert: Homeverzeichnis)</entry> -</row> -<row> - <entry><option>dcc_upload_path</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'~'</entry> - <entry>Pfad, aus dem Dateien standardm��ig gelesen werden, wenn keine explizite Angabe vorliegt</entry> -</row> -<row> - <entry><option>dcc_convert_spaces</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Leerzeichen in Unterstriche umwandeln beim Veschicken von Dateien</entry> -</row> -<row> - <entry><option>dcc_auto_rename</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Eingehende Dateien automatisch umbenennen, falls n�tig, um �berschreiben zu vermeiden (durch Hinzuf�gen von '.1', '.2', ...)</entry> -</row> -<row> - <entry><option>dcc_auto_resume</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Abgebrochene �bertragungen automatisch fortsetzen, wenn die Verbindung abgebrochen ist</entry> -</row> -<row> - <entry><option>proxy_use</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'off'</entry> - <entry>Einen Proxyserver verwenden, um die Verbindung zum IRC-Server aufzubauen</entry> -</row> -<row> - <entry><option>proxy_type</option></entry> - <entry>Zeichenfolge</entry> - <entry>'http', 'socks4', 'socks5'</entry> - <entry>'http'</entry> - <entry>Proxytyp (http (Standard), socks4, socks5)</entry> -</row> -<row> - <entry><option>proxy_ipv6</option></entry> - <entry>Boolean</entry> - <entry>'http', 'socks4', 'socks5'</entry> - <entry>'off'</entry> - <entry>Verbindung zum Proxy �ber IPv6 aufbauen</entry> -</row> -<row> - <entry><option>proxy_address</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Adresse des Proxyservers (IP oder Hostname)</entry> -</row> -<row> - <entry><option>proxy_port</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 65535</entry> - <entry>3128</entry> - <entry>Port, auf dem der Proxyserver l�uft</entry> -</row> -<row> - <entry><option>proxy_username</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Benutzername f�r die Proxyverbindung</entry> -</row> -<row> - <entry><option>proxy_password</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Passwort f�r die Proxyverbindung</entry> -</row> -<row> - <entry><option>plugins_path</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'%h/plugins'</entry> - <entry>Suchpfad f�r WeeChat-Plugins ('%h' wird durch das WeeChat-Basisiverzeichnis ersetzt, voreingestellt ist ~/.weechat)</entry> -</row> -<row> - <entry><option>plugins_autoload</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'*'</entry> - <entry>Kommagetrennte Liste der Plugins, die beim Start automatisch geladen werden sollen, "*" l�dt alle gefundenen Plugins (es k�nnen auch Teile des Namens angegeben werden, "perl" l�dt z.B. auch "libperl.so")</entry> -</row> -<row> - <entry><option>plugins_extension</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'.so'</entry> - <entry>Standard-Dateinamenserweiterung f�r Plugins, wird f�r das automatische Laden verwendet (wenn kein Wert angegeben ist und der Wert f�r das automatische Laden "*" ist, werden alle Dateien geladen)</entry> -</row> -<row> - <entry><option>server_name</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Mit dem IRC-Server assoziierter eindeutiger Name (nur zur Anzeige)</entry> -</row> -<row> - <entry><option>server_autoconnect</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Automatisch mit dem Server verbinden, wenn WeeChat gestartet wird</entry> -</row> -<row> - <entry><option>server_autoreconnect</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Die Verbindung nach Trennung automatisch wiederherstellen</entry> -</row> -<row> - <entry><option>server_autoreconnect_delay</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 65535</entry> - <entry>30</entry> - <entry>Zeit in Sekunden, die gewartet wird, bevor ein Verbindungsneuaufbau versucht wird</entry> -</row> -<row> - <entry><option>server_address</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>IP-Adresse oder Hostname des IRC-Servers</entry> -</row> -<row> - <entry><option>server_port</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 65535</entry> - <entry>6667</entry> - <entry>Port, auf dem der IRC-Server l�uft</entry> -</row> -<row> - <entry><option>server_ipv6</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 65535</entry> - <entry>'off'</entry> - <entry>Server �ber IPv6 ansprechen</entry> -</row> -<row> - <entry><option>server_ssl</option></entry> - <entry>Boolean</entry> - <entry>zwischen 0 und 65535</entry> - <entry>'off'</entry> - <entry>Server �ber SSL ansprechen</entry> -</row> -<row> - <entry><option>server_password</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Passwort f�r den IRC-Server</entry> -</row> -<row> - <entry><option>server_nick1</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Eigener Nickname, der auf dem IRC-Server benutzt werden soll</entry> -</row> -<row> - <entry><option>server_nick2</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Alternativer Nickname, der auf dem IRC-Server benutzt werden soll, wenn der erste Kandidat bereits benutzt wird</entry> -</row> -<row> - <entry><option>server_nick3</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>2. alternativer Nickname, der auf dem IRC-Server benutzt werden soll, wenn der erste alternative Nickname bereits benutzt wird</entry> -</row> -<row> - <entry><option>server_username</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Benutzername, der an den Server �bermittelt werden soll</entry> -</row> -<row> - <entry><option>server_realname</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Voller Name, der an den Server �bermittelt werden soll</entry> -</row> -<row> - <entry><option>server_hostname</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Angepasster Hostname oder angepasste IP-Adresse f�r den Server (wenn nichts eingetragen ist, wird der lokale Hostname verwendet)</entry> -</row> -<row> - <entry><option>server_command</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Befehle, die nach der Verbindung zum Server ausgef�hrt werden sollen (mehrere Befehle m�ssen mit einem Semikolon getrennt werden, um ein Semikolon zu schreiben, muss man '\;' verwenden, die spezielllen Variablen $nick, $channel und $server werden dabei durch den jeweiligen Wert ersetzt)</entry> -</row> -<row> - <entry><option>server_command_delay</option></entry> - <entry>Ganzzahl</entry> - <entry>zwischen 0 und 3600</entry> - <entry>0</entry> - <entry>Wartezeit in Sekunden nach Ausf�hrung des Befehls, um z.B. eine Authentifizierung zu erm�glichen</entry> -</row> -<row> - <entry><option>server_autojoin</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Durch Kommata getrennte Liste der Channels, die beim Verbinden zum Server betreten werden sollen (Beispiel: "#chan1,#chan2,#chan3 key1,key2")</entry> -</row> -<row> - <entry><option>server_autorejoin</option></entry> - <entry>Boolean</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>'on'</entry> - <entry>Channels nach Kick automatisch wieder betreten, falls m�glich</entry> -</row> -<row> - <entry><option>server_notify_levels</option></entry> - <entry>Zeichenfolge</entry> - <entry>eine beliebige Zeichenfolge</entry> - <entry>''</entry> - <entry>Durch Kommata getrennte Liste der Notify-Levels f�r die Channels auf diesem Server (Format: #channel:1,...), der Channelname '*' ist f�r den Default-Server-Notify-Level</entry> -</row> diff --git a/weechat/doc/de/irc_commands.xml b/weechat/doc/de/irc_commands.xml deleted file mode 100644 index 0a157dd18..000000000 --- a/weechat/doc/de/irc_commands.xml +++ /dev/null @@ -1,443 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>admin [Ziel]</command> -<programlisting> -Information �ber den Server-Administrator abfragen - -Ziel: Server - -</programlisting> -<command>ame Nachricht</command> -<programlisting> -Nachricht an alle Channels aller verbundenen Server schicken - -zu sendende Nachricht - -</programlisting> -<command>amsg Text</command> -<programlisting> -Nachricht an alle Channels aller verbundener Server schicken - -Text: zu sendender Text - -</programlisting> -<command>away [-all] [Nachricht]</command> -<programlisting> -Abwesenheitsnachricht ein/ausschalten - - -all: Abwesenheitszustand auf allen Servern �ndern -Nachricht: Abwesenheitsnachricht (bzw. keine, um den Abwesenheitszustand zu deaktivieren) - -</programlisting> -<command>ban [Channel] [Nickname [Nickname ...]]</command> -<programlisting> -Nicknames oder Hosts sperren/verbannen - - Channel: Channel f�r die Sperre -Nickname: zu sperrender User oder Host - -</programlisting> -<command>ctcp Empf�nger Typ [Argumente]</command> -<programlisting> -CTCP-Nachricht verschicken - - Empf�nger: User, an den die CTCP-Nachricht geschickt werden soll - Typ: Typ der CTCP-Nachricht (z.B. "version", "ping", ..) -Argumente: Argumente f�r CTCP - -</programlisting> -<command>cycle [Channel[,Channel]] [Abschiedsnachricht]</command> -<programlisting> -einen Channel verlassen und wieder betreten - - Channel: zu verlassender Channel -Abschiedsnachricht: Abschiedsnachricht (die den anderen Usern angezeigt wird) - -</programlisting> -<command>dehalfop Nickname [Nickname]</command> -<programlisting> -Halb-Operatorstatus aberkennen - -</programlisting> -<command>deop Nickname [Nickname]</command> -<programlisting> -Operatorstatus aberkennen - -</programlisting> -<command>devoice Nickname [Nickname]</command> -<programlisting> -Voice wegnehmen - -</programlisting> -<command>die</command> -<programlisting> -Server herunterfahren - -</programlisting> -<command>halfop Nickname [Nickname]</command> -<programlisting> -Halb-Operatorstatus verleihen - -</programlisting> -<command>info [Ziel]</command> -<programlisting> -Information �ber den Server abfragen - -Ziel: Servername - -</programlisting> -<command>invite Nickname Channel</command> -<programlisting> -jemanden in einen Channel einladen - -Nickname: Chatname des Einzuladenden -Channel: Channel, in den er eingeladen werden soll - -</programlisting> -<command>ison Nickname [Nickname ...]</command> -<programlisting> -�berpr�fen, ob jemand zur Zeit im IRC ist - -Nickname: Nickname - -</programlisting> -<command>join Channel[,Channel] [Passwort[,Passwort]]</command> -<programlisting> -einen Channel betreten - -Channel: zu betretender Channel - Passwort: Channelpasswort (+k-Mode) - -</programlisting> -<command>kick [Channel] Nickname [Kommentar]</command> -<programlisting> -einen User aus einem Channel herauskicken - -Channel: Channel des Benutzers -Nickname: Nickname des Benutzers -Kommentar: Begr�ndung f�r den Kick - -</programlisting> -<command>kickban [Channel] Nickname [Kommentar]</command> -<programlisting> -kickt und verbannt jemanden von einem Channel - -Channel: Channel des Benutzers -Nickname: Nickname des Benutzers -Kommentar: Begr�ndung f�r den Kickban - -</programlisting> -<command>kill Nickname Kommentar</command> -<programlisting> -Jemanden vom Server werfen - -Nickname: Chatname -Kommentar: Begr�ndung - -</programlisting> -<command>links [[Server] Servermaske]</command> -<programlisting> -Alle dem antwortenden Server bekannten Servernamen auflisten - - Server: dieser Server soll die Anfrage beantworten -Servermaske: die aufzulistenden Server sollen diesem Muster entsprechen - -</programlisting> -<command>list [Channel[,Channel] [Server]]</command> -<programlisting> -Channels mit ihren Topics auflisten - -Channel: aufzulistender Channel (regul�re Ausdr�cke sind m�glich) -Server: Servername - -</programlisting> -<command>lusers [Maske [Ziel]]</command> -<programlisting> -Statistik �ber die Gr��e dieses IRC-Netzwerks abfragen - - Maske: Nur Server, die diesem Muster entsprechen -Ziel: Server, der die Anfrage weiterleiten soll - -</programlisting> -<command>me Nachricht</command> -<programlisting> -eine CTCP ACTION an den aktuellen Channel senden - -zu sendende Nachricht - -</programlisting> -<command>mode { Channel {[+|-]|o|p|s|i|t|n|b|v} [Limit] [User] [Bannmaske] } | {Nickname {[+|-]|i|w|s|o} }</command> -<programlisting> -Channel- oder Usermode �ndern - -Channelmodi: - Channel: zu �ndernder Channel - o: gib/nimm Operatorstatus - p: privater Channel - s: geheimer Channel - i: geschlossener Channel (Zutritt nur mit Einladung) - t: nur Operatoren d�rfen das Topic setzen - n: keine Channelnachrichten von au�erhalb des Channels - m: moderierter Channel (schreiben nur mit Voice) - l: maximale Anzahl an Usern im Channel festlegen - b: Bannmaske f�r zu sperrende User (in nick!ident@host-Form) - e: lege Ausnahmemaske fest - v: gib/nimm Voice (d.h. Schreibrecht bei moderierten Channels) - k: Channelkey/Channelpasswort festlegen -Usermodi: - Nickname: zu �ndernder Nickname - i: User als unsichtbar kennzeichnen - s: User empf�ngt Server-Nachrichten - w: User empf�ngt WALLOPS - o: User ist Channeloperator - -</programlisting> -<command>motd [Ziel]</command> -<programlisting> -die "Nachricht von heute" abfragen - -Ziel: Servername - -</programlisting> -<command>msg Empf�nger[,Empf�nger] Text</command> -<programlisting> -Nachricht an Nick/Channel verschicken - -Empf�nger: Nick/Channel (darf eine Maske sein, '*' = aktueller Channel) -Text: zu sendender Text - -</programlisting> -<command>names [Channel[,Channel]]</command> -<programlisting> -Nicknames in Channels auflisten - -Channel: Channelname - -</programlisting> -<command>nick [-all] Nickname</command> -<programlisting> -aktuellen Nickname wechseln - - -all: Nickname auf allen verbundenen Servern �ndern -Nickname: neuer Nickname - -</programlisting> -<command>notice Nickname Text</command> -<programlisting> -NOTICE an einen User verschicken - -Nickname: Empf�nger der Nachricht - Text: zu sendender Text - -</programlisting> -<command>op Nickname [Nickname]</command> -<programlisting> -Channeloperatorstatus verleihen - -</programlisting> -<command>oper Benutzername Passwort</command> -<programlisting> -Serveroperatorprivilegien anfordern - -Benutzername/Passwort: Account im IRC-Server - -</programlisting> -<command>part [Channel[,Channel]] [Abschiedsnachricht]</command> -<programlisting> -einen Channel verlassen - - Channel: zu verlassender Channel -Abschiedsnachricht: Abschiedsnachricht, die den anderen Usern angezeigt wird - -</programlisting> -<command>ping Server1 [Server2]</command> -<programlisting> -Server anpingen - -Server1: Anzupingender Server -Server2: Ping an diesen Server weiterleiten - -</programlisting> -<command>pong Daemon [Daemon2]</command> -<programlisting> -auf Ping antworten - - Daemon: Daemon, der auf die Ping-Nachricht geantwortet hat -Daemon2: Nachricht an diesen Daemon weiterleiten - -</programlisting> -<command>query Nickname [Text]</command> -<programlisting> -private Nachricht an jemanden schicken - -Nickname: Nickname f�r privaten Chat - Text: zu sendender Text - -</programlisting> -<command>quit [Abschiedsnachricht]</command> -<programlisting> -alle Verbindungen trennen und Programm beenden - -Abschiednachricht: anderen Usern zu zeigende Nachricht - -</programlisting> -<command>quote Daten</command> -<programlisting> -Daten direkt an Server senden (siehe RFC 2812) - -Daten: zu sendende Rohdaten - -</programlisting> -<command>rehash</command> -<programlisting> -den Server dazu bringen, seine Konfigurationsdatei neu zu laden - -</programlisting> -<command>restart</command> -<programlisting> -den Server dazu bringen, sich selbst neu zu starten - -</programlisting> -<command>service Nickname reserviert Distribution Typ reserviert Info</command> -<programlisting> -einen neuen Service eintragen - -Distribution: Sichtbarkeit des Services - Typ: f�r sp�tere Verwendung reserviert - -</programlisting> -<command>servlist [Maske [Typ]]</command> -<programlisting> -zur Zeit verbundene Services auflisten - -Maske: nur zutreffende Services auflisten -Typ: nur Services von diesem Typ auflisten - -</programlisting> -<command>squery Service Text</command> -<programlisting> -Nachricht an einen Service senden - -Service: Name des Service -Text: zu sendender Text - -</programlisting> -<command>squit Server Kommentar</command> -<programlisting> -Serververbindungen trennen - -Server: Servername -Kommentar: Trennungsgrund - -</programlisting> -<command>stats [Anfrage [Server]]</command> -<programlisting> -Serverstatistik abfragen - - Anfrage: c/h/i/k/l/m/o/y/u (siehe RFC1459) -Server: zu befragender Server - -</programlisting> -<command>summon User [Ziel [Channel]]</command> -<programlisting> -Nutzer, die auf dem IRC-Server arbeiten, darum bitten, auf den IRC-Server zu kommen - - User: Benutzername -Ziel: Servername -Channel: Channelname - -</programlisting> -<command>time [Ziel]</command> -<programlisting> -Ortszeit des Servers abfragen - -Ziel: der zu fragende Server - -</programlisting> -<command>topic [Channel] [Topic]</command> -<programlisting> -Channeltopic abfragen/setzen - -Channel: Channelname -Topic: neues Topic (oder "-delete" zum Entfernen des Topics) - -</programlisting> -<command>trace [Ziel]</command> -<programlisting> -Route zum angegebenen Server ermitteln - -Ziel: Server - -</programlisting> -<command>unban [Channel] nickname [nickname ...]</command> -<programlisting> -Bann aufheben - - Channel: Channel, in dem der Bann aufzuheben ist -Nickname: User, f�r den der Bann aufzuheben ist - -</programlisting> -<command>userhost Nickname [Nickname ...]</command> -<programlisting> -liste von Nickname-Informationen ermitteln - -Nickname: Nickname - -</programlisting> -<command>users [Ziel]</command> -<programlisting> -auf dem Server eingeloggte User auflisten - -Ziel: Server - -</programlisting> -<command>version [Server | Nickname]</command> -<programlisting> -Versionsinformationen von Nickname oder Server ermitteln - - Server: Servername -Nickname: Nickname - -</programlisting> -<command>voice Nickname [Nickname]</command> -<programlisting> -Voice vergeben - -</programlisting> -<command>wallops Text</command> -<programlisting> -Nachricht an alle User schicken, die den 'w'-Mode gesetzt haben - -zu sendender Text - -</programlisting> -<command>who [Maske ["o"]]</command> -<programlisting> -erweiterte Nicknameliste - -Maske: nur Information �ber betreffende Nicknames abfragen - o: nur Operatoren ausgeben, die dem Filter entsprechen - -</programlisting> -<command>whois [Server] Nickname[,Nickname]</command> -<programlisting> -Information �ber User abfragen - - Server: Servername -Nickname: Nickname (oder eine Maske) - -</programlisting> -<command>whowas Nickname [,Nickname [,Nickname ...]] [Anzahl [Ziel]]</command> -<programlisting> -Information �ber die Vergangenheit eines Nicknames erfragen - -Nickname: abzufragende Nicknames - Anzahl: maximale Anzahl an Antworten (negative Zahl f�r eine vollst�ndige Liste) - Ziel: zu suchende Hostmaske - -</programlisting> diff --git a/weechat/doc/de/key_functions.xml b/weechat/doc/de/key_functions.xml deleted file mode 100644 index 4ad36226b..000000000 --- a/weechat/doc/de/key_functions.xml +++ /dev/null @@ -1,215 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><literal>return</literal></entry> - <entry>Zeile terminieren</entry> -</row> -<row> - <entry><literal>tab</literal></entry> - <entry>Wort vervollst�ndigen</entry> -</row> -<row> - <entry><literal>tab_previous</literal></entry> - <entry>finde letzte Wortvervollst�ndigung</entry> -</row> -<row> - <entry><literal>backspace</literal></entry> - <entry>vorheriges Zeichen l�schen</entry> -</row> -<row> - <entry><literal>delete</literal></entry> - <entry>n�chstes Zeichen l�schen</entry> -</row> -<row> - <entry><literal>delete_end_line</literal></entry> - <entry>bis zum Zeilenende l�schen</entry> -</row> -<row> - <entry><literal>delete_beginning_line</literal></entry> - <entry>bis zum Zeilenanfang l�schen</entry> -</row> -<row> - <entry><literal>delete_line</literal></entry> - <entry>ganze Zeile l�schen</entry> -</row> -<row> - <entry><literal>delete_previous_word</literal></entry> - <entry>vorheriges Wort l�schen</entry> -</row> -<row> - <entry><literal>delete_next_word</literal></entry> - <entry>n�chstes Wort l�schen</entry> -</row> -<row> - <entry><literal>clipboard_paste</literal></entry> - <entry>einf�gen</entry> -</row> -<row> - <entry><literal>transpose_chars</literal></entry> - <entry>Zeichen vertauschen</entry> -</row> -<row> - <entry><literal>home</literal></entry> - <entry>zum Zeilenanfang gehen</entry> -</row> -<row> - <entry><literal>end</literal></entry> - <entry>zum Zeilenende gehen</entry> -</row> -<row> - <entry><literal>left</literal></entry> - <entry>ein Zeichen nach links gehen</entry> -</row> -<row> - <entry><literal>previous_word</literal></entry> - <entry>ein Wort nach links gehen</entry> -</row> -<row> - <entry><literal>right</literal></entry> - <entry>ein Zeichen nach rechts gehen</entry> -</row> -<row> - <entry><literal>next_word</literal></entry> - <entry>ein Wort nach rechts gehen</entry> -</row> -<row> - <entry><literal>up</literal></entry> - <entry>vorherigen Befehl aus dem Verlauf abfragen</entry> -</row> -<row> - <entry><literal>up_global</literal></entry> - <entry>vorherigen Befehl aus dem globalen Verlauf abfragen</entry> -</row> -<row> - <entry><literal>down</literal></entry> - <entry>n�chsten Befehl aus dem Verlauf abfragen</entry> -</row> -<row> - <entry><literal>down_global</literal></entry> - <entry>n�chsten Befehl aus dem globalen Verlauf abfragen</entry> -</row> -<row> - <entry><literal>page_up</literal></entry> - <entry>eine Seite hochscrollen</entry> -</row> -<row> - <entry><literal>page_down</literal></entry> - <entry>eine Seite herunterscrollen</entry> -</row> -<row> - <entry><literal>scroll_up</literal></entry> - <entry>einige Zeilen hochscrollen</entry> -</row> -<row> - <entry><literal>scroll_down</literal></entry> - <entry>einige Zeilen herunterscrollen</entry> -</row> -<row> - <entry><literal>scroll_top</literal></entry> - <entry>nach ganz oben scrollen</entry> -</row> -<row> - <entry><literal>scroll_bottom</literal></entry> - <entry>nach ganz unten scrollen</entry> -</row> -<row> - <entry><literal>scroll_topic_left</literal></entry> - <entry>Topic nach links scrollen</entry> -</row> -<row> - <entry><literal>scroll_topic_right</literal></entry> - <entry>Topic nach rechts scrollen</entry> -</row> -<row> - <entry><literal>nick_beginning</literal></entry> - <entry>zum Anfang der Nicklist gehen</entry> -</row> -<row> - <entry><literal>nick_end</literal></entry> - <entry>zum Ende der Nicklist gehen</entry> -</row> -<row> - <entry><literal>nick_page_up</literal></entry> - <entry>Nickliste eine Seite hochscrollen</entry> -</row> -<row> - <entry><literal>nick_page_down</literal></entry> - <entry>Nickliste eine Seite herunterscrollen</entry> -</row> -<row> - <entry><literal>jump_smart</literal></entry> - <entry>zu n�chstem aktiven Puffer springen</entry> -</row> -<row> - <entry><literal>jump_dcc</literal></entry> - <entry>zum DCC-Puffer springen</entry> -</row> -<row> - <entry><literal>jump_raw_data</literal></entry> - <entry>gehe zum IRC-Rohdaten-Puffer</entry> -</row> -<row> - <entry><literal>jump_last_buffer</literal></entry> - <entry>zum letzten Puffer springen</entry> -</row> -<row> - <entry><literal>jump_previous_buffer</literal></entry> - <entry>jump to previous buffer</entry> -</row> -<row> - <entry><literal>jump_server</literal></entry> - <entry>zum Serverpuffer springen</entry> -</row> -<row> - <entry><literal>jump_next_server</literal></entry> - <entry>zum n�chsten Server springen</entry> -</row> -<row> - <entry><literal>switch_server</literal></entry> - <entry>wechsel den aktiven Server im Server-Puffer</entry> -</row> -<row> - <entry><literal>scroll_previous_highlight</literal></entry> - <entry>scrolle zur vorherigen hervorhebung im Puffer</entry> -</row> -<row> - <entry><literal>scroll_next_highlight</literal></entry> - <entry>scrolle zur n�chsten Hervorhebung im Puffer</entry> -</row> -<row> - <entry><literal>scroll_unread</literal></entry> - <entry>scrolle zur ersten, ungelesenen Zeile im Puffer</entry> -</row> -<row> - <entry><literal>set_unread</literal></entry> - <entry>set unread marker on all buffers</entry> -</row> -<row> - <entry><literal>hotlist_clear</literal></entry> - <entry>Hotlist leeren</entry> -</row> -<row> - <entry><literal>infobar_clear</literal></entry> - <entry>Infobar leeren</entry> -</row> -<row> - <entry><literal>refresh</literal></entry> - <entry>Bild neu aufbauen</entry> -</row> -<row> - <entry><literal>grab_key</literal></entry> - <entry>Tastencode ermitteln und einf�gen</entry> -</row> -<row> - <entry><literal>insert</literal></entry> - <entry>f�ge eine Zeichenkette in der Befehlszeile ein</entry> -</row> -<row> - <entry><literal>search_text</literal></entry> - <entry>suche Text im Pufferverlauf</entry> -</row> diff --git a/weechat/doc/de/weechat.de.xml b/weechat/doc/de/weechat.de.xml deleted file mode 100644 index 5bd65ed24..000000000 --- a/weechat/doc/de/weechat.de.xml +++ /dev/null @@ -1,8110 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- - -WeeChat documentation (german version) - -Copyright (c) 2003-2007 by FlashCode <flashcode@flashtux.org> - -This manual 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. - -This manual is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. - ---> - -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" -[ - <!ENTITY date.xml SYSTEM "date.xml"> - <!ENTITY config.xml SYSTEM "config.xml"> - <!ENTITY weechat_commands.xml SYSTEM "weechat_commands.xml"> - <!ENTITY irc_commands.xml SYSTEM "irc_commands.xml"> - <!ENTITY key_functions.xml SYSTEM "key_functions.xml"> -]> - -<book lang="de"> - - <bookinfo> - - <title>WeeChat 0.2.6-cvs - User guide</title> - <subtitle>Schneller, leichter und erweiterbarer IRC Client</subtitle> - - <author> - <firstname>S�bastien</firstname> - <surname>Helleu</surname> - <email>flashcode AT flashtux.org</email> - </author> - - &date.xml; - - <copyright> - <year>2007</year> - <holder>S�bastien Helleu</holder> - </copyright> - - <legalnotice> - <para> - Dieses Programm ist freie Software. Sie k�nnen es unter - den Bedingungen der GNU General Public License, - wie von der Free Software Foundation ver�ffentlicht, - weitergeben und/oder modifizieren, entweder gem�� Version 3 - der Lizenz oder (nach Ihrer Option) jeder sp�teren Version. - </para> - <para> - Die Ver�ffentlichung dieses Programms erfolgt in der - Hoffnung, da� es Ihnen von Nutzen sein wird, aber OHNE - IRGENDEINE GARANTIE, sogar ohne die implizite Garantie der - MARKTREIFE oder der VERWENDBARKEIT F�R EINEN BESTIMMTEN ZWECK. - Details finden Sie in der GNU General Public License. - </para> - <para> - Sie sollten ein Exemplar der GNU General Public License - zusammen mit diesem Programm erhalten haben. Falls nicht, - <http://www.gnu.org/licenses/>. - </para> - </legalnotice> - - <abstract> - <para> - Dieses Dokument beschreibt den WeeChat IRC client, es ist ein Teil von WeeChat. - </para> - <para> - Deutsche version: Frank Zacharias - </para> - <para> - Die aktuellste Version ist auf dieser Seite zu finden: - <ulink url="http://weechat.flashtux.org/doc.php"> - http://weechat.flashtux.org/doc.php - </ulink> - </para> - </abstract> - - </bookinfo> - - <!-- =========================== Introduction =========================== --> - - <chapter id="chapIntroduction"> - <title>Einf�hrung</title> - - <para> - Dieses Kapitel beschreibt WeeChat und die Vorraussetzungen f�r die Installation. - </para> - - <section id="secDescription"> - <title>Beschreibung</title> - - <para> - WeeChat (Wee Enhanced Environment for Chat) ist ein freier - <acronym>IRC</acronym> Client, schnell und klein, entwickelt f�r viele - Betriebssysteme. - </para> - - <para> - Hauptmerkmale: - <itemizedlist> - <listitem> - <para> - Mehrere Server gleichzeitig nutzbar (mit SSL, IPv6, Proxy) - </para> - </listitem> - <listitem> - <para> - viele unterschiedliche User-Interfaces: Curses, wxWidgets, Gtk und Qt - </para> - </listitem> - <listitem> - <para> - klein, schnell and leichtgewichtig - </para> - </listitem> - <listitem> - <para> - �nderbar und erweiterbar mit Plugins und Skripten - </para> - </listitem> - <listitem> - <para> - entsprechend den folgenden <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2810.txt">2810</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2811.txt">2811</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> und - <ulink url="http://www.ietf.org/rfc/rfc2813.txt">2813</ulink> - </para> - </listitem> - <listitem> - <para> - Viele Plattformen (GNU/Linux, *BSD, MacOS X, Windows and other) - </para> - </listitem> - <listitem> - <para> - 100% GPL, freie Software - </para> - </listitem> - </itemizedlist> - </para> - - <para> - WeeChat Homepage: - <ulink url="http://weechat.flashtux.org"> - http://weechat.flashtux.org - </ulink> - </para> - - </section> - - <section id="secPreRequis"> - <title>Vorraussetzungen</title> - - <para> - Um WeeChat zu installieren, werden <emphasis>gebraucht</emphasis>: - <itemizedlist> - <listitem> - <para> - ein laufendes GNU/Linux (Compiler f�r Quellcode-Pakete) - </para> - </listitem> - <listitem> - <para> - root-Rechte f�r die Installation - </para> - </listitem> - <listitem> - <para> - dem User-Interface entsprechend, eine der folgenden Bibliotheken: - <itemizedlist> - <listitem> - <para> - Curses: ncurses Bibliothek - </para> - </listitem> - <listitem> - <para> - Gtk: <emphasis>*** noch nicht implementiert ***</emphasis> - </para> - </listitem> - <listitem> - <para> - WxWidgets: <emphasis>*** noch nicht implementiert ***</emphasis> - </para> - </listitem> - <listitem> - <para> - Qt: <emphasis>*** noch nicht implementiert ***</emphasis> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - </chapter> - - <!-- =========================== Installation =========================== --> - - <chapter id="chapInstallation"> - <title>Installation</title> - - <para> - Dieses Kapitel erkl�rt die Installation von WeeChat. - </para> - - <section id="secBinaryPackages"> - <title>Bin�re Pakete</title> - - <para> - Bin�re Pakete sind f�r die folgenden Distributionen verf�gbar: - <itemizedlist> - <listitem> - <para> - Debian (oder Debian-kompatible): - <userinput>apt-get install weechat</userinput> - </para> - </listitem> - <listitem> - <para> - Mandriva/RedHat (oder jede RPM-kompatible Distribution): - <userinput> - rpm -i /chemin/weechat-x.y.z-1.i386.rpm - </userinput> - </para> - </listitem> - <listitem> - <para> - Gentoo: - <userinput>emerge weechat</userinput> - </para> - </listitem> - </itemizedlist> - F�r andere Distributionen: sehen sie in die Dokumentation - f�r Installationsanweisungen. - </para> - - </section> - - <section id="secSourcePackage"> - <title>Quellcode-Pakete</title> - - <para> - Alles was sie tun m�ssen, ist in einer Konsole oder einem Terminal aufzurufen: -<screen><prompt>$ </prompt><userinput>./configure</userinput> -<prompt>$ </prompt><userinput>make</userinput></screen> - </para> - <para> - Dann root werden und WeeChat installieren: -<screen><prompt>$ </prompt><userinput>su</userinput> -(root-Passwort eingeben) -<prompt># </prompt><userinput>make install</userinput></screen> - </para> - - </section> - - <section id="secCVSSources"> - <title>CVS Quellen</title> - - <para> - Warnung: CVS Quellen sind f�r fortgeschrittene Anwender, das �bersetzen k�nnte - fehlschlagen oder das Ergebnis nicht stabil sein. Sie wurden gewarnt! - </para> - - <para> - Um die CVS Quellen zu bekommen, sind folgende Kommandos n�tig: -<screen><prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@cvs.savannah.nongnu.org:/sources/weechat co weechat</userinput></screen> - </para> - - <para> - Ausf�hren des folgenden Skripts: - <userinput>./autogen.sh</userinput> - </para> - - <para> - Dann folgen sie den Anweisungen zu den Quellpaketen - (siehe <xref linkend="secSourcePackage" />) - </para> - - </section> - - </chapter> - - <!-- ============================== Usage =============================== --> - - <chapter id="chapUsage"> - <title>Nutzung</title> - - <para> - Dieses Kapitel erkl�rt, wie Weechat zu starten ist, die zu verwendenden - Tastenkombinationen, interne und IRC-Kommandos, die Konfigurationsdatei - und die FIFO f�r die remote-Bedienung. - </para> - - <section id="secRunningWeeChat"> - <title>Starten von WeeChat</title> - - <para> - Argumente der Kommandozeile: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Parameter</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>-a, --no-connect</literal></entry> - <entry> - Schaltet das auto-connect ab - </entry> - </row> - <row> - <entry><literal>-c, --config</literal></entry> - <entry> - Zeigt eine Hilfe zu den Konfigurationsm�glichkeiten (Liste der Optionen) - </entry> - </row> - <row> - <entry><literal>-d, --dir <path></literal></entry> - <entry> - Setzt den Pfad f�r das Verzeichnis, dass Weechat benutzen soll - (relevant f�r die Konfigurationsdateien, Logs, Plugins und Skripte). - Der Standardwert "<literal>~/.weechat</literal>". - Bitte beachten Sie: dieses Verzeichnis wird automatisch erzeugt, wenn es noch nicht - exitiert. - </entry> - </row> - <row> - <entry><literal>-f, --key-functions</literal></entry> - <entry> - Zeigt die intern verwendeten Funktionen von WeeChat f�r bestimmte Tastenkombinationen an - </entry> - </row> - <row> - <entry><literal>-h, --help</literal></entry> - <entry> - Zeigt eine zusammenfassende Hilfe an. - </entry> - </row> - <row> - <entry><literal>-i, --irc-commands</literal></entry> - <entry> - Zeigt die IRC-Kommandos an - </entry> - </row> - <row> - <entry><literal>-k, --keys</literal></entry> - <entry> - Zeigt die Standard-Tastenkombinationen an - </entry> - </row> - <row> - <entry><literal>-l, --license</literal></entry> - <entry> - Zeigt die Lizenz an - </entry> - </row> - <row> - <entry><literal>-p, --no-plugin</literal></entry> - <entry> - Schaltet das automatische Laden der Plugins ab - </entry> - </row> - <row> - <entry><literal>-v, --version</literal></entry> - <entry> - Zeigt die Programmversion an - </entry> - </row> - <row> - <entry><literal>-w, --weechat-commands</literal></entry> - <entry> - Zeigt die Weechat-eigenen Kommandos an - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Es ist auch m�glich URLs f�r einen oder mehrere IRC-Server anzugeben, so wie: - <screen>irc[6][s]://[nick[:passwort]@]irc.example.org[:port][/channel][,channel[...]</screen> - Beispiel um die Channels #weechat and #toto zu betreten - "<literal>irc.freenode.net</literal>" server, default port (6667), - mit dem Nicknamen "nono": - <screen><prompt>$ </prompt><userinput>weechat-curses irc://nono@irc.freenode.net/#weechat,#toto</userinput></screen> - </para> - - <para> - Um WeeChat zu starten, ist eins der folgenden Kommandos abzusetzen: - <itemizedlist> - <listitem> - <para> - f�r Curses GUI: <userinput>weechat-curses</userinput> - </para> - </listitem> - <listitem> - <para> - f�r Gtk GUI: <userinput>weechat-gtk</userinput> - </para> - </listitem> - <listitem> - <para> - f�r wxWidgets GUI: <userinput>weechat-wxwidgets</userinput> - </para> - </listitem> - <listitem> - <para> - f�r Qt GUI: <userinput>weechat-qt</userinput> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Wenn Sie Weechat zum ersten Mal starten, wird eine Konfigurationsdatei - erzeugt, deren Optionen besitzen Standardwerte. Diese Datei ist: - "<literal>~/.weechat/weechat.rc</literal>" - </para> - - <para> - Sie k�nnen diese Datei entsprechend ihren Bed�rfnissen editieren, - um Weechat anzupassen (NUR wenn Weechat nicht l�uft) oder Parameter - zu beeinflussen mit - "<literal>/set</literal>" Kommando in WeeChat - (siehe <xref linkend="secWeeChatCommands" />) - </para> - - </section> - - <section id="secKeyboardShortcuts"> - <title>Tastenkombinationen</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Tastenkombination</entry> - <entry>Wirkung</entry> - </row> - </thead> - <tbody> - <row> - <entry>Links / Strg + B</entry> - <entry> - Gehe zum vorherigen Zeichen in der Kommandozeile - </entry> - </row> - <row> - <entry>Rechts / Strg + F</entry> - <entry> - Gehe zum n�chsten Zeichen in der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + Links</entry> - <entry> - Gehe zum vorherigen Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + Rechts</entry> - <entry> - Gehe zum n�chsten Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Pos1 / Strg + A</entry> - <entry> - Gehe zum Anfang der Kommandozeile - </entry> - </row> - <!-- TRANSLATION NEEDED --> - <row> - <entry>Strg + C dann B</entry> - <entry> - Insert code for bold text. - </entry> - </row> - <row> - <entry>Strg + C dann C</entry> - <entry> - Insert code for colored text. - </entry> - </row> - <row> - <entry>Strg + C dann O</entry> - <entry> - Insert code for color reset. - </entry> - </row> - <row> - <entry>Strg + C dann R</entry> - <entry> - Insert code for reverse color. - </entry> - </row> - <row> - <entry>Strg + C dann U</entry> - <entry> - Insert code for underlined text. - </entry> - </row> - <row> - <entry>Ende / Strg + E</entry> - <entry> - Gehe zum Ende der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + K</entry> - <entry> - L�sche vom Cursor bis zum Ende der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + L</entry> - <entry> - Fenster neu aufbauen - </entry> - </row> - <row> - <entry>Strg + R</entry> - <entry> - Suche nach Text im Pufferverlauf - (zwei Mal: suche nach dem genauen Text) - </entry> - </row> - <row> - <entry>Strg + S dann Strg + U</entry> - <entry> - <!-- TRANSLATION NEEDED --> - Set unread marker on all buffers - </entry> - </row> - <row> - <entry>Strg + T</entry> - <entry> - Zeichen transponieren - </entry> - </row> - <row> - <entry>Strg + U</entry> - <entry> - L�sche vom Cursor bis zum Aanfang der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + W</entry> - <entry> - L�sche das vorhergehende Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Strg + Y</entry> - <entry> - Inhalt der Zwischenablage einf�gen - </entry> - </row> - <row> - <entry>R�ckschritt / Strg + H</entry> - <entry> - L�sche das vorhergehende Zeichen in der Kommandozeile - </entry> - </row> - <row> - <entry>Entfernen / Strg + D</entry> - <entry> - L�sche das n�chste Zeichen in der Kommandozeile - </entry> - </row> - <row> - <entry>Tabulator / Shift + Tabulator</entry> - <entry> - Vervollst�ndige ein Kommando oder Nick - (wiederhole: finde n�chste Vervollst�ndigung) - </entry> - </row> - <row> - <entry>Jedes Zeichen</entry> - <entry> - Setze das Zeichen beim Cursor in die Kommandozeile ein - </entry> - </row> - <row> - <entry>Eingabe / Strg + J / Strg + M</entry> - <entry> - F�hre ein Kommando aus oder sende eine Nachricht - (im Suchmodus: Suche anhalten) - </entry> - </row> - <row> - <entry>Hoch / Runter</entry> - <entry> - Rufe das letzte Kommando/die letzte Nachricht wieder auf - (im Suchmodus: suche r�ckw�rts/vorw�rts) - </entry> - </row> - <row> - <entry>Strg + Hoch / Strg + Runter</entry> - <entry> - Rufe das letzte Kommando/die letzte Nachricht des globalen Buffers - wieder auf (f�r alle Buffer) - </entry> - </row> - <row> - <entry>Seite hoch / Seite runter</entry> - <entry> - Eine Seite hoch / runter im Verlauf des Buffers - </entry> - </row> - <row> - <entry>Alt + Seite hoch / Alt + Seite runter</entry> - <entry> - Ein paar Zeilen hoch / runter im Verlauf des Buffers - </entry> - </row> - <row> - <entry>Alt + Pos1 / Alt + Ende</entry> - <entry> - Gehe zum Anfang / Ende des Puffers - </entry> - </row> - <row> - <entry>F5 / Alt + Links</entry> - <entry> - Gehe zum vorherigen Puffer - </entry> - </row> - <row> - <entry>F6 / Alt + Rechts</entry> - <entry> - Gehe zum n�chsten Puffer - </entry> - </row> - <row> - <entry>F7</entry> - <entry> - Schalte in das vorherige Fenster - </entry> - </row> - <row> - <entry>F8</entry> - <entry> - Schalte in das n�chste Fenster - </entry> - </row> - <row> - <entry>F9 / F10</entry> - <entry> - Bl�ttere in der Topic - </entry> - </row> - <row> - <entry>F11 / F12</entry> - <entry> - Bl�ttere in der Nicklist - </entry> - </row> - <row> - <entry>Alt + F11 / Alt + F12</entry> - <entry> - Gehe zum Anfang / Ende der Nicklist - </entry> - </row> - <row> - <entry>Alt + A</entry> - <entry> - Schalte in den n�chsten Puffer mit Aktivit�t - (mit der Priorit�t: highlight, message, other) - </entry> - </row> - <row> - <entry>Alt + B</entry> - <entry> - Gehe zum vorherigen Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Alt + D</entry> - <entry> - L�sche das n�chste Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Alt + F</entry> - <entry> - Gehe zum n�chsten Wort in der Kommandozeile - </entry> - </row> - <row> - <entry>Alt + H</entry> - <entry> - L�sche den Inhalt der Hotlist - (Aktivit�tsanzeige f�r andere Puffer) - </entry> - </row> - <row> - <entry>Alt + I</entry> - <entry> - Entferne den letzten Hinweis in der Infobar - </entry> - </row> - <row> - <entry>Alt + J dann Alt + D</entry> - <entry> - Zeige den DCC-Puffer - </entry> - </row> - <row> - <entry>Alt + J dann Alt + L</entry> - <entry> - Schalte zum letzten Puffer - </entry> - </row> - <row> - <entry>Alt + J then Alt + P</entry> - <entry> - <!-- TRANSLATION NEEDED --> - Switch to buffer previously displayed - </entry> - </row> - <row> - <entry>Alt + J dann Alt + R</entry> - <entry> - Schalte in den reinen IRC-Daten Puffer - </entry> - </row> - <row> - <entry>Alt + J dann Alt + S</entry> - <entry> - Schalte in den Server-Puffer - </entry> - </row> - <row> - <entry>Alt + J dann Alt + X</entry> - <entry> - Schalte in den ersten Channel des n�chsten Servers - (oder in den Server-Puffer wenn keine Channel offen ist) - </entry> - </row> - <row> - <entry>Alt + Zahl (0-9)</entry> - <entry> - Schalte in den Puffer mit der Nummer (0 = 10) - </entry> - </row> - <row> - <entry>Alt + J dann eine Zahl (01-99)</entry> - <entry> - Schalte in den Puffer mit der Nummer - </entry> - </row> - <row> - <entry>Alt + K</entry> - <entry> - Setze den Keycode der n�chsten Taste in der Kommandozeile - ein - </entry> - </row> - <row> - <entry>Alt + N</entry> - <entry> - Bl�ttere zum n�chsten Highlight - </entry> - </row> - <row> - <entry>Alt + P</entry> - <entry> - Bl�ttere zum vorigen Highlight - </entry> - </row> - <row> - <entry>Alt + R</entry> - <entry> - L�sche die komplette Kommandozeile - </entry> - </row> - <row> - <entry>Alt + S</entry> - <entry> - Schalte zwischen den Servern im Server-Puffer hin und her - (wenn "look_one_server_buffer" angeschaltet ist) - </entry> - </row> - <row> - <entry>Alt + U</entry> - <entry> - Bl�ttere zur ersten ungelesenen Zeile im Puffer - </entry> - </row> - <row> - <entry>Alt + W dann Alt + Pfeil</entry> - <entry> - Schalte zum Fenster in der entsprechenden Richtung - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secCommandLine"> - <title>Kommandozeile</title> - - <para> - Die WeeChat Kommandozeile (am Ende des Fensters) l�sst sie Nachrichten an einen - Channel senden oder WeeChat- bzw. IRC-Kommandos ausf�hren - (siehe <xref linkend="secWeeChatIRCCommands" />). - </para> - - <para> - Kommandos beginnen mit einem "/", gefolgt vom Namen des Kommandos. - Um zum Beispiel einen privaten Chat mit "<literal>toto</literal>" zu beginnen: - <screen><userinput>/query toto</userinput></screen> - </para> - - <para> - Nachrichten an einen Channel sind jeder Text, der nicht mit einem "/" begint. - Um zum Beispiel den Text "<literal>hello</literal>" an den gegenw�rtigen Channel - zu senden: - <screen><userinput>hello</userinput></screen> - </para> - - <para> - Dennoch ist es m�glich, eine Nachricht auch mit einem "/" zu beginnen, einfach - ein weiteres "/" voranstellen. Um zum Beispiel den Text "<literal>/query toto</literal>" - an den gegenw�rtigen Channel zu senden: - <screen><userinput>//query toto</userinput></screen> - </para> - - <para> - Wenn die Option IRC-Farben ("<literal>irc_colors_send</literal>") senden - angeschaltet ist, k�nnen sie Farbcodierung und Attribute wiefolgt verwenden - <!-- TRANSLATION NEEDED --> - (press Ctrl-C then following letter, with optional value): - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>^Cb</entry> - <entry> - Fett (bold) - </entry> - </row> - <row> - <entry>^Ccxx</entry> - <entry> - Textfarbe "<literal>xx</literal>" (color) - (siehe Farbtabelle) - </entry> - </row> - <row> - <entry>^Ccxx,yy</entry> - <entry> - Textfarbe "<literal>xx</literal>" - und Hintergrund "<literal>yy</literal>" - (siehe Farbtabelle) - </entry> - </row> - <row> - <entry>^Co</entry> - <entry> - Schalte Farben und Attribute ab - </entry> - </row> - <row> - <entry>^Cr</entry> - <entry> - umgedrehte Farben (tausche Textfarbe mit Hintergrundfarbe) - </entry> - </row> - <row> - <entry>^Cu</entry> - <entry> - Unterstreiche Text - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - Hinweis: Der gleiche Farbcode (ohne die Nummer) kann zum Ausschalten - des Attributes verwendet werden. - </para> - - <para> - Farbcodes f�r ^Cc: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Farbe</entry> - </row> - </thead> - <tbody> - <row> - <entry>00</entry> - <entry>weiss</entry> - </row> - <row> - <entry>01</entry> - <entry>schwarz</entry> - </row> - <row> - <entry>02</entry> - <entry>dunkles Blau</entry> - </row> - <row> - <entry>03</entry> - <entry>dunkles Gr�n</entry> - </row> - <row> - <entry>04</entry> - <entry>helles Rot</entry> - </row> - <row> - <entry>05</entry> - <entry>dunkles Rot</entry> - </row> - <row> - <entry>06</entry> - <entry>Magenta</entry> - </row> - <row> - <entry>07</entry> - <entry>Orange</entry> - </row> - <row> - <entry>08</entry> - <entry>Gelb</entry> - </row> - <row> - <entry>09</entry> - <entry>helles Gr�n</entry> - </row> - <row> - <entry>10</entry> - <entry>Cyan</entry> - </row> - <row> - <entry>11</entry> - <entry>helles Cyan</entry> - </row> - <row> - <entry>12</entry> - <entry>helles Blau</entry> - </row> - <row> - <entry>13</entry> - <entry>helles Magenta</entry> - </row> - <row> - <entry>14</entry> - <entry>Grau</entry> - </row> - <row> - <entry>15</entry> - <entry>helles Grau (Weiss)</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Beispiel: Anzeige von "<literal>hello everybody!</literal>" mit - "<literal>hello</literal>" fett in hellem Blau, und - "<literal>everybody</literal>" unterstrichen in hellem Rot: -<screen><userinput>^Cc12^Cbhello^Cb^Cc04^Cu everybody^Cu^Cc!</userinput></screen> - </para> - - </section> - - <section id="secWeeChatIRCCommands"> - <title>WeeChat / IRC Kommandos</title> - - <para> - Dieses Kapitel listet alle WeeChat- und IRC-Kommandos auf. - </para> - - <section id="secWeeChatCommands"> - <title>WeeChat Kommandos</title> - - <para> - &weechat_commands.xml; - </para> - - </section> - - <section id="secKeyFunctions"> - <title>Funktionen</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Funktion</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - - &key_functions.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secIRCCommands"> - <title>IRC Kommandos</title> - - <para> - &irc_commands.xml; - </para> - - </section> - - </section> - - <section id="secConfigurationFile"> - <title>Konfigurationsdatei</title> - - <para> - Liste der Optionen f�r die Konfigurationsdatei: - <informaltable colsep="0" frame="none"> - <tgroup cols="5"> - <thead> - <row> - <entry>Option</entry> - <entry>Typ</entry> - <entry>Wert</entry> - <entry>Default</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - - &config.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Farben f�r die Curses GUI: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Schl�sselwort</entry> - <entry>Farbe</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>default</literal></entry> - <entry>default Farbe (Transparent f�r den Hintergrund)</entry> - </row> - <row> - <entry><literal>black</literal></entry> - <entry>Schwarz</entry> - </row> - <row> - <entry><literal>red</literal></entry> - <entry>dunkles Rot</entry> - </row> - <row> - <entry><literal>lightred</literal></entry> - <entry>helles Rot</entry> - </row> - <row> - <entry><literal>green</literal></entry> - <entry>dunkles Gr�n</entry> - </row> - <row> - <entry><literal>lightgreen</literal></entry> - <entry>helles Gr�n</entry> - </row> - <row> - <entry><literal>brown</literal></entry> - <entry>Braun</entry> - </row> - <row> - <entry><literal>yellow</literal></entry> - <entry>Gelb</entry> - </row> - <row> - <entry><literal>blue</literal></entry> - <entry>dunkles Blau</entry> - </row> - <row> - <entry><literal>lightblue</literal></entry> - <entry>helles Blau</entry> - </row> - <row> - <entry><literal>magenta</literal></entry> - <entry>dunkles Magenta</entry> - </row> - <row> - <entry><literal>lightmagenta</literal></entry> - <entry>helles Magenta</entry> - </row> - <row> - <entry><literal>cyan</literal></entry> - <entry>dunkles Cyan</entry> - </row> - <row> - <entry><literal>lightcyan</literal></entry> - <entry>helles Cyan</entry> - </row> - <row> - <entry><literal>white</literal></entry> - <entry>Weiss</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secFIFOpipe"> - <title>Remote-Schnittstelle (FIFO pipe)</title> - - <para> - Sie k�nnen WeeChat auch extern steuern, indem sie Kommandos oder Text - an eine sogen. pipe �bergeben (sie m�ssen die Option "irc_fifo_pipe" - anschalten, die normalerweise abgeschaltet ist). - </para> - - <para> - Diese pipe liegt in "<literal>~/.weechat/</literal>" und hat den Namen - "weechat_fifo_xxxxx" (das xxxxx ist die Prozess-ID (PID) eines laufenden WeeChat). - Wenn mehrere Instanzen von WeeChat laufen, sind mehrere pipes vorhanden, eine - f�r jede Instanz. - </para> - - <para> - Der Syntax f�r ein pipe-Kommando ist: - <screen>server,channel *Text oder Kommando</screen> - wobei Server und Channel optional sind, aber wenn der Channel angegeben ist, - muss der Server auch angegeben werden. - </para> - - <para> - Einige Beispiele: - <itemizedlist> - <listitem> - <para> - �ndern des Nicks auf freenode in "mynick|out" : - <screen><prompt>$ </prompt><userinput>echo 'freenode */nick mynick|out' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - Senden einer Nachricht an #weechat: - <screen><prompt>$ </prompt><userinput>echo 'freenode,#weechat *hello everybody!' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - Senden einer Nachricht an den gegenw�rtigen Channel (Puffer, der in WeeChat angezeigt wird): - <screen><prompt>$ </prompt><userinput>echo '*hello!' >~/.weechat/weechat_fifo_12345</userinput></screen> - <emphasis>Warnung:</emphasis> Das ist gef�hrlich und sie sollten das nicht tun, ausgenommen sie wissen was sie tun! - </para> - </listitem> - <listitem> - <para> - Sende zwei Kommandos um (alle) Perl-Skripte abzuschalten/neu zu laden (getrennt durch ein "\n"): - <screen><prompt>$ </prompt><userinput>echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Sie k�nnen ein Skript schreiben, um ein Kommando an alle laufenden WeeChat-Instanzen zu senden, - zum Beispiel: -<screen> -#!/bin/sh -if [ $# -eq 1 ]; then - for fifo in ~/.weechat/weechat_fifo_* - do - echo -e "$1" >$fifo - done -fi -</screen> - Wenn das Skript "auto_weechat_command" heisst, k�nnen sie es folgendermassen aufrufen: - <screen><prompt>$ </prompt><userinput>./auto_weechat_command "freenode,#weechat *hello"</userinput></screen> - </para> - - </section> - - </chapter> - - <!-- ============================ Extensions ============================ --> - - <chapter id="chapPlugins"> - <title>Plugins</title> - - <para> - Dieses Kapitel beschreibt das Plugin-Interface (API) in WeeChat und die - Standard-Skriptplugins (Perl, Python, Ruby, Lua), die zu WeeChat geh�ren. - </para> - - <section id="secPluginsInWeeChat"> - <title>Plugins in WeeChat</title> - - <para> - Ein Plugin ist ein C-Programm, dass WeeChat-Funktionen aufrufen kann, - die in einem Interface definiert sind. - </para> - - <para> - Dieses C-Programm braucht nicht den Quellcode von WeeChat (aber die - API-Beschreibung) und kann dynamisch mit dem folgenden Kommando in - WeeChat geladen werden - <command>/plugin</command>. - </para> - - <para> - Das Plugin muss in Form einer dynamischen Bibliothek vorliegen, - damit es das Betriebssystem dynamisch laden kann. - Unter GNU/Linux besitzt die Datei die Endung ".so", unter - Windows ".dll". - </para> - - </section> - - <section id="secWriteAPlugin"> - <title>Ein Plugin schreiben</title> - - <para> - Das Plugin muss die Datei "weechat-plugin.h" einbinden (verf�gbar - im WeeChat-Quellcode). - Diese Datei definiert die Strukturen und Typen um mit WeeChat - zu kommunizieren. - </para> - - <para> - Das Plugin muss einige Variablen und Funktionen besitzen - (n�tig, sonst kann das Plugin nicht geladen werden): - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>char plugin_name[]</literal></entry> - <entry>Plugin Name</entry> - </row> - <row> - <entry><literal>char plugin_version[]</literal></entry> - <entry>Plugin Version</entry> - </row> - <row> - <entry><literal>char plugin_description[]</literal></entry> - <entry>kurze Beschreibung des Plugins</entry> - </row> - </tbody> - </tgroup> - </informaltable> - - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Funktion</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>int weechat_plugin_init (t_weechat_plugin *plugin)</literal></entry> - <entry> - Die Funktion wird aufgerufen, wenn das Plugin geladen wird. - Sie muss bei Erfolg PLUGIN_RC_OK, bei Fehlschlag PLUGIN_RC_KO - zur�ckgeben. (Bei einem Fehler wird das Plugin nicht geladen) - </entry> - </row> - <row> - <entry><literal>void weechat_plugin_end (t_weechat_plugin *plugin)</literal></entry> - <entry>Funktion wird beim Abschalten aufgerufen</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <section id="secAPIFunctions"> - <title>API Funktionen</title> - - <section id="secAPI_set_charset"> - <title>set_charset</title> - - <para> - Prototyp: - <command> - void set_charset (t_weechat_plugin *plugin, char *charset) - </command> - </para> - <para> - Legt neuen Zeichensatz f�r ein Plugin fest. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: neuer Zeichensatz, der benutzt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: - <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> - </para> - </section> - - <section id="secAPI_iconv_to_internal"> - <title>iconv_to_internal</title> - - <para> - Prototyp: - <command> - void iconv_to_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Konvertiert eine Zeichenkette in das interne Format von WeeChat (UTF-8). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: urspr�nglicher Zeichensatz, von dem konvertiert werden soll - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu konvertierende Zeichenkette - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: konvertierte Zeichenkette - </para> - <para> - Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss mit free() wieder freigegeben werden. - </para> - <para> - Beispiel: - <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "iso string: � �");</screen> - </para> - </section> - - <section id="secAPI_iconv_from_internal"> - <title>iconv_from_internal</title> - - <para> - Prototyp: - <command> - void iconv_from_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Konvertiert eine Zeichenkette von dem internen WeeChat-Zeichensatz (UTF-8) in einen anderen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: Ziel-Zeichensatz - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu konvertierende Zeichenkette - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: konvertierte Zeichenkette - </para> - <para> - Anmerkung: der Speicher, der durch das Ergebnis belegt wird, muss mit free() wieder freigegeben werden. - </para> - <para> - Beispiel: - <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "utf-8 string: � �");</screen> - </para> - </section> - - <section id="secAPI_ascii_strcasecmp"> - <title>ascii_strcasecmp</title> - - <para> - Prototyp: - <command> - int ascii_strcasecmp (t_weechat_plugin *plugin, - char *string1, char *string2) - </command> - </para> - <para> - Vergleich von Zeichenketten unabh�ngig von Sprache und Schreibweise (gross/klein). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: erste Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: zweite Zeichenkette des Vergleichs - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner Null wenn - string1 < string2, Null wenn string1 == string2, gr�sser Null wenn string1 > string2 - </para> - <para> - Beispiel: - <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> - </para> - </section> - - <section id="secAPI_ascii_strncasecmp"> - <title>ascii_strncasecmp</title> - - <para> - Prototyp: - <command> - int ascii_strncasecmp (t_weechat_plugin *plugin, - char *string1, char *string2, int max) - </command> - </para> - <para> - Vergleich von Zeichenketten unabh�ngig von Sprache und Schreibweise (gross/klein) f�r h�chstens "max" Zeichen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: erste Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: zweite Zeichenkette des Vergleichs - </para> - </listitem> - <listitem> - <para> - <option>max</option>: maximale Zahl an Zeichen f�r den Vergleich - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Unterschied zwischen den zwei Zeichenketten: kleiner Null wenn - string1 < string2, Null wenn string1 == string2, gr�sser Null wenn string1 > string2 - </para> - <para> - Beispiel: - <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> - </para> - </section> - - <section id="secAPI_explode_string"> - <title>explode_string</title> - - <para> - Prototyp: - <command> - char **explode_string (t_weechat_plugin *plugin, char *string, - char *separators, int num_items_max, int *num_items) - </command> - </para> - <para> - Zerlege eine Zeichenkette entsprechend eines oder mehrerer Trennzeichen(s). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string</option>: zu zerlegende Zeichenkette - </para> - </listitem> - <listitem> - <para> - <option>separators</option>: zu verwendende(s) Trennzeichen - </para> - </listitem> - <listitem> - <para> - <option>num_items_max</option>: maximale Anzahl an zu erzeugenden Teilen (0 = keine Grenze) - </para> - </listitem> - <listitem> - <para> - <option>num_items</option>: Zeiger auf eine int-Variable, die die Anzahl der erzeugten - Teile enth�lt - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: ein Array von Zeichenketten, NULL bei Fehlern. - </para> - <para> - Hinweis: Das zur�ckgegebene Array muss nach der Benutzung mittels - "free_exloded_string" explizit freigegeben werden. - </para> - <para> - Beispiel: -<screen> -char **argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_free_exploded_string"> - <title>free_exploded_string</title> - - <para> - Prototyp: - <command> - char **free_exploded_string (t_weechat_plugin *plugin, - char **string) - </command> - </para> - <para> - Gib ein Array frei, dass infolge der Zerlegung eines Strings reserviert wurde. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>string</option>: ein Array von Strings - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner (?). - </para> - <para> - Beispiel: -<screen> -char *argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_mkdir_home"> - <title>mkdir_home</title> - - <para> - Prototyp: - <command> - int mkdir_home (t_weechat_plugin *plugin, char *directory) - </command> - </para> - <para> - Erzeugt ein Verzeichnis im WeeChat-Verzeichnis. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstrukur - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: Verzeichnis, das erzeugt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn das Verzeichnis erfolgreich erstellt wurde, 0 wenn ein - Fehler aufgetreten ist. - </para> - <para> - Beispiel: -<screen> -if (!plugin->mkdir_home (plugin, "temp")) - plugin->print_server(plugin, "Konnte 'temp'-Verzeichnis im WeeChat-Verzeichnis nicht erstellen."); -</screen> - </para> - </section> - - <section id="secAPI_exec_on_files"> - <title>exec_on_files</title> - - <para> - Prototyp: - <command> - void exec_on_files (t_weechat_plugin *plugin, char *repertoire, - int (*callback)(t_weechat_plugin *, char *)) - </command> - </para> - <para> - F�hre eine Funktion auf allen Dateien eines Verzeichnisses aus. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: Verzeichnis der zu verwendenden Dateien - </para> - </listitem> - <listitem> - <para> - <option>callback</option>: die anzuwendende Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: -<screen> -int callback (t_weechat_plugin *plugin, char *file) -{ - plugin->print_server (plugin, "file: %s", file); - return 1; -} -... -plugin->exec_on_files (plugin, "/tmp", &callback); -</screen> - </para> - </section> - - <section id="secAPI_print"> - <title>print</title> - - <para> - Prototyp: - <command> - void print (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Sende eine Nachricht an einen WeeChat-Puffer, bezeichnet durch server - und channel (beide k�nnen NULL sein, dann wird der aktuelle Puffer verwendet). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu welchem der Puffer geh�rt, in dem die Nachricht - angezeigt werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, in dem die Nachricht angezeigt werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <!-- TRANSLATION NEEDED --> - <para> - To display colored text, there are following codes: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>0x02</entry> - <entry> - bold text - </entry> - </row> - <row> - <entry>0x03 + "xx"</entry> - <entry> - text color "<literal>xx</literal>" - (see <xref linkend="secAPI_get_irc_color" /> for colors) - </entry> - </row> - <row> - <entry>0x03 + "xx,yy"</entry> - <entry> - text color "<literal>xx</literal>" - and background "<literal>yy</literal>" - (see <xref linkend="secAPI_get_irc_color" /> for colors) - </entry> - </row> - <row> - <entry>0x0F</entry> - <entry> - disable color and attributes - </entry> - </row> - <row> - <entry>0x12</entry> - <entry> - reverse video (revert text color with background) - </entry> - </row> - <row> - <entry>0x1F</entry> - <entry> - underlined text - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - Note: the same code (without number for 0x03) may be used to stop - the attribute. - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiele: -<screen> -plugin->print (plugin, NULL, NULL, "hello"); -plugin->print (plugin, NULL, "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, NULL, NULL, - "Test: \x02 Fett \x0F\x03%02d Blau \x03%02d Gr�n", - plugin->get_irc_color (plugin, "blue"), - plugin->get_irc_color (plugin, "green")); -</screen> - </para> - </section> - - <section id="secAPI_print_server"> - <title>print_server</title> - - <para> - Prototyp: - <command> - void print_server (t_weechat_plugin *plugin, - char *message, ...) - </command> - </para> - <para> - Zeige eine Nachricht im aktuellen Server-Puffer. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <para> - <!-- TRANSLATION NEEDED --> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: <screen>plugin->print_server (plugin, "hello");</screen> - </para> - </section> - - <section id="secAPI_print_infobar"> - <title>print_infobar</title> - - <para> - Prototyp: - <command> - void print_infobar (t_weechat_plugin *plugin, - int time, char *message, ...) - </command> - </para> - <para> - Zeige eine Nachricht in der Infobar f�r eine bestimmte Zeit - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>time</option>: Zeitspanne f�r die Anzeige (in Sekunden, 0 = st�ndige Anzeige) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: -<screen> -plugin->print_infobar (plugin, 5, "hello"); -</screen> - </para> - </section> - - <section id="secAPI_infobar_remove"> - <title>infobar_remove</title> - - <para> - Prototyp: - <command> - void infobar_remove (t_weechat_plugin *plugin, int count) - </command> - </para> - <para> - Entferne eine oder mehr Nachrichten aus der Infobar. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>count</option>: Anzahl der Nachrichten (wenn das Argument kleiner als Null ist, werden alle Nachrichten entfernt) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: <screen>plugin->infobar_remove (1);</screen> - </para> - </section> - - <section id="secAPI_log"> - <title>log</title> - - <para> - Prototyp: - <command> - void log (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Schreibe eine Nachricht in die Log-Datei (f�r den entsprechenden Server/Channel). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu welchem der Log-Puffer geh�rt (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, zu welchem der Log-Puffer geh�rt (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: -<screen> -plugin->log (plugin, "freenode", "#weechat", "test"); -</screen> - </para> - </section> - - <section id="secAPI_msg_handler_add"> - <title>msg_handler_add</title> - - <para> - Prototyp: - <command> - t_plugin_handler *msg_handler_add (t_weechat_plugin - *plugin, char *message, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Erzeuge einen IRC-Message-Handler, der aufgerufen wird, wenn - eine Nachricht empfangen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Name (Typ) der IRC-Nachricht ("*" f�r alle - Nachrichten). - Eine Liste der bekannten IRC-Nachrichten ist in den - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> und - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> zu finden. - Weiterhin k�nnen sie einen speziellen Namen verwenden, der mit "weechat_" beginnt, - um spezielle Ereignisse zu bearbeiten, wie in der folgenden Tabelle aufgef�hrt: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>weechat_pv</literal></entry> - <entry>private Nachricht empfangen</entry> - </row> - <row> - <entry><literal>weechat_highlight</literal></entry> - <entry> - hervorgehobene Nachricht (in einem Channel oder privatem Chat) - </entry> - </row> - <row> - <entry><literal>weechat_ctcp</literal></entry> - <entry> - CTCP-Nachricht empfangen (VERSION, PING, ...) - </entry> - </row> - <row> - <entry><literal>weechat_dcc</literal></entry> - <entry> - DCC-Nachricht empfangen (Chat oder Datei) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird, wenn eine Nachricht empfangen wurde - </para> - <para> - Sie verwendet den folgenden Prototyp: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc ist auf 3 gesetzt, die folgenden Werte sind im argv-Array: - <itemizedlist> - <listitem> - <para>argv[0] = Server Name</para> - </listitem> - <listitem> - <para>argv[1] = IRC Nachricht</para> - </listitem> - <listitem> - <para>argv[2] = Kommando Argumente</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die beim Aufruf an die Funktion �bergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function when called - <option>handler_pointer</option>: Zeiger, der an die Funktion �bergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Zeiger auf den neuen Handler - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht empfangen wurde, - muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: Die Nachricht wird nicht an WeeChat �bergeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: Die Nachricht wird nicht an andere Plugins weitergegeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: Die Nachricht wird weder an WeeChat noch an andere - Plugins weitergegeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: Funktion - erfolgreich vervollst�ndigt und eine Hervorhebung bei den - empfangenen Nachrichten eingebaut - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<screen> -int msg_kick (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, "KICK received"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *msg_handler; -msg_handler = plugin->msg_handler_add (plugin, "KICK", - &msg_kick, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_cmd_handler_add"> - <title>cmd_handler_add</title> - - <para> - Prototyp: - <command> - t_plugin_handler *cmd_handler_add (t_weechat_plugin - *plugin, char *command, char *description, char *arguments, - char *arguments_description, char *completion_template, - t_plugin_handler_func *fonction, char *handler_args, - void *handler_pointer) - </command> - </para> - <para> - Erzeugt einen Handler f�r ein WeeChat-Kommando, der aufgerufen wird, wenn - der Anwender das Kommando ausf�hrt (Beispiel: /command). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>command</option>: Name des neuen Kommandos, der auch Name eines bereits existierenden Kommandos - sein kann (mit Bedacht zu verwenden, das ersetzte Kommando ist nicht verf�gbar, bis das Plugin entfernt - wurde) - </para> - </listitem> - <listitem> - <para> - <option>description</option>: kurze Beschreibung des Kommandos (angezeigt beim Ausf�hren von /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments</option>: kurze Beschreibung der Argumente des Kommandos (angezeigt beim Ausf�hren von /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option>: lange Beschreibung der Argumente des Kommandos (angezeigt beim Ausf�hren von /help command) - </para> - </listitem> - <listitem> - <para> - <option>completion_template</option>: Vorlage f�r die Vervollst�ndigung; zum Beispiel - bedeutet "<literal>abc|%w def|%i</literal>", dass das erste Argument "abc" oder ein - WeeChat-Kommando sein kann und das zweite Argument "def" oder ein IRC-Kommando. - Eine leere Zeichenkette bedeutet, dass WeeChat f�r jedes Argument einen Nicknamen - des gegenw�rtigen Channels einsetzt, ein NULL oder "-" schaltet die Vervollst�ndigung - f�r alle Argumente ab. - </para> - <para> - Die folgenden Ersetzungen k�nnen verwendet werden: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>%-</literal></entry> - <entry>keine Vervollst�ndigung f�r das Argument</entry> - </row> - <row> - <entry><literal>%*</literal></entry> - <entry> - <!-- TRANSLATION NEEDED --> - repeat last completion for all following arguments - (this code has to be at the end of completion - template, preceded by "|") - </entry> - </row> - <row> - <entry><literal>%a</literal></entry> - <entry>Alias</entry> - </row> - <row> - <entry><literal>%A</literal></entry> - <entry> - Aliase und Kommandos (WeeChat, IRC und Plugins) - </entry> - </row> - <row> - <entry><literal>%c</literal></entry> - <entry>gegenw�rtiger Channel</entry> - </row> - <row> - <entry><literal>%C</literal></entry> - <entry>alle channels (inklusive Queries)</entry> - </row> - <row> - <entry><literal>%f</literal></entry> - <entry>Dateiname</entry> - </row> - <row> - <entry><literal>%h</literal></entry> - <entry>Plugin Kommandos</entry> - </row> - <row> - <entry><literal>%i</literal></entry> - <entry>IRC Kommandos (senden)</entry> - </row> - <row> - <entry><literal>%I</literal></entry> - <entry>IRC Kommandos (empfangen)</entry> - </row> - <row> - <entry><literal>%k</literal></entry> - <entry>Grundfunktionen</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>Nicknamen des gegenw�rtigen Servers</entry> - </row> - <row> - <entry><literal>%M</literal></entry> - <entry> - Nicks auf dem gegenw�rtigen Server (in allen offenen Channeln) - </entry> - </row> - <row> - <entry><literal>%n</literal></entry> - <entry>Nicknamen des gegenw�rtigen Channels</entry> - </row> - <row> - <entry><literal>%N</literal></entry> - <entry>Nicknamen und Hostnamen des gegenw�rtigen Channels</entry> - </row> - <row> - <entry><literal>%o</literal></entry> - <entry>Konfigurationseinstellungen</entry> - </row> - <row> - <entry><literal>%O</literal></entry> - <entry>Plugin Optionen</entry> - </row> - <row> - <entry><literal>%p</literal></entry> - <entry>Standard "part" Nachricht</entry> - </row> - <row> - <entry><literal>%q</literal></entry> - <entry>Standard "quit" Nachricht</entry> - </row> - <row> - <entry><literal>%s</literal></entry> - <entry>Name des gegenw�rtigen Servers</entry> - </row> - <row> - <entry><literal>%S</literal></entry> - <entry>Namen aller definierten Server</entry> - </row> - <row> - <entry><literal>%t</literal></entry> - <entry>Topic des gegenw�rtigen Channels</entry> - </row> - <row> - <entry><literal>%v</literal></entry> - <entry>Wert einer Konfigurationseinstellung</entry> - </row> - <row> - <entry><literal>%V</literal></entry> - <entry>Wert einer Plugin-Option</entry> - </row> - <row> - <entry><literal>%w</literal></entry> - <entry>WeeChat Kommandos</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird, wenn das Kommando ausgef�hrt wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 3 gesetzt, das Array argv enth�lt die folgenden Werte: - <itemizedlist> - <listitem> - <para>argv[0] = Server Name</para> - </listitem> - <listitem> - <para>argv[1] = Kommando</para> - </listitem> - <listitem> - <para>argv[2] = Kommando-Argumente</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die an die Funktion �bergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger, der an die Funktion �bergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Zeiger auf den neuen Kommando-Handler. - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird, wenn das Kommando ausgef�hrt wird, - muss einen der folgende Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<screen> -int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, - "test command, nick: %s", - (argv[2]) ? argv[2] : "none"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *cmd_handler; -cmd_handler = plugin->cmd_handler_add (plugin, "test", "Test command", - "[nick]", "nick: nick of channel", - "%n", &cmd_test, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_timer_handler_add"> - <title>timer_handler_add</title> - - <para> - Prototyp: - <command> - t_plugin_handler *timer_handler_add (t_weechat_plugin - *plugin, int interval, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Erzeuge einen zeitgesteuerten Handler, der periodisch - eine Funktion aufruft. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>interval</option>: Intervall (in Secunden) zwischen zwei Aufrufen der Funktion - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 0 gesetzt und argv ist auf NULL gesetzt. - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente der aufgerufenen Funktion - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger, der an die Funktion �bergeben wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Zeiger auf den neuen timer-Handler. - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird, muss einen der folgende Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<screen> -int my_timer (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "my timer"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *timer_handler; -timer_handler = plugin->timer_handler_add (plugin, 60, &my_timer); -</screen> - </para> - </section> - - <section id="secAPI_keyboard_handler_add"> - <title>keyboard_handler_add</title> - - <para> - Prototyp: - <command> - t_plugin_handler *keyboard_handler_add (t_weechat_plugin - *plugin, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Erzeugt einen Keyboard-Handler, der nach dem Dr�cken einer Taste aufgerufen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Die Funktion, die aufgerufen wird - </para> - <para> - Sie verwendet den folgenden Prototypen: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Das Argument argc ist auf 3 gesetzt, argv enth�lt die folgenden Werte: - <itemizedlist> - <listitem> - <para> - argv[0] = Taste, die gedr�ckt wurde - (Name der internen Funktion oder '*' gefolgt von einem Tastaturcode) - </para> - </listitem> - <listitem> - <para> - argv[1] = Kommandozeile vor dem Tastendruck - </para> - </listitem> - <listitem> - <para> - argv[2] = Kommandozeile nach dem Tastendruck - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argumente, die bei Aufruf der Funktion �bergeben - werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Zeiger auf die Funktion, der bei Aufruf �bergeben - wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Zeiger auf den Handler. - </para> - <para> - Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<screen> -int my_keyb (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argc == 2) - { - plugin->print (plugin, NULL, NULL, "key pressed: %s", argv[0]); - if (argv[1] && (argv[1][0] == '1')) - plugin->print (plugin, NULL, NULL, "input text changed"); - else - plugin->print (plugin, NULL, NULL, "input text not changed"); - } - return PLUGIN_RC_OK; -} -... -t_plugin_handler *keyb_handler; -keyb_handler = plugin->keyboard_handler_add (plugin, &my_keyb); -</screen> - </para> - </section> - - <section id="secAPI_event_handler_add"> - <title>event_handler_add</title> - - <para> - Prototyp: - <command> - t_plugin_handler *event_handler_add (t_weechat_plugin - *plugin, char *event, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - F�gt einen Ereignishandler hinzu, der aufgerufen wird, wenn ein Ereignis eintritt. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Strukture - </para> - </listitem> - <listitem> - <para> - <option>event</option> : Ereignis (siehe folgende Tabelle) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - <para> - Es wird folgender Prototyp verwendet: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - <!-- TRANSLATION NEEDED --> - Arguments depend on event (see table below). - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: Argument, die an die aufgerufene - Funktion �bergeben werden - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: Pointer, der an die aufgerufene - Funktion �bergeben werden - </para> - </listitem> - </itemizedlist> - </para> - <!-- TRANSLATION NEEDED --> - <para> - List of events: - <informaltable colsep="0" frame="none"> - <tgroup cols="3"> - <thead> - <row> - <entry>Ereignis</entry> - <entry>Beschreibung</entry> - <entry>Arguments</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>buffer_open</literal></entry> - <entry>ein Puffer wurde ge�ffnet</entry> - <entry> - argc = 1, argv = { buffer number } - </entry> - </row> - <row> - <entry><literal>buffer_close</literal></entry> - <entry>ein Puffer wurde geschlossen</entry> - <entry> - argc = 1, argv = { buffer number } - </entry> - </row> - <row> - <entry><literal>buffer_move</literal></entry> - <entry>a buffer was moved</entry> - <entry> - argc = 2, argv = { new buffer number, old number } - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - R�ckgabewert: Pointer auf den neuen Ereignishandler. - </para> - <para> - Anmerkung: die aufgerufene Function muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion erfolgreich beendet - </para> - </listitem> - </itemizedlist> - </para> - <para> - Beispiel: -<screen> -int my_event (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "my_event"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *event_handler; -event_handler = plugin->event_handler_add (plugin, "buffer_open", - &my_event); -</screen> - </para> - </section> - - <section id="secAPI_handler_remove"> - <title>handler_remove</title> - - <para> - Prototyp: - <command> - void handler_remove (t_weechat_plugin *plugin, - t_plugin_handler *handler) - </command> - </para> - <para> - Entfernt einen Nachrichten- oder Kommando-Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>handler</option>: Handler, der entfernt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->handler_remove (plugin, my_handler);</screen> - </para> - </section> - - <section id="secAPI_handler_remove_all"> - <title>handler_remove_all</title> - - <para> - Prototyp: - <command> - void handler_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Entfernt alle Handler eines Plugins. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->handler_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_modifier_add"> - <title>modifier_add</title> - - <para> - Prototyp: - <command> - t_plugin_modifier *modifier_add (t_weechat_plugin *plugin, - char *type, char *message, t_plugin_modifier_func *function, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - F�ge einen Nachrichtenmodifikator hinzu. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>type</option>: Modifikatorart: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Art</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>wird bei eingehenden IRC-Nachrichten aufgerufen</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - wird bei jeder Benutzernachricht (oder Befehl) aufgerufen - (bevor WeeChat die Nachricht parst) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - wird unmittelbar vor dem Abschicken einer ausgehenden - Nachricht an den IRC-Server aufgerufen (auch bei - Nachrichten, die WeeChat automatisch an den Server - sendet) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Name der IRC-Nachricht (wird nur bei den Arten - "irc_in" and "irc_out" benutzt) - Um eine Liste der IRC-Nachrichten zu erhalten, lies bitte folgende Dokumente: - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Au�erdem gibt es den Wert "*", der alle Nachrichten anspricht (ohne Filter). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - <para> - Folgender Prototyp wird daf�r benutzt: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Argument argc hat den Wert 2, folgende Werte sind in dem - argv-Array: - <itemizedlist> - <listitem> - <para>argv[0] = Servername</para> - </listitem> - <listitem> - <para>argv[1] = Nachricht</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>modifier_args</option>: an die Funktion �bergebene Werte - </para> - </listitem> - <listitem> - <para> - <option>modifier_pointer</option>: an die Funktion �bergebener Zeiger - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Zeiger auf den neuen Nachrichtenmodifikator - </para> - <para> - Anmerkung: Die Funktion muss die ver�nderte Zeichenkette oder NULL - (wenn keine �nderungen erfolgten) zur�ckgeben. - Wenn die Funktion eine leere Zeichenkette zur�ckgibt, wird die - Nachricht komplett verworfen und nicht weiter von WeeChat - verarbeitet. (Seien Sie vorsichtig mit dem Verwerfen von Nachrichten!) - Die zur�ckgegebene Zeichenkette muss mit malloc() zugewiesen worden sein und - wird von WeeChat nach Gebrauch automatisch mit free() wieder freigegeben. - </para> - <para> - Beispiel: -<screen> -char *adder (t_weechat_plugin *plugin, int argc, char **argv, - char *modifier_args, void *modifier_pointer) -{ - char *string; - string = (char *)malloc (strlen (argv[1]) + 16); - strcpy (string, argv[1]); - strcat (string, "test"); - return string; -} -... -t_plugin_modifier *modifier; -modifier = plugin->modifier_add (plugin, "irc_in", "privmsg", - &adder, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_modifier_remove"> - <title>modifier_remove</title> - - <para> - Prototyp: - <command> - void modifier_remove (t_weechat_plugin *plugin, - t_plugin_modifier *modifier) - </command> - </para> - <para> - Entfernt einen Nachrichtenmodifikator. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>modifier</option>: zu entfernender Modifikator - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->modifier_remove (plugin, my_modifier);</screen> - </para> - </section> - - <section id="secAPI_modifier_remove_all"> - <title>modifier_remove_all</title> - - <para> - Prototyp: - <command> - void modifier_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Entfernt alle Modifikatoren f�r ein Plugin. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner - </para> - <para> - Beispiel: - <screen>plugin->modifier_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_exec_command"> - <title>exec_command</title> - - <para> - Prototyp: - <command> - void exec_command (t_weechat_plugin - *plugin, char *server, char *channel, char *command) - </command> - </para> - <para> - F�hre ein WeeChat-Kommando aus (oder sende eine Nachricht an einen Channel). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, auf den das Kommando angewendet werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, auf den das Kommando angewendet werden soll (kann NULL sein) - </para> - </listitem> - <listitem> - <para> - <option>command</option>: Kommando - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner - </para> - <para> - Beispiel: -<screen> -plugin->exec_command (plugin, NULL, NULL, "/help nick"); -plugin->exec_command (plugin, "freenode", "#weechat", "hello"); -</screen> - </para> - </section> - - <section id="secAPI_get_info"> - <title>get_info</title> - - <para> - Prototyp: - <command> - char *get_info (t_weechat_plugin *plugin, - char *info, char *server) - </command> - </para> - <para> - Gib eine Information �ber WeeChat oder einen Channel zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>info</option> : Name (Typ) der Information: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Info</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>version</literal></entry> - <entry>WeeChats Version</entry> - </row> - <row> - <entry><literal>nick</literal></entry> - <entry>Nickname</entry> - </row> - <row> - <entry><literal>channel</literal></entry> - <entry> - Name des Channels (NULL bei einem Server oder Privatchat) - </entry> - </row> - <row> - <entry><literal>server</literal></entry> - <entry>Name des Servers</entry> - </row> - <row> - <entry><literal>type</literal></entry> - <entry> - Puffertyp: 0=standard, 1=DCC, 2=raw IRC data - </entry> - </row> - <row> - <entry><literal>away</literal></entry> - <entry>Status des "away"-Flags</entry> - </row> - <row> - <entry><literal>inactivity</literal></entry> - <entry> - Anzahl der Sekunden seit der letzten Tastenbet�tigung - </entry> - </row> - <row> - <entry><literal>input</literal></entry> - <entry> - Inhalt der Kommandozeile im gegenw�rtigen Fenster - </entry> - </row> - <row> - <entry><literal>input_mask</literal></entry> - <entry> - Inhalt der Farbmaske f�r die Kommandozeile - </entry> - </row> - <row> - <entry><literal>input_pos</literal></entry> - <entry> - Position des Cursors in der Kommandozeile - </entry> - </row> - <row> - <entry><literal>weechat_dir</literal></entry> - <entry> - WeeChat-Verzeichnis (Standard: ~/.weechat/) - </entry> - </row> - <row> - <entry><literal>weechat_libdir</literal></entry> - <entry>WeeChat-Systemverzeichnis (Bibliotheken)</entry> - </row> - <row> - <entry><literal>weechat_sharedir</literal></entry> - <entry>WeeChat-Systemverzeichnis (gemeinsame Dateien)</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers um Informationen zu lesen (wenn ben�tigt) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: angeforderte Information oder NULL - </para> - <para> - Hinweis: das Ergebnis muss nach Nutzung mit "free" wieder freigegeben werden. - </para> - <para> - Beispiele: -<screen> -char *version = plugin->get_info (plugin, "version", NULL); -char *nick = plugin->get_info (plugin, "nick", "freenode"); -char *inactivity = plugin->get_info (plugin, "inactivity", NULL); - -plugin->print (plugin, NULL, NULL, - "WeeChat version %s, you are %s on freenode " - "(inactive for %s seconds)", - version, nick, inactivity); - -if (version) - free (version); -if (nick) - free (nick); -if (inactivity) - free (inactivity); -</screen> - </para> - </section> - - <section id="secAPI_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Prototyp: - <command> - t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gib eine Liste der aktiven oder beendeten DCCs zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: verkettete Liste von DCCs. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>server</literal></entry> - <entry>IRC Server</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel</literal></entry> - <entry>IRC Channel</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - DCC Typ: - 0 = Chatanfrage empfangen, - 1 = Chatanfrage gesendet, - 2 = Datei empfangen, - 3 = Datei gesendet - </entry> - </row> - <row> - <entry>int*</entry> - <entry><literal>status</literal></entry> - <entry> - DCC Status: - 0 = wartend, - 1 = verbindend, - 2 = aktiv, - 3 = beendet, - 4 = fehlgeschlagen, - 5 = unterbrochen durch Anwender - </entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_time</literal></entry> - <entry>Datum/Zeit der Erzeugung der DCC</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_transfer</literal></entry> - <entry>Datum/Zeit des Beginns der �bertragung der DCC</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>addr</literal></entry> - <entry>IP-Adresse des Partners</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>Port der DCC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>Nickname des Partners</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>filename</literal></entry> - <entry>Dateiname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>local_filename</literal></entry> - <entry>lokaler Dateiname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>filename_suffix</literal></entry> - <entry>Suffix wenn die Datei umbenannt wird</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>size</literal></entry> - <entry>Dateigr�sse</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>pos</literal></entry> - <entry>Position in Datei</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>start_resume</literal></entry> - <entry>Startposition nach einer Unterbrechung</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>bytes_per_sec</literal></entry> - <entry> - �bertragungsrate (Bytes/s) seit Beginn der �bertragung - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>prev_dcc</literal></entry> - <entry> - Zeiger auf voheriges DCC-Info - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>next_dcc</literal></entry> - <entry> - Zeiger auf n�chstes DCC-Info - </entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mittels "free_dcc_info" wieder freigegeben werden. - </para> - <para> - Beispiele: -<screen> -t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin); -for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = ptr_dcc->next_dcc) -{ - plugin->print_server (plugin, "DCC type=%d, with: %s", - ptr_dcc->type, ptr_dcc->nick); -} -if (dcc_info) - plugin->free_dcc_info (plugin, dcc_info); -</screen> - </para> - </section> - - <section id="secAPI_free_dcc_info"> - <title>free_dcc_info</title> - - <para> - Prototyp: - <command> - void free_dcc_info (t_weechat_plugin *plugin, - t_plugin_dcc_info *dcc_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste von DCC-Infos wieder frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>dcc_info</option>: Zeiger auf eine Liste mit DCC-Infos, die - mit "get_dcc_info" angelegt wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> - </para> - </section> - - <section id="secAPI_get_server_info"> - <title>get_server_info</title> - - <para> - Prototyp: - <command> - t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gibt die Liste von IRC-Servern zur�ck (verbunden oder nicht) - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Liste von IRC-Servern. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>interner Servername</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoconnect</literal></entry> - <entry>1 wenn Autoconnect gesetzt ist, 0 sonst</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect</literal></entry> - <entry> - 1 wenn autoreconnect gesetzt ist, - 0 sonst - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect_delay</literal></entry> - <entry>Wartezeit vor erneutem Verbindungsversuch</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_line</literal></entry> - <entry> - 1 wenn der Servername auf der Kommandozeile angegeben wurde (ist somit tempor�r) - 0 sonst - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>address</literal></entry> - <entry>Serveradresse (Name oder IP)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>Port</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ipv6</literal></entry> - <entry>IPv6-Verbindung</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl</literal></entry> - <entry>SSL-Verbindung</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>password</literal></entry> - <entry>Passwort</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick1</literal></entry> - <entry>prim�rer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick2</literal></entry> - <entry>alternativer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick3</literal></entry> - <entry>zweiter, alternativer Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>username</literal></entry> - <entry>Username</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>real name</literal></entry> - <entry>tats�chlicher Name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>command</literal></entry> - <entry>Kommando, dass bei erfolgreicher Verbindung ausgef�hrt wurde</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_delay</literal></entry> - <entry>Verz�gerung nach Ausf�hrung des Kommandos</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>autojoin</literal></entry> - <entry>Channels, die automatisch betreten werden sollen</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autorejoin</literal></entry> - <entry> - 1 wenn Channels wieder betreten werden sollen, nachdem man gekickt wurde - 0 sonst - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>notify_levels</literal></entry> - <entry>Benachrichtigungs-Level von Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_iso</literal></entry> - <entry>Zeichensatz zum Dekodieren von ISO</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_utf</literal></entry> - <entry>Zeichensatz zum Dekodieren von UTF</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_encode</literal></entry> - <entry>Zeichensatz der Channels zum Kodieren von Nachrichten</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_connected</literal></entry> - <entry>1 wenn verbunden mit einem Server, 0 otherwise</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl_connected</literal></entry> - <entry>1 wenn verbunden �ber SSL, 0 sonst</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>gegenw�rtiger Nickname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_away</literal></entry> - <entry>1 wenn away-flag gesetzt ist, 0 sonst</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>away_time</literal></entry> - <entry>Zeitspanne seit away-flag gesetzt ist</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>lag</literal></entry> - <entry>Lag (in Millisekunden)</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>prev_server</literal></entry> - <entry>Zeiger auf vorherigen Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>next_server</literal></entry> - <entry>Zeiger auf n�chsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: das Ergebnis muss nach der Benutzung mit "free_server_info" wieder - freigegeben werden. - </para> - <para> - Beispiel: -<screen> -t_plugin_server_info *server_info, *ptr_server_info; -server_info = plugin->get_server_info (plugin); -if (server_info) -{ - for (ptr_server_info = server_info; ptr_server_info; - ptr_server_info = ptr_server_info->next_server) - { - plugin->print (plugin, NULL, NULL, - "server: %s, address: %s, port: %d %s", - ptr_server_info->name, - ptr_server_info->address, - ptr_server_info->port, - (ptr_server_info->is_connected) ? "(connected)" : ""); - } - plugin->free_server_info (plugin, server_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_server_info"> - <title>free_server_info</title> - - <para> - Prototyp: - <command> - void free_server_info (t_weechat_plugin *plugin, - t_plugin_server_info *server_info) - </command> - </para> - <para> - Gib den Speicher einer Liste "server info" frei - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server_info</option>: Zeiger auf eine Server-Liste, der von der Funktion "get_server_info" - zur�ckgegeben wurde. - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_server_info (plugin, server_info);</screen> - </para> - </section> - - <section id="secAPI_get_channel_info"> - <title>get_channel_info</title> - - <para> - Prototyp: - <command> - t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, - char *server) - </command> - </para> - <para> - Gib eine Liste der Channels f�r einen Server zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Server - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: verkettete Liste von Channels f�r einen Server. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>0 f�r einen normalen Channel, 1 f�r einen Privaten</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>Name des Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>topic</literal></entry> - <entry>Topic des Channels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>modes</literal></entry> - <entry>Channelmodus (Flags)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>limit</literal></entry> - <entry>Anzahl der erlaubten User</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>key</literal></entry> - <entry>Schl�ssel des Channels</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>nicks_count</literal></entry> - <entry>Anzahl der Nicknamen des Channels</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>prev_channel</literal></entry> - <entry>Zeiger auf vorherigem Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>next_channel</literal></entry> - <entry>Zeiger auf n�chsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free_channel_info" wieder freigegeben werden. - </para> - <para> - Beispiel: -<screen> -t_plugin_channel_info *channel_info, *ptr_chan_info; -channel_info = plugin->get_channel_info (plugin, "freenode"); -if (channel_info) -{ - for (ptr_chan_info = channel_info; ptr_chan_info; - ptr_chan_info = ptr_chan_info->next_channel) - { - plugin->print (plugin, NULL, NULL, - " %s (type %d)", - ptr_chan_info->name, - ptr_chan_info->type); - } - plugin->free_channel_info (plugin, channel_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_channel_info"> - <title>free_channel_info</title> - - <para> - Prototyp: - <command> - void free_channel_info (t_weechat_plugin *plugin, - t_plugin_channel_info *channel_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste "channel info" wieder frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>channel_info</option>: Zeiger auf eine Liste "channel info", der von "get_channel_info" - zur�ckgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_channel_info (plugin, channel_info);</screen> - </para> - </section> - - <section id="secAPI_get_nick_info"> - <title>get_nick_info</title> - - <para> - Prototyp: - <command> - t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, - char *server, char *channel) - </command> - </para> - <para> - Gib eine Liste der Nicknamen f�r einen Channel zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: verkettete Liste von Nicknamen eines Channels. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>Nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>host</literal></entry> - <entry>Hostname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>Flags</literal></entry> - <entry> - Flags, die f�r einen Nicknamen gesetzt sind: - Zweierpotenzen "oder" Zwischenwerte - (1 = channel owner, - 2 = channel admin, - 4 = op, - 8 = halfop, - 16 = voice, - 32 = away) - </entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>prev_nick</literal></entry> - <entry>Zeiger auf vorherigen Knoten der Liste</entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>next_nick</literal></entry> - <entry>Zeiger auf n�chsten Knoten der Liste</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free_nick_info" wieder freigegeben werden. - </para> - <para> - Beispiel: -<screen> -t_plugin_nick_info *nick_info, *ptr_nick_info; -nick_info = plugin->get_nick_info (plugin, "freenode", "#weechat"); -if (nick_info) -{ - for (ptr_nick_info = nick_info; ptr_nick_info; - ptr_nick_info = ptr_nick_info->next_nick) - { - plugin->print (plugin, NULL, NULL, - " %s (flags: %d)", - ptr_nick_info->nick, - ptr_nick_info->flags); - } - plugin->free_nick_info (plugin, nick_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_nick_info"> - <title>free_nick_info</title> - - <para> - Prototyp: - <command> - void free_nick_info (t_weechat_plugin *plugin, - t_plugin_nick_info *nick_info) - </command> - </para> - <para> - Gibt den Speicher einer Liste "nick info" frei. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>nick_info</option>: Zeiger auf eine Liste "nick info", der von "get_nick_info" - zur�ckgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_nick_info (plugin, nick_info);</screen> - </para> - </section> - - <section id="secAPI_get_config"> - <title>get_config</title> - - <para> - Prototyp: - <command> - char *get_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Gibt den Wert einer Option der WeeChat-Konfiguration zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Wert der Option, oder NULL, wenn nichts gefunden wurde. - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder freigegeben werden. - </para> - <para> - Beispiel: -<screen> -char *value1 = plugin->get_config (plugin, "look_set_title"); -char *value2 = plugin->get_config (plugin, "freenode.server_autojoin"); -</screen> - </para> - </section> - - <section id="secAPI_set_config"> - <title>set_config</title> - - <para> - Prototyp: - <command> - int set_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Setze den Wert einer Option der WeeChat-Konfiguration. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - <listitem> - <para> - <option>value</option>: der neue Wert der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn der Wert der Option gesetzt werden konnte, 0 bei Auftreten eines Fehlers. - </para> - <para> - Beispiel: -<screen> -plugin->set_config (plugin, "look_nicklist", "off"); -</screen> - </para> - </section> - - <section id="secAPI_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Prototyp: - <command> - char *get_plugin_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Gibt den Wert einer Option eines Plugins zur�ck. - Die Option wird aus "<literal>~/.weechat/plugins.rc</literal>" gelesen - und sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: der Name des Plugins wird automatisch gesetzt). - - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Wert der Option, NULL wenn nichts gefunden wurde. - </para> - <para> - Hinweis: Das Ergebnis muss nach der Benutzung mit "free" wieder freigegeben werden. - </para> - <para> - Beispiel: -<screen> -char *value = plugin->get_plugin_config (plugin, "my_var"); -</screen> - </para> - </section> - - <section id="secAPI_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Prototyp: - <command> - int set_plugin_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Setzt den Wert einer Option eines Plugins. - Die Option wird in die Datei "<literal>~/.weechat/plugins.rc</literal>" geschrieben - und sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: der Name des Plugins wird automatisch gesetzt) - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf eine Plugin-Struktur - </para> - </listitem> - <listitem> - <para> - <option>option</option>: Name der Option, die gesetzt werden soll - </para> - </listitem> - <listitem> - <para> - <option>value</option>: Wert der zu setzenden Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn die Option gesetzt werden konnte, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiel: -<screen> -plugin->set_plugin_config (plugin, "my_var", "value"); -</screen> - </para> - </section> - - <section id="secAPI_get_irc_color"> - <title>get_irc_color</title> - - <para> - Prototype: - <command> - int get_irc_color (t_weechat_plugin *plugin, - char *color_name) - </command> - </para> - <para> - Hole IRC-Farbindex mit dem Farbnamen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf die Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>color_name</option>: Farbname - Folgende Farben sind erlaubt: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Farbname</entry> - <entry>Wert</entry> - </row> - </thead> - <tbody> - <row> - <entry>white</entry> - <entry>0</entry> - </row> - <row> - <entry>black</entry> - <entry>1</entry> - </row> - <row> - <entry>blue</entry> - <entry>2</entry> - </row> - <row> - <entry>green</entry> - <entry>3</entry> - </row> - <row> - <entry>lightred</entry> - <entry>4</entry> - </row> - <row> - <entry>red</entry> - <entry>5</entry> - </row> - <row> - <entry>magenta</entry> - <entry>6</entry> - </row> - <row> - <entry>brown</entry> - <entry>7</entry> - </row> - <row> - <entry>yellow</entry> - <entry>8</entry> - </row> - <row> - <entry>lightgreen</entry> - <entry>9</entry> - </row> - <row> - <entry>cyan</entry> - <entry>10</entry> - </row> - <row> - <entry>lightcyan</entry> - <entry>11</entry> - </row> - <row> - <entry>lightblue</entry> - <entry>12</entry> - </row> - <row> - <entry>lightmagenta</entry> - <entry>13</entry> - </row> - <row> - <entry>gray</entry> - <entry>14</entry> - </row> - <row> - <entry>lightgray</entry> - <entry>15</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: IRC-Farbindex, -1 wenn die Farbe nicht gefunden wurde. - </para> - <para> - Beispiel: -<screen> -int color_blue = plugin->get_irc_color (plugin, "blue"); /* return 2 */ -</screen> - </para> - </section> - - <section id="secAPI_input_color"> - <title>input_color</title> - - <para> - Prototyp: - <command> - void input_color (t_weechat_plugin *plugin, - int color, int start, int length) - </command> - </para> - <para> - Erzeugt einen Farbcode im Eingabepuffer. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf die Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>color</option>: Textfarbe (wenn der Wert < 0 ist, dann wird der - Eingabepuffer aufgefrischt und nicht ver�ndert) - </para> - </listitem> - <listitem> - <para> - <option>start</option>: Startposition f�r Einf�rbung (wenn der Wert < 0 ist, - wird die Maske neu initialisiert) - </para> - </listitem> - <listitem> - <para> - <option>length</option>: L�nge der Einf�rbung (wenn der Wert <= 0 ist, - wird die Maske neu initialisiert) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiele: -<screen> -plugin->input_color (plugin, plugin->get_irc_color (plugin, "blue"), 10, 5); -</screen> - </para> - </section> - - <section id="secAPI_get_window_info"> - <title>get_window_info</title> - - <para> - Prototype: - <command> - t_plugin_window_info *get_window_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gibt die Liste der WeeChat-Fenster zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: verkettete Liste der WeeChat-Fenster. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>win_x</literal></entry> - <entry>horizontale Fensterposition</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_y</literal></entry> - <entry>vertikale Fensterposition</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width</literal></entry> - <entry>Fensterbreite</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height</literal></entry> - <entry>Fensterh�he</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width_pct</literal></entry> - <entry>Breite in % (im Vergleich zum �bergeordneten Fenster)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height_pct</literal></entry> - <entry>H�he % (im Vergleich zum �bergeordneten Fenster)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_buffer</literal></entry> - <entry>Anzahl der angezeigten Puffer</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>prev_window</literal></entry> - <entry>Zeiger auf die Informationen des vorhergehenden Fensters</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>next_window</literal></entry> - <entry>Zeiger auf die Informationen des n�chsten Fensters</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Anmerkung: Das Ergebnis muss nach Benutzung durch einen Aufruf der - "free_window_info"-Funktion gel�scht werden. - </para> - <para> - Example: -<screen> -t_plugin_window_info *window_info, *ptr_window; - -window_info = plugin->get_window_info (plugin); -if (window_info) -{ - for (ptr_window = window_info; ptr_window; ptr_window = ptr_window->next_window) - { - plugin->print (plugin, NULL, NULL, "--- window info ---"); - plugin->print (plugin, NULL, NULL, "(%d,%d), size: %dx%d, %%size: %d%%x%d%%", - ptr_window->win_x, ptr_window->win_y, - ptr_window->win_width, ptr_window->win_height, - ptr_window->win_width_pct, ptr_window->win_height_pct); - plugin->print (plugin, NULL, NULL, "num_buffer: %d", ptr_window->num_buffer); - } - plugin->free_window_info (plugin, window_info); -} -else - plugin->print (plugin, NULL, NULL, "no window info!"); -</screen> - </para> - </section> - - <section id="secAPI_free_window_info"> - <title>free_window_info</title> - - <para> - Prototyp: - <command> - void free_window_info (t_weechat_plugin *plugin, - t_plugin_window_info *window_info) - </command> - </para> - <para> - Gibt den Speicher wieder frei, der von der Fenster-Informationsliste belegt wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>window_info</option>: Zeiger auf Fenster-Informationsliste, - der von der "get_window_info"-Funktion zur�ckgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_window_info (plugin, window_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Prototyp: - <command> - t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Gibt eine Liste der WeeChat-Puffer zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: verkettete Liste der WeeChat-Puffer. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>Puffertyp: 0=standard, 1=DCC, 2=raw IRC data</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>number</literal></entry> - <entry>Puffer-Nummer</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_displayed</literal></entry> - <entry>Anzahl der Fenster im Puffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>server_name</literal></entry> - <entry>Servername f�r den Puffer (kann NULL sein)</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel_name</literal></entry> - <entry>Channelname f�r den Puffer (kann NULL sein)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>notify_level</literal></entry> - <entry>Benachrichtigungslevel f�r den Puffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>log_filename</literal></entry> - <entry>Name der Logdatei (NULL bedeutet, dass nichts geloggt wird)</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>prev_buffer</literal></entry> - <entry>Zeiger auf die vorhergehenden Pufferinformationen</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>next_buffer</literal></entry> - <entry>Zeiger auf die n�chsten Pufferinformationen</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Bemerkung: Das Ergebnis muss nach der Auswertung mit der "free_buffer_info"-Funktion - wieder gel�scht werden. - </para> - <para> - Beispiel: -<screen> -t_plugin_buffer_info *buffer_info, *ptr_buffer; - -buffer_info = plugin->get_buffer_info (plugin); -if (buffer_info) -{ - for (ptr_buffer = buffer_info; ptr_buffer; ptr_buffer = ptr_buffer->next_buffer) - { - plugin->print (plugin, NULL, NULL, "--- buffer info ---"); - plugin->print (plugin, NULL, NULL, "type: %d", ptr_buffer->type); - plugin->print (plugin, NULL, NULL, "number: %d", ptr_buffer->number); - plugin->print (plugin, NULL, NULL, "num_displayed: %d", ptr_buffer->num_displayed); - plugin->print (plugin, NULL, NULL, "server: %s", ptr_buffer->server_name); - plugin->print (plugin, NULL, NULL, "channel: %s", ptr_buffer->channel_name); - plugin->print (plugin, NULL, NULL, "notify level: %d", ptr_buffer->notify_level); - plugin->print (plugin, NULL, NULL, "log filename: %s", ptr_buffer->log_filename); - } - plugin->free_buffer_info (plugin, buffer_info); -} -else - plugin->print (plugin, NULL, NULL, "no buffer info!"); -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_info"> - <title>free_buffer_info</title> - - <para> - Prototyp: - <command> - void free_buffer_info (t_weechat_plugin *plugin, - t_plugin_buffer_info *buffer_info) - </command> - </para> - <para> - Gibt den Speicher frei, der von der Puffer-Informationsliste belegt wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>buffer_info</option>: pointer to buffer info list - returned by "get_buffer_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiel: - <screen>plugin->free_buffer_info (plugin, buffer_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Prototype: - <command> - t_plugin_buffer_data *get_buffer_info (t_weechat_plugin *plugin, - char *server, char *channel) - </command> - </para> - <para> - Gibt den Inhalt des Puffers zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Channelname - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Pufferinhalt (verkettete Liste mit den Zeilen). - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Typ</entry> - <entry>Feld</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry>time_t</entry> - <entry><literal>date</literal></entry> - <entry>Datum/Zeit</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>Nick</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>data</literal></entry> - <entry>Zeileninhalt (Farbcodes wurden entfernt)</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>prev_line</literal></entry> - <entry>Zeiger auf die vorherige Zeile</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>next_line</literal></entry> - <entry>Zeiger auf die n�chste Zeile</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Bemerkung: Das Ergebnis muss nach der Auswertung mit der "free_buffer_data"-Funktion - wieder gel�scht werden. - </para> - <para> - Example: -<screen> -t_plugin_buffer_line *buffer_line, *ptr_line; -char text_time[256]; - -buffer_line = plugin->get_buffer_data (plugin); -if (buffer_line) -{ - for (ptr_line = buffer_line; ptr_line; ptr_line = ptr_line->next_line) - { - strftime (text_time, sizeof (text_time), "%x %X", localtime (&(ptr_line->date))); - plugin->print (plugin, NULL, NULL, "date: %s, nick: %s, data: %s", - text_time, ptr_line->nick, ptr_line->data); - } - plugin->free_buffer_data (plugin, buffer_line); -} -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_data"> - <title>free_buffer_data</title> - - <para> - Prototype: - <command> - void free_buffer_data (t_weechat_plugin *plugin, - t_plugin_buffer_line *buffer_line) - </command> - </para> - <para> - Gibt den Speicher frei, der von den Pufferzeilen belegt wurde. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: Zeiger auf Pluginstruktur - </para> - </listitem> - <listitem> - <para> - <option>buffer_line</option>: Zeiger auf Pufferzeilen, der - von der "get_buffer_data"-Funktion zur�ckgegeben wurde - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Beispiele: - <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> - </para> - </section> - - </section> - - <section id="secCompilePlugin"> - <title>�bersetzen eines Plugins</title> - - <para> - Das �bersetzen braucht keine WeeChat-Quellen, aber die Datei "<literal>weechat-plugin.h</literal>". - </para> - - <para> - Um ein Plugin zu �bersetzen, das aus einer Datei "toto.c" besteht (unter GNU/Linux): -<screen> -<prompt>$ </prompt><userinput>gcc -fPIC -Wall -c toto.c</userinput> -<prompt>$ </prompt><userinput>gcc -shared -fPIC -o libtoto.so toto.o</userinput> -</screen> - </para> - - </section> - - <section id="secLoadPlugin"> - <title>Laden des Plugins in WeeChat</title> - - <para> - Kopiere die Datei "libtoto.so" in das Plugin-Verzeichnis der systemweiten Dateien WeeChats - (zum Beispiel: "<literal>/usr/local/lib/weechat/plugins</literal>") oder in das Plugin-Verzeichnis - des Users (zum Beispiel: "<literal>/home/xxxxx/.weechat/plugins</literal>"). - </para> - - <para> - In WeeChat: - <screen><userinput>/plugin load toto</userinput></screen> - </para> - - </section> - - <section id="secPluginExample"> - <title>Plugin Beispiel</title> - - <para> - Vollst�ndiges Beispiel eines Plugins, welches das Kommando /double implementiert, dass - seine Argumente im gegenw�rtigen Channel doppelt ausgibt (ok, das ist weniger n�tzlich, - aber auch nur ein Beispiel!): -<screen> -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Double"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/double" command manager */ - -int double_cmd (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argv[2] && (argv[2][0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, argv[2]); - plugin->exec_command (plugin, NULL, NULL, argv[2]); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message to display two times", - NULL, - &double_cmd, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -</screen> - </para> - - </section> - - </section> - - <section id="secCharset"> - <title>Zeichensatz Plugin</title> - - <para> - Das Zeichensatz-Plugin erm�glicht das Ver- und Entschl�sseln von Daten - auf 3 Ebenen: Global, pro Server oder pro Channel. - Das Plugin ist optional, wird jedoch empfohlen: wenn es nicht geladen ist, - kann WeeChat nur UTF-8-Daten lesen und schreiben. - </para> - - <para> - Das Zeichensatz-Plugin sollte beim Start von WeeChat automatisch geladen - werden. - Um sicherzustellen, dass das Plugin geladen wurde, versuchen Sie: - "<literal>/charset</literal>". - Wenn der Befehl nicht gefunden wird, laden Sie das Plugin manuell mit dem Befehl: - <screen>/plugin load charset</screen> - Wenn das Plugin nicht gefunden wird, kompilieren Sie WeeChat erneut mit Plugin- - und Zeichensatz-Support - </para> - - <para> - Wenn das Zeichensatz-Plugin startet, zeigt es den Terminalzeichensatz - und den internen Zeichensatz an. Der Terminalzeichensatz h�ngt von - den LOCALE-Einstellungen ab, der interne ist UTF-8. - Zum Beispiel: -<screen> --P- Charset plugin starting, terminal charset: ISO-8859-15 (WeeChat internal: UTF-8) -</screen> - </para> - - <section id="secCharsetSettings"> - <title>Einstellungen</title> - - <itemizedlist> - <listitem> - <para> - Um den globalen Zeichensatz zum Kodieren und Dekodieren festzulegen, benutzen Sie den - "<literal>/setp</literal>" Befehl. - Zum Beispiel: -<screen> -/setp charset.global.decode = ISO-8859-15 -/setp charset.global.encode = ISO-8859-15 -</screen> - Wenn der Zeichensatz zum Dekodieren nicht gesetzt ist (z.B. beim ersten - Start des Plugins), wird es automatisch auf den Terminalzeichensatz - eingestellt (wenn es nicht UTF-8 ist) oder als Voreinstellung auf - "<literal>ISO-8859-1</literal>" gesetzt. - Der voreingestellte Enkodierungszeichensatz ist leer, so dass in der - Voreinstellung mit dem internen Zeichensatz (UTF-8) enkodiert wird. - </para> - </listitem> - <listitem> - <para> - Um den Serverzeichensatz festzulegen, benutzen Sie den - "<literal>/charset</literal>"-Befehl im Server-Puffer. - Wenn Sie nur einen Zeichensatz vorgeben, wird dieser automatisch - zum Enkodieren und Dekodieren verwendet. - Zum Beispiel: - <screen>/charset ISO-8859-15</screen> - Das ist gleichbedeutend mit: -<screen> -/charset decode ISO-8859-15 -/charset encode ISO-8859-15 -</screen> - </para> - </listitem> - <listitem> - <para> - Um den zeichensatz im Channel (oder einem privatem Chat) festzulegen, - m�ssen Sie den gleichen Befehl wie f�r den Server benutzen, jedoch in - dem Channel-Puffer (oder Query-Puffer) - </para> - </listitem> - </itemizedlist> - - </section> - - <section id="secCharsetFAQ"> - <title>FAQ</title> - - <para> - Wenn Sie Probleme mit den Zeichen oder dem Zeichensatz-Plugin haben: - <itemizedlist> - <listitem> - <para> - �berpr�fen Sie, ob weechat-curses zu libcursesw gelinkt ist - (Achtung: Wird bei den meisten, jedoch nicht bei allen Distributionen ben�tigt): - <screen>ldd /pfad/zu/weechat-curses</screen> - </para> - </listitem> - <listitem> - <para> - �berpr�fen Sie die Zeichensatz-Zeile im Server-Puffer, dort sollten ISO-XXXXXX - oder UTF-8 f�r den Terminal-Zeichensatz stehen. Wenn Sie dort ANSI_X3.4-1968 - oder andere Werte sehen, sind Ihre LOCALES eventuell falsch eingestellt. - </para> - </listitem> - <listitem> - <para> - Setze die globalen Dekodier-Einstellungen, z.B.: - <screen>/setp charset.global.decode = ISO-8859-15</screen> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </section> - - <section id="secScriptsPlugins"> - <title>Skript-Plugins</title> - - <para> - Vier Plugins werden von WeeChat angeboten um Skriptsprachen zu nutzen: - Perl, Python, Ruby und Lua. - </para> - - <section id="secLoadUnloadScripts"> - <title>Laden / Entfernen von Skripten</title> - - <para> - Scripts are loaded and unloaded with <command>/perl</command>, - <command>/python</command>, <command>/ruby</command> and - <command>/lua</command> commands - (type <command>/help</command> in WeeChat for help about commands). - - Skripte werden mit den Kommandos <command>/perl</command>, <command>/python</command>, - <command>/ruby</command> und <command>/lua</command> geladen oder entfernt. - (Benutze <command>/help</command> in WeeChat f�r Hilfe zu den Kommandos). - </para> - - <para> - Beispiele: - <itemizedlist> - <listitem> - <para> - Laden eines Perl-Skripts: - <command><userinput>/perl load /tmp/test.pl</userinput></command> - </para> - </listitem> - <listitem> - <para> - Liste alle geladenen Perl-Skripte auf: - <command><userinput>/perl</userinput></command> - </para> - </listitem> - <listitem> - <para> - Laden eines Python-Skripts: - <command><userinput>/python load /tmp/test.py</userinput></command> - </para> - </listitem> - <listitem> - <para> - Liste alle geladenen Python-Skripte auf: - <command><userinput>/python</userinput></command> - </para> - </listitem> - <listitem> - <para> - Laden eines Ruby-Skripts: - <command><userinput>/ruby load /tmp/test.rb</userinput></command> - </para> - </listitem> - <listitem> - <para> - Liste alle geladenen Ruby-Skripte auf: - <command><userinput>/ruby</userinput></command> - </para> - </listitem> - <listitem> - <para> - Laden eines Lua-Skripts: - <command><userinput>/lua load /tmp/test.lua</userinput></command> - </para> - </listitem> - <listitem> - <para> - Liste alle geladenen Lua-Skripte auf: - <command><userinput>/lua</userinput></command> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSyntaxByLanguage"> - <title>Syntax in den Skriptsprachen</title> - - <section id="secScriptPerl"> - <title>Perl</title> - - <para> - In einem WeeChat-PerlSkript ist allen API-Funktionen und Variablen ein - "<literal>weechat::</literal>" vorangestellt. - Beispiel: -<screen>weechat::register("test", "1.0", "end_test", "WeeChat perl script");</screen> - </para> - - </section> - - <section id="secScriptPython"> - <title>Python</title> - - <para> - Ein WeeChat-Pythonskript muss mit einer Importdirektive f�r WeeChat beginnen: - <screen>import weechat</screen> - </para> - - <para> - Allen API-Funktionen und Variablen ist ein "<literal>weechat.</literal>" vorangestellt. - Beispiel: -<screen>weechat.register("test", "1.0", "end_test", "WeeChat python script")</screen> - </para> - - </section> - - <section id="secScriptRuby"> - <title>Ruby</title> - - <para> - In einem WeeChat-Rubyskript muss der gesamte Code innerhalb von - Funktionen stehen. F�r den Hauptteil ist die Funktion "<literal>weechat_init</literal>" - zu definieren, die automatisch aufgerufen wird, wenn das Skript in WeeChat geladen wird. - Beispiel: -<screen> -def weechat_init - Weechat.register("test", "1.0", "end_test", "WeeChat ruby script") - Weechat.add_command_handler("command", "my_command") - return Weechat::PLUGIN_RC_OK -end - -def my_command(server, args) - Weechat.print("my command") - return Weechat::PLUGIN_RC_OK -end -</screen> - </para> - - <para> - Allen API-Funktionen ist "<literal>Weechat.</literal>" - und Variablen "<literal>Weechat::</literal>" vorangestellt. - </para> - - </section> - - <section id="secScriptLua"> - <title>Lua</title> - - <para> - In einem WeeChat-Luaskript ist allen Funktionen ein "<literal>weechat.</literal>" - vorangestellt. Variablen beginnen mit "<literal>weechat.</literal>" und - enden mit "<literal>()</literal>". - Beispiel: -<screen> -function message_handler(server, args) - weechat.print("I am a message handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - - </section> - - </section> - - <section id="secWeeChatScriptsAPI"> - <title>WeeChat / Skript-API</title> - - <section id="secScript_register"> - <title>register</title> - - <para> - Perl-Prototyp: - <command> - weechat::register(name, version, end_function, description, [charset]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - Das ist die erste Funktion, die in einem Skript aufgerufen wird. - Alle WeeChat-Skripte m�ssen diese Funktion aufrufen. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>name</option>: eindeutiger Name des Skripts - (jedes Skript muss einen eindeutigen Namen besitzen) - </para> - </listitem> - <listitem> - <para> - <option>version</option>: Version des Skripts - </para> - </listitem> - <listitem> - <para> - <option>end_function</option>: Funktion, die aufgerufen wird, wenn - das Skript entfernt werden soll (optional; ein leerer String bedeutet, - dass nichts aufgerufen wird) - </para> - </listitem> - <listitem> - <para> - <option>description</option>: eine kurze Beschreibung des Skripts - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: Zeichensatz, der von dem Script benutzt wird, sollten Sie - setzen, wenn das Script nicht in UTF-8 geschrieben ist - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn das Skript registriert werden konnte, 0 wenn ein Fehler aufgetaucht ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::register("test", "1.0", "end_test", "Test script!", "ISO-8859-1"); - -# python -weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") - -# ruby -Weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") - --- lua -weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") -</screen> - </para> - </section> - - <section id="secScript_set_charset"> - <title>set_charset</title> - - <para> - Perl-Prototyp: - <command> - weechat::set_charset(charset); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.set_charset(charset) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Legt einen neuen Script-Zeichensatz fest. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>charset</option>: neuer Script-Zeichensatz - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1, wenn der Zeichensatz erfolgreich gesetzt wurd, 0, wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::set_charset("ISO-8859-1"); - -# python -weechat.set_charset("ISO-8859-1") - -# ruby -Weechat.set_charset("ISO-8859-1") - --- lua -weechat.set_charset("ISO-8859-1") -</screen> - </para> - </section> - - <section id="secScript_print"> - <title>print</title> - - <para> - Perl-Prototyp: - <command> - weechat::print(message, [channel, [server]]) - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.prnt(message, [channel, [server]]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.print(message, [channel, [server]]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.print(message, [channel, [server]]) - </command> - </para> - <para> - Sende eine Nachricht an einen WeeChat-Puffer, identifiziert durch Server - und Channel. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, zu welchem der Puffer geh�rt, in dem die - Nachricht angezeigt werden soll - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu welchem der Puffer geh�rt, in dem - die Nachricht angezeigt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - <!-- TRANSLATION NEEDED --> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::print("message"); -weechat::print("message", "#weechat"); -weechat::print("message", "#weechat", "freenode"); -weechat::print("test: \x0305 rot \x0F normal"); - -# python -weechat.prnt("message") -weechat.prnt("message", "#weechat") -weechat.prnt("message", "#weechat", "freenode") - -# ruby -Weechat.print("message") -Weechat.print("message", "#weechat") -Weechat.print("message", "#weechat", "freenode") - --- lua -weechat.print("message") -weechat.print("message", "#weechat") -weechat.print("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <!-- TRANSLATION NEEDED --> - <section id="secScript_print_server"> - <title>print_server</title> - - <para> - Perl prototype: - <command> - weechat::print_server(message) - </command> - </para> - <para> - Python prototype: - <command> - weechat.print_server(message) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.print_server(message) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.print_server(message) - </command> - </para> - <para> - Display a message on server buffer. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::print_server("message"); -weechat::print_server("test: \x0305 rot \x0F normal"); - -# python -weechat.print_server("message") - -# ruby -Weechat.print_server("message") - --- lua -weechat.print_server("message") -</screen> - </para> - </section> - - <section id="secScript_print_infobar"> - <title>print_infobar</title> - - <para> - Perl-Prototyp: - <command> - weechat::print_infobar(time, message); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.print_infobar(time, message) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.print_infobar(time, message) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.print_infobar(time, message) - </command> - </para> - <para> - Zeige eine Nachricht f�r einen festen Zeitraum in der Infobar. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>time</option>: Zeit (in sekunden) der Anzeige (0 = permanent) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::print_infobar(5, "message"); - -# python -weechat.print_infobar(5, "message") - -# ruby -Weechat.print_infobar(5, "message") - --- lua -weechat.print_infobar(5, "message") -</screen> - </para> - </section> - - <section id="secScript_remove_infobar"> - <title>remove_infobar</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_infobar([count]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_infobar([count]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_infobar([count]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_infobar([count]) - </command> - </para> - <para> - Entfernt eine oder mehrere Nachrichten aus dem Infobar-Speicher. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>count</option>: Anzahl der Nachrichten, die entfernt werden sollen - (Ist kein Argument angegeben oder <= 0 werden alle Nachrichten entfernt) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 bei Auftreten eines Fehlers - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_infobar(1); - -# python -weechat.remove_infobar(1) - -# ruby -Weechat.remove_infobar(1) - --- lua -weechat.remove_infobar(1) -</screen> - </para> - </section> - - <section id="secScript_log"> - <title>log</title> - - <para> - Perl-Prototyp: - <command> - weechat::log(message, [channel, [server]]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Schreibe eine Nachricht in die Logdatei eines Servers oder Channels. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>message</option>: Nachricht - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, zu welchem der Puffer der Logdatei geh�rt - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, zu welchem der Puffer der Logdatei geh�rt - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiel: -<screen> -# perl -weechat::log("message", "#weechat", "freenode"); - -# python -weechat.log("message", "#weechat", "freenode") - -# ruby -Weechat.log("message", "#weechat", "freenode") - --- lua -weechat.log("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <section id="secScript_add_message_handler"> - <title>add_message_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_message_handler(message, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_message_handler(message, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_message_handler(message, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_message_handler(message, function) - </command> - </para> - <para> - Erzeuge einen Nachrichten-Handler, der bei Empfang einer IRC-Nachricht aufgerufen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>message</option>: Name (Typ) der IRC-Nachricht. F�r eine Liste - der bekannten Typen von IRC-Nachrichten konsultieren sie bitte die - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> und - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Mehr noch, sie k�nnen spezielle Ereignisse abfangen, indem sie einen speziellen Namen verwenden, der mit - "weechat_" beginnt (siehe <xref linkend="secAPI_msg_handler_add" />). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die bei Empfang einer Nachricht aufgerufen werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_message_handler ("privmsg", "my_function"); -sub my_function -{ - weechat::print("server=$_[0]"); - ($null, $channel, $message) = split ":",$_[1],3; - ($mask, $null, $channel) = split " ", $channel; - weechat::print("mask=$mask, channel=$channel, msg=$message"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_message_handler ("privmsg", "my_function") -def my_function(server, args): - weechat.prnt("server="+server) - null, channel, message = string.split(args, ":", 2) - mask, null, channel = string.split(string.strip(channel), " ", 2) - weechat.prnt("mask="+mask+", canal="+channel+", message="+message) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_message_handler("privmsg", "my_function") -def my_function(server, args) - Weechat.print("server=#{server}, args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_message_handler ("privmsg", "my_function") -function my_function(server, args) - weechat.print("server=" .. server .. ", args=" .. args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht - empfangen wurde, muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: Die Nachricht wird nicht an WeeChat �bergeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: Die Nachricht wird nicht an andere Plugins - weitergegeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: Die Nachricht wird weder - an WeeChat noch an andere Plugins �bergeben - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: Funktion - erfolgreich vervollst�ndigt und eine Hervorhebung bei den - empfangenen Nachrichten eingebaut - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_command_handler"> - <title>add_command_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Erzeugt einen Kommando-Handler, der aufgerufen wird, wenn der Anwender - das Kommando benutzt (Beispiel: /command). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>command</option>: - Name des neuen Kommandos, der auch Name eines bereits - existierenden Kommandos sein kann (mit Bedacht zu verwenden, - das ersetzte Kommando ist nicht verf�gbar, bis das Plugin entfernt wurde) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird, wenn - das Kommando ausgef�hrt wird - </para> - </listitem> - <listitem> - <para> - <option>arguments</option>: eine kurze Beschreibung der Argumente des Kommandos - (werden angezeigt bei /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option>: eine ausf�hrliche Beschreibung der Argumente - des Kommandos (werden angezeigt bei /help command) - </para> - </listitem> - <listitem> - <para> - <option>completion_template</option>: - Vorlage f�r die Vervollst�ndigung; zum Beispiel bedeutet - "<literal>abc|%w def|%i</literal>", dass das - erste Argument "abc" oder ein WeeChat-Kommando sein kann - und das zweite Argument "def" oder ein IRC-Kommando. - (siehe <xref linkend="secAPI_cmd_handler_add" />) - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_command_handler("command", "my_command"); -sub my_command -{ - weechat::print("server= $_[0], args: $_[1]"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_command_handler("command", "my_command") -def my_command(server, args): - weechat.prnt("server="+server+", args="+args) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_command_handler("command", "my_command") -def my_command(server, args) - Weechat.print("server=#{server}, args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_command_handler("command", "my_command") -def my_command(server, args) - weechat.print("server="..server..", args="..args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Hinweis: die Funktion, die aufgerufen wird wenn eine Nachricht - empfangen wurde, muss einen der folgenden Werte zur�ckgeben: - - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_timer_handler"> - <title>add_timer_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_timer_handler(interval, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Erzeugt einen zeitgesteuerten Handler, der periodisch eine Funktion aufruft. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>interval</option>: Interval (in Sekunden) zwischen - zwei Aufrufen der Funktion. - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_timer_handler(60, "my_timer"); -sub my_timer -{ - weechat::print("this is timer handler"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_timer_handler(60, "my_timer") -def my_timer(): - weechat.prnt("this is timer handler") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_timer_handler(60, "my_timer") -def my_timer() - Weechat.print("this is timer handler") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_timer_handler(60, "my_timer") -function my_timer() - weechat.print("this is timer handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note: function called has to return one of following values: - Hinweis: die Funktion, die aufgerufen wird, muss - einen der folgenden Werte zur�ckgeben: - - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - completed - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_keyboard_handler"> - <title>add_keyboard_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_keyboard_handler(function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Erzeugt einen Keyboard-Handler, der f�r jeden Tastendruck aufgerufen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>function</option>: Funktion, die aufgerufen wird - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_keyboard_handler("my_keyboard"); -sub my_keyboard -{ - my $key = shift; - my $input_before = shift; - my $input_after = shift; - weechat::print("keyboard handler: key = '$key', " - ."input before = '$input_before' " - ."after = '$input_after'"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_keyboard_handler("my_keyboard") -def my_keyboard(key, input_before, input_after): - weechat.prnt("keyboard handler: key = '%s', " \ - "input before = '%s' after = '%s'" - %(key, input_before, input_after)) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_keyboard_handler("my_keyboard") -def my_keyboard(key, input_before, input_after) - Weechat.print("keyboard handler: key = '#{key}', " \ - "input before = '#{input_before}' " \ - "after = '#{input_after}'") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_keyboard_handler("my_keyboard") -function my_keyboard(key, input_before, input_after) - weechat.print("keyboard handler: key = '"..key.. - "', input before = '"..input_before.. - "' after = '"..input_after.."'") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Hinweis: Die aufgerufene Funktion muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion ist fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion war erfolgreich - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_event_handler"> - <title>add_event_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_event_handler(event, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_event_handler(event, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_event_handler(event, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_event_handler(event, function) - </command> - </para> - <para> - F�gt einen Ereignis-Handler hinzu, der beim Auftreten eines Ereignisses aufgerufen wird. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>event</option> : Ereignis - (see <xref linkend="secAPI_event_handler_add" />) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewerte: 1 bei Erfolg, 0 bei aufgetretenen Fehlern - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_event_handler("buffer_open", "my_event"); -sub my_event -{ - weechat::print("buffer open"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_event_handler("buffer_open", "my_event") -def my_event(): - weechat.prnt("buffer open") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_event_handler("buffer_open", "my_event") -def my_event() - Weechat.print("buffer open") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_event_handler("buffer_open", "my_event") -function my_event() - weechat.print("buffer open") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Bemerkung: aufgerufene Funktion muss einen der folgenden Werte zur�ckgeben: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: Funktion fehlgeschlagen - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: Funktion erfolgreich beendet - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_remove_handler"> - <title>remove_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_handler(name, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_handler(name, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_handler(name, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_handler(name, function) - </command> - </para> - <para> - Entfernt einen Nachrichten- oder Kommando-Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>name</option>: Name der IRC-Message oder Kommando - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 bei Auftreten eines Fehlers - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_handler("command", "my_command"); - -# python -weechat.remove_handler("command", "my_command") - -# ruby -Weechat.remove_handler("command", "my_command") - --- lua -weechat.remove_handler("command", "my_command") -</screen> - </para> - </section> - - <section id="secScript_remove_timer_handler"> - <title>remove_timer_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_timer_handler(function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_timer_handler(function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_timer_handler(function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_timer_handler(function) - </command> - </para> - <para> - Entfernt einen zeitgesteuerten Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>function</option>: Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_timer_handler("my_timer"); - -# python -weechat.remove_timer_handler("my_timer") - -# ruby -Weechat.remove_timer_handler("my_timer") - --- lua -weechat.remove_timer_handler("my_timer") -</screen> - </para> - </section> - - <section id="secScript_remove_keyboard_handler"> - <title>remove_keyboard_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_keyboard_handler(function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Entfernt einen Keyboard-Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>function</option>: Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewerte: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_keyboard_handler("my_keyboard"); - -# python -weechat.remove_keyboard_handler("my_keyboard") - -# ruby -Weechat.remove_keyboard_handler("my_keyboard") - --- lua -weechat.remove_keyboard_handler("my_keyboard") -</screen> - </para> - </section> - - <section id="secScrip_remove_event_handler"> - <title>remove_event_handler</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_event_handler(function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_event_handler(function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_event_handler(function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_event_handler(function) - </command> - </para> - <para> - Entfernt einen Ereignis-Handler. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>function</option>: Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewerte: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_event_handler("my_event"); - -# python -weechat.remove_event_handler("my_event") - -# ruby -Weechat.remove_event_handler("my_event") - --- lua -weechat.remove_event_handler("my_event") -</screen> - </para> - </section> - - <section id="secScript_add_modifier"> - <title>add_modifier</title> - - <para> - Perl-Prototyp: - <command> - weechat::add_modifier(type, message, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.add_modifier(type, message, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.add_modifier(type, message, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.add_modifier(type, message, function) - </command> - </para> - <para> - F�gt einen Nachrichtenmodifikator hinzu. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>type</option>: Modifikatorart: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Art</entry> - <entry>Beschreibung</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>wird bei eingehenden IRC-Nachrichten aufgerufen</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - wird bei jeder Benutzernachricht (oder Befehl) aufgerufen - (bevor WeeChat die Nachricht parst) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - wird unmittelbar vor dem Abschicken einer ausgehenden - Nachricht an den IRC-Server aufgerufen (auch bei - Nachrichten, die WeeChat automatisch an den Server - sendet) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option>:Name der IRC-Nachricht (wird nur bei den Arten - "irc_in" and "irc_out" benutzt) - Um eine Liste der IRC-Nachrichten zu erhalten, lies bitte folgende Dokumente: - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Au�erdem gibt es den Wert "*", der alle Nachrichten anspricht (ohne Filter). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: aufgerufene Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 bei einem aufgetretenem Fehler - </para> - <para> - Beispiele: -<screen> -# perl -weechat::add_modifier("irc_in", "privmsg", "mod_in"); -weechat::add_modifier("irc_out", "privmsg", "mod_out"); -sub mod_in -{ - return "$_[1] [modifier IN]"; -} -sub mod_out -{ - return "$_[1] [modifier OUT]"; -} - -# python -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(server, args): - return args + " [modifier IN]" -def mod_out(server, args): - return args + " [modifier OUT]" - -# ruby -Weechat.add_modifier("irc_in", "privmsg", "mod_in") -Weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(server, args) - return args + " [modifier IN]" -end -def mod_out(server, args) - return args + " [modifier OUT]" -end - --- lua -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -function mod_in(server, args) - return args .. " [modifier IN]" -end -function mod_out(server, args) - return args .. " [modifier OUT]" -end -</screen> - </para> - </section> - - <section id="secScript_remove_modifier"> - <title>remove_modifier</title> - - <para> - Perl-Prototyp: - <command> - weechat::remove_modifier(type, message, function); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Entfernt einen Nachrichtenmodifikator. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>type</option>: Modifikatorart - </para> - </listitem> - <listitem> - <para> - <option>message</option>: Nachrichtenart, die der Modifikator verwaltet - </para> - </listitem> - <listitem> - <para> - <option>function</option>: Funktion - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 bei einem aufgetretenem Fehler - </para> - <para> - Beispiele: -<screen> -# perl -weechat::remove_modifier("irc_in", "privmsg", "mod_in"); - -# python -weechat.remove_modifier("irc_in", "privmsg", "mod_in") - -# ruby -Weechat.remove_modifier("irc_in", "privmsg", "mod_in") - --- lua -weechat.remove_modifier("irc_in", "privmsg", "mod_in") -</screen> - </para> - </section> - - <section id="secScript_command"> - <title>command</title> - - <para> - Perl-Prototyp: - <command> - weechat::command(command, [channel, [server]]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - F�hrt ein WeeChat-Kommando aus (oder sendet eine Nachricht an einen Channel). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>command</option>: Kommando - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: Name des Channels, f�r den das Kommando - ausgef�hrt werden soll - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers, f�r den das - Kommando ausgef�hrt werden soll - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 bei Erfolg, 0 wenn ein Fehler aufgetreten ist - </para> - <para> - Beispiele: -<screen> -# perl -weechat::command("hello everybody!"); -weechat::command("/kick toto please leave this channel", "#weechat"); -weechat::command("/nick newnick", "", "freenode"); - -# python -weechat.command("hello everybody!") -weechat.command("/kick toto please leave this channel", "#weechat") -weechat.command("/nick newnick", "", "freenode") - -# ruby -Weechat.command("hello everybody!") -Weechat.command("/kick toto please leave this channel", "#weechat") -Weechat.command("/nick newnick", "", "freenode") - --- lua -weechat.command("hello everybody!") -weechat.command("/kick toto please leave this channel", "#weechat") -weechat.command("/nick newnick", "", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_info"> - <title>get_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_info(name, [server]); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_info(name, [server]) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_info(name, [server]) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_info(name, [server]) - </command> - </para> - <para> - Gibt ein Info �ber WweeChat oder einen Channel zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>name</option>: Name (Typ) des Infos, das gelesen werden soll - (siehe <xref linkend="secAPI_get_info" />) - </para> - </listitem> - <listitem> - <para> - <option>server</option>: interner Name des Servers - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: angefragte Infos, oder leerer String, wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -$version = get_info("version"); -$nick = get_info("nick", "freenode"); - -# python -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") - -# ruby -version = Weechat.get_info("version") -nick = Weechat.get_info("nick", "freenode") - --- lua -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_dcc_info(); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_dcc_info() - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Gibt eine Liste der gegenw�rtig aktiven oder beendeten DCCs zur�ck. - </para> - <para> - R�ckgabewert: Liste der DCCS - (siehe <xref linkend="secAPI_get_dcc_info" />). - </para> - <para> - Beispiele: -<screen> -# perl -my @dccs = weechat::get_dcc_info(); -if (@dccs) -{ - foreach my $dcc (@dccs) - { - while (my ($key, $value) = each %$dcc) - { - weechat::print("$key = '$value'"); - } - } -} -else -{ - weechat::print("no DCC"); -} - -# python -dccs = weechat.get_dcc_info() -if dccs != None: - if dccs == []: - weechat.prnt("no DCC") - else: - for d in dccs: - for b in d.keys(): - weechat.prnt("%s = '%s'" %(b, d[b])) -else: - weechat.prnt("error while getting DCC") - -# ruby -dccs = Weechat.get_dcc_info() -if dccs != nil - if dccs == [] - Weechat.print("no DCC") - else - dccs.each do |m| - m.each do |key, value| - Weechat.print("#{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting DCC") -end - --- lua -dccs = weechat.get_dcc_info() -if dccs ~= nil then - if dccs then - dcc, dccinfos = next (dccs, nil) - while (dcc) do - key, value = next (dccinfos, nil) - while (key) do - weechat.print(key.." = '"..value.."'") - key, value = next (dccinfos, key) - end - dcc, dccinfos = next (dccs, dcc) - end - else - weechat.print("no DCC") - end -else - weechat.print("error while getting DCC") -end -</screen> - </para> - </section> - - <section id="secScript_get_server_info"> - <title>get_server_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_server_info(); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_server_info() - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_server_info() - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_server_info() - </command> - </para> - <para> - Gibt eine Liste der IRC-Server zur�ck (verbunden oder nicht). - </para> - <para> - R�ckgabewert: Liste der Server - (siehe <xref linkend="secAPI_get_server_info" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $servers = weechat::get_server_info(); -if ($servers) -{ - while (my ($srvname, $srvinfos) = each %$servers) - { - while ( my ($key, $value) = each %$srvinfos) - { - weechat::print("$srvname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no server"); -} - -# python -servers = weechat.get_server_info() -if servers != None: - if servers == {}: - weechat.prnt("no server") - else: - for s in servers: - for i in servers[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(servers[s][i]))) -else: - weechat.prnt("error while getting servers") - -# ruby -servers = Weechat.get_server_info() -if servers != nil - if servers == [] - Weechat.print("no server") - else - servers.each do |n, s| - s.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting servers") -end - --- lua -servers = weechat.get_server_info() -if servers ~= nil then - if servers then - srv, srvinfos = next (servers, nil) - while (srv) do - key, value = next (srvinfos, nil) - while (key) do - weechat.print(srv.." -> "..key.." = '"..value.."'") - key, value = next (srvinfos, key) - end - srv, srvinfos = next (servers, srv) - end - else - weechat.print("no server") - end -else - weechat.print("error while getting servers") -end -</screen> - </para> - </section> - - <section id="secScript_get_channel_info"> - <title>get_channel_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_channel_info(server); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_channel_info(server) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_channel_info(server) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_channel_info(server) - </command> - </para> - <para> - Gibt eine Liste der Channels f�r einen Server zur�ck. - </para> - <para> - R�ckgabewert: Liste der Channel f�r einen Server - (siehe <xref linkend="secAPI_get_channel_info" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $channels = weechat::get_channel_info(weechat::get_info("server")); -if ($channels) -{ - while (my ($channame, $chaninfos) = each %$channels) - { - while (my ($key, $value) = each %$chaninfos) - { - weechat::print("$channame -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no channel"); -} - -# python -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans != None: - if chans == {}: - weechat.prnt("no channel") - else: - for s in chans: - for i in chans[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(chans[s][i]))) -else: - weechat.prnt("error while getting channels") - -# ruby -channels = Weechat.get_channel_info(Weechat.get_info("server")) -if channels != nil - if channels == {} - Weechat.print("no channel") - else - channels.each do |n, c| - c.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting channels") -end - --- lua -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans ~= nil then - if chans then - chan, chaninfos = next (chans, nil) - while (chan) do - key, value = next (chaninfos, nil) - while (key) do - weechat.print(chan.." -> "..key.." = '"..value.."'") - key, value = next (chaninfos, key) - end - chan, chaninfos = next (chans, chan) - end - else - weechat.print("no channel") - end -else - weechat.print("error while getting channels") -end -</screen> - </para> - </section> - - <section id="secScript_get_nick_info"> - <title>get_nick_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_nick_info(server, channel); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Gibt eine Liste der Nicknamen f�r einen Channel zur�ck. - </para> - <para> - R�ckgabewert: Liste der Nicknamen eines Channels - (siehe <xref linkend="secAPI_get_nick_info" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $nicks = weechat::get_nick_info("freenode", "#weechat"); -if ($nicks) -{ - while (my ($nickname, $nickinfos) = each %$nicks) - { - while ( my ($key, $value) = each %$nickinfos) - { - weechat::print("$nickname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no nick"); -} - -# python -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks != None: - if nicks == {}: - weechat.prnt("no nick") - else: - for n in nicks: - for f in nicks[n]: - weechat.prnt("%s -> %s = '%s'" % (n, f, str(nicks[n][f]))) -else: - weechat.prnt("error while getting nicks") - -# ruby -nicks = Weechat.get_nick_info("freenode", "#weechat") -if nicks != nil - if nicks == {} - Weechat.print("no nick") - else - nicks.each do |nk, nattr| - nattr.each do |key, value| - Weechat.print("#{nk} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting nicks") -end - --- lua -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks ~= nil then - if nicks then - nick, nickinfos = next (nicks, nil) - while (nick) do - key, value = next (nickinfos, nil) - while (key) do - weechat.print(nick.." -> "..key.." = '"..value.."'") - key, value = next (nickinfos, key) - end - nick, nickinfos = next (nicks, nick) - end - else - weechat.print("no nick") - end -else - weechat.print("error while getting nicks") -end -</screen> - </para> - </section> - - <section id="secScript_get_config"> - <title>get_config</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_config(option); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_config(option) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_config(option) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_config(option) - </command> - </para> - <para> - Gibt den Wert einer Option der WeeChat-Konfiguration zur�ck. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>option</option>: Name der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Wert der Option, leerer String wenn nichts gefunden wurde. - </para> - <para> - Beispiele: -<screen> -# perl -$value1 = weechat::get_config("look_nicklist"); -$value2 = weechat::get_config("freenode.server_autojoin"); - -# python -value1 = weechat.get_config("look_nicklist") -value2 = weechat.get_config("freenode.server_autojoin") - -# ruby -value1 = Weechat.get_config("look_nicklist") -value2 = Weechat.get_config("freenode.server_autojoin") - --- lua -value1 = weechat.get_config("look_nicklist") -value2 = weechat.get_config("freenode.server_autojoin") -</screen> - </para> - </section> - - <section id="secScript_set_config"> - <title>set_config</title> - - <para> - Perl-Prototyp: - <command> - weechat::set_config(option, value); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.set_config(option, value) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.set_config(option, value) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.set_config(option, value) - </command> - </para> - <para> - Setze den Wert einer Option der WeeChat-Konfiguration. - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>option</option>: Name der Option, die gesetzt werden soll - </para> - </listitem> - <listitem> - <para> - <option>value</option>: neuer Wert der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn der Wert gesetzt wurde, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::set_config("look_nicklist", "off"); -weechat::set_config("freenode.server_autojoin", "#weechat"); - -# python -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") - -# ruby -Weechat.set_config("look_nicklist", "off") -Weechat.set_config("freenode.server_autojoin", "#weechat") - --- lua -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") -</screen> - </para> - </section> - - <section id="secScript_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_plugin_config(option); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_plugin_config(option) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Gibt den Wert einer Option eines Plugins zur�ck. Die Option wird aus - der Datei "<literal>~/.weechat/plugins.rc</literal>" gelesen und - sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: Der Name des Plugins wird automatisch gesetzt). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>option</option>: Name der zu lesenden Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: Wert der Option, leerer String wenn die Option nicht - gefunden wurde. - </para> - <para> - Beispiele: -<screen> -# perl -$value = weechat::get_plugin_config("my_var"); - -# python -value = weechat.get_plugin_config("my_var") - -# ruby -value = Weechat.get_plugin_config("my_var") - --- lua -value = weechat.get_plugin_config("my_var") -</screen> - </para> - </section> - - <section id="secScript_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Perl-Prototyp: - <command> - weechat::set_plugin_config(option, value); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Setzt den Wert einer Option eines Plugins. Die Option bzw. ihr Wert - wird in "<literal>~/.weechat/plugins.rc</literal>" geschrieben und - sieht so aus: "<literal>plugin.option=value</literal>" - (Hinweis: der Name des Plugins wird automatisch gesetzt). - </para> - <para> - Argumente: - <itemizedlist> - <listitem> - <para> - <option>option</option>: Name der Option, die gesetzt werden soll - </para> - </listitem> - <listitem> - <para> - <option>value</option>: Der neue Wert der Option - </para> - </listitem> - </itemizedlist> - </para> - <para> - R�ckgabewert: 1 wenn die Option gesetzt wurde, 0 wenn ein Fehler aufgetreten ist. - </para> - <para> - Beispiele: -<screen> -# perl -weechat::set_plugin_config("my_var", "value"); - -# python -weechat.set_plugin_config("my_var", "value") - -# ruby -Weechat.set_plugin_config("my_var", "value") - --- lua -weechat.set_plugin_config("my_var", "value") -</screen> - </para> - </section> - - <section id="secScript_get_irc_color"> - <title>get_irc_color</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_irc_color(color); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_irc_color(color) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Hole IRC-Farbindex mit dem Farbnamen. - </para> - <para> - R�ckgabewert: IRC-Farbindex, -1 wenn die Farbe nicht gefunden wurde - (siehe <xref linkend="secAPI_get_irc_color" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $color_blue = weechat::get_irc_color("blue"); - -# python -color_blue = weechat.get_irc_color("blue") - -# ruby -color_blue = Weechat.get_irc_color("blue") - --- lua -color_blue = weechat.get_irc_color("blue") -</screen> - </para> - </section> - - <section id="secScript_input_color"> - <title>input_color</title> - - <para> - Perl-Prototyp: - <command> - weechat::input_color(color); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.input_color(color) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.input_color(color) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.input_color(color) - </command> - </para> - <para> - Erzeugt einen Farbcode im Eingabepuffer.Add color in input buffer. - </para> - <para> - R�ckgabewert: keiner. - </para> - <para> - Bespiele: -<screen> -# perl -weechat::input_color(weechat::get_irc_color("blue"), 10, 5); - -# python -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) - -# ruby -Weechat.input_color(Weechat.get_irc_color("blue"), 10, 5) - --- lua -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) -</screen> - </para> - </section> - - <section id="secScript_get_window_info"> - <title>get_window_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_window_info(); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_window_info() - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_window_info() - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_window_info() - </command> - </para> - <para> - Gibt die Liste der WeeChat-Fenster zur�ck. - </para> - <para> - R�ckgabewert: List der WeeChat-Fenster - (see <xref linkend="secAPI_get_window_info" />). - </para> - <para> - Besipiele: -<screen> -# perl -my @wf = weechat::get_window_info(); -if (@wf) -{ - weechat::print("**** Fenster-Informationen ****"); - foreach my $w (@wf) - { - while ( my ($key, $value) = each %$w) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** Keine Fenster-Informationen ****"); -} - -# python -wf = weechat.get_window_info() -if wf != None and wf != []: - weechat.prnt ("**** Fenster-Informationen ****") - for w in wf: - for i in w: - weechat.prnt (" > %s => %s" % (i, w[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** Keine Fenster-Informationen ****") - -# ruby -wf = Weechat.get_window_info() -if wf != nil and wf != [] - Weechat.print("**** Fenster-Informationen ****") - wf.each do |w| - w.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** Keine Fenster-Informationen ****") -end - --- lua -wf = weechat.get_window_info() -if wf then - weechat.print ("**** Fenster-Informationen ****") - w, winfos = next (wf, nil) - while (w) do - key, value = next (winfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (winfos, key) - end - weechat.print ("----------------------") - w, winfos = next (wf, w) - end -else - weechat.print("**** Keine Fenster-Informationen ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_buffer_info(); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_buffer_info() - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Gibt eine Liste der WeeChat-Puffer. - </para> - <para> - R�ckgabewert: Liste der WeeChat-Puffer - (siehe <xref linkend="secAPI_get_buffer_info" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $bf = weechat::get_buffer_info(); -if ($bf) -{ - while ( my ($nobuf, $binfos) = each %$bf) - { - while ( my ($key, $value) = each %$binfos) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** keine Pufferinformationen ****"); -} - -# python -bf = weechat.get_buffer_info() -if bf != None and bf != {}: - for b in bf: - weechat.prnt ("**** Informationen f�r Puffer Nr. %d ****" % b) - for c in bf[b]: - weechat.prnt (" > %s => %s" % (c, bf[b][c])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** keine Pufferinformationen ****") - -# ruby -bf = Weechat.get_buffer_info() -if bf != nil and bf != {} - bf.each do |n, c| - Weechat.print("**** Informationen f�r Puffer Nr. #{n} ****") - c.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** keine Pufferinformationen ****") -end - --- lua -bf = weechat.get_buffer_info() -if bf then - b, binfos = next (bf, nil) - while (b) do - weechat.print("**** Informationen f�r Puffer Nr. " .. b .. " ****") - key, value = next (binfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (binfos, key) - end - weechat.print ("----------------------") - b, infos = next (bf, b) - end -else - weechat.print("**** keine Pufferinformationen ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Perl-Prototyp: - <command> - weechat::get_buffer_data(server, channel); - </command> - </para> - <para> - Python-Prototyp: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Ruby-Prototyp: - <command> - Weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Lua-Prototyp: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Gibt den Inhalt eines Puffers zur�ck. - </para> - <para> - R�ckgabewert: Liste der Pufferzeilen - (see <xref linkend="secAPI_get_buffer_data" />). - </para> - <para> - Beispiele: -<screen> -# perl -my $server = weechat::get_info("server"); -my $channel = weechat::get_info("channel"); -my @bc = weechat::get_buffer_data($server, $channel); -if (@bc) -{ - weechat::print("**** Pufferdaten f�r '$channel'\@'$server' ****"); - foreach my $l (@bc) { - while ( my ($key, $value) = each %$l) { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** keine Pufferdaten ****"); -} - -# python -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc != None and bc != []: - weechat.prnt ("**** Pufferdaten f�r '%s'@'%s' ****" % (channel, server)) - for l in bc: - for i in l: - weechat.prnt (" > %s => %s" % (i, l[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** keine Pufferdaten ****") - -# ruby -server = Weechat.get_info("server") -channel = Weechat.get_info("channel") -bc = Weechat.get_buffer_data(server, channel) -if bc != nil and bc != [] - Weechat.print("**** Pufferdaten f�r '#{channel}'@'#{server}' ****") - bc.each do |l| - l.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** keine Pufferdaten ****") -end - --- lua -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc then - b, bdatas = next (bc, nil) - weechat.print("**** Pufferdaten f�r '" .. channel .. "'@'" .. server .. "' ****") - while (b) do - key, value = next (bdatas, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (bdatas, key) - end - weechat.print ("----------------------") - b, bdatas = next (bc, b) - end -else - weechat.print("**** keine Pufferdaten ****") -end -</screen> - </para> - </section> - - </section> - - </section> - - </chapter> - - <!-- ======================== Auteurs / Support ========================= --> - - <chapter id="chapAuthorsSupport"> - <title>Autoren / Support</title> - - <para> - Dieses Kapitel listet Autoren und Beitragende f�r WeeChat auf, und - zeigt die M�glichkeiten um Support zu bekommen. - </para> - - <section id="secAuthors"> - <title>Autoren</title> - - <para> - WeeChat wird entwickelt von: - <itemizedlist> - <listitem> - <para> - <emphasis>FlashCode (S�bastien Helleu)</emphasis> - <email>flashcode AT flashtux.org</email> - - Hauptentwickler - </para> - </listitem> - <listitem> - <para> - <emphasis>kolter (Emmanuel Bouthenot)</emphasis> - <email>kolter AT openics.org</email> - - Entwickler - </para> - </listitem> - <listitem> - <para> - <emphasis>Ptitlouis</emphasis> - <email>ptitlouis AT sysif.net</email> - - erzeugt Debian-Pakete - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secContributors"> - <title>Beitragende</title> - - <para> - Die folgenden Personen trugen zur Entwicklung von WeeChat bei: - <itemizedlist> - <listitem> - <para> - <emphasis>Jiri Golembiovsky</emphasis> - - Tschechische �bersetzung, Patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Rudolf Polzer</emphasis> - - Patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Jim Ramsay</emphasis> - - Patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Odin</emphasis> - - SuSE RPM - </para> - </listitem> - <listitem> - <para> - <emphasis>Pistos</emphasis> - - Patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Gwenn</emphasis> - - Patches - </para> - </listitem> - <listitem> - <para> - <emphasis>voroskoi</emphasis> - - Ungarische �bersetzung - </para> - </listitem> - <listitem> - <para> - <emphasis>Frank Zacharias</emphasis> - - Deutsche �bersetzung - </para> - </listitem> - <listitem> - <para> - <emphasis>Pavel Shevchuk</emphasis> - - Russisch �bersetzung - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSupport"> - <title>Support bekommen</title> - - <para> - Bevor Sie nach Support fragen, sollten Sie die Dokumentation und die FAQ - gelesen haben, die bei WeeChat angeboten wird. (Die Dokumentation - ist dieses Dokument, wenn Sie sie nicht bis zu dieser Zeile gelesen - haben, sollten Sie sie noch Mal lesen!) - </para> - - <para> - <itemizedlist> - <listitem> - <para> - IRC: Server "<literal>irc.freenode.net</literal>", - Channel "<literal>#weechat</literal>" - </para> - </listitem> - <listitem> - <para> - WeeChat Forum: - <ulink url="http://forums.flashtux.org"> - http://forums.flashtux.org - </ulink> - </para> - </listitem> - <listitem> - <para> - Mailingliste: - <itemizedlist> - <listitem> - <para> - Zum abonnieren: - <ulink url="http://mail.nongnu.org/mailman/listinfo/weechat-support"> - http://mail.nongnu.org/mailman/listinfo/weechat-support - </ulink> - </para> - </listitem> - <listitem> - <para> - Um eine Mail an die Liste zu senden: - <email>weechat-support@nongnu.org</email> - </para> - </listitem> - </itemizedlist> - Das Archiv der Mailingliste ist hier: - <ulink url="http://mail.nongnu.org/archive/html/weechat-support"> - http://mail.nongnu.org/archive/html/weechat-support - </ulink> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </chapter> - -</book> diff --git a/weechat/doc/de/weechat_commands.xml b/weechat/doc/de/weechat_commands.xml deleted file mode 100644 index 7ee732d63..000000000 --- a/weechat/doc/de/weechat_commands.xml +++ /dev/null @@ -1,278 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>alias [Aliasname [Befehl [Argumente]]]</command> -<programlisting> -einen Alias f�r einen Befehl anlegen - -Aliasname: Name des Alias - Befehl: Befehlsname (WeeChat- oder IRC-Befehl ohne f�hrenden '/', mehrere Befehle k�nnen durch Semikola getrennt werden) -Argumente: Argumente f�r den Befehl - -</programlisting> -<command>wird durch alle Argumente ersetzt.</command> -<programlisting>Die Variablen $nick, $channel and $server werden durch den aktuellen Nick/Channel oder Server ersetzt. - -</programlisting> -<command>buffer [Aktion [Argumente] | Nummer | [[Server] [Channel]]]</command> -<programlisting> -Puffer verwalten - - action: action to do: - move: move buffer in the list (may be relative, for example -1) - close: close buffer (optional arg is part message, for a channel) - list: list open buffers (no parameter implies this list) - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part) - (when executed on server buffer, this sets default notify level for whole server) - scroll: scroll in history (may be relative, and may end by a letter: s=sec, m=min, h=hour, d=day, M=month, y=year); if there is only letter, then scroll to beginning of this item - - number: jump to buffer by number -server, -channel: jump to buffer by server and/or channel name - -Examples: - move buffer: /buffer move 5 - close buffer: /buffer close this is part msg - set notify: /buffer notify 2 - scroll 1 day up: /buffer scroll 1d == /buffer scroll -1d == /buffer scroll -24h -scroll to beginning - of this day: /buffer scroll d - scroll 15 min down: /buffer scroll +15m - scroll 20 msgs up: /buffer scroll -20 - jump to #weechat: /buffer #weechat - -</programlisting> -<command>builtin Befehl</command> -<programlisting> -starte eingebauten WeeChat/IRC-Befehl (ohne Plugin-Handler oder Aliase) - -Befehl: auszuf�hrender Befehl (falls nicht vorhanden wird automatisch ein '/' vorangestellt) - - -</programlisting> -<command>clear [-all | number [number ...]]</command> -<programlisting> -Fenster leeren - - -all: l�sche alle Puffer -Nummer: l�sche den Puffer mit der angegebenen Nummer - -</programlisting> -<command>connect [-all [-nojoin] | servername [servername ...] [-nojoin] | hostname [-port port] [-ipv6] [-ssl]]</command> -<programlisting> -mit Server verbinden - - -all: connect to all servers -servername: internal server name to connect - -nojoin: do not join any channel (even if autojoin is enabled on server) - hostname: hostname to connect, creating temporary server - port: port for server (integer, default is 6667) - ipv6: use IPv6 protocol - ssl: use SSL protocol - -</programlisting> -<command>disconnect [-all | Servername [Servername ...]]</command> -<programlisting> -Serververbindung(en) trennen - - -all: Trenne von allen Servern -servername: Servername, von dem getrennt werden soll - -</programlisting> -<command>dcc Aktion [Nickname [Datei]]</command> -<programlisting> -DCC (Filetransfer oder Chat) starten oder Chat beenden - - Aktion: 'send' (Datei) oder 'chat' oder 'close' (Chat) -Nickname: Empf�nger der Datei bzw. Chatpartner - Datei: zu versendende (lokal vorliegende) Datei - -</programlisting> -<command>debug dump | windows</command> -<programlisting> -Debugging-Nachricht ausgeben - -dump: Speicherabbild im WeeChat-Logfile ablegen (wie nach einem Programmabsturz) -windows: zeigt Fensterdaten an - -</programlisting> -<command>help [Befehl]</command> -<programlisting> -Hilfe zu Befehlen abfragen - -Befehl: Name eines WeeChat- oder IRC-Befehls - -</programlisting> -<command>history [clear | Anzahl]</command> -<programlisting> -zeigt Befehlsverlauf des Puffers - -clear: L�scht Verlauf -Anzahl: zeigt die gew�nschte Anzahl an Verlaufseintr�gen - -</programlisting> -<command>ignore [Maske [[Typ | Befehl] [Channel [Server]]]]</command> -<programlisting> -IRC-Nachrichten und/oder Hosts ignorieren - - Nummer: Nummer des zu entfernenden Eintrags (siehe Liste) - Maske: Nickname oder Hostmaske, die ignoriert werden soll - Typ: Typ der Nachrichten, die ignoriert werden sollen (action, ctcp, dcc, pv) -Befehl: IRC-Befehl - Channel: Channel, in dem ignoriert werden soll - Server: Server, auf dem ignoriert werden soll - -Bei jedem Argument steht '*' f�r 'alle'. -Ohne Argumente listet /ignore alle definierten /ignore-Regeln auf. - -</programlisting> -<command>key [Taste [Funktion/Befehl]] [unbind Taste] [functions] [call Funktion ["Argumente"]] [reset -yes] </command> -<programlisting> -belegen/freigeben von Tasten - - Taste: diese Taste anzeigen oder mit einer internen Funktion oder einem Befehl, beginnend mit "/", belegen - unbind: Tastenbelegung aufheben -functions: interne Funktionen f�r Tastenbelegungen auflisten - call: rufe eine Funktion �ber ihren Namen auf (mit optionalen Argumenten) - reset: Standardbelegung wiederherstellen und entferne ALLE eigenen Belegungen (Vorsicht!) - -</programlisting> -<command>plugin [list [Name]] | [listfull [Name]] | [load Dateiname] | [autoload] | [reload [Name]] | [unload [Name]]</command> -<programlisting> -auflisten/laden/entladen von Plugins - - list: geladene Plugins auflisten -listfull: geladene Plugins mit Details f�r jedes Plugin auflisten - load: lade ein Plugin -autoload: lade automatisch alle Plugins im System- oder Benutzerverzeichnis - reload: lade ein Plugin erneut (wenn kein Name vorgegeben ist, werden alle Plugins entladen und autolade die Plugins) - unload: entlade eines oder alle Plugins - -Ohne Argument, listet /plugin alle geladenen Plugins auf. - -</programlisting> -<command>reconnect [-all [-nojoin] | servername [servername ...] [-nojoin]]</command> -<programlisting> -mit einem Server oder mehreren Servern neu verbinden - - -all: reconnect to all servers -servername: server name to reconnect - -nojoin: do not join any channel (even if autojoin is enabled on server) - -</programlisting> -<command>save [Datei]</command> -<programlisting> -Konfiguration abspeichern - -Datei: Name der zu speichernden Konfigurationsdatei - -</programlisting> -<command>server [list [servername]] | [listfull [servername]] | [servername] | [add servername hostname [-port port] [-temp] [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [copy server newservername] [rename servername newservername] | [keep servername] [del servername]</command> -<programlisting> -Auflisten, Hinzuf�gen oder Entfernen von Servern - - list: list servers (no parameter implies this list) - listfull: list servers with detailed info for each server - add: create a new server -servername: server name, for internal and display use - hostname: name or IP address of server - port: port for server (integer, default is 6667) - temp: create temporary server (not saved in config file) - auto: automatically connect to server when WeeChat starts - noauto: do not connect to server when WeeChat starts (default) - ipv6: use IPv6 protocol - ssl: use SSL protocol - password: password for server - nick1: first nick for server - nick2: alternate nick for server - nick3: second alternate nick for server - username: user name - realname: real name of user - copy: duplicate a server - rename: rename a server - keep: keep server in config file (for temporary servers only) - del: delete a server - -</programlisting> -<command>set [Option [ = Wert]]</command> -<programlisting> -Konfigurationsparameter setzen - -Option: Name einer Option (wenn der Name vorhanden ist, aber kein Wert, dann wird eine Hilfe zur Option ausgegeben - Wert: Wert der Option - -Option kann Servername.server_xxx lauten, wobei "Servername" der interne Servername ist und "xxx" eine Option f�r diesen Server. - -</programlisting> -<command>setp [Option [ = Wert]]</command> -<programlisting> -Konfigurationsparameter f�r Plugin setzen - -Option: Name einer Plugin-Option - Wert: Wert f�r Option - -Option wird wie folgt formatiert: Plugin.Option, z.B. perl.myscript.item1 - -</programlisting> -<command>unalias Aliasname</command> -<programlisting> -einen Alias entfernen - -Aliasname: Name des zu l�schenden Aliases - -</programlisting> -<command>unignore [Nummer | [Maske [[Typ | Befehl] [Channel [Server]]]]</command> -<programlisting> -/ignore-Regel entfernen - - Nummer: Nummer des zu entfernenden Eintrags (siehe Liste) - Maske: Nickname oder Hostmaske, die ignoriert werden soll - Typ: Typ der Nachrichten, die ignoriert werden sollen (action, ctcp, dcc, pv) -Befehl: IRC-Befehl - Channel: Channel, in dem ignoriert werden soll - Server: Server, auf dem ignoriert werden soll - -Bei jedem Argument steht '*' f�r 'alle'. -Ohne Argumente listet /unignore alle definierten /ignore-Regeln auf. - -</programlisting> -<command>upgrade [path_to_binary]</command> -<programlisting> -aktualisiert WeeChat ohne die Verbindung zum Server zu trennen - -path_to_binary: path to WeeChat binary (default is current binary) - -This command run again a WeeChat binary, so it should have been compiled or installed with a package manager before running this command. - -</programlisting> -<command>uptime [-o]</command> -<programlisting> -zeigt die Uptime von Weechat an - --o: sendet die Weechat-Uptime als IRC-Nachricht in den aktuellen Channel - -</programlisting> -<command>window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]]</command> -<programlisting> -Fenster verwalten - - list: listet die ge�ffneten Fenster (Default, kann auch weggelassen werden) - -1: springt zum vorherigen Fenster - +1: springt zum n�chsten Fenster - b#: springt zum n�chsten Fenster, dass Puffer Nummer # anzeigt - up: wechselt zum Fenster �ber dem aktuellen - down: wechselt zum Fenster unter dem aktuellen - left: wechselt zum linken Fenster - right: wechselt zum rechten Fenster -splith: teilt das aktuelle Fenster horizontal -splitv: teilt das aktuelle Fenster vertikal -resize: ver�ndert die Gr��e des aktuellen Fensters, die neue Gr��e ist <pct> Prozent des Elternfensters gro� - merge: vereinigt Fenster miteinander (all = alle Fenster vereinigen) - -Bei splith und splitv gibt pct die neue Gr��e des Fensters im verh�ltnis zur aktuellen Gr��e an. Zum Beispiel w�rde 25 bedeuten, dass das neue Fenster nur noch ein Viertel der Gr��e des alten Fensters h�tte. - -</programlisting> diff --git a/weechat/doc/de/weechat_quickstart.de.txt b/weechat/doc/de/weechat_quickstart.de.txt deleted file mode 100644 index 8ae0f7241..000000000 --- a/weechat/doc/de/weechat_quickstart.de.txt +++ /dev/null @@ -1,109 +0,0 @@ -WeeChat Schnellstarter (deutsche Version) -====================== - -1. Weechat starten - - Entsprechend dem gew�hlten User-Interface m�ssen Du starten: - - weechat-curses f�r das Curses GUI - - weechat-gtk f�r das Gtk GUI (in Entwicklung) - - weechat-qt f�r das Qt GUI (in Planung) - - weechat-wxwidgets f�r das WxWidgets GUI (in Planung) - -2. Online-Hilfe / Optionen - - WeeChat hat eine eingebaute Hilfe f�r all Kommandos, tippe einfach /help - Um Hilfe zu einem Kommando zu bekommen, tippe /help Kommando - - Um Optionen zu ver�ndern, benutzt du /set Option = Wert - Du brauchst /set Option nur mit den Anfangsbuchstaben eingeben - (<tab> zeigt alle Optionen mit den gleichen Buchstaben) oder mit dem vollen - Namen ohne einen Wert, um eine ausf�hrliche Hilfe zu bekommen. - - Wichtig: die Einstellungen werden gespeichert, wenn WeeChat beendet wird - (oder mit dem Befehl /save). Ver�ndere die Einstellungen nicht, wenn WeeChat - l�uft, weil WeeChat diese Datei zu jeder Zeit �berschreiben kann und - �nderungen verloren sind. Um irgendeine Einstellung zu ver�ndern, verwendest du - das /set Kommando, WeeChat wird die neuen Einstellungen umgehend �bernehmen. - -3. Einen Server-Eintrag anlegen - - Zum Beispiel f�r irc.quakenet.org, Port 6667: - /server quakenet irc.quakenet.org 6667 - (/help Server f�r volle Hilfe zu diesem Kommando) - -4. Eigene Server-Optionen setzen - - Nickname: - /set quakenet.server_nick1 = "mynick" - /set quakenet.server_nick2 = "mynick2" - /set quakenet.server_nick3 = "mynick3" - - Username/Klarname: - /set quakenet.server_username = "My username" - /set quakenet.server_realname = "My real name" - - Automatische Server-Verbindung: - /set quakenet.server_autoconnect = on - - Automatisches Betreten eines Channels: - /set quakenet.server_autojoin = "#chan1,#chan2" - - Andere Optionen: - Du kannst die Server-Optionen und ihre Werte mit /set quakenet sehen - Um eine Option zu setzen, tippe /set quakenet.option = Wert - -5. Verbinden zu einem Server und automatisch einen Channel betreten - - /connect quakenet - -6. Channels betreten/verlassen - - Einen Channel betreten: - /join #channel - Einen Channel verlassen: - /part [Nachricht] - Einen Channel verlassen und den Buffer schliessen: - /close [Nachricht] - (/close ist ein Alias f�r /buffer close) - -7. Buffer/Fenster Management - - Du kannst die einzelnen Buffer mit /buffer und Fenster mit /window - verwalten. - Um zum Beispiel das Fenster in ein kleineres (1/3 breit) und ein - grosses (2/3 breit) zu teilen, nutzt du das folgende Kommando: - /window splitv 33 - -8. Tastenkombinationen - - Entsprechend deiner Tastatur und/oder deinen W�nschen, kannst du jede Taste - mit "/key" neu zuordnen. - Eine n�tzliche Taste ist meta-k (alt-k), sie zeigt die Tastaturcodes an. - - Um zum Beispiel meta-y (alt-y) dem Kommando "/buffer close" zuzuordnen: - /key (tippe meta-k) (tippe meta-y) /buffer close - Und du bekommst damit die Kommandozeile: - /key meta-y /buffer close - -9. Plugins/Skripte - - In einigen Distributionen, wie zum Beispiel Debian, sind Plugins in separaten - Paketen verf�gbar (wie weechat-plugins). Plugins werden automatisch geladen, - wenn welche gefunden wurden. - Viele Plugins/Skripte f�r WeeChat sind zu finden auf: - http://weechat.flashtux.org/plugins.php - Bitte lies f�r das Laden/Entladen von Plugins oder Skripten die Dokumentation. - - -10. Mehr Dokumentation - - Jetzt kannst du WeeChat starten und die FAQ/Dokumentation lesen, falls du weitere - Fragen hast: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Viel Spass mit WeeChat! - --- -(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org> -This document is part of WeeChat and is distributed under GPL licence. diff --git a/weechat/doc/en/Makefile.am b/weechat/doc/en/Makefile.am deleted file mode 100644 index 955047680..000000000 --- a/weechat/doc/en/Makefile.am +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = en -BOOK = weechat.$(LANGCODE) -BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART) - -if DBLATEX_FOUND -PDF = pdf-stamp -endif - -docdir = $(datadir)/doc/$(PACKAGE) - -all-local: html-stamp $(PDF) - -# HTML output with chunks (many pages) - -html: html-stamp - -html-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html/ - xsltproc -o html/ ../weechat-html.xsl $(BOOK).xml || true - cp ../weechat-doc.css html/ - touch html-stamp - -# HTML output, all in one page - -html1: html1-stamp - -html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html1/ - xsltproc -o html1/$(BOOK).html ../weechat-html-one.xsl $(BOOK).xml || true - cp ../weechat-doc.css html1/ - touch html1-stamp - -# PDF output - -pdf: pdf-stamp - -pdf-stamp: $(BOOK).xml $(BOOK_INCLUDE) - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - dblatex -c ../dblatex.conf $(BOOK).xml || true - touch pdf-stamp - -# install docs - -install-data-hook: - $(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ -if DBLATEX_FOUND - $(INSTALL_DATA) $(BOOK).pdf $(DESTDIR)$(docdir)/ -endif - -# clean - -clean-local: - -rm -f $(BOOK).html $(BOOK).pdf $(BOOK).txt date.xml - -rm -rf html/ html1/ - -rm -f html-stamp html1-stamp pdf-stamp diff --git a/weechat/doc/en/config.xml b/weechat/doc/en/config.xml deleted file mode 100644 index 4d062a077..000000000 --- a/weechat/doc/en/config.xml +++ /dev/null @@ -1,1281 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><option>look_save_on_exit</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Save config file on exit</entry> -</row> -<row> - <entry><option>look_set_title</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Set title for window (terminal for Curses GUI) with name and version</entry> -</row> -<row> - <entry><option>look_startup_logo</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display WeeChat logo at startup</entry> -</row> -<row> - <entry><option>look_startup_version</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display WeeChat version at startup</entry> -</row> -<row> - <entry><option>look_weechat_slogan</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'the geekest IRC client!'</entry> - <entry>WeeChat slogan (if empty, slogan is not used)</entry> -</row> -<row> - <entry><option>look_one_server_buffer</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Use same buffer for all servers</entry> -</row> -<row> - <entry><option>look_open_near_server</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Open new channels/privates near server</entry> -</row> -<row> - <entry><option>look_scroll_amount</option></entry> - <entry>integer</entry> - <entry>between 1 and 2147483647</entry> - <entry>3</entry> - <entry>How many lines to scroll by with scroll_up and scroll_down</entry> -</row> -<row> - <entry><option>look_buffer_timestamp</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'[%H:%M:%S]'</entry> - <entry>Timestamp for buffers</entry> -</row> -<row> - <entry><option>look_color_nicks_number</option></entry> - <entry>integer</entry> - <entry>between 1 and 10</entry> - <entry>10</entry> - <entry>Number of colors to use for nicks colors</entry> -</row> -<row> - <entry><option>look_color_actions</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display actions with different colors</entry> -</row> -<row> - <entry><option>look_nicklist</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display nicklist window (for channel windows)</entry> -</row> -<row> - <entry><option>look_nicklist_position</option></entry> - <entry>string</entry> - <entry>'left', 'right', 'top', 'bottom'</entry> - <entry>'right'</entry> - <entry>Nicklist position (top, left, right (default), bottom)</entry> -</row> -<row> - <entry><option>look_nicklist_min_size</option></entry> - <entry>integer</entry> - <entry>between 0 and 100</entry> - <entry>0</entry> - <entry>Min size for nicklist (width or height, depending on look_nicklist_position (0 = no min size))</entry> -</row> -<row> - <entry><option>look_nicklist_max_size</option></entry> - <entry>integer</entry> - <entry>between 0 and 100</entry> - <entry>0</entry> - <entry>Max size for nicklist (width or height, depending on look_nicklist_position (0 = no max size; if min = max and > 0, then size is fixed))</entry> -</row> -<row> - <entry><option>look_nicklist_separator</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Separator between chat and nicklist</entry> -</row> -<row> - <entry><option>look_no_nickname</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'-cmd-'</entry> - <entry>Text to display instead of nick when not connected</entry> -</row> -<row> - <entry><option>look_nickmode</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display nick mode ((half)op/voice) before each nick</entry> -</row> -<row> - <entry><option>look_nickmode_empty</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Display space if nick mode is not (half)op/voice</entry> -</row> -<row> - <entry><option>look_nick_prefix</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Text to display before nick in chat window</entry> -</row> -<row> - <entry><option>look_nick_suffix</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>' |'</entry> - <entry>Text to display after nick in chat window</entry> -</row> -<row> - <entry><option>look_align_nick</option></entry> - <entry>string</entry> - <entry>'none', 'left', 'right'</entry> - <entry>'right'</entry> - <entry>Nick alignment (fixed size for nicks in chat window (none, left, right))</entry> -</row> -<row> - <entry><option>look_align_other</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Alignment for other messages (not beginning with a nick)</entry> -</row> -<row> - <entry><option>look_align_size</option></entry> - <entry>integer</entry> - <entry>between 8 and 64</entry> - <entry>14</entry> - <entry>Size for aligning nick and other messages</entry> -</row> -<row> - <entry><option>look_align_size_max</option></entry> - <entry>integer</entry> - <entry>between 8 and 64</entry> - <entry>20</entry> - <entry>Max size for aligning nick and other messages (should be >= to look_align_size)</entry> -</row> -<row> - <entry><option>look_nick_completor</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>':'</entry> - <entry>The string inserted after nick completion</entry> -</row> -<row> - <entry><option>look_nick_completion_ignore</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'[]-^'</entry> - <entry>Chars ignored for nick completion</entry> -</row> -<row> - <entry><option>look_nick_completion_smart</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Smart completion for nicks (completes with last speakers first)</entry> -</row> -<row> - <entry><option>look_nick_complete_first</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Complete only with first nick found</entry> -</row> -<row> - <entry><option>look_infobar</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Enable info bar</entry> -</row> -<row> - <entry><option>look_infobar_timestamp</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%B, %A %d %Y'</entry> - <entry>Timestamp for time in infobar</entry> -</row> -<row> - <entry><option>look_infobar_seconds</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display seconds in infobar time</entry> -</row> -<row> - <entry><option>look_infobar_delay_highlight</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>7</entry> - <entry>Delay (in seconds) for highlight messages in infobar (0 = disable highlight notifications in infobar)</entry> -</row> -<row> - <entry><option>look_hotlist_names_count</option></entry> - <entry>integer</entry> - <entry>between 0 and 32</entry> - <entry>3</entry> - <entry>Max number of names in hotlist (0 = no name displayed, only buffer numbers)</entry> -</row> -<row> - <entry><option>look_hotlist_names_level</option></entry> - <entry>integer</entry> - <entry>between 1 and 15</entry> - <entry>12</entry> - <entry>Level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)</entry> -</row> -<row> - <entry><option>look_hotlist_names_length</option></entry> - <entry>integer</entry> - <entry>between 0 and 32</entry> - <entry>0</entry> - <entry>Max length of names in hotlist (0 = no limit)</entry> -</row> -<row> - <entry><option>look_hotlist_sort</option></entry> - <entry>string</entry> - <entry>'group_time_asc', 'group_time_desc', 'group_number_asc', 'group_number_desc', 'number_asc', 'number_desc'</entry> - <entry>'group_time_asc'</entry> - <entry>Hotlist sort type (group_time_asc (default), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)</entry> -</row> -<row> - <entry><option>look_day_change</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Display special message when day changes</entry> -</row> -<row> - <entry><option>look_day_change_timestamp</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%a, %d %b %Y'</entry> - <entry>Timestamp for date displayed when day changed</entry> -</row> -<row> - <entry><option>look_read_marker</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>' '</entry> - <entry>Use a marker on servers/channels to show first unread line</entry> -</row> -<row> - <entry><option>look_input_format</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'[%n(%m)] '</entry> - <entry>Format for input prompt ('%c' is replaced by channel or server, '%n' by nick and '%m' by nick modes)</entry> -</row> -<row> - <entry><option>look_paste_max_lines</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>3</entry> - <entry>Max number of lines for paste without asking user (0 = disable this feature)</entry> -</row> -<row> - <entry><option>col_real_white</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>If set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)</entry> -</row> -<row> - <entry><option>col_separator</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Color for window separators (when splited)</entry> -</row> -<row> - <entry><option>col_title</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for title bar</entry> -</row> -<row> - <entry><option>col_title_more</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightmagenta'</entry> - <entry>Color for '+' when scrolling topic</entry> -</row> -<row> - <entry><option>col_title_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Background for title bar</entry> -</row> -<row> - <entry><option>col_chat</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for chat text</entry> -</row> -<row> - <entry><option>col_chat_time</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for time in chat window</entry> -</row> -<row> - <entry><option>col_chat_time_sep</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'brown'</entry> - <entry>Color for time separator (chat window)</entry> -</row> -<row> - <entry><option>col_chat_prefix1</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightcyan'</entry> - <entry>Color for 1st and 3rd char of prefix</entry> -</row> -<row> - <entry><option>col_chat_prefix2</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for middle char of prefix</entry> -</row> -<row> - <entry><option>col_chat_server</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'brown'</entry> - <entry>Color for server name</entry> -</row> -<row> - <entry><option>col_chat_join</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for join arrow (prefix)</entry> -</row> -<row> - <entry><option>col_chat_part</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightred'</entry> - <entry>Color for part/quit arrow (prefix)</entry> -</row> -<row> - <entry><option>col_chat_nick</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightcyan'</entry> - <entry>Color for nicks in actions (chat window)</entry> -</row> -<row> - <entry><option>col_chat_host</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Color for hostnames (chat window)</entry> -</row> -<row> - <entry><option>col_chat_channel</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for channel names in actions (chat window)</entry> -</row> -<row> - <entry><option>col_chat_dark</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'green'</entry> - <entry>Color for dark separators (chat window)</entry> -</row> -<row> - <entry><option>col_chat_highlight</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'yellow'</entry> - <entry>Color for highlighted nick (chat window)</entry> -</row> -<row> - <entry><option>col_chat_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Background for chat window</entry> -</row> -<row> - <entry><option>col_chat_read_marker</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'yellow'</entry> - <entry>Color for unread data marker</entry> -</row> -<row> - <entry><option>col_chat_read_marker_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'magenta'</entry> - <entry>Background for unread data marker</entry> -</row> -<row> - <entry><option>col_status</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for status bar</entry> -</row> -<row> - <entry><option>col_status_delimiters</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Color for status bar delimiters</entry> -</row> -<row> - <entry><option>col_status_channel</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for current channel in status bar</entry> -</row> -<row> - <entry><option>col_status_data_msg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'yellow'</entry> - <entry>Color for window with new messages (status bar)</entry> -</row> -<row> - <entry><option>col_status_private</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightmagenta'</entry> - <entry>Color for window with private message (status bar)</entry> -</row> -<row> - <entry><option>col_status_highlight</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightred'</entry> - <entry>Color for window with highlight (status bar)</entry> -</row> -<row> - <entry><option>col_status_data_other</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for window with new data (not messages) (status bar)</entry> -</row> -<row> - <entry><option>col_status_more</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for window with new data (status bar)</entry> -</row> -<row> - <entry><option>col_status_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Background for status window</entry> -</row> -<row> - <entry><option>col_infobar</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'black'</entry> - <entry>Color for info bar text</entry> -</row> -<row> - <entry><option>col_infobar_delimiters</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Color for infobar delimiters</entry> -</row> -<row> - <entry><option>col_infobar_highlight</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for info bar highlight notification</entry> -</row> -<row> - <entry><option>col_infobar_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Background for info bar window</entry> -</row> -<row> - <entry><option>col_input</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for input text</entry> -</row> -<row> - <entry><option>col_input_server</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'brown'</entry> - <entry>Color for input text (server name)</entry> -</row> -<row> - <entry><option>col_input_channel</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for input text (channel name)</entry> -</row> -<row> - <entry><option>col_input_nick</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightcyan'</entry> - <entry>Color for input text (nick name)</entry> -</row> -<row> - <entry><option>col_input_delimiters</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Color for input text (delimiters)</entry> -</row> -<row> - <entry><option>col_input_text_not_found</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'red'</entry> - <entry>Color for text not found</entry> -</row> -<row> - <entry><option>col_input_actions</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for actions in input window</entry> -</row> -<row> - <entry><option>col_input_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Background for input window</entry> -</row> -<row> - <entry><option>col_nick</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for nicknames</entry> -</row> -<row> - <entry><option>col_nick_away</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Color for away nicknames</entry> -</row> -<row> - <entry><option>col_nick_chanowner</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for chan owner symbol (specific to unrealircd)</entry> -</row> -<row> - <entry><option>col_nick_chanadmin</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for chan admin symbol (specific to unrealircd)</entry> -</row> -<row> - <entry><option>col_nick_op</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for operator symbol</entry> -</row> -<row> - <entry><option>col_nick_halfop</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightmagenta'</entry> - <entry>Color for half-operator symbol</entry> -</row> -<row> - <entry><option>col_nick_voice</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'yellow'</entry> - <entry>Color for voice symbol</entry> -</row> -<row> - <entry><option>col_nick_user</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Color for user symbol</entry> -</row> -<row> - <entry><option>col_nick_more</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightmagenta'</entry> - <entry>Color for '+' when scrolling nicks</entry> -</row> -<row> - <entry><option>col_nick_sep</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Color for nick separator</entry> -</row> -<row> - <entry><option>col_nick_self</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for local nick</entry> -</row> -<row> - <entry><option>col_nick_color1</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'cyan'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color2</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'magenta'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color3</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'green'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color4</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'brown'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color5</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightblue'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color6</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color7</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightcyan'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color8</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightmagenta'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color9</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_color10</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'blue'</entry> - <entry>Color for nick</entry> -</row> -<row> - <entry><option>col_nick_private</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Color for other nick in private window</entry> -</row> -<row> - <entry><option>col_nick_bg</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'default'</entry> - <entry>Background for nicknames</entry> -</row> -<row> - <entry><option>col_chat_dcc_selected</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'white'</entry> - <entry>Color for selected DCC (chat window)</entry> -</row> -<row> - <entry><option>col_dcc_waiting</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightcyan'</entry> - <entry>Color for "waiting" dcc status</entry> -</row> -<row> - <entry><option>col_dcc_connecting</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'yellow'</entry> - <entry>Color for "connecting" dcc status</entry> -</row> -<row> - <entry><option>col_dcc_active</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightblue'</entry> - <entry>Color for "active" dcc status</entry> -</row> -<row> - <entry><option>col_dcc_done</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightgreen'</entry> - <entry>Color for "done" dcc status</entry> -</row> -<row> - <entry><option>col_dcc_failed</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightred'</entry> - <entry>Color for "failed" dcc status</entry> -</row> -<row> - <entry><option>col_dcc_aborted</option></entry> - <entry>color</entry> - <entry>Curses or Gtk color</entry> - <entry>'lightred'</entry> - <entry>Color for "aborted" dcc status</entry> -</row> -<row> - <entry><option>history_max_lines</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>4096</entry> - <entry>Maximum number of lines in history for one server/channel/private window (0 = unlimited)</entry> -</row> -<row> - <entry><option>history_max_commands</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>100</entry> - <entry>Maximum number of user commands in history (0 = unlimited)</entry> -</row> -<row> - <entry><option>history_display_default</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>5</entry> - <entry>Maximum number of commands to display by default in history listing (0 = unlimited)</entry> -</row> -<row> - <entry><option>log_auto_server</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Automatically log server messages</entry> -</row> -<row> - <entry><option>log_auto_channel</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Automatically log channel chats</entry> -</row> -<row> - <entry><option>log_auto_private</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Automatically log private chats</entry> -</row> -<row> - <entry><option>log_plugin_msg</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Log messages from plugins (scripts)</entry> -</row> -<row> - <entry><option>log_path</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%h/logs/'</entry> - <entry>Path for WeeChat log files ('%h' will be replaced by WeeChat home, ~/.weechat by default)</entry> -</row> -<row> - <entry><option>log_timestamp</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%Y %b %d %H:%M:%S'</entry> - <entry>Timestamp for log (see man strftime for date/time specifiers)</entry> -</row> -<row> - <entry><option>log_hide_nickserv_pwd</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Hide password displayed by nickserv</entry> -</row> -<row> - <entry><option>irc_display_away</option></entry> - <entry>string</entry> - <entry>'off', 'local', 'channel'</entry> - <entry>'off'</entry> - <entry>Display message when (un)marking as away</entry> -</row> -<row> - <entry><option>irc_show_away_once</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Show remote away message only once in private</entry> -</row> -<row> - <entry><option>irc_default_msg_part</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'WeeChat %v'</entry> - <entry>Default part message (leaving channel) ('%v' will be replaced by WeeChat version in string)</entry> -</row> -<row> - <entry><option>irc_default_msg_quit</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'WeeChat %v'</entry> - <entry>Default quit message ('%v' will be replaced by WeeChat version in string)</entry> -</row> -<row> - <entry><option>irc_notice_as_pv</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Display notices as private messages</entry> -</row> -<row> - <entry><option>irc_away_check</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>0</entry> - <entry>Interval between two checks for away (in minutes, 0 = never check)</entry> -</row> -<row> - <entry><option>irc_away_check_max_nicks</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>0</entry> - <entry>Do not check away nicks on channels with high number of nicks (0 = unlimited)</entry> -</row> -<row> - <entry><option>irc_lag_check</option></entry> - <entry>integer</entry> - <entry>between 30 and 2147483647</entry> - <entry>60</entry> - <entry>Interval between two checks for lag (in seconds)</entry> -</row> -<row> - <entry><option>irc_lag_min_show</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>1</entry> - <entry>Minimum lag to show (in seconds)</entry> -</row> -<row> - <entry><option>irc_lag_disconnect</option></entry> - <entry>integer</entry> - <entry>between 0 and 2147483647</entry> - <entry>5</entry> - <entry>Disconnect after important lag (in minutes, 0 = never disconnect)</entry> -</row> -<row> - <entry><option>irc_anti_flood</option></entry> - <entry>integer</entry> - <entry>between 0 and 5</entry> - <entry>2</entry> - <entry>Anti-flood: # seconds between two user messages (0 = no anti-flood)</entry> -</row> -<row> - <entry><option>irc_fifo_pipe</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Create a FIFO pipe for remote control</entry> -</row> -<row> - <entry><option>irc_highlight</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)</entry> -</row> -<row> - <entry><option>irc_colors_receive</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>When off, colors codes are ignored in incoming messages</entry> -</row> -<row> - <entry><option>irc_colors_send</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Allow user to send colors with special codes (^Cb=bold, ^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, ^Cr=reverse)</entry> -</row> -<row> - <entry><option>irc_send_unknown_commands</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Send unknown commands to IRC server</entry> -</row> -<row> - <entry><option>dcc_auto_accept_files</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Automatically accept incoming dcc files</entry> -</row> -<row> - <entry><option>dcc_auto_accept_chats</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Automatically accept dcc chats (use carefully!)</entry> -</row> -<row> - <entry><option>dcc_timeout</option></entry> - <entry>integer</entry> - <entry>between 5 and 2147483647</entry> - <entry>300</entry> - <entry>Timeout for dcc request (in seconds)</entry> -</row> -<row> - <entry><option>dcc_blocksize</option></entry> - <entry>integer</entry> - <entry>between 1024 and 102400</entry> - <entry>65536</entry> - <entry>Block size for dcc packets in bytes (default: 65536)</entry> -</row> -<row> - <entry><option>dcc_fast_send</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Does not wait for ACK when sending file</entry> -</row> -<row> - <entry><option>dcc_port_range</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Restricts outgoing dcc to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)</entry> -</row> -<row> - <entry><option>dcc_own_ip</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>IP or DNS address used for outgoing dcc (if empty, local interface IP is used)</entry> -</row> -<row> - <entry><option>dcc_download_path</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%h/dcc'</entry> - <entry>Path for writing incoming files with dcc (default: user home)</entry> -</row> -<row> - <entry><option>dcc_upload_path</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'~'</entry> - <entry>Path for reading files when sending thru dcc (when no path is specified)</entry> -</row> -<row> - <entry><option>dcc_convert_spaces</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Convert spaces to underscores when sending files</entry> -</row> -<row> - <entry><option>dcc_auto_rename</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Rename incoming files if already exists (add '.1', '.2', ...)</entry> -</row> -<row> - <entry><option>dcc_auto_resume</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Automatically resume dcc transfer if connection with remote host is loosed</entry> -</row> -<row> - <entry><option>proxy_use</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Use a proxy server to connect to irc server</entry> -</row> -<row> - <entry><option>proxy_type</option></entry> - <entry>string</entry> - <entry>'http', 'socks4', 'socks5'</entry> - <entry>'http'</entry> - <entry>Proxy type (http (default), socks4, socks5)</entry> -</row> -<row> - <entry><option>proxy_ipv6</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Connect to proxy in ipv6</entry> -</row> -<row> - <entry><option>proxy_address</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Proxy server address (IP or hostname)</entry> -</row> -<row> - <entry><option>proxy_port</option></entry> - <entry>integer</entry> - <entry>between 0 and 65535</entry> - <entry>3128</entry> - <entry>Port for connecting to proxy server</entry> -</row> -<row> - <entry><option>proxy_username</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Username for proxy server</entry> -</row> -<row> - <entry><option>proxy_password</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Password for proxy server</entry> -</row> -<row> - <entry><option>plugins_path</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'%h/plugins'</entry> - <entry>Path for searching plugins ('%h' will be replaced by WeeChat home, ~/.weechat by default)</entry> -</row> -<row> - <entry><option>plugins_autoload</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'*'</entry> - <entry>Comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "libperl.so")</entry> -</row> -<row> - <entry><option>plugins_extension</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>'.so'</entry> - <entry>Standard plugins extension in filename, used for autoload (if empty, then all files are loaded when autoload is "*")</entry> -</row> -<row> - <entry><option>server_name</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Name associated to IRC server (for display only)</entry> -</row> -<row> - <entry><option>server_autoconnect</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Automatically connect to server when WeeChat is starting</entry> -</row> -<row> - <entry><option>server_autoreconnect</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Automatically reconnect to server when disconnected</entry> -</row> -<row> - <entry><option>server_autoreconnect_delay</option></entry> - <entry>integer</entry> - <entry>between 0 and 65535</entry> - <entry>30</entry> - <entry>Delay (in seconds) before trying again to reconnect to server</entry> -</row> -<row> - <entry><option>server_address</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>IP address or hostname of IRC server</entry> -</row> -<row> - <entry><option>server_port</option></entry> - <entry>integer</entry> - <entry>between 0 and 65535</entry> - <entry>6667</entry> - <entry>Port for connecting to server</entry> -</row> -<row> - <entry><option>server_ipv6</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Use IPv6 protocol for server communication</entry> -</row> -<row> - <entry><option>server_ssl</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'off'</entry> - <entry>Use SSL for server communication</entry> -</row> -<row> - <entry><option>server_password</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Password for IRC server</entry> -</row> -<row> - <entry><option>server_nick1</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Nickname to use on IRC server</entry> -</row> -<row> - <entry><option>server_nick2</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Alternate nickname to use on IRC server (if nickname is already used)</entry> -</row> -<row> - <entry><option>server_nick3</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>2nd alternate nickname to use on IRC server (if alternate nickname is already used)</entry> -</row> -<row> - <entry><option>server_username</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>User name to use on IRC server</entry> -</row> -<row> - <entry><option>server_realname</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Real name to use on IRC server</entry> -</row> -<row> - <entry><option>server_hostname</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Custom hostname/IP for server (optional, if empty local hostname is used)</entry> -</row> -<row> - <entry><option>server_command</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Command(s) to run when connected to server (many commands should be separated by ';', use '\;' for a semicolon, special variables $nick, $channel and $server are replaced by their value)</entry> -</row> -<row> - <entry><option>server_command_delay</option></entry> - <entry>integer</entry> - <entry>between 0 and 3600</entry> - <entry>0</entry> - <entry>Delay (in seconds) after command was executed (example: give some time for authentication)</entry> -</row> -<row> - <entry><option>server_autojoin</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")</entry> -</row> -<row> - <entry><option>server_autorejoin</option></entry> - <entry>boolean</entry> - <entry>'on' or 'off'</entry> - <entry>'on'</entry> - <entry>Automatically rejoin channels when kicked</entry> -</row> -<row> - <entry><option>server_notify_levels</option></entry> - <entry>string</entry> - <entry>any string</entry> - <entry>''</entry> - <entry>Comma separated list of notify levels for channels of this server (format: #channel:1,..), a channel name '*' is reserved for server default notify level</entry> -</row> diff --git a/weechat/doc/en/irc_commands.xml b/weechat/doc/en/irc_commands.xml deleted file mode 100644 index 294c70f14..000000000 --- a/weechat/doc/en/irc_commands.xml +++ /dev/null @@ -1,443 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>admin [target]</command> -<programlisting> -find information about the administrator of the server - -target: server - -</programlisting> -<command>ame message</command> -<programlisting> -send a CTCP action to all channels of all connected servers - -message: message to send - -</programlisting> -<command>amsg text</command> -<programlisting> -send message to all channels of all connected servers - -text: text to send - -</programlisting> -<command>away [-all] [message]</command> -<programlisting> -toggle away status - - -all: toggle away status on all connected servers -message: message for away (if no message is given, away status is removed) - -</programlisting> -<command>ban [channel] [nickname [nickname ...]]</command> -<programlisting> -bans nicks or hosts - - channel: channel for ban -nickname: user or host to ban - -</programlisting> -<command>ctcp receiver type [arguments]</command> -<programlisting> -send a CTCP message (Client-To-Client Protocol) - - receiver: nick or channel to send CTCP to - type: CTCP type (examples: "version", "ping", ..) -arguments: arguments for CTCP - -</programlisting> -<command>cycle [channel[,channel]] [part_message]</command> -<programlisting> -leave and rejoin a channel - - channel: channel name for cycle -part_message: part message (displayed to other users) - -</programlisting> -<command>dehalfop [nickname [nickname]]</command> -<programlisting> -removes half channel operator status from nickname(s) - -</programlisting> -<command>deop [nickname [nickname]]</command> -<programlisting> -removes channel operator status from nickname(s) - -</programlisting> -<command>devoice [nickname [nickname]]</command> -<programlisting> -removes voice from nickname(s) - -</programlisting> -<command>die</command> -<programlisting> -shutdown the server - -</programlisting> -<command>halfop [nickname [nickname]]</command> -<programlisting> -gives half channel operator status to nickname(s) - -</programlisting> -<command>info [target]</command> -<programlisting> -get information describing the server - -target: server name - -</programlisting> -<command>invite nickname channel</command> -<programlisting> -invite a nick on a channel - -nickname: nick to invite - channel: channel to invite - -</programlisting> -<command>ison nickname [nickname ...]</command> -<programlisting> -check if a nickname is currently on IRC - -nickname: nickname - -</programlisting> -<command>join channel[,channel] [key[,key]]</command> -<programlisting> -join a channel - -channel: channel name to join - key: key to join the channel - -</programlisting> -<command>kick [channel] nickname [comment]</command> -<programlisting> -forcibly remove a user from a channel - - channel: channel where user is -nickname: nickname to kick - comment: comment for kick - -</programlisting> -<command>kickban [channel] nickname [comment]</command> -<programlisting> -kicks and bans a nick from a channel - - channel: channel where user is -nickname: nickname to kick and ban - comment: comment for kick - -</programlisting> -<command>kill nickname comment</command> -<programlisting> -close client-server connection - -nickname: nickname - comment: comment for kill - -</programlisting> -<command>links [[server] server_mask]</command> -<programlisting> -list all servernames which are known by the server answering the query - - server: this server should answer the query -server_mask: list of servers must match this mask - -</programlisting> -<command>list [channel[,channel] [server]]</command> -<programlisting> -list channels and their topic - -channel: channel to list (a regexp is allowed) -server: server name - -</programlisting> -<command>lusers [mask [target]]</command> -<programlisting> -get statistics about the size of the IRC network - - mask: servers matching the mask only -target: server for forwarding request - -</programlisting> -<command>me message</command> -<programlisting> -send a CTCP action to the current channel - -message: message to send - -</programlisting> -<command>mode { channel {[+|-]|o|p|s|i|t|n|b|v} [limit] [user] [ban mask] } | { nickname {[+|-]|i|w|s|o} }</command> -<programlisting> -change channel or user mode - -channel modes: - channel: channel name to modify - o: give/take channel operator privileges - p: private channel flag - s: secret channel flag - i: invite-only channel flag - t: topic settable by channel operator only flag - n: no messages to channel from clients on the outside - m: moderated channel - l: set the user limit to channel - b: set a ban mask to keep users out - e: set exception mask - v: give/take the ability to speak on a moderated channel - k: set a channel key (password) -user modes: - nickname: nickname to modify - i: mark a user as invisible - s: mark a user for receive server notices - w: user receives wallops - o: operator flag - -</programlisting> -<command>motd [target]</command> -<programlisting> -get the "Message Of The Day" - -target: server name - -</programlisting> -<command>msg receiver[,receiver] text</command> -<programlisting> -send message to a nick or channel - -receiver: nick or channel (may be mask, '*' = current channel) -text: text to send - -</programlisting> -<command>names [channel[,channel]]</command> -<programlisting> -list nicknames on channels - -channel: channel name - -</programlisting> -<command>nick [-all] nickname</command> -<programlisting> -change current nickname - - -all: set new nickname for all connected servers -nickname: new nickname - -</programlisting> -<command>notice nickname text</command> -<programlisting> -send notice message to user - -nickname: user to send notice to - text: text to send - -</programlisting> -<command>op nickname [nickname]</command> -<programlisting> -gives channel operator status to nickname(s) - -</programlisting> -<command>oper user password</command> -<programlisting> -get operator privileges - -user/password: used to get privileges on current IRC server - -</programlisting> -<command>part [channel[,channel]] [part_message]</command> -<programlisting> -leave a channel - - channel: channel name to leave -part_message: part message (displayed to other users) - -</programlisting> -<command>ping server1 [server2]</command> -<programlisting> -ping server - -server1: server to ping -server2: forward ping to this server - -</programlisting> -<command>pong daemon [daemon2]</command> -<programlisting> -answer to a ping message - - daemon: daemon who has responded to Ping message -daemon2: forward message to this daemon - -</programlisting> -<command>query nickname [text]</command> -<programlisting> -send a private message to a nick - -nickname: nickname for private conversation - text: text to send - -</programlisting> -<command>quit [quit_message]</command> -<programlisting> -close all connections and quit - -quit_message: quit message (displayed to other users) - -</programlisting> -<command>quote data</command> -<programlisting> -send raw data to server without parsing - -data: raw data to send - -</programlisting> -<command>rehash</command> -<programlisting> -tell the server to reload its config file - -</programlisting> -<command>restart</command> -<programlisting> -tell the server to restart itself - -</programlisting> -<command>service nickname reserved distribution type reserved info</command> -<programlisting> -register a new service - -distribution: visibility of service - type: reserved for future usage - -</programlisting> -<command>servlist [mask [type]]</command> -<programlisting> -list services currently connected to the network - -mask: list only services matching this mask -type: list only services of this type - -</programlisting> -<command>squery service text</command> -<programlisting> -deliver a message to a service - -service: name of service -text: text to send - -</programlisting> -<command>squit server comment</command> -<programlisting> -disconnect server links - -server: server name -comment: comment for quit - -</programlisting> -<command>stats [query [server]]</command> -<programlisting> -query statistics about server - - query: c/h/i/k/l/m/o/y/u (see RFC1459) -server: server name - -</programlisting> -<command>summon user [target [channel]]</command> -<programlisting> -give users who are on a host running an IRC server a message asking them to please join IRC - - user: username -target: server name -channel: channel name - -</programlisting> -<command>time [target]</command> -<programlisting> -query local time from server - -target: query time from specified server - -</programlisting> -<command>topic [channel] [topic]</command> -<programlisting> -get/set channel topic - -channel: channel name -topic: new topic for channel (if topic is "-delete" then topic is deleted) - -</programlisting> -<command>trace [target]</command> -<programlisting> -find the route to specific server - -target: server - -</programlisting> -<command>unban [channel] nickname [nickname ...]</command> -<programlisting> -unbans nicks or hosts - - channel: channel for unban -nickname: user or host to unban - -</programlisting> -<command>userhost nickname [nickname ...]</command> -<programlisting> -return a list of information about nicknames - -nickname: nickname - -</programlisting> -<command>users [target]</command> -<programlisting> -list of users logged into the server - -target: server - -</programlisting> -<command>version [server | nickname]</command> -<programlisting> -gives the version info of nick or server (current or specified) - - server: server name -nickname: nickname - -</programlisting> -<command>voice [nickname [nickname]]</command> -<programlisting> -gives voice to nickname(s) - -</programlisting> -<command>wallops text</command> -<programlisting> -send a message to all currently connected users who have set the 'w' user mode for themselves - -text to send - -</programlisting> -<command>who [mask ["o"]]</command> -<programlisting> -generate a query which returns a list of information - -mask: only information which match this mask - o: only operators are returned according to the mask supplied - -</programlisting> -<command>whois [server] nickname[,nickname]</command> -<programlisting> -query information about user(s) - - server: server name -nickname: nickname (may be a mask) - -</programlisting> -<command>whowas nickname [,nickname [,nickname ...]] [count [target]]</command> -<programlisting> -ask for information about a nickname which no longer exists - -nickname: nickname to search - count: number of replies to return (full search if negative number) - target: reply should match this mask - -</programlisting> diff --git a/weechat/doc/en/key_functions.xml b/weechat/doc/en/key_functions.xml deleted file mode 100644 index 27deec273..000000000 --- a/weechat/doc/en/key_functions.xml +++ /dev/null @@ -1,215 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><literal>return</literal></entry> - <entry>terminate line</entry> -</row> -<row> - <entry><literal>tab</literal></entry> - <entry>complete word</entry> -</row> -<row> - <entry><literal>tab_previous</literal></entry> - <entry>find previous completion for word</entry> -</row> -<row> - <entry><literal>backspace</literal></entry> - <entry>delete previous char</entry> -</row> -<row> - <entry><literal>delete</literal></entry> - <entry>delete next char</entry> -</row> -<row> - <entry><literal>delete_end_line</literal></entry> - <entry>delete until end of line</entry> -</row> -<row> - <entry><literal>delete_beginning_line</literal></entry> - <entry>delete until beginning of line</entry> -</row> -<row> - <entry><literal>delete_line</literal></entry> - <entry>delete entire line</entry> -</row> -<row> - <entry><literal>delete_previous_word</literal></entry> - <entry>delete previous word</entry> -</row> -<row> - <entry><literal>delete_next_word</literal></entry> - <entry>delete next word</entry> -</row> -<row> - <entry><literal>clipboard_paste</literal></entry> - <entry>paste current clipboard content</entry> -</row> -<row> - <entry><literal>transpose_chars</literal></entry> - <entry>transpose chars</entry> -</row> -<row> - <entry><literal>home</literal></entry> - <entry>go to beginning of line</entry> -</row> -<row> - <entry><literal>end</literal></entry> - <entry>go to end of line</entry> -</row> -<row> - <entry><literal>left</literal></entry> - <entry>move one char left</entry> -</row> -<row> - <entry><literal>previous_word</literal></entry> - <entry>move to previous word</entry> -</row> -<row> - <entry><literal>right</literal></entry> - <entry>move one char right</entry> -</row> -<row> - <entry><literal>next_word</literal></entry> - <entry>move to next word</entry> -</row> -<row> - <entry><literal>up</literal></entry> - <entry>call previous command in history</entry> -</row> -<row> - <entry><literal>up_global</literal></entry> - <entry>call previous command in global history</entry> -</row> -<row> - <entry><literal>down</literal></entry> - <entry>call next command in history</entry> -</row> -<row> - <entry><literal>down_global</literal></entry> - <entry>call next command in global history</entry> -</row> -<row> - <entry><literal>page_up</literal></entry> - <entry>scroll one page up</entry> -</row> -<row> - <entry><literal>page_down</literal></entry> - <entry>scroll one page down</entry> -</row> -<row> - <entry><literal>scroll_up</literal></entry> - <entry>scroll a few lines up</entry> -</row> -<row> - <entry><literal>scroll_down</literal></entry> - <entry>scroll a few lines down</entry> -</row> -<row> - <entry><literal>scroll_top</literal></entry> - <entry>scroll to top of buffer</entry> -</row> -<row> - <entry><literal>scroll_bottom</literal></entry> - <entry>scroll to bottom of buffer</entry> -</row> -<row> - <entry><literal>scroll_topic_left</literal></entry> - <entry>scroll left topic</entry> -</row> -<row> - <entry><literal>scroll_topic_right</literal></entry> - <entry>scroll right topic</entry> -</row> -<row> - <entry><literal>nick_beginning</literal></entry> - <entry>display beginning of nicklist</entry> -</row> -<row> - <entry><literal>nick_end</literal></entry> - <entry>display end of nicklist</entry> -</row> -<row> - <entry><literal>nick_page_up</literal></entry> - <entry>scroll nicklist one page up</entry> -</row> -<row> - <entry><literal>nick_page_down</literal></entry> - <entry>scroll nicklist one page down</entry> -</row> -<row> - <entry><literal>jump_smart</literal></entry> - <entry>jump to buffer with activity</entry> -</row> -<row> - <entry><literal>jump_dcc</literal></entry> - <entry>jump to DCC buffer</entry> -</row> -<row> - <entry><literal>jump_raw_data</literal></entry> - <entry>jump to raw IRC data buffer</entry> -</row> -<row> - <entry><literal>jump_last_buffer</literal></entry> - <entry>jump to last buffer</entry> -</row> -<row> - <entry><literal>jump_previous_buffer</literal></entry> - <entry>jump to previous buffer</entry> -</row> -<row> - <entry><literal>jump_server</literal></entry> - <entry>jump to server buffer</entry> -</row> -<row> - <entry><literal>jump_next_server</literal></entry> - <entry>jump to next server</entry> -</row> -<row> - <entry><literal>switch_server</literal></entry> - <entry>switch active server on servers buffer</entry> -</row> -<row> - <entry><literal>scroll_previous_highlight</literal></entry> - <entry>scroll to previous highlight in buffer</entry> -</row> -<row> - <entry><literal>scroll_next_highlight</literal></entry> - <entry>scroll to next highlight in buffer</entry> -</row> -<row> - <entry><literal>scroll_unread</literal></entry> - <entry>scroll to first unread line in buffer</entry> -</row> -<row> - <entry><literal>set_unread</literal></entry> - <entry>set unread marker on all buffers</entry> -</row> -<row> - <entry><literal>hotlist_clear</literal></entry> - <entry>clear hotlist</entry> -</row> -<row> - <entry><literal>infobar_clear</literal></entry> - <entry>clear infobar</entry> -</row> -<row> - <entry><literal>refresh</literal></entry> - <entry>refresh screen</entry> -</row> -<row> - <entry><literal>grab_key</literal></entry> - <entry>grab a key</entry> -</row> -<row> - <entry><literal>insert</literal></entry> - <entry>insert a string in command line</entry> -</row> -<row> - <entry><literal>search_text</literal></entry> - <entry>search text in buffer history</entry> -</row> diff --git a/weechat/doc/en/weechat.en.xml b/weechat/doc/en/weechat.en.xml deleted file mode 100644 index 8910c6d0d..000000000 --- a/weechat/doc/en/weechat.en.xml +++ /dev/null @@ -1,8137 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- - -WeeChat documentation (english version) - -Copyright (c) 2003-2007 by FlashCode <flashcode@flashtux.org> - -This manual 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. - -This manual is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. - ---> - -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" -[ - <!ENTITY date.xml SYSTEM "date.xml"> - <!ENTITY config.xml SYSTEM "config.xml"> - <!ENTITY weechat_commands.xml SYSTEM "weechat_commands.xml"> - <!ENTITY irc_commands.xml SYSTEM "irc_commands.xml"> - <!ENTITY key_functions.xml SYSTEM "key_functions.xml"> -]> - -<book lang="en"> - - <bookinfo> - - <title>WeeChat 0.2.6-cvs - User guide</title> - <subtitle>Fast, light and extensible IRC client</subtitle> - - <author> - <firstname>S�bastien</firstname> - <surname>Helleu</surname> - <email>flashcode AT flashtux.org</email> - </author> - - &date.xml; - - <copyright> - <year>2007</year> - <holder>S�bastien Helleu</holder> - </copyright> - - <legalnotice> - <para> - This manual 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. - </para> - <para> - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - </para> - <para> - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - </para> - </legalnotice> - - <abstract> - <para> - This manual documents WeeChat IRC client, it is part of WeeChat. - </para> - <para> - Latest version of this document can be found on this page: - <ulink url="http://weechat.flashtux.org/doc.php"> - http://weechat.flashtux.org/doc.php - </ulink> - </para> - </abstract> - - </bookinfo> - - <!-- =========================== Introduction =========================== --> - - <chapter id="chapIntroduction"> - <title>Introduction</title> - - <para> - This chapter describes WeeChat and pre-requisites for its installation. - </para> - - <section id="secDescription"> - <title>Description</title> - - <para> - WeeChat (Wee Enhanced Environment for Chat) is a free - <acronym>IRC</acronym> client, fast and light, designed for many - operating systems. - </para> - - <para> - Main features are: - <itemizedlist> - <listitem> - <para> - multi-servers connection (with SSL, IPv6, proxy) - </para> - </listitem> - <listitem> - <para> - many GUI: Curses, wxWidgets, Gtk and Qt - </para> - </listitem> - <listitem> - <para> - small, fast and light - </para> - </listitem> - <listitem> - <para> - customizable and extensible with plugins and scripts - </para> - </listitem> - <listitem> - <para> - compliant with <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2810.txt">2810</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2811.txt">2811</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2813.txt">2813</ulink> - </para> - </listitem> - <listitem> - <para> - multi-platform (GNU/Linux, *BSD, MacOS X, Windows and other) - </para> - </listitem> - <listitem> - <para> - 100% GPL, free software - </para> - </listitem> - </itemizedlist> - </para> - - <para> - WeeChat homepage is here: - <ulink url="http://weechat.flashtux.org"> - http://weechat.flashtux.org - </ulink> - </para> - - </section> - - <section id="secPreRequis"> - <title>Pre-requisites</title> - - <para> - In order to install WeeChat, you <emphasis>need</emphasis>: - <itemizedlist> - <listitem> - <para> - a running GNU/Linux system (with compiler tools for source - package) - </para> - </listitem> - <listitem> - <para> - "root" privileges (to install WeeChat) - </para> - </listitem> - <listitem> - <para> - according to GUI, one of the following libraries: - <itemizedlist> - <listitem> - <para> - Curses: ncurses library - </para> - </listitem> - <listitem> - <para> - Gtk: <emphasis>*** GUI not developed ***</emphasis> - </para> - </listitem> - <listitem> - <para> - WxWidgets: <emphasis>*** GUI not developed ***</emphasis> - </para> - </listitem> - <listitem> - <para> - Qt: <emphasis>*** GUI not developed ***</emphasis> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - </chapter> - - <!-- =========================== Installation =========================== --> - - <chapter id="chapInstallation"> - <title>Installation</title> - - <para> - This chapter explains how to install WeeChat. - </para> - - <section id="secBinaryPackages"> - <title>Binary packages</title> - - <para> - Binary packages are available for these distributions: - <itemizedlist> - <listitem> - <para> - Debian (or any Debian compatible distribution): - <userinput>apt-get install weechat</userinput> - </para> - </listitem> - <listitem> - <para> - Mandriva/RedHat (or any RPM compatible distribution): - <userinput> - rpm -i /chemin/weechat-x.y.z-1.i386.rpm - </userinput> - </para> - </listitem> - <listitem> - <para> - Gentoo : - <userinput>emerge weechat</userinput> - </para> - </listitem> - </itemizedlist> - - For other distributions, please look at your manual for - installation instructions. - </para> - - </section> - - <section id="secSourcePackage"> - <title>Source package</title> - - <para> - All you have to do is to run in a console or a terminal: -<screen><prompt>$ </prompt><userinput>./configure</userinput> -<prompt>$ </prompt><userinput>make</userinput></screen> - </para> - <para> - Then get root privileges and install WeeChat: -<screen><prompt>$ </prompt><userinput>su</userinput> -(enter root password) -<prompt># </prompt><userinput>make install</userinput></screen> - </para> - - </section> - - <section id="secCVSSources"> - <title>CVS sources</title> - - <para> - Warning: CVS sources are for advanced users: it may not compile - or not be stable. You're warned! - </para> - - <para> - To get CVS sources, issue this command: -<screen><prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@cvs.savannah.nongnu.org:/sources/weechat co weechat</userinput></screen> - </para> - - <para> - Execute this script: - <userinput>./autogen.sh</userinput> - </para> - - <para> - Then follow instructions for source package - (see <xref linkend="secSourcePackage" />) - </para> - - </section> - - </chapter> - - <!-- ============================== Usage =============================== --> - - <chapter id="chapUsage"> - <title>Usage</title> - - <para> - This chapter explains how to run WeeChat, the default key bindings - used, internal and IRC commands, setup file, and FIFO pipe use. - </para> - - <section id="secRunningWeeChat"> - <title>Running WeeChat</title> - - <para> - Command line arguments: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Parameter</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>-a, --no-connect</literal></entry> - <entry> - Disable auto-connect to servers at startup - </entry> - </row> - <row> - <entry><literal>-c, --config</literal></entry> - <entry> - Display config help (list of options) - </entry> - </row> - <row> - <entry><literal>-d, --dir <path></literal></entry> - <entry> - Set path as home for WeeChat (used for configuration files, - logs, user plugins and scripts). Default value is - "<literal>~/.weechat</literal>". Please note that directory - is created if not found by WeeChat. - </entry> - </row> - <row> - <entry><literal>-f, --key-functions</literal></entry> - <entry> - Display WeeChat internal functions for keys - </entry> - </row> - <row> - <entry><literal>-h, --help</literal></entry> - <entry> - Display help - </entry> - </row> - <row> - <entry><literal>-i, --irc-commands</literal></entry> - <entry> - Display IRC commands list - </entry> - </row> - <row> - <entry><literal>-k, --keys</literal></entry> - <entry> - Display WeeChat default keys - </entry> - </row> - <row> - <entry><literal>-l, --license</literal></entry> - <entry> - Display WeeChat license - </entry> - </row> - <row> - <entry><literal>-p, --no-plugin</literal></entry> - <entry> - Disable plugins auto-load - </entry> - </row> - <row> - <entry><literal>-v, --version</literal></entry> - <entry> - Display WeeChat version - </entry> - </row> - <row> - <entry><literal>-w, --weechat-commands</literal></entry> - <entry> - Display WeeChat commands list - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - It is also possible to give URL for one or many IRC servers, as - follow: - <screen>irc[6][s]://[pseudo[:mot_passe]@]irc.example.org[:port][/channel][,channel[...]</screen> - Example to join #weechat and #toto on - "<literal>irc.freenode.net</literal>" server, default port (6667), - with "nono" nick: - <screen><prompt>$ </prompt><userinput>weechat-curses irc://nono@irc.freenode.net/#weechat,#toto</userinput></screen> - </para> - - <para> - To start WeeChat, issue this command: - <itemizedlist> - <listitem> - <para> - for Curses GUI: <userinput>weechat-curses</userinput> - </para> - </listitem> - <listitem> - <para> - for Gtk GUI: <userinput>weechat-gtk</userinput> - </para> - </listitem> - <listitem> - <para> - for wxWidgets GUI: <userinput>weechat-wxwidgets</userinput> - </para> - </listitem> - <listitem> - <para> - for Qt GUI: <userinput>weechat-qt</userinput> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - When you run WeeChat for the first time, a default configuration - file is created, with default options. - The default configuration file is: - "<literal>~/.weechat/weechat.rc</literal>" - </para> - - <para> - You can edit this file at your convenience to configure WeeChat - (ONLY if WeeChat is not running), or you can set parameters with - "<literal>/set</literal>" command in WeeChat - (see <xref linkend="secWeeChatCommands" />) - </para> - - </section> - - <section id="secKeyboardShortcuts"> - <title>Key bindings</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Key</entry> - <entry>Action</entry> - </row> - </thead> - <tbody> - <row> - <entry>Left arrow / Ctrl + B</entry> - <entry> - Go to previous char in command line - </entry> - </row> - <row> - <entry>Right arrow / Ctrl + F</entry> - <entry> - Go to next char in command line - </entry> - </row> - <row> - <entry>Ctrl + left arrow</entry> - <entry> - Go to previous word in command line - </entry> - </row> - <row> - <entry>Ctrl + right arrow</entry> - <entry> - Go to next word in command line - </entry> - </row> - <row> - <entry>Home / Ctrl + A</entry> - <entry> - Go to the beginning of command line - </entry> - </row> - <row> - <entry>Ctrl + C then B</entry> - <entry> - Insert code for bold text. - </entry> - </row> - <row> - <entry>Ctrl + C then C</entry> - <entry> - Insert code for colored text. - </entry> - </row> - <row> - <entry>Ctrl + C then O</entry> - <entry> - Insert code for color reset. - </entry> - </row> - <row> - <entry>Ctrl + C then R</entry> - <entry> - Insert code for reverse color. - </entry> - </row> - <row> - <entry>Ctrl + C then U</entry> - <entry> - Insert code for underlined text. - </entry> - </row> - <row> - <entry>End / Ctrl + E</entry> - <entry> - Go to the end of command line - </entry> - </row> - <row> - <entry>Ctrl + K</entry> - <entry> - Delete from cursor until end of command line - </entry> - </row> - <row> - <entry>Ctrl + L</entry> - <entry> - Redraw whole window - </entry> - </row> - <row> - <entry>Ctrl + R</entry> - <entry> - Search for text in buffer history - (two times: search exact text) - </entry> - </row> - <row> - <entry>Ctrl + S then Ctrl + U</entry> - <entry> - Set unread marker on all buffers - </entry> - </row> - <row> - <entry>Ctrl + T</entry> - <entry> - Transpose chars - </entry> - </row> - <row> - <entry>Ctrl + U</entry> - <entry> - Delete from cursor until beginning of command line - </entry> - </row> - <row> - <entry>Ctrl + W</entry> - <entry> - Delete previous word of command line - </entry> - </row> - <row> - <entry>Ctrl + Y</entry> - <entry> - Paste clipboard content - </entry> - </row> - <row> - <entry>Backspace / Ctrl + H</entry> - <entry> - Delete previous char in command line - </entry> - </row> - <row> - <entry>Delete / Ctrl + D</entry> - <entry> - Delete next char in command line - </entry> - </row> - <row> - <entry>Tab / Shift + Tab</entry> - <entry> - Complete command or nick - (Tab again: find next completion) - </entry> - </row> - <row> - <entry>Any char</entry> - <entry> - Insert char at cursor position in command line - </entry> - </row> - <row> - <entry>Enter / Ctrl + J / Ctrl + M</entry> - <entry> - Execute command or send message - (in search mode: stop search) - </entry> - </row> - <row> - <entry>Up arrow / Down arrow</entry> - <entry> - Call again last commands/messages (in search mode: search - up/down) - </entry> - </row> - <row> - <entry>Ctrl + up arrow / Ctrl + down arrow</entry> - <entry> - Call again last commands/messages in global history - (common for all buffers) - </entry> - </row> - <row> - <entry>PageUp / PageDown</entry> - <entry> - Scroll up / down one page in buffer history - </entry> - </row> - <row> - <entry>Alt + PageUp / Alt + PageDown</entry> - <entry> - Scroll up / down a few lines in buffer history - </entry> - </row> - <row> - <entry>Alt + Home / Alt + End</entry> - <entry> - Scroll to top / bottom of buffer - </entry> - </row> - <row> - <entry>F5 / Alt + left arrow</entry> - <entry> - Switch to previous buffer - </entry> - </row> - <row> - <entry>F6 / Alt + right arrow</entry> - <entry> - Switch to next buffer - </entry> - </row> - <row> - <entry>F7</entry> - <entry> - Switch to previous window - </entry> - </row> - <row> - <entry>F8</entry> - <entry> - Switch to next window - </entry> - </row> - <row> - <entry>F9 / F10</entry> - <entry> - Scroll topic - </entry> - </row> - <row> - <entry>F11 / F12</entry> - <entry> - Scroll nicklist - </entry> - </row> - <row> - <entry>Alt + F11 / Alt + F12</entry> - <entry> - Go to the beginning / the end of nicklist - </entry> - </row> - <row> - <entry>Alt + A</entry> - <entry> - Switch to next buffer with activity - (with priority: highlight, message, other) - </entry> - </row> - <row> - <entry>Alt + B</entry> - <entry> - Go to previous word in command line - </entry> - </row> - <row> - <entry>Alt + D</entry> - <entry> - Delete next word in command line - </entry> - </row> - <row> - <entry>Alt + F</entry> - <entry> - Go to next word in command line - </entry> - </row> - <row> - <entry>Alt + H</entry> - <entry> - Clear hotlist - (activity notification on other buffers) - </entry> - </row> - <row> - <entry>Alt + I</entry> - <entry> - Remove last infobar message - </entry> - </row> - <row> - <entry>Alt + J then Alt + D</entry> - <entry> - Display DCC buffer - </entry> - </row> - <row> - <entry>Alt + J then Alt + L</entry> - <entry> - Switch to last buffer - </entry> - </row> - <row> - <entry>Alt + J then Alt + P</entry> - <entry> - Switch to buffer previously displayed - </entry> - </row> - <row> - <entry>Alt + J then Alt + R</entry> - <entry> - Switch to raw IRC data buffer - </entry> - </row> - <row> - <entry>Alt + J then Alt + S</entry> - <entry> - Switch to server buffer - </entry> - </row> - <row> - <entry>Alt + J then Alt + X</entry> - <entry> - Switch to first channel of next server - (or server buffer if no channel is opened) - </entry> - </row> - <row> - <entry>Alt + digit (0-9)</entry> - <entry> - Switch to buffer by number (0 = 10) - </entry> - </row> - <row> - <entry>Alt + J then number (01-99)</entry> - <entry> - Switch to buffer by number - </entry> - </row> - <row> - <entry>Alt + K</entry> - <entry> - Grab a key and insert its code in command line - </entry> - </row> - <row> - <entry>Alt + N</entry> - <entry> - Scroll to next highlight - </entry> - </row> - <row> - <entry>Alt + P</entry> - <entry> - Scroll to previous highlight - </entry> - </row> - <row> - <entry>Alt + R</entry> - <entry> - Delete entire command line - </entry> - </row> - <row> - <entry>Alt + S</entry> - <entry> - Switch servers on servers buffer - (if option "look_one_server_buffer" is enabled) - </entry> - </row> - <row> - <entry>Alt + U</entry> - <entry> - Scroll to first unread line in buffer - </entry> - </row> - <row> - <entry>Alt + W then Alt + arrow</entry> - <entry> - Switch to window with direction - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secCommandLine"> - <title>Command line</title> - - <para> - WeeChat command line (at the bottom of window) lets you send text on - channels and execute WeeChat or IRC commands (see - <xref linkend="secWeeChatIRCCommands" />). - </para> - - <para> - Commands begin with "/" char, followed by name of command. - For example, to initiate a private chat with "<literal>toto</literal>": - <screen><userinput>/query toto</userinput></screen> - </para> - - <para> - Text sent to a channel is any text that does not begin with "/" char. - For example, to send text "<literal>hello</literal>" on current - channel: - <screen><userinput>hello</userinput></screen> - </para> - - <para> - However, it is possible to start with "/" char, by adding another. - For example, to send text "<literal>/query toto</literal>" on current - channel: - <screen><userinput>//query toto</userinput></screen> - </para> - - <para> - If option for sending IRC colors ("<literal>irc_colors_send</literal>") - is enabled, you can use color codes and attributes, as follow (press - Ctrl-C then following letter, with optional value): - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>^Cb</entry> - <entry> - bold text - </entry> - </row> - <row> - <entry>^Ccxx</entry> - <entry> - text color "<literal>xx</literal>" - (see colors table below) - </entry> - </row> - <row> - <entry>^Ccxx,yy</entry> - <entry> - text color "<literal>xx</literal>" - and background "<literal>yy</literal>" - (see colors table below) - </entry> - </row> - <row> - <entry>^Co</entry> - <entry> - disable color and attributes - </entry> - </row> - <row> - <entry>^Cr</entry> - <entry> - reverse video (revert text color with background) - </entry> - </row> - <row> - <entry>^Cu</entry> - <entry> - underlined text - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - Note: the same code (without number for ^Cc) may be used to stop the - attribute. - </para> - - <para> - Color codes for ^Cc are: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Color</entry> - </row> - </thead> - <tbody> - <row> - <entry>00</entry> - <entry>white</entry> - </row> - <row> - <entry>01</entry> - <entry>black</entry> - </row> - <row> - <entry>02</entry> - <entry>dark blue</entry> - </row> - <row> - <entry>03</entry> - <entry>dark green</entry> - </row> - <row> - <entry>04</entry> - <entry>light red</entry> - </row> - <row> - <entry>05</entry> - <entry>dark red</entry> - </row> - <row> - <entry>06</entry> - <entry>magenta</entry> - </row> - <row> - <entry>07</entry> - <entry>orange</entry> - </row> - <row> - <entry>08</entry> - <entry>yellow</entry> - </row> - <row> - <entry>09</entry> - <entry>light green</entry> - </row> - <row> - <entry>10</entry> - <entry>cyan</entry> - </row> - <row> - <entry>11</entry> - <entry>light cyan</entry> - </row> - <row> - <entry>12</entry> - <entry>light blue</entry> - </row> - <row> - <entry>13</entry> - <entry>light magenta</entry> - </row> - <row> - <entry>14</entry> - <entry>gray</entry> - </row> - <row> - <entry>15</entry> - <entry>light gray (white)</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Example: display of "<literal>hello everybody!</literal>" with - "<literal>hello</literal>" in light blue bold, and - "<literal>everybody</literal>" in light red underlined: -<screen><userinput>^Cc12^Cbhello^Cb^Cc04^Cu everybody^Cu^Cc!</userinput></screen> - </para> - - </section> - - <section id="secWeeChatIRCCommands"> - <title>WeeChat / IRC commands</title> - - <para> - This chapter lists all WeeChat and IRC commands. - </para> - - <section id="secWeeChatCommands"> - <title>WeeChat commands</title> - - <para> - &weechat_commands.xml; - </para> - - </section> - - <section id="secKeyFunctions"> - <title>Key functions</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Function</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - - &key_functions.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secIRCCommands"> - <title>IRC commands</title> - - <para> - &irc_commands.xml; - </para> - - </section> - - </section> - - <section id="secConfigurationFile"> - <title>Configuration file</title> - - <para> - List of options for config file: - <informaltable colsep="0" frame="none"> - <tgroup cols="5"> - <thead> - <row> - <entry>Option</entry> - <entry>Type</entry> - <entry>Values</entry> - <entry>Default</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - - &config.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Colors for Curses GUI are: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Keyword</entry> - <entry>Color</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>default</literal></entry> - <entry>default color (transparent for background)</entry> - </row> - <row> - <entry><literal>black</literal></entry> - <entry>black</entry> - </row> - <row> - <entry><literal>red</literal></entry> - <entry>dark red</entry> - </row> - <row> - <entry><literal>lightred</literal></entry> - <entry>light red</entry> - </row> - <row> - <entry><literal>green</literal></entry> - <entry>dark green</entry> - </row> - <row> - <entry><literal>lightgreen</literal></entry> - <entry>light green</entry> - </row> - <row> - <entry><literal>brown</literal></entry> - <entry>brown</entry> - </row> - <row> - <entry><literal>yellow</literal></entry> - <entry>yellow</entry> - </row> - <row> - <entry><literal>blue</literal></entry> - <entry>dark blue</entry> - </row> - <row> - <entry><literal>lightblue</literal></entry> - <entry>light blue</entry> - </row> - <row> - <entry><literal>magenta</literal></entry> - <entry>dark magenta</entry> - </row> - <row> - <entry><literal>lightmagenta</literal></entry> - <entry>light magenta</entry> - </row> - <row> - <entry><literal>cyan</literal></entry> - <entry>dark cyan</entry> - </row> - <row> - <entry><literal>lightcyan</literal></entry> - <entry>light cyan</entry> - </row> - <row> - <entry><literal>white</literal></entry> - <entry>white</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secFIFOpipe"> - <title>FIFO pipe</title> - - <para> - You can remote control WeeChat, by sending commands or text to a - FIFO pipe (you have to enable option "irc_fifo_pipe", it is disabled - by default). - </para> - - <para> - The FIFO pipe is located in "<literal>~/.weechat/</literal>" and is - called "weechat_fifo_xxxxx" (where xxxxx is the process ID (PID) of - running WeeChat). So if many WeeChat are running, you have many FIFO - pipes, one for each session. - </para> - - <para> - The syntax for the FIFO pipe commands/text is: - <screen>server,channel *text or command here</screen> - where server and channel are optional, but if channel is here, server - should be too. - </para> - - <para> - Some examples: - <itemizedlist> - <listitem> - <para> - nick change on freenode to "mynick|out" : - <screen><prompt>$ </prompt><userinput>echo 'freenode */nick mynick|out' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - display text on #weechat channel: - <screen><prompt>$ </prompt><userinput>echo 'freenode,#weechat *hello everybody!' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - display text on current channel (buffer displayed by WeeChat): - <screen><prompt>$ </prompt><userinput>echo '*hello!' >~/.weechat/weechat_fifo_12345</userinput></screen> - <emphasis>Warning:</emphasis> this is dangerous and you should - not do that except if you know what you do! - </para> - </listitem> - <listitem> - <para> - send two commands to unload/reload Perl scripts (you have to - separate them with "\n"): - <screen><prompt>$ </prompt><userinput>echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - You can write a script to send command to all running WeeChat at same - time, for example: -<screen> -#!/bin/sh -if [ $# -eq 1 ]; then - for fifo in ~/.weechat/weechat_fifo_* - do - echo -e "$1" >$fifo - done -fi -</screen> - If the script is called "auto_weechat_command", you can run it with: - <screen><prompt>$ </prompt><userinput>./auto_weechat_command "freenode,#weechat *hello"</userinput></screen> - </para> - - </section> - - </chapter> - - <!-- ============================== Plugins ============================= --> - - <chapter id="chapPlugins"> - <title>Plugins</title> - - <para> - This chapter describes WeeChat plugins interface (API) and - the default scripts plugins (Perl, Python, Ruby, Lua), provided with - WeeChat. - </para> - - <section id="secPluginsInWeeChat"> - <title>Plugins in WeeChat</title> - - <para> - A plugin is a C program which can call WeeChat functions defined in - an interface. - </para> - - <para> - This C program does not need WeeChat sources to compile and can be - dynamically loaded into WeeChat with command - <command>/plugin</command>. - </para> - - <para> - The plugin has to be a dynamic library, for dynamic loading by - operating system. - Under GNU/Linux, the file has ".so" extension, ".dll" under - Windows. - </para> - - </section> - - <section id="secWriteAPlugin"> - <title>Write a plugin</title> - - <para> - The plugin has to include "weechat-plugin.h" file (available in - WeeChat source code). - This file defines structures and types used to communicate with - WeeChat. - </para> - - <para> - The plugin must have some variables and functions (mandatory, - without them the plugin can't load): - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>char plugin_name[]</literal></entry> - <entry>plugin name</entry> - </row> - <row> - <entry><literal>char plugin_version[]</literal></entry> - <entry>plugin version</entry> - </row> - <row> - <entry><literal>char plugin_description[]</literal></entry> - <entry>short description of plugin</entry> - </row> - </tbody> - </tgroup> - </informaltable> - - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Function</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>int weechat_plugin_init (t_weechat_plugin *plugin)</literal></entry> - <entry> - function called when plugin is loaded, must return - PLUGIN_RC_OK if successful, PLUGIN_RC_KO if error - (if error, plugin will NOT be loaded) - </entry> - </row> - <row> - <entry><literal>void weechat_plugin_end (t_weechat_plugin *plugin)</literal></entry> - <entry>function called when plugin is unloaded</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <section id="secAPIFunctions"> - <title>API functions</title> - - <section id="secAPI_set_charset"> - <title>set_charset</title> - - <para> - Prototype: - <command> - void set_charset (t_weechat_plugin *plugin, char *charset) - </command> - </para> - <para> - Set new plugin charset. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: new charset to use - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: - <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> - </para> - </section> - - <section id="secAPI_iconv_to_internal"> - <title>iconv_to_internal</title> - - <para> - Prototype: - <command> - void iconv_to_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convert string to WeeChat internal charset (UTF-8). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: charset to convert - </para> - </listitem> - <listitem> - <para> - <option>string</option>: string to convert - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: converted string. - </para> - <para> - Note: result has to be free by a call to "free" after use. - </para> - <para> - Example: - <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "iso string: � �");</screen> - </para> - </section> - - <section id="secAPI_iconv_from_internal"> - <title>iconv_from_internal</title> - - <para> - Prototype: - <command> - void iconv_from_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convert string from internal WeeChat charset (UTF-8) to another. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: target charset - </para> - </listitem> - <listitem> - <para> - <option>string</option>: string to convert - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: converted string. - </para> - <para> - Note: result has to be free by a call to "free" after use. - </para> - <para> - Example: - <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "utf-8 string: � �");</screen> - </para> - </section> - - <section id="secAPI_ascii_strcasecmp"> - <title>ascii_strcasecmp</title> - - <para> - Prototype: - <command> - int ascii_strcasecmp (t_weechat_plugin *plugin, - char *string1, char *string2) - </command> - </para> - <para> - Locale and case independent string comparison. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: first string for comparison - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: second string for comparison - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: difference between two strings: negative if - string1 < string2, zero if string1 == string2, positive if - string1 > string2 - </para> - <para> - Example: - <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> - </para> - </section> - - <section id="secAPI_ascii_strncasecmp"> - <title>ascii_strncasecmp</title> - - <para> - Prototype: - <command> - int ascii_strncasecmp (t_weechat_plugin *plugin, - char *string1, char *string2, int max) - </command> - </para> - <para> - Locale and case independent string comparison, for "max" chars. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin struct - </para> - </listitem> - <listitem> - <para> - <option>string1</option>: first string for comparison - </para> - </listitem> - <listitem> - <para> - <option>string2</option>: second string for comparison - </para> - </listitem> - <listitem> - <para> - <option>max</option>: max number of chars for comparison - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: difference between two strings: negative if - string1 < string2, zero if string1 == string2, positive if - string1 > string2 - </para> - <para> - Example: - <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> - </para> - </section> - - <section id="secAPI_explode_string"> - <title>explode_string</title> - - <para> - Prototype: - <command> - char **explode_string (t_weechat_plugin *plugin, char *string, - char *separators, int num_items_max, int *num_items) - </command> - </para> - <para> - Explode a string according to one or more delimiter(s). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin struct - </para> - </listitem> - <listitem> - <para> - <option>string</option>: string to explode - </para> - </listitem> - <listitem> - <para> - <option>separators</option>: delimiters used for explosion - </para> - </listitem> - <listitem> - <para> - <option>num_items_max</option>: maximum number of items - created (0 = no limit) - </para> - </listitem> - <listitem> - <para> - <option>num_items</option>: pointer to int which will - contain number of items created - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: array of strings, NULL if problem. - </para> - <para> - Note: result has to be free by a call to "free_exloded_string" - after use. - </para> - <para> - Example: -<screen> -char **argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_free_exploded_string"> - <title>free_exploded_string</title> - - <para> - Prototype: - <command> - char **free_exploded_string (t_weechat_plugin *plugin, - char **string) - </command> - </para> - <para> - Free memory used by a string explosion. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>string</option>: string exploded by - "explode_string" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: -<screen> -char *argv; -int argc; -argv = plugin->explode_string (plugin, string, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_mkdir_home"> - <title>mkdir_home</title> - - <para> - Prototype: - <command> - int mkdir_home (t_weechat_plugin *plugin, char *directory) - </command> - </para> - <para> - Create a directory in WeeChat home. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: directory to create - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if directory was successfully created, 0 if an - error occurred. - </para> - <para> - Example: -<screen> -if (!plugin->mkdir_home (plugin, "temp")) - plugin->print_server(plugin, "Failed to create 'temp' directory in WeeChat home."); -</screen> - </para> - </section> - - <section id="secAPI_exec_on_files"> - <title>exec_on_files</title> - - <para> - Prototype: - <command> - void exec_on_files (t_weechat_plugin *plugin, char *directory, - int (*callback)(t_weechat_plugin *, char *)) - </command> - </para> - <para> - Execute a function on all files of a directory. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>directory</option>: directory for searching files - </para> - </listitem> - <listitem> - <para> - <option>callback</option>: function called for each file - found - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: -<screen> -int callback (t_weechat_plugin *plugin, char *file) -{ - plugin->print_server (plugin, "file: %s", file); - return 1; -} -... -plugin->exec_on_files (plugin, "/tmp", &callback); -</screen> - </para> - </section> - - <section id="secAPI_print"> - <title>print</title> - - <para> - Prototype: - <command> - void print (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Display a message on a WeeChat buffer, identified by server and - channel (both may be NULL for current buffer). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server to find - buffer for message display (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel to find buffer - for message display (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - To display colored text, there are following codes: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>0x02</entry> - <entry> - bold text - </entry> - </row> - <row> - <entry>0x03 + "xx"</entry> - <entry> - text color "<literal>xx</literal>" - (see <xref linkend="secAPI_get_irc_color" /> for colors) - </entry> - </row> - <row> - <entry>0x03 + "xx,yy"</entry> - <entry> - text color "<literal>xx</literal>" - and background "<literal>yy</literal>" - (see <xref linkend="secAPI_get_irc_color" /> for colors) - </entry> - </row> - <row> - <entry>0x0F</entry> - <entry> - disable color and attributes - </entry> - </row> - <row> - <entry>0x12</entry> - <entry> - reverse video (revert text color with background) - </entry> - </row> - <row> - <entry>0x1F</entry> - <entry> - underlined text - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - Note: the same code (without number for 0x03) may be used to stop - the attribute. - </para> - <para> - Return value: none. - </para> - <para> - Examples: -<screen> -plugin->print (plugin, NULL, NULL, "hello"); -plugin->print (plugin, NULL, "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, NULL, NULL, - "test: \x02 bold \x0F\x03%02d blue \x03%02d green", - plugin->get_irc_color (plugin, "blue"), - plugin->get_irc_color (plugin, "green")); -</screen> - </para> - </section> - - <section id="secAPI_print_server"> - <title>print_server</title> - - <para> - Prototype: - <command> - void print_server (t_weechat_plugin *plugin, - char *message, ...) - </command> - </para> - <para> - Display a message on current server buffer. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - Return value: none. - </para> - <para> - Example: <screen>plugin->print_server (plugin, "hello");</screen> - </para> - </section> - - <section id="secAPI_print_infobar"> - <title>print_infobar</title> - - <para> - Prototype: - <command> - void print_infobar (t_weechat_plugin *plugin, - int time, char *message, ...) - </command> - </para> - <para> - Display a message in infobar for a specified time. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>time</option>: time (in seconds) for displaying - message (0 = never erased) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: -<screen> -plugin->print_infobar (plugin, 5, "hello"); -</screen> - </para> - </section> - - <section id="secAPI_infobar_remove"> - <title>infobar_remove</title> - - <para> - Prototype: - <command> - void infobar_remove (t_weechat_plugin *plugin, int count) - </command> - </para> - <para> - Remove one or more messages in infobar stack. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>count</option>: number of messages to remove - (if argument is <= 0, then all messages are removed) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: <screen>plugin->infobar_remove (1);</screen> - </para> - </section> - - <section id="secAPI_log"> - <title>log</title> - - <para> - Prototype: - <command> - void log (t_weechat_plugin *plugin, - char *server, char *channel, char *message, ...) - </command> - </para> - <para> - Write a message in log file for a server or a channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server to find - buffer for log (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel to find buffer - for log (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: -<screen> -plugin->log (plugin, "freenode", "#weechat", "test"); -</screen> - </para> - </section> - - <section id="secAPI_msg_handler_add"> - <title>msg_handler_add</title> - - <para> - Prototype: - <command> - t_plugin_handler *msg_handler_add (t_weechat_plugin - *plugin, char *message, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Add an IRC message handler, called when an IRC message is - received. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>message</option>: name of IRC message ("*" for all - messages). - To know list of IRC messages, please consult - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Moreover you can use a special name, prefixed by "weechat_" to catch - special events, as written in table below: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>weechat_pv</literal></entry> - <entry>private message received</entry> - </row> - <row> - <entry><literal>weechat_highlight</literal></entry> - <entry> - message with highlight (on a channel or pv) - </entry> - </row> - <row> - <entry><literal>weechat_ctcp</literal></entry> - <entry> - CTCP message received (VERSION, PING, ..) - </entry> - </row> - <row> - <entry><literal>weechat_dcc</literal></entry> - <entry> - DCC message received (chat or file) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called when message - is received - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc is set to 3, following values are set in - argv array: - <itemizedlist> - <listitem> - <para>argv[0] = server name</para> - </listitem> - <listitem> - <para>argv[1] = IRC message</para> - </listitem> - <listitem> - <para>argv[2] = command arguments</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: pointer to new message handler. - </para> - <para> - Note: function called when message is received has to return - one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: message - will not be sent to WeeChat - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: message - will not be sent to other plugins - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: message - will not be sent to WeeChat neither other plugins - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: function - successfully completed and make "highlight" on received - message - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: -<screen> -int msg_kick (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, "KICK received"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *msg_handler; -msg_handler = plugin->msg_handler_add (plugin, "KICK", - &msg_kick, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_cmd_handler_add"> - <title>cmd_handler_add</title> - - <para> - Prototype: - <command> - t_plugin_handler *cmd_handler_add (t_weechat_plugin - *plugin, char *command, char *description, char *arguments, - char *arguments_description, char *completion_template, - t_plugin_handler_func *fonction, char *handler_args, - void *handler_pointer) - </command> - </para> - <para> - Add a WeeChat command handler, called when user uses command - (for example /command). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>command</option>: the new command name, which - may be an existing command (be careful, replaced command - will not be available until plugin is unloaded) - </para> - </listitem> - <listitem> - <para> - <option>description</option>: short command description - (displayed by /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments</option>: short description of command - arguments (displayed by /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option>: long description - of command arguments (displayed by /help command) - </para> - </listitem> - <listitem> - <para> - <option>completion_template</option>: template for - completion, like "<literal>abc|%w def|%i</literal>" - which means "abc" or a WeeChat command for first argument, - "def" or IRC command for second. - An empty string lets WeeChat complete any argument with - a nick from current channel, NULL or "-" disable completion - for all command arguments. - </para> - <para> - Following codes can be used: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>%-</literal></entry> - <entry>no completion for argument</entry> - </row> - <row> - <entry><literal>%*</literal></entry> - <entry> - repeat last completion for all following arguments - (this code has to be at the end of completion - template, preceded by "|") - </entry> - </row> - <row> - <entry><literal>%a</literal></entry> - <entry>alias</entry> - </row> - <row> - <entry><literal>%A</literal></entry> - <entry> - alias and commands (WeeChat, IRC and plugins) - </entry> - </row> - <row> - <entry><literal>%c</literal></entry> - <entry>current channel</entry> - </row> - <row> - <entry><literal>%C</literal></entry> - <entry>all channels (including queries)</entry> - </row> - <row> - <entry><literal>%f</literal></entry> - <entry>file name</entry> - </row> - <row> - <entry><literal>%h</literal></entry> - <entry>plugins commands</entry> - </row> - <row> - <entry><literal>%i</literal></entry> - <entry>IRC commands (sent)</entry> - </row> - <row> - <entry><literal>%I</literal></entry> - <entry>IRC commands (received)</entry> - </row> - <row> - <entry><literal>%k</literal></entry> - <entry>key functions</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>nick on current server</entry> - </row> - <row> - <entry><literal>%M</literal></entry> - <entry> - nicks on current server (on all open channels) - </entry> - </row> - <row> - <entry><literal>%n</literal></entry> - <entry>nicks of current channel</entry> - </row> - <row> - <entry><literal>%N</literal></entry> - <entry>nicks and hostnames of current channel</entry> - </row> - <row> - <entry><literal>%o</literal></entry> - <entry>setup options</entry> - </row> - <row> - <entry><literal>%O</literal></entry> - <entry>plugin options</entry> - </row> - <row> - <entry><literal>%p</literal></entry> - <entry>default "part" message</entry> - </row> - <row> - <entry><literal>%q</literal></entry> - <entry>default "quit" message</entry> - </row> - <row> - <entry><literal>%s</literal></entry> - <entry>current server name</entry> - </row> - <row> - <entry><literal>%S</literal></entry> - <entry>all servers names</entry> - </row> - <row> - <entry><literal>%t</literal></entry> - <entry>topic of current channel</entry> - </row> - <row> - <entry><literal>%v</literal></entry> - <entry>setup option value</entry> - </row> - <row> - <entry><literal>%V</literal></entry> - <entry>plugin option value</entry> - </row> - <row> - <entry><literal>%w</literal></entry> - <entry>WeeChat commands</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called when command - is executed - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc is set to 3, following values are set in - argc array: - <itemizedlist> - <listitem> - <para>argv[0] = server name</para> - </listitem> - <listitem> - <para>argv[1] = command</para> - </listitem> - <listitem> - <para>argv[2] = command arguments</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: pointer to new command handler. - </para> - <para> - Note: function called when command is executed has to return - one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: -<screen> -int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, - "test command, nick: %s", - (argv[2]) ? argv[2] : "none"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *cmd_handler; -cmd_handler = plugin->cmd_handler_add (plugin, "test", "Test command", - "[nick]", "nick: nick of channel", - "%n", &cmd_test, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_timer_handler_add"> - <title>timer_handler_add</title> - - <para> - Prototype: - <command> - t_plugin_handler *timer_handler_add (t_weechat_plugin - *plugin, int interval, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Add a timer handler which periodically calls a function. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>interval</option>: interval (in seconds) between - two calls of function. - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc is set to 0, and argv is set to NULL. - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: pointer to new timer handler. - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: -<screen> -int my_timer (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "my timer"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *timer_handler; -timer_handler = plugin->timer_handler_add (plugin, 60, &my_timer); -</screen> - </para> - </section> - - <section id="secAPI_keyboard_handler_add"> - <title>keyboard_handler_add</title> - - <para> - Prototype: - <command> - t_plugin_handler *keyboard_handler_add (t_weechat_plugin - *plugin, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Add a keyboard handler, called for any key pressed. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Argument argc is set to 3, following values are set in - argc array: - <itemizedlist> - <listitem> - <para> - argv[0] = key pressed (name of internal function or - '*' followed by a key code) - </para> - </listitem> - <listitem> - <para> - argv[1] = command line before key action - </para> - </listitem> - <listitem> - <para> - argv[2] = command line after key action - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: pointer to new message handler. - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: -<screen> -int my_keyb (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argc == 2) - { - plugin->print (plugin, NULL, NULL, "key pressed: %s", argv[0]); - if (argv[1] && (argv[1][0] == '1')) - plugin->print (plugin, NULL, NULL, "input text changed"); - else - plugin->print (plugin, NULL, NULL, "input text not changed"); - } - return PLUGIN_RC_OK; -} -... -t_plugin_handler *keyb_handler; -keyb_handler = plugin->keyboard_handler_add (plugin, &my_keyb); -</screen> - </para> - </section> - - <section id="secAPI_event_handler_add"> - <title>event_handler_add</title> - - <para> - Prototype: - <command> - t_plugin_handler *event_handler_add (t_weechat_plugin - *plugin, char *event, t_plugin_handler_func *function, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Add an event handler, called when an event happens. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>event</option> : event (see table below) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Arguments depend on event (see table below). - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - List of events: - <informaltable colsep="0" frame="none"> - <tgroup cols="3"> - <thead> - <row> - <entry>Event</entry> - <entry>Description</entry> - <entry>Arguments</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>buffer_open</literal></entry> - <entry>a buffer was open</entry> - <entry> - argc = 1, argv = { buffer number } - </entry> - </row> - <row> - <entry><literal>buffer_close</literal></entry> - <entry>a buffer was closed</entry> - <entry> - argc = 1, argv = { buffer number } - </entry> - </row> - <row> - <entry><literal>buffer_move</literal></entry> - <entry>a buffer was moved</entry> - <entry> - argc = 2, argv = { new buffer number, old number } - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Return value: pointer to new event handler. - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - <para> - Example: -<screen> -int my_event (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "my_event"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *event_handler; -event_handler = plugin->event_handler_add (plugin, "buffer_open", - &my_event); -</screen> - </para> - </section> - - <section id="secAPI_handler_remove"> - <title>handler_remove</title> - - <para> - Prototype: - <command> - void handler_remove (t_weechat_plugin *plugin, - t_plugin_handler *handler) - </command> - </para> - <para> - Remove a command or message handler. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>handler</option>: handler to remove - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->handler_remove (plugin, my_handler);</screen> - </para> - </section> - - <section id="secAPI_handler_remove_all"> - <title>handler_remove_all</title> - - <para> - Prototype: - <command> - void handler_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Remove all handlers for a plugin. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->handler_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_modifier_add"> - <title>modifier_add</title> - - <para> - Prototype: - <command> - t_plugin_modifier *modifier_add (t_weechat_plugin *plugin, - char *type, char *message, t_plugin_modifier_func *function, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Add a message modifier. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>type</option>: modifier type: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>called for incoming IRC messages</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - called for each user message (or command) (before - WeeChat parses message) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - called for outgoing messages, immediately before - sending it to IRC server (this includes messages - sent automatically by WeeChat to server) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option>: name of IRC message (used only for - types "irc_in" and "irc_out"). - To know list of IRC messages, please consult - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Moreover, special value "*" means all messages (no filter). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - <para> - It uses following prototype: - <command> - int my_function (t_weechat_plugin *plugin, - int argc, char **argv, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Argument argc is set to 2, following values are set in - argv array: - <itemizedlist> - <listitem> - <para>argv[0] = server name</para> - </listitem> - <listitem> - <para>argv[1] = message</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>modifier_args</option>: arguments given to function - when called - </para> - </listitem> - <listitem> - <para> - <option>modifier_pointer</option>: pointer given to function - when called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: pointer to new message modifier. - </para> - <para> - Note: function has to return modified string, or NULL if no - changes are made to message. - If function returns empty string, then message is dropped and - will not be read at all by WeeChat (be careful when dropping - messages!). - Returned string must have been allocated by malloc() and will - be freed (with call to free()) automatically by WeeChat after use. - </para> - <para> - Example: -<screen> -char *adder (t_weechat_plugin *plugin, int argc, char **argv, - char *modifier_args, void *modifier_pointer) -{ - char *string; - string = (char *)malloc (strlen (argv[1]) + 16); - strcpy (string, argv[1]); - strcat (string, "test"); - return string; -} -... -t_plugin_modifier *modifier; -modifier = plugin->modifier_add (plugin, "irc_in", "privmsg", - &adder, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_modifier_remove"> - <title>modifier_remove</title> - - <para> - Prototype: - <command> - void modifier_remove (t_weechat_plugin *plugin, - t_plugin_modifier *modifier) - </command> - </para> - <para> - Remove a message modifier. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>modifier</option>: modifier to remove - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->modifier_remove (plugin, my_modifier);</screen> - </para> - </section> - - <section id="secAPI_modifier_remove_all"> - <title>modifier_remove_all</title> - - <para> - Prototype: - <command> - void modifier_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Remove all modifiers for a plugin. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->modifier_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_exec_command"> - <title>exec_command</title> - - <para> - Prototype: - <command> - void exec_command (t_weechat_plugin - *plugin, char *server, char *channel, char *command) - </command> - </para> - <para> - Execute a WeeChat command (or send a message to a channel). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server for - executing command (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel for executing - command (may be NULL) - </para> - </listitem> - <listitem> - <para> - <option>command</option>: command - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Examples: -<screen> -plugin->exec_command (plugin, NULL, NULL, "/help nick"); -plugin->exec_command (plugin, "freenode", "#weechat", "hello"); -</screen> - </para> - </section> - - <section id="secAPI_get_info"> - <title>get_info</title> - - <para> - Prototype: - <command> - char *get_info (t_weechat_plugin *plugin, - char *info, char *server) - </command> - </para> - <para> - Return an info about WeeChat or a channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>info</option> : name of info to read: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Info</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>version</literal></entry> - <entry>WeeChat's version</entry> - </row> - <row> - <entry><literal>nick</literal></entry> - <entry>nick</entry> - </row> - <row> - <entry><literal>channel</literal></entry> - <entry> - name of channel (NULL for a server or private) - </entry> - </row> - <row> - <entry><literal>server</literal></entry> - <entry>name of server</entry> - </row> - <row> - <entry><literal>type</literal></entry> - <entry> - buffer type: 0=standard, 1=DCC, 2=raw IRC data - </entry> - </row> - <row> - <entry><literal>away</literal></entry> - <entry>"away" flag</entry> - </row> - <row> - <entry><literal>inactivity</literal></entry> - <entry> - number of seconds since last key was pressed - </entry> - </row> - <row> - <entry><literal>input</literal></entry> - <entry> - content of command line for current window - </entry> - </row> - <row> - <entry><literal>input_mask</literal></entry> - <entry> - content of color mask for command line - </entry> - </row> - <row> - <entry><literal>input_pos</literal></entry> - <entry> - cursor position in command line - </entry> - </row> - <row> - <entry><literal>weechat_dir</literal></entry> - <entry> - WeeChat home directory - (by default: ~/.weechat/) - </entry> - </row> - <row> - <entry><literal>weechat_libdir</literal></entry> - <entry>WeeChat system lib directory</entry> - </row> - <row> - <entry><literal>weechat_sharedir</literal></entry> - <entry>WeeChat system share directory</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server for - reading info (if needed) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: information asked, NULL if not found. - </para> - <para> - Note: result has to be free by a call to "free" function after - use. - </para> - <para> - Examples: -<screen> -char *version = plugin->get_info (plugin, "version", NULL); -char *nick = plugin->get_info (plugin, "nick", "freenode"); -char *inactivity = plugin->get_info (plugin, "inactivity", NULL); - -plugin->print (plugin, NULL, NULL, - "WeeChat version %s, you are %s on freenode " - "(inactive for %s seconds)", - version, nick, inactivity); - -if (version) - free (version); -if (nick) - free (nick); -if (inactivity) - free (inactivity); -</screen> - </para> - </section> - - <section id="secAPI_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Prototype: - <command> - t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Return list of DCC currently active or finished. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of DCC. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>server</literal></entry> - <entry>IRC server</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel</literal></entry> - <entry>IRC channel</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - DCC type: - 0 = chat received, - 1 = chat sent, - 2 = file received, - 3 = file sent - </entry> - </row> - <row> - <entry>int*</entry> - <entry><literal>status</literal></entry> - <entry> - DCC status: - 0 = waiting, - 1 = connecting, - 2 = active, - 3 = finished, - 4 = failed, - 5 = interrupted by user - </entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_time</literal></entry> - <entry>date/time of DCC creation</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_transfer</literal></entry> - <entry>date/time of DCC transfer start</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>addr</literal></entry> - <entry>IP address of remote user</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>port used for DCC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>remote nick</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>filename</literal></entry> - <entry>file name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>local_filename</literal></entry> - <entry>local file name</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>filename_suffix</literal></entry> - <entry>suffix if renaming file</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>size</literal></entry> - <entry>file size</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>pos</literal></entry> - <entry>position in file</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>start_resume</literal></entry> - <entry>start position after interruption</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>bytes_per_sec</literal></entry> - <entry> - number of bytes per second since transfer start - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>prev_dcc</literal></entry> - <entry> - pointer to previous DCC info - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>next_dcc</literal></entry> - <entry> - pointer to next DCC info - </entry> - </row> - - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_dcc_info" function - after use. - </para> - <para> - Examples: -<screen> -t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin); -for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = ptr_dcc->next_dcc) -{ - plugin->print_server (plugin, "DCC type=%d, with: %s", - ptr_dcc->type, ptr_dcc->nick); -} -if (dcc_info) - plugin->free_dcc_info (plugin, dcc_info); -</screen> - </para> - </section> - - <section id="secAPI_free_dcc_info"> - <title>free_dcc_info</title> - - <para> - Prototype: - <command> - void free_dcc_info (t_weechat_plugin *plugin, - t_plugin_dcc_info *dcc_info) - </command> - </para> - <para> - Free memory used by a DCC list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>dcc_info</option>: pointer to DCC list returned by - "get_dcc_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> - </para> - </section> - - <section id="secAPI_get_server_info"> - <title>get_server_info</title> - - <para> - Prototype: - <command> - t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Return list of IRC servers (connected or not). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of IRC servers. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>server internal name</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoconnect</literal></entry> - <entry>1 if autoconnect at start-up, 0 otherwise</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect</literal></entry> - <entry> - 1 if autoreconnect when disconnected, - 0 otherwise - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect_delay</literal></entry> - <entry>delay before trying again connection</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_line</literal></entry> - <entry> - 1 if server was on command line (so it is temporary), - 0 otherwise - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>address</literal></entry> - <entry>server address (host or IP)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>port</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ipv6</literal></entry> - <entry>IPv6 connection</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl</literal></entry> - <entry>SSL connection</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>password</literal></entry> - <entry>server password</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick1</literal></entry> - <entry>first nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick2</literal></entry> - <entry>alternate nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick3</literal></entry> - <entry>second alternate nickname</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>username</literal></entry> - <entry>user name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>real name</literal></entry> - <entry>real name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>command</literal></entry> - <entry>command run once connected</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_delay</literal></entry> - <entry>delay after execution of command</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>autojoin</literal></entry> - <entry>channels joined automatically</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autorejoin</literal></entry> - <entry> - 1 if channels are rejoined when kicked, - 0 otherwise - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>notify_levels</literal></entry> - <entry>channels notify levels</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_iso</literal></entry> - <entry>channels charsets for decoding ISO</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_utf</literal></entry> - <entry>channels charsets for decoding UTF</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_encode</literal></entry> - <entry>channels charsets for encoding messages</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_connected</literal></entry> - <entry>1 if connected to server, 0 otherwise</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl_connected</literal></entry> - <entry>1 if connected with SSL, 0 otherwise</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>current nickname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_away</literal></entry> - <entry>1 if away, 0 otherwise</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>away_time</literal></entry> - <entry>time when user is marking as away</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>lag</literal></entry> - <entry>lag (in milliseconds)</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>prev_server</literal></entry> - <entry>pointer to previous server info</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>next_server</literal></entry> - <entry>pointer to next server info</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_server_info" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_server_info *server_info, *ptr_server_info; -server_info = plugin->get_server_info (plugin); -if (server_info) -{ - for (ptr_server_info = server_info; ptr_server_info; - ptr_server_info = ptr_server_info->next_server) - { - plugin->print (plugin, NULL, NULL, - "server: %s, address: %s, port: %d %s", - ptr_server_info->name, - ptr_server_info->address, - ptr_server_info->port, - (ptr_server_info->is_connected) ? "(connected)" : ""); - } - plugin->free_server_info (plugin, server_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_server_info"> - <title>free_server_info</title> - - <para> - Prototype: - <command> - void free_server_info (t_weechat_plugin *plugin, - t_plugin_server_info *server_info) - </command> - </para> - <para> - Free memory used by server info list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server_info</option>: pointer to server list - returned by "get_server_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_server_info (plugin, server_info);</screen> - </para> - </section> - - <section id="secAPI_get_channel_info"> - <title>get_channel_info</title> - - <para> - Prototype: - <command> - t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, - char *server) - </command> - </para> - <para> - Return list of IRC channels for a server. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal server name - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of IRC channels for server. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>0 for a channel, 1 for a private</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>name of channel</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>topic</literal></entry> - <entry>topic of channel</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>modes</literal></entry> - <entry>channel modes</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>limit</literal></entry> - <entry>user limit</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>key</literal></entry> - <entry>channel key</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>nicks_count</literal></entry> - <entry>number of nicks on channel</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>prev_channel</literal></entry> - <entry>pointer to previous channel info</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>next_channel</literal></entry> - <entry>pointer to next channel info</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_channel_info" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_channel_info *channel_info, *ptr_chan_info; -channel_info = plugin->get_channel_info (plugin, "freenode"); -if (channel_info) -{ - for (ptr_chan_info = channel_info; ptr_chan_info; - ptr_chan_info = ptr_chan_info->next_channel) - { - plugin->print (plugin, NULL, NULL, - " %s (type %d)", - ptr_chan_info->name, - ptr_chan_info->type); - } - plugin->free_channel_info (plugin, channel_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_channel_info"> - <title>free_channel_info</title> - - <para> - Prototype: - <command> - void free_channel_info (t_weechat_plugin *plugin, - t_plugin_channel_info *channel_info) - </command> - </para> - <para> - Free memory used by channel info list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>channel_info</option>: pointer to channel info list - returned by "get_channel_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_channel_info (plugin, channel_info);</screen> - </para> - </section> - - <section id="secAPI_get_nick_info"> - <title>get_nick_info</title> - - <para> - Prototype: - <command> - t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, - char *server, char *channel) - </command> - </para> - <para> - Return list of nicks for a channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal server name - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: channel name - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of nicks on channel. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>nick name</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>host</literal></entry> - <entry>hostname</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>flags</literal></entry> - <entry> - nick flags, binary "or" between values (1 = channel - owner, 2 = channel admin, 4 = op, 8 = halfop, - 16 = voice, 32 = away) - </entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>prev_nick</literal></entry> - <entry>pointer to previous nick info</entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>next_nick</literal></entry> - <entry>pointer to next nick info</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_nick_info" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_nick_info *nick_info, *ptr_nick_info; -nick_info = plugin->get_nick_info (plugin, "freenode", "#weechat"); -if (nick_info) -{ - for (ptr_nick_info = nick_info; ptr_nick_info; - ptr_nick_info = ptr_nick_info->next_nick) - { - plugin->print (plugin, NULL, NULL, - " %s (flags: %d)", - ptr_nick_info->nick, - ptr_nick_info->flags); - } - plugin->free_nick_info (plugin, nick_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_nick_info"> - <title>free_nick_info</title> - - <para> - Prototype: - <command> - void free_nick_info (t_weechat_plugin *plugin, - t_plugin_nick_info *nick_info) - </command> - </para> - <para> - Free memory used by nick info list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>nick_info</option>: pointer to nick info list - returned by "get_nick_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_nick_info (plugin, nick_info);</screen> - </para> - </section> - - <section id="secAPI_get_config"> - <title>get_config</title> - - <para> - Prototype: - <command> - char *get_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Return value of a WeeChat config option. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>option</option>: name of option to read - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: option value, NULL if not found. - </para> - <para> - Note: result has to be free by a call to "free" function after - use. - </para> - <para> - Examples: -<screen> -char *value1 = plugin->get_config (plugin, "look_set_title"); -char *value2 = plugin->get_config (plugin, "freenode.server_autojoin"); -</screen> - </para> - </section> - - <section id="secAPI_set_config"> - <title>set_config</title> - - <para> - Prototype: - <command> - int set_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Update value of a WeeChat config option. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>option</option>: name of option to update - </para> - </listitem> - <listitem> - <para> - <option>value</option>: new value for option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if option was successfully updated, 0 if an - error occurred. - </para> - <para> - Example: -<screen> -plugin->set_config (plugin, "look_nicklist", "off"); -</screen> - </para> - </section> - - <section id="secAPI_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Prototype: - <command> - char *get_plugin_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Return value of a plugin option. - Option is read from file "<literal>~/.weechat/plugins.rc</literal>" - and is like: "<literal>plugin.option=value</literal>" - (note: plugin name is automatically added). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>option</option>: name of option to read - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: option value, NULL if not found. - </para> - <para> - Note: result has to be free by a call to "free" function after - use. - </para> - <para> - Example: -<screen> -char *value = plugin->get_plugin_config (plugin, "my_var"); -</screen> - </para> - </section> - - <section id="secAPI_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Prototype: - <command> - int set_plugin_config (t_weechat_plugin *plugin, - char *option, char *value) - </command> - </para> - <para> - Update value of a plugin option. - Option is written in file "<literal>~/.weechat/plugins.rc</literal>" - and is like: "<literal>plugin.option=value</literal>" - (note: plugin name is automatically added). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>option</option>: name of option to update - </para> - </listitem> - <listitem> - <para> - <option>value</option>: new value for option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if option was successfully updated, 0 if an - error occurred. - </para> - <para> - Example: -<screen> -plugin->set_plugin_config (plugin, "my_var", "value"); -</screen> - </para> - </section> - - <section id="secAPI_get_irc_color"> - <title>get_irc_color</title> - - <para> - Prototype: - <command> - int get_irc_color (t_weechat_plugin *plugin, - char *color_name) - </command> - </para> - <para> - Get IRC color index with name. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>color_name</option>: color name - Allowed colors are: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Color name</entry> - <entry>Value</entry> - </row> - </thead> - <tbody> - <row> - <entry>white</entry> - <entry>0</entry> - </row> - <row> - <entry>black</entry> - <entry>1</entry> - </row> - <row> - <entry>blue</entry> - <entry>2</entry> - </row> - <row> - <entry>green</entry> - <entry>3</entry> - </row> - <row> - <entry>lightred</entry> - <entry>4</entry> - </row> - <row> - <entry>red</entry> - <entry>5</entry> - </row> - <row> - <entry>magenta</entry> - <entry>6</entry> - </row> - <row> - <entry>brown</entry> - <entry>7</entry> - </row> - <row> - <entry>yellow</entry> - <entry>8</entry> - </row> - <row> - <entry>lightgreen</entry> - <entry>9</entry> - </row> - <row> - <entry>cyan</entry> - <entry>10</entry> - </row> - <row> - <entry>lightcyan</entry> - <entry>11</entry> - </row> - <row> - <entry>lightblue</entry> - <entry>12</entry> - </row> - <row> - <entry>lightmagenta</entry> - <entry>13</entry> - </row> - <row> - <entry>gray</entry> - <entry>14</entry> - </row> - <row> - <entry>lightgray</entry> - <entry>15</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: IRC color index, -1 if color is not found. - </para> - <para> - Example: -<screen> -int color_blue = plugin->get_irc_color (plugin, "blue"); /* return 2 */ -</screen> - </para> - </section> - - <section id="secAPI_input_color"> - <title>input_color</title> - - <para> - Prototype: - <command> - void input_color (t_weechat_plugin *plugin, - int color, int start, int length) - </command> - </para> - <para> - Add color in input buffer. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>color</option>: color for text (if < 0, then input - buffer is refresh, and there's no change in input buffer - content) - </para> - </listitem> - <listitem> - <para> - <option>start</option>: start position for color (if < 0, - then mask is reinitialized) - </para> - </listitem> - <listitem> - <para> - <option>length</option>: length for color (if <= 0, - then mask is reinitialized) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: -<screen> -plugin->input_color (plugin, plugin->get_irc_color (plugin, "blue"), 10, 5); -</screen> - </para> - </section> - - <section id="secAPI_get_window_info"> - <title>get_window_info</title> - - <para> - Prototype: - <command> - t_plugin_window_info *get_window_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Return list of WeeChat windows. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of WeeChat windows. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>win_x</literal></entry> - <entry>horizontal position of window</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_y</literal></entry> - <entry>vertical position of window</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width</literal></entry> - <entry>width of window</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height</literal></entry> - <entry>height of window</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width_pct</literal></entry> - <entry>width % (compared to parent window)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height_pct</literal></entry> - <entry>height % (compared to parent window)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_buffer</literal></entry> - <entry>number of displayed buffer</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>prev_window</literal></entry> - <entry>pointer to previous window info</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>next_window</literal></entry> - <entry>pointer to next window info</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_window_info" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_window_info *window_info, *ptr_window; - -window_info = plugin->get_window_info (plugin); -if (window_info) -{ - for (ptr_window = window_info; ptr_window; ptr_window = ptr_window->next_window) - { - plugin->print (plugin, NULL, NULL, "--- window info ---"); - plugin->print (plugin, NULL, NULL, "(%d,%d), size: %dx%d, %%size: %d%%x%d%%", - ptr_window->win_x, ptr_window->win_y, - ptr_window->win_width, ptr_window->win_height, - ptr_window->win_width_pct, ptr_window->win_height_pct); - plugin->print (plugin, NULL, NULL, "num_buffer: %d", ptr_window->num_buffer); - } - plugin->free_window_info (plugin, window_info); -} -else - plugin->print (plugin, NULL, NULL, "no window info!"); -</screen> - </para> - </section> - - <section id="secAPI_free_window_info"> - <title>free_window_info</title> - - <para> - Prototype: - <command> - void free_window_info (t_weechat_plugin *plugin, - t_plugin_window_info *window_info) - </command> - </para> - <para> - Free memory used by window info list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>window_info</option>: pointer to window info list - returned by "get_window_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_window_info (plugin, window_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Prototype: - <command> - t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Return list of WeeChat buffers. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: linked list of WeeChat buffers. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>buffer type: 0=standard, 1=DCC, 2=raw IRC data</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>number</literal></entry> - <entry>buffer number</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_displayed</literal></entry> - <entry>number of windows displaying buffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>server_name</literal></entry> - <entry>server name for buffer (may be NULL)</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel_name</literal></entry> - <entry>channel name for buffer (may be NULL)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>notify_level</literal></entry> - <entry>notify level for buffer</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>log_filename</literal></entry> - <entry>log filename (NULL means not logging)</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>prev_buffer</literal></entry> - <entry>pointer to previous buffer info</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>next_buffer</literal></entry> - <entry>pointer to next buffer info</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_buffer_info" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_buffer_info *buffer_info, *ptr_buffer; - -buffer_info = plugin->get_buffer_info (plugin); -if (buffer_info) -{ - for (ptr_buffer = buffer_info; ptr_buffer; ptr_buffer = ptr_buffer->next_buffer) - { - plugin->print (plugin, NULL, NULL, "--- buffer info ---"); - plugin->print (plugin, NULL, NULL, "type: %d", ptr_buffer->type); - plugin->print (plugin, NULL, NULL, "number: %d", ptr_buffer->number); - plugin->print (plugin, NULL, NULL, "num_displayed: %d", ptr_buffer->num_displayed); - plugin->print (plugin, NULL, NULL, "server: %s", ptr_buffer->server_name); - plugin->print (plugin, NULL, NULL, "channel: %s", ptr_buffer->channel_name); - plugin->print (plugin, NULL, NULL, "notify level: %d", ptr_buffer->notify_level); - plugin->print (plugin, NULL, NULL, "log filename: %s", ptr_buffer->log_filename); - } - plugin->free_buffer_info (plugin, buffer_info); -} -else - plugin->print (plugin, NULL, NULL, "no buffer info!"); -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_info"> - <title>free_buffer_info</title> - - <para> - Prototype: - <command> - void free_buffer_info (t_weechat_plugin *plugin, - t_plugin_buffer_info *buffer_info) - </command> - </para> - <para> - Free memory used by buffer info list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>buffer_info</option>: pointer to buffer info list - returned by "get_buffer_info" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_buffer_info (plugin, buffer_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Prototype: - <command> - t_plugin_buffer_data *get_buffer_info (t_weechat_plugin *plugin, - char *server, char *channel) - </command> - </para> - <para> - Return content of buffer. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: channel name - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: buffer content (linked list of lines). - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>time_t</entry> - <entry><literal>date</literal></entry> - <entry>date and time</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>nick</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>data</literal></entry> - <entry>line content (color codes are removed)</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>prev_line</literal></entry> - <entry>pointer to previous line</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>next_line</literal></entry> - <entry>pointer to next line</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note: result has to be free by a call to "free_buffer_data" - function after use. - </para> - <para> - Example: -<screen> -t_plugin_buffer_line *buffer_line, *ptr_line; -char text_time[256]; - -buffer_line = plugin->get_buffer_data (plugin); -if (buffer_line) -{ - for (ptr_line = buffer_line; ptr_line; ptr_line = ptr_line->next_line) - { - strftime (text_time, sizeof (text_time), "%x %X", localtime (&(ptr_line->date))); - plugin->print (plugin, NULL, NULL, "date: %s, nick: %s, data: %s", - text_time, ptr_line->nick, ptr_line->data); - } - plugin->free_buffer_data (plugin, buffer_line); -} -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_data"> - <title>free_buffer_data</title> - - <para> - Prototype: - <command> - void free_buffer_data (t_weechat_plugin *plugin, - t_plugin_buffer_line *buffer_line) - </command> - </para> - <para> - Free memory used by buffer line list. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option>: pointer to plugin structure - </para> - </listitem> - <listitem> - <para> - <option>buffer_line</option>: pointer to buffer line list - returned by "get_buffer_data" function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: none. - </para> - <para> - Example: - <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> - </para> - </section> - - </section> - - <section id="secCompilePlugin"> - <title>Compile plugin</title> - - <para> - Compile does not need WeeChat sources, only file - "<literal>weechat-plugin.h</literal>". - </para> - - <para> - To compile a plugin which has one file "toto.c" (under GNU/Linux): -<screen> -<prompt>$ </prompt><userinput>gcc -fPIC -Wall -c toto.c</userinput> -<prompt>$ </prompt><userinput>gcc -shared -fPIC -o libtoto.so toto.o</userinput> -</screen> - </para> - - </section> - - <section id="secLoadPlugin"> - <title>Load plugin into WeeChat</title> - - <para> - Copy "libtoto.so" file into system plugins directory (for example - "<literal>/usr/local/lib/weechat/plugins</literal>") or into - user's plugins directory (for example - "<literal>/home/xxxxx/.weechat/plugins</literal>"). - </para> - - <para> - Under WeeChat: - <screen><userinput>/plugin load toto</userinput></screen> - </para> - - </section> - - <section id="secPluginExample"> - <title>Plugin example</title> - - <para> - Full example of plugin, which adds a /double command, which displays - two times arguments on current channel (ok that's not very useful, but - that's just an example!): -<screen> -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Double"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Test plugin for WeeChat"; - -/* "/double" command manager */ - -int double_cmd (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argv[2] && (argv[2][0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, argv[2]); - plugin->exec_command (plugin, NULL, NULL, argv[2]); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Display two times a message", - "msg", - "msg: message to display two times", - NULL, - &double_cmd, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* nothing done here */ -} -</screen> - </para> - - </section> - - </section> - - <section id="secCharset"> - <title>Charset plugin</title> - - <para> - Charset plugin lets you encode or decode data using charsets, with 3 - levels: global, by server, or by channel. - This plugin is optional, but recommended: if it's not loaded, WeeChat - can only read/write UTF-8 data. - </para> - - <para> - Charset plugin should be autoloaded by WeeChat at startup. - To be sure plugin is loaded, try: - "<literal>/charset</literal>". - If command is not found, then load plugin with command: - <screen>/plugin load charset</screen> - If plugin is not found, then you should compile again WeeChat with - plugins and Charset support. - </para> - - <para> - When Charset plugin starts, it displays terminal and internal charsets. - Terminal charset depends on your locale, and internal is UTF-8. - For example : -<screen> --P- Charset plugin starting, terminal charset: ISO-8859-15 (WeeChat internal: UTF-8) -</screen> - </para> - - <section id="secCharsetSettings"> - <title>Settings</title> - - <itemizedlist> - <listitem> - <para> - To set global decode and encode charsets, use - "<literal>/setp</literal>" command. - For example: -<screen> -/setp charset.global.decode = ISO-8859-15 -/setp charset.global.encode = ISO-8859-15 -</screen> - If global decode charset is not set (for example during first - load of Charset plugin), it will be automatically set to terminal - charset (if it's different from UTF-8), or by default to - "<literal>ISO-8859-1</literal>". - Default encode value is empty, so it sends by default with - internal charset (UTF-8). - </para> - </listitem> - <listitem> - <para> - To set server charset, use "<literal>/charset</literal>" command - on server buffer. - If you give only charset, then it will set "decode" and "encode" - values. - For example: - <screen>/charset ISO-8859-15</screen> - It's equivalent to: -<screen> -/charset decode ISO-8859-15 -/charset encode ISO-8859-15 -</screen> - </para> - </listitem> - <listitem> - <para> - To set channel (or private) charset, use same commands as server, - but on channel (or private) buffer. - </para> - </listitem> - </itemizedlist> - - </section> - - <section id="secCharsetFAQ"> - <title>FAQ</title> - - <para> - If you have problems with chars or accents using Charset plugin: - <itemizedlist> - <listitem> - <para> - check that weechat-curses is linked to libncursesw (warning: - needed on most distributions but not all) : - <screen>ldd /path/to/weechat-curses</screen> - </para> - </listitem> - <listitem> - <para> - check charset line (on server buffer), you should see - ISO-XXXXXX or UTF-8 for terminal charset. If you see - ANSI_X3.4-1968 or other values, probably your locale is wrong. - </para> - </listitem> - <listitem> - <para> - setup global decode value, for example: - <screen>/setp charset.global.decode = ISO-8859-15</screen> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </section> - - <section id="secScriptsPlugins"> - <title>Scripts plugins</title> - - <para> - Four plugins are provided with WeeChat to use script languages: - Perl, Python, Ruby and Lua. - </para> - - <section id="secLoadUnloadScripts"> - <title>Load / unload scripts</title> - - <para> - Scripts are loaded and unloaded with <command>/perl</command>, - <command>/python</command>, <command>/ruby</command> and - <command>/lua</command> commands - (type <command>/help</command> in WeeChat for help about commands). - </para> - - <para> - Examples: - <itemizedlist> - <listitem> - <para> - Load a Perl script: - <command><userinput>/perl load /tmp/test.pl</userinput></command> - </para> - </listitem> - <listitem> - <para> - List all loaded Perl scripts: - <command><userinput>/perl</userinput></command> - </para> - </listitem> - <listitem> - <para> - Load a Python script: - <command><userinput>/python load /tmp/test.py</userinput></command> - </para> - </listitem> - <listitem> - <para> - List all loaded Python scripts: - <command><userinput>/python</userinput></command> - </para> - </listitem> - <listitem> - <para> - Load a Ruby script: - <command><userinput>/ruby load /tmp/test.rb</userinput></command> - </para> - </listitem> - <listitem> - <para> - List all loaded Ruby scripts: - <command><userinput>/ruby</userinput></command> - </para> - </listitem> - <listitem> - <para> - Load a Lua script: - <command><userinput>/lua load /tmp/test.lua</userinput></command> - </para> - </listitem> - <listitem> - <para> - List all loaded Lua scripts: - <command><userinput>/lua</userinput></command> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSyntaxByLanguage"> - <title>Syntax by language</title> - - <section id="secScriptPerl"> - <title>Perl</title> - - <para> - In a WeeChat Perl script, all API functions and variables are - prefixed by "<literal>weechat::</literal>". - Example: -<screen>weechat::register("test", "1.0", "end_test", "WeeChat perl script");</screen> - </para> - - </section> - - <section id="secScriptPython"> - <title>Python</title> - - <para> - A WeeChat Python script has to start by importing weechat: - <screen>import weechat</screen> - </para> - - <para> - All API functions and variables are prefixed by - "<literal>weechat.</literal>". - Example: -<screen>weechat.register("test", "1.0", "end_test", "WeeChat python script")</screen> - </para> - - </section> - - <section id="secScriptRuby"> - <title>Ruby</title> - - <para> - In a WeeChat Ruby script, all code has to be in functions. - So for main code, you have to define a - "<literal>weechat_init</literal>" function, which is automatically - called when script is loaded by WeeChat. Example: -<screen> -def weechat_init - Weechat.register("test", "1.0", "end_test", "WeeChat ruby script") - Weechat.add_command_handler("command", "my_command") - return Weechat::PLUGIN_RC_OK -end - -def my_command(server, args) - Weechat.print("my command") - return Weechat::PLUGIN_RC_OK -end -</screen> - </para> - - <para> - All API functions are prefixed by - "<literal>Weechat.</literal>" and variables by - "<literal>Weechat::</literal>". - </para> - - </section> - - <section id="secScriptLua"> - <title>Lua</title> - - <para> - In a WeeChat Lua script, all API functions are prefixed by - "<literal>weechat.</literal>". - Variables are prefixed by "<literal>weechat.</literal>" and - suffixed by "<literal>()</literal>". - Example: -<screen> -function message_handler(server, args) - weechat.print("I am a message handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - - </section> - - </section> - - <section id="secWeeChatScriptsAPI"> - <title>WeeChat / scripts API</title> - - <section id="secScript_register"> - <title>register</title> - - <para> - Perl prototype: - <command> - weechat::register(name, version, end_function, description, [charset]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.register(name, version, end_function, description, [charset]) - </command> - </para> - <para> - This is first function to call in script. - All WeeChat scripts have to call this function. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>name</option>: unique name to identify script - (each script must have unique name) - </para> - </listitem> - <listitem> - <para> - <option>version</option>: script version - </para> - </listitem> - <listitem> - <para> - <option>end_function</option>: function called when script is - unloaded (optional parameter, empty string means nothing is - called at the end) - </para> - </listitem> - <listitem> - <para> - <option>description</option>: short description of script - </para> - </listitem> - <listitem> - <para> - <option>charset</option>: charset used by script, you should - set this if script is not written with UTF-8 - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if script was registered, 0 if an error occured. - </para> - <para> - Examples: -<screen> -# perl -weechat::register("test", "1.0", "end_test", "Test script!", "ISO-8859-1"); - -# python -weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") - -# ruby -Weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") - --- lua -weechat.register("test", "1.0", "end_test", "Test script!", "ISO-8859-1") -</screen> - </para> - </section> - - <section id="secScript_set_charset"> - <title>set_charset</title> - - <para> - Perl prototype: - <command> - weechat::set_charset(charset); - </command> - </para> - <para> - Python prototype: - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.set_charset(charset) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Set new script charset. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>charset</option>: new script charset - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if new charset was set, 0 if an error occured. - </para> - <para> - Examples: -<screen> -# perl -weechat::set_charset("ISO-8859-1"); - -# python -weechat.set_charset("ISO-8859-1") - -# ruby -Weechat.set_charset("ISO-8859-1") - --- lua -weechat.set_charset("ISO-8859-1") -</screen> - </para> - </section> - - <section id="secScript_print"> - <title>print</title> - - <para> - Perl prototype: - <command> - weechat::print(message, [channel, [server]]) - </command> - </para> - <para> - Python prototype: - <command> - weechat.prnt(message, [channel, [server]]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.print(message, [channel, [server]]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.print(message, [channel, [server]]) - </command> - </para> - <para> - Display a message on a WeeChat buffer, identified by server - and channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel to find buffer - for message display - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server to find - buffer for message display - </para> - </listitem> - </itemizedlist> - </para> - <para> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::print("message"); -weechat::print("message", "#weechat"); -weechat::print("message", "#weechat", "freenode"); -weechat::print("test: \x0305 red \x0F normal"); - -# python -weechat.prnt("message") -weechat.prnt("message", "#weechat") -weechat.prnt("message", "#weechat", "freenode") - -# ruby -Weechat.print("message") -Weechat.print("message", "#weechat") -Weechat.print("message", "#weechat", "freenode") - --- lua -weechat.print("message") -weechat.print("message", "#weechat") -weechat.print("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <section id="secScript_print_server"> - <title>print_server</title> - - <para> - Perl prototype: - <command> - weechat::print_server(message) - </command> - </para> - <para> - Python prototype: - <command> - weechat.print_server(message) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.print_server(message) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.print_server(message) - </command> - </para> - <para> - Display a message on server buffer. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - To display colored text, see <xref linkend="secAPI_print" />. - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::print_server("message"); -weechat::print_server("test: \x0305 red \x0F normal"); - -# python -weechat.print_server("message") - -# ruby -Weechat.print_server("message") - --- lua -weechat.print_server("message") -</screen> - </para> - </section> - - <section id="secScript_print_infobar"> - <title>print_infobar</title> - - <para> - Perl prototype: - <command> - weechat::print_infobar(time, message); - </command> - </para> - <para> - Python prototype: - <command> - weechat.print_infobar(time, message) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.print_infobar(time, message) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.print_infobar(time, message) - </command> - </para> - <para> - Display a message in infobar for a specified time. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>time</option>: time (in seconds) for displaying - message (0 = never erased) - </para> - </listitem> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::print_infobar(5, "message"); - -# python -weechat.print_infobar(5, "message") - -# ruby -Weechat.print_infobar(5, "message") - --- lua -weechat.print_infobar(5, "message") -</screen> - </para> - </section> - - <section id="secScript_remove_infobar"> - <title>remove_infobar</title> - - <para> - Perl prototype: - <command> - weechat::remove_infobar([count]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_infobar([count]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_infobar([count]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_infobar([count]) - </command> - </para> - <para> - Remove one or more messages in infobar stack. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>count</option>: number of messages to remove - (if argument not given or <= 0, then all messages are - removed) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_infobar(1); - -# python -weechat.remove_infobar(1) - -# ruby -Weechat.remove_infobar(1) - --- lua -weechat.remove_infobar(1) -</screen> - </para> - </section> - - <section id="secScript_log"> - <title>log</title> - - <para> - Perl prototype: - <command> - weechat::log(message, [channel, [server]]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.log(message, [channel, [server]]) - </command> - </para> - <para> - Write a message in log file for a server or a channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>message</option>: message - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel to find buffer - for log - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server to find - buffer for log - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::log("message", "#weechat", "freenode"); - -# python -weechat.log("message", "#weechat", "freenode") - -# ruby -Weechat.log("message", "#weechat", "freenode") - --- lua -weechat.log("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <section id="secScript_add_message_handler"> - <title>add_message_handler</title> - - <para> - Perl prototype: - <command> - weechat::add_message_handler(message, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_message_handler(message, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_message_handler(message, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_message_handler(message, function) - </command> - </para> - <para> - Add an IRC message handler, called when an IRC message is - received. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>message</option>: name of IRC message. To know list - of IRC messages, please consult <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Moreover you can use a special name, prefixed by "weechat_" to catch - special events (see <xref linkend="secAPI_msg_handler_add" />). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called when message is - received - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_message_handler ("privmsg", "my_function"); -sub my_function -{ - weechat::print("server=$_[0]"); - ($null, $channel, $message) = split ":",$_[1],3; - ($mask, $null, $channel) = split " ", $channel; - weechat::print("mask=$mask, channel=$channel, msg=$message"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_message_handler ("privmsg", "my_function") -def my_function(server, args): - weechat.prnt("server="+server) - null, channel, message = string.split(args, ":", 2) - mask, null, channel = string.split(string.strip(channel), " ", 2) - weechat.prnt("mask="+mask+", canal="+channel+", message="+message) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_message_handler("privmsg", "my_function") -def my_function(server, args) - Weechat.print("server=#{server}, args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_message_handler ("privmsg", "my_function") -function my_function(server, args) - weechat.print("server=" .. server .. ", args=" .. args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note: function called when message is received has to return - one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal>: message - will not be sent to WeeChat - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal>: message - will not be sent to other plugins - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal>: message - will not be sent to WeeChat neither other plugins - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal>: function - successfully completed and make "highlight" on received - message - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_command_handler"> - <title>add_command_handler</title> - - <para> - Perl prototype: - <command> - weechat::add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_command_handler(command, function, - [description, arguments, arguments_description, - completion_template]) - </command> - </para> - <para> - Add a WeeChat command handler, called when user uses command - (for example /command). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>command</option>: the new command name, which - may be an existing command (be careful, replaced command - will not be available until script is unloaded) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called when command - is executed - </para> - </listitem> - <listitem> - <para> - <option>arguments</option>: short description of command - arguments (displayed by /help command) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option>: long description - of command arguments (displayed by /help command) - </para> - </listitem> - <listitem> - <para> - <option>completion_template</option>: template for - completion, like "<literal>abc|%w def|%i</literal>" which - means "abc" or a WeeChat command for first argument, - "def" or IRC command for second. - (see <xref linkend="secAPI_cmd_handler_add" />) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_command_handler("command", "my_command"); -sub my_command -{ - weechat::print("server= $_[0], args: $_[1]"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_command_handler("command", "my_command") -def my_command(server, args): - weechat.prnt("server="+server+", args="+args) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_command_handler("command", "my_command") -def my_command(server, args) - Weechat.print("server=#{server}, args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_command_handler("command", "my_command") -def my_command(server, args) - weechat.print("server="..server..", args="..args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Notes: function called when command is executed has to return - one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_timer_handler"> - <title>add_timer_handler</title> - - <para> - Perl prototype: - <command> - weechat::add_timer_handler(interval, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_timer_handler(interval, function) - </command> - </para> - <para> - Add a timer handler which periodically calls a function. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>interval</option>: interval (in seconds) between - two calls of function. - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_timer_handler(60, "my_timer"); -sub my_timer -{ - weechat::print("this is timer handler"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_timer_handler(60, "my_timer") -def my_timer(): - weechat.prnt("this is timer handler") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_timer_handler(60, "my_timer") -def my_timer() - Weechat.print("this is timer handler") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_timer_handler(60, "my_timer") -function my_timer() - weechat.print("this is timer handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_keyboard_handler"> - <title>add_keyboard_handler</title> - - <para> - Perl prototype: - <command> - weechat::add_keyboard_handler(function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_keyboard_handler(function) - </command> - </para> - <para> - Add a keyboard handler, called for any key pressed. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>function</option>: function called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_keyboard_handler("my_keyboard"); -sub my_keyboard -{ - my $key = shift; - my $input_before = shift; - my $input_after = shift; - weechat::print("keyboard handler: key = '$key', " - ."input before = '$input_before' " - ."after = '$input_after'"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_keyboard_handler("my_keyboard") -def my_keyboard(key, input_before, input_after): - weechat.prnt("keyboard handler: key = '%s', " \ - "input before = '%s' after = '%s'" - %(key, input_before, input_after)) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_keyboard_handler("my_keyboard") -def my_keyboard(key, input_before, input_after) - Weechat.print("keyboard handler: key = '#{key}', " \ - "input before = '#{input_before}' " \ - "after = '#{input_after}'") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_keyboard_handler("my_keyboard") -function my_keyboard(key, input_before, input_after) - weechat.print("keyboard handler: key = '"..key.. - "', input before = '"..input_before.. - "' after = '"..input_after.."'") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_event_handler"> - <title>add_event_handler</title> - - <para> - Perl prototype: - <command> - weechat::add_event_handler(event, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_event_handler(event, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_event_handler(event, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_event_handler(event, function) - </command> - </para> - <para> - Add an event handler, called when an event happens. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>event</option> : event - (see <xref linkend="secAPI_event_handler_add" />) - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_event_handler("buffer_open", "my_event"); -sub my_event -{ - weechat::print("buffer open"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_event_handler("buffer_open", "my_event") -def my_event(): - weechat.prnt("buffer open") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_event_handler("buffer_open", "my_event") -def my_event() - Weechat.print("buffer open") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_event_handler("buffer_open", "my_event") -function my_event() - weechat.print("buffer open") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note: function called has to return one of following values: - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal>: function failed - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal>: function successfully - completed - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_remove_handler"> - <title>remove_handler</title> - - <para> - Perl prototype: - <command> - weechat::remove_handler(name, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_handler(name, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_handler(name, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_handler(name, function) - </command> - </para> - <para> - Remove a message or command handler. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>name</option>: name of IRC message or command - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_handler("command", "my_command"); - -# python -weechat.remove_handler("command", "my_command") - -# ruby -Weechat.remove_handler("command", "my_command") - --- lua -weechat.remove_handler("command", "my_command") -</screen> - </para> - </section> - - <section id="secScript_remove_timer_handler"> - <title>remove_timer_handler</title> - - <para> - Perl prototype: - <command> - weechat::remove_timer_handler(function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_timer_handler(function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_timer_handler(function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_timer_handler(function) - </command> - </para> - <para> - Remove a timer handler. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>function</option>: function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_timer_handler("my_timer"); - -# python -weechat.remove_timer_handler("my_timer") - -# ruby -Weechat.remove_timer_handler("my_timer") - --- lua -weechat.remove_timer_handler("my_timer") -</screen> - </para> - </section> - - <section id="secScrip_remove_keyboard_handler"> - <title>remove_keyboard_handler</title> - - <para> - Perl prototype: - <command> - weechat::remove_keyboard_handler(function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_keyboard_handler(function) - </command> - </para> - <para> - Remove a keyboard handler. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>function</option>: function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_keyboard_handler("my_keyboard"); - -# python -weechat.remove_keyboard_handler("my_keyboard") - -# ruby -Weechat.remove_keyboard_handler("my_keyboard") - --- lua -weechat.remove_keyboard_handler("my_keyboard") -</screen> - </para> - </section> - - <section id="secScrip_remove_event_handler"> - <title>remove_event_handler</title> - - <para> - Perl prototype: - <command> - weechat::remove_event_handler(function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_event_handler(function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_event_handler(function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_event_handler(function) - </command> - </para> - <para> - Remove an event handler. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>function</option>: function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_event_handler("my_event"); - -# python -weechat.remove_event_handler("my_event") - -# ruby -Weechat.remove_event_handler("my_event") - --- lua -weechat.remove_event_handler("my_event") -</screen> - </para> - </section> - - <section id="secScript_add_modifier"> - <title>add_modifier</title> - - <para> - Perl prototype: - <command> - weechat::add_modifier(type, message, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.add_modifier(type, message, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.add_modifier(type, message, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.add_modifier(type, message, function) - </command> - </para> - <para> - Add a message modifier. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>type</option>: modifier type: - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>called for incoming IRC messages</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - called for each user message (or command) (before - WeeChat parses message) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - called for outgoing messages, immediately before - sending it to IRC server (this includes messages - sent automatically by WeeChat to server) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option>: name of IRC message (used only for - types "irc_in" and "irc_out"). - To know list of IRC messages, please consult - <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> and - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - Moreover, special value "*" means all messages (no filter). - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function called - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::add_modifier("irc_in", "privmsg", "mod_in"); -weechat::add_modifier("irc_out", "privmsg", "mod_out"); -sub mod_in -{ - return "$_[1] [modifier IN]"; -} -sub mod_out -{ - return "$_[1] [modifier OUT]"; -} - -# python -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(serveur, args): - return args + " [modifier IN]" -def mod_out(serveur, args): - return args + " [modifier OUT]" - -# ruby -Weechat.add_modifier("irc_in", "privmsg", "mod_in") -Weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(server, args) - return args + " [modifier IN]" -end -def mod_out(server, args) - return args + " [modifier OUT]" -end - --- lua -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -function mod_in(server, args) - return args .. " [modifier IN]" -end -function mod_out(server, args) - return args .. " [modifier OUT]" -end -</screen> - </para> - </section> - - <section id="secScript_remove_modifier"> - <title>remove_modifier</title> - - <para> - Perl prototype: - <command> - weechat::remove_modifier(type, message, function); - </command> - </para> - <para> - Python prototype: - <command> - weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.remove_modifier(type, message, function) - </command> - </para> - <para> - Remove a message modifier. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>type</option>: modifier type - </para> - </listitem> - <listitem> - <para> - <option>message</option>: message managed by modifier - </para> - </listitem> - <listitem> - <para> - <option>function</option>: function - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::remove_modifier("irc_in", "privmsg", "mod_in"); - -# python -weechat.remove_modifier("irc_in", "privmsg", "mod_in") - -# ruby -Weechat.remove_modifier("irc_in", "privmsg", "mod_in") - --- lua -weechat.remove_modifier("irc_in", "privmsg", "mod_in") -</screen> - </para> - </section> - - <section id="secScript_command"> - <title>command</title> - - <para> - Perl prototype: - <command> - weechat::command(command, [channel, [server]]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.command(command, [channel, [server]]) - </command> - </para> - <para> - Execute a WeeChat command (or send a message to a channel). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>command</option>: command - </para> - </listitem> - <listitem> - <para> - <option>channel</option>: name of channel for executing - command - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server for - executing command - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if success, 0 if an error occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::command("hello everybody!"); -weechat::command("/kick toto please leave this channel", "#weechat"); -weechat::command("/nick newnick", "", "freenode"); - -# python -weechat.command("hello everybody!") -weechat.command("/kick toto please leave this channel", "#weechat") -weechat.command("/nick newnick", "", "freenode") - -# ruby -Weechat.command("hello everybody!") -Weechat.command("/kick toto please leave this channel", "#weechat") -Weechat.command("/nick newnick", "", "freenode") - --- lua -weechat.command("hello everybody!") -weechat.command("/kick toto please leave this channel", "#weechat") -weechat.command("/nick newnick", "", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_info"> - <title>get_info</title> - - <para> - Perl prototype: - <command> - weechat::get_info(name, [server]); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_info(name, [server]) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_info(name, [server]) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_info(name, [server]) - </command> - </para> - <para> - Return an info about WeeChat or a channel. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>name</option>: name of info to read - (see <xref linkend="secAPI_get_info" />) - </para> - </listitem> - <listitem> - <para> - <option>server</option>: internal name of server for - reading info (if needed) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: information asked, empty string if an error - occurred. - </para> - <para> - Examples: -<screen> -# perl -$version = get_info("version"); -$nick = get_info("nick", "freenode"); - -# python -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") - -# ruby -version = Weechat.get_info("version") -nick = Weechat.get_info("nick", "freenode") - --- lua -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Perl prototype: - <command> - weechat::get_dcc_info(); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_dcc_info() - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Return list of DCC currently active or finished. - </para> - <para> - Return value: list of DCC - (see <xref linkend="secAPI_get_dcc_info" />). - </para> - <para> - Examples: -<screen> -# perl -my @dccs = weechat::get_dcc_info(); -if (@dccs) -{ - foreach my $dcc (@dccs) - { - while (my ($key, $value) = each %$dcc) - { - weechat::print("$key = '$value'"); - } - } -} -else -{ - weechat::print("no DCC"); -} - -# python -dccs = weechat.get_dcc_info() -if dccs != None: - if dccs == []: - weechat.prnt("no DCC") - else: - for d in dccs: - for b in d.keys(): - weechat.prnt("%s = '%s'" %(b, d[b])) -else: - weechat.prnt("error while getting DCC") - -# ruby -dccs = Weechat.get_dcc_info() -if dccs != nil - if dccs == [] - Weechat.print("no DCC") - else - dccs.each do |m| - m.each do |key, value| - Weechat.print("#{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting DCC") -end - --- lua -dccs = weechat.get_dcc_info() -if dccs ~= nil then - if dccs then - dcc, dccinfos = next (dccs, nil) - while (dcc) do - key, value = next (dccinfos, nil) - while (key) do - weechat.print(key.." = '"..value.."'") - key, value = next (dccinfos, key) - end - dcc, dccinfos = next (dccs, dcc) - end - else - weechat.print("no DCC") - end -else - weechat.print("error while getting DCC") -end -</screen> - </para> - </section> - - <section id="secScript_get_server_info"> - <title>get_server_info</title> - - <para> - Perl prototype: - <command> - weechat::get_server_info(); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_server_info() - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_server_info() - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_server_info() - </command> - </para> - <para> - Return list of IRC servers (connected or not). - </para> - <para> - Return value: list of servers - (see <xref linkend="secAPI_get_server_info" />). - </para> - <para> - Examples: -<screen> -# perl -my $servers = weechat::get_server_info(); -if ($servers) -{ - while (my ($srvname, $srvinfos) = each %$servers) - { - while ( my ($key, $value) = each %$srvinfos) - { - weechat::print("$srvname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no server"); -} - -# python -servers = weechat.get_server_info() -if servers != None: - if servers == {}: - weechat.prnt("no server") - else: - for s in servers: - for i in servers[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(servers[s][i]))) -else: - weechat.prnt("error while getting servers") - -# ruby -servers = Weechat.get_server_info() -if servers != nil - if servers == [] - Weechat.print("no server") - else - servers.each do |n, s| - s.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting servers") -end - --- lua -servers = weechat.get_server_info() -if servers ~= nil then - if servers then - srv, srvinfos = next (servers, nil) - while (srv) do - key, value = next (srvinfos, nil) - while (key) do - weechat.print(srv.." -> "..key.." = '"..value.."'") - key, value = next (srvinfos, key) - end - srv, srvinfos = next (servers, srv) - end - else - weechat.print("no server") - end -else - weechat.print("error while getting servers") -end -</screen> - </para> - </section> - - <section id="secScript_get_channel_info"> - <title>get_channel_info</title> - - <para> - Perl prototype: - <command> - weechat::get_channel_info(server); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_channel_info(server) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_channel_info(server) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_channel_info(server) - </command> - </para> - <para> - Return list of IRC channels for a server. - </para> - <para> - Return value: list of IRC channels for server - (see <xref linkend="secAPI_get_channel_info" />). - </para> - <para> - Examples: -<screen> -# perl -my $channels = weechat::get_channel_info(weechat::get_info("server")); -if ($channels) -{ - while (my ($channame, $chaninfos) = each %$channels) - { - while (my ($key, $value) = each %$chaninfos) - { - weechat::print("$channame -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no channel"); -} - -# python -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans != None: - if chans == {}: - weechat.prnt("no channel") - else: - for s in chans: - for i in chans[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(chans[s][i]))) -else: - weechat.prnt("error while getting channels") - -# ruby -channels = Weechat.get_channel_info(Weechat.get_info("server")) -if channels != nil - if channels == {} - Weechat.print("no channel") - else - channels.each do |n, c| - c.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting channels") -end - --- lua -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans ~= nil then - if chans then - chan, chaninfos = next (chans, nil) - while (chan) do - key, value = next (chaninfos, nil) - while (key) do - weechat.print(chan.." -> "..key.." = '"..value.."'") - key, value = next (chaninfos, key) - end - chan, chaninfos = next (chans, chan) - end - else - weechat.print("no channel") - end -else - weechat.print("error while getting channels") -end -</screen> - </para> - </section> - - <section id="secScript_get_nick_info"> - <title>get_nick_info</title> - - <para> - Perl prototype: - <command> - weechat::get_nick_info(server, channel); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_nick_info(server, channel) - </command> - </para> - <para> - Return list of nicks for a channel. - </para> - <para> - Return value: list of nicks on channel - (see <xref linkend="secAPI_get_nick_info" />). - </para> - <para> - Examples: -<screen> -# perl -my $nicks = weechat::get_nick_info("freenode", "#weechat"); -if ($nicks) -{ - while (my ($nickname, $nickinfos) = each %$nicks) - { - while ( my ($key, $value) = each %$nickinfos) - { - weechat::print("$nickname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("no nick"); -} - -# python -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks != None: - if nicks == {}: - weechat.prnt("no nick") - else: - for n in nicks: - for f in nicks[n]: - weechat.prnt("%s -> %s = '%s'" % (n, f, str(nicks[n][f]))) -else: - weechat.prnt("error while getting nicks") - -# ruby -nicks = Weechat.get_nick_info("freenode", "#weechat") -if nicks != nil - if nicks == {} - Weechat.print("no nick") - else - nicks.each do |nk, nattr| - nattr.each do |key, value| - Weechat.print("#{nk} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("error while getting nicks") -end - --- lua -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks ~= nil then - if nicks then - nick, nickinfos = next (nicks, nil) - while (nick) do - key, value = next (nickinfos, nil) - while (key) do - weechat.print(nick.." -> "..key.." = '"..value.."'") - key, value = next (nickinfos, key) - end - nick, nickinfos = next (nicks, nick) - end - else - weechat.print("no nick") - end -else - weechat.print("error while getting nicks") -end -</screen> - </para> - </section> - - <section id="secScript_get_config"> - <title>get_config</title> - - <para> - Perl prototype: - <command> - weechat::get_config(option); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_config(option) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_config(option) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_config(option) - </command> - </para> - <para> - Return value of a WeeChat config option. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>option</option>: name of option to read - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: option value, empty string if not found. - </para> - <para> - Examples: -<screen> -# perl -$value1 = weechat::get_config("look_nicklist"); -$value2 = weechat::get_config("freenode.server_autojoin"); - -# python -value1 = weechat.get_config("look_nicklist") -value2 = weechat.get_config("freenode.server_autojoin") - -# ruby -value1 = Weechat.get_config("look_nicklist") -value2 = Weechat.get_config("freenode.server_autojoin") - --- lua -value1 = weechat.get_config("look_nicklist") -value2 = weechat.get_config("freenode.server_autojoin") -</screen> - </para> - </section> - - <section id="secScript_set_config"> - <title>set_config</title> - - <para> - Perl prototype: - <command> - weechat::set_config(option, value); - </command> - </para> - <para> - Python prototype: - <command> - weechat.set_config(option, value) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.set_config(option, value) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.set_config(option, value) - </command> - </para> - <para> - Update value of a WeeChat config option. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>option</option>: name of option to update - </para> - </listitem> - <listitem> - <para> - <option>value</option>: new value for option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if option was successfully updated, 0 if an error - occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::set_config("look_nicklist", "off"); -weechat::set_config("freenode.server_autojoin", "#weechat"); - -# python -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") - -# ruby -Weechat.set_config("look_nicklist", "off") -Weechat.set_config("freenode.server_autojoin", "#weechat") - --- lua -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") -</screen> - </para> - </section> - - <section id="secScript_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Perl prototype: - <command> - weechat::get_plugin_config(option); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_plugin_config(option) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Return value of a plugin option. Option is read from file - "<literal>~/.weechat/plugins.rc</literal>" and is like: - "<literal>plugin.option=value</literal>" (note: plugin name - is automatically added). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>option</option>: name of option to read - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: value of option, empty string if not found. - </para> - <para> - Examples : -<screen> -# perl -$value = weechat::get_plugin_config("my_var"); - -# python -value = weechat.get_plugin_config("my_var") - -# ruby -value = Weechat.get_plugin_config("my_var") - --- lua -value = weechat.get_plugin_config("my_var") -</screen> - </para> - </section> - - <section id="secScript_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Perl prototype: - <command> - weechat::set_plugin_config(option, value); - </command> - </para> - <para> - Python prototype: - <command> - weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.set_plugin_config(option, value) - </command> - </para> - <para> - Update value of a plugin option. Option is written in file - "<literal>~/.weechat/plugins.rc</literal>" and is like: - "<literal>plugin.option=value</literal>" (note: plugin name - is automatically added). - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>option</option>: name of option to update - </para> - </listitem> - <listitem> - <para> - <option>value</option>: new value for option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Return value: 1 if option was successfully updated, 0 if an error - occurred. - </para> - <para> - Examples: -<screen> -# perl -weechat::set_plugin_config("my_var", "value"); - -# python -weechat.set_plugin_config("my_var", "value") - -# ruby -Weechat.set_plugin_config("my_var", "value") - --- lua -weechat.set_plugin_config("my_var", "value") -</screen> - </para> - </section> - - <section id="secScript_get_irc_color"> - <title>get_irc_color</title> - - <para> - Perl prototype: - <command> - weechat::get_irc_color(color); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_irc_color(color) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Return IRC color index with name. - </para> - <para> - Return value: IRC color index, -1 if color is not found - (see <xref linkend="secAPI_get_irc_color" />). - </para> - <para> - Examples: -<screen> -# perl -my $color_blue = weechat::get_irc_color("blue"); - -# python -color_blue = weechat.get_irc_color("blue") - -# ruby -color_blue = Weechat.get_irc_color("blue") - --- lua -color_blue = weechat.get_irc_color("blue") -</screen> - </para> - </section> - - <section id="secScript_input_color"> - <title>input_color</title> - - <para> - Perl prototype: - <command> - weechat::input_color(color); - </command> - </para> - <para> - Python prototype: - <command> - weechat.input_color(color) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.input_color(color) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.input_color(color) - </command> - </para> - <para> - Add color in input buffer. - </para> - <para> - Return value: none. - </para> - <para> - Examples: -<screen> -# perl -weechat::input_color(weechat::get_irc_color("blue"), 10, 5); - -# python -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) - -# ruby -Weechat.input_color(Weechat.get_irc_color("blue"), 10, 5) - --- lua -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) -</screen> - </para> - </section> - - <section id="secScript_get_window_info"> - <title>get_window_info</title> - - <para> - Perl prototype: - <command> - weechat::get_window_info(); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_window_info() - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_window_info() - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_window_info() - </command> - </para> - <para> - Return list of WeeChat windows. - </para> - <para> - Return value: list of WeeChat windows - (see <xref linkend="secAPI_get_window_info" />). - </para> - <para> - Examples: -<screen> -# perl -my @wf = weechat::get_window_info(); -if (@wf) -{ - weechat::print("**** windows infos ****"); - foreach my $w (@wf) - { - while ( my ($key, $value) = each %$w) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** no window info ****"); -} - -# python -wf = weechat.get_window_info() -if wf != None and wf != []: - weechat.prnt ("**** windows infos ****") - for w in wf: - for i in w: - weechat.prnt (" > %s => %s" % (i, w[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** no window info ****") - -# ruby -wf = Weechat.get_window_info() -if wf != nil and wf != [] - Weechat.print("**** windows infos ****") - wf.each do |w| - w.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** no window info ****") -end - --- lua -wf = weechat.get_window_info() -if wf then - weechat.print ("**** windows infos ****") - w, winfos = next (wf, nil) - while (w) do - key, value = next (winfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (winfos, key) - end - weechat.print ("----------------------") - w, winfos = next (wf, w) - end -else - weechat.print("**** no window info ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Perl prototype: - <command> - weechat::get_buffer_info(); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_buffer_info() - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Return list of WeeChat buffers. - </para> - <para> - Return value: list of WeeChat buffers - (see <xref linkend="secAPI_get_buffer_info" />). - </para> - <para> - Examples: -<screen> -# perl -my $bf = weechat::get_buffer_info(); -if ($bf) -{ - while ( my ($nobuf, $binfos) = each %$bf) - { - while ( my ($key, $value) = each %$binfos) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** no buffer info ****"); -} - -# python -bf = weechat.get_buffer_info() -if bf != None and bf != {}: - for b in bf: - weechat.prnt ("**** info for buffer no %d ****" % b) - for c in bf[b]: - weechat.prnt (" > %s => %s" % (c, bf[b][c])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** no buffer info ****") - -# ruby -bf = Weechat.get_buffer_info() -if bf != nil and bf != {} - bf.each do |n, c| - Weechat.print("**** info for buffer no #{n} ****") - c.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** no buffer info ****") -end - --- lua -bf = weechat.get_buffer_info() -if bf then - b, binfos = next (bf, nil) - while (b) do - weechat.print("**** info for buffer no " .. b .. " ****") - key, value = next (binfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (binfos, key) - end - weechat.print ("----------------------") - b, infos = next (bf, b) - end -else - weechat.print("**** no buffer info ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Perl prototype: - <command> - weechat::get_buffer_data(server, channel); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Return content of buffer. - </para> - <para> - Return value: list of lines for buffer - (see <xref linkend="secAPI_get_buffer_data" />). - </para> - <para> - Examples: -<screen> -# perl -my $server = weechat::get_info("server"); -my $channel = weechat::get_info("channel"); -my @bc = weechat::get_buffer_data($server, $channel); -if (@bc) -{ - weechat::print("**** buffer data for '$channel'\@'$server' ****"); - foreach my $l (@bc) { - while ( my ($key, $value) = each %$l) { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** no buffer data ****"); -} - -# python -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc != None and bc != []: - weechat.prnt ("**** buffer data for '%s'@'%s' ****" % (channel, server)) - for l in bc: - for i in l: - weechat.prnt (" > %s => %s" % (i, l[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** no buffer data ****") - -# ruby -server = Weechat.get_info("server") -channel = Weechat.get_info("channel") -bc = Weechat.get_buffer_data(server, channel) -if bc != nil and bc != [] - Weechat.print("**** buffer data for '#{channel}'@'#{server}' ****") - bc.each do |l| - l.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** no buffer data ****") -end - --- lua -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc then - b, bdatas = next (bc, nil) - weechat.print("**** buffer data for '" .. channel .. "'@'" .. server .. "' ****") - while (b) do - key, value = next (bdatas, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (bdatas, key) - end - weechat.print ("----------------------") - b, bdatas = next (bc, b) - end -else - weechat.print("**** no buffer data ****") -end -</screen> - </para> - </section> - - </section> - - </section> - - </chapter> - - <!-- ======================== Auteurs / Support ========================= --> - - <chapter id="chapAuthorsSupport"> - <title>Authors / Support</title> - - <para> - This chapter lists authors and contributors for WeeChat, and - shows ways to get support. - </para> - - <section id="secAuthors"> - <title>Authors</title> - - <para> - WeeChat is developed by: - <itemizedlist> - <listitem> - <para> - <emphasis>FlashCode (S�bastien Helleu)</emphasis> - <email>flashcode AT flashtux.org</email> - - main developer - </para> - </listitem> - <listitem> - <para> - <emphasis>kolter (Emmanuel Bouthenot)</emphasis> - <email>kolter AT openics.org</email> - - developer - </para> - </listitem> - <listitem> - <para> - <emphasis>Ptitlouis</emphasis> - <email>ptitlouis AT sysif.net</email> - - Debian packager - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secContributors"> - <title>Contributors</title> - - <para> - Following people contributed to WeeChat: - <itemizedlist> - <listitem> - <para> - <emphasis>Jiri Golembiovsky</emphasis> - - czech translation, patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Rudolf Polzer</emphasis> - - patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Jim Ramsay</emphasis> - - patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Odin</emphasis> - - SuSE RPM - </para> - </listitem> - <listitem> - <para> - <emphasis>Pistos</emphasis> - - patches - </para> - </listitem> - <listitem> - <para> - <emphasis>Gwenn</emphasis> - - patches - </para> - </listitem> - <listitem> - <para> - <emphasis>voroskoi</emphasis> - - hungarian translation - </para> - </listitem> - <listitem> - <para> - <emphasis>Frank Zacharias</emphasis> - - german translation - </para> - </listitem> - <listitem> - <para> - <emphasis>Pavel Shevchuk</emphasis> - - russian translation - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSupport"> - <title>Get support</title> - - <para> - Before asking for support, be sure you've read documentation and FAQ - provided with WeeChat (documentation is this document, if you don't - read all lines until this sentence, you can start again!) - </para> - - <para> - <itemizedlist> - <listitem> - <para> - IRC: server "<literal>irc.freenode.net</literal>", - channel "<literal>#weechat</literal>" - </para> - </listitem> - <listitem> - <para> - WeeChat forum: - <ulink url="http://forums.flashtux.org"> - http://forums.flashtux.org - </ulink> - </para> - </listitem> - <listitem> - <para> - Mailing list: - <itemizedlist> - <listitem> - <para> - To subscribe: - <ulink url="http://mail.nongnu.org/mailman/listinfo/weechat-support"> - http://mail.nongnu.org/mailman/listinfo/weechat-support - </ulink> - </para> - </listitem> - <listitem> - <para> - To send a mail on mailing list: - <email>weechat-support@nongnu.org</email> - </para> - </listitem> - </itemizedlist> - Mailing list archives are available here: - <ulink url="http://mail.nongnu.org/archive/html/weechat-support"> - http://mail.nongnu.org/archive/html/weechat-support - </ulink> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </chapter> - -</book> diff --git a/weechat/doc/en/weechat_commands.xml b/weechat/doc/en/weechat_commands.xml deleted file mode 100644 index 074565c35..000000000 --- a/weechat/doc/en/weechat_commands.xml +++ /dev/null @@ -1,277 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>alias [alias_name [command [arguments]]]</command> -<programlisting> -create an alias for a command - -alias_name: name of alias - command: command name (WeeChat or IRC command, many commands can be separated by semicolons) - arguments: arguments for command - -</programlisting> -<command>is replaced by all arguments.</command> -<programlisting>Variables $nick, $channel and $server are replaced by current nick/channel/server. - -</programlisting> -<command>buffer [action [args] | number | [[server] [channel]]]</command> -<programlisting> -manage buffers - - action: action to do: - move: move buffer in the list (may be relative, for example -1) - close: close buffer (optional arg is part message, for a channel) - list: list open buffers (no parameter implies this list) - notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part) - (when executed on server buffer, this sets default notify level for whole server) - scroll: scroll in history (may be relative, and may end by a letter: s=sec, m=min, h=hour, d=day, M=month, y=year); if there is only letter, then scroll to beginning of this item - - number: jump to buffer by number -server, -channel: jump to buffer by server and/or channel name - -Examples: - move buffer: /buffer move 5 - close buffer: /buffer close this is part msg - set notify: /buffer notify 2 - scroll 1 day up: /buffer scroll 1d == /buffer scroll -1d == /buffer scroll -24h -scroll to beginning - of this day: /buffer scroll d - scroll 15 min down: /buffer scroll +15m - scroll 20 msgs up: /buffer scroll -20 - jump to #weechat: /buffer #weechat - -</programlisting> -<command>builtin command</command> -<programlisting> -launch WeeChat/IRC builtin command (do not look at plugins handlers or aliases) - -command: command to execute (a '/' is automatically added if not found at beginning of command) - - -</programlisting> -<command>clear [-all | number [number ...]]</command> -<programlisting> -clear window(s) - - -all: clear all buffers -number: clear buffer by number - -</programlisting> -<command>connect [-all [-nojoin] | servername [servername ...] [-nojoin] | hostname [-port port] [-ipv6] [-ssl]]</command> -<programlisting> -connect to server(s) - - -all: connect to all servers -servername: internal server name to connect - -nojoin: do not join any channel (even if autojoin is enabled on server) - hostname: hostname to connect, creating temporary server - port: port for server (integer, default is 6667) - ipv6: use IPv6 protocol - ssl: use SSL protocol - -</programlisting> -<command>disconnect [-all | servername [servername ...]]</command> -<programlisting> -disconnect from server(s) - - -all: disconnect from all servers -servername: server name to disconnect - -</programlisting> -<command>dcc action [nickname [file]]</command> -<programlisting> -starts DCC (file or chat) or close chat - - action: 'send' (file) or 'chat' or 'close' (chat) -nickname: nickname to send file or chat - file: filename (on local host) - -</programlisting> -<command>debug dump | windows</command> -<programlisting> -print debug messages - - dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes) -windows: display windows tree - -</programlisting> -<command>help [command]</command> -<programlisting> -display help about commands - -command: name of a WeeChat or IRC command - -</programlisting> -<command>history [clear | value]</command> -<programlisting> -show buffer command history - -clear: clear history -value: number of history entries to show - -</programlisting> -<command>ignore [mask [[type | command] [channel [server]]]]</command> -<programlisting> -ignore IRC messages and/or hosts - - mask: nick or host mask to ignore - type: type of message to ignore (action, ctcp, dcc, pv) -command: IRC command -channel: name of channel for ignore - server: name of server for ignore - -For each argument, '*' means all. -Without argument, /ignore command lists all defined ignore. - -</programlisting> -<command>key [key [function/command]] [unbind key] [functions] [call function ["args"]] [reset -yes]</command> -<programlisting> -bind/unbind keys - - key: display or bind this key to an internal function or a command (beginning by "/") - unbind: unbind a key -functions: list internal functions for key bindings - call: call a function by name (with optional arguments) - reset: restore bindings to the default values and delete ALL personal bindings (use carefully!) - -</programlisting> -<command>plugin [list [name]] | [listfull [name]] | [load filename] | [autoload] | [reload [name]] | [unload [name]]</command> -<programlisting> -list/load/unload plugins - - list: list loaded plugins -listfull: list loaded plugins with detailed info for each plugin - load: load a plugin -autoload: autoload plugins in system or user directory - reload: reload one plugin (if no name given, unload all plugins, then autoload plugins) - unload: unload one or all plugins - -Without argument, /plugin command lists loaded plugins. - -</programlisting> -<command>reconnect [-all [-nojoin] | servername [servername ...] [-nojoin]]</command> -<programlisting> -reconnect to server(s) - - -all: reconnect to all servers -servername: server name to reconnect - -nojoin: do not join any channel (even if autojoin is enabled on server) - -</programlisting> -<command>save [file]</command> -<programlisting> -save config to disk - -file: filename for writing config - -</programlisting> -<command>server [list [servername]] | [listfull [servername]] | [servername] | [add servername hostname [-port port] [-temp] [-auto | -noauto] [-ipv6] [-ssl] [-pwd password] [-nicks nick1 nick2 nick3] [-username username] [-realname realname] [-command command] [-autojoin channel[,channel]] ] | [copy server newservername] [rename servername newservername] | [keep servername] [del servername]</command> -<programlisting> -list, add or remove servers - - list: list servers (no parameter implies this list) - listfull: list servers with detailed info for each server - add: create a new server -servername: server name, for internal and display use - hostname: name or IP address of server - port: port for server (integer, default is 6667) - temp: create temporary server (not saved in config file) - auto: automatically connect to server when WeeChat starts - noauto: do not connect to server when WeeChat starts (default) - ipv6: use IPv6 protocol - ssl: use SSL protocol - password: password for server - nick1: first nick for server - nick2: alternate nick for server - nick3: second alternate nick for server - username: user name - realname: real name of user - copy: duplicate a server - rename: rename a server - keep: keep server in config file (for temporary servers only) - del: delete a server - -</programlisting> -<command>set [option [ = value]]</command> -<programlisting> -set config options - -option: name of an option (if name is full and no value is given, then help is displayed on option) - value: value for option - -Option may be: servername.server_xxx where "servername" is an internal server name and "xxx" an option for this server. - -</programlisting> -<command>setp [option [ = value]]</command> -<programlisting> -set plugin config options - -option: name of a plugin option - value: value for option - -Option is format: plugin.option, example: perl.myscript.item1 - -</programlisting> -<command>unalias alias_name</command> -<programlisting> -remove an alias - -alias_name: name of alias to remove - -</programlisting> -<command>unignore [number | [mask [[type | command] [channel [server]]]]]</command> -<programlisting> -unignore IRC messages and/or hosts - - number: # of ignore to unignore (number is displayed by list of ignore) - mask: nick or host mask to unignore - type: type of message to unignore (action, ctcp, dcc, pv) -command: IRC command -channel: name of channel for unignore - server: name of server for unignore - -For each argument, '*' means all. -Without argument, /unignore command lists all defined ignore. - -</programlisting> -<command>upgrade [path_to_binary]</command> -<programlisting> -upgrade WeeChat without disconnecting from servers - -path_to_binary: path to WeeChat binary (default is current binary) - -This command run again a WeeChat binary, so it should have been compiled or installed with a package manager before running this command. - -</programlisting> -<command>uptime [-o]</command> -<programlisting> -show WeeChat uptime - --o: send uptime on current channel as an IRC message - -</programlisting> -<command>window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]]</command> -<programlisting> -manage windows - - list: list open windows (no parameter implies this list) - -1: jump to previous window - +1: jump to next window - b#: jump to next window displaying buffer number # - up: switch to window above current one - down: switch to window below current one - left: switch to window on the left - right: switch to window on the right -splith: split current window horizontally -splitv: split current window vertically -resize: resize window size, new size is <pct> pourcentage of parent window - merge: merge window with another (all = keep only one window) - -For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4 - -</programlisting> diff --git a/weechat/doc/en/weechat_quickstart.en.txt b/weechat/doc/en/weechat_quickstart.en.txt deleted file mode 100644 index 46cca93a5..000000000 --- a/weechat/doc/en/weechat_quickstart.en.txt +++ /dev/null @@ -1,107 +0,0 @@ -WeeChat quick start guide (english version) -========================= - -1. Launch weechat - - According to choosed GUI, you have to launch: - - weechat-curses for Curses GUI - - weechat-gtk for Gtk GUI (under development) - - weechat-qt for Qt GUI (not developed) - - weechat-wxwidgets for WxWidgets GUI (not developed) - -2. Online help / options - - WeeChat has help for all commands, just issue /help - To get help on a command, issue /help command - - To set options, use /set option = value - You can use /set option with partial name (display all options - containg letters), or with only a full option name without value - (to see long help for option). - - Important note: settings are saved when WeeChat ends (or with "/save" - command). Do NOT edit setup file while WeeChat is running, because WeeChat - may write this file at any time, and it's not possible to reload it. - To change any settings, use "/set" command, WeeChat immediately uses new - settings. - -3. Create a server - - For example irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (/help server for full command help) - -4. Set custom server options - - Nicks: - /set quakenet.server_nick1 = "mynick" - /set quakenet.server_nick2 = "mynick2" - /set quakenet.server_nick3 = "mynick3" - - Username/realname: - /set quakenet.server_username = "My username" - /set quakenet.server_realname = "My real name" - - Auto-connect to server: - /set quakenet.server_autoconnect = on - - Auto-join for some channels: - /set quakenet.server_autojoin = "#chan1,#chan2" - - Other options: - You can see servers options and values with /set quakenet - To set an option, use /set quakenet.server_option = value - -5. Connect to server and auto-join channels: - - /connect quakenet - -6. Join/part channels - - Join a channel: - /join #channel - Part a channel: - /part [quit message] - Part a channel and close buffer: - /close [quit message] - (/close is an alias on /buffer close) - -7. Buffer/window management - - You can manage buffers with "/buffer" command and windows - with "/window" command. - For example, to split verticaly screen into a small window (1/3 width), - and a large (2/3), use command: - /window splitv 33 - -8. Key bindings - - According to your keyboard and/or your needs, you can rebind any key - with "/key" command. - A useful key is meta-k (alt-k) to find key codes. - - For example, to bind meta-y (alt-y) to command "/buffer close": - /key (press meta-k) (press meta-y) /buffer close - You'll have a command line like: - /key meta-y /buffer close - -9. Plugins/scripts - - On some distros like Debian, plugins are available via a separate package - (like weechat-plugins). - Plugins are automatically loaded when found. - Many plugins/scripts are available for WeeChat, please look at: - http://weechat.flashtux.org/plugins.php - Please look at WeeChat documentation to load/unload plugins or scripts. - -10. More documentation - - You can now use WeeChat and read FAQ/documentation for any other question: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Enjoy WeeChat! - --- -(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org> -This document is part of WeeChat and is distributed under GPL licence. diff --git a/weechat/doc/fr/Makefile.am b/weechat/doc/fr/Makefile.am deleted file mode 100644 index 279e24040..000000000 --- a/weechat/doc/fr/Makefile.am +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = fr -BOOK = weechat.$(LANGCODE) -BOOK_INCLUDE = weechat_commands.xml irc_commands.xml key_functions.xml config.xml -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(BOOK).xml $(BOOK_INCLUDE) $(QUICKSTART) - -if DBLATEX_FOUND -PDF = pdf-stamp -endif - -docdir = $(datadir)/doc/$(PACKAGE) - -all-local: html-stamp $(PDF) - -# HTML output with chunks (many pages) - -html: html-stamp - -html-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html/ - xsltproc -o html/ ../weechat-html.xsl $(BOOK).xml || true - cp ../weechat-doc.css html/ - touch html-stamp - -# HTML output, all in one page - -html1: html1-stamp - -html1-stamp: $(BOOK).xml $(BOOK_INCLUDE) ../weechat-html-one.xsl ../weechat-doc.css - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - mkdir -p html1/ - xsltproc -o html1/$(BOOK).html ../weechat-html-one.xsl $(BOOK).xml || true - cp ../weechat-doc.css html1/ - touch html1-stamp - -# PDF output - -pdf: pdf-stamp - -pdf-stamp: $(BOOK).xml $(BOOK_INCLUDE) - echo "<pubdate>`date '+%F %T'`</pubdate>" >date.xml - dblatex -c ../dblatex.conf $(BOOK).xml || true - touch pdf-stamp - -# install docs - -install-data-hook: - $(mkinstalldirs) $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) html/* $(DESTDIR)$(docdir)/html/$(LANGCODE)/ - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ -if DBLATEX_FOUND - $(INSTALL_DATA) $(BOOK).pdf $(DESTDIR)$(docdir)/ -endif - -# clean - -clean-local: - -rm -f $(BOOK).html $(BOOK).pdf $(BOOK).txt date.xml - -rm -rf html/ html1/ - -rm -f html-stamp html1-stamp pdf-stamp diff --git a/weechat/doc/fr/config.xml b/weechat/doc/fr/config.xml deleted file mode 100644 index b04b0c81d..000000000 --- a/weechat/doc/fr/config.xml +++ /dev/null @@ -1,1281 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><option>look_save_on_exit</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Sauvegarder la configuration en quittant</entry> -</row> -<row> - <entry><option>look_set_title</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>D�finit le titre de la fen�tre (terminal pour l'interface Curses) avec le nom et la version</entry> -</row> -<row> - <entry><option>look_startup_logo</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher le logo WeeChat au d�marrage</entry> -</row> -<row> - <entry><option>look_startup_version</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher la version de WeeChat au d�marrage</entry> -</row> -<row> - <entry><option>look_weechat_slogan</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'the geekest IRC client!'</entry> - <entry>Slogan WeeChat (si vide, le slogan ne sera pas utilis�)</entry> -</row> -<row> - <entry><option>look_one_server_buffer</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Utiliser le m�me tampon pour tous les serveurs</entry> -</row> -<row> - <entry><option>look_open_near_server</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Ouvrir les nouveaux canaux/priv�s pr�s du serveur</entry> -</row> -<row> - <entry><option>look_scroll_amount</option></entry> - <entry>entier</entry> - <entry>entre 1 et 2147483647</entry> - <entry>3</entry> - <entry>Nombre de lignes pour le d�filement avec scroll_up et scroll_down</entry> -</row> -<row> - <entry><option>look_buffer_timestamp</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'[%H:%M:%S]'</entry> - <entry>Format de date/heure pour les tampons</entry> -</row> -<row> - <entry><option>look_color_nicks_number</option></entry> - <entry>entier</entry> - <entry>entre 1 et 10</entry> - <entry>10</entry> - <entry>Nombre de couleurs � utiliser pour les couleurs des pseudos</entry> -</row> -<row> - <entry><option>look_color_actions</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher les actions avec diff�rentes couleurs</entry> -</row> -<row> - <entry><option>look_nicklist</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher la fen�tre des pseudos (pour les fen�tres de canaux)</entry> -</row> -<row> - <entry><option>look_nicklist_position</option></entry> - <entry>cha�ne</entry> - <entry>'left', 'right', 'top', 'bottom'</entry> - <entry>'right'</entry> - <entry>Position de la fen�tre des pseudos (haut (top), gauche (left), droite (right, par d�faut), bas (bottom))</entry> -</row> -<row> - <entry><option>look_nicklist_min_size</option></entry> - <entry>entier</entry> - <entry>entre 0 et 100</entry> - <entry>0</entry> - <entry>Taille minimum pour la fen�tre des pseudos (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille minimum))</entry> -</row> -<row> - <entry><option>look_nicklist_max_size</option></entry> - <entry>entier</entry> - <entry>entre 0 et 100</entry> - <entry>0</entry> - <entry>Taille maximum pour la fen�tre des pseudos (largeur ou hauteur, selon look_nicklist_position (0 = pas de taille maximum; si min = max et > 0, alors la taille est fixe))</entry> -</row> -<row> - <entry><option>look_nicklist_separator</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>S�parateur entre la discussion et la liste de pseudos</entry> -</row> -<row> - <entry><option>look_no_nickname</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'-cmd-'</entry> - <entry>Texte � afficher en lieu et place du pseudo lorsque la connexion n'est pas active</entry> -</row> -<row> - <entry><option>look_nickmode</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher le mode du pseudo ((half)op/voice) devant chaque utilisateur</entry> -</row> -<row> - <entry><option>look_nickmode_empty</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Afficher un espace si le mode du pseudo n'est pas (half)op/voice</entry> -</row> -<row> - <entry><option>look_nick_prefix</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Texte � afficher avant le pseudo dans la fen�tre de discussion</entry> -</row> -<row> - <entry><option>look_nick_suffix</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>' |'</entry> - <entry>Texte � afficher apr�s le pseudo dans la fen�tre de discussion</entry> -</row> -<row> - <entry><option>look_align_nick</option></entry> - <entry>cha�ne</entry> - <entry>'none', 'left', 'right'</entry> - <entry>'right'</entry> - <entry>Alignement des pseudos (taille fixe pour les pseudos dans la fen�tre de discussion (none, left, right))</entry> -</row> -<row> - <entry><option>look_align_other</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Alignement pour les autres messages (ne commen�ant pas par un pseudo)</entry> -</row> -<row> - <entry><option>look_align_size</option></entry> - <entry>entier</entry> - <entry>entre 8 et 64</entry> - <entry>14</entry> - <entry>Taille pour l'alignement des pseudos et autres messages</entry> -</row> -<row> - <entry><option>look_align_size_max</option></entry> - <entry>entier</entry> - <entry>entre 8 et 64</entry> - <entry>20</entry> - <entry>Taille maximum pour l'alignement des pseudos et autres messages (doit �tre >= � look_align_size)</entry> -</row> -<row> - <entry><option>look_nick_completor</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>':'</entry> - <entry>La cha�ne affich�e apr�s la compl�tion des pseudos</entry> -</row> -<row> - <entry><option>look_nick_completion_ignore</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'[]-^'</entry> - <entry>Caract�res � ignorer pour la compl�tion des pseudos</entry> -</row> -<row> - <entry><option>look_nick_completion_smart</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Compl�tion intelligente pour les pseudos (compl�te d'abord avec les personnes qui ont parl� r�cemment)</entry> -</row> -<row> - <entry><option>look_nick_complete_first</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Compl�ter seulement avec le premier pseudo trouv�</entry> -</row> -<row> - <entry><option>look_infobar</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Active la barre d'infos</entry> -</row> -<row> - <entry><option>look_infobar_timestamp</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%B, %A %d %Y'</entry> - <entry>Format de date/heure dans la barre d'infos</entry> -</row> -<row> - <entry><option>look_infobar_seconds</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Afficher les secondes pour l'heure dans la barre d'infos</entry> -</row> -<row> - <entry><option>look_infobar_delay_highlight</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>7</entry> - <entry>D�lai (en secondes) pour la notification des messages dans la barre d'infos (0 = d�sactiver les notifications dans la barre d'infos)</entry> -</row> -<row> - <entry><option>look_hotlist_names_count</option></entry> - <entry>entier</entry> - <entry>entre 0 et 32</entry> - <entry>3</entry> - <entry>Nombre maximum de noms dans la liste d'activit� (0 = pas de nom affich�, seulement les num�ros de tampons)</entry> -</row> -<row> - <entry><option>look_hotlist_names_level</option></entry> - <entry>entier</entry> - <entry>entre 1 et 15</entry> - <entry>12</entry> - <entry>Niveau pour l'affichage des noms dans la liste d'activit� (combinaison de: 1=join/part, 2=message, 4=priv�, 8=highlight, par exemple: 12=priv�+highlight)</entry> -</row> -<row> - <entry><option>look_hotlist_names_length</option></entry> - <entry>entier</entry> - <entry>entre 0 et 32</entry> - <entry>0</entry> - <entry>Nombre maximum des noms dans la liste d'activit� (0 = pas de limite)</entry> -</row> -<row> - <entry><option>look_hotlist_sort</option></entry> - <entry>cha�ne</entry> - <entry>'group_time_asc', 'group_time_desc', 'group_number_asc', 'group_number_desc', 'number_asc', 'number_desc'</entry> - <entry>'group_time_asc'</entry> - <entry>Type de tri pour la liste d'activit� (group_time_asc (par d�faut), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)</entry> -</row> -<row> - <entry><option>look_day_change</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Affiche un message quand le jour change</entry> -</row> -<row> - <entry><option>look_day_change_timestamp</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%a, %d %b %Y'</entry> - <entry>Format de date pour la date affich�e quand le jour a chang�</entry> -</row> -<row> - <entry><option>look_read_marker</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>' '</entry> - <entry>Utiliser un marqueur sur les serveurs/canaux pour montrer la premi�re ligne non lue</entry> -</row> -<row> - <entry><option>look_input_format</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'[%n(%m)] '</entry> - <entry>Format pour l'invite de la zone de saisie ('%c' est remplac� par le canal ou serveur, '%n' par le pseudo et '%m' par les modes du pseudo)</entry> -</row> -<row> - <entry><option>look_paste_max_lines</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>3</entry> - <entry>Nombre maximum de lignes pour la d�tection de collage sans demander � l'utilisateur (0 = d�sactiver cette fonctionnalit�)</entry> -</row> -<row> - <entry><option>col_real_white</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Si activ�, utilise la vraie couleur blanche, d�sactiv� par d�faut pour les terminaux avec un fond blanc (si vous n'utilisez jamais de fond blanc, vous devriez activer cette option pour voir du vrai blanc au lieu de la couleur d'avant plan par d�faut du terminal)</entry> -</row> -<row> - <entry><option>col_separator</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur pour les s�parateurs de fen�tres (quand divis�)</entry> -</row> -<row> - <entry><option>col_title</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour la barre de titre</entry> -</row> -<row> - <entry><option>col_title_more</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightmagenta'</entry> - <entry>Couleur pour les '+' lors du d�filement du titre</entry> -</row> -<row> - <entry><option>col_title_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur de fond pour la barre de titre</entry> -</row> -<row> - <entry><option>col_chat</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour le texte de discussion</entry> -</row> -<row> - <entry><option>col_chat_time</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour l'heure dans la fen�tre de discussion</entry> -</row> -<row> - <entry><option>col_chat_time_sep</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'brown'</entry> - <entry>Couleur pour la s�paration de l'heure (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_prefix1</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightcyan'</entry> - <entry>Couleur pour le 1er et le 3�me caract�re du pr�fixe</entry> -</row> -<row> - <entry><option>col_chat_prefix2</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour le caract�re du milieu du pr�fixe</entry> -</row> -<row> - <entry><option>col_chat_server</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'brown'</entry> - <entry>Couleur pour le nom du serveur</entry> -</row> -<row> - <entry><option>col_chat_join</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour la fl�che du join (pr�fixe)</entry> -</row> -<row> - <entry><option>col_chat_part</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightred'</entry> - <entry>Couleur pour la fl�che du part/quit (pr�fixe)</entry> -</row> -<row> - <entry><option>col_chat_nick</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightcyan'</entry> - <entry>Couleur pour les pseudos dans les actions (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_host</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur pour les h�tes (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_channel</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour les canaux dans les actions (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_dark</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'green'</entry> - <entry>Couleur pour les s�parateurs sombres (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_highlight</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'yellow'</entry> - <entry>Couleur pour le pseudo surlign� (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_chat_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur de fond pour la fen�tre de discussion</entry> -</row> -<row> - <entry><option>col_chat_read_marker</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'yellow'</entry> - <entry>Couleur pour le marqueur de donn�es non lues</entry> -</row> -<row> - <entry><option>col_chat_read_marker_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'magenta'</entry> - <entry>Couleur de fond pour le marqueur de donn�es non lues</entry> -</row> -<row> - <entry><option>col_status</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour la barre de statut</entry> -</row> -<row> - <entry><option>col_status_delimiters</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur pour les d�limiteurs de la barre de statut</entry> -</row> -<row> - <entry><option>col_status_channel</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour le canal courant dans la barre de statut</entry> -</row> -<row> - <entry><option>col_status_data_msg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'yellow'</entry> - <entry>Couleur pour une fen�tre avec de nouvelles infos (barre de statut)</entry> -</row> -<row> - <entry><option>col_status_private</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightmagenta'</entry> - <entry>Couleur pour une fen�tre avec un message priv� (barre de statut)</entry> -</row> -<row> - <entry><option>col_status_highlight</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightred'</entry> - <entry>Couleur pour une fen�tre avec un highlight (barre de statut)</entry> -</row> -<row> - <entry><option>col_status_data_other</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour une fen�tre avec des nouvelles donn�es (pas des infos) (barre de statut)</entry> -</row> -<row> - <entry><option>col_status_more</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour une fen�tre avec des nouvelles donn�es (barre de statut)</entry> -</row> -<row> - <entry><option>col_status_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur de fond pour la fen�tre de statut</entry> -</row> -<row> - <entry><option>col_infobar</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'black'</entry> - <entry>Couleur pour la barre d'infos</entry> -</row> -<row> - <entry><option>col_infobar_delimiters</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur pour les d�limiteurs de la barre d'infos</entry> -</row> -<row> - <entry><option>col_infobar_highlight</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour la notification dans la barre d'infos</entry> -</row> -<row> - <entry><option>col_infobar_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur de fond pour la fen�tre de barre d'infos</entry> -</row> -<row> - <entry><option>col_input</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour le texte saisi</entry> -</row> -<row> - <entry><option>col_input_server</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'brown'</entry> - <entry>Couleur pour le texte saisi (nom du serveur)</entry> -</row> -<row> - <entry><option>col_input_channel</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour le texte saisi (nom du canal)</entry> -</row> -<row> - <entry><option>col_input_nick</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightcyan'</entry> - <entry>Couleur pour le texte saisi (pseudo)</entry> -</row> -<row> - <entry><option>col_input_delimiters</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur pour le texte saisi (d�limiteurs)</entry> -</row> -<row> - <entry><option>col_input_text_not_found</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'red'</entry> - <entry>Couleur pour le texte non trouv�</entry> -</row> -<row> - <entry><option>col_input_actions</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour les actions dans la fen�tre de saisie</entry> -</row> -<row> - <entry><option>col_input_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur de fond pour la fen�tre de saisie</entry> -</row> -<row> - <entry><option>col_nick</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour les pseudos</entry> -</row> -<row> - <entry><option>col_nick_away</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur pour les pseudos absents</entry> -</row> -<row> - <entry><option>col_nick_chanowner</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour le symbole propri�taire du canal (sp�cifique � unrealircd)</entry> -</row> -<row> - <entry><option>col_nick_chanadmin</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour le symbole administrateur du canal (sp�cifique � unrealircd)</entry> -</row> -<row> - <entry><option>col_nick_op</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour le symbole op�rateur</entry> -</row> -<row> - <entry><option>col_nick_halfop</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightmagenta'</entry> - <entry>Couleur pour le symbole demi-op�rateur</entry> -</row> -<row> - <entry><option>col_nick_voice</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'yellow'</entry> - <entry>Couleur pour le symbole voix</entry> -</row> -<row> - <entry><option>col_nick_user</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur pour le symbole utilisateur</entry> -</row> -<row> - <entry><option>col_nick_more</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightmagenta'</entry> - <entry>Couleur pour les '+' lors du d�filement des pseudos</entry> -</row> -<row> - <entry><option>col_nick_sep</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur pour le s�parateur de pseudos</entry> -</row> -<row> - <entry><option>col_nick_self</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour le pseudo local</entry> -</row> -<row> - <entry><option>col_nick_color1</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'cyan'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color2</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'magenta'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color3</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'green'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color4</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'brown'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color5</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightblue'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color6</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color7</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightcyan'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color8</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightmagenta'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color9</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_color10</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'blue'</entry> - <entry>Couleur pour le pseudo</entry> -</row> -<row> - <entry><option>col_nick_private</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur pour l'autre pseudo dans la fen�tre priv�e</entry> -</row> -<row> - <entry><option>col_nick_bg</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'default'</entry> - <entry>Couleur de fond pour les pseudos</entry> -</row> -<row> - <entry><option>col_chat_dcc_selected</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'white'</entry> - <entry>Couleur pour le DCC s�lectionn� (fen�tre de discussion)</entry> -</row> -<row> - <entry><option>col_dcc_waiting</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightcyan'</entry> - <entry>Couleur pour le statut dcc "attente"</entry> -</row> -<row> - <entry><option>col_dcc_connecting</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'yellow'</entry> - <entry>Couleur pour le statut dcc "connexion"</entry> -</row> -<row> - <entry><option>col_dcc_active</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightblue'</entry> - <entry>Couleur pour le statut dcc "actif"</entry> -</row> -<row> - <entry><option>col_dcc_done</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightgreen'</entry> - <entry>Couleur pour le statut dcc "termin�"</entry> -</row> -<row> - <entry><option>col_dcc_failed</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightred'</entry> - <entry>Couleur pour le statut dcc "�chou�"</entry> -</row> -<row> - <entry><option>col_dcc_aborted</option></entry> - <entry>couleur</entry> - <entry>couleur Curses ou Gtk</entry> - <entry>'lightred'</entry> - <entry>Couleur pour le statut dcc "interrompu"</entry> -</row> -<row> - <entry><option>history_max_lines</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>4096</entry> - <entry>Nombre maximum de lignes dans l'historique pour un serveur/fen�tre/fen�tre priv�e (0 = sans limite)</entry> -</row> -<row> - <entry><option>history_max_commands</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>100</entry> - <entry>Nombre maximum de commandes utilisateur dans l'historique (0 = sans limite)</entry> -</row> -<row> - <entry><option>history_display_default</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>5</entry> - <entry>Nombre maximum de commandes � afficher par d�faut dans le listing d'historique (0 = sans limite)</entry> -</row> -<row> - <entry><option>log_auto_server</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Enregistrer automatiquement les messages du serveur</entry> -</row> -<row> - <entry><option>log_auto_channel</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Enregistrer automatiquement les conversations des canaux</entry> -</row> -<row> - <entry><option>log_auto_private</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Enregistrer automatiquement les conversations priv�es</entry> -</row> -<row> - <entry><option>log_plugin_msg</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Enregistrer les messages des plugins (scripts)</entry> -</row> -<row> - <entry><option>log_path</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%h/logs/'</entry> - <entry>Chemin pour les conversations sauvegard�es par WeeChat ('%h' sera remplac� par le r�pertoire de base WeeChat, par d�faut: ~/.weechat)</entry> -</row> -<row> - <entry><option>log_timestamp</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%Y %b %d %H:%M:%S'</entry> - <entry>Format de date/heure pour les conversations sauvegard�es (voir strftime(3) pour le format de date/heure)</entry> -</row> -<row> - <entry><option>log_hide_nickserv_pwd</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Masquer le mot de passe affich� par nickserv</entry> -</row> -<row> - <entry><option>irc_display_away</option></entry> - <entry>cha�ne</entry> - <entry>'off', 'local', 'channel'</entry> - <entry>'off'</entry> - <entry>Affiche un message pour l'absence/le retour</entry> -</row> -<row> - <entry><option>irc_show_away_once</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Voir le message d'absence distant une seule fois en priv�</entry> -</row> -<row> - <entry><option>irc_default_msg_part</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'WeeChat %v'</entry> - <entry>Message par d�faut pour le part (quitte un canal) ('%v' sera remplac� par la version de WeeChat dans la cha�ne)</entry> -</row> -<row> - <entry><option>irc_default_msg_quit</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'WeeChat %v'</entry> - <entry>Message de fin par d�faut ('%v' sera remplac� par la version de WeeChat dans la cha�ne)</entry> -</row> -<row> - <entry><option>irc_notice_as_pv</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Afficher les notices comme des messages priv�s</entry> -</row> -<row> - <entry><option>irc_away_check</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>0</entry> - <entry>Intervalle entre deux v�rifications des absences (en minutes, 0 = ne jamais v�rifier)</entry> -</row> -<row> - <entry><option>irc_away_check_max_nicks</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>0</entry> - <entry>Ne pas v�rifier les pseudos absents lorsqu'il y a un nombre important de pseudos (0 = pas de limite)</entry> -</row> -<row> - <entry><option>irc_lag_check</option></entry> - <entry>entier</entry> - <entry>entre 30 et 2147483647</entry> - <entry>60</entry> - <entry>Intervalle entre deux mesures de lag (en secondes)</entry> -</row> -<row> - <entry><option>irc_lag_min_show</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>1</entry> - <entry>Lag minimum � afficher (en secondes)</entry> -</row> -<row> - <entry><option>irc_lag_disconnect</option></entry> - <entry>entier</entry> - <entry>entre 0 et 2147483647</entry> - <entry>5</entry> - <entry>D�connexion apr�s un lag important (en minutes, 0 = ne jamais se d�connecter)</entry> -</row> -<row> - <entry><option>irc_anti_flood</option></entry> - <entry>entier</entry> - <entry>entre 0 et 5</entry> - <entry>2</entry> - <entry>Anti-flood: nombre de secondes entre deux messages utilisateur (0 = pas d'anti-flood)</entry> -</row> -<row> - <entry><option>irc_fifo_pipe</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Cr�er un tube FIFO pour le contr�le � distance</entry> -</row> -<row> - <entry><option>irc_highlight</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Liste des mots pour la notification (s�par�s par des virgules, la comparaison ne tient pas compte de la casse, les mots peuvent commencer ou se terminer par "*" pour une comparaison partielle)</entry> -</row> -<row> - <entry><option>irc_colors_receive</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Si d�sactiv�, les codes couleurs des messages entrants sont ignor�s</entry> -</row> -<row> - <entry><option>irc_colors_send</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Autorise l'utilisateur � envoyer des couleurs avec des codes sp�ciaux (^Cb=gras, ^Cxx=couleur, ^Ccxx,yy=couleur+fond, ^Cu=soulign�, ^Cr=invers�)</entry> -</row> -<row> - <entry><option>irc_send_unknown_commands</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Envoie les commandes inconnues au serveur IRC</entry> -</row> -<row> - <entry><option>dcc_auto_accept_files</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Accepte automatiquement les fichiers dcc entrants</entry> -</row> -<row> - <entry><option>dcc_auto_accept_chats</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Accepte automatiquement les demandes de discussion dcc (� utiliser avec pr�caution !)</entry> -</row> -<row> - <entry><option>dcc_timeout</option></entry> - <entry>entier</entry> - <entry>entre 5 et 2147483647</entry> - <entry>300</entry> - <entry>D�lai d'attente pour les requ�tes dcc (en secondes)</entry> -</row> -<row> - <entry><option>dcc_blocksize</option></entry> - <entry>entier</entry> - <entry>entre 1024 et 102400</entry> - <entry>65536</entry> - <entry>Taille de bloc pour les paquets dcc en octets (d�faut: 65536)</entry> -</row> -<row> - <entry><option>dcc_fast_send</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>N'attend pas les accus�s de r�ception lors de l'envoi de fichier</entry> -</row> -<row> - <entry><option>dcc_port_range</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Restreint le dcc sortant � utiliser des ports dans la plage donn�e (pratique pour le NAT) (syntaxe: un port simple, par exemple 5000, une plage de ports, par exemple 5000-5015, si non renseign� tout port peut �tre utilis�)</entry> -</row> -<row> - <entry><option>dcc_own_ip</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Adresse IP ou DNS utilis�e pour le dcc sortant (si non renseign�, l'interface IP locale est utilis�e)</entry> -</row> -<row> - <entry><option>dcc_download_path</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%h/dcc'</entry> - <entry>Chemin pour �crire les fichiers re�us par dcc (par d�faut: r�pertoire de l'utilisateur)</entry> -</row> -<row> - <entry><option>dcc_upload_path</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'~'</entry> - <entry>Chemin pour lire les fichiers lorsqu'ils sont envoy�s par dcc (quand aucun chemin n'est sp�cifi�)</entry> -</row> -<row> - <entry><option>dcc_convert_spaces</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Convertir les espaces en underscores lors d'envoi de fichiers</entry> -</row> -<row> - <entry><option>dcc_auto_rename</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Renommer les fichiers re�us s'ils existent d�j� (ajoute '.1', '.2', ...)</entry> -</row> -<row> - <entry><option>dcc_auto_resume</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Continuer automatiquement les transferts dcc si la connexion avec l'h�te a �t� perdue</entry> -</row> -<row> - <entry><option>proxy_use</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Utiliser un proxy pour se connecter au serveur irc</entry> -</row> -<row> - <entry><option>proxy_type</option></entry> - <entry>cha�ne</entry> - <entry>'http', 'socks4', 'socks5'</entry> - <entry>'http'</entry> - <entry>Type de proxy (http (d�faut), socks4, socks5)</entry> -</row> -<row> - <entry><option>proxy_ipv6</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Se connecter au proxy en ipv6</entry> -</row> -<row> - <entry><option>proxy_address</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Adresse du serveur proxy (IP ou nom de machine)</entry> -</row> -<row> - <entry><option>proxy_port</option></entry> - <entry>entier</entry> - <entry>entre 0 et 65535</entry> - <entry>3128</entry> - <entry>Port pour se connecter au serveur proxy</entry> -</row> -<row> - <entry><option>proxy_username</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Nom d'utilisateur pour le serveur proxy</entry> -</row> -<row> - <entry><option>proxy_password</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Mot de passe pour le serveur proxy</entry> -</row> -<row> - <entry><option>plugins_path</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'%h/plugins'</entry> - <entry>Chemin de recherche des extensions ('%h' sera remplac� par le r�pertoire de base WeeChat, par d�faut: ~/.weechat)</entry> -</row> -<row> - <entry><option>plugins_autoload</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'*'</entry> - <entry>Liste des extensions � charger automatiquement au d�marrage, "*" signifie toutes (s�par�es par des virgules, les noms peuvent �tre partiels, par exemple "perl" est ok pour "libperl.so")</entry> -</row> -<row> - <entry><option>plugins_extension</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>'.so'</entry> - <entry>Extension standard des extensions dans le nom de fichier, pour le chargement automatique (si vide, alors tous les fichiers sont charg�s si autoload vaut "*")</entry> -</row> -<row> - <entry><option>server_name</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Nom associ� au serveur IRC (pour affichage seulement)</entry> -</row> -<row> - <entry><option>server_autoconnect</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Connexion automatique au serveur quand WeeChat d�marre</entry> -</row> -<row> - <entry><option>server_autoreconnect</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Reconnexion automatique au serveur apr�s une d�connexion</entry> -</row> -<row> - <entry><option>server_autoreconnect_delay</option></entry> - <entry>entier</entry> - <entry>entre 0 et 65535</entry> - <entry>30</entry> - <entry>D�lai (en secondes) avant de tenter une reconnexion au serveur</entry> -</row> -<row> - <entry><option>server_address</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Adresse IP ou nom du serveur IRC</entry> -</row> -<row> - <entry><option>server_port</option></entry> - <entry>entier</entry> - <entry>entre 0 et 65535</entry> - <entry>6667</entry> - <entry>Port pour se connecter au serveur</entry> -</row> -<row> - <entry><option>server_ipv6</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Utiliser le protocole IPv6 pour la communication avec le serveur</entry> -</row> -<row> - <entry><option>server_ssl</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'off'</entry> - <entry>Utiliser SSL pour la communication avec le serveur</entry> -</row> -<row> - <entry><option>server_password</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Mot de passe pour le serveur IRC</entry> -</row> -<row> - <entry><option>server_nick1</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Pseudo � utiliser sur le serveur IRC</entry> -</row> -<row> - <entry><option>server_nick2</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Pseudo alternatif pour le serveur IRC (si le pseudo est d�j� utilis�)</entry> -</row> -<row> - <entry><option>server_nick3</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>2�me pseudo alternatif pour le serveur IRC (si le pseudo alternatif est d�j� utilis�)</entry> -</row> -<row> - <entry><option>server_username</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Nom d'utilisateur pour le serveur IRC</entry> -</row> -<row> - <entry><option>server_realname</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Nom r�el pour le serveur IRC</entry> -</row> -<row> - <entry><option>server_hostname</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Nom de machine/IP personnalis� pour le serveur (optionnel, si non renseign�, le nom de machine local est utilis�)</entry> -</row> -<row> - <entry><option>server_command</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Commande(s) � ex�cuter lorsque connect� au serveur (plusieurs commandes doivent �tre s�par�es par ';', utilisez '\;' pour un point-virgule, les variables sp�ciales $nick, $channel et $server sont remplac�es par leur valeur)</entry> -</row> -<row> - <entry><option>server_command_delay</option></entry> - <entry>entier</entry> - <entry>entre 0 et 3600</entry> - <entry>0</entry> - <entry>D�lai (en secondes) apr�s ex�cution de la commande (exemple: donner du temps pour l'authentification)</entry> -</row> -<row> - <entry><option>server_autojoin</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Liste des canaux (s�par�s par des virgules) � rejoindre lorsque connect� au serveur (exemple: "#chan1,#chan2,#chan3 key1,key2")</entry> -</row> -<row> - <entry><option>server_autorejoin</option></entry> - <entry>bool�en</entry> - <entry>'on' ou 'off'</entry> - <entry>'on'</entry> - <entry>Rejoindre automatiquement les canaux quand mis dehors</entry> -</row> -<row> - <entry><option>server_notify_levels</option></entry> - <entry>cha�ne</entry> - <entry>toute cha�ne</entry> - <entry>''</entry> - <entry>Liste des niveaux de notifications (s�par�s par des virgules) pour les canaux de ce serveur (format: #canal:1,..), un nom de canal '*' est r�serv� pour la notification par d�faut du serveur</entry> -</row> diff --git a/weechat/doc/fr/irc_commands.xml b/weechat/doc/fr/irc_commands.xml deleted file mode 100644 index 228f25b48..000000000 --- a/weechat/doc/fr/irc_commands.xml +++ /dev/null @@ -1,443 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>admin [cible]</command> -<programlisting> -trouver les informations sur l'administrateur du serveur - -cible: serveur - -</programlisting> -<command>ame message</command> -<programlisting> -envoyer une action CTCP � tous les canaux de tous les serveurs connect�s - -message: message � envoyer - -</programlisting> -<command>amsg texte</command> -<programlisting> -envoyer un message � tous les canaux de tous les serveurs connect�s - -texte: texte � envoyer - -</programlisting> -<command>away [-all] [message]</command> -<programlisting> -basculer le statut absent - - -all: basculer le statut absent sur tous les serveurs connect�s -message: message pour l'absence (si pas de message donn�, le statut d'absence est supprim�) - -</programlisting> -<command>ban [canal] [pseudo [pseudo ...]]</command> -<programlisting> -bannit des pseudos ou h�tes - - canal: nom du canal pour le bannissement -pseudo: pseudo ou h�te pour le bannissement - -</programlisting> -<command>ctcp cible type [arguments]</command> -<programlisting> -envoyer un message CTCP (Client-To-Client Protocol) - - cible: pseudo � qui envoyer le CTCP - type: type de CTCP (exemples: "version", "ping", etc...) -arguments: arguments pour le CTCP - -</programlisting> -<command>cycle [canal[,canal]] [message_de_fin]</command> -<programlisting> -quitter et rejoindre un canal - - canal: canal pour le cycle -message_de_fin: message de fin (affich� aux autres utilisateurs) - -</programlisting> -<command>dehalfop [pseudo [pseudo]]</command> -<programlisting> -retire le statut de demi-op�rateur du canal �/aux pseudo(s) - -</programlisting> -<command>deop [pseudo [pseudo]]</command> -<programlisting> -retire le statut d'op�rateur du canal �/aux pseudo(s) - -</programlisting> -<command>devoice [pseudo [pseudo]]</command> -<programlisting> -retire la voix du/des pseudo(s) - -</programlisting> -<command>die</command> -<programlisting> -arr�ter le serveur - -</programlisting> -<command>halfop [pseudo [pseudo]]</command> -<programlisting> -donner le statut de demi-op�rateur � un/des pseudo(s) - -</programlisting> -<command>info [cible]</command> -<programlisting> -voir les informations d�crivant le serveur - -cible: nom du serveur - -</programlisting> -<command>invite pseudo canal</command> -<programlisting> -inviter un pseudo sur un canal - - pseudo: pseudo � inviter -channel: canal pour l'invitation - -</programlisting> -<command>ison pseudo [pseudo ...]</command> -<programlisting> -v�rifier si un pseudo est actuellement sur IRC - -pseudo: pseudo - -</programlisting> -<command>join canal[,canal] [cl�[,cl�]]</command> -<programlisting> -joindre un canal - -canal: nom du canal � rejoindre - cl�: cl� pour rejoindre le canal - -</programlisting> -<command>kick [canal] pseudo [commentaire]</command> -<programlisting> -retirer par la force un utilisateur d'un canal - - canal: canal o� l'utilisateur se trouve - pseudo: pseudo � �liminer -commentaire: commentaire pour l'�limination - -</programlisting> -<command>kickban [canal] pseudo [commentaire]</command> -<programlisting> -retirer par la force un pseudo d'un canal et le bannir - - canal: canal o� l'utilisateur se trouve - pseudo: pseudo � �liminer et bannir -commentaire: commentaire pour l'�limination - -</programlisting> -<command>kill pseudo commentaire</command> -<programlisting> -fermer la connexion client-serveur - - pseudo: pseudo -commentaire: commentaire pour la mort - -</programlisting> -<command>links [[serveur] masque_serveur]</command> -<programlisting> -lister tous les noms de serveurs connus du serveur qui r�pondent � la requ�te - - serveur: ce serveur doit r�pondre � la requ�te -masque_serveur: liste des serveurs correspondant au masque - -</programlisting> -<command>list [canal[,canal] [serveur]]</command> -<programlisting> -lister les canaux et leur sujet - -canal: canal � lister (une expression r�guli�re est accept�e) -serveur: nom du serveur - -</programlisting> -<command>lusers [masque [cible]]</command> -<programlisting> -obtenir des statistiques sur la taille du r�seau IRC - -masque: serveurs qui correspondent au masque seulement - cible: serveur pour faire suivre la requ�te - -</programlisting> -<command>me message</command> -<programlisting> -envoyer une action CTCP au canal courant - -message: message � envoyer - -</programlisting> -<command>mode { canal {[+|-]|o|p|s|i|t|n|b|v} [limite] [utilisateur] [masque de banissement] } | { pseudo {[+|-]|i|w|s|o} }</command> -<programlisting> -changer le mode du canal ou de l'utilisateur - -modes de canaux : - canal: nom du canal � modifier - o: donner/reprendre le statut privil�gi� d'op�rateur - p: indicateur de canal priv� - s: indicateur de canal secret - i: indicateur de canal avec invitation seulement - t: le titre est modifiable seulement par un op�rateur du canal - n: aucun message au canal depuis l'ext�rieur - m: canal mod�r� - l: fixer la limite d'utilisateurs pour le canal - b: param�trer un masque de banissement pour garder des utilisateurs dehors - e: param�trer un masque d'exception - v: donner/reprendre la possibilit� de parler sur un canal mod�r� - k: d�finir une cl� (mot de passe) pour acc�der au canal -modes utilisateur : - pseudo: pseudo � modifier - i: marquer un utilisateur comme invisible - s: marquer un utilisateur pour recevoir les notices du serveur - w: l'utilisateur re�oit les wallops - o: drapeau op�rateur - -</programlisting> -<command>motd [cible]</command> -<programlisting> -obtenir le message du jour - -cible: nom du serveur - -</programlisting> -<command>msg cible[,cible] texte</command> -<programlisting> -envoyer un message � un pseudo ou canal - -cible: pseudo ou canal (peut-�tre un masque, '*' = canal courant) -texte: texte � envoyer - -</programlisting> -<command>names [canal[,canal]]</command> -<programlisting> -lister les pseudos sur des canaux - -canal: nom du canal - -</programlisting> -<command>nick [-all] pseudo</command> -<programlisting> -changer le pseudo courant - - -all: d�finir le nouveau pseudo sur tous les serveurs connect�s -pseudo: nouveau pseudo - -</programlisting> -<command>notice pseudo texte</command> -<programlisting> -envoyer un message notice � un utilisateur - -pseudo: pseudo cible pour la notice - texte: texte � envoyer - -</programlisting> -<command>op pseudo [pseudo]</command> -<programlisting> -donner le statut op�rateur � un/des pseudo(s) - -</programlisting> -<command>oper utilisateur mot_de_passe</command> -<programlisting> -obtenir le statut d'op�rateur - -utilisateur/mot_de_passe: utilis� pour obtenir les privil�ges sur le serveur IRC courant - -</programlisting> -<command>part [canal[,canal]] [message_de_fin]</command> -<programlisting> -quitter un canal - - canal: canal � quitter -message_de_fin: message de fin (affich� aux autres utilisateurs) - -</programlisting> -<command>ping serveur1 [serveur2]</command> -<programlisting> -pinguer un serveur - -serveur1: serveur � pinguer -serveur2: faire suivre le ping � ce serveur - -</programlisting> -<command>pong d�mon [d�mon2]</command> -<programlisting> -r�pondre � un message ping - - d�mon: d�mon qui a r�pondu au message Ping -d�mon2: faire suivre le message � ce d�mon - -</programlisting> -<command>query pseudo [texte]</command> -<programlisting> -envoyer un message priv� � un pseudo - -pseudo: pseudo pour la conversation priv�e - texte: texte � envoyer - -</programlisting> -<command>quit [message_de_fin]</command> -<programlisting> -fermer toutes les connexions et quitter - -message_de_fin: message de fin (affich� aux autres utilisateurs) - -</programlisting> -<command>quote donn�es</command> -<programlisting> -envoyer des donn�es brutes au serveur sans analyse - -donn�es: donn�es brutes � envoyer - -</programlisting> -<command>rehash</command> -<programlisting> -demander au serveur de recharger son fichier de configuration - -</programlisting> -<command>restart</command> -<programlisting> -demander au serveur de red�marrer - -</programlisting> -<command>service pseudo r�serv� distribution type r�serv� info</command> -<programlisting> -enregister un nouveau service - -distribution: visibilit� du service - type: r�serv� pour une utilisation future - -</programlisting> -<command>servlist [masque [type]]</command> -<programlisting> -lister les services actuellement connect�s au r�seau - -masque: lister seulement les services qui correspondent � ce masque - type: lister seulement les services de ce type - -</programlisting> -<command>squery service texte</command> -<programlisting> -envoyer un message � un service - -service: nom du service -texte: texte � envoyer - -</programlisting> -<command>squit serveur commentaire</command> -<programlisting> -d�connecter les liens vers un serveur - -serveur: nom du serveur -commentaire: commentaire pour quitter - -</programlisting> -<command>stats [requ�te [serveur]]</command> -<programlisting> -demander des statistiques sur le serveur - -requ�te: c/h/i/k/l/m/o/y/u (voir la RFC1459) -serveur: nom du serveur - -</programlisting> -<command>summon utilisateur [cible [canal]]</command> -<programlisting> -envoyer aux utilisateurs d'un serveur IRC un message leur demandant de rejoindre IRC - -utilisateur: nom d'utilisateur - cible: nom du serveur - canal: nom du canal - -</programlisting> -<command>time [cible]</command> -<programlisting> -demander l'heure locale de serveur - -cible: demander l'heure de ce serveur - -</programlisting> -<command>topic [canal] [titre]</command> -<programlisting> -recevoir/d�finir le titre du canal - -canal: nom du canal -titre: nouveau titre pour le canal (si le titre est "-delete" alors le titre est supprim�) - -</programlisting> -<command>trace [cible]</command> -<programlisting> -trouver le chemin jusqu'� un serveur sp�cifique - -cible: serveur - -</programlisting> -<command>unban [canal] pseudo [pseudo ...]</command> -<programlisting> -supprime le bannissement sur des pseudos ou h�tes - - canal: nom du canal pour supprimer le bannissement -pseudo: pseudo ou h�te pour supprimer le bannissement - -</programlisting> -<command>userhost pseudo [pseudo ...]</command> -<programlisting> -retourne une liste d'informations sur des pseudos - -pseudo: pseudo - -</programlisting> -<command>users [cible]</command> -<programlisting> -liste des utilisateurs connect�s au serveur - -cible: serveur - -</programlisting> -<command>version [serveur | pseudo]</command> -<programlisting> -retourne la version du pseudo ou du serveur (courant ou sp�cifi�) - -serveur: nom du serveur - pseudo: pseudo - -</programlisting> -<command>voice [pseudo [pseudo]]</command> -<programlisting> -donne la voix �/aux pseudo(s) - -</programlisting> -<command>wallops texte</command> -<programlisting> -envoyer un message � tous les utilisateurs connect�s qui ont activ� le mode utilisateur 'w' pour eux-m�mes - -texte � envoyer - -</programlisting> -<command>who [masque ["o"]]</command> -<programlisting> -g�n�re une requ�te qui retourne une liste d'information - -masque: information qui correspond � ce masque uniquement - o: seul les op�rateurs sont retourn�s correspondant au masque fourni - -</programlisting> -<command>whois [serveur] pseudo[,pseudo]</command> -<programlisting> -demande les informations sur le(s) utilisateur(s) - -serveur: nom du serveur - pseudo: pseudo (peut �tre un masque) - -</programlisting> -<command>whowas pseudo [,pseudo [,pseudo ...]] [nombre [cible]]</command> -<programlisting> -demander de l'information sur un pseudo qui n'existe plus - -pseudo: pseudo � chercher -nombre: nombre de r�ponses � retourner (recherche compl�te si nombre n�gatif) - cible: la r�ponse doit correspondre � ce masque - -</programlisting> diff --git a/weechat/doc/fr/key_functions.xml b/weechat/doc/fr/key_functions.xml deleted file mode 100644 index beb61c720..000000000 --- a/weechat/doc/fr/key_functions.xml +++ /dev/null @@ -1,215 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<row> - <entry><literal>return</literal></entry> - <entry>terminer la ligne</entry> -</row> -<row> - <entry><literal>tab</literal></entry> - <entry>compl�ter le mot</entry> -</row> -<row> - <entry><literal>tab_previous</literal></entry> - <entry>trouver le mot compl�t� pr�c�dent</entry> -</row> -<row> - <entry><literal>backspace</literal></entry> - <entry>effacer le caract�re pr�c�dent</entry> -</row> -<row> - <entry><literal>delete</literal></entry> - <entry>effacer le caract�re suivant</entry> -</row> -<row> - <entry><literal>delete_end_line</literal></entry> - <entry>effacer jusqu'� la fin de la ligne</entry> -</row> -<row> - <entry><literal>delete_beginning_line</literal></entry> - <entry>effacer jusqu'au d�but de la ligne</entry> -</row> -<row> - <entry><literal>delete_line</literal></entry> - <entry>effacer la ligne enti�re</entry> -</row> -<row> - <entry><literal>delete_previous_word</literal></entry> - <entry>effacer le mot pr�c�dent</entry> -</row> -<row> - <entry><literal>delete_next_word</literal></entry> - <entry>effacer le mot suivant</entry> -</row> -<row> - <entry><literal>clipboard_paste</literal></entry> - <entry>coller le contenu du presse-papier</entry> -</row> -<row> - <entry><literal>transpose_chars</literal></entry> - <entry>inverser les caract�res</entry> -</row> -<row> - <entry><literal>home</literal></entry> - <entry>aller au d�but de la ligne</entry> -</row> -<row> - <entry><literal>end</literal></entry> - <entry>aller � la fin de la ligne</entry> -</row> -<row> - <entry><literal>left</literal></entry> - <entry>se d�placer d'un caract�re � gauche</entry> -</row> -<row> - <entry><literal>previous_word</literal></entry> - <entry>se d�placer au mot pr�c�dent</entry> -</row> -<row> - <entry><literal>right</literal></entry> - <entry>se d�placer d'un caract�re � droite</entry> -</row> -<row> - <entry><literal>next_word</literal></entry> - <entry>se d�placer au mot suivant</entry> -</row> -<row> - <entry><literal>up</literal></entry> - <entry>appeler la commande pr�c�dente dans l'historique</entry> -</row> -<row> - <entry><literal>up_global</literal></entry> - <entry>appeler la commande pr�c�dente dans l'historique global</entry> -</row> -<row> - <entry><literal>down</literal></entry> - <entry>appeler la commande suivante dans l'historique</entry> -</row> -<row> - <entry><literal>down_global</literal></entry> - <entry>appeler la commande suivante dans l'historique global</entry> -</row> -<row> - <entry><literal>page_up</literal></entry> - <entry>faire d�filer d'une page vers le haut</entry> -</row> -<row> - <entry><literal>page_down</literal></entry> - <entry>faire d�filer d'une page vers le bas</entry> -</row> -<row> - <entry><literal>scroll_up</literal></entry> - <entry>faire d�filer de quelques lignes vers le haut</entry> -</row> -<row> - <entry><literal>scroll_down</literal></entry> - <entry>faire d�filer de quelques lignes vers le bas</entry> -</row> -<row> - <entry><literal>scroll_top</literal></entry> - <entry>faire d�filer jusqu'au d�but du tampon</entry> -</row> -<row> - <entry><literal>scroll_bottom</literal></entry> - <entry>faire d�filer jusqu'� la fin du tampon</entry> -</row> -<row> - <entry><literal>scroll_topic_left</literal></entry> - <entry>faire d�filer le titre vers la gauche</entry> -</row> -<row> - <entry><literal>scroll_topic_right</literal></entry> - <entry>faire d�filer le titre vers la droite</entry> -</row> -<row> - <entry><literal>nick_beginning</literal></entry> - <entry>afficher le d�but de la liste des pseudos</entry> -</row> -<row> - <entry><literal>nick_end</literal></entry> - <entry>afficher la fin de la liste des pseudos</entry> -</row> -<row> - <entry><literal>nick_page_up</literal></entry> - <entry>faire d�filer la liste des pseudos d'une page vers le haut</entry> -</row> -<row> - <entry><literal>nick_page_down</literal></entry> - <entry>faire d�filer la liste des pseudos d'une page vers le bas</entry> -</row> -<row> - <entry><literal>jump_smart</literal></entry> - <entry>sauter au tampon avec de l'activit�</entry> -</row> -<row> - <entry><literal>jump_dcc</literal></entry> - <entry>sauter au tampon DCC</entry> -</row> -<row> - <entry><literal>jump_raw_data</literal></entry> - <entry>sauter au tampon IRC brut</entry> -</row> -<row> - <entry><literal>jump_last_buffer</literal></entry> - <entry>sauter au dernier tampon</entry> -</row> -<row> - <entry><literal>jump_previous_buffer</literal></entry> - <entry>sauter au tampon pr�c�dent</entry> -</row> -<row> - <entry><literal>jump_server</literal></entry> - <entry>sauter au tampon du serveur</entry> -</row> -<row> - <entry><literal>jump_next_server</literal></entry> - <entry>sauter au prochain serveur</entry> -</row> -<row> - <entry><literal>switch_server</literal></entry> - <entry>bascule de serveur actif sur le tampon des serveurs</entry> -</row> -<row> - <entry><literal>scroll_previous_highlight</literal></entry> - <entry>faire d�filer jusqu'au highlight pr�c�dent du tampon</entry> -</row> -<row> - <entry><literal>scroll_next_highlight</literal></entry> - <entry>faire d�filer jusqu'au highlight suivant du tampon</entry> -</row> -<row> - <entry><literal>scroll_unread</literal></entry> - <entry>faire d�filer jusqu'� la premi�re ligne non lue du tampon</entry> -</row> -<row> - <entry><literal>set_unread</literal></entry> - <entry>positionner le marqueur de donn�es non lues sur tous les tampons</entry> -</row> -<row> - <entry><literal>hotlist_clear</literal></entry> - <entry>effacer la liste d'activit�</entry> -</row> -<row> - <entry><literal>infobar_clear</literal></entry> - <entry>effacer la barre d'infos</entry> -</row> -<row> - <entry><literal>refresh</literal></entry> - <entry>rafra�chir l'�cran</entry> -</row> -<row> - <entry><literal>grab_key</literal></entry> - <entry>capturer une touche</entry> -</row> -<row> - <entry><literal>insert</literal></entry> - <entry>ins�rer une cha�ne dans la ligne de commande</entry> -</row> -<row> - <entry><literal>search_text</literal></entry> - <entry>recherche de texte dans l'historique du tampon</entry> -</row> diff --git a/weechat/doc/fr/weechat.fr.xml b/weechat/doc/fr/weechat.fr.xml deleted file mode 100644 index 352812e2d..000000000 --- a/weechat/doc/fr/weechat.fr.xml +++ /dev/null @@ -1,8302 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- - -WeeChat documentation (french version) - -Copyright (c) 2003-2007 by FlashCode <flashcode@flashtux.org> - -This manual 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. - -This manual is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see <http://www.gnu.org/licenses/>. - ---> - -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" -[ - <!ENTITY date.xml SYSTEM "date.xml"> - <!ENTITY config.xml SYSTEM "config.xml"> - <!ENTITY weechat_commands.xml SYSTEM "weechat_commands.xml"> - <!ENTITY irc_commands.xml SYSTEM "irc_commands.xml"> - <!ENTITY key_functions.xml SYSTEM "key_functions.xml"> -]> - -<book lang="fr"> - - <bookinfo> - - <title>WeeChat 0.2.6-cvs - Guide utilisateur</title> - <subtitle>Client IRC rapide, l�ger et extensible</subtitle> - - <author> - <firstname>S�bastien</firstname> - <surname>Helleu</surname> - <email>flashcode AT flashtux.org</email> - </author> - - &date.xml; - - <copyright> - <year>2007</year> - <holder>S�bastien Helleu</holder> - </copyright> - - <legalnotice> - <para> - This manual 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. - </para> - <para> - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - </para> - <para> - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - </para> - </legalnotice> - - <abstract> - <para> - Ce manuel documente le client IRC WeeChat, il fait partie de WeeChat. - </para> - <para> - La derni�re version de ce document peut �tre t�l�charg�e - sur cette page : - <ulink url="http://weechat.flashtux.org/doc.php"> - http://weechat.flashtux.org/doc.php - </ulink> - </para> - </abstract> - - </bookinfo> - - <!-- =========================== Introduction =========================== --> - - <chapter id="chapIntroduction"> - <title>Introduction</title> - - <para> - Ce chapitre d�crit WeeChat et les pr�-requis pour son installation. - </para> - - <section id="secDescription"> - <title>Description</title> - - <para> - WeeChat (Wee Enhanced Environment for Chat) est un client - <acronym>IRC</acronym> libre, rapide et l�ger, con�u pour - diff�rents syst�mes d'exploitation. - </para> - - <para> - Ses principales caract�ristiques sont les suivantes : - <itemizedlist> - <listitem> - <para> - connexion multi-serveurs (avec SSL, IPv6, proxy) - </para> - </listitem> - <listitem> - <para> - plusieurs interfaces : Curses, wxWidgets, Gtk et Qt - </para> - </listitem> - <listitem> - <para> - petit, rapide et l�ger - </para> - </listitem> - <listitem> - <para> - param�trable et extensible avec des extensions et des scripts - </para> - </listitem> - <listitem> - <para> - conforme aux <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2810.txt">2810</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2811.txt">2811</ulink>, - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink> et - <ulink url="http://www.ietf.org/rfc/rfc2813.txt">2813</ulink> - </para> - </listitem> - <listitem> - <para> - multi plates-formes (GNU/L'index, *BSD, MacOS X, Windows et - d'autres syst�mes) - </para> - </listitem> - <listitem> - <para> - 100% GPL, logiciel libre - </para> - </listitem> - </itemizedlist> - </para> - - <para> - La page d'accueil de WeeChat est ici : - <ulink url="http://weechat.flashtux.org"> - http://weechat.flashtux.org - </ulink> - </para> - - </section> - - <section id="secPreRequis"> - <title>Pr�-requis</title> - - <para> - Pour installer WeeChat, vous <emphasis>devez</emphasis> avoir : - <itemizedlist> - <listitem> - <para> - un syst�me GNU/Linux (avec le compilateur et les outils - associ�s pour le paquet des sources) - </para> - </listitem> - <listitem> - <para> - droits "root" (pour installer WeeChat) - </para> - </listitem> - <listitem> - <para> - selon l'interface, une des biblioth�ques - suivantes : - <itemizedlist> - <listitem> - <para> - Curses : la biblioth�que ncurses - </para> - </listitem> - <listitem> - <para> - Gtk : <emphasis>*** interface non d�velopp�e ***</emphasis> - </para> - </listitem> - <listitem> - <para> - WxWidgets : <emphasis>*** interface non d�velopp�e ***</emphasis> - </para> - </listitem> - <listitem> - <para> - Qt : <emphasis>*** interface non d�velopp�e ***</emphasis> - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - </chapter> - - <!-- =========================== Installation =========================== --> - - <chapter id="chapInstallation"> - <title>Installation</title> - - <para> - Ce chapitre explique comment installer WeeChat. - </para> - - <section id="secPaquetsBinaires"> - <title>Paquets binaires</title> - - <para> - Les paquets binaires sont disponibles pour les distributions - suivantes : - <itemizedlist> - <listitem> - <para> - Debian (ou toute distribution compatible Debian) : - <userinput>apt-get install weechat</userinput> - </para> - </listitem> - <listitem> - <para> - Mandriva/RedHat (ou toute distribution compatible avec les RPM) : - <userinput> - rpm -i /chemin/weechat-x.y.z-1.i386.rpm - </userinput> - </para> - </listitem> - <listitem> - <para> - Gentoo : - <userinput>emerge weechat</userinput> - </para> - </listitem> - </itemizedlist> - - Pour les autres distributions support�es, merci de vous - r�f�rer au manuel de la distribution pour la m�thode d'installation. - </para> - - </section> - - <section id="secPaquetSource"> - <title>Paquet source</title> - - <para> - Tapez simplement dans une console ou un terminal : -<screen><prompt>$ </prompt><userinput>./configure</userinput> -<prompt>$ </prompt><userinput>make</userinput></screen> - </para> - <para> - Obtenez les droits root et installez WeeChat : -<screen><prompt>$ </prompt><userinput>su</userinput> -(entrez le mot de passe root) -<prompt># </prompt><userinput>make install</userinput></screen> - </para> - - </section> - - <section id="secSourcesCVS"> - <title>Sources CVS</title> - - <para> - Attention : les sources CVS sont r�serv�s aux utilisateurs - avanc�s : il se peut que WeeChat ne compile pas et qu'il soit - tr�s instable. Vous �tes pr�venus ! - </para> - - <para> - Pour r�cup�rer les sources CVS, tapez cette commande : -<screen><prompt>$ </prompt><userinput>cvs -z3 -d:pserver:anonymous@cvs.savannah.nongnu.org:/sources/weechat co weechat</userinput></screen> - </para> - - <para> - Ex�cutez ce script : - <userinput>./autogen.sh</userinput> - </para> - - <para> - Suivez alors les instructions du paquet source - (voir <xref linkend="secPaquetSource" />) - </para> - - </section> - - </chapter> - - <!-- =========================== Utilisation ============================ --> - - <chapter id="chapUtilisation"> - <title>Utilisation</title> - - <para> - Ce chapitre explique comment lancer WeeChat, les touches utilis�es par - d�faut, les commandes internes et IRC, le fichier de configuration et - l'utilisation du tube FIFO. - </para> - - <section id="secLancerWeeChat"> - <title>Lancer WeeChat</title> - - <para> - Param�tres de ligne de commande : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Param�tre</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>-a, --no-connect</literal></entry> - <entry> - Supprimer la connexion automatique aux serveurs lors du d�marrage - </entry> - </row> - <row> - <entry><literal>-c, --config</literal></entry> - <entry> - Afficher l'aide sur le fichier de config (liste des options) - </entry> - </row> - <row> - <entry><literal>-d, --dir <r�pertoire></literal></entry> - <entry> - 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 - "<literal>~/.weechat</literal>". NB: le r�pertoire est cr�� - s'il n'est pas trouv� par WeeChat. - </entry> - </row> - <row> - <entry><literal>-f, --key-functions</literal></entry> - <entry> - Afficher la liste des fonctions internes WeeChat pour les touches - </entry> - </row> - <row> - <entry><literal>-h, --help</literal></entry> - <entry> - Afficher l'aide - </entry> - </row> - <row> - <entry><literal>-i, --irc-commands</literal></entry> - <entry> - Afficher la liste des commandes IRC - </entry> - </row> - <row> - <entry><literal>-k, --keys</literal></entry> - <entry> - Afficher les touches par d�faut de WeeChat - </entry> - </row> - <row> - <entry><literal>-l, --license</literal></entry> - <entry> - Afficher la licence de WeeChat - </entry> - </row> - <row> - <entry><literal>-p, --no-plugin</literal></entry> - <entry> - Supprimer le chargement automatique des extensions au - d�marrage - </entry> - </row> - <row> - <entry><literal>-v, --version</literal></entry> - <entry> - Afficher la version de WeeChat - </entry> - </row> - <row> - <entry><literal>-w, --weechat-commands</literal></entry> - <entry> - Afficher la liste des commandes WeeChat - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Il est �galement possible de passer une URL pour un ou plusieurs - serveurs IRC, de la forme : - <screen>irc[6][s]://[pseudo[:mot_passe]@]irc.exemple.org[:port][/canal][,canal[...]</screen> - Exemple pour rejoindre #weechat et #toto sur le serveur - "<literal>irc.freenode.net</literal>", port par d�faut (6667), sous - le pseudo "nono" : - <screen><prompt>$ </prompt><userinput>weechat-curses irc://nono@irc.freenode.net/#weechat,#toto</userinput></screen> - </para> - - <para> - Pour lancer WeeChat, tapez cette commande : - <itemizedlist> - <listitem> - <para> - pour l'interface Curses : <userinput>weechat-curses</userinput> - </para> - </listitem> - <listitem> - <para> - pour l'interface Gtk : <userinput>weechat-gtk</userinput> - </para> - </listitem> - <listitem> - <para> - pour l'interface wxWidgets : <userinput>weechat-wxwidgets</userinput> - </para> - </listitem> - <listitem> - <para> - pour l'interface Qt : <userinput>weechat-qt</userinput> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Lorsque vous lancez WeeChat pour la premi�re fois, un fichier de - configuration par d�faut est cr��, avec les options par d�faut. - Le fichier de configuration par d�faut est : - "<literal>~/.weechat/weechat.rc</literal>" - </para> - - <para> - Vous pouvez �diter ce fichier pour configurer WeeChat � votre - convenance (SEULEMENT si WeeChat ne tourne pas), ou vous pouvez - modifier les param�tres dans WeeChat avec la commande - "<literal>/set</literal>" - (voir <xref linkend="secCommandesWeeChat" />) - </para> - - </section> - - <section id="secRaccourcisClavier"> - <title>Raccourcis clavier</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Touche</entry> - <entry>Action</entry> - </row> - </thead> - <tbody> - <row> - <entry>Fl�che gauche / Ctrl + B</entry> - <entry> - Aller au caract�re pr�c�dent sur la ligne de commande - </entry> - </row> - <row> - <entry>Fl�che droite / Ctrl + F</entry> - <entry> - Aller au caract�re suivant sur la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + fl�che gauche</entry> - <entry> - Aller au mot pr�c�dent sur la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + fl�che droite</entry> - <entry> - Aller au mot suivant sur la ligne de commande - </entry> - </row> - <row> - <entry>Home / Ctrl + A</entry> - <entry> - Aller au d�but de la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + C puis B</entry> - <entry> - Ins�rer le code pour mettre le texte en gras. - </entry> - </row> - <row> - <entry>Ctrl + C puis C</entry> - <entry> - Ins�rer le code pour �crire en couleur. - </entry> - </row> - <row> - <entry>Ctrl + C puis O</entry> - <entry> - Ins�rer le code pour r�initaliser la couleur. - </entry> - </row> - <row> - <entry>Ctrl + C puis R</entry> - <entry> - Ins�rer le code pour �crire en couleur invers�e. - </entry> - </row> - <row> - <entry>Ctrl + C puis U</entry> - <entry> - Ins�rer le code pour �crire en soulign�. - </entry> - </row> - <row> - <entry>End / Ctrl + E</entry> - <entry> - Aller � la fin de la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + K</entry> - <entry> - Effacer du curseur jusqu'� la fin de la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + L</entry> - <entry> - R�afficher toute la fen�tre - </entry> - </row> - <row> - <entry>Ctrl + R</entry> - <entry> - Chercher du texte dans l'historique du tampon - (deux appuis successifs pour rechercher du texte exact) - </entry> - </row> - <row> - <entry>Ctrl + S puis Ctrl + U</entry> - <entry> - Positionner le marqueur de donn�es non lues sur tous les - tampons - </entry> - </row> - <row> - <entry>Ctrl + T</entry> - <entry> - Inverser deux caract�res - </entry> - </row> - <row> - <entry>Ctrl + U</entry> - <entry> - Effacer du curseur jusqu'au d�but de la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + W</entry> - <entry> - Effacer le mot pr�c�dent sur la ligne de commande - </entry> - </row> - <row> - <entry>Ctrl + Y</entry> - <entry> - Coller le contenu du presse-papiers - </entry> - </row> - <row> - <entry>Backspace / Ctrl + H</entry> - <entry> - Effacer le caract�re pr�c�dent sur la ligne de commande - </entry> - </row> - <row> - <entry>Delete / Ctrl + D</entry> - <entry> - Effacer le caract�re suivant sur la ligne de commande - </entry> - </row> - <row> - <entry>Tab / Shift + Tab</entry> - <entry> - Compl�ter la commande ou le pseudo - (Tab de nouveau: trouver la compl�tion suivante) - </entry> - </row> - <row> - <entry>Tout caract�re</entry> - <entry> - Ins�rer le caract�re � la position du curseur - sur la ligne de commande - </entry> - </row> - <row> - <entry>Entr�e / Ctrl + J / Ctrl + M</entry> - <entry> - Ex�cuter la commande ou envoyer le message - (en mode recherche: arr�ter la recherche) - </entry> - </row> - <row> - <entry>Fl�che haut / fl�che bas</entry> - <entry> - Rappeler les derni�res commandes ou messages - (en mode recherche: chercher en haut/bas) - </entry> - </row> - <row> - <entry>Ctrl + fl�che haut / Ctrl + fl�che bas</entry> - <entry> - Rappeler les derni�res commandes ou messages dans - l'historique global (commun � tous les tampons) - </entry> - </row> - <row> - <entry>PageUp / PageDown</entry> - <entry> - Monter / descendre d'une page dans l'historique du tampon - </entry> - </row> - <row> - <entry>Alt + PageUp / Alt + PageDown</entry> - <entry> - Monter / descendre de quelques lignes dans l'historique - du tampon - </entry> - </row> - <row> - <entry>Alt + Home / Alt + End</entry> - <entry> - Aller au d�but / � la fin du tampon - </entry> - </row> - <row> - <entry>F5 / Alt + fl�che gauche</entry> - <entry> - Aller au tampon pr�c�dent - </entry> - </row> - <row> - <entry>F6 / Alt + fl�che droite</entry> - <entry> - Aller au tampon suivant - </entry> - </row> - <row> - <entry>F7</entry> - <entry> - Aller � la fen�tre pr�c�dente - </entry> - </row> - <row> - <entry>F8</entry> - <entry> - Aller � la fen�tre suivante - </entry> - </row> - <row> - <entry>F9 / F10</entry> - <entry> - Faire d�filer le titre du canal - </entry> - </row> - <row> - <entry>F11 / F12</entry> - <entry> - Faire d�filer la liste des pseudos - </entry> - </row> - <row> - <entry>Alt + F11 / Alt + F12</entry> - <entry> - Aller au d�but / � la fin de la liste des pseudos - </entry> - </row> - <row> - <entry>Alt + A</entry> - <entry> - Sauter au prochain tampon avec activit� - (avec priorit� : highlight, message, autre) - </entry> - </row> - <row> - <entry>Alt + B</entry> - <entry> - Aller au mot pr�c�dent - </entry> - </row> - <row> - <entry>Alt + D</entry> - <entry> - Effacer le mot suivant - </entry> - </row> - <row> - <entry>Alt + F</entry> - <entry> - Aller au mot suivant - </entry> - </row> - <row> - <entry>Alt + H</entry> - <entry> - Vider la hotlist - (notification d'activit� sur les autres tampons) - </entry> - </row> - <row> - <entry>Alt + I</entry> - <entry> - Effacer le dernier message de la barre d'informations - </entry> - </row> - <row> - <entry>Alt + J puis Alt + D</entry> - <entry> - Afficher le tampon des DCC - </entry> - </row> - <row> - <entry>Alt + J puis Alt + L</entry> - <entry> - Sauter au dernier tampon - </entry> - </row> - <row> - <entry>Alt + J puis Alt + P</entry> - <entry> - Sauter au tampon affich� pr�c�demment - </entry> - </row> - <row> - <entry>Alt + J puis Alt + R</entry> - <entry> - Sauter au tampon de donn�es brutes IRC - </entry> - </row> - <row> - <entry>Alt + J puis Alt + S</entry> - <entry> - Sauter au tampon du serveur - </entry> - </row> - <row> - <entry>Alt + J puis Alt + X</entry> - <entry> - Sauter au premier canal du serveur suivant - (ou tampon du serveur si aucun canal n'est ouvert) - </entry> - </row> - <row> - <entry>Alt + chiffre (0-9)</entry> - <entry> - Sauter au tampon qui porte ce num�ro (0 = 10) - </entry> - </row> - <row> - <entry>Alt + J puis nombre (01-99)</entry> - <entry> - Sauter au tampon qui porte ce num�ro - </entry> - </row> - <row> - <entry>Alt + K</entry> - <entry> - Capturer une touche et ins�rer son code sur la ligne - de commande - </entry> - </row> - <row> - <entry>Alt + N</entry> - <entry> - Se positionner sur le highlight suivant - </entry> - </row> - <row> - <entry>Alt + P</entry> - <entry> - Se positionner sur le highlight pr�c�dent - </entry> - </row> - <row> - <entry>Alt + R</entry> - <entry> - Effacer enti�rement la ligne de commande - </entry> - </row> - <row> - <entry>Alt + S</entry> - <entry> - Changer de serveur sur le tampon des serveurs - (si l'option "look_one_server_buffer" est activ�e) - </entry> - </row> - <row> - <entry>Alt + U</entry> - <entry> - Se positionner sur la premi�re ligne non lue du tampon - </entry> - </row> - <row> - <entry>Alt + W puis Alt + fl�che</entry> - <entry> - Sauter � une fen�tre avec une direction - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secLigneDeCommande"> - <title>La ligne de commande</title> - - <para> - La ligne de commande WeeChat (situ�e en bas de la fen�tre) permet - d'envoyer du texte sur les canaux et d'ex�cuter des commandes - WeeChat ou IRC (voir <xref linkend="secCommandesWeeChatIRC" />). - </para> - - <para> - Les commandes d�butent par un caract�re "/", suivi du nom de la - commande. Par exemple pour initier une conversation priv�e avec - "<literal>toto</literal>" : - <screen><userinput>/query toto</userinput></screen> - </para> - - <para> - Le texte envoy� � un canal est tout texte ne commen�ant pas par le - caract�re "/", par exemple pour envoyer "<literal>bonjour</literal>" - sur le canal courant : - <screen><userinput>bonjour</userinput></screen> - </para> - - <para> - Il est cependant possible de faire d�buter un texte par "/" en le - doublant. Par exemple pour envoyer le texte - "<literal>/query toto</literal>" sur le canal courant : - <screen><userinput>//query toto</userinput></screen> - </para> - - <para> - Si l'option d'envoi des couleurs IRC - ("<literal>irc_colors_send</literal>") est activ�e, il est possible - d'utiliser des codes couleur et attributs comme suit (appuyer sur Ctrl-C - puis la lettre qui suit et �ventuellement une valeur) : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>^Cb</entry> - <entry> - texte gras - </entry> - </row> - <row> - <entry>^Ccxx</entry> - <entry> - couleur du texte "<literal>xx</literal>" - (voir le tableau des couleurs ci-dessous) - </entry> - </row> - <row> - <entry>^Ccxx,yy</entry> - <entry> - couleur du texte "<literal>xx</literal>" - et du fond "<literal>yy</literal>" - (voir le tableau des couleurs ci-dessous) - </entry> - </row> - <row> - <entry>^Co</entry> - <entry> - d�sactiver la couleur et tous les attributs - </entry> - </row> - <row> - <entry>^Cr</entry> - <entry> - vid�o inverse (inversion de la couleur d'�criture et du fond) - </entry> - </row> - <row> - <entry>^Cu</entry> - <entry> - texte soulign� - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - NB: le m�me code (sans le num�ro pour ^Cc) peut �tre utilis� pour stopper - l'attribut d�fini. - </para> - - <para> - Les codes couleur pour ^Cc sont : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Couleur</entry> - </row> - </thead> - <tbody> - <row> - <entry>00</entry> - <entry>blanc</entry> - </row> - <row> - <entry>01</entry> - <entry>noir</entry> - </row> - <row> - <entry>02</entry> - <entry>bleu fonc�</entry> - </row> - <row> - <entry>03</entry> - <entry>vert fonc�</entry> - </row> - <row> - <entry>04</entry> - <entry>rouge clair</entry> - </row> - <row> - <entry>05</entry> - <entry>rouge fonc�</entry> - </row> - <row> - <entry>06</entry> - <entry>magenta</entry> - </row> - <row> - <entry>07</entry> - <entry>orange</entry> - </row> - <row> - <entry>08</entry> - <entry>jaune</entry> - </row> - <row> - <entry>09</entry> - <entry>vert clair</entry> - </row> - <row> - <entry>10</entry> - <entry>cyan</entry> - </row> - <row> - <entry>11</entry> - <entry>cyan clair</entry> - </row> - <row> - <entry>12</entry> - <entry>bleu clair</entry> - </row> - <row> - <entry>13</entry> - <entry>magenta clair</entry> - </row> - <row> - <entry>14</entry> - <entry>gris</entry> - </row> - <row> - <entry>15</entry> - <entry>gris clair (blanc)</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Exemple : affichage de "<literal>bonjour tout le monde !</literal>" - avec "<literal>bonjour</literal>" en bleu clair gras, et - "<literal>tout le monde</literal>" en rouge clair soulign� : -<screen><userinput>^Cc12^Cbbonjour^Cb^Cc04^Cu tout le monde^Cu^Cc !</userinput></screen> - </para> - - </section> - - <section id="secCommandesWeeChatIRC"> - <title>Commandes WeeChat / IRC</title> - - <para> - Ce chapitre liste toutes les commandes WeeChat et IRC. - </para> - - <section id="secCommandesWeeChat"> - <title>Commandes WeeChat</title> - - <para> - &weechat_commands.xml; - </para> - - </section> - - <section id="secFonctionsTouches"> - <title>Fonctions pour les touches</title> - - <para> - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Fonction</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - - &key_functions.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secCommandesIRC"> - <title>Commandes IRC</title> - - <para> - &irc_commands.xml; - </para> - - </section> - - </section> - - <section id="secFichierConfiguration"> - <title>Fichier de configuration</title> - - <para> - Liste des options du fichier de configuration : - <informaltable colsep="0" frame="none"> - <tgroup cols="5"> - <thead> - <row> - <entry>Option</entry> - <entry>Type</entry> - <entry>Valeurs</entry> - <entry>D�faut</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - - &config.xml; - - </tbody> - </tgroup> - </informaltable> - </para> - - <para> - Les couleurs pour l'interface Curses sont : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Mot cl�</entry> - <entry>Couleur</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>default</literal></entry> - <entry>couleur par d�faut (transparent pour le fond)</entry> - </row> - <row> - <entry><literal>black</literal></entry> - <entry>noir</entry> - </row> - <row> - <entry><literal>red</literal></entry> - <entry>rouge fonc�</entry> - </row> - <row> - <entry><literal>lightred</literal></entry> - <entry>rouge clair</entry> - </row> - <row> - <entry><literal>green</literal></entry> - <entry>vert fonc�</entry> - </row> - <row> - <entry><literal>lightgreen</literal></entry> - <entry>vert clair</entry> - </row> - <row> - <entry><literal>brown</literal></entry> - <entry>marron</entry> - </row> - <row> - <entry><literal>yellow</literal></entry> - <entry>jaune</entry> - </row> - <row> - <entry><literal>blue</literal></entry> - <entry>bleu fonc�</entry> - </row> - <row> - <entry><literal>lightblue</literal></entry> - <entry>bleu clair</entry> - </row> - <row> - <entry><literal>magenta</literal></entry> - <entry>violet fonc�</entry> - </row> - <row> - <entry><literal>lightmagenta</literal></entry> - <entry>violet clair</entry> - </row> - <row> - <entry><literal>cyan</literal></entry> - <entry>cyan fonc�</entry> - </row> - <row> - <entry><literal>lightcyan</literal></entry> - <entry>cyan clair</entry> - </row> - <row> - <entry><literal>white</literal></entry> - <entry>blanc</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - </section> - - <section id="secTubeFIFO"> - <title>Tube FIFO</title> - - <para> - Vous pouvez contr�ler WeeChat � distance, en envoyant des commandes - ou du texte dans un tube FIFO (l'option "irc_fifo_pipe" doit �tre - activ�e, elle est d�sactiv�e par d�faut). - </para> - - <para> - Le tube FIFO est dans le r�pertoire "<literal>~/.weechat/</literal>" - et s'appelle "weechat_fifo_xxxxx" (o� xxxxx est l'ID du processus - (PID) du WeeChat qui tourne). Donc si plusieurs WeeChat tournent, il - y a plusieurs tubes FIFO, un pour chaque session. - </para> - - <para> - La syntaxe pour envoyer des commandes ou du texte dans le tube FIFO - est la suivante : - <screen>serveur,canal *texte ou commande ici</screen> - o� le serveur et le canal sont facultatifs, mais si le canal est l�, - le serveur doit l'�tre aussi. - </para> - - <para> - Quelques exemples : - <itemizedlist> - <listitem> - <para> - changement du pseudo sur freenode en "pseudo|absent" : - <screen><prompt>$ </prompt><userinput>echo 'freenode */nick pseudo|absent' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - affichage de texte sur le canal #weechat : - <screen><prompt>$ </prompt><userinput>echo 'freenode,#weechat *bonjour tout le monde !' >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - <listitem> - <para> - affichage de texte sur le canal courant (le tampon affich� - par WeeChat) : - <screen><prompt>$ </prompt><userinput>echo '*bonjour !' >~/.weechat/weechat_fifo_12345</userinput></screen> - <emphasis>Attention :</emphasis> ceci est dangereux et vous ne - devriez pas le faire sauf si vous savez ce que vous faites ! - </para> - </listitem> - <listitem> - <para> - envoyer deux commandes pour d�charger/recharger les scripts Perl - (vous devez les s�parer par "\n") : - <screen><prompt>$ </prompt><userinput>echo -e "freenode */perl unload\nfreenode */perl autoload" >~/.weechat/weechat_fifo_12345</userinput></screen> - </para> - </listitem> - </itemizedlist> - </para> - - <para> - Vous pouvez �crire un script qui envoie les commandes � tous les - WeeChat qui tournent en m�me temps, par exemple : -<screen> -#!/bin/sh -if [ $# -eq 1 ]; then - for fifo in ~/.weechat/weechat_fifo_* - do - echo -e "$1" >$fifo - done -fi -</screen> - Si le script s'appelle "auto_weechat_command", vous pouvez le lancer - ainsi : - <screen><prompt>$ </prompt><userinput>./auto_weechat_command "freenode,#weechat *bonjour"</userinput></screen> - </para> - - </section> - - </chapter> - - <!-- ============================ Extensions ============================ --> - - <chapter id="chapExtensions"> - <title>Extensions</title> - - <para> - Ce chapitre d�crit l'interface des extensions (API) et les extensions - pour scripts (Perl, Python, Ruby, Lua), fournies avec WeeChat. - </para> - - <section id="secLesExtensionsDansWeeChat"> - <title>Les extensions dans WeeChat</title> - - <para> - Une extension ("plugin" en anglais) est un programme �crit en C - qui peut appeler des fonctions de WeeChat d�finies dans une interface. - </para> - - <para> - Ce programme C n'a pas besoin des sources WeeChat pour �tre - compil� et peut �tre charg�/d�charg� dynamiquement dans - WeeChat via la commande <command>/plugin</command>. - </para> - - <para> - L'extension doit �tre au format biblioth�que, chargeable - dynamiquement par le syst�me d'exploitation. - Sous GNU/Linux, il s'agit d'un fichier ayant pour extension ".so", - sous Windows ".dll". - </para> - - </section> - - <section id="secEcrireUneExtension"> - <title>Ecrire une extension</title> - - <para> - L'extension doit inclure le fichier "weechat-plugin.h" - (disponible dans les sources de WeeChat). - Ce fichier d�finit les structures et types dont l'extension aura - besoin pour communiquer avec WeeChat. - </para> - - <para> - L'extension doit comporter certaines variables et fonctions - obligatoires (sans quoi l'extension ne peut �tre charg�e) : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Variable</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>char plugin_name[]</literal></entry> - <entry>le nom de l'extension</entry> - </row> - <row> - <entry><literal>char plugin_version[]</literal></entry> - <entry>la version de l'extension</entry> - </row> - <row> - <entry><literal>char plugin_description[]</literal></entry> - <entry>une courte description de l'extension</entry> - </row> - </tbody> - </tgroup> - </informaltable> - - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Fonction</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>int weechat_plugin_init (t_weechat_plugin *plugin)</literal></entry> - <entry> - fonction appel�e au chargement de l'extension - qui doit renvoyer PLUGIN_RC_OK en cas de succ�s, - PLUGIN_RC_KO en cas d'erreur (si erreur, l'extension - ne sera PAS charg�e) - </entry> - </row> - <row> - <entry><literal>void weechat_plugin_end (t_weechat_plugin *plugin)</literal></entry> - <entry>fonction appel�e au d�chargement de l'extension</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - - <section id="secFonctionsInterface"> - <title>Fonctions de l'interface (API)</title> - - <section id="secAPI_set_charset"> - <title>set_charset</title> - - <para> - Prototype : - <command> - void set_charset (t_weechat_plugin *plugin, char *charset) - </command> - </para> - <para> - Change le jeu de caract�res de l'extension. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : nouveau jeu de caract�res � utiliser - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : - <screen>plugin->set_charset (plugin, "ISO-8859-1");</screen> - </para> - </section> - - <section id="secAPI_iconv_to_internal"> - <title>iconv_to_internal</title> - - <para> - Prototype : - <command> - void iconv_to_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convertit une cha�ne de caract�res vers le jeu de caract�res - interne WeeChat (UTF-8). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : le jeu de caract�res de d�part - </para> - </listitem> - <listitem> - <para> - <option>string</option> : la cha�ne � convertir - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la cha�ne convertie. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free" apr�s utilisation. - </para> - <para> - Exemple : - <screen>char *str = plugin->iconv_to_internal (plugin, "ISO-8859-1", "chaine iso: � �");</screen> - </para> - </section> - - <section id="secAPI_iconv_from_internal"> - <title>iconv_from_internal</title> - - <para> - Prototype : - <command> - void iconv_from_internal (t_weechat_plugin *plugin, char *charset, - char *string) - </command> - </para> - <para> - Convertit une cha�ne de caract�res depuis le jeu de caract�res - interne WeeChat (UTF-8) vers un autre. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : le jeu de caract�res voulu - </para> - </listitem> - <listitem> - <para> - <option>string</option> : la cha�ne � convertir - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la cha�ne convertie. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free" apr�s utilisation. - </para> - <para> - Exemple : - <screen>char *str = plugin->iconv_from_internal (plugin, "ISO-8859-1", "chaine utf-8: � �");</screen> - </para> - </section> - - <section id="secAPI_ascii_strcasecmp"> - <title>ascii_strcasecmp</title> - - <para> - Prototype : - <command> - int ascii_strcasecmp (t_weechat_plugin *plugin, - char *chaine1, char *chaine2) - </command> - </para> - <para> - Effectue une comparaison entre deux cha�nes, sans tenir compte des - majuscules/minuscules ni de la locale. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine1</option> : la premi�re cha�ne � comparer - </para> - </listitem> - <listitem> - <para> - <option>chaine2</option> : la deuxi�me cha�ne � comparer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la diff�rence entre les deux cha�nes : n�gatif - si chaine1 < chaine2, z�ro si chaine1 == chaine2, positif si - chaine1 > chaine2 - </para> - <para> - Exemple : - <screen>if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...</screen> - </para> - </section> - - <section id="secAPI_ascii_strncasecmp"> - <title>ascii_strncasecmp</title> - - <para> - Prototype : - <command> - int ascii_strncasecmp (t_weechat_plugin *plugin, - char *chaine1, char *chaine2, int max) - </command> - </para> - <para> - Effectue une comparaison entre deux cha�nes, sans tenir compte des - majuscules/minuscules ni de la locale, en comparant au plus "max" - caract�res. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine1</option> : la premi�re cha�ne � comparer - </para> - </listitem> - <listitem> - <para> - <option>chaine2</option> : la deuxi�me cha�ne � comparer - </para> - </listitem> - <listitem> - <para> - <option>max</option> : nombre de caract�res max � comparer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la diff�rence entre les deux cha�nes : n�gatif - si chaine1 < chaine2, z�ro si chaine1 == chaine 2, positif si - chaine1 > chaine2 - </para> - <para> - Exemple : - <screen>if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...</screen> - </para> - </section> - - <section id="secAPI_explode_string"> - <title>explode_string</title> - - <para> - Prototype : - <command> - char **explode_string (t_weechat_plugin *plugin, char *chaine, - char *separateurs, int num_items_max, int *num_items) - </command> - </para> - <para> - Explose une cha�ne en plusieurs selon un/des d�limiteur(s). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine</option> : la cha�ne � exploser - </para> - </listitem> - <listitem> - <para> - <option>separateurs</option> : les d�limiteurs utilis�s - pour exploser la cha�ne - </para> - </listitem> - <listitem> - <para> - <option>num_items_max</option> : nombre maximum de - sous-cha�nes cr��es (0 = pas de limite) - </para> - </listitem> - <listitem> - <para> - <option>num_items</option> : pointeur vers un entier qui - contiendra le nombre de sous-cha�nes cr��es en retour - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : un tableau de cha�nes, ou NULL si un probl�me - a �t� rencontr�. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_exploded_string" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -char **argv; -int argc; -argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_free_exploded_string"> - <title>free_exploded_string</title> - - <para> - Prototype : - <command> - char **free_exploded_string (t_weechat_plugin *plugin, - char **chaine) - </command> - </para> - <para> - Lib�re la m�moire utilis�e pour une explosion de cha�ne. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>chaine</option> : la cha�ne explos�e par la fonction - "explode_string" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : -<screen> -char *argv; -int argc; -argv = plugin->explode_string (plugin, chaine, " ", 0, &argc); -... -if (argv != NULL) - plugin->free_exploded_string (plugin, argv); -</screen> - </para> - </section> - - <section id="secAPI_mkdir_home"> - <title>mkdir_home</title> - - <para> - Prototype : - <command> - int mkdir_home (t_weechat_plugin *plugin, char *repertoire) - </command> - </para> - <para> - Cr�� un r�pertoire dans le r�pertoire de base de WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>repertoire</option> : r�pertoire � cr�er - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si le r�pertoire a �t� cr�� avec succ�s, - 0 si une erreur s'est produite. - </para> - <para> - Example: -<screen> -if (!plugin->mkdir_home (plugin, "temp")) - plugin->print_server(plugin, "Impossible de cr�er le r�pertoire 'temp' dans la base WeeChat."); -</screen> - </para> - </section> - - <section id="secAPI_exec_on_files"> - <title>exec_on_files</title> - - <para> - Prototype : - <command> - void exec_on_files (t_weechat_plugin *plugin, char *repertoire, - int (*callback)(t_weechat_plugin *, char *)) - </command> - </para> - <para> - Ex�cute une fonction sur tous les fichiers d'un r�pertoire. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>repertoire</option> : le r�pertoire o� les fichiers - sont recherch�s - </para> - </listitem> - <listitem> - <para> - <option>callback</option> : une fonction appel�e pour chaque - fichier trouv� - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : -<screen> -int callback (t_weechat_plugin *plugin, char *fichier) -{ - plugin->print_server (plugin, "fichier: %s", fichier); - return 1; -} -... -plugin->exec_on_files (plugin, "/tmp", &callback); -</screen> - </para> - </section> - - <section id="secAPI_print"> - <title>print</title> - - <para> - Prototype : - <command> - void print (t_weechat_plugin *plugin, - char *serveur, char *canal, char *message, ...) - </command> - </para> - <para> - Affiche un message sur un tampon WeeChat, identifi� par le serveur - et le canal (tous deux pouvant �tre NULL pour le tampon courant). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le tampon dans lequel afficher (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - tampon dans lequel afficher (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message � afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, il faut utiliser les codes - suivants : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>0x02</entry> - <entry> - texte gras - </entry> - </row> - <row> - <entry>0x03 + "xx"</entry> - <entry> - couleur du texte "<literal>xx</literal>" - (voir <xref linkend="secAPI_get_irc_color" /> pour les - couleurs) - </entry> - </row> - <row> - <entry>0x03 + "xx,yy"</entry> - <entry> - couleur du texte "<literal>xx</literal>" - et du fond "<literal>yy</literal>" - (voir <xref linkend="secAPI_get_irc_color" /> pour les - couleurs) - </entry> - </row> - <row> - <entry>0x0F</entry> - <entry> - d�sactiver la couleur et tous les attributs - </entry> - </row> - <row> - <entry>0x12</entry> - <entry> - vid�o inverse (inversion de la couleur d'�criture et du fond) - </entry> - </row> - <row> - <entry>0x1F</entry> - <entry> - texte soulign� - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - NB: le m�me code (sans le num�ro pour 0x03) peut �tre utilis� pour stopper - l'attribut d�fini. - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemples : -<screen> -plugin->print (plugin, NULL, NULL, "hello"); -plugin->print (plugin, NULL, "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, "freenode", "#weechat", "hello"); -plugin->print (plugin, NULL, NULL, - "test: \x02 gras \x0F\x03%02d bleu \x03%02d vert", - plugin->get_irc_color (plugin, "blue"), - plugin->get_irc_color (plugin, "green")); -</screen> - </para> - </section> - - <section id="secAPI_print_server"> - <title>print_server</title> - - <para> - Prototype : - <command> - void print_server (t_weechat_plugin *plugin, - char *message, ...) - </command> - </para> - <para> - Affiche un message sur le tampon du serveur courant. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message � afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, voir - <xref linkend="secAPI_print" />. - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : <screen>plugin->print_server (plugin, "hello");</screen> - </para> - </section> - - <section id="secAPI_print_infobar"> - <title>print_infobar</title> - - <para> - Prototype : - <command> - void print_infobar (t_weechat_plugin *plugin, - int temps, char *message, ...) - </command> - </para> - <para> - Affiche un message sur la barre d'infos pour un temps d�termin�. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>temps</option> : temps (en secondes) pendant lequel - le message est affich� (0 = jamais effac�) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : -<screen> -plugin->print_infobar (plugin, 5, "hello"); -</screen> - </para> - </section> - - <section id="secAPI_infobar_remove"> - <title>infobar_remove</title> - - <para> - Prototype : - <command> - void infobar_remove (t_weechat_plugin *plugin, int nombre) - </command> - </para> - <para> - Efface un ou plusieurs messages dans la pile de la barre d'infos. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>nombre</option> : nombre de messages � supprimer - (si param�tre non pr�sent ou <= 0, alors tous les messages - sont effac�s) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : <screen>plugin->infobar_remove (1);</screen> - </para> - </section> - - <section id="secAPI_log"> - <title>log</title> - - <para> - Prototype : - <command> - void log (t_weechat_plugin *plugin, - char *serveur, char *canal, char *message, ...) - </command> - </para> - <para> - Ecrit un message dans le fichier de log pour un serveur ou un - canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le log du tampon (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - tampon le log du tampon (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : -<screen> -plugin->log (plugin, "freenode", "#weechat", "test"); -</screen> - </para> - </section> - - <section id="secAPI_msg_handler_add"> - <title>msg_handler_add</title> - - <para> - Prototype : - <command> - t_plugin_handler *msg_handler_add (t_weechat_plugin - *plugin, char *message, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de messages IRC, appel� d�s qu'un message - IRC est re�u. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appel�e ("*" pour tous les messages). - Pour conna�tre la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - De plus, vous pouvez utiliser un nom sp�cial, pr�fix� par - "weechat_" pour capturer des �v�nements sp�ciaux, comme d�crit - dans le tableau ci-dessous : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Nom</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>weechat_pv</literal></entry> - <entry>message priv� re�u</entry> - </row> - <row> - <entry><literal>weechat_highlight</literal></entry> - <entry> - message avec highlight (sur un canal ou en priv�) - </entry> - </row> - <row> - <entry><literal>weechat_ctcp</literal></entry> - <entry> - message CTCP re�u (VERSION, PING, etc...) - </entry> - </row> - <row> - <entry><literal>weechat_dcc</literal></entry> - <entry> - message DCC re�u (discussion ou fichier) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e lorsque le - message est re�u - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le param�tre argc vaut 3 et les arguments suivants sont - pass�s dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = message IRC</para> - </listitem> - <listitem> - <para>argv[2] = arguments de la commande</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau gestionnaire de - messages. - </para> - <para> - Note : la fonction appel�e lorsque le message est re�u doit - renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal> : le message - ne sera pas transmis � WeeChat - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal> : le message - ne sera pas transmis � d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal> : le message - ne sera ni transmis � WeeChat ni � d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal> : la fonction - a r�ussi et provoque un "highlight" sur le message re�u - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int msg_kick (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, "KICK re�u"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *msg_handler; -msg_handler = plugin->msg_handler_add (plugin, "KICK", - &msg_kick, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_cmd_handler_add"> - <title>cmd_handler_add</title> - - <para> - Prototype : - <command> - t_plugin_handler *cmd_handler_add (t_weechat_plugin - *plugin, char *commande, char *description, char *arguments, - char *arguments_description, char *modele_completion, - t_plugin_handler_func *fonction, char *handler_args, - void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de commande WeeChat, appel� d�s que - l'utilisateur utilise la commande (par exemple /commande). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>commande</option> : nom de la nouvelle commande, - qui peut �tre une commande d�j� existante (attention la - commande remplac�e ne sera plus disponible jusqu'� ce que - l'extension soit d�charg�e) - </para> - </listitem> - <listitem> - <para> - <option>description</option> : br�ve description de la - commande (affich�e par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>arguments</option> : br�ve description des - param�tres de la commande (affich�e par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option> : longue description - des param�tres de la commande (affich�e par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>modele_completion</option> : mod�le pour la - compl�tion sous la forme "<literal>abc|%w def|%i</literal>" - qui signifie "abc" ou une commande WeeChat pour le premier - param�tre, et "def" ou une commande IRC pour le deuxi�me. - Une cha�ne vide indique � WeeChat de compl�ter tout - param�tre avec un pseudo du canal courant, une valeur NULL - ou �gale � "-" d�sactive toute compl�tion pour tous les - param�tres de la commande. - </para> - <para> - Les codes suivants peuvent �tre utilis�s : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Code</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>%-</literal></entry> - <entry>aucune compl�tion pour le param�tre</entry> - </row> - <row> - <entry><literal>%*</literal></entry> - <entry> - r�p�tition de la derni�re compl�tion pour tous - les param�tres suivants (ce code doit �tre � la - fin du mod�le de compl�tion, pr�c�d� d'un "|") - </entry> - </row> - <row> - <entry><literal>%a</literal></entry> - <entry>alias</entry> - </row> - <row> - <entry><literal>%A</literal></entry> - <entry> - alias et commandes (WeeChat, IRC et extensions) - </entry> - </row> - <row> - <entry><literal>%c</literal></entry> - <entry>canal courant</entry> - </row> - <row> - <entry><literal>%C</literal></entry> - <entry>tous les canaux (y compris les priv�s)</entry> - </row> - <row> - <entry><literal>%f</literal></entry> - <entry>nom de fichier</entry> - </row> - <row> - <entry><literal>%h</literal></entry> - <entry>commandes d�finies par des extensions</entry> - </row> - <row> - <entry><literal>%i</literal></entry> - <entry>commandes IRC (envoy�es)</entry> - </row> - <row> - <entry><literal>%I</literal></entry> - <entry>commandes IRC (re�ues)</entry> - </row> - <row> - <entry><literal>%k</literal></entry> - <entry>fonctions associ�es aux touches</entry> - </row> - <row> - <entry><literal>%m</literal></entry> - <entry>pseudo sur le serveur courant</entry> - </row> - <row> - <entry><literal>%M</literal></entry> - <entry> - pseudos sur le serveur courant - (tous les canaux ouverts) - </entry> - </row> - <row> - <entry><literal>%n</literal></entry> - <entry>pseudos du canal courant</entry> - </row> - <row> - <entry><literal>%N</literal></entry> - <entry> - pseudos et noms de machines du canal - courant - </entry> - </row> - <row> - <entry><literal>%o</literal></entry> - <entry>options de configuration</entry> - </row> - <row> - <entry><literal>%O</literal></entry> - <entry>options des extensions</entry> - </row> - <row> - <entry><literal>%p</literal></entry> - <entry>message de "part" par d�faut</entry> - </row> - <row> - <entry><literal>%q</literal></entry> - <entry>message de "quit" par d�faut</entry> - </row> - <row> - <entry><literal>%s</literal></entry> - <entry>nom du serveur courant</entry> - </row> - <row> - <entry><literal>%S</literal></entry> - <entry>tous les serveurs</entry> - </row> - <row> - <entry><literal>%t</literal></entry> - <entry>titre du canal courant</entry> - </row> - <row> - <entry><literal>%v</literal></entry> - <entry>valeur d'une option de configuration</entry> - </row> - <row> - <entry><literal>%V</literal></entry> - <entry>valeur d'une option d'extension</entry> - </row> - <row> - <entry><literal>%w</literal></entry> - <entry>commandes WeeChat</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e lorsque la - commande est ex�cut�e. - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le param�tre argc vaut 3 et les arguments suivants sont - pass�s dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = commande</para> - </listitem> - <listitem> - <para>argv[2] = arguments de la commande</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau gestionnaire de - commande. - </para> - <para> - Note : la fonction appel�e lorsque la commande est ex�cut�e doit - renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int cmd_test (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, argv[0], NULL, - "commande test, pseudo: %s", - (argv[2]) ? argv[2] : "aucun"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *cmd_handler; -cmd_handler = plugin->cmd_handler_add (plugin, "test", "Commande test", - "[pesudo]", "pseudo: un pseudo du canal", - "%n", &cmd_test, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_timer_handler_add"> - <title>timer_handler_add</title> - - <para> - Prototype : - <command> - t_plugin_handler *timer_handler_add (t_weechat_plugin - *plugin, int intervalle, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de temps, qui appelle p�riodiquement une - fonction. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>intervalle</option> : intervalle (en secondes) - entre deux appels de la fonction. - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le param�tre argc vaut 0 et argv vaut NULL. - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau gestionnaire de - temps. - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_timer (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "mon timer"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *timer_handler; -timer_handler = plugin->timer_handler_add (plugin, 60, &mon_timer); -</screen> - </para> - </section> - - <section id="secAPI_keyboard_handler_add"> - <title>keyboard_handler_add</title> - - <para> - Prototype : - <command> - t_plugin_handler *keyboard_handler_add (t_weechat_plugin - *plugin, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire de clavier, appel� d�s qu'une touche est - press�e. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Le param�tre argc vaut 3 et les arguments suivants sont - pass�s dans le tableau argv : - <itemizedlist> - <listitem> - <para> - argv[0] = touche appuy�e (nom d'une fonction interne - ou bien '*' suivi du code d'une touche) - </para> - </listitem> - <listitem> - <para> - argv[1] = la ligne de commande avant l'action de la - touche - </para> - </listitem> - <listitem> - <para> - argv[2] = la ligne de commande apr�s l'action de la - touche - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau gestionnaire de - clavier. - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_keyb (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argc == 2) - { - plugin->print (plugin, NULL, NULL, "touche appuy�e: %s", argv[0]); - if (argv[1] && (argv[1][0] == '1')) - plugin->print (plugin, NULL, NULL, "le texte d'entr�e a chang�"); - else - plugin->print (plugin, NULL, NULL, "le texte d'entr�e n'a pas chang�"); - } - return PLUGIN_RC_OK; -} -... -t_plugin_handler *keyb_handler; -keyb_handler = plugin->keyboard_handler_add (plugin, &mon_keyb); -</screen> - </para> - </section> - - <section id="secAPI_event_handler_add"> - <title>event_handler_add</title> - - <para> - Prototype : - <command> - t_plugin_handler *event_handler_add (t_weechat_plugin - *plugin, char *evenement, t_plugin_handler_func *fonction, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Ajoute un gestionnaire d'�v�nement, appel� d�s qu'un �v�nement se - produit. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>�v�nement</option> : �v�nement (voir le tableau - ci-dessous) - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - <para> - Elle a le prototype suivant : - <command> - int ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *handler_args, void *handler_pointer) - </command> - </para> - <para> - Les param�tres pass�s � la fonction d�pendent de l'�v�nement - (voir le tableau ci-dessous). - </para> - </listitem> - <listitem> - <para> - <option>handler_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>handler_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Liste des �v�nements : - <informaltable colsep="0" frame="none"> - <tgroup cols="3"> - <thead> - <row> - <entry>Ev�nement</entry> - <entry>Description</entry> - <entry>Param�tres</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>buffer_open</literal></entry> - <entry>un tampon a �t� ouvert</entry> - <entry> - argc = 1, argv = { num�ro de tampon } - </entry> - </row> - <row> - <entry><literal>buffer_close</literal></entry> - <entry>un tampon a �t� ferm�</entry> - <entry> - argc = 1, argv = { num�ro de tampon } - </entry> - </row> - <row> - <entry><literal>buffer_move</literal></entry> - <entry>un tampon a �t� d�plac�</entry> - <entry> - argc = 2, argv = { nouveau num�ro de tampon, ancien num�ro } - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau gestionnaire - d'�v�nement. - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - <para> - Exemple : -<screen> -int mon_evenement (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - plugin->print (plugin, NULL, NULL, "mon_evenement"); - return PLUGIN_RC_OK; -} -... -t_plugin_handler *event_handler; -event_handler = plugin->event_handler_add (plugin, "buffer_open", - &mon_evenement); -</screen> - </para> - </section> - - <section id="secAPI_handler_remove"> - <title>handler_remove</title> - - <para> - Prototype : - <command> - void handler_remove (t_weechat_plugin *plugin, - t_plugin_handler *handler) - </command> - </para> - <para> - Supprime un gestionnaire de commande ou message. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>handler</option> : le gestionnaire � supprimer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->handler_remove (plugin, mon_handler);</screen> - </para> - </section> - - <section id="secAPI_handler_remove_all"> - <title>handler_remove_all</title> - - <para> - Prototype : - <command> - void handler_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Supprime tous les gestionnaires d'une extension. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->handler_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_modifier_add"> - <title>modifier_add</title> - - <para> - Prototype : - <command> - t_plugin_modifier *modifier_add (t_weechat_plugin *plugin, - char *type, char *message, t_plugin_modifier_func *fonction, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Ajoute un modifieur de message. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>type</option> : type de modifieur : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>appel� pour chaque message IRC re�u</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - appel� pour chaque message (ou commande) envoy� par - l'utilisateur (avant traitement et affichage par - WeeChat) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - appel� pour chaque message sortant juste avant - envoi au serveur IRC (y compris pour les messages - envoy�s automatiquement et de mani�re transparente - par WeeChat) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appel�e (utilis� uniquement pour les types - "irc_in" et "irc_out"). - Pour conna�tre la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - La valeur sp�ciale "*" signifie tous les messages (pas de filtre). - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - <para> - Elle a le prototype suivant : - <command> - char *ma_fonction (t_weechat_plugin *plugin, - int argc, char **argv, - char *modifier_args, void *modifier_pointer) - </command> - </para> - <para> - Le param�tre argc vaut 2 et les arguments suivants sont - pass�s dans le tableau argv : - <itemizedlist> - <listitem> - <para>argv[0] = nom du serveur</para> - </listitem> - <listitem> - <para>argv[1] = message</para> - </listitem> - </itemizedlist> - </para> - </listitem> - <listitem> - <para> - <option>modifier_args</option> : param�tres pass�s � la - fonction appel�e - </para> - </listitem> - <listitem> - <para> - <option>modifier_pointer</option> : pointeur pass� � la - fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : le pointeur vers le nouveau modifieur de message. - </para> - <para> - Note : la fonction doit retourner une cha�ne modifi�e, ou NULL si - elle ne souhaite pas modifier le message. - Si elle retourne une chaine vide, alors le message est supprim� et - ne sera pas trait� du tout par WeeChat (soyez prudent en supprimant - des messages !). - La cha�ne renvoy�e doit avoir �t� allou�e par malloc() et sera - lib�r�e (par appel � free()) automatiquement par WeeChat apr�s - utilisation. - </para> - <para> - Exemple : -<screen> -char *adder (t_weechat_plugin *plugin, int argc, char **argv, - char *modifier_args, void *modifier_pointer) -{ - char *string; - string = (char *)malloc (strlen (argv[1]) + 16); - strcpy (string, argv[1]); - strcat (string, "test"); - return string; -} -... -t_plugin_modifier *modifier; -modifier = plugin->modifier_add (plugin, "irc_in", "privmsg", - &adder, NULL, NULL); -</screen> - </para> - </section> - - <section id="secAPI_modifier_remove"> - <title>modifier_remove</title> - - <para> - Prototype : - <command> - void modifier_remove (t_weechat_plugin *plugin, - t_plugin_modifier *modifier) - </command> - </para> - <para> - Supprime un modifieur de message. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>modifier</option> : le modifieur � supprimer - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->modifier_remove (plugin, mon_modifier);</screen> - </para> - </section> - - <section id="secAPI_modifier_remove_all"> - <title>modifier_remove_all</title> - - <para> - Prototype : - <command> - void modifier_remove_all (t_weechat_plugin *plugin) - </command> - </para> - <para> - Supprime tous les modifieurs d'une extension. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->modifier_remove_all (plugin);</screen> - </para> - </section> - - <section id="secAPI_exec_command"> - <title>exec_command</title> - - <para> - Prototype : - <command> - void exec_command (t_weechat_plugin - *plugin, char *serveur, char *canal, char *commande) - </command> - </para> - <para> - Execute une commande WeeChat ou envoie un message � un canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur o� - ex�cuter la commande (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal o� ex�cuter la - commande (peut �tre NULL) - </para> - </listitem> - <listitem> - <para> - <option>commande</option> : la commande � ex�cuter - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemples : -<screen> -plugin->exec_command (plugin, NULL, NULL, "/help nick"); -plugin->exec_command (plugin, "freenode", "#weechat", "bonjour"); -</screen> - </para> - </section> - - <section id="secAPI_get_info"> - <title>get_info</title> - - <para> - Prototype : - <command> - char *get_info (t_weechat_plugin *plugin, - char *info, char *serveur) - </command> - </para> - <para> - Renvoie une information sur WeeChat ou un canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>info</option> : nom de l'info � obtenir : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Info</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>version</literal></entry> - <entry>version de WeeChat</entry> - </row> - <row> - <entry><literal>nick</literal></entry> - <entry>pesudo</entry> - </row> - <row> - <entry><literal>channel</literal></entry> - <entry> - nom du canal (NULL pour un serveur ou un priv�) - </entry> - </row> - <row> - <entry><literal>server</literal></entry> - <entry>nom du serveur</entry> - </row> - <row> - <entry><literal>type</literal></entry> - <entry> - type de tampon: 0=standard, 1=DCC, - 2=donn�es IRC brutes - </entry> - </row> - <row> - <entry><literal>away</literal></entry> - <entry>drapeau "away"</entry> - </row> - <row> - <entry><literal>inactivity</literal></entry> - <entry> - nombre de secondes �coul�es depuis que la derni�re - touche a �t� appuy�e - </entry> - </row> - <row> - <entry><literal>input</literal></entry> - <entry> - contenu de la ligne de commande de la fen�tre - courante - </entry> - </row> - <row> - <entry><literal>input_mask</literal></entry> - <entry> - contenu du masque de couleur de la ligne de - commande - </entry> - </row> - <row> - <entry><literal>input_pos</literal></entry> - <entry> - position du curseur dans la ligne de commande - </entry> - </row> - <row> - <entry><literal>weechat_dir</literal></entry> - <entry> - r�pertoire de base de WeeChat - (par d�faut: ~/.weechat/) - </entry> - </row> - <row> - <entry><literal>weechat_libdir</literal></entry> - <entry>r�pertoire "lib" syst�me de WeeChat</entry> - </row> - <row> - <entry><literal>weechat_sharedir</literal></entry> - <entry>r�pertoire "share" syst�me de WeeChat</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur o� - r�cup�rer l'information (si n�cessaire) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : l'information recherch�e, NULL si non trouv�e. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free" apr�s utilisation. - </para> - <para> - Exemples : -<screen> -char *version = plugin->get_info (plugin, "version", NULL); -char *nick = plugin->get_info (plugin, "nick", "freenode"); -char *inactivity = plugin->get_info (plugin, "inactivity", NULL); - -plugin->print (plugin, NULL, NULL, - "WeeChat version %s, vous �tes %s sur freenode " - "(inactif depuis %s secondes)", - version, nick, inactivity); - -if (version) - free (version); -if (nick) - free (nick); -if (inactivity) - free (inactivity); -</screen> - </para> - </section> - - <section id="secAPI_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Prototype : - <command> - t_plugin_info_dcc *get_dcc_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Renvoie la liste des DCC en cours ou termin�s. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la liste cha�n�e des DCC. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>server</literal></entry> - <entry>le serveur IRC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel</literal></entry> - <entry>le canal IRC</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - le type de DCC : - 0 = discussion re�ue, - 1 = discussion envoy�e, - 2 = fichier re�u, - 3 = fichier envoy� - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>status</literal></entry> - <entry> - le statut du DCC : - 0 = en attente, - 1 = en cours de connexion, - 2 = actif, - 3 = termin�, - 4 = �chou�, - 5 = interrompu par l'utilisateur - </entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_time</literal></entry> - <entry>la date et heure de cr�ation du DCC</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>start_transfer</literal></entry> - <entry>la date et heure de d�marrage du transfert</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>addr</literal></entry> - <entry>adresse IP de l'utilisateur distant</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>port utilis� pour le DCC</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo de l'utilisateur distant</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>filename</literal></entry> - <entry>nom de fichier</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>local_filename</literal></entry> - <entry>nom de fichier local</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>filename_suffix</literal></entry> - <entry>suffixe si renommage de fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>size</literal></entry> - <entry>taille du fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>pos</literal></entry> - <entry>position actuelle dans le fichier</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>start_resume</literal></entry> - <entry>position de d�marrage apr�s une interruption</entry> - </row> - <row> - <entry>unsigned long</entry> - <entry><literal>bytes_per_sec</literal></entry> - <entry> - nombre d'octets transmis par seconde depuis le d�but - du transfert - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>prev_dcc</literal></entry> - <entry> - pointeur vers l'info DCC pr�c�dente - </entry> - </row> - <row> - <entry>t_plugin_dcc_info *</entry> - <entry><literal>next_dcc</literal></entry> - <entry> - pointeur vers l'info DCC suivante - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_dcc_info" apr�s utilisation. - </para> - <para> - Exemples : -<screen> -t_plugin_dcc_info *dcc_info = plugin->get_dcc_info (plugin); -for (ptr_dcc = dcc_info; ptr_dcc; ptr_dcc = ptr_dcc->next_dcc) -{ - plugin->print_server (plugin, "DCC type=%d, avec: %s", - ptr_dcc->type, ptr_dcc->nick); -} -if (dcc_info) - plugin->free_dcc_info (plugin, dcc_info); -</screen> - </para> - </section> - - <section id="secAPI_free_dcc_info"> - <title>free_dcc_info</title> - - <para> - Prototype : - <command> - void free_dcc_info (t_weechat_plugin *plugin, - t_plugin_dcc_info *dcc_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de DCC. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>dcc_info</option> : pointeur vers la liste DCC - renvoy�e par la fonction "get_dcc_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_dcc_info (plugin, dcc_info);</screen> - </para> - </section> - - <section id="secAPI_get_server_info"> - <title>get_server_info</title> - - <para> - Prototype : - <command> - t_plugin_server_info *get_server_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Renvoie la liste des serveurs IRC (connect�s ou non). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur retourn�e : la liste cha�n�e des serveurs IRC. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>nom interne du serveur</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoconnect</literal></entry> - <entry>1 si auto-connexion au d�marrage, 0 sinon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect</literal></entry> - <entry> - 1 si auto-reconnexion quand d�connect�, - 0 sinon - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autoreconnect_delay</literal></entry> - <entry>d�lai avant de tenter une reconnexion</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_line</literal></entry> - <entry> - 1 si le serveur vient de la ligne de commande - (donc temporaire), 0 sinon - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>address</literal></entry> - <entry>adresse du serveur (nom ou IP)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>port</literal></entry> - <entry>port</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ipv6</literal></entry> - <entry>connexion IPv6</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl</literal></entry> - <entry>connexion SSL</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>password</literal></entry> - <entry>mot de passe pour le serveur</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick1</literal></entry> - <entry>premier pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick2</literal></entry> - <entry>pseudo alternatif</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick3</literal></entry> - <entry>second pseudo alternatif</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>username</literal></entry> - <entry>nom d'utilisateur</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>real name</literal></entry> - <entry>nom r�el</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>command</literal></entry> - <entry>commande ex�cut�e une fois connect�</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>command_delay</literal></entry> - <entry>d�lai apr�s ex�cution de la commande</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>autojoin</literal></entry> - <entry>canaux joints automatiquement</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>autorejoin</literal></entry> - <entry> - 1 si les canaux sont rejoints apr�s un "kick", - 0 sinon - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>notify_levels</literal></entry> - <entry>niveaux de notification des canaux</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_iso</literal></entry> - <entry> - jeux de caract�res de d�codage ISO pour les canaux - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_decode_utf</literal></entry> - <entry> - jeux de caract�res de d�codage UTF pour les canaux - </entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>charset_encode</literal></entry> - <entry> - jeux de caract�res d'encodage pour les canaux - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_connected</literal></entry> - <entry>1 si connect� au serveur, 0 sinon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>ssl_connected</literal></entry> - <entry>1 si connect� via SSL, 0 sinon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo courant</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>is_away</literal></entry> - <entry>1 si absent, 0 sinon</entry> - </row> - <row> - <entry>time_t</entry> - <entry><literal>away_time</literal></entry> - <entry> - date/heure � laquelle l'utilisateur a �t� marqu� absent - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>lag</literal></entry> - <entry>lag (en millisecondes)</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>prev_server</literal></entry> - <entry>pointeur vers les infos du serveur pr�c�dent</entry> - </row> - <row> - <entry>t_plugin_server_info *</entry> - <entry><literal>next_server</literal></entry> - <entry>pointeur vers les infos du serveur suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_server_info" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_server_info *server_info, *ptr_server_info; -server_info = plugin->get_server_info (plugin); -if (server_info) -{ - for (ptr_server_info = server_info; ptr_server_info; - ptr_server_info = ptr_server_info->next_server) - { - plugin->print (plugin, NULL, NULL, - "serveur: %s, addresse: %s, port: %d %s", - ptr_server_info->name, - ptr_server_info->address, - ptr_server_info->port, - (ptr_server_info->is_connected) ? "(connect�)" : ""); - } - plugin->free_server_info (plugin, server_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_server_info"> - <title>free_server_info</title> - - <para> - Prototype : - <command> - void free_server_info (t_weechat_plugin *plugin, - t_plugin_server_info *server_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de serveurs. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>server_info</option> : pointeur vers la liste de - serveurs retourn�e par la fonction "get_server_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_server_info (plugin, server_info);</screen> - </para> - </section> - - <section id="secAPI_get_channel_info"> - <title>get_channel_info</title> - - <para> - Prototype : - <command> - t_plugin_channel_info *get_channel_info (t_weechat_plugin *plugin, - char *serveur) - </command> - </para> - <para> - Renvoie la liste des canaux IRC pour un serveur. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la liste cha�n�e des canaux IRC du serveur. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Field</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry>0 pour un canal, 1 pour un priv�</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>name</literal></entry> - <entry>nom du canal</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>topic</literal></entry> - <entry>titre du canal</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>modes</literal></entry> - <entry>modes du canal</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>limit</literal></entry> - <entry>limite d'utilisateurs</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>key</literal></entry> - <entry>cl� du canal</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>nicks_count</literal></entry> - <entry>nombre de pseudos pr�sents sur le canal</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>prev_channel</literal></entry> - <entry>pointeur vers les infos du canal pr�c�dent</entry> - </row> - <row> - <entry>t_plugin_channel_info *</entry> - <entry><literal>next_channel</literal></entry> - <entry>pointeur vers les infos du canal suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_channel_info" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_channel_info *channel_info, *ptr_chan_info; -channel_info = plugin->get_channel_info (plugin, "freenode"); -if (channel_info) -{ - for (ptr_chan_info = channel_info; ptr_chan_info; - ptr_chan_info = ptr_chan_info->next_channel) - { - plugin->print (plugin, NULL, NULL, - " %s (type %d)", - ptr_chan_info->name, - ptr_chan_info->type); - } - plugin->free_channel_info (plugin, channel_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_channel_info"> - <title>free_channel_info</title> - - <para> - Prototype : - <command> - void free_channel_info (t_weechat_plugin *plugin, - t_plugin_channel_info *channel_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de canaux. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>channel_info</option> : pointeur vers la liste de - canaux retourn�e par la fonction "get_channel_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_channel_info (plugin, channel_info);</screen> - </para> - </section> - - <section id="secAPI_get_nick_info"> - <title>get_nick_info</title> - - <para> - Prototype : - <command> - t_plugin_nick_info *get_nick_info (t_weechat_plugin *plugin, - char *serveur, char *canal) - </command> - </para> - <para> - Renvoie la liste des pseudos pour un canal. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la liste cha�n�e des pseudos pr�sents - sur le canal. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>host</literal></entry> - <entry>nom de machine</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>flags</literal></entry> - <entry> - propri�t�s du pseudo, "ou" binaire entre plusieurs - valeurs (1 =propri�taire du canal, 2 = administrateur - du canal, 4 = op, 8 = demi-op, 16 = voix, 32 = absent) - </entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>prev_nick</literal></entry> - <entry>pointeur vers les infos du pseudo pr�c�dent</entry> - </row> - <row> - <entry>t_plugin_nick_info *</entry> - <entry><literal>next_nick</literal></entry> - <entry>pointeur vers les infos du pseudo pr�c�dent</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_nick_info" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_nick_info *nick_info, *ptr_nick_info; -nick_info = plugin->get_nick_info (plugin, "freenode", "#weechat"); -if (nick_info) -{ - for (ptr_nick_info = nick_info; ptr_nick_info; - ptr_nick_info = ptr_nick_info->next_nick) - { - plugin->print (plugin, NULL, NULL, - " %s (flags: %d)", - ptr_nick_info->nick, - ptr_nick_info->flags); - } - plugin->free_nick_info (plugin, nick_info); -} -</screen> - </para> - </section> - - <section id="secAPI_free_nick_info"> - <title>free_nick_info</title> - - <para> - Prototype : - <command> - void free_nick_info (t_weechat_plugin *plugin, - t_plugin_nick_info *nick_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de pseudos. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>nick_info</option> : pointeur vers la liste de - pseudos retourn�e par la fonction "get_nick_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_nick_info (plugin, nick_info);</screen> - </para> - </section> - - <section id="secAPI_get_config"> - <title>get_config</title> - - <para> - Prototype : - <command> - char *get_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Renvoie la valeur d'une option de configuration WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option � lire - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la valeur de l'option, NULL si non trouv�e. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free" apr�s utilisation. - </para> - <para> - Exemples : -<screen> -char *value1 = plugin->get_config (plugin, "look_set_title"); -char *value2 = plugin->get_config (plugin, "freenode.server_autojoin"); -</screen> - </para> - </section> - - <section id="secAPI_set_config"> - <title>set_config</title> - - <para> - Prototype : - <command> - int set_config (t_weechat_plugin *plugin, - char *option, char *valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de configuration WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option � mettre � jour - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : nouvelle valeur pour l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si l'option a �t� modifi�e avec succ�s, 0 si - une erreur s'est produite. - </para> - <para> - Exemple : -<screen> -plugin->set_config (plugin, "look_nicklist", "off"); -</screen> - </para> - </section> - - <section id="secAPI_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Prototype : - <command> - char *get_plugin_config (t_weechat_plugin *plugin, char *option) - </command> - </para> - <para> - Renvoie la valeur d'une option de l'extension. - L'option est lue depuis le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : "<literal>extension.option=valeur</literal>" - (NB : le nom de l'extension est ajout� automatiquement). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option � lire - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la valeur de l'option, NULL si non trouv�e. - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -char *value = plugin->get_plugin_config (plugin, "ma_variable"); -</screen> - </para> - </section> - - <section id="secAPI_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Prototype : - <command> - int set_plugin_config (t_weechat_plugin *plugin, - char *option, char *valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de l'extension. - L'option est �crite dans le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : "<literal>extension.option=valeur</literal>" - (NB : le nom de l'extension est ajout� automatiquement). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>option</option> : nom de l'option � mettre � jour - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : nouvelle valeur pour l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si l'option a �t� modifi�e avec succ�s, 0 si - une erreur s'est produite. - </para> - <para> - Exemple : -<screen> -plugin->set_plugin_config (plugin, "ma_variable", "valeur"); -</screen> - </para> - </section> - - <section id="secAPI_get_irc_color"> - <title>get_irc_color</title> - - <para> - Prototype : - <command> - int get_irc_color (t_weechat_plugin *plugin, - char *nom_couleur) - </command> - </para> - <para> - Renvoie le num�ro d'une couleur IRC avec son nom. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>nom_couleur</option> : nom de la couleur - Les couleure autoris�es sont : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Nom couleur</entry> - <entry>Valeur</entry> - </row> - </thead> - <tbody> - <row> - <entry>white</entry> - <entry>0</entry> - </row> - <row> - <entry>black</entry> - <entry>1</entry> - </row> - <row> - <entry>blue</entry> - <entry>2</entry> - </row> - <row> - <entry>green</entry> - <entry>3</entry> - </row> - <row> - <entry>lightred</entry> - <entry>4</entry> - </row> - <row> - <entry>red</entry> - <entry>5</entry> - </row> - <row> - <entry>magenta</entry> - <entry>6</entry> - </row> - <row> - <entry>brown</entry> - <entry>7</entry> - </row> - <row> - <entry>yellow</entry> - <entry>8</entry> - </row> - <row> - <entry>lightgreen</entry> - <entry>9</entry> - </row> - <row> - <entry>cyan</entry> - <entry>10</entry> - </row> - <row> - <entry>lightcyan</entry> - <entry>11</entry> - </row> - <row> - <entry>lightblue</entry> - <entry>12</entry> - </row> - <row> - <entry>lightmagenta</entry> - <entry>13</entry> - </row> - <row> - <entry>gray</entry> - <entry>14</entry> - </row> - <row> - <entry>lightgray</entry> - <entry>15</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : num�ro de la couleur IRC, -1 si la couleur - n'est pas trouv�e. - </para> - <para> - Exemple : -<screen> -int color_blue = plugin->get_irc_color (plugin, "blue"); /* retourne 2 */ -</screen> - </para> - </section> - - <section id="secAPI_input_color"> - <title>input_color</title> - - <para> - Prototype : - <command> - void input_color (t_weechat_plugin *plugin, - int couleur, int debut, int longueur) - </command> - </para> - <para> - Ajoute de la couleur dans la zone de saisie. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>couleur</option> : couleur pour le texte (si < 0, - alors la zone de saisie est rafraichie, et il n'y a aucun - changement dans son contenu) - </para> - </listitem> - <listitem> - <para> - <option>debut</option> : position de d�but pour la coloration - (si < 0, alors le masque est r�initialis�) - </para> - </listitem> - <listitem> - <para> - <option>longueur</option> : longueur pour la coloration - (si <= 0, alors le masque est r�initialis�) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : -<screen> -plugin->input_color (plugin, plugin->get_irc_color (plugin, "blue"), 10, 5); -</screen> - </para> - </section> - - <section id="secAPI_get_window_info"> - <title>get_window_info</title> - - <para> - Prototype : - <command> - t_plugin_window_info *get_window_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Retourne la liste des fen�tres WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : liste cha�n�e des fen�tres WeeChat. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>win_x</literal></entry> - <entry>position horizontale de la fen�tre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_y</literal></entry> - <entry>position verticale de la fen�tre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width</literal></entry> - <entry>largeur de la fen�tre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height</literal></entry> - <entry>hauteur de la fen�tre</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_width_pct</literal></entry> - <entry>largeur en % (compar� � la fen�tre parent)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>win_height_pct</literal></entry> - <entry>hauteur en % (compar� � la fen�tre parent)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_buffer</literal></entry> - <entry>num�ro du tampon affich�</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>prev_window</literal></entry> - <entry>pointeur vers les infos de la fen�tre pr�c�dente</entry> - </row> - <row> - <entry>t_plugin_window_info *</entry> - <entry><literal>next_window</literal></entry> - <entry>pointeur vers les infos de la fen�tre suivante</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_window_info" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_window_info *window_info, *ptr_window; - -window_info = plugin->get_window_info (plugin); -if (window_info) -{ - for (ptr_window = window_info; ptr_window; ptr_window = ptr_window->next_window) - { - plugin->print (plugin, NULL, NULL, "--- info fen�tre ---"); - plugin->print (plugin, NULL, NULL, "(%d,%d), size: %dx%d, %%size: %d%%x%d%%", - ptr_window->win_x, ptr_window->win_y, - ptr_window->win_width, ptr_window->win_height, - ptr_window->win_width_pct, ptr_window->win_height_pct); - plugin->print (plugin, NULL, NULL, "num_buffer: %d", ptr_window->num_buffer); - } - plugin->free_window_info (plugin, window_info); -} -else - plugin->print (plugin, NULL, NULL, "pas d'info fen�tre !"); -</screen> - </para> - </section> - - <section id="secAPI_free_window_info"> - <title>free_window_info</title> - - <para> - Prototype : - <command> - void free_window_info (t_weechat_plugin *plugin, - t_plugin_window_info *window_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de fen�tres. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>window_info</option> : pointeur vers la liste des - infos fen�tres retourn�e par la fonction "get_window_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_window_info (plugin, window_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Prototype : - <command> - t_plugin_buffer_info *get_buffer_info (t_weechat_plugin *plugin) - </command> - </para> - <para> - Retourne la liste des tampons WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : liste cha�n�e des tampons WeeChat. - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry><literal>type</literal></entry> - <entry> - type de tampon: 0=standard, 1=DCC, - 2=donn�es IRC brutes - </entry> - </row> - <row> - <entry>int</entry> - <entry><literal>number</literal></entry> - <entry>num�ro de tampon</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>num_displayed</literal></entry> - <entry>nombre de fen�tres affichant ce tampon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>server_name</literal></entry> - <entry>nom du serveur pour le tampon (peut �tre NULL)</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>channel_name</literal></entry> - <entry>nom du canal pout le tampon (peut �tre NULL)</entry> - </row> - <row> - <entry>int</entry> - <entry><literal>notify_level</literal></entry> - <entry>niveau de notification du tampon</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>log_filename</literal></entry> - <entry> - nom du fichier de log (NULL signifie qu'il n'y a - pas de log) - </entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>prev_buffer</literal></entry> - <entry>pointeur vers les infos du tampon pr�c�dent</entry> - </row> - <row> - <entry>t_plugin_buffer_info *</entry> - <entry><literal>next_buffer</literal></entry> - <entry>pointeur vers les infos du tampon suivant</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_buffer_info" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_buffer_info *buffer_info, *ptr_buffer; - -buffer_info = plugin->get_buffer_info (plugin); -if (buffer_info) -{ - for (ptr_buffer = buffer_info; ptr_buffer; ptr_buffer = ptr_buffer->next_buffer) - { - plugin->print (plugin, NULL, NULL, "--- info tampon ---"); - plugin->print (plugin, NULL, NULL, "type: %d", ptr_buffer->type); - plugin->print (plugin, NULL, NULL, "number: %d", ptr_buffer->number); - plugin->print (plugin, NULL, NULL, "num_displayed: %d", ptr_buffer->num_displayed); - plugin->print (plugin, NULL, NULL, "server: %s", ptr_buffer->server_name); - plugin->print (plugin, NULL, NULL, "channel: %s", ptr_buffer->channel_name); - plugin->print (plugin, NULL, NULL, "notify level: %d", ptr_buffer->notify_level); - plugin->print (plugin, NULL, NULL, "log filename: %s", ptr_buffer->log_filename); - } - plugin->free_buffer_info (plugin, buffer_info); -} -else - plugin->print (plugin, NULL, NULL, "pas d'info tampon !"); -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_info"> - <title>free_buffer_info</title> - - <para> - Prototype: - <command> - void free_buffer_info (t_weechat_plugin *plugin, - t_plugin_buffer_info *buffer_info) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par une liste de tampons. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>buffer_info</option> : pointeur vers la liste des - infos tampons retourn�e par la fonction "get_buffer_info" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_buffer_info (plugin, buffer_info);</screen> - </para> - </section> - - <section id="secAPI_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Prototype: - <command> - t_plugin_buffer_data *get_buffer_info (t_weechat_plugin *plugin, - char *serveur, char *canal) - </command> - </para> - <para> - Renvoie le contenu du tampon. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : contenu du tampon (liste cha�n�e de lignes). - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Champ</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>time_t</entry> - <entry><literal>date</literal></entry> - <entry>date et heure</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>nick</literal></entry> - <entry>pseudo</entry> - </row> - <row> - <entry>char *</entry> - <entry><literal>data</literal></entry> - <entry> - contenu de la ligne (les codes couleur sont - retir�s) - </entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>prev_line</literal></entry> - <entry>pointeur vers la ligne pr�c�dente</entry> - </row> - <row> - <entry>t_plugin_buffer_line *</entry> - <entry><literal>next_line</literal></entry> - <entry>pointeur vers la ligne suivante</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> - Note : le r�sultat doit �tre lib�r� par un appel � la fonction - "free_buffer_data" apr�s utilisation. - </para> - <para> - Exemple : -<screen> -t_plugin_buffer_line *buffer_line, *ptr_line; -char text_time[256]; - -buffer_line = plugin->get_buffer_data (plugin); -if (buffer_line) -{ - for (ptr_line = buffer_line; ptr_line; ptr_line = ptr_line->next_line) - { - strftime (text_time, sizeof (text_time), "%x %X", localtime (&(ptr_line->date))); - plugin->print (plugin, NULL, NULL, "date: %s, pseudo: %s, donn�es: %s", - text_time, ptr_line->nick, ptr_line->data); - } - plugin->free_buffer_data (plugin, buffer_line); -} -</screen> - </para> - </section> - - <section id="secAPI_free_buffer_data"> - <title>free_buffer_data</title> - - <para> - Prototype: - <command> - void free_buffer_data (t_weechat_plugin *plugin, - t_plugin_buffer_line *buffer_line) - </command> - </para> - <para> - Lib�re la m�moire utilis�e par les lignes d'un tampon. - </para> - <para> - Arguments: - <itemizedlist> - <listitem> - <para> - <option>plugin</option> : pointeur vers la structure - de l'extension - </para> - </listitem> - <listitem> - <para> - <option>buffer_line</option> : pointeur vers la liste des - lignes du tampon retourn�e par la fonction "get_buffer_data" - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemple : - <screen>plugin->free_buffer_data (plugin, buffer_line);</screen> - </para> - </section> - - </section> - - <section id="secCompilerExtension"> - <title>Compiler l'extension</title> - - <para> - La compilation ne n�cessite pas les sources WeeChat, mais seulement - le fichier "<literal>weechat-plugin.h</literal>". - </para> - - <para> - Pour compiler une extension compos�e d'un fichier "toto.c" (sous - GNU/Linux) : -<screen> -<prompt>$ </prompt><userinput>gcc -fPIC -Wall -c toto.c</userinput> -<prompt>$ </prompt><userinput>gcc -shared -fPIC -o libtoto.so toto.o</userinput> -</screen> - </para> - - </section> - - <section id="secChargerExtension"> - <title>Charger l'extension dans WeeChat</title> - - <para> - Copier le fichier "libtoto.so" dans le r�pertoire syst�me des - extensions (par exemple - "<literal>/usr/local/lib/weechat/plugins)</literal>" ou bien dans - celui de l'utilisateur (par exemple - "<literal>/home/xxxxx/.weechat/plugins</literal>"). - </para> - - <para> - Sous WeeChat : - <screen><userinput>/plugin load toto</userinput></screen> - </para> - - </section> - - <section id="secExempleExtension"> - <title>Exemple d'extension</title> - - <para> - Un exemple complet d'extension, qui ajoute une commande /double - affichant deux fois les param�tres pass�s sur le canal courant - (d'accord ce n'est pas tr�s utile mais ceci est un exemple !) : -<screen> -#include <stdlib.h> - -#include "weechat-plugin.h" - -char plugin_name[] = "Double"; -char plugin_version[] = "0.1"; -char plugin_description[] = "Plugin de test pour WeeChat"; - -/* gestionnaire de commande "/double" */ - -int double_cmd (t_weechat_plugin *plugin, int argc, char **argv, - char *handler_args, void *handler_pointer) -{ - if (argv[2] && (argv[2][0] != '/')) - { - plugin->exec_command (plugin, NULL, NULL, argv[2]); - plugin->exec_command (plugin, NULL, NULL, argv[2]); - } - return PLUGIN_RC_OK; -} - -int weechat_plugin_init (t_weechat_plugin *plugin) -{ - plugin->cmd_handler_add (plugin, "double", - "Affiche deux fois un message", - "msg", - "msg: message a afficher deux fois", - NULL, - &double_cmd, - NULL, NULL); - return PLUGIN_RC_OK; -} - -void weechat_plugin_end (t_weechat_plugin *plugin) -{ - /* on ne fait rien ici */ -} -</screen> - </para> - - </section> - - </section> - - <section id="secCharset"> - <title>Extension Charset</title> - - <para> - L'extension Charset vous permet d'encoder et d�coder les donn�es en - utilisant un jeu de caract�res, avec 3 niveaux : global, par serveur, - ou par canal. - Cette extension est facultative, mais recommand�e : si elle n'est pas - charg�e, WeeChat pourra uniquement lire/�crire des donn�es UTF-8. - </para> - - <para> - L'extension Charset devrait �tre automatiquement charg�e par WeeChat - au d�marrage. - Pour s'assurer que l'extension est bien charg�e, essayez : - "<literal>/charset</literal>". - Si la commande n'est pas trouv�e, alors chargez l'extension avec la - commande : - <screen>/plugin load charset</screen> - Si l'extension n'est pas trouv�e, alors vous devriez recompiler - WeeChat avec les extensions et le support de Charset. - </para> - - <para> - Lorsque l'extension Charset d�marre, elle affiche le jeu de caract�res - du terminal et l'interne. - Le jeu de caract�res du terminal d�pend de votre locale, et l'interne - est UTF-8. - Par exemple : -<screen> --P- Charset plugin starting, terminal charset: ISO-8859-15 (WeeChat internal: UTF-8) -</screen> - </para> - - <section id="secCharsetSettings"> - <title>Configuration</title> - - <itemizedlist> - <listitem> - <para> - Pour modifier les jeux de caract�res de d�codage et d'encodage - globaux, utilisez la commande "<literal>/setp</literal>". - Par exemple : -<screen> -/setp charset.global.decode = ISO-8859-15 -/setp charset.global.encode = ISO-8859-15 -</screen> - Si le jeu de caract�res de d�codage global n'est pas renseign� - (par exemple pendant le premier chargement de Charset), il sera - renseign� automatiquement avec le jeu de caract�res du terminal - (s'il est diff�rent de UTF-8) ou par d�faut � - "<literal>ISO-8859-1</literal>". - La valeur d'encodage par d�faut est vide, donc WeeChat envoie par - d�faut avec le jeu de caract�res interne (UTF-8). - </para> - </listitem> - <listitem> - <para> - Pour modifier le jeu de caract�res d'un serveur, utilisez la - commande "<literal>/charset</literal>" sur le tampon serveur. - Si vous donnez seulement le jeu de caract�res, alors vous - modifiez en m�me temps les valeurs de d�codage et d'encodage. - Par exemple : - <screen>/charset ISO-8859-15</screen> - Ce qui est �quivalent � : -<screen> -/charset decode ISO-8859-15 -/charset encode ISO-8859-15 -</screen> - </para> - </listitem> - <listitem> - <para> - Pour modifier le jeu de caract�res d'un canal (ou d'une - conversation priv�e), utilisez la m�me commande que pour le - serveur, mais sur le tampon du canal (ou du priv�). - </para> - </listitem> - </itemizedlist> - - </section> - - <section id="secCharsetFAQ"> - <title>FAQ</title> - - <para> - Si vous avez des probl�mes avec certains caract�res ou les accents en - utilisant l'extension Charset : - <itemizedlist> - <listitem> - <para> - v�rifiez que weechat-curses est li� avec libncursesw - (attention : n�cessaire sur beaucoup de distributions, mais pas - toutes) : - <screen>ldd /chemin/vers/weechat-curses</screen> - </para> - </listitem> - <listitem> - <para> - v�rifiez la ligne charset (sur le tampon serveur), vous devriez - voir ISO-XXXXXX ou UTF-8 pour le charset du terminal. Si vous - voyez ANSI_X3.4-1968 ou d'autres valeurs, votre locale est - probablement erron�e. - </para> - </listitem> - <listitem> - <para> - affectez la valeur pour le d�codage global, par exemple : - <screen>/setp charset.global.decode = ISO-8859-15</screen> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </section> - - <section id="secExtensionsScripts"> - <title>Extensions pour scripts</title> - - <para> - Quatre extensions sont fournies en standard avec WeeChat pour utiliser - des langages de script : Perl, Python, Ruby et Lua. - </para> - - <section id="secChargerDechargerScripts"> - <title>Charger / d�charger des scripts</title> - - <para> - Les scripts sont charg�s et d�charg�s avec les commandes - <command>/perl</command>, <command>/python</command>, - <command>/ruby</command> et <command>/lua</command> - (tapez <command>/help</command> dans WeeChat pour obtenir - de l'aide sur les commandes). - </para> - - <para> - Exemples : - <itemizedlist> - <listitem> - <para> - Charger un script Perl : - <command><userinput>/perl load /tmp/essai.pl</userinput></command> - </para> - </listitem> - <listitem> - <para> - Lister les scripts Perl charg�s : - <command><userinput>/perl</userinput></command> - </para> - </listitem> - <listitem> - <para> - Charger un script Python : - <command><userinput>/python load /tmp/essai.py</userinput></command> - </para> - </listitem> - <listitem> - <para> - Lister les scripts Python charg�s : - <command><userinput>/python</userinput></command> - </para> - </listitem> - <listitem> - <para> - Charger un script Ruby : - <command><userinput>/ruby load /tmp/essai.rb</userinput></command> - </para> - </listitem> - <listitem> - <para> - Lister les scripts Ruby charg�s : - <command><userinput>/ruby</userinput></command> - </para> - </listitem> - <listitem> - <para> - Charger un script Lua : - <command><userinput>/lua load /tmp/essai.lua</userinput></command> - </para> - </listitem> - <listitem> - <para> - Lister les scripts Lua charg�s : - <command><userinput>/lua</userinput></command> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSyntaxeParLangage"> - <title>Syntaxe par langage</title> - - <section id="secScriptPerl"> - <title>Perl</title> - - <para> - Dans un script Perl WeeChat, toutes les fonctions et variables - de l'interface sont pr�fix�es par "<literal>weechat::</literal>". - Exemple : -<screen>weechat::register("test", "1.0", "end_test", "Script perl WeeChat");</screen> - </para> - - </section> - - <section id="secScriptPython"> - <title>Python</title> - - <para> - Un script Python WeeChat doit commencer par importer weechat : - <screen>import weechat</screen> - </para> - - <para> - Toutes les fonctions et variables de l'interface sont pr�fix�es - par "<literal>weechat.</literal>". - Exemple : -<screen>weechat.register("test", "1.0", "end_test", "Script python WeeChat")</screen> - </para> - - </section> - - <section id="secScriptRuby"> - <title>Ruby</title> - - <para> - Dans un script Ruby WeeChat, tout le code doit �tre dans des - fonctions. Pour le code principal, vous devez d�finir une - fonction "<literal>weechat_init</literal>", qui est appel�e - automatiquement quand le script est charg� par WeeChat. - Exemple : -<screen> -def weechat_init - Weechat.register("test", "1.0", "end_test", "Script ruby WeeChat") - Weechat.add_command_handler("commande", "ma_commande") - return Weechat::PLUGIN_RC_OK -end - -def ma_commande(server, args) - Weechat.print("ma commande") - return Weechat::PLUGIN_RC_OK -end -</screen> - </para> - - <para> - Toutes les fonctions de l'interface sont pr�fix�es par - "<literal>Weechat.</literal>" et les variables par - "<literal>Weechat::</literal>". - </para> - - </section> - - <section id="secScriptLua"> - <title>Lua</title> - - <para> - Dans un script Lua WeeChat, toutes les fonctions de l'interface - sont pr�fix�es par "<literal>weechat.</literal>". - Les variables sont pr�fix�es par "<literal>weechat.</literal>" et - suffix�es par "<literal>()</literal>". - Exemple : -<screen> -function message_handler(server, args) - weechat.print("Je suis un message handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - - </section> - - </section> - - <section id="secInterfaceWeeChatScripts"> - <title>Interface WeeChat / scripts</title> - - <section id="sec_script_register"> - <title>register</title> - - <para> - Prototype Perl : - <command> - weechat::register(nom, version, fonction_de_fin, description, [charset]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.register(nom, version, fonction_de_fin, description, [charset]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.register(nom, version, fonction_de_fin, description, [charset]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.register(nom, version, fonction_de_fin, description, [charset]) - </command> - </para> - <para> - C'est la premi�re fonction � appeler dans le script. - Tout script pour WeeChat doit appeler cette fonction. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>nom</option> : nom unique pour identifier le script - (chaque script doit avoir un nom diff�rent) - </para> - </listitem> - <listitem> - <para> - <option>version</option> : version du script - </para> - </listitem> - <listitem> - <para> - <option>fonction_de_fin</option> : fonction appel�e quand - le script est d�charg� (param�tre facultatif, une cha�ne - vide signifiant qu'il n'y a pas de fonction � appeler) - </para> - </listitem> - <listitem> - <para> - <option>description</option> : br�ve description du script - </para> - </listitem> - <listitem> - <para> - <option>charset</option> : jeu de caract�res du script, � - pr�ciser si le script n'est pas �crit en UTF-8 - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si le script a �t� enregistr�, 0 si une erreur - s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::register("essai", "1.0", "fin_essai", "Script d'essai !", "ISO-8859-1"); - -# python -weechat.register("essai", "1.0", "fin_essai", "Script d'essai !", "ISO-8859-1") - -# ruby -Weechat.register("essai", "1.0", "fin_essai", "Script d'essai !", "ISO-8859-1") - --- lua -weechat.register("essai", "1.0", "fin_essai", "Script d'essai !", "ISO-8859-1") -</screen> - </para> - </section> - - <section id="sec_script_set_charset"> - <title>set_charset</title> - - <para> - Prototype Perl : - <command> - weechat::set_charset(charset); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.set_charsetr(charset) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.set_charset(charset) - </command> - </para> - <para> - Change le jeu de caract�res du script. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>charset</option> : nouveau jeu de caract�res - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si le nouveau jeu de caract�res a �t� - mis en place, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::set_charset("ISO-8859-1"); - -# python -weechat.set_charset("ISO-8859-1") - -# ruby -Weechat.set_charset("ISO-8859-1") - --- lua -weechat.set_charset("ISO-8859-1") -</screen> - </para> - </section> - - <section id="secScript_print"> - <title>print</title> - - <para> - Prototype Perl : - <command> - weechat::print(message, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Python : - <command> - weechat.prnt(message, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.print(message, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.print(message, [canal, [serveur]]) - </command> - </para> - <para> - Affiche un message sur un tampon WeeChat, identifi� par le - serveur et le canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>message</option> : message � afficher - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - tampon dans lequel afficher - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le tampon dans lequel afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, voir - <xref linkend="secAPI_print" />. - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::print("message"); -weechat::print("message", "#weechat"); -weechat::print("message", "#weechat", "freenode"); -weechat::print("test: \x0305 rouge \x0F normal"); - -# python -weechat.prnt("message") -weechat.prnt("message", "#weechat") -weechat.prnt("message", "#weechat", "freenode") - -# ruby -Weechat.print("message") -Weechat.print("message", "#weechat") -Weechat.print("message", "#weechat", "freenode") - --- lua -weechat.print("message") -weechat.print("message", "#weechat") -weechat.print("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <section id="secScript_print_server"> - <title>print_server</title> - - <para> - Prototype Perl : - <command> - weechat::print_server(message) - </command> - </para> - <para> - Prototype Python : - <command> - weechat.print_server(message) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.print_server(message) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.print_server(message) - </command> - </para> - <para> - Affiche un message sur le tampon serveur. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>message</option> : message � afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Pour afficher du texte en couleur, voir - <xref linkend="secAPI_print" />. - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::print_server("message"); -weechat::print_server("test: \x0305 rouge \x0F normal"); - -# python -weechat.print_server("message") - -# ruby -Weechat.print_server("message") - --- lua -weechat.print_server("message") -</screen> - </para> - </section> - - <section id="secScript_print_infobar"> - <title>print_infobar</title> - - <para> - Prototype Perl : - <command> - weechat::print_infobar(temps, message); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.print_infobar(temps, message) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.print_infobar(temps, message) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.print_infobar(temps, message) - </command> - </para> - <para> - Affiche un message sur la barre d'infos pour un temps d�termin�. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>temps</option> : temps (en secondes) pendant - lequel le message est affich� (0 = jamais effac�) - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message � afficher - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::print_infobar(5, "message"); - -# python -weechat.print_infobar(5, "message") - -# ruby -Weechat.print_infobar(5, "message") - --- lua -weechat.print_infobar(5, "message") -</screen> - </para> - </section> - - <section id="secScript_remove_infobar"> - <title>remove_infobar</title> - - <para> - Prototype Perl : - <command> - weechat::remove_infobar([nombre]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_infobar([nombre]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_infobar([nombre]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_infobar([nombre]) - </command> - </para> - <para> - Efface un ou plusieurs messages dans la pile de la barre d'infos. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>nombre</option> : nombre de messages � supprimer - (si param�tre non pr�sent ou <= 0, alors tous les messages - sont effac�s) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_infobar(1); - -# python -weechat.remove_infobar(1) - -# ruby -Weechat.remove_infobar(1) - --- lua -weechat.remove_infobar(1) -</screen> - </para> - </section> - - <section id="secScript_log"> - <title>log</title> - - <para> - Prototype Perl : - <command> - weechat::log(message, [canal, [serveur]]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.log(message, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.log(message, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.log(message, [canal, [serveur]]) - </command> - </para> - <para> - Ecrit un message dans le fichier de log pour un serveur ou un - canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>message</option> : message - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal pour trouver le - log du tampon - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur pour - trouver le log du tampon - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::log("message", "#weechat", "freenode"); - -# python -weechat.log("message", "#weechat", "freenode") - -# ruby -Weechat.log("message", "#weechat", "freenode") - --- lua -weechat.log("message", "#weechat", "freenode") -</screen> - </para> - </section> - - <section id="secScript_add_message_handler"> - <title>add_message_handler</title> - - <para> - Prototype Perl : - <command> - weechat::add_message_handler(message, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_message_handler(message, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_message_handler(message, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_message_handler(message, fonction) - </command> - </para> - <para> - Ajoute un gestionnaire de messages IRC, appel� d�s qu'un message - IRC est re�u. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appel�e. - Pour conna�tre la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - De plus, vous pouvez utiliser un nom sp�cial, pr�fix� par - "weechat_" pour capturer des �v�nements sp�ciaux - (voir <xref linkend="secAPI_msg_handler_add" />). - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e lorsque le message - est re�u - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_message_handler("privmsg", "ma_fonction"); -sub ma_fonction -{ - weechat::print("serveur=$_[0]"); - ($null, $canal, $message) = split ":",$_[1],3; - ($masque, $null, $canal) = split " ", $canal; - weechat::print("masque=$masque, canal=$canal, msg=$message"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_message_handler("privmsg", "ma_fonction") -def ma_fonction(serveur, args): - weechat.prnt("serveur="+serveur) - null, canal, message = string.split(args, ":", 2) - masque, null, canal = string.split(string.strip(canal), " ", 2) - weechat.prnt("masque="+masque+", canal="+canal+", message="+message) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_message_handler("privmsg", "ma_fonction") -def ma_fonction(server, args) - Weechat.print("serveur=#{server}, args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_message_handler("privmsg", "ma_fonction") -function ma_fonction(server, args) - weechat.print("serveur=" .. server .. ", args=" .. args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note : la fonction appel�e lorsque le message est re�u doit - renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_WEECHAT</literal> : le message - ne sera pas transmis � WeeChat - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_PLUGINS</literal> : le message - ne sera pas transmis � d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_IGNORE_ALL</literal> : le message - ne sera ni transmis � WeeChat ni � d'autres extensions - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK_WITH_HIGHLIGHT</literal> : la fonction - a r�ussi et provoque un "highlight" sur le message re�u - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_command_handler"> - <title>add_command_handler</title> - - <para> - Prototype Perl : - <command> - weechat::add_command_handler(commande, fonction, - [description, arguments, arguments_description, - modele_completion]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_command_handler(commande, fonction, - [description, arguments, arguments_description, - modele_completion]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_command_handler(commande, fonction, - [description, arguments, arguments_description, - modele_completion]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_command_handler(commande, fonction, - [description, arguments, arguments_description, - modele_completion]) - </command> - </para> - <para> - Ajoute un gestionnaire de commande WeeChat, appel� d�s que - l'utilisateur utilise la commande (par exemple /commande). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>commande</option> : nom de la nouvelle commande, - qui peut �tre une commande d�j� existante (attention la - commande remplac�e ne sera plus disponible jusqu'� ce que - le script soit d�charg�) - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e lorsque la - commande est ex�cut�e - </para> - </listitem> - <listitem> - <para> - <option>arguments</option> : br�ve description des - param�tres de la commande (affich�e par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>arguments_description</option> : longue description - des param�tres de la commande (affich�e par /help commande) - </para> - </listitem> - <listitem> - <para> - <option>modele_completion</option> : mod�le pour la - compl�tion sous la forme "<literal>abc|%w def|%i</literal>" - qui signifie "abc" ou une commande WeeChat pour le premier - param�tre, et "def" ou une commande IRC pour le deuxi�me. - (voir <xref linkend="secAPI_cmd_handler_add" />) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_command_handler("commande", "ma_commande"); -sub ma_commande -{ - weechat::print("serveur=$_[0], args=$_[1]"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_command_handler("commande", "ma_commande") -def ma_commande(serveur, args): - weechat.prnt("serveur="+serveur+", args="+args) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_command_handler("commande", "ma_commande") -def ma_commande(server, args) - Weechat.print("serveur=#{server} args=#{args}") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_command_handler("commande", "ma_commande") -def my_command(server, args) - weechat.print("serveur="..server..", args="..args) - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Notes : la fonction appel�e lorsque la commande est ex�cut�e - doit renvoyer une des valeurs suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_timer_handler"> - <title>add_timer_handler</title> - - <para> - Prototype Perl : - <command> - weechat::add_timer_handler(intervalle, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_timer_handler(intervalle, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_timer_handler(intervalle, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_timer_handler(intervalle, fonction) - </command> - </para> - <para> - Ajoute un gestionnaire de temps, qui appelle p�riodiquement une - fonction. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>intervalle</option> : intervalle (en secondes) - entre deux appels de la fonction. - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_timer_handler(60, "mon_timer"); -sub mon_timer -{ - weechat::print("ceci est le timer handler"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_timer_handler(60, "mon_timer") -def mon_timer(): - weechat.prnt("ceci est le timer handler") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_timer_handler(60, "mon_timer") -def mon_timer() - Weechat.print("ceci est le timer handler") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_timer_handler(60, "mon_timer") -function mon_timer() - weechat.print("ceci est le timer handler") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_keyboard_handler"> - <title>add_keyboard_handler</title> - - <para> - Prototype Perl : - <command> - weechat::add_keyboard_handler(fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_keyboard_handler(fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_keyboard_handler(fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_keyboard_handler(fonction) - </command> - </para> - <para> - Ajoute un gestionnaire de clavier, appel� d�s qu'une touche est - press�e. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_keyboard_handler("mon_clavier"); -sub mon_clavier -{ - my $key = shift; - my $input_before = shift; - my $input_after = shift; - weechat::print("gestionnaire clavier: key = '$key', " - ."entr�e avant = '$input_before' " - ."apr�s = '$input_after'"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_keyboard_handler("mon_clavier") -def mon_clavier(key, input_before, input_after): - weechat.prnt("gestionnaire clavier: touche = '%s', " \ - "entr�e avant = '%s' apr�s = '%s'" - %(key, input_before, input_after)) - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_keyboard_handler("mon_clavier") -def mon_clavier(key, input_before, input_after) - Weechat.print("gestionnaire clavier: touche = '#{key}', " \ - "entr�e avant = '#{input_before}' " \ - "apr�s = '#{input_after}'") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_keyboard_handler("mon_clavier") -function mon_clavier(key, input_before, input_after) - weechat.print("gestionnaire clavier: touche = '"..key.. - "', entr�e avant = '"..input_before.. - "' apr�s = '"..input_after.."'") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_add_event_handler"> - <title>add_event_handler</title> - - <para> - Prototype Perl : - <command> - weechat::add_event_handler(�v�nement, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_event_handler(�v�nement, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_event_handler(�v�nement, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_event_handler(�v�nement, fonction) - </command> - </para> - <para> - Ajoute un gestionnaire d'�v�nement, appel� d�s qu'un �v�nement se - produit. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>�v�nement</option> : �v�nement - (voir <xref linkend="secAPI_event_handler_add" />) - </para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_event_handler("buffer_open", "mon_evenement"); -sub mon_evenement -{ - weechat::print("buffer open"); - return weechat::PLUGIN_RC_OK; -} - -# python -weechat.add_event_handler("buffer_open", "mon_evenement") -def mon_evenement(): - weechat.prnt("buffer open") - return weechat.PLUGIN_RC_OK - -# ruby -Weechat.add_event_handler("buffer_open", "mon_evenement") -def mon_evenement() - Weechat.print("buffer open") - return Weechat::PLUGIN_RC_OK -end - --- lua -weechat.add_event_handler("buffer_open", "mon_evenement") -function mon_evenement() - weechat.print("buffer open") - return weechat.PLUGIN_RC_OK() -end -</screen> - </para> - <para> - Note : la fonction appel�e doit renvoyer une des valeurs - suivantes : - <itemizedlist> - <listitem> - <para> - <literal>PLUGIN_RC_KO</literal> : la fonction a �chou� - </para> - </listitem> - <listitem> - <para> - <literal>PLUGIN_RC_OK</literal> : la fonction a r�ussi - </para> - </listitem> - </itemizedlist> - </para> - </section> - - <section id="secScript_remove_handler"> - <title>remove_handler</title> - - <para> - Prototype Perl : - <command> - weechat::remove_handler(nom, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_handler(nom, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_handler(nom, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_handler(nom, fonction) - </command> - </para> - <para> - Supprime un gestionnaire de message ou de commande. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>nom</option> : nom du message IRC ou de la commande - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction associ�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_handler("commande", "ma_commande"); - -# python -weechat.remove_handler("commande", "ma_commande") - -# ruby -Weechat.remove_handler("commande", "ma_commande") - --- lua -weechat.remove_handler("commande", "ma_commande") -</screen> - </para> - </section> - - <section id="secScript_remove_timer_handler"> - <title>remove_timer_handler</title> - - <para> - Prototype Perl : - <command> - weechat::remove_timer_handler(fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_timer_handler(fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_timer_handler(fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_timer_handler(fonction) - </command> - </para> - <para> - Supprime un gestionnaire de temps. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>fonction</option> : fonction - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_timer_handler("mon_timer"); - -# python -weechat.remove_timer_handler("mon_timer") - -# ruby -Weechat.remove_timer_handler("mon_timer") - --- lua -weechat.remove_timer_handler("mon_timer") -</screen> - </para> - </section> - - <section id="secScript_remove_keyboard_handler"> - <title>remove_keyboard_handler</title> - - <para> - Prototype Perl : - <command> - weechat::remove_keyboard_handler(fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_keyboard_handler(fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_keyboard_handler(fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_keyboard_handler(fonction) - </command> - </para> - <para> - Supprime un gestionnaire de clavier. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>fonction</option> : fonction - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_keyboard_handler("mon_clavier"); - -# python -weechat.remove_keyboard_handler("mon_clavier") - -# ruby -Weechat.remove_keyboard_handler("mon_clavier") - --- lua -weechat.remove_keyboard_handler("mon_clavier") -</screen> - </para> - </section> - - <section id="secScript_remove_event_handler"> - <title>remove_event_handler</title> - - <para> - Prototype Perl : - <command> - weechat::remove_event_handler(fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_event_handler(fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_event_handler(fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_event_handler(fonction) - </command> - </para> - <para> - Supprime un gestionnaire d'�v�nement. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>fonction</option> : fonction - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_event_handler("mon_evenement"); - -# python -weechat.remove_event_handler("mon_evenement") - -# ruby -Weechat.remove_event_handler("mon_evenement") - --- lua -weechat.remove_event_handler("mon_evenement") -</screen> - </para> - </section> - - <section id="secScript_add_modifier"> - <title>add_modifier</title> - - <para> - Prototype Perl : - <command> - weechat::add_modifier(type, message, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.add_modifier(type, message, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.add_modifier(type, message, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.add_modifier(type, message, fonction) - </command> - </para> - <para> - Ajoute un modifieur de messages. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>type</option> : type de modifieur : - <informaltable colsep="0" frame="none"> - <tgroup cols="2"> - <thead> - <row> - <entry>Type</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><literal>irc_in</literal></entry> - <entry>appel� pour chaque message IRC re�u</entry> - </row> - <row> - <entry><literal>irc_user</literal></entry> - <entry> - appel� pour chaque message (ou commande) envoy� par - l'utilisateur (avant traitement et affichage par - WeeChat) - </entry> - </row> - <row> - <entry><literal>irc_out</literal></entry> - <entry> - appel� pour chaque message sortant juste avant - envoi au serveur IRC (y compris pour les messages - envoy�s automatiquement et de mani�re transparente - par WeeChat) - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </listitem> - <listitem> - <para> - <option>message</option> : nom du message IRC pour lequel la - fonction est appel�e (utilis� uniquement pour les types - "irc_in" et "irc_out"). - Pour conna�tre la liste des messages IRC disponibles, merci - de consulter les <acronym>RFC</acronym>s - <ulink url="http://www.ietf.org/rfc/rfc1459.txt">1459</ulink> et - <ulink url="http://www.ietf.org/rfc/rfc2812.txt">2812</ulink>. - La valeur sp�ciale "*" signifie tous les messages (pas de filtre). - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction appel�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::add_modifier("irc_in", "privmsg", "mod_in"); -weechat::add_modifier("irc_out", "privmsg", "mod_out"); -sub mod_in -{ - return "$_[1] [modifier IN]"; -} -sub mod_out -{ - return "$_[1] [modifier OUT]"; -} - -# python -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(serveur, args): - return args + " [modifier IN]" -def mod_out(serveur, args): - return args + " [modifier OUT]" - -# ruby -Weechat.add_modifier("irc_in", "privmsg", "mod_in") -Weechat.add_modifier("irc_out", "privmsg", "mod_out") -def mod_in(server, args) - return args + " [modifier IN]" -end -def mod_out(server, args) - return args + " [modifier OUT]" -end - --- lua -weechat.add_modifier("irc_in", "privmsg", "mod_in") -weechat.add_modifier("irc_out", "privmsg", "mod_out") -function mod_in(server, args) - return args .. " [modifier IN]" -end -function mod_out(server, args) - return args .. " [modifier OUT]" -end -</screen> - </para> - </section> - - <section id="secScript_remove_modifier"> - <title>remove_modifier</title> - - <para> - Prototype Perl : - <command> - weechat::remove_modifier(type, message, fonction); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.remove_handler(type, message, fonction) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.remove_handler(type, message, fonction) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.remove_handler(type, message, fonction) - </command> - </para> - <para> - Supprime un modifieur de messages. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>type</option> : type de modifieur - </para> - </listitem> - <listitem> - <para> - <option>message</option> : message trait� par le modifieur - </para> - </listitem> - <listitem> - <para> - <option>fonction</option> : fonction associ�e - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::remove_modifier("irc_in", "privmsg", "mod_in"); - -# python -weechat.remove_modifier("irc_in", "privmsg", "mod_in") - -# ruby -Weechat.remove_modifier("irc_in", "privmsg", "mod_in") - --- lua -weechat.remove_modifier("irc_in", "privmsg", "mod_in") -</screen> - </para> - </section> - - <section id="secScript_command"> - <title>command</title> - - <para> - Prototype Perl : - <command> - weechat::command(commande, [canal, [serveur]]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.command(commande, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.command(commande, [canal, [serveur]]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.command(commande, [canal, [serveur]]) - </command> - </para> - <para> - Ex�cute une commande ou envoie un message � un canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>commande</option> : la commande � ex�cuter - </para> - </listitem> - <listitem> - <para> - <option>canal</option> : nom du canal o� ex�cuter la - commande - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur o� - ex�cuter la commande - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::command("bonjour tout le monde !"); -weechat::command("/kick toto merci de quitter ce canal", "#weechat"); -weechat::command("/nick newnick", "", "freenode"); - -# python -weechat.command("bonjour tout le monde !") -weechat.command("/kick toto merci de quitter ce canal", "#weechat") -weechat.command("/nick newnick", "", "freenode") - -# ruby -Weechat.command("bonjour tout le monde !") -Weechat.command("/kick toto merci de quitter ce canal", "#weechat") -Weechat.command("/nick newnick", "", "freenode") - --- lua -weechat.command("bonjour tout le monde !") -weechat.command("/kick toto merci de quitter ce canal", "#weechat") -weechat.command("/nick newnick", "", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_info"> - <title>get_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_info(nom, [serveur]); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_info(nom, [serveur]) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_info(nom, [serveur]) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_info(nom, [serveur]) - </command> - </para> - <para> - Renvoie une information sur WeeChat ou un canal. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>nom</option> : nom de l'info � obtenir - (voir <xref linkend="secAPI_get_info" />) - </para> - </listitem> - <listitem> - <para> - <option>serveur</option> : nom interne du serveur o� - r�cup�rer l'information (si n�cessaire) - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : l'information demand�e, cha�ne vide si une - erreur s'est produite ou que l'information n'a pas �t� trouv�e. - </para> - <para> - Exemples : -<screen> -# perl -$version = get_info("version"); -$nick = get_info("nick", "freenode"); - -# python -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") - -# ruby -version = Weechat.get_info("version") -nick = Weechat.get_info("nick", "freenode") - --- lua -version = weechat.get_info("version") -nick = weechat.get_info("nick", "freenode") -</screen> - </para> - </section> - - <section id="secScript_get_dcc_info"> - <title>get_dcc_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_dcc_info(); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_dcc_info() - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_dcc_info() - </command> - </para> - <para> - Renvoie la liste des DCC en cours ou termin�s. - </para> - <para> - Valeur renvoy�e : la liste des DCC - (voir <xref linkend="secAPI_get_dcc_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my @dccs = weechat::get_dcc_info(); -if (@dccs) -{ - foreach my $dcc (@dccs) - { - while (my ($key, $value) = each %$dcc) - { - weechat::print("$key = '$value'"); - } - } -} -else -{ - weechat::print("pas de DCC"); -} - -# python -dccs = weechat.get_dcc_info() -if dccs != None: - if dccs == []: - weechat.prnt("pas de DCC") - else: - for d in dccs: - for b in d.keys(): - weechat.prnt("%s = '%s'" %(b, d[b])) -else: - weechat.prnt("erreur de lecture des DCC") - -# ruby -dccs = Weechat.get_dcc_info() -if dccs != nil - if dccs == [] - Weechat.print("pas de DCC") - else - dccs.each do |m| - m.each do |key, value| - Weechat.print("#{key} = '#{value}'") - end - end - end -else - Weechat.print("erreur de lecture des DCC") -end - --- lua -dccs = weechat.get_dcc_info() -if dccs ~= nil then - if dccs then - dcc, dccinfos = next (dccs, nil) - while (dcc) do - key, value = next (dccinfos, nil) - while (key) do - weechat.print(key.." = '"..value.."'") - key, value = next (dccinfos, key) - end - dcc, dccinfos = next (dccs, dcc) - end - else - weechat.print("pas de DCC") - end -else - weechat.print("erreur de lecture des DCC") -end -</screen> - </para> - </section> - - <section id="secScript_get_server_info"> - <title>get_server_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_server_info(); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_server_info() - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_server_info() - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_server_info() - </command> - </para> - <para> - Renvoie la liste des serveurs IRC (connect�s ou non). - </para> - <para> - Valeur renvoy�e : la liste des serveurs IRC (connect�s ou non) - (voir <xref linkend="secAPI_get_server_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my $servers = weechat::get_server_info(); -if ($servers) -{ - while (my ($srvname, $srvinfos) = each %$servers) - { - while (my ($key, $value) = each %$srvinfos) - { - weechat::print("$srvname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("pas de serveur"); -} - -# python -servers = weechat.get_server_info() -if servers != None: - if servers == {}: - weechat.prnt("pas de serveur") - else: - for s in servers: - for i in servers[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(servers[s][i]))) -else: - weechat.prnt("erreur de lecture des serveurs") - -# ruby -servers = Weechat.get_server_info() -if servers != nil - if servers == [] - Weechat.print("pas de serveur") - else - servers.each do |n, s| - s.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("erreur de lecture des serveurs") -end - --- lua -servers = weechat.get_server_info() -if servers ~= nil then - if servers then - srv, srvinfos = next (servers, nil) - while (srv) do - key, value = next (srvinfos, nil) - while (key) do - weechat.print(srv.." -> "..key.." = '"..value.."'") - key, value = next (srvinfos, key) - end - srv, srvinfos = next (servers, srv) - end - else - weechat.print("pas de serveur") - end -else - weechat.print("erreur de lecture des serveurs") -end -</screen> - </para> - </section> - - <section id="secScript_get_channel_info"> - <title>get_channel_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_channel_info(serveur); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_channel_info(serveur) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_channel_info(serveur) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_channel_info(serveur) - </command> - </para> - <para> - Renvoie la liste des canaux IRC pour un serveur. - </para> - <para> - Valeur renvoy�e : la liste des canaux IRC du serveur - (voir <xref linkend="secAPI_get_channel_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my $channels = weechat::get_channel_info(weechat::get_info("server")); -if ($channels) -{ - while (my ($channame, $chaninfos) = each %$channels) - { - while (my ($key, $value) = each %$chaninfos) - { - weechat::print("$channame -> $key = '$value'"); - } - } -} -else -{ - weechat::print("pas de canal"); -} - -# python -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans != None: - if chans == {}: - weechat.prnt("pas de canal") - else: - for s in chans: - for i in chans[s]: - weechat.prnt("%s -> %s = '%s'" % (s, i, str(chans[s][i]))) -else: - weechat.prnt("erreur de lecture des canaux") - -# ruby -channels = Weechat.get_channel_info(Weechat.get_info("server")) -if channels != nil - if channels == {} - Weechat.print("pas de canal") - else - channels.each do |n, c| - c.each do |key, value| - Weechat.print("#{n} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("erreur de lecture des canaux") -end - --- lua -chans = weechat.get_channel_info(weechat.get_info("server")) -if chans ~= nil then - if chans then - chan, chaninfos = next (chans, nil) - while (chan) do - key, value = next (chaninfos, nil) - while (key) do - weechat.print(chan.." -> "..key.." = '"..value.."'") - key, value = next (chaninfos, key) - end - chan, chaninfos = next (chans, chan) - end - else - weechat.print("pas de canal") - end -else - weechat.print("erreur de lecture des canaux") -end -</screen> - </para> - </section> - - <section id="secScript_get_nick_info"> - <title>get_nick_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_nick_info(serveur, canal); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_nick_info(serveur, canal) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_nick_info(serveur, canal) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_nick_info(serveur, canal) - </command> - </para> - <para> - Renvoie la liste des pseudos pour un canal. - </para> - <para> - Valeur renvoy�e : la liste des pseudos pr�sents sur le canal - (voir <xref linkend="secAPI_get_nick_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my $nicks = weechat::get_nick_info("freenode", "#weechat"); -if ($nicks) -{ - while (my ($nickname, $nickinfos) = each %$nicks) - { - while ( my ($key, $value) = each %$nickinfos) - { - weechat::print("$nickname -> $key = '$value'"); - } - } -} -else -{ - weechat::print("pas de pseudo"); -} - -# python -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks != None: - if nicks == {}: - weechat.prnt("pas de pseudo") - else: - for n in nicks: - for f in nicks[n]: - weechat.prnt("%s -> %s = '%s'" % (n, f, str(nicks[n][f]))) -else: - weechat.prnt("erreur de lecture des pseudos") - -# ruby -nicks = Weechat.get_nick_info("freenode", "#weechat") -if nicks != nil - if nicks == {} - Weechat.print("pas de pseudo") - else - nicks.each do |nk, nattr| - nattr.each do |key, value| - Weechat.print("#{nk} -> #{key} = '#{value}'") - end - end - end -else - Weechat.print("erreur de lecture des pseudos") -end - --- lua -nicks = weechat.get_nick_info("freenode", "#weechat") -if nicks ~= nil then - if nicks then - nick, nickinfos = next (nicks, nil) - while (nick) do - key, value = next (nickinfos, nil) - while (key) do - weechat.print(nick.." -> "..key.." = '"..value.."'") - key, value = next (nickinfos, key) - end - nick, nickinfos = next (nicks, nick) - end - else - weechat.print("pas de pseudo") - end -else - weechat.print("erreur de lecture des pseudos") -end -</screen> - </para> - </section> - - <section id="secScript_get_config"> - <title>get_config</title> - - <para> - Prototype Perl : - <command> - weechat::get_config(option); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_config(option) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_config(option) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_config(option) - </command> - </para> - <para> - Renvoie la valeur d'une option de configuration WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>option</option> : nom de l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la valeur de l'option, cha�ne vide si l'option - n'a pas �t� trouv�e. - </para> - <para> - Exemples : -<screen> -# perl -$valeur1 = weechat::get_config("look_nicklist"); -$valeur2 = weechat::get_config("freenode.server_autojoin"); - -# python -valeur1 = weechat.get_config("look_nicklist") -valeur2 = weechat.get_config("freenode.server_autojoin") - -# ruby -valeur1 = Weechat.get_config("look_nicklist") -valeur2 = Weechat.get_config("freenode.server_autojoin") - --- lua -valeur1 = weechat.get_config("look_nicklist") -valeur2 = weechat.get_config("freenode.server_autojoin") -</screen> - </para> - </section> - - <section id="secScript_set_config"> - <title>set_config</title> - - <para> - Prototype Perl : - <command> - weechat::set_config(option, valeur); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.set_config(option, valeur) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.set_config(option, valeur) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.set_config(option, valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de configuration WeeChat. - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>option</option> : nom de l'option - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : la nouvelle valeur pour - l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est - produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::set_config("look_nicklist", "off"); -weechat::set_config("freenode.server_autojoin", "#weechat"); - -# python -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") - -# ruby -Weechat.set_config("look_nicklist", "off") -Weechat.set_config("freenode.server_autojoin", "#weechat") - --- lua -weechat.set_config("look_nicklist", "off") -weechat.set_config("freenode.server_autojoin", "#weechat") -</screen> - </para> - </section> - - <section id="secScript_get_plugin_config"> - <title>get_plugin_config</title> - - <para> - Prototype Perl : - <command> - weechat::get_plugin_config(option); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_plugin_config(option) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_plugin_config(option) - </command> - </para> - <para> - Renvoie la valeur d'une option de l'extension. - L'option est lue depuis le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : - "<literal>extension.script.option=valeur</literal>" - (NB : le nom de l'extension et du script sont ajout�s - automatiquement). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>option</option> : nom de l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : la valeur de l'option, cha�ne vide si l'option - n'a pas �t� trouv�e. - </para> - <para> - Exemples : -<screen> -# perl -$valeur = weechat::get_plugin_config("ma_variable"); - -# python -valeur = weechat.get_plugin_config("ma_variable") - -# ruby -valeur = Weechat.get_plugin_config("ma_variable") - --- lua -valeur = weechat.get_plugin_config("ma_variable") -</screen> - </para> - </section> - - <section id="secScript_set_plugin_config"> - <title>set_plugin_config</title> - - <para> - Prototype Perl : - <command> - weechat::set_plugin_config(option, valeur); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.set_plugin_config(option, valeur) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.set_plugin_config(option, valeur) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.set_plugin_config(option, valeur) - </command> - </para> - <para> - Modifie la valeur d'une option de l'extension. - L'option est �crite dans le fichier - "<literal>~/.weechat/plugins.rc</literal>" et est - sous cette forme : - "<literal>extension.script.option=valeur</literal>" - (NB : le nom de l'extension et du script sont rajout�s - automatiquement). - </para> - <para> - Param�tres : - <itemizedlist> - <listitem> - <para> - <option>option</option> : nom de l'option - </para> - </listitem> - <listitem> - <para> - <option>valeur</option> : la nouvelle valeur pour - l'option - </para> - </listitem> - </itemizedlist> - </para> - <para> - Valeur renvoy�e : 1 si succ�s, 0 si une erreur s'est - produite. - </para> - <para> - Exemples : -<screen> -# perl -weechat::set_plugin_config("ma_variable", "valeur"); - -# python -weechat.set_plugin_config("ma_variable", "valeur") - -# ruby -Weechat.set_plugin_config("ma_variable", "valeur") - --- lua -weechat.set_plugin_config("ma_variable", "valeur") -</screen> - </para> - </section> - - <section id="secScript_get_irc_color"> - <title>get_irc_color</title> - - <para> - Prototype Perl : - <command> - weechat::get_irc_color(color); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_irc_color(color) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_irc_color(color) - </command> - </para> - <para> - Renvoie le num�ro d'une couleur IRC avec son nom. - </para> - <para> - Valeur renvoy�e : num�ro de la couleur IRC, -1 si la couleur - n'est pas trouv�e (voir <xref linkend="secAPI_get_irc_color" />). - </para> - <para> - Exemples : -<screen> -# perl -my $color_blue = weechat::get_irc_color("blue"); - -# python -color_blue = weechat.get_irc_color("blue") - -# ruby -color_blue = Weechat.get_irc_color("blue") - --- lua -color_blue = weechat.get_irc_color("blue") -</screen> - </para> - </section> - - <section id="secScript_input_color"> - <title>input_color</title> - - <para> - Prototype Perl : - <command> - weechat::input_color(color); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.input_color(color) - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.input_color(color) - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.input_color(color) - </command> - </para> - <para> - Ajoute de la couleur dans la zone de saisie. - </para> - <para> - Valeur renvoy�e : aucune. - </para> - <para> - Exemples : -<screen> -# perl -weechat::input_color(weechat::get_irc_color("blue"), 10, 5); - -# python -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) - -# ruby -Weechat.input_color(Weechat.get_irc_color("blue"), 10, 5) - --- lua -weechat.input_color(weechat.get_irc_color("blue"), 10, 5) -</screen> - </para> - </section> - - <section id="secScript_get_window_info"> - <title>get_window_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_window_info(); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_window_info() - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_window_info() - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_window_info() - </command> - </para> - <para> - Renvoie la liste des fen�tres WeeChat. - </para> - <para> - Valeur renvoy�e : liste des fen�tres WeeChat - (voir <xref linkend="secAPI_get_window_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my @wf = weechat::get_window_info(); -if (@wf) -{ - weechat::print("**** infos fen�tres ****"); - foreach my $w (@wf) - { - while ( my ($key, $value) = each %$w) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** pas d'info fen�tre ****"); -} - -# python -wf = weechat.get_window_info() -if wf != None and wf != []: - weechat.prnt ("**** infos fen�tres ****") - for w in wf: - for i in w: - weechat.prnt (" > %s => %s" % (i, w[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** pas d'info sur les fen�tres ****") - -# ruby -wf = Weechat.get_window_info() -if wf != nil and wf != [] - Weechat.print("**** infos fen�tres ****") - wf.each do |w| - w.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** pas d'info sur les fen�tres ****") -end - --- lua -wf = weechat.get_window_info() -if wf then - weechat.print ("**** infos fen�tres ****") - w, winfos = next (wf, nil) - while (w) do - key, value = next (winfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (winfos, key) - end - weechat.print ("----------------------") - w, winfos = next (wf, w) - end -else - weechat.print("**** pas d'info sur les fen�tres ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_info"> - <title>get_buffer_info</title> - - <para> - Prototype Perl : - <command> - weechat::get_buffer_info(); - </command> - </para> - <para> - Prototype Python : - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Prototype Ruby : - <command> - Weechat.get_buffer_info() - </command> - </para> - <para> - Prototype Lua : - <command> - weechat.get_buffer_info() - </command> - </para> - <para> - Renvoie la liste des tampons WeeChat. - </para> - <para> - Valeur renvoy�e : liste des tampons WeeChat - (voir <xref linkend="secAPI_get_buffer_info" />). - </para> - <para> - Exemples : -<screen> -# perl -my $bf = weechat::get_buffer_info(); -if ($bf) -{ - while ( my ($nobuf, $binfos) = each %$bf) - { - while ( my ($key, $value) = each %$binfos) - { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** pas d'info sur les tampons ****"); -} - -# python -bf = weechat.get_buffer_info() -if bf != None and bf != {}: - for b in bf: - weechat.prnt ("**** info pour tampon buffer no %d ****" % b) - for c in bf[b]: - weechat.prnt (" > %s => %s" % (c, bf[b][c])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** pas d'info sur les tampons ****") - -# ruby -bf = Weechat.get_buffer_info() -if bf != nil and bf != {} - bf.each do |n, c| - Weechat.print("**** info pour tampon no #{n} ****") - c.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** pas d'info sur les tampons ****") -end - --- lua -bf = weechat.get_buffer_info() -if bf then - b, binfos = next (bf, nil) - while (b) do - weechat.print("**** info pour tampon no " .. b .. " ****") - key, value = next (binfos, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (binfos, key) - end - weechat.print ("----------------------") - b, infos = next (bf, b) - end -else - weechat.print("**** pas d'info sur les tampons ****") -end -</screen> - </para> - </section> - - <section id="secScript_get_buffer_data"> - <title>get_buffer_data</title> - - <para> - Perl prototype: - <command> - weechat::get_buffer_data(server, channel); - </command> - </para> - <para> - Python prototype: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Ruby prototype: - <command> - Weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Lua prototype: - <command> - weechat.get_buffer_data(server, channel) - </command> - </para> - <para> - Return content of buffer. - </para> - <para> - Return value: list of lines for buffer - (see <xref linkend="secAPI_get_buffer_data" />). - </para> - <para> - Examples: -<screen> -# perl -my $server = weechat::get_info("server"); -my $channel = weechat::get_info("channel"); -my @bc = weechat::get_buffer_data($server, $channel); -if (@bc) -{ - weechat::print("**** buffer data for '$channel'\@'$server' ****"); - foreach my $l (@bc) { - while ( my ($key, $value) = each %$l) { - weechat::print(" > $key => $value"); - } - weechat::print("----------------------"); - } -} -else -{ - weechat::print("**** no buffer data ****"); -} - -# python -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc != None and bc != []: - weechat.prnt ("**** buffer data for '%s'@'%s' ****" % (channel, server)) - for l in bc: - for i in l: - weechat.prnt (" > %s => %s" % (i, l[i])) - weechat.prnt ("----------------------") -else: - weechat.prnt ("**** no buffer data ****") - -# ruby -server = Weechat.get_info("server") -channel = Weechat.get_info("channel") -bc = Weechat.get_buffer_data(server, channel) -if bc != nil and bc != [] - Weechat.print("**** buffer data for '#{channel}'@'#{server}' ****") - bc.each do |l| - l.each do |key, value| - Weechat.print(" > #{key} => #{value}") - end - Weechat.print("----------------------") - end -else - Weechat.print("**** no buffer data ****") -end - --- lua -server = weechat.get_info("server") -channel = weechat.get_info("channel") -bc = weechat.get_buffer_data(server, channel) -if bc then - b, bdatas = next (bc, nil) - weechat.print("**** buffer data for '" .. channel .. "'@'" .. server .. "' ****") - while (b) do - key, value = next (bdatas, nil) - while (key) do - weechat.print(" > " .. key .. " => " .. value) - key, value = next (bdatas, key) - end - weechat.print ("----------------------") - b, bdatas = next (bc, b) - end -else - weechat.print("**** no buffer data ****") -end -</screen> - </para> - </section> - - </section> - - </section> - - </chapter> - - <!-- ======================== Auteurs / Support ========================= --> - - <chapter id="chapAuteursSupport"> - <title>Auteurs / Support</title> - - <para> - Ce chapitre liste les auteurs et contributeurs pour WeeChat, et - indique les moyens d'obtenir du support. - </para> - - <section id="secAuteurs"> - <title>Auteurs</title> - - <para> - WeeChat est d�velopp� par : - <itemizedlist> - <listitem> - <para> - <emphasis>FlashCode (S�bastien Helleu)</emphasis> - <email>flashcode AT flashtux.org</email> - - d�veloppeur principal - </para> - </listitem> - <listitem> - <para> - <emphasis>kolter (Emmanuel Bouthenot)</emphasis> - <email>kolter AT openics.org</email> - - d�veloppeur - </para> - </listitem> - <listitem> - <para> - <emphasis>Ptitlouis</emphasis> - <email>ptitlouis AT sysif.net</email> - - empaqueteur Debian - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secContributeurs"> - <title>Contributeurs</title> - - <para> - Les personnes suivantes ont contribu� � WeeChat : - <itemizedlist> - <listitem> - <para> - <emphasis>Jiri Golembiovsky</emphasis> - - traduction en tch�que, patchs - </para> - </listitem> - <listitem> - <para> - <emphasis>Rudolf Polzer</emphasis> - - patchs - </para> - </listitem> - <listitem> - <para> - <emphasis>Jim Ramsay</emphasis> - - patchs - </para> - </listitem> - <listitem> - <para> - <emphasis>Odin</emphasis> - - RPM pour SuSE - </para> - </listitem> - <listitem> - <para> - <emphasis>Pistos</emphasis> - - patchs - </para> - </listitem> - <listitem> - <para> - <emphasis>Gwenn</emphasis> - - patchs - </para> - </listitem> - <listitem> - <para> - <emphasis>voroskoi</emphasis> - - traduction en hongrois - </para> - </listitem> - <listitem> - <para> - <emphasis>Frank Zacharias</emphasis> - - traduction en allemand - </para> - </listitem> - <listitem> - <para> - <emphasis>Pavel Shevchuk</emphasis> - - traduction en russe - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - <section id="secSupport"> - <title>Obtenir du support</title> - - <para> - Avant de faire appel au support, merci de lire la documentation et - la FAQ de WeeChat (la documentation est le document que vous �tes - en train de lire, si vous n'avez pas tout lu jusqu'ici, il est encore - temps de recommencer !) - </para> - - <para> - <itemizedlist> - <listitem> - <para> - IRC : serveur "<literal>irc.freenode.net</literal>", - canal "<literal>#weechat</literal>" - </para> - </listitem> - <listitem> - <para> - Forum WeeChat : - <ulink url="http://forums.flashtux.org"> - http://forums.flashtux.org - </ulink> - </para> - </listitem> - <listitem> - <para> - Liste de diffusion : - <itemizedlist> - <listitem> - <para> - Pour souscrire : - <ulink url="http://mail.nongnu.org/mailman/listinfo/weechat-support"> - http://mail.nongnu.org/mailman/listinfo/weechat-support - </ulink> - </para> - </listitem> - <listitem> - <para> - Pour envoyer un mail � la liste de diffusion : - <email>weechat-support@nongnu.org</email> - </para> - </listitem> - </itemizedlist> - Les archives de la liste de diffusion sont ici : - <ulink url="http://mail.nongnu.org/archive/html/weechat-support"> - http://mail.nongnu.org/archive/html/weechat-support - </ulink> - </para> - </listitem> - </itemizedlist> - </para> - - </section> - - </chapter> - -</book> diff --git a/weechat/doc/fr/weechat_commands.xml b/weechat/doc/fr/weechat_commands.xml deleted file mode 100644 index 148fc44c2..000000000 --- a/weechat/doc/fr/weechat_commands.xml +++ /dev/null @@ -1,277 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> - -<!-- ********* WARNING! ********* - - This file is automatically built with a Perl script. DO NOT EDIT! ---> - -<command>alias [nom_alias [commande [param�tres]]]</command> -<programlisting> -cr�er un alias pour une commande - - nom_alias: nom de l'alias - commande: nom de la commande (commande WeeChat ou IRC, plusieurs commandes peuvent �tre s�par�es par des point-virgules) -param�tres: param�tres pour la commande - -</programlisting> -<command>est remplac� par tous les param�tres.</command> -<programlisting>Les variables $nick, $channel et $server sont remplac�es par le pseudo/canal/serveur courant. - -</programlisting> -<command>buffer [action [args] | nombre | [[serveur] [canal]]]</command> -<programlisting> -gestion des tampons - - action: action � effectuer: - move: d�place le tampon dans la liste (peut �tre relatif, par exemple -1) - close: ferme le tampon (le param�tre optionnel est le message de fin, pour un canal) - list: liste les tampons ouverts (pas de param�tre affiche cette liste) - notify: fixe le niveau de notification (0=jamais, 1=highlight, 2=1+msg, 3=2+join/part) - (quand ex�cut� sur un tampon serveur, cela fixe le niveau de notification par d�faut pour le serveur entier) - scroll: fait d�filer l'historique (peut �tre relatif, et peut se terminer par une lettre: s=sec, m=min, h=heure, d=jour, M=mois, y=ann�e); s'il y a seulement une lettre, alors fait d�filer jusqu'au d�but de cet �l�ment - - nombre: saute au tampon qui a ce num�ro -serveur, - canal: saute au tampon par serveur et/ou nom de canal - -Exemples : - d�placer tampon: /buffer move 5 - fermer tampon: /buffer close c'est le message de d�part - niveau de notif.: /buffer notify 2 - d�filer 1 jour haut: /buffer scroll 1d == /buffer scroll -1d == /buffer scroll -24h - d�filer au d�but - de ce jour: /buffer scroll d - d�filer 15 min bas: /buffer scroll +15m -d�filer 20 msgs haut: /buffer scroll -20 - aller sur #weechat: /buffer #weechat - -</programlisting> -<command>builtin commande</command> -<programlisting> -lance une commande WeeChat/IRC interne (sans regarder les gestionnaires de commandes et les alias) - -commande: commande � ex�cuter (un '/' est automatiquement ajout� s'il n'est pas trouv� au d�but de la commande) - - -</programlisting> -<command>clear [-all | num�ro [num�ro ...]]</command> -<programlisting> -effacer la/les fen�tre(s) - - -all: effacer tous les tampons -num�ro: effacer un tampon par son num�ro - -</programlisting> -<command>connect [-all [-nojoin] | nom_serveur [nom_serveur ...] [-nojoin] | nom/IP [-port port] [-ipv6] [-ssl]]</command> -<programlisting> -se connecter � un/plusieurs serveur(s) - - -all: se reconnecter � tous les serveurs -nom_serveur: nom du serveur pour se connecter - -nojoin: ne rejoindre aucun canal (m�me si l'autojoin est activ� pour le serveur) - nom/IP: nom/IP pour se connecter, en cr�ant un serveur temporaire - port: port pour le serveur (nombre entier, 6667 par d�faut) - ipv6: utiliser le protocole IPv6 - ssl: utiliser le protocole SSL - -</programlisting> -<command>disconnect [-all | nom_serveur [nom_serveur...]]</command> -<programlisting> -se d�connecter d'un/plusieurs serveur(s) - - -all: se d�connecter de tous les serveurs -nom_serveur: nom du serveur pour se d�connecter - -</programlisting> -<command>dcc action [pseudo [fichier]]</command> -<programlisting> -d�marre le DCC (fichier ou discussion) ou ferme une discussion - - action: 'send' (envoi de fichier) ou 'chat' (discussion) ou 'close' (fermeture discussion) - pseudo: pseudo pour envoyer le fichier ou discuter -fichier: nom du fichier (sur la machine locale) - -</programlisting> -<command>debug dump | windows</command> -<programlisting> -affiche des messages de debogage - - dump: affiche les variables m�moire WeeChat dans le fichier log (les m�mes messages sont affich�s lorsque WeeChat plante) -windows: affiche l'arbre des fen�tres - -</programlisting> -<command>help [commande]</command> -<programlisting> -afficher l'aide sur les commandes - -commande: nom d'une commande WeeChat ou IRC - -</programlisting> -<command>history [clear | valeur]</command> -<programlisting> -affiche l'historique des commandes du tampon - -clear: effacer l'historique -valeur: nombre d'entr�es dans l'historique � afficher - -</programlisting> -<command>ignore [masque [[type | commande] [canal [serveur]]]]</command> -<programlisting> -ignorer des messages IRC et/ou des h�tes - - masque: pseudo ou h�te � ignorer - type: type de message � ignorer (action, ctcp, dcc, pv) -commande: commande IRC - canal: nom du canal pour le ignore - serveur: nom du serveur pour le ignore - -Pour chaque param�tre, '*' signifie tou(te)s. -Sans param�tres, la commande /ignore liste les ignore d�finis. - -</programlisting> -<command>key [touche [fonction/commande]] [unbind touche] [functions] [call fonction ["params"]] [reset -yes]</command> -<programlisting> -associer/lib�rer des touches - - touche: voir ou associer cette touche � une fonction interne ou une commande (commen�ant par "/") - unbind: supprimer l'association � une touche -functions: lister la liste des fonctions internes pour les associations de touches - call: appeler une foonction par son nom (avec param�tres optionnels) - reset: restaure les touches aux valeurs par d�faut et supprime TOUTES les touches personnelles (utiliser avec pr�caution !) - -</programlisting> -<command>plugin [list [nom]] | [listfull [nom]] | [load fichier] | [autoload] | [reload [nom]] | [unload [nom]]</command> -<programlisting> -liste/charge/d�charge des extensions - - list: lister les extensions charg�es -listfull: lister les extensions charg�es avec de l'info d�taill�e pour chaque extension - load: charger une extension -autoload: charger automatiquement les extensions dans un r�pertoire syst�me ou utilisateur - reload: recharger une extension (si pas de nom donn�, d�charger toutes les extensions, puis puis recharger automatiquement les extensions) - unload: d�charger une ou plusieurs exteneions - -Sans param�tre, la commande /plugin liste les extensions charg�es. - -</programlisting> -<command>reconnect [-all [-nojoin] | nom_serveur [nom_serveur...] [-nojoin]]</command> -<programlisting> -se reconnecter � un/plusieurs serveur(s) - - -all: se reconnecter � tous les serveurs -nom_serveur: nom du serveur pour se reconnecter - -nojoin: ne rejoindre aucun canal (m�me si l'autojoin est activ� pour le serveur) - -</programlisting> -<command>save [fichier]</command> -<programlisting> -sauvegarder la configuration sur disque - -fichier: fichier pour sauvegarder la configuration - -</programlisting> -<command>server [list [nom_serveur]] | [listfull [nom_serveur]] | [nom_serveur] | [add nom_serveur nom/IP [-port port] [-temp] [-auto | -noauto] [-ipv6] [-ssl] [-pwd mot_de_passe] [-nicks pseudo1 pseudo2 pseudo3] [-username nom_utilisateur] [-realname nom_r�el] [-command commande] [-autojoin canal[,canal]] ] | [copy nom_serveur nouveau_nom_serveur] | [rename nom_serveur nouveau_nom_serveur] | [keep nom_serveur] | [del nom_serveur]</command> -<programlisting> -liste, ajoute ou retire des serveurs - - list: afficher les serveurs (pas de param�tre implique cette liste) - listfull: afficher les serveurs avec de l'info d�taill�e pour chaque - add: cr�er un nouveau serveur - nom_serveur: nom du serveur, pour usage interne et affichage - nom/IP: nom ou adresse IP du serveur - port: port pour le serveur (nombre entier, 6667 par d�faut) - temp: cr�er un serveur temporaire (non sauv� dans le fichier de configuration) - auto: se connecter automatiquement au serveur quand WeeChat d�marre - noauto: ne pas se connecter au serveur quand WeeChat d�marre (par d�faut) - ipv6: utiliser le protocole IPv6 - ssl: utiliser le protocole SSL - mot_de_passe: mot de passe pour le serveur - pseudo1: premier pseudo pour le serveur - pseudo2: pseudo alternatif pour le serveur - pseudo3: second pseudo alternatif pour le serveur -nom_utilisateur: nom d'utilisateur - nom_r�el: nom r�el de l'utilisateur - copy: dupliquer un serveur - rename: renommer un serveur - keep: garder le serveur dans le fichier de configuration (pour les serveurs temporaires seulement) - del: supprimer un serveur - -</programlisting> -<command>set [option [ = valeur]]</command> -<programlisting> -modifier des options de configuration - -option: nom de l'option (si le nom est complet et qu'aucune valeur n'est donn�e, alors l'aide sur l'option est affich�e) -valeur: valeur pour l'option - -L'option peut �tre: nomserveur.server_xxx o� "nomserveur" est le nom interne d'un serveur et "xxx" une option pour ce serveur. - -</programlisting> -<command>setp [option [ = valeur]]</command> -<programlisting> -modifier des options de configuration des extensions - -option: nom d'une option d'extension -valeur: valeur pour l'option - -L'option est au format: extension.option, par exemple: perl.monscript.variable1 - -</programlisting> -<command>unalias nom_alias</command> -<programlisting> -supprimer un alias - -nom_alias: nom de l'alias � supprimer - -</programlisting> -<command>unignore [nombre | [masque [[type | commande] [canal [serveur]]]]]</command> -<programlisting> -supprimer le ignore des messages IRC et/ou des h�tes - - nombre: num�ro de ignore � supprimer (le nombre est affich� sur la liste des ignore) - masque: pseudo ou h�te � ignorer - type: type de message � ignorer (action, ctcp, dcc, pv) -commande: commande IRC - canal: nom du canal pour le ignore - serveur: nom du serveur pour le ignore - -Pour chaque param�tre, '*' signifie tou(te)s. -Sans param�tre, /ignore liste les ignore d�finis. - -</programlisting> -<command>upgrade [chemin_vers_binaire]</command> -<programlisting> -mettre � jour WeeChat sans se d�connecter des serveurs - -chemin_vers_binaire: chemin vers le binaire WeeChat (par d�faut le binaire courant) - -Cette commande lance � nouveau un binaire WeeChat, il doit donc avoir �t� compil� ou install� via un gestionnaire de paquet avant de lancer cette commande. - -</programlisting> -<command>uptime [-o]</command> -<programlisting> -montrer l'uptime de WeeChat - --o: envoyer l'uptime sur le canal courant en tant que message IRC - -</programlisting> -<command>window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [ptc] | resize pct | merge [all]]</command> -<programlisting> -gestion des fen�tres - - list: liste les fen�tres ouvertes (pas de param�tre affiche cette liste) - -1: saute � la fen�tre pr�c�dente - +1: saute � la fen�tre suivante - b#: saute � la fen�tre affichant le tampon # - up: saute � la fen�tre au dessus - down: saute � la fen�tre au dessous - left: saute � la fen�tre � gauche - right: saute � la fen�tre � droite -splith: �clate la fen�tre en deux horizontalement -splitv: �clate la fen�tre en deux verticalement -resize: redimensionne une fen�tre, la nouvelle taille est <pct> pourcentage de la fen�tre parent - merge: fusionne la fen�tre avec une autre - -Pour splith et splitv, pct est un pourcentage qui repr�sente la taille de la nouvelle fen�tre, calcul�e par rapport � la taille de la fen�tre courante. Par exemple 25 signifie cr�er une fen�tre qui a pour taille: taille_courante / 4 - -</programlisting> diff --git a/weechat/doc/fr/weechat_quickstart.fr.txt b/weechat/doc/fr/weechat_quickstart.fr.txt deleted file mode 100644 index 74c184579..000000000 --- a/weechat/doc/fr/weechat_quickstart.fr.txt +++ /dev/null @@ -1,110 +0,0 @@ -Guide de d�marrage rapide WeeChat (version fran�aise) -================================= - -1. D�marrer weechat - - Selon l'interface choisie, vous devez lancer : - - weechat-curses pour l'interface Curses - - weechat-gtk pour l'interface Gtk (en d�veloppement) - - weechat-qt pour l'interface Qt (non d�velopp�e) - - weechat-wxwidgets pour l'interface WxWidgets (non d�velopp�e) - -2. Aide en ligne / options - - WeeChat dispose d'aide pour toutes les commandes, tapez simplement /help - Pour avoir de l'aide sur une commande, tapez /help commande - - Pour modifier des options, utilisez /set option = valeur - Vous pouvez utiliser /set avec un nom partiel d'option (affiche alors - les options contenant ces lettres), ou avec un nom complet d'option - sans valeur (pour voir l'aide compl�te de l'option). - - Note importante: les options sont sauv�es lorsque WeeChat quitte (ou avec - la commande "/save"). N'�ditez PAS le fichier de configuration pendant que - WeeChat tourne, car WeeChat peut �crire ce fichier � tout moment, et il - n'est pas possible de le recharger. - Pour changer toute option, utilisez la commande "/set", WeeChat prend en - compte imm�diatement les nouvelles valeurs. - -3. Cr�er un serveur - - Par exemple irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (/help server pour l'aide compl�te sur la commande) - -4. D�finir les options du serveur - - Pseudos : - /set quakenet.server_nick1 = "mynick" - /set quakenet.server_nick2 = "mynick2" - /set quakenet.server_nick3 = "mynick3" - - Nom d'utilisateur/r�el : - /set quakenet.server_username = "Mon nom d'utilisateur" - /set quakenet.server_realname = "Mon nom r�el" - - Connexion auto au serveur : - /set quakenet.server_autoconnect = on - - Rejoindre automatiquement des canaux : - /set quakenet.server_autojoin = "#canal1,#canal2" - - Autres options : - Vous pouvez voir les options du serveur et les valeurs avec /set quakenet - Pour modifier une option, utilisez /set quakenet.server_option = valeur - -5. Se connecter au serveur et rejoindre les canaux - - /connect quakenet - -6. Rejoindre/quitter les canaux - - Joindre un canal : - /join #channel - Quitter un canal : - /part [message de fin] - Quitter un canal et fermer le tampon : - /close [message de fin] - (/close est un alias sur /buffer close) - -7. G�rer les tampons/fen�tres - - Vous pouvez g�rer les tampons avec la commande "/buffer" et les fen�tres - avec la commande "/window". - Par exemple, pour d�couper verticalement l'�cran en une petite fen�tre - (1/3 de la largeur) et une large (2/3 de la largeur), utilisez la commande - /window splitv 33 - -8. G�rer les raccourcis clavier - - Selon votre clavier et vos besoins, vous pouvez associer n'importe quelle - touche � une commande avec la commande "/key". - Une touche utile est meta-k (alt-k) pour trouver le code des touches. - - Par exemple, pour associer meta-y (alt-y) � la commande "/buffer close" : - /key (pressez meta-k) (pressez meta-y) /buffer close - Vous aurez une ligne de commande qui ressemble � ceci : - /key meta-y /buffer close - -9. Extensions/scripts - - Sur certaines distributions comme Debian, les extensions sont disponibles - via un paquet s�par� (par exemple weechat-plugins). - Les extensions sont automatiquement charg�es lorsqu'elles sont trouv�es. - Plusieurs extensions/scripts sont disponibles pour WeeChat, voir ici : - http://weechat.flashtux.org/plugins.php - Merci de regarder la documentation WeeChat pour charger/d�charger des - extensions ou des scripts. - -10. Plus de documentation - - Vous pouvez maintenant utiliser WeeChat et lire la FAQ/documentation pour - toute autre question : - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Bon WeeChat ! - --- -(c) 2006-05-31, �crit par FlashCode <flashcode@flashtux.org> -Ce document fait partie de WeeChat et est distribu� sous license GPL. diff --git a/weechat/doc/pl/Makefile.am b/weechat/doc/pl/Makefile.am deleted file mode 100644 index b226d50fe..000000000 --- a/weechat/doc/pl/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = pl -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(QUICKSTART) - -docdir = $(datadir)/doc/$(PACKAGE) - -# install docs - -install-data-hook: - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ diff --git a/weechat/doc/pl/weechat_quickstart.pl.txt b/weechat/doc/pl/weechat_quickstart.pl.txt deleted file mode 100644 index 51f233147..000000000 --- a/weechat/doc/pl/weechat_quickstart.pl.txt +++ /dev/null @@ -1,111 +0,0 @@ -Weechat szybki start (wersja polska) - -1. W��czenie - - Aby wybra� konkretny interfejs nale�y wpisa�: - - weechat-curses dla interfejsu curses - - weechat-gtk dla interfejsu GTK (w fazie tworzenia) - - weechat-qt dla interfejsu QT (planowany) - - weechat-wxwidgets dla interfejsu WxWidgets (planowany) - - -2. Pomoc online / opcje - - Weechat posiada polecenie pomocy, kt�rego mo�na u�y� dla ka�dej dost�pnej opcji, wystarczy wpisa� /help - Aby otrzyma� pomoc odno�nie komendy, wpisz /help <komenda> - - Aby konfigurowa� opcje nale�y wpisa� /set <opcja> = <warto��> - Mo�esz wpisa� /set <opcja> z nie pe�n� nazw� opcji (poka�e to opcje zawieraj�ce wpisany ci�g znak�w), - lub z ca�� nazw� opcji bez warto�ci (poka�e sie wtedy ca�a pomoc odno�nie opcji). - - Uwaga: ustawienia s� zapami�tywane podczas wy��czania WeeChata (albo po wpisaniu /save ) - NIE EDYTUJ pliku konfiguracyjnego WeeChata podczas pracy programu, poniewa� WeeChat mo�e nadpisa� - ten plik w ka�dej chwili i nie b�dzie mo�liwo�ci odzyskania ustawie�. - Aby zmieni� ka�de z ustawie�, u�ywaj komendy "/set", WeeChat po jej u�yciu od razu zacznie korzysta� z nowych - parametr�w. - -3. Dodawanie serwer�w - - Dla przyk�adu irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (wpisz /help server dla pe�nej pomocy) - -4. Ustawianie w�asnych ustawie� dotycz�cych serwera - - Niki: - /set quakenet.server_nick1 = "m�j-nick" - /set quakenet.server_nick2 = "m�j-nick2" - /set quakenet.server_nick3 = "m�j-nick3" - - Imi� u�ytkownika: - /set quakenet.server_username = "My username" - /set quakenet.server_realname = "My real name" - - Automatyczne ��czenie do serwera przy starcie WeeChata: - /set quakenet.server_autoconnect = on - - Automatyczne wchodzenie na wybrane kana�y po po��czeniu sie do serwera: - /set quakenet.server_autojoin = "#kana�1,#kana�2" - - Inne opcje: - Mo�esz zobaczy� inne opcje i ich w�a�ciwo�ci po wpisaniu /set quakenet - Aby ustawi� konkretn� opcj� wpisz /set quakenet.server_opcja = warto�� - - -5. ��czenie do serwera i automatyczne wchodzenie na wybrane kana�y: - - /connect quakenet - -6. Wchodzenie/wychodzenie na/z kana�y/-�w - - Wchodzenie na kana�: - /join #kana� - Wychodzenie z kana�u: - /part {wiadomo�� przy wychodzeniu} - Wyj�cie z kana�u i zamkni�cie zak�adki: - /close {wiadomo�� przy wychodzeniu} - ("/close" to alias od "/bufer close") - -7. Zarz�dzanie bufory/okna - - Mo�esz zarz�dza� buforami przy pomocy polecenia "/buffer" i oknami "/windows" - Przyk�ad: - -aby rozdzieli� ekran w pionie na ma�e okno (1/3 szeroko�ci), - i na du�e (2/3), wpisz: - /window splthv 33 - -8. Przypisywanie funkcji do klawiszy: - - W celu �atwiejszej pracy mo�na przypisa� dowolnym klawiszom wybrane funkcje/polecenia - przy pomocy komendy "/key" - U�yteczn� mo�e by� funkcja meta-k (alt+k) kt�ra pozwala znale�� przypisane klawiszom kody. - - Przyk�ad: aby zbindowa� (przypisa�) meta-y (alt-y) do polecenia "/buffer close": - /key (naci�nij meta-k) (naci�nij meta-y) /buffer close - Otrzymujesz: - /key meta-y /buffer close - - -9. Wtyczki/skrypty - - Na niekt�rych systemach operacyjnych, takich jak Debian, wtyczki s� dost�pne jako oddzielne paczki - (np. weechat-plugins) - Wtyczki s� automatycznie �adowane przy starcie. - Dodatkowe skrypty i wtyczki do WeeChata dost�pne s� na: - http://weechat.flashtux.org/plugins.php - Zajrzyj do dokumentacji WeeChata, aby dowiedzie� sie jak ladowa� i wy�adowa� wtyczki i skrypty: - http://weechat.flashtux.org/doc.php - -10. Dokumentacja szczeg�owa - - Wiesz juz jak w podstawowy spos�b u�ywa� WeeChata, aby dowiedzie� sie wi�cej poczytaj dokumentacj�. - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Mi�ej pracy z WeeChatem! - --- -(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org> - Translated by dzik (znajdziecie mnie na irc.freenode.net) -This document is part of WeeChat and is distributed under GPL licence. - diff --git a/weechat/doc/ru/Makefile.am b/weechat/doc/ru/Makefile.am deleted file mode 100644 index b3fb22206..000000000 --- a/weechat/doc/ru/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = ru -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(QUICKSTART) - -docdir = $(datadir)/doc/$(PACKAGE) - -# install docs - -install-data-hook: - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ diff --git a/weechat/doc/ru/weechat_quickstart.ru.txt b/weechat/doc/ru/weechat_quickstart.ru.txt deleted file mode 100644 index 8dc03429c..000000000 --- a/weechat/doc/ru/weechat_quickstart.ru.txt +++ /dev/null @@ -1,110 +0,0 @@ -Краткое руководство пользователя (русская версия) -================================ - -1. Запуск WeeChat - - В зависимости от выбранного интерфейса вы должны запустить: - - weechat-curses для Curses интерфейса - - weechat-gtk для GTK интерфейса (в разработке) - - weechat-qt для Qt интерфейса (не разрабатывается) - - weechat-wxwidgets для WxWidgets интерфейса (не разрабатывается) - -2. Справка / настройки - WeeChat содержит справку по всем командам, просто запустите /help - Для получения справки по команде наберите /help команда - - Для настройки используйте /set параметр = значение - Вы можете использовать /set с частичным названием параметра - (выведет все параметры с указанной фразой) или с полным названием - (для получения подробной справки по параметру) - - Внимание: настройки сохраняются при выходе из WeeChat (или командой - "/save"). НЕ РЕДАКТИРУЙТЕ файл конфигурации когда WeeChat запущен, - т.к. WeeChat может в любой момент перезаписать его. Возможности - перезагрузить файл конфигурации нет. Для изменения любых настроек - воспользуйтесь командой "/set", изменения вступят в силу - незамедлительно. - -3. Создание сервера - - Например, irc.quakenet.org, порт 6667: - /server quakenet irc.quakenet.org 6667 - (/help server выведет подробную справку) - -4. Настройка сервера - - Ники: - /set quakenet.server_nick1 = "mynick" - /set quakenet.server_nick2 = "mynick2" - /set quakenet.server_nick3 = "mynick3" - - Имя пользователя / реальное имя: - /set quakenet.server_username = "Имя пользователя" - /set quakenet.server_realname = "Реальное имя" - - Автоматическое подключение к серверу: - /set quakenet.server_autoconnect = on - - Автоматический заход на некоторые каналы: - /set quakenet.server_autojoin = "#chan1,#chan2" - - Другие настройки: - Чтобы вывести все настройки сервера наберите /set quakenet - Для настройки наберите /set quakenet.параметр_сервера = значение - -5. Подключение к серверу и автоматический заход на каналы: - - /connect quakenet - -6. Заход/покидание каналов - - Зайти на канал: - /join #канал - Покинуть канал: - /part [прощальное сообщение] - Покинуть канал и закрыть буфер: - /close [прощальное сообщение] - (/close - это сокращение для /buffer close) - -7. Управление буферами/окнами - - Вы можете управлять буферами командой "/buffer" и окнами - командой "/window". - Например, чтобы разбить экран по вертикали на маленькое (треть - экрана) и большое (2/3 экрана) окна наберите: - /window splitv 33 - -8. Привязки клавиш - - Вы можете переназначить любую клавишу в соответствии с вашими - пожеланиями командой "/key". - Полезна привязка meta-k (alt-k) для поиска нужных кодов клавиш. - - Например, чтобы привязать meta-y (alt-y) к команде "/buffer close": - /key (нажмите meta-k) (нажмите meta-y) /buffer close - Вы получите команду: - /key meta-y /buffer close - -9. Plugins/скрипты - - В некоторых дистрибутивах pluginы доступны отдельным пакетом - (например, weechat-plugins). - Pluginы загружаются автоматически. - Для WeeChat доступны многочисленные pluginы и скрипты: - http://weechat.flashtux.org/plugins.php - Процесс загрузки и выгрузки pluginов и скриптов подробно описан в - документации. - -10. Другая документация - - Теперь вы можете пользоваться WeeChat и почитать ЧаВо и документацию - для поиска ответов на оставшиеся вопросы: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Наслаждайтесь WeeChat! - --- -(c) 2006-05-31, автор - FlashCode <flashcode@flashtux.org> -(с) 2006-06-04, переводчик - Stalwart <stlwrt@gmail.com> -Этот документ является частью WeeChat и распространяется по лицензии GPL. diff --git a/weechat/doc/sco/Makefile.am b/weechat/doc/sco/Makefile.am deleted file mode 100644 index 1a74c7b07..000000000 --- a/weechat/doc/sco/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = sco -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(QUICKSTART) - -docdir = $(datadir)/doc/$(PACKAGE) - -# install docs - -install-data-hook: - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ diff --git a/weechat/doc/sco/weechat_quickstart.sco.txt b/weechat/doc/sco/weechat_quickstart.sco.txt deleted file mode 100644 index 0002eea12..000000000 --- a/weechat/doc/sco/weechat_quickstart.sco.txt +++ /dev/null @@ -1,108 +0,0 @@ -WeeChat quik stairt guide (Scots version) -========================= - -1. Launch weechat - - Accordin tae choosed GUI, ye hav tae launch: - - weechat-curses fer Curses GUI - - weechat-gtk fer Gtk GUI (under development) - - weechat-qt fer Qt GUI (no developed) - - weechat-wxwidgets fer WxWidgets GUI (no developed yit) - -2. Online help / options - - WeeChat hus help fer awl commands, jus issu /help - Tae get help on a command, issu /help command - - Tae set options, use eh /set option = value - Ye can use /set option wi partial name (displ't awl options - contain leters), or wi ownly a full option nam wi'oot value - (tae see long help fer option). - - Pure Important: settings are saved when WeeChat ends (or wi eh "/save" - command). Gonnae NO(!) edit eh setup file whyle WeeChat is running, cause WeeChat - may write eh file at 'ne time, and its nae possible tae reload it. - Tae chainge any settins, use "/set" command, WeeChat immediately uses new - settings. - -3. Create a server - - Fer example irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (/help server fer ful command help) - -4. Set custom server options - - Nicks: - /set quakenet.server_nick1 = "manick" - /set quakenet.server_nick2 = "manick2" - /set quakenet.server_nick3 = "manick3" - - Username/realname: - /set quakenet.server_username = "Ma username" - /set quakenet.server_realname = "Ma real name" - - Auto-connect tae server: - /set quakenet.server_autoconnect = on - - Auto-join fer sum channels: - /set quakenet.server_autojoin = "#chan1,#chan2" - - Other options: - Ye can see servers options and values wi /set quakenet - Tae set an option, use eh /set quakenet.server_option = value - -5. Connect tae server n auto-join channels: - - /connect quakenet - -6. Join/part channels - - Join a channel: - /join #channel - Part a channel: - /part [quit message] - Part a channel n close buffer: - /close [quit message] - (/close is an alias on /buffer close) - -7. Buffer/window management - - Ye can manage buffers wi "/buffer" command and windows - with "/window" command. - Fer example, tae split verticaly screen intae a wee windea (1/3 width), - n a big yin (2/3), use command: - /window splitv 33 - -8. Key bindings - - According tae yer keyboard and/or ya needs, ye can rebind 'ne key - wi "/key" command. - A useful key is meta-k (alt-k) tae find key codes. - - Fer example, tae bind meta-y (alt-y) tae command "/buffer close": - /key (press meta-k) (press meta-y) /buffer close - - Ye wull huv a command line like: - /key meta-y /buffer close - -9. Plugins/scripts - - On som distros lyke Debian, plugins are available via a separate package - (like weechat-plugins). - Plugins are automatically loadet when found. - Many plugins/scripts are available fer WeeChat, please luk at: - http://weechat.flashtux.org/plugins.php - Please luk at WeeChat documentation tae load/unload plugins or scripts. - -10. Mer documentation - - Yae can noo use WeeChat and read FAQ/documentation fer any oths questins: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Enjoy WeeChat! - --- -(c) 2006-05-31, written by FlashCode <flashcode@flashtux.org>, Translate't by AndrewB <andrewb@tuxhacker.org> -This document is part of WeeChat and is distributed under GPL licence. diff --git a/weechat/doc/sv/Makefile.am b/weechat/doc/sv/Makefile.am deleted file mode 100644 index 0d66e8f43..000000000 --- a/weechat/doc/sv/Makefile.am +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright (c) 2003-2007 FlashCode <flashcode@flashtux.org> -# -# This program 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. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. -# - -LANGCODE = sv -QUICKSTART = weechat_quickstart.$(LANGCODE).txt - -EXTRA_DIST = $(QUICKSTART) - -docdir = $(datadir)/doc/$(PACKAGE) - -# install docs - -install-data-hook: - $(INSTALL_DATA) $(QUICKSTART) $(DESTDIR)$(docdir)/ diff --git a/weechat/doc/sv/weechat_quickstart.sv.txt b/weechat/doc/sv/weechat_quickstart.sv.txt deleted file mode 100644 index 1e26294c7..000000000 --- a/weechat/doc/sv/weechat_quickstart.sv.txt +++ /dev/null @@ -1,109 +0,0 @@ -WeeChat snabb start guide (svensk version) -========================= - -1. Starta weechat - - Beroende p� vald GUI, m�ste du starta: - - weechat-curses f�r Curses GUI - - weechat-gtk f�r Gtk GUI (under utveckling) - - weechat-qt f�r Qt GUI (inte utvecklad) - - weechat-wxwidgets f�r WxWidgets GUI (inte utvecklad) - -2. Online hj�lp / inst�llningar - - WeeChat har hj�lp f�r alla kommandon, skriv /help f�r mer information. - F�r att f� hj�lp med ett kommando, skriv /help kommando. - - F�r att st�lla in inst�llningarna, anv�nd /set inst�llning = v�rde, - t ex. /set col_nick_self = white (�ndrar ditt namn till f�rgen vit.) - Du kan anv�nda /set inst�llning med partial namn (visar alla inst�llningar - som inneh�ller bokst�ver), eller bara en inst�llning utan ett v�rde - (f�r att se mer information om den specifika inst�llningen, t ex. /set col_nick_self.) - - Viktigt: inst�llningar sparas n�r WeeChat avlutas (eller med "/save" - kommando). Redigera INTE setup filen medans WeeChat k�rs, d�rf�r WeeChat - kan skriva i denna fil n�r som helst, och det �r inte m�jligt att ladda om den. - F�r att �ndra inst�llingar, anv�nd "/set" kommandot, WeeChat anv�nder d� - direkt de nya inst�llningarna. - -3. Skapa en server - - Till exempel irc.quakenet.org, port 6667: - /server quakenet irc.quakenet.org 6667 - (/help server f�r full kommando hj�lp) - -4. Server inst�llningar - - Smeknamn: - /set quakenet.server_nick1 = "mynick" - /set quakenet.server_nick2 = "mynick2" - /set quakenet.server_nick3 = "mynick3" - - Anv�ndarnamn/Riktigt namn: - /set quakenet.server_username = "Mitt anv�ndarnamn" - /set quakenet.server_realname = "Mtt riktiga namn" - - Automatiskt ansluta till server: - /set quakenet.server_autoconnect = on - - Automatiskt joina en/flera kanaler: - /set quakenet.server_autojoin = "#chan1,#chan2" - - Andra inst�llningar: - Du kan see server inst�llningar and v�rden med /set quakenet - F�r att st�lla in en inst�llning, anv�nd /set quakenet.server_inst�llning = v�rde - -5. Ansluta till en server och automatiskt joina kanaler: - - /connect quakenet - -6. Joina/parta en kanal: - - Joina en kanal: - /join #kanal - Parta en kanal: - /part [quit message] - Parta en kanal och st�ng buffer: - /close [quit message] - (/close �r ett alias av /buffer close) - -7. Buffer/f�nster management - - Du kan ta hand om buffers med "/buffer" kommandot och f�nster - med "/window" kommandot. - Till exempel, F�r att dela f�nstret till ett litet f�nster (1/3 bred), - och ett stort (2/3), anv�nd kommandot: - /window splitv 33 - -8. Knapp 'binding' - - Beroende p� ditt tangentbord och/eller dina behov, kan du binda varje tangentknapp - med "/key" kommandot. - - Till exempel, f�r att binda meta-y (alt-y) till kommandot "/buffer close": - /key (tryck meta-k) (tryck meta-y) /buffer close - Du borde ha en kommando rad som denna: - /key meta-y /buffer close - -9. Plugins/skripts - - P� vissa distributioner s�som Debian, �r plugins tillg�ngliga via ett separat paket - (som weechat-plugins). - Plugins �r automatiskt laddad n�r det har hittats. - Det finns m�nga plugins/skripts tillg�ngliga f�r WeeChat, Kolla: - http://weechat.flashtux.org/plugins.php - Kolla �ven WeeChat's dokumentering f�r att ladda/'unloada' plugins eller skripts.. - -10. Mer dokumentation - - Du kan nu anv�nda WeeChat och l�sa FAQ/dokumentation f�r �vriga fr�gor: - http://weechat.flashtux.org/faq.php - http://weechat.flashtux.org/doc.php - - Njut av WeeChat! - --- -(c) 2006-05-31, skrivet av FlashCode <flashcode@flashtux.org> - 2007-08-09, �versatt till svenska av Robin Karlsson <Robin--Karlsson@bredband.net> -Det h�r dokumentet �r en del av WeeChat och �r distribuerad under GPL -licens. diff --git a/weechat/doc/weechat-curses.1 b/weechat/doc/weechat-curses.1 deleted file mode 100644 index 2b1c35fac..000000000 --- a/weechat/doc/weechat-curses.1 +++ /dev/null @@ -1,93 +0,0 @@ -.TH WEECHAT 1 "June 2007" "FlashCode" - -.SH NAME -weechat-curses \- Wee Enhanced Environment for Chat (Curses version) - -.SH SYNOPSIS -.B weechat-curses -.RI [ options... ] -or -.RI [ url... ] -.br - -.SH DESCRIPTION -Fast, light and extensible IRC client for many operating systems. -.br -Everything can be done with a keyboard. It is customizable and extensible with scripts. -Many GUIs are or will be available (Curses, Gtk and Qt). -It is compliant with 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, \-\-config -.br -display config file help (list of options) -.TP -.B \-d, \-\-dir <dir> -.br -set WeeChat home dir -.TP -.B \-f, \-\-key\-functions -.br -display internal functions for keys -.TP -.B \-h, \-\-help -.br -display summary of options -.TP -.B \-i, \-\-irc\-commands -.br -display IRC commands -.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 \-v, \-\-version -.br -display WeeChat version -.TP -.B \-w, \-\-weechat\-commands -.br -display WeeChat commands - -.SH URL -WeeChat can use an URL (Uniform Resource Locator) to automatically connect -to an IRC server. These are in the following form: -.TP -.B irc[6][s]://[[nickname][:password]@]server[:port][/[#&+!]channel[,channel...]] -.TP -Exemple to join WeeChat channel support with nick "FlashCode": -irc://FlashCode@irc.freenode.net/weechat - -.SH FILES -.TP -.B $HOME/.weechat/weechat.rc -configuration file for WeeChat -.TP -.B $HOME/.weechat/weechat.log -WeeChat log file - -.SH AUTHOR -WeeChat is written by FlashCode <flashcode@flashtux.org> -.br -WeeChat on the web: -.UR -http://weechat.flashtux.org/ -.br -Get support there: -.UR -http://weechat.flashtux.org/support.php -.UE diff --git a/weechat/doc/weechat-doc.css b/weechat/doc/weechat-doc.css deleted file mode 100644 index d9d8355c4..000000000 --- a/weechat/doc/weechat-doc.css +++ /dev/null @@ -1,92 +0,0 @@ -/* - * WeeChat doc CSS - * (c) 2006 by FlashCode <flashcode@flashtux.org> - */ - -body { - font-family: Verdana, Tahoma, Arial, Helvetica, sans-serif; - font-size: 12px; -} - -table { - font-size: 12px; -} - -a { - color: #000099; -} - -a:visited { - color: #770077; -} - -a:hover { - background-color: #FFCCCC; -} - -.navheader { - background-color: #E0E0FF; - border: solid 1px #A7A7C4; - margin: -10px; - padding: 8px; -} - -.navheader hr { - display: none; -} - -.navfooter { - background-color: #E0E0FF; - border: solid 1px #A7A7C4; - margin: 20px -10px -10px -10px; - padding: 8px; -} - -.navfooter hr { - display: none; -} - -.title { - background-color: #EBEBEB; - border: solid 1px #CACACA; - margin-top: 25px; - padding: 6px; - letter-spacing: 1px; -} - -.informaltable table { - font-size: 11px; - font-family: Verdana; - border-collapse: collapse; -} - -.informaltable table th { - padding: 2px 5px 2px 5px; - border: solid 1px #AAAAAA; - background-color: #DDDDFF; -} - -.informaltable table td { - padding: 2px 5px 2px 5px; - border: solid 1px #AAAAAA; -} - -.oddrow { - background-color: #F0F0F0; -} - -.synopsis { - font-size: 11px; -} - -.programlisting { - font-size: 11px; -} - -pre.screen { - font-size: 11px; - background-color: #FAFAFA; - border: dotted 1px #CCCCCC; - padding: 4px; - margin: 0 40px 0 40px; -} diff --git a/weechat/doc/weechat-html-one.xsl.in b/weechat/doc/weechat-html-one.xsl.in deleted file mode 100644 index ad13bd2e8..000000000 --- a/weechat/doc/weechat-html-one.xsl.in +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> - -<xsl:import href="@DOC_XSL_PREFIX@/html/docbook.xsl"/> - -<xsl:output indent="yes"/> - -<xsl:param name="chunk.section.depth" select="2"/> -<xsl:param name="chunk.quietly" select="1"/> -<xsl:param name="chunk.first.sections" select="1"/> -<xsl:param name="generate.section.toc.level" select="3"/> - -<xsl:param name="html.stylesheet">weechat-doc.css</xsl:param> - -<xsl:template name="tr.attributes"> - <xsl:param name="row" select="."/> - <xsl:param name="rownum" select="0"/> - - <xsl:if test="not(ancestor::table/@tabstyle = 'unstriped')"> - <xsl:if test="$rownum mod 2 = 0"> - <xsl:attribute name="class">oddrow</xsl:attribute> - </xsl:if> - </xsl:if> -</xsl:template> - -</xsl:stylesheet> diff --git a/weechat/doc/weechat-html.xsl.in b/weechat/doc/weechat-html.xsl.in deleted file mode 100644 index f0b7bef71..000000000 --- a/weechat/doc/weechat-html.xsl.in +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> - -<xsl:import href="@DOC_XSL_PREFIX@/html/chunk.xsl"/> - -<xsl:output indent="yes"/> - -<xsl:param name="chunk.section.depth" select="2"/> -<xsl:param name="chunk.quietly" select="1"/> -<xsl:param name="chunk.first.sections" select="1"/> -<xsl:param name="generate.section.toc.level" select="3"/> - -<xsl:param name="html.stylesheet">weechat-doc.css</xsl:param> - -<xsl:template name="tr.attributes"> - <xsl:param name="row" select="."/> - <xsl:param name="rownum" select="0"/> - - <xsl:if test="not(ancestor::table/@tabstyle = 'unstriped')"> - <xsl:if test="$rownum mod 2 = 0"> - <xsl:attribute name="class">oddrow</xsl:attribute> - </xsl:if> - </xsl:if> -</xsl:template> - -</xsl:stylesheet> diff --git a/weechat/doc/weechat-pdf.xsl b/weechat/doc/weechat-pdf.xsl deleted file mode 100644 index a91ee4f71..000000000 --- a/weechat/doc/weechat-pdf.xsl +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1" ?> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> - <xsl:param name="latex.hyperparam">colorlinks,linkcolor=blue</xsl:param> -</xsl:stylesheet> - |