diff options
Diffstat (limited to 'doc/en/autogen')
| -rw-r--r-- | doc/en/autogen/alias_commands.xml | 19 | ||||
| -rw-r--r-- | doc/en/autogen/alias_infos.xml | 13 | ||||
| -rw-r--r-- | doc/en/autogen/charset_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/debug_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/demo_commands.xml | 39 | ||||
| -rw-r--r-- | doc/en/autogen/fifo_infos.xml | 13 | ||||
| -rw-r--r-- | doc/en/autogen/irc_commands.xml | 465 | ||||
| -rw-r--r-- | doc/en/autogen/irc_infos.xml | 43 | ||||
| -rw-r--r-- | doc/en/autogen/irc_options.xml | 632 | ||||
| -rw-r--r-- | doc/en/autogen/logger_infos.xml | 13 | ||||
| -rw-r--r-- | doc/en/autogen/lua_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/notify_commands.xml | 18 | ||||
| -rw-r--r-- | doc/en/autogen/perl_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/python_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/ruby_commands.xml | 17 | ||||
| -rw-r--r-- | doc/en/autogen/weechat_commands.xml | 220 | ||||
| -rw-r--r-- | doc/en/autogen/weechat_infos.xml | 103 | ||||
| -rw-r--r-- | doc/en/autogen/weechat_options.xml | 2056 | ||||
| -rw-r--r-- | doc/en/autogen/xfer_commands.xml | 14 | ||||
| -rw-r--r-- | doc/en/autogen/xfer_infos.xml | 13 | ||||
| -rw-r--r-- | doc/en/autogen/xfer_options.xml | 408 |
21 files changed, 4171 insertions, 0 deletions
diff --git a/doc/en/autogen/alias_commands.xml b/doc/en/autogen/alias_commands.xml new file mode 100644 index 000000000..7872fdc44 --- /dev/null +++ b/doc/en/autogen/alias_commands.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>alias [alias_name [command [arguments]]]</command> +<programlisting> +create an alias for a command + +alias_name: name of alias + command: command name (many commands can be separated by semicolons) + arguments: arguments for command + +Note: in command, special variables $1, $2,..,$9 are replaced by arguments given by user, and $* is replaced by all arguments. +Variables $nick, $channel and $server are replaced by current nick/channel/server. +</programlisting> diff --git a/doc/en/autogen/alias_infos.xml b/doc/en/autogen/alias_infos.xml new file mode 100644 index 000000000..cee87effa --- /dev/null +++ b/doc/en/autogen/alias_infos.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>infolist</entry> + <entry>alias</entry> + <entry>list of alias</entry> +</row> diff --git a/doc/en/autogen/charset_commands.xml b/doc/en/autogen/charset_commands.xml new file mode 100644 index 000000000..febdcb060 --- /dev/null +++ b/doc/en/autogen/charset_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>charset [[decode | encode] charset] | [reset]</command> +<programlisting> +change charset for current buffer + + decode: change decoding charset + encode: change encoding charset +charset: new charset for current buffer + reset: reset charsets for current buffer +</programlisting> diff --git a/doc/en/autogen/debug_commands.xml b/doc/en/autogen/debug_commands.xml new file mode 100644 index 000000000..b8fe102d7 --- /dev/null +++ b/doc/en/autogen/debug_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>debug dump | buffer | windows | text</command> +<programlisting> +print debug messages + + dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes) + buffer: dump buffer content with hexadecimal values in log file +windows: display windows tree + text: send "debug" signal with "text" as argument +</programlisting> diff --git a/doc/en/autogen/demo_commands.xml b/doc/en/autogen/demo_commands.xml new file mode 100644 index 000000000..e4901d610 --- /dev/null +++ b/doc/en/autogen/demo_commands.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>demo_buffer category name</command> +<programlisting> +open a new buffer +</programlisting> +<command>demo_buffer_set property value</command> +<programlisting> +set a buffer property +</programlisting> +<command>demo_info [info [arguments]]</command> +<programlisting> +get and display an info + + info: info to display +arguments: optional arguments for info + +Without argument, this command displays list of available infos +</programlisting> +<command>demo_infolist [infolist]</command> +<programlisting> +get and display an infolist + +infolist: infolist to display + +Without argument, this command displays list of available infolists +</programlisting> +<command>demo_printf [text]</command> +<programlisting> +print some messages on current ubffer + +text: write this text +</programlisting> diff --git a/doc/en/autogen/fifo_infos.xml b/doc/en/autogen/fifo_infos.xml new file mode 100644 index 000000000..916a40236 --- /dev/null +++ b/doc/en/autogen/fifo_infos.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>info</entry> + <entry>fifo_filename</entry> + <entry>name of FIFO pipe</entry> +</row> diff --git a/doc/en/autogen/irc_commands.xml b/doc/en/autogen/irc_commands.xml new file mode 100644 index 000000000..d8928e6e2 --- /dev/null +++ b/doc/en/autogen/irc_commands.xml @@ -0,0 +1,465 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>admin [target]</command> +<programlisting> +find information about the administrator of the server + +target: server +</programlisting> +<command>ame message</command> +<programlisting> +send a CTCP action to all channels of all connected servers + +message: message to send +</programlisting> +<command>amsg text</command> +<programlisting> +send message to all channels of all connected servers + +text: text to send +</programlisting> +<command>away [-all] [message]</command> +<programlisting> +toggle away status + + -all: toggle away status on all connected servers +message: message for away (if no message is given, away status is removed) +</programlisting> +<command>ban [channel] [nickname [nickname ...]]</command> +<programlisting> +ban nicks or hosts + + channel: channel for ban +nickname: user or host to ban +</programlisting> +<command>connect [-all [-nojoin] | servername [servername ...] [-nojoin] | hostname [-port port] [-ipv6] [-ssl]]</command> +<programlisting> +connect to server(s) + + -all: connect to all servers +servername: internal server name to connect + -nojoin: do not join any channel (even if autojoin is enabled on server) + hostname: hostname to connect + port: port for server (integer, default is 6667) + ipv6: use IPv6 protocol + ssl: use SSL protocol +</programlisting> +<command>ctcp receiver type [arguments]</command> +<programlisting> +send a CTCP message (Client-To-Client Protocol) + + receiver: nick or channel to send CTCP to + type: CTCP type (examples: "version", "ping", ..) +arguments: arguments for CTCP +</programlisting> +<command>cycle [channel[,channel]] [part_message]</command> +<programlisting> +leave and rejoin a channel + + channel: channel name for cycle +part_message: part message (displayed to other users) +</programlisting> +<command>dcc action [nickname [file]]</command> +<programlisting> +start DCC (file or chat) + + action: 'send' (file) or 'chat' +nickname: nickname to send file or chat + file: filename (on local host) +</programlisting> +<command>dehalfop [nickname [nickname]]</command> +<programlisting> +remove half channel operator status from nickname(s) +</programlisting> +<command>deop [nickname [nickname]]</command> +<programlisting> +remove channel operator status from nickname(s) +</programlisting> +<command>devoice [nickname [nickname]]</command> +<programlisting> +remove voice from nickname(s) +</programlisting> +<command>die</command> +<programlisting> +shutdown the server +</programlisting> +<command>disconnect [-all | servername [servername ...]]</command> +<programlisting> +disconnect from server(s) + + -all: disconnect from all servers +servername: server name to disconnect +</programlisting> +<command>halfop [nickname [nickname]]</command> +<programlisting> +give half channel operator status to nickname(s) +</programlisting> +<command>ignore [list] | [add nick/host [server [channel]]] | [del number|-all]</command> +<programlisting> +ignore nicks/hosts from servers or channels + + list: list all ignore + add: add a ignore + del: del a ignore + number: number of ignore to delete (look at list to find it) + -all: delete all ignore +nick/host: nick or host to ignore (regular expression allowed) + server: internal server name where ignore is working + channel: channel name where ignore is working + +Examples: + ignore nick "toto" everywhere: + /ignore add toto + ignore host "toto@domain.com" on freenode server: + /ignore add toto@domain.com freenode + ignore host "toto*@*.domain.com" on freenode/#weechat: + /ignore add toto*@*.domain.com freenode #weechat +</programlisting> +<command>info [target]</command> +<programlisting> +get information describing the server + +target: server name +</programlisting> +<command>invite nickname channel</command> +<programlisting> +invite a nick on a channel + +nickname: nick to invite + channel: channel to invite +</programlisting> +<command>ison nickname [nickname ...]</command> +<programlisting> +check if a nickname is currently on IRC + +nickname: nickname +</programlisting> +<command>join channel[,channel] [key[,key]]</command> +<programlisting> +join a channel + +channel: channel name to join + key: key to join the channel +</programlisting> +<command>kick [channel] nickname [comment]</command> +<programlisting> +forcibly remove a user from a channel + + channel: channel where user is +nickname: nickname to kick + comment: comment for kick +</programlisting> +<command>kickban [channel] nickname [comment]</command> +<programlisting> +kicks and bans a nick from a channel + + channel: channel where user is +nickname: nickname to kick and ban + comment: comment for kick +</programlisting> +<command>kill nickname comment</command> +<programlisting> +close client-server connection + +nickname: nickname + comment: comment for kill +</programlisting> +<command>links [[server] server_mask]</command> +<programlisting> +list all servernames which are known by the server answering the query + + server: this server should answer the query +server_mask: list of servers must match this mask +</programlisting> +<command>list [channel[,channel] [server]]</command> +<programlisting> +list channels and their topic + +channel: channel to list (a regexp is allowed) +server: server name +</programlisting> +<command>lusers [mask [target]]</command> +<programlisting> +get statistics about the size of the IRC network + + mask: servers matching the mask only +target: server for forwarding request +</programlisting> +<command>me message</command> +<programlisting> +send a CTCP action to the current channel + +message: message to send +</programlisting> +<command>mode { channel {[+|-]|o|p|s|i|t|n|b|v} [limit] [user] [ban mask] } | { nickname {[+|-]|i|w|s|o} }</command> +<programlisting> +change channel or user mode + +channel modes: + channel: channel name to modify + o: give/take channel operator privileges + p: private channel flag + s: secret channel flag + i: invite-only channel flag + t: topic settable by channel operator only flag + n: no messages to channel from clients on the outside + m: moderated channel + l: set the user limit to channel + b: set a ban mask to keep users out + e: set exception mask + v: give/take the ability to speak on a moderated channel + k: set a channel key (password) +user modes: + nickname: nickname to modify + i: mark a user as invisible + s: mark a user for receive server notices + w: user receives wallops + o: operator flag +</programlisting> +<command>motd [target]</command> +<programlisting> +get the "Message Of The Day" + +target: server name +</programlisting> +<command>msg receiver[,receiver] text</command> +<programlisting> +send message to a nick or channel + +receiver: nick or channel (may be mask, '*' = current channel) +text: text to send +</programlisting> +<command>names [channel[,channel]]</command> +<programlisting> +list nicknames on channels + +channel: channel name +</programlisting> +<command>nick [-all] nickname</command> +<programlisting> +change current nickname + + -all: set new nickname for all connected servers +nickname: new nickname +</programlisting> +<command>notice nickname text</command> +<programlisting> +send notice message to user + +nickname: user to send notice to + text: text to send +</programlisting> +<command>op nickname [nickname]</command> +<programlisting> +give channel operator status to nickname(s) +</programlisting> +<command>oper user password</command> +<programlisting> +get operator privileges + +user/password: used to get privileges on current IRC server +</programlisting> +<command>part [channel[,channel]] [part_message]</command> +<programlisting> +leave a channel + + channel: channel name to leave +part_message: part message (displayed to other users) +</programlisting> +<command>ping server1 [server2]</command> +<programlisting> +ping server + +server1: server to ping +server2: forward ping to this server +</programlisting> +<command>pong daemon [daemon2]</command> +<programlisting> +answer to a ping message + + daemon: daemon who has responded to Ping message +daemon2: forward message to this daemon +</programlisting> +<command>query nickname [text]</command> +<programlisting> +send a private message to a nick + +nickname: nickname for private conversation + text: text to send +</programlisting> +<command>quote data</command> +<programlisting> +send raw data to server without parsing + +data: raw data to send +</programlisting> +<command>reconnect [-all [-nojoin] | servername [servername ...] [-nojoin]]</command> +<programlisting> +reconnect to server(s) + + -all: reconnect to all servers +servername: server name to reconnect + -nojoin: do not join any channel (even if autojoin is enabled on server) +</programlisting> +<command>rehash</command> +<programlisting> +tell the server to reload its config file +</programlisting> +<command>restart</command> +<programlisting> +tell the server to restart itself +</programlisting> +<command>server [list [servername]] | [listfull [servername]] | [add servername hostname[/port] [-auto | -noauto] [-ipv6] [-ssl]] | [copy servername newservername] | [rename servername newservername] | [del servername]</command> +<programlisting> +list, add or remove servers + + list: list servers (no parameter implies this list) + listfull: list servers with detailed info for each server + add: create a new server +servername: server name, for internal and display use + hostname: name or IP address of server, with optional port (default: 6667) + auto: automatically connect to server when WeeChat starts + noauto: do not connect to server when WeeChat starts (default) + ipv6: use IPv6 protocol + ssl: use SSL protocol + copy: duplicate a server + rename: rename a server + del: delete a server + deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending) + +Examples: + /server listfull + /server add oftc irc.oftc.net/6697 -ssl + /server add oftc6 irc6.oftc.net/6697 -ipv6 -ssl + /server add freenode2 chat.eu.freenode.net/6667,chat.us.freenode.net/6667 + /server copy oftc oftcbis + /server rename oftc newoftc + /server del freenode + /server deloutq +</programlisting> +<command>service nickname reserved distribution type reserved info</command> +<programlisting> +register a new service + +distribution: visibility of service + type: reserved for future usage +</programlisting> +<command>servlist [mask [type]]</command> +<programlisting> +list services currently connected to the network + +mask: list only services matching this mask +type: list only services of this type +</programlisting> +<command>squery service text</command> +<programlisting> +deliver a message to a service + +service: name of service +text: text to send +</programlisting> +<command>squit server comment</command> +<programlisting> +disconnect server links + +server: server name +comment: comment for quit +</programlisting> +<command>stats [query [server]]</command> +<programlisting> +query statistics about server + + query: c/h/i/k/l/m/o/y/u (see RFC1459) +server: server name +</programlisting> +<command>summon user [target [channel]]</command> +<programlisting> +give users who are on a host running an IRC server a message asking them to please join IRC + + user: username +target: server name +channel: channel name +</programlisting> +<command>time [target]</command> +<programlisting> +query local time from server + +target: query time from specified server +</programlisting> +<command>topic [channel] [topic]</command> +<programlisting> +get/set channel topic + +channel: channel name +topic: new topic for channel (if topic is "-delete" then topic is deleted) +</programlisting> +<command>trace [target]</command> +<programlisting> +find the route to specific server + +target: server +</programlisting> +<command>unban [channel] nickname [nickname ...]</command> +<programlisting> +unban nicks or hosts + + channel: channel for unban +nickname: user or host to unban +</programlisting> +<command>userhost nickname [nickname ...]</command> +<programlisting> +return a list of information about nicknames + +nickname: nickname +</programlisting> +<command>users [target]</command> +<programlisting> +list of users logged into the server + +target: server +</programlisting> +<command>version [server | nickname]</command> +<programlisting> +give the version info of nick or server (current or specified) + + server: server name +nickname: nickname +</programlisting> +<command>voice [nickname [nickname]]</command> +<programlisting> +give voice to nickname(s) +</programlisting> +<command>wallops text</command> +<programlisting> +send a message to all currently connected users who have set the 'w' user mode for themselves + +text to send +</programlisting> +<command>who [mask ["o"]]</command> +<programlisting> +generate a query which returns a list of information + +mask: only information which match this mask + o: only operators are returned according to the mask supplied +</programlisting> +<command>whois [server] nickname[,nickname]</command> +<programlisting> +query information about user(s) + + server: server name +nickname: nickname (may be a mask) +</programlisting> +<command>whowas nickname [,nickname [,nickname ...]] [count [target]]</command> +<programlisting> +ask for information about a nickname which no longer exists + +nickname: nickname to search + count: number of replies to return (full search if negative number) + target: reply should match this mask +</programlisting> diff --git a/doc/en/autogen/irc_infos.xml b/doc/en/autogen/irc_infos.xml new file mode 100644 index 000000000..2add5d5d3 --- /dev/null +++ b/doc/en/autogen/irc_infos.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>info</entry> + <entry>irc_buffer</entry> + <entry>get buffer pointer for an IRC server/channel</entry> +</row> +<row> + <entry>info</entry> + <entry>irc_is_channel</entry> + <entry>1 if string is an IRC channel</entry> +</row> +<row> + <entry>info</entry> + <entry>irc_nick_from_host</entry> + <entry>get nick from IRC host</entry> +</row> +<row> + <entry>infolist</entry> + <entry>irc_channel</entry> + <entry>list of channels for an IRC server</entry> +</row> +<row> + <entry>infolist</entry> + <entry>irc_ignore</entry> + <entry>list of IRC ignore</entry> +</row> +<row> + <entry>infolist</entry> + <entry>irc_nick</entry> + <entry>list of nicks for an IRC channel</entry> +</row> +<row> + <entry>infolist</entry> + <entry>irc_server</entry> + <entry>list of IRC servers</entry> +</row> diff --git a/doc/en/autogen/irc_options.xml b/doc/en/autogen/irc_options.xml new file mode 100644 index 000000000..cdbfa1088 --- /dev/null +++ b/doc/en/autogen/irc_options.xml @@ -0,0 +1,632 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>irc.log.auto_log_channel</command> +<itemizedlist> + <listitem> + <para>description: automatically log channel chats</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.log.auto_log_private</command> +<itemizedlist> + <listitem> + <para>description: automatically log private chats</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.log.auto_log_server</command> +<itemizedlist> + <listitem> + <para>description: automatically log server messages</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.log.hide_nickserv_pwd</command> +<itemizedlist> + <listitem> + <para>description: hide password displayed by nickserv</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.look.display_away</command> +<itemizedlist> + <listitem> + <para>description: display message when (un)marking as away</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: off, local, channel</para> + </listitem> + <listitem> + <para>default value: local</para> + </listitem> +</itemizedlist> + +<command>irc.look.highlight_tags</command> +<itemizedlist> + <listitem> + <para>description: comma separated list of tags for messages that may produce highlight (usually any message from another user, not server messages,..)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'irc_privmsg,irc_notice'</para> + </listitem> +</itemizedlist> + +<command>irc.look.nick_completion_smart</command> +<itemizedlist> + <listitem> + <para>description: smart completion for nicks (completes with last speakers first)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.look.nick_prefix</command> +<itemizedlist> + <listitem> + <para>description: text to display before nick in chat window</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.look.nick_suffix</command> +<itemizedlist> + <listitem> + <para>description: text to display after nick in chat window</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.look.notice_as_pv</command> +<itemizedlist> + <listitem> + <para>description: display notices as private messages</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.look.one_server_buffer</command> +<itemizedlist> + <listitem> + <para>description: use same buffer for all servers</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.look.open_near_server</command> +<itemizedlist> + <listitem> + <para>description: open new channels/privates near server</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.look.show_away_once</command> +<itemizedlist> + <listitem> + <para>description: show remote away message only once in private</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.network.anti_flood</command> +<itemizedlist> + <listitem> + <para>description: anti-flood: # seconds between two user messages (0 = no anti-flood)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 5</para> + </listitem> + <listitem> + <para>default value: 2</para> + </listitem> +</itemizedlist> + +<command>irc.network.away_check</command> +<itemizedlist> + <listitem> + <para>description: interval between two checks for away (in minutes, 0 = never check)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>irc.network.away_check_max_nicks</command> +<itemizedlist> + <listitem> + <para>description: do not check away nicks on channels with high number of nicks (0 = unlimited)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>irc.network.colors_receive</command> +<itemizedlist> + <listitem> + <para>description: when off, colors codes are ignored in incoming messages</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.network.colors_send</command> +<itemizedlist> + <listitem> + <para>description: allow user to send colors with special codes (^Cb=bold, ^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, ^Cr=reverse)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.network.default_msg_part</command> +<itemizedlist> + <listitem> + <para>description: default part message (leaving channel) ('%v' will be replaced by WeeChat version in string)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'WeeChat %v'</para> + </listitem> +</itemizedlist> + +<command>irc.network.default_msg_quit</command> +<itemizedlist> + <listitem> + <para>description: default quit message (disconnecting from server) ('%v' will be replaced by WeeChat version in string)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'WeeChat %v'</para> + </listitem> +</itemizedlist> + +<command>irc.network.lag_check</command> +<itemizedlist> + <listitem> + <para>description: interval between two checks for lag (in seconds, 0 = never check)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 60</para> + </listitem> +</itemizedlist> + +<command>irc.network.lag_disconnect</command> +<itemizedlist> + <listitem> + <para>description: disconnect after important lag (in minutes, 0 = never disconnect)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 5</para> + </listitem> +</itemizedlist> + +<command>irc.network.lag_min_show</command> +<itemizedlist> + <listitem> + <para>description: minimum lag to show (in seconds)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 1</para> + </listitem> +</itemizedlist> + +<command>irc.network.send_unknown_commands</command> +<itemizedlist> + <listitem> + <para>description: send unknown commands to IRC server</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.addresses</command> +<itemizedlist> + <listitem> + <para>description: list of IP/port or hostname/port for server (separated by comma)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.autoconnect</command> +<itemizedlist> + <listitem> + <para>description: automatically connect to server when WeeChat is starting</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.autojoin</command> +<itemizedlist> + <listitem> + <para>description: comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.autoreconnect</command> +<itemizedlist> + <listitem> + <para>description: automatically reconnect to server when disconnected</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.autoreconnect_delay</command> +<itemizedlist> + <listitem> + <para>description: delay (in seconds) before trying again to reconnect to server</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 65535</para> + </listitem> + <listitem> + <para>default value: 30</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.autorejoin</command> +<itemizedlist> + <listitem> + <para>description: automatically rejoin channels when kicked</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.command</command> +<itemizedlist> + <listitem> + <para>description: command(s) to run when connected to server (many commands should be separated by ';', use '\;' for a semicolon, special variables $nick, $channel and $server are replaced by their value)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.command_delay</command> +<itemizedlist> + <listitem> + <para>description: delay (in seconds) after command was executed (example: give some time for authentication)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 3600</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.ipv6</command> +<itemizedlist> + <listitem> + <para>description: use IPv6 protocol for server communication</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.local_hostname</command> +<itemizedlist> + <listitem> + <para>description: custom local hostname/IP for server (optional, if empty local hostname is used)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.nicks</command> +<itemizedlist> + <listitem> + <para>description: nicknames to use on IRC server (separated by comma)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'flashcode,flashcode1,flashcode2,flashcode3,flashcode4'</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.password</command> +<itemizedlist> + <listitem> + <para>description: password for IRC server</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.realname</command> +<itemizedlist> + <listitem> + <para>description: real name to use on IRC server</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'flashcode'</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.ssl</command> +<itemizedlist> + <listitem> + <para>description: use SSL for server communication</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>irc.server_default.username</command> +<itemizedlist> + <listitem> + <para>description: user name to use on IRC server</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'flashcode'</para> + </listitem> +</itemizedlist> + diff --git a/doc/en/autogen/logger_infos.xml b/doc/en/autogen/logger_infos.xml new file mode 100644 index 000000000..bf249d045 --- /dev/null +++ b/doc/en/autogen/logger_infos.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>infolist</entry> + <entry>logger_buffer</entry> + <entry>list of logger buffers</entry> +</row> diff --git a/doc/en/autogen/lua_commands.xml b/doc/en/autogen/lua_commands.xml new file mode 100644 index 000000000..b6ca43353 --- /dev/null +++ b/doc/en/autogen/lua_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>lua [list [name]] | [listfull [name]] [load filename] | [autoload] | [reload] | [unload [name]]</command> +<programlisting> +list/load/unload scripts + +filename: script (file) to load +name: a script name + +Without argument, this command lists all loaded scripts. +</programlisting> diff --git a/doc/en/autogen/notify_commands.xml b/doc/en/autogen/notify_commands.xml new file mode 100644 index 000000000..6c58a3940 --- /dev/null +++ b/doc/en/autogen/notify_commands.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>notify reset | none | highlight | message | all</command> +<programlisting> +change notify level for current buffer + + reset: reset notify level to default value + none: buffer will never be in hotlist +highlight: buffer will be in hotlist for highlights only + message: buffer will be in hotlist for highlights and user messages only + all: buffer will be in hotlist for any text printed +</programlisting> diff --git a/doc/en/autogen/perl_commands.xml b/doc/en/autogen/perl_commands.xml new file mode 100644 index 000000000..8ad606570 --- /dev/null +++ b/doc/en/autogen/perl_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>perl [list [name]] | [listfull [name]] [load filename] | [autoload] | [reload] | [unload [name]]</command> +<programlisting> +list/load/unload scripts + +filename: script (file) to load +name: a script name + +Without argument, this command lists all loaded scripts. +</programlisting> diff --git a/doc/en/autogen/python_commands.xml b/doc/en/autogen/python_commands.xml new file mode 100644 index 000000000..b58bca303 --- /dev/null +++ b/doc/en/autogen/python_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>python [list [name]] | [listfull [name]] [load filename] | [autoload] | [reload] | [unload [name]]</command> +<programlisting> +list/load/unload scripts + +filename: script (file) to load +name: a script name + +Without argument, this command lists all loaded scripts. +</programlisting> diff --git a/doc/en/autogen/ruby_commands.xml b/doc/en/autogen/ruby_commands.xml new file mode 100644 index 000000000..87e16a84c --- /dev/null +++ b/doc/en/autogen/ruby_commands.xml @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>ruby [list [name]] | [listfull [name]] [load filename] | [autoload] | [reload] | [unload [name]]</command> +<programlisting> +list/load/unload scripts + +filename: script (file) to load +name: a script name + +Without argument, this command lists all loaded scripts. +</programlisting> diff --git a/doc/en/autogen/weechat_commands.xml b/doc/en/autogen/weechat_commands.xml new file mode 100644 index 000000000..4fa9c345d --- /dev/null +++ b/doc/en/autogen/weechat_commands.xml @@ -0,0 +1,220 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>bar [add barname type[,cond1,cond2,...] position size separator item1,item2,...] | [default] | [del barname|-all] | [set barname name|priority|condition|position|filling|size|separator|items value] | [hide|show barname] | [scroll barname category.name value] | [list] | [listitems]</command> +<programlisting> +manage bars + + add: add a new bar + barname: name of bar (must be unique) + type: root: outside windows), + window: inside windows, with optional conditions (see below) + cond1,...: condition(s) for displaying bar (only for type "window"): + active: on active window + inactive: on inactive windows + nicklist: on windows with nicklist + without condition, bar is always displayed + position: bottom, top, left or right + filling: horizontal or vertical + size: size of bar (in chars) + separator: 1 for using separator (line), 0 or nothing means no separator + item1,...: items for this bar + default: create default bars + del: delete a bar (or all bars with -all) + set: set a value for a bar property + hide: hide a bar + show: show an hidden bar + scroll: scroll bar up/down +category.name: category and name of buffer to scroll ('*' means current buffer, you should use '*' for root bars) + value: value for scroll: 'x' or 'y', followed by '+', '-', 'b' (beginning) or 'e' (end), value (for +/-), and optional %% (to scroll by %% of width/height, otherwise value is number of chars) + list: list all bars + listfull: list all bars (verbose) + listitems: list all bar items + +Examples: + create a bar with time and completion: + /bar add mybar root bottom 1 0 [time],completion + hide a bar: + /bar hide mybar + scroll nicklist 10 lines down on current buffer: + /bar scroll nicklist * y+10 + scroll nicklist one page up on #weechat buffer: + /bar scroll nicklist #weechat y-100% + scroll to end of nicklist on current buffer: + /bar scroll nicklist * ye +</programlisting> +<command>buffer [action [args] | number | [[server] [channel]]]</command> +<programlisting> +manage buffers + + action: action to do: + clear: clear buffer content (-all for all buffers, number for a buffer, or nothing for current buffer) + move: move buffer in the list (may be relative, for example -1) + close: close buffer + list: list buffers (no parameter implies this list) + notify: display notify levels for all open buffers + scroll: scroll in history (may be relative, and may end by a letter: s=sec, m=min, h=hour, d=day, M=month, y=year); if there is only letter, then scroll to beginning of this item + + number: jump to buffer by number +server, +channel: jump to buffer by server and/or channel name + +Examples: +clear current buffer: /buffer clear + clear all buffers: /buffer clear -all + move buffer: /buffer move 5 + close buffer: /buffer close this is part msg + scroll 1 day up: /buffer scroll 1d == /buffer scroll -1d == /buffer scroll -24h + scroll to beginning + of this day: /buffer scroll d + scroll 15 min down: /buffer scroll +15m + scroll 20 msgs up: /buffer scroll -20 + jump to #weechat: /buffer #weechat +</programlisting> +<command>command plugin command</command> +<programlisting> +launch explicit WeeChat or plugin command + + plugin: plugin name ('weechat' for WeeChat internal command) +command: command to execute (a '/' is automatically added if not found at beginning of command) +</programlisting> +<command>filter [list] | [enable|disable|toggle] | [add buffer tags regex] | [del number|-all]</command> +<programlisting> +filter messages in buffers, to hide/show them according to tags or regex + + list: list all filters + enable: enable filters (filters are enabled by default) +disable: disable filters + toggle: toggle filters + add: add a filter + del: delete a filter + number: number of filter to delete (look at list to find it) + -all: delete all filters + buffer: buffer where filter is active: it may be a name (category.name) or "*" for all buffers + tags: comma separated list of tags, for example: "irc_join,irc_part,irc_quit" + regex: regular expression to search in line (use \t to separate prefix from message) + +Examples: + filter IRC join/part/quit messages: + /filter add * irc_join,irc_part,irc_quit * + filter nick "toto" on channel #weechat: + /filter add freenode.#weechat * toto\t + filter lines containing word "spam": + /filter add * * spam + filter lines containing "weechat sucks" on channel #weechat: + /filter add freenode.#weechat * weechat sucks +</programlisting> +<command>help [command | option]</command> +<programlisting> +display help about commands and options + +command: a command name + option: an option name (use /set to see list) +</programlisting> +<command>history [clear | value]</command> +<programlisting> +show buffer command history + +clear: clear history +value: number of history entries to show +</programlisting> +<command>input return | complete_next | complete_previous | search_next | delete_previous_char | delete_next_char | delete_previous_word | delete_next_word | delete_beginning_of_line | delete_end_of_line | delete_line | clipboard_paste | transpose_chars | move_beginning_of_line | move_end_of_line | move_previous_char | move_next_char | move_previous_word | move_next_word | history_previous | history_next | history_global_previous | history_global_next | jump_smart | jump_last_buffer | jump_previous_buffer | hotlist_clear | grab_key | scroll_unread | set_unread | set_unread_current_buffer | insert [args]</command> +<programlisting> +functions for command line + +Cette commande est utilisée par les associations de touches ou les extensions. +</programlisting> +<command>key [key [command [args]]] | [unbind key] | [reset -yes]</command> +<programlisting> +bind/unbind keys + + key: display or bind this key to a command + unbind: unbind a key + reset: restore bindings to the default values and delete ALL personal bindings (use carefully!) +</programlisting> +<command>plugin [list [name]] | [listfull [name]] | [load filename] | [autoload] | [reload [name]] | [unload [name]]</command> +<programlisting> +list/load/unload plugins + + list: list loaded plugins +listfull: list loaded plugins (verbose) + load: load a plugin +autoload: autoload plugins in system or user directory + reload: reload one plugin (if no name given, unload all plugins, then autoload plugins) + unload: unload one or all plugins + +Without argument, /plugin command lists loaded plugins. +</programlisting> +<command>quit</command> +<programlisting> +quit WeeChat +</programlisting> +<command>reload [file [file...]]</command> +<programlisting> +reload configuration files from disk + +file: configuration file to reload + +Without argument, all files (WeeChat and plugins) are reloaded. +</programlisting> +<command>save [file [file...]]</command> +<programlisting> +save configuration files to disk + +file: configuration file to save + +Without argument, all files (WeeChat and plugins) are saved. +</programlisting> +<command>set [option [ = value]]</command> +<programlisting> +set config options + +option: name of an option + value: value for option +</programlisting> +<command>unset [option]</command> +<programlisting> +unset/reset config options + +option: name of an option (may begin or end with "*" to mass-reset options, use carefully!) + +According to option, it's reset (for standard options) or removed (for optional settings, like server values). +</programlisting> +<command>upgrade [path_to_binary]</command> +<programlisting> +upgrade WeeChat without disconnecting from servers + +path_to_binary: path to WeeChat binary (default is current binary) + +This command run again a WeeChat binary, so it should have been compiled or installed with a package manager before running this command. +</programlisting> +<command>uptime [-o]</command> +<programlisting> +show WeeChat uptime + +-o: send uptime on current channel as an IRC message +</programlisting> +<command>window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]]</command> +<programlisting> +manage windows + + list: list open windows (no parameter implies this list) + -1: jump to previous window + +1: jump to next window + b#: jump to next window displaying buffer number # + up: switch to window above current one + down: switch to window below current one + left: switch to window on the left + right: switch to window on the right +splith: split current window horizontally +splitv: split current window vertically +resize: resize window size, new size is <pct> pourcentage of parent window + merge: merge window with another (all = keep only one window) + +For splith and splitv, pct is a pourcentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4 +</programlisting> diff --git a/doc/en/autogen/weechat_infos.xml b/doc/en/autogen/weechat_infos.xml new file mode 100644 index 000000000..476a7d9fe --- /dev/null +++ b/doc/en/autogen/weechat_infos.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>info</entry> + <entry>charset_internal</entry> + <entry>WeeChat internal charset</entry> +</row> +<row> + <entry>info</entry> + <entry>charset_terminal</entry> + <entry>terminal charset</entry> +</row> +<row> + <entry>info</entry> + <entry>date</entry> + <entry>WeeChat compilation date</entry> +</row> +<row> + <entry>info</entry> + <entry>dir_separator</entry> + <entry>directory separator</entry> +</row> +<row> + <entry>info</entry> + <entry>filters_enabled</entry> + <entry>1 if filters are enabled</entry> +</row> +<row> + <entry>info</entry> + <entry>inactivity</entry> + <entry>keyboard inactivity (seconds)</entry> +</row> +<row> + <entry>info</entry> + <entry>version</entry> + <entry>WeeChat version</entry> +</row> +<row> + <entry>info</entry> + <entry>weechat_dir</entry> + <entry>WeeChat directory</entry> +</row> +<row> + <entry>info</entry> + <entry>weechat_libdir</entry> + <entry>WeeChat "lib" directory</entry> +</row> +<row> + <entry>info</entry> + <entry>weechat_localedir</entry> + <entry>WeeChat "locale" directory</entry> +</row> +<row> + <entry>info</entry> + <entry>weechat_sharedir</entry> + <entry>WeeChat "share" directory</entry> +</row> +<row> + <entry>infolist</entry> + <entry>buffer</entry> + <entry>list of buffers</entry> +</row> +<row> + <entry>infolist</entry> + <entry>buffer_lines</entry> + <entry>lines of a buffer</entry> +</row> +<row> + <entry>infolist</entry> + <entry>filter</entry> + <entry>list of filters</entry> +</row> +<row> + <entry>infolist</entry> + <entry>hook</entry> + <entry>list of hooks</entry> +</row> +<row> + <entry>infolist</entry> + <entry>hotlist</entry> + <entry>list of buffers in hotlist</entry> +</row> +<row> + <entry>infolist</entry> + <entry>nicklist</entry> + <entry>nicks in nicklist for a buffer</entry> +</row> +<row> + <entry>infolist</entry> + <entry>option</entry> + <entry>list of options</entry> +</row> +<row> + <entry>infolist</entry> + <entry>window</entry> + <entry>list of windows</entry> +</row> diff --git a/doc/en/autogen/weechat_options.xml b/doc/en/autogen/weechat_options.xml new file mode 100644 index 000000000..34dc8de3e --- /dev/null +++ b/doc/en/autogen/weechat_options.xml @@ -0,0 +1,2056 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>weechat.color.bar_more</command> +<itemizedlist> + <listitem> + <para>description: text color for '+' when scrolling bars</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat</command> +<itemizedlist> + <listitem> + <para>description: text color for chat</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for chat</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_buffer</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer names</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_channel</command> +<itemizedlist> + <listitem> + <para>description: text color for channel names</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_delimiters</command> +<itemizedlist> + <listitem> + <para>description: text color for delimiters</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: green</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_highlight</command> +<itemizedlist> + <listitem> + <para>description: text color for highlighted prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_highlight_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for highlighted prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: magenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_host</command> +<itemizedlist> + <listitem> + <para>description: text color for hostnames</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: cyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick</command> +<itemizedlist> + <listitem> + <para>description: text color for nicks in chat window</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightcyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color01</command> +<itemizedlist> + <listitem> + <para>description: text color #1 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: cyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color02</command> +<itemizedlist> + <listitem> + <para>description: text color #2 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: magenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color03</command> +<itemizedlist> + <listitem> + <para>description: text color #3 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: green</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color04</command> +<itemizedlist> + <listitem> + <para>description: text color #4 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: brown</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color05</command> +<itemizedlist> + <listitem> + <para>description: text color #5 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightblue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color06</command> +<itemizedlist> + <listitem> + <para>description: text color #6 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color07</command> +<itemizedlist> + <listitem> + <para>description: text color #7 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightcyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color08</command> +<itemizedlist> + <listitem> + <para>description: text color #8 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color09</command> +<itemizedlist> + <listitem> + <para>description: text color #9 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_color10</command> +<itemizedlist> + <listitem> + <para>description: text color #10 for nick</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_other</command> +<itemizedlist> + <listitem> + <para>description: text color for other nick in private buffer</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_nick_self</command> +<itemizedlist> + <listitem> + <para>description: text color for local nick in chat window</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_action</command> +<itemizedlist> + <listitem> + <para>description: text color for action prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_error</command> +<itemizedlist> + <listitem> + <para>description: text color for error prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_join</command> +<itemizedlist> + <listitem> + <para>description: text color for join prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_more</command> +<itemizedlist> + <listitem> + <para>description: text color for '+' when prefix is too long</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_network</command> +<itemizedlist> + <listitem> + <para>description: text color for network prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: magenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_quit</command> +<itemizedlist> + <listitem> + <para>description: text color for quit prefix</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightred</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_prefix_suffix</command> +<itemizedlist> + <listitem> + <para>description: text color for suffix (after prefix)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: green</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_read_marker</command> +<itemizedlist> + <listitem> + <para>description: text color for unread data marker</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: magenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_read_marker_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for unread data marker</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_server</command> +<itemizedlist> + <listitem> + <para>description: text color for server names</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: brown</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_time</command> +<itemizedlist> + <listitem> + <para>description: text color for time in chat window</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.chat_time_delimiters</command> +<itemizedlist> + <listitem> + <para>description: text color for time delimiters</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: brown</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input</command> +<itemizedlist> + <listitem> + <para>description: text color for input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_actions</command> +<itemizedlist> + <listitem> + <para>description: text color for actions in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_channel</command> +<itemizedlist> + <listitem> + <para>description: text color for channel name in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_delimiters</command> +<itemizedlist> + <listitem> + <para>description: text color for delimiters in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: cyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_nick</command> +<itemizedlist> + <listitem> + <para>description: text color for nick name in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightcyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_server</command> +<itemizedlist> + <listitem> + <para>description: text color for server name in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: brown</para> + </listitem> +</itemizedlist> + +<command>weechat.color.input_text_not_found</command> +<itemizedlist> + <listitem> + <para>description: text color for unsucessful text search in input line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: red</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist</command> +<itemizedlist> + <listitem> + <para>description: text color for nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_away</command> +<itemizedlist> + <listitem> + <para>description: text color for away nicknames</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: cyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_group</command> +<itemizedlist> + <listitem> + <para>description: text color for groups in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: green</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_more</command> +<itemizedlist> + <listitem> + <para>description: text color for '+' when scrolling nicks in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_prefix1</command> +<itemizedlist> + <listitem> + <para>description: text color for prefix #1 in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_prefix2</command> +<itemizedlist> + <listitem> + <para>description: text color for prefix #2 in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_prefix3</command> +<itemizedlist> + <listitem> + <para>description: text color for prefix #3 in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_prefix4</command> +<itemizedlist> + <listitem> + <para>description: text color for prefix #4 in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_prefix5</command> +<itemizedlist> + <listitem> + <para>description: text color for prefix #5 in nicklist</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: brown</para> + </listitem> +</itemizedlist> + +<command>weechat.color.nicklist_separator</command> +<itemizedlist> + <listitem> + <para>description: text color for nicklist separator</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.separator</command> +<itemizedlist> + <listitem> + <para>description: background color for window separators (when splited)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status</command> +<itemizedlist> + <listitem> + <para>description: text color for status bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for status bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_category</command> +<itemizedlist> + <listitem> + <para>description: text color for current buffer category in status bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_data_highlight</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer with highlight (status bar)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightmagenta</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_data_msg</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer with new messages (status bar)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_data_other</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer with new data (not messages) (status bar)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_data_private</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer with private message (status bar)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_delimiters</command> +<itemizedlist> + <listitem> + <para>description: text color for status bar delimiters</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: cyan</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_more</command> +<itemizedlist> + <listitem> + <para>description: text color for buffer with new data (status bar)</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_name</command> +<itemizedlist> + <listitem> + <para>description: text color for current buffer name in status bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>weechat.color.status_number</command> +<itemizedlist> + <listitem> + <para>description: text color for current buffer number in status bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>weechat.color.title</command> +<itemizedlist> + <listitem> + <para>description: text color for title bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>weechat.color.title_bg</command> +<itemizedlist> + <listitem> + <para>description: background color for title bar</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: blue</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.nick_completor</command> +<itemizedlist> + <listitem> + <para>description: string inserted after nick completion</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ':'</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.nick_first_only</command> +<itemizedlist> + <listitem> + <para>description: complete only with first nick found</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.nick_ignore_chars</command> +<itemizedlist> + <listitem> + <para>description: chars ignored for nick completion</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '[]-^'</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.partial_completion_alert</command> +<itemizedlist> + <listitem> + <para>description: alert user when a partial completion occurs</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.partial_completion_command</command> +<itemizedlist> + <listitem> + <para>description: partially complete command names (stop when many commands found begin with same letters)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.partial_completion_command_arg</command> +<itemizedlist> + <listitem> + <para>description: partially complete command arguments (stop when many arguments found begin with same prefix)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.partial_completion_count</command> +<itemizedlist> + <listitem> + <para>description: display count for each partial completion in bar item</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.completion.partial_completion_nick</command> +<itemizedlist> + <listitem> + <para>description: partially complete nicks (stop when many nicks found begin with same letters)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.history.display_default</command> +<itemizedlist> + <listitem> + <para>description: maximum number of commands to display by default in history listing (0 = unlimited)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 5</para> + </listitem> +</itemizedlist> + +<command>weechat.history.max_commands</command> +<itemizedlist> + <listitem> + <para>description: maximum number of user commands in history (0 = unlimited)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 100</para> + </listitem> +</itemizedlist> + +<command>weechat.history.max_lines</command> +<itemizedlist> + <listitem> + <para>description: maximum number of lines in history per buffer (0 = unlimited)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 4096</para> + </listitem> +</itemizedlist> + +<command>weechat.look.buffer_notify_default</command> +<itemizedlist> + <listitem> + <para>description: default notify level for buffers (used to tell WeeChat if buffer must be displayed in hotlist or not, according to importance of message)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: none, highlight, message, all</para> + </listitem> + <listitem> + <para>default value: all</para> + </listitem> +</itemizedlist> + +<command>weechat.look.buffer_time_format</command> +<itemizedlist> + <listitem> + <para>description: time format for buffers</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '%H:%M:%S'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.color_nicks_number</command> +<itemizedlist> + <listitem> + <para>description: number of colors to use for nicks colors</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 1 .. 10</para> + </listitem> + <listitem> + <para>default value: 10</para> + </listitem> +</itemizedlist> + +<command>weechat.look.color_real_white</command> +<itemizedlist> + <listitem> + <para>description: if set, uses real white color, disabled by default for terms with white background (if you never use white background, you should turn on this option to see real white instead of default term foreground color)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.look.day_change</command> +<itemizedlist> + <listitem> + <para>description: display special message when day changes</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.look.day_change_time_format</command> +<itemizedlist> + <listitem> + <para>description: time format for date displayed when day changed</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '%a, %d %b %Y'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.highlight</command> +<itemizedlist> + <listitem> + <para>description: comma separated list of words to highlight (case insensitive comparison, words may begin or end with "*" for partial match)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.look.hotlist_names_count</command> +<itemizedlist> + <listitem> + <para>description: max number of names in hotlist (0 = no name displayed, only buffer numbers)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 32</para> + </listitem> + <listitem> + <para>default value: 3</para> + </listitem> +</itemizedlist> + +<command>weechat.look.hotlist_names_length</command> +<itemizedlist> + <listitem> + <para>description: max length of names in hotlist (0 = no limit)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 32</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>weechat.look.hotlist_names_level</command> +<itemizedlist> + <listitem> + <para>description: level for displaying names in hotlist (combination of: 1=join/part, 2=message, 4=private, 8=highlight, for example: 12=private+highlight)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 1 .. 15</para> + </listitem> + <listitem> + <para>default value: 12</para> + </listitem> +</itemizedlist> + +<command>weechat.look.hotlist_sort</command> +<itemizedlist> + <listitem> + <para>description: hotlist sort type (group_time_asc (default), group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: group_time_asc, group_time_desc, group_number_asc, group_number_desc, number_asc, number_desc</para> + </listitem> + <listitem> + <para>default value: group_time_asc</para> + </listitem> +</itemizedlist> + +<command>weechat.look.input_format</command> +<itemizedlist> + <listitem> + <para>description: format for input prompt ('%c' is replaced by channel or server, '%n' by nick and '%m' by nick modes)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '[%n(%m)] '</para> + </listitem> +</itemizedlist> + +<command>weechat.look.item_time_format</command> +<itemizedlist> + <listitem> + <para>description: time format for "time" bar item</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '%H:%M'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nicklist</command> +<itemizedlist> + <listitem> + <para>description: display nicklist (on buffers with nicklist enabled)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nicklist_max_size</command> +<itemizedlist> + <listitem> + <para>description: max size for nicklist (width or height, depending on nicklist_position (0 = no max size; if min = max and > 0, then size is fixed))</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 100</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nicklist_min_size</command> +<itemizedlist> + <listitem> + <para>description: min size for nicklist (width or height, depending on nicklist_position (0 = no min size))</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 100</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nicklist_position</command> +<itemizedlist> + <listitem> + <para>description: nicklist position (top, left, right (default), bottom)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: left, right, top, bottom</para> + </listitem> + <listitem> + <para>default value: right</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nicklist_separator</command> +<itemizedlist> + <listitem> + <para>description: separator between chat and nicklist</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nickmode</command> +<itemizedlist> + <listitem> + <para>description: display nick mode ((half)op/voice) before each nick</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.look.nickmode_empty</command> +<itemizedlist> + <listitem> + <para>description: display space if nick mode is not (half)op/voice</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.look.paste_max_lines</command> +<itemizedlist> + <listitem> + <para>description: max number of lines for paste without asking user (0 = disable this feature)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 3</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_action</command> +<itemizedlist> + <listitem> + <para>description: prefix for action messages</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ' *'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_align</command> +<itemizedlist> + <listitem> + <para>description: prefix alignment (none, left, right (default))</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: none, left, right</para> + </listitem> + <listitem> + <para>default value: right</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_align_max</command> +<itemizedlist> + <listitem> + <para>description: max size for prefix (0 = no max size)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 64</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_error</command> +<itemizedlist> + <listitem> + <para>description: prefix for error messages</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '=!='</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_join</command> +<itemizedlist> + <listitem> + <para>description: prefix for join messages</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '-->'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_network</command> +<itemizedlist> + <listitem> + <para>description: prefix for network messages</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '--'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_quit</command> +<itemizedlist> + <listitem> + <para>description: prefix for quit messages</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '<--'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.prefix_suffix</command> +<itemizedlist> + <listitem> + <para>description: string displayed after prefix</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '|'</para> + </listitem> +</itemizedlist> + +<command>weechat.look.read_marker</command> +<itemizedlist> + <listitem> + <para>description: use a marker (line or char) on buffers to show first unread line</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: none, line, dotted-line, char</para> + </listitem> + <listitem> + <para>default value: dotted-line</para> + </listitem> +</itemizedlist> + +<command>weechat.look.save_on_exit</command> +<itemizedlist> + <listitem> + <para>description: save configuration file on exit</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.look.scroll_amount</command> +<itemizedlist> + <listitem> + <para>description: how many lines to scroll by with scroll_up and scroll_down</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 1 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 3</para> + </listitem> +</itemizedlist> + +<command>weechat.look.set_title</command> +<itemizedlist> + <listitem> + <para>description: set title for window (terminal for Curses GUI) with name and version</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.plugin.autoload</command> +<itemizedlist> + <listitem> + <para>description: comma separated list of plugins to load automatically at startup, "*" means all plugins found (names may be partial, for example "perl" is ok for "perl.so")</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '*'</para> + </listitem> +</itemizedlist> + +<command>weechat.plugin.debug</command> +<itemizedlist> + <listitem> + <para>description: enable debug messages by default in all plugins (option disabled by default, which is highly recommended)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.plugin.extension</command> +<itemizedlist> + <listitem> + <para>description: standard plugins extension in filename (for example ".so" under Linux or ".dll" under Microsoft Windows)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '.so'</para> + </listitem> +</itemizedlist> + +<command>weechat.plugin.path</command> +<itemizedlist> + <listitem> + <para>description: path for searching plugins ('%h' will be replaced by WeeChat home, ~/.weechat by default)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '%h/plugins'</para> + </listitem> +</itemizedlist> + +<command>weechat.plugin.save_config_on_unload</command> +<itemizedlist> + <listitem> + <para>description: save configuration files when unloading plugins</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.address</command> +<itemizedlist> + <listitem> + <para>description: proxy server address (IP or hostname)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.ipv6</command> +<itemizedlist> + <listitem> + <para>description: connect to proxy using ipv6</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.password</command> +<itemizedlist> + <listitem> + <para>description: password for proxy server</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.port</command> +<itemizedlist> + <listitem> + <para>description: port for connecting to proxy server</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 65535</para> + </listitem> + <listitem> + <para>default value: 3128</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.type</command> +<itemizedlist> + <listitem> + <para>description: proxy type (http (default), socks4, socks5)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: http, socks4, socks5</para> + </listitem> + <listitem> + <para>default value: http</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.use</command> +<itemizedlist> + <listitem> + <para>description: use a proxy server</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>weechat.proxy.username</command> +<itemizedlist> + <listitem> + <para>description: username for proxy server</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.startup.command_after_plugins</command> +<itemizedlist> + <listitem> + <para>description: command executed when WeeChat starts, after loading plugins</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.startup.command_before_plugins</command> +<itemizedlist> + <listitem> + <para>description: command executed when WeeChat starts, before loading plugins</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>weechat.startup.display_logo</command> +<itemizedlist> + <listitem> + <para>description: display WeeChat logo at startup</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.startup.display_version</command> +<itemizedlist> + <listitem> + <para>description: display WeeChat version at startup</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>weechat.startup.weechat_slogan</command> +<itemizedlist> + <listitem> + <para>description: WeeChat slogan (if empty, slogan is not used)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: 'le client de discussion le plus geek !'</para> + </listitem> +</itemizedlist> + diff --git a/doc/en/autogen/xfer_commands.xml b/doc/en/autogen/xfer_commands.xml new file mode 100644 index 000000000..d1f51d2e2 --- /dev/null +++ b/doc/en/autogen/xfer_commands.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>xfer</command> +<programlisting> +xfer control + +Open buffer with xfer list +</programlisting> diff --git a/doc/en/autogen/xfer_infos.xml b/doc/en/autogen/xfer_infos.xml new file mode 100644 index 000000000..0a67e3420 --- /dev/null +++ b/doc/en/autogen/xfer_infos.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<row> + <entry>infolist</entry> + <entry>xfer</entry> + <entry>list of xfer</entry> +</row> diff --git a/doc/en/autogen/xfer_options.xml b/doc/en/autogen/xfer_options.xml new file mode 100644 index 000000000..f09e4cfae --- /dev/null +++ b/doc/en/autogen/xfer_options.xml @@ -0,0 +1,408 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ********* WARNING! ********* + + This file is autogenerated with docgen.pl script. *** DO NOT EDIT! *** + docgen.pl builds XML doc files to include in many languages +--> + +<command>xfer.color.status_aborted</command> +<itemizedlist> + <listitem> + <para>description: text color for "aborted" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightred</para> + </listitem> +</itemizedlist> + +<command>xfer.color.status_active</command> +<itemizedlist> + <listitem> + <para>description: text color for "active" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightblue</para> + </listitem> +</itemizedlist> + +<command>xfer.color.status_connecting</command> +<itemizedlist> + <listitem> + <para>description: text color for "connecting" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: yellow</para> + </listitem> +</itemizedlist> + +<command>xfer.color.status_done</command> +<itemizedlist> + <listitem> + <para>description: text color for "done" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightgreen</para> + </listitem> +</itemizedlist> + +<command>xfer.color.status_failed</command> +<itemizedlist> + <listitem> + <para>description: text color for "failed" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightred</para> + </listitem> +</itemizedlist> + +<command>xfer.color.status_waiting</command> +<itemizedlist> + <listitem> + <para>description: text color for "waiting" status</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: lightcyan</para> + </listitem> +</itemizedlist> + +<command>xfer.color.text</command> +<itemizedlist> + <listitem> + <para>description: text color</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>xfer.color.text_bg</command> +<itemizedlist> + <listitem> + <para>description: background color</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: default</para> + </listitem> +</itemizedlist> + +<command>xfer.color.text_selected</command> +<itemizedlist> + <listitem> + <para>description: text color of selected xfer line</para> + </listitem> + <listitem> + <para>type: color</para> + </listitem> + <listitem> + <para>values: a color name</para> + </listitem> + <listitem> + <para>default value: white</para> + </listitem> +</itemizedlist> + +<command>xfer.file.auto_accept_chats</command> +<itemizedlist> + <listitem> + <para>description: automatically accept chat requests (use carefully!)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>xfer.file.auto_accept_files</command> +<itemizedlist> + <listitem> + <para>description: automatically accept incoming files (use carefully!)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: off</para> + </listitem> +</itemizedlist> + +<command>xfer.file.auto_rename</command> +<itemizedlist> + <listitem> + <para>description: rename incoming files if already exists (add '.1', '.2', ...)</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.file.auto_resume</command> +<itemizedlist> + <listitem> + <para>description: automatically resume file transfer if connection with remote host is lost</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.file.convert_spaces</command> +<itemizedlist> + <listitem> + <para>description: convert spaces to underscores when sending files</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.file.download_path</command> +<itemizedlist> + <listitem> + <para>description: path for writing incoming files</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '%h/xfer'</para> + </listitem> +</itemizedlist> + +<command>xfer.file.upload_path</command> +<itemizedlist> + <listitem> + <para>description: path for reading files when sending (when no path is specified by user)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: '~'</para> + </listitem> +</itemizedlist> + +<command>xfer.file.use_nick_in_filename</command> +<itemizedlist> + <listitem> + <para>description: use remote nick as prefix in local filename when receiving a file</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.look.auto_open_buffer</command> +<itemizedlist> + <listitem> + <para>description: auto open xfer buffer when a new xfer is added to list</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.look.progress_bar_size</command> +<itemizedlist> + <listitem> + <para>description: size of progress bar, in chars (if 0, progress bar is disabled)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 256</para> + </listitem> + <listitem> + <para>default value: 20</para> + </listitem> +</itemizedlist> + +<command>xfer.network.blocksize</command> +<itemizedlist> + <listitem> + <para>description: block size for sending packets, in bytes</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 1024 .. 102400</para> + </listitem> + <listitem> + <para>default value: 65536</para> + </listitem> +</itemizedlist> + +<command>xfer.network.fast_send</command> +<itemizedlist> + <listitem> + <para>description: does not wait for ACK when sending file</para> + </listitem> + <listitem> + <para>type: boolean</para> + </listitem> + <listitem> + <para>values: on, off</para> + </listitem> + <listitem> + <para>default value: on</para> + </listitem> +</itemizedlist> + +<command>xfer.network.own_ip</command> +<itemizedlist> + <listitem> + <para>description: IP or DNS address used for sending files/chats (if empty, local interface IP is used)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>xfer.network.port_range</command> +<itemizedlist> + <listitem> + <para>description: restricts outgoing files/chats to use only ports in the given range (useful for NAT) (syntax: a single port, ie. 5000 or a port range, ie. 5000-5015, empty value means any port)</para> + </listitem> + <listitem> + <para>type: string</para> + </listitem> + <listitem> + <para>values: any string</para> + </listitem> + <listitem> + <para>default value: ''</para> + </listitem> +</itemizedlist> + +<command>xfer.network.speed_limit</command> +<itemizedlist> + <listitem> + <para>description: speed limit for sending files, in kilo-bytes by second (0 means no limit)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 0 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 0</para> + </listitem> +</itemizedlist> + +<command>xfer.network.timeout</command> +<itemizedlist> + <listitem> + <para>description: timeout for xfer request (in seconds)</para> + </listitem> + <listitem> + <para>type: integer</para> + </listitem> + <listitem> + <para>values: 5 .. 2147483647</para> + </listitem> + <listitem> + <para>default value: 300</para> + </listitem> +</itemizedlist> + |