weechat/doc/en/autogen/irc_options.xml

419 lines
12 KiB
XML

<?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.color.input_nick</command>: color for nick in input bar
<itemizedlist>
<listitem>
<para>type: color</para>
</listitem>
<listitem>
<para>values: a color name (default value: lightcyan)</para>
</listitem>
</itemizedlist>
<command>irc.look.display_away</command>: display message when (un)marking as away
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: off, local, channel (default value: local)</para>
</listitem>
</itemizedlist>
<command>irc.look.display_channel_modes</command>: display channel modes in "buffer_name" bar item
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.look.hide_nickserv_pwd</command>: hide password displayed by nickserv
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.look.highlight_tags</command>: comma separated list of tags for messages that may produce highlight (usually any message from another user, not server messages,..)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: 'irc_privmsg,irc_notice')</para>
</listitem>
</itemizedlist>
<command>irc.look.nick_completion_smart</command>: smart completion for nicks (completes with last speakers first)
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.look.nick_prefix</command>: text to display before nick in chat window
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.look.nick_suffix</command>: text to display after nick in chat window
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.look.notice_as_pv</command>: display notices as private messages
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.look.one_server_buffer</command>: use same buffer for all servers
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.look.open_near_server</command>: open new channels/privates near server
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.look.show_away_once</command>: show remote away message only once in private
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.look.smart_filter</command>: filter join/part/quit messages for a nick if not speaking for some minutes on channel (you must create a filter on tag "irc_smart_filter")
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.look.smart_filter_delay</command>: delay for filtering join/part/quit messages (in minutes)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 1 .. 10080 (default value: 5)</para>
</listitem>
</itemizedlist>
<command>irc.network.anti_flood</command>: anti-flood: # seconds between two user messages (0 = no anti-flood)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 5 (default value: 2)</para>
</listitem>
</itemizedlist>
<command>irc.network.away_check</command>: interval between two checks for away (in minutes, 0 = never check)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 2147483647 (default value: 0)</para>
</listitem>
</itemizedlist>
<command>irc.network.away_check_max_nicks</command>: do not check away nicks on channels with high number of nicks (0 = unlimited)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 2147483647 (default value: 0)</para>
</listitem>
</itemizedlist>
<command>irc.network.colors_receive</command>: when off, colors codes are ignored in incoming messages
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.network.colors_send</command>: allow user to send colors with special codes (^Cb=bold, ^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, ^Cr=reverse)
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.network.default_msg_part</command>: default part message (leaving channel) ('%v' will be replaced by WeeChat version in string)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: 'WeeChat %v')</para>
</listitem>
</itemizedlist>
<command>irc.network.default_msg_quit</command>: default quit message (disconnecting from server) ('%v' will be replaced by WeeChat version in string)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: 'WeeChat %v')</para>
</listitem>
</itemizedlist>
<command>irc.network.lag_check</command>: interval between two checks for lag (in seconds, 0 = never check)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 2147483647 (default value: 60)</para>
</listitem>
</itemizedlist>
<command>irc.network.lag_disconnect</command>: disconnect after important lag (in minutes, 0 = never disconnect)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 2147483647 (default value: 5)</para>
</listitem>
</itemizedlist>
<command>irc.network.lag_min_show</command>: minimum lag to show (in seconds)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 2147483647 (default value: 1)</para>
</listitem>
</itemizedlist>
<command>irc.network.send_unknown_commands</command>: send unknown commands to IRC server
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.addresses</command>: list of IP/port or hostname/port for server (separated by comma)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.autoconnect</command>: automatically connect to server when WeeChat is starting
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.autojoin</command>: comma separated list of channels to join when connected to server (example: "#chan1,#chan2,#chan3 key1,key2")
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.autoreconnect</command>: automatically reconnect to server when disconnected
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: on)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.autoreconnect_delay</command>: delay (in seconds) before trying again to reconnect to server
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 65535 (default value: 30)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.autorejoin</command>: automatically rejoin channels when kicked
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.command</command>: 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)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.command_delay</command>: delay (in seconds) after command was executed (example: give some time for authentication)
<itemizedlist>
<listitem>
<para>type: integer</para>
</listitem>
<listitem>
<para>values: 0 .. 3600 (default value: 0)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.ipv6</command>: use IPv6 protocol for server communication
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.local_hostname</command>: custom local hostname/IP for server (optional, if empty local hostname is used)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.nicks</command>: nicknames to use on IRC server (separated by comma)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.password</command>: password for IRC server
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.proxy</command>: proxy used for this server (optional)
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.realname</command>: real name to use on IRC server
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>
<command>irc.server_default.ssl</command>: use SSL for server communication
<itemizedlist>
<listitem>
<para>type: boolean</para>
</listitem>
<listitem>
<para>values: on, off (default value: off)</para>
</listitem>
</itemizedlist>
<command>irc.server_default.username</command>: user name to use on IRC server
<itemizedlist>
<listitem>
<para>type: string</para>
</listitem>
<listitem>
<para>values: any string (default value: '')</para>
</listitem>
</itemizedlist>