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