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