2014-11-08 12:27:43 +00:00
|
|
|
/* $OpenBSD$ */
|
2011-01-03 23:52:38 +00:00
|
|
|
|
|
|
|
|
/*
|
2016-01-19 15:59:12 +00:00
|
|
|
* Copyright (c) 2011 Nicholas Marriott <nicholas.marriott@gmail.com>
|
2011-01-03 23:52:38 +00:00
|
|
|
*
|
|
|
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
|
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
|
|
|
* copyright notice and this permission notice appear in all copies.
|
|
|
|
|
*
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
|
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
|
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
|
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
|
|
|
* WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
|
|
|
|
|
* IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
|
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#include <sys/types.h>
|
|
|
|
|
|
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
|
|
#include "tmux.h"
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* This file has a tables with all the server, session and window
|
|
|
|
|
* options. These tables are the master copy of the options with their real
|
|
|
|
|
* (user-visible) types, range limits and default values. At start these are
|
|
|
|
|
* copied into the runtime global options trees (which only has number and
|
2014-04-17 11:38:35 +00:00
|
|
|
* string types). These tables are then used to look up the real type when the
|
|
|
|
|
* user sets an option or its value needs to be shown.
|
2011-01-03 23:52:38 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/* Choice option type lists. */
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_mode_keys_list[] = {
|
2011-01-03 23:52:38 +00:00
|
|
|
"emacs", "vi", NULL
|
|
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_clock_mode_style_list[] = {
|
2011-01-03 23:52:38 +00:00
|
|
|
"12", "24", NULL
|
|
|
|
|
};
|
2019-03-18 20:53:33 +00:00
|
|
|
static const char *options_table_status_list[] = {
|
|
|
|
|
"off", "on", "2", "3", "4", "5", NULL
|
|
|
|
|
};
|
2022-09-09 11:02:23 +00:00
|
|
|
static const char *options_table_message_line_list[] = {
|
|
|
|
|
"0", "1", "2", "3", "4", NULL
|
|
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_status_keys_list[] = {
|
2011-01-03 23:52:38 +00:00
|
|
|
"emacs", "vi", NULL
|
|
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_status_justify_list[] = {
|
2021-03-11 06:41:04 +00:00
|
|
|
"left", "centre", "right", "absolute-centre", NULL
|
2011-01-03 23:52:38 +00:00
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_status_position_list[] = {
|
2012-01-29 12:57:01 +00:00
|
|
|
"top", "bottom", NULL
|
|
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_bell_action_list[] = {
|
2015-05-12 15:27:46 +00:00
|
|
|
"none", "any", "current", "other", NULL
|
2011-01-03 23:52:38 +00:00
|
|
|
};
|
2017-07-26 16:14:08 +00:00
|
|
|
static const char *options_table_visual_bell_list[] = {
|
|
|
|
|
"off", "on", "both", NULL
|
|
|
|
|
};
|
2021-11-03 13:37:17 +00:00
|
|
|
static const char *options_table_cursor_style_list[] = {
|
|
|
|
|
"default", "blinking-block", "block", "blinking-underline", "underline",
|
|
|
|
|
"blinking-bar", "bar", NULL
|
|
|
|
|
};
|
2016-10-03 22:52:11 +00:00
|
|
|
static const char *options_table_pane_status_list[] = {
|
2016-04-29 15:00:48 +00:00
|
|
|
"off", "top", "bottom", NULL
|
|
|
|
|
};
|
2022-02-01 14:46:41 +00:00
|
|
|
static const char *options_table_pane_border_indicators_list[] = {
|
|
|
|
|
"off", "colour", "arrows", "both", NULL
|
|
|
|
|
};
|
2021-10-14 13:19:01 +00:00
|
|
|
static const char *options_table_pane_border_lines_list[] = {
|
2020-05-14 15:49:08 +00:00
|
|
|
"single", "double", "heavy", "simple", "number", NULL
|
|
|
|
|
};
|
2021-10-14 13:19:01 +00:00
|
|
|
static const char *options_table_popup_border_lines_list[] = {
|
|
|
|
|
"single", "double", "heavy", "simple", "rounded", "padded", "none", NULL
|
|
|
|
|
};
|
2017-06-03 17:43:01 +00:00
|
|
|
static const char *options_table_set_clipboard_list[] = {
|
|
|
|
|
"off", "external", "on", NULL
|
|
|
|
|
};
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
static const char *options_table_window_size_list[] = {
|
2019-09-19 09:02:30 +00:00
|
|
|
"largest", "smallest", "manual", "latest", NULL
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
};
|
2021-01-04 08:43:16 +00:00
|
|
|
static const char *options_table_remain_on_exit_list[] = {
|
|
|
|
|
"off", "on", "failed", NULL
|
|
|
|
|
};
|
2024-02-13 08:10:23 +00:00
|
|
|
static const char *options_table_destroy_unattached_list[] = {
|
|
|
|
|
"off", "on", "keep-last", "keep-group", NULL
|
|
|
|
|
};
|
2021-02-01 08:01:14 +00:00
|
|
|
static const char *options_table_detach_on_destroy_list[] = {
|
2023-09-01 13:48:54 +00:00
|
|
|
"off", "on", "no-detached", "previous", "next", NULL
|
2021-02-01 08:01:14 +00:00
|
|
|
};
|
2021-04-21 08:32:48 +00:00
|
|
|
static const char *options_table_extended_keys_list[] = {
|
|
|
|
|
"off", "on", "always", NULL
|
|
|
|
|
};
|
2022-08-02 11:09:26 +00:00
|
|
|
static const char *options_table_allow_passthrough_list[] = {
|
|
|
|
|
"off", "on", "all", NULL
|
|
|
|
|
};
|
2011-01-03 23:52:38 +00:00
|
|
|
|
2019-03-18 20:53:33 +00:00
|
|
|
/* Status line format. */
|
|
|
|
|
#define OPTIONS_TABLE_STATUS_FORMAT1 \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#[align=left range=left #{E:status-left-style}]" \
|
2019-11-28 08:38:04 +00:00
|
|
|
"#[push-default]" \
|
|
|
|
|
"#{T;=/#{status-left-length}:status-left}" \
|
|
|
|
|
"#[pop-default]" \
|
|
|
|
|
"#[norange default]" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"#[list=on align=#{status-justify}]" \
|
|
|
|
|
"#[list=left-marker]<#[list=right-marker]>#[list=on]" \
|
|
|
|
|
"#{W:" \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#[range=window|#{window_index} " \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{E:window-status-style}" \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#{?#{&&:#{window_last_flag}," \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{!=:#{E:window-status-last-style},default}}, " \
|
|
|
|
|
"#{E:window-status-last-style}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"}" \
|
|
|
|
|
"#{?#{&&:#{window_bell_flag}," \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{!=:#{E:window-status-bell-style},default}}, " \
|
|
|
|
|
"#{E:window-status-bell-style}," \
|
2019-04-02 18:41:24 +00:00
|
|
|
"#{?#{&&:#{||:#{window_activity_flag}," \
|
|
|
|
|
"#{window_silence_flag}}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#{!=:" \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{E:window-status-activity-style}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"default}}, " \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{E:window-status-activity-style}," \
|
2019-03-18 20:53:33 +00:00
|
|
|
"}" \
|
2019-03-19 21:09:51 +00:00
|
|
|
"}" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"]" \
|
2019-09-15 21:42:57 +00:00
|
|
|
"#[push-default]" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"#{T:window-status-format}" \
|
2019-09-15 21:42:57 +00:00
|
|
|
"#[pop-default]" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"#[norange default]" \
|
|
|
|
|
"#{?window_end_flag,,#{window-status-separator}}" \
|
|
|
|
|
"," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#[range=window|#{window_index} list=focus " \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{?#{!=:#{E:window-status-current-style},default}," \
|
|
|
|
|
"#{E:window-status-current-style}," \
|
|
|
|
|
"#{E:window-status-style}" \
|
2020-05-08 18:10:09 +00:00
|
|
|
"}" \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#{?#{&&:#{window_last_flag}," \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{!=:#{E:window-status-last-style},default}}, " \
|
|
|
|
|
"#{E:window-status-last-style}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"}" \
|
|
|
|
|
"#{?#{&&:#{window_bell_flag}," \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{!=:#{E:window-status-bell-style},default}}, " \
|
|
|
|
|
"#{E:window-status-bell-style}," \
|
2019-04-02 18:41:24 +00:00
|
|
|
"#{?#{&&:#{||:#{window_activity_flag}," \
|
|
|
|
|
"#{window_silence_flag}}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"#{!=:" \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{E:window-status-activity-style}," \
|
2019-03-19 21:09:51 +00:00
|
|
|
"default}}, " \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#{E:window-status-activity-style}," \
|
2019-03-18 20:53:33 +00:00
|
|
|
"}" \
|
2019-03-19 21:09:51 +00:00
|
|
|
"}" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"]" \
|
2019-09-15 21:42:57 +00:00
|
|
|
"#[push-default]" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"#{T:window-status-current-format}" \
|
2019-09-15 21:42:57 +00:00
|
|
|
"#[pop-default]" \
|
2019-03-18 20:53:33 +00:00
|
|
|
"#[norange list=on default]" \
|
|
|
|
|
"#{?window_end_flag,,#{window-status-separator}}" \
|
|
|
|
|
"}" \
|
2021-08-12 20:44:49 +00:00
|
|
|
"#[nolist align=right range=right #{E:status-right-style}]" \
|
2019-11-28 08:38:04 +00:00
|
|
|
"#[push-default]" \
|
|
|
|
|
"#{T;=/#{status-right-length}:status-right}" \
|
|
|
|
|
"#[pop-default]" \
|
|
|
|
|
"#[norange default]"
|
2019-03-18 20:53:33 +00:00
|
|
|
#define OPTIONS_TABLE_STATUS_FORMAT2 \
|
|
|
|
|
"#[align=centre]#{P:#{?pane_active,#[reverse],}" \
|
|
|
|
|
"#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
|
|
|
|
|
static const char *options_table_status_format_default[] = {
|
|
|
|
|
OPTIONS_TABLE_STATUS_FORMAT1, OPTIONS_TABLE_STATUS_FORMAT2, NULL
|
|
|
|
|
};
|
|
|
|
|
|
2020-04-13 07:25:33 +00:00
|
|
|
/* Helpers for hook options. */
|
2019-04-26 11:38:51 +00:00
|
|
|
#define OPTIONS_TABLE_HOOK(hook_name, default_value) \
|
|
|
|
|
{ .name = hook_name, \
|
|
|
|
|
.type = OPTIONS_TABLE_COMMAND, \
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION, \
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
|
|
|
|
|
.default_str = default_value, \
|
|
|
|
|
.separator = "" \
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-13 07:25:33 +00:00
|
|
|
#define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
|
|
|
|
|
{ .name = hook_name, \
|
|
|
|
|
.type = OPTIONS_TABLE_COMMAND, \
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
|
|
|
|
|
.default_str = default_value, \
|
|
|
|
|
.separator = "" \
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
|
|
|
|
|
{ .name = hook_name, \
|
|
|
|
|
.type = OPTIONS_TABLE_COMMAND, \
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW, \
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
|
|
|
|
|
.default_str = default_value, \
|
|
|
|
|
.separator = "" \
|
|
|
|
|
}
|
|
|
|
|
|
2020-08-25 11:35:32 +00:00
|
|
|
/* Map of name conversions. */
|
|
|
|
|
const struct options_name_map options_other_names[] = {
|
|
|
|
|
{ "display-panes-color", "display-panes-colour" },
|
|
|
|
|
{ "display-panes-active-color", "display-panes-active-colour" },
|
|
|
|
|
{ "clock-mode-color", "clock-mode-colour" },
|
2021-11-01 09:34:49 +00:00
|
|
|
{ "cursor-color", "cursor-colour" },
|
2021-08-11 20:49:55 +00:00
|
|
|
{ "pane-colors", "pane-colours" },
|
2020-08-25 11:35:32 +00:00
|
|
|
{ NULL, NULL }
|
|
|
|
|
};
|
|
|
|
|
|
2017-01-15 20:48:41 +00:00
|
|
|
/* Top-level options. */
|
2015-11-20 12:01:19 +00:00
|
|
|
const struct options_table_entry options_table[] = {
|
2019-04-26 11:38:51 +00:00
|
|
|
/* Server options. */
|
2019-11-14 07:55:01 +00:00
|
|
|
{ .name = "backspace",
|
|
|
|
|
.type = OPTIONS_TABLE_KEY,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
|
|
|
|
.default_num = '\177',
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "The key to send for backspace."
|
2019-11-14 07:55:01 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "buffer-limit",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 1,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 50,
|
|
|
|
|
.text = "The maximum number of automatic buffers. "
|
|
|
|
|
"When this is reached, the oldest buffer is deleted."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2017-01-24 19:59:19 +00:00
|
|
|
{ .name = "command-alias",
|
2019-04-23 20:36:55 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2017-01-24 19:59:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2019-04-23 20:36:55 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2017-01-24 19:59:19 +00:00
|
|
|
.default_str = "split-pane=split-window,"
|
|
|
|
|
"splitp=split-window,"
|
|
|
|
|
"server-info=show-messages -JT,"
|
Rewrite of choose mode, both to simplify and tidy the code and to add
some modern features.
Now the common code is in mode-tree.c, which provides an API used by the
three modes now separated into window-{buffer,client,tree}.c. Buffer
mode shows buffers, client mode clients and tree mode a tree of
sessions, windows and panes.
Each mode has a common set of key bindings plus a few that are specific
to the mode. Other changes are:
- each mode has a preview pane: for buffers this is the buffer content
(very useful), for others it is a preview of the pane;
- items may be sorted in different ways ('O' key);
- multiple items may be tagged and an operation applied to all of them
(for example, to delete multiple buffers at once);
- in tree mode a command may be run on the selected item (session,
window, pane) or on tagged items (key ':');
- displayed items may be filtered in tree mode by using a format (this
is used to implement find-window) (key 'f');
- the custom format (-F) for the display is no longer available;
- shortcut keys change from 0-9, a-z, A-Z which was always a bit weird
with keys used for other uses to 0-9, M-a to M-z.
Now that the code is simpler, other improvements will come later.
Primary key bindings for each mode are documented under the commands in
the man page (choose-buffer, choose-client, choose-tree).
Parts written by Thomas Adam.
2017-05-30 21:44:59 +00:00
|
|
|
"info=show-messages -JT,"
|
|
|
|
|
"choose-window=choose-tree -w,"
|
|
|
|
|
"choose-session=choose-tree -s",
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Array of command aliases. "
|
|
|
|
|
"Each entry is an alias and a command separated by '='."
|
2017-01-24 19:59:19 +00:00
|
|
|
},
|
|
|
|
|
|
2020-04-17 08:03:22 +00:00
|
|
|
{ .name = "copy-command",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "",
|
|
|
|
|
.text = "Shell command run when text is copied. "
|
|
|
|
|
"If empty, no command is run."
|
2020-04-17 08:03:22 +00:00
|
|
|
},
|
|
|
|
|
|
2021-11-01 09:34:49 +00:00
|
|
|
{ .name = "cursor-colour",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
|
|
|
|
.default_num = -1,
|
|
|
|
|
.text = "Colour of the cursor."
|
|
|
|
|
},
|
|
|
|
|
|
2021-11-03 13:37:17 +00:00
|
|
|
{ .name = "cursor-style",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
|
|
|
|
.choices = options_table_cursor_style_list,
|
|
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Style of the cursor."
|
|
|
|
|
},
|
|
|
|
|
|
2015-04-29 15:59:08 +00:00
|
|
|
{ .name = "default-terminal",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2021-07-14 08:56:00 +00:00
|
|
|
.default_str = TMUX_TERM,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Default for the 'TERM' environment variable."
|
2015-04-29 15:59:08 +00:00
|
|
|
},
|
|
|
|
|
|
2020-05-01 08:02:44 +00:00
|
|
|
{ .name = "editor",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = _PATH_VI,
|
|
|
|
|
.text = "Editor run to edit files."
|
2020-05-01 08:02:44 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "escape-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 500,
|
2022-03-24 12:07:25 +00:00
|
|
|
.unit = "milliseconds",
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Time to wait before assuming a key is Escape."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2018-02-22 10:54:51 +00:00
|
|
|
{ .name = "exit-empty",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether the server should exit if there are no sessions."
|
2018-02-22 10:54:51 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "exit-unattached",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether the server should exit if there are no attached "
|
|
|
|
|
"clients."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2020-05-15 15:15:24 +00:00
|
|
|
{ .name = "extended-keys",
|
2021-04-21 08:32:48 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2020-05-15 15:15:24 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2021-04-21 08:32:48 +00:00
|
|
|
.choices = options_table_extended_keys_list,
|
2020-05-15 15:15:24 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether to request extended key sequences from terminals "
|
2022-02-15 13:11:29 +00:00
|
|
|
"that support it."
|
2020-05-15 15:15:24 +00:00
|
|
|
},
|
|
|
|
|
|
2013-06-23 13:10:46 +00:00
|
|
|
{ .name = "focus-events",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether to send focus events to applications."
|
2013-06-23 13:10:46 +00:00
|
|
|
},
|
|
|
|
|
|
2015-07-20 15:50:04 +00:00
|
|
|
{ .name = "history-file",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "",
|
|
|
|
|
.text = "Location of the command prompt history file. "
|
|
|
|
|
"Empty does not write a history file."
|
2015-07-20 15:50:04 +00:00
|
|
|
},
|
|
|
|
|
|
2023-08-08 08:08:47 +00:00
|
|
|
{ .name = "menu-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.default_str = "default",
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of menu."
|
|
|
|
|
},
|
|
|
|
|
|
2023-08-15 07:01:47 +00:00
|
|
|
{ .name = "menu-selected-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.default_str = "bg=yellow,fg=black",
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of selected menu item."
|
|
|
|
|
},
|
|
|
|
|
|
2023-08-08 08:08:47 +00:00
|
|
|
{ .name = "menu-border-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of menu borders."
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "menu-border-lines",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.choices = options_table_popup_border_lines_list,
|
|
|
|
|
.default_num = BOX_LINES_SINGLE,
|
|
|
|
|
.text = "Type of characters used to draw menu border lines. Some of "
|
|
|
|
|
"these are only supported on terminals with UTF-8 support."
|
|
|
|
|
},
|
|
|
|
|
|
2014-03-07 15:37:01 +00:00
|
|
|
{ .name = "message-limit",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2014-03-07 15:37:01 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1000,
|
|
|
|
|
.text = "Maximum number of server messages to keep."
|
2014-03-07 15:37:01 +00:00
|
|
|
},
|
|
|
|
|
|
2021-05-03 06:39:32 +00:00
|
|
|
{ .name = "prompt-history-limit",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
|
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
|
|
|
|
.default_num = 100,
|
|
|
|
|
.text = "Maximum number of commands to keep in history."
|
|
|
|
|
},
|
|
|
|
|
|
2011-05-22 16:23:07 +00:00
|
|
|
{ .name = "set-clipboard",
|
2017-06-03 17:43:01 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2017-06-03 17:43:01 +00:00
|
|
|
.choices = options_table_set_clipboard_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether to attempt to set the system clipboard ('on' or "
|
|
|
|
|
"'external') and whether to allow applications to create "
|
|
|
|
|
"paste buffers with an escape sequence ('on' only)."
|
2011-05-22 16:23:07 +00:00
|
|
|
},
|
|
|
|
|
|
2014-02-23 00:53:06 +00:00
|
|
|
{ .name = "terminal-overrides",
|
2019-04-23 20:36:55 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2019-04-23 20:36:55 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2020-04-24 14:52:44 +00:00
|
|
|
.default_str = "",
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "List of terminal capabilities overrides."
|
2020-04-20 13:25:36 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "terminal-features",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2020-05-22 15:08:38 +00:00
|
|
|
.default_str = "xterm*:clipboard:ccolour:cstyle:focus:title,"
|
2022-06-14 07:29:00 +00:00
|
|
|
"screen*:title,"
|
|
|
|
|
"rxvt*:ignorefkeys",
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "List of terminal features, used if they cannot be "
|
|
|
|
|
"automatically detected."
|
2014-02-23 00:53:06 +00:00
|
|
|
},
|
|
|
|
|
|
2017-06-23 15:36:52 +00:00
|
|
|
{ .name = "user-keys",
|
2019-04-23 20:36:55 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2017-06-23 15:36:52 +00:00
|
|
|
.scope = OPTIONS_TABLE_SERVER,
|
2019-04-23 20:36:55 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2017-06-23 15:36:52 +00:00
|
|
|
.default_str = "",
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "User key assignments. "
|
|
|
|
|
"Each sequence in the list is translated into a key: "
|
|
|
|
|
"'User0', 'User1' and so on."
|
2017-06-23 15:36:52 +00:00
|
|
|
},
|
|
|
|
|
|
2019-04-26 11:38:51 +00:00
|
|
|
/* Session options. */
|
2017-07-26 16:14:08 +00:00
|
|
|
{ .name = "activity-action",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
|
|
|
|
.choices = options_table_bell_action_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = ALERT_OTHER,
|
|
|
|
|
.text = "Action to take on an activity alert."
|
2017-07-26 16:14:08 +00:00
|
|
|
},
|
|
|
|
|
|
2013-01-15 22:55:29 +00:00
|
|
|
{ .name = "assume-paste-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2013-01-15 22:55:29 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
|
|
|
|
.default_num = 1,
|
2020-05-08 18:10:09 +00:00
|
|
|
.unit = "milliseconds",
|
2021-06-16 11:57:04 +00:00
|
|
|
.text = "Maximum time between input to assume it is pasting rather "
|
2020-05-08 18:10:09 +00:00
|
|
|
"than typing."
|
2013-01-15 22:55:29 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "base-index",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Default index of the first window in each session."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "bell-action",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.choices = options_table_bell_action_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = ALERT_ANY,
|
|
|
|
|
.text = "Action to take on a bell alert."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "default-command",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "",
|
|
|
|
|
.text = "Default command to run in new panes. If empty, a shell is "
|
|
|
|
|
"started."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "default-shell",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = _PATH_BSHELL,
|
|
|
|
|
.text = "Location of default shell."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
{ .name = "default-size",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
|
|
|
|
.pattern = "[0-9]*x[0-9]*",
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "80x24",
|
|
|
|
|
.text = "Initial size of new sessions."
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "destroy-unattached",
|
2024-02-13 08:10:23 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2024-02-13 08:10:23 +00:00
|
|
|
.choices = options_table_destroy_unattached_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether to destroy sessions when they have no attached "
|
2024-02-13 08:10:23 +00:00
|
|
|
"clients, or keep the last session whether in the group."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "detach-on-destroy",
|
2021-02-01 08:01:14 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2021-02-01 08:01:14 +00:00
|
|
|
.choices = options_table_detach_on_destroy_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether to detach when a session is destroyed, or switch "
|
|
|
|
|
"the client to another session if any exist."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "display-panes-active-colour",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Colour of the active pane for 'display-panes'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "display-panes-colour",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 4,
|
|
|
|
|
.text = "Colour of not active panes for 'display-panes'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "display-panes-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 1,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1000,
|
|
|
|
|
.unit = "milliseconds",
|
|
|
|
|
.text = "Time for which 'display-panes' should show pane numbers."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "display-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2015-11-22 18:28:01 +00:00
|
|
|
.minimum = 0,
|
2011-01-03 23:52:38 +00:00
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 750,
|
|
|
|
|
.unit = "milliseconds",
|
|
|
|
|
.text = "Time for which status line messages should appear."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "history-limit",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
2011-01-21 23:54:19 +00:00
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 2000,
|
|
|
|
|
.unit = "lines",
|
|
|
|
|
.text = "Maximum number of lines to keep in the history for each "
|
|
|
|
|
"pane. "
|
|
|
|
|
"If changed, the new value applies only to new panes."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2015-12-12 18:32:24 +00:00
|
|
|
{ .name = "key-table",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "root",
|
|
|
|
|
.text = "Default key table. "
|
|
|
|
|
"Key presses are first looked up in this table."
|
2015-12-12 18:32:24 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "lock-after-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.unit = "seconds",
|
|
|
|
|
.text = "Time after which a client is locked if not used."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "lock-command",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2023-04-25 16:23:32 +00:00
|
|
|
.default_str = TMUX_LOCK_CMD,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Shell command to run to lock a client."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "message-command-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "bg=black,fg=yellow",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the command prompt when in command mode, if "
|
|
|
|
|
"'mode-keys' is set to 'vi'."
|
2011-11-10 21:40:17 +00:00
|
|
|
},
|
|
|
|
|
|
2022-09-09 11:02:23 +00:00
|
|
|
{ .name = "message-line",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
|
|
|
|
.choices = options_table_message_line_list,
|
|
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Position (line) of messages and the command prompt."
|
|
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "message-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "bg=yellow,fg=black",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
2022-09-09 11:02:23 +00:00
|
|
|
.text = "Style of messages and the command prompt."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2015-04-19 21:34:21 +00:00
|
|
|
{ .name = "mouse",
|
2011-04-18 21:07:58 +00:00
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether the mouse is recognised and mouse key bindings are "
|
|
|
|
|
"executed. "
|
|
|
|
|
"Applications inside panes can use the mouse even when 'off'."
|
2011-04-18 21:07:58 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "prefix",
|
2012-01-21 19:36:40 +00:00
|
|
|
.type = OPTIONS_TABLE_KEY,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2012-01-21 19:36:40 +00:00
|
|
|
.default_num = '\002',
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "The prefix key."
|
2012-01-21 19:36:40 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "prefix2",
|
|
|
|
|
.type = OPTIONS_TABLE_KEY,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2012-01-21 19:36:40 +00:00
|
|
|
.default_num = KEYC_NONE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "A second prefix key."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2012-05-03 17:51:04 +00:00
|
|
|
{ .name = "renumber-windows",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether windows are automatically renumbered rather than "
|
|
|
|
|
"leaving gaps."
|
2012-05-03 17:51:04 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "repeat-time",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = SHRT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 500,
|
|
|
|
|
.unit = "milliseconds",
|
|
|
|
|
.text = "Time to wait for a key binding to repeat, if it is bound "
|
|
|
|
|
"with the '-r' flag."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "set-titles",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether to set the terminal title, if supported."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "set-titles-string",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "#S:#I:#W - \"#T\" #{session_alerts}",
|
|
|
|
|
.text = "Format of the terminal title to set."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2017-07-26 16:14:08 +00:00
|
|
|
{ .name = "silence-action",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
|
|
|
|
.choices = options_table_bell_action_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = ALERT_OTHER,
|
|
|
|
|
.text = "Action to take on a silence alert."
|
2017-07-26 16:14:08 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "status",
|
2019-03-18 20:53:33 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2019-03-18 20:53:33 +00:00
|
|
|
.choices = options_table_status_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Number of lines in the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-bg",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_num = 8,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Background colour of the status line. This option is "
|
|
|
|
|
"deprecated, use 'status-style' instead."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-fg",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_num = 8,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Foreground colour of the status line. This option is "
|
|
|
|
|
"deprecated, use 'status-style' instead."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2019-03-18 20:53:33 +00:00
|
|
|
{ .name = "status-format",
|
2019-04-23 20:36:55 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2019-03-18 20:53:33 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2019-04-23 20:36:55 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2019-03-18 20:53:33 +00:00
|
|
|
.default_arr = options_table_status_format_default,
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Formats for the status lines. "
|
|
|
|
|
"Each array member is the format for one status line. "
|
|
|
|
|
"The default status line is made up of several components "
|
2021-06-16 11:57:04 +00:00
|
|
|
"which may be configured individually with other options such "
|
2020-05-08 18:10:09 +00:00
|
|
|
"as 'status-left'."
|
2019-03-18 20:53:33 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "status-interval",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 15,
|
|
|
|
|
.unit = "seconds",
|
|
|
|
|
.text = "Number of seconds between status line updates."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-justify",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.choices = options_table_status_justify_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Position of the window list in the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-keys",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.choices = options_table_status_keys_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = MODEKEY_EMACS,
|
|
|
|
|
.text = "Key set to use at the command prompt."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-left",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "[#{session_name}] ",
|
|
|
|
|
.text = "Contents of the left side of the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-left-length",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = SHRT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 10,
|
|
|
|
|
.text = "Maximum width of the left side of the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "status-left-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the left side of the status line."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2012-01-29 12:57:01 +00:00
|
|
|
{ .name = "status-position",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2012-01-29 12:57:01 +00:00
|
|
|
.choices = options_table_status_position_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Position of the status line."
|
2012-01-29 12:57:01 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "status-right",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2018-09-26 17:41:18 +00:00
|
|
|
.default_str = "#{?window_bigger,"
|
2020-05-08 18:10:09 +00:00
|
|
|
"[#{window_offset_x}#,#{window_offset_y}] ,}"
|
|
|
|
|
"\"#{=21:pane_title}\" %H:%M %d-%b-%y",
|
|
|
|
|
.text = "Contents of the right side of the status line."
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-right-length",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = SHRT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 40,
|
|
|
|
|
.text = "Maximum width of the right side of the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "status-right-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the right side of the status line."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "status-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "bg=green,fg=black",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the status line."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "update-environment",
|
2019-04-23 20:36:55 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2019-04-23 20:36:55 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
2018-04-23 14:03:06 +00:00
|
|
|
.default_str = "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
|
2020-05-08 18:10:09 +00:00
|
|
|
"SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
|
|
|
|
|
.text = "List of environment variables to update in the session "
|
|
|
|
|
"environment when a client is attached."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "visual-activity",
|
2017-07-26 16:14:08 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2017-07-26 16:14:08 +00:00
|
|
|
.choices = options_table_visual_bell_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = VISUAL_OFF,
|
|
|
|
|
.text = "How activity alerts should be shown: a message ('on'), "
|
|
|
|
|
"a message and a bell ('both') or nothing ('off')."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "visual-bell",
|
2017-07-26 16:14:08 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2017-07-26 16:14:08 +00:00
|
|
|
.choices = options_table_visual_bell_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = VISUAL_OFF,
|
|
|
|
|
.text = "How bell alerts should be shown: a message ('on'), "
|
|
|
|
|
"a message and a bell ('both') or nothing ('off')."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "visual-silence",
|
2017-07-26 16:14:08 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2017-07-26 16:14:08 +00:00
|
|
|
.choices = options_table_visual_bell_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = VISUAL_OFF,
|
|
|
|
|
.text = "How silence alerts should be shown: a message ('on'), "
|
|
|
|
|
"a message and a bell ('both') or nothing ('off')."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2011-11-25 13:33:04 +00:00
|
|
|
{ .name = "word-separators",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_SESSION,
|
2021-05-13 07:49:58 +00:00
|
|
|
/*
|
|
|
|
|
* The set of non-alphanumeric printable ASCII characters minus the
|
|
|
|
|
* underscore.
|
|
|
|
|
*/
|
|
|
|
|
.default_str = "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Characters considered to separate words."
|
2011-11-25 13:33:04 +00:00
|
|
|
},
|
|
|
|
|
|
2019-04-26 11:38:51 +00:00
|
|
|
/* Window options. */
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "aggressive-resize",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "When 'window-size' is 'smallest', whether the maximum size "
|
|
|
|
|
"of a window is the smallest attached session where it is "
|
|
|
|
|
"the current window ('on') or the smallest session it is "
|
|
|
|
|
"linked to ('off')."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2022-02-15 13:11:29 +00:00
|
|
|
{ .name = "allow-passthrough",
|
2022-08-02 11:09:26 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2022-02-15 13:11:29 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2022-08-02 11:09:26 +00:00
|
|
|
.choices = options_table_allow_passthrough_list,
|
2022-02-15 13:11:29 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether applications are allowed to use the escape sequence "
|
2022-08-02 11:09:26 +00:00
|
|
|
"to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
|
|
|
|
|
"if the pane is visible), or 'all' (allowed even if the pane "
|
|
|
|
|
"is invisible)."
|
2022-02-15 13:11:29 +00:00
|
|
|
},
|
|
|
|
|
|
2012-01-20 21:18:39 +00:00
|
|
|
{ .name = "allow-rename",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2019-06-20 13:40:22 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether applications are allowed to use the escape sequence "
|
|
|
|
|
"to rename windows."
|
2012-01-20 21:18:39 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "alternate-screen",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2019-06-20 13:40:22 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether applications are allowed to use the alternate "
|
|
|
|
|
"screen."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "automatic-rename",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether windows are automatically renamed."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2013-08-19 21:16:11 +00:00
|
|
|
{ .name = "automatic-rename-format",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2014-04-17 12:57:28 +00:00
|
|
|
.default_str = "#{?pane_in_mode,[tmux],#{pane_current_command}}"
|
2020-05-08 18:10:09 +00:00
|
|
|
"#{?pane_dead,[dead],}",
|
|
|
|
|
.text = "Format used to automatically rename windows."
|
2013-08-19 21:16:11 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "clock-mode-colour",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 4,
|
|
|
|
|
.text = "Colour of the clock in clock mode."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "clock-mode-style",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2011-01-03 23:52:38 +00:00
|
|
|
.choices = options_table_clock_mode_style_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Time format of the clock in clock mode."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2020-04-29 17:08:21 +00:00
|
|
|
{ .name = "copy-mode-match-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "bg=cyan,fg=black",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of search matches in copy mode."
|
2020-04-29 17:08:21 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "copy-mode-current-match-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "bg=magenta,fg=black",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the current search match in copy mode."
|
2020-04-29 17:08:21 +00:00
|
|
|
},
|
|
|
|
|
|
2020-05-13 05:29:57 +00:00
|
|
|
{ .name = "copy-mode-mark-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "bg=red,fg=black",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the marked line in copy mode."
|
|
|
|
|
},
|
|
|
|
|
|
2022-03-16 17:00:17 +00:00
|
|
|
{ .name = "fill-character",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "",
|
|
|
|
|
.text = "Character used to fill unused parts of window."
|
|
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "main-pane-height",
|
2020-04-22 06:57:13 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "24",
|
|
|
|
|
.text = "Height of the main pane in the 'main-horizontal' layout. "
|
|
|
|
|
"This may be a percentage, for example '10%'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "main-pane-width",
|
2020-04-22 06:57:13 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "80",
|
|
|
|
|
.text = "Width of the main pane in the 'main-vertical' layout. "
|
|
|
|
|
"This may be a percentage, for example '10%'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "mode-keys",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2011-01-03 23:52:38 +00:00
|
|
|
.choices = options_table_mode_keys_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = MODEKEY_EMACS,
|
|
|
|
|
.text = "Key set used in copy mode."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "mode-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2023-08-15 07:01:47 +00:00
|
|
|
.default_str = "bg=yellow,fg=black",
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of indicators and highlighting in modes."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "monitor-activity",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether an alert is triggered by activity."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2017-08-17 08:37:38 +00:00
|
|
|
{ .name = "monitor-bell",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether an alert is triggered by a bell."
|
2017-08-17 08:37:38 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "monitor-silence",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2011-01-03 23:52:38 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = INT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Time after which an alert is triggered by silence. "
|
|
|
|
|
"Zero means no alert."
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "other-pane-height",
|
2020-04-22 06:57:13 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "0",
|
|
|
|
|
.text = "Height of the other panes in the 'main-horizontal' layout. "
|
|
|
|
|
"This may be a percentage, for example '10%'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "other-pane-width",
|
2020-04-22 06:57:13 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = "0",
|
|
|
|
|
.text = "Height of the other panes in the 'main-vertical' layout. "
|
|
|
|
|
"This may be a percentage, for example '10%'."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2015-02-06 15:09:34 +00:00
|
|
|
{ .name = "pane-active-border-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-29 07:59:20 +00:00
|
|
|
.default_str = "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
|
2020-04-28 12:50:07 +00:00
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the active pane border."
|
2015-02-06 15:09:34 +00:00
|
|
|
},
|
|
|
|
|
|
2011-08-25 21:13:45 +00:00
|
|
|
{ .name = "pane-base-index",
|
|
|
|
|
.type = OPTIONS_TABLE_NUMBER,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2011-08-25 21:13:45 +00:00
|
|
|
.minimum = 0,
|
|
|
|
|
.maximum = USHRT_MAX,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Index of the first pane in each window."
|
2011-08-25 21:13:45 +00:00
|
|
|
},
|
|
|
|
|
|
2016-04-29 15:00:48 +00:00
|
|
|
{ .name = "pane-border-format",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2021-12-13 09:42:20 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2016-05-04 21:29:47 +00:00
|
|
|
.default_str = "#{?pane_active,#[reverse],}#{pane_index}#[default] "
|
2020-05-08 18:10:09 +00:00
|
|
|
"\"#{pane_title}\"",
|
|
|
|
|
.text = "Format of text in the pane status lines."
|
2016-04-29 15:00:48 +00:00
|
|
|
},
|
|
|
|
|
|
2022-02-01 14:46:41 +00:00
|
|
|
{ .name = "pane-border-indicators",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.choices = options_table_pane_border_indicators_list,
|
|
|
|
|
.default_num = PANE_BORDER_COLOUR,
|
|
|
|
|
.text = "Whether to indicate the active pane by colouring border or "
|
|
|
|
|
"displaying arrow markers."
|
|
|
|
|
},
|
|
|
|
|
|
2020-05-14 15:49:08 +00:00
|
|
|
{ .name = "pane-border-lines",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2021-10-14 13:19:01 +00:00
|
|
|
.choices = options_table_pane_border_lines_list,
|
2020-05-14 15:49:08 +00:00
|
|
|
.default_num = PANE_LINES_SINGLE,
|
2021-06-16 11:57:04 +00:00
|
|
|
.text = "Type of characters used to draw pane border lines. Some of "
|
2022-02-15 13:11:29 +00:00
|
|
|
"these are only supported on terminals with UTF-8 support."
|
2020-05-14 15:49:08 +00:00
|
|
|
},
|
|
|
|
|
|
2016-04-29 15:00:48 +00:00
|
|
|
{ .name = "pane-border-status",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.choices = options_table_pane_status_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = PANE_STATUS_OFF,
|
|
|
|
|
.text = "Position of the pane status lines."
|
2016-04-29 15:00:48 +00:00
|
|
|
},
|
|
|
|
|
|
2015-02-06 15:09:34 +00:00
|
|
|
{ .name = "pane-border-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the pane status lines."
|
2015-02-06 15:09:34 +00:00
|
|
|
},
|
|
|
|
|
|
2021-08-11 20:49:55 +00:00
|
|
|
{ .name = "pane-colours",
|
|
|
|
|
.type = OPTIONS_TABLE_COLOUR,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
|
|
|
|
.default_str = "",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_ARRAY,
|
|
|
|
|
.text = "The default colour palette for colours zero to 255."
|
|
|
|
|
},
|
|
|
|
|
|
2021-10-13 09:28:36 +00:00
|
|
|
{ .name = "popup-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of popups."
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "popup-border-style",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
|
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of popup borders."
|
|
|
|
|
},
|
|
|
|
|
|
2021-10-14 13:19:01 +00:00
|
|
|
{ .name = "popup-border-lines",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.choices = options_table_popup_border_lines_list,
|
|
|
|
|
.default_num = BOX_LINES_SINGLE,
|
|
|
|
|
.text = "Type of characters used to draw popup border lines. Some of "
|
2022-02-15 13:11:29 +00:00
|
|
|
"these are only supported on terminals with UTF-8 support."
|
2021-10-14 13:19:01 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "remain-on-exit",
|
2021-01-04 08:43:16 +00:00
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
2019-06-20 11:59:59 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2021-01-04 08:43:16 +00:00
|
|
|
.choices = options_table_remain_on_exit_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether panes should remain ('on') or be automatically "
|
2021-01-04 08:43:16 +00:00
|
|
|
"killed ('off' or 'failed') when the program inside exits."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2022-03-08 18:31:46 +00:00
|
|
|
{ .name = "remain-on-exit-format",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
|
|
|
|
.default_str = "Pane is dead ("
|
|
|
|
|
"#{?#{!=:#{pane_dead_status},},"
|
|
|
|
|
"status #{pane_dead_status},}"
|
|
|
|
|
"#{?#{!=:#{pane_dead_signal},},"
|
|
|
|
|
"signal #{pane_dead_signal},}, "
|
|
|
|
|
"#{t:pane_dead_time})",
|
|
|
|
|
.text = "Message shown after the program in a pane has exited, if "
|
|
|
|
|
"remain-on-exit is enabled."
|
|
|
|
|
},
|
|
|
|
|
|
2022-03-17 11:35:37 +00:00
|
|
|
{ .name = "scroll-on-clear",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
|
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether the contents of the screen should be scrolled into"
|
|
|
|
|
"history when clearing the whole screen."
|
|
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "synchronize-panes",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2020-12-15 08:31:50 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 0,
|
|
|
|
|
.text = "Whether typing should be sent to all panes simultaneously."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2015-04-19 21:05:27 +00:00
|
|
|
{ .name = "window-active-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2019-06-20 11:59:59 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of the active pane."
|
2015-04-19 21:05:27 +00:00
|
|
|
},
|
|
|
|
|
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
{ .name = "window-size",
|
|
|
|
|
.type = OPTIONS_TABLE_CHOICE,
|
|
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
|
|
|
|
.choices = options_table_window_size_list,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = WINDOW_SIZE_LATEST,
|
|
|
|
|
.text = "How window size is calculated. "
|
|
|
|
|
"'latest' uses the size of the most recently used client, "
|
|
|
|
|
"'largest' the largest client, 'smallest' the smallest "
|
|
|
|
|
"client and 'manual' a size set by the 'resize-window' "
|
|
|
|
|
"command."
|
Support for windows larger than the client.
This adds two new options, window-size and default-size, and a new
command, resize-window.
The force-width and force-height options, and the session_width and
session_height formats have been removed.
The new window-size option tells tmux how to work out the size of
windows: largest means it picks the size of the largest session,
smallest the smallest session (similar to the old behaviour) and
manual means that it does not automatically resize
windows. aggressive-resize modifies the choice of session for largest
and smallest as it did before.
If a window is in a session attached to a client that is too small,
only part of the window is shown. tmux attempts to keep the cursor
visible, so the part of the window displayed is changed as the cursor
moves (with a small delay, to try and avoid excess redrawing when
applications redraw status lines or similar that are not currently
visible).
Drawing windows which are larger than the client is not as efficient
as those which fit, particularly when the cursor moves, so it is
recommended to avoid using this on slow machines or networks (set
window-size to smallest or manual).
The resize-window command can be used to resize a window manually. If
it is used, the window-size option is automatically set to manual for
the window (undo this with "setw -u window-size"). resize-window works
in a similar way to resize-pane (-U -D -L -R -x -y flags) but also has
-a and -A flags. -a sets the window to the size of the smallest client
(what it would be if window-size was smallest) and -A the largest.
For the same behaviour as force-width or force-height, use
resize-width -x or -y.
If the global window-size option is set to manual, the default-size
option is used for new windows. If -x or -y is used with new-session,
that sets the default-size option for the new session.
The maximum size of a window is 10000x10000. But expect applications
to complain and higher memory use if you make a window that big. The
minimum size is the size required for the current layout including
borders.
This change allows some code improvements, most notably that since
windows can now never be cropped, that code can be removed from the
layout code, and since panes can now never be outside the size of the
window, window_pane_visible can be removed.
2018-08-20 14:22:14 +00:00
|
|
|
},
|
|
|
|
|
|
2015-04-19 21:05:27 +00:00
|
|
|
{ .name = "window-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2019-06-20 11:59:59 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Default style of panes that are not the active pane."
|
2015-04-19 21:05:27 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "window-status-activity-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "reverse",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of windows in the status line with an activity alert."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "window-status-bell-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "reverse",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of windows in the status line with a bell alert."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = "window-status-current-format",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2021-01-20 07:16:54 +00:00
|
|
|
.default_str = "#I:#W#{?window_flags,#{window_flags}, }",
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Format of the current window in the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "window-status-current-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the current window in the status line."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "window-status-format",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2021-01-20 07:16:54 +00:00
|
|
|
.default_str = "#I:#W#{?window_flags,#{window_flags}, }",
|
2020-05-08 18:10:09 +00:00
|
|
|
.text = "Format of windows in the status line, except the current "
|
|
|
|
|
"window."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{ .name = "window-status-last-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of the last window in the status line."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2012-04-24 16:20:18 +00:00
|
|
|
{ .name = "window-status-separator",
|
|
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_str = " ",
|
|
|
|
|
.text = "Separator between windows in the status line."
|
2012-04-24 16:20:18 +00:00
|
|
|
},
|
|
|
|
|
|
2014-01-28 23:07:09 +00:00
|
|
|
{ .name = "window-status-style",
|
2020-04-28 12:50:07 +00:00
|
|
|
.type = OPTIONS_TABLE_STRING,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-04-28 12:50:07 +00:00
|
|
|
.default_str = "default",
|
|
|
|
|
.flags = OPTIONS_TABLE_IS_STYLE,
|
2020-05-08 18:10:09 +00:00
|
|
|
.separator = ",",
|
|
|
|
|
.text = "Style of windows in the status line, except the current and "
|
|
|
|
|
"last windows."
|
2014-01-28 23:07:09 +00:00
|
|
|
},
|
|
|
|
|
|
2012-03-18 02:12:24 +00:00
|
|
|
{ .name = "wrap-search",
|
|
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
|
|
|
|
.text = "Whether searching in copy mode should wrap at the top or "
|
|
|
|
|
"bottom."
|
2012-03-18 02:12:24 +00:00
|
|
|
},
|
|
|
|
|
|
2020-05-15 09:31:54 +00:00
|
|
|
{ .name = "xterm-keys", /* no longer used */
|
2011-01-03 23:52:38 +00:00
|
|
|
.type = OPTIONS_TABLE_FLAG,
|
2015-11-20 12:01:19 +00:00
|
|
|
.scope = OPTIONS_TABLE_WINDOW,
|
2020-05-08 18:10:09 +00:00
|
|
|
.default_num = 1,
|
2020-05-15 09:31:54 +00:00
|
|
|
.text = "Whether xterm-style function key sequences should be sent. "
|
2022-02-15 13:11:29 +00:00
|
|
|
"This option is no longer used."
|
2011-01-03 23:52:38 +00:00
|
|
|
},
|
|
|
|
|
|
2019-04-26 11:38:51 +00:00
|
|
|
/* Hook options. */
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-bind-key", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-capture-pane", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-copy-mode", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-display-message", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-display-panes", ""),
|
2019-11-28 10:55:45 +00:00
|
|
|
OPTIONS_TABLE_HOOK("after-kill-pane", ""),
|
2019-04-26 11:38:51 +00:00
|
|
|
OPTIONS_TABLE_HOOK("after-list-buffers", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-list-clients", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-list-keys", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-list-panes", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-list-sessions", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-list-windows", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-load-buffer", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-lock-server", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-new-session", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-new-window", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-queue", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-refresh-client", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-rename-session", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-rename-window", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-resize-pane", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-resize-window", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-save-buffer", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-select-layout", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-select-pane", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-select-window", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-send-keys", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-set-buffer", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-set-environment", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-set-hook", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-set-option", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-show-environment", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-show-messages", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-show-options", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-split-window", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("after-unbind-key", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("alert-activity", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("alert-bell", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("alert-silence", ""),
|
2021-08-04 08:07:19 +00:00
|
|
|
OPTIONS_TABLE_HOOK("client-active", ""),
|
2019-04-26 11:38:51 +00:00
|
|
|
OPTIONS_TABLE_HOOK("client-attached", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("client-detached", ""),
|
2022-02-15 13:11:29 +00:00
|
|
|
OPTIONS_TABLE_HOOK("client-focus-in", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("client-focus-out", ""),
|
2019-04-26 11:38:51 +00:00
|
|
|
OPTIONS_TABLE_HOOK("client-resized", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("client-session-changed", ""),
|
2020-04-13 07:25:33 +00:00
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
|
|
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
|
|
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
|
|
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
|
|
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
|
|
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
|
2020-07-24 07:05:37 +00:00
|
|
|
OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
|
2019-04-26 11:38:51 +00:00
|
|
|
OPTIONS_TABLE_HOOK("session-closed", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("session-created", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("session-renamed", ""),
|
|
|
|
|
OPTIONS_TABLE_HOOK("session-window-changed", ""),
|
2020-04-13 07:25:33 +00:00
|
|
|
OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
|
2021-07-28 07:06:54 +00:00
|
|
|
OPTIONS_TABLE_HOOK("window-linked", ""),
|
2020-04-13 07:25:33 +00:00
|
|
|
OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
|
|
|
|
|
OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
|
2022-02-17 09:58:47 +00:00
|
|
|
OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
|
2021-07-28 07:06:54 +00:00
|
|
|
OPTIONS_TABLE_HOOK("window-unlinked", ""),
|
2019-04-26 11:38:51 +00:00
|
|
|
|
2011-01-03 23:52:38 +00:00
|
|
|
{ .name = NULL }
|
|
|
|
|
};
|