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", 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-border-style",
339 .type
= OPTIONS_TABLE_STRING
,
340 .scope
= OPTIONS_TABLE_WINDOW
,
341 .default_str
= "default",
342 .flags
= OPTIONS_TABLE_IS_STYLE
,
344 .text
= "Default style of menu borders."
347 { .name
= "menu-border-lines",
348 .type
= OPTIONS_TABLE_CHOICE
,
349 .scope
= OPTIONS_TABLE_WINDOW
,
350 .choices
= options_table_popup_border_lines_list
,
351 .default_num
= BOX_LINES_SINGLE
,
352 .text
= "Type of characters used to draw menu border lines. Some of "
353 "these are only supported on terminals with UTF-8 support."
356 { .name
= "message-limit",
357 .type
= OPTIONS_TABLE_NUMBER
,
358 .scope
= OPTIONS_TABLE_SERVER
,
362 .text
= "Maximum number of server messages to keep."
365 { .name
= "prompt-history-limit",
366 .type
= OPTIONS_TABLE_NUMBER
,
367 .scope
= OPTIONS_TABLE_SERVER
,
371 .text
= "Maximum number of commands to keep in history."
374 { .name
= "set-clipboard",
375 .type
= OPTIONS_TABLE_CHOICE
,
376 .scope
= OPTIONS_TABLE_SERVER
,
377 .choices
= options_table_set_clipboard_list
,
379 .text
= "Whether to attempt to set the system clipboard ('on' or "
380 "'external') and whether to allow applications to create "
381 "paste buffers with an escape sequence ('on' only)."
384 { .name
= "terminal-overrides",
385 .type
= OPTIONS_TABLE_STRING
,
386 .scope
= OPTIONS_TABLE_SERVER
,
387 .flags
= OPTIONS_TABLE_IS_ARRAY
,
390 .text
= "List of terminal capabilities overrides."
393 { .name
= "terminal-features",
394 .type
= OPTIONS_TABLE_STRING
,
395 .scope
= OPTIONS_TABLE_SERVER
,
396 .flags
= OPTIONS_TABLE_IS_ARRAY
,
397 .default_str
= "xterm*:clipboard:ccolour:cstyle:focus:title,"
401 .text
= "List of terminal features, used if they cannot be "
402 "automatically detected."
405 { .name
= "user-keys",
406 .type
= OPTIONS_TABLE_STRING
,
407 .scope
= OPTIONS_TABLE_SERVER
,
408 .flags
= OPTIONS_TABLE_IS_ARRAY
,
411 .text
= "User key assignments. "
412 "Each sequence in the list is translated into a key: "
413 "'User0', 'User1' and so on."
416 /* Session options. */
417 { .name
= "activity-action",
418 .type
= OPTIONS_TABLE_CHOICE
,
419 .scope
= OPTIONS_TABLE_SESSION
,
420 .choices
= options_table_bell_action_list
,
421 .default_num
= ALERT_OTHER
,
422 .text
= "Action to take on an activity alert."
425 { .name
= "assume-paste-time",
426 .type
= OPTIONS_TABLE_NUMBER
,
427 .scope
= OPTIONS_TABLE_SESSION
,
431 .unit
= "milliseconds",
432 .text
= "Maximum time between input to assume it is pasting rather "
436 { .name
= "base-index",
437 .type
= OPTIONS_TABLE_NUMBER
,
438 .scope
= OPTIONS_TABLE_SESSION
,
442 .text
= "Default index of the first window in each session."
445 { .name
= "bell-action",
446 .type
= OPTIONS_TABLE_CHOICE
,
447 .scope
= OPTIONS_TABLE_SESSION
,
448 .choices
= options_table_bell_action_list
,
449 .default_num
= ALERT_ANY
,
450 .text
= "Action to take on a bell alert."
453 { .name
= "default-command",
454 .type
= OPTIONS_TABLE_STRING
,
455 .scope
= OPTIONS_TABLE_SESSION
,
457 .text
= "Default command to run in new panes. If empty, a shell is "
461 { .name
= "default-shell",
462 .type
= OPTIONS_TABLE_STRING
,
463 .scope
= OPTIONS_TABLE_SESSION
,
464 .default_str
= _PATH_BSHELL
,
465 .text
= "Location of default shell."
468 { .name
= "default-size",
469 .type
= OPTIONS_TABLE_STRING
,
470 .scope
= OPTIONS_TABLE_SESSION
,
471 .pattern
= "[0-9]*x[0-9]*",
472 .default_str
= "80x24",
473 .text
= "Initial size of new sessions."
476 { .name
= "destroy-unattached",
477 .type
= OPTIONS_TABLE_FLAG
,
478 .scope
= OPTIONS_TABLE_SESSION
,
480 .text
= "Whether to destroy sessions when they have no attached "
484 { .name
= "detach-on-destroy",
485 .type
= OPTIONS_TABLE_CHOICE
,
486 .scope
= OPTIONS_TABLE_SESSION
,
487 .choices
= options_table_detach_on_destroy_list
,
489 .text
= "Whether to detach when a session is destroyed, or switch "
490 "the client to another session if any exist."
493 { .name
= "display-panes-active-colour",
494 .type
= OPTIONS_TABLE_COLOUR
,
495 .scope
= OPTIONS_TABLE_SESSION
,
497 .text
= "Colour of the active pane for 'display-panes'."
500 { .name
= "display-panes-colour",
501 .type
= OPTIONS_TABLE_COLOUR
,
502 .scope
= OPTIONS_TABLE_SESSION
,
504 .text
= "Colour of not active panes for 'display-panes'."
507 { .name
= "display-panes-time",
508 .type
= OPTIONS_TABLE_NUMBER
,
509 .scope
= OPTIONS_TABLE_SESSION
,
513 .unit
= "milliseconds",
514 .text
= "Time for which 'display-panes' should show pane numbers."
517 { .name
= "display-time",
518 .type
= OPTIONS_TABLE_NUMBER
,
519 .scope
= OPTIONS_TABLE_SESSION
,
523 .unit
= "milliseconds",
524 .text
= "Time for which status line messages should appear."
527 { .name
= "history-limit",
528 .type
= OPTIONS_TABLE_NUMBER
,
529 .scope
= OPTIONS_TABLE_SESSION
,
534 .text
= "Maximum number of lines to keep in the history for each "
536 "If changed, the new value applies only to new panes."
539 { .name
= "key-table",
540 .type
= OPTIONS_TABLE_STRING
,
541 .scope
= OPTIONS_TABLE_SESSION
,
542 .default_str
= "root",
543 .text
= "Default key table. "
544 "Key presses are first looked up in this table."
547 { .name
= "lock-after-time",
548 .type
= OPTIONS_TABLE_NUMBER
,
549 .scope
= OPTIONS_TABLE_SESSION
,
554 .text
= "Time after which a client is locked if not used."
557 { .name
= "lock-command",
558 .type
= OPTIONS_TABLE_STRING
,
559 .scope
= OPTIONS_TABLE_SESSION
,
560 .default_str
= TMUX_LOCK_CMD
,
561 .text
= "Shell command to run to lock a client."
564 { .name
= "message-command-style",
565 .type
= OPTIONS_TABLE_STRING
,
566 .scope
= OPTIONS_TABLE_SESSION
,
567 .default_str
= "bg=black,fg=yellow",
568 .flags
= OPTIONS_TABLE_IS_STYLE
,
570 .text
= "Style of the command prompt when in command mode, if "
571 "'mode-keys' is set to 'vi'."
574 { .name
= "message-line",
575 .type
= OPTIONS_TABLE_CHOICE
,
576 .scope
= OPTIONS_TABLE_SESSION
,
577 .choices
= options_table_message_line_list
,
579 .text
= "Position (line) of messages and the command prompt."
582 { .name
= "message-style",
583 .type
= OPTIONS_TABLE_STRING
,
584 .scope
= OPTIONS_TABLE_SESSION
,
585 .default_str
= "bg=yellow,fg=black",
586 .flags
= OPTIONS_TABLE_IS_STYLE
,
588 .text
= "Style of messages and the command prompt."
592 .type
= OPTIONS_TABLE_FLAG
,
593 .scope
= OPTIONS_TABLE_SESSION
,
595 .text
= "Whether the mouse is recognised and mouse key bindings are "
597 "Applications inside panes can use the mouse even when 'off'."
601 .type
= OPTIONS_TABLE_KEY
,
602 .scope
= OPTIONS_TABLE_SESSION
,
603 .default_num
= '\002',
604 .text
= "The prefix key."
608 .type
= OPTIONS_TABLE_KEY
,
609 .scope
= OPTIONS_TABLE_SESSION
,
610 .default_num
= KEYC_NONE
,
611 .text
= "A second prefix key."
614 { .name
= "renumber-windows",
615 .type
= OPTIONS_TABLE_FLAG
,
616 .scope
= OPTIONS_TABLE_SESSION
,
618 .text
= "Whether windows are automatically renumbered rather than "
622 { .name
= "repeat-time",
623 .type
= OPTIONS_TABLE_NUMBER
,
624 .scope
= OPTIONS_TABLE_SESSION
,
628 .unit
= "milliseconds",
629 .text
= "Time to wait for a key binding to repeat, if it is bound "
630 "with the '-r' flag."
633 { .name
= "set-titles",
634 .type
= OPTIONS_TABLE_FLAG
,
635 .scope
= OPTIONS_TABLE_SESSION
,
637 .text
= "Whether to set the terminal title, if supported."
640 { .name
= "set-titles-string",
641 .type
= OPTIONS_TABLE_STRING
,
642 .scope
= OPTIONS_TABLE_SESSION
,
643 .default_str
= "#S:#I:#W - \"#T\" #{session_alerts}",
644 .text
= "Format of the terminal title to set."
647 { .name
= "silence-action",
648 .type
= OPTIONS_TABLE_CHOICE
,
649 .scope
= OPTIONS_TABLE_SESSION
,
650 .choices
= options_table_bell_action_list
,
651 .default_num
= ALERT_OTHER
,
652 .text
= "Action to take on a silence alert."
656 .type
= OPTIONS_TABLE_CHOICE
,
657 .scope
= OPTIONS_TABLE_SESSION
,
658 .choices
= options_table_status_list
,
660 .text
= "Number of lines in the status line."
663 { .name
= "status-bg",
664 .type
= OPTIONS_TABLE_COLOUR
,
665 .scope
= OPTIONS_TABLE_SESSION
,
667 .text
= "Background colour of the status line. This option is "
668 "deprecated, use 'status-style' instead."
671 { .name
= "status-fg",
672 .type
= OPTIONS_TABLE_COLOUR
,
673 .scope
= OPTIONS_TABLE_SESSION
,
675 .text
= "Foreground colour of the status line. This option is "
676 "deprecated, use 'status-style' instead."
679 { .name
= "status-format",
680 .type
= OPTIONS_TABLE_STRING
,
681 .scope
= OPTIONS_TABLE_SESSION
,
682 .flags
= OPTIONS_TABLE_IS_ARRAY
,
683 .default_arr
= options_table_status_format_default
,
684 .text
= "Formats for the status lines. "
685 "Each array member is the format for one status line. "
686 "The default status line is made up of several components "
687 "which may be configured individually with other options such "
691 { .name
= "status-interval",
692 .type
= OPTIONS_TABLE_NUMBER
,
693 .scope
= OPTIONS_TABLE_SESSION
,
698 .text
= "Number of seconds between status line updates."
701 { .name
= "status-justify",
702 .type
= OPTIONS_TABLE_CHOICE
,
703 .scope
= OPTIONS_TABLE_SESSION
,
704 .choices
= options_table_status_justify_list
,
706 .text
= "Position of the window list in the status line."
709 { .name
= "status-keys",
710 .type
= OPTIONS_TABLE_CHOICE
,
711 .scope
= OPTIONS_TABLE_SESSION
,
712 .choices
= options_table_status_keys_list
,
713 .default_num
= MODEKEY_EMACS
,
714 .text
= "Key set to use at the command prompt."
717 { .name
= "status-left",
718 .type
= OPTIONS_TABLE_STRING
,
719 .scope
= OPTIONS_TABLE_SESSION
,
720 .default_str
= "[#{session_name}] ",
721 .text
= "Contents of the left side of the status line."
724 { .name
= "status-left-length",
725 .type
= OPTIONS_TABLE_NUMBER
,
726 .scope
= OPTIONS_TABLE_SESSION
,
730 .text
= "Maximum width of the left side of the status line."
733 { .name
= "status-left-style",
734 .type
= OPTIONS_TABLE_STRING
,
735 .scope
= OPTIONS_TABLE_SESSION
,
736 .default_str
= "default",
737 .flags
= OPTIONS_TABLE_IS_STYLE
,
739 .text
= "Style of the left side of the status line."
742 { .name
= "status-position",
743 .type
= OPTIONS_TABLE_CHOICE
,
744 .scope
= OPTIONS_TABLE_SESSION
,
745 .choices
= options_table_status_position_list
,
747 .text
= "Position of the status line."
750 { .name
= "status-right",
751 .type
= OPTIONS_TABLE_STRING
,
752 .scope
= OPTIONS_TABLE_SESSION
,
753 .default_str
= "#{?window_bigger,"
754 "[#{window_offset_x}#,#{window_offset_y}] ,}"
755 "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
756 .text
= "Contents of the right side of the status line."
760 { .name
= "status-right-length",
761 .type
= OPTIONS_TABLE_NUMBER
,
762 .scope
= OPTIONS_TABLE_SESSION
,
766 .text
= "Maximum width of the right side of the status line."
769 { .name
= "status-right-style",
770 .type
= OPTIONS_TABLE_STRING
,
771 .scope
= OPTIONS_TABLE_SESSION
,
772 .default_str
= "default",
773 .flags
= OPTIONS_TABLE_IS_STYLE
,
775 .text
= "Style of the right side of the status line."
778 { .name
= "status-style",
779 .type
= OPTIONS_TABLE_STRING
,
780 .scope
= OPTIONS_TABLE_SESSION
,
781 .default_str
= "bg=green,fg=black",
782 .flags
= OPTIONS_TABLE_IS_STYLE
,
784 .text
= "Style of the status line."
787 { .name
= "update-environment",
788 .type
= OPTIONS_TABLE_STRING
,
789 .scope
= OPTIONS_TABLE_SESSION
,
790 .flags
= OPTIONS_TABLE_IS_ARRAY
,
791 .default_str
= "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
792 "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
793 .text
= "List of environment variables to update in the session "
794 "environment when a client is attached."
797 { .name
= "visual-activity",
798 .type
= OPTIONS_TABLE_CHOICE
,
799 .scope
= OPTIONS_TABLE_SESSION
,
800 .choices
= options_table_visual_bell_list
,
801 .default_num
= VISUAL_OFF
,
802 .text
= "How activity alerts should be shown: a message ('on'), "
803 "a message and a bell ('both') or nothing ('off')."
806 { .name
= "visual-bell",
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 bell alerts should be shown: a message ('on'), "
812 "a message and a bell ('both') or nothing ('off')."
815 { .name
= "visual-silence",
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 silence alerts should be shown: a message ('on'), "
821 "a message and a bell ('both') or nothing ('off')."
824 { .name
= "word-separators",
825 .type
= OPTIONS_TABLE_STRING
,
826 .scope
= OPTIONS_TABLE_SESSION
,
828 * The set of non-alphanumeric printable ASCII characters minus the
831 .default_str
= "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
832 .text
= "Characters considered to separate words."
835 /* Window options. */
836 { .name
= "aggressive-resize",
837 .type
= OPTIONS_TABLE_FLAG
,
838 .scope
= OPTIONS_TABLE_WINDOW
,
840 .text
= "When 'window-size' is 'smallest', whether the maximum size "
841 "of a window is the smallest attached session where it is "
842 "the current window ('on') or the smallest session it is "
846 { .name
= "allow-passthrough",
847 .type
= OPTIONS_TABLE_CHOICE
,
848 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
849 .choices
= options_table_allow_passthrough_list
,
851 .text
= "Whether applications are allowed to use the escape sequence "
852 "to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
853 "if the pane is visible), or 'all' (allowed even if the pane "
857 { .name
= "allow-rename",
858 .type
= OPTIONS_TABLE_FLAG
,
859 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
861 .text
= "Whether applications are allowed to use the escape sequence "
865 { .name
= "alternate-screen",
866 .type
= OPTIONS_TABLE_FLAG
,
867 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
869 .text
= "Whether applications are allowed to use the alternate "
873 { .name
= "automatic-rename",
874 .type
= OPTIONS_TABLE_FLAG
,
875 .scope
= OPTIONS_TABLE_WINDOW
,
877 .text
= "Whether windows are automatically renamed."
880 { .name
= "automatic-rename-format",
881 .type
= OPTIONS_TABLE_STRING
,
882 .scope
= OPTIONS_TABLE_WINDOW
,
883 .default_str
= "#{?pane_in_mode,[tmux],#{pane_current_command}}"
884 "#{?pane_dead,[dead],}",
885 .text
= "Format used to automatically rename windows."
888 { .name
= "clock-mode-colour",
889 .type
= OPTIONS_TABLE_COLOUR
,
890 .scope
= OPTIONS_TABLE_WINDOW
,
892 .text
= "Colour of the clock in clock mode."
895 { .name
= "clock-mode-style",
896 .type
= OPTIONS_TABLE_CHOICE
,
897 .scope
= OPTIONS_TABLE_WINDOW
,
898 .choices
= options_table_clock_mode_style_list
,
900 .text
= "Time format of the clock in clock mode."
903 { .name
= "copy-mode-match-style",
904 .type
= OPTIONS_TABLE_STRING
,
905 .scope
= OPTIONS_TABLE_WINDOW
,
906 .default_str
= "bg=cyan,fg=black",
907 .flags
= OPTIONS_TABLE_IS_STYLE
,
909 .text
= "Style of search matches in copy mode."
912 { .name
= "copy-mode-current-match-style",
913 .type
= OPTIONS_TABLE_STRING
,
914 .scope
= OPTIONS_TABLE_WINDOW
,
915 .default_str
= "bg=magenta,fg=black",
916 .flags
= OPTIONS_TABLE_IS_STYLE
,
918 .text
= "Style of the current search match in copy mode."
921 { .name
= "copy-mode-mark-style",
922 .type
= OPTIONS_TABLE_STRING
,
923 .scope
= OPTIONS_TABLE_WINDOW
,
924 .default_str
= "bg=red,fg=black",
925 .flags
= OPTIONS_TABLE_IS_STYLE
,
927 .text
= "Style of the marked line in copy mode."
930 { .name
= "fill-character",
931 .type
= OPTIONS_TABLE_STRING
,
932 .scope
= OPTIONS_TABLE_WINDOW
,
934 .text
= "Character used to fill unused parts of window."
937 { .name
= "main-pane-height",
938 .type
= OPTIONS_TABLE_STRING
,
939 .scope
= OPTIONS_TABLE_WINDOW
,
941 .text
= "Height of the main pane in the 'main-horizontal' layout. "
942 "This may be a percentage, for example '10%'."
945 { .name
= "main-pane-width",
946 .type
= OPTIONS_TABLE_STRING
,
947 .scope
= OPTIONS_TABLE_WINDOW
,
949 .text
= "Width of the main pane in the 'main-vertical' layout. "
950 "This may be a percentage, for example '10%'."
953 { .name
= "mode-keys",
954 .type
= OPTIONS_TABLE_CHOICE
,
955 .scope
= OPTIONS_TABLE_WINDOW
,
956 .choices
= options_table_mode_keys_list
,
957 .default_num
= MODEKEY_EMACS
,
958 .text
= "Key set used in copy mode."
961 { .name
= "mode-style",
962 .type
= OPTIONS_TABLE_STRING
,
963 .scope
= OPTIONS_TABLE_WINDOW
,
964 .default_str
= "bg=yellow,fg=black",
965 .flags
= OPTIONS_TABLE_IS_STYLE
,
967 .text
= "Style of indicators and highlighting in modes."
970 { .name
= "monitor-activity",
971 .type
= OPTIONS_TABLE_FLAG
,
972 .scope
= OPTIONS_TABLE_WINDOW
,
974 .text
= "Whether an alert is triggered by activity."
977 { .name
= "monitor-bell",
978 .type
= OPTIONS_TABLE_FLAG
,
979 .scope
= OPTIONS_TABLE_WINDOW
,
981 .text
= "Whether an alert is triggered by a bell."
984 { .name
= "monitor-silence",
985 .type
= OPTIONS_TABLE_NUMBER
,
986 .scope
= OPTIONS_TABLE_WINDOW
,
990 .text
= "Time after which an alert is triggered by silence. "
991 "Zero means no alert."
995 { .name
= "other-pane-height",
996 .type
= OPTIONS_TABLE_STRING
,
997 .scope
= OPTIONS_TABLE_WINDOW
,
999 .text
= "Height of the other panes in the 'main-horizontal' layout. "
1000 "This may be a percentage, for example '10%'."
1003 { .name
= "other-pane-width",
1004 .type
= OPTIONS_TABLE_STRING
,
1005 .scope
= OPTIONS_TABLE_WINDOW
,
1007 .text
= "Height of the other panes in the 'main-vertical' layout. "
1008 "This may be a percentage, for example '10%'."
1011 { .name
= "pane-active-border-style",
1012 .type
= OPTIONS_TABLE_STRING
,
1013 .scope
= OPTIONS_TABLE_WINDOW
,
1014 .default_str
= "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
1015 .flags
= OPTIONS_TABLE_IS_STYLE
,
1017 .text
= "Style of the active pane border."
1020 { .name
= "pane-base-index",
1021 .type
= OPTIONS_TABLE_NUMBER
,
1022 .scope
= OPTIONS_TABLE_WINDOW
,
1024 .maximum
= USHRT_MAX
,
1026 .text
= "Index of the first pane in each window."
1029 { .name
= "pane-border-format",
1030 .type
= OPTIONS_TABLE_STRING
,
1031 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1032 .default_str
= "#{?pane_active,#[reverse],}#{pane_index}#[default] "
1033 "\"#{pane_title}\"",
1034 .text
= "Format of text in the pane status lines."
1037 { .name
= "pane-border-indicators",
1038 .type
= OPTIONS_TABLE_CHOICE
,
1039 .scope
= OPTIONS_TABLE_WINDOW
,
1040 .choices
= options_table_pane_border_indicators_list
,
1041 .default_num
= PANE_BORDER_COLOUR
,
1042 .text
= "Whether to indicate the active pane by colouring border or "
1043 "displaying arrow markers."
1046 { .name
= "pane-border-lines",
1047 .type
= OPTIONS_TABLE_CHOICE
,
1048 .scope
= OPTIONS_TABLE_WINDOW
,
1049 .choices
= options_table_pane_border_lines_list
,
1050 .default_num
= PANE_LINES_SINGLE
,
1051 .text
= "Type of characters used to draw pane border lines. Some of "
1052 "these are only supported on terminals with UTF-8 support."
1055 { .name
= "pane-border-status",
1056 .type
= OPTIONS_TABLE_CHOICE
,
1057 .scope
= OPTIONS_TABLE_WINDOW
,
1058 .choices
= options_table_pane_status_list
,
1059 .default_num
= PANE_STATUS_OFF
,
1060 .text
= "Position of the pane status lines."
1063 { .name
= "pane-border-style",
1064 .type
= OPTIONS_TABLE_STRING
,
1065 .scope
= OPTIONS_TABLE_WINDOW
,
1066 .default_str
= "default",
1067 .flags
= OPTIONS_TABLE_IS_STYLE
,
1069 .text
= "Style of the pane status lines."
1072 { .name
= "pane-colours",
1073 .type
= OPTIONS_TABLE_COLOUR
,
1074 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1076 .flags
= OPTIONS_TABLE_IS_ARRAY
,
1077 .text
= "The default colour palette for colours zero to 255."
1080 { .name
= "popup-style",
1081 .type
= OPTIONS_TABLE_STRING
,
1082 .scope
= OPTIONS_TABLE_WINDOW
,
1083 .default_str
= "default",
1084 .flags
= OPTIONS_TABLE_IS_STYLE
,
1086 .text
= "Default style of popups."
1089 { .name
= "popup-border-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 popup borders."
1098 { .name
= "popup-border-lines",
1099 .type
= OPTIONS_TABLE_CHOICE
,
1100 .scope
= OPTIONS_TABLE_WINDOW
,
1101 .choices
= options_table_popup_border_lines_list
,
1102 .default_num
= BOX_LINES_SINGLE
,
1103 .text
= "Type of characters used to draw popup border lines. Some of "
1104 "these are only supported on terminals with UTF-8 support."
1107 { .name
= "remain-on-exit",
1108 .type
= OPTIONS_TABLE_CHOICE
,
1109 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1110 .choices
= options_table_remain_on_exit_list
,
1112 .text
= "Whether panes should remain ('on') or be automatically "
1113 "killed ('off' or 'failed') when the program inside exits."
1116 { .name
= "remain-on-exit-format",
1117 .type
= OPTIONS_TABLE_STRING
,
1118 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1119 .default_str
= "Pane is dead ("
1120 "#{?#{!=:#{pane_dead_status},},"
1121 "status #{pane_dead_status},}"
1122 "#{?#{!=:#{pane_dead_signal},},"
1123 "signal #{pane_dead_signal},}, "
1124 "#{t:pane_dead_time})",
1125 .text
= "Message shown after the program in a pane has exited, if "
1126 "remain-on-exit is enabled."
1129 { .name
= "scroll-on-clear",
1130 .type
= OPTIONS_TABLE_FLAG
,
1131 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1133 .text
= "Whether the contents of the screen should be scrolled into"
1134 "history when clearing the whole screen."
1137 { .name
= "synchronize-panes",
1138 .type
= OPTIONS_TABLE_FLAG
,
1139 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1141 .text
= "Whether typing should be sent to all panes simultaneously."
1144 { .name
= "window-active-style",
1145 .type
= OPTIONS_TABLE_STRING
,
1146 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1147 .default_str
= "default",
1148 .flags
= OPTIONS_TABLE_IS_STYLE
,
1150 .text
= "Default style of the active pane."
1153 { .name
= "window-size",
1154 .type
= OPTIONS_TABLE_CHOICE
,
1155 .scope
= OPTIONS_TABLE_WINDOW
,
1156 .choices
= options_table_window_size_list
,
1157 .default_num
= WINDOW_SIZE_LATEST
,
1158 .text
= "How window size is calculated. "
1159 "'latest' uses the size of the most recently used client, "
1160 "'largest' the largest client, 'smallest' the smallest "
1161 "client and 'manual' a size set by the 'resize-window' "
1165 { .name
= "window-style",
1166 .type
= OPTIONS_TABLE_STRING
,
1167 .scope
= OPTIONS_TABLE_WINDOW
|OPTIONS_TABLE_PANE
,
1168 .default_str
= "default",
1169 .flags
= OPTIONS_TABLE_IS_STYLE
,
1171 .text
= "Default style of panes that are not the active pane."
1174 { .name
= "window-status-activity-style",
1175 .type
= OPTIONS_TABLE_STRING
,
1176 .scope
= OPTIONS_TABLE_WINDOW
,
1177 .default_str
= "reverse",
1178 .flags
= OPTIONS_TABLE_IS_STYLE
,
1180 .text
= "Style of windows in the status line with an activity alert."
1183 { .name
= "window-status-bell-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 a bell alert."
1192 { .name
= "window-status-current-format",
1193 .type
= OPTIONS_TABLE_STRING
,
1194 .scope
= OPTIONS_TABLE_WINDOW
,
1195 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1196 .text
= "Format of the current window in the status line."
1199 { .name
= "window-status-current-style",
1200 .type
= OPTIONS_TABLE_STRING
,
1201 .scope
= OPTIONS_TABLE_WINDOW
,
1202 .default_str
= "default",
1203 .flags
= OPTIONS_TABLE_IS_STYLE
,
1205 .text
= "Style of the current window in the status line."
1208 { .name
= "window-status-format",
1209 .type
= OPTIONS_TABLE_STRING
,
1210 .scope
= OPTIONS_TABLE_WINDOW
,
1211 .default_str
= "#I:#W#{?window_flags,#{window_flags}, }",
1212 .text
= "Format of windows in the status line, except the current "
1216 { .name
= "window-status-last-style",
1217 .type
= OPTIONS_TABLE_STRING
,
1218 .scope
= OPTIONS_TABLE_WINDOW
,
1219 .default_str
= "default",
1220 .flags
= OPTIONS_TABLE_IS_STYLE
,
1222 .text
= "Style of the last window in the status line."
1225 { .name
= "window-status-separator",
1226 .type
= OPTIONS_TABLE_STRING
,
1227 .scope
= OPTIONS_TABLE_WINDOW
,
1229 .text
= "Separator between windows in the status line."
1232 { .name
= "window-status-style",
1233 .type
= OPTIONS_TABLE_STRING
,
1234 .scope
= OPTIONS_TABLE_WINDOW
,
1235 .default_str
= "default",
1236 .flags
= OPTIONS_TABLE_IS_STYLE
,
1238 .text
= "Style of windows in the status line, except the current and "
1242 { .name
= "wrap-search",
1243 .type
= OPTIONS_TABLE_FLAG
,
1244 .scope
= OPTIONS_TABLE_WINDOW
,
1246 .text
= "Whether searching in copy mode should wrap at the top or "
1250 { .name
= "xterm-keys", /* no longer used */
1251 .type
= OPTIONS_TABLE_FLAG
,
1252 .scope
= OPTIONS_TABLE_WINDOW
,
1254 .text
= "Whether xterm-style function key sequences should be sent. "
1255 "This option is no longer used."
1259 OPTIONS_TABLE_HOOK("after-bind-key", ""),
1260 OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1261 OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1262 OPTIONS_TABLE_HOOK("after-display-message", ""),
1263 OPTIONS_TABLE_HOOK("after-display-panes", ""),
1264 OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1265 OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1266 OPTIONS_TABLE_HOOK("after-list-clients", ""),
1267 OPTIONS_TABLE_HOOK("after-list-keys", ""),
1268 OPTIONS_TABLE_HOOK("after-list-panes", ""),
1269 OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1270 OPTIONS_TABLE_HOOK("after-list-windows", ""),
1271 OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1272 OPTIONS_TABLE_HOOK("after-lock-server", ""),
1273 OPTIONS_TABLE_HOOK("after-new-session", ""),
1274 OPTIONS_TABLE_HOOK("after-new-window", ""),
1275 OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1276 OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1277 OPTIONS_TABLE_HOOK("after-queue", ""),
1278 OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1279 OPTIONS_TABLE_HOOK("after-rename-session", ""),
1280 OPTIONS_TABLE_HOOK("after-rename-window", ""),
1281 OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1282 OPTIONS_TABLE_HOOK("after-resize-window", ""),
1283 OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1284 OPTIONS_TABLE_HOOK("after-select-layout", ""),
1285 OPTIONS_TABLE_HOOK("after-select-pane", ""),
1286 OPTIONS_TABLE_HOOK("after-select-window", ""),
1287 OPTIONS_TABLE_HOOK("after-send-keys", ""),
1288 OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1289 OPTIONS_TABLE_HOOK("after-set-environment", ""),
1290 OPTIONS_TABLE_HOOK("after-set-hook", ""),
1291 OPTIONS_TABLE_HOOK("after-set-option", ""),
1292 OPTIONS_TABLE_HOOK("after-show-environment", ""),
1293 OPTIONS_TABLE_HOOK("after-show-messages", ""),
1294 OPTIONS_TABLE_HOOK("after-show-options", ""),
1295 OPTIONS_TABLE_HOOK("after-split-window", ""),
1296 OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1297 OPTIONS_TABLE_HOOK("alert-activity", ""),
1298 OPTIONS_TABLE_HOOK("alert-bell", ""),
1299 OPTIONS_TABLE_HOOK("alert-silence", ""),
1300 OPTIONS_TABLE_HOOK("client-active", ""),
1301 OPTIONS_TABLE_HOOK("client-attached", ""),
1302 OPTIONS_TABLE_HOOK("client-detached", ""),
1303 OPTIONS_TABLE_HOOK("client-focus-in", ""),
1304 OPTIONS_TABLE_HOOK("client-focus-out", ""),
1305 OPTIONS_TABLE_HOOK("client-resized", ""),
1306 OPTIONS_TABLE_HOOK("client-session-changed", ""),
1307 OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1308 OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1309 OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1310 OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1311 OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1312 OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1313 OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1314 OPTIONS_TABLE_HOOK("session-closed", ""),
1315 OPTIONS_TABLE_HOOK("session-created", ""),
1316 OPTIONS_TABLE_HOOK("session-renamed", ""),
1317 OPTIONS_TABLE_HOOK("session-window-changed", ""),
1318 OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1319 OPTIONS_TABLE_HOOK("window-linked", ""),
1320 OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1321 OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1322 OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
1323 OPTIONS_TABLE_HOOK("window-unlinked", ""),