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