4 * Copyright (c) 2011 Nicholas Marriott <nicholas.marriott@gmail.com>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19 #include <sys/types.h>
27 * This file has a tables with all the server, session and window
28 * options. These tables are the master copy of the options with their real
29 * (user-visible) types, range limits and default values. At start these are
30 * copied into the runtime global options trees (which only has number and
31 * string types). These tables are then used to look up the real type when the
32 * user sets an option or its value needs to be shown.
35 /* Choice option type lists. */
36 static const char *options_table_mode_keys_list
[] = {
39 static const char *options_table_clock_mode_style_list
[] = {
42 static const char *options_table_status_list
[] = {
43 "off", "on", "2", "3", "4", "5", NULL
45 static const char *options_table_message_line_list
[] = {
46 "0", "1", "2", "3", "4", NULL
48 static const char *options_table_status_keys_list
[] = {
51 static const char *options_table_status_justify_list
[] = {
52 "left", "centre", "right", "absolute-centre", NULL
54 static const char *options_table_status_position_list
[] = {
57 static const char *options_table_bell_action_list
[] = {
58 "none", "any", "current", "other", NULL
60 static const char *options_table_visual_bell_list
[] = {
61 "off", "on", "both", NULL
63 static const char *options_table_cursor_style_list
[] = {
64 "default", "blinking-block", "block", "blinking-underline", "underline",
65 "blinking-bar", "bar", NULL
67 static const char *options_table_pane_status_list
[] = {
68 "off", "top", "bottom", NULL
70 static const char *options_table_pane_border_indicators_list
[] = {
71 "off", "colour", "arrows", "both", NULL
73 static const char *options_table_pane_border_lines_list
[] = {
74 "single", "double", "heavy", "simple", "number", NULL
76 static const char *options_table_popup_border_lines_list
[] = {
77 "single", "double", "heavy", "simple", "rounded", "padded", "none", NULL
79 static const char *options_table_set_clipboard_list
[] = {
80 "off", "external", "on", NULL
82 static const char *options_table_window_size_list
[] = {
83 "largest", "smallest", "manual", "latest", NULL
85 static const char *options_table_remain_on_exit_list
[] = {
86 "off", "on", "failed", NULL
88 static const char *options_table_destroy_unattached_list
[] = {
89 "off", "on", "keep-last", "keep-group", NULL
91 static const char *options_table_detach_on_destroy_list
[] = {
92 "off", "on", "no-detached", "previous", "next", NULL
94 static const char *options_table_extended_keys_list
[] = {
95 "off", "on", "always", NULL
97 static const char *options_table_allow_passthrough_list
[] = {
98 "off", "on", "all", NULL
101 /* Status line format. */
102 #define OPTIONS_TABLE_STATUS_FORMAT1 \
103 "#[align=left range=left #{E:status-left-style}]" \
105 "#{T;=/#{status-left-length}:status-left}" \
107 "#[norange default]" \
108 "#[list=on align=#{status-justify}]" \
109 "#[list=left-marker]<#[list=right-marker]>#[list=on]" \
111 "#[range=window|#{window_index} " \
112 "#{E:window-status-style}" \
113 "#{?#{&&:#{window_last_flag}," \
114 "#{!=:#{E:window-status-last-style},default}}, " \
115 "#{E:window-status-last-style}," \
117 "#{?#{&&:#{window_bell_flag}," \
118 "#{!=:#{E:window-status-bell-style},default}}, " \
119 "#{E:window-status-bell-style}," \
120 "#{?#{&&:#{||:#{window_activity_flag}," \
121 "#{window_silence_flag}}," \
123 "#{E:window-status-activity-style}," \
125 "#{E:window-status-activity-style}," \
130 "#{T:window-status-format}" \
132 "#[norange default]" \
133 "#{?window_end_flag,,#{window-status-separator}}" \
135 "#[range=window|#{window_index} list=focus " \
136 "#{?#{!=:#{E:window-status-current-style},default}," \
137 "#{E:window-status-current-style}," \
138 "#{E:window-status-style}" \
140 "#{?#{&&:#{window_last_flag}," \
141 "#{!=:#{E:window-status-last-style},default}}, " \
142 "#{E:window-status-last-style}," \
144 "#{?#{&&:#{window_bell_flag}," \
145 "#{!=:#{E:window-status-bell-style},default}}, " \
146 "#{E:window-status-bell-style}," \
147 "#{?#{&&:#{||:#{window_activity_flag}," \
148 "#{window_silence_flag}}," \
150 "#{E:window-status-activity-style}," \
152 "#{E:window-status-activity-style}," \
157 "#{T:window-status-current-format}" \
159 "#[norange list=on default]" \
160 "#{?window_end_flag,,#{window-status-separator}}" \
162 "#[nolist align=right range=right #{E:status-right-style}]" \
164 "#{T;=/#{status-right-length}:status-right}" \
167 #define OPTIONS_TABLE_STATUS_FORMAT2 \
168 "#[align=centre]#{P:#{?pane_active,#[reverse],}" \
169 "#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
170 static const char *options_table_status_format_default
[] = {
171 OPTIONS_TABLE_STATUS_FORMAT1
, OPTIONS_TABLE_STATUS_FORMAT2
, NULL
174 /* Helpers for hook options. */
175 #define OPTIONS_TABLE_HOOK(hook_name, default_value) \
176 { .name = hook_name, \
177 .type = OPTIONS_TABLE_COMMAND, \
178 .scope = OPTIONS_TABLE_SESSION, \
179 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
180 .default_str = default_value, \
184 #define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
185 { .name = hook_name, \
186 .type = OPTIONS_TABLE_COMMAND, \
187 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
188 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
189 .default_str = default_value, \
193 #define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
194 { .name = hook_name, \
195 .type = OPTIONS_TABLE_COMMAND, \
196 .scope = OPTIONS_TABLE_WINDOW, \
197 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
198 .default_str = default_value, \
202 /* Map of name conversions. */
203 const struct options_name_map options_other_names
[] = {
204 { "display-panes-color", "display-panes-colour" },
205 { "display-panes-active-color", "display-panes-active-colour" },
206 { "clock-mode-color", "clock-mode-colour" },
207 { "cursor-color", "cursor-colour" },
208 { "pane-colors", "pane-colours" },
212 /* Top-level options. */
213 const struct options_table_entry options_table
[] = {
214 /* Server options. */
215 { .name
= "backspace",
216 .type
= OPTIONS_TABLE_KEY
,
217 .scope
= OPTIONS_TABLE_SERVER
,
218 .default_num
= '\177',
219 .text
= "The key to send for backspace."
222 { .name
= "buffer-limit",
223 .type
= OPTIONS_TABLE_NUMBER
,
224 .scope
= OPTIONS_TABLE_SERVER
,
228 .text
= "The maximum number of automatic buffers. "
229 "When this is reached, the oldest buffer is deleted."
232 { .name
= "command-alias",
233 .type
= OPTIONS_TABLE_STRING
,
234 .scope
= OPTIONS_TABLE_SERVER
,
235 .flags
= OPTIONS_TABLE_IS_ARRAY
,
236 .default_str
= "split-pane=split-window,"
237 "splitp=split-window,"
238 "server-info=show-messages -JT,"
239 "info=show-messages -JT,"
240 "choose-window=choose-tree -w,"
241 "choose-session=choose-tree -s",
243 .text
= "Array of command aliases. "
244 "Each entry is an alias and a command separated by '='."
247 { .name
= "copy-command",
248 .type
= OPTIONS_TABLE_STRING
,
249 .scope
= OPTIONS_TABLE_SERVER
,
251 .text
= "Shell command run when text is copied. "
252 "If empty, no command is run."
255 { .name
= "cursor-colour",
256 .type
= OPTIONS_TABLE_COLOUR
,
257 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
259 .text
= "Colour of the cursor."
262 { .name
= "cursor-style",
263 .type
= OPTIONS_TABLE_CHOICE
,
264 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
265 .choices
= options_table_cursor_style_list
,
267 .text
= "Style of the cursor."
270 { .name
= "default-terminal",
271 .type
= OPTIONS_TABLE_STRING
,
272 .scope
= OPTIONS_TABLE_SERVER
,
273 .default_str
= TMUX_TERM
,
274 .text
= "Default for the 'TERM' environment variable."
278 .type
= OPTIONS_TABLE_STRING
,
279 .scope
= OPTIONS_TABLE_SERVER
,
280 .default_str
= _PATH_VI
,
281 .text
= "Editor run to edit files."
284 { .name
= "escape-time",
285 .type
= OPTIONS_TABLE_NUMBER
,
286 .scope
= OPTIONS_TABLE_SERVER
,
290 .unit
= "milliseconds",
291 .text
= "Time to wait before assuming a key is Escape."
294 { .name
= "exit-empty",
295 .type
= OPTIONS_TABLE_FLAG
,
296 .scope
= OPTIONS_TABLE_SERVER
,
298 .text
= "Whether the server should exit if there are no sessions."
301 { .name
= "exit-unattached",
302 .type
= OPTIONS_TABLE_FLAG
,
303 .scope
= OPTIONS_TABLE_SERVER
,
305 .text
= "Whether the server should exit if there are no attached "
309 { .name
= "extended-keys",
310 .type
= OPTIONS_TABLE_CHOICE
,
311 .scope
= OPTIONS_TABLE_SERVER
,
312 .choices
= options_table_extended_keys_list
,
314 .text
= "Whether to request extended key sequences from terminals "
318 { .name
= "focus-events",
319 .type
= OPTIONS_TABLE_FLAG
,
320 .scope
= OPTIONS_TABLE_SERVER
,
322 .text
= "Whether to send focus events to applications."
325 { .name
= "history-file",
326 .type
= OPTIONS_TABLE_STRING
,
327 .scope
= OPTIONS_TABLE_SERVER
,
329 .text
= "Location of the command prompt history file. "
330 "Empty does not write a history file."
333 { .name
= "menu-style",
334 .type
= OPTIONS_TABLE_STRING
,
335 .scope
= OPTIONS_TABLE_WINDOW
,
336 .flags
= OPTIONS_TABLE_IS_STYLE
,
337 .default_str
= "default",
339 .text
= "Default style of menu."
342 { .name
= "menu-selected-style",
343 .type
= OPTIONS_TABLE_STRING
,
344 .scope
= OPTIONS_TABLE_WINDOW
,
345 .flags
= OPTIONS_TABLE_IS_STYLE
,
346 .default_str
= "bg=yellow,fg=black",
348 .text
= "Default style of selected menu item."
351 { .name
= "menu-border-style",
352 .type
= OPTIONS_TABLE_STRING
,
353 .scope
= OPTIONS_TABLE_WINDOW
,
354 .default_str
= "default",
355 .flags
= OPTIONS_TABLE_IS_STYLE
,
357 .text
= "Default style of menu borders."
360 { .name
= "menu-border-lines",
361 .type
= OPTIONS_TABLE_CHOICE
,
362 .scope
= OPTIONS_TABLE_WINDOW
,
363 .choices
= options_table_popup_border_lines_list
,
364 .default_num
= BOX_LINES_SINGLE
,
365 .text
= "Type of characters used to draw menu border lines. Some of "
366 "these are only supported on terminals with UTF-8 support."
369 { .name
= "message-limit",
370 .type
= OPTIONS_TABLE_NUMBER
,
371 .scope
= OPTIONS_TABLE_SERVER
,
375 .text
= "Maximum number of server messages to keep."
378 { .name
= "prompt-history-limit",
379 .type
= OPTIONS_TABLE_NUMBER
,
380 .scope
= OPTIONS_TABLE_SERVER
,
384 .text
= "Maximum number of commands to keep in history."
387 { .name
= "set-clipboard",
388 .type
= OPTIONS_TABLE_CHOICE
,
389 .scope
= OPTIONS_TABLE_SERVER
,
390 .choices
= options_table_set_clipboard_list
,
392 .text
= "Whether to attempt to set the system clipboard ('on' or "
393 "'external') and whether to allow applications to create "
394 "paste buffers with an escape sequence ('on' only)."
397 { .name
= "terminal-overrides",
398 .type
= OPTIONS_TABLE_STRING
,
399 .scope
= OPTIONS_TABLE_SERVER
,
400 .flags
= OPTIONS_TABLE_IS_ARRAY
,
403 .text
= "List of terminal capabilities overrides."
406 { .name
= "terminal-features",
407 .type
= OPTIONS_TABLE_STRING
,
408 .scope
= OPTIONS_TABLE_SERVER
,
409 .flags
= OPTIONS_TABLE_IS_ARRAY
,
410 .default_str
= "xterm*:clipboard:ccolour:cstyle:focus:title,"
414 .text
= "List of terminal features, used if they cannot be "
415 "automatically detected."
418 { .name
= "user-keys",
419 .type
= OPTIONS_TABLE_STRING
,
420 .scope
= OPTIONS_TABLE_SERVER
,
421 .flags
= OPTIONS_TABLE_IS_ARRAY
,
424 .text
= "User key assignments. "
425 "Each sequence in the list is translated into a key: "
426 "'User0', 'User1' and so on."
429 /* Session options. */
430 { .name
= "activity-action",
431 .type
= OPTIONS_TABLE_CHOICE
,
432 .scope
= OPTIONS_TABLE_SESSION
,
433 .choices
= options_table_bell_action_list
,
434 .default_num
= ALERT_OTHER
,
435 .text
= "Action to take on an activity alert."
438 { .name
= "assume-paste-time",
439 .type
= OPTIONS_TABLE_NUMBER
,
440 .scope
= OPTIONS_TABLE_SESSION
,
444 .unit
= "milliseconds",
445 .text
= "Maximum time between input to assume it is pasting rather "
449 { .name
= "base-index",
450 .type
= OPTIONS_TABLE_NUMBER
,
451 .scope
= OPTIONS_TABLE_SESSION
,
455 .text
= "Default index of the first window in each session."
458 { .name
= "bell-action",
459 .type
= OPTIONS_TABLE_CHOICE
,
460 .scope
= OPTIONS_TABLE_SESSION
,
461 .choices
= options_table_bell_action_list
,
462 .default_num
= ALERT_ANY
,
463 .text
= "Action to take on a bell alert."
466 { .name
= "default-command",
467 .type
= OPTIONS_TABLE_STRING
,
468 .scope
= OPTIONS_TABLE_SESSION
,
470 .text
= "Default command to run in new panes. If empty, a shell is "
474 { .name
= "default-shell",
475 .type
= OPTIONS_TABLE_STRING
,
476 .scope
= OPTIONS_TABLE_SESSION
,
477 .default_str
= _PATH_BSHELL
,
478 .text
= "Location of default shell."
481 { .name
= "default-size",
482 .type
= OPTIONS_TABLE_STRING
,
483 .scope
= OPTIONS_TABLE_SESSION
,
484 .pattern
= "[0-9]*x[0-9]*",
485 .default_str
= "80x24",
486 .text
= "Initial size of new sessions."
489 { .name
= "destroy-unattached",
490 .type
= OPTIONS_TABLE_CHOICE
,
491 .scope
= OPTIONS_TABLE_SESSION
,
492 .choices
= options_table_destroy_unattached_list
,
494 .text
= "Whether to destroy sessions when they have no attached "
495 "clients, or keep the last session whether in the group."
498 { .name
= "detach-on-destroy",
499 .type
= OPTIONS_TABLE_CHOICE
,
500 .scope
= OPTIONS_TABLE_SESSION
,
501 .choices
= options_table_detach_on_destroy_list
,
503 .text
= "Whether to detach when a session is destroyed, or switch "
504 "the client to another session if any exist."
507 { .name
= "display-panes-active-colour",
508 .type
= OPTIONS_TABLE_COLOUR
,
509 .scope
= OPTIONS_TABLE_SESSION
,
511 .text
= "Colour of the active pane for 'display-panes'."
514 { .name
= "display-panes-colour",
515 .type
= OPTIONS_TABLE_COLOUR
,
516 .scope
= OPTIONS_TABLE_SESSION
,
518 .text
= "Colour of not active panes for 'display-panes'."
521 { .name
= "display-panes-time",
522 .type
= OPTIONS_TABLE_NUMBER
,
523 .scope
= OPTIONS_TABLE_SESSION
,
527 .unit
= "milliseconds",
528 .text
= "Time for which 'display-panes' should show pane numbers."
531 { .name
= "display-time",
532 .type
= OPTIONS_TABLE_NUMBER
,
533 .scope
= OPTIONS_TABLE_SESSION
,
537 .unit
= "milliseconds",
538 .text
= "Time for which status line messages should appear."
541 { .name
= "history-limit",
542 .type
= OPTIONS_TABLE_NUMBER
,
543 .scope
= OPTIONS_TABLE_SESSION
,
548 .text
= "Maximum number of lines to keep in the history for each "
550 "If changed, the new value applies only to new panes."
553 { .name
= "key-table",
554 .type
= OPTIONS_TABLE_STRING
,
555 .scope
= OPTIONS_TABLE_SESSION
,
556 .default_str
= "root",
557 .text
= "Default key table. "
558 "Key presses are first looked up in this table."
561 { .name
= "lock-after-time",
562 .type
= OPTIONS_TABLE_NUMBER
,
563 .scope
= OPTIONS_TABLE_SESSION
,
568 .text
= "Time after which a client is locked if not used."
571 { .name
= "lock-command",
572 .type
= OPTIONS_TABLE_STRING
,
573 .scope
= OPTIONS_TABLE_SESSION
,
574 .default_str
= "lock -np",
575 .text
= "Shell command to run to lock a client."
578 { .name
= "message-command-style",
579 .type
= OPTIONS_TABLE_STRING
,
580 .scope
= OPTIONS_TABLE_SESSION
,
581 .default_str
= "bg=black,fg=yellow",
582 .flags
= OPTIONS_TABLE_IS_STYLE
,
584 .text
= "Style of the command prompt when in command mode, if "
585 "'mode-keys' is set to 'vi'."
588 { .name
= "message-line",
589 .type
= OPTIONS_TABLE_CHOICE
,
590 .scope
= OPTIONS_TABLE_SESSION
,
591 .choices
= options_table_message_line_list
,
593 .text
= "Position (line) of messages and the command prompt."
596 { .name
= "message-style",
597 .type
= OPTIONS_TABLE_STRING
,
598 .scope
= OPTIONS_TABLE_SESSION
,
599 .default_str
= "bg=yellow,fg=black",
600 .flags
= OPTIONS_TABLE_IS_STYLE
,
602 .text
= "Style of messages and the command prompt."
606 .type
= OPTIONS_TABLE_FLAG
,
607 .scope
= OPTIONS_TABLE_SESSION
,
609 .text
= "Whether the mouse is recognised and mouse key bindings are "
611 "Applications inside panes can use the mouse even when 'off'."
615 .type
= OPTIONS_TABLE_KEY
,
616 .scope
= OPTIONS_TABLE_SESSION
,
617 .default_num
= '\002',
618 .text
= "The prefix key."
622 .type
= OPTIONS_TABLE_KEY
,
623 .scope
= OPTIONS_TABLE_SESSION
,
624 .default_num
= KEYC_NONE
,
625 .text
= "A second prefix key."
628 { .name
= "renumber-windows",
629 .type
= OPTIONS_TABLE_FLAG
,
630 .scope
= OPTIONS_TABLE_SESSION
,
632 .text
= "Whether windows are automatically renumbered rather than "
636 { .name
= "repeat-time",
637 .type
= OPTIONS_TABLE_NUMBER
,
638 .scope
= OPTIONS_TABLE_SESSION
,
642 .unit
= "milliseconds",
643 .text
= "Time to wait for a key binding to repeat, if it is bound "
644 "with the '-r' flag."
647 { .name
= "set-titles",
648 .type
= OPTIONS_TABLE_FLAG
,
649 .scope
= OPTIONS_TABLE_SESSION
,
651 .text
= "Whether to set the terminal title, if supported."
654 { .name
= "set-titles-string",
655 .type
= OPTIONS_TABLE_STRING
,
656 .scope
= OPTIONS_TABLE_SESSION
,
657 .default_str
= "#S:#I:#W - \"#T\" #{session_alerts}",
658 .text
= "Format of the terminal title to set."
661 { .name
= "silence-action",
662 .type
= OPTIONS_TABLE_CHOICE
,
663 .scope
= OPTIONS_TABLE_SESSION
,
664 .choices
= options_table_bell_action_list
,
665 .default_num
= ALERT_OTHER
,
666 .text
= "Action to take on a silence alert."
670 .type
= OPTIONS_TABLE_CHOICE
,
671 .scope
= OPTIONS_TABLE_SESSION
,
672 .choices
= options_table_status_list
,
674 .text
= "Number of lines in the status line."
677 { .name
= "status-bg",
678 .type
= OPTIONS_TABLE_COLOUR
,
679 .scope
= OPTIONS_TABLE_SESSION
,
681 .text
= "Background colour of the status line. This option is "
682 "deprecated, use 'status-style' instead."
685 { .name
= "status-fg",
686 .type
= OPTIONS_TABLE_COLOUR
,
687 .scope
= OPTIONS_TABLE_SESSION
,
689 .text
= "Foreground colour of the status line. This option is "
690 "deprecated, use 'status-style' instead."
693 { .name
= "status-format",
694 .type
= OPTIONS_TABLE_STRING
,
695 .scope
= OPTIONS_TABLE_SESSION
,
696 .flags
= OPTIONS_TABLE_IS_ARRAY
,
697 .default_arr
= options_table_status_format_default
,
698 .text
= "Formats for the status lines. "
699 "Each array member is the format for one status line. "
700 "The default status line is made up of several components "
701 "which may be configured individually with other options such "
705 { .name
= "status-interval",
706 .type
= OPTIONS_TABLE_NUMBER
,
707 .scope
= OPTIONS_TABLE_SESSION
,
712 .text
= "Number of seconds between status line updates."
715 { .name
= "status-justify",
716 .type
= OPTIONS_TABLE_CHOICE
,
717 .scope
= OPTIONS_TABLE_SESSION
,
718 .choices
= options_table_status_justify_list
,
720 .text
= "Position of the window list in the status line."
723 { .name
= "status-keys",
724 .type
= OPTIONS_TABLE_CHOICE
,
725 .scope
= OPTIONS_TABLE_SESSION
,
726 .choices
= options_table_status_keys_list
,
727 .default_num
= MODEKEY_EMACS
,
728 .text
= "Key set to use at the command prompt."
731 { .name
= "status-left",
732 .type
= OPTIONS_TABLE_STRING
,
733 .scope
= OPTIONS_TABLE_SESSION
,
734 .default_str
= "[#{session_name}] ",
735 .text
= "Contents of the left side of the status line."
738 { .name
= "status-left-length",
739 .type
= OPTIONS_TABLE_NUMBER
,
740 .scope
= OPTIONS_TABLE_SESSION
,
744 .text
= "Maximum width of the left side of the status line."
747 { .name
= "status-left-style",
748 .type
= OPTIONS_TABLE_STRING
,
749 .scope
= OPTIONS_TABLE_SESSION
,
750 .default_str
= "default",
751 .flags
= OPTIONS_TABLE_IS_STYLE
,
753 .text
= "Style of the left side of the status line."
756 { .name
= "status-position",
757 .type
= OPTIONS_TABLE_CHOICE
,
758 .scope
= OPTIONS_TABLE_SESSION
,
759 .choices
= options_table_status_position_list
,
761 .text
= "Position of the status line."
764 { .name
= "status-right",
765 .type
= OPTIONS_TABLE_STRING
,
766 .scope
= OPTIONS_TABLE_SESSION
,
767 .default_str
= "#{?window_bigger,"
768 "[#{window_offset_x}#,#{window_offset_y}] ,}"
769 "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
770 .text
= "Contents of the right side of the status line."
774 { .name
= "status-right-length",
775 .type
= OPTIONS_TABLE_NUMBER
,
776 .scope
= OPTIONS_TABLE_SESSION
,
780 .text
= "Maximum width of the right side of the status line."
783 { .name
= "status-right-style",
784 .type
= OPTIONS_TABLE_STRING
,
785 .scope
= OPTIONS_TABLE_SESSION
,
786 .default_str
= "default",
787 .flags
= OPTIONS_TABLE_IS_STYLE
,
789 .text
= "Style of the right side of the status line."
792 { .name
= "status-style",
793 .type
= OPTIONS_TABLE_STRING
,
794 .scope
= OPTIONS_TABLE_SESSION
,
795 .default_str
= "bg=green,fg=black",
796 .flags
= OPTIONS_TABLE_IS_STYLE
,
798 .text
= "Style of the status line."
801 { .name
= "update-environment",
802 .type
= OPTIONS_TABLE_STRING
,
803 .scope
= OPTIONS_TABLE_SESSION
,
804 .flags
= OPTIONS_TABLE_IS_ARRAY
,
805 .default_str
= "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
806 "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
807 .text
= "List of environment variables to update in the session "
808 "environment when a client is attached."
811 { .name
= "visual-activity",
812 .type
= OPTIONS_TABLE_CHOICE
,
813 .scope
= OPTIONS_TABLE_SESSION
,
814 .choices
= options_table_visual_bell_list
,
815 .default_num
= VISUAL_OFF
,
816 .text
= "How activity alerts should be shown: a message ('on'), "
817 "a message and a bell ('both') or nothing ('off')."
820 { .name
= "visual-bell",
821 .type
= OPTIONS_TABLE_CHOICE
,
822 .scope
= OPTIONS_TABLE_SESSION
,
823 .choices
= options_table_visual_bell_list
,
824 .default_num
= VISUAL_OFF
,
825 .text
= "How bell alerts should be shown: a message ('on'), "
826 "a message and a bell ('both') or nothing ('off')."
829 { .name
= "visual-silence",
830 .type
= OPTIONS_TABLE_CHOICE
,
831 .scope
= OPTIONS_TABLE_SESSION
,
832 .choices
= options_table_visual_bell_list
,
833 .default_num
= VISUAL_OFF
,
834 .text
= "How silence alerts should be shown: a message ('on'), "
835 "a message and a bell ('both') or nothing ('off')."
838 { .name
= "word-separators",
839 .type
= OPTIONS_TABLE_STRING
,
840 .scope
= OPTIONS_TABLE_SESSION
,
842 * The set of non-alphanumeric printable ASCII characters minus the
845 .default_str
= "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
846 .text
= "Characters considered to separate words."
849 /* Window options. */
850 { .name
= "aggressive-resize",
851 .type
= OPTIONS_TABLE_FLAG
,
852 .scope
= OPTIONS_TABLE_WINDOW
,
854 .text
= "When 'window-size' is 'smallest', whether the maximum size "
855 "of a window is the smallest attached session where it is "
856 "the current window ('on') or the smallest session it is "
860 { .name
= "allow-passthrough",
861 .type
= OPTIONS_TABLE_CHOICE
,
862 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
863 .choices
= options_table_allow_passthrough_list
,
865 .text
= "Whether applications are allowed to use the escape sequence "
866 "to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
867 "if the pane is visible), or 'all' (allowed even if the pane "
871 { .name
= "allow-rename",
872 .type
= OPTIONS_TABLE_FLAG
,
873 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
875 .text
= "Whether applications are allowed to use the escape sequence "
879 { .name
= "alternate-screen",
880 .type
= OPTIONS_TABLE_FLAG
,
881 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
883 .text
= "Whether applications are allowed to use the alternate "
887 { .name
= "automatic-rename",
888 .type
= OPTIONS_TABLE_FLAG
,
889 .scope
= OPTIONS_TABLE_WINDOW
,
891 .text
= "Whether windows are automatically renamed."
894 { .name
= "automatic-rename-format",
895 .type
= OPTIONS_TABLE_STRING
,
896 .scope
= OPTIONS_TABLE_WINDOW
,
897 .default_str
= "#{?pane_in_mode,[tmux],#{pane_current_command}}"
898 "#{?pane_dead,[dead],}",
899 .text
= "Format used to automatically rename windows."
902 { .name
= "clock-mode-colour",
903 .type
= OPTIONS_TABLE_COLOUR
,
904 .scope
= OPTIONS_TABLE_WINDOW
,
906 .text
= "Colour of the clock in clock mode."
909 { .name
= "clock-mode-style",
910 .type
= OPTIONS_TABLE_CHOICE
,
911 .scope
= OPTIONS_TABLE_WINDOW
,
912 .choices
= options_table_clock_mode_style_list
,
914 .text
= "Time format of the clock in clock mode."
917 { .name
= "copy-mode-match-style",
918 .type
= OPTIONS_TABLE_STRING
,
919 .scope
= OPTIONS_TABLE_WINDOW
,
920 .default_str
= "bg=cyan,fg=black",
921 .flags
= OPTIONS_TABLE_IS_STYLE
,
923 .text
= "Style of search matches in copy mode."
926 { .name
= "copy-mode-current-match-style",
927 .type
= OPTIONS_TABLE_STRING
,
928 .scope
= OPTIONS_TABLE_WINDOW
,
929 .default_str
= "bg=magenta,fg=black",
930 .flags
= OPTIONS_TABLE_IS_STYLE
,
932 .text
= "Style of the current search match in copy mode."
935 { .name
= "copy-mode-mark-style",
936 .type
= OPTIONS_TABLE_STRING
,
937 .scope
= OPTIONS_TABLE_WINDOW
,
938 .default_str
= "bg=red,fg=black",
939 .flags
= OPTIONS_TABLE_IS_STYLE
,
941 .text
= "Style of the marked line in copy mode."
944 { .name
= "fill-character",
945 .type
= OPTIONS_TABLE_STRING
,
946 .scope
= OPTIONS_TABLE_WINDOW
,
948 .text
= "Character used to fill unused parts of window."
951 { .name
= "main-pane-height",
952 .type
= OPTIONS_TABLE_STRING
,
953 .scope
= OPTIONS_TABLE_WINDOW
,
955 .text
= "Height of the main pane in the 'main-horizontal' layout. "
956 "This may be a percentage, for example '10%'."
959 { .name
= "main-pane-width",
960 .type
= OPTIONS_TABLE_STRING
,
961 .scope
= OPTIONS_TABLE_WINDOW
,
963 .text
= "Width of the main pane in the 'main-vertical' layout. "
964 "This may be a percentage, for example '10%'."
967 { .name
= "mode-keys",
968 .type
= OPTIONS_TABLE_CHOICE
,
969 .scope
= OPTIONS_TABLE_WINDOW
,
970 .choices
= options_table_mode_keys_list
,
971 .default_num
= MODEKEY_EMACS
,
972 .text
= "Key set used in copy mode."
975 { .name
= "mode-style",
976 .type
= OPTIONS_TABLE_STRING
,
977 .scope
= OPTIONS_TABLE_WINDOW
,
978 .flags
= OPTIONS_TABLE_IS_STYLE
,
979 .default_str
= "bg=yellow,fg=black",
981 .text
= "Style of indicators and highlighting in modes."
984 { .name
= "monitor-activity",
985 .type
= OPTIONS_TABLE_FLAG
,
986 .scope
= OPTIONS_TABLE_WINDOW
,
988 .text
= "Whether an alert is triggered by activity."
991 { .name
= "monitor-bell",
992 .type
= OPTIONS_TABLE_FLAG
,
993 .scope
= OPTIONS_TABLE_WINDOW
,
995 .text
= "Whether an alert is triggered by a bell."
998 { .name
= "monitor-silence",
999 .type
= OPTIONS_TABLE_NUMBER
,
1000 .scope
= OPTIONS_TABLE_WINDOW
,
1004 .text
= "Time after which an alert is triggered by silence. "
1005 "Zero means no alert."
1009 { .name
= "other-pane-height",
1010 .type
= OPTIONS_TABLE_STRING
,
1011 .scope
= OPTIONS_TABLE_WINDOW
,
1013 .text
= "Height of the other panes in the 'main-horizontal' layout. "
1014 "This may be a percentage, for example '10%'."
1017 { .name
= "other-pane-width",
1018 .type
= OPTIONS_TABLE_STRING
,
1019 .scope
= OPTIONS_TABLE_WINDOW
,
1021 .text
= "Height of the other panes in the 'main-vertical' layout. "
1022 "This may be a percentage, for example '10%'."
1025 { .name
= "pane-active-border-style",
1026 .type
= OPTIONS_TABLE_STRING
,
1027 .scope
= OPTIONS_TABLE_WINDOW
,
1028 .default_str
= "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
1029 .flags
= OPTIONS_TABLE_IS_STYLE
,
1031 .text
= "Style of the active pane border."
1034 { .name
= "pane-base-index",
1035 .type
= OPTIONS_TABLE_NUMBER
,
1036 .scope
= OPTIONS_TABLE_WINDOW
,
1038 .maximum
= USHRT_MAX
,
1040 .text
= "Index of the first pane in each window."
1043 { .name
= "pane-border-format",
1044 .type
= OPTIONS_TABLE_STRING
,
1045 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1046 .default_str
= "#{?pane_active,#[reverse],}#{pane_index}#[default] "
1047 "\"#{pane_title}\"",
1048 .text
= "Format of text in the pane status lines."
1051 { .name
= "pane-border-indicators",
1052 .type
= OPTIONS_TABLE_CHOICE
,
1053 .scope
= OPTIONS_TABLE_WINDOW
,
1054 .choices
= options_table_pane_border_indicators_list
,
1055 .default_num
= PANE_BORDER_COLOUR
,
1056 .text
= "Whether to indicate the active pane by colouring border or "
1057 "displaying arrow markers."
1060 { .name
= "pane-border-lines",
1061 .type
= OPTIONS_TABLE_CHOICE
,
1062 .scope
= OPTIONS_TABLE_WINDOW
,
1063 .choices
= options_table_pane_border_lines_list
,
1064 .default_num
= PANE_LINES_SINGLE
,
1065 .text
= "Type of characters used to draw pane border lines. Some of "
1066 "these are only supported on terminals with UTF-8 support."
1069 { .name
= "pane-border-status",
1070 .type
= OPTIONS_TABLE_CHOICE
,
1071 .scope
= OPTIONS_TABLE_WINDOW
,
1072 .choices
= options_table_pane_status_list
,
1073 .default_num
= PANE_STATUS_OFF
,
1074 .text
= "Position of the pane status lines."
1077 { .name
= "pane-border-style",
1078 .type
= OPTIONS_TABLE_STRING
,
1079 .scope
= OPTIONS_TABLE_WINDOW
,
1080 .default_str
= "default",
1081 .flags
= OPTIONS_TABLE_IS_STYLE
,
1083 .text
= "Style of the pane status lines."
1086 { .name
= "pane-colours",
1087 .type
= OPTIONS_TABLE_COLOUR
,
1088 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1090 .flags
= OPTIONS_TABLE_IS_ARRAY
,
1091 .text
= "The default colour palette for colours zero to 255."
1094 { .name
= "popup-style",
1095 .type
= OPTIONS_TABLE_STRING
,
1096 .scope
= OPTIONS_TABLE_WINDOW
,
1097 .default_str
= "default",
1098 .flags
= OPTIONS_TABLE_IS_STYLE
,
1100 .text
= "Default style of popups."
1103 { .name
= "popup-border-style",
1104 .type
= OPTIONS_TABLE_STRING
,
1105 .scope
= OPTIONS_TABLE_WINDOW
,
1106 .default_str
= "default",
1107 .flags
= OPTIONS_TABLE_IS_STYLE
,
1109 .text
= "Default style of popup borders."
1112 { .name
= "popup-border-lines",
1113 .type
= OPTIONS_TABLE_CHOICE
,
1114 .scope
= OPTIONS_TABLE_WINDOW
,
1115 .choices
= options_table_popup_border_lines_list
,
1116 .default_num
= BOX_LINES_SINGLE
,
1117 .text
= "Type of characters used to draw popup border lines. Some of "
1118 "these are only supported on terminals with UTF-8 support."
1121 { .name
= "remain-on-exit",
1122 .type
= OPTIONS_TABLE_CHOICE
,
1123 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1124 .choices
= options_table_remain_on_exit_list
,
1126 .text
= "Whether panes should remain ('on') or be automatically "
1127 "killed ('off' or 'failed') when the program inside exits."
1130 { .name
= "remain-on-exit-format",
1131 .type
= OPTIONS_TABLE_STRING
,
1132 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1133 .default_str
= "Pane is dead ("
1134 "#{?#{!=:#{pane_dead_status},},"
1135 "status #{pane_dead_status},}"
1136 "#{?#{!=:#{pane_dead_signal},},"
1137 "signal #{pane_dead_signal},}, "
1138 "#{t:pane_dead_time})",
1139 .text
= "Message shown after the program in a pane has exited, if "
1140 "remain-on-exit is enabled."
1143 { .name
= "scroll-on-clear",
1144 .type
= OPTIONS_TABLE_FLAG
,
1145 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1147 .text
= "Whether the contents of the screen should be scrolled into"
1148 "history when clearing the whole screen."
1151 { .name
= "synchronize-panes",
1152 .type
= OPTIONS_TABLE_FLAG
,
1153 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1155 .text
= "Whether typing should be sent to all panes simultaneously."
1158 { .name
= "window-active-style",
1159 .type
= OPTIONS_TABLE_STRING
,
1160 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1161 .default_str
= "default",
1162 .flags
= OPTIONS_TABLE_IS_STYLE
,
1164 .text
= "Default style of the active pane."
1167 { .name
= "window-size",
1168 .type
= OPTIONS_TABLE_CHOICE
,
1169 .scope
= OPTIONS_TABLE_WINDOW
,
1170 .choices
= options_table_window_size_list
,
1171 .default_num
= WINDOW_SIZE_LATEST
,
1172 .text
= "How window size is calculated. "
1173 "'latest' uses the size of the most recently used client, "
1174 "'largest' the largest client, 'smallest' the smallest "
1175 "client and 'manual' a size set by the 'resize-window' "
1179 { .name
= "window-style",
1180 .type
= OPTIONS_TABLE_STRING
,
1181 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1182 .default_str
= "default",
1183 .flags
= OPTIONS_TABLE_IS_STYLE
,
1185 .text
= "Default style of panes that are not the active pane."
1188 { .name
= "window-status-activity-style",
1189 .type
= OPTIONS_TABLE_STRING
,
1190 .scope
= OPTIONS_TABLE_WINDOW
,
1191 .default_str
= "reverse",
1192 .flags
= OPTIONS_TABLE_IS_STYLE
,
1194 .text
= "Style of windows in the status line with an activity alert."
1197 { .name
= "window-status-bell-style",
1198 .type
= OPTIONS_TABLE_STRING
,
1199 .scope
= OPTIONS_TABLE_WINDOW
,
1200 .default_str
= "reverse",
1201 .flags
= OPTIONS_TABLE_IS_STYLE
,
1203 .text
= "Style of windows in the status line with a bell alert."
1206 { .name
= "window-status-current-format",
1207 .type
= OPTIONS_TABLE_STRING
,
1208 .scope
= OPTIONS_TABLE_WINDOW
,
1209 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1210 .text
= "Format of the current window in the status line."
1213 { .name
= "window-status-current-style",
1214 .type
= OPTIONS_TABLE_STRING
,
1215 .scope
= OPTIONS_TABLE_WINDOW
,
1216 .default_str
= "default",
1217 .flags
= OPTIONS_TABLE_IS_STYLE
,
1219 .text
= "Style of the current window in the status line."
1222 { .name
= "window-status-format",
1223 .type
= OPTIONS_TABLE_STRING
,
1224 .scope
= OPTIONS_TABLE_WINDOW
,
1225 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1226 .text
= "Format of windows in the status line, except the current "
1230 { .name
= "window-status-last-style",
1231 .type
= OPTIONS_TABLE_STRING
,
1232 .scope
= OPTIONS_TABLE_WINDOW
,
1233 .default_str
= "default",
1234 .flags
= OPTIONS_TABLE_IS_STYLE
,
1236 .text
= "Style of the last window in the status line."
1239 { .name
= "window-status-separator",
1240 .type
= OPTIONS_TABLE_STRING
,
1241 .scope
= OPTIONS_TABLE_WINDOW
,
1243 .text
= "Separator between windows in the status line."
1246 { .name
= "window-status-style",
1247 .type
= OPTIONS_TABLE_STRING
,
1248 .scope
= OPTIONS_TABLE_WINDOW
,
1249 .default_str
= "default",
1250 .flags
= OPTIONS_TABLE_IS_STYLE
,
1252 .text
= "Style of windows in the status line, except the current and "
1256 { .name
= "wrap-search",
1257 .type
= OPTIONS_TABLE_FLAG
,
1258 .scope
= OPTIONS_TABLE_WINDOW
,
1260 .text
= "Whether searching in copy mode should wrap at the top or "
1264 { .name
= "xterm-keys", /* no longer used */
1265 .type
= OPTIONS_TABLE_FLAG
,
1266 .scope
= OPTIONS_TABLE_WINDOW
,
1268 .text
= "Whether xterm-style function key sequences should be sent. "
1269 "This option is no longer used."
1273 OPTIONS_TABLE_HOOK("after-bind-key", ""),
1274 OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1275 OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1276 OPTIONS_TABLE_HOOK("after-display-message", ""),
1277 OPTIONS_TABLE_HOOK("after-display-panes", ""),
1278 OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1279 OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1280 OPTIONS_TABLE_HOOK("after-list-clients", ""),
1281 OPTIONS_TABLE_HOOK("after-list-keys", ""),
1282 OPTIONS_TABLE_HOOK("after-list-panes", ""),
1283 OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1284 OPTIONS_TABLE_HOOK("after-list-windows", ""),
1285 OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1286 OPTIONS_TABLE_HOOK("after-lock-server", ""),
1287 OPTIONS_TABLE_HOOK("after-new-session", ""),
1288 OPTIONS_TABLE_HOOK("after-new-window", ""),
1289 OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1290 OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1291 OPTIONS_TABLE_HOOK("after-queue", ""),
1292 OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1293 OPTIONS_TABLE_HOOK("after-rename-session", ""),
1294 OPTIONS_TABLE_HOOK("after-rename-window", ""),
1295 OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1296 OPTIONS_TABLE_HOOK("after-resize-window", ""),
1297 OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1298 OPTIONS_TABLE_HOOK("after-select-layout", ""),
1299 OPTIONS_TABLE_HOOK("after-select-pane", ""),
1300 OPTIONS_TABLE_HOOK("after-select-window", ""),
1301 OPTIONS_TABLE_HOOK("after-send-keys", ""),
1302 OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1303 OPTIONS_TABLE_HOOK("after-set-environment", ""),
1304 OPTIONS_TABLE_HOOK("after-set-hook", ""),
1305 OPTIONS_TABLE_HOOK("after-set-option", ""),
1306 OPTIONS_TABLE_HOOK("after-show-environment", ""),
1307 OPTIONS_TABLE_HOOK("after-show-messages", ""),
1308 OPTIONS_TABLE_HOOK("after-show-options", ""),
1309 OPTIONS_TABLE_HOOK("after-split-window", ""),
1310 OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1311 OPTIONS_TABLE_HOOK("alert-activity", ""),
1312 OPTIONS_TABLE_HOOK("alert-bell", ""),
1313 OPTIONS_TABLE_HOOK("alert-silence", ""),
1314 OPTIONS_TABLE_HOOK("client-active", ""),
1315 OPTIONS_TABLE_HOOK("client-attached", ""),
1316 OPTIONS_TABLE_HOOK("client-detached", ""),
1317 OPTIONS_TABLE_HOOK("client-focus-in", ""),
1318 OPTIONS_TABLE_HOOK("client-focus-out", ""),
1319 OPTIONS_TABLE_HOOK("client-resized", ""),
1320 OPTIONS_TABLE_HOOK("client-session-changed", ""),
1321 OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1322 OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1323 OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1324 OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1325 OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1326 OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1327 OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1328 OPTIONS_TABLE_HOOK("session-closed", ""),
1329 OPTIONS_TABLE_HOOK("session-created", ""),
1330 OPTIONS_TABLE_HOOK("session-renamed", ""),
1331 OPTIONS_TABLE_HOOK("session-window-changed", ""),
1332 OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1333 OPTIONS_TABLE_HOOK("window-linked", ""),
1334 OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1335 OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1336 OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
1337 OPTIONS_TABLE_HOOK("window-unlinked", ""),