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