Make send-keys without any arguments send the key it is bound to (if
[tmux-openbsd.git] / options-table.c
blob607a90b6300a3016cfed19c1668899ca9515df33
1 /* $OpenBSD$ */
3 /*
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>
21 #include <string.h>
22 #include <paths.h>
24 #include "tmux.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[] = {
37 "emacs", "vi", NULL
39 static const char *options_table_clock_mode_style_list[] = {
40 "12", "24", NULL
42 static const char *options_table_status_list[] = {
43 "off", "on", "2", "3", "4", "5", NULL
45 static const char *options_table_status_keys_list[] = {
46 "emacs", "vi", NULL
48 static const char *options_table_status_justify_list[] = {
49 "left", "centre", "right", "absolute-centre", NULL
51 static const char *options_table_status_position_list[] = {
52 "top", "bottom", NULL
54 static const char *options_table_bell_action_list[] = {
55 "none", "any", "current", "other", NULL
57 static const char *options_table_visual_bell_list[] = {
58 "off", "on", "both", NULL
60 static const char *options_table_pane_status_list[] = {
61 "off", "top", "bottom", NULL
63 static const char *options_table_pane_lines_list[] = {
64 "single", "double", "heavy", "simple", "number", NULL
66 static const char *options_table_set_clipboard_list[] = {
67 "off", "external", "on", NULL
69 static const char *options_table_window_size_list[] = {
70 "largest", "smallest", "manual", "latest", NULL
72 static const char *options_table_remain_on_exit_list[] = {
73 "off", "on", "failed", NULL
75 static const char *options_table_detach_on_destroy_list[] = {
76 "off", "on", "no-detached", NULL
78 static const char *options_table_extended_keys_list[] = {
79 "off", "on", "always", NULL
82 /* Status line format. */
83 #define OPTIONS_TABLE_STATUS_FORMAT1 \
84 "#[align=left range=left #{E:status-left-style}]" \
85 "#[push-default]" \
86 "#{T;=/#{status-left-length}:status-left}" \
87 "#[pop-default]" \
88 "#[norange default]" \
89 "#[list=on align=#{status-justify}]" \
90 "#[list=left-marker]<#[list=right-marker]>#[list=on]" \
91 "#{W:" \
92 "#[range=window|#{window_index} " \
93 "#{E:window-status-style}" \
94 "#{?#{&&:#{window_last_flag}," \
95 "#{!=:#{E:window-status-last-style},default}}, " \
96 "#{E:window-status-last-style}," \
97 "}" \
98 "#{?#{&&:#{window_bell_flag}," \
99 "#{!=:#{E:window-status-bell-style},default}}, " \
100 "#{E:window-status-bell-style}," \
101 "#{?#{&&:#{||:#{window_activity_flag}," \
102 "#{window_silence_flag}}," \
103 "#{!=:" \
104 "#{E:window-status-activity-style}," \
105 "default}}, " \
106 "#{E:window-status-activity-style}," \
107 "}" \
108 "}" \
109 "]" \
110 "#[push-default]" \
111 "#{T:window-status-format}" \
112 "#[pop-default]" \
113 "#[norange default]" \
114 "#{?window_end_flag,,#{window-status-separator}}" \
115 "," \
116 "#[range=window|#{window_index} list=focus " \
117 "#{?#{!=:#{E:window-status-current-style},default}," \
118 "#{E:window-status-current-style}," \
119 "#{E:window-status-style}" \
120 "}" \
121 "#{?#{&&:#{window_last_flag}," \
122 "#{!=:#{E:window-status-last-style},default}}, " \
123 "#{E:window-status-last-style}," \
124 "}" \
125 "#{?#{&&:#{window_bell_flag}," \
126 "#{!=:#{E:window-status-bell-style},default}}, " \
127 "#{E:window-status-bell-style}," \
128 "#{?#{&&:#{||:#{window_activity_flag}," \
129 "#{window_silence_flag}}," \
130 "#{!=:" \
131 "#{E:window-status-activity-style}," \
132 "default}}, " \
133 "#{E:window-status-activity-style}," \
134 "}" \
135 "}" \
136 "]" \
137 "#[push-default]" \
138 "#{T:window-status-current-format}" \
139 "#[pop-default]" \
140 "#[norange list=on default]" \
141 "#{?window_end_flag,,#{window-status-separator}}" \
142 "}" \
143 "#[nolist align=right range=right #{E:status-right-style}]" \
144 "#[push-default]" \
145 "#{T;=/#{status-right-length}:status-right}" \
146 "#[pop-default]" \
147 "#[norange default]"
148 #define OPTIONS_TABLE_STATUS_FORMAT2 \
149 "#[align=centre]#{P:#{?pane_active,#[reverse],}" \
150 "#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
151 static const char *options_table_status_format_default[] = {
152 OPTIONS_TABLE_STATUS_FORMAT1, OPTIONS_TABLE_STATUS_FORMAT2, NULL
155 /* Helpers for hook options. */
156 #define OPTIONS_TABLE_HOOK(hook_name, default_value) \
157 { .name = hook_name, \
158 .type = OPTIONS_TABLE_COMMAND, \
159 .scope = OPTIONS_TABLE_SESSION, \
160 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
161 .default_str = default_value, \
162 .separator = "" \
165 #define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
166 { .name = hook_name, \
167 .type = OPTIONS_TABLE_COMMAND, \
168 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
169 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
170 .default_str = default_value, \
171 .separator = "" \
174 #define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
175 { .name = hook_name, \
176 .type = OPTIONS_TABLE_COMMAND, \
177 .scope = OPTIONS_TABLE_WINDOW, \
178 .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
179 .default_str = default_value, \
180 .separator = "" \
183 /* Map of name conversions. */
184 const struct options_name_map options_other_names[] = {
185 { "display-panes-color", "display-panes-colour" },
186 { "display-panes-active-color", "display-panes-active-colour" },
187 { "clock-mode-color", "clock-mode-colour" },
188 { "pane-colors", "pane-colours" },
189 { NULL, NULL }
192 /* Top-level options. */
193 const struct options_table_entry options_table[] = {
194 /* Server options. */
195 { .name = "backspace",
196 .type = OPTIONS_TABLE_KEY,
197 .scope = OPTIONS_TABLE_SERVER,
198 .default_num = '\177',
199 .text = "The key to send for backspace."
202 { .name = "buffer-limit",
203 .type = OPTIONS_TABLE_NUMBER,
204 .scope = OPTIONS_TABLE_SERVER,
205 .minimum = 1,
206 .maximum = INT_MAX,
207 .default_num = 50,
208 .text = "The maximum number of automatic buffers. "
209 "When this is reached, the oldest buffer is deleted."
212 { .name = "command-alias",
213 .type = OPTIONS_TABLE_STRING,
214 .scope = OPTIONS_TABLE_SERVER,
215 .flags = OPTIONS_TABLE_IS_ARRAY,
216 .default_str = "split-pane=split-window,"
217 "splitp=split-window,"
218 "server-info=show-messages -JT,"
219 "info=show-messages -JT,"
220 "choose-window=choose-tree -w,"
221 "choose-session=choose-tree -s",
222 .separator = ",",
223 .text = "Array of command aliases. "
224 "Each entry is an alias and a command separated by '='."
227 { .name = "copy-command",
228 .type = OPTIONS_TABLE_STRING,
229 .scope = OPTIONS_TABLE_SERVER,
230 .default_str = "",
231 .text = "Shell command run when text is copied. "
232 "If empty, no command is run."
235 { .name = "default-terminal",
236 .type = OPTIONS_TABLE_STRING,
237 .scope = OPTIONS_TABLE_SERVER,
238 .default_str = TMUX_TERM,
239 .text = "Default for the 'TERM' environment variable."
242 { .name = "editor",
243 .type = OPTIONS_TABLE_STRING,
244 .scope = OPTIONS_TABLE_SERVER,
245 .default_str = _PATH_VI,
246 .text = "Editor run to edit files."
249 { .name = "escape-time",
250 .type = OPTIONS_TABLE_NUMBER,
251 .scope = OPTIONS_TABLE_SERVER,
252 .minimum = 0,
253 .maximum = INT_MAX,
254 .default_num = 500,
255 .text = "Time to wait before assuming a key is Escape."
258 { .name = "exit-empty",
259 .type = OPTIONS_TABLE_FLAG,
260 .scope = OPTIONS_TABLE_SERVER,
261 .default_num = 1,
262 .text = "Whether the server should exit if there are no sessions."
265 { .name = "exit-unattached",
266 .type = OPTIONS_TABLE_FLAG,
267 .scope = OPTIONS_TABLE_SERVER,
268 .default_num = 0,
269 .text = "Whether the server should exit if there are no attached "
270 "clients."
273 { .name = "extended-keys",
274 .type = OPTIONS_TABLE_CHOICE,
275 .scope = OPTIONS_TABLE_SERVER,
276 .choices = options_table_extended_keys_list,
277 .default_num = 0,
278 .text = "Whether to request extended key sequences from terminals "
279 "that support it."
282 { .name = "focus-events",
283 .type = OPTIONS_TABLE_FLAG,
284 .scope = OPTIONS_TABLE_SERVER,
285 .default_num = 0,
286 .text = "Whether to send focus events to applications."
289 { .name = "history-file",
290 .type = OPTIONS_TABLE_STRING,
291 .scope = OPTIONS_TABLE_SERVER,
292 .default_str = "",
293 .text = "Location of the command prompt history file. "
294 "Empty does not write a history file."
297 { .name = "message-limit",
298 .type = OPTIONS_TABLE_NUMBER,
299 .scope = OPTIONS_TABLE_SERVER,
300 .minimum = 0,
301 .maximum = INT_MAX,
302 .default_num = 1000,
303 .text = "Maximum number of server messages to keep."
306 { .name = "prompt-history-limit",
307 .type = OPTIONS_TABLE_NUMBER,
308 .scope = OPTIONS_TABLE_SERVER,
309 .minimum = 0,
310 .maximum = INT_MAX,
311 .default_num = 100,
312 .text = "Maximum number of commands to keep in history."
315 { .name = "set-clipboard",
316 .type = OPTIONS_TABLE_CHOICE,
317 .scope = OPTIONS_TABLE_SERVER,
318 .choices = options_table_set_clipboard_list,
319 .default_num = 1,
320 .text = "Whether to attempt to set the system clipboard ('on' or "
321 "'external') and whether to allow applications to create "
322 "paste buffers with an escape sequence ('on' only)."
325 { .name = "terminal-overrides",
326 .type = OPTIONS_TABLE_STRING,
327 .scope = OPTIONS_TABLE_SERVER,
328 .flags = OPTIONS_TABLE_IS_ARRAY,
329 .default_str = "",
330 .separator = ",",
331 .text = "List of terminal capabilities overrides."
334 { .name = "terminal-features",
335 .type = OPTIONS_TABLE_STRING,
336 .scope = OPTIONS_TABLE_SERVER,
337 .flags = OPTIONS_TABLE_IS_ARRAY,
338 .default_str = "xterm*:clipboard:ccolour:cstyle:focus:title,"
339 "screen*:title",
340 .separator = ",",
341 .text = "List of terminal features, used if they cannot be "
342 "automatically detected."
345 { .name = "user-keys",
346 .type = OPTIONS_TABLE_STRING,
347 .scope = OPTIONS_TABLE_SERVER,
348 .flags = OPTIONS_TABLE_IS_ARRAY,
349 .default_str = "",
350 .separator = ",",
351 .text = "User key assignments. "
352 "Each sequence in the list is translated into a key: "
353 "'User0', 'User1' and so on."
356 /* Session options. */
357 { .name = "activity-action",
358 .type = OPTIONS_TABLE_CHOICE,
359 .scope = OPTIONS_TABLE_SESSION,
360 .choices = options_table_bell_action_list,
361 .default_num = ALERT_OTHER,
362 .text = "Action to take on an activity alert."
365 { .name = "assume-paste-time",
366 .type = OPTIONS_TABLE_NUMBER,
367 .scope = OPTIONS_TABLE_SESSION,
368 .minimum = 0,
369 .maximum = INT_MAX,
370 .default_num = 1,
371 .unit = "milliseconds",
372 .text = "Maximum time between input to assume it is pasting rather "
373 "than typing."
376 { .name = "base-index",
377 .type = OPTIONS_TABLE_NUMBER,
378 .scope = OPTIONS_TABLE_SESSION,
379 .minimum = 0,
380 .maximum = INT_MAX,
381 .default_num = 0,
382 .text = "Default index of the first window in each session."
385 { .name = "bell-action",
386 .type = OPTIONS_TABLE_CHOICE,
387 .scope = OPTIONS_TABLE_SESSION,
388 .choices = options_table_bell_action_list,
389 .default_num = ALERT_ANY,
390 .text = "Action to take on a bell alert."
393 { .name = "default-command",
394 .type = OPTIONS_TABLE_STRING,
395 .scope = OPTIONS_TABLE_SESSION,
396 .default_str = "",
397 .text = "Default command to run in new panes. If empty, a shell is "
398 "started."
401 { .name = "default-shell",
402 .type = OPTIONS_TABLE_STRING,
403 .scope = OPTIONS_TABLE_SESSION,
404 .default_str = _PATH_BSHELL,
405 .text = "Location of default shell."
408 { .name = "default-size",
409 .type = OPTIONS_TABLE_STRING,
410 .scope = OPTIONS_TABLE_SESSION,
411 .pattern = "[0-9]*x[0-9]*",
412 .default_str = "80x24",
413 .text = "Initial size of new sessions."
416 { .name = "destroy-unattached",
417 .type = OPTIONS_TABLE_FLAG,
418 .scope = OPTIONS_TABLE_SESSION,
419 .default_num = 0,
420 .text = "Whether to destroy sessions when they have no attached "
421 "clients."
424 { .name = "detach-on-destroy",
425 .type = OPTIONS_TABLE_CHOICE,
426 .scope = OPTIONS_TABLE_SESSION,
427 .choices = options_table_detach_on_destroy_list,
428 .default_num = 1,
429 .text = "Whether to detach when a session is destroyed, or switch "
430 "the client to another session if any exist."
433 { .name = "display-panes-active-colour",
434 .type = OPTIONS_TABLE_COLOUR,
435 .scope = OPTIONS_TABLE_SESSION,
436 .default_num = 1,
437 .text = "Colour of the active pane for 'display-panes'."
440 { .name = "display-panes-colour",
441 .type = OPTIONS_TABLE_COLOUR,
442 .scope = OPTIONS_TABLE_SESSION,
443 .default_num = 4,
444 .text = "Colour of not active panes for 'display-panes'."
447 { .name = "display-panes-time",
448 .type = OPTIONS_TABLE_NUMBER,
449 .scope = OPTIONS_TABLE_SESSION,
450 .minimum = 1,
451 .maximum = INT_MAX,
452 .default_num = 1000,
453 .unit = "milliseconds",
454 .text = "Time for which 'display-panes' should show pane numbers."
457 { .name = "display-time",
458 .type = OPTIONS_TABLE_NUMBER,
459 .scope = OPTIONS_TABLE_SESSION,
460 .minimum = 0,
461 .maximum = INT_MAX,
462 .default_num = 750,
463 .unit = "milliseconds",
464 .text = "Time for which status line messages should appear."
467 { .name = "history-limit",
468 .type = OPTIONS_TABLE_NUMBER,
469 .scope = OPTIONS_TABLE_SESSION,
470 .minimum = 0,
471 .maximum = INT_MAX,
472 .default_num = 2000,
473 .unit = "lines",
474 .text = "Maximum number of lines to keep in the history for each "
475 "pane. "
476 "If changed, the new value applies only to new panes."
479 { .name = "key-table",
480 .type = OPTIONS_TABLE_STRING,
481 .scope = OPTIONS_TABLE_SESSION,
482 .default_str = "root",
483 .text = "Default key table. "
484 "Key presses are first looked up in this table."
487 { .name = "lock-after-time",
488 .type = OPTIONS_TABLE_NUMBER,
489 .scope = OPTIONS_TABLE_SESSION,
490 .minimum = 0,
491 .maximum = INT_MAX,
492 .default_num = 0,
493 .unit = "seconds",
494 .text = "Time after which a client is locked if not used."
497 { .name = "lock-command",
498 .type = OPTIONS_TABLE_STRING,
499 .scope = OPTIONS_TABLE_SESSION,
500 .default_str = "lock -np",
501 .text = "Shell command to run to lock a client."
504 { .name = "message-command-style",
505 .type = OPTIONS_TABLE_STRING,
506 .scope = OPTIONS_TABLE_SESSION,
507 .default_str = "bg=black,fg=yellow",
508 .flags = OPTIONS_TABLE_IS_STYLE,
509 .separator = ",",
510 .text = "Style of the command prompt when in command mode, if "
511 "'mode-keys' is set to 'vi'."
514 { .name = "message-style",
515 .type = OPTIONS_TABLE_STRING,
516 .scope = OPTIONS_TABLE_SESSION,
517 .default_str = "bg=yellow,fg=black",
518 .flags = OPTIONS_TABLE_IS_STYLE,
519 .separator = ",",
520 .text = "Style of the command prompt."
523 { .name = "mouse",
524 .type = OPTIONS_TABLE_FLAG,
525 .scope = OPTIONS_TABLE_SESSION,
526 .default_num = 0,
527 .text = "Whether the mouse is recognised and mouse key bindings are "
528 "executed. "
529 "Applications inside panes can use the mouse even when 'off'."
532 { .name = "prefix",
533 .type = OPTIONS_TABLE_KEY,
534 .scope = OPTIONS_TABLE_SESSION,
535 .default_num = '\002',
536 .text = "The prefix key."
539 { .name = "prefix2",
540 .type = OPTIONS_TABLE_KEY,
541 .scope = OPTIONS_TABLE_SESSION,
542 .default_num = KEYC_NONE,
543 .text = "A second prefix key."
546 { .name = "renumber-windows",
547 .type = OPTIONS_TABLE_FLAG,
548 .scope = OPTIONS_TABLE_SESSION,
549 .default_num = 0,
550 .text = "Whether windows are automatically renumbered rather than "
551 "leaving gaps."
554 { .name = "repeat-time",
555 .type = OPTIONS_TABLE_NUMBER,
556 .scope = OPTIONS_TABLE_SESSION,
557 .minimum = 0,
558 .maximum = SHRT_MAX,
559 .default_num = 500,
560 .unit = "milliseconds",
561 .text = "Time to wait for a key binding to repeat, if it is bound "
562 "with the '-r' flag."
565 { .name = "set-titles",
566 .type = OPTIONS_TABLE_FLAG,
567 .scope = OPTIONS_TABLE_SESSION,
568 .default_num = 0,
569 .text = "Whether to set the terminal title, if supported."
572 { .name = "set-titles-string",
573 .type = OPTIONS_TABLE_STRING,
574 .scope = OPTIONS_TABLE_SESSION,
575 .default_str = "#S:#I:#W - \"#T\" #{session_alerts}",
576 .text = "Format of the terminal title to set."
579 { .name = "silence-action",
580 .type = OPTIONS_TABLE_CHOICE,
581 .scope = OPTIONS_TABLE_SESSION,
582 .choices = options_table_bell_action_list,
583 .default_num = ALERT_OTHER,
584 .text = "Action to take on a silence alert."
587 { .name = "status",
588 .type = OPTIONS_TABLE_CHOICE,
589 .scope = OPTIONS_TABLE_SESSION,
590 .choices = options_table_status_list,
591 .default_num = 1,
592 .text = "Number of lines in the status line."
595 { .name = "status-bg",
596 .type = OPTIONS_TABLE_COLOUR,
597 .scope = OPTIONS_TABLE_SESSION,
598 .default_num = 8,
599 .text = "Background colour of the status line. This option is "
600 "deprecated, use 'status-style' instead."
603 { .name = "status-fg",
604 .type = OPTIONS_TABLE_COLOUR,
605 .scope = OPTIONS_TABLE_SESSION,
606 .default_num = 8,
607 .text = "Foreground colour of the status line. This option is "
608 "deprecated, use 'status-style' instead."
611 { .name = "status-format",
612 .type = OPTIONS_TABLE_STRING,
613 .scope = OPTIONS_TABLE_SESSION,
614 .flags = OPTIONS_TABLE_IS_ARRAY,
615 .default_arr = options_table_status_format_default,
616 .text = "Formats for the status lines. "
617 "Each array member is the format for one status line. "
618 "The default status line is made up of several components "
619 "which may be configured individually with other options such "
620 "as 'status-left'."
623 { .name = "status-interval",
624 .type = OPTIONS_TABLE_NUMBER,
625 .scope = OPTIONS_TABLE_SESSION,
626 .minimum = 0,
627 .maximum = INT_MAX,
628 .default_num = 15,
629 .unit = "seconds",
630 .text = "Number of seconds between status line updates."
633 { .name = "status-justify",
634 .type = OPTIONS_TABLE_CHOICE,
635 .scope = OPTIONS_TABLE_SESSION,
636 .choices = options_table_status_justify_list,
637 .default_num = 0,
638 .text = "Position of the window list in the status line."
641 { .name = "status-keys",
642 .type = OPTIONS_TABLE_CHOICE,
643 .scope = OPTIONS_TABLE_SESSION,
644 .choices = options_table_status_keys_list,
645 .default_num = MODEKEY_EMACS,
646 .text = "Key set to use at the command prompt."
649 { .name = "status-left",
650 .type = OPTIONS_TABLE_STRING,
651 .scope = OPTIONS_TABLE_SESSION,
652 .default_str = "[#{session_name}] ",
653 .text = "Contents of the left side of the status line."
656 { .name = "status-left-length",
657 .type = OPTIONS_TABLE_NUMBER,
658 .scope = OPTIONS_TABLE_SESSION,
659 .minimum = 0,
660 .maximum = SHRT_MAX,
661 .default_num = 10,
662 .text = "Maximum width of the left side of the status line."
665 { .name = "status-left-style",
666 .type = OPTIONS_TABLE_STRING,
667 .scope = OPTIONS_TABLE_SESSION,
668 .default_str = "default",
669 .flags = OPTIONS_TABLE_IS_STYLE,
670 .separator = ",",
671 .text = "Style of the left side of the status line."
674 { .name = "status-position",
675 .type = OPTIONS_TABLE_CHOICE,
676 .scope = OPTIONS_TABLE_SESSION,
677 .choices = options_table_status_position_list,
678 .default_num = 1,
679 .text = "Position of the status line."
682 { .name = "status-right",
683 .type = OPTIONS_TABLE_STRING,
684 .scope = OPTIONS_TABLE_SESSION,
685 .default_str = "#{?window_bigger,"
686 "[#{window_offset_x}#,#{window_offset_y}] ,}"
687 "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
688 .text = "Contents of the right side of the status line."
692 { .name = "status-right-length",
693 .type = OPTIONS_TABLE_NUMBER,
694 .scope = OPTIONS_TABLE_SESSION,
695 .minimum = 0,
696 .maximum = SHRT_MAX,
697 .default_num = 40,
698 .text = "Maximum width of the right side of the status line."
701 { .name = "status-right-style",
702 .type = OPTIONS_TABLE_STRING,
703 .scope = OPTIONS_TABLE_SESSION,
704 .default_str = "default",
705 .flags = OPTIONS_TABLE_IS_STYLE,
706 .separator = ",",
707 .text = "Style of the right side of the status line."
710 { .name = "status-style",
711 .type = OPTIONS_TABLE_STRING,
712 .scope = OPTIONS_TABLE_SESSION,
713 .default_str = "bg=green,fg=black",
714 .flags = OPTIONS_TABLE_IS_STYLE,
715 .separator = ",",
716 .text = "Style of the status line."
719 { .name = "update-environment",
720 .type = OPTIONS_TABLE_STRING,
721 .scope = OPTIONS_TABLE_SESSION,
722 .flags = OPTIONS_TABLE_IS_ARRAY,
723 .default_str = "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
724 "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
725 .text = "List of environment variables to update in the session "
726 "environment when a client is attached."
729 { .name = "visual-activity",
730 .type = OPTIONS_TABLE_CHOICE,
731 .scope = OPTIONS_TABLE_SESSION,
732 .choices = options_table_visual_bell_list,
733 .default_num = VISUAL_OFF,
734 .text = "How activity alerts should be shown: a message ('on'), "
735 "a message and a bell ('both') or nothing ('off')."
738 { .name = "visual-bell",
739 .type = OPTIONS_TABLE_CHOICE,
740 .scope = OPTIONS_TABLE_SESSION,
741 .choices = options_table_visual_bell_list,
742 .default_num = VISUAL_OFF,
743 .text = "How bell alerts should be shown: a message ('on'), "
744 "a message and a bell ('both') or nothing ('off')."
747 { .name = "visual-silence",
748 .type = OPTIONS_TABLE_CHOICE,
749 .scope = OPTIONS_TABLE_SESSION,
750 .choices = options_table_visual_bell_list,
751 .default_num = VISUAL_OFF,
752 .text = "How silence alerts should be shown: a message ('on'), "
753 "a message and a bell ('both') or nothing ('off')."
756 { .name = "word-separators",
757 .type = OPTIONS_TABLE_STRING,
758 .scope = OPTIONS_TABLE_SESSION,
760 * The set of non-alphanumeric printable ASCII characters minus the
761 * underscore.
763 .default_str = "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
764 .text = "Characters considered to separate words."
767 /* Window options. */
768 { .name = "aggressive-resize",
769 .type = OPTIONS_TABLE_FLAG,
770 .scope = OPTIONS_TABLE_WINDOW,
771 .default_num = 0,
772 .text = "When 'window-size' is 'smallest', whether the maximum size "
773 "of a window is the smallest attached session where it is "
774 "the current window ('on') or the smallest session it is "
775 "linked to ('off')."
778 { .name = "allow-rename",
779 .type = OPTIONS_TABLE_FLAG,
780 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
781 .default_num = 0,
782 .text = "Whether applications are allowed to use the escape sequence "
783 "to rename windows."
786 { .name = "alternate-screen",
787 .type = OPTIONS_TABLE_FLAG,
788 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
789 .default_num = 1,
790 .text = "Whether applications are allowed to use the alternate "
791 "screen."
794 { .name = "automatic-rename",
795 .type = OPTIONS_TABLE_FLAG,
796 .scope = OPTIONS_TABLE_WINDOW,
797 .default_num = 1,
798 .text = "Whether windows are automatically renamed."
801 { .name = "automatic-rename-format",
802 .type = OPTIONS_TABLE_STRING,
803 .scope = OPTIONS_TABLE_WINDOW,
804 .default_str = "#{?pane_in_mode,[tmux],#{pane_current_command}}"
805 "#{?pane_dead,[dead],}",
806 .text = "Format used to automatically rename windows."
809 { .name = "clock-mode-colour",
810 .type = OPTIONS_TABLE_COLOUR,
811 .scope = OPTIONS_TABLE_WINDOW,
812 .default_num = 4,
813 .text = "Colour of the clock in clock mode."
816 { .name = "clock-mode-style",
817 .type = OPTIONS_TABLE_CHOICE,
818 .scope = OPTIONS_TABLE_WINDOW,
819 .choices = options_table_clock_mode_style_list,
820 .default_num = 1,
821 .text = "Time format of the clock in clock mode."
824 { .name = "copy-mode-match-style",
825 .type = OPTIONS_TABLE_STRING,
826 .scope = OPTIONS_TABLE_WINDOW,
827 .default_str = "bg=cyan,fg=black",
828 .flags = OPTIONS_TABLE_IS_STYLE,
829 .separator = ",",
830 .text = "Style of search matches in copy mode."
833 { .name = "copy-mode-current-match-style",
834 .type = OPTIONS_TABLE_STRING,
835 .scope = OPTIONS_TABLE_WINDOW,
836 .default_str = "bg=magenta,fg=black",
837 .flags = OPTIONS_TABLE_IS_STYLE,
838 .separator = ",",
839 .text = "Style of the current search match in copy mode."
842 { .name = "copy-mode-mark-style",
843 .type = OPTIONS_TABLE_STRING,
844 .scope = OPTIONS_TABLE_WINDOW,
845 .default_str = "bg=red,fg=black",
846 .flags = OPTIONS_TABLE_IS_STYLE,
847 .separator = ",",
848 .text = "Style of the marked line in copy mode."
851 { .name = "main-pane-height",
852 .type = OPTIONS_TABLE_STRING,
853 .scope = OPTIONS_TABLE_WINDOW,
854 .default_str = "24",
855 .text = "Height of the main pane in the 'main-horizontal' layout. "
856 "This may be a percentage, for example '10%'."
859 { .name = "main-pane-width",
860 .type = OPTIONS_TABLE_STRING,
861 .scope = OPTIONS_TABLE_WINDOW,
862 .default_str = "80",
863 .text = "Width of the main pane in the 'main-vertical' layout. "
864 "This may be a percentage, for example '10%'."
867 { .name = "mode-keys",
868 .type = OPTIONS_TABLE_CHOICE,
869 .scope = OPTIONS_TABLE_WINDOW,
870 .choices = options_table_mode_keys_list,
871 .default_num = MODEKEY_EMACS,
872 .text = "Key set used in copy mode."
875 { .name = "mode-style",
876 .type = OPTIONS_TABLE_STRING,
877 .scope = OPTIONS_TABLE_WINDOW,
878 .default_str = "bg=yellow,fg=black",
879 .flags = OPTIONS_TABLE_IS_STYLE,
880 .separator = ",",
881 .text = "Style of indicators and highlighting in modes."
884 { .name = "monitor-activity",
885 .type = OPTIONS_TABLE_FLAG,
886 .scope = OPTIONS_TABLE_WINDOW,
887 .default_num = 0,
888 .text = "Whether an alert is triggered by activity."
891 { .name = "monitor-bell",
892 .type = OPTIONS_TABLE_FLAG,
893 .scope = OPTIONS_TABLE_WINDOW,
894 .default_num = 1,
895 .text = "Whether an alert is triggered by a bell."
898 { .name = "monitor-silence",
899 .type = OPTIONS_TABLE_NUMBER,
900 .scope = OPTIONS_TABLE_WINDOW,
901 .minimum = 0,
902 .maximum = INT_MAX,
903 .default_num = 0,
904 .text = "Time after which an alert is triggered by silence. "
905 "Zero means no alert."
909 { .name = "other-pane-height",
910 .type = OPTIONS_TABLE_STRING,
911 .scope = OPTIONS_TABLE_WINDOW,
912 .default_str = "0",
913 .text = "Height of the other panes in the 'main-horizontal' layout. "
914 "This may be a percentage, for example '10%'."
917 { .name = "other-pane-width",
918 .type = OPTIONS_TABLE_STRING,
919 .scope = OPTIONS_TABLE_WINDOW,
920 .default_str = "0",
921 .text = "Height of the other panes in the 'main-vertical' layout. "
922 "This may be a percentage, for example '10%'."
925 { .name = "pane-active-border-style",
926 .type = OPTIONS_TABLE_STRING,
927 .scope = OPTIONS_TABLE_WINDOW,
928 .default_str = "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
929 .flags = OPTIONS_TABLE_IS_STYLE,
930 .separator = ",",
931 .text = "Style of the active pane border."
934 { .name = "pane-base-index",
935 .type = OPTIONS_TABLE_NUMBER,
936 .scope = OPTIONS_TABLE_WINDOW,
937 .minimum = 0,
938 .maximum = USHRT_MAX,
939 .default_num = 0,
940 .text = "Index of the first pane in each window."
943 { .name = "pane-border-format",
944 .type = OPTIONS_TABLE_STRING,
945 .scope = OPTIONS_TABLE_WINDOW,
946 .default_str = "#{?pane_active,#[reverse],}#{pane_index}#[default] "
947 "\"#{pane_title}\"",
948 .text = "Format of text in the pane status lines."
951 { .name = "pane-border-lines",
952 .type = OPTIONS_TABLE_CHOICE,
953 .scope = OPTIONS_TABLE_WINDOW,
954 .choices = options_table_pane_lines_list,
955 .default_num = PANE_LINES_SINGLE,
956 .text = "Type of characters used to draw pane border lines. Some of "
957 "these are only supported on terminals with UTF-8 support."
960 { .name = "pane-border-status",
961 .type = OPTIONS_TABLE_CHOICE,
962 .scope = OPTIONS_TABLE_WINDOW,
963 .choices = options_table_pane_status_list,
964 .default_num = PANE_STATUS_OFF,
965 .text = "Position of the pane status lines."
968 { .name = "pane-border-style",
969 .type = OPTIONS_TABLE_STRING,
970 .scope = OPTIONS_TABLE_WINDOW,
971 .default_str = "default",
972 .flags = OPTIONS_TABLE_IS_STYLE,
973 .separator = ",",
974 .text = "Style of the pane status lines."
977 { .name = "pane-colours",
978 .type = OPTIONS_TABLE_COLOUR,
979 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
980 .default_str = "",
981 .flags = OPTIONS_TABLE_IS_ARRAY,
982 .text = "The default colour palette for colours zero to 255."
985 { .name = "remain-on-exit",
986 .type = OPTIONS_TABLE_CHOICE,
987 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
988 .choices = options_table_remain_on_exit_list,
989 .default_num = 0,
990 .text = "Whether panes should remain ('on') or be automatically "
991 "killed ('off' or 'failed') when the program inside exits."
994 { .name = "synchronize-panes",
995 .type = OPTIONS_TABLE_FLAG,
996 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
997 .default_num = 0,
998 .text = "Whether typing should be sent to all panes simultaneously."
1001 { .name = "window-active-style",
1002 .type = OPTIONS_TABLE_STRING,
1003 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1004 .default_str = "default",
1005 .flags = OPTIONS_TABLE_IS_STYLE,
1006 .separator = ",",
1007 .text = "Default style of the active pane."
1010 { .name = "window-size",
1011 .type = OPTIONS_TABLE_CHOICE,
1012 .scope = OPTIONS_TABLE_WINDOW,
1013 .choices = options_table_window_size_list,
1014 .default_num = WINDOW_SIZE_LATEST,
1015 .text = "How window size is calculated. "
1016 "'latest' uses the size of the most recently used client, "
1017 "'largest' the largest client, 'smallest' the smallest "
1018 "client and 'manual' a size set by the 'resize-window' "
1019 "command."
1022 { .name = "window-style",
1023 .type = OPTIONS_TABLE_STRING,
1024 .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1025 .default_str = "default",
1026 .flags = OPTIONS_TABLE_IS_STYLE,
1027 .separator = ",",
1028 .text = "Default style of panes that are not the active pane."
1031 { .name = "window-status-activity-style",
1032 .type = OPTIONS_TABLE_STRING,
1033 .scope = OPTIONS_TABLE_WINDOW,
1034 .default_str = "reverse",
1035 .flags = OPTIONS_TABLE_IS_STYLE,
1036 .separator = ",",
1037 .text = "Style of windows in the status line with an activity alert."
1040 { .name = "window-status-bell-style",
1041 .type = OPTIONS_TABLE_STRING,
1042 .scope = OPTIONS_TABLE_WINDOW,
1043 .default_str = "reverse",
1044 .flags = OPTIONS_TABLE_IS_STYLE,
1045 .separator = ",",
1046 .text = "Style of windows in the status line with a bell alert."
1049 { .name = "window-status-current-format",
1050 .type = OPTIONS_TABLE_STRING,
1051 .scope = OPTIONS_TABLE_WINDOW,
1052 .default_str = "#I:#W#{?window_flags,#{window_flags}, }",
1053 .text = "Format of the current window in the status line."
1056 { .name = "window-status-current-style",
1057 .type = OPTIONS_TABLE_STRING,
1058 .scope = OPTIONS_TABLE_WINDOW,
1059 .default_str = "default",
1060 .flags = OPTIONS_TABLE_IS_STYLE,
1061 .separator = ",",
1062 .text = "Style of the current window in the status line."
1065 { .name = "window-status-format",
1066 .type = OPTIONS_TABLE_STRING,
1067 .scope = OPTIONS_TABLE_WINDOW,
1068 .default_str = "#I:#W#{?window_flags,#{window_flags}, }",
1069 .text = "Format of windows in the status line, except the current "
1070 "window."
1073 { .name = "window-status-last-style",
1074 .type = OPTIONS_TABLE_STRING,
1075 .scope = OPTIONS_TABLE_WINDOW,
1076 .default_str = "default",
1077 .flags = OPTIONS_TABLE_IS_STYLE,
1078 .separator = ",",
1079 .text = "Style of the last window in the status line."
1082 { .name = "window-status-separator",
1083 .type = OPTIONS_TABLE_STRING,
1084 .scope = OPTIONS_TABLE_WINDOW,
1085 .default_str = " ",
1086 .text = "Separator between windows in the status line."
1089 { .name = "window-status-style",
1090 .type = OPTIONS_TABLE_STRING,
1091 .scope = OPTIONS_TABLE_WINDOW,
1092 .default_str = "default",
1093 .flags = OPTIONS_TABLE_IS_STYLE,
1094 .separator = ",",
1095 .text = "Style of windows in the status line, except the current and "
1096 "last windows."
1099 { .name = "wrap-search",
1100 .type = OPTIONS_TABLE_FLAG,
1101 .scope = OPTIONS_TABLE_WINDOW,
1102 .default_num = 1,
1103 .text = "Whether searching in copy mode should wrap at the top or "
1104 "bottom."
1107 { .name = "xterm-keys", /* no longer used */
1108 .type = OPTIONS_TABLE_FLAG,
1109 .scope = OPTIONS_TABLE_WINDOW,
1110 .default_num = 1,
1111 .text = "Whether xterm-style function key sequences should be sent. "
1112 "This option is no longer used."
1115 /* Hook options. */
1116 OPTIONS_TABLE_HOOK("after-bind-key", ""),
1117 OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1118 OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1119 OPTIONS_TABLE_HOOK("after-display-message", ""),
1120 OPTIONS_TABLE_HOOK("after-display-panes", ""),
1121 OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1122 OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1123 OPTIONS_TABLE_HOOK("after-list-clients", ""),
1124 OPTIONS_TABLE_HOOK("after-list-keys", ""),
1125 OPTIONS_TABLE_HOOK("after-list-panes", ""),
1126 OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1127 OPTIONS_TABLE_HOOK("after-list-windows", ""),
1128 OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1129 OPTIONS_TABLE_HOOK("after-lock-server", ""),
1130 OPTIONS_TABLE_HOOK("after-new-session", ""),
1131 OPTIONS_TABLE_HOOK("after-new-window", ""),
1132 OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1133 OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1134 OPTIONS_TABLE_HOOK("after-queue", ""),
1135 OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1136 OPTIONS_TABLE_HOOK("after-rename-session", ""),
1137 OPTIONS_TABLE_HOOK("after-rename-window", ""),
1138 OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1139 OPTIONS_TABLE_HOOK("after-resize-window", ""),
1140 OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1141 OPTIONS_TABLE_HOOK("after-select-layout", ""),
1142 OPTIONS_TABLE_HOOK("after-select-pane", ""),
1143 OPTIONS_TABLE_HOOK("after-select-window", ""),
1144 OPTIONS_TABLE_HOOK("after-send-keys", ""),
1145 OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1146 OPTIONS_TABLE_HOOK("after-set-environment", ""),
1147 OPTIONS_TABLE_HOOK("after-set-hook", ""),
1148 OPTIONS_TABLE_HOOK("after-set-option", ""),
1149 OPTIONS_TABLE_HOOK("after-show-environment", ""),
1150 OPTIONS_TABLE_HOOK("after-show-messages", ""),
1151 OPTIONS_TABLE_HOOK("after-show-options", ""),
1152 OPTIONS_TABLE_HOOK("after-split-window", ""),
1153 OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1154 OPTIONS_TABLE_HOOK("alert-activity", ""),
1155 OPTIONS_TABLE_HOOK("alert-bell", ""),
1156 OPTIONS_TABLE_HOOK("alert-silence", ""),
1157 OPTIONS_TABLE_HOOK("client-active", ""),
1158 OPTIONS_TABLE_HOOK("client-attached", ""),
1159 OPTIONS_TABLE_HOOK("client-detached", ""),
1160 OPTIONS_TABLE_HOOK("client-focus-in", ""),
1161 OPTIONS_TABLE_HOOK("client-focus-out", ""),
1162 OPTIONS_TABLE_HOOK("client-resized", ""),
1163 OPTIONS_TABLE_HOOK("client-session-changed", ""),
1164 OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1165 OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1166 OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1167 OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1168 OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1169 OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1170 OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1171 OPTIONS_TABLE_HOOK("session-closed", ""),
1172 OPTIONS_TABLE_HOOK("session-created", ""),
1173 OPTIONS_TABLE_HOOK("session-renamed", ""),
1174 OPTIONS_TABLE_HOOK("session-window-changed", ""),
1175 OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1176 OPTIONS_TABLE_HOOK("window-linked", ""),
1177 OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1178 OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1179 OPTIONS_TABLE_HOOK("window-unlinked", ""),
1181 { .name = NULL }