From 7d433b798fecc7002bb132e206a23d57fb89cb28 Mon Sep 17 00:00:00 2001 From: Sebastien Helleu Date: Fri, 4 Feb 2011 22:12:19 +0100 Subject: [PATCH] Improve arguments displayed in /help of commands, display all commands with same name (for same command name in many plugins) --- doc/asciidoc.css | 8 +- doc/de/autogen/user/alias_commands.txt | 59 +- doc/de/autogen/user/aspell_commands.txt | 20 +- doc/de/autogen/user/charset_commands.txt | 14 +- doc/de/autogen/user/demo_commands.txt | 46 +- doc/de/autogen/user/irc_commands.txt | 1018 ++++++++------- doc/de/autogen/user/logger_commands.txt | 57 +- doc/de/autogen/user/lua_commands.txt | 22 +- doc/de/autogen/user/perl_commands.txt | 22 +- doc/de/autogen/user/python_commands.txt | 22 +- doc/de/autogen/user/relay_commands.txt | 40 +- doc/de/autogen/user/rmodifier_commands.txt | 44 +- doc/de/autogen/user/ruby_commands.txt | 22 +- doc/de/autogen/user/tcl_commands.txt | 22 +- doc/de/autogen/user/weechat_commands.txt | 832 +++++++------ doc/de/autogen/user/xfer_commands.txt | 20 +- doc/docgen.pl | 14 +- doc/en/autogen/user/alias_commands.txt | 59 +- doc/en/autogen/user/aspell_commands.txt | 20 +- doc/en/autogen/user/charset_commands.txt | 14 +- doc/en/autogen/user/demo_commands.txt | 46 +- doc/en/autogen/user/irc_commands.txt | 1018 ++++++++------- doc/en/autogen/user/logger_commands.txt | 57 +- doc/en/autogen/user/lua_commands.txt | 22 +- doc/en/autogen/user/perl_commands.txt | 22 +- doc/en/autogen/user/python_commands.txt | 22 +- doc/en/autogen/user/relay_commands.txt | 40 +- doc/en/autogen/user/rmodifier_commands.txt | 44 +- doc/en/autogen/user/ruby_commands.txt | 22 +- doc/en/autogen/user/tcl_commands.txt | 22 +- doc/en/autogen/user/weechat_commands.txt | 864 +++++++------ doc/en/autogen/user/xfer_commands.txt | 20 +- doc/en/weechat_user.en.txt | 2 +- doc/fr/autogen/user/alias_commands.txt | 59 +- doc/fr/autogen/user/aspell_commands.txt | 20 +- doc/fr/autogen/user/charset_commands.txt | 14 +- doc/fr/autogen/user/demo_commands.txt | 46 +- doc/fr/autogen/user/irc_commands.txt | 1084 ++++++++-------- doc/fr/autogen/user/logger_commands.txt | 57 +- doc/fr/autogen/user/lua_commands.txt | 22 +- doc/fr/autogen/user/perl_commands.txt | 22 +- doc/fr/autogen/user/python_commands.txt | 22 +- doc/fr/autogen/user/relay_commands.txt | 40 +- doc/fr/autogen/user/rmodifier_commands.txt | 44 +- doc/fr/autogen/user/ruby_commands.txt | 22 +- doc/fr/autogen/user/tcl_commands.txt | 22 +- doc/fr/autogen/user/weechat_commands.txt | 834 +++++++------ doc/fr/autogen/user/xfer_commands.txt | 20 +- doc/it/autogen/user/alias_commands.txt | 59 +- doc/it/autogen/user/aspell_commands.txt | 20 +- doc/it/autogen/user/charset_commands.txt | 14 +- doc/it/autogen/user/demo_commands.txt | 46 +- doc/it/autogen/user/irc_commands.txt | 1210 +++++++++--------- doc/it/autogen/user/logger_commands.txt | 57 +- doc/it/autogen/user/lua_commands.txt | 22 +- doc/it/autogen/user/perl_commands.txt | 22 +- doc/it/autogen/user/python_commands.txt | 22 +- doc/it/autogen/user/relay_commands.txt | 40 +- doc/it/autogen/user/rmodifier_commands.txt | 44 +- doc/it/autogen/user/ruby_commands.txt | 22 +- doc/it/autogen/user/tcl_commands.txt | 22 +- doc/it/autogen/user/weechat_commands.txt | 834 +++++++------ doc/it/autogen/user/xfer_commands.txt | 20 +- po/cs.po | 809 ++++++++---- po/de.po | 844 +++++++++---- po/es.po | 836 +++++++++---- po/fr.po | 1297 +++++++++++--------- po/hu.po | 722 +++++++---- po/it.po | 835 +++++++++---- po/pl.po | 836 +++++++++---- po/pt_BR.po | 673 ++++++---- po/ru.po | 722 +++++++---- po/weechat.pot | 549 +++++---- src/core/wee-command.c | 369 ++++-- src/plugins/alias/alias.c | 10 +- src/plugins/aspell/weechat-aspell.c | 6 +- src/plugins/charset/charset.c | 3 +- src/plugins/demo/demo.c | 34 +- src/plugins/irc/irc-command.c | 365 +++--- src/plugins/logger/logger.c | 4 +- src/plugins/relay/relay-command.c | 6 +- src/plugins/rmodifier/rmodifier-command.c | 7 +- src/plugins/scripts/script.c | 22 +- src/plugins/xfer/xfer-command.c | 4 +- 84 files changed, 10485 insertions(+), 7826 deletions(-) diff --git a/doc/asciidoc.css b/doc/asciidoc.css index 489477040..117af18d0 100644 --- a/doc/asciidoc.css +++ b/doc/asciidoc.css @@ -1,6 +1,12 @@ div.sectionbody { - font-family: serif,Helvetica,arial; + font-family: serif,Helvetica,arial; } h5 { font-size: 0.95em; } +span.command { + background: #EEEEFF; + border: solid 1px #BBBBDD; + padding: 0 8px 0 8px; + margin-right: 12px; +} diff --git a/doc/de/autogen/user/alias_commands.txt b/doc/de/autogen/user/alias_commands.txt index 160fa4910..6f3504880 100644 --- a/doc/de/autogen/user/alias_commands.txt +++ b/doc/de/autogen/user/alias_commands.txt @@ -1,34 +1,33 @@ -• *`/alias`* `[[-completion completion] alias_name [command [arguments]]]`:: - +[command]*`alias`* Einem Befehl wird ein Alias zugewiesen:: ........................................ - Einem Befehl wird ein Alias zugewiesen +/alias [-completion ] [ []] - completion: optionale Vervollständigung für einen Alias-Befehl (Standardverhalten: Vervollständigung wird auf den Zielbefehl angewendet) - alias_name: Name des Alias (kann mit Joker "*" beginnen oder enden für Alias-Listing) - command: Name des zuzuordnenden Befehls (WeeChat- oder IRC-Befehl ohne führenden '/', mehrere Befehle müssen durch Semikolon getrennt werden) - arguments: Argumente für Befehl - - Ohne Angabe von Argumenten werden alle definierten Alias angezeigt. - - Anmerkung: im Befehl können Variablen gesetzt werden, die dann durch den entsprechenden Wert ersetzt werden: - $n: Argument 'n' (zwischen 1 und 9) - $-m: Argumente von 1 bis 'm' - $n-: Argumente von 'n' bis zum letzten Argument - $n-m: Argumente von 'n' bis 'm' - $*: alle Argumente - $~: letztes Argument - $nick: aktueller Nick - $channel: aktueller Channel - $server: aktueller Server - - Um ein Alias zu löschen, nutze "/unalias". - - Beispiele: - Alias "/split" wird anlegt um damit ein Fenster horizontal zu teilen: - /alias split /window splith - Alias "/hallo" wird angelegt um in allen Channels, außer im #weechat Channel, den Text "Hallo" auszugeben: - /alias hallo /allchan -exclude=#weechat msg * Hallo - Alias "/forcejoin" wird angelegt um den IRC Befehl "forcejoin" mit einer Vervollständigung von /sajoin auszuführen: - /alias -completion %%sajoin forcejoin /quote forcejoin +completion: completion for alias (optional, by default completion is done with target command) + alias: name of alias (can start or end with "*" for alias listing) + command: command name (many commands can be separated by semicolons) + arguments: arguments for command + +Without argument, this command lists all defined alias. + +Note: in command, special variables are replaced: + $n: argument 'n' (between 1 and 9) + $-m: arguments from 1 to 'm' + $n-: arguments from 'n' to last + $n-m: arguments from 'n' to 'm' + $*: all arguments + $~: last argument + $nick: current nick + $channel: current channel + $server: current server + +To remove an alias, use command /unalias. + +Examples: + alias /split to split window horizontally: + /alias split /window splith + alias /hello to say "hello" on all channels but not on #weechat: + /alias hello /allchan -exclude=#weechat msg * hello + alias /forcejoin to send IRC command "forcejoin" with completion of /sajoin: + /alias -completion %%sajoin forcejoin /quote forcejoin ........................................ diff --git a/doc/de/autogen/user/aspell_commands.txt b/doc/de/autogen/user/aspell_commands.txt index d7f961f37..cf32141cb 100644 --- a/doc/de/autogen/user/aspell_commands.txt +++ b/doc/de/autogen/user/aspell_commands.txt @@ -1,13 +1,15 @@ -• *`/aspell`* `dictlist | enable lang | disable | addword [lang] word`:: - +[command]*`aspell`* Konfiguration für aspell-Erweiterung:: ........................................ - Konfiguration für aspell-Erweiterung +/aspell dictlist + enable + disable + addword [] - dictlist: listet installierte Wörterbücher auf - enable: aktiviert aspell in aktuellem Buffer [lang = Wörterbuch) - disable: deaktiviert aspell in aktuellem Buffer - addword: fügt ein Wort in das persönliche Wörterbuch von aspell hinzu - - Eingaben die mit '/' beginnen werden nicht überprüft, außer bei einigen Befehle. +dictlist: listet installierte Wörterbücher auf + enable: aktiviert aspell in aktuellem Buffer [lang = Wörterbuch) + disable: deaktiviert aspell in aktuellem Buffer + addword: fügt ein Wort in das persönliche Wörterbuch von aspell hinzu + +Eingaben die mit '/' beginnen werden nicht überprüft, außer bei einigen Befehle. ........................................ diff --git a/doc/de/autogen/user/charset_commands.txt b/doc/de/autogen/user/charset_commands.txt index 361178bd1..bb2dee1c7 100644 --- a/doc/de/autogen/user/charset_commands.txt +++ b/doc/de/autogen/user/charset_commands.txt @@ -1,11 +1,11 @@ -• *`/charset`* `[[dekodiere | kodieren] Zeichensatz] | [Reset]`:: - +[command]*`charset`* ändere Zeichensatz für aktuellen Buffer:: ........................................ - ändere Zeichensatz für aktuellen Buffer +/charset decode|encode + reset - decode: ändere Zeichensatz zum dekodieren - encode: ändere Zeichensatz zum kodieren - charset: wähle neuen Zeichensatz für aktuellen Buffer - reset: setze im aktuellen Buffer den Zeichensatz zurück + decode: ändere Zeichensatz zum dekodieren + encode: ändere Zeichensatz zum kodieren +charset: wähle neuen Zeichensatz für aktuellen Buffer + reset: setze im aktuellen Buffer den Zeichensatz zurück ........................................ diff --git a/doc/de/autogen/user/demo_commands.txt b/doc/de/autogen/user/demo_commands.txt index a36173d66..fd1aab80e 100644 --- a/doc/de/autogen/user/demo_commands.txt +++ b/doc/de/autogen/user/demo_commands.txt @@ -1,42 +1,32 @@ -• *`/demo_buffer`* `Name`:: - +[command]*`demo_buffer`* Öffne einen neuen Buffer:: ........................................ - Öffne einen neuen Buffer +/demo_buffer ........................................ -• *`/demo_buffer_set`* `Eigenschaft eines Wertes`:: - +[command]*`demo_info`* Hole eine Info und zeige sie an:: ........................................ - Bestimme eine Eigenschaft des Buffers +/demo_info [] + + Info: Information die dargestellt werden soll +Argumente: optionale Argumente für Info + +Wird der Befehl ohne Argumente aufgerufen werden alle verfügbaren Informationen angezeigt ........................................ -• *`/demo_info`* `[Info [Argumente]]`:: - +[command]*`demo_infolist`* Hole eine Infolist und zeige sie an:: ........................................ - Hole eine Info und zeige sie an +/demo_infolist [] - Info: Information die dargestellt werden soll - Argumente: optionale Argumente für Info - - Wird der Befehl ohne Argumente aufgerufen werden alle verfügbaren Informationen angezeigt + Infolist: Infoliste die dargestellt werden soll +Argumente: optionale Argumente für Infoliste + +Wird der Befehl ohne Argumente aufgerufen werden alle verfügbaren Informationen der Infoliste angezeigt ........................................ -• *`/demo_infolist`* `[Infolist [Argumente]]`:: - +[command]*`demo_printf`* Gibt ein paar Nachrichten im aktuellen Buffer aus:: ........................................ - Hole eine Infolist und zeige sie an +/demo_printf - Infolist: Infoliste die dargestellt werden soll - Argumente: optionale Argumente für Infoliste - - Wird der Befehl ohne Argumente aufgerufen werden alle verfügbaren Informationen der Infoliste angezeigt -........................................ - -• *`/demo_printf`* `[Text]`:: - -........................................ - Gibt ein paar Nachrichten im aktuellen Buffer aus - - Text: schreibe diesen Text +Text: schreibe diesen Text ........................................ diff --git a/doc/de/autogen/user/irc_commands.txt b/doc/de/autogen/user/irc_commands.txt index c0fa55d68..7a417bdcd 100644 --- a/doc/de/autogen/user/irc_commands.txt +++ b/doc/de/autogen/user/irc_commands.txt @@ -1,721 +1,671 @@ -• *`/admin`* `[Ziel]`:: - -........................................ - Information über den Server-Administrator abfragen - - Ziel: Server -........................................ - -• *`/allchan`* `[-current] [-exclude=channel[,channel...]] command [arguments]`:: - -........................................ - Führt einen Befehl aus der an alle Channels gesendet wird, die mit einem Server verbunden sind - - -current: führt einen Befehl aus der an alle Channels des aktuellen Servers gesendet wird - -exclude: dient zum Ausschluss ausgewählter Channels ('*' wird zu Beginn oder am Ende des Channel-Namens akzeptiert, um mehrere Channels auszuschließen) - command: Befehl der ausgeführt werden soll - arguments: Argumente des Befehls - - Beispiele: - Führe den Befehl '/me Ich teste gerade etwas...' für alle Channels aus: - /allchan me Ich teste gerade etwas... - Schicke 'Hallo Welt' an jeden Channel, ausgenommen an den #weechat Channel: - /allchan -exclude=#weechat msg * Hallo Welt - Schicke 'Hallo Welt' an jeden Channel, ausgenommen an den #weechat Channel und Channels die mit #linux beginnen: - /allchan -exclude=#weechat,#linux* msg * Hallo Welt -........................................ - -• *`/allserv`* `[-exclude=server[,server...]] command [arguments]`:: - -........................................ - Führt einen Befehl aus, der zu allen verbundenen Server gesendet wird - - -exclude: dient zum Ausschluss ausgewählter Server ('*' wird zu Beginn oder am Ende des Server-Namens akzeptiert, um mehrere Server auszuschließen) - command: Befehl der ausgeführt werden soll - arguments: Argumente des Befehls - - Beispiele: - Ändere den Nick auf allen Servern: - /allserv nick newnick - Setzt den Status, auf allen Servern,auf abwesend: - /allserv away I'm away -........................................ - -• *`/ban`* `[Channel] [Nickname [Nickname ...]]`:: - -........................................ - Nicknamen oder Hosts sperren/verbannen - - Channel: Channel für die Sperre - Nickname: zu sperrender User oder Host -........................................ - -• *`/connect`* `[servername [servername ...] | hostname[/port] [-option[=value]] [-nooption] | -all | -open] [-nojoin] [-switch]`:: - -........................................ - Mit IRC-Server(n) verbinden - - servername: intern genutzter Servername mit dem verbunden werden soll (Der Server muss zuerst mittels "/server add" angelegt werden) - hostname: Hostname oder IP eines Servers (damit erstelt man ausschließlich einen TEMPORÄREN Server) - port: Port den der Server nutzen soll (Standardport: 6667) - option: legt die Optionen für den Server fest (die Boolean-Optionen können weggelassen werden) - nooption: stellt die Boolean Option auf "off" (Beispiel: -nossl) - -all: Verbindet mit allen Servern - -open: stellt eine Verbindung zu allen geöffneten Servern her zu denen es aktuell keine Verbindung gibt - -nojoin: Channel(s) werden nicht betreten (auch falls die Funktion "autojoin" aktiviert sein sollte) - -switch: wechselt zur nächsten Server-Adresse - - Beispiele: - /connect freenode - /connect irc.oftc.net/6667 - /connect irc6.oftc.net/6667 -ipv6 - /connect irc6.oftc.net/6697 -ipv6 -ssl - /connect my.server.org/6697 -ssl -password=test - /connect -switch -........................................ - -• *`/ctcp`* `target type [arguments]`:: - -........................................ - CTCP-Nachricht verschicken - - target: User oder Channel an welchen eine CTCP-Nachricht geschickt werden soll - type: CTCP-Nachricht (z.B. "version", "ping", ..) - arguments: Argumente für CTCP -........................................ - -• *`/cycle`* `[Channel[,Channel]] [Abschiedsnachricht]`:: - -........................................ - Einen Channel verlassen und wieder betreten - - Channel: zu verlassender Channel - Abschiedsnachricht: Abschiedsnachricht (die den anderen Usern angezeigt wird) -........................................ - -• *`/dcc`* `Aktion [Nickname [Datei]]`:: - -........................................ - Starte DCC (Datentransfer oder Chat) - - Aktion: 'send' (Datei) oder 'chat' - Nickname: Empfänger einer Datei bzw. eines Chats - Datei: zu versendende (lokal vorliegende) Datei - - Beispiel: - Sende eine Chat-Anfrage an den User "toto" - /dcc chat toto - Sende die Datei "/home/foo/bar.txt" an den User "toto" - /dcc send toto /home/foo/bar.txt -........................................ - -• *`/dehalfop`* `Nickname [Nickname]`:: - -........................................ - Halb-Operator-Privilegien einem oder mehreren Nicknamen aberkennen -........................................ - -• *`/deop`* `Nickname [Nickname]`:: - -........................................ - Operator-Privilegien einem oder mehreren Nicknamen aberkennen -........................................ - -• *`/devoice`* `Nickname [Nickname]`:: - -........................................ - Voice-Privilegien einem oder mehreren Nicknamen wegnehmen -........................................ - -• *`/die`*:: - -........................................ - Server herunterfahren -........................................ - -• *`/disconnect`* `[-all | Servername [Servername ...]]`:: - -........................................ - Verbindung, zu einem oder mehreren IRC-Server(n), trennen - - -all: Trenne von allen Servern - servername: Servername, von dem getrennt werden soll -........................................ - -• *`/halfop`* `Nickname [Nickname]`:: - -........................................ - Vergebe halbe Operator Privilegien an einen oder mehrere Nicknamen -........................................ - -• *`/ignore`* `[list] | [add [re:]nick/host [server [channel]]] | [del number|-all]`:: - +[command]*`admin`* Information über den Server-Administrator abfragen:: ........................................ - Ignoriert Nicks/Hosts von Channels oder Servern +/admin [] - list: zeigt an, wer/was ignoriert wird - add: fügt eine Ignorierung hinzu - del: entfernt eine Ignorierung - number: Nummer der Ignorierung die entfernt werden soll (nutze "list" um die entsprechende Nummer zu finden) - -all: entfernt alle Einträge - nick/host: Nick oder Host der ignoriert werden soll: Syntax ist "re:regex" oder "mask" (Eine Maske ist eine Zeichenkette in der mittels "*" ein- oder mehrere Zeichen ersetzt werden können) - server: interner Name des Server, in dem die Ignorierung statt finden soll - channel: Name des Channel, in dem die Ignorierung statt finden soll - - Beispiele: - ignoriert den Nick "toto" global: - /ignore add toto - ignoriert den Host "toto@domain.com" auf dem freenode Server: - /ignore add toto@domain.com freenode - ignoriert den Host "toto*@*.domain.com" im Chat freenode/#weechat: - /ignore add toto*@*.domain.com freenode #weechat +Ziel: Server ........................................ -• *`/info`* `[Ziel]`:: - -........................................ - Information über den Server abfragen - - Ziel: Servername +[command]*`allchan`* Führt einen Befehl aus der an alle Channels gesendet wird, die mit einem Server verbunden sind:: ........................................ +/allchan [-current] [-exclude=[,...]] [] -• *`/invite`* `Nickname Channel`:: + -current: führt einen Befehl aus der an alle Channels des aktuellen Servers gesendet wird + -exclude: dient zum Ausschluss ausgewählter Channels ('*' wird zu Beginn oder am Ende des Channel-Namens akzeptiert, um mehrere Channels auszuschließen) + command: Befehl der ausgeführt werden soll +arguments: Argumente des Befehls +Beispiele: + Führe den Befehl '/me Ich teste gerade etwas...' für alle Channels aus: + /allchan me Ich teste gerade etwas... + Schicke 'Hallo Welt' an jeden Channel, ausgenommen an den #weechat Channel: + /allchan -exclude=#weechat msg * Hallo Welt + Schicke 'Hallo Welt' an jeden Channel, ausgenommen an den #weechat Channel und Channels die mit #linux beginnen: + /allchan -exclude=#weechat,#linux* msg * Hallo Welt ........................................ - Jemanden in einen Channel einladen - Nickname: Chatname des Einzuladenden - Channel: Channel, in den er eingeladen werden soll +[command]*`allserv`* Führt einen Befehl aus, der zu allen verbundenen Server gesendet wird:: ........................................ +/allserv [-exclude=[,...]] [] -• *`/ison`* `Nickname [Nickname ...]`:: + -exclude: dient zum Ausschluss ausgewählter Server ('*' wird zu Beginn oder am Ende des Server-Namens akzeptiert, um mehrere Server auszuschließen) + command: Befehl der ausgeführt werden soll +arguments: Argumente des Befehls +Beispiele: + Ändere den Nick auf allen Servern: + /allserv nick newnick + Setzt den Status, auf allen Servern,auf abwesend: + /allserv away I'm away ........................................ - Überprüfen, ob jemand zur Zeit im IRC ist - Nickname: Nickname +[command]*`ban`* Nicknamen oder Hosts sperren/verbannen:: ........................................ +/ban [] [ [...]] -• *`/join`* `[-server server] [channel1[,channel2[,channel3]] [key1[,key2]]]`:: - -........................................ - einen Channel betreten - - server: sendet an diesen Server (interner Name) - channel: Name des Channels der betreten werden soll - key: Zugriffsschlüssel für einen Channel (Channels die einen Zugriffsschlüssel benötigen müssen zuerst aufgeführt werden) - - Beispiele: - /join #weechat - /join #geschützterChannel,#weechat Zugriffsschlüssel - /join -server freenode #weechat -........................................ - -• *`/kick`* `[channel] nickname [comment]`:: - +channel: channel for ban + nick: user or host to ban ........................................ - Einen User aus einem Channel herauskicken - channel: Channel des Benutzers - nickname: Nickname des Benutzers - comment: Begründung für den Kick +[command]*`connect`* Mit IRC-Server(n) verbinden:: ........................................ +/connect [ [...] | [/]] [-