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