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