diff options
Diffstat (limited to 'docs/Options.md')
| -rw-r--r-- | docs/Options.md | 170 |
1 files changed, 88 insertions, 82 deletions
diff --git a/docs/Options.md b/docs/Options.md index 7a7dc3d..bd2dda7 100644 --- a/docs/Options.md +++ b/docs/Options.md @@ -16,53 +16,53 @@ slack` after changing it to take effect. ## Available options: -### color_reaction_suffix +### auto_open_threads -**Default:** `darkgray` +**Default:** `false` -**Description:** Color to use for the [:wave:(@user)] suffix on messages that have reactions attached to them. +**Description:** Automatically open threads when mentioned or inresponse to own messages. -### unfurl_ignore_alt_text +### background_load_all_history **Default:** `false` -**Description:** When displaying ("unfurling") links to channels/users/etc, ignore the "alt text" present in the message and instead use the canonical name of the thing being linked to. +**Description:** Load history for each channel in the background as soon as it opens, rather than waiting for the user to look at it. -### shared_name_prefix +### channel_name_typing_indicator -**Default:** `%` +**Default:** `true` -**Description:** The prefix of buffer names for shared channels. +**Description:** Change the prefix of a channel from # to > when someone is typing in it. Note that this will (temporarily) affect the sort order if you sort buffers by name rather than by number. -### send_typing_notice +### color_buflist_muted_channels -**Default:** `true` +**Default:** `darkgray` -**Description:** Alert Slack users when you are typing a message in the input bar (Requires reload) +**Description:** Color to use for muted channels in the buflist -### map_underline_to +### color_edited_suffix -**Default:** `_` +**Default:** `095` -**Description:** When sending underlined text to slack, use this formatting character for it. The default ("_") sends it as italics. Use "*" to send bold instead. +**Description:** Color to use for (edited) suffix on messages that have been edited. -### slack_api_token +### color_reaction_suffix -**Default:** `INSERT VALID KEY HERE!` +**Default:** `darkgray` -**Description:** List of Slack API tokens, one per Slack instance you want to connect to. See the README for details on how to get these. +**Description:** Color to use for the [:wave:(@user)] suffix on messages that have reactions attached to them. -### render_italic_as +### color_thread_suffix -**Default:** `italic` +**Default:** `lightcyan` -**Description:** When receiving bold text from Slack, render it as this in weechat. If your terminal lacks italic support, consider using "underline" instead. +**Description:** Color to use for the [thread: XXX] suffix on messages that have threads attached to them. -### switch_buffer_on_join +### colorize_private_chats -**Default:** `true` +**Default:** `false` -**Description:** When /joining a channel, automatically switch to it as well. +**Description:** Whether to use nick-colors in DM windows. ### debug_level @@ -70,47 +70,47 @@ slack` after changing it to take effect. **Description:** Show only this level of debug info (or higher) when debug_mode is on. Lower levels -> more messages. -### color_edited_suffix - -**Default:** `095` - -**Description:** Color to use for (edited) suffix on messages that have been edited. - ### debug_mode **Default:** `false` **Description:** Open a dedicated buffer for debug messages and start logging to it. How verbose the logging is depends on log_level. -### group_name_prefix +### distracting_channels -**Default:** `&` +**Default:** `` -**Description:** The prefix of buffer names for groups (private channels). +**Description:** List of channels to hide. -### show_buflist_presence +### external_user_suffix -**Default:** `true` +**Default:** `*` -**Description:** Display a `+` character in the buffer list for present users. +**Description:** The suffix appended to nicks to indicate external users. -### auto_open_threads +### files_download_location -**Default:** `false` +**Default:** `` -**Description:** Automatically open threads when mentioned or inresponse to own messages. +**Description:** If set, file attachments will be automatically downloaded to this location. -### server_aliases +### group_name_prefix -**Default:** `` +**Default:** `&` -**Description:** A comma separated list of `subdomain:alias` pairs. The alias will be used instead of the actual name of the slack (in buffer names, logging, etc). E.g `work:no_fun_allowed` would make your work slack show up as `no_fun_allowed` rather than `work.slack.com`. +**Description:** The prefix of buffer names for groups (private channels). -### colorize_private_chats +### map_underline_to -**Default:** `false` +**Default:** `_` -**Description:** Whether to use nick-colors in DM windows. +**Description:** When sending underlined text to slack, use this formatting character for it. The default ("_") sends it as italics. Use "*" to send bold instead. + +### muted_channels_activity + +**Default:** `personal_highlights` + +**Description:** Control which activity you see from muted channels, either none, personal_highlights, all_highlights or all. none: Don't show any activity. personal_highlights: Only show personal highlights, i.e. not @channel and @here. all_highlights: Show all highlights, but not other messages. all: Show all activity, like other channels. ### never_away @@ -118,89 +118,95 @@ slack` after changing it to take effect. **Description:** Poke Slack every five minutes so that it never marks you "away". +### record_events + +**Default:** `false` + +**Description:** Log all traffic from Slack to disk as JSON. + ### render_bold_as **Default:** `bold` **Description:** When receiving bold text from Slack, render it as this in weechat. -### record_events +### render_italic_as -**Default:** `false` +**Default:** `italic` -**Description:** Log all traffic from Slack to disk as JSON. +**Description:** When receiving bold text from Slack, render it as this in weechat. If your terminal lacks italic support, consider using "underline" instead. -### background_load_all_history +### send_typing_notice -**Default:** `false` +**Default:** `true` -**Description:** Load history for each channel in the background as soon as it opens, rather than waiting for the user to look at it. +**Description:** Alert Slack users when you are typing a message in the input bar (Requires reload) -### external_user_suffix +### server_aliases -**Default:** `*` +**Default:** `` -**Description:** The suffix appended to nicks to indicate external users. +**Description:** A comma separated list of `subdomain:alias` pairs. The alias will be used instead of the actual name of the slack (in buffer names, logging, etc). E.g `work:no_fun_allowed` would make your work slack show up as `no_fun_allowed` rather than `work.slack.com`. -### distracting_channels +### shared_name_prefix -**Default:** `` +**Default:** `%` -**Description:** List of channels to hide. +**Description:** The prefix of buffer names for shared channels. -### color_buflist_muted_channels +### short_buffer_names -**Default:** `darkgray` +**Default:** `false` -**Description:** Color to use for muted channels in the buflist +**Description:** Use `foo.#channel` rather than `foo.slack.com.#channel` as the internal name for Slack buffers. -### slack_timeout +### show_buflist_presence -**Default:** `20000` +**Default:** `true` -**Description:** How long (ms) to wait when communicating with Slack. +**Description:** Display a `+` character in the buffer list for present users. -### thread_messages_in_channel +### show_reaction_nicks **Default:** `false` -**Description:** When enabled shows thread messages in the parent channel. +**Description:** Display the name of the reacting user(s) alongside each reactji. -### unfurl_auto_link_display +### slack_api_token -**Default:** `both` +**Default:** `INSERT VALID KEY HERE!` -**Description:** When displaying ("unfurling") links to channels/users/etc, determine what is displayed when the text matches the url without the protocol. This happens when Slack automatically creates links, e.g. from words separated by dots or email addresses. Set it to "text" to only display the text written by the user, "url" to only display the url or "both" (the default) to display both. +**Description:** List of Slack API tokens, one per Slack instance you want to connect to. See the README for details on how to get these. -### short_buffer_names +### slack_timeout -**Default:** `false` +**Default:** `20000` -**Description:** Use `foo.#channel` rather than `foo.slack.com.#channel` as the internal name for Slack buffers. Overrides server_aliases. +**Description:** How long (ms) to wait when communicating with Slack. -### show_reaction_nicks +### switch_buffer_on_join -**Default:** `false` +**Default:** `true` -**Description:** Display the name of the reacting user(s) alongside each reactji. +**Description:** When /joining a channel, automatically switch to it as well. -### color_thread_suffix +### thread_messages_in_channel -**Default:** `lightcyan` +**Default:** `false` -**Description:** Color to use for the [thread: XXX] suffix on messages that have threads attached to them. +**Description:** When enabled shows thread messages in the parent channel. -### channel_name_typing_indicator +### unfurl_auto_link_display -**Default:** `true` +**Default:** `both` -**Description:** Change the prefix of a channel from # to > when someone is typing in it. Note that this will (temporarily) affect the sort order if you sort buffers by name rather than by number. +**Description:** When displaying ("unfurling") links to channels/users/etc, determine what is displayed when the text matches the url without the protocol. This happens when Slack automatically creates links, e.g. from words separated by dots or email addresses. Set it to "text" to only display the text written by the user, "url" to only display the url or "both" (the default) to display both. -### muted_channels_activity +### unfurl_ignore_alt_text -**Default:** `personal_highlights` +**Default:** `false` -**Description:** Control which activity you see from muted channels, either none, personal_highlights, all_highlights or all. none: Don't show any activity. personal_highlights: Only show personal highlights, i.e. not @channel and @here. all_highlights: Show all highlights, but not other messages. all: Show all activity, like other channels. +**Description:** When displaying ("unfurling") links to channels/users/etc, ignore the "alt text" present in the message and instead use the canonical name of the thing being linked to. ### unhide_buffers_with_activity |