diff options
author | dx <dx@dxzone.com.ar> | 2016-07-25 17:07:49 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-07-25 17:07:49 -0300 |
commit | c22acb6c6265673a013805f2f190364b4d5d1dea (patch) | |
tree | aee50cbee0abe57ce70a76049b7c9ea2b6e01ffc | |
parent | 60ecd79396e2881c3c6b11a2597bfc4e1d17bd55 (diff) | |
parent | 6cec5c19c9becb6e50b0bf4173363541df7de3cb (diff) | |
download | irssi.github.io-c22acb6c6265673a013805f2f190364b4d5d1dea.zip |
Merge pull request #26 from dequis/settings-stuff
Settings page revamp
-rw-r--r-- | _includes/sb_sidebar_settings.html | 283 | ||||
-rw-r--r-- | documentation/settings/index.markdown | 1280 |
2 files changed, 736 insertions, 827 deletions
diff --git a/_includes/sb_sidebar_settings.html b/_includes/sb_sidebar_settings.html index ec37efe..dd3ec52 100644 --- a/_includes/sb_sidebar_settings.html +++ b/_includes/sb_sidebar_settings.html @@ -7,7 +7,8 @@ <option value="activity_hide_targets">activity_hide_targets</option> <option value="activity_hilight_level">activity_hilight_level</option> <option value="activity_msg_level">activity_msg_level</option> - <option value="actlist_moves">actlist_moves</option> + <option value="actlist_names">actlist_names</option> + <option value="actlist_sort">actlist_sort</option> <option value="alternate_nick">alternate_nick</option> <option value="auto_whowas">auto_whowas</option> <option value="autoclose_query">autoclose_query</option> @@ -21,6 +22,7 @@ <option value="autoignore_time">autoignore_time</option> <option value="autolog">autolog</option> <option value="autolog_colors">autolog_colors</option> + <option value="autolog_ignore_targets">autolog_ignore_targets</option> <option value="autolog_level">autolog_level</option> <option value="autolog_path">autolog_path</option> <option value="autostick_split_windows">autostick_split_windows</option> @@ -64,6 +66,7 @@ <option value="dcc_timeout">dcc_timeout</option> <option value="dcc_upload_path">dcc_upload_path</option> <option value="emphasis">emphasis</option> + <option value="emphasis_italics">emphasis_italics</option> <option value="emphasis_multiword">emphasis_multiword</option> <option value="emphasis_replace">emphasis_replace</option> <option value="expand_escapes">expand_escapes</option> @@ -79,6 +82,7 @@ <option value="hilight_color">hilight_color</option> <option value="hilight_level">hilight_level</option> <option value="hilight_nick_matches">hilight_nick_matches</option> + <option value="hilight_nick_matches_everywhere">hilight_nick_matches_everywhere</option> <option value="hostname">hostname</option> <option value="ignore_signals">ignore_signals</option> <option value="indent">indent</option> @@ -108,14 +112,13 @@ <option value="netsplit_nicks_hide_threshold">netsplit_nicks_hide_threshold</option> <option value="nick">nick</option> <option value="notify_check_time">notify_check_time</option> - <option value="notify_idle_time">notify_idle_time</option> <option value="notify_whois_time">notify_whois_time</option> <option value="opermode">opermode</option> <option value="override_coredump_limit">override_coredump_limit</option> <option value="part_message">part_message</option> - <option value="paste_detect_keycount">paste_detect_keycount</option> <option value="paste_detect_time">paste_detect_time</option> <option value="paste_join_multiline">paste_join_multiline</option> + <option value="paste_use_bracketed_mode">paste_use_bracketed_mode</option> <option value="paste_verify_line_count">paste_verify_line_count</option> <option value="perl_use_lib">perl_use_lib</option> <option value="print_active_channel">print_active_channel</option> @@ -140,7 +143,6 @@ <option value="scroll_page_count">scroll_page_count</option> <option value="scrollback_burst_remove">scrollback_burst_remove</option> <option value="scrollback_lines">scrollback_lines</option> - <option value="scrollback_save_formats">scrollback_save_formats</option> <option value="scrollback_time">scrollback_time</option> <option value="server_connect_timeout">server_connect_timeout</option> <option value="server_reconnect_time">server_reconnect_time</option> @@ -152,13 +154,11 @@ <option value="show_own_nickchange_once">show_own_nickchange_once</option> <option value="show_quit_once">show_quit_once</option> <option value="skip_motd">skip_motd</option> - <option value="ssl_cacert">ssl_cacert</option> - <option value="ssl_cafile">ssl_cafile</option> - <option value="ssl_cert">ssl_cert</option> - <option value="ssl_pkey">ssl_pkey</option> - <option value="ssl_verify">ssl_verify</option> + <option value="split_line_end">split_line_end</option> + <option value="split_line_on_space">split_line_on_space</option> + <option value="split_line_start">split_line_start</option> <option value="STATUS_OPER">STATUS_OPER</option> - <option value="term_auto_detach">term_auto_detach</option> + <option value="term_appkey_mode">term_appkey_mode</option> <option value="term_charset">term_charset</option> <option value="term_force_colors">term_force_colors</option> <option value="theme">theme</option> @@ -166,10 +166,8 @@ <option value="timestamp_level">timestamp_level</option> <option value="timestamp_timeout">timestamp_timeout</option> <option value="timestamps">timestamps</option> - <option value="translation">translation</option> <option value="use_msgs_window">use_msgs_window</option> <option value="use_proxy">use_proxy</option> - <option value="use_ssl">use_ssl</option> <option value="use_status_window">use_status_window</option> <option value="user_name">user_name</option> <option value="usermode">usermode</option> @@ -187,202 +185,201 @@ <p> <select name="cat_completion" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- completion --]</option> - <option value="completion_strict">completion_strict</option> - <option value="completion_keep_privates">completion_keep_privates</option> - <option value="completion_char">completion_char</option> <option value="completion_auto">completion_auto</option> - <option value="completion_nicks_lowercase">completion_nicks_lowercase</option> + <option value="completion_char">completion_char</option> + <option value="completion_keep_privates">completion_keep_privates</option> <option value="completion_keep_publics">completion_keep_publics</option> + <option value="completion_nicks_lowercase">completion_nicks_lowercase</option> + <option value="completion_strict">completion_strict</option> </select> <select name="cat_dcc" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- dcc --]</option> - <option value="dcc_autorename">dcc_autorename</option> - <option value="dcc_autoresume">dcc_autoresume</option> - <option value="dcc_timeout">dcc_timeout</option> + <option value="dcc_autoaccept_lowports">dcc_autoaccept_lowports</option> + <option value="dcc_autochat_masks">dcc_autochat_masks</option> <option value="dcc_autoget">dcc_autoget</option> - <option value="dcc_upload_path">dcc_upload_path</option> <option value="dcc_autoget_masks">dcc_autoget_masks</option> <option value="dcc_autoget_max_size">dcc_autoget_max_size</option> - <option value="dcc_send_replace_space_with_underscore">dcc_send_replace_space_with_underscore</option> - <option value="dcc_own_ip">dcc_own_ip</option> + <option value="dcc_autorename">dcc_autorename</option> + <option value="dcc_autoresume">dcc_autoresume</option> <option value="dcc_download_path">dcc_download_path</option> <option value="dcc_file_create_mode">dcc_file_create_mode</option> - <option value="dcc_port">dcc_port</option> - <option value="dcc_autochat_masks">dcc_autochat_masks</option> <option value="dcc_mirc_ctcp">dcc_mirc_ctcp</option> - <option value="dcc_autoaccept_lowports">dcc_autoaccept_lowports</option> + <option value="dcc_own_ip">dcc_own_ip</option> + <option value="dcc_port">dcc_port</option> + <option value="dcc_send_replace_space_with_underscore">dcc_send_replace_space_with_underscore</option> + <option value="dcc_timeout">dcc_timeout</option> + <option value="dcc_upload_path">dcc_upload_path</option> </select> <select name="cat_flood" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- flood --]</option> - <option value="autoignore_time">autoignore_time</option> <option value="autoignore_level">autoignore_level</option> + <option value="autoignore_time">autoignore_time</option> + <option value="cmd_queue_speed">cmd_queue_speed</option> + <option value="cmds_max_at_once">cmds_max_at_once</option> <option value="flood_max_msgs">flood_max_msgs</option> <option value="flood_timecheck">flood_timecheck</option> - <option value="cmds_max_at_once">cmds_max_at_once</option> - <option value="cmd_queue_speed">cmd_queue_speed</option> <option value="max_ctcp_queue">max_ctcp_queue</option> </select> <select name="cat_history" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- history --]</option> - <option value="scrollback_save_formats">scrollback_save_formats</option> - <option value="scroll_page_count">scroll_page_count</option> - <option value="window_history">window_history</option> <option value="max_command_history">max_command_history</option> - <option value="scrollback_time">scrollback_time</option> <option value="rawlog_lines">rawlog_lines</option> - <option value="scrollback_lines">scrollback_lines</option> + <option value="scroll_page_count">scroll_page_count</option> <option value="scrollback_burst_remove">scrollback_burst_remove</option> + <option value="scrollback_lines">scrollback_lines</option> + <option value="scrollback_time">scrollback_time</option> + <option value="window_history">window_history</option> </select> <select name="cat_log" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- log --]</option> - <option value="log_close_string">log_close_string</option> - <option value="log_timestamp">log_timestamp</option> + <option value="autolog">autolog</option> <option value="autolog_colors">autolog_colors</option> + <option value="autolog_ignore_targets">autolog_ignore_targets</option> <option value="autolog_level">autolog_level</option> - <option value="awaylog_colors">awaylog_colors</option> - <option value="log_day_changed">log_day_changed</option> - <option value="autolog">autolog</option> <option value="autolog_path">autolog_path</option> - <option value="awaylog_level">awaylog_level</option> + <option value="awaylog_colors">awaylog_colors</option> <option value="awaylog_file">awaylog_file</option> - <option value="log_theme">log_theme</option> + <option value="awaylog_level">awaylog_level</option> + <option value="log_close_string">log_close_string</option> <option value="log_create_mode">log_create_mode</option> + <option value="log_day_changed">log_day_changed</option> <option value="log_open_string">log_open_string</option> + <option value="log_theme">log_theme</option> + <option value="log_timestamp">log_timestamp</option> </select> <select name="cat_lookandfeel" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- lookandfeel --]</option> - <option value="show_names_on_join">show_names_on_join</option> - <option value="window_check_level_first">window_check_level_first</option> - <option value="window_default_level">window_default_level</option> - <option value="emphasis">emphasis</option> + <option value="active_window_ignore_refnum">active_window_ignore_refnum</option> + <option value="activity_hide_level">activity_hide_level</option> + <option value="activity_hide_targets">activity_hide_targets</option> + <option value="activity_hilight_level">activity_hilight_level</option> + <option value="activity_msg_level">activity_msg_level</option> + <option value="actlist_names">actlist_names</option> + <option value="actlist_sort">actlist_sort</option> + <option value="autoclose_query">autoclose_query</option> + <option value="autoclose_windows">autoclose_windows</option> + <option value="autocreate_own_query">autocreate_own_query</option> + <option value="autocreate_query_level">autocreate_query_level</option> <option value="autocreate_split_windows">autocreate_split_windows</option> + <option value="autocreate_windows">autocreate_windows</option> + <option value="autofocus_new_items">autofocus_new_items</option> + <option value="autostick_split_windows">autostick_split_windows</option> <option value="beep_msg_level">beep_msg_level</option> - <option value="actlist_moves">actlist_moves</option> - <option value="hilight_nick_matches">hilight_nick_matches</option> + <option value="beep_when_away">beep_when_away</option> + <option value="beep_when_window_active">beep_when_window_active</option> + <option value="bell_beeps">bell_beeps</option> + <option value="chanmode_expando_strip">chanmode_expando_strip</option> + <option value="colors">colors</option> + <option value="emphasis">emphasis</option> + <option value="emphasis_italics">emphasis_italics</option> <option value="emphasis_multiword">emphasis_multiword</option> + <option value="emphasis_replace">emphasis_replace</option> + <option value="expand_escapes">expand_escapes</option> <option value="hide_colors">hide_colors</option> - <option value="names_max_width">names_max_width</option> - <option value="mirc_blink_fix">mirc_blink_fix</option> - <option value="autoclose_windows">autoclose_windows</option> - <option value="bell_beeps">bell_beeps</option> <option value="hide_server_tags">hide_server_tags</option> - <option value="show_nickmode">show_nickmode</option> - <option value="theme">theme</option> - <option value="timestamps">timestamps</option> - <option value="indent">indent</option> - <option value="timestamp_format">timestamp_format</option> - <option value="activity_msg_level">activity_msg_level</option> - <option value="print_active_channel">print_active_channel</option> - <option value="autoclose_query">autoclose_query</option> - <option value="activity_hide_targets">activity_hide_targets</option> - <option value="use_msgs_window">use_msgs_window</option> - <option value="timestamp_timeout">timestamp_timeout</option> - <option value="use_status_window">use_status_window</option> - <option value="windows_auto_renumber">windows_auto_renumber</option> - <option value="show_nickmode_empty">show_nickmode_empty</option> - <option value="beep_when_away">beep_when_away</option> - <option value="timestamp_level">timestamp_level</option> - <option value="indent_always">indent_always</option> + <option value="hide_text_style">hide_text_style</option> + <option value="hilight_act_color">hilight_act_color</option> <option value="hilight_color">hilight_color</option> - <option value="emphasis_replace">emphasis_replace</option> <option value="hilight_level">hilight_level</option> - <option value="hilight_act_color">hilight_act_color</option> - <option value="expand_escapes">expand_escapes</option> - <option value="autocreate_windows">autocreate_windows</option> - <option value="autocreate_query_level">autocreate_query_level</option> - <option value="term_auto_detach">term_auto_detach</option> - <option value="hide_text_style">hide_text_style</option> - <option value="whois_hide_safe_channel_id">whois_hide_safe_channel_id</option> + <option value="hilight_nick_matches">hilight_nick_matches</option> + <option value="hilight_nick_matches_everywhere">hilight_nick_matches_everywhere</option> + <option value="indent">indent</option> + <option value="indent_always">indent_always</option> + <option value="mirc_blink_fix">mirc_blink_fix</option> <option value="names_max_columns">names_max_columns</option> - <option value="chanmode_expando_strip">chanmode_expando_strip</option> - <option value="show_quit_once">show_quit_once</option> - <option value="show_away_once">show_away_once</option> - <option value="autocreate_own_query">autocreate_own_query</option> - <option value="term_charset">term_charset</option> - <option value="activity_hilight_level">activity_hilight_level</option> - <option value="autostick_split_windows">autostick_split_windows</option> + <option value="names_max_width">names_max_width</option> + <option value="print_active_channel">print_active_channel</option> <option value="query_track_nick_changes">query_track_nick_changes</option> + <option value="reuse_unused_windows">reuse_unused_windows</option> <option value="scroll">scroll</option> - <option value="window_auto_change">window_auto_change</option> - <option value="beep_when_window_active">beep_when_window_active</option> - <option value="activity_hide_level">activity_hide_level</option> + <option value="show_away_once">show_away_once</option> + <option value="show_names_on_join">show_names_on_join</option> + <option value="show_nickmode">show_nickmode</option> + <option value="show_nickmode_empty">show_nickmode_empty</option> <option value="show_own_nickchange_once">show_own_nickchange_once</option> - <option value="reuse_unused_windows">reuse_unused_windows</option> - <option value="colors">colors</option> + <option value="show_quit_once">show_quit_once</option> + <option value="term_appkey_mode">term_appkey_mode</option> + <option value="term_charset">term_charset</option> <option value="term_force_colors">term_force_colors</option> - <option value="autofocus_new_items">autofocus_new_items</option> + <option value="theme">theme</option> + <option value="timestamp_format">timestamp_format</option> + <option value="timestamp_level">timestamp_level</option> + <option value="timestamp_timeout">timestamp_timeout</option> + <option value="timestamps">timestamps</option> + <option value="use_msgs_window">use_msgs_window</option> + <option value="use_status_window">use_status_window</option> + <option value="whois_hide_safe_channel_id">whois_hide_safe_channel_id</option> + <option value="window_auto_change">window_auto_change</option> + <option value="window_check_level_first">window_check_level_first</option> + <option value="window_default_level">window_default_level</option> + <option value="windows_auto_renumber">windows_auto_renumber</option> </select> <select name="cat_misc" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- misc --]</option> - <option value="opermode">opermode</option> + <option value="auto_whowas">auto_whowas</option> + <option value="ban_type">ban_type</option> <option value="channel_max_who_sync">channel_max_who_sync</option> - <option value="recode_autodetect_utf8">recode_autodetect_utf8</option> - <option value="lag_check_time">lag_check_time</option> - <option value="quit_message">quit_message</option> - <option value="paste_detect_time">paste_detect_time</option> - <option value="notify_check_time">notify_check_time</option> - <option value="help_path">help_path</option> - <option value="ctcp_userinfo_reply">ctcp_userinfo_reply</option> - <option value="override_coredump_limit">override_coredump_limit</option> - <option value="join_auto_chans_on_invite">join_auto_chans_on_invite</option> - <option value="netjoin_max_nicks">netjoin_max_nicks</option> - <option value="paste_join_multiline">paste_join_multiline</option> <option value="channel_sync">channel_sync</option> - <option value="paste_detect_keycount">paste_detect_keycount</option> - <option value="recode_fallback">recode_fallback</option> - <option value="notify_idle_time">notify_idle_time</option> - <option value="massjoin_max_joins">massjoin_max_joins</option> - <option value="write_buffer_size">write_buffer_size</option> - <option value="write_buffer_timeout">write_buffer_timeout</option> - <option value="STATUS_OPER">STATUS_OPER</option> - <option value="recode">recode</option> - <option value="ban_type">ban_type</option> - <option value="lag_max_before_disconnect">lag_max_before_disconnect</option> - <option value="part_message">part_message</option> - <option value="auto_whowas">auto_whowas</option> - <option value="paste_verify_line_count">paste_verify_line_count</option> - <option value="max_wildcard_modes">max_wildcard_modes</option> + <option value="cmdchars">cmdchars</option> + <option value="ctcp_userinfo_reply">ctcp_userinfo_reply</option> + <option value="ctcp_version_reply">ctcp_version_reply</option> + <option value="group_multi_mode">group_multi_mode</option> + <option value="help_path">help_path</option> <option value="hide_netsplit_quits">hide_netsplit_quits</option> + <option value="ignore_signals">ignore_signals</option> + <option value="join_auto_chans_on_invite">join_auto_chans_on_invite</option> + <option value="kick_first_on_kickban">kick_first_on_kickban</option> <option value="knockout_time">knockout_time</option> - <option value="massjoin_max_wait">massjoin_max_wait</option> + <option value="lag_check_time">lag_check_time</option> + <option value="lag_max_before_disconnect">lag_max_before_disconnect</option> <option value="lag_min_show">lag_min_show</option> - <option value="wall_format">wall_format</option> + <option value="massjoin_max_joins">massjoin_max_joins</option> + <option value="massjoin_max_wait">massjoin_max_wait</option> + <option value="max_wildcard_modes">max_wildcard_modes</option> + <option value="netjoin_max_nicks">netjoin_max_nicks</option> + <option value="netsplit_max_nicks">netsplit_max_nicks</option> <option value="netsplit_nicks_hide_threshold">netsplit_nicks_hide_threshold</option> - <option value="settings_autosave">settings_autosave</option> - <option value="translation">translation</option> - <option value="group_multi_mode">group_multi_mode</option> - <option value="recode_out_default_charset">recode_out_default_charset</option> - <option value="cmdchars">cmdchars</option> + <option value="notify_check_time">notify_check_time</option> <option value="notify_whois_time">notify_whois_time</option> - <option value="kick_first_on_kickban">kick_first_on_kickban</option> + <option value="opermode">opermode</option> + <option value="override_coredump_limit">override_coredump_limit</option> + <option value="part_message">part_message</option> + <option value="paste_detect_time">paste_detect_time</option> + <option value="paste_join_multiline">paste_join_multiline</option> + <option value="paste_use_bracketed_mode">paste_use_bracketed_mode</option> + <option value="paste_verify_line_count">paste_verify_line_count</option> + <option value="quit_message">quit_message</option> + <option value="recode">recode</option> + <option value="recode_autodetect_utf8">recode_autodetect_utf8</option> + <option value="recode_fallback">recode_fallback</option> + <option value="recode_out_default_charset">recode_out_default_charset</option> <option value="recode_transliterate">recode_transliterate</option> + <option value="settings_autosave">settings_autosave</option> + <option value="split_line_end">split_line_end</option> + <option value="split_line_on_space">split_line_on_space</option> + <option value="split_line_start">split_line_start</option> + <option value="STATUS_OPER">STATUS_OPER</option> <option value="usermode">usermode</option> - <option value="ignore_signals">ignore_signals</option> - <option value="netsplit_max_nicks">netsplit_max_nicks</option> - <option value="ctcp_version_reply">ctcp_version_reply</option> + <option value="wall_format">wall_format</option> + <option value="write_buffer_size">write_buffer_size</option> + <option value="write_buffer_timeout">write_buffer_timeout</option> </select> <select name="cat_perl" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- perl --]</option> <option value="perl_use_lib">perl_use_lib</option> </select> <select name="cat_proxy" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- proxy --]</option> - <option value="use_proxy">use_proxy</option> - <option value="proxy_string">proxy_string</option> - <option value="proxy_string_after">proxy_string_after</option> <option value="proxy_address">proxy_address</option> - <option value="proxy_port">proxy_port</option> <option value="proxy_password">proxy_password</option> + <option value="proxy_port">proxy_port</option> + <option value="proxy_string">proxy_string</option> + <option value="proxy_string_after">proxy_string_after</option> + <option value="use_proxy">use_proxy</option> </select> <select name="cat_server" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- server --]</option> - <option value="server_connect_timeout">server_connect_timeout</option> - <option value="resolve_reverse_lookup">resolve_reverse_lookup</option> - <option value="ssl_cacert">ssl_cacert</option> - <option value="ssl_cafile">ssl_cafile</option> - <option value="ssl_cert">ssl_cert</option> - <option value="ssl_pkey">ssl_pkey</option> - <option value="ssl_verify">ssl_verify</option> - <option value="use_ssl">use_ssl</option> + <option value="alternate_nick">alternate_nick</option> <option value="hostname">hostname</option> - <option value="user_name">user_name</option> - <option value="resolve_prefer_ipv6">resolve_prefer_ipv6</option> <option value="nick">nick</option> - <option value="alternate_nick">alternate_nick</option> <option value="real_name">real_name</option> - <option value="skip_motd">skip_motd</option> + <option value="resolve_prefer_ipv6">resolve_prefer_ipv6</option> + <option value="resolve_reverse_lookup">resolve_reverse_lookup</option> + <option value="server_connect_timeout">server_connect_timeout</option> <option value="server_reconnect_time">server_reconnect_time</option> + <option value="skip_motd">skip_motd</option> + <option value="user_name">user_name</option> </select> <select name="cat_servers" onchange="location.hash='#' + options[options.selectedIndex].value;selectedIndex=0"> <option class="header" value="">[-- servers --]</option> <option value="channels_rejoin_unavailable">channels_rejoin_unavailable</option> @@ -398,7 +395,5 @@ <br /> <a href="#a_d">D: Color Codes</a> <br /> - <a href="#a_e">E: TRANSLATION</a> - <br /> - <a href="#a_f">Appendix F</a> + <a href="#a_credits">E: Credits and copyright</a> </p> diff --git a/documentation/settings/index.markdown b/documentation/settings/index.markdown index 6ae0ccc..a1a9a78 100644 --- a/documentation/settings/index.markdown +++ b/documentation/settings/index.markdown @@ -5,72 +5,14 @@ permalink: documentation/settings/ sidebar: sb_sidebar_settings.html licence: "[Creative Commons Attribution-ShareAlike 2.5 License](http://creativecommons.org/licenses/by-sa/2.5/)" --- -Irssi 0.8.10 settings notes. Gathered through much effort by Rocco Caputo rcaputo at cpan dot org (aka dngor). Includes original work by Nei, and advice and guidance from irc.freenode.net #irssi. +Irssi settings notes. Updated for 0.8.19. This is not an attempt to document Irssi completely. It should be used along with the documents at [Documentation](/documentation) for more complete understanding of how irssi works. For example, the startup HOWTO and tips/tricks show sample uses for these settings, including some very useful stuff. -We respect the work of others. Parts of this document have been collected from other locations. Wherever possible, we have made every effort to locate and attribute the original authors. Please let us know if we've overlooked you. - -We ask the same respect in return. The Copyright and license notices are at the end. - -* * * - -2008-Apr-20: (dngor) - -> Added a FAQ. - -2005-Dec-08: (dngor) - -> Switched to Creative Commons' ShareAlike license. We'd like to thank Coekie coekie@irssi.org for pointing out out that the previous license was weak, and that he could just alter it and redistribute our work without attribution. -> -> Minor revisions throughout a major portion of the document. - -2005-Dec-07: (Nei) - -> Set example values to default values where appropriate. Add new settings from 0.8.10. Sorted settings according to my local /set output. -> -> (dngor) Marked the 0.8.10 settings as coming from that version. - -2005-Dec-01: (Nei) - -> Updated some links. Renamed term_type. - -2005-06-05: (dngor) - -> Tweaked an example to use the same command the surrounding text said it was. - -2005-05-04: (dngor) - -> Not terribly significant. All edits happened in the introduction. - -* * * +See the [appendix](#a_credits) for credits and license information of this document. ## [completion] -{:#completion_strict} -` completion_strict = OFF ` - -> When on, nicknames are matched strictly. That is, the partial nickname you enter must be at the beginning of a nickname in one of irssi's lists. -> -> When off, irssi will first try a strict match. If a strict match can't be found, irssi will look for nicknames that match when their leading non-alphanumeric characters are removed. For example: -> ->> ->> vis: hello -> -> With strict completion on, it will only match nicknames beginning with vis. With strict completion off, it may match visitors or _visitors_ or [visitors], and so on. - -{:#completion_keep_privates} -` completion_keep_privates = 10 ` - -> Irssi keeps a list of nicknames from private messages to search during nick completion. This setting determines how many nicknames are held. -> -> TODO - Is this list maintained by people who privately message you, who you privately message, or both? - -{:#completion_char} -` completion_char = : ` - -> The text that irssi puts after a tab-completed nickname, or that it uses to detect nicknames when you have completion_auto turned on. Some people alter this to colorize the completion character, creating the oft-dreaded bold colon. - {:#completion_auto} ` completion_auto = OFF ` @@ -92,40 +34,49 @@ We ask the same respect in return. The Copyright and license notices are at the > > This will eventually bite you. -{:#completion_nicks_lowercase} -` completion_nicks_lowercase = OFF ` +{:#completion_char} +` completion_char = : ` -> When enabled, irssi forces completed nicknames to lowercase. Manually typed nicknames retain their case. +> The text that irssi puts after a tab-completed nickname, or that it uses to detect nicknames when you have completion_auto turned on. Some people alter this to colorize the completion character, creating the oft-dreaded bold colon. + +{:#completion_keep_privates} +` completion_keep_privates = 10 ` + +> Irssi keeps a list of nicknames from private messages (sent and received) to search during nick completion. This setting determines how many nicknames are held. {:#completion_keep_publics} ` completion_keep_publics = 50 ` -> Irssi keeps a list of nicknames from public messages to search during nick completion. This setting determines how many nicknames are held. -> -> TODO - Is this list maintained by watching who you speak to, who speak to you, or both? - -## [dcc] +> Irssi keeps a list of nicknames from public messages (sent and received) to search during nick completion. This setting determines how many nicknames are held. -{:#dcc_autorename} -` dcc_autorename = OFF ` +{:#completion_nicks_lowercase} +` completion_nicks_lowercase = OFF ` -> Turn on this setting to automatically rename received files so they don't overwrite existing files. -> -> I think this setting may thwart dcc_autoresume, since the auto-resume feature looks for existing filenames when resuming. Auto-renaming downloads makes sure that filenames never conflict, so resuming is not possible. +> When enabled, irssi forces completed nicknames to lowercase. Manually typed nicknames retain their case. -{:#dcc_autoresume} -` dcc_autoresume = OFF ` +{:#completion_strict} +` completion_strict = OFF ` -> When on, dcc_autoresume will cause irssi to look for existing files with the same name as a new DCC transfer. If a file already exists by that name, irssi will try to resume the transfer by appending any new data to the existing file. +> When on, nicknames are matched strictly. That is, the partial nickname you enter must be at the beginning of a nickname in one of irssi's lists. > -> I think this option clashes with dcc_autorename. See dcc_autorename for more information. +> When off, irssi will first try a strict match. If a strict match can't be found, irssi will look for nicknames that match when their leading non-alphanumeric characters are removed. For example: > -> Dcc_autoresume is ignored if dcc_autoget is off. +>> +>> vis: hello +> +> With strict completion on, it will only match nicknames beginning with vis. With strict completion off, it may match visitors or _visitors_ or [visitors], and so on. -{:#dcc_timeout} -` dcc_timeout = 5min ` +## [dcc] -> How long to keep track of pending DCC requests. Requests that do not receive responses within this time will be automatically canceled. +{:#dcc_autoaccept_lowports} +` dcc_autoaccept_lowports = OFF ` + +> When this setting is OFF, irssi will not auto-accept DCC requests from privileged ports (those below 1024) even when auto-accept is otherwise on. + +{:#dcc_autochat_masks} +` dcc_autochat_masks = ` + +> Set dcc_autochat_masks with user masks to auto-accept chat requests from. When unset, irssi's auto-accept settings work for everyone who tries to DCC chat you. The drawbacks can range from annoying through downright dangerous. Use auto-accept with care. {:#dcc_autoget} ` dcc_autoget = OFF ` @@ -134,11 +85,6 @@ We ask the same respect in return. The Copyright and license notices are at the > > This feature can be abused, so it is usually off by default. If you enable it, consider also setting dcc_autoget_masks and dcc_autoget_max_size to make this feature more secure. -{:#dcc_upload_path} -` dcc_upload_path = ~ ` - -> The path where you keep public files available to send via DCC. - {:#dcc_autoget_masks} ` dcc_autoget_masks = ` @@ -155,15 +101,21 @@ We ask the same respect in return. The Copyright and license notices are at the > > This setting is only significant if dcc_autoget is ON. -{:#dcc_send_replace_space_with_underscore} -` dcc_send_replace_space_with_underscore = OFF ` +{:#dcc_autorename} +` dcc_autorename = OFF ` -> When enabled, irssi will replace spaces with underscores in the names of files you send. It should only be necessary when sending files to clients that don't support quoted filenames, or if you hate spaces in filenames. +> Turn on this setting to automatically rename received files so they don't overwrite existing files. +> +> I think this setting may thwart dcc_autoresume, since the auto-resume feature looks for existing filenames when resuming. Auto-renaming downloads makes sure that filenames never conflict, so resuming is not possible. -{:#dcc_own_ip} -` dcc_own_ip = ` +{:#dcc_autoresume} +` dcc_autoresume = OFF ` -> Set dcc_own_ip to force irssi to always send DCC requests from a particular virtual host (vhost). Irssi will always bind sockets to this address when answering DCC requests. Otherwise irssi will determine your IP address on its own. +> When on, dcc_autoresume will cause irssi to look for existing files with the same name as a new DCC transfer. If a file already exists by that name, irssi will try to resume the transfer by appending any new data to the existing file. +> +> I think this option clashes with dcc_autorename. See dcc_autorename for more information. +> +> Dcc_autoresume is ignored if dcc_autoget is off. {:#dcc_download_path} ` dcc_download_path = ~ ` @@ -179,6 +131,16 @@ We ask the same respect in return. The Copyright and license notices are at the >> 644 is read/write by you, and readable by everybody else. 600 >> is read/write by you, nobody else can read or write. +{:#dcc_mirc_ctcp} +` dcc_mirc_ctcp = OFF ` + +> Tells irssi to send CTCP messages that are compatible with mIRC clients. This lets you use /me actions in DCC chats with mIRC users, among other things. + +{:#dcc_own_ip} +` dcc_own_ip = ` + +> Set dcc_own_ip to force irssi to always send DCC requests from a particular virtual host (vhost). Irssi will always bind sockets to this address when answering DCC requests. Otherwise irssi will determine your IP address on its own. + {:#dcc_port} ` dcc_port = 0 ` @@ -189,20 +151,20 @@ We ask the same respect in return. The Copyright and license notices are at the >> >> /set dcc_port 10000 20000 -{:#dcc_autochat_masks} -` dcc_autochat_masks = ` +{:#dcc_send_replace_space_with_underscore} +` dcc_send_replace_space_with_underscore = OFF ` -> Set dcc_autochat_masks with user masks to auto-accept chat requests from. When unset, irssi's auto-accept settings work for everyone who tries to DCC chat you. The drawbacks can range from annoying through downright dangerous. Use auto-accept with care. +> When enabled, irssi will replace spaces with underscores in the names of files you send. It should only be necessary when sending files to clients that don't support quoted filenames, or if you hate spaces in filenames. -{:#dcc_mirc_ctcp} -` dcc_mirc_ctcp = OFF ` +{:#dcc_timeout} +` dcc_timeout = 5min ` -> Tells irssi to send CTCP messages that are compatible with mIRC clients. This lets you use /me actions in DCC chats with mIRC users, among other things. +> How long to keep track of pending DCC requests. Requests that do not receive responses within this time will be automatically canceled. -{:#dcc_autoaccept_lowports} -` dcc_autoaccept_lowports = OFF ` +{:#dcc_upload_path} +` dcc_upload_path = ~ ` -> When this setting is OFF, irssi will not auto-accept DCC requests from privileged ports (those below 1024) even when auto-accept is otherwise on. +> The path where you keep public files available to send via DCC. ## [flood] @@ -243,12 +205,15 @@ We ask the same respect in return. The Copyright and license notices are at the ## [history] -{:#scrollback_save_formats} -` scrollback_save_formats = OFF ` +{:#max_command_history} +` max_command_history = 100 ` -> Turn on to save formats in the scrollback buffer, so that old messages are not changed by new themes. Turn off so the current theme applies to your entire scrollback buffer. -> -> Setting this to OFF doesn't seem to do anything, however. +> The number of lines of your own input to keep for recall. + +{:#rawlog_lines} +` rawlog_lines = 200 ` + +> Irssi's raw log is a buffer of raw IRC messages. It's used for debugging irssi and maybe some other things. This setting tells irssi how many raw messages to keep around. {:#scroll_page_count} ` scroll_page_count = /2 ` @@ -260,25 +225,10 @@ We ask the same respect in return. The Copyright and license notices are at the >> .33 = Scroll about a third of a page. >> 4 = Scroll four lines. -{:#window_history} -` window_history = OFF ` - -> When turned ON, command history will be kept per-window. When off, irssi uses a single command history for all windows. - -{:#max_command_history} -` max_command_history = 100 ` - -> The number of lines of your own input to keep for recall. - -{:#scrollback_time} -` scrollback_time = 1day ` - -> Keep at least scrollback_time worth of messages in the scrollback buffer, even if it means having more than scrollback_lines lines in the buffer. - -{:#rawlog_lines} -` rawlog_lines = 200 ` +{:#scrollback_burst_remove} +` scrollback_burst_remove = 10 ` -> Irssi's raw log is a buffer of raw IRC messages. It's used for debugging irssi and maybe some other things. This setting tells irssi how many raw messages to keep around. +> This is a speed optimization: Don't bother removing messages from the scrollback buffer until the line limit has been exceeded by scrollback_burst_remove lines. This lets irssi do its memory management in chunks rather than one line at a time. {:#scrollback_lines} ` scrollback_lines = 500 ` @@ -287,55 +237,39 @@ We ask the same respect in return. The Copyright and license notices are at the > > Setting scrollback_lines to zero also seems to thwart the scrollback_burst_remove optimization. -{:#scrollback_burst_remove} -` scrollback_burst_remove = 10 ` +{:#scrollback_time} +` scrollback_time = 1day ` -> This is a speed optimization: Don't bother removing messages from the scrollback buffer until the line limit has been exceeded by scrollback_burst_remove lines. This lets irssi do its memory management in chunks rather than one line at a time. -> -> TODO - Is this right? +> Keep at least scrollback_time worth of messages in the scrollback buffer, even if it means having more than scrollback_lines lines in the buffer. -## [log] +{:#window_history} +` window_history = OFF ` -{:#log_close_string} -` log_close_string = --- Log closed %a %b %d %H:%M:%S %Y ` +> When turned ON, command history will be kept per-window. When off, irssi uses a single command history for all windows. -> The message to log when logs are closed. -> -> See Appendix C for the meanings of Irssi's time format codes. +## [log] -{:#log_timestamp} -` log_timestamp = %H:%M ` +{:#autolog} +` autolog = OFF ` -> The time format for log timestamps. -> -> See Appendix C for the meanings of Irssi's time format codes. +> Automatically log everything, or at least the types of messages defined by autolog_level. {:#autolog_colors} ` autolog_colors = OFF ` > Whether to save colors in autologs. Colors make logs harder to parse and grep, but they may be vital for channels that deal heavily in ANSI art, or something. -{:#autolog_level} -` autolog_level = all -crap -clientcrap -ctcps ` +{:#autolog_ignore_targets} +` autolog_ignore_targets = ` -> The types of messages to auto-log. See the autolog setting. - -{:#awaylog_colors} -` awaylog_colors = ON ` - -> Whether to store color information in /away logs. - -{:#log_day_changed} -` log_day_changed = --- Day changed %a %b %d %Y ` - -> The message to log when a new day begins. +> A space separated list of targets to exclude from autologging > -> See Appendix C for the meanings of Irssi's time format codes. +> Added in irssi 0.8.13 -{:#autolog} -` autolog = OFF ` +{:#autolog_level} +` autolog_level = all -crap -clientcrap -ctcps ` -> Automatically log everything, or at least the types of messages defined by autolog_level. +> The types of messages to auto-log. See the autolog setting. {:#autolog_path} ` autolog_path = ~/irclogs/$tag/$0.log ` @@ -344,10 +278,10 @@ We ask the same respect in return. The Copyright and license notices are at the > > See Appendix B for Irssi's special variables. Irssi's special variables can be used to do fancy things like daily log rotations. -{:#awaylog_level} -` awaylog_level = msgs hilight ` +{:#awaylog_colors} +` awaylog_colors = ON ` -> The types of messages to log to awaylog_file while you're away. +> Whether to store color information in /away logs. {:#awaylog_file} ` awaylog_file = ~/.irssi/away.log ` @@ -356,10 +290,17 @@ We ask the same respect in return. The Copyright and license notices are at the > > I assume irssi's special variables also work here. See Appendix B for more information about them. -{:#log_theme} -` log_theme = ` +{:#awaylog_level} +` awaylog_level = msgs hilight ` -> Logs can have a different theme than what you see on the screen. This can be used to create machine-parseable versions of logs, for example. +> The types of messages to log to awaylog_file while you're away. + +{:#log_close_string} +` log_close_string = --- Log closed %a %b %d %H:%M:%S %Y ` + +> The message to log when logs are closed. +> +> See Appendix C for the meanings of Irssi's time format codes. {:#log_create_mode} ` log_create_mode = 600 ` @@ -368,6 +309,13 @@ We ask the same respect in return. The Copyright and license notices are at the > > 600 is read/write by you, but nobody else can see them. A sensible default mode. It can also be set to 644 if you want the rest of the world to read your logs. +{:#log_day_changed} +` log_day_changed = --- Day changed %a %b %d %Y ` + +> The message to log when a new day begins. +> +> See Appendix C for the meanings of Irssi's time format codes. + {:#log_open_string} ` log_open_string = --- Log opened %a %b %d %H:%M:%S %Y ` @@ -375,219 +323,172 @@ We ask the same respect in return. The Copyright and license notices are at the > > See Appendix C for the meanings of Irssi's time format codes. -## [lookandfeel] - -{:#show_names_on_join} -` show_names_on_join = ON ` - -> Display the list of names in a channel when you join that channel. It's generally recommended, but you can disable it for pathologically huge channels or in case you just don't care. +{:#log_theme} +` log_theme = ` -{:#window_check_level_first} -` window_check_level_first = OFF ` +> Logs can have a different theme than what you see on the screen. This can be used to create machine-parseable versions of logs, for example. -{:#window_default_level} -` window_default_level = NONE ` +{:#log_timestamp} +` log_timestamp = %H:%M ` -> From irssi's ChangeLog: -> -> Added /SET window_check_level_first and /SET window_default_level. This allows you to keep all messages with specific level in it's own window, even if it was supposed to be printed in channel window. patch by mike@po.cs.msu.su -> -> Try to choose better the window where we print when matching by level and multiple windows have a match. Should fix problems with query windows with a default msgs window + /SET window_check_level_first ON. +> The time format for log timestamps. > -> Wouter Coekaerts has made a nice explanation about this, see <<http://wouter.coekaerts.be/site/irssi/wclf>> +> See Appendix C for the meanings of Irssi's time format codes. -{:#emphasis} -` emphasis = ON ` +## [lookandfeel] -> Enable or disable real underlining and bolding when someone says *bold* or _underlined_. +{:#active_window_ignore_refnum} +` active_window_ignore_refnum = ON ` -{:#autocreate_split_windows} -` autocreate_split_windows = OFF ` - -> Automatically created windows will be created as split windows with this setting on. +> When set ON, the active_window key (meta-a by default) switches to the window with the highest activity level that was last activated. > -> Split windows are the kind where multiple windows are on one screen. - -{:#beep_msg_level} -` beep_msg_level = ` - -> Beep when messages match this level mask. +> When set OFF, the pre-0.8.15 behavior is used: it switches to the window with the highest activity level with the lowest refnum. +> +> Added in irssi 0.8.15 -{:#actlist_moves} -` actlist_moves = OFF ` +{:#activity_hide_level} +` activity_hide_level = ` -> When on, irssi rearranges the activity list so windows with more recent activity appear first. Otherwise windows are listed in numeric order. +> Message levels that don't count towards channel activity. That is, channels won't be marked as active if messages of these types appear. -{:#hilight_nick_matches} -` hilight_nick_matches = ON ` +{:#activity_hide_targets} +` activity_hide_targets = ` -> Tell irssi whether it should automatically highlight text that matches your nickname. +> Sometimes you don't care at all about a channel's activity. This can be set to a list of channels that will never appear to be active. -{:#emphasis_multiword} -` emphasis_multiword = OFF ` +{:#activity_hilight_level} +` activity_hilight_level = MSGS DCCMSGS ` -> Turn on to allow *more than one word bold* and _multiple underlined words_. Used in conjunction with the emphasis setting. +> There are times when you want to highlight channel activity in a window. Like when someone sends you a private message, or a DCC message. Activity_highlight_level sets the kind of messages you think are extra important. -{:#hide_colors} -` hide_colors = OFF ` +{:#activity_msg_level} +` activity_msg_level = PUBLIC ` -> Hide mIRC and ANSI colors when turned on. This can be used to eliminate angry fruit salad syndrome in some channels. +> Flag a channel as active when messages of this type are displayed there. -{:#names_max_width} -` names_max_width = 0 ` +{:#actlist_names} +` actlist_names = OFF ` -> Maximum number of columns to consume with a /names listing. Overrides names_max_columns if non-zero. Set to 0 for as many as fit in your terminal. +> Turn on to add active items names in 'act' statusbar item. -{:#mirc_blink_fix} -` mirc_blink_fix = OFF ` +{:#actlist_sort} +` actlist_sort = refnum ` -> Some terminals interpret bright background colors as blinking text. mIRC doesn't support blinking at all. This fixes the blinky terminals by replacing high colors with their low equivalents. +> Specifies the sorting type used for the activity bar. Accepted values: > -> From irssi's ChangeLog: +> * `refnum` (default) - windows are listed in numeric order +> * `recent` - windows with more recent activity appear first +> * `level` - sort by window level (hilight, msg, etc), same ordering used by active_window command. Windows with the same level are sorted by refnum. +> * `level,recent` - same as level, but windows with the same level are sorted by recent. > ->> ->> /SET mirc_blink_fix - if ON, the bright/blink bit is stripped ->> from MIRC colors. Set this to ON, if your terminal shows bright ->> background colors as blinking. +>Added in irssi 0.8.12. Before irssi 0.8.12, a boolean `actlist_moves` setting existed, which was equivalent to setting actlist_sort to refnum. + +{:#autoclose_query} +` autoclose_query = 0 ` + +> Automatically close query windows after autoclose_query seconds of inactivity. Setting autoclose_query to zero will keep them open until you decide to close them yourself. {:#autoclose_windows} ` autoclose_windows = ON ` > Automatically close windows when nobody is in them. This keeps your window list tidy, but it means that query windows may rearrange as people log off then privately message you later. -{:#bell_beeps} -` bell_beeps = OFF ` +{:#autocreate_own_query} +` autocreate_own_query = ON ` -> Tell irssi whether bell characters (chr 7, ^G) should actually cause beeps. -> -> According to Nei, bell_beeps seems to cover the case where a beep is caused by a printed message/format. It's unrelated to activity beeps. +> Turn on to automatically create query windows when you /msg someone. -{:#hide_server_tags} -` hide_server_tags = OFF ` +{:#autocreate_query_level} +` autocreate_query_level = MSGS DCCMSGS ` -> Server tags are prefixes to some messages (server messages?) that let you know which server the message came from. They're often considered noisy, so this option lets you hide them. +> Automatically create query windows when receiving these types of messages. -{:#show_nickmode} -` show_nickmode = ON ` +{:#autocreate_windows} +` autocreate_windows = ON ` -> Prefix nicknames with their channel status: -> -> voiced + half-op % op @ +> When on, create new windows for certain operations, such as /join. When off, everything is just dumped into one window. -{:#theme} -` theme = default ` +{:#autocreate_split_windows} +` autocreate_split_windows = OFF ` -> Irssi supports themes that can change most of the client's look and feel. This setting lets you name the theme you wish to use. +> Automatically created windows will be created as split windows with this setting on. +> +> Split windows are the kind where multiple windows are on one screen. -{:#timestamps} -` timestamps = ON ` +{:#autofocus_new_items} +` autofocus_new_items = ON ` -> Turn timestamps on or off. When off, not even timestamp_level will trigger them. +> Switch the focus to a new item when it's created. This may be disturbing at first when combined with query window auto-creation, and it may be downright dangerous if it causes you to accidentally misdirect messages. -{:#indent} -` indent = 10 ` +{:#autostick_split_windows} +` autostick_split_windows = ON ` -> How many columns to indent subsequent lines of a wrapped message. +> TODO - What is this? > -> Attention: This can be overwritten by themes. - -{:#timestamp_format} -` timestamp_format = %H:%M ` - -> How to format the time used in timestamps. +> Nei says: Setting split windows to stick means that their content won't change. Best thing to come up with a viable description might be if you tried it. > -> See Appendix C for the meanings of Irssi's time format codes. - -{:#activity_msg_level} -` activity_msg_level = PUBLIC ` - -> Flag a channel as active when messages of this type are displayed there. - -{:#print_active_channel} -` print_active_channel = OFF ` - -> Always print the channel with the nickname (like nick:channel) even if the message is from the channel you currently have active. - -{:#autoclose_query} -` autoclose_query = 0 ` - -> Automatically close query windows after autoclose_query seconds of inactivity. Setting autoclose_query to zero will keep them open until you decide to close them yourself. +> f0rked has written an excellent guide to irssi's split windows: <<http://f0rked.com/articles/irssisplit>> -{:#activity_hide_targets} -` activity_hide_targets = ` +{:#beep_msg_level} +` beep_msg_level = ` -> Sometimes you don't care at all about a channel's activity. This can be set to a list of channels that will never appear to be active. +> Beep when messages match this level mask. -{:#use_msgs_window} -` use_msgs_window = OFF ` +{:#beep_when_away} +` beep_when_away = ON ` -> Use a single window for all private messages. This setting only makes sense if automatic query windows is turned off. +> Should beeps be noisy when you're /away? Great for people who sleep near their terminals or keep irssi running at work. :) -{:#timestamp_timeout} -` timestamp_timeout = 0 ` +{:#beep_when_window_active} +` beep_when_window_active = ON ` -> The amount of time to leave timestamps on after a timestamp_level message triggered timestamping. Useful for people who think timestamps are noisy but would like timestamps for important conversations. +> Should beeps be noisy in a window you're watching? Perhaps not, since you are theoretically watching that window. You ARE watching it, aren't you? -{:#use_status_window} -` use_status_window = ON ` +{:#bell_beeps} +` bell_beeps = OFF ` -> Create a separate window for all server status messages, so they don't clutter up your channels. +> Tell irssi whether bell characters (chr 7, ^G) should actually cause beeps. +> +> According to Nei, bell_beeps seems to cover the case where a beep is caused by a printed message/format. It's unrelated to activity beeps. -{:#windows_auto_renumber} -` windows_auto_renumber = ON ` +{:#chanmode_expando_strip} +` chanmode_expando_strip = OFF ` -> Closing windows can create gaps in the window list. When windows_auto_renumber is turned on, however, windows are shifted to lower numbers in the list to fill those gaps. +> When on, $M will not return mode parameters. +> +> This means for example that the channel limit and channel key won't be shown in your statusbar (a common place where $M is used) (but also not in all other places that refer to $M for whatever reason). -{:#show_nickmode_empty} -` show_nickmode_empty = ON ` +{:#colors} +` colors = ON ` -> If a person has no channel modes, prefix their nickname with a blank space. This keeps nicknames of normal people aligned with those of voiced, half-opped, and opped people. +> Enable or disable colors. -{:#beep_when_away} -` beep_when_away = ON ` +{:#emphasis} +` emphasis = ON ` -> Should beeps be noisy when you're /away? Great for people who sleep near their terminals or keep irssi running at work. :) +> Enable or disable real underlining and bolding when someone says `*bold*` or `_underlined_`. -{:#timestamp_level} -` timestamp_level = ALL ` +{:#emphasis_italics} +` emphasis_italics = FALSE ` -> Types of messages to prefix a timestamp to. Useful for explicit or automatic timestamps. +> Enable or disable applying real italics when someone says `/italics/`. > -> Once timestamping is temporarily turned on, it may stay on for timestamp_timeout seconds. - -{:#indent_always} -` indent_always = OFF ` - -> Should we indent the long words that are forcibly wrapped to the next line? This can break long words such as URLs by inserting spaces in the middle of them. +> Note: not all terminals support this. Most notably, if the TERM environment variable is set to screen, it won't work. > -> Turn off if you would like to copy/paste or otherwise use URLs from your terminal. +> Added in irssi 0.8.17 -{:#hilight_color} -` hilight_color = %Y ` +{:#emphasis_multiword} +` emphasis_multiword = OFF ` -> The default color for /hilight. -> -> See Appendix D for Irssi's color codes. +> Turn on to allow `*more than one word bold*` and `_multiple underlined words_`. Used in conjunction with the emphasis setting. {:#emphasis_replace} ` emphasis_replace = OFF ` -> If emphasis is turned on, the * or _ characters indicating emphasis will be removed when the word is made bold or underlined. Some people find this looks cleaner. +> If emphasis is turned on, the `*` or `_` characters indicating emphasis will be removed when the word is made bold or underlined. Some people find this looks cleaner. > > See the emphasis setting for more information. -{:#hilight_level} -` hilight_level = PUBLIC DCCMSGS ` - -> The types of messages that can be highlighted. - -{:#hilight_act_color} -` hilight_act_color = %M ` - -> The color to use to highlight window activity in the status bar. That's the section that shows [Act: ...]. -> -> See Appendix D for Irssi's color codes. - {:#expand_escapes} ` expand_escapes = OFF ` @@ -598,93 +499,102 @@ We ask the same respect in return. The Copyright and license notices are at the > > Is literally '' and 't' when expand_escapes is off, but it's the tab character (chr 9) when expand_escapes is on. -{:#autocreate_windows} -` autocreate_windows = ON ` - -> When on, create new windows for certain operations, such as /join. When off, everything is just dumped into one window. - -{:#autocreate_query_level} -` autocreate_query_level = MSGS DCCMSGS ` +{:#hide_colors} +` hide_colors = OFF ` -> Automatically create query windows when receiving these types of messages. +> Hide mIRC and ANSI colors when turned on. This can be used to eliminate angry fruit salad syndrome in some channels. -{:#term_auto_detach} -` term_auto_detach = OFF ` +{:#hide_server_tags} +` hide_server_tags = OFF ` -> Automatically detach from the terminal when it disappears. -> -> This doesn't actually work. Or if it does, there's currently no way to re-attach to the terminal. It may be useful for setting up daemons where you don't want to run nohup or screen, however. +> Server tags are prefixes to some messages (server messages?) that let you know which server the message came from. They're often considered noisy, so this option lets you hide them. {:#hide_text_style} ` hide_text_style = OFF ` > Hide bold, blink, underline, and reverse attributes. -{:#whois_hide_safe_channel_id} -` whois_hide_safe_channel_id = ON ` +{:#hilight_act_color} +` hilight_act_color = %M ` -> Introduced in 0.8.10. +> The color to use to highlight window activity in the status bar. That's the section that shows [Act: ...]. > -> Hides the unique id of !channels in /whois output (IRCNet/irc2 networks only). +> See Appendix D for Irssi's color codes. + +{:#hilight_color} +` hilight_color = %Y ` + +> The default color for /hilight. > -> E.g. shows !channel instead of !12345channel +> See Appendix D for Irssi's color codes. -{:#names_max_columns} -` names_max_columns = 6 ` +{:#hilight_level} +` hilight_level = PUBLIC DCCMSGS ` -> Maximum number of columns to use for /names listing. Also shown on channel join. Set to 0 for as many as fit in your terminal. +> The types of messages that can be highlighted. -{:#chanmode_expando_strip} -` chanmode_expando_strip = OFF ` +{:#hilight_nick_matches} +` hilight_nick_matches = ON ` -> When on, $M will not return mode parameters. -> -> This means for example that the channel limit and channel key won't be shown in your statusbar (a common place where $M is used) (but also not in all other places that refer to $M for whatever reason). +> Tell irssi whether it should automatically highlight text that starts with your nickname. -{:#show_quit_once} -` show_quit_once = OFF ` +{:#hilight_nick_matches_everywhere} +` hilight_nick_matches_everywhere = OFF ` -> When turned on, a quit message will only be shown once. Otherwise it will be displayed in every window you share with the quitter. +> Turn on to extend hilight_nick_matches to match your nickname everywhere in messages, not just at the beginning. +> +> Added in irssi 0.8.18 -{:#show_away_once} -` show_away_once = ON ` +{:#indent} +` indent = 10 ` -> When on, only show /away messages in the window that's currently open. Otherwise the message will appear in every window you share with the away person. +> How many columns to indent subsequent lines of a wrapped message. +> +> Attention: This can be overwritten by themes. -{:#autocreate_own_query} -` autocreate_own_query = ON ` +{:#indent_always} +` indent_always = OFF ` -> Turn on to automatically create query windows when you /msg someone. +> Should we indent the long words that are forcibly wrapped to the next line? This can break long words such as URLs by inserting spaces in the middle of them. +> +> Turn off if you would like to copy/paste or otherwise use URLs from your terminal. -{:#term_charset} -` term_charset = US-ASCII ` +{:#mirc_blink_fix} +` mirc_blink_fix = OFF ` -> Sets your native terminal character set. Irssi will take this into consideration when it needs to delete multibyte characters, for example. +> Some terminals interpret bright background colors as blinking text. mIRC doesn't support blinking at all. This fixes the blinky terminals by replacing high colors with their low equivalents. > -> A common value is utf-8 for Unicode/UTF-8 enabled terminals. +> From irssi's ChangeLog: > -> TODO - Does this still support Chinese terminal emulators? (Used to be term_type = big5 in old Irssi.) +>> +>> /SET mirc_blink_fix - if ON, the bright/blink bit is stripped +>> from MIRC colors. Set this to ON, if your terminal shows bright +>> background colors as blinking. -{:#activity_hilight_level} -` activity_hilight_level = MSGS DCCMSGS ` +{:#names_max_columns} +` names_max_columns = 6 ` -> There are times when you want to highlight channel activity in a window. Like when someone sends you a private message, or a DCC message. Activity_highlight_level sets the kind of messages you think are extra important. +> Maximum number of columns to use for /names listing. Also shown on channel join. Set to 0 for as many as fit in your terminal. -{:#autostick_split_windows} -` autostick_split_windows = ON ` +{:#names_max_width} +` names_max_width = 0 ` -> TODO - What is this? -> -> Nei says: Setting split windows to stick means that their content won't change. Best thing to come up with a viable description might be if you tried it. -> -> f0rked has written an excellent guide to irssi's split windows: <<http://f0rked.com/articles/irssisplit>> +> Maximum number of columns to consume with a /names listing. Overrides names_max_columns if non-zero. Set to 0 for as many as fit in your terminal. + +{:#print_active_channel} +` print_active_channel = OFF ` + +> Always print the channel with the nickname (like nick:channel) even if the message is from the channel you currently have active. {:#query_track_nick_changes} ` query_track_nick_changes = ON ` -> Query windows will track nick changes when this is on. That is, it looks for a matching user@host if a message comes in with an unknown nick. -> -> TODO - Really? +> Query windows will track nick changes when this is on. That is, when receiving a message from an unknown nick, it looks for a query with a matching user@host before creating a new one, and if it finds one, it gets renamed to use the new nick. + +{:#reuse_unused_windows} +` reuse_unused_windows = OFF ` + +> When set on, irssi will reuse unused windows when looking for a new window to put something in. Otherwise unused windows are ignored, and new ones are always created. {:#scroll} ` scroll = ON ` @@ -693,220 +603,248 @@ We ask the same respect in return. The Copyright and license notices are at the > > Warning: If set to OFF, this will stop scrolling in all windows and not reenable scrolling even if you set it back to ON. (You need to manually scroll to the bottom in each window first.) -{:#window_auto_change} -` window_auto_change = OFF ` +{:#show_away_once} +` show_away_once = ON ` -> Turn this on to automatically switch to newly-created windows. This may cause you to misdirect messages, so be careful. +> When on, only show /away messages in the window that's currently open. Otherwise the message will appear in every window you share with the away person. -{:#beep_when_window_active} -` beep_when_window_active = ON ` +{:#show_names_on_join} +` show_names_on_join = ON ` -> Should beeps be noisy in a window you're watching? Perhaps not, since you are theoretically watching that window. You ARE watching it, aren't you? +> Display the list of names in a channel when you join that channel. It's generally recommended, but you can disable it for pathologically huge channels or in case you just don't care. -{:#activity_hide_level} -` activity_hide_level = ` +{:#show_nickmode} +` show_nickmode = ON ` -> Message levels that don't count towards channel activity. That is, channels won't be marked as active if messages of these types appear. +> Prefix nicknames with their channel status: +> +> voiced + half-op % op @ + +{:#show_nickmode_empty} +` show_nickmode_empty = ON ` + +> If a person has no channel modes, prefix their nickname with a blank space. This keeps nicknames of normal people aligned with those of voiced, half-opped, and opped people. {:#show_own_nickchange_once} ` show_own_nickchange_once = OFF ` > Squash your own nick-change messages so they appear only once, not once in every window you have on that network. -{:#reuse_unused_windows} -` reuse_unused_windows = OFF ` +{:#show_quit_once} +` show_quit_once = OFF ` -> When set on, irssi will reuse unused windows when looking for a new window to put something in. Otherwise unused windows are ignored, and new ones are always created. +> When turned on, a quit message will only be shown once. Otherwise it will be displayed in every window you share with the quitter. -{:#colors} -` colors = ON ` +{:#term_appkey_mode} +` term_appkey_mode = ON ` -> Enable or disable colors. +> If this is ON, the application keys mode is used, which is needed for some terminals. +> +> Turn this off if your terminal doesn't need this mode and you need to bind meta-O (that's an uppercase O) +> +> Added in irssi 0.8.19 + +{:#term_charset} +` term_charset = US-ASCII ` + +> Sets your native terminal character set. Irssi will take this into consideration when it needs to delete multibyte characters, for example. +> +> A common value is utf-8 for Unicode/UTF-8 enabled terminals. +> +> TODO - Does this still support Chinese terminal emulators? (Used to be term_type = big5 in old Irssi.) {:#term_force_colors} ` term_force_colors = OFF ` > Always display colors, even when the terminal type says colors aren't supported. Useful for working around really dumb terminals. -{:#autofocus_new_items} -` autofocus_new_items = ON ` - -> Switch the focus to a new item when it's created. This may be disturbing at first when combined with query window auto-creation, and it may be downright dangerous if it causes you to accidentally misdirect messages. +{:#theme} +` theme = default ` -## [misc] +> Irssi supports themes that can change most of the client's look and feel. This setting lets you name the theme you wish to use. -{:#opermode} -` opermode = ` +{:#timestamp_format} +` timestamp_format = %H:%M ` -> When set, irssi will set your modes to match opermode when you /oper up. For example, you might +> How to format the time used in timestamps. > ->> ->> /set opermode +s 1048575 +> See Appendix C for the meanings of Irssi's time format codes. -{:#channel_max_who_sync} -` channel_max_who_sync = 1000 ` +{:#timestamp_level} +` timestamp_level = ALL ` -> Introduced in 0.8.10. -> -> The maximum number of users that may be in a channel for Irssi to issue a -> ->> ->> /who #channel -> -> in order to obtain the hostmasks of every participant. +> Types of messages to prefix a timestamp to. Useful for explicit or automatic timestamps. > -> If this is set too high, IRC servers might kick you for Sendq exceeded. +> Once timestamping is temporarily turned on, it may stay on for timestamp_timeout seconds. -{:#recode_autodetect_utf8} -` recode_autodetect_utf8 = ON ` +{:#timestamp_timeout} +` timestamp_timeout = 0 ` -> Introduced in 0.8.10. -> -> Irssi's recode system is broken. This tries to cover up for it by leaving messages intact that seem to decode fine as Unicode UTF-8. +> The amount of time to leave timestamps on after a timestamp_level message triggered timestamping. Useful for people who think timestamps are noisy but would like timestamps for important conversations. -{:#lag_check_time} -` lag_check_time = 1min ` +{:#timestamps} +` timestamps = ON ` -> How long to wait between active lag checks. Irssi will passively check for lag when you're active, but sometimes it's necessary to actively check. This is the minimum amount of time between active checks. +> Turn timestamps on or off. When off, not even timestamp_level will trigger them. -{:#quit_message} -` quit_message = leaving ` +{:#use_msgs_window} +` use_msgs_window = OFF ` -> Default message to send when /quit'ting. +> Use a single window for all private messages. This setting only makes sense if automatic query windows is turned off. -{:#paste_detect_time} -` paste_detect_time = 5msecs ` +{:#use_status_window} +` use_status_window = ON ` -> Irssi will detect pastes when your input has less than this much time between lines. +> Create a separate window for all server status messages, so they don't clutter up your channels. -{:#notify_check_time} -` notify_check_time = 1min ` +{:#whois_hide_safe_channel_id} +` whois_hide_safe_channel_id = ON ` -> How often to check for someone online when /notify is on. +> Hides the unique id of !channels in /whois output (IRCNet/irc2 networks only). +> +> E.g. shows !channel instead of !12345channel +> +> Added in irssi 0.8.10 -{:#help_path} -` help_path = /usr/local/share/irssi/help ` +{:#window_auto_change} +` window_auto_change = OFF ` -> One or more paths where irssi will look for its help database. Multiple paths are separated by :. It's very important that this is correct. +> Turn this on to automatically switch to newly-created windows. This may cause you to misdirect messages, so be careful. -{:#ctcp_userinfo_reply} -` ctcp_userinfo_reply = $Y ` +{:#window_check_level_first} +` window_check_level_first = OFF ` -> The reply to send when someone queries your user information. By default, it's $Y, which is defined by the real_name setting. +{:#window_default_level} +` window_default_level = NONE ` + +> From irssi's ChangeLog: > -> See <<http://irssi.org/documentation/special_vars>> for more special variables you can use. +> Added /SET window_check_level_first and /SET window_default_level. This allows you to keep all messages with specific level in it's own window, even if it was supposed to be printed in channel window. patch by mike@po.cs.msu.su +> +> Try to choose better the window where we print when matching by level and multiple windows have a match. Should fix problems with query windows with a default msgs window + /SET window_check_level_first ON. +> +> Wouter Coekaerts has made a nice explanation about this, see <<http://wouter.coekaerts.be/site/irssi/wclf>> -{:#override_coredump_limit} -` override_coredump_limit = ON ` +{:#windows_auto_renumber} +` windows_auto_renumber = ON ` -> Allow really really big coredumps if this is set on. +> Closing windows can create gaps in the window list. When windows_auto_renumber is turned on, however, windows are shifted to lower numbers in the list to fill those gaps. -{:#join_auto_chans_on_invite} -` join_auto_chans_on_invite = ON ` +## [misc] -> Automatically join a channel when invited to it. -> -> TODO - Does this only work with channels on the /channel add -auto list? +{:#auto_whowas} +` auto_whowas = ON ` -{:#netjoin_max_nicks} -` netjoin_max_nicks = 10 ` +> Automatically try /whowas if you /whois someone who isn't online. -> When non-zero, limits the number of nicknames to display during netjoins. -> -> TODO - Is this correct? +{:#ban_type} +` ban_type = normal ` -{:#paste_join_multiline} -` paste_join_multiline = ON ` +> The default ban type to use: normal, user, host, domain, custom? See /help ban for a description of ban types. + +{:#channel_max_who_sync} +` channel_max_who_sync = 1000 ` -> Introduced in 0.8.10. +> The maximum number of users that may be in a channel for Irssi to issue a > -> Irssi will try to concatenate multiple lines into a single lined message when these lines have the same indentation level and look like they were copied out of Irssi. +>> +>> /who #channel > -> It's useful for quoting e-mail or other large-text messages, but it will probably bite you if you try to pasted indented text, such as code listings. Irssi will join multiple lines of code, destroying any structure you wanted to preserve. +> in order to obtain the hostmasks of every participant. +> +> If this is set too high, IRC servers might kick you for Sendq exceeded. +> +> Added in irssi 0.8.10 {:#channel_sync} ` channel_sync = ON ` > Set whether irssi should synchronize a channel on join. When enabled, irssi will gather extra information about a channel: modes, who list, ban list, ban exceptions, and invite list. -{:#paste_detect_keycount} -` paste_detect_keycount = 5 ` +{:#cmdchars} +` cmdchars = / ` -> Introduced in 0.8.10. -> -> TODO - What's this? +> Prefix characters that tell irssi that your input is a command rather than chat text. -{:#recode_fallback} -` recode_fallback = CP1252 ` +{:#ctcp_userinfo_reply} +` ctcp_userinfo_reply = $Y ` -> Introduced in 0.8.10. -> -> If you have Irssi compiled with recode support and Irssi believes that a message you received did not recode properly in your terminal default character set (or the specified one), it will recode the message using this character set. +> The reply to send when someone queries your user information. By default, it's $Y, which is defined by the real_name setting. > -> (CP1252, the irssi default, is the Microsoft(R) Windows default character set for Western Europe.) +> See <<http://irssi.org/documentation/special_vars>> for more special variables you can use. + +{:#ctcp_version_reply} +` ctcp_version_reply = irssi v$J - running on $sysname $sysarch ` + +> What to tell someone when they query your client's version. > -> Also see /help recode for more details about recoding. +> Some people consider announcing your client and operating system type and version to be a security hole. Those people change this setting. -{:#notify_idle_time} -` notify_idle_time = 1hour ` +{:#group_multi_mode} +` group_multi_mode = ON ` -> Irssi will notify you when someone you're watching becomes idle for this long. +> Consolidate multiple consecutive channel modes into a single message. This will delay the display of channel modes for a short period of time while it waits to see if multiple modes are occurring. -{:#massjoin_max_joins} -` massjoin_max_joins = 3 ` +{:#help_path} +` help_path = /usr/local/share/irssi/help ` -> If nonzero, detect mass joins. A mass join is when someone joins more than massjoin_max_joins per massjoin_max_wait seconds. -> -> TODO - Or is this when more than massjoin_max_joins people join per massjoin_max_wait seconds, regardless of the user mask? +> One or more paths where irssi will look for its help database. Multiple paths are separated by :. It's very important that this is correct. -{:#write_buffer_size} -` write_buffer_size = 0 ` +{:#hide_netsplit_quits} +` hide_netsplit_quits = ON ` -> Amount of text (logs, etc) to buffer in memory before writing to disk. Useful for minimizing disk access. +> Don't display quit messages if they're the product of a netsplit. Some people find this helpful, while others find it creepy. -{:#write_buffer_timeout} -` write_buffer_timeout = 0 ` +{:#ignore_signals} +` ignore_signals = ` -> Amount of time to keep text in memory. A buffer is flushed to disk if the text in it is this old, even if the buffer isn't full. -> -> Useful in conjunction with really large write_buffer_size values, to prevent a lot of text from being lost if irssi crashes or is killed. +> Operating system signals to ignore. May be zero or more of: int, quit, term, alrm, usr1, and usr2. -{:#STATUS_OPER} -` STATUS_OPER = * ` +{:#join_auto_chans_on_invite} +` join_auto_chans_on_invite = ON ` -> TODO - What's this? +> Automatically join a channel when invited to it, if that channel was previously added to the autojoin list (`/channel add -auto`). -{:#recode} -` recode = ON ` +{:#kick_first_on_kickban} +` kick_first_on_kickban = OFF ` + +> Kickban will normally ban first, then kick. Turn this option on to reverse the situation, which can create a race condition if the user rejoins between your kick and the subsequent ban. + +{:#knockout_time} +` knockout_time = 5min ` -> Introduced in 0.8.10. +> Knockouts are temporary kickbans. Knockout_time is the default amount of time before each temporary ban is lifted. > -> This setting allows you to disable irssi's recode functionality, if you prefer your messages not being messed with. +> See /help knockout -{:#ban_type} -` ban_type = normal ` +{:#lag_check_time} +` lag_check_time = 1min ` -> The default ban type to use: normal, user, host, domain, custom? See /help ban for a description of ban types. +> How long to wait between active lag checks. Irssi will passively check for lag when you're active, but sometimes it's necessary to actively check. This is the minimum amount of time between active checks. {:#lag_max_before_disconnect} ` lag_max_before_disconnect = 5min ` > Irssi detects your lag and will reconnect you automatically if your lag exceeds this value. -{:#part_message} -` part_message = ` +{:#lag_min_show} +` lag_min_show = 1sec ` -> Default message to send when parting a channel. +> Lag is a part of life on IRC. Don't bother displaying lag that's below this threshold, presumably because you consider it to be insignificant. -{:#auto_whowas} -` auto_whowas = ON ` +{:#massjoin_max_joins} +` massjoin_max_joins = 3 ` -> Automatically try /whowas if you /whois someone who isn't online. +> If nonzero, detect mass joins. A mass join is when someone joins more than massjoin_max_joins per massjoin_max_wait seconds. +> +> TODO - Or is this when more than massjoin_max_joins people join per massjoin_max_wait seconds, regardless of the user mask? -{:#paste_verify_line_count} -` paste_verify_line_count = 5 ` +{:#massjoin_max_wait} +` massjoin_max_wait = 5000 ` -> Ask you whether you meant to paste something if it's longer than this many lines. +> The amount of time to watch for mass-joins, in seconds. +> +> 5000 is probably a bit too much. {:#max_wildcard_modes} ` max_wildcard_modes = 6 ` @@ -928,111 +866,181 @@ We ask the same respect in return. The Copyright and license notices are at the >> >> /kick -yes * -{:#hide_netsplit_quits} -` hide_netsplit_quits = ON ` +{:#netjoin_max_nicks} +` netjoin_max_nicks = 10 ` -> Don't display quit messages if they're the product of a netsplit. Some people find this helpful, while others find it creepy. +> When non-zero, limits the number of nicknames to display during netjoins. -{:#knockout_time} -` knockout_time = 5min ` +{:#netsplit_max_nicks} +` netsplit_max_nicks = 10 ` -> Knockouts are temporary kickbans. Knockout_time is the default amount of time before each temporary ban is lifted. -> -> See /help knockout +> When non-zero, limits the number of nicknames to display during netsplits. -{:#massjoin_max_wait} -` massjoin_max_wait = 5000 ` +{:#netsplit_nicks_hide_threshold} +` netsplit_nicks_hide_threshold = 15 ` + +> Limit the number of nicks to display during netsplits to this many. Or don't limit them at all, if this is set to 0. + +{:#notify_check_time} +` notify_check_time = 1min ` -> The amount of time to watch for mass-joins. +> How often to check for someone online when /notify is on. + +{:#notify_whois_time} +` notify_whois_time = 5min ` + +> How often to check /whois on a user who's online, to see if their /away or idle status changes. + +{:#opermode} +` opermode = ` + +> When set, irssi will set your modes to match opermode when you /oper up. For example, you might > -> I'm not sure which unit of time is used to measure massjoin_max_wait. +>> +>> /set opermode +s 1048575 -{:#lag_min_show} -` lag_min_show = 1sec ` +{:#override_coredump_limit} +` override_coredump_limit = ON ` -> Lag is a part of life on IRC. Don't bother displaying lag that's below this threshold, presumably because you consider it to be insignificant. +> Allow really really big coredumps if this is set on. -{:#wall_format} -` wall_format = [Wall/$0] $1- ` +{:#part_message} +` part_message = ` -> Format for wall messages. +> Default message to send when parting a channel. -{:#netsplit_nicks_hide_threshold} -` netsplit_nicks_hide_threshold = 15 ` +{:#paste_detect_time} +` paste_detect_time = 5msecs ` -> Limit the number of nicks to display during netsplits to this many. Or don't limit them at all, if this is set to 0. +> Irssi will detect pastes when your input has less than this much time between lines. -{:#settings_autosave} -` settings_autosave = ON ` +{:#paste_join_multiline} +` paste_join_multiline = ON ` -> Automatically save your settings when you quit irssi, or once per hour, rather than waiting for you to /save them yourself. +> Irssi will try to concatenate multiple lines into a single lined message when these lines have the same indentation level and look like they were copied out of Irssi. +> +> It's useful for quoting e-mail or other large-text messages, but it will probably bite you if you try to pasted indented text, such as code listings. Irssi will join multiple lines of code, destroying any structure you wanted to preserve. +> +> Added in irssi 0.8.10 -{:#translation} -` translation = ` +{:#paste_use_bracketed_mode} +` paste_use_bracketed_mode = OFF ` -> Set the translation table to use. See Appendix E. +> Enables bracketed paste mode, which is an alternative to the time-based paste detection. +> +> If supported by the terminal, it's much more reliable since irssi knows exactly where and when a paste starts and ends, because the terminal sends special control sequences (the "brackets") indicating those positions. > -> TODO - Does this still work even? +> To take full advantage of this feature, time-based paste detection should be disabled by setting `paste_detect_time` to 0. +> +> See <https://cirw.in/blog/bracketed-paste> for more details on how this works. +> +> Added in irssi 0.8.18 -{:#group_multi_mode} -` group_multi_mode = ON ` +{:#paste_verify_line_count} +` paste_verify_line_count = 5 ` -> Consolidate multiple consecutive channel modes into a single message. This will delay the display of channel modes for a short period of time while it waits to see if multiple modes are occurring. +> Ask you whether you meant to paste something if it's longer than this many lines. -{:#recode_out_default_charset} -` recode_out_default_charset = ` +{:#quit_message} +` quit_message = leaving ` -> Introduced in 0.8.10. +> Default message to send when /quit'ting. + +{:#recode} +` recode = ON ` + +> This setting allows you to disable irssi's recode functionality, if you prefer your messages not being messed with. > -> The outgoing character set you want your messags to be recoded into, if different from your term_charset. +> Added in irssi 0.8.10 -{:#cmdchars} -` cmdchars = / ` +{:#recode_autodetect_utf8} +` recode_autodetect_utf8 = ON ` -> Prefix characters that tell irssi that your input is a command rather than chat text. +> Irssi's recode system is broken. This tries to cover up for it by leaving messages intact that seem to decode fine as Unicode UTF-8. +> +> Added in irssi 0.8.10 -{:#notify_whois_time} -` notify_whois_time = 5min ` +{:#recode_fallback} +` recode_fallback = CP1252 ` -> How often to check /whois on a user who's online, to see if their /away or idle status changes. +> If you have Irssi compiled with recode support and Irssi believes that a message you received did not recode properly in your terminal default character set (or the specified one), it will recode the message using this character set. +> +> (CP1252, the irssi default, is the Microsoft(R) Windows default character set for Western Europe.) +> +> Also see /help recode for more details about recoding. +> +> Added in irssi 0.8.10 -{:#kick_first_on_kickban} -` kick_first_on_kickban = OFF ` +{:#recode_out_default_charset} +` recode_out_default_charset = ` -> Kickban will normally ban first, then kick. Turn this option on to reverse the situation, which can create a race condition if the user rejoins between your kick and the subsequent ban. +> The outgoing character set you want your messags to be recoded into, if different from your term_charset. +> +> Added in irssi 0.8.10 {:#recode_transliterate} ` recode_transliterate = ON ` -> Introduced in 0.8.10. -> > If enabled, irssi tells iconv to try and replace characters that don't recode well with similar looking ones that exist in the target character set. > > If disabled, irssi replaces the character it could not recode with a ? instead. +> +> Added in irssi 0.8.10 + +{:#settings_autosave} +` settings_autosave = ON ` + +> Automatically save your settings when you quit irssi, or once per hour, rather than waiting for you to /save them yourself. + +{:#split_line_end} +` split_line_end = ` + +> When automatically splitting long lines, this is added to the end of line fragments. +> +> Added in irssi 0.8.17 + +{:#split_line_on_space} +` split_line_on_space = ON` + +> When this is ON, irssi tries to split long lines on spaces, instead of splitting in the middle of words. +> +> Added in irssi 0.8.18 + +{:#split_line_start} +` split_line_start = ` + +> When automatically splitting long lines, this is added to the beginning of line fragments. +> +> Added in irssi 0.8.17 + +{:#STATUS_OPER} +` STATUS_OPER = * ` + +> Determines what's shown in the `$O` expando when the user is an oper. +> +> TODO - why {:#usermode} ` usermode = +i ` > Default modes to set yourself once you've connected to a server. -{:#ignore_signals} -` ignore_signals = ` +{:#wall_format} +` wall_format = [Wall/$0] $1- ` -> Operating system signals to ignore. May be zero or more of: int, quit, term, alrm, usr1, and usr2. +> Format for wall messages. -{:#netsplit_max_nicks} -` netsplit_max_nicks = 10 ` +{:#write_buffer_size} +` write_buffer_size = 0 ` -> When non-zero, limits the number of nicknames to display during netsplits. -> -> TODO - Is this correct? +> Amount of text (logs, etc) to buffer in memory before writing to disk. Useful for minimizing disk access. -{:#ctcp_version_reply} -` ctcp_version_reply = irssi v$J - running on $sysname $sysarch ` +{:#write_buffer_timeout} +` write_buffer_timeout = 0 ` -> What to tell someone when they query your client's version. +> Amount of time to keep text in memory. A buffer is flushed to disk if the text in it is this old, even if the buffer isn't full. > -> Some people consider announcing your client and operating system type and version to be a security hole. Those people change this setting. +> Useful in conjunction with really large write_buffer_size values, to prevent a lot of text from being lost if irssi crashes or is killed. ## [perl] @@ -1043,10 +1051,20 @@ We ask the same respect in return. The Copyright and license notices are at the ## [proxy] -{:#use_proxy} -` use_proxy = OFF ` +{:#proxy_address} +` proxy_address = ` -> Tell irssi whether it should connect through a proxy server. +> The address of your IRC proxy. + +{:#proxy_password} +` proxy_password = ` + +> The password to use if the proxy requires authentication. + +{:#proxy_port} +` proxy_port = 6667 ` + +> The port of your IRC proxy. {:#proxy_string} ` proxy_string = CONNECT %s %d ` @@ -1062,54 +1080,17 @@ We ask the same respect in return. The Copyright and license notices are at the > Text to send after setting NICK and USER through a proxy. -{:#proxy_address} -` proxy_address = ` - -{:#proxy_port} -` proxy_port = 6667 ` - -> The address and port of your IRC proxy. - -{:#proxy_password} -` proxy_password = ` +{:#use_proxy} +` use_proxy = OFF ` -> The password to use if the proxy requires authentication. +> Tell irssi whether it should connect through a proxy server. ## [server] -{:#server_connect_timeout} -` server_connect_timeout = 5min ` - -> How long to wait for a connection to be established. -> -> Be careful using very short timeouts. Servers may recognize the activity as abuse. - -{:#resolve_reverse_lookup} -` resolve_reverse_lookup = OFF ` - -> When connecting, resolve the server's IP address back into its hostname. Probably useful for figuring out exactly which server you're on after resolving a round-robin host. - -{:#ssl_cacert} -` ssl_cacert = ` - -{:#ssl_cafile} -` ssl_cafile = ` - -{:#ssl_cert} -` ssl_cert = ` - -{:#ssl_pkey} -` ssl_pkey = ` - -{:#ssl_verify} -` ssl_verify = OFF ` - -{:#use_ssl} -` use_ssl = OFF ` +{:#alternate_nick} +` alternate_nick = ` -> SSL options. Set the certificates and keys, and stuff you'll use to connect to a secure server. -> -> TODO - Does verify work? If so, how? +> An alternate nickname to use if your preferred one is already taken. {:#hostname} ` hostname = ` @@ -1118,40 +1099,47 @@ We ask the same respect in return. The Copyright and license notices are at the > > This setting tells irssi which IP to bind to. -{:#user_name} -` user_name = $IRCUSER ` +{:#nick} +` nick = $IRCNICK ` -> Set your system user name. This is used in times when you don't have working ident. +> Your main, preferred nick. + +{:#real_name} +` real_name = $IRCNAME ` + +> Your real name. {:#resolve_prefer_ipv6} ` resolve_prefer_ipv6 = OFF ` > Turn this option on to prefer using an ipv6 address when a host has both ipv4 and ipv6 addresses. -{:#nick} -` nick = $IRCNICK ` +{:#resolve_reverse_lookup} +` resolve_reverse_lookup = OFF ` -> Your main, preferred nick. +> When connecting, resolve the server's IP address back into its hostname. Probably useful for figuring out exactly which server you're on after resolving a round-robin host. -{:#alternate_nick} -` alternate_nick = ` +{:#server_connect_timeout} +` server_connect_timeout = 5min ` -> An alternate nickname to use if your preferred one is already taken. +> How long to wait for a connection to be established. +> +> Be careful using very short timeouts. Servers may recognize the activity as abuse. -{:#real_name} -` real_name = $IRCNAME ` +{:#server_reconnect_time} +` server_reconnect_time = 5min ` -> Your real name. +> How long to wait between reconnects to the same server. Some servers will k-line you if you reconnect too quickly, so be careful setting this value lower. {:#skip_motd} ` skip_motd = OFF ` > Turn this on to avoid displaying the server's message of the day. Messages of the day are often noisy, and few people actually read them, but they contain important information amongst the ASCII art and song lyrics. :) -{:#server_reconnect_time} -` server_reconnect_time = 5min ` +{:#user_name} +` user_name = $IRCUSER ` -> How long to wait between reconnects to the same server. Some servers will k-line you if you reconnect too quickly, so be careful setting this value lower. +> Set your system user name. This is used in times when you don't have working ident. ## [servers] @@ -1516,86 +1504,12 @@ From <http://irssi.org/documentation/formats>: * * * -## Appendix E comes directly from <http://irc.fu-berlin.de/irc/help/SET/TRANSLATION.html>: -{:#a_e} - - Usage: SET TRANSLATION character translation table - - The TRANSLATION variable defines a character translation table. By - default, ircII assumes that all text processed over the network is - in the ISO 8859/1 map, also known as Latin-1. This is identical to - standard ASCII, except that it is extended with additional - characters in the range 128-255. Many environments by default use - the Latin-1 map, such as X Windows, MS Windows, AmigaDOS, and modern - ANSI terminals including Digital VT200, VT300, VT400 series and - MS-Kermit. However, many older environments use non-standard - extensions to ASCII, and yet others use 7-bit national replacement - sets. - - Some available settings for the TRANSLATION variable: - - 8-bit sets: - CP437 Old IBM PC, compatibles and Atari ST. - CP850 New IBM PC compatibles and IBM PS/2. - DEC_MCS DEC Multinational Character Set. - VAX/VMS. VT320's and other 8-bit - Digital terminals use this set by - default, but I recommend changing to - Latin-1 in the terminal Set-Up. - DG_MCS Data General Multinational Character Set. - HP_MCS Hewlett Packard Extended Roman 8. - LATIN_1 ISO 8859/1. Default. - MACINTOSH Apple Macintosh computers and boat - anchors. - NEXT NeXT. - - 7-bit sets: - ASCII ANSI ASCII, ISO Reg. 006. For American - terminals in 7-bit environments. Use - this one if everything else fails. - DANISH Norwegian/Danish. - DUTCH Dutch. - FINNISH Finnish. - FRENCH ISO French, ISO Reg. 025. - FRENCH_CANADIAN French in Canada. - GERMAN ISO German, ISO Reg. 021. - IRV International Reference Version, ISO - Reg. 002. For use pedantic in ISO 646 - environments. - ITALIAN ISO Italian, ISO Reg. 015. - JIS JIS ASCII, ISO Reg. 014. Japanese - ASCII hybrid. - NORWEGIAN_1 ISO Norwegian, Version 1, ISO Reg. 060. - NORWEGIAN_2 ISO Norwegian, Version 2, ISO Reg. 061. - PORTUGUESE ISO Portuguese, ISO Reg. 016. - PORTUGUESE_COM Portuguese on Digital terminals. - RUSSIAN Russian - RUSSIAN_ALT Alternative Russian. - SPANISH ISO Spanish, ISO Reg. 017. - SWEDISH ISO Swedish, ISO Reg. 010. - SWEDISH_NAMES ISO Swedish for Names, ISO Reg. 011. - SWEDISH_NAMES_COM Swedish. Digital, Hewlett Packard. - SWISS Swiss. - UNITED_KINGDOM ISO United Kingdom, ISO Reg. 004. - UNITED_KINGDOM_COM United Kingdom on DEC and HP terminals. - - Please forward any extra translation tables to the ircII development - team by using the ircbug utility that comes with the package, or, - failing that, sending mail to ircii-bugs@eterna.com.au directly. +## Appendix E: Credits and copyright +{:#a_credits} +We respect the work of others. Parts of this document have been collected from other locations. Wherever possible, we have made every effort to locate and attribute the original authors. Please let us know if we've overlooked you. -* * * - -## Appendix F is for FAQ. -{:#a_f} - -### Q: Will you relicense this document under YOUR_FAVORITE_LICENSE? - -A: The Creative Commons Attribution-ShareAlike license best embodies the author's wishes for use and redistribution of his work. It is strictly a license and does not promulgate a political or ideological agenda. YOUR_FAVORITE_LICENSE will be considered if its terms are very similar (if not identical) to the current license, but it will be rejected if it's someone's soapbox. - -* * * - -### Copyright License. +We ask the same respect in return. The original portions of this document are Copyright 2005 by Rocco Caputo rcaputo@cpan.org and Nei (on irc.freenode.net #irssi). Other portions are Copyright by their respective authors or licensors. |