Annotation of src/usr.bin/tmux/options-table.c, Revision 1.170
1.170 ! nicm 1: /* $OpenBSD: options-table.c,v 1.169 2024/02/13 08:10:23 nicm Exp $ */
1.1 nicm 2:
3: /*
1.71 nicm 4: * Copyright (c) 2011 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 5: *
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.
9: *
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.
17: */
18:
19: #include <sys/types.h>
20:
21: #include <string.h>
22: #include <paths.h>
23:
24: #include "tmux.h"
25:
26: /*
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
1.49 nicm 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.
1.1 nicm 33: */
34:
35: /* Choice option type lists. */
1.74 nicm 36: static const char *options_table_mode_keys_list[] = {
1.1 nicm 37: "emacs", "vi", NULL
38: };
1.74 nicm 39: static const char *options_table_clock_mode_style_list[] = {
1.1 nicm 40: "12", "24", NULL
41: };
1.99 nicm 42: static const char *options_table_status_list[] = {
43: "off", "on", "2", "3", "4", "5", NULL
44: };
1.165 nicm 45: static const char *options_table_message_line_list[] = {
46: "0", "1", "2", "3", "4", NULL
47: };
1.74 nicm 48: static const char *options_table_status_keys_list[] = {
1.1 nicm 49: "emacs", "vi", NULL
50: };
1.74 nicm 51: static const char *options_table_status_justify_list[] = {
1.140 nicm 52: "left", "centre", "right", "absolute-centre", NULL
1.1 nicm 53: };
1.74 nicm 54: static const char *options_table_status_position_list[] = {
1.20 nicm 55: "top", "bottom", NULL
56: };
1.74 nicm 57: static const char *options_table_bell_action_list[] = {
1.59 nicm 58: "none", "any", "current", "other", NULL
1.1 nicm 59: };
1.91 nicm 60: static const char *options_table_visual_bell_list[] = {
61: "off", "on", "both", NULL
62: };
1.154 nicm 63: static const char *options_table_cursor_style_list[] = {
64: "default", "blinking-block", "block", "blinking-underline", "underline",
65: "blinking-bar", "bar", NULL
66: };
1.74 nicm 67: static const char *options_table_pane_status_list[] = {
1.72 nicm 68: "off", "top", "bottom", NULL
69: };
1.156 nicm 70: static const char *options_table_pane_border_indicators_list[] = {
71: "off", "colour", "arrows", "both", NULL
72: };
1.152 nicm 73: static const char *options_table_pane_border_lines_list[] = {
1.129 nicm 74: "single", "double", "heavy", "simple", "number", NULL
75: };
1.152 nicm 76: static const char *options_table_popup_border_lines_list[] = {
77: "single", "double", "heavy", "simple", "rounded", "padded", "none", NULL
78: };
1.89 nicm 79: static const char *options_table_set_clipboard_list[] = {
80: "off", "external", "on", NULL
81: };
1.97 nicm 82: static const char *options_table_window_size_list[] = {
1.111 nicm 83: "largest", "smallest", "manual", "latest", NULL
1.97 nicm 84: };
1.137 nicm 85: static const char *options_table_remain_on_exit_list[] = {
86: "off", "on", "failed", NULL
87: };
1.169 nicm 88: static const char *options_table_destroy_unattached_list[] = {
89: "off", "on", "keep-last", "keep-group", NULL
90: };
1.139 nicm 91: static const char *options_table_detach_on_destroy_list[] = {
1.168 nicm 92: "off", "on", "no-detached", "previous", "next", NULL
1.139 nicm 93: };
1.141 nicm 94: static const char *options_table_extended_keys_list[] = {
95: "off", "on", "always", NULL
96: };
1.164 nicm 97: static const char *options_table_allow_passthrough_list[] = {
98: "off", "on", "all", NULL
99: };
1.1 nicm 100:
1.99 nicm 101: /* Status line format. */
102: #define OPTIONS_TABLE_STATUS_FORMAT1 \
1.150 nicm 103: "#[align=left range=left #{E:status-left-style}]" \
1.114 nicm 104: "#[push-default]" \
105: "#{T;=/#{status-left-length}:status-left}" \
106: "#[pop-default]" \
107: "#[norange default]" \
1.99 nicm 108: "#[list=on align=#{status-justify}]" \
109: "#[list=left-marker]<#[list=right-marker]>#[list=on]" \
110: "#{W:" \
1.101 nicm 111: "#[range=window|#{window_index} " \
1.150 nicm 112: "#{E:window-status-style}" \
1.101 nicm 113: "#{?#{&&:#{window_last_flag}," \
1.150 nicm 114: "#{!=:#{E:window-status-last-style},default}}, " \
115: "#{E:window-status-last-style}," \
1.101 nicm 116: "}" \
117: "#{?#{&&:#{window_bell_flag}," \
1.150 nicm 118: "#{!=:#{E:window-status-bell-style},default}}, " \
119: "#{E:window-status-bell-style}," \
1.102 nicm 120: "#{?#{&&:#{||:#{window_activity_flag}," \
121: "#{window_silence_flag}}," \
1.101 nicm 122: "#{!=:" \
1.150 nicm 123: "#{E:window-status-activity-style}," \
1.101 nicm 124: "default}}, " \
1.150 nicm 125: "#{E:window-status-activity-style}," \
1.99 nicm 126: "}" \
1.101 nicm 127: "}" \
1.99 nicm 128: "]" \
1.110 nicm 129: "#[push-default]" \
1.99 nicm 130: "#{T:window-status-format}" \
1.110 nicm 131: "#[pop-default]" \
1.99 nicm 132: "#[norange default]" \
133: "#{?window_end_flag,,#{window-status-separator}}" \
134: "," \
1.101 nicm 135: "#[range=window|#{window_index} list=focus " \
1.150 nicm 136: "#{?#{!=:#{E:window-status-current-style},default}," \
137: "#{E:window-status-current-style}," \
138: "#{E:window-status-style}" \
1.127 nicm 139: "}" \
1.101 nicm 140: "#{?#{&&:#{window_last_flag}," \
1.150 nicm 141: "#{!=:#{E:window-status-last-style},default}}, " \
142: "#{E:window-status-last-style}," \
1.101 nicm 143: "}" \
144: "#{?#{&&:#{window_bell_flag}," \
1.150 nicm 145: "#{!=:#{E:window-status-bell-style},default}}, " \
146: "#{E:window-status-bell-style}," \
1.102 nicm 147: "#{?#{&&:#{||:#{window_activity_flag}," \
148: "#{window_silence_flag}}," \
1.101 nicm 149: "#{!=:" \
1.150 nicm 150: "#{E:window-status-activity-style}," \
1.101 nicm 151: "default}}, " \
1.150 nicm 152: "#{E:window-status-activity-style}," \
1.99 nicm 153: "}" \
1.101 nicm 154: "}" \
1.99 nicm 155: "]" \
1.110 nicm 156: "#[push-default]" \
1.99 nicm 157: "#{T:window-status-current-format}" \
1.110 nicm 158: "#[pop-default]" \
1.99 nicm 159: "#[norange list=on default]" \
160: "#{?window_end_flag,,#{window-status-separator}}" \
161: "}" \
1.150 nicm 162: "#[nolist align=right range=right #{E:status-right-style}]" \
1.114 nicm 163: "#[push-default]" \
164: "#{T;=/#{status-right-length}:status-right}" \
165: "#[pop-default]" \
166: "#[norange default]"
1.99 nicm 167: #define OPTIONS_TABLE_STATUS_FORMAT2 \
168: "#[align=centre]#{P:#{?pane_active,#[reverse],}" \
169: "#{pane_index}[#{pane_width}x#{pane_height}]#[default] }"
170: static const char *options_table_status_format_default[] = {
171: OPTIONS_TABLE_STATUS_FORMAT1, OPTIONS_TABLE_STATUS_FORMAT2, NULL
172: };
173:
1.116 nicm 174: /* Helpers for hook options. */
1.105 nicm 175: #define OPTIONS_TABLE_HOOK(hook_name, default_value) \
176: { .name = hook_name, \
177: .type = OPTIONS_TABLE_COMMAND, \
178: .scope = OPTIONS_TABLE_SESSION, \
179: .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
180: .default_str = default_value, \
181: .separator = "" \
182: }
183:
1.116 nicm 184: #define OPTIONS_TABLE_PANE_HOOK(hook_name, default_value) \
185: { .name = hook_name, \
186: .type = OPTIONS_TABLE_COMMAND, \
187: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE, \
188: .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
189: .default_str = default_value, \
190: .separator = "" \
191: }
192:
193: #define OPTIONS_TABLE_WINDOW_HOOK(hook_name, default_value) \
194: { .name = hook_name, \
195: .type = OPTIONS_TABLE_COMMAND, \
196: .scope = OPTIONS_TABLE_WINDOW, \
197: .flags = OPTIONS_TABLE_IS_ARRAY|OPTIONS_TABLE_IS_HOOK, \
198: .default_str = default_value, \
199: .separator = "" \
200: }
1.134 nicm 201:
202: /* Map of name conversions. */
203: const struct options_name_map options_other_names[] = {
204: { "display-panes-color", "display-panes-colour" },
205: { "display-panes-active-color", "display-panes-active-colour" },
206: { "clock-mode-color", "clock-mode-colour" },
1.153 nicm 207: { "cursor-color", "cursor-colour" },
1.149 nicm 208: { "pane-colors", "pane-colours" },
1.134 nicm 209: { NULL, NULL }
210: };
1.116 nicm 211:
1.80 nicm 212: /* Top-level options. */
1.67 nicm 213: const struct options_table_entry options_table[] = {
1.105 nicm 214: /* Server options. */
1.112 nicm 215: { .name = "backspace",
216: .type = OPTIONS_TABLE_KEY,
217: .scope = OPTIONS_TABLE_SERVER,
218: .default_num = '\177',
1.127 nicm 219: .text = "The key to send for backspace."
1.112 nicm 220: },
221:
1.1 nicm 222: { .name = "buffer-limit",
223: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 224: .scope = OPTIONS_TABLE_SERVER,
1.1 nicm 225: .minimum = 1,
226: .maximum = INT_MAX,
1.127 nicm 227: .default_num = 50,
228: .text = "The maximum number of automatic buffers. "
229: "When this is reached, the oldest buffer is deleted."
1.83 nicm 230: },
231:
232: { .name = "command-alias",
1.104 nicm 233: .type = OPTIONS_TABLE_STRING,
1.83 nicm 234: .scope = OPTIONS_TABLE_SERVER,
1.104 nicm 235: .flags = OPTIONS_TABLE_IS_ARRAY,
1.83 nicm 236: .default_str = "split-pane=split-window,"
1.84 nicm 237: "splitp=split-window,"
238: "server-info=show-messages -JT,"
1.88 nicm 239: "info=show-messages -JT,"
240: "choose-window=choose-tree -w,"
241: "choose-session=choose-tree -s",
1.127 nicm 242: .separator = ",",
243: .text = "Array of command aliases. "
244: "Each entry is an alias and a command separated by '='."
1.117 nicm 245: },
246:
247: { .name = "copy-command",
248: .type = OPTIONS_TABLE_STRING,
249: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 250: .default_str = "",
251: .text = "Shell command run when text is copied. "
252: "If empty, no command is run."
1.153 nicm 253: },
254:
255: { .name = "cursor-colour",
256: .type = OPTIONS_TABLE_COLOUR,
257: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
258: .default_num = -1,
259: .text = "Colour of the cursor."
1.154 nicm 260: },
261:
262: { .name = "cursor-style",
263: .type = OPTIONS_TABLE_CHOICE,
264: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
265: .choices = options_table_cursor_style_list,
266: .default_num = 0,
267: .text = "Style of the cursor."
1.81 nicm 268: },
269:
1.56 nicm 270: { .name = "default-terminal",
271: .type = OPTIONS_TABLE_STRING,
1.67 nicm 272: .scope = OPTIONS_TABLE_SERVER,
1.145 nicm 273: .default_str = TMUX_TERM,
1.127 nicm 274: .text = "Default for the 'TERM' environment variable."
1.125 nicm 275: },
276:
277: { .name = "editor",
278: .type = OPTIONS_TABLE_STRING,
279: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 280: .default_str = _PATH_VI,
281: .text = "Editor run to edit files."
1.56 nicm 282: },
283:
1.1 nicm 284: { .name = "escape-time",
285: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 286: .scope = OPTIONS_TABLE_SERVER,
1.1 nicm 287: .minimum = 0,
288: .maximum = INT_MAX,
1.170 ! nicm 289: .default_num = 10,
1.162 nicm 290: .unit = "milliseconds",
1.127 nicm 291: .text = "Time to wait before assuming a key is Escape."
1.95 nicm 292: },
293:
294: { .name = "exit-empty",
295: .type = OPTIONS_TABLE_FLAG,
296: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 297: .default_num = 1,
298: .text = "Whether the server should exit if there are no sessions."
1.1 nicm 299: },
300:
301: { .name = "exit-unattached",
1.38 nicm 302: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 303: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 304: .default_num = 0,
305: .text = "Whether the server should exit if there are no attached "
306: "clients."
1.131 nicm 307: },
308:
309: { .name = "extended-keys",
1.141 nicm 310: .type = OPTIONS_TABLE_CHOICE,
1.131 nicm 311: .scope = OPTIONS_TABLE_SERVER,
1.141 nicm 312: .choices = options_table_extended_keys_list,
1.131 nicm 313: .default_num = 0,
314: .text = "Whether to request extended key sequences from terminals "
1.157 nicm 315: "that support it."
1.38 nicm 316: },
317:
318: { .name = "focus-events",
1.1 nicm 319: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 320: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 321: .default_num = 0,
322: .text = "Whether to send focus events to applications."
1.61 nicm 323: },
324:
325: { .name = "history-file",
326: .type = OPTIONS_TABLE_STRING,
1.67 nicm 327: .scope = OPTIONS_TABLE_SERVER,
1.127 nicm 328: .default_str = "",
329: .text = "Location of the command prompt history file. "
330: "Empty does not write a history file."
1.166 nicm 331: },
332:
333: { .name = "menu-style",
334: .type = OPTIONS_TABLE_STRING,
335: .scope = OPTIONS_TABLE_WINDOW,
336: .flags = OPTIONS_TABLE_IS_STYLE,
337: .default_str = "default",
338: .separator = ",",
339: .text = "Default style of menu."
340: },
341:
1.167 nicm 342: { .name = "menu-selected-style",
343: .type = OPTIONS_TABLE_STRING,
344: .scope = OPTIONS_TABLE_WINDOW,
345: .flags = OPTIONS_TABLE_IS_STYLE,
346: .default_str = "bg=yellow,fg=black",
347: .separator = ",",
348: .text = "Default style of selected menu item."
349: },
350:
1.166 nicm 351: { .name = "menu-border-style",
352: .type = OPTIONS_TABLE_STRING,
353: .scope = OPTIONS_TABLE_WINDOW,
354: .default_str = "default",
355: .flags = OPTIONS_TABLE_IS_STYLE,
356: .separator = ",",
357: .text = "Default style of menu borders."
358: },
359:
360: { .name = "menu-border-lines",
361: .type = OPTIONS_TABLE_CHOICE,
362: .scope = OPTIONS_TABLE_WINDOW,
363: .choices = options_table_popup_border_lines_list,
364: .default_num = BOX_LINES_SINGLE,
365: .text = "Type of characters used to draw menu border lines. Some of "
366: "these are only supported on terminals with UTF-8 support."
1.1 nicm 367: },
368:
1.46 nicm 369: { .name = "message-limit",
370: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 371: .scope = OPTIONS_TABLE_SERVER,
1.46 nicm 372: .minimum = 0,
373: .maximum = INT_MAX,
1.127 nicm 374: .default_num = 1000,
375: .text = "Maximum number of server messages to keep."
1.142 nicm 376: },
377:
378: { .name = "prompt-history-limit",
379: .type = OPTIONS_TABLE_NUMBER,
380: .scope = OPTIONS_TABLE_SERVER,
381: .minimum = 0,
382: .maximum = INT_MAX,
383: .default_num = 100,
384: .text = "Maximum number of commands to keep in history."
1.1 nicm 385: },
386:
1.8 nicm 387: { .name = "set-clipboard",
1.89 nicm 388: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 389: .scope = OPTIONS_TABLE_SERVER,
1.89 nicm 390: .choices = options_table_set_clipboard_list,
1.127 nicm 391: .default_num = 1,
392: .text = "Whether to attempt to set the system clipboard ('on' or "
393: "'external') and whether to allow applications to create "
394: "paste buffers with an escape sequence ('on' only)."
1.8 nicm 395: },
396:
1.45 nicm 397: { .name = "terminal-overrides",
1.104 nicm 398: .type = OPTIONS_TABLE_STRING,
1.67 nicm 399: .scope = OPTIONS_TABLE_SERVER,
1.104 nicm 400: .flags = OPTIONS_TABLE_IS_ARRAY,
1.122 nicm 401: .default_str = "",
1.127 nicm 402: .separator = ",",
403: .text = "List of terminal capabilities overrides."
1.118 nicm 404: },
405:
406: { .name = "terminal-features",
407: .type = OPTIONS_TABLE_STRING,
408: .scope = OPTIONS_TABLE_SERVER,
409: .flags = OPTIONS_TABLE_IS_ARRAY,
1.132 nicm 410: .default_str = "xterm*:clipboard:ccolour:cstyle:focus:title,"
1.163 nicm 411: "screen*:title,"
412: "rxvt*:ignorefkeys",
1.127 nicm 413: .separator = ",",
414: .text = "List of terminal features, used if they cannot be "
415: "automatically detected."
1.90 nicm 416: },
417:
418: { .name = "user-keys",
1.104 nicm 419: .type = OPTIONS_TABLE_STRING,
1.90 nicm 420: .scope = OPTIONS_TABLE_SERVER,
1.104 nicm 421: .flags = OPTIONS_TABLE_IS_ARRAY,
1.90 nicm 422: .default_str = "",
1.127 nicm 423: .separator = ",",
424: .text = "User key assignments. "
425: "Each sequence in the list is translated into a key: "
426: "'User0', 'User1' and so on."
1.45 nicm 427: },
428:
1.105 nicm 429: /* Session options. */
1.91 nicm 430: { .name = "activity-action",
431: .type = OPTIONS_TABLE_CHOICE,
432: .scope = OPTIONS_TABLE_SESSION,
433: .choices = options_table_bell_action_list,
1.127 nicm 434: .default_num = ALERT_OTHER,
435: .text = "Action to take on an activity alert."
1.91 nicm 436: },
437:
1.31 nicm 438: { .name = "assume-paste-time",
439: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 440: .scope = OPTIONS_TABLE_SESSION,
1.31 nicm 441: .minimum = 0,
442: .maximum = INT_MAX,
443: .default_num = 1,
1.127 nicm 444: .unit = "milliseconds",
1.144 nicm 445: .text = "Maximum time between input to assume it is pasting rather "
1.127 nicm 446: "than typing."
1.31 nicm 447: },
448:
1.1 nicm 449: { .name = "base-index",
450: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 451: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 452: .minimum = 0,
453: .maximum = INT_MAX,
1.127 nicm 454: .default_num = 0,
455: .text = "Default index of the first window in each session."
1.1 nicm 456: },
457:
458: { .name = "bell-action",
459: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 460: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 461: .choices = options_table_bell_action_list,
1.127 nicm 462: .default_num = ALERT_ANY,
463: .text = "Action to take on a bell alert."
1.11 nicm 464: },
465:
1.1 nicm 466: { .name = "default-command",
467: .type = OPTIONS_TABLE_STRING,
1.67 nicm 468: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 469: .default_str = "",
470: .text = "Default command to run in new panes. If empty, a shell is "
471: "started."
1.1 nicm 472: },
473:
474: { .name = "default-shell",
475: .type = OPTIONS_TABLE_STRING,
1.67 nicm 476: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 477: .default_str = _PATH_BSHELL,
478: .text = "Location of default shell."
1.1 nicm 479: },
480:
1.97 nicm 481: { .name = "default-size",
482: .type = OPTIONS_TABLE_STRING,
483: .scope = OPTIONS_TABLE_SESSION,
484: .pattern = "[0-9]*x[0-9]*",
1.127 nicm 485: .default_str = "80x24",
486: .text = "Initial size of new sessions."
1.97 nicm 487: },
488:
1.1 nicm 489: { .name = "destroy-unattached",
1.169 nicm 490: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 491: .scope = OPTIONS_TABLE_SESSION,
1.169 nicm 492: .choices = options_table_destroy_unattached_list,
1.127 nicm 493: .default_num = 0,
494: .text = "Whether to destroy sessions when they have no attached "
1.169 nicm 495: "clients, or keep the last session whether in the group."
1.1 nicm 496: },
497:
498: { .name = "detach-on-destroy",
1.139 nicm 499: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 500: .scope = OPTIONS_TABLE_SESSION,
1.139 nicm 501: .choices = options_table_detach_on_destroy_list,
1.127 nicm 502: .default_num = 1,
503: .text = "Whether to detach when a session is destroyed, or switch "
504: "the client to another session if any exist."
1.1 nicm 505: },
506:
507: { .name = "display-panes-active-colour",
508: .type = OPTIONS_TABLE_COLOUR,
1.67 nicm 509: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 510: .default_num = 1,
511: .text = "Colour of the active pane for 'display-panes'."
1.1 nicm 512: },
513:
514: { .name = "display-panes-colour",
515: .type = OPTIONS_TABLE_COLOUR,
1.67 nicm 516: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 517: .default_num = 4,
518: .text = "Colour of not active panes for 'display-panes'."
1.1 nicm 519: },
520:
521: { .name = "display-panes-time",
522: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 523: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 524: .minimum = 1,
525: .maximum = INT_MAX,
1.127 nicm 526: .default_num = 1000,
527: .unit = "milliseconds",
528: .text = "Time for which 'display-panes' should show pane numbers."
1.1 nicm 529: },
530:
531: { .name = "display-time",
532: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 533: .scope = OPTIONS_TABLE_SESSION,
1.68 tim 534: .minimum = 0,
1.1 nicm 535: .maximum = INT_MAX,
1.127 nicm 536: .default_num = 750,
537: .unit = "milliseconds",
538: .text = "Time for which status line messages should appear."
1.1 nicm 539: },
540:
541: { .name = "history-limit",
542: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 543: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 544: .minimum = 0,
1.3 nicm 545: .maximum = INT_MAX,
1.127 nicm 546: .default_num = 2000,
547: .unit = "lines",
548: .text = "Maximum number of lines to keep in the history for each "
549: "pane. "
550: "If changed, the new value applies only to new panes."
1.70 nicm 551: },
552:
553: { .name = "key-table",
554: .type = OPTIONS_TABLE_STRING,
555: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 556: .default_str = "root",
557: .text = "Default key table. "
558: "Key presses are first looked up in this table."
1.1 nicm 559: },
560:
561: { .name = "lock-after-time",
562: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 563: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 564: .minimum = 0,
565: .maximum = INT_MAX,
1.127 nicm 566: .default_num = 0,
567: .unit = "seconds",
568: .text = "Time after which a client is locked if not used."
1.1 nicm 569: },
570:
571: { .name = "lock-command",
572: .type = OPTIONS_TABLE_STRING,
1.67 nicm 573: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 574: .default_str = "lock -np",
575: .text = "Shell command to run to lock a client."
1.1 nicm 576: },
577:
1.43 nicm 578: { .name = "message-command-style",
1.123 nicm 579: .type = OPTIONS_TABLE_STRING,
1.67 nicm 580: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 581: .default_str = "bg=black,fg=yellow",
582: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 583: .separator = ",",
584: .text = "Style of the command prompt when in command mode, if "
585: "'mode-keys' is set to 'vi'."
1.1 nicm 586: },
587:
1.165 nicm 588: { .name = "message-line",
589: .type = OPTIONS_TABLE_CHOICE,
590: .scope = OPTIONS_TABLE_SESSION,
591: .choices = options_table_message_line_list,
592: .default_num = 0,
593: .text = "Position (line) of messages and the command prompt."
594: },
595:
1.43 nicm 596: { .name = "message-style",
1.123 nicm 597: .type = OPTIONS_TABLE_STRING,
1.67 nicm 598: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 599: .default_str = "bg=yellow,fg=black",
600: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 601: .separator = ",",
1.165 nicm 602: .text = "Style of messages and the command prompt."
1.43 nicm 603: },
604:
1.55 nicm 605: { .name = "mouse",
1.1 nicm 606: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 607: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 608: .default_num = 0,
609: .text = "Whether the mouse is recognised and mouse key bindings are "
610: "executed. "
611: "Applications inside panes can use the mouse even when 'off'."
1.1 nicm 612: },
613:
614: { .name = "prefix",
1.19 nicm 615: .type = OPTIONS_TABLE_KEY,
1.67 nicm 616: .scope = OPTIONS_TABLE_SESSION,
1.19 nicm 617: .default_num = '\002',
1.127 nicm 618: .text = "The prefix key."
1.19 nicm 619: },
620:
621: { .name = "prefix2",
622: .type = OPTIONS_TABLE_KEY,
1.67 nicm 623: .scope = OPTIONS_TABLE_SESSION,
1.19 nicm 624: .default_num = KEYC_NONE,
1.127 nicm 625: .text = "A second prefix key."
1.29 nicm 626: },
627:
628: { .name = "renumber-windows",
629: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 630: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 631: .default_num = 0,
632: .text = "Whether windows are automatically renumbered rather than "
633: "leaving gaps."
1.1 nicm 634: },
635:
636: { .name = "repeat-time",
637: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 638: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 639: .minimum = 0,
640: .maximum = SHRT_MAX,
1.127 nicm 641: .default_num = 500,
642: .unit = "milliseconds",
643: .text = "Time to wait for a key binding to repeat, if it is bound "
644: "with the '-r' flag."
1.1 nicm 645: },
646:
647: { .name = "set-titles",
648: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 649: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 650: .default_num = 0,
651: .text = "Whether to set the terminal title, if supported."
1.1 nicm 652: },
653:
654: { .name = "set-titles-string",
655: .type = OPTIONS_TABLE_STRING,
1.67 nicm 656: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 657: .default_str = "#S:#I:#W - \"#T\" #{session_alerts}",
658: .text = "Format of the terminal title to set."
1.1 nicm 659: },
660:
1.91 nicm 661: { .name = "silence-action",
662: .type = OPTIONS_TABLE_CHOICE,
663: .scope = OPTIONS_TABLE_SESSION,
664: .choices = options_table_bell_action_list,
1.127 nicm 665: .default_num = ALERT_OTHER,
666: .text = "Action to take on a silence alert."
1.91 nicm 667: },
668:
1.1 nicm 669: { .name = "status",
1.99 nicm 670: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 671: .scope = OPTIONS_TABLE_SESSION,
1.99 nicm 672: .choices = options_table_status_list,
1.127 nicm 673: .default_num = 1,
674: .text = "Number of lines in the status line."
1.1 nicm 675: },
676:
677: { .name = "status-bg",
678: .type = OPTIONS_TABLE_COLOUR,
1.67 nicm 679: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 680: .default_num = 8,
1.127 nicm 681: .text = "Background colour of the status line. This option is "
682: "deprecated, use 'status-style' instead."
1.1 nicm 683: },
684:
685: { .name = "status-fg",
686: .type = OPTIONS_TABLE_COLOUR,
1.67 nicm 687: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 688: .default_num = 8,
1.127 nicm 689: .text = "Foreground colour of the status line. This option is "
690: "deprecated, use 'status-style' instead."
1.99 nicm 691: },
692:
693: { .name = "status-format",
1.104 nicm 694: .type = OPTIONS_TABLE_STRING,
1.99 nicm 695: .scope = OPTIONS_TABLE_SESSION,
1.104 nicm 696: .flags = OPTIONS_TABLE_IS_ARRAY,
1.99 nicm 697: .default_arr = options_table_status_format_default,
1.127 nicm 698: .text = "Formats for the status lines. "
699: "Each array member is the format for one status line. "
700: "The default status line is made up of several components "
1.144 nicm 701: "which may be configured individually with other options such "
1.127 nicm 702: "as 'status-left'."
1.1 nicm 703: },
704:
705: { .name = "status-interval",
706: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 707: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 708: .minimum = 0,
709: .maximum = INT_MAX,
1.127 nicm 710: .default_num = 15,
711: .unit = "seconds",
712: .text = "Number of seconds between status line updates."
1.1 nicm 713: },
714:
715: { .name = "status-justify",
716: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 717: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 718: .choices = options_table_status_justify_list,
1.127 nicm 719: .default_num = 0,
720: .text = "Position of the window list in the status line."
1.1 nicm 721: },
722:
723: { .name = "status-keys",
724: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 725: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 726: .choices = options_table_status_keys_list,
1.127 nicm 727: .default_num = MODEKEY_EMACS,
728: .text = "Key set to use at the command prompt."
1.1 nicm 729: },
730:
731: { .name = "status-left",
732: .type = OPTIONS_TABLE_STRING,
1.67 nicm 733: .scope = OPTIONS_TABLE_SESSION,
1.127 nicm 734: .default_str = "[#{session_name}] ",
735: .text = "Contents of the left side of the status line."
1.1 nicm 736: },
737:
738: { .name = "status-left-length",
739: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 740: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 741: .minimum = 0,
742: .maximum = SHRT_MAX,
1.127 nicm 743: .default_num = 10,
744: .text = "Maximum width of the left side of the status line."
1.20 nicm 745: },
746:
1.43 nicm 747: { .name = "status-left-style",
1.123 nicm 748: .type = OPTIONS_TABLE_STRING,
1.67 nicm 749: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 750: .default_str = "default",
751: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 752: .separator = ",",
753: .text = "Style of the left side of the status line."
1.43 nicm 754: },
755:
1.20 nicm 756: { .name = "status-position",
757: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 758: .scope = OPTIONS_TABLE_SESSION,
1.20 nicm 759: .choices = options_table_status_position_list,
1.127 nicm 760: .default_num = 1,
761: .text = "Position of the status line."
1.1 nicm 762: },
763:
764: { .name = "status-right",
765: .type = OPTIONS_TABLE_STRING,
1.67 nicm 766: .scope = OPTIONS_TABLE_SESSION,
1.97 nicm 767: .default_str = "#{?window_bigger,"
1.127 nicm 768: "[#{window_offset_x}#,#{window_offset_y}] ,}"
769: "\"#{=21:pane_title}\" %H:%M %d-%b-%y",
770: .text = "Contents of the right side of the status line."
771:
1.1 nicm 772: },
773:
774: { .name = "status-right-length",
775: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 776: .scope = OPTIONS_TABLE_SESSION,
1.1 nicm 777: .minimum = 0,
778: .maximum = SHRT_MAX,
1.127 nicm 779: .default_num = 40,
780: .text = "Maximum width of the right side of the status line."
1.1 nicm 781: },
782:
1.43 nicm 783: { .name = "status-right-style",
1.123 nicm 784: .type = OPTIONS_TABLE_STRING,
1.67 nicm 785: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 786: .default_str = "default",
787: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 788: .separator = ",",
789: .text = "Style of the right side of the status line."
1.43 nicm 790: },
791:
792: { .name = "status-style",
1.123 nicm 793: .type = OPTIONS_TABLE_STRING,
1.67 nicm 794: .scope = OPTIONS_TABLE_SESSION,
1.123 nicm 795: .default_str = "bg=green,fg=black",
796: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 797: .separator = ",",
798: .text = "Style of the status line."
1.43 nicm 799: },
800:
1.1 nicm 801: { .name = "update-environment",
1.104 nicm 802: .type = OPTIONS_TABLE_STRING,
1.67 nicm 803: .scope = OPTIONS_TABLE_SESSION,
1.104 nicm 804: .flags = OPTIONS_TABLE_IS_ARRAY,
1.96 nicm 805: .default_str = "DISPLAY KRB5CCNAME SSH_ASKPASS SSH_AUTH_SOCK "
1.127 nicm 806: "SSH_AGENT_PID SSH_CONNECTION WINDOWID XAUTHORITY",
807: .text = "List of environment variables to update in the session "
808: "environment when a client is attached."
1.1 nicm 809: },
810:
811: { .name = "visual-activity",
1.91 nicm 812: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 813: .scope = OPTIONS_TABLE_SESSION,
1.91 nicm 814: .choices = options_table_visual_bell_list,
1.127 nicm 815: .default_num = VISUAL_OFF,
816: .text = "How activity alerts should be shown: a message ('on'), "
817: "a message and a bell ('both') or nothing ('off')."
1.1 nicm 818: },
819:
820: { .name = "visual-bell",
1.91 nicm 821: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 822: .scope = OPTIONS_TABLE_SESSION,
1.91 nicm 823: .choices = options_table_visual_bell_list,
1.127 nicm 824: .default_num = VISUAL_OFF,
825: .text = "How bell alerts should be shown: a message ('on'), "
826: "a message and a bell ('both') or nothing ('off')."
1.1 nicm 827: },
828:
829: { .name = "visual-silence",
1.91 nicm 830: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 831: .scope = OPTIONS_TABLE_SESSION,
1.91 nicm 832: .choices = options_table_visual_bell_list,
1.127 nicm 833: .default_num = VISUAL_OFF,
834: .text = "How silence alerts should be shown: a message ('on'), "
835: "a message and a bell ('both') or nothing ('off')."
1.1 nicm 836: },
837:
1.16 nicm 838: { .name = "word-separators",
839: .type = OPTIONS_TABLE_STRING,
1.67 nicm 840: .scope = OPTIONS_TABLE_SESSION,
1.143 nicm 841: /*
842: * The set of non-alphanumeric printable ASCII characters minus the
843: * underscore.
844: */
845: .default_str = "!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~",
1.127 nicm 846: .text = "Characters considered to separate words."
1.16 nicm 847: },
848:
1.105 nicm 849: /* Window options. */
1.1 nicm 850: { .name = "aggressive-resize",
851: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 852: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 853: .default_num = 0,
854: .text = "When 'window-size' is 'smallest', whether the maximum size "
855: "of a window is the smallest attached session where it is "
856: "the current window ('on') or the smallest session it is "
857: "linked to ('off')."
1.17 nicm 858: },
859:
1.157 nicm 860: { .name = "allow-passthrough",
1.164 nicm 861: .type = OPTIONS_TABLE_CHOICE,
1.157 nicm 862: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.164 nicm 863: .choices = options_table_allow_passthrough_list,
1.157 nicm 864: .default_num = 0,
865: .text = "Whether applications are allowed to use the escape sequence "
1.164 nicm 866: "to bypass tmux. Can be 'off' (disallowed), 'on' (allowed "
867: "if the pane is visible), or 'all' (allowed even if the pane "
868: "is invisible)."
1.157 nicm 869: },
870:
1.17 nicm 871: { .name = "allow-rename",
872: .type = OPTIONS_TABLE_FLAG,
1.108 nicm 873: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.127 nicm 874: .default_num = 0,
875: .text = "Whether applications are allowed to use the escape sequence "
876: "to rename windows."
1.1 nicm 877: },
878:
879: { .name = "alternate-screen",
880: .type = OPTIONS_TABLE_FLAG,
1.108 nicm 881: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.127 nicm 882: .default_num = 1,
883: .text = "Whether applications are allowed to use the alternate "
884: "screen."
1.1 nicm 885: },
886:
887: { .name = "automatic-rename",
888: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 889: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 890: .default_num = 1,
891: .text = "Whether windows are automatically renamed."
1.41 nicm 892: },
893:
894: { .name = "automatic-rename-format",
895: .type = OPTIONS_TABLE_STRING,
1.67 nicm 896: .scope = OPTIONS_TABLE_WINDOW,
1.50 nicm 897: .default_str = "#{?pane_in_mode,[tmux],#{pane_current_command}}"
1.127 nicm 898: "#{?pane_dead,[dead],}",
899: .text = "Format used to automatically rename windows."
1.1 nicm 900: },
901:
902: { .name = "clock-mode-colour",
903: .type = OPTIONS_TABLE_COLOUR,
1.67 nicm 904: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 905: .default_num = 4,
906: .text = "Colour of the clock in clock mode."
1.1 nicm 907: },
908:
909: { .name = "clock-mode-style",
910: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 911: .scope = OPTIONS_TABLE_WINDOW,
1.1 nicm 912: .choices = options_table_clock_mode_style_list,
1.127 nicm 913: .default_num = 1,
914: .text = "Time format of the clock in clock mode."
1.124 nicm 915: },
916:
917: { .name = "copy-mode-match-style",
918: .type = OPTIONS_TABLE_STRING,
919: .scope = OPTIONS_TABLE_WINDOW,
920: .default_str = "bg=cyan,fg=black",
921: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 922: .separator = ",",
923: .text = "Style of search matches in copy mode."
1.124 nicm 924: },
925:
926: { .name = "copy-mode-current-match-style",
927: .type = OPTIONS_TABLE_STRING,
928: .scope = OPTIONS_TABLE_WINDOW,
929: .default_str = "bg=magenta,fg=black",
930: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 931: .separator = ",",
932: .text = "Style of the current search match in copy mode."
1.128 nicm 933: },
934:
935: { .name = "copy-mode-mark-style",
936: .type = OPTIONS_TABLE_STRING,
937: .scope = OPTIONS_TABLE_WINDOW,
938: .default_str = "bg=red,fg=black",
939: .flags = OPTIONS_TABLE_IS_STYLE,
940: .separator = ",",
941: .text = "Style of the marked line in copy mode."
1.160 nicm 942: },
943:
944: { .name = "fill-character",
945: .type = OPTIONS_TABLE_STRING,
946: .scope = OPTIONS_TABLE_WINDOW,
947: .default_str = "",
948: .text = "Character used to fill unused parts of window."
1.1 nicm 949: },
950:
951: { .name = "main-pane-height",
1.120 nicm 952: .type = OPTIONS_TABLE_STRING,
1.67 nicm 953: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 954: .default_str = "24",
955: .text = "Height of the main pane in the 'main-horizontal' layout. "
956: "This may be a percentage, for example '10%'."
1.1 nicm 957: },
958:
959: { .name = "main-pane-width",
1.120 nicm 960: .type = OPTIONS_TABLE_STRING,
1.67 nicm 961: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 962: .default_str = "80",
963: .text = "Width of the main pane in the 'main-vertical' layout. "
964: "This may be a percentage, for example '10%'."
1.1 nicm 965: },
966:
967: { .name = "mode-keys",
968: .type = OPTIONS_TABLE_CHOICE,
1.67 nicm 969: .scope = OPTIONS_TABLE_WINDOW,
1.1 nicm 970: .choices = options_table_mode_keys_list,
1.127 nicm 971: .default_num = MODEKEY_EMACS,
972: .text = "Key set used in copy mode."
1.1 nicm 973: },
974:
1.43 nicm 975: { .name = "mode-style",
1.123 nicm 976: .type = OPTIONS_TABLE_STRING,
1.67 nicm 977: .scope = OPTIONS_TABLE_WINDOW,
1.167 nicm 978: .flags = OPTIONS_TABLE_IS_STYLE,
1.123 nicm 979: .default_str = "bg=yellow,fg=black",
1.127 nicm 980: .separator = ",",
981: .text = "Style of indicators and highlighting in modes."
1.43 nicm 982: },
983:
1.1 nicm 984: { .name = "monitor-activity",
985: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 986: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 987: .default_num = 0,
988: .text = "Whether an alert is triggered by activity."
1.93 nicm 989: },
990:
991: { .name = "monitor-bell",
992: .type = OPTIONS_TABLE_FLAG,
993: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 994: .default_num = 1,
995: .text = "Whether an alert is triggered by a bell."
1.1 nicm 996: },
997:
998: { .name = "monitor-silence",
999: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 1000: .scope = OPTIONS_TABLE_WINDOW,
1.1 nicm 1001: .minimum = 0,
1002: .maximum = INT_MAX,
1.127 nicm 1003: .default_num = 0,
1004: .text = "Time after which an alert is triggered by silence. "
1005: "Zero means no alert."
1006:
1.1 nicm 1007: },
1008:
1009: { .name = "other-pane-height",
1.120 nicm 1010: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1011: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 1012: .default_str = "0",
1013: .text = "Height of the other panes in the 'main-horizontal' layout. "
1014: "This may be a percentage, for example '10%'."
1.1 nicm 1015: },
1016:
1017: { .name = "other-pane-width",
1.120 nicm 1018: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1019: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 1020: .default_str = "0",
1021: .text = "Height of the other panes in the 'main-vertical' layout. "
1022: "This may be a percentage, for example '10%'."
1.13 nicm 1023: },
1024:
1.53 nicm 1025: { .name = "pane-active-border-style",
1.123 nicm 1026: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1027: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1028: .default_str = "#{?pane_in_mode,fg=yellow,#{?synchronize-panes,fg=red,fg=green}}",
1029: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1030: .separator = ",",
1031: .text = "Style of the active pane border."
1.53 nicm 1032: },
1033:
1.13 nicm 1034: { .name = "pane-base-index",
1035: .type = OPTIONS_TABLE_NUMBER,
1.67 nicm 1036: .scope = OPTIONS_TABLE_WINDOW,
1.13 nicm 1037: .minimum = 0,
1038: .maximum = USHRT_MAX,
1.127 nicm 1039: .default_num = 0,
1040: .text = "Index of the first pane in each window."
1.53 nicm 1041: },
1042:
1.72 nicm 1043: { .name = "pane-border-format",
1044: .type = OPTIONS_TABLE_STRING,
1.155 nicm 1045: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.73 nicm 1046: .default_str = "#{?pane_active,#[reverse],}#{pane_index}#[default] "
1.127 nicm 1047: "\"#{pane_title}\"",
1048: .text = "Format of text in the pane status lines."
1.156 nicm 1049: },
1050:
1051: { .name = "pane-border-indicators",
1052: .type = OPTIONS_TABLE_CHOICE,
1053: .scope = OPTIONS_TABLE_WINDOW,
1054: .choices = options_table_pane_border_indicators_list,
1055: .default_num = PANE_BORDER_COLOUR,
1056: .text = "Whether to indicate the active pane by colouring border or "
1057: "displaying arrow markers."
1.129 nicm 1058: },
1059:
1060: { .name = "pane-border-lines",
1061: .type = OPTIONS_TABLE_CHOICE,
1062: .scope = OPTIONS_TABLE_WINDOW,
1.152 nicm 1063: .choices = options_table_pane_border_lines_list,
1.129 nicm 1064: .default_num = PANE_LINES_SINGLE,
1.144 nicm 1065: .text = "Type of characters used to draw pane border lines. Some of "
1.157 nicm 1066: "these are only supported on terminals with UTF-8 support."
1.72 nicm 1067: },
1068:
1069: { .name = "pane-border-status",
1070: .type = OPTIONS_TABLE_CHOICE,
1071: .scope = OPTIONS_TABLE_WINDOW,
1072: .choices = options_table_pane_status_list,
1.127 nicm 1073: .default_num = PANE_STATUS_OFF,
1074: .text = "Position of the pane status lines."
1.53 nicm 1075: },
1076:
1077: { .name = "pane-border-style",
1.123 nicm 1078: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1079: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1080: .default_str = "default",
1081: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1082: .separator = ",",
1083: .text = "Style of the pane status lines."
1.149 nicm 1084: },
1085:
1086: { .name = "pane-colours",
1087: .type = OPTIONS_TABLE_COLOUR,
1088: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1089: .default_str = "",
1090: .flags = OPTIONS_TABLE_IS_ARRAY,
1091: .text = "The default colour palette for colours zero to 255."
1.151 nicm 1092: },
1093:
1094: { .name = "popup-style",
1095: .type = OPTIONS_TABLE_STRING,
1096: .scope = OPTIONS_TABLE_WINDOW,
1097: .default_str = "default",
1098: .flags = OPTIONS_TABLE_IS_STYLE,
1099: .separator = ",",
1100: .text = "Default style of popups."
1101: },
1102:
1103: { .name = "popup-border-style",
1104: .type = OPTIONS_TABLE_STRING,
1105: .scope = OPTIONS_TABLE_WINDOW,
1106: .default_str = "default",
1107: .flags = OPTIONS_TABLE_IS_STYLE,
1108: .separator = ",",
1109: .text = "Default style of popup borders."
1.152 nicm 1110: },
1111:
1112: { .name = "popup-border-lines",
1113: .type = OPTIONS_TABLE_CHOICE,
1114: .scope = OPTIONS_TABLE_WINDOW,
1115: .choices = options_table_popup_border_lines_list,
1116: .default_num = BOX_LINES_SINGLE,
1117: .text = "Type of characters used to draw popup border lines. Some of "
1.157 nicm 1118: "these are only supported on terminals with UTF-8 support."
1.22 nicm 1119: },
1120:
1.1 nicm 1121: { .name = "remain-on-exit",
1.137 nicm 1122: .type = OPTIONS_TABLE_CHOICE,
1.107 nicm 1123: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.137 nicm 1124: .choices = options_table_remain_on_exit_list,
1.127 nicm 1125: .default_num = 0,
1126: .text = "Whether panes should remain ('on') or be automatically "
1.137 nicm 1127: "killed ('off' or 'failed') when the program inside exits."
1.159 nicm 1128: },
1129:
1130: { .name = "remain-on-exit-format",
1131: .type = OPTIONS_TABLE_STRING,
1132: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1133: .default_str = "Pane is dead ("
1134: "#{?#{!=:#{pane_dead_status},},"
1135: "status #{pane_dead_status},}"
1136: "#{?#{!=:#{pane_dead_signal},},"
1137: "signal #{pane_dead_signal},}, "
1138: "#{t:pane_dead_time})",
1139: .text = "Message shown after the program in a pane has exited, if "
1140: "remain-on-exit is enabled."
1.161 nicm 1141: },
1142:
1143: { .name = "scroll-on-clear",
1144: .type = OPTIONS_TABLE_FLAG,
1145: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1146: .default_num = 1,
1147: .text = "Whether the contents of the screen should be scrolled into"
1148: "history when clearing the whole screen."
1.1 nicm 1149: },
1150:
1151: { .name = "synchronize-panes",
1152: .type = OPTIONS_TABLE_FLAG,
1.136 nicm 1153: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.127 nicm 1154: .default_num = 0,
1155: .text = "Whether typing should be sent to all panes simultaneously."
1.54 nicm 1156: },
1157:
1158: { .name = "window-active-style",
1.123 nicm 1159: .type = OPTIONS_TABLE_STRING,
1.107 nicm 1160: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.123 nicm 1161: .default_str = "default",
1162: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1163: .separator = ",",
1164: .text = "Default style of the active pane."
1.97 nicm 1165: },
1166:
1167: { .name = "window-size",
1168: .type = OPTIONS_TABLE_CHOICE,
1169: .scope = OPTIONS_TABLE_WINDOW,
1170: .choices = options_table_window_size_list,
1.127 nicm 1171: .default_num = WINDOW_SIZE_LATEST,
1172: .text = "How window size is calculated. "
1173: "'latest' uses the size of the most recently used client, "
1174: "'largest' the largest client, 'smallest' the smallest "
1175: "client and 'manual' a size set by the 'resize-window' "
1176: "command."
1.54 nicm 1177: },
1178:
1179: { .name = "window-style",
1.123 nicm 1180: .type = OPTIONS_TABLE_STRING,
1.107 nicm 1181: .scope = OPTIONS_TABLE_WINDOW|OPTIONS_TABLE_PANE,
1.123 nicm 1182: .default_str = "default",
1183: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1184: .separator = ",",
1185: .text = "Default style of panes that are not the active pane."
1.1 nicm 1186: },
1187:
1.43 nicm 1188: { .name = "window-status-activity-style",
1.123 nicm 1189: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1190: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1191: .default_str = "reverse",
1192: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1193: .separator = ",",
1194: .text = "Style of windows in the status line with an activity alert."
1.43 nicm 1195: },
1196:
1197: { .name = "window-status-bell-style",
1.123 nicm 1198: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1199: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1200: .default_str = "reverse",
1201: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1202: .separator = ",",
1203: .text = "Style of windows in the status line with a bell alert."
1.43 nicm 1204: },
1205:
1.1 nicm 1206: { .name = "window-status-current-format",
1207: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1208: .scope = OPTIONS_TABLE_WINDOW,
1.138 nicm 1209: .default_str = "#I:#W#{?window_flags,#{window_flags}, }",
1.127 nicm 1210: .text = "Format of the current window in the status line."
1.30 nicm 1211: },
1212:
1.43 nicm 1213: { .name = "window-status-current-style",
1.123 nicm 1214: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1215: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1216: .default_str = "default",
1217: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1218: .separator = ",",
1219: .text = "Style of the current window in the status line."
1.43 nicm 1220: },
1221:
1222: { .name = "window-status-format",
1223: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1224: .scope = OPTIONS_TABLE_WINDOW,
1.138 nicm 1225: .default_str = "#I:#W#{?window_flags,#{window_flags}, }",
1.127 nicm 1226: .text = "Format of windows in the status line, except the current "
1227: "window."
1.1 nicm 1228: },
1229:
1.43 nicm 1230: { .name = "window-status-last-style",
1.123 nicm 1231: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1232: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1233: .default_str = "default",
1234: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1235: .separator = ",",
1236: .text = "Style of the last window in the status line."
1.1 nicm 1237: },
1238:
1.43 nicm 1239: { .name = "window-status-separator",
1.1 nicm 1240: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1241: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 1242: .default_str = " ",
1243: .text = "Separator between windows in the status line."
1.28 nicm 1244: },
1245:
1.43 nicm 1246: { .name = "window-status-style",
1.123 nicm 1247: .type = OPTIONS_TABLE_STRING,
1.67 nicm 1248: .scope = OPTIONS_TABLE_WINDOW,
1.123 nicm 1249: .default_str = "default",
1250: .flags = OPTIONS_TABLE_IS_STYLE,
1.127 nicm 1251: .separator = ",",
1252: .text = "Style of windows in the status line, except the current and "
1253: "last windows."
1.24 nicm 1254: },
1255:
1256: { .name = "wrap-search",
1257: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 1258: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 1259: .default_num = 1,
1260: .text = "Whether searching in copy mode should wrap at the top or "
1261: "bottom."
1.1 nicm 1262: },
1263:
1.130 nicm 1264: { .name = "xterm-keys", /* no longer used */
1.1 nicm 1265: .type = OPTIONS_TABLE_FLAG,
1.67 nicm 1266: .scope = OPTIONS_TABLE_WINDOW,
1.127 nicm 1267: .default_num = 1,
1.130 nicm 1268: .text = "Whether xterm-style function key sequences should be sent. "
1.157 nicm 1269: "This option is no longer used."
1.1 nicm 1270: },
1.105 nicm 1271:
1272: /* Hook options. */
1273: OPTIONS_TABLE_HOOK("after-bind-key", ""),
1274: OPTIONS_TABLE_HOOK("after-capture-pane", ""),
1275: OPTIONS_TABLE_HOOK("after-copy-mode", ""),
1276: OPTIONS_TABLE_HOOK("after-display-message", ""),
1277: OPTIONS_TABLE_HOOK("after-display-panes", ""),
1.115 nicm 1278: OPTIONS_TABLE_HOOK("after-kill-pane", ""),
1.105 nicm 1279: OPTIONS_TABLE_HOOK("after-list-buffers", ""),
1280: OPTIONS_TABLE_HOOK("after-list-clients", ""),
1281: OPTIONS_TABLE_HOOK("after-list-keys", ""),
1282: OPTIONS_TABLE_HOOK("after-list-panes", ""),
1283: OPTIONS_TABLE_HOOK("after-list-sessions", ""),
1284: OPTIONS_TABLE_HOOK("after-list-windows", ""),
1285: OPTIONS_TABLE_HOOK("after-load-buffer", ""),
1286: OPTIONS_TABLE_HOOK("after-lock-server", ""),
1287: OPTIONS_TABLE_HOOK("after-new-session", ""),
1288: OPTIONS_TABLE_HOOK("after-new-window", ""),
1289: OPTIONS_TABLE_HOOK("after-paste-buffer", ""),
1290: OPTIONS_TABLE_HOOK("after-pipe-pane", ""),
1291: OPTIONS_TABLE_HOOK("after-queue", ""),
1292: OPTIONS_TABLE_HOOK("after-refresh-client", ""),
1293: OPTIONS_TABLE_HOOK("after-rename-session", ""),
1294: OPTIONS_TABLE_HOOK("after-rename-window", ""),
1295: OPTIONS_TABLE_HOOK("after-resize-pane", ""),
1296: OPTIONS_TABLE_HOOK("after-resize-window", ""),
1297: OPTIONS_TABLE_HOOK("after-save-buffer", ""),
1298: OPTIONS_TABLE_HOOK("after-select-layout", ""),
1299: OPTIONS_TABLE_HOOK("after-select-pane", ""),
1300: OPTIONS_TABLE_HOOK("after-select-window", ""),
1301: OPTIONS_TABLE_HOOK("after-send-keys", ""),
1302: OPTIONS_TABLE_HOOK("after-set-buffer", ""),
1303: OPTIONS_TABLE_HOOK("after-set-environment", ""),
1304: OPTIONS_TABLE_HOOK("after-set-hook", ""),
1305: OPTIONS_TABLE_HOOK("after-set-option", ""),
1306: OPTIONS_TABLE_HOOK("after-show-environment", ""),
1307: OPTIONS_TABLE_HOOK("after-show-messages", ""),
1308: OPTIONS_TABLE_HOOK("after-show-options", ""),
1309: OPTIONS_TABLE_HOOK("after-split-window", ""),
1310: OPTIONS_TABLE_HOOK("after-unbind-key", ""),
1311: OPTIONS_TABLE_HOOK("alert-activity", ""),
1312: OPTIONS_TABLE_HOOK("alert-bell", ""),
1313: OPTIONS_TABLE_HOOK("alert-silence", ""),
1.147 nicm 1314: OPTIONS_TABLE_HOOK("client-active", ""),
1.105 nicm 1315: OPTIONS_TABLE_HOOK("client-attached", ""),
1316: OPTIONS_TABLE_HOOK("client-detached", ""),
1.157 nicm 1317: OPTIONS_TABLE_HOOK("client-focus-in", ""),
1318: OPTIONS_TABLE_HOOK("client-focus-out", ""),
1.105 nicm 1319: OPTIONS_TABLE_HOOK("client-resized", ""),
1320: OPTIONS_TABLE_HOOK("client-session-changed", ""),
1.116 nicm 1321: OPTIONS_TABLE_PANE_HOOK("pane-died", ""),
1322: OPTIONS_TABLE_PANE_HOOK("pane-exited", ""),
1323: OPTIONS_TABLE_PANE_HOOK("pane-focus-in", ""),
1324: OPTIONS_TABLE_PANE_HOOK("pane-focus-out", ""),
1325: OPTIONS_TABLE_PANE_HOOK("pane-mode-changed", ""),
1326: OPTIONS_TABLE_PANE_HOOK("pane-set-clipboard", ""),
1.133 nicm 1327: OPTIONS_TABLE_PANE_HOOK("pane-title-changed", ""),
1.105 nicm 1328: OPTIONS_TABLE_HOOK("session-closed", ""),
1329: OPTIONS_TABLE_HOOK("session-created", ""),
1330: OPTIONS_TABLE_HOOK("session-renamed", ""),
1331: OPTIONS_TABLE_HOOK("session-window-changed", ""),
1.116 nicm 1332: OPTIONS_TABLE_WINDOW_HOOK("window-layout-changed", ""),
1.146 nicm 1333: OPTIONS_TABLE_HOOK("window-linked", ""),
1.116 nicm 1334: OPTIONS_TABLE_WINDOW_HOOK("window-pane-changed", ""),
1335: OPTIONS_TABLE_WINDOW_HOOK("window-renamed", ""),
1.158 nicm 1336: OPTIONS_TABLE_WINDOW_HOOK("window-resized", ""),
1.146 nicm 1337: OPTIONS_TABLE_HOOK("window-unlinked", ""),
1.1 nicm 1338:
1339: { .name = NULL }
1340: };
![[BACK]](/icons/back.gif){kind=icon}
Return to options-table.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / tmux