36 |
|
|
37 |
@title WeeChat - Guia do Utilizador |
@title WeeChat - Guia do Utilizador |
38 |
@subtitle Cliente de IRC rapido, leve e extencivel |
@subtitle Cliente de IRC rapido, leve e extencivel |
39 |
@subtitle Documenta@,{c}@~ao do WeeChat v0.1.6-cvs - 18 de outubro de 2005 |
@subtitle Documenta@,{c}@~ao do WeeChat v0.1.6-cvs - 23 de outubro de 2005 |
40 |
|
|
41 |
@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> |
@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}> |
42 |
|
|
263 |
@item look_weechat_slogan |
@item look_weechat_slogan |
264 |
WeeChat slogan (if empty, slogan is not used)@* |
WeeChat slogan (if empty, slogan is not used)@* |
265 |
Type: string (any string), default value: 'the geekest IRC client!'@* |
Type: string (any string), default value: 'the geekest IRC client!'@* |
266 |
@item look_charset_decode |
@item look_charset_decode_iso |
267 |
Charset for decoding messages from server, examples: UTF-8, ISO-8859-1 (if empty, messages are not converted)@* |
ISO charset for decoding messages from server (used only if locale is UTF-8) (if empty, messages are not converted if locale is UTF-8@* |
268 |
|
Type: string (any string), default value: 'ISO-8859-1'@* |
269 |
|
@item look_charset_decode_utf |
270 |
|
UTF charset for decoding messages from server (used only if locale is not UTF-8) (if empty, messages are not converted if locale is not UTF-8@* |
271 |
Type: string (any string), default value: 'UTF-8'@* |
Type: string (any string), default value: 'UTF-8'@* |
272 |
@item look_charset_encode |
@item look_charset_encode |
273 |
Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, local charset is used)@* |
Charset for encoding messages sent to server, examples: UFT-8, ISO-8859-1 (if empty, messages are not converted)@* |
274 |
Type: string (any string), default value: ''@* |
Type: string (any string), default value: ''@* |
275 |
@item look_charset_internal |
@item look_charset_internal |
276 |
Internal WeeChat charset, should be ISO-xxxx even if locale is UTF-8 (if empty, local charset is used)@* |
Forces internal WeeChat charset (should be empty in most cases, that means detected charset is used)@* |
277 |
Type: string (any string), default value: 'ISO-8859-1'@* |
Type: string (any string), default value: ''@* |
278 |
@item look_buffer_timestamp |
@item look_buffer_timestamp |
279 |
Timestamp for buffers@* |
Timestamp for buffers@* |
280 |
Type: string (any string), default value: '[%H:%M:%S]'@* |
Type: string (any string), default value: '[%H:%M:%S]'@* |
436 |
Type: color (Curses or Gtk color), default value: 'lightcyan'@* |
Type: color (Curses or Gtk color), default value: 'lightcyan'@* |
437 |
@item col_input_delimiters |
@item col_input_delimiters |
438 |
Color for input text (delimiters)@* |
Color for input text (delimiters)@* |
439 |
Type: color (Curses or Gtk color), default value: 'lightgreen'@* |
Type: color (Curses or Gtk color), default value: 'white'@* |
440 |
@item col_input_bg |
@item col_input_bg |
441 |
Background for input window@* |
Background for input window@* |
442 |
Type: color (Curses or Gtk color), default value: 'default'@* |
Type: color (Curses or Gtk color), default value: 'default'@* |
599 |
@item dcc_blocksize |
@item dcc_blocksize |
600 |
Block size for dcc packets in bytes (default: 65536)@* |
Block size for dcc packets in bytes (default: 65536)@* |
601 |
Type: integer (values: between 1024 and 102400), default value: 65536@* |
Type: integer (values: between 1024 and 102400), default value: 65536@* |
602 |
|
@item dcc_port_range |
603 |
|
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)@* |
604 |
|
Type: string (any string), default value: ''@* |
605 |
|
@item dcc_own_ip |
606 |
|
IP or DNS address used for outgoing dcc (if empty, local interface IP is used)@* |
607 |
|
Type: string (any string), default value: ''@* |
608 |
@item dcc_download_path |
@item dcc_download_path |
609 |
Path for writing incoming files with dcc (default: user home)@* |
Path for writing incoming files with dcc (default: user home)@* |
610 |
Type: string (any string), default value: '~'@* |
Type: string (any string), default value: '~'@* |
985 |
For each argument, '*' means all.@* |
For each argument, '*' means all.@* |
986 |
Without argument, /unignore command lists all defined ignore.@* |
Without argument, /unignore command lists all defined ignore.@* |
987 |
@* |
@* |
988 |
@item window [list | splith | splitv | [merge [down | up | left | right | all]]] |
@item window [list | -1 | +1 | b# | splith | splitv | [merge [down | up | left | right | all]]] |
989 |
@* |
@* |
990 |
manage windows@* |
manage windows@* |
991 |
@* |
@* |
992 |
list: list opened windows (no parameter implies this list)@* |
list: list opened windows (no parameter implies this list)@* |
993 |
|
-1: jump to previous window@* |
994 |
|
+1: jump to next window@* |
995 |
|
b#: jump to next window displaying buffer number #@* |
996 |
splith: split current window horizontally@* |
splith: split current window horizontally@* |
997 |
splitv: split current window vertically@* |
splitv: split current window vertically@* |
998 |
merge: merge window with another@* |
merge: merge window with another@* |
1532 |
@* |
@* |
1533 |
The plugin has to be a dynamic library, for dynamic loading by |
The plugin has to be a dynamic library, for dynamic loading by |
1534 |
operating system. |
operating system. |
1535 |
Under GNU/Linux, the file has ``.so'' extension. |
Under GNU/Linux, the file has ``.so'' extension, ``.dll'' under |
1536 |
|
Windows. |
1537 |
|
|
1538 |
@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins |
@node Write a plugin, Plugin example, Plugins in WeeChat, Plugins |
1539 |
@section Write a plugin |
@section Write a plugin |
1562 |
|
|
1563 |
@subsection API functions |
@subsection API functions |
1564 |
|
|
1565 |
The plugin can call some functions defined in t_weechat_plugin structure.@* |
The plugin can call some functions defined in t_weechat_plugin |
1566 |
These functions are detailed below: |
structure.@* |
1567 |
|
@* |
1568 |
|
These functions are detailed below:@* |
1569 |
|
|
1570 |
@itemize @bullet |
@itemize @bullet |
1571 |
@item |
@item |
1589 |
@emph{Example:}@* |
@emph{Example:}@* |
1590 |
@* |
@* |
1591 |
@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* |
@code{if (plugin->ascii_strcasecmp (plugin, "abc", "def") != 0) ...}@* |
1592 |
|
@* |
1593 |
|
|
1594 |
|
@item |
1595 |
|
@command{int ascii_strncasecmp (t_weechat_plugin *plugin, |
1596 |
|
char *string1, char *string2, int max)}@* |
1597 |
|
@* |
1598 |
|
locale and case independent string comparison, for ``max'' chars.@* |
1599 |
|
|
1600 |
|
@emph{Arguments:} |
1601 |
|
@itemize @minus |
1602 |
|
@item @option{plugin}: pointer to plugin structure |
1603 |
|
@item @option{string1}: first string for comparison |
1604 |
|
@item @option{string2}: second string for comparison |
1605 |
|
@item @option{max}: max number of chars for comparison |
1606 |
|
@end itemize |
1607 |
|
@* |
1608 |
|
@emph{Return value:}@* |
1609 |
|
@* |
1610 |
|
Difference between two strings: negative if chaine1 < chaine2, |
1611 |
|
nul if chaine1 == chaine 2, positive if chaine1 > chaine2@* |
1612 |
|
@* |
1613 |
|
@emph{Example:}@* |
1614 |
|
@* |
1615 |
|
@code{if (plugin->ascii_strncasecmp (plugin, "abc", "def", 2) != 0) ...}@* |
1616 |
@* |
@* |
1617 |
|
|
1618 |
@item |
@item |
2090 |
|
|
2091 |
Full example of plugin, which adds a /double command, which displays |
Full example of plugin, which adds a /double command, which displays |
2092 |
two times arguments on current channel (ok that's not very useful, but |
two times arguments on current channel (ok that's not very useful, but |
2093 |
that's just an example!): |
that's just an example!):@* |
2094 |
|
|
2095 |
@verbatim |
@verbatim |
2096 |
#include <stdlib.h> |
#include <stdlib.h> |
2289 |
@* |
@* |
2290 |
|
|
2291 |
@item |
@item |
2292 |
@command{weechat::get_info ( nome, [servidor] );}@* |
@command{weechat::get_info ( nome, [servidor, [canal] ] );}@* |
2293 |
@* |
@* |
2294 |
Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@* |
Comece o v@'ario info sobre WeeChat, servidor ou usu@'ario.@* |
2295 |
|
|
2307 |
@item @option{weechat_sharedir}: get WeeChat system share dir |
@item @option{weechat_sharedir}: get WeeChat system share dir |
2308 |
@end itemize |
@end itemize |
2309 |
@item @option{servidor}: nome interno da servidor |
@item @option{servidor}: nome interno da servidor |
2310 |
|
@item @option{canal}: nome da canal |
2311 |
@end itemize |
@end itemize |
2312 |
@* |
@* |
2313 |
@emph{Exemplos:}@* |
@emph{Exemplos:}@* |