summaryrefslogtreecommitdiff
path: root/doc/weechat_doc_en.texi
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2005-12-16 14:16:03 +0000
committerSebastien Helleu <flashcode@flashtux.org>2005-12-16 14:16:03 +0000
commitd5b58ff068c601906c83524b91b7d5aea666faa0 (patch)
tree6d9f81116be9b339ba3a2e695c4bb67f374da70d /doc/weechat_doc_en.texi
parent6eabc3aa61c7f0d6be44c2d9e88a8611ff0cc9f3 (diff)
downloadweechat-d5b58ff068c601906c83524b91b7d5aea666faa0.zip
Added completion system for plugins/scripts commands, fixed plugins autoload
Diffstat (limited to 'doc/weechat_doc_en.texi')
-rw-r--r--doc/weechat_doc_en.texi90
1 files changed, 77 insertions, 13 deletions
diff --git a/doc/weechat_doc_en.texi b/doc/weechat_doc_en.texi
index 4d332f836..115c46c05 100644
--- a/doc/weechat_doc_en.texi
+++ b/doc/weechat_doc_en.texi
@@ -35,7 +35,7 @@
@title WeeChat - User guide
@subtitle Fast, light and extensible IRC client
-@subtitle Documentation for WeeChat v0.1.7-cvs - December, 15 2005
+@subtitle Documentation for WeeChat v0.1.7-cvs - December, 16 2005
@author FlashCode <@email{flashcode@@flashtux.org, flashcode AT flashtux.org}>
@@ -1525,18 +1525,14 @@ call next command in global history@*
scroll one page up@*
@item page_down
scroll one page down@*
-@item infobar_clear
-clear infobar@*
-@item nick_page_up
-scroll nicklist one page up@*
-@item nick_page_down
-scroll nicklist one page down@*
@item nick_beginning
display beginning of nicklist@*
@item nick_end
display end of nicklist@*
-@item refresh
-refresh screen@*
+@item nick_page_up
+scroll nicklist one page up@*
+@item nick_page_down
+scroll nicklist one page down@*
@item jump_smart
jump to buffer with activity@*
@item jump_dcc
@@ -1547,8 +1543,20 @@ jump to last buffer@*
jump to server buffer@*
@item jump_next_server
jump to next server@*
+@item switch_server
+switch active server on servers buffer@*
+@item scroll_previous_highlight
+scroll to previous highlight in buffer@*
+@item scroll_next_highlight
+scroll to next highlight in buffer@*
+@item scroll_unread
+scroll to first unread line in buffer@*
@item hotlist_clear
clear hotlist@*
+@item infobar_clear
+clear infobar@*
+@item refresh
+refresh screen@*
@item grab_key
grab a key@*
@end table
@@ -1920,8 +1928,9 @@ WeeChat neither other plugins
@item
@command{t_plugin_handler *cmd_handler_add (t_weechat_plugin
*plugin, char *command, char *description, char *arguments,
-char *arguments_description, t_plugin_handler_func *handler_func,
-char *handler_args, void *handler_pointer)}@*
+char *arguments_description, char *completion_template,
+t_plugin_handler_func *handler_func, char *handler_args,
+void *handler_pointer)}@*
@*
Add a WeeChat command handler, called when user uses command
(for example /command).@*
@@ -1936,6 +1945,32 @@ command)
(displayed by /help command)
@item @option{arguments_description}: long description of command
arguments (displayed by /help command)
+@item @option{completion_template}: template for completion, like
+@code{abc|%w def|%i} which means ``abc'' or a WeeChat command
+for first argument, and ``def'' or IRC command for second.@*
+Following codes can be used:
+@itemize @minus
+@item @code{%-}: no completion for argument
+@item @code{%a}: alias
+@item @code{%A}: alias and commands (WeeChat, IRC and plugins)
+@item @code{%c}: current channel
+@item @code{%C}: channels of current server
+@item @code{%f}: filename
+@item @code{%h}: plugins commands
+@item @code{%i}: IRC commands (sent)
+@item @code{%I}: IRC commands (received)
+@item @code{%k}: keys
+@item @code{%n}: nicks of current channel
+@item @code{%o}: setup option
+@item @code{%p}: default ``part'' message
+@item @code{%q}: default ``quit'' message
+@item @code{%s}: current server name
+@item @code{%S}: all servers names
+@item @code{%t}: topic of current channel
+@item @code{%v}: setup option value
+@item @code{%w}: WeeChat commands
+@item @code{%y}: default ``away'' message
+@end itemize
@item @option{handler_func}: function called when comand is executed
@item @option{handler_args}: arguments given to function when called
@item @option{handler_pointer}: pointer given to function when called
@@ -2274,6 +2309,7 @@ int weechat_plugin_init (t_weechat_plugin *plugin)
"Display two times a message",
"msg",
"msg: message",
+ NULL,
&toto_cmd_double,
NULL, NULL);
return PLUGIN_RC_OK;
@@ -2468,9 +2504,11 @@ WeeChat neither other plugins
@item
Perl: @command{weechat::add_command_handler ( name, function,
-[description, arguments, arguments_description] );}@*
+[description, arguments, arguments_description,
+completion_template] );}@*
Python: @command{weechat.add_command_handler ( name, function,
-[description, arguments, arguments_description] )}@*
+[description, arguments, arguments_description,
+completion_template] )}@*
@*
Create new WeeChat command, linked with script function.@*
Function will be called when user will launch command with @kbd{/name}.@*
@@ -2488,6 +2526,32 @@ command)
(displayed by /help command)
@item @option{arguments_description}: long description of command
arguments (displayed by /help command)
+@item @option{completion_template}: template for completion, like
+@code{abc|%w def|%i} which means ``abc'' or a WeeChat command
+for first argument, and ``def'' or IRC command for second.@*
+Following codes can be used:
+@itemize @minus
+@item @code{%-}: no completion for argument
+@item @code{%a}: alias
+@item @code{%A}: alias and commands (WeeChat, IRC and plugins)
+@item @code{%c}: current channel
+@item @code{%C}: channels of current server
+@item @code{%f}: filename
+@item @code{%h}: plugins commands
+@item @code{%i}: IRC commands (sent)
+@item @code{%I}: IRC commands (received)
+@item @code{%k}: keys
+@item @code{%n}: nicks of current channel
+@item @code{%o}: setup option
+@item @code{%p}: default ``part'' message
+@item @code{%q}: default ``quit'' message
+@item @code{%s}: current server name
+@item @code{%S}: all servers names
+@item @code{%t}: topic of current channel
+@item @code{%v}: setup option value
+@item @code{%w}: WeeChat commands
+@item @code{%y}: default ``away'' message
+@end itemize
@end itemize
@*
@emph{Return value:}@*