diff --git a/doc/de/Makefile.am b/doc/de/Makefile.am index 35741d472..bc97f7ba5 100644 --- a/doc/de/Makefile.am +++ b/doc/de/Makefile.am @@ -18,39 +18,29 @@ LANGCODE = de BOOK_AUTOGEN_INCLUDE = ../include_autogen.xml \ autogen/alias_commands.xml \ - autogen/alias_infos.xml \ autogen/aspell_commands.xml \ autogen/aspell_options.xml \ autogen/charset_commands.xml \ autogen/charset_options.xml \ autogen/completions.xml \ autogen/demo_commands.xml \ - autogen/fifo_infos.xml \ autogen/irc_commands.xml \ - autogen/irc_infos.xml \ autogen/irc_options.xml \ + autogen/infos.xml \ + autogen/infolists.xml \ autogen/jabber_commands.xml \ - autogen/jabber_infos.xml \ autogen/jabber_options.xml \ autogen/logger_commands.xml \ - autogen/logger_infos.xml \ autogen/logger_options.xml \ autogen/lua_commands.xml \ - autogen/lua_infos.xml \ autogen/notify_commands.xml \ autogen/perl_commands.xml \ - autogen/perl_infos.xml \ autogen/python_commands.xml \ - autogen/python_infos.xml \ autogen/ruby_commands.xml \ - autogen/ruby_infos.xml \ autogen/tcl_commands.xml \ - autogen/tcl_infos.xml \ autogen/weechat_commands.xml \ - autogen/weechat_infos.xml \ autogen/weechat_options.xml \ autogen/xfer_commands.xml \ - autogen/xfer_infos.xml \ autogen/xfer_options.xml BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ diff --git a/doc/de/autogen/alias_infos.xml b/doc/de/autogen/alias_infos.xml deleted file mode 100644 index cee87effa..000000000 --- a/doc/de/autogen/alias_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - alias - list of alias - diff --git a/doc/de/autogen/fifo_infos.xml b/doc/de/autogen/fifo_infos.xml deleted file mode 100644 index 916a40236..000000000 --- a/doc/de/autogen/fifo_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - info - fifo_filename - name of FIFO pipe - diff --git a/doc/de/autogen/infolists.xml b/doc/de/autogen/infolists.xml new file mode 100644 index 000000000..c80b8c298 --- /dev/null +++ b/doc/de/autogen/infolists.xml @@ -0,0 +1,133 @@ + + + + + alias + alias + list of alias + + + irc + irc_channel + list of channels for an IRC server + + + irc + irc_ignore + list of IRC ignore + + + irc + irc_nick + list of nicks for an IRC channel + + + irc + irc_server + list of IRC servers + + + logger + logger_buffer + list of logger buffers + + + lua + lua_script + list of lua scripts + + + perl + perl_script + list of perl scripts + + + python + python_script + list of python scripts + + + relay + relay + list of relay clients + + + ruby + ruby_script + list of ruby scripts + + + tcl + tcl_script + list of tcl scripts + + + weechat + bar + list of bars + + + weechat + bar_item + list of bar items + + + weechat + bar_window + list of bar windows + + + weechat + buffer + list of buffers + + + weechat + buffer_lines + lines of a buffer + + + weechat + filter + list of filters + + + weechat + hook + list of hooks + + + weechat + hotlist + list of buffers in hotlist + + + weechat + nicklist + nicks in nicklist for a buffer + + + weechat + option + list of options + + + weechat + plugin + list of plugins + + + weechat + window + list of windows + + + xfer + xfer + list of xfer + diff --git a/doc/de/autogen/infos.xml b/doc/de/autogen/infos.xml new file mode 100644 index 000000000..fb303729d --- /dev/null +++ b/doc/de/autogen/infos.xml @@ -0,0 +1,88 @@ + + + + + fifo + fifo_filename + name of FIFO pipe + + + irc + irc_buffer + get buffer pointer for an IRC server/channel + + + irc + irc_is_channel + 1 if string is an IRC channel + + + irc + irc_nick + get current nick on a server + + + irc + irc_nick_from_host + get nick from IRC host + + + weechat + charset_internal + WeeChat internal charset + + + weechat + charset_terminal + terminal charset + + + weechat + date + WeeChat compilation date + + + weechat + dir_separator + directory separator + + + weechat + filters_enabled + 1 if filters are enabled + + + weechat + inactivity + keyboard inactivity (seconds) + + + weechat + version + WeeChat version + + + weechat + weechat_dir + WeeChat directory + + + weechat + weechat_libdir + WeeChat "lib" directory + + + weechat + weechat_localedir + WeeChat "locale" directory + + + weechat + weechat_sharedir + WeeChat "share" directory + diff --git a/doc/de/autogen/irc_infos.xml b/doc/de/autogen/irc_infos.xml deleted file mode 100644 index 8f8753ce5..000000000 --- a/doc/de/autogen/irc_infos.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - info - irc_buffer - get buffer pointer for an IRC server/channel - - - info - irc_is_channel - 1 if string is an IRC channel - - - info - irc_nick - get current nick on a server - - - info - irc_nick_from_host - get nick from IRC host - - - infolist - irc_channel - list of channels for an IRC server - - - infolist - irc_ignore - list of IRC ignore - - - infolist - irc_nick - list of nicks for an IRC channel - - - infolist - irc_server - list of IRC servers - diff --git a/doc/de/autogen/jabber_infos.xml b/doc/de/autogen/jabber_infos.xml deleted file mode 100644 index 1bf578e87..000000000 --- a/doc/de/autogen/jabber_infos.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - info - jabber_buffer - get buffer pointer for a Jabber server/MUC - - - infolist - jabber_buddy - list of buddies for a Jabber server or MUC - - - infolist - jabber_muc - list of MUCs for a Jabber server - - - infolist - jabber_server - list of Jabber servers - diff --git a/doc/de/autogen/logger_infos.xml b/doc/de/autogen/logger_infos.xml deleted file mode 100644 index bf249d045..000000000 --- a/doc/de/autogen/logger_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - logger_buffer - list of logger buffers - diff --git a/doc/de/autogen/lua_infos.xml b/doc/de/autogen/lua_infos.xml deleted file mode 100644 index 0cbd17c46..000000000 --- a/doc/de/autogen/lua_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - lua_script - liste des scripts lua - diff --git a/doc/de/autogen/perl_infos.xml b/doc/de/autogen/perl_infos.xml deleted file mode 100644 index 76d6614a2..000000000 --- a/doc/de/autogen/perl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - perl_script - liste des scripts perl - diff --git a/doc/de/autogen/python_infos.xml b/doc/de/autogen/python_infos.xml deleted file mode 100644 index 5522e371e..000000000 --- a/doc/de/autogen/python_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - python_script - liste des scripts python - diff --git a/doc/de/autogen/relay_infos.xml b/doc/de/autogen/relay_infos.xml deleted file mode 100644 index eb979c513..000000000 --- a/doc/de/autogen/relay_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - relay - list of relay clients - diff --git a/doc/de/autogen/ruby_infos.xml b/doc/de/autogen/ruby_infos.xml deleted file mode 100644 index 8f4374da6..000000000 --- a/doc/de/autogen/ruby_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - ruby_script - liste des scripts ruby - diff --git a/doc/de/autogen/tcl_infos.xml b/doc/de/autogen/tcl_infos.xml deleted file mode 100644 index 47e5275eb..000000000 --- a/doc/de/autogen/tcl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - tcl_script - liste des scripts tcl - diff --git a/doc/de/autogen/weechat_infos.xml b/doc/de/autogen/weechat_infos.xml deleted file mode 100644 index a0e9108e8..000000000 --- a/doc/de/autogen/weechat_infos.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - info - charset_internal - WeeChat internal charset - - - info - charset_terminal - terminal charset - - - info - date - WeeChat compilation date - - - info - dir_separator - directory separator - - - info - filters_enabled - 1 if filters are enabled - - - info - inactivity - keyboard inactivity (seconds) - - - info - version - WeeChat version - - - info - weechat_dir - WeeChat directory - - - info - weechat_libdir - WeeChat "lib" directory - - - info - weechat_localedir - WeeChat "locale" directory - - - info - weechat_sharedir - WeeChat "share" directory - - - infolist - bar - list of bars - - - infolist - bar_item - list of bar items - - - infolist - bar_window - list of bar windows - - - infolist - buffer - list of buffers - - - infolist - buffer_lines - lines of a buffer - - - infolist - filter - list of filters - - - infolist - hook - list of hooks - - - infolist - hotlist - list of buffers in hotlist - - - infolist - nicklist - nicks in nicklist for a buffer - - - infolist - option - list of options - - - infolist - plugin - list of plugins - - - infolist - window - list of windows - diff --git a/doc/de/autogen/xfer_infos.xml b/doc/de/autogen/xfer_infos.xml deleted file mode 100644 index 0a67e3420..000000000 --- a/doc/de/autogen/xfer_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - xfer - list of xfer - diff --git a/doc/de/dev/plugin_c_api.de.xml b/doc/de/dev/plugin_c_api.de.xml index e04330536..b236c30ae 100644 --- a/doc/de/dev/plugin_c_api.de.xml +++ b/doc/de/dev/plugin_c_api.de.xml @@ -546,7 +546,7 @@ int weechat_string_match ( - Check if a string matches a mask. Mask may begin or end with "*" (no + Check if a string matches a mask. Mask can begin or end with "*" (no other "*" are allowed inside mask). @@ -2227,7 +2227,7 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Example: - weechat_list_set (item, "new data");/ + weechat_list_set (item, "new data"); @@ -2259,7 +2259,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Example: - struct t_weelist_item *next_item = weechat_list_next_item (item);/ + struct t_weelist_item *next_item = weechat_list_next_item (item); @@ -2291,7 +2291,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Example: - struct t_weelist_item *prev_item = weechat_list_prev_item (item);/ + struct t_weelist_item *prev_item = weechat_list_prev_item (item); @@ -2322,7 +2322,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Example: - char *value = weechat_list_string (item);/ + char *value = weechat_list_string (item); @@ -2353,7 +2353,7 @@ char *weechat_list_size (struct t_weelist *weelist); Example: - int size = weechat_list_size (list);/ + int size = weechat_list_size (list); @@ -2388,7 +2388,7 @@ void weechat_list_remove ( Example: - weechat_list_remove (list, item);/ + weechat_list_remove (list, item); @@ -2416,7 +2416,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Example: - weechat_list_remove_all (list);/ + weechat_list_remove_all (list); @@ -2444,7 +2444,7 @@ void weechat_list_free (struct t_weelist *weelist); Example: - weechat_list_free (list);/ + weechat_list_free (list); @@ -2487,7 +2487,7 @@ struct t_config_file *weechat_config_new ( : callback called when - configuration file is reloaded with /reload (optional, may be + configuration file is reloaded with /reload (optional, can be NULL), arguments: @@ -4727,7 +4727,7 @@ const char *weechat_color (const char *color_name); - : name of color: may be a WeeChat + : name of color: can be a WeeChat color name (from weechat.color.xxx), a color with optional background (separated by comma), attribute ("bold", "-bold", "reverse", "-reverse", "italic", "-italic", "underline", @@ -8944,84 +8944,25 @@ const char *weechat_info_get (const char *info_name, - Get info from WeeChat or other plugin. + Get info from WeeChat or a plugin. Arguments: - : info name to read, from WeeChat - core or other plugin (see plugin doc for infos returned by - each plugin). WeeChat core infos are: + : name of info to read: - Info + Plugin + Name Description - Example - - version - WeeChat version - 0.2.7 - - - date - WeeChat compilation date - Dec 25 2008 - - - dir_separator - - directory separator: "/" under GNU/Linux, "\" under - MS-Windows - - / - - - weechat_dir - WeeChat home directory - /home/login/.weechat - - - weechat_libdir - WeeChat lib directory - /usr/lib/weechat - - - weechat_sharedir - WeeChat share directory - /usr/share/weechat - - - weechat_localedir - WeeChat locale directory - /usr/share/locale - - - charset_terminal - terminal charset - UTF-8 - - - charset_internal - internal WeeChat charset (always "UTF-8") - UTF-8 - - - inactivity - keyboard inactivity (in seconds) - 12 - - - filters_enabled - 1 if filters are enabled, otherwise 0 - 1 - + &infos.xml; @@ -9058,13 +8999,794 @@ weechat_printf (NULL, "WeeChat home is: %s", Infolists - Functions for infolists. + Functions to get infolists. - Missing doc! + An infolist is a list of "items". Each item contains variables. + For example, infolist "irc_server" has N items (N is number of IRC + servers defined). For each item, there is variables like "name", + "buffer", "is_connected", ... + Each variable has a type and a value. Possible types are: + + + + + Type + Description + + + + + integer + any integer value + + + string + any string value + + + pointer + any pointer + + + buffer + buffer with fixed length, containing any data + + + time + time value + + + + +
+ weechat_infolist_new + + + Prototype: + +struct t_infolist *weechat_infolist_new (); + + + + Create a new infolist. + + + Return value: pointer to new infolist. + + + Example: + struct t_infolist *infolist = weechat_infolist_new (); + +
+ +
+ weechat_infolist_new_item + + + Prototype: + +struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); + + + + Add an item in an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: pointer to new item. + + + Example: + +struct t_infolist_item *item = weechat_infolist_new_item (infolist); + + +
+ +
+ weechat_infolist_new_var_integer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_integer ( + struct t_infolist_item *item, + const char *name, + int value); + + + + Add an integer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : integer value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_integer (item, "my_integer", 123); + + +
+ +
+ weechat_infolist_new_var_string + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_string ( + struct t_infolist_item *item, + const char *name, + const char *value); + + + + Add a string variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : string value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_string (item, "my_string", "value here"); + + +
+ +
+ weechat_infolist_new_var_pointer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_pointer ( + struct t_infolist_item *item, + const char *name, + void *pointer); + + + + Add a pointer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_pointer (item, "my_pointer", &something); + + +
+ +
+ weechat_infolist_new_var_buffer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_buffer ( + struct t_infolist_item *item, + const char *name, + void *pointer, + int size); + + + + Add a buffer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer to buffer + + + + + : size of buffer + + + + + + Return value: pointer to new variable. + + + Example: + +char buffer[256]; +/* ... */ +struct t_infolist_var *var = + weechat_infolist_new_variable_buffer (item, "my_buffer", + &buffer, sizeof (buffer)); + + +
+ +
+ weechat_infolist_new_var_time + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_time ( + struct t_infolist_item *item, + const char *name, + time_t time); + + + + Add a time variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : time value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_time (item, "my_time", time (NULL)); + + +
+ +
+ weechat_infolist_get + + + Prototype: + +struct t_infolist *weechat_infolist_get (const char *infolist_name, + void *pointer, + const char *arguments); + + + + Get infolist from WeeChat or a plugin. + + + Arguments: + + + + : name of infolist to read: + + + + + Plugin + Name + Description + + + + &infolists.xml; + + + + + + + + : pointer to an item, to get only this + item in infolist (optional, can be NULL) + + + + + : name/type of item to retrieve + (optional, can be NULL) + + + + + + Return value: pointer to infolist, NULL if an error occured. + + + Example: + +struct t_infolist *infolist = weechat_infolist_get ("irc_server", NULL, NULL); + + +
+ +
+ weechat_infolist_next + + + Prototype: + +int weechat_infolist_next (struct t_infolist *infolist); + + + + Move "cursor" to next item in an infolist. The first call to this + function for an infolist moves cursor to first item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on next item, 0 if end of list was + reached. + + + Example: + +if (weechat_infolist_next (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_prev + + + Prototype: + +int weechat_infolist_prev (struct t_infolist *infolist); + + + + Move "cursor" to previous item in an infolist. The first call to this + function for an infolist moves cursor to last item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on previous item, 0 if beginning of + list was reached. + + + Example: + +if (weechat_infolist_prev (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_reset_item_cursor + + + Prototype: + +void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); + + + + Reset "cursor" for infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: weechat_infolist_reset_item_cursor (infolist); + +
+ +
+ weechat_infolist_fields + + + Prototype: + +const char *weechat_infolist_fields (struct t_infolist *infolist); + + + + Get list of fields for current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: string with list of fields for current infolist item. + List is comma separated, and contains letter for type, followed by + variable name. Types are: "i" (integer), "s" (string), "p" (pointer), + "b" (buffer), "t" (time). + + + Example: + +const char *fields = weechat_infolist_fields (infolist); +/* fields contains something like: + "i:my_integer,s:my_string,p:my_pointer,b:my_buffer,t:my_time" */ + + +
+ +
+ weechat_infolist_integer + + + Prototype: + +int weechat_infolist_integer (struct t_infolist *infolist, + const char *var); + + + + Get value of integer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "integer") + + + + + + Return value: integer value of variable. + + + Example: + +weechat_printf (NULL, "integer value = %d", + weechat_infolist_integer (infolist, "my_integer")); + + +
+ +
+ weechat_infolist_string + + + Prototype: + +const char *weechat_infolist_string (struct t_infolist *infolist, + const char *var); + + + + Get value of string variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "string") + + + + + + Return value: string value of variable. + + + Example: + +weechat_printf (NULL, "string value = %s", + weechat_infolist_string (infolist, "my_string")); + + +
+ +
+ weechat_infolist_pointer + + + Prototype: + +void *weechat_infolist_pointer (struct t_infolist *infolist, + const char *var); + + + + Get value of pointer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "pointer") + + + + + + Return value: pointer value of variable. + + + Example: + +weechat_printf (NULL, "pointer value = 0x%lx", + weechat_infolist_pointer (infolist, "my_pointer")); + + +
+ +
+ weechat_infolist_buffer + + + Prototype: + +void *weechat_infolist_buffer (struct t_infolist *infolist, + const char *var, + int *size); + + + + Get value of buffer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "buffer") + + + + + : pointer to integer variable, will be set + with buffer size + + + + + + Return value: buffer pointer. + + + Example: + +int size; +void *pointer = weechat_infolist_buffer (infolist, "my_buffer", &size); +weechat_printf (NULL, "buffer pointer = 0x%lx, size = %d", + pointer, size); + + +
+ +
+ weechat_infolist_time + + + Prototype: + +time_t weechat_infolist_time (struct t_infolist *infolist, + const char *var); + + + + Get value of time variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "time") + + + + + + Return value: time value of variable. + + + Example: + +weechat_printf (NULL, "time value = 0x%ld", + weechat_infolist_time (infolist, "my_time")); + + +
+ +
+ weechat_infolist_free + + + Prototype: + +void weechat_infolist_free (struct t_weelist *weelist); + + + + Free an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: + weechat_infolist_free (infolist); + +
+ @@ -9076,3041 +9798,170 @@ weechat_printf (NULL, "WeeChat home is: %s", Functions for WeeChat upgrading. - - Missing doc! - +
+ weechat_upgrade_new + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_new (const char *filename, + int write); + + + + Create or read a file for upgrade. + + + Arguments: + + + + : name of file (extension ".upgrade" + will be added to this name by WeeChat) + + + : 1 to create file (write mode, before + upgrade), 0 to read file (after upgrade) + + + + + + Return value: pointer to new upgrade file. + + + Example: + +struct t_upgrade_file *upgrade_file = weechat_upgrade_new ("my_file"); + + +
- - - - - - - - - - - - - - - - +
+ weechat_upgrade_write_object + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_write_object ( + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist); + + + + Write an object in upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : id for object + + + : infolist to write in file + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +weechat_upgrade_write_object (upgrade_file, 1, &infolist); + + +
+ +
+ weechat_upgrade_read + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_read ( + struct t_upgrade_file *upgrade_file, + int (*callback_read)(void *data, + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist), + void *callback_read_data); + + + + Read an upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : callback called for each object + read in upgrade file + + + : pointer given to read + callback when it is called by WeeChat + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +int +my_upgrade_read_cb (struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist) +{ + /* read variables... */ + return WEECHAT_RC_OK; +} - - -
diff --git a/doc/de/user/plugin_alias.de.xml b/doc/de/user/plugin_alias.de.xml index 3ae902955..fef4d85f6 100644 --- a/doc/de/user/plugin_alias.de.xml +++ b/doc/de/user/plugin_alias.de.xml @@ -39,26 +39,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &alias_infos.xml; - - - - - -
- diff --git a/doc/de/user/plugin_irc.de.xml b/doc/de/user/plugin_irc.de.xml index 815335b85..4f68f2498 100644 --- a/doc/de/user/plugin_irc.de.xml +++ b/doc/de/user/plugin_irc.de.xml @@ -71,26 +71,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &irc_infos.xml; - - - - - -
- diff --git a/doc/de/user/plugin_jabber.de.xml b/doc/de/user/plugin_jabber.de.xml index 1ae2bc8b0..085c72e3e 100644 --- a/doc/de/user/plugin_jabber.de.xml +++ b/doc/de/user/plugin_jabber.de.xml @@ -48,26 +48,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &jabber_infos.xml; - - - - - -
- diff --git a/doc/de/user/plugin_logger.de.xml b/doc/de/user/plugin_logger.de.xml index a5aa755c1..c5c8774e9 100644 --- a/doc/de/user/plugin_logger.de.xml +++ b/doc/de/user/plugin_logger.de.xml @@ -47,28 +47,6 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &logger_infos.xml; - - - - - -
-
Levels diff --git a/doc/de/user/plugin_scripts.de.xml b/doc/de/user/plugin_scripts.de.xml index 34dec0187..4a7998eb5 100644 --- a/doc/de/user/plugin_scripts.de.xml +++ b/doc/de/user/plugin_scripts.de.xml @@ -55,30 +55,4 @@ along with this program. If not, see .
-
- Infos and infolists - - - - - - - Type - Name - Description - - - - &perl_infos.xml; - &python_infos.xml; - &ruby_infos.xml; - &lua_infos.xml; - &tcl_infos.xml; - - - - - -
- diff --git a/doc/de/user/plugin_xfer.de.xml b/doc/de/user/plugin_xfer.de.xml index e9254eb4f..d77d46168 100644 --- a/doc/de/user/plugin_xfer.de.xml +++ b/doc/de/user/plugin_xfer.de.xml @@ -43,26 +43,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &xfer_infos.xml; - - - - - -
- diff --git a/doc/docgen.pl b/doc/docgen.pl index 6562cdb15..ad2c823bc 100644 --- a/doc/docgen.pl +++ b/doc/docgen.pl @@ -84,6 +84,12 @@ my @ignore_options = ("aspell\\.dict\\..*", "weechat\\.bar\\..*", "weechat\\.debug\\..*"); +# infos to ignore +my @ignore_infos_plugins = ("jabber"); + +# infolists to ignore +my @ignore_infolists_plugins = ("jabber"); + # completions to ignore my @ignore_completions_plugins = ("jabber"); my @ignore_completions_items = ("jabber.*", @@ -164,7 +170,7 @@ sub get_options return %options; } -# get list of infos and infolists hooked by plugins in a hash with 4 indexes: plugin, info/infolist, name, xxx +# get list of infos hooked by plugins in a hash with 3 indexes: plugin, name, xxx sub get_infos { my %infos; @@ -177,23 +183,51 @@ sub get_infos my $plugin = weechat::infolist_string($infolist, "plugin_name"); $plugin = "weechat" if ($plugin eq ""); - $infos{$plugin}{"info"}{$info_name}{"description"} = weechat::infolist_string($infolist, "description"); + # check if infolist is ignored or not + my $ignore = 0; + foreach my $mask (@ignore_infos_plugins) + { + $ignore = 1 if ($plugin =~ /${mask}/); + } + + if ($ignore ne 1) + { + $infos{$plugin}{$info_name}{"description"} = weechat::infolist_string($infolist, "description"); + } } weechat::infolist_free($infolist); + return %infos; +} + +# get list of infolists hooked by plugins in a hash with 3 indexes: plugin, name, xxx +sub get_infolists +{ + my %infolists; + # get infolists hooked - $infolist = weechat::infolist_get("hook", "", "infolist"); + my $infolist = weechat::infolist_get("hook", "", "infolist"); while (weechat::infolist_next($infolist)) { my $infolist_name = weechat::infolist_string($infolist, "infolist_name"); my $plugin = weechat::infolist_string($infolist, "plugin_name"); $plugin = "weechat" if ($plugin eq ""); - $infos{$plugin}{"infolist"}{$infolist_name}{"description"} = weechat::infolist_string($infolist, "description"); + # check if infolist is ignored or not + my $ignore = 0; + foreach my $mask (@ignore_infolists_plugins) + { + $ignore = 1 if ($plugin =~ /${mask}/); + } + + if ($ignore ne 1) + { + $infolists{$plugin}{$infolist_name}{"description"} = weechat::infolist_string($infolist, "description"); + } } weechat::infolist_free($infolist); - return %infos; + return %infolists; } # get list of completions hooked by plugins in a hash with 3 indexes: plugin, item, xxx @@ -245,6 +279,7 @@ sub docgen my %plugin_commands = get_commands(); my %plugin_options = get_options(); my %plugin_infos = get_infos(); + my %plugin_infolists = get_infolists(); my %plugin_completions = get_completions(); # xml header (comment) for all files @@ -266,6 +301,7 @@ sub docgen # write to doc files, by locale my $num_files = 0; my $num_files_updated = 0; + my $filename = ""; foreach my $locale (@locale_list) { my $num_files_commands = 0; @@ -274,6 +310,8 @@ sub docgen my $num_files_options_updated = 0; my $num_files_infos = 0; my $num_files_infos_updated = 0; + my $num_files_infolists = 0; + my $num_files_infolists_updated = 0; my $num_files_completions = 0; my $num_files_completions_updated = 0; @@ -288,7 +326,7 @@ sub docgen # write commands foreach my $plugin (keys %plugin_commands) { - my $filename = $dir.$plugin."_commands.xml"; + $filename = $dir.$plugin."_commands.xml"; if (open(FILE, ">".$filename.".tmp")) { print FILE $xml_header; @@ -334,7 +372,7 @@ sub docgen # write config options foreach my $config (keys %plugin_options) { - my $filename = $dir.$config."_options.xml"; + $filename = $dir.$config."_options.xml"; if (open(FILE, ">".$filename.".tmp")) { print FILE $xml_header; @@ -414,51 +452,88 @@ sub docgen } } - # write infos/infolists hooked - foreach my $plugin (keys %plugin_infos) + # write infos hooked + $filename = $dir."infos.xml"; + if (open(FILE, ">".$filename.".tmp")) { - my $filename = $dir.$plugin."_infos.xml"; - if (open(FILE, ">".$filename.".tmp")) + print FILE $xml_header; + foreach my $plugin (sort keys %plugin_infos) { - print FILE $xml_header; - foreach my $type (sort keys %{$plugin_infos{$plugin}}) + foreach my $info (sort keys %{$plugin_infos{$plugin}}) { - foreach my $info (sort keys %{$plugin_infos{$plugin}{$type}}) - { - my $description = $plugin_infos{$plugin}{$type}{$info}{"description"}; - $description = $d->get($description) if ($description ne ""); - - print FILE "\n"; - print FILE " ".escape($type)."\n"; - print FILE " ".escape($info)."\n"; - print FILE " ".escape($description)."\n"; - print FILE "\n"; - } + my $description = $plugin_infos{$plugin}{$info}{"description"}; + $description = $d->get($description) if ($description ne ""); + + print FILE "\n"; + print FILE " ".escape($plugin)."\n"; + print FILE " ".escape($info)."\n"; + print FILE " ".escape($description)."\n"; + print FILE "\n"; } - #weechat::print("", "docgen: file ok: '$filename'"); - my $rc = system("diff ".$filename." ".$filename.".tmp >/dev/null 2>&1"); - if ($rc != 0) - { - system("mv -f ".$filename.".tmp ".$filename); - $num_files_updated++; - $num_files_infos_updated++; - } - else - { - system("rm ".$filename.".tmp"); - } - $num_files++; - $num_files_infos++; - close(FILE); + } + #weechat::print("", "docgen: file ok: '$filename'"); + my $rc = system("diff ".$filename." ".$filename.".tmp >/dev/null 2>&1"); + if ($rc != 0) + { + system("mv -f ".$filename.".tmp ".$filename); + $num_files_updated++; + $num_files_infos_updated++; } else { - weechat::print("", weechat::prefix("error")."docgen error: unable to write file '$filename'"); + system("rm ".$filename.".tmp"); } + $num_files++; + $num_files_infos++; + close(FILE); + } + else + { + weechat::print("", weechat::prefix("error")."docgen error: unable to write file '$filename'"); + } + + # write infolists hooked + $filename = $dir."infolists.xml"; + if (open(FILE, ">".$filename.".tmp")) + { + print FILE $xml_header; + foreach my $plugin (sort keys %plugin_infolists) + { + foreach my $infolist (sort keys %{$plugin_infolists{$plugin}}) + { + my $description = $plugin_infolists{$plugin}{$infolist}{"description"}; + $description = $d->get($description) if ($description ne ""); + + print FILE "\n"; + print FILE " ".escape($plugin)."\n"; + print FILE " ".escape($infolist)."\n"; + print FILE " ".escape($description)."\n"; + print FILE "\n"; + } + } + #weechat::print("", "docgen: file ok: '$filename'"); + my $rc = system("diff ".$filename." ".$filename.".tmp >/dev/null 2>&1"); + if ($rc != 0) + { + system("mv -f ".$filename.".tmp ".$filename); + $num_files_updated++; + $num_files_infolists_updated++; + } + else + { + system("rm ".$filename.".tmp"); + } + $num_files++; + $num_files_infolists++; + close(FILE); + } + else + { + weechat::print("", weechat::prefix("error")."docgen error: unable to write file '$filename'"); } # write completions hooked - my $filename = $dir."completions.xml"; + $filename = $dir."completions.xml"; if (open(FILE, ">".$filename.".tmp")) { print FILE $xml_header; @@ -502,18 +577,21 @@ sub docgen weechat::print("", weechat::prefix("error")."docgen error: directory '$dir' does not exist"); } my $total_files = $num_files_commands + $num_files_options - + $num_files_infos + $num_files_completions; - my $total_files_updated = $num_files_commands_updated + $num_files_options_updated - + $num_files_infos_updated + $num_files_completions_updated; + + $num_files_infos + $num_files_infolists + $num_files_completions; + my $total_files_updated = $num_files_commands_updated + + $num_files_options_updated + $num_files_infos_updated + + $num_files_infolists_updated + $num_files_completions_updated; weechat::print("", "docgen: ".$locale.": ".$total_files." files (" .$num_files_commands." cmd, " .$num_files_options." opt, " .$num_files_infos." infos, " + .$num_files_infolists." infolists, " .$num_files_completions." complt) -- " .$total_files_updated." updated (" .$num_files_commands_updated." cmd, " .$num_files_options_updated." opt, " .$num_files_infos_updated." infos, " + .$num_files_infolists_updated." infolists, " .$num_files_completions_updated." complt)"); } weechat::print("", "docgen: total: ".$num_files." files (".$num_files_updated." updated)"); @@ -521,7 +599,7 @@ sub docgen # write "include_autogen.xml" file (with includes for all files built) if ($num_files > 0) { - my $filename = $path."/include_autogen.xml"; + $filename = $path."/include_autogen.xml"; if (open(FILE, ">".$filename.".tmp")) { print FILE "\n\n"; @@ -534,11 +612,10 @@ sub docgen { print FILE "\n"; } - print FILE "\n\n\n"; - foreach my $plugin (sort keys %plugin_infos) - { - print FILE "\n"; - } + print FILE "\n\n\n"; + print FILE "\n"; + print FILE "\n\n\n"; + print FILE "\n"; print FILE "\n\n\n"; print FILE "\n"; close(FILE); diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am index 641fcdc6f..f7ff31e4b 100644 --- a/doc/en/Makefile.am +++ b/doc/en/Makefile.am @@ -18,39 +18,29 @@ LANGCODE = en BOOK_AUTOGEN_INCLUDE = ../include_autogen.xml \ autogen/alias_commands.xml \ - autogen/alias_infos.xml \ autogen/aspell_commands.xml \ autogen/aspell_options.xml \ autogen/charset_commands.xml \ autogen/charset_options.xml \ autogen/completions.xml \ autogen/demo_commands.xml \ - autogen/fifo_infos.xml \ autogen/irc_commands.xml \ - autogen/irc_infos.xml \ autogen/irc_options.xml \ + autogen/infos.xml \ + autogen/infolists.xml \ autogen/jabber_commands.xml \ - autogen/jabber_infos.xml \ autogen/jabber_options.xml \ autogen/logger_commands.xml \ - autogen/logger_infos.xml \ autogen/logger_options.xml \ autogen/lua_commands.xml \ - autogen/lua_infos.xml \ autogen/notify_commands.xml \ autogen/perl_commands.xml \ - autogen/perl_infos.xml \ autogen/python_commands.xml \ - autogen/python_infos.xml \ autogen/ruby_commands.xml \ - autogen/ruby_infos.xml \ autogen/tcl_commands.xml \ - autogen/tcl_infos.xml \ autogen/weechat_commands.xml \ - autogen/weechat_infos.xml \ autogen/weechat_options.xml \ autogen/xfer_commands.xml \ - autogen/xfer_infos.xml \ autogen/xfer_options.xml BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ diff --git a/doc/en/autogen/alias_infos.xml b/doc/en/autogen/alias_infos.xml deleted file mode 100644 index cee87effa..000000000 --- a/doc/en/autogen/alias_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - alias - list of alias - diff --git a/doc/en/autogen/fifo_infos.xml b/doc/en/autogen/fifo_infos.xml deleted file mode 100644 index 916a40236..000000000 --- a/doc/en/autogen/fifo_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - info - fifo_filename - name of FIFO pipe - diff --git a/doc/en/autogen/infolists.xml b/doc/en/autogen/infolists.xml new file mode 100644 index 000000000..c80b8c298 --- /dev/null +++ b/doc/en/autogen/infolists.xml @@ -0,0 +1,133 @@ + + + + + alias + alias + list of alias + + + irc + irc_channel + list of channels for an IRC server + + + irc + irc_ignore + list of IRC ignore + + + irc + irc_nick + list of nicks for an IRC channel + + + irc + irc_server + list of IRC servers + + + logger + logger_buffer + list of logger buffers + + + lua + lua_script + list of lua scripts + + + perl + perl_script + list of perl scripts + + + python + python_script + list of python scripts + + + relay + relay + list of relay clients + + + ruby + ruby_script + list of ruby scripts + + + tcl + tcl_script + list of tcl scripts + + + weechat + bar + list of bars + + + weechat + bar_item + list of bar items + + + weechat + bar_window + list of bar windows + + + weechat + buffer + list of buffers + + + weechat + buffer_lines + lines of a buffer + + + weechat + filter + list of filters + + + weechat + hook + list of hooks + + + weechat + hotlist + list of buffers in hotlist + + + weechat + nicklist + nicks in nicklist for a buffer + + + weechat + option + list of options + + + weechat + plugin + list of plugins + + + weechat + window + list of windows + + + xfer + xfer + list of xfer + diff --git a/doc/en/autogen/infos.xml b/doc/en/autogen/infos.xml new file mode 100644 index 000000000..fb303729d --- /dev/null +++ b/doc/en/autogen/infos.xml @@ -0,0 +1,88 @@ + + + + + fifo + fifo_filename + name of FIFO pipe + + + irc + irc_buffer + get buffer pointer for an IRC server/channel + + + irc + irc_is_channel + 1 if string is an IRC channel + + + irc + irc_nick + get current nick on a server + + + irc + irc_nick_from_host + get nick from IRC host + + + weechat + charset_internal + WeeChat internal charset + + + weechat + charset_terminal + terminal charset + + + weechat + date + WeeChat compilation date + + + weechat + dir_separator + directory separator + + + weechat + filters_enabled + 1 if filters are enabled + + + weechat + inactivity + keyboard inactivity (seconds) + + + weechat + version + WeeChat version + + + weechat + weechat_dir + WeeChat directory + + + weechat + weechat_libdir + WeeChat "lib" directory + + + weechat + weechat_localedir + WeeChat "locale" directory + + + weechat + weechat_sharedir + WeeChat "share" directory + diff --git a/doc/en/autogen/irc_infos.xml b/doc/en/autogen/irc_infos.xml deleted file mode 100644 index 8f8753ce5..000000000 --- a/doc/en/autogen/irc_infos.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - info - irc_buffer - get buffer pointer for an IRC server/channel - - - info - irc_is_channel - 1 if string is an IRC channel - - - info - irc_nick - get current nick on a server - - - info - irc_nick_from_host - get nick from IRC host - - - infolist - irc_channel - list of channels for an IRC server - - - infolist - irc_ignore - list of IRC ignore - - - infolist - irc_nick - list of nicks for an IRC channel - - - infolist - irc_server - list of IRC servers - diff --git a/doc/en/autogen/jabber_infos.xml b/doc/en/autogen/jabber_infos.xml deleted file mode 100644 index 1bf578e87..000000000 --- a/doc/en/autogen/jabber_infos.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - info - jabber_buffer - get buffer pointer for a Jabber server/MUC - - - infolist - jabber_buddy - list of buddies for a Jabber server or MUC - - - infolist - jabber_muc - list of MUCs for a Jabber server - - - infolist - jabber_server - list of Jabber servers - diff --git a/doc/en/autogen/logger_infos.xml b/doc/en/autogen/logger_infos.xml deleted file mode 100644 index bf249d045..000000000 --- a/doc/en/autogen/logger_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - logger_buffer - list of logger buffers - diff --git a/doc/en/autogen/lua_infos.xml b/doc/en/autogen/lua_infos.xml deleted file mode 100644 index 0cbd17c46..000000000 --- a/doc/en/autogen/lua_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - lua_script - liste des scripts lua - diff --git a/doc/en/autogen/perl_infos.xml b/doc/en/autogen/perl_infos.xml deleted file mode 100644 index 76d6614a2..000000000 --- a/doc/en/autogen/perl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - perl_script - liste des scripts perl - diff --git a/doc/en/autogen/python_infos.xml b/doc/en/autogen/python_infos.xml deleted file mode 100644 index 5522e371e..000000000 --- a/doc/en/autogen/python_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - python_script - liste des scripts python - diff --git a/doc/en/autogen/relay_infos.xml b/doc/en/autogen/relay_infos.xml deleted file mode 100644 index eb979c513..000000000 --- a/doc/en/autogen/relay_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - relay - list of relay clients - diff --git a/doc/en/autogen/ruby_infos.xml b/doc/en/autogen/ruby_infos.xml deleted file mode 100644 index 8f4374da6..000000000 --- a/doc/en/autogen/ruby_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - ruby_script - liste des scripts ruby - diff --git a/doc/en/autogen/tcl_infos.xml b/doc/en/autogen/tcl_infos.xml deleted file mode 100644 index 47e5275eb..000000000 --- a/doc/en/autogen/tcl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - tcl_script - liste des scripts tcl - diff --git a/doc/en/autogen/weechat_infos.xml b/doc/en/autogen/weechat_infos.xml deleted file mode 100644 index a0e9108e8..000000000 --- a/doc/en/autogen/weechat_infos.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - info - charset_internal - WeeChat internal charset - - - info - charset_terminal - terminal charset - - - info - date - WeeChat compilation date - - - info - dir_separator - directory separator - - - info - filters_enabled - 1 if filters are enabled - - - info - inactivity - keyboard inactivity (seconds) - - - info - version - WeeChat version - - - info - weechat_dir - WeeChat directory - - - info - weechat_libdir - WeeChat "lib" directory - - - info - weechat_localedir - WeeChat "locale" directory - - - info - weechat_sharedir - WeeChat "share" directory - - - infolist - bar - list of bars - - - infolist - bar_item - list of bar items - - - infolist - bar_window - list of bar windows - - - infolist - buffer - list of buffers - - - infolist - buffer_lines - lines of a buffer - - - infolist - filter - list of filters - - - infolist - hook - list of hooks - - - infolist - hotlist - list of buffers in hotlist - - - infolist - nicklist - nicks in nicklist for a buffer - - - infolist - option - list of options - - - infolist - plugin - list of plugins - - - infolist - window - list of windows - diff --git a/doc/en/autogen/xfer_infos.xml b/doc/en/autogen/xfer_infos.xml deleted file mode 100644 index 0a67e3420..000000000 --- a/doc/en/autogen/xfer_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - xfer - list of xfer - diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml index f4a50efd7..36a607b0f 100644 --- a/doc/en/dev/plugin_c_api.en.xml +++ b/doc/en/dev/plugin_c_api.en.xml @@ -545,7 +545,7 @@ int weechat_string_match ( - Check if a string matches a mask. Mask may begin or end with "*" (no + Check if a string matches a mask. Mask can begin or end with "*" (no other "*" are allowed inside mask). @@ -2226,7 +2226,7 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Example: - weechat_list_set (item, "new data");/ + weechat_list_set (item, "new data"); @@ -2258,7 +2258,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Example: - struct t_weelist_item *next_item = weechat_list_next_item (item);/ + struct t_weelist_item *next_item = weechat_list_next_item (item); @@ -2290,7 +2290,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Example: - struct t_weelist_item *prev_item = weechat_list_prev_item (item);/ + struct t_weelist_item *prev_item = weechat_list_prev_item (item); @@ -2321,7 +2321,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Example: - char *value = weechat_list_string (item);/ + char *value = weechat_list_string (item); @@ -2352,7 +2352,7 @@ char *weechat_list_size (struct t_weelist *weelist); Example: - int size = weechat_list_size (list);/ + int size = weechat_list_size (list); @@ -2387,7 +2387,7 @@ void weechat_list_remove ( Example: - weechat_list_remove (list, item);/ + weechat_list_remove (list, item); @@ -2415,7 +2415,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Example: - weechat_list_remove_all (list);/ + weechat_list_remove_all (list); @@ -2443,7 +2443,7 @@ void weechat_list_free (struct t_weelist *weelist); Example: - weechat_list_free (list);/ + weechat_list_free (list); @@ -2486,7 +2486,7 @@ struct t_config_file *weechat_config_new ( : callback called when - configuration file is reloaded with /reload (optional, may be + configuration file is reloaded with /reload (optional, can be NULL), arguments: @@ -4726,7 +4726,7 @@ const char *weechat_color (const char *color_name); - : name of color: may be a WeeChat + : name of color: can be a WeeChat color name (from weechat.color.xxx), a color with optional background (separated by comma), attribute ("bold", "-bold", "reverse", "-reverse", "italic", "-italic", "underline", @@ -8943,84 +8943,25 @@ const char *weechat_info_get (const char *info_name, - Get info from WeeChat or other plugin. + Get info from WeeChat or a plugin. Arguments: - : info name to read, from WeeChat - core or other plugin (see plugin doc for infos returned by - each plugin). WeeChat core infos are: + : name of info to read: - Info + Plugin + Name Description - Example - - version - WeeChat version - 0.2.7 - - - date - WeeChat compilation date - Dec 25 2008 - - - dir_separator - - directory separator: "/" under GNU/Linux, "\" under - MS-Windows - - / - - - weechat_dir - WeeChat home directory - /home/login/.weechat - - - weechat_libdir - WeeChat lib directory - /usr/lib/weechat - - - weechat_sharedir - WeeChat share directory - /usr/share/weechat - - - weechat_localedir - WeeChat locale directory - /usr/share/locale - - - charset_terminal - terminal charset - UTF-8 - - - charset_internal - internal WeeChat charset (always "UTF-8") - UTF-8 - - - inactivity - keyboard inactivity (in seconds) - 12 - - - filters_enabled - 1 if filters are enabled, otherwise 0 - 1 - + &infos.xml; @@ -9057,13 +8998,794 @@ weechat_printf (NULL, "WeeChat home is: %s", Infolists - Functions for infolists. + Functions to get infolists. - Missing doc! + An infolist is a list of "items". Each item contains variables. + For example, infolist "irc_server" has N items (N is number of IRC + servers defined). For each item, there is variables like "name", + "buffer", "is_connected", ... + Each variable has a type and a value. Possible types are: + + + + + Type + Description + + + + + integer + any integer value + + + string + any string value + + + pointer + any pointer + + + buffer + buffer with fixed length, containing any data + + + time + time value + + + + +
+ weechat_infolist_new + + + Prototype: + +struct t_infolist *weechat_infolist_new (); + + + + Create a new infolist. + + + Return value: pointer to new infolist. + + + Example: + struct t_infolist *infolist = weechat_infolist_new (); + +
+ +
+ weechat_infolist_new_item + + + Prototype: + +struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); + + + + Add an item in an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: pointer to new item. + + + Example: + +struct t_infolist_item *item = weechat_infolist_new_item (infolist); + + +
+ +
+ weechat_infolist_new_var_integer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_integer ( + struct t_infolist_item *item, + const char *name, + int value); + + + + Add an integer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : integer value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_integer (item, "my_integer", 123); + + +
+ +
+ weechat_infolist_new_var_string + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_string ( + struct t_infolist_item *item, + const char *name, + const char *value); + + + + Add a string variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : string value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_string (item, "my_string", "value here"); + + +
+ +
+ weechat_infolist_new_var_pointer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_pointer ( + struct t_infolist_item *item, + const char *name, + void *pointer); + + + + Add a pointer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_pointer (item, "my_pointer", &something); + + +
+ +
+ weechat_infolist_new_var_buffer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_buffer ( + struct t_infolist_item *item, + const char *name, + void *pointer, + int size); + + + + Add a buffer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer to buffer + + + + + : size of buffer + + + + + + Return value: pointer to new variable. + + + Example: + +char buffer[256]; +/* ... */ +struct t_infolist_var *var = + weechat_infolist_new_variable_buffer (item, "my_buffer", + &buffer, sizeof (buffer)); + + +
+ +
+ weechat_infolist_new_var_time + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_time ( + struct t_infolist_item *item, + const char *name, + time_t time); + + + + Add a time variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : time value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_time (item, "my_time", time (NULL)); + + +
+ +
+ weechat_infolist_get + + + Prototype: + +struct t_infolist *weechat_infolist_get (const char *infolist_name, + void *pointer, + const char *arguments); + + + + Get infolist from WeeChat or a plugin. + + + Arguments: + + + + : name of infolist to read: + + + + + Plugin + Name + Description + + + + &infolists.xml; + + + + + + + + : pointer to an item, to get only this + item in infolist (optional, can be NULL) + + + + + : name/type of item to retrieve + (optional, can be NULL) + + + + + + Return value: pointer to infolist, NULL if an error occured. + + + Example: + +struct t_infolist *infolist = weechat_infolist_get ("irc_server", NULL, NULL); + + +
+ +
+ weechat_infolist_next + + + Prototype: + +int weechat_infolist_next (struct t_infolist *infolist); + + + + Move "cursor" to next item in an infolist. The first call to this + function for an infolist moves cursor to first item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on next item, 0 if end of list was + reached. + + + Example: + +if (weechat_infolist_next (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_prev + + + Prototype: + +int weechat_infolist_prev (struct t_infolist *infolist); + + + + Move "cursor" to previous item in an infolist. The first call to this + function for an infolist moves cursor to last item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on previous item, 0 if beginning of + list was reached. + + + Example: + +if (weechat_infolist_prev (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_reset_item_cursor + + + Prototype: + +void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); + + + + Reset "cursor" for infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: weechat_infolist_reset_item_cursor (infolist); + +
+ +
+ weechat_infolist_fields + + + Prototype: + +const char *weechat_infolist_fields (struct t_infolist *infolist); + + + + Get list of fields for current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: string with list of fields for current infolist item. + List is comma separated, and contains letter for type, followed by + variable name. Types are: "i" (integer), "s" (string), "p" (pointer), + "b" (buffer), "t" (time). + + + Example: + +const char *fields = weechat_infolist_fields (infolist); +/* fields contains something like: + "i:my_integer,s:my_string,p:my_pointer,b:my_buffer,t:my_time" */ + + +
+ +
+ weechat_infolist_integer + + + Prototype: + +int weechat_infolist_integer (struct t_infolist *infolist, + const char *var); + + + + Get value of integer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "integer") + + + + + + Return value: integer value of variable. + + + Example: + +weechat_printf (NULL, "integer value = %d", + weechat_infolist_integer (infolist, "my_integer")); + + +
+ +
+ weechat_infolist_string + + + Prototype: + +const char *weechat_infolist_string (struct t_infolist *infolist, + const char *var); + + + + Get value of string variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "string") + + + + + + Return value: string value of variable. + + + Example: + +weechat_printf (NULL, "string value = %s", + weechat_infolist_string (infolist, "my_string")); + + +
+ +
+ weechat_infolist_pointer + + + Prototype: + +void *weechat_infolist_pointer (struct t_infolist *infolist, + const char *var); + + + + Get value of pointer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "pointer") + + + + + + Return value: pointer value of variable. + + + Example: + +weechat_printf (NULL, "pointer value = 0x%lx", + weechat_infolist_pointer (infolist, "my_pointer")); + + +
+ +
+ weechat_infolist_buffer + + + Prototype: + +void *weechat_infolist_buffer (struct t_infolist *infolist, + const char *var, + int *size); + + + + Get value of buffer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "buffer") + + + + + : pointer to integer variable, will be set + with buffer size + + + + + + Return value: buffer pointer. + + + Example: + +int size; +void *pointer = weechat_infolist_buffer (infolist, "my_buffer", &size); +weechat_printf (NULL, "buffer pointer = 0x%lx, size = %d", + pointer, size); + + +
+ +
+ weechat_infolist_time + + + Prototype: + +time_t weechat_infolist_time (struct t_infolist *infolist, + const char *var); + + + + Get value of time variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "time") + + + + + + Return value: time value of variable. + + + Example: + +weechat_printf (NULL, "time value = 0x%ld", + weechat_infolist_time (infolist, "my_time")); + + +
+ +
+ weechat_infolist_free + + + Prototype: + +void weechat_infolist_free (struct t_weelist *weelist); + + + + Free an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: + weechat_infolist_free (infolist); + +
+ @@ -9075,3041 +9797,170 @@ weechat_printf (NULL, "WeeChat home is: %s", Functions for WeeChat upgrading. - - Missing doc! - +
+ weechat_upgrade_new + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_new (const char *filename, + int write); + + + + Create or read a file for upgrade. + + + Arguments: + + + + : name of file (extension ".upgrade" + will be added to this name by WeeChat) + + + : 1 to create file (write mode, before + upgrade), 0 to read file (after upgrade) + + + + + + Return value: pointer to new upgrade file. + + + Example: + +struct t_upgrade_file *upgrade_file = weechat_upgrade_new ("my_file"); + + +
- - - - - - - - - - - - - - - - +
+ weechat_upgrade_write_object + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_write_object ( + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist); + + + + Write an object in upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : id for object + + + : infolist to write in file + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +weechat_upgrade_write_object (upgrade_file, 1, &infolist); + + +
+ +
+ weechat_upgrade_read + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_read ( + struct t_upgrade_file *upgrade_file, + int (*callback_read)(void *data, + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist), + void *callback_read_data); + + + + Read an upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : callback called for each object + read in upgrade file + + + : pointer given to read + callback when it is called by WeeChat + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +int +my_upgrade_read_cb (struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist) +{ + /* read variables... */ + return WEECHAT_RC_OK; +} - - -
diff --git a/doc/en/user/plugin_alias.en.xml b/doc/en/user/plugin_alias.en.xml index b9463fa7d..5f2c2de6d 100644 --- a/doc/en/user/plugin_alias.en.xml +++ b/doc/en/user/plugin_alias.en.xml @@ -38,26 +38,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &alias_infos.xml; - - - - - -
- diff --git a/doc/en/user/plugin_irc.en.xml b/doc/en/user/plugin_irc.en.xml index fc2aef8f0..faeec482a 100644 --- a/doc/en/user/plugin_irc.en.xml +++ b/doc/en/user/plugin_irc.en.xml @@ -70,26 +70,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &irc_infos.xml; - - - - - -
- diff --git a/doc/en/user/plugin_jabber.en.xml b/doc/en/user/plugin_jabber.en.xml index 250a110ca..0d99189bc 100644 --- a/doc/en/user/plugin_jabber.en.xml +++ b/doc/en/user/plugin_jabber.en.xml @@ -47,26 +47,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &jabber_infos.xml; - - - - - -
- diff --git a/doc/en/user/plugin_logger.en.xml b/doc/en/user/plugin_logger.en.xml index fbb384652..9b9cae82a 100644 --- a/doc/en/user/plugin_logger.en.xml +++ b/doc/en/user/plugin_logger.en.xml @@ -47,28 +47,6 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &logger_infos.xml; - - - - - -
-
Levels diff --git a/doc/en/user/plugin_scripts.en.xml b/doc/en/user/plugin_scripts.en.xml index 2cb5921f9..9d094fcd3 100644 --- a/doc/en/user/plugin_scripts.en.xml +++ b/doc/en/user/plugin_scripts.en.xml @@ -54,30 +54,4 @@ along with this program. If not, see .
-
- Infos and infolists - - - - - - - Type - Name - Description - - - - &perl_infos.xml; - &python_infos.xml; - &ruby_infos.xml; - &lua_infos.xml; - &tcl_infos.xml; - - - - - -
- diff --git a/doc/en/user/plugin_xfer.en.xml b/doc/en/user/plugin_xfer.en.xml index 4b7a75c81..9f9de4bd0 100644 --- a/doc/en/user/plugin_xfer.en.xml +++ b/doc/en/user/plugin_xfer.en.xml @@ -42,26 +42,4 @@ along with this program. If not, see . -
- Infos and infolists - - - - - - - Type - Name - Description - - - - &xfer_infos.xml; - - - - - -
- diff --git a/doc/fr/Makefile.am b/doc/fr/Makefile.am index 9483f23ee..f450654e5 100644 --- a/doc/fr/Makefile.am +++ b/doc/fr/Makefile.am @@ -18,39 +18,29 @@ LANGCODE = fr BOOK_AUTOGEN_INCLUDE = ../include_autogen.xml \ autogen/alias_commands.xml \ - autogen/alias_infos.xml \ autogen/aspell_commands.xml \ autogen/aspell_options.xml \ autogen/charset_commands.xml \ autogen/charset_options.xml \ autogen/completions.xml \ autogen/demo_commands.xml \ - autogen/fifo_infos.xml \ autogen/irc_commands.xml \ - autogen/irc_infos.xml \ autogen/irc_options.xml \ + autogen/infos.xml \ + autogen/infolists.xml \ autogen/jabber_commands.xml \ - autogen/jabber_infos.xml \ autogen/jabber_options.xml \ autogen/logger_commands.xml \ - autogen/logger_infos.xml \ autogen/logger_options.xml \ autogen/lua_commands.xml \ - autogen/lua_infos.xml \ autogen/notify_commands.xml \ autogen/perl_commands.xml \ - autogen/perl_infos.xml \ autogen/python_commands.xml \ - autogen/python_infos.xml \ autogen/ruby_commands.xml \ - autogen/ruby_infos.xml \ autogen/tcl_commands.xml \ - autogen/tcl_infos.xml \ autogen/weechat_commands.xml \ - autogen/weechat_infos.xml \ autogen/weechat_options.xml \ autogen/xfer_commands.xml \ - autogen/xfer_infos.xml \ autogen/xfer_options.xml BOOK_COMMON_INCLUDE = authors.$(LANGCODE).xml \ diff --git a/doc/fr/autogen/alias_infos.xml b/doc/fr/autogen/alias_infos.xml deleted file mode 100644 index 506dc2898..000000000 --- a/doc/fr/autogen/alias_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - alias - liste des alias - diff --git a/doc/fr/autogen/fifo_infos.xml b/doc/fr/autogen/fifo_infos.xml deleted file mode 100644 index 488b86d4f..000000000 --- a/doc/fr/autogen/fifo_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - info - fifo_filename - nom du tube FIFO - diff --git a/doc/fr/autogen/infolists.xml b/doc/fr/autogen/infolists.xml new file mode 100644 index 000000000..9236919e5 --- /dev/null +++ b/doc/fr/autogen/infolists.xml @@ -0,0 +1,133 @@ + + + + + alias + alias + liste des alias + + + irc + irc_channel + liste des canaux pour un serveur IRC + + + irc + irc_ignore + liste des ignore IRC + + + irc + irc_nick + liste des pseudos pour un canal IRC + + + irc + irc_server + liste des serveurs IRC + + + logger + logger_buffer + liste des enregistreurs de tampons (loggers) + + + lua + lua_script + list of lua scripts + + + perl + perl_script + list of perl scripts + + + python + python_script + list of python scripts + + + relay + relay + liste des clients pour le relai + + + ruby + ruby_script + list of ruby scripts + + + tcl + tcl_script + list of tcl scripts + + + weechat + bar + liste des barres + + + weechat + bar_item + liste des objets de barres + + + weechat + bar_window + liste des fenêtres de barre + + + weechat + buffer + liste des tampons + + + weechat + buffer_lines + lignes d'un tampon + + + weechat + filter + liste des filtres + + + weechat + hook + liste des hooks + + + weechat + hotlist + liste des tampons dans la hotlist + + + weechat + nicklist + pseudos dans la liste des pseudos pour un tampon + + + weechat + option + liste des options + + + weechat + plugin + liste des extensions + + + weechat + window + liste des fenêtres + + + xfer + xfer + liste des xfer + diff --git a/doc/fr/autogen/infos.xml b/doc/fr/autogen/infos.xml new file mode 100644 index 000000000..436e16c5e --- /dev/null +++ b/doc/fr/autogen/infos.xml @@ -0,0 +1,88 @@ + + + + + fifo + fifo_filename + nom du tube FIFO + + + irc + irc_buffer + retourne le pointeur vers le tampon pour un serveur/canal IRC + + + irc + irc_is_channel + 1 si la chaîne est un canal IRC + + + irc + irc_nick + retourne le pseudo utilisé actuellement sur un serveur + + + irc + irc_nick_from_host + retourne le pseudo à partir d'un host IRC + + + weechat + charset_internal + charset interne à WeeChat + + + weechat + charset_terminal + charset du terminal + + + weechat + date + date de compilation de WeeChat + + + weechat + dir_separator + séparateur de répertoire + + + weechat + filters_enabled + 1 si les filtres sont activés + + + weechat + inactivity + inactivité du clavier (secondes) + + + weechat + version + version de WeeChat + + + weechat + weechat_dir + répertoire de WeeChat + + + weechat + weechat_libdir + répertoire "lib" de WeeChat + + + weechat + weechat_localedir + répertoire "locale" de WeeChat + + + weechat + weechat_sharedir + répertoire "share" de WeeChat + diff --git a/doc/fr/autogen/irc_infos.xml b/doc/fr/autogen/irc_infos.xml deleted file mode 100644 index ae0ee2838..000000000 --- a/doc/fr/autogen/irc_infos.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - info - irc_buffer - retourne le pointeur vers le tampon pour un serveur/canal IRC - - - info - irc_is_channel - 1 si la chaîne est un canal IRC - - - info - irc_nick - retourne le pseudo utilisé actuellement sur un serveur - - - info - irc_nick_from_host - retourne le pseudo à partir d'un host IRC - - - infolist - irc_channel - liste des canaux pour un serveur IRC - - - infolist - irc_ignore - liste des ignore IRC - - - infolist - irc_nick - liste des pseudos pour un canal IRC - - - infolist - irc_server - liste des serveurs IRC - diff --git a/doc/fr/autogen/jabber_infos.xml b/doc/fr/autogen/jabber_infos.xml deleted file mode 100644 index 9d2a2fe59..000000000 --- a/doc/fr/autogen/jabber_infos.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - info - jabber_buffer - retourne le pointeur vers le tampon pour un serveur/MUC Jabber - - - infolist - jabber_buddy - liste des contacts pour un serveur ou MUC Jabber - - - infolist - jabber_muc - liste des MUCs pour un serveur Jabber - - - infolist - jabber_server - liste des serveurs Jabber - diff --git a/doc/fr/autogen/logger_infos.xml b/doc/fr/autogen/logger_infos.xml deleted file mode 100644 index 150865b63..000000000 --- a/doc/fr/autogen/logger_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - logger_buffer - liste des enregistreurs de tampons (loggers) - diff --git a/doc/fr/autogen/lua_infos.xml b/doc/fr/autogen/lua_infos.xml deleted file mode 100644 index 0cbd17c46..000000000 --- a/doc/fr/autogen/lua_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - lua_script - liste des scripts lua - diff --git a/doc/fr/autogen/perl_infos.xml b/doc/fr/autogen/perl_infos.xml deleted file mode 100644 index 76d6614a2..000000000 --- a/doc/fr/autogen/perl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - perl_script - liste des scripts perl - diff --git a/doc/fr/autogen/python_infos.xml b/doc/fr/autogen/python_infos.xml deleted file mode 100644 index 5522e371e..000000000 --- a/doc/fr/autogen/python_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - python_script - liste des scripts python - diff --git a/doc/fr/autogen/relay_infos.xml b/doc/fr/autogen/relay_infos.xml deleted file mode 100644 index 9e9834a12..000000000 --- a/doc/fr/autogen/relay_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - relay - liste des clients pour le relai - diff --git a/doc/fr/autogen/ruby_infos.xml b/doc/fr/autogen/ruby_infos.xml deleted file mode 100644 index 8f4374da6..000000000 --- a/doc/fr/autogen/ruby_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - ruby_script - liste des scripts ruby - diff --git a/doc/fr/autogen/tcl_infos.xml b/doc/fr/autogen/tcl_infos.xml deleted file mode 100644 index 47e5275eb..000000000 --- a/doc/fr/autogen/tcl_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - tcl_script - liste des scripts tcl - diff --git a/doc/fr/autogen/weechat_infos.xml b/doc/fr/autogen/weechat_infos.xml deleted file mode 100644 index 5dd237430..000000000 --- a/doc/fr/autogen/weechat_infos.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - info - charset_internal - charset interne à WeeChat - - - info - charset_terminal - charset du terminal - - - info - date - date de compilation de WeeChat - - - info - dir_separator - séparateur de répertoire - - - info - filters_enabled - 1 si les filtres sont activés - - - info - inactivity - inactivité du clavier (secondes) - - - info - version - version de WeeChat - - - info - weechat_dir - répertoire de WeeChat - - - info - weechat_libdir - répertoire "lib" de WeeChat - - - info - weechat_localedir - répertoire "locale" de WeeChat - - - info - weechat_sharedir - répertoire "share" de WeeChat - - - infolist - bar - liste des barres - - - infolist - bar_item - liste des objets de barres - - - infolist - bar_window - liste des fenêtres de barre - - - infolist - buffer - liste des tampons - - - infolist - buffer_lines - lignes d'un tampon - - - infolist - filter - liste des filtres - - - infolist - hook - liste des hooks - - - infolist - hotlist - liste des tampons dans la hotlist - - - infolist - nicklist - pseudos dans la liste des pseudos pour un tampon - - - infolist - option - liste des options - - - infolist - plugin - liste des extensions - - - infolist - window - liste des fenêtres - diff --git a/doc/fr/autogen/xfer_infos.xml b/doc/fr/autogen/xfer_infos.xml deleted file mode 100644 index 7ad3f7260..000000000 --- a/doc/fr/autogen/xfer_infos.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - infolist - xfer - liste des xfer - diff --git a/doc/fr/dev/plugin_c_api.fr.xml b/doc/fr/dev/plugin_c_api.fr.xml index ecf45a0df..8f763942f 100644 --- a/doc/fr/dev/plugin_c_api.fr.xml +++ b/doc/fr/dev/plugin_c_api.fr.xml @@ -546,7 +546,7 @@ int weechat_string_match ( - Check if a string matches a mask. Mask may begin or end with "*" (no + Check if a string matches a mask. Mask can begin or end with "*" (no other "*" are allowed inside mask). @@ -2069,7 +2069,7 @@ struct t_weelist_item *weechat_list_add ( - : un pointeur + : any pointer @@ -2227,7 +2227,7 @@ void weechat_list_set (struct t_weelist_item *item, const char *value); Example: - weechat_list_set (item, "new data");/ + weechat_list_set (item, "new data"); @@ -2259,7 +2259,7 @@ struct t_weelist_item *weechat_list_next (struct t_weelist_item *item); Example: - struct t_weelist_item *next_item = weechat_list_next_item (item);/ + struct t_weelist_item *next_item = weechat_list_next_item (item); @@ -2291,7 +2291,7 @@ struct t_weelist_item *weechat_list_prev (struct t_weelist_item *item); Example: - struct t_weelist_item *prev_item = weechat_list_prev_item (item);/ + struct t_weelist_item *prev_item = weechat_list_prev_item (item); @@ -2322,7 +2322,7 @@ const char *weechat_list_string (struct t_weelist_item *item); Example: - char *value = weechat_list_string (item);/ + char *value = weechat_list_string (item); @@ -2353,7 +2353,7 @@ char *weechat_list_size (struct t_weelist *weelist); Example: - int size = weechat_list_size (list);/ + int size = weechat_list_size (list); @@ -2388,7 +2388,7 @@ void weechat_list_remove ( Example: - weechat_list_remove (list, item);/ + weechat_list_remove (list, item); @@ -2416,7 +2416,7 @@ void weechat_list_remove_all (struct t_weelist *weelist); Example: - weechat_list_remove_all (list);/ + weechat_list_remove_all (list); @@ -2444,7 +2444,7 @@ void weechat_list_free (struct t_weelist *weelist); Example: - weechat_list_free (list);/ + weechat_list_free (list); @@ -2487,7 +2487,7 @@ struct t_config_file *weechat_config_new ( : callback called when - configuration file is reloaded with /reload (optional, may be + configuration file is reloaded with /reload (optional, can be NULL), arguments: @@ -4727,7 +4727,7 @@ const char *weechat_color (const char *color_name); - : name of color: may be a WeeChat + : name of color: can be a WeeChat color name (from weechat.color.xxx), a color with optional background (separated by comma), attribute ("bold", "-bold", "reverse", "-reverse", "italic", "-italic", "underline", @@ -8944,84 +8944,25 @@ const char *weechat_info_get (const char *info_name, - Get info from WeeChat or other plugin. + Get info from WeeChat or a plugin. Arguments: - : info name to read, from WeeChat - core or other plugin (see plugin doc for infos returned by - each plugin). WeeChat core infos are: + : name of info to read: - Info + Plugin + Name Description - Example - - version - WeeChat version - 0.2.7 - - - date - WeeChat compilation date - Dec 25 2008 - - - dir_separator - - directory separator: "/" under GNU/Linux, "\" under - MS-Windows - - / - - - weechat_dir - WeeChat home directory - /home/login/.weechat - - - weechat_libdir - WeeChat lib directory - /usr/lib/weechat - - - weechat_sharedir - WeeChat share directory - /usr/share/weechat - - - weechat_localedir - WeeChat locale directory - /usr/share/locale - - - charset_terminal - terminal charset - UTF-8 - - - charset_internal - internal WeeChat charset (always "UTF-8") - UTF-8 - - - inactivity - keyboard inactivity (in seconds) - 12 - - - filters_enabled - 1 if filters are enabled, otherwise 0 - 1 - + &infos.xml; @@ -9058,13 +8999,794 @@ weechat_printf (NULL, "WeeChat home is: %s", Infolists - Functions for infolists. + Functions to get infolists. - Missing doc! + An infolist is a list of "items". Each item contains variables. + For example, infolist "irc_server" has N items (N is number of IRC + servers defined). For each item, there is variables like "name", + "buffer", "is_connected", ... + Each variable has a type and a value. Possible types are: + + + + + Type + Description + + + + + integer + any integer value + + + string + any string value + + + pointer + any pointer + + + buffer + buffer with fixed length, containing any data + + + time + time value + + + + +
+ weechat_infolist_new + + + Prototype: + +struct t_infolist *weechat_infolist_new (); + + + + Create a new infolist. + + + Return value: pointer to new infolist. + + + Example: + struct t_infolist *infolist = weechat_infolist_new (); + +
+ +
+ weechat_infolist_new_item + + + Prototype: + +struct t_infolist_item *weechat_infolist_new_item (struct t_infolist *infolist); + + + + Add an item in an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: pointer to new item. + + + Example: + +struct t_infolist_item *item = weechat_infolist_new_item (infolist); + + +
+ +
+ weechat_infolist_new_var_integer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_integer ( + struct t_infolist_item *item, + const char *name, + int value); + + + + Add an integer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : integer value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_integer (item, "my_integer", 123); + + +
+ +
+ weechat_infolist_new_var_string + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_string ( + struct t_infolist_item *item, + const char *name, + const char *value); + + + + Add a string variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : string value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_string (item, "my_string", "value here"); + + +
+ +
+ weechat_infolist_new_var_pointer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_pointer ( + struct t_infolist_item *item, + const char *name, + void *pointer); + + + + Add a pointer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_pointer (item, "my_pointer", &something); + + +
+ +
+ weechat_infolist_new_var_buffer + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_buffer ( + struct t_infolist_item *item, + const char *name, + void *pointer, + int size); + + + + Add a buffer variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : pointer to buffer + + + + + : size of buffer + + + + + + Return value: pointer to new variable. + + + Example: + +char buffer[256]; +/* ... */ +struct t_infolist_var *var = + weechat_infolist_new_variable_buffer (item, "my_buffer", + &buffer, sizeof (buffer)); + + +
+ +
+ weechat_infolist_new_var_time + + + Prototype: + +struct t_infolist_var *weechat_infolist_new_var_time ( + struct t_infolist_item *item, + const char *name, + time_t time); + + + + Add a time variable to an infolist item. + + + Arguments: + + + + : infolist item pointer + + + + + : variable name + + + + + : time value + + + + + + Return value: pointer to new variable. + + + Example: + +struct t_infolist_var *var = + weechat_infolist_new_variable_time (item, "my_time", time (NULL)); + + +
+ +
+ weechat_infolist_get + + + Prototype: + +struct t_infolist *weechat_infolist_get (const char *infolist_name, + void *pointer, + const char *arguments); + + + + Get infolist from WeeChat or a plugin. + + + Arguments: + + + + : name of infolist to read: + + + + + Plugin + Name + Description + + + + &infolists.xml; + + + + + + + + : pointer to an item, to get only this + item in infolist (optional, can be NULL) + + + + + : name/type of item to retrieve + (optional, can be NULL) + + + + + + Return value: pointer to infolist, NULL if an error occured. + + + Example: + +struct t_infolist *infolist = weechat_infolist_get ("irc_server", NULL, NULL); + + +
+ +
+ weechat_infolist_next + + + Prototype: + +int weechat_infolist_next (struct t_infolist *infolist); + + + + Move "cursor" to next item in an infolist. The first call to this + function for an infolist moves cursor to first item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on next item, 0 if end of list was + reached. + + + Example: + +if (weechat_infolist_next (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_prev + + + Prototype: + +int weechat_infolist_prev (struct t_infolist *infolist); + + + + Move "cursor" to previous item in an infolist. The first call to this + function for an infolist moves cursor to last item in infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: 1 if pointer is now on previous item, 0 if beginning of + list was reached. + + + Example: + +if (weechat_infolist_prev (infolist)) +{ + /* read variables in item... */ +} +else +{ + /* no more item available */ +} + + +
+ +
+ weechat_infolist_reset_item_cursor + + + Prototype: + +void weechat_infolist_reset_item_cursor (struct t_infolist *infolist); + + + + Reset "cursor" for infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: weechat_infolist_reset_item_cursor (infolist); + +
+ +
+ weechat_infolist_fields + + + Prototype: + +const char *weechat_infolist_fields (struct t_infolist *infolist); + + + + Get list of fields for current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + + Return value: string with list of fields for current infolist item. + List is comma separated, and contains letter for type, followed by + variable name. Types are: "i" (integer), "s" (string), "p" (pointer), + "b" (buffer), "t" (time). + + + Example: + +const char *fields = weechat_infolist_fields (infolist); +/* fields contains something like: + "i:my_integer,s:my_string,p:my_pointer,b:my_buffer,t:my_time" */ + + +
+ +
+ weechat_infolist_integer + + + Prototype: + +int weechat_infolist_integer (struct t_infolist *infolist, + const char *var); + + + + Get value of integer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "integer") + + + + + + Return value: integer value of variable. + + + Example: + +weechat_printf (NULL, "integer value = %d", + weechat_infolist_integer (infolist, "my_integer")); + + +
+ +
+ weechat_infolist_string + + + Prototype: + +const char *weechat_infolist_string (struct t_infolist *infolist, + const char *var); + + + + Get value of string variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "string") + + + + + + Return value: string value of variable. + + + Example: + +weechat_printf (NULL, "string value = %s", + weechat_infolist_string (infolist, "my_string")); + + +
+ +
+ weechat_infolist_pointer + + + Prototype: + +void *weechat_infolist_pointer (struct t_infolist *infolist, + const char *var); + + + + Get value of pointer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "pointer") + + + + + + Return value: pointer value of variable. + + + Example: + +weechat_printf (NULL, "pointer value = 0x%lx", + weechat_infolist_pointer (infolist, "my_pointer")); + + +
+ +
+ weechat_infolist_buffer + + + Prototype: + +void *weechat_infolist_buffer (struct t_infolist *infolist, + const char *var, + int *size); + + + + Get value of buffer variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "buffer") + + + + + : pointer to integer variable, will be set + with buffer size + + + + + + Return value: buffer pointer. + + + Example: + +int size; +void *pointer = weechat_infolist_buffer (infolist, "my_buffer", &size); +weechat_printf (NULL, "buffer pointer = 0x%lx, size = %d", + pointer, size); + + +
+ +
+ weechat_infolist_time + + + Prototype: + +time_t weechat_infolist_time (struct t_infolist *infolist, + const char *var); + + + + Get value of time variable in current infolist item. + + + Arguments: + + + + : infolist pointer + + + + + : variable name (must be type "time") + + + + + + Return value: time value of variable. + + + Example: + +weechat_printf (NULL, "time value = 0x%ld", + weechat_infolist_time (infolist, "my_time")); + + +
+ +
+ weechat_infolist_free + + + Prototype: + +void weechat_infolist_free (struct t_weelist *weelist); + + + + Free an infolist. + + + Arguments: + + + + : infolist pointer + + + + + + Example: + weechat_infolist_free (infolist); + +
+ @@ -9076,3041 +9798,170 @@ weechat_printf (NULL, "WeeChat home is: %s", Functions for WeeChat upgrading. - - Missing doc! - +
+ weechat_upgrade_new + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_new (const char *filename, + int write); + + + + Create or read a file for upgrade. + + + Arguments: + + + + : name of file (extension ".upgrade" + will be added to this name by WeeChat) + + + : 1 to create file (write mode, before + upgrade), 0 to read file (after upgrade) + + + + + + Return value: pointer to new upgrade file. + + + Example: + +struct t_upgrade_file *upgrade_file = weechat_upgrade_new ("my_file"); + + +
- - - - - - - - - - - - - - - - +
+ weechat_upgrade_write_object + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_write_object ( + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist); + + + + Write an object in upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : id for object + + + : infolist to write in file + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +weechat_upgrade_write_object (upgrade_file, 1, &infolist); + + +
+ +
+ weechat_upgrade_read + + + Prototype: + +struct t_upgrade_file *weechat_upgrade_read ( + struct t_upgrade_file *upgrade_file, + int (*callback_read)(void *data, + struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist), + void *callback_read_data); + + + + Read an upgrade file. + + + Arguments: + + + + : upgrade file pointer + + + : callback called for each object + read in upgrade file + + + : pointer given to read + callback when it is called by WeeChat + + + + + + Return value: 1 if ok, 0 if error. + + + Example: + +int +my_upgrade_read_cb (struct t_upgrade_file *upgrade_file, + int object_id, + struct t_infolist *infolist) +{ + /* read variables... */ + return WEECHAT_RC_OK; +} - - -
diff --git a/doc/fr/user/plugin_alias.fr.xml b/doc/fr/user/plugin_alias.fr.xml index e87eed67b..0228980f5 100644 --- a/doc/fr/user/plugin_alias.fr.xml +++ b/doc/fr/user/plugin_alias.fr.xml @@ -38,26 +38,4 @@ along with this program. If not, see . -
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &alias_infos.xml; - - - - - -
- diff --git a/doc/fr/user/plugin_irc.fr.xml b/doc/fr/user/plugin_irc.fr.xml index bc2c44118..709505222 100644 --- a/doc/fr/user/plugin_irc.fr.xml +++ b/doc/fr/user/plugin_irc.fr.xml @@ -71,26 +71,4 @@ along with this program. If not, see . -
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &irc_infos.xml; - - - - - -
- diff --git a/doc/fr/user/plugin_jabber.fr.xml b/doc/fr/user/plugin_jabber.fr.xml index aa66f6933..796928c76 100644 --- a/doc/fr/user/plugin_jabber.fr.xml +++ b/doc/fr/user/plugin_jabber.fr.xml @@ -48,26 +48,4 @@ along with this program. If not, see . -
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &jabber_infos.xml; - - - - - -
- diff --git a/doc/fr/user/plugin_logger.fr.xml b/doc/fr/user/plugin_logger.fr.xml index c6878c027..65d285d18 100644 --- a/doc/fr/user/plugin_logger.fr.xml +++ b/doc/fr/user/plugin_logger.fr.xml @@ -47,28 +47,6 @@ along with this program. If not, see . -
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &logger_infos.xml; - - - - - -
-
Niveaux diff --git a/doc/fr/user/plugin_scripts.fr.xml b/doc/fr/user/plugin_scripts.fr.xml index f48e573c6..b4c94c445 100644 --- a/doc/fr/user/plugin_scripts.fr.xml +++ b/doc/fr/user/plugin_scripts.fr.xml @@ -56,30 +56,4 @@ along with this program. If not, see .
-
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &perl_infos.xml; - &python_infos.xml; - &ruby_infos.xml; - &lua_infos.xml; - &tcl_infos.xml; - - - - - -
- diff --git a/doc/fr/user/plugin_xfer.fr.xml b/doc/fr/user/plugin_xfer.fr.xml index a259d74ff..5ded80461 100644 --- a/doc/fr/user/plugin_xfer.fr.xml +++ b/doc/fr/user/plugin_xfer.fr.xml @@ -42,26 +42,4 @@ along with this program. If not, see . -
- Infos et infolists - - - - - - - Type - Nom - Description - - - - &xfer_infos.xml; - - - - - -
- diff --git a/doc/include_autogen.xml b/doc/include_autogen.xml index 6ce8297f0..49f4e8d1a 100644 --- a/doc/include_autogen.xml +++ b/doc/include_autogen.xml @@ -28,21 +28,13 @@ - + - - - - - - - - - - - - - + + + + + diff --git a/src/plugins/scripts/script.c b/src/plugins/scripts/script.c index eac4dd996..cce516c9f 100644 --- a/src/plugins/scripts/script.c +++ b/src/plugins/scripts/script.c @@ -166,7 +166,7 @@ script_init (struct t_weechat_plugin *weechat_plugin, callback_completion, NULL); snprintf (infolist_description, sizeof (infolist_description), /* TRANSLATORS: %s is language (for example "perl") */ - _("list of %s scripts"), weechat_plugin->name); + N_("list of %s scripts"), weechat_plugin->name); weechat_hook_infolist (string, infolist_description, callback_infolist, NULL); free (string);