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>
26 * This file has a tables with all the server, session and window
27 * options. These tables are the master copy of the options with their real
28 * (user-visible) types, range limits and default values. At start these are
29 * copied into the runtime global options trees (which only has number and
30 * string types). These tables are then used to look up the real type when the
31 * user sets an option or its value needs to be shown.
34 /* Choice option type lists. */
35 static const char *options_table_mode_keys_list
[] = {
38 static const char *options_table_clock_mode_style_list
[] = {
41 static const char *options_table_status_list
[] = {
42 "off", "on", "2", "3", "4", "5", NULL
44 static const char *options_table_message_line_list
[] = {
45 "0", "1", "2", "3", "4", NULL
47 static const char *options_table_status_keys_list
[] = {
50 static const char *options_table_status_justify_list
[] = {
51 "left", "centre", "right", "absolute-centre", NULL
53 static const char *options_table_status_position_list
[] = {
56 static const char *options_table_bell_action_list
[] = {
57 "none", "any", "current", "other", NULL
59 static const char *options_table_visual_bell_list
[] = {
60 "off", "on", "both", NULL
62 static const char *options_table_cursor_style_list
[] = {
63 "default", "blinking-block", "block", "blinking-underline", "underline",
64 "blinking-bar", "bar", NULL
66 static const char *options_table_pane_status_list
[] = {
67 "off", "top", "bottom", NULL
69 static const char *options_table_pane_border_indicators_list
[] = {
70 "off", "colour", "arrows", "both", NULL
72 static const char *options_table_pane_border_lines_list
[] = {
73 "single", "double", "heavy", "simple", "number", NULL
75 static const char *options_table_popup_border_lines_list
[] = {
76 "single", "double", "heavy", "simple", "rounded", "padded", "none", NULL
78 static const char *options_table_set_clipboard_list
[] = {
79 "off", "external", "on", NULL
81 static const char *options_table_window_size_list
[] = {
82 "largest", "smallest", "manual", "latest", NULL
84 static const char *options_table_remain_on_exit_list
[] = {
85 "off", "on", "failed", NULL
87 static const char *options_table_detach_on_destroy_list
[] = {
88 "off", "on", "no-detached", "previous", "next", NULL
90 static const char *options_table_extended_keys_list
[] = {
91 "off", "on", "always", NULL
93 static const char *options_table_allow_passthrough_list
[] = {
94 "off", "on", "all", NULL
97 /* Status line format. */
98 #define OPTIONS_TABLE_STATUS_FORMAT1 \
99 "#[align=left range=left #{E:status-left-style}]" \
101 "#{T;=/#{status-left-length}:status-left}" \
103 "#[norange default]" \
104 "#[list=on align=#{status-justify}]" \
105 "#[list=left-marker]<#[list=right-marker]>#[list=on]" \
107 "#[range=window|#{window_index} " \
108 "#{E:window-status-style}" \
109 "#{?#{&&:#{window_last_flag}," \
110 "#{!=:#{E:window-status-last-style},default}}, " \
111 "#{E:window-status-last-style}," \
113 "#{?#{&&:#{window_bell_flag}," \
114 "#{!=:#{E:window-status-bell-style},default}}, " \
115 "#{E:window-status-bell-style}," \
116 "#{?#{&&:#{||:#{window_activity_flag}," \
117 "#{window_silence_flag}}," \
119 "#{E:window-status-activity-style}," \
121 "#{E:window-status-activity-style}," \
126 "#{T:window-status-format}" \
128 "#[norange default]" \
129 "#{?window_end_flag,,#{window-status-separator}}" \
131 "#[range=window|#{window_index} list=focus " \
132 "#{?#{!=:#{E:window-status-current-style},default}," \
133 "#{E:window-status-current-style}," \
134 "#{E:window-status-style}" \
136 "#{?#{&&:#{window_last_flag}," \
137 "#{!=:#{E:window-status-last-style},default}}, " \
138 "#{E:window-status-last-style}," \
140 "#{?#{&&:#{window_bell_flag}," \
141 "#{!=:#{E:window-status-bell-style},default}}, " \
142 "#{E:window-status-bell-style}," \
143 "#{?#{&&:#{||:#{window_activity_flag}," \
144 "#{window_silence_flag}}," \
146 "#{E:window-status-activity-style}," \
148 "#{E:window-status-activity-style}," \
153 "#{T:window-status-current-format}" \
155 "#[norange list=on default]" \
156 "#{?window_end_flag,,#{window-status-separator}}" \
158 "#[nolist align=right range=right #{E:status-right-style}]" \
160 "#{T;=/#{status-right-length}:status-right}" \
163 #define OPTIONS_TABLE_STATUS_FORMAT2 \
164 "#[align=centre]#{P:#{?pane_active,#[reverse],}" \
165 "#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
166 static const char *options_table_status_format_default
[] = {
167 OPTIONS_TABLE_STATUS_FORMAT1
, OPTIONS_TABLE_STATUS_FORMAT2
, NULL
170 /* Helpers for hook options. */
171 #define OPTIONS_TABLE_HOOK(hook_name, default_value) \
172 { .name = hook_name, \
173 .type = OPTIONS_TABLE_COMMAND, \
174 .scope = OPTIONS_TABLE_SESSION, \
175 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
176 .default_str = default_value, \
180 #define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
181 { .name = hook_name, \
182 .type = OPTIONS_TABLE_COMMAND, \
183 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
184 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
185 .default_str = default_value, \
189 #define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
190 { .name = hook_name, \
191 .type = OPTIONS_TABLE_COMMAND, \
192 .scope = OPTIONS_TABLE_WINDOW, \
193 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
194 .default_str = default_value, \
198 /* Map of name conversions. */
199 const struct options_name_map options_other_names
[] = {
200 { "display-panes-color", "display-panes-colour" },
201 { "display-panes-active-color", "display-panes-active-colour" },
202 { "clock-mode-color", "clock-mode-colour" },
203 { "cursor-color", "cursor-colour" },
204 { "pane-colors", "pane-colours" },
208 /* Top-level options. */
209 const struct options_table_entry options_table
[] = {
210 /* Server options. */
211 { .name
= "backspace",
212 .type
= OPTIONS_TABLE_KEY
,
213 .scope
= OPTIONS_TABLE_SERVER
,
214 .default_num
= '\177',
215 .text
= "The key to send for backspace."
218 { .name
= "buffer-limit",
219 .type
= OPTIONS_TABLE_NUMBER
,
220 .scope
= OPTIONS_TABLE_SERVER
,
224 .text
= "The maximum number of automatic buffers. "
225 "When this is reached, the oldest buffer is deleted."
228 { .name
= "command-alias",
229 .type
= OPTIONS_TABLE_STRING
,
230 .scope
= OPTIONS_TABLE_SERVER
,
231 .flags
= OPTIONS_TABLE_IS_ARRAY
,
232 .default_str
= "split-pane=split-window,"
233 "splitp=split-window,"
234 "server-info=show-messages -JT,"
235 "info=show-messages -JT,"
236 "choose-window=choose-tree -w,"
237 "choose-session=choose-tree -s",
239 .text
= "Array of command aliases. "
240 "Each entry is an alias and a command separated by '='."
243 { .name
= "copy-command",
244 .type
= OPTIONS_TABLE_STRING
,
245 .scope
= OPTIONS_TABLE_SERVER
,
247 .text
= "Shell command run when text is copied. "
248 "If empty, no command is run."
251 { .name
= "cursor-colour",
252 .type
= OPTIONS_TABLE_COLOUR
,
253 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
255 .text
= "Colour of the cursor."
258 { .name
= "cursor-style",
259 .type
= OPTIONS_TABLE_CHOICE
,
260 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
261 .choices
= options_table_cursor_style_list
,
263 .text
= "Style of the cursor."
266 { .name
= "default-terminal",
267 .type
= OPTIONS_TABLE_STRING
,
268 .scope
= OPTIONS_TABLE_SERVER
,
269 .default_str
= TMUX_TERM
,
270 .text
= "Default for the 'TERM' environment variable."
274 .type
= OPTIONS_TABLE_STRING
,
275 .scope
= OPTIONS_TABLE_SERVER
,
276 .default_str
= _PATH_VI
,
277 .text
= "Editor run to edit files."
280 { .name
= "escape-time",
281 .type
= OPTIONS_TABLE_NUMBER
,
282 .scope
= OPTIONS_TABLE_SERVER
,
286 .unit
= "milliseconds",
287 .text
= "Time to wait before assuming a key is Escape."
290 { .name
= "exit-empty",
291 .type
= OPTIONS_TABLE_FLAG
,
292 .scope
= OPTIONS_TABLE_SERVER
,
294 .text
= "Whether the server should exit if there are no sessions."
297 { .name
= "exit-unattached",
298 .type
= OPTIONS_TABLE_FLAG
,
299 .scope
= OPTIONS_TABLE_SERVER
,
301 .text
= "Whether the server should exit if there are no attached "
305 { .name
= "extended-keys",
306 .type
= OPTIONS_TABLE_CHOICE
,
307 .scope
= OPTIONS_TABLE_SERVER
,
308 .choices
= options_table_extended_keys_list
,
310 .text
= "Whether to request extended key sequences from terminals "
314 { .name
= "focus-events",
315 .type
= OPTIONS_TABLE_FLAG
,
316 .scope
= OPTIONS_TABLE_SERVER
,
318 .text
= "Whether to send focus events to applications."
321 { .name
= "history-file",
322 .type
= OPTIONS_TABLE_STRING
,
323 .scope
= OPTIONS_TABLE_SERVER
,
325 .text
= "Location of the command prompt history file. "
326 "Empty does not write a history file."
329 { .name
= "menu-style",
330 .type
= OPTIONS_TABLE_STRING
,
331 .scope
= OPTIONS_TABLE_WINDOW
,
332 .flags
= OPTIONS_TABLE_IS_STYLE
,
333 .default_str
= "default",
335 .text
= "Default style of menu."
338 { .name
= "menu-selected-style",
339 .type
= OPTIONS_TABLE_STRING
,
340 .scope
= OPTIONS_TABLE_WINDOW
,
341 .flags
= OPTIONS_TABLE_IS_STYLE
,
342 .default_str
= "bg=yellow,fg=black",
344 .text
= "Default style of selected menu item."
347 { .name
= "menu-border-style",
348 .type
= OPTIONS_TABLE_STRING
,
349 .scope
= OPTIONS_TABLE_WINDOW
,
350 .default_str
= "default",
351 .flags
= OPTIONS_TABLE_IS_STYLE
,
353 .text
= "Default style of menu borders."
356 { .name
= "menu-border-lines",
357 .type
= OPTIONS_TABLE_CHOICE
,
358 .scope
= OPTIONS_TABLE_WINDOW
,
359 .choices
= options_table_popup_border_lines_list
,
360 .default_num
= BOX_LINES_SINGLE
,
361 .text
= "Type of characters used to draw menu border lines. Some of "
362 "these are only supported on terminals with UTF-8 support."
365 { .name
= "message-limit",
366 .type
= OPTIONS_TABLE_NUMBER
,
367 .scope
= OPTIONS_TABLE_SERVER
,
371 .text
= "Maximum number of server messages to keep."
374 { .name
= "prompt-history-limit",
375 .type
= OPTIONS_TABLE_NUMBER
,
376 .scope
= OPTIONS_TABLE_SERVER
,
380 .text
= "Maximum number of commands to keep in history."
383 { .name
= "set-clipboard",
384 .type
= OPTIONS_TABLE_CHOICE
,
385 .scope
= OPTIONS_TABLE_SERVER
,
386 .choices
= options_table_set_clipboard_list
,
388 .text
= "Whether to attempt to set the system clipboard ('on' or "
389 "'external') and whether to allow applications to create "
390 "paste buffers with an escape sequence ('on' only)."
393 { .name
= "terminal-overrides",
394 .type
= OPTIONS_TABLE_STRING
,
395 .scope
= OPTIONS_TABLE_SERVER
,
396 .flags
= OPTIONS_TABLE_IS_ARRAY
,
399 .text
= "List of terminal capabilities overrides."
402 { .name
= "terminal-features",
403 .type
= OPTIONS_TABLE_STRING
,
404 .scope
= OPTIONS_TABLE_SERVER
,
405 .flags
= OPTIONS_TABLE_IS_ARRAY
,
406 .default_str
= "xterm*:clipboard:ccolour:cstyle:focus:title,"
410 .text
= "List of terminal features, used if they cannot be "
411 "automatically detected."
414 { .name
= "user-keys",
415 .type
= OPTIONS_TABLE_STRING
,
416 .scope
= OPTIONS_TABLE_SERVER
,
417 .flags
= OPTIONS_TABLE_IS_ARRAY
,
420 .text
= "User key assignments. "
421 "Each sequence in the list is translated into a key: "
422 "'User0', 'User1' and so on."
425 /* Session options. */
426 { .name
= "activity-action",
427 .type
= OPTIONS_TABLE_CHOICE
,
428 .scope
= OPTIONS_TABLE_SESSION
,
429 .choices
= options_table_bell_action_list
,
430 .default_num
= ALERT_OTHER
,
431 .text
= "Action to take on an activity alert."
434 { .name
= "assume-paste-time",
435 .type
= OPTIONS_TABLE_NUMBER
,
436 .scope
= OPTIONS_TABLE_SESSION
,
440 .unit
= "milliseconds",
441 .text
= "Maximum time between input to assume it is pasting rather "
445 { .name
= "base-index",
446 .type
= OPTIONS_TABLE_NUMBER
,
447 .scope
= OPTIONS_TABLE_SESSION
,
451 .text
= "Default index of the first window in each session."
454 { .name
= "bell-action",
455 .type
= OPTIONS_TABLE_CHOICE
,
456 .scope
= OPTIONS_TABLE_SESSION
,
457 .choices
= options_table_bell_action_list
,
458 .default_num
= ALERT_ANY
,
459 .text
= "Action to take on a bell alert."
462 { .name
= "default-command",
463 .type
= OPTIONS_TABLE_STRING
,
464 .scope
= OPTIONS_TABLE_SESSION
,
466 .text
= "Default command to run in new panes. If empty, a shell is "
470 { .name
= "default-shell",
471 .type
= OPTIONS_TABLE_STRING
,
472 .scope
= OPTIONS_TABLE_SESSION
,
473 .default_str
= _PATH_BSHELL
,
474 .text
= "Location of default shell."
477 { .name
= "default-size",
478 .type
= OPTIONS_TABLE_STRING
,
479 .scope
= OPTIONS_TABLE_SESSION
,
480 .pattern
= "[0-9]*x[0-9]*",
481 .default_str
= "80x24",
482 .text
= "Initial size of new sessions."
485 { .name
= "destroy-unattached",
486 .type
= OPTIONS_TABLE_FLAG
,
487 .scope
= OPTIONS_TABLE_SESSION
,
489 .text
= "Whether to destroy sessions when they have no attached "
493 { .name
= "detach-on-destroy",
494 .type
= OPTIONS_TABLE_CHOICE
,
495 .scope
= OPTIONS_TABLE_SESSION
,
496 .choices
= options_table_detach_on_destroy_list
,
498 .text
= "Whether to detach when a session is destroyed, or switch "
499 "the client to another session if any exist."
502 { .name
= "display-panes-active-colour",
503 .type
= OPTIONS_TABLE_COLOUR
,
504 .scope
= OPTIONS_TABLE_SESSION
,
506 .text
= "Colour of the active pane for 'display-panes'."
509 { .name
= "display-panes-colour",
510 .type
= OPTIONS_TABLE_COLOUR
,
511 .scope
= OPTIONS_TABLE_SESSION
,
513 .text
= "Colour of not active panes for 'display-panes'."
516 { .name
= "display-panes-time",
517 .type
= OPTIONS_TABLE_NUMBER
,
518 .scope
= OPTIONS_TABLE_SESSION
,
522 .unit
= "milliseconds",
523 .text
= "Time for which 'display-panes' should show pane numbers."
526 { .name
= "display-time",
527 .type
= OPTIONS_TABLE_NUMBER
,
528 .scope
= OPTIONS_TABLE_SESSION
,
532 .unit
= "milliseconds",
533 .text
= "Time for which status line messages should appear."
536 { .name
= "history-limit",
537 .type
= OPTIONS_TABLE_NUMBER
,
538 .scope
= OPTIONS_TABLE_SESSION
,
543 .text
= "Maximum number of lines to keep in the history for each "
545 "If changed, the new value applies only to new panes."
548 { .name
= "key-table",
549 .type
= OPTIONS_TABLE_STRING
,
550 .scope
= OPTIONS_TABLE_SESSION
,
551 .default_str
= "root",
552 .text
= "Default key table. "
553 "Key presses are first looked up in this table."
556 { .name
= "lock-after-time",
557 .type
= OPTIONS_TABLE_NUMBER
,
558 .scope
= OPTIONS_TABLE_SESSION
,
563 .text
= "Time after which a client is locked if not used."
566 { .name
= "lock-command",
567 .type
= OPTIONS_TABLE_STRING
,
568 .scope
= OPTIONS_TABLE_SESSION
,
569 .default_str
= TMUX_LOCK_CMD
,
570 .text
= "Shell command to run to lock a client."
573 { .name
= "message-command-style",
574 .type
= OPTIONS_TABLE_STRING
,
575 .scope
= OPTIONS_TABLE_SESSION
,
576 .default_str
= "bg=black,fg=yellow",
577 .flags
= OPTIONS_TABLE_IS_STYLE
,
579 .text
= "Style of the command prompt when in command mode, if "
580 "'mode-keys' is set to 'vi'."
583 { .name
= "message-line",
584 .type
= OPTIONS_TABLE_CHOICE
,
585 .scope
= OPTIONS_TABLE_SESSION
,
586 .choices
= options_table_message_line_list
,
588 .text
= "Position (line) of messages and the command prompt."
591 { .name
= "message-style",
592 .type
= OPTIONS_TABLE_STRING
,
593 .scope
= OPTIONS_TABLE_SESSION
,
594 .default_str
= "bg=yellow,fg=black",
595 .flags
= OPTIONS_TABLE_IS_STYLE
,
597 .text
= "Style of messages and the command prompt."
601 .type
= OPTIONS_TABLE_FLAG
,
602 .scope
= OPTIONS_TABLE_SESSION
,
604 .text
= "Whether the mouse is recognised and mouse key bindings are "
606 "Applications inside panes can use the mouse even when 'off'."
610 .type
= OPTIONS_TABLE_KEY
,
611 .scope
= OPTIONS_TABLE_SESSION
,
612 .default_num
= '\002',
613 .text
= "The prefix key."
617 .type
= OPTIONS_TABLE_KEY
,
618 .scope
= OPTIONS_TABLE_SESSION
,
619 .default_num
= KEYC_NONE
,
620 .text
= "A second prefix key."
623 { .name
= "renumber-windows",
624 .type
= OPTIONS_TABLE_FLAG
,
625 .scope
= OPTIONS_TABLE_SESSION
,
627 .text
= "Whether windows are automatically renumbered rather than "
631 { .name
= "repeat-time",
632 .type
= OPTIONS_TABLE_NUMBER
,
633 .scope
= OPTIONS_TABLE_SESSION
,
637 .unit
= "milliseconds",
638 .text
= "Time to wait for a key binding to repeat, if it is bound "
639 "with the '-r' flag."
642 { .name
= "set-titles",
643 .type
= OPTIONS_TABLE_FLAG
,
644 .scope
= OPTIONS_TABLE_SESSION
,
646 .text
= "Whether to set the terminal title, if supported."
649 { .name
= "set-titles-string",
650 .type
= OPTIONS_TABLE_STRING
,
651 .scope
= OPTIONS_TABLE_SESSION
,
652 .default_str
= "#S:#I:#W - \"#T\" #{session_alerts}",
653 .text
= "Format of the terminal title to set."
656 { .name
= "silence-action",
657 .type
= OPTIONS_TABLE_CHOICE
,
658 .scope
= OPTIONS_TABLE_SESSION
,
659 .choices
= options_table_bell_action_list
,
660 .default_num
= ALERT_OTHER
,
661 .text
= "Action to take on a silence alert."
665 .type
= OPTIONS_TABLE_CHOICE
,
666 .scope
= OPTIONS_TABLE_SESSION
,
667 .choices
= options_table_status_list
,
669 .text
= "Number of lines in the status line."
672 { .name
= "status-bg",
673 .type
= OPTIONS_TABLE_COLOUR
,
674 .scope
= OPTIONS_TABLE_SESSION
,
676 .text
= "Background colour of the status line. This option is "
677 "deprecated, use 'status-style' instead."
680 { .name
= "status-fg",
681 .type
= OPTIONS_TABLE_COLOUR
,
682 .scope
= OPTIONS_TABLE_SESSION
,
684 .text
= "Foreground colour of the status line. This option is "
685 "deprecated, use 'status-style' instead."
688 { .name
= "status-format",
689 .type
= OPTIONS_TABLE_STRING
,
690 .scope
= OPTIONS_TABLE_SESSION
,
691 .flags
= OPTIONS_TABLE_IS_ARRAY
,
692 .default_arr
= options_table_status_format_default
,
693 .text
= "Formats for the status lines. "
694 "Each array member is the format for one status line. "
695 "The default status line is made up of several components "
696 "which may be configured individually with other options such "
700 { .name
= "status-interval",
701 .type
= OPTIONS_TABLE_NUMBER
,
702 .scope
= OPTIONS_TABLE_SESSION
,
707 .text
= "Number of seconds between status line updates."
710 { .name
= "status-justify",
711 .type
= OPTIONS_TABLE_CHOICE
,
712 .scope
= OPTIONS_TABLE_SESSION
,
713 .choices
= options_table_status_justify_list
,
715 .text
= "Position of the window list in the status line."
718 { .name
= "status-keys",
719 .type
= OPTIONS_TABLE_CHOICE
,
720 .scope
= OPTIONS_TABLE_SESSION
,
721 .choices
= options_table_status_keys_list
,
722 .default_num
= MODEKEY_EMACS
,
723 .text
= "Key set to use at the command prompt."
726 { .name
= "status-left",
727 .type
= OPTIONS_TABLE_STRING
,
728 .scope
= OPTIONS_TABLE_SESSION
,
729 .default_str
= "[#{session_name}] ",
730 .text
= "Contents of the left side of the status line."
733 { .name
= "status-left-length",
734 .type
= OPTIONS_TABLE_NUMBER
,
735 .scope
= OPTIONS_TABLE_SESSION
,
739 .text
= "Maximum width of the left side of the status line."
742 { .name
= "status-left-style",
743 .type
= OPTIONS_TABLE_STRING
,
744 .scope
= OPTIONS_TABLE_SESSION
,
745 .default_str
= "default",
746 .flags
= OPTIONS_TABLE_IS_STYLE
,
748 .text
= "Style of the left side of the status line."
751 { .name
= "status-position",
752 .type
= OPTIONS_TABLE_CHOICE
,
753 .scope
= OPTIONS_TABLE_SESSION
,
754 .choices
= options_table_status_position_list
,
756 .text
= "Position of the status line."
759 { .name
= "status-right",
760 .type
= OPTIONS_TABLE_STRING
,
761 .scope
= OPTIONS_TABLE_SESSION
,
762 .default_str
= "#{?window_bigger,"
763 "[#{window_offset_x}#,#{window_offset_y}] ,}"
764 "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
765 .text
= "Contents of the right side of the status line."
769 { .name
= "status-right-length",
770 .type
= OPTIONS_TABLE_NUMBER
,
771 .scope
= OPTIONS_TABLE_SESSION
,
775 .text
= "Maximum width of the right side of the status line."
778 { .name
= "status-right-style",
779 .type
= OPTIONS_TABLE_STRING
,
780 .scope
= OPTIONS_TABLE_SESSION
,
781 .default_str
= "default",
782 .flags
= OPTIONS_TABLE_IS_STYLE
,
784 .text
= "Style of the right side of the status line."
787 { .name
= "status-style",
788 .type
= OPTIONS_TABLE_STRING
,
789 .scope
= OPTIONS_TABLE_SESSION
,
790 .default_str
= "bg=green,fg=black",
791 .flags
= OPTIONS_TABLE_IS_STYLE
,
793 .text
= "Style of the status line."
796 { .name
= "update-environment",
797 .type
= OPTIONS_TABLE_STRING
,
798 .scope
= OPTIONS_TABLE_SESSION
,
799 .flags
= OPTIONS_TABLE_IS_ARRAY
,
800 .default_str
= "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
801 "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
802 .text
= "List of environment variables to update in the session "
803 "environment when a client is attached."
806 { .name
= "visual-activity",
807 .type
= OPTIONS_TABLE_CHOICE
,
808 .scope
= OPTIONS_TABLE_SESSION
,
809 .choices
= options_table_visual_bell_list
,
810 .default_num
= VISUAL_OFF
,
811 .text
= "How activity alerts should be shown: a message ('on'), "
812 "a message and a bell ('both') or nothing ('off')."
815 { .name
= "visual-bell",
816 .type
= OPTIONS_TABLE_CHOICE
,
817 .scope
= OPTIONS_TABLE_SESSION
,
818 .choices
= options_table_visual_bell_list
,
819 .default_num
= VISUAL_OFF
,
820 .text
= "How bell alerts should be shown: a message ('on'), "
821 "a message and a bell ('both') or nothing ('off')."
824 { .name
= "visual-silence",
825 .type
= OPTIONS_TABLE_CHOICE
,
826 .scope
= OPTIONS_TABLE_SESSION
,
827 .choices
= options_table_visual_bell_list
,
828 .default_num
= VISUAL_OFF
,
829 .text
= "How silence alerts should be shown: a message ('on'), "
830 "a message and a bell ('both') or nothing ('off')."
833 { .name
= "word-separators",
834 .type
= OPTIONS_TABLE_STRING
,
835 .scope
= OPTIONS_TABLE_SESSION
,
837 * The set of non-alphanumeric printable ASCII characters minus the
840 .default_str
= "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
841 .text
= "Characters considered to separate words."
844 /* Window options. */
845 { .name
= "aggressive-resize",
846 .type
= OPTIONS_TABLE_FLAG
,
847 .scope
= OPTIONS_TABLE_WINDOW
,
849 .text
= "When 'window-size' is 'smallest', whether the maximum size "
850 "of a window is the smallest attached session where it is "
851 "the current window ('on') or the smallest session it is "
855 { .name
= "allow-passthrough",
856 .type
= OPTIONS_TABLE_CHOICE
,
857 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
858 .choices
= options_table_allow_passthrough_list
,
860 .text
= "Whether applications are allowed to use the escape sequence "
861 "to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
862 "if the pane is visible), or 'all' (allowed even if the pane "
866 { .name
= "allow-rename",
867 .type
= OPTIONS_TABLE_FLAG
,
868 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
870 .text
= "Whether applications are allowed to use the escape sequence "
874 { .name
= "alternate-screen",
875 .type
= OPTIONS_TABLE_FLAG
,
876 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
878 .text
= "Whether applications are allowed to use the alternate "
882 { .name
= "automatic-rename",
883 .type
= OPTIONS_TABLE_FLAG
,
884 .scope
= OPTIONS_TABLE_WINDOW
,
886 .text
= "Whether windows are automatically renamed."
889 { .name
= "automatic-rename-format",
890 .type
= OPTIONS_TABLE_STRING
,
891 .scope
= OPTIONS_TABLE_WINDOW
,
892 .default_str
= "#{?pane_in_mode,[tmux],#{pane_current_command}}"
893 "#{?pane_dead,[dead],}",
894 .text
= "Format used to automatically rename windows."
897 { .name
= "clock-mode-colour",
898 .type
= OPTIONS_TABLE_COLOUR
,
899 .scope
= OPTIONS_TABLE_WINDOW
,
901 .text
= "Colour of the clock in clock mode."
904 { .name
= "clock-mode-style",
905 .type
= OPTIONS_TABLE_CHOICE
,
906 .scope
= OPTIONS_TABLE_WINDOW
,
907 .choices
= options_table_clock_mode_style_list
,
909 .text
= "Time format of the clock in clock mode."
912 { .name
= "copy-mode-match-style",
913 .type
= OPTIONS_TABLE_STRING
,
914 .scope
= OPTIONS_TABLE_WINDOW
,
915 .default_str
= "bg=cyan,fg=black",
916 .flags
= OPTIONS_TABLE_IS_STYLE
,
918 .text
= "Style of search matches in copy mode."
921 { .name
= "copy-mode-current-match-style",
922 .type
= OPTIONS_TABLE_STRING
,
923 .scope
= OPTIONS_TABLE_WINDOW
,
924 .default_str
= "bg=magenta,fg=black",
925 .flags
= OPTIONS_TABLE_IS_STYLE
,
927 .text
= "Style of the current search match in copy mode."
930 { .name
= "copy-mode-mark-style",
931 .type
= OPTIONS_TABLE_STRING
,
932 .scope
= OPTIONS_TABLE_WINDOW
,
933 .default_str
= "bg=red,fg=black",
934 .flags
= OPTIONS_TABLE_IS_STYLE
,
936 .text
= "Style of the marked line in copy mode."
939 { .name
= "fill-character",
940 .type
= OPTIONS_TABLE_STRING
,
941 .scope
= OPTIONS_TABLE_WINDOW
,
943 .text
= "Character used to fill unused parts of window."
946 { .name
= "main-pane-height",
947 .type
= OPTIONS_TABLE_STRING
,
948 .scope
= OPTIONS_TABLE_WINDOW
,
950 .text
= "Height of the main pane in the 'main-horizontal' layout. "
951 "This may be a percentage, for example '10%'."
954 { .name
= "main-pane-width",
955 .type
= OPTIONS_TABLE_STRING
,
956 .scope
= OPTIONS_TABLE_WINDOW
,
958 .text
= "Width of the main pane in the 'main-vertical' layout. "
959 "This may be a percentage, for example '10%'."
962 { .name
= "mode-keys",
963 .type
= OPTIONS_TABLE_CHOICE
,
964 .scope
= OPTIONS_TABLE_WINDOW
,
965 .choices
= options_table_mode_keys_list
,
966 .default_num
= MODEKEY_EMACS
,
967 .text
= "Key set used in copy mode."
970 { .name
= "mode-style",
971 .type
= OPTIONS_TABLE_STRING
,
972 .scope
= OPTIONS_TABLE_WINDOW
,
973 .flags
= OPTIONS_TABLE_IS_STYLE
,
974 .default_str
= "bg=yellow,fg=black",
976 .text
= "Style of indicators and highlighting in modes."
979 { .name
= "monitor-activity",
980 .type
= OPTIONS_TABLE_FLAG
,
981 .scope
= OPTIONS_TABLE_WINDOW
,
983 .text
= "Whether an alert is triggered by activity."
986 { .name
= "monitor-bell",
987 .type
= OPTIONS_TABLE_FLAG
,
988 .scope
= OPTIONS_TABLE_WINDOW
,
990 .text
= "Whether an alert is triggered by a bell."
993 { .name
= "monitor-silence",
994 .type
= OPTIONS_TABLE_NUMBER
,
995 .scope
= OPTIONS_TABLE_WINDOW
,
999 .text
= "Time after which an alert is triggered by silence. "
1000 "Zero means no alert."
1004 { .name
= "other-pane-height",
1005 .type
= OPTIONS_TABLE_STRING
,
1006 .scope
= OPTIONS_TABLE_WINDOW
,
1008 .text
= "Height of the other panes in the 'main-horizontal' layout. "
1009 "This may be a percentage, for example '10%'."
1012 { .name
= "other-pane-width",
1013 .type
= OPTIONS_TABLE_STRING
,
1014 .scope
= OPTIONS_TABLE_WINDOW
,
1016 .text
= "Height of the other panes in the 'main-vertical' layout. "
1017 "This may be a percentage, for example '10%'."
1020 { .name
= "pane-active-border-style",
1021 .type
= OPTIONS_TABLE_STRING
,
1022 .scope
= OPTIONS_TABLE_WINDOW
,
1023 .default_str
= "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
1024 .flags
= OPTIONS_TABLE_IS_STYLE
,
1026 .text
= "Style of the active pane border."
1029 { .name
= "pane-base-index",
1030 .type
= OPTIONS_TABLE_NUMBER
,
1031 .scope
= OPTIONS_TABLE_WINDOW
,
1033 .maximum
= USHRT_MAX
,
1035 .text
= "Index of the first pane in each window."
1038 { .name
= "pane-border-format",
1039 .type
= OPTIONS_TABLE_STRING
,
1040 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1041 .default_str
= "#{?pane_active,#[reverse],}#{pane_index}#[default] "
1042 "\"#{pane_title}\"",
1043 .text
= "Format of text in the pane status lines."
1046 { .name
= "pane-border-indicators",
1047 .type
= OPTIONS_TABLE_CHOICE
,
1048 .scope
= OPTIONS_TABLE_WINDOW
,
1049 .choices
= options_table_pane_border_indicators_list
,
1050 .default_num
= PANE_BORDER_COLOUR
,
1051 .text
= "Whether to indicate the active pane by colouring border or "
1052 "displaying arrow markers."
1055 { .name
= "pane-border-lines",
1056 .type
= OPTIONS_TABLE_CHOICE
,
1057 .scope
= OPTIONS_TABLE_WINDOW
,
1058 .choices
= options_table_pane_border_lines_list
,
1059 .default_num
= PANE_LINES_SINGLE
,
1060 .text
= "Type of characters used to draw pane border lines. Some of "
1061 "these are only supported on terminals with UTF-8 support."
1064 { .name
= "pane-border-status",
1065 .type
= OPTIONS_TABLE_CHOICE
,
1066 .scope
= OPTIONS_TABLE_WINDOW
,
1067 .choices
= options_table_pane_status_list
,
1068 .default_num
= PANE_STATUS_OFF
,
1069 .text
= "Position of the pane status lines."
1072 { .name
= "pane-border-style",
1073 .type
= OPTIONS_TABLE_STRING
,
1074 .scope
= OPTIONS_TABLE_WINDOW
,
1075 .default_str
= "default",
1076 .flags
= OPTIONS_TABLE_IS_STYLE
,
1078 .text
= "Style of the pane status lines."
1081 { .name
= "pane-colours",
1082 .type
= OPTIONS_TABLE_COLOUR
,
1083 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1085 .flags
= OPTIONS_TABLE_IS_ARRAY
,
1086 .text
= "The default colour palette for colours zero to 255."
1089 { .name
= "popup-style",
1090 .type
= OPTIONS_TABLE_STRING
,
1091 .scope
= OPTIONS_TABLE_WINDOW
,
1092 .default_str
= "default",
1093 .flags
= OPTIONS_TABLE_IS_STYLE
,
1095 .text
= "Default style of popups."
1098 { .name
= "popup-border-style",
1099 .type
= OPTIONS_TABLE_STRING
,
1100 .scope
= OPTIONS_TABLE_WINDOW
,
1101 .default_str
= "default",
1102 .flags
= OPTIONS_TABLE_IS_STYLE
,
1104 .text
= "Default style of popup borders."
1107 { .name
= "popup-border-lines",
1108 .type
= OPTIONS_TABLE_CHOICE
,
1109 .scope
= OPTIONS_TABLE_WINDOW
,
1110 .choices
= options_table_popup_border_lines_list
,
1111 .default_num
= BOX_LINES_SINGLE
,
1112 .text
= "Type of characters used to draw popup border lines. Some of "
1113 "these are only supported on terminals with UTF-8 support."
1116 { .name
= "remain-on-exit",
1117 .type
= OPTIONS_TABLE_CHOICE
,
1118 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1119 .choices
= options_table_remain_on_exit_list
,
1121 .text
= "Whether panes should remain ('on') or be automatically "
1122 "killed ('off' or 'failed') when the program inside exits."
1125 { .name
= "remain-on-exit-format",
1126 .type
= OPTIONS_TABLE_STRING
,
1127 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1128 .default_str
= "Pane is dead ("
1129 "#{?#{!=:#{pane_dead_status},},"
1130 "status #{pane_dead_status},}"
1131 "#{?#{!=:#{pane_dead_signal},},"
1132 "signal #{pane_dead_signal},}, "
1133 "#{t:pane_dead_time})",
1134 .text
= "Message shown after the program in a pane has exited, if "
1135 "remain-on-exit is enabled."
1138 { .name
= "scroll-on-clear",
1139 .type
= OPTIONS_TABLE_FLAG
,
1140 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1142 .text
= "Whether the contents of the screen should be scrolled into"
1143 "history when clearing the whole screen."
1146 { .name
= "synchronize-panes",
1147 .type
= OPTIONS_TABLE_FLAG
,
1148 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1150 .text
= "Whether typing should be sent to all panes simultaneously."
1153 { .name
= "window-active-style",
1154 .type
= OPTIONS_TABLE_STRING
,
1155 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1156 .default_str
= "default",
1157 .flags
= OPTIONS_TABLE_IS_STYLE
,
1159 .text
= "Default style of the active pane."
1162 { .name
= "window-size",
1163 .type
= OPTIONS_TABLE_CHOICE
,
1164 .scope
= OPTIONS_TABLE_WINDOW
,
1165 .choices
= options_table_window_size_list
,
1166 .default_num
= WINDOW_SIZE_LATEST
,
1167 .text
= "How window size is calculated. "
1168 "'latest' uses the size of the most recently used client, "
1169 "'largest' the largest client, 'smallest' the smallest "
1170 "client and 'manual' a size set by the 'resize-window' "
1174 { .name
= "window-style",
1175 .type
= OPTIONS_TABLE_STRING
,
1176 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1177 .default_str
= "default",
1178 .flags
= OPTIONS_TABLE_IS_STYLE
,
1180 .text
= "Default style of panes that are not the active pane."
1183 { .name
= "window-status-activity-style",
1184 .type
= OPTIONS_TABLE_STRING
,
1185 .scope
= OPTIONS_TABLE_WINDOW
,
1186 .default_str
= "reverse",
1187 .flags
= OPTIONS_TABLE_IS_STYLE
,
1189 .text
= "Style of windows in the status line with an activity alert."
1192 { .name
= "window-status-bell-style",
1193 .type
= OPTIONS_TABLE_STRING
,
1194 .scope
= OPTIONS_TABLE_WINDOW
,
1195 .default_str
= "reverse",
1196 .flags
= OPTIONS_TABLE_IS_STYLE
,
1198 .text
= "Style of windows in the status line with a bell alert."
1201 { .name
= "window-status-current-format",
1202 .type
= OPTIONS_TABLE_STRING
,
1203 .scope
= OPTIONS_TABLE_WINDOW
,
1204 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1205 .text
= "Format of the current window in the status line."
1208 { .name
= "window-status-current-style",
1209 .type
= OPTIONS_TABLE_STRING
,
1210 .scope
= OPTIONS_TABLE_WINDOW
,
1211 .default_str
= "default",
1212 .flags
= OPTIONS_TABLE_IS_STYLE
,
1214 .text
= "Style of the current window in the status line."
1217 { .name
= "window-status-format",
1218 .type
= OPTIONS_TABLE_STRING
,
1219 .scope
= OPTIONS_TABLE_WINDOW
,
1220 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1221 .text
= "Format of windows in the status line, except the current "
1225 { .name
= "window-status-last-style",
1226 .type
= OPTIONS_TABLE_STRING
,
1227 .scope
= OPTIONS_TABLE_WINDOW
,
1228 .default_str
= "default",
1229 .flags
= OPTIONS_TABLE_IS_STYLE
,
1231 .text
= "Style of the last window in the status line."
1234 { .name
= "window-status-separator",
1235 .type
= OPTIONS_TABLE_STRING
,
1236 .scope
= OPTIONS_TABLE_WINDOW
,
1238 .text
= "Separator between windows in the status line."
1241 { .name
= "window-status-style",
1242 .type
= OPTIONS_TABLE_STRING
,
1243 .scope
= OPTIONS_TABLE_WINDOW
,
1244 .default_str
= "default",
1245 .flags
= OPTIONS_TABLE_IS_STYLE
,
1247 .text
= "Style of windows in the status line, except the current and "
1251 { .name
= "wrap-search",
1252 .type
= OPTIONS_TABLE_FLAG
,
1253 .scope
= OPTIONS_TABLE_WINDOW
,
1255 .text
= "Whether searching in copy mode should wrap at the top or "
1259 { .name
= "xterm-keys", /* no longer used */
1260 .type
= OPTIONS_TABLE_FLAG
,
1261 .scope
= OPTIONS_TABLE_WINDOW
,
1263 .text
= "Whether xterm-style function key sequences should be sent. "
1264 "This option is no longer used."
1268 OPTIONS_TABLE_HOOK("after-bind-key", ""),
1269 OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1270 OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1271 OPTIONS_TABLE_HOOK("after-display-message", ""),
1272 OPTIONS_TABLE_HOOK("after-display-panes", ""),
1273 OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1274 OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1275 OPTIONS_TABLE_HOOK("after-list-clients", ""),
1276 OPTIONS_TABLE_HOOK("after-list-keys", ""),
1277 OPTIONS_TABLE_HOOK("after-list-panes", ""),
1278 OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1279 OPTIONS_TABLE_HOOK("after-list-windows", ""),
1280 OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1281 OPTIONS_TABLE_HOOK("after-lock-server", ""),
1282 OPTIONS_TABLE_HOOK("after-new-session", ""),
1283 OPTIONS_TABLE_HOOK("after-new-window", ""),
1284 OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1285 OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1286 OPTIONS_TABLE_HOOK("after-queue", ""),
1287 OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1288 OPTIONS_TABLE_HOOK("after-rename-session", ""),
1289 OPTIONS_TABLE_HOOK("after-rename-window", ""),
1290 OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1291 OPTIONS_TABLE_HOOK("after-resize-window", ""),
1292 OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1293 OPTIONS_TABLE_HOOK("after-select-layout", ""),
1294 OPTIONS_TABLE_HOOK("after-select-pane", ""),
1295 OPTIONS_TABLE_HOOK("after-select-window", ""),
1296 OPTIONS_TABLE_HOOK("after-send-keys", ""),
1297 OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1298 OPTIONS_TABLE_HOOK("after-set-environment", ""),
1299 OPTIONS_TABLE_HOOK("after-set-hook", ""),
1300 OPTIONS_TABLE_HOOK("after-set-option", ""),
1301 OPTIONS_TABLE_HOOK("after-show-environment", ""),
1302 OPTIONS_TABLE_HOOK("after-show-messages", ""),
1303 OPTIONS_TABLE_HOOK("after-show-options", ""),
1304 OPTIONS_TABLE_HOOK("after-split-window", ""),
1305 OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1306 OPTIONS_TABLE_HOOK("alert-activity", ""),
1307 OPTIONS_TABLE_HOOK("alert-bell", ""),
1308 OPTIONS_TABLE_HOOK("alert-silence", ""),
1309 OPTIONS_TABLE_HOOK("client-active", ""),
1310 OPTIONS_TABLE_HOOK("client-attached", ""),
1311 OPTIONS_TABLE_HOOK("client-detached", ""),
1312 OPTIONS_TABLE_HOOK("client-focus-in", ""),
1313 OPTIONS_TABLE_HOOK("client-focus-out", ""),
1314 OPTIONS_TABLE_HOOK("client-resized", ""),
1315 OPTIONS_TABLE_HOOK("client-session-changed", ""),
1316 OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1317 OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1318 OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1319 OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1320 OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1321 OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1322 OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1323 OPTIONS_TABLE_HOOK("session-closed", ""),
1324 OPTIONS_TABLE_HOOK("session-created", ""),
1325 OPTIONS_TABLE_HOOK("session-renamed", ""),
1326 OPTIONS_TABLE_HOOK("session-window-changed", ""),
1327 OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1328 OPTIONS_TABLE_HOOK("window-linked", ""),
1329 OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1330 OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1331 OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
1332 OPTIONS_TABLE_HOOK("window-unlinked", ""),