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_detach_on_destroy_list
[] = {
89 "off", "on", "no-detached", NULL
91 static const char *options_table_extended_keys_list
[] = {
92 "off", "on", "always", NULL
94 static const char *options_table_allow_passthrough_list
[] = {
95 "off", "on", "all", NULL
98 /* Status line format. */
99 #define OPTIONS_TABLE_STATUS_FORMAT1 \
100 "#[align=left range=left #{E:status-left-style}]" \
102 "#{T;=/#{status-left-length}:status-left}" \
104 "#[norange default]" \
105 "#[list=on align=#{status-justify}]" \
106 "#[list=left-marker]<#[list=right-marker]>#[list=on]" \
108 "#[range=window|#{window_index} " \
109 "#{E:window-status-style}" \
110 "#{?#{&&:#{window_last_flag}," \
111 "#{!=:#{E:window-status-last-style},default}}, " \
112 "#{E:window-status-last-style}," \
114 "#{?#{&&:#{window_bell_flag}," \
115 "#{!=:#{E:window-status-bell-style},default}}, " \
116 "#{E:window-status-bell-style}," \
117 "#{?#{&&:#{||:#{window_activity_flag}," \
118 "#{window_silence_flag}}," \
120 "#{E:window-status-activity-style}," \
122 "#{E:window-status-activity-style}," \
127 "#{T:window-status-format}" \
129 "#[norange default]" \
130 "#{?window_end_flag,,#{window-status-separator}}" \
132 "#[range=window|#{window_index} list=focus " \
133 "#{?#{!=:#{E:window-status-current-style},default}," \
134 "#{E:window-status-current-style}," \
135 "#{E:window-status-style}" \
137 "#{?#{&&:#{window_last_flag}," \
138 "#{!=:#{E:window-status-last-style},default}}, " \
139 "#{E:window-status-last-style}," \
141 "#{?#{&&:#{window_bell_flag}," \
142 "#{!=:#{E:window-status-bell-style},default}}, " \
143 "#{E:window-status-bell-style}," \
144 "#{?#{&&:#{||:#{window_activity_flag}," \
145 "#{window_silence_flag}}," \
147 "#{E:window-status-activity-style}," \
149 "#{E:window-status-activity-style}," \
154 "#{T:window-status-current-format}" \
156 "#[norange list=on default]" \
157 "#{?window_end_flag,,#{window-status-separator}}" \
159 "#[nolist align=right range=right #{E:status-right-style}]" \
161 "#{T;=/#{status-right-length}:status-right}" \
164 #define OPTIONS_TABLE_STATUS_FORMAT2 \
165 "#[align=centre]#{P:#{?pane_active,#[reverse],}" \
166 "#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
167 static const char *options_table_status_format_default
[] = {
168 OPTIONS_TABLE_STATUS_FORMAT1
, OPTIONS_TABLE_STATUS_FORMAT2
, NULL
171 /* Helpers for hook options. */
172 #define OPTIONS_TABLE_HOOK(hook_name, default_value) \
173 { .name = hook_name, \
174 .type = OPTIONS_TABLE_COMMAND, \
175 .scope = OPTIONS_TABLE_SESSION, \
176 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
177 .default_str = default_value, \
181 #define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
182 { .name = hook_name, \
183 .type = OPTIONS_TABLE_COMMAND, \
184 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
185 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
186 .default_str = default_value, \
190 #define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
191 { .name = hook_name, \
192 .type = OPTIONS_TABLE_COMMAND, \
193 .scope = OPTIONS_TABLE_WINDOW, \
194 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
195 .default_str = default_value, \
199 /* Map of name conversions. */
200 const struct options_name_map options_other_names
[] = {
201 { "display-panes-color", "display-panes-colour" },
202 { "display-panes-active-color", "display-panes-active-colour" },
203 { "clock-mode-color", "clock-mode-colour" },
204 { "cursor-color", "cursor-colour" },
205 { "pane-colors", "pane-colours" },
209 /* Top-level options. */
210 const struct options_table_entry options_table
[] = {
211 /* Server options. */
212 { .name
= "backspace",
213 .type
= OPTIONS_TABLE_KEY
,
214 .scope
= OPTIONS_TABLE_SERVER
,
215 .default_num
= '\177',
216 .text
= "The key to send for backspace."
219 { .name
= "buffer-limit",
220 .type
= OPTIONS_TABLE_NUMBER
,
221 .scope
= OPTIONS_TABLE_SERVER
,
225 .text
= "The maximum number of automatic buffers. "
226 "When this is reached, the oldest buffer is deleted."
229 { .name
= "command-alias",
230 .type
= OPTIONS_TABLE_STRING
,
231 .scope
= OPTIONS_TABLE_SERVER
,
232 .flags
= OPTIONS_TABLE_IS_ARRAY
,
233 .default_str
= "split-pane=split-window,"
234 "splitp=split-window,"
235 "server-info=show-messages -JT,"
236 "info=show-messages -JT,"
237 "choose-window=choose-tree -w,"
238 "choose-session=choose-tree -s",
240 .text
= "Array of command aliases. "
241 "Each entry is an alias and a command separated by '='."
244 { .name
= "copy-command",
245 .type
= OPTIONS_TABLE_STRING
,
246 .scope
= OPTIONS_TABLE_SERVER
,
248 .text
= "Shell command run when text is copied. "
249 "If empty, no command is run."
252 { .name
= "cursor-colour",
253 .type
= OPTIONS_TABLE_COLOUR
,
254 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
256 .text
= "Colour of the cursor."
259 { .name
= "cursor-style",
260 .type
= OPTIONS_TABLE_CHOICE
,
261 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
262 .choices
= options_table_cursor_style_list
,
264 .text
= "Style of the cursor."
267 { .name
= "default-terminal",
268 .type
= OPTIONS_TABLE_STRING
,
269 .scope
= OPTIONS_TABLE_SERVER
,
270 .default_str
= TMUX_TERM
,
271 .text
= "Default for the 'TERM' environment variable."
275 .type
= OPTIONS_TABLE_STRING
,
276 .scope
= OPTIONS_TABLE_SERVER
,
277 .default_str
= _PATH_VI
,
278 .text
= "Editor run to edit files."
281 { .name
= "escape-time",
282 .type
= OPTIONS_TABLE_NUMBER
,
283 .scope
= OPTIONS_TABLE_SERVER
,
287 .unit
= "milliseconds",
288 .text
= "Time to wait before assuming a key is Escape."
291 { .name
= "exit-empty",
292 .type
= OPTIONS_TABLE_FLAG
,
293 .scope
= OPTIONS_TABLE_SERVER
,
295 .text
= "Whether the server should exit if there are no sessions."
298 { .name
= "exit-unattached",
299 .type
= OPTIONS_TABLE_FLAG
,
300 .scope
= OPTIONS_TABLE_SERVER
,
302 .text
= "Whether the server should exit if there are no attached "
306 { .name
= "extended-keys",
307 .type
= OPTIONS_TABLE_CHOICE
,
308 .scope
= OPTIONS_TABLE_SERVER
,
309 .choices
= options_table_extended_keys_list
,
311 .text
= "Whether to request extended key sequences from terminals "
315 { .name
= "focus-events",
316 .type
= OPTIONS_TABLE_FLAG
,
317 .scope
= OPTIONS_TABLE_SERVER
,
319 .text
= "Whether to send focus events to applications."
322 { .name
= "history-file",
323 .type
= OPTIONS_TABLE_STRING
,
324 .scope
= OPTIONS_TABLE_SERVER
,
326 .text
= "Location of the command prompt history file. "
327 "Empty does not write a history file."
330 { .name
= "message-limit",
331 .type
= OPTIONS_TABLE_NUMBER
,
332 .scope
= OPTIONS_TABLE_SERVER
,
336 .text
= "Maximum number of server messages to keep."
339 { .name
= "prompt-history-limit",
340 .type
= OPTIONS_TABLE_NUMBER
,
341 .scope
= OPTIONS_TABLE_SERVER
,
345 .text
= "Maximum number of commands to keep in history."
348 { .name
= "set-clipboard",
349 .type
= OPTIONS_TABLE_CHOICE
,
350 .scope
= OPTIONS_TABLE_SERVER
,
351 .choices
= options_table_set_clipboard_list
,
353 .text
= "Whether to attempt to set the system clipboard ('on' or "
354 "'external') and whether to allow applications to create "
355 "paste buffers with an escape sequence ('on' only)."
358 { .name
= "terminal-overrides",
359 .type
= OPTIONS_TABLE_STRING
,
360 .scope
= OPTIONS_TABLE_SERVER
,
361 .flags
= OPTIONS_TABLE_IS_ARRAY
,
364 .text
= "List of terminal capabilities overrides."
367 { .name
= "terminal-features",
368 .type
= OPTIONS_TABLE_STRING
,
369 .scope
= OPTIONS_TABLE_SERVER
,
370 .flags
= OPTIONS_TABLE_IS_ARRAY
,
371 .default_str
= "xterm*:clipboard:ccolour:cstyle:focus:title,"
375 .text
= "List of terminal features, used if they cannot be "
376 "automatically detected."
379 { .name
= "user-keys",
380 .type
= OPTIONS_TABLE_STRING
,
381 .scope
= OPTIONS_TABLE_SERVER
,
382 .flags
= OPTIONS_TABLE_IS_ARRAY
,
385 .text
= "User key assignments. "
386 "Each sequence in the list is translated into a key: "
387 "'User0', 'User1' and so on."
390 /* Session options. */
391 { .name
= "activity-action",
392 .type
= OPTIONS_TABLE_CHOICE
,
393 .scope
= OPTIONS_TABLE_SESSION
,
394 .choices
= options_table_bell_action_list
,
395 .default_num
= ALERT_OTHER
,
396 .text
= "Action to take on an activity alert."
399 { .name
= "assume-paste-time",
400 .type
= OPTIONS_TABLE_NUMBER
,
401 .scope
= OPTIONS_TABLE_SESSION
,
405 .unit
= "milliseconds",
406 .text
= "Maximum time between input to assume it is pasting rather "
410 { .name
= "base-index",
411 .type
= OPTIONS_TABLE_NUMBER
,
412 .scope
= OPTIONS_TABLE_SESSION
,
416 .text
= "Default index of the first window in each session."
419 { .name
= "bell-action",
420 .type
= OPTIONS_TABLE_CHOICE
,
421 .scope
= OPTIONS_TABLE_SESSION
,
422 .choices
= options_table_bell_action_list
,
423 .default_num
= ALERT_ANY
,
424 .text
= "Action to take on a bell alert."
427 { .name
= "default-command",
428 .type
= OPTIONS_TABLE_STRING
,
429 .scope
= OPTIONS_TABLE_SESSION
,
431 .text
= "Default command to run in new panes. If empty, a shell is "
435 { .name
= "default-shell",
436 .type
= OPTIONS_TABLE_STRING
,
437 .scope
= OPTIONS_TABLE_SESSION
,
438 .default_str
= _PATH_BSHELL
,
439 .text
= "Location of default shell."
442 { .name
= "default-size",
443 .type
= OPTIONS_TABLE_STRING
,
444 .scope
= OPTIONS_TABLE_SESSION
,
445 .pattern
= "[0-9]*x[0-9]*",
446 .default_str
= "80x24",
447 .text
= "Initial size of new sessions."
450 { .name
= "destroy-unattached",
451 .type
= OPTIONS_TABLE_FLAG
,
452 .scope
= OPTIONS_TABLE_SESSION
,
454 .text
= "Whether to destroy sessions when they have no attached "
458 { .name
= "detach-on-destroy",
459 .type
= OPTIONS_TABLE_CHOICE
,
460 .scope
= OPTIONS_TABLE_SESSION
,
461 .choices
= options_table_detach_on_destroy_list
,
463 .text
= "Whether to detach when a session is destroyed, or switch "
464 "the client to another session if any exist."
467 { .name
= "display-panes-active-colour",
468 .type
= OPTIONS_TABLE_COLOUR
,
469 .scope
= OPTIONS_TABLE_SESSION
,
471 .text
= "Colour of the active pane for 'display-panes'."
474 { .name
= "display-panes-colour",
475 .type
= OPTIONS_TABLE_COLOUR
,
476 .scope
= OPTIONS_TABLE_SESSION
,
478 .text
= "Colour of not active panes for 'display-panes'."
481 { .name
= "display-panes-time",
482 .type
= OPTIONS_TABLE_NUMBER
,
483 .scope
= OPTIONS_TABLE_SESSION
,
487 .unit
= "milliseconds",
488 .text
= "Time for which 'display-panes' should show pane numbers."
491 { .name
= "display-time",
492 .type
= OPTIONS_TABLE_NUMBER
,
493 .scope
= OPTIONS_TABLE_SESSION
,
497 .unit
= "milliseconds",
498 .text
= "Time for which status line messages should appear."
501 { .name
= "history-limit",
502 .type
= OPTIONS_TABLE_NUMBER
,
503 .scope
= OPTIONS_TABLE_SESSION
,
508 .text
= "Maximum number of lines to keep in the history for each "
510 "If changed, the new value applies only to new panes."
513 { .name
= "key-table",
514 .type
= OPTIONS_TABLE_STRING
,
515 .scope
= OPTIONS_TABLE_SESSION
,
516 .default_str
= "root",
517 .text
= "Default key table. "
518 "Key presses are first looked up in this table."
521 { .name
= "lock-after-time",
522 .type
= OPTIONS_TABLE_NUMBER
,
523 .scope
= OPTIONS_TABLE_SESSION
,
528 .text
= "Time after which a client is locked if not used."
531 { .name
= "lock-command",
532 .type
= OPTIONS_TABLE_STRING
,
533 .scope
= OPTIONS_TABLE_SESSION
,
534 .default_str
= "lock -np",
535 .text
= "Shell command to run to lock a client."
538 { .name
= "message-command-style",
539 .type
= OPTIONS_TABLE_STRING
,
540 .scope
= OPTIONS_TABLE_SESSION
,
541 .default_str
= "bg=black,fg=yellow",
542 .flags
= OPTIONS_TABLE_IS_STYLE
,
544 .text
= "Style of the command prompt when in command mode, if "
545 "'mode-keys' is set to 'vi'."
548 { .name
= "message-line",
549 .type
= OPTIONS_TABLE_CHOICE
,
550 .scope
= OPTIONS_TABLE_SESSION
,
551 .choices
= options_table_message_line_list
,
553 .text
= "Position (line) of messages and the command prompt."
556 { .name
= "message-style",
557 .type
= OPTIONS_TABLE_STRING
,
558 .scope
= OPTIONS_TABLE_SESSION
,
559 .default_str
= "bg=yellow,fg=black",
560 .flags
= OPTIONS_TABLE_IS_STYLE
,
562 .text
= "Style of messages and the command prompt."
566 .type
= OPTIONS_TABLE_FLAG
,
567 .scope
= OPTIONS_TABLE_SESSION
,
569 .text
= "Whether the mouse is recognised and mouse key bindings are "
571 "Applications inside panes can use the mouse even when 'off'."
575 .type
= OPTIONS_TABLE_KEY
,
576 .scope
= OPTIONS_TABLE_SESSION
,
577 .default_num
= '\002',
578 .text
= "The prefix key."
582 .type
= OPTIONS_TABLE_KEY
,
583 .scope
= OPTIONS_TABLE_SESSION
,
584 .default_num
= KEYC_NONE
,
585 .text
= "A second prefix key."
588 { .name
= "renumber-windows",
589 .type
= OPTIONS_TABLE_FLAG
,
590 .scope
= OPTIONS_TABLE_SESSION
,
592 .text
= "Whether windows are automatically renumbered rather than "
596 { .name
= "repeat-time",
597 .type
= OPTIONS_TABLE_NUMBER
,
598 .scope
= OPTIONS_TABLE_SESSION
,
602 .unit
= "milliseconds",
603 .text
= "Time to wait for a key binding to repeat, if it is bound "
604 "with the '-r' flag."
607 { .name
= "set-titles",
608 .type
= OPTIONS_TABLE_FLAG
,
609 .scope
= OPTIONS_TABLE_SESSION
,
611 .text
= "Whether to set the terminal title, if supported."
614 { .name
= "set-titles-string",
615 .type
= OPTIONS_TABLE_STRING
,
616 .scope
= OPTIONS_TABLE_SESSION
,
617 .default_str
= "#S:#I:#W - \"#T\" #{session_alerts}",
618 .text
= "Format of the terminal title to set."
621 { .name
= "silence-action",
622 .type
= OPTIONS_TABLE_CHOICE
,
623 .scope
= OPTIONS_TABLE_SESSION
,
624 .choices
= options_table_bell_action_list
,
625 .default_num
= ALERT_OTHER
,
626 .text
= "Action to take on a silence alert."
630 .type
= OPTIONS_TABLE_CHOICE
,
631 .scope
= OPTIONS_TABLE_SESSION
,
632 .choices
= options_table_status_list
,
634 .text
= "Number of lines in the status line."
637 { .name
= "status-bg",
638 .type
= OPTIONS_TABLE_COLOUR
,
639 .scope
= OPTIONS_TABLE_SESSION
,
641 .text
= "Background colour of the status line. This option is "
642 "deprecated, use 'status-style' instead."
645 { .name
= "status-fg",
646 .type
= OPTIONS_TABLE_COLOUR
,
647 .scope
= OPTIONS_TABLE_SESSION
,
649 .text
= "Foreground colour of the status line. This option is "
650 "deprecated, use 'status-style' instead."
653 { .name
= "status-format",
654 .type
= OPTIONS_TABLE_STRING
,
655 .scope
= OPTIONS_TABLE_SESSION
,
656 .flags
= OPTIONS_TABLE_IS_ARRAY
,
657 .default_arr
= options_table_status_format_default
,
658 .text
= "Formats for the status lines. "
659 "Each array member is the format for one status line. "
660 "The default status line is made up of several components "
661 "which may be configured individually with other options such "
665 { .name
= "status-interval",
666 .type
= OPTIONS_TABLE_NUMBER
,
667 .scope
= OPTIONS_TABLE_SESSION
,
672 .text
= "Number of seconds between status line updates."
675 { .name
= "status-justify",
676 .type
= OPTIONS_TABLE_CHOICE
,
677 .scope
= OPTIONS_TABLE_SESSION
,
678 .choices
= options_table_status_justify_list
,
680 .text
= "Position of the window list in the status line."
683 { .name
= "status-keys",
684 .type
= OPTIONS_TABLE_CHOICE
,
685 .scope
= OPTIONS_TABLE_SESSION
,
686 .choices
= options_table_status_keys_list
,
687 .default_num
= MODEKEY_EMACS
,
688 .text
= "Key set to use at the command prompt."
691 { .name
= "status-left",
692 .type
= OPTIONS_TABLE_STRING
,
693 .scope
= OPTIONS_TABLE_SESSION
,
694 .default_str
= "[#{session_name}] ",
695 .text
= "Contents of the left side of the status line."
698 { .name
= "status-left-length",
699 .type
= OPTIONS_TABLE_NUMBER
,
700 .scope
= OPTIONS_TABLE_SESSION
,
704 .text
= "Maximum width of the left side of the status line."
707 { .name
= "status-left-style",
708 .type
= OPTIONS_TABLE_STRING
,
709 .scope
= OPTIONS_TABLE_SESSION
,
710 .default_str
= "default",
711 .flags
= OPTIONS_TABLE_IS_STYLE
,
713 .text
= "Style of the left side of the status line."
716 { .name
= "status-position",
717 .type
= OPTIONS_TABLE_CHOICE
,
718 .scope
= OPTIONS_TABLE_SESSION
,
719 .choices
= options_table_status_position_list
,
721 .text
= "Position of the status line."
724 { .name
= "status-right",
725 .type
= OPTIONS_TABLE_STRING
,
726 .scope
= OPTIONS_TABLE_SESSION
,
727 .default_str
= "#{?window_bigger,"
728 "[#{window_offset_x}#,#{window_offset_y}] ,}"
729 "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
730 .text
= "Contents of the right side of the status line."
734 { .name
= "status-right-length",
735 .type
= OPTIONS_TABLE_NUMBER
,
736 .scope
= OPTIONS_TABLE_SESSION
,
740 .text
= "Maximum width of the right side of the status line."
743 { .name
= "status-right-style",
744 .type
= OPTIONS_TABLE_STRING
,
745 .scope
= OPTIONS_TABLE_SESSION
,
746 .default_str
= "default",
747 .flags
= OPTIONS_TABLE_IS_STYLE
,
749 .text
= "Style of the right side of the status line."
752 { .name
= "status-style",
753 .type
= OPTIONS_TABLE_STRING
,
754 .scope
= OPTIONS_TABLE_SESSION
,
755 .default_str
= "bg=green,fg=black",
756 .flags
= OPTIONS_TABLE_IS_STYLE
,
758 .text
= "Style of the status line."
761 { .name
= "update-environment",
762 .type
= OPTIONS_TABLE_STRING
,
763 .scope
= OPTIONS_TABLE_SESSION
,
764 .flags
= OPTIONS_TABLE_IS_ARRAY
,
765 .default_str
= "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
766 "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
767 .text
= "List of environment variables to update in the session "
768 "environment when a client is attached."
771 { .name
= "visual-activity",
772 .type
= OPTIONS_TABLE_CHOICE
,
773 .scope
= OPTIONS_TABLE_SESSION
,
774 .choices
= options_table_visual_bell_list
,
775 .default_num
= VISUAL_OFF
,
776 .text
= "How activity alerts should be shown: a message ('on'), "
777 "a message and a bell ('both') or nothing ('off')."
780 { .name
= "visual-bell",
781 .type
= OPTIONS_TABLE_CHOICE
,
782 .scope
= OPTIONS_TABLE_SESSION
,
783 .choices
= options_table_visual_bell_list
,
784 .default_num
= VISUAL_OFF
,
785 .text
= "How bell alerts should be shown: a message ('on'), "
786 "a message and a bell ('both') or nothing ('off')."
789 { .name
= "visual-silence",
790 .type
= OPTIONS_TABLE_CHOICE
,
791 .scope
= OPTIONS_TABLE_SESSION
,
792 .choices
= options_table_visual_bell_list
,
793 .default_num
= VISUAL_OFF
,
794 .text
= "How silence alerts should be shown: a message ('on'), "
795 "a message and a bell ('both') or nothing ('off')."
798 { .name
= "word-separators",
799 .type
= OPTIONS_TABLE_STRING
,
800 .scope
= OPTIONS_TABLE_SESSION
,
802 * The set of non-alphanumeric printable ASCII characters minus the
805 .default_str
= "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
806 .text
= "Characters considered to separate words."
809 /* Window options. */
810 { .name
= "aggressive-resize",
811 .type
= OPTIONS_TABLE_FLAG
,
812 .scope
= OPTIONS_TABLE_WINDOW
,
814 .text
= "When 'window-size' is 'smallest', whether the maximum size "
815 "of a window is the smallest attached session where it is "
816 "the current window ('on') or the smallest session it is "
820 { .name
= "allow-passthrough",
821 .type
= OPTIONS_TABLE_CHOICE
,
822 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
823 .choices
= options_table_allow_passthrough_list
,
825 .text
= "Whether applications are allowed to use the escape sequence "
826 "to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
827 "if the pane is visible), or 'all' (allowed even if the pane "
831 { .name
= "allow-rename",
832 .type
= OPTIONS_TABLE_FLAG
,
833 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
835 .text
= "Whether applications are allowed to use the escape sequence "
839 { .name
= "alternate-screen",
840 .type
= OPTIONS_TABLE_FLAG
,
841 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
843 .text
= "Whether applications are allowed to use the alternate "
847 { .name
= "automatic-rename",
848 .type
= OPTIONS_TABLE_FLAG
,
849 .scope
= OPTIONS_TABLE_WINDOW
,
851 .text
= "Whether windows are automatically renamed."
854 { .name
= "automatic-rename-format",
855 .type
= OPTIONS_TABLE_STRING
,
856 .scope
= OPTIONS_TABLE_WINDOW
,
857 .default_str
= "#{?pane_in_mode,[tmux],#{pane_current_command}}"
858 "#{?pane_dead,[dead],}",
859 .text
= "Format used to automatically rename windows."
862 { .name
= "clock-mode-colour",
863 .type
= OPTIONS_TABLE_COLOUR
,
864 .scope
= OPTIONS_TABLE_WINDOW
,
866 .text
= "Colour of the clock in clock mode."
869 { .name
= "clock-mode-style",
870 .type
= OPTIONS_TABLE_CHOICE
,
871 .scope
= OPTIONS_TABLE_WINDOW
,
872 .choices
= options_table_clock_mode_style_list
,
874 .text
= "Time format of the clock in clock mode."
877 { .name
= "copy-mode-match-style",
878 .type
= OPTIONS_TABLE_STRING
,
879 .scope
= OPTIONS_TABLE_WINDOW
,
880 .default_str
= "bg=cyan,fg=black",
881 .flags
= OPTIONS_TABLE_IS_STYLE
,
883 .text
= "Style of search matches in copy mode."
886 { .name
= "copy-mode-current-match-style",
887 .type
= OPTIONS_TABLE_STRING
,
888 .scope
= OPTIONS_TABLE_WINDOW
,
889 .default_str
= "bg=magenta,fg=black",
890 .flags
= OPTIONS_TABLE_IS_STYLE
,
892 .text
= "Style of the current search match in copy mode."
895 { .name
= "copy-mode-mark-style",
896 .type
= OPTIONS_TABLE_STRING
,
897 .scope
= OPTIONS_TABLE_WINDOW
,
898 .default_str
= "bg=red,fg=black",
899 .flags
= OPTIONS_TABLE_IS_STYLE
,
901 .text
= "Style of the marked line in copy mode."
904 { .name
= "fill-character",
905 .type
= OPTIONS_TABLE_STRING
,
906 .scope
= OPTIONS_TABLE_WINDOW
,
908 .text
= "Character used to fill unused parts of window."
911 { .name
= "main-pane-height",
912 .type
= OPTIONS_TABLE_STRING
,
913 .scope
= OPTIONS_TABLE_WINDOW
,
915 .text
= "Height of the main pane in the 'main-horizontal' layout. "
916 "This may be a percentage, for example '10%'."
919 { .name
= "main-pane-width",
920 .type
= OPTIONS_TABLE_STRING
,
921 .scope
= OPTIONS_TABLE_WINDOW
,
923 .text
= "Width of the main pane in the 'main-vertical' layout. "
924 "This may be a percentage, for example '10%'."
927 { .name
= "mode-keys",
928 .type
= OPTIONS_TABLE_CHOICE
,
929 .scope
= OPTIONS_TABLE_WINDOW
,
930 .choices
= options_table_mode_keys_list
,
931 .default_num
= MODEKEY_EMACS
,
932 .text
= "Key set used in copy mode."
935 { .name
= "mode-style",
936 .type
= OPTIONS_TABLE_STRING
,
937 .scope
= OPTIONS_TABLE_WINDOW
,
938 .default_str
= "bg=yellow,fg=black",
939 .flags
= OPTIONS_TABLE_IS_STYLE
,
941 .text
= "Style of indicators and highlighting in modes."
944 { .name
= "monitor-activity",
945 .type
= OPTIONS_TABLE_FLAG
,
946 .scope
= OPTIONS_TABLE_WINDOW
,
948 .text
= "Whether an alert is triggered by activity."
951 { .name
= "monitor-bell",
952 .type
= OPTIONS_TABLE_FLAG
,
953 .scope
= OPTIONS_TABLE_WINDOW
,
955 .text
= "Whether an alert is triggered by a bell."
958 { .name
= "monitor-silence",
959 .type
= OPTIONS_TABLE_NUMBER
,
960 .scope
= OPTIONS_TABLE_WINDOW
,
964 .text
= "Time after which an alert is triggered by silence. "
965 "Zero means no alert."
969 { .name
= "other-pane-height",
970 .type
= OPTIONS_TABLE_STRING
,
971 .scope
= OPTIONS_TABLE_WINDOW
,
973 .text
= "Height of the other panes in the 'main-horizontal' layout. "
974 "This may be a percentage, for example '10%'."
977 { .name
= "other-pane-width",
978 .type
= OPTIONS_TABLE_STRING
,
979 .scope
= OPTIONS_TABLE_WINDOW
,
981 .text
= "Height of the other panes in the 'main-vertical' layout. "
982 "This may be a percentage, for example '10%'."
985 { .name
= "pane-active-border-style",
986 .type
= OPTIONS_TABLE_STRING
,
987 .scope
= OPTIONS_TABLE_WINDOW
,
988 .default_str
= "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
989 .flags
= OPTIONS_TABLE_IS_STYLE
,
991 .text
= "Style of the active pane border."
994 { .name
= "pane-base-index",
995 .type
= OPTIONS_TABLE_NUMBER
,
996 .scope
= OPTIONS_TABLE_WINDOW
,
998 .maximum
= USHRT_MAX
,
1000 .text
= "Index of the first pane in each window."
1003 { .name
= "pane-border-format",
1004 .type
= OPTIONS_TABLE_STRING
,
1005 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1006 .default_str
= "#{?pane_active,#[reverse],}#{pane_index}#[default] "
1007 "\"#{pane_title}\"",
1008 .text
= "Format of text in the pane status lines."
1011 { .name
= "pane-border-indicators",
1012 .type
= OPTIONS_TABLE_CHOICE
,
1013 .scope
= OPTIONS_TABLE_WINDOW
,
1014 .choices
= options_table_pane_border_indicators_list
,
1015 .default_num
= PANE_BORDER_COLOUR
,
1016 .text
= "Whether to indicate the active pane by colouring border or "
1017 "displaying arrow markers."
1020 { .name
= "pane-border-lines",
1021 .type
= OPTIONS_TABLE_CHOICE
,
1022 .scope
= OPTIONS_TABLE_WINDOW
,
1023 .choices
= options_table_pane_border_lines_list
,
1024 .default_num
= PANE_LINES_SINGLE
,
1025 .text
= "Type of characters used to draw pane border lines. Some of "
1026 "these are only supported on terminals with UTF-8 support."
1029 { .name
= "pane-border-status",
1030 .type
= OPTIONS_TABLE_CHOICE
,
1031 .scope
= OPTIONS_TABLE_WINDOW
,
1032 .choices
= options_table_pane_status_list
,
1033 .default_num
= PANE_STATUS_OFF
,
1034 .text
= "Position of the pane status lines."
1037 { .name
= "pane-border-style",
1038 .type
= OPTIONS_TABLE_STRING
,
1039 .scope
= OPTIONS_TABLE_WINDOW
,
1040 .default_str
= "default",
1041 .flags
= OPTIONS_TABLE_IS_STYLE
,
1043 .text
= "Style of the pane status lines."
1046 { .name
= "pane-colours",
1047 .type
= OPTIONS_TABLE_COLOUR
,
1048 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1050 .flags
= OPTIONS_TABLE_IS_ARRAY
,
1051 .text
= "The default colour palette for colours zero to 255."
1054 { .name
= "popup-style",
1055 .type
= OPTIONS_TABLE_STRING
,
1056 .scope
= OPTIONS_TABLE_WINDOW
,
1057 .default_str
= "default",
1058 .flags
= OPTIONS_TABLE_IS_STYLE
,
1060 .text
= "Default style of popups."
1063 { .name
= "popup-border-style",
1064 .type
= OPTIONS_TABLE_STRING
,
1065 .scope
= OPTIONS_TABLE_WINDOW
,
1066 .default_str
= "default",
1067 .flags
= OPTIONS_TABLE_IS_STYLE
,
1069 .text
= "Default style of popup borders."
1072 { .name
= "popup-border-lines",
1073 .type
= OPTIONS_TABLE_CHOICE
,
1074 .scope
= OPTIONS_TABLE_WINDOW
,
1075 .choices
= options_table_popup_border_lines_list
,
1076 .default_num
= BOX_LINES_SINGLE
,
1077 .text
= "Type of characters used to draw popup border lines. Some of "
1078 "these are only supported on terminals with UTF-8 support."
1081 { .name
= "remain-on-exit",
1082 .type
= OPTIONS_TABLE_CHOICE
,
1083 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1084 .choices
= options_table_remain_on_exit_list
,
1086 .text
= "Whether panes should remain ('on') or be automatically "
1087 "killed ('off' or 'failed') when the program inside exits."
1090 { .name
= "remain-on-exit-format",
1091 .type
= OPTIONS_TABLE_STRING
,
1092 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1093 .default_str
= "Pane is dead ("
1094 "#{?#{!=:#{pane_dead_status},},"
1095 "status #{pane_dead_status},}"
1096 "#{?#{!=:#{pane_dead_signal},},"
1097 "signal #{pane_dead_signal},}, "
1098 "#{t:pane_dead_time})",
1099 .text
= "Message shown after the program in a pane has exited, if "
1100 "remain-on-exit is enabled."
1103 { .name
= "scroll-on-clear",
1104 .type
= OPTIONS_TABLE_FLAG
,
1105 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1107 .text
= "Whether the contents of the screen should be scrolled into"
1108 "history when clearing the whole screen."
1111 { .name
= "synchronize-panes",
1112 .type
= OPTIONS_TABLE_FLAG
,
1113 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1115 .text
= "Whether typing should be sent to all panes simultaneously."
1118 { .name
= "window-active-style",
1119 .type
= OPTIONS_TABLE_STRING
,
1120 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1121 .default_str
= "default",
1122 .flags
= OPTIONS_TABLE_IS_STYLE
,
1124 .text
= "Default style of the active pane."
1127 { .name
= "window-size",
1128 .type
= OPTIONS_TABLE_CHOICE
,
1129 .scope
= OPTIONS_TABLE_WINDOW
,
1130 .choices
= options_table_window_size_list
,
1131 .default_num
= WINDOW_SIZE_LATEST
,
1132 .text
= "How window size is calculated. "
1133 "'latest' uses the size of the most recently used client, "
1134 "'largest' the largest client, 'smallest' the smallest "
1135 "client and 'manual' a size set by the 'resize-window' "
1139 { .name
= "window-style",
1140 .type
= OPTIONS_TABLE_STRING
,
1141 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1142 .default_str
= "default",
1143 .flags
= OPTIONS_TABLE_IS_STYLE
,
1145 .text
= "Default style of panes that are not the active pane."
1148 { .name
= "window-status-activity-style",
1149 .type
= OPTIONS_TABLE_STRING
,
1150 .scope
= OPTIONS_TABLE_WINDOW
,
1151 .default_str
= "reverse",
1152 .flags
= OPTIONS_TABLE_IS_STYLE
,
1154 .text
= "Style of windows in the status line with an activity alert."
1157 { .name
= "window-status-bell-style",
1158 .type
= OPTIONS_TABLE_STRING
,
1159 .scope
= OPTIONS_TABLE_WINDOW
,
1160 .default_str
= "reverse",
1161 .flags
= OPTIONS_TABLE_IS_STYLE
,
1163 .text
= "Style of windows in the status line with a bell alert."
1166 { .name
= "window-status-current-format",
1167 .type
= OPTIONS_TABLE_STRING
,
1168 .scope
= OPTIONS_TABLE_WINDOW
,
1169 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1170 .text
= "Format of the current window in the status line."
1173 { .name
= "window-status-current-style",
1174 .type
= OPTIONS_TABLE_STRING
,
1175 .scope
= OPTIONS_TABLE_WINDOW
,
1176 .default_str
= "default",
1177 .flags
= OPTIONS_TABLE_IS_STYLE
,
1179 .text
= "Style of the current window in the status line."
1182 { .name
= "window-status-format",
1183 .type
= OPTIONS_TABLE_STRING
,
1184 .scope
= OPTIONS_TABLE_WINDOW
,
1185 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1186 .text
= "Format of windows in the status line, except the current "
1190 { .name
= "window-status-last-style",
1191 .type
= OPTIONS_TABLE_STRING
,
1192 .scope
= OPTIONS_TABLE_WINDOW
,
1193 .default_str
= "default",
1194 .flags
= OPTIONS_TABLE_IS_STYLE
,
1196 .text
= "Style of the last window in the status line."
1199 { .name
= "window-status-separator",
1200 .type
= OPTIONS_TABLE_STRING
,
1201 .scope
= OPTIONS_TABLE_WINDOW
,
1203 .text
= "Separator between windows in the status line."
1206 { .name
= "window-status-style",
1207 .type
= OPTIONS_TABLE_STRING
,
1208 .scope
= OPTIONS_TABLE_WINDOW
,
1209 .default_str
= "default",
1210 .flags
= OPTIONS_TABLE_IS_STYLE
,
1212 .text
= "Style of windows in the status line, except the current and "
1216 { .name
= "wrap-search",
1217 .type
= OPTIONS_TABLE_FLAG
,
1218 .scope
= OPTIONS_TABLE_WINDOW
,
1220 .text
= "Whether searching in copy mode should wrap at the top or "
1224 { .name
= "xterm-keys", /* no longer used */
1225 .type
= OPTIONS_TABLE_FLAG
,
1226 .scope
= OPTIONS_TABLE_WINDOW
,
1228 .text
= "Whether xterm-style function key sequences should be sent. "
1229 "This option is no longer used."
1233 OPTIONS_TABLE_HOOK("after-bind-key", ""),
1234 OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1235 OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1236 OPTIONS_TABLE_HOOK("after-display-message", ""),
1237 OPTIONS_TABLE_HOOK("after-display-panes", ""),
1238 OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1239 OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1240 OPTIONS_TABLE_HOOK("after-list-clients", ""),
1241 OPTIONS_TABLE_HOOK("after-list-keys", ""),
1242 OPTIONS_TABLE_HOOK("after-list-panes", ""),
1243 OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1244 OPTIONS_TABLE_HOOK("after-list-windows", ""),
1245 OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1246 OPTIONS_TABLE_HOOK("after-lock-server", ""),
1247 OPTIONS_TABLE_HOOK("after-new-session", ""),
1248 OPTIONS_TABLE_HOOK("after-new-window", ""),
1249 OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1250 OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1251 OPTIONS_TABLE_HOOK("after-queue", ""),
1252 OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1253 OPTIONS_TABLE_HOOK("after-rename-session", ""),
1254 OPTIONS_TABLE_HOOK("after-rename-window", ""),
1255 OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1256 OPTIONS_TABLE_HOOK("after-resize-window", ""),
1257 OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1258 OPTIONS_TABLE_HOOK("after-select-layout", ""),
1259 OPTIONS_TABLE_HOOK("after-select-pane", ""),
1260 OPTIONS_TABLE_HOOK("after-select-window", ""),
1261 OPTIONS_TABLE_HOOK("after-send-keys", ""),
1262 OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1263 OPTIONS_TABLE_HOOK("after-set-environment", ""),
1264 OPTIONS_TABLE_HOOK("after-set-hook", ""),
1265 OPTIONS_TABLE_HOOK("after-set-option", ""),
1266 OPTIONS_TABLE_HOOK("after-show-environment", ""),
1267 OPTIONS_TABLE_HOOK("after-show-messages", ""),
1268 OPTIONS_TABLE_HOOK("after-show-options", ""),
1269 OPTIONS_TABLE_HOOK("after-split-window", ""),
1270 OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1271 OPTIONS_TABLE_HOOK("alert-activity", ""),
1272 OPTIONS_TABLE_HOOK("alert-bell", ""),
1273 OPTIONS_TABLE_HOOK("alert-silence", ""),
1274 OPTIONS_TABLE_HOOK("client-active", ""),
1275 OPTIONS_TABLE_HOOK("client-attached", ""),
1276 OPTIONS_TABLE_HOOK("client-detached", ""),
1277 OPTIONS_TABLE_HOOK("client-focus-in", ""),
1278 OPTIONS_TABLE_HOOK("client-focus-out", ""),
1279 OPTIONS_TABLE_HOOK("client-resized", ""),
1280 OPTIONS_TABLE_HOOK("client-session-changed", ""),
1281 OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1282 OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1283 OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1284 OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1285 OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1286 OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1287 OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1288 OPTIONS_TABLE_HOOK("session-closed", ""),
1289 OPTIONS_TABLE_HOOK("session-created", ""),
1290 OPTIONS_TABLE_HOOK("session-renamed", ""),
1291 OPTIONS_TABLE_HOOK("session-window-changed", ""),
1292 OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1293 OPTIONS_TABLE_HOOK("window-linked", ""),
1294 OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1295 OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1296 OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
1297 OPTIONS_TABLE_HOOK("window-unlinked", ""),