kitty.conf (45691B)
1 # vim:fileencoding=utf-8:ft=conf:foldmethod=marker 2 3 #: Fonts {{{ 4 5 #: kitty has very powerful font management. You can configure 6 #: individual font faces and even specify special fonts for particular 7 #: characters. 8 9 font_family Inconsolata 10 bold_font auto 11 italic_font auto 12 bold_italic_font auto 13 14 #: You can specify different fonts for the bold/italic/bold-italic 15 #: variants. To get a full list of supported fonts use the `kitty 16 #: list-fonts` command. By default they are derived automatically, by 17 #: the OSes font system. Setting them manually is useful for font 18 #: families that have many weight variants like Book, Medium, Thick, 19 #: etc. For example:: 20 21 #: font_family Operator Mono Book 22 #: bold_font Operator Mono Medium 23 #: italic_font Operator Mono Book Italic 24 #: bold_italic_font Operator Mono Medium Italic 25 26 font_size 15.0 27 28 #: Font size (in pts) 29 30 force_ltr no 31 32 #: kitty does not support BIDI (bidirectional text), however, for RTL 33 #: scripts, words are automatically displayed in RTL. That is to say, 34 #: in an RTL script, the words "HELLO WORLD" display in kitty as 35 #: "WORLD HELLO", and if you try to select a substring of an RTL- 36 #: shaped string, you will get the character that would be there had 37 #: the the string been LTR. For example, assuming the Hebrew word 38 #: ירושלים, selecting the character that on the screen appears to be ם 39 #: actually writes into the selection buffer the character י. 40 41 #: kitty's default behavior is useful in conjunction with a filter to 42 #: reverse the word order, however, if you wish to manipulate RTL 43 #: glyphs, it can be very challenging to work with, so this option is 44 #: provided to turn it off. Furthermore, this option can be used with 45 #: the command line program GNU FriBidi 46 #: <https://github.com/fribidi/fribidi#executable> to get BIDI 47 #: support, because it will force kitty to always treat the text as 48 #: LTR, which FriBidi expects for terminals. 49 50 adjust_line_height 0 51 adjust_column_width 0 52 53 #: Change the size of each character cell kitty renders. You can use 54 #: either numbers, which are interpreted as pixels or percentages 55 #: (number followed by %), which are interpreted as percentages of the 56 #: unmodified values. You can use negative pixels or percentages less 57 #: than 100% to reduce sizes (but this might cause rendering 58 #: artifacts). 59 60 # symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols 61 62 #: Map the specified unicode codepoints to a particular font. Useful 63 #: if you need special rendering for some symbols, such as for 64 #: Powerline. Avoids the need for patched fonts. Each unicode code 65 #: point is specified in the form U+<code point in hexadecimal>. You 66 #: can specify multiple code points, separated by commas and ranges 67 #: separated by hyphens. symbol_map itself can be specified multiple 68 #: times. Syntax is:: 69 70 #: symbol_map codepoints Font Family Name 71 72 disable_ligatures never 73 74 #: Choose how you want to handle multi-character ligatures. The 75 #: default is to always render them. You can tell kitty to not render 76 #: them when the cursor is over them by using cursor to make editing 77 #: easier, or have kitty never render them at all by using always, if 78 #: you don't like them. The ligature strategy can be set per-window 79 #: either using the kitty remote control facility or by defining 80 #: shortcuts for it in kitty.conf, for example:: 81 82 #: map alt+1 disable_ligatures_in active always 83 #: map alt+2 disable_ligatures_in all never 84 #: map alt+3 disable_ligatures_in tab cursor 85 86 #: Note that this refers to programming ligatures, typically 87 #: implemented using the calt OpenType feature. For disabling general 88 #: ligatures, use the font_features setting. 89 90 font_features none 91 92 #: Choose exactly which OpenType features to enable or disable. This 93 #: is useful as some fonts might have features worthwhile in a 94 #: terminal. For example, Fira Code Retina includes a discretionary 95 #: feature, zero, which in that font changes the appearance of the 96 #: zero (0), to make it more easily distinguishable from Ø. Fira Code 97 #: Retina also includes other discretionary features known as 98 #: Stylistic Sets which have the tags ss01 through ss20. 99 100 #: Note that this code is indexed by PostScript name, and not the font 101 #: family. This allows you to define very precise feature settings; 102 #: e.g. you can disable a feature in the italic font but not in the 103 #: regular font. 104 105 #: On Linux, these are read from the FontConfig database first and 106 #: then this, setting is applied, so they can be configured in a 107 #: single, central place. 108 109 #: To get the PostScript name for a font, use kitty + list-fonts 110 #: --psnames: 111 112 #: .. code-block:: sh 113 114 #: $ kitty + list-fonts --psnames | grep Fira 115 #: Fira Code 116 #: Fira Code Bold (FiraCode-Bold) 117 #: Fira Code Light (FiraCode-Light) 118 #: Fira Code Medium (FiraCode-Medium) 119 #: Fira Code Regular (FiraCode-Regular) 120 #: Fira Code Retina (FiraCode-Retina) 121 122 #: The part in brackets is the PostScript name. 123 124 #: Enable alternate zero and oldstyle numerals:: 125 126 #: font_features FiraCode-Retina +zero +onum 127 128 #: Enable only alternate zero:: 129 130 #: font_features FiraCode-Retina +zero 131 132 #: Disable the normal ligatures, but keep the calt feature which (in 133 #: this font) breaks up monotony:: 134 135 #: font_features TT2020StyleB-Regular -liga +calt 136 137 #: In conjunction with force_ltr, you may want to disable Arabic 138 #: shaping entirely, and only look at their isolated forms if they 139 #: show up in a document. You can do this with e.g.:: 140 141 #: font_features UnifontMedium +isol -medi -fina -init 142 143 box_drawing_scale 0.001, 1, 1.5, 2 144 145 #: Change the sizes of the lines used for the box drawing unicode 146 #: characters These values are in pts. They will be scaled by the 147 #: monitor DPI to arrive at a pixel value. There must be four values 148 #: corresponding to thin, normal, thick, and very thick lines. 149 150 #: }}} 151 152 #: Cursor customization {{{ 153 # cursor #38fe27 154 155 #: Default cursor color 156 # cursor_text_color #28fe14 157 158 #: Choose the color of text under the cursor. If you want it rendered 159 #: with the background color of the cell underneath instead, use the 160 #: special keyword: background 161 162 cursor_shape block 163 164 #: The cursor shape can be one of (block, beam, underline) 165 166 cursor_beam_thickness 1.5 167 168 #: Defines the thickness of the beam cursor (in pts) 169 170 cursor_underline_thickness 2.0 171 172 #: Defines the thickness of the underline cursor (in pts) 173 174 cursor_blink_interval 0 175 176 #: The interval (in seconds) at which to blink the cursor. Set to zero 177 #: to disable blinking. Negative values mean use system default. Note 178 #: that numbers smaller than repaint_delay will be limited to 179 #: repaint_delay. 180 181 cursor_stop_blinking_after 15.0 182 183 #: Stop blinking cursor after the specified number of seconds of 184 #: keyboard inactivity. Set to zero to never stop blinking. 185 186 #: }}} 187 188 #: Scrollback {{{ 189 190 scrollback_lines 4096 191 192 #: Number of lines of history to keep in memory for scrolling back. 193 #: Memory is allocated on demand. Negative numbers are (effectively) 194 #: infinite scrollback. Note that using very large scrollback is not 195 #: recommended as it can slow down performance of the terminal and 196 #: also use large amounts of RAM. Instead, consider using 197 #: scrollback_pager_history_size. 198 199 scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER 200 201 #: Program with which to view scrollback in a new window. The 202 #: scrollback buffer is passed as STDIN to this program. If you change 203 #: it, make sure the program you use can handle ANSI escape sequences 204 #: for colors and text formatting. INPUT_LINE_NUMBER in the command 205 #: line above will be replaced by an integer representing which line 206 #: should be at the top of the screen. Similarly CURSOR_LINE and 207 #: CURSOR_COLUMN will be replaced by the current cursor position. 208 209 scrollback_pager_history_size 0 210 211 #: Separate scrollback history size, used only for browsing the 212 #: scrollback buffer (in MB). This separate buffer is not available 213 #: for interactive scrolling but will be piped to the pager program 214 #: when viewing scrollback buffer in a separate window. The current 215 #: implementation stores the data in UTF-8, so approximatively 10000 216 #: lines per megabyte at 100 chars per line, for pure ASCII text, 217 #: unformatted text. A value of zero or less disables this feature. 218 #: The maximum allowed size is 4GB. 219 220 wheel_scroll_multiplier 5.0 221 222 #: Modify the amount scrolled by the mouse wheel. Note this is only 223 #: used for low precision scrolling devices, not for high precision 224 #: scrolling on platforms such as macOS and Wayland. Use negative 225 #: numbers to change scroll direction. 226 227 touch_scroll_multiplier 1.0 228 229 #: Modify the amount scrolled by a touchpad. Note this is only used 230 #: for high precision scrolling devices on platforms such as macOS and 231 #: Wayland. Use negative numbers to change scroll direction. 232 233 #: }}} 234 235 #: Mouse {{{ 236 237 mouse_hide_wait -1 238 239 #: Hide mouse cursor after the specified number of seconds of the 240 #: mouse not being used. Set to zero to disable mouse cursor hiding. 241 #: Set to a negative value to hide the mouse cursor immediately when 242 #: typing text. Disabled by default on macOS as getting it to work 243 #: robustly with the ever-changing sea of bugs that is Cocoa is too 244 #: much effort. 245 # url_color #0000d7 246 url_style double 247 248 #: The color and style for highlighting URLs on mouse-over. url_style 249 #: can be one of: none, single, double, curly 250 251 open_url_modifiers kitty_mod 252 253 #: The modifier keys to press when clicking with the mouse on URLs to 254 #: open the URL 255 256 open_url_with default 257 258 #: The program with which to open URLs that are clicked on. The 259 #: special value default means to use the operating system's default 260 #: URL handler. 261 262 url_prefixes http https file ftp 263 264 #: The set of URL prefixes to look for when detecting a URL under the 265 #: mouse cursor. 266 267 detect_urls yes 268 269 #: Detect URLs under the mouse. Detected URLs are highlighted with an 270 #: underline and the mouse cursor becomes a hand over them. Even if 271 #: this option is disabled, URLs are still clickable. 272 273 copy_on_select no 274 275 #: Copy to clipboard or a private buffer on select. With this set to 276 #: clipboard, simply selecting text with the mouse will cause the text 277 #: to be copied to clipboard. Useful on platforms such as macOS that 278 #: do not have the concept of primary selections. You can instead 279 #: specify a name such as a1 to copy to a private kitty buffer 280 #: instead. Map a shortcut with the paste_from_buffer action to paste 281 #: from this private buffer. For example:: 282 283 #: map cmd+shift+v paste_from_buffer a1 284 285 #: Note that copying to the clipboard is a security risk, as all 286 #: programs, including websites open in your browser can read the 287 #: contents of the system clipboard. 288 289 strip_trailing_spaces never 290 291 #: Remove spaces at the end of lines when copying to clipboard. A 292 #: value of smart will do it when using normal selections, but not 293 #: rectangle selections. always will always do it. 294 295 rectangle_select_modifiers ctrl+alt 296 297 #: The modifiers to use rectangular selection (i.e. to select text in 298 #: a rectangular block with the mouse) 299 300 terminal_select_modifiers shift 301 302 #: The modifiers to override mouse selection even when a terminal 303 #: application has grabbed the mouse 304 305 select_by_word_characters @-./_~?&=%+# 306 307 #: Characters considered part of a word when double clicking. In 308 #: addition to these characters any character that is marked as an 309 #: alphanumeric character in the unicode database will be matched. 310 311 click_interval -1.0 312 313 #: The interval between successive clicks to detect double/triple 314 #: clicks (in seconds). Negative numbers will use the system default 315 #: instead, if available, or fallback to 0.5. 316 317 focus_follows_mouse no 318 319 #: Set the active window to the window under the mouse when moving the 320 #: mouse around 321 322 pointer_shape_when_grabbed arrow 323 324 #: The shape of the mouse pointer when the program running in the 325 #: terminal grabs the mouse. Valid values are: arrow, beam and hand 326 327 default_pointer_shape beam 328 329 #: The default shape of the mouse pointer. Valid values are: arrow, 330 #: beam and hand 331 332 pointer_shape_when_dragging beam 333 334 #: The default shape of the mouse pointer when dragging across text. 335 #: Valid values are: arrow, beam and hand 336 337 #: }}} 338 339 #: Performance tuning {{{ 340 341 repaint_delay 10 342 343 #: Delay (in milliseconds) between screen updates. Decreasing it, 344 #: increases frames-per-second (FPS) at the cost of more CPU usage. 345 #: The default value yields ~100 FPS which is more than sufficient for 346 #: most uses. Note that to actually achieve 100 FPS you have to either 347 #: set sync_to_monitor to no or use a monitor with a high refresh 348 #: rate. Also, to minimize latency when there is pending input to be 349 #: processed, repaint_delay is ignored. 350 351 input_delay 3 352 353 #: Delay (in milliseconds) before input from the program running in 354 #: the terminal is processed. Note that decreasing it will increase 355 #: responsiveness, but also increase CPU usage and might cause flicker 356 #: in full screen programs that redraw the entire screen on each loop, 357 #: because kitty is so fast that partial screen updates will be drawn. 358 359 sync_to_monitor yes 360 361 #: Sync screen updates to the refresh rate of the monitor. This 362 #: prevents tearing (https://en.wikipedia.org/wiki/Screen_tearing) 363 #: when scrolling. However, it limits the rendering speed to the 364 #: refresh rate of your monitor. With a very high speed mouse/high 365 #: keyboard repeat rate, you may notice some slight input latency. If 366 #: so, set this to no. 367 368 #: }}} 369 370 #: Terminal bell {{{ 371 372 enable_audio_bell no 373 374 #: Enable/disable the audio bell. Useful in environments that require 375 #: silence. 376 377 visual_bell_duration 0.0 378 379 #: Visual bell duration. Flash the screen when a bell occurs for the 380 #: specified number of seconds. Set to zero to disable. 381 382 window_alert_on_bell yes 383 384 #: Request window attention on bell. Makes the dock icon bounce on 385 #: macOS or the taskbar flash on linux. 386 387 bell_on_tab yes 388 389 #: Show a bell symbol on the tab if a bell occurs in one of the 390 #: windows in the tab and the window is not the currently focused 391 #: window 392 393 command_on_bell none 394 395 #: Program to run when a bell occurs. 396 397 #: }}} 398 399 #: Window layout {{{ 400 401 remember_window_size yes 402 initial_window_width 640 403 initial_window_height 400 404 405 #: If enabled, the window size will be remembered so that new 406 #: instances of kitty will have the same size as the previous 407 #: instance. If disabled, the window will initially have size 408 #: configured by initial_window_width/height, in pixels. You can use a 409 #: suffix of "c" on the width/height values to have them interpreted 410 #: as number of cells instead of pixels. 411 412 enabled_layouts * 413 414 #: The enabled window layouts. A comma separated list of layout names. 415 #: The special value all means all layouts. The first listed layout 416 #: will be used as the startup layout. Default configuration is all 417 #: layouts in alphabetical order. For a list of available layouts, see 418 #: the https://sw.kovidgoyal.net/kitty/index.html#layouts. 419 420 window_resize_step_cells 2 421 window_resize_step_lines 2 422 423 #: The step size (in units of cell width/cell height) to use when 424 #: resizing windows. The cells value is used for horizontal resizing 425 #: and the lines value for vertical resizing. 426 427 window_border_width 0.5pt 428 429 #: The width of window borders. Can be either in pixels (px) or pts 430 #: (pt). Values in pts will be rounded to the nearest number of pixels 431 #: based on screen resolution. If not specified the unit is assumed to 432 #: be pts. Note that borders are displayed only when more than one 433 #: window is visible. They are meant to separate multiple windows. 434 435 draw_minimal_borders yes 436 437 #: Draw only the minimum borders needed. This means that only the 438 #: minimum needed borders for inactive windows are drawn. That is only 439 #: the borders that separate the inactive window from a neighbor. Note 440 #: that setting a non-zero window margin overrides this and causes all 441 #: borders to be drawn. 442 443 window_margin_width 0 444 445 #: The window margin (in pts) (blank area outside the border). A 446 #: single value sets all four sides. Two values set the vertical and 447 #: horizontal sides. Three values set top, horizontal and bottom. Four 448 #: values set top, right, bottom and left. 449 450 single_window_margin_width -1 451 452 #: The window margin (in pts) to use when only a single window is 453 #: visible. Negative values will cause the value of 454 #: window_margin_width to be used instead. A single value sets all 455 #: four sides. Two values set the vertical and horizontal sides. Three 456 #: values set top, horizontal and bottom. Four values set top, right, 457 #: bottom and left. 458 459 window_padding_width 0 460 461 #: The window padding (in pts) (blank area between the text and the 462 #: window border). A single value sets all four sides. Two values set 463 #: the vertical and horizontal sides. Three values set top, horizontal 464 #: and bottom. Four values set top, right, bottom and left. 465 466 placement_strategy center 467 468 #: When the window size is not an exact multiple of the cell size, the 469 #: cell area of the terminal window will have some extra padding on 470 #: the sides. You can control how that padding is distributed with 471 #: this option. Using a value of center means the cell area will be 472 #: placed centrally. A value of top-left means the padding will be on 473 #: only the bottom and right edges. 474 # active_border_color #00ff00 475 476 #: The color for the border of the active window. Set this to none to 477 #: not draw borders around the active window. 478 # inactive_border_color #cccccc 479 480 #: The color for the border of inactive windows 481 # bell_border_color #ff5a00 482 483 #: The color for the border of inactive windows in which a bell has 484 #: occurred 485 486 inactive_text_alpha 1.0 487 488 #: Fade the text in inactive windows by the specified amount (a number 489 #: between zero and one, with zero being fully faded). 490 491 hide_window_decorations no 492 493 #: Hide the window decorations (title-bar and window borders) with 494 #: yes. On macOS, titlebar-only can be used to only hide the titlebar. 495 #: Whether this works and exactly what effect it has depends on the 496 #: window manager/operating system. 497 498 resize_debounce_time 0.1 499 500 #: The time (in seconds) to wait before redrawing the screen when a 501 #: resize event is received. On platforms such as macOS, where the 502 #: operating system sends events corresponding to the start and end of 503 #: a resize, this number is ignored. 504 505 resize_draw_strategy static 506 507 #: Choose how kitty draws a window while a resize is in progress. A 508 #: value of static means draw the current window contents, mostly 509 #: unchanged. A value of scale means draw the current window contents 510 #: scaled. A value of blank means draw a blank window. A value of size 511 #: means show the window size in cells. 512 513 resize_in_steps no 514 515 #: Resize the OS window in steps as large as the cells, instead of 516 #: with the usual pixel accuracy. Combined with an 517 #: initial_window_width and initial_window_height in number of cells, 518 #: this option can be used to keep the margins as small as possible 519 #: when resizing the OS window. Note that this does not currently work 520 #: on Wayland. 521 522 confirm_os_window_close 0 523 524 #: Ask for confirmation when closing an OS window or a tab that has at 525 #: least this number of kitty windows in it. A value of zero disables 526 #: confirmation. This confirmation also applies to requests to quit 527 #: the entire application (all OS windows, via the quit action). 528 529 #: }}} 530 531 #: Tab bar {{{ 532 533 tab_bar_edge bottom 534 535 #: Which edge to show the tab bar on, top or bottom 536 537 tab_bar_margin_width 0.0 538 539 #: The margin to the left and right of the tab bar (in pts) 540 541 tab_bar_style fade 542 543 #: The tab bar style, can be one of: fade, separator, powerline, or 544 #: hidden. In the fade style, each tab's edges fade into the 545 #: background color, in the separator style, tabs are separated by a 546 #: configurable separator, and the powerline shows the tabs as a 547 #: continuous line. If you use the hidden style, you might want to 548 #: create a mapping for the select_tab action which presents you with 549 #: a list of tabs and allows for easy switching to a tab. 550 551 tab_bar_min_tabs 2 552 553 #: The minimum number of tabs that must exist before the tab bar is 554 #: shown 555 556 tab_switch_strategy previous 557 558 #: The algorithm to use when switching to a tab when the current tab 559 #: is closed. The default of previous will switch to the last used 560 #: tab. A value of left will switch to the tab to the left of the 561 #: closed tab. A value of right will switch to the tab to the right of 562 #: the closed tab. A value of last will switch to the right-most tab. 563 564 tab_fade 0.25 0.5 0.75 1 565 566 #: Control how each tab fades into the background when using fade for 567 #: the tab_bar_style. Each number is an alpha (between zero and one) 568 #: that controls how much the corresponding cell fades into the 569 #: background, with zero being no fade and one being full fade. You 570 #: can change the number of cells used by adding/removing entries to 571 #: this list. 572 573 tab_separator " ┇" 574 575 #: The separator between tabs in the tab bar when using separator as 576 #: the tab_bar_style. 577 578 tab_activity_symbol none 579 580 #: Some text or a unicode symbol to show on the tab if a window in the 581 #: tab that does not have focus has some activity. 582 583 tab_title_template "{title}" 584 585 #: A template to render the tab title. The default just renders the 586 #: title. If you wish to include the tab-index as well, use something 587 #: like: {index}: {title}. Useful if you have shortcuts mapped for 588 #: goto_tab N. In addition you can use {layout_name} for the current 589 #: layout name and {num_windows} for the number of windows in the tab. 590 #: Note that formatting is done by Python's string formatting 591 #: machinery, so you can use, for instance, {layout_name[:2].upper()} 592 #: to show only the first two letters of the layout name, upper-cased. 593 #: If you want to style the text, you can use styling directives, for 594 #: example: {fmt.fg.red}red{fmt.fg.default}normal{fmt.bg._00FF00}green 595 #: bg{fmt.bg.normal}. Similarly, for bold and italic: 596 #: {fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}. 597 598 active_tab_title_template none 599 600 #: Template to use for active tabs, if not specified falls back to 601 #: tab_title_template. 602 # active_tab_foreground #000 603 # active_tab_background #eee 604 active_tab_font_style bold-italic 605 # inactive_tab_foreground #444 606 # inactive_tab_background #999 607 inactive_tab_font_style normal 608 609 #: Tab bar colors and styles 610 # tab_bar_background none 611 612 #: Background color for the tab bar. Defaults to using the terminal 613 #: background color. 614 615 #: }}} 616 617 #: Color scheme {{{ 618 # foreground #dddddd 619 # background #000000 620 621 #: The foreground and background colors 622 623 background_opacity 0.9 624 625 #: The opacity of the background. A number between 0 and 1, where 1 is 626 #: opaque and 0 is fully transparent. This will only work if 627 #: supported by the OS (for instance, when using a compositor under 628 #: X11). Note that it only sets the background color's opacity in 629 #: cells that have the same background color as the default terminal 630 #: background. This is so that things like the status bar in vim, 631 #: powerline prompts, etc. still look good. But it means that if you 632 #: use a color theme with a background color in your editor, it will 633 #: not be rendered as transparent. Instead you should change the 634 #: default background color in your kitty config and not use a 635 #: background color in the editor color scheme. Or use the escape 636 #: codes to set the terminals default colors in a shell script to 637 #: launch your editor. Be aware that using a value less than 1.0 is a 638 #: (possibly significant) performance hit. If you want to dynamically 639 #: change transparency of windows set dynamic_background_opacity to 640 #: yes (this is off by default as it has a performance cost) 641 642 background_image none 643 644 #: Path to a background image. Must be in PNG format. 645 646 background_image_layout tiled 647 648 #: Whether to tile or scale the background image. 649 650 background_image_linear no 651 652 #: When background image is scaled, whether linear interpolation 653 #: should be used. 654 655 dynamic_background_opacity no 656 657 #: Allow changing of the background_opacity dynamically, using either 658 #: keyboard shortcuts (increase_background_opacity and 659 #: decrease_background_opacity) or the remote control facility. 660 661 background_tint 0.0 662 663 #: How much to tint the background image by the background color. The 664 #: tint is applied only under the text area, not margin/borders. Makes 665 #: it easier to read the text. Tinting is done using the current 666 #: background color for each window. This setting applies only if 667 #: background_opacity is set and transparent windows are supported or 668 #: background_image is set. 669 670 dim_opacity 0.75 671 672 #: How much to dim text that has the DIM/FAINT attribute set. One 673 #: means no dimming and zero means fully dimmed (i.e. invisible). 674 # selection_foreground #000000 675 676 #: The foreground for text selected with the mouse. A value of none 677 #: means to leave the color unchanged. 678 # selection_background #fffacd 679 680 #: The background for text selected with the mouse. 681 682 683 #: The 16 terminal colors. There are 8 basic colors, each color has a 684 #: dull and bright version. You can also set the remaining colors from 685 #: the 256 color table as color16 to color255. 686 # color0 #000000 687 # color8 #000000 688 689 #: black 690 # color1 #c33720 691 # color9 #c33720 692 693 #: red 694 # color2 #34bc26 695 # color10 #34bc26 696 697 #: green 698 # color3 #afad24 699 # color11 #afad24 700 701 #: yellow 702 # color4 #532fe1 703 # color12 #532fe1 704 705 #: blue 706 # color5 #d43bd3 707 # color13 #d43bd3 708 709 #: magenta 710 # color6 #34bbc8 711 # color14 #34bbc8 712 713 #: cyan 714 # color7 #cccccc 715 # color15 #cccccc 716 717 718 719 #: white 720 # mark1_foreground black 721 722 #: Color for marks of type 1 723 # mark1_background #98d3cb 724 725 #: Color for marks of type 1 (light steel blue) 726 # mark2_foreground black 727 728 #: Color for marks of type 2 729 # mark2_background #f2dcd3 730 731 #: Color for marks of type 1 (beige) 732 # mark3_foreground black 733 734 #: Color for marks of type 3 735 # mark3_background #f274bc 736 737 #: Color for marks of type 1 (violet) 738 739 #: }}} 740 741 #: Advanced {{{ 742 743 shell . 744 745 #: The shell program to execute. The default value of . means to use 746 #: whatever shell is set as the default shell for the current user. 747 #: Note that on macOS if you change this, you might need to add 748 #: --login to ensure that the shell starts in interactive mode and 749 #: reads its startup rc files. 750 751 editor . 752 753 #: The console editor to use when editing the kitty config file or 754 #: similar tasks. A value of . means to use the environment variables 755 #: VISUAL and EDITOR in that order. Note that this environment 756 #: variable has to be set not just in your shell startup scripts but 757 #: system-wide, otherwise kitty will not see it. 758 759 close_on_child_death no 760 761 #: Close the window when the child process (shell) exits. If no (the 762 #: default), the terminal will remain open when the child exits as 763 #: long as there are still processes outputting to the terminal (for 764 #: example disowned or backgrounded processes). If yes, the window 765 #: will close as soon as the child process exits. Note that setting it 766 #: to yes means that any background processes still using the terminal 767 #: can fail silently because their stdout/stderr/stdin no longer work. 768 769 allow_remote_control no 770 771 #: Allow other programs to control kitty. If you turn this on other 772 #: programs can control all aspects of kitty, including sending text 773 #: to kitty windows, opening new windows, closing windows, reading the 774 #: content of windows, etc. Note that this even works over ssh 775 #: connections. You can chose to either allow any program running 776 #: within kitty to control it, with yes or only programs that connect 777 #: to the socket specified with the kitty --listen-on command line 778 #: option, if you use the value socket-only. The latter is useful if 779 #: you want to prevent programs running on a remote computer over ssh 780 #: from controlling kitty. 781 782 listen_on none 783 784 #: Tell kitty to listen to the specified unix/tcp socket for remote 785 #: control connections. Note that this will apply to all kitty 786 #: instances. It can be overridden by the kitty --listen-on command 787 #: line flag. This option accepts only UNIX sockets, such as 788 #: unix:${TEMP}/mykitty or (on Linux) unix:@mykitty. Environment 789 #: variables are expanded. If {kitty_pid} is present then it is 790 #: replaced by the PID of the kitty process, otherwise the PID of the 791 #: kitty process is appended to the value, with a hyphen. This option 792 #: is ignored unless you also set allow_remote_control to enable 793 #: remote control. See the help for kitty --listen-on for more 794 #: details. 795 796 # env 797 798 #: Specify environment variables to set in all child processes. Note 799 #: that environment variables are expanded recursively, so if you 800 #: use:: 801 802 #: env MYVAR1=a 803 #: env MYVAR2=${MYVAR1}/${HOME}/b 804 805 #: The value of MYVAR2 will be a/<path to home directory>/b. 806 807 update_check_interval 24 808 809 #: Periodically check if an update to kitty is available. If an update 810 #: is found a system notification is displayed informing you of the 811 #: available update. The default is to check every 24 hrs, set to zero 812 #: to disable. 813 814 startup_session none 815 816 #: Path to a session file to use for all kitty instances. Can be 817 #: overridden by using the kitty --session command line option for 818 #: individual instances. See 819 #: https://sw.kovidgoyal.net/kitty/index.html#sessions in the kitty 820 #: documentation for details. Note that relative paths are interpreted 821 #: with respect to the kitty config directory. Environment variables 822 #: in the path are expanded. 823 824 clipboard_control write-clipboard write-primary 825 826 #: Allow programs running in kitty to read and write from the 827 #: clipboard. You can control exactly which actions are allowed. The 828 #: set of possible actions is: write-clipboard read-clipboard write- 829 #: primary read-primary. You can additionally specify no-append to 830 #: disable kitty's protocol extension for clipboard concatenation. The 831 #: default is to allow writing to the clipboard and primary selection 832 #: with concatenation enabled. Note that enabling the read 833 #: functionality is a security risk as it means that any program, even 834 #: one running on a remote server via SSH can read your clipboard. 835 836 allow_hyperlinks yes 837 838 #: Process hyperlink (OSC 8) escape sequences. If disabled OSC 8 839 #: escape sequences are ignored. Otherwise they become clickable 840 #: links, that you can click by holding down ctrl+shift and clicking 841 #: with the mouse. The special value of ``ask`` means that kitty will 842 #: ask before opening the link. 843 844 term xterm-kitty 845 846 #: The value of the TERM environment variable to set. Changing this 847 #: can break many terminal programs, only change it if you know what 848 #: you are doing, not because you read some advice on Stack Overflow 849 #: to change it. The TERM variable is used by various programs to get 850 #: information about the capabilities and behavior of the terminal. If 851 #: you change it, depending on what programs you run, and how 852 #: different the terminal you are changing it to is, various things 853 #: from key-presses, to colors, to various advanced features may not 854 #: work. 855 856 #: }}} 857 858 #: OS specific tweaks {{{ 859 # macos_titlebar_color system 860 861 #: Change the color of the kitty window's titlebar on macOS. A value 862 #: of system means to use the default system color, a value of 863 #: background means to use the background color of the currently 864 #: active window and finally you can use an arbitrary color, such as 865 #: #12af59 or red. WARNING: This option works by using a hack, as 866 #: there is no proper Cocoa API for it. It sets the background color 867 #: of the entire window and makes the titlebar transparent. As such it 868 #: is incompatible with background_opacity. If you want to use both, 869 #: you are probably better off just hiding the titlebar with 870 #: hide_window_decorations. 871 872 macos_option_as_alt no 873 874 #: Use the option key as an alt key. With this set to no, kitty will 875 #: use the macOS native Option+Key = unicode character behavior. This 876 #: will break any Alt+key keyboard shortcuts in your terminal 877 #: programs, but you can use the macOS unicode input technique. You 878 #: can use the values: left, right, or both to use only the left, 879 #: right or both Option keys as Alt, instead. 880 881 macos_hide_from_tasks no 882 883 #: Hide the kitty window from running tasks (Option+Tab) on macOS. 884 885 macos_quit_when_last_window_closed no 886 887 #: Have kitty quit when all the top-level windows are closed. By 888 #: default, kitty will stay running, even with no open windows, as is 889 #: the expected behavior on macOS. 890 891 macos_window_resizable yes 892 893 #: Disable this if you want kitty top-level (OS) windows to not be 894 #: resizable on macOS. 895 896 macos_thicken_font 0 897 898 #: Draw an extra border around the font with the given width, to 899 #: increase legibility at small font sizes. For example, a value of 900 #: 0.75 will result in rendering that looks similar to sub-pixel 901 #: antialiasing at common font sizes. 902 903 macos_traditional_fullscreen no 904 905 #: Use the traditional full-screen transition, that is faster, but 906 #: less pretty. 907 908 macos_show_window_title_in all 909 910 #: Show or hide the window title in the macOS window or menu-bar. A 911 #: value of window will show the title of the currently active window 912 #: at the top of the macOS window. A value of menubar will show the 913 #: title of the currently active window in the macOS menu-bar, making 914 #: use of otherwise wasted space. all will show the title everywhere 915 #: and none hides the title in the window and the menu-bar. 916 917 macos_custom_beam_cursor no 918 919 #: Enable/disable custom mouse cursor for macOS that is easier to see 920 #: on both light and dark backgrounds. WARNING: this might make your 921 #: mouse cursor invisible on dual GPU machines. 922 923 linux_display_server auto 924 925 #: Choose between Wayland and X11 backends. By default, an appropriate 926 #: backend based on the system state is chosen automatically. Set it 927 #: to x11 or wayland to force the choice. 928 929 #: }}} 930 931 #: Keyboard shortcuts {{{ 932 933 #: For a list of key names, see: the GLFW key macros 934 #: <https://github.com/kovidgoyal/kitty/blob/master/glfw/glfw3.h#L349>. 935 #: The name to use is the part after the GLFW_KEY_ prefix. For a list 936 #: of modifier names, see: GLFW mods 937 #: <https://www.glfw.org/docs/latest/group__mods.html> 938 939 #: On Linux you can also use XKB key names to bind keys that are not 940 #: supported by GLFW. See XKB keys 941 #: <https://github.com/xkbcommon/libxkbcommon/blob/master/xkbcommon/xkbcommon- 942 #: keysyms.h> for a list of key names. The name to use is the part 943 #: after the XKB_KEY_ prefix. Note that you can only use an XKB key 944 #: name for keys that are not known as GLFW keys. 945 946 #: Finally, you can use raw system key codes to map keys, again only 947 #: for keys that are not known as GLFW keys. To see the system key 948 #: code for a key, start kitty with the kitty --debug-keyboard option. 949 #: Then kitty will output some debug text for every key event. In that 950 #: text look for ``native_code`` the value of that becomes the key 951 #: name in the shortcut. For example: 952 953 #: .. code-block:: none 954 955 #: on_key_input: glfw key: 65 native_code: 0x61 action: PRESS mods: 0x0 text: 'a' 956 957 #: Here, the key name for the A key is 0x61 and you can use it with:: 958 959 #: map ctrl+0x61 something 960 961 #: to map ctrl+a to something. 962 963 #: You can use the special action no_op to unmap a keyboard shortcut 964 #: that is assigned in the default configuration:: 965 966 #: map kitty_mod+space no_op 967 968 #: You can combine multiple actions to be triggered by a single 969 #: shortcut, using the syntax below:: 970 971 #: map key combine <separator> action1 <separator> action2 <separator> action3 ... 972 973 #: For example:: 974 975 #: map kitty_mod+e combine : new_window : next_layout 976 977 #: this will create a new window and switch to the next available 978 #: layout 979 980 #: You can use multi-key shortcuts using the syntax shown below:: 981 982 #: map key1>key2>key3 action 983 984 #: For example:: 985 986 #: map ctrl+f>2 set_font_size 20 987 988 kitty_mod ctrl+shift 989 990 #: The value of kitty_mod is used as the modifier for all default 991 #: shortcuts, you can change it in your kitty.conf to change the 992 #: modifiers for all the default shortcuts. 993 994 clear_all_shortcuts no 995 996 #: You can have kitty remove all shortcut definition seen up to this 997 #: point. Useful, for instance, to remove the default shortcuts. 998 999 # kitten_alias hints hints --hints-offset=0 1000 1001 #: You can create aliases for kitten names, this allows overriding the 1002 #: defaults for kitten options and can also be used to shorten 1003 #: repeated mappings of the same kitten with a specific group of 1004 #: options. For example, the above alias changes the default value of 1005 #: kitty +kitten hints --hints-offset to zero for all mappings, 1006 #: including the builtin ones. 1007 1008 #: Clipboard {{{ 1009 1010 map alt+c copy_to_clipboard 1011 1012 #: There is also a copy_or_interrupt action that can be optionally 1013 #: mapped to Ctrl+c. It will copy only if there is a selection and 1014 #: send an interrupt otherwise. Similarly, copy_and_clear_or_interrupt 1015 #: will copy and clear the selection or send an interrupt if there is 1016 #: no selection. 1017 1018 map kitty_mod+v paste_from_clipboard 1019 map kitty_mod+s paste_from_selection 1020 map shift+insert paste_from_selection 1021 map kitty_mod+o pass_selection_to_program 1022 1023 #: You can also pass the contents of the current selection to any 1024 #: program using pass_selection_to_program. By default, the system's 1025 #: open program is used, but you can specify your own, the selection 1026 #: will be passed as a command line argument to the program, for 1027 #: example:: 1028 1029 #: map kitty_mod+o pass_selection_to_program firefox 1030 1031 #: You can pass the current selection to a terminal program running in 1032 #: a new kitty window, by using the @selection placeholder:: 1033 1034 #: map kitty_mod+y new_window less @selection 1035 1036 #: }}} 1037 1038 #: Scrolling {{{ 1039 1040 map kitty_mod+up scroll_line_up 1041 map kitty_mod+k scroll_line_up 1042 map kitty_mod+down scroll_line_down 1043 map kitty_mod+j scroll_line_down 1044 map kitty_mod+page_up scroll_page_up 1045 map kitty_mod+page_down scroll_page_down 1046 map kitty_mod+home scroll_home 1047 map kitty_mod+end scroll_end 1048 map kitty_mod+h show_scrollback 1049 1050 #: You can pipe the contents of the current screen + history buffer as 1051 #: STDIN to an arbitrary program using the ``launch`` function. For 1052 #: example, the following opens the scrollback buffer in less in an 1053 #: overlay window:: 1054 1055 #: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R 1056 1057 #: For more details on piping screen and buffer contents to external 1058 #: programs, see launch. 1059 1060 #: }}} 1061 1062 #: Window management {{{ 1063 map kitty_mod+space new_window 1064 1065 #: You can open a new window running an arbitrary program, for 1066 #: example:: 1067 1068 #: map kitty_mod+y launch mutt 1069 1070 #: You can open a new window with the current working directory set to 1071 #: the working directory of the current window using:: 1072 1073 #: map ctrl+alt+enter launch --cwd=current 1074 1075 #: You can open a new window that is allowed to control kitty via the 1076 #: kitty remote control facility by prefixing the command line with @. 1077 #: Any programs running in that window will be allowed to control 1078 #: kitty. For example:: 1079 1080 #: map ctrl+enter launch --allow-remote-control some_program 1081 1082 #: You can open a new window next to the currently active window or as 1083 #: the first window, with:: 1084 1085 #: map ctrl+n launch --location=neighbor some_program 1086 #: map ctrl+f launch --location=first some_program 1087 1088 #: For more details, see launch. 1089 1090 map kitty_mod+n new_os_window 1091 1092 #: Works like new_window above, except that it opens a top level OS 1093 #: kitty window. In particular you can use new_os_window_with_cwd to 1094 #: open a window with the current working directory. 1095 1096 map ctrl+shift+q close_window 1097 map kitty_mod+w no_op 1098 map kitty_mod+] next_window 1099 map kitty_mod+[ previous_window 1100 map kitty_mod+f move_window_forward 1101 map kitty_mod+b move_window_backward 1102 map kitty_mod+` move_window_to_top 1103 map kitty_mod+r start_resizing_window 1104 map kitty_mod+1 first_window 1105 map kitty_mod+2 second_window 1106 map kitty_mod+3 third_window 1107 map kitty_mod+4 fourth_window 1108 map kitty_mod+5 fifth_window 1109 map kitty_mod+6 sixth_window 1110 map kitty_mod+7 seventh_window 1111 map kitty_mod+8 eighth_window 1112 map kitty_mod+9 ninth_window 1113 map kitty_mod+0 tenth_window 1114 #: }}} 1115 1116 #: Tab management {{{ 1117 1118 map kitty_mod+right next_tab 1119 map kitty_mod+left previous_tab 1120 map kitty_mod+t new_tab 1121 map kitty_mod+q close_tab 1122 map kitty_mod+. move_tab_forward 1123 map kitty_mod+, move_tab_backward 1124 map kitty_mod+alt+t set_tab_title 1125 1126 #: You can also create shortcuts to go to specific tabs, with 1 being 1127 #: the first tab, 2 the second tab and -1 being the previously active 1128 #: tab, and any number larger than the last tab being the last tab:: 1129 1130 #: map ctrl+alt+1 goto_tab 1 1131 #: map ctrl+alt+2 goto_tab 2 1132 1133 #: Just as with new_window above, you can also pass the name of 1134 #: arbitrary commands to run when using new_tab and use 1135 #: new_tab_with_cwd. Finally, if you want the new tab to open next to 1136 #: the current tab rather than at the end of the tabs list, use:: 1137 1138 #: map ctrl+t new_tab !neighbor [optional cmd to run] 1139 #: }}} 1140 1141 #: Layout management {{{ 1142 1143 map kitty_mod+l next_layout 1144 1145 #: You can also create shortcuts to switch to specific layouts:: 1146 1147 #: map ctrl+alt+t goto_layout tall 1148 #: map ctrl+alt+s goto_layout stack 1149 1150 #: Similarly, to switch back to the previous layout:: 1151 1152 #: map ctrl+alt+p last_used_layout 1153 #: }}} 1154 1155 #: Font sizes {{{ 1156 1157 #: You can change the font size for all top-level kitty OS windows at 1158 #: a time or only the current one. 1159 1160 map kitty_mod+shift+equal change_font_size all +2.0 1161 map kitty_mod+shift+minus change_font_size all -2.0 1162 map kitty_mod+backspace change_font_size all 0 1163 1164 #: To setup shortcuts for specific font sizes:: 1165 1166 #: map kitty_mod+f6 change_font_size all 10.0 1167 1168 #: To setup shortcuts to change only the current OS window's font 1169 #: size:: 1170 1171 #: map kitty_mod+f6 change_font_size current 10.0 1172 #: }}} 1173 1174 #: Select and act on visible text {{{ 1175 1176 #: Use the hints kitten to select text and either pass it to an 1177 #: external program or insert it into the terminal or copy it to the 1178 #: clipboard. 1179 1180 map kitty_mod+e kitten hints 1181 1182 #: Open a currently visible URL using the keyboard. The program used 1183 #: to open the URL is specified in open_url_with. 1184 1185 map kitty_mod+p>f kitten hints --type path --program - 1186 1187 #: Select a path/filename and insert it into the terminal. Useful, for 1188 #: instance to run git commands on a filename output from a previous 1189 #: git command. 1190 1191 map kitty_mod+p>shift+f kitten hints --type path 1192 1193 #: Select a path/filename and open it with the default open program. 1194 1195 map kitty_mod+p>l kitten hints --type line --program - 1196 1197 #: Select a line of text and insert it into the terminal. Use for the 1198 #: output of things like: ls -1 1199 1200 map kitty_mod+p>w kitten hints --type word --program - 1201 1202 #: Select words and insert into terminal. 1203 1204 map kitty_mod+p>h kitten hints --type hash --program - 1205 1206 #: Select something that looks like a hash and insert it into the 1207 #: terminal. Useful with git, which uses sha1 hashes to identify 1208 #: commits 1209 1210 map kitty_mod+p>n kitten hints --type linenum 1211 1212 #: Select something that looks like filename:linenum and open it in 1213 #: vim at the specified line number. 1214 1215 map kitty_mod+p>y kitten hints --type hyperlink 1216 1217 #: Select a hyperlink (i.e. a URL that has been marked as such by the 1218 #: terminal program, for example, by ls --hyperlink=auto). 1219 1220 1221 #: The hints kitten has many more modes of operation that you can map 1222 #: to different shortcuts. For a full description see kittens/hints. 1223 #: }}} 1224 1225 #: Miscellaneous {{{ 1226 1227 map kitty_mod+f11 toggle_fullscreen 1228 map kitty_mod+f10 toggle_maximized 1229 map kitty_mod+u kitten unicode_input 1230 map kitty_mod+f2 edit_config_file 1231 map kitty_mod+escape kitty_shell window 1232 1233 #: Open the kitty shell in a new window/tab/overlay/os_window to 1234 #: control kitty using commands. 1235 1236 map kitty_mod+a>m set_background_opacity +0.1 1237 map kitty_mod+a>l set_background_opacity -0.1 1238 map kitty_mod+a>1 set_background_opacity 1 1239 map kitty_mod+a>d set_background_opacity default 1240 map kitty_mod+delete clear_terminal reset active 1241 1242 #: You can create shortcuts to clear/reset the terminal. For example:: 1243 1244 #: # Reset the terminal 1245 #: map kitty_mod+f9 clear_terminal reset active 1246 #: # Clear the terminal screen by erasing all contents 1247 #: map kitty_mod+f10 clear_terminal clear active 1248 #: # Clear the terminal scrollback by erasing it 1249 #: map kitty_mod+f11 clear_terminal scrollback active 1250 #: # Scroll the contents of the screen into the scrollback 1251 #: map kitty_mod+f12 clear_terminal scroll active 1252 1253 #: If you want to operate on all windows instead of just the current 1254 #: one, use all instead of active. 1255 1256 #: It is also possible to remap Ctrl+L to both scroll the current 1257 #: screen contents into the scrollback buffer and clear the screen, 1258 #: instead of just clearing the screen:: 1259 1260 #: map ctrl+l combine : clear_terminal scroll active : send_text normal,application \x0c 1261 1262 1263 #: You can tell kitty to send arbitrary (UTF-8) encoded text to the 1264 #: client program when pressing specified shortcut keys. For example:: 1265 1266 #: map ctrl+alt+a send_text all Special text 1267 1268 #: This will send "Special text" when you press the ctrl+alt+a key 1269 #: combination. The text to be sent is a python string literal so you 1270 #: can use escapes like \x1b to send control codes or \u21fb to send 1271 #: unicode characters (or you can just input the unicode characters 1272 #: directly as UTF-8 text). The first argument to send_text is the 1273 #: keyboard modes in which to activate the shortcut. The possible 1274 #: values are normal or application or kitty or a comma separated 1275 #: combination of them. The special keyword all means all modes. The 1276 #: modes normal and application refer to the DECCKM cursor key mode 1277 #: for terminals, and kitty refers to the special kitty extended 1278 #: keyboard protocol. 1279 1280 #: Another example, that outputs a word and then moves the cursor to 1281 #: the start of the line (same as pressing the Home key):: 1282 1283 #: map ctrl+alt+a send_text normal Word\x1b[H 1284 #: map ctrl+alt+a send_text application Word\x1bOH 1285 1286 #: }}} 1287 1288 # }}} 1289 1290 1291 # BEGIN_KITTY_THEME 1292 # Dark Pastel 1293 include current-theme.conf 1294 # END_KITTY_THEME