diff options
Diffstat (limited to 'doc/en/autogen/irc_options.xml')
| -rw-r--r-- | doc/en/autogen/irc_options.xml | 632 |
1 files changed, 632 insertions, 0 deletions
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> + |