diff options
Diffstat (limited to 'doc')
21 files changed, 445 insertions, 55 deletions
diff --git a/doc/de/autogen/plugin_api/completions.txt b/doc/de/autogen/plugin_api/completions.txt index fdacbab69..1ac42ba2e 100644 --- a/doc/de/autogen/plugin_api/completions.txt +++ b/doc/de/autogen/plugin_api/completions.txt @@ -46,6 +46,8 @@ | relay | relay_relays | Protokoll.Name des aktuellen Relays von der Relay-Erweiterung +| rmodifier | rmodifier | list of rmodifiers + | ruby | ruby_script | Liste der Skripten: | tcl | tcl_script | Liste der Skripten: diff --git a/doc/de/autogen/plugin_api/infolists.txt b/doc/de/autogen/plugin_api/infolists.txt index 2300074d2..92acac5f1 100644 --- a/doc/de/autogen/plugin_api/infolists.txt +++ b/doc/de/autogen/plugin_api/infolists.txt @@ -22,6 +22,8 @@ | relay | relay | Liste der Relay-Clients | Relay Pointer (optional) | - +| rmodifier | rmodifier | list of rmodifiers | rmodifier pointer (optional) | rmodifier name (can start or end with "*" as joker) (optional) + | ruby | ruby_script | Liste der Skripten: | Skript Pointer (optional) | Name des Skripts (darf mit einem "*" als Platzhalter beginnen oder enden) (optional) | tcl | tcl_script | Liste der Skripten: | Skript Pointer (optional) | Name des Skripts (darf mit einem "*" als Platzhalter beginnen oder enden) (optional) diff --git a/doc/de/autogen/user/rmodifier_commands.txt b/doc/de/autogen/user/rmodifier_commands.txt new file mode 100644 index 000000000..42ef6b896 --- /dev/null +++ b/doc/de/autogen/user/rmodifier_commands.txt @@ -0,0 +1,25 @@ +• *`/rmodifier`* `[list] | [listdefault] | [add name modifiers groups regex] | [del name|-all [name...]] | [default -yes]`:: + +........................................ + alter modifier strings with regular expressions + + list: list all rmodifiers + listdefault: list default rmodifiers + add: add a rmodifier + name: name of rmodifier + modifiers: comma separated list of modifiers + groups: action on groups found: comma separated list of groups (from 1 to 9) with optional "*" after number to hide group + regex: regular expression + del: delete a rmodifier + -all: delete all rmodifiers + default: restore default rmodifiers + + Examples: + hide everything typed after a command /password: + /rmodifier add password input_text_display 1,2* ^(/password +)(.*) + delete rmodifier "password": + /rmodifier del password + delete all rmodifiers: + /rmodifier del -all +........................................ + diff --git a/doc/de/autogen/user/rmodifier_options.txt b/doc/de/autogen/user/rmodifier_options.txt new file mode 100644 index 000000000..43222b7f4 --- /dev/null +++ b/doc/de/autogen/user/rmodifier_options.txt @@ -0,0 +1,5 @@ +* *rmodifier.look.hide_char* +** Beschreibung: char used to hide part of a string +** Typ: Zeichenkette +** Werte: beliebige Zeichenkette (Standardwert: "*") + diff --git a/doc/de/weechat_user.de.txt b/doc/de/weechat_user.de.txt index 75d7d8f39..6d2f360a1 100644 --- a/doc/de/weechat_user.de.txt +++ b/doc/de/weechat_user.de.txt @@ -22,7 +22,7 @@ Funktionen wesentliche Merkmale: -* Multi-Protokoll fähig (IRC, andere Protokolle folgen) +* Multi-Protokoll fähig (IRC, Jabber) * Multi-Server Verbindungen (mittels SSL, IPv6, proxy) * verschiedene GUIs: Curses (wxWidgets, Gtk und Qt sind in der Entwicklung) * klein, schnell und schlank @@ -923,20 +923,22 @@ Standarderweiterungen: [width="50%",cols="^1,5",options="header"] |======================================== -| Erweit. | Beschreibung -| alias | definiert Alias für Befehle -| aspell | Rechtschreibprüfung für Befehlszeile -| charset | Zeichensatz (de)-kodierung in Buffern -| demo | Demo Erweiterung (nicht standardmäßig kompiliert) -| fifo | FIFO Pipe die zur Fernsteuerung von WeeChat genutzt werden kann -| irc | IRC Chat-Protokoll -| logger | erstellt Protokolldateien von Buffern -| perl | Perl-Skript API -| python | Python-Skript API -| ruby | Ruby-Skript API -| lua | Lua-Skript API -| tcl | Tcl-Skript API -| xfer | Datentransfer und Direktchat +| Erweit. | Beschreibung +| alias | definiert Alias für Befehle +| aspell | Rechtschreibprüfung für Befehlszeile +| charset | Zeichensatz (de)-kodierung in Buffern +| demo | Demo Erweiterung (nicht standardmäßig kompiliert) +| fifo | FIFO Pipe die zur Fernsteuerung von WeeChat genutzt werden kann +| irc | IRC Chat-Protokoll +| logger | erstellt Protokolldateien von Buffern +// TRANSLATION MISSING +| rmodifier | Alter modifier strings with regular expressions +| perl | Perl-Skript API +| python | Python-Skript API +| ruby | Ruby-Skript API +| lua | Lua-Skript API +| tcl | Tcl-Skript API +| xfer | Datentransfer und Direktchat |======================================== [[alias_plugin]] @@ -1564,6 +1566,67 @@ In einer Baumstruktur sieht es dann wie folgt aus: | #chan2.weechatlog ........................................ +// TRANSLATION MISSING +[[rmodifier_plugin]] +Rmodifier plugin +~~~~~~~~~~~~~~~~ + +The Rmodifier plugin lets you alter modifier strings using regular expressions. +Typical use is to hide password when you type them, or when WeeChat saves +them in command history. For example, it is possible to replace each char in +these passwords by "*". + +[[rmodifier_options]] +Options (rmodifier.conf) +^^^^^^^^^^^^^^^^^^^^^^^^ + +include::autogen/user/rmodifier_options.txt[] + +[[rmodifier_commands]] +Commands +^^^^^^^^ + +include::autogen/user/rmodifier_commands.txt[] + +[[rmodifier_creation]] +Rmodifier creation +^^^^^^^^^^^^^^^^^^ + +A rmodifier consists of three elements: + +. one or more "modifiers" +. a regular expression, to capture "groups" +. a string that describes output using number of "groups" captured in regular + expression + +For list of modifiers used by WeeChat or plugins, see +''WeeChat Plugin API Reference', function 'weechat_hook_modifier'. + +For each captured group, following actions are possible: + +* keep group as-is (by using group number) +* replace all chars in group to hide content (group number + "*") +* remove group (if group is not used in string) + +Example of default rmodifier for command `/oper`: + +* modifiers: `history_add,input_text_display` +** `history_add`: called when WeeChat stores command in history +** `input_text_display`: called when command line has changed + (applies only on display, not content of command line) +* regular expression: `^(/oper +\S+ +)(.*)` +* groupes: `1,2*` + +Each time modifiers "history_add" or "input_text_display" are called, regular +expression is checked. If string matches, then it is replaced by captured groups, +as defined in string with groups. + +In this example, we keep number 1 as-is, and we replace all chars of group 2 by +replacement char defined in configuration (option 'rmodifier.look.hide_char'). + +If command line contains: `/oper nick password` then display becomes: +`/oper nick ********`. + [[scripts_plugins]] Skripten Erweiterungen ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/docgen.pl b/doc/docgen.pl index 9ef30bc88..e8409c2af 100644 --- a/doc/docgen.pl +++ b/doc/docgen.pl @@ -63,14 +63,14 @@ my @all_locale_list = qw(en_US fr_FR it_IT de_DE); # if plugin is listed without "c", that means plugin has only one command # /name (where "name" # is name of plugin) # Note: we consider core is a plugin called "weechat" -my %plugin_list = ("weechat" => "co", "alias" => "", - "aspell" => "o", "charset" => "co", - "demo" => "co", "fifo" => "co", - "irc" => "co", "logger" => "co", - "relay" => "co", "perl" => "", - "python" => "", "ruby" => "", - "lua" => "", "tcl" => "", - "xfer" => "co"); +my %plugin_list = ("weechat" => "co", "alias" => "", + "aspell" => "o", "charset" => "co", + "demo" => "co", "fifo" => "co", + "irc" => "co", "logger" => "co", + "relay" => "co", "rmodifier" => "co", + "perl" => "", "python" => "", + "ruby" => "", "lua" => "", + "tcl" => "", "xfer" => "co"); # options to ignore my @ignore_options = ("aspell\\.dict\\..*", @@ -84,6 +84,7 @@ my @ignore_options = ("aspell\\.dict\\..*", "logger\\.level\\..*", "logger\\.mask\\..*", "relay\\.port\\..*", + "rmodifier\\.modifier\\..*", "weechat\\.proxy\\..*", "weechat\\.bar\\..*", "weechat\\.debug\\..*", diff --git a/doc/en/autogen/plugin_api/completions.txt b/doc/en/autogen/plugin_api/completions.txt index d3409e6b6..85dc06699 100644 --- a/doc/en/autogen/plugin_api/completions.txt +++ b/doc/en/autogen/plugin_api/completions.txt @@ -46,6 +46,8 @@ | relay | relay_relays | protocol.name of current relays for relay plugin +| rmodifier | rmodifier | list of rmodifiers + | ruby | ruby_script | list of scripts | tcl | tcl_script | list of scripts diff --git a/doc/en/autogen/plugin_api/infolists.txt b/doc/en/autogen/plugin_api/infolists.txt index c734fc2a4..9eee2fec8 100644 --- a/doc/en/autogen/plugin_api/infolists.txt +++ b/doc/en/autogen/plugin_api/infolists.txt @@ -22,6 +22,8 @@ | relay | relay | list of relay clients | relay pointer (optional) | - +| rmodifier | rmodifier | list of rmodifiers | rmodifier pointer (optional) | rmodifier name (can start or end with "*" as joker) (optional) + | ruby | ruby_script | list of scripts | script pointer (optional) | script name (can start or end with "*" as wildcard) (optional) | tcl | tcl_script | list of scripts | script pointer (optional) | script name (can start or end with "*" as wildcard) (optional) diff --git a/doc/en/autogen/user/rmodifier_commands.txt b/doc/en/autogen/user/rmodifier_commands.txt new file mode 100644 index 000000000..42ef6b896 --- /dev/null +++ b/doc/en/autogen/user/rmodifier_commands.txt @@ -0,0 +1,25 @@ +• *`/rmodifier`* `[list] | [listdefault] | [add name modifiers groups regex] | [del name|-all [name...]] | [default -yes]`:: + +........................................ + alter modifier strings with regular expressions + + list: list all rmodifiers + listdefault: list default rmodifiers + add: add a rmodifier + name: name of rmodifier + modifiers: comma separated list of modifiers + groups: action on groups found: comma separated list of groups (from 1 to 9) with optional "*" after number to hide group + regex: regular expression + del: delete a rmodifier + -all: delete all rmodifiers + default: restore default rmodifiers + + Examples: + hide everything typed after a command /password: + /rmodifier add password input_text_display 1,2* ^(/password +)(.*) + delete rmodifier "password": + /rmodifier del password + delete all rmodifiers: + /rmodifier del -all +........................................ + diff --git a/doc/en/autogen/user/rmodifier_options.txt b/doc/en/autogen/user/rmodifier_options.txt new file mode 100644 index 000000000..358ae2769 --- /dev/null +++ b/doc/en/autogen/user/rmodifier_options.txt @@ -0,0 +1,5 @@ +* *rmodifier.look.hide_char* +** description: char used to hide part of a string +** type: string +** values: any string (default value: "*") + diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt index 854657c9b..88c589e6f 100644 --- a/doc/en/weechat_user.en.txt +++ b/doc/en/weechat_user.en.txt @@ -22,7 +22,7 @@ Features Main features are: -* multi-protocols (IRC and other soon) +* multi-protocols (IRC, Jabber) * multi-servers connection (with SSL, IPv6, proxy) * many GUI: Curses (wxWidgets, Gtk and Qt under development) * small, fast and light @@ -923,20 +923,21 @@ Default plugins are: [width="50%",cols="^1,5",options="header"] |======================================== -| Plugin | Description -| alias | Define alias for commands -| aspell | Spell checking for command line -| charset | Charset decoding/encoding for buffers -| demo | Demo plugin (not compiled by default) -| fifo | FIFO pipe used to remotely send commands to WeeChat -| irc | IRC chat protocol -| logger | Log buffers to files -| perl | Perl scripting API -| python | Python scripting API -| ruby | Ruby scripting API -| lua | Lua scripting API -| tcl | Tcl scripting API -| xfer | File transfer and direct chat +| Plugin | Description +| alias | Define alias for commands +| aspell | Spell checking for command line +| charset | Charset decoding/encoding for buffers +| demo | Demo plugin (not compiled by default) +| fifo | FIFO pipe used to remotely send commands to WeeChat +| irc | IRC chat protocol +| logger | Log buffers to files +| rmodifier | Alter modifier strings with regular expressions +| perl | Perl scripting API +| python | Python scripting API +| ruby | Ruby scripting API +| lua | Lua scripting API +| tcl | Tcl scripting API +| xfer | File transfer and direct chat |======================================== [[alias_plugin]] @@ -1549,6 +1550,66 @@ You'll have following files: | #chan2.weechatlog ........................................ +[[rmodifier_plugin]] +Rmodifier plugin +~~~~~~~~~~~~~~~~ + +The Rmodifier plugin lets you alter modifier strings using regular expressions. +Typical use is to hide password when you type them, or when WeeChat saves +them in command history. For example, it is possible to replace each char in +these passwords by "*". + +[[rmodifier_options]] +Options (rmodifier.conf) +^^^^^^^^^^^^^^^^^^^^^^^^ + +include::autogen/user/rmodifier_options.txt[] + +[[rmodifier_commands]] +Commands +^^^^^^^^ + +include::autogen/user/rmodifier_commands.txt[] + +[[rmodifier_creation]] +Rmodifier creation +^^^^^^^^^^^^^^^^^^ + +A rmodifier consists of three elements: + +. one or more "modifiers" +. a regular expression, to capture "groups" +. a string that describes output using number of "groups" captured in regular + expression + +For list of modifiers used by WeeChat or plugins, see +''WeeChat Plugin API Reference', function 'weechat_hook_modifier'. + +For each captured group, following actions are possible: + +* keep group as-is (by using group number) +* replace all chars in group to hide content (group number + "*") +* remove group (if group is not used in string) + +Example of default rmodifier for command `/oper`: + +* modifiers: `history_add,input_text_display` +** `history_add`: called when WeeChat stores command in history +** `input_text_display`: called when command line has changed + (applies only on display, not content of command line) +* regular expression: `^(/oper +\S+ +)(.*)` +* groupes: `1,2*` + +Each time modifiers "history_add" or "input_text_display" are called, regular +expression is checked. If string matches, then it is replaced by captured groups, +as defined in string with groups. + +In this example, we keep number 1 as-is, and we replace all chars of group 2 by +replacement char defined in configuration (option 'rmodifier.look.hide_char'). + +If command line contains: `/oper nick password` then display becomes: +`/oper nick ********`. + [[scripts_plugins]] Scripts plugins ~~~~~~~~~~~~~~~ diff --git a/doc/fr/autogen/plugin_api/completions.txt b/doc/fr/autogen/plugin_api/completions.txt index 60cae5969..e84b1614f 100644 --- a/doc/fr/autogen/plugin_api/completions.txt +++ b/doc/fr/autogen/plugin_api/completions.txt @@ -46,6 +46,8 @@ | relay | relay_relays | protocole.nom des relais courants pour l'extension relay +| rmodifier | rmodifier | liste des rmodifiers + | ruby | ruby_script | liste des scripts | tcl | tcl_script | liste des scripts diff --git a/doc/fr/autogen/plugin_api/infolists.txt b/doc/fr/autogen/plugin_api/infolists.txt index 9e18f46e3..616d0e2ff 100644 --- a/doc/fr/autogen/plugin_api/infolists.txt +++ b/doc/fr/autogen/plugin_api/infolists.txt @@ -22,6 +22,8 @@ | relay | relay | liste des clients pour le relai | pointeur vers le relay (optionnel) | - +| rmodifier | rmodifier | liste des rmodifiers | pointeur vers le rmodifieur (optionnel) | nom du rmodifier (peut démarrer ou se terminer par "*" comme caractère joker) (optionnel) + | ruby | ruby_script | liste des scripts | pointeur vers le script (optionnel) | nom de script (peut démarrer ou se terminer par "*" comme joker) (optionnel) | tcl | tcl_script | liste des scripts | pointeur vers le script (optionnel) | nom de script (peut démarrer ou se terminer par "*" comme joker) (optionnel) diff --git a/doc/fr/autogen/user/rmodifier_commands.txt b/doc/fr/autogen/user/rmodifier_commands.txt new file mode 100644 index 000000000..6bd1a47aa --- /dev/null +++ b/doc/fr/autogen/user/rmodifier_commands.txt @@ -0,0 +1,25 @@ +• *`/rmodifier`* `[list] | [listdefault] | [add nom modifiers groupes regex] | [del nom|-all [nom...]] | [default -yes]`:: + +........................................ + modifie des chaînes de "modifier" avec des expressions régulières + + list: liste les rmodifiers + listdefault: liste les rmodifiers par défaut + add: ajoute un rmodifier + name: nom du rmodifier + modifiers: liste de modifiers (séparés par une virgule) + groupes: action sur les groupes trouvés: liste de groupes (séparés par une virgule) (de 1 à 9) avec en option "*" après le nombre pour cacher le groupe + regex: expression régulière + del: supprime un rmodifier + -all: supprime tous les rmodifiers + default: restaure les rmodifiers par défaut + + Exemples: + cacher tout ce qui est tapé après la commande /password: + /rmodifier add password input_text_display 1,2* ^(/password +)(.*) + supprimer le rmodifier "password": + /rmodifier del password + supprimer tous les rmodifiers: + /rmodifier del -all +........................................ + diff --git a/doc/fr/autogen/user/rmodifier_options.txt b/doc/fr/autogen/user/rmodifier_options.txt new file mode 100644 index 000000000..5cebb0483 --- /dev/null +++ b/doc/fr/autogen/user/rmodifier_options.txt @@ -0,0 +1,5 @@ +* *rmodifier.look.hide_char* +** description: caractère utilisé pour cacher une partie de la chaîne +** type: chaîne +** valeurs: toute chaîne (valeur par défaut: "*") + diff --git a/doc/fr/weechat_user.fr.txt b/doc/fr/weechat_user.fr.txt index b2317cad9..2dd951186 100644 --- a/doc/fr/weechat_user.fr.txt +++ b/doc/fr/weechat_user.fr.txt @@ -23,7 +23,7 @@ Fonctionnalités Ses principales fonctionnalités sont les suivantes : -* multi-protocoles (IRC et bientôt d'autres) +* multi-protocoles (IRC, Jabber) * connexion multi-serveurs (avec SSL, IPv6, proxy) * plusieurs interfaces : Curses (wxWidgets, Gtk et Qt en développement) * petit, rapide et léger @@ -954,6 +954,7 @@ Les extensions par défaut sont : | fifo | Tube FIFO pour envoyer des commandes à distance vers WeeChat | irc | Discussion avec le protocole IRC | logger | Enregistrement des tampons dans des fichiers +| rmodifier | Modification des chaînes de "modifier" avec des expressions régulières | perl | Interface (API) pour scripts Perl | python | Interface (API) pour scripts Python | ruby | Interface (API) pour scripts Ruby @@ -1594,6 +1595,71 @@ Vous obtiendrez les fichiers suivants : | #chan2.weechatlog ........................................ +[[rmodifier_plugin]] +Extension Rmodifier +~~~~~~~~~~~~~~~~~~~ + +L'extension Rmodifier vous permet de modifier les chaînes de "modifier" avec +des expressions régulières. + +L'utilisation typique est pour cacher les mots de passe lorsque vous les tapez, +ou lorsque WeeChat les sauvegarde dans l'historique des commandes. Il est +possible par exemple de remplacer chaque lettre de ces mots de passe par "*". + +[[rmodifier_options]] +Options (rmodifier.conf) +^^^^^^^^^^^^^^^^^^^^^^^^ + +include::autogen/user/rmodifier_options.txt[] + +[[rmodifier_commands]] +Commandes +^^^^^^^^^ + +include::autogen/user/rmodifier_commands.txt[] + +[[rmodifier_creation]] +Création d'un rmodifier +^^^^^^^^^^^^^^^^^^^^^^^ + +Un rmodifier se compose de trois éléments : + +. un ou plusieurs "modifiers" +. une expression régulière, permettant de capturer des "groupes" +. une chaîne décrivant la sortie en utilisant les numéros de "groupes" capturés + dans l'expression régulière + +Pour la liste des modifiers utilisés par WeeChat ou des extensions, voir la +'Référence API Extension WeeChat', fonction 'weechat_hook_modifier'. + +Pour chaque groupe capturé, les actions suivantes sont possibles : + +* garder le groupe tel quel (en utilisant son numéro) +* remplacer tous les caractères du groupe pour cacher le contenu + (numéro du groupe + "*") +* supprimer le groupe (si le groupe n'est pas utilisé dans la chaîne) + +Exemple du rmodifier par défaut pour la commande `/oper` : + +* modifiers : `history_add,input_text_display` +** `history_add` : appelé lorsque WeeChat stocke la commande dans l'historique +** `input_text_display` : appelé lorsque la ligne de commande a changé + (agit uniquement sur l'affichage, pas le contenu de la ligne de commande) +* expression régulière : `^(/oper +\S+ +)(.*)` +* groupes : `1,2*` + +A chaque fois que les modifiers "history_add" ou "input_text_display" sont +appelés, l'expression régulière est vérifiée. Si la chaîne correspont, alors +elle est remplacée par les groupes capturés, tels que définis dans la chaîne +des groupes. + +Dans cet exemple, on garde le groupe numéro 1 tel quel, et on remplace tous les +caractères du groupe 2 par le caractère de remplacement défini dans la +configuration (option 'rmodifier.look.hide_char'). + +Si la ligne de commande contient : `/oper nick password` alors l'affichage +sera : `/oper nick ********`. + [[scripts_plugins]] Extensions Scripts ~~~~~~~~~~~~~~~~~~ @@ -1650,7 +1716,7 @@ L'extension Xfer permet : [[xfer_options]] Options (xfer.conf) -^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ include::autogen/user/xfer_options.txt[] diff --git a/doc/it/autogen/plugin_api/completions.txt b/doc/it/autogen/plugin_api/completions.txt index 012e2bdcd..69a019619 100644 --- a/doc/it/autogen/plugin_api/completions.txt +++ b/doc/it/autogen/plugin_api/completions.txt @@ -46,6 +46,8 @@ | relay | relay_relays | protocollo.nome dei relay correnti per il plugin relay +| rmodifier | rmodifier | list of rmodifiers + | ruby | ruby_script | elenco degli script | tcl | tcl_script | elenco degli script diff --git a/doc/it/autogen/plugin_api/infolists.txt b/doc/it/autogen/plugin_api/infolists.txt index ee5ae7d9d..f960d8b4c 100644 --- a/doc/it/autogen/plugin_api/infolists.txt +++ b/doc/it/autogen/plugin_api/infolists.txt @@ -22,6 +22,8 @@ | relay | relay | elenco di client relay | puntatore al relay (opzionale) | - +| rmodifier | rmodifier | list of rmodifiers | rmodifier pointer (optional) | rmodifier name (can start or end with "*" as joker) (optional) + | ruby | ruby_script | elenco degli script | puntatore allo script (opzionale) | nome script (può iniziare o terminare con "*" come carattere jolly) (opzionale) | tcl | tcl_script | elenco degli script | puntatore allo script (opzionale) | nome script (può iniziare o terminare con "*" come carattere jolly) (opzionale) diff --git a/doc/it/autogen/user/rmodifier_commands.txt b/doc/it/autogen/user/rmodifier_commands.txt new file mode 100644 index 000000000..42ef6b896 --- /dev/null +++ b/doc/it/autogen/user/rmodifier_commands.txt @@ -0,0 +1,25 @@ +• *`/rmodifier`* `[list] | [listdefault] | [add name modifiers groups regex] | [del name|-all [name...]] | [default -yes]`:: + +........................................ + alter modifier strings with regular expressions + + list: list all rmodifiers + listdefault: list default rmodifiers + add: add a rmodifier + name: name of rmodifier + modifiers: comma separated list of modifiers + groups: action on groups found: comma separated list of groups (from 1 to 9) with optional "*" after number to hide group + regex: regular expression + del: delete a rmodifier + -all: delete all rmodifiers + default: restore default rmodifiers + + Examples: + hide everything typed after a command /password: + /rmodifier add password input_text_display 1,2* ^(/password +)(.*) + delete rmodifier "password": + /rmodifier del password + delete all rmodifiers: + /rmodifier del -all +........................................ + diff --git a/doc/it/autogen/user/rmodifier_options.txt b/doc/it/autogen/user/rmodifier_options.txt new file mode 100644 index 000000000..3206809d7 --- /dev/null +++ b/doc/it/autogen/user/rmodifier_options.txt @@ -0,0 +1,5 @@ +* *rmodifier.look.hide_char* +** descrizione: char used to hide part of a string +** tipo: stringa +** valori: qualsiasi stringa (valore predefinito: "*") + diff --git a/doc/it/weechat_user.it.txt b/doc/it/weechat_user.it.txt index 6c56392b4..1d4ea739d 100644 --- a/doc/it/weechat_user.it.txt +++ b/doc/it/weechat_user.it.txt @@ -23,7 +23,7 @@ Caratteristiche Le caratteristiche principali: -* multi-protocollo (IRC ed altri presto in arrivo) +* multi-protocollo (IRC, Jabber) * connessione a server multipli (con SSL, IPv6, proxy) * molte interfacce: Curses (wxWidgets, Gtk e Qt in fase di sviluppo) * piccolo, veloce e leggero @@ -940,20 +940,22 @@ I plugin predefiniti sono: [width="50%",cols="^1,5",options="header"] |======================================= -| Plugin | Descrizione -| alias | Definisce gli alias per i comandi -| aspell | Controllo ortografico per la riga di comando -| charset | Set di caratteri per la codifica/decodifica nei buffer -| demo | Plugin Demo (non viene compilato per default) -| fifo | pipe FIFO utilizzata per inviare comandi da remoto su WeeChat -| irc | protocollo chat per IRC -| logger | Registra i buffer su file -| perl | API per lo scripting in Perl -| python | API per lo scripting in Python -| ruby | API per lo scripting in Ruby -| lua | API per lo scripting in Lua -| tcl | API per lo scripting in TCL -| xfer | Trasferimento file e chat diretta +| Plugin | Descrizione +| alias | Definisce gli alias per i comandi +| aspell | Controllo ortografico per la riga di comando +| charset | Set di caratteri per la codifica/decodifica nei buffer +| demo | Plugin Demo (non viene compilato per default) +| fifo | pipe FIFO utilizzata per inviare comandi da remoto su WeeChat +| irc | protocollo chat per IRC +| logger | Registra i buffer su file +// TRANSLATION MISSING +| rmodifier | Alter modifier strings with regular expressions +| perl | API per lo scripting in Perl +| python | API per lo scripting in Python +| ruby | API per lo scripting in Ruby +| lua | API per lo scripting in Lua +| tcl | API per lo scripting in TCL +| xfer | Trasferimento file e chat diretta |======================================= [[alias_plugin]] @@ -1585,6 +1587,67 @@ Si avranno i seguenti file: | #canale2.weechatlog ........................................ +// TRANSLATION MISSING +[[rmodifier_plugin]] +Rmodifier plugin +~~~~~~~~~~~~~~~~ + +The Rmodifier plugin lets you alter modifier strings using regular expressions. +Typical use is to hide password when you type them, or when WeeChat saves +them in command history. For example, it is possible to replace each char in +these passwords by "*". + +[[rmodifier_options]] +Options (rmodifier.conf) +^^^^^^^^^^^^^^^^^^^^^^^^ + +include::autogen/user/rmodifier_options.txt[] + +[[rmodifier_commands]] +Commands +^^^^^^^^ + +include::autogen/user/rmodifier_commands.txt[] + +[[rmodifier_creation]] +Rmodifier creation +^^^^^^^^^^^^^^^^^^ + +A rmodifier consists of three elements: + +. one or more "modifiers" +. a regular expression, to capture "groups" +. a string that describes output using number of "groups" captured in regular + expression + +For list of modifiers used by WeeChat or plugins, see +''WeeChat Plugin API Reference', function 'weechat_hook_modifier'. + +For each captured group, following actions are possible: + +* keep group as-is (by using group number) +* replace all chars in group to hide content (group number + "*") +* remove group (if group is not used in string) + +Example of default rmodifier for command `/oper`: + +* modifiers: `history_add,input_text_display` +** `history_add`: called when WeeChat stores command in history +** `input_text_display`: called when command line has changed + (applies only on display, not content of command line) +* regular expression: `^(/oper +\S+ +)(.*)` +* groupes: `1,2*` + +Each time modifiers "history_add" or "input_text_display" are called, regular +expression is checked. If string matches, then it is replaced by captured groups, +as defined in string with groups. + +In this example, we keep number 1 as-is, and we replace all chars of group 2 by +replacement char defined in configuration (option 'rmodifier.look.hide_char'). + +If command line contains: `/oper nick password` then display becomes: +`/oper nick ********`. + [[scripts_plugins]] Plugin per gli script ~~~~~~~~~~~~~~~~~~~~~ |