+3

kitty/README.md

reviewed

··· 1 1 + # kitty terminal config 2 2 + 3 3 + App icon is from [kitty-icon](https://github.com/DinkDonk/kitty-icon)

kitty/kitty-dark.icns

reviewed

This is a binary file and will not be displayed.

kitty/kitty-light.icns

reviewed

This is a binary file and will not be displayed.

kitty/kitty.app.icns

reviewed

This is a binary file and will not be displayed.

+2266

kitty/kitty.conf

reviewed

··· 1 1 + # vim:fileencoding=utf-8:foldmethod=marker 2 2 + 3 3 + #: Fonts {{{ 4 4 + 5 5 + #: kitty has very powerful font management. You can configure 6 6 + #: individual font faces and even specify special fonts for particular 7 7 + #: characters. 8 8 + 9 9 + font_family Fira Code 10 10 + bold_font Fira Code Bold 11 11 + italic_font auto 12 12 + bold_italic_font auto 13 13 + 14 14 + #: You can specify different fonts for the bold/italic/bold-italic 15 15 + #: variants. To get a full list of supported fonts use the `kitty 16 16 + #: +list-fonts` command. By default they are derived automatically, by 17 17 + #: the OSes font system. When bold_font or bold_italic_font is set to 18 18 + #: auto on macOS, the priority of bold fonts is semi-bold, bold, 19 19 + #: heavy. Setting them manually is useful for font families that have 20 20 + #: many weight variants like Book, Medium, Thick, etc. For example:: 21 21 + 22 22 + #: font_family Operator Mono Book 23 23 + #: bold_font Operator Mono Medium 24 24 + #: italic_font Operator Mono Book Italic 25 25 + #: bold_italic_font Operator Mono Medium Italic 26 26 + 27 27 + font_size 16.0 28 28 + 29 29 + #: Font size (in pts) 30 30 + 31 31 + # force_ltr no 32 32 + 33 33 + #: kitty does not support BIDI (bidirectional text), however, for RTL 34 34 + #: scripts, words are automatically displayed in RTL. That is to say, 35 35 + #: in an RTL script, the words "HELLO WORLD" display in kitty as 36 36 + #: "WORLD HELLO", and if you try to select a substring of an RTL- 37 37 + #: shaped string, you will get the character that would be there had 38 38 + #: the the string been LTR. For example, assuming the Hebrew word 39 39 + #: ירושלים, selecting the character that on the screen appears to be ם 40 40 + #: actually writes into the selection buffer the character י. kitty's 41 41 + #: default behavior is useful in conjunction with a filter to reverse 42 42 + #: the word order, however, if you wish to manipulate RTL glyphs, it 43 43 + #: can be very challenging to work with, so this option is provided to 44 44 + #: turn it off. Furthermore, this option can be used with the command 45 45 + #: line program GNU FriBidi 46 46 + #: <https://github.com/fribidi/fribidi#executable> to get BIDI 47 47 + #: support, because it will force kitty to always treat the text as 48 48 + #: LTR, which FriBidi expects for terminals. 49 49 + 50 50 + # - Use additional nerd symbols 51 51 + # See https://github.com/be5invis/Iosevka/issues/248 52 52 + # See https://github.com/ryanoasis/nerd-fonts/wiki/Glyph-Sets-and-Code-Points 53 53 + # Seti-UI + Custom 54 54 + symbol_map U+E5FA-U+E62B Symbols Nerd Font 55 55 + # Devicons 56 56 + symbol_map U+E700-U+E7C5 Symbols Nerd Font 57 57 + # Font Awesome 58 58 + symbol_map U+F000-U+F2E0 Symbols Nerd Font 59 59 + # Font Awesome Extension 60 60 + symbol_map U+E200-U+E2A9 Symbols Nerd Font 61 61 + # Material Design Icons 62 62 + symbol_map U+F500-U+FD46 Symbols Nerd Font 63 63 + # Weather 64 64 + symbol_map U+E300-U+E3EB Symbols Nerd Font 65 65 + # Octicons 66 66 + symbol_map U+F400-U+F4A8,U+2665,U+26A1,U+F27C Symbols Nerd Font 67 67 + # Powerline Extra Symbols 68 68 + symbol_map U+E0A3,U+E0B4-U+E0C8,U+E0CC-U+E0D2,U+E0D4 Symbols Nerd Font 69 69 + # IEC Power Symbols 70 70 + symbol_map U+23FB-U+23FE,U+2b58 Symbols Nerd Font 71 71 + # Font Logos 72 72 + symbol_map U+F300-U+F313 Symbols Nerd Font 73 73 + # Pomicons 74 74 + symbol_map U+E000-U+E00D Symbols Nerd Font 75 75 + 76 76 + #: E.g. symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols 77 77 + 78 78 + #: Map the specified Unicode codepoints to a particular font. Useful 79 79 + #: if you need special rendering for some symbols, such as for 80 80 + #: Powerline. Avoids the need for patched fonts. Each Unicode code 81 81 + #: point is specified in the form `U+<code point in hexadecimal>`. You 82 82 + #: can specify multiple code points, separated by commas and ranges 83 83 + #: separated by hyphens. This option can be specified multiple times. 84 84 + #: The syntax is:: 85 85 + 86 86 + #: symbol_map codepoints Font Family Name 87 87 + 88 88 + # narrow_symbols 89 89 + 90 90 + #: E.g. narrow_symbols U+E0A0-U+E0A3,U+E0C0-U+E0C7 1 91 91 + 92 92 + #: Usually, for Private Use Unicode characters and some symbol/dingbat 93 93 + #: characters, if the character is followed by one or more spaces, 94 94 + #: kitty will use those extra cells to render the character larger, if 95 95 + #: the character in the font has a wide aspect ratio. Using this 96 96 + #: option you can force kitty to restrict the specified code points to 97 97 + #: render in the specified number of cells (defaulting to one cell). 98 98 + #: This option can be specified multiple times. The syntax is:: 99 99 + 100 100 + #: narrow_symbols codepoints [optionally the number of cells] 101 101 + 102 102 + # disable_ligatures never 103 103 + 104 104 + #: Choose how you want to handle multi-character ligatures. The 105 105 + #: default is to always render them. You can tell kitty to not render 106 106 + #: them when the cursor is over them by using cursor to make editing 107 107 + #: easier, or have kitty never render them at all by using always, if 108 108 + #: you don't like them. The ligature strategy can be set per-window 109 109 + #: either using the kitty remote control facility or by defining 110 110 + #: shortcuts for it in kitty.conf, for example:: 111 111 + 112 112 + #: map alt+1 disable_ligatures_in active always 113 113 + #: map alt+2 disable_ligatures_in all never 114 114 + #: map alt+3 disable_ligatures_in tab cursor 115 115 + 116 116 + #: Note that this refers to programming ligatures, typically 117 117 + #: implemented using the calt OpenType feature. For disabling general 118 118 + #: ligatures, use the font_features option. 119 119 + 120 120 + font_features FiraCode-Retina +zero +ss06 121 121 + 122 122 + #: E.g. font_features none 123 123 + 124 124 + #: Choose exactly which OpenType features to enable or disable. This 125 125 + #: is useful as some fonts might have features worthwhile in a 126 126 + #: terminal. For example, Fira Code includes a discretionary feature, 127 127 + #: zero, which in that font changes the appearance of the zero (0), to 128 128 + #: make it more easily distinguishable from Ø. Fira Code also includes 129 129 + #: other discretionary features known as Stylistic Sets which have the 130 130 + #: tags ss01 through ss20. 131 131 + 132 132 + #: For the exact syntax to use for individual features, see the 133 133 + #: HarfBuzz documentation <https://harfbuzz.github.io/harfbuzz-hb- 134 134 + #: common.html#hb-feature-from-string>. 135 135 + 136 136 + #: Note that this code is indexed by PostScript name, and not the font 137 137 + #: family. This allows you to define very precise feature settings; 138 138 + #: e.g. you can disable a feature in the italic font but not in the 139 139 + #: regular font. 140 140 + 141 141 + #: On Linux, font features are first read from the FontConfig database 142 142 + #: and then this option is applied, so they can be configured in a 143 143 + #: single, central place. 144 144 + 145 145 + #: To get the PostScript name for a font, use `kitty +list-fonts 146 146 + #: --psnames`: 147 147 + 148 148 + #: .. code-block:: sh 149 149 + 150 150 + #: $ kitty +list-fonts --psnames | grep Fira 151 151 + #: Fira Code 152 152 + #: Fira Code Bold (FiraCode-Bold) 153 153 + #: Fira Code Light (FiraCode-Light) 154 154 + #: Fira Code Medium (FiraCode-Medium) 155 155 + #: Fira Code Regular (FiraCode-Regular) 156 156 + #: Fira Code Retina (FiraCode-Retina) 157 157 + 158 158 + #: The part in brackets is the PostScript name. 159 159 + 160 160 + #: Enable alternate zero and oldstyle numerals:: 161 161 + 162 162 + #: font_features FiraCode-Retina +zero +onum 163 163 + 164 164 + #: Enable only alternate zero in the bold font:: 165 165 + 166 166 + #: font_features FiraCode-Bold +zero 167 167 + 168 168 + #: Disable the normal ligatures, but keep the calt feature which (in 169 169 + #: this font) breaks up monotony:: 170 170 + 171 171 + #: font_features TT2020StyleB-Regular -liga +calt 172 172 + 173 173 + #: In conjunction with force_ltr, you may want to disable Arabic 174 174 + #: shaping entirely, and only look at their isolated forms if they 175 175 + #: show up in a document. You can do this with e.g.:: 176 176 + 177 177 + #: font_features UnifontMedium +isol -medi -fina -init 178 178 + 179 179 + modify_font cell_height 100% 180 180 + # modify_font baseline 3.5 181 181 + 182 182 + #: Modify font characteristics such as the position or thickness of 183 183 + #: the underline and strikethrough. The modifications can have the 184 184 + #: suffix px for pixels or % for percentage of original value. No 185 185 + #: suffix means use pts. For example:: 186 186 + 187 187 + #: modify_font underline_position -2 188 188 + #: modify_font underline_thickness 150% 189 189 + #: modify_font strikethrough_position 2px 190 190 + 191 191 + #: Additionally, you can modify the size of the cell in which each 192 192 + #: font glyph is rendered and the baseline at which the glyph is 193 193 + #: placed in the cell. For example:: 194 194 + 195 195 + #: modify_font cell_width 80% 196 196 + #: modify_font cell_height -2px 197 197 + #: modify_font baseline 3 198 198 + 199 199 + #: Note that modifying the baseline will automatically adjust the 200 200 + #: underline and strikethrough positions by the same amount. 201 201 + #: Increasing the baseline raises glyphs inside the cell and 202 202 + #: decreasing it lowers them. Decreasing the cell size might cause 203 203 + #: rendering artifacts, so use with care. 204 204 + 205 205 + # box_drawing_scale 0.001, 1, 1.5, 2 206 206 + 207 207 + #: The sizes of the lines used for the box drawing Unicode characters. 208 208 + #: These values are in pts. They will be scaled by the monitor DPI to 209 209 + #: arrive at a pixel value. There must be four values corresponding to 210 210 + #: thin, normal, thick, and very thick lines. 211 211 + 212 212 + #: }}} 213 213 + 214 214 + #: Cursor customization {{{ 215 215 + 216 216 + # cursor #cccccc 217 217 + 218 218 + #: Default cursor color. If set to the special value none the cursor 219 219 + #: will be rendered with a "reverse video" effect. It's color will be 220 220 + #: the color of the text in the cell it is over and the text will be 221 221 + #: rendered with the background color of the cell. Note that if the 222 222 + #: program running in the terminal sets a cursor color, this takes 223 223 + #: precedence. Also, the cursor colors are modified if the cell 224 224 + #: background and foreground colors have very low contrast. 225 225 + 226 226 + # cursor_text_color #111111 227 227 + 228 228 + #: The color of text under the cursor. If you want it rendered with 229 229 + #: the background color of the cell underneath instead, use the 230 230 + #: special keyword: background. Note that if cursor is set to none 231 231 + #: then this option is ignored. 232 232 + 233 233 + # cursor_shape block 234 234 + 235 235 + #: The cursor shape can be one of block, beam, underline. Note that 236 236 + #: when reloading the config this will be changed only if the cursor 237 237 + #: shape has not been set by the program running in the terminal. This 238 238 + #: sets the default cursor shape, applications running in the terminal 239 239 + #: can override it. In particular, shell integration 240 240 + #: <https://sw.kovidgoyal.net/kitty/shell-integration/> in kitty sets 241 241 + #: the cursor shape to beam at shell prompts. You can avoid this by 242 242 + #: setting shell_integration to no-cursor. 243 243 + 244 244 + # cursor_beam_thickness 1.5 245 245 + 246 246 + #: The thickness of the beam cursor (in pts). 247 247 + 248 248 + # cursor_underline_thickness 2.0 249 249 + 250 250 + #: The thickness of the underline cursor (in pts). 251 251 + 252 252 + cursor_blink_interval 0 253 253 + 254 254 + #: The interval to blink the cursor (in seconds). Set to zero to 255 255 + #: disable blinking. Negative values mean use system default. Note 256 256 + #: that the minimum interval will be limited to repaint_delay. 257 257 + 258 258 + # cursor_stop_blinking_after 15.0 259 259 + 260 260 + #: Stop blinking cursor after the specified number of seconds of 261 261 + #: keyboard inactivity. Set to zero to never stop blinking. 262 262 + 263 263 + #: }}} 264 264 + 265 265 + #: Scrollback {{{ 266 266 + 267 267 + # scrollback_lines 2000 268 268 + 269 269 + #: Number of lines of history to keep in memory for scrolling back. 270 270 + #: Memory is allocated on demand. Negative numbers are (effectively) 271 271 + #: infinite scrollback. Note that using very large scrollback is not 272 272 + #: recommended as it can slow down performance of the terminal and 273 273 + #: also use large amounts of RAM. Instead, consider using 274 274 + #: scrollback_pager_history_size. Note that on config reload if this 275 275 + #: is changed it will only affect newly created windows, not existing 276 276 + #: ones. 277 277 + 278 278 + # scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER 279 279 + 280 280 + #: Program with which to view scrollback in a new window. The 281 281 + #: scrollback buffer is passed as STDIN to this program. If you change 282 282 + #: it, make sure the program you use can handle ANSI escape sequences 283 283 + #: for colors and text formatting. INPUT_LINE_NUMBER in the command 284 284 + #: line above will be replaced by an integer representing which line 285 285 + #: should be at the top of the screen. Similarly CURSOR_LINE and 286 286 + #: CURSOR_COLUMN will be replaced by the current cursor position or 287 287 + #: set to 0 if there is no cursor, for example, when showing the last 288 288 + #: command output. 289 289 + 290 290 + # scrollback_pager_history_size 0 291 291 + 292 292 + #: Separate scrollback history size (in MB), used only for browsing 293 293 + #: the scrollback buffer with pager. This separate buffer is not 294 294 + #: available for interactive scrolling but will be piped to the pager 295 295 + #: program when viewing scrollback buffer in a separate window. The 296 296 + #: current implementation stores the data in UTF-8, so approximatively 297 297 + #: 10000 lines per megabyte at 100 chars per line, for pure ASCII, 298 298 + #: unformatted text. A value of zero or less disables this feature. 299 299 + #: The maximum allowed size is 4GB. Note that on config reload if this 300 300 + #: is changed it will only affect newly created windows, not existing 301 301 + #: ones. 302 302 + 303 303 + # scrollback_fill_enlarged_window no 304 304 + 305 305 + #: Fill new space with lines from the scrollback buffer after 306 306 + #: enlarging a window. 307 307 + 308 308 + # wheel_scroll_multiplier 5.0 309 309 + 310 310 + #: Multiplier for the number of lines scrolled by the mouse wheel. 311 311 + #: Note that this is only used for low precision scrolling devices, 312 312 + #: not for high precision scrolling devices on platforms such as macOS 313 313 + #: and Wayland. Use negative numbers to change scroll direction. See 314 314 + #: also wheel_scroll_min_lines. 315 315 + 316 316 + # wheel_scroll_min_lines 1 317 317 + 318 318 + #: The minimum number of lines scrolled by the mouse wheel. The scroll 319 319 + #: multiplier wheel_scroll_multiplier only takes effect after it 320 320 + #: reaches this number. Note that this is only used for low precision 321 321 + #: scrolling devices like wheel mice that scroll by very small amounts 322 322 + #: when using the wheel. With a negative number, the minimum number of 323 323 + #: lines will always be added. 324 324 + 325 325 + # touch_scroll_multiplier 1.0 326 326 + 327 327 + #: Multiplier for the number of lines scrolled by a touchpad. Note 328 328 + #: that this is only used for high precision scrolling devices on 329 329 + #: platforms such as macOS and Wayland. Use negative numbers to change 330 330 + #: scroll direction. 331 331 + 332 332 + #: }}} 333 333 + 334 334 + #: Mouse {{{ 335 335 + 336 336 + # mouse_hide_wait 3.0 337 337 + 338 338 + #: Hide mouse cursor after the specified number of seconds of the 339 339 + #: mouse not being used. Set to zero to disable mouse cursor hiding. 340 340 + #: Set to a negative value to hide the mouse cursor immediately when 341 341 + #: typing text. Disabled by default on macOS as getting it to work 342 342 + #: robustly with the ever-changing sea of bugs that is Cocoa is too 343 343 + #: much effort. 344 344 + 345 345 + # url_color #0087bd 346 346 + # url_style curly 347 347 + 348 348 + #: The color and style for highlighting URLs on mouse-over. url_style 349 349 + #: can be one of: none, straight, double, curly, dotted, dashed. 350 350 + 351 351 + # open_url_with default 352 352 + 353 353 + #: The program to open clicked URLs. The special value default with 354 354 + #: first look for any URL handlers defined via the open_actions 355 355 + #: <https://sw.kovidgoyal.net/kitty/open_actions/> facility and if non 356 356 + #: are found, it will use the Operating System's default URL handler 357 357 + #: (open on macOS and xdg-open on Linux). 358 358 + 359 359 + # url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh 360 360 + 361 361 + #: The set of URL prefixes to look for when detecting a URL under the 362 362 + #: mouse cursor. 363 363 + 364 364 + # detect_urls yes 365 365 + 366 366 + #: Detect URLs under the mouse. Detected URLs are highlighted with an 367 367 + #: underline and the mouse cursor becomes a hand over them. Even if 368 368 + #: this option is disabled, URLs are still clickable. 369 369 + 370 370 + # url_excluded_characters 371 371 + 372 372 + #: Additional characters to be disallowed from URLs, when detecting 373 373 + #: URLs under the mouse cursor. By default, all characters that are 374 374 + #: legal in URLs are allowed. 375 375 + 376 376 + # copy_on_select no 377 377 + 378 378 + #: Copy to clipboard or a private buffer on select. With this set to 379 379 + #: clipboard, selecting text with the mouse will cause the text to be 380 380 + #: copied to clipboard. Useful on platforms such as macOS that do not 381 381 + #: have the concept of primary selection. You can instead specify a 382 382 + #: name such as a1 to copy to a private kitty buffer. Map a shortcut 383 383 + #: with the paste_from_buffer action to paste from this private 384 384 + #: buffer. For example:: 385 385 + 386 386 + #: copy_on_select a1 387 387 + #: map shift+cmd+v paste_from_buffer a1 388 388 + 389 389 + #: Note that copying to the clipboard is a security risk, as all 390 390 + #: programs, including websites open in your browser can read the 391 391 + #: contents of the system clipboard. 392 392 + 393 393 + # paste_actions quote-urls-at-prompt 394 394 + 395 395 + #: A comma separated list of actions to take when pasting text into 396 396 + #: the terminal. The supported paste actions are: 397 397 + 398 398 + #: quote-urls-at-prompt: 399 399 + #: If the text being pasted is a URL and the cursor is at a shell prompt, 400 400 + #: automatically quote the URL (needs shell_integration). 401 401 + #: confirm: 402 402 + #: Confirm the paste if bracketed paste mode is not active or there is more 403 403 + #: a large amount of text being pasted. 404 404 + #: filter: 405 405 + #: Run the filter_paste() function from the file paste-actions.py in 406 406 + #: the kitty config directory on the pasted text. The text returned by the 407 407 + #: function will be actually pasted. 408 408 + 409 409 + # strip_trailing_spaces never 410 410 + 411 411 + #: Remove spaces at the end of lines when copying to clipboard. A 412 412 + #: value of smart will do it when using normal selections, but not 413 413 + #: rectangle selections. A value of always will always do it. 414 414 + 415 415 + # select_by_word_characters @-./_~?&=%+# 416 416 + 417 417 + #: Characters considered part of a word when double clicking. In 418 418 + #: addition to these characters any character that is marked as an 419 419 + #: alphanumeric character in the Unicode database will be matched. 420 420 + 421 421 + # select_by_word_characters_forward 422 422 + 423 423 + #: Characters considered part of a word when extending the selection 424 424 + #: forward on double clicking. In addition to these characters any 425 425 + #: character that is marked as an alphanumeric character in the 426 426 + #: Unicode database will be matched. 427 427 + 428 428 + #: If empty (default) select_by_word_characters will be used for both 429 429 + #: directions. 430 430 + 431 431 + # click_interval -1.0 432 432 + 433 433 + #: The interval between successive clicks to detect double/triple 434 434 + #: clicks (in seconds). Negative numbers will use the system default 435 435 + #: instead, if available, or fallback to 0.5. 436 436 + 437 437 + # focus_follows_mouse no 438 438 + 439 439 + #: Set the active window to the window under the mouse when moving the 440 440 + #: mouse around. 441 441 + 442 442 + # pointer_shape_when_grabbed arrow 443 443 + 444 444 + #: The shape of the mouse pointer when the program running in the 445 445 + #: terminal grabs the mouse. Valid values are: arrow, beam and hand. 446 446 + 447 447 + # default_pointer_shape beam 448 448 + 449 449 + #: The default shape of the mouse pointer. Valid values are: arrow, 450 450 + #: beam and hand. 451 451 + 452 452 + # pointer_shape_when_dragging beam 453 453 + 454 454 + #: The default shape of the mouse pointer when dragging across text. 455 455 + #: Valid values are: arrow, beam and hand. 456 456 + 457 457 + #: Mouse actions {{{ 458 458 + 459 459 + #: Mouse buttons can be mapped to perform arbitrary actions. The 460 460 + #: syntax is: 461 461 + 462 462 + #: .. code-block:: none 463 463 + 464 464 + #: mouse_map button-name event-type modes action 465 465 + 466 466 + #: Where button-name is one of left, middle, right, b1 ... b8 with 467 467 + #: added keyboard modifiers. For example: ctrl+shift+left refers to 468 468 + #: holding the Ctrl+Shift keys while clicking with the left mouse 469 469 + #: button. The value b1 ... b8 can be used to refer to up to eight 470 470 + #: buttons on a mouse. 471 471 + 472 472 + #: event-type is one of press, release, doublepress, triplepress, 473 473 + #: click, doubleclick. modes indicates whether the action is performed 474 474 + #: when the mouse is grabbed by the program running in the terminal, 475 475 + #: or not. The values are grabbed or ungrabbed or a comma separated 476 476 + #: combination of them. grabbed refers to when the program running in 477 477 + #: the terminal has requested mouse events. Note that the click and 478 478 + #: double click events have a delay of click_interval to disambiguate 479 479 + #: from double and triple presses. 480 480 + 481 481 + #: You can run kitty with the kitty --debug-input command line option 482 482 + #: to see mouse events. See the builtin actions below to get a sense 483 483 + #: of what is possible. 484 484 + 485 485 + #: If you want to unmap an action, map it to no_op. For example, to 486 486 + #: disable opening of URLs with a plain click:: 487 487 + 488 488 + #: mouse_map left click ungrabbed no_op 489 489 + 490 490 + #: See all the mappable actions including mouse actions here 491 491 + #: <https://sw.kovidgoyal.net/kitty/actions/>. 492 492 + 493 493 + #: .. note:: 494 494 + #: Once a selection is started, releasing the button that started it will 495 495 + #: automatically end it and no release event will be dispatched. 496 496 + 497 497 + # clear_all_mouse_actions no 498 498 + 499 499 + #: Remove all mouse action definitions up to this point. Useful, for 500 500 + #: instance, to remove the default mouse actions. 501 501 + 502 502 + #: Click the link under the mouse or move the cursor 503 503 + 504 504 + # mouse_map left click ungrabbed mouse_handle_click selection link prompt 505 505 + 506 506 + #:: First check for a selection and if one exists do nothing. Then 507 507 + #:: check for a link under the mouse cursor and if one exists, click 508 508 + #:: it. Finally check if the click happened at the current shell 509 509 + #:: prompt and if so, move the cursor to the click location. Note 510 510 + #:: that this requires shell integration 511 511 + #:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work. 512 512 + 513 513 + #: Click the link under the mouse or move the cursor even when grabbed 514 514 + 515 515 + # mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt 516 516 + 517 517 + #:: Same as above, except that the action is performed even when the 518 518 + #:: mouse is grabbed by the program running in the terminal. 519 519 + 520 520 + #: Click the link under the mouse cursor 521 521 + 522 522 + # mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link 523 523 + 524 524 + #:: Variant with Ctrl+Shift is present because the simple click based 525 525 + #:: version has an unavoidable delay of click_interval, to 526 526 + #:: disambiguate clicks from double clicks. 527 527 + 528 528 + #: Discard press event for link click 529 529 + 530 530 + # mouse_map ctrl+shift+left press grabbed discard_event 531 531 + 532 532 + #:: Prevent this press event from being sent to the program that has 533 533 + #:: grabbed the mouse, as the corresponding release event is used to 534 534 + #:: open a URL. 535 535 + 536 536 + #: Paste from the primary selection 537 537 + 538 538 + # mouse_map middle release ungrabbed paste_from_selection 539 539 + 540 540 + #: Start selecting text 541 541 + 542 542 + # mouse_map left press ungrabbed mouse_selection normal 543 543 + 544 544 + #: Start selecting text in a rectangle 545 545 + 546 546 + # mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle 547 547 + 548 548 + #: Select a word 549 549 + 550 550 + # mouse_map left doublepress ungrabbed mouse_selection word 551 551 + 552 552 + #: Select a line 553 553 + 554 554 + # mouse_map left triplepress ungrabbed mouse_selection line 555 555 + 556 556 + #: Select line from point 557 557 + 558 558 + # mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point 559 559 + 560 560 + #:: Select from the clicked point to the end of the line. 561 561 + 562 562 + #: Extend the current selection 563 563 + 564 564 + # mouse_map right press ungrabbed mouse_selection extend 565 565 + 566 566 + #:: If you want only the end of the selection to be moved instead of 567 567 + #:: the nearest boundary, use move-end instead of extend. 568 568 + 569 569 + #: Paste from the primary selection even when grabbed 570 570 + 571 571 + # mouse_map shift+middle release ungrabbed,grabbed paste_selection 572 572 + # mouse_map shift+middle press grabbed discard_event 573 573 + 574 574 + #: Start selecting text even when grabbed 575 575 + 576 576 + # mouse_map shift+left press ungrabbed,grabbed mouse_selection normal 577 577 + 578 578 + #: Start selecting text in a rectangle even when grabbed 579 579 + 580 580 + # mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle 581 581 + 582 582 + #: Select a word even when grabbed 583 583 + 584 584 + # mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word 585 585 + 586 586 + #: Select a line even when grabbed 587 587 + 588 588 + # mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line 589 589 + 590 590 + #: Select line from point even when grabbed 591 591 + 592 592 + # mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point 593 593 + 594 594 + #:: Select from the clicked point to the end of the line even when 595 595 + #:: grabbed. 596 596 + 597 597 + #: Extend the current selection even when grabbed 598 598 + 599 599 + # mouse_map shift+right press ungrabbed,grabbed mouse_selection extend 600 600 + 601 601 + #: Show clicked command output in pager 602 602 + 603 603 + # mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output 604 604 + 605 605 + #:: Requires shell integration 606 606 + #:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work. 607 607 + 608 608 + #: }}} 609 609 + 610 610 + #: }}} 611 611 + 612 612 + #: Performance tuning {{{ 613 613 + 614 614 + # repaint_delay 10 615 615 + 616 616 + #: Delay between screen updates (in milliseconds). Decreasing it, 617 617 + #: increases frames-per-second (FPS) at the cost of more CPU usage. 618 618 + #: The default value yields ~100 FPS which is more than sufficient for 619 619 + #: most uses. Note that to actually achieve 100 FPS, you have to 620 620 + #: either set sync_to_monitor to no or use a monitor with a high 621 621 + #: refresh rate. Also, to minimize latency when there is pending input 622 622 + #: to be processed, this option is ignored. 623 623 + 624 624 + # input_delay 3 625 625 + 626 626 + #: Delay before input from the program running in the terminal is 627 627 + #: processed (in milliseconds). Note that decreasing it will increase 628 628 + #: responsiveness, but also increase CPU usage and might cause flicker 629 629 + #: in full screen programs that redraw the entire screen on each loop, 630 630 + #: because kitty is so fast that partial screen updates will be drawn. 631 631 + 632 632 + # sync_to_monitor yes 633 633 + 634 634 + #: Sync screen updates to the refresh rate of the monitor. This 635 635 + #: prevents screen tearing 636 636 + #: <https://en.wikipedia.org/wiki/Screen_tearing> when scrolling. 637 637 + #: However, it limits the rendering speed to the refresh rate of your 638 638 + #: monitor. With a very high speed mouse/high keyboard repeat rate, 639 639 + #: you may notice some slight input latency. If so, set this to no. 640 640 + 641 641 + #: }}} 642 642 + 643 643 + #: Terminal bell {{{ 644 644 + 645 645 + # enable_audio_bell yes 646 646 + 647 647 + #: The audio bell. Useful to disable it in environments that require 648 648 + #: silence. 649 649 + 650 650 + # visual_bell_duration 0.0 651 651 + 652 652 + #: The visual bell duration (in seconds). Flash the screen when a bell 653 653 + #: occurs for the specified number of seconds. Set to zero to disable. 654 654 + 655 655 + # visual_bell_color none 656 656 + 657 657 + #: The color used by visual bell. Set to none will fall back to 658 658 + #: selection background color. If you feel that the visual bell is too 659 659 + #: bright, you can set it to a darker color. 660 660 + 661 661 + # window_alert_on_bell yes 662 662 + 663 663 + #: Request window attention on bell. Makes the dock icon bounce on 664 664 + #: macOS or the taskbar flash on linux. 665 665 + 666 666 + # bell_on_tab "🔔 " 667 667 + 668 668 + #: Some text or a Unicode symbol to show on the tab if a window in the 669 669 + #: tab that does not have focus has a bell. If you want to use leading 670 670 + #: or trailing spaces, surround the text with quotes. See 671 671 + #: tab_title_template for how this is rendered. 672 672 + 673 673 + #: For backwards compatibility, values of yes, y and true are 674 674 + #: converted to the default bell symbol and no, n, false and none are 675 675 + #: converted to the empty string. 676 676 + 677 677 + # command_on_bell none 678 678 + 679 679 + #: Program to run when a bell occurs. The environment variable 680 680 + #: KITTY_CHILD_CMDLINE can be used to get the program running in the 681 681 + #: window in which the bell occurred. 682 682 + 683 683 + # bell_path none 684 684 + 685 685 + #: Path to a sound file to play as the bell sound. If set to none, the 686 686 + #: system default bell sound is used. Must be in a format supported by 687 687 + #: the operating systems sound API, such as WAV or OGA on Linux 688 688 + #: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound) 689 689 + 690 690 + #: }}} 691 691 + 692 692 + #: Window layout {{{ 693 693 + 694 694 + # remember_window_size yes 695 695 + # initial_window_width 640 696 696 + # initial_window_height 400 697 697 + 698 698 + #: If enabled, the window size will be remembered so that new 699 699 + #: instances of kitty will have the same size as the previous 700 700 + #: instance. If disabled, the window will initially have size 701 701 + #: configured by initial_window_width/height, in pixels. You can use a 702 702 + #: suffix of "c" on the width/height values to have them interpreted 703 703 + #: as number of cells instead of pixels. 704 704 + 705 705 + # enabled_layouts * 706 706 + 707 707 + #: The enabled window layouts. A comma separated list of layout names. 708 708 + #: The special value all means all layouts. The first listed layout 709 709 + #: will be used as the startup layout. Default configuration is all 710 710 + #: layouts in alphabetical order. For a list of available layouts, see 711 711 + #: the layouts <https://sw.kovidgoyal.net/kitty/overview/#layouts>. 712 712 + 713 713 + # window_resize_step_cells 2 714 714 + # window_resize_step_lines 2 715 715 + 716 716 + #: The step size (in units of cell width/cell height) to use when 717 717 + #: resizing kitty windows in a layout with the shortcut 718 718 + #: start_resizing_window. The cells value is used for horizontal 719 719 + #: resizing, and the lines value is used for vertical resizing. 720 720 + 721 721 + # window_border_width 0.5pt 722 722 + 723 723 + #: The width of window borders. Can be either in pixels (px) or pts 724 724 + #: (pt). Values in pts will be rounded to the nearest number of pixels 725 725 + #: based on screen resolution. If not specified, the unit is assumed 726 726 + #: to be pts. Note that borders are displayed only when more than one 727 727 + #: window is visible. They are meant to separate multiple windows. 728 728 + 729 729 + # draw_minimal_borders yes 730 730 + 731 731 + #: Draw only the minimum borders needed. This means that only the 732 732 + #: borders that separate the inactive window from a neighbor are 733 733 + #: drawn. Note that setting a non-zero window_margin_width overrides 734 734 + #: this and causes all borders to be drawn. 735 735 + 736 736 + # window_margin_width 0 737 737 + 738 738 + #: The window margin (in pts) (blank area outside the border). A 739 739 + #: single value sets all four sides. Two values set the vertical and 740 740 + #: horizontal sides. Three values set top, horizontal and bottom. Four 741 741 + #: values set top, right, bottom and left. 742 742 + 743 743 + # single_window_margin_width -1 744 744 + 745 745 + #: The window margin to use when only a single window is visible (in 746 746 + #: pts). Negative values will cause the value of window_margin_width 747 747 + #: to be used instead. A single value sets all four sides. Two values 748 748 + #: set the vertical and horizontal sides. Three values set top, 749 749 + #: horizontal and bottom. Four values set top, right, bottom and left. 750 750 + 751 751 + # window_padding_width 0 752 752 + 753 753 + #: The window padding (in pts) (blank area between the text and the 754 754 + #: window border). A single value sets all four sides. Two values set 755 755 + #: the vertical and horizontal sides. Three values set top, horizontal 756 756 + #: and bottom. Four values set top, right, bottom and left. 757 757 + 758 758 + # placement_strategy center 759 759 + 760 760 + #: When the window size is not an exact multiple of the cell size, the 761 761 + #: cell area of the terminal window will have some extra padding on 762 762 + #: the sides. You can control how that padding is distributed with 763 763 + #: this option. Using a value of center means the cell area will be 764 764 + #: placed centrally. A value of top-left means the padding will be 765 765 + #: only at the bottom and right edges. 766 766 + 767 767 + # active_border_color #00ff00 768 768 + 769 769 + #: The color for the border of the active window. Set this to none to 770 770 + #: not draw borders around the active window. 771 771 + 772 772 + # inactive_border_color #cccccc 773 773 + 774 774 + #: The color for the border of inactive windows. 775 775 + 776 776 + # bell_border_color #ff5a00 777 777 + 778 778 + #: The color for the border of inactive windows in which a bell has 779 779 + #: occurred. 780 780 + 781 781 + # inactive_text_alpha 1.0 782 782 + 783 783 + #: Fade the text in inactive windows by the specified amount (a number 784 784 + #: between zero and one, with zero being fully faded). 785 785 + 786 786 + # hide_window_decorations no 787 787 + 788 788 + #: Hide the window decorations (title-bar and window borders) with 789 789 + #: yes. On macOS, titlebar-only can be used to only hide the titlebar. 790 790 + #: Whether this works and exactly what effect it has depends on the 791 791 + #: window manager/operating system. Note that the effects of changing 792 792 + #: this option when reloading config are undefined. 793 793 + 794 794 + # window_logo_path none 795 795 + 796 796 + #: Path to a logo image. Must be in PNG format. Relative paths are 797 797 + #: interpreted relative to the kitty config directory. The logo is 798 798 + #: displayed in a corner of every kitty window. The position is 799 799 + #: controlled by window_logo_position. Individual windows can be 800 800 + #: configured to have different logos either using the launch action 801 801 + #: or the remote control <https://sw.kovidgoyal.net/kitty/remote- 802 802 + #: control/> facility. 803 803 + 804 804 + # window_logo_position bottom-right 805 805 + 806 806 + #: Where to position the window logo in the window. The value can be 807 807 + #: one of: top-left, top, top-right, left, center, right, bottom-left, 808 808 + #: bottom, bottom-right. 809 809 + 810 810 + # window_logo_alpha 0.5 811 811 + 812 812 + #: The amount the logo should be faded into the background. With zero 813 813 + #: being fully faded and one being fully opaque. 814 814 + 815 815 + # resize_debounce_time 0.1 816 816 + 817 817 + #: The time to wait before redrawing the screen when a resize event is 818 818 + #: received (in seconds). On platforms such as macOS, where the 819 819 + #: operating system sends events corresponding to the start and end of 820 820 + #: a resize, this number is ignored. 821 821 + 822 822 + # resize_draw_strategy static 823 823 + 824 824 + #: Choose how kitty draws a window while a resize is in progress. A 825 825 + #: value of static means draw the current window contents, mostly 826 826 + #: unchanged. A value of scale means draw the current window contents 827 827 + #: scaled. A value of blank means draw a blank window. A value of size 828 828 + #: means show the window size in cells. 829 829 + 830 830 + resize_in_steps yes 831 831 + 832 832 + #: Resize the OS window in steps as large as the cells, instead of 833 833 + #: with the usual pixel accuracy. Combined with initial_window_width 834 834 + #: and initial_window_height in number of cells, this option can be 835 835 + #: used to keep the margins as small as possible when resizing the OS 836 836 + #: window. Note that this does not currently work on Wayland. 837 837 + 838 838 + # visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ 839 839 + 840 840 + #: The list of characters for visual window selection. For example, 841 841 + #: for selecting a window to focus on with focus_visible_window. The 842 842 + #: value should be a series of unique numbers or alphabets, case 843 843 + #: insensitive, from the set [0-9A-Z]. Specify your preference as a 844 844 + #: string of characters. 845 845 + 846 846 + # confirm_os_window_close -1 847 847 + 848 848 + #: Ask for confirmation when closing an OS window or a tab with at 849 849 + #: least this number of kitty windows in it by window manager (e.g. 850 850 + #: clicking the window close button or pressing the operating system 851 851 + #: shortcut to close windows) or by the close_tab action. A value of 852 852 + #: zero disables confirmation. This confirmation also applies to 853 853 + #: requests to quit the entire application (all OS windows, via the 854 854 + #: quit action). Negative values are converted to positive ones, 855 855 + #: however, with shell_integration enabled, using negative values 856 856 + #: means windows sitting at a shell prompt are not counted, only 857 857 + #: windows where some command is currently running. Note that if you 858 858 + #: want confirmation when closing individual windows, you can map the 859 859 + #: close_window_with_confirmation action. 860 860 + 861 861 + #: }}} 862 862 + 863 863 + #: Tab bar {{{ 864 864 + 865 865 + # tab_bar_edge bottom 866 866 + 867 867 + #: The edge to show the tab bar on, top or bottom. 868 868 + 869 869 + # tab_bar_margin_width 0.0 870 870 + 871 871 + #: The margin to the left and right of the tab bar (in pts). 872 872 + 873 873 + # tab_bar_margin_height 0.0 0.0 874 874 + 875 875 + #: The margin above and below the tab bar (in pts). The first number 876 876 + #: is the margin between the edge of the OS Window and the tab bar. 877 877 + #: The second number is the margin between the tab bar and the 878 878 + #: contents of the current tab. 879 879 + 880 880 + # tab_bar_style fade 881 881 + 882 882 + #: The tab bar style, can be one of: 883 883 + 884 884 + #: fade 885 885 + #: Each tab's edges fade into the background color. (See also tab_fade) 886 886 + #: slant 887 887 + #: Tabs look like the tabs in a physical file. 888 888 + #: separator 889 889 + #: Tabs are separated by a configurable separator. (See also 890 890 + #: tab_separator) 891 891 + #: powerline 892 892 + #: Tabs are shown as a continuous line with "fancy" separators. 893 893 + #: (See also tab_powerline_style) 894 894 + #: custom 895 895 + #: A user-supplied Python function called draw_tab is loaded from the file 896 896 + #: tab_bar.py in the kitty config directory. For examples of how to 897 897 + #: write such a function, see the functions named draw_tab_with_* in 898 898 + #: kitty's source code: kitty/tab_bar.py. See also 899 899 + #: this discussion <https://github.com/kovidgoyal/kitty/discussions/4447> 900 900 + #: for examples from kitty users. 901 901 + #: hidden 902 902 + #: The tab bar is hidden. If you use this, you might want to create a mapping 903 903 + #: for the select_tab action which presents you with a list of tabs and 904 904 + #: allows for easy switching to a tab. 905 905 + 906 906 + # tab_bar_align left 907 907 + 908 908 + #: The horizontal alignment of the tab bar, can be one of: left, 909 909 + #: center, right. 910 910 + 911 911 + # tab_bar_min_tabs 2 912 912 + 913 913 + #: The minimum number of tabs that must exist before the tab bar is 914 914 + #: shown. 915 915 + 916 916 + # tab_switch_strategy previous 917 917 + 918 918 + #: The algorithm to use when switching to a tab when the current tab 919 919 + #: is closed. The default of previous will switch to the last used 920 920 + #: tab. A value of left will switch to the tab to the left of the 921 921 + #: closed tab. A value of right will switch to the tab to the right of 922 922 + #: the closed tab. A value of last will switch to the right-most tab. 923 923 + 924 924 + # tab_fade 0.25 0.5 0.75 1 925 925 + 926 926 + #: Control how each tab fades into the background when using fade for 927 927 + #: the tab_bar_style. Each number is an alpha (between zero and one) 928 928 + #: that controls how much the corresponding cell fades into the 929 929 + #: background, with zero being no fade and one being full fade. You 930 930 + #: can change the number of cells used by adding/removing entries to 931 931 + #: this list. 932 932 + 933 933 + # tab_separator " ┇" 934 934 + 935 935 + #: The separator between tabs in the tab bar when using separator as 936 936 + #: the tab_bar_style. 937 937 + 938 938 + # tab_powerline_style angled 939 939 + 940 940 + #: The powerline separator style between tabs in the tab bar when 941 941 + #: using powerline as the tab_bar_style, can be one of: angled, 942 942 + #: slanted, round. 943 943 + 944 944 + # tab_activity_symbol none 945 945 + 946 946 + #: Some text or a Unicode symbol to show on the tab if a window in the 947 947 + #: tab that does not have focus has some activity. If you want to use 948 948 + #: leading or trailing spaces, surround the text with quotes. See 949 949 + #: tab_title_template for how this is rendered. 950 950 + 951 951 + # tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title}" 952 952 + 953 953 + #: A template to render the tab title. The default just renders the 954 954 + #: title with optional symbols for bell and activity. If you wish to 955 955 + #: include the tab-index as well, use something like: {index}:{title}. 956 956 + #: Useful if you have shortcuts mapped for goto_tab N. If you prefer 957 957 + #: to see the index as a superscript, use {sup.index}. All data 958 958 + #: available is: 959 959 + 960 960 + #: title 961 961 + #: The current tab title. 962 962 + #: index 963 963 + #: The tab index useable with goto_tab N goto_tab shortcuts. 964 964 + #: layout_name 965 965 + #: The current layout name. 966 966 + #: num_windows 967 967 + #: The number of windows in the tab. 968 968 + #: num_window_groups 969 969 + #: The number of window groups (not counting overlay windows) in the tab. 970 970 + #: tab.active_wd 971 971 + #: The working directory of the currently active window in the tab (expensive, 972 972 + #: requires syscall). 973 973 + #: max_title_length 974 974 + #: The maximum title length available. 975 975 + 976 976 + #: Note that formatting is done by Python's string formatting 977 977 + #: machinery, so you can use, for instance, {layout_name[:2].upper()} 978 978 + #: to show only the first two letters of the layout name, upper-cased. 979 979 + #: If you want to style the text, you can use styling directives, for 980 980 + #: example: 981 981 + #: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`. 982 982 + #: Similarly, for bold and italic: 983 983 + #: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`. 984 984 + #: Note that for backward compatibility, if {bell_symbol} or 985 985 + #: {activity_symbol} are not present in the template, they are 986 986 + #: prepended to it. 987 987 + 988 988 + # active_tab_title_template none 989 989 + 990 990 + #: Template to use for active tabs. If not specified falls back to 991 991 + #: tab_title_template. 992 992 + 993 993 + # active_tab_foreground #000 994 994 + # active_tab_background #eee 995 995 + # active_tab_font_style bold-italic 996 996 + # inactive_tab_foreground #444 997 997 + # inactive_tab_background #999 998 998 + # inactive_tab_font_style normal 999 999 + 1000 1000 + #: Tab bar colors and styles. 1001 1001 + 1002 1002 + # tab_bar_background none 1003 1003 + 1004 1004 + #: Background color for the tab bar. Defaults to using the terminal 1005 1005 + #: background color. 1006 1006 + 1007 1007 + # tab_bar_margin_color none 1008 1008 + 1009 1009 + #: Color for the tab bar margin area. Defaults to using the terminal 1010 1010 + #: background color. 1011 1011 + 1012 1012 + #: }}} 1013 1013 + 1014 1014 + #: Color scheme {{{ 1015 1015 + 1016 1016 + # foreground #dddddd 1017 1017 + # background #000000 1018 1018 + 1019 1019 + #: The foreground and background colors. 1020 1020 + 1021 1021 + # background_opacity 0.9 1022 1022 + 1023 1023 + #: The opacity of the background. A number between zero and one, where 1024 1024 + #: one is opaque and zero is fully transparent. This will only work if 1025 1025 + #: supported by the OS (for instance, when using a compositor under 1026 1026 + #: X11). Note that it only sets the background color's opacity in 1027 1027 + #: cells that have the same background color as the default terminal 1028 1028 + #: background, so that things like the status bar in vim, powerline 1029 1029 + #: prompts, etc. still look good. But it means that if you use a color 1030 1030 + #: theme with a background color in your editor, it will not be 1031 1031 + #: rendered as transparent. Instead you should change the default 1032 1032 + #: background color in your kitty config and not use a background 1033 1033 + #: color in the editor color scheme. Or use the escape codes to set 1034 1034 + #: the terminals default colors in a shell script to launch your 1035 1035 + #: editor. Be aware that using a value less than 1.0 is a (possibly 1036 1036 + #: significant) performance hit. If you want to dynamically change 1037 1037 + #: transparency of windows, set dynamic_background_opacity to yes 1038 1038 + #: (this is off by default as it has a performance cost). Changing 1039 1039 + #: this option when reloading the config will only work if 1040 1040 + #: dynamic_background_opacity was enabled in the original config. 1041 1041 + 1042 1042 + # background_image none 1043 1043 + 1044 1044 + #: Path to a background image. Must be in PNG format. 1045 1045 + 1046 1046 + # background_image_layout tiled 1047 1047 + 1048 1048 + #: Whether to tile, scale or clamp the background image. The value can 1049 1049 + #: be one of tiled, mirror-tiled, scaled, clamped or centered. 1050 1050 + 1051 1051 + # background_image_linear no 1052 1052 + 1053 1053 + #: When background image is scaled, whether linear interpolation 1054 1054 + #: should be used. 1055 1055 + 1056 1056 + # dynamic_background_opacity no 1057 1057 + 1058 1058 + #: Allow changing of the background_opacity dynamically, using either 1059 1059 + #: keyboard shortcuts (increase_background_opacity and 1060 1060 + #: decrease_background_opacity) or the remote control facility. 1061 1061 + #: Changing this option by reloading the config is not supported. 1062 1062 + 1063 1063 + # background_tint 0.0 1064 1064 + 1065 1065 + #: How much to tint the background image by the background color. 1066 1066 + #: This option makes it easier to read the text. Tinting is done using 1067 1067 + #: the current background color for each window. This option applies 1068 1068 + #: only if background_opacity is set and transparent windows are 1069 1069 + #: supported or background_image is set. 1070 1070 + 1071 1071 + # dim_opacity 0.75 1072 1072 + 1073 1073 + #: How much to dim text that has the DIM/FAINT attribute set. One 1074 1074 + #: means no dimming and zero means fully dimmed (i.e. invisible). 1075 1075 + 1076 1076 + # selection_foreground #000000 1077 1077 + # selection_background #fffacd 1078 1078 + 1079 1079 + #: The foreground and background colors for text selected with the 1080 1080 + #: mouse. Setting both of these to none will cause a "reverse video" 1081 1081 + #: effect for selections, where the selection will be the cell text 1082 1082 + #: color and the text will become the cell background color. Setting 1083 1083 + #: only selection_foreground to none will cause the foreground color 1084 1084 + #: to be used unchanged. Note that these colors can be overridden by 1085 1085 + #: the program running in the terminal. 1086 1086 + 1087 1087 + #: The color table {{{ 1088 1088 + 1089 1089 + #: The 256 terminal colors. There are 8 basic colors, each color has a 1090 1090 + #: dull and bright version, for the first 16 colors. You can set the 1091 1091 + #: remaining 240 colors as color16 to color255. 1092 1092 + 1093 1093 + # color0 #000000 1094 1094 + # color8 #767676 1095 1095 + 1096 1096 + #: black 1097 1097 + 1098 1098 + # color1 #cc0403 1099 1099 + # color9 #f2201f 1100 1100 + 1101 1101 + #: red 1102 1102 + 1103 1103 + # color2 #19cb00 1104 1104 + # color10 #23fd00 1105 1105 + 1106 1106 + #: green 1107 1107 + 1108 1108 + # color3 #cecb00 1109 1109 + # color11 #fffd00 1110 1110 + 1111 1111 + #: yellow 1112 1112 + 1113 1113 + # color4 #0d73cc 1114 1114 + # color12 #1a8fff 1115 1115 + 1116 1116 + #: blue 1117 1117 + 1118 1118 + # color5 #cb1ed1 1119 1119 + # color13 #fd28ff 1120 1120 + 1121 1121 + #: magenta 1122 1122 + 1123 1123 + # color6 #0dcdcd 1124 1124 + # color14 #14ffff 1125 1125 + 1126 1126 + #: cyan 1127 1127 + 1128 1128 + # color7 #dddddd 1129 1129 + # color15 #ffffff 1130 1130 + 1131 1131 + #: white 1132 1132 + 1133 1133 + # mark1_foreground black 1134 1134 + 1135 1135 + #: Color for marks of type 1 1136 1136 + 1137 1137 + # mark1_background #98d3cb 1138 1138 + 1139 1139 + #: Color for marks of type 1 (light steel blue) 1140 1140 + 1141 1141 + # mark2_foreground black 1142 1142 + 1143 1143 + #: Color for marks of type 2 1144 1144 + 1145 1145 + # mark2_background #f2dcd3 1146 1146 + 1147 1147 + #: Color for marks of type 1 (beige) 1148 1148 + 1149 1149 + # mark3_foreground black 1150 1150 + 1151 1151 + #: Color for marks of type 3 1152 1152 + 1153 1153 + # mark3_background #f274bc 1154 1154 + 1155 1155 + #: Color for marks of type 3 (violet) 1156 1156 + 1157 1157 + #: }}} 1158 1158 + 1159 1159 + #: }}} 1160 1160 + 1161 1161 + #: Advanced {{{ 1162 1162 + 1163 1163 + # shell . 1164 1164 + 1165 1165 + #: The shell program to execute. The default value of . means to use 1166 1166 + #: whatever shell is set as the default shell for the current user. 1167 1167 + #: Note that on macOS if you change this, you might need to add 1168 1168 + #: --login and --interactive to ensure that the shell starts in 1169 1169 + #: interactive mode and reads its startup rc files. 1170 1170 + 1171 1171 + # editor . 1172 1172 + 1173 1173 + #: The terminal based text editor (such as vim or nano) to use when 1174 1174 + #: editing the kitty config file or similar tasks. 1175 1175 + 1176 1176 + #: The default value of . means to use the environment variables 1177 1177 + #: VISUAL and EDITOR in that order. If these variables aren't set, 1178 1178 + #: kitty will run your shell ($SHELL -l -i -c env) to see if your 1179 1179 + #: shell startup rc files set VISUAL or EDITOR. If that doesn't work, 1180 1180 + #: kitty will cycle through various known editors (vim, emacs, etc.) 1181 1181 + #: and take the first one that exists on your system. 1182 1182 + 1183 1183 + # close_on_child_death no 1184 1184 + 1185 1185 + #: Close the window when the child process (shell) exits. With the 1186 1186 + #: default value no, the terminal will remain open when the child 1187 1187 + #: exits as long as there are still processes outputting to the 1188 1188 + #: terminal (for example disowned or backgrounded processes). When 1189 1189 + #: enabled with yes, the window will close as soon as the child 1190 1190 + #: process exits. Note that setting it to yes means that any 1191 1191 + #: background processes still using the terminal can fail silently 1192 1192 + #: because their stdout/stderr/stdin no longer work. 1193 1193 + 1194 1194 + # remote_control_password 1195 1195 + 1196 1196 + #: Allow other programs to control kitty using passwords. This option 1197 1197 + #: can be specified multiple times to add multiple passwords. If no 1198 1198 + #: passwords are present kitty will ask the user for permission if a 1199 1199 + #: program tries to use remote control with a password. A password can 1200 1200 + #: also *optionally* be associated with a set of allowed remote 1201 1201 + #: control actions. For example:: 1202 1202 + 1203 1203 + #: remote_control_password "my passphrase" get-colors set-colors focus-window focus-tab 1204 1204 + 1205 1205 + #: Only the specified actions will be allowed when using this 1206 1206 + #: password. Glob patterns can be used too, for example:: 1207 1207 + 1208 1208 + #: remote_control_password "my passphrase" set-tab-* resize-* 1209 1209 + 1210 1210 + #: To get a list of available actions, run:: 1211 1211 + 1212 1212 + #: kitty @ --help 1213 1213 + 1214 1214 + #: A set of actions to be allowed when no password is sent can be 1215 1215 + #: specified by using an empty password, for example:: 1216 1216 + 1217 1217 + #: remote_control_password "" *-colors 1218 1218 + 1219 1219 + #: Finally, the path to a python module can be specified that provides 1220 1220 + #: a function is_cmd_allowed that is used to check every remote 1221 1221 + #: control command. See rc_custom_auth 1222 1222 + #: <https://sw.kovidgoyal.net/kitty/remote-control/#rc-custom-auth> 1223 1223 + #: for details. For example:: 1224 1224 + 1225 1225 + #: remote_control_password "my passphrase" my_rc_command_checker.py 1226 1226 + 1227 1227 + #: Relative paths are resolved from the kitty configuration directory. 1228 1228 + 1229 1229 + # allow_remote_control no 1230 1230 + 1231 1231 + #: Allow other programs to control kitty. If you turn this on, other 1232 1232 + #: programs can control all aspects of kitty, including sending text 1233 1233 + #: to kitty windows, opening new windows, closing windows, reading the 1234 1234 + #: content of windows, etc. Note that this even works over SSH 1235 1235 + #: connections. The default setting of no prevents any form of remote 1236 1236 + #: control. The meaning of the various values are: 1237 1237 + 1238 1238 + #: password 1239 1239 + #: Remote control requests received over both the TTY device and the socket are 1240 1240 + #: confirmed based on passwords, see remote_control_password. 1241 1241 + 1242 1242 + #: socket-only 1243 1243 + #: Remote control requests received over a socket are accepted unconditionally. 1244 1244 + #: Requests received over the TTY are denied. See listen_on. 1245 1245 + 1246 1246 + #: socket 1247 1247 + #: Remote control requests received over a socket are accepted unconditionally. 1248 1248 + #: Requests received over the TTY are confirmed based on password. 1249 1249 + 1250 1250 + #: no 1251 1251 + #: Remote control is completely disabled. 1252 1252 + 1253 1253 + #: yes 1254 1254 + #: Remote control requests are always accepted. 1255 1255 + 1256 1256 + # listen_on none 1257 1257 + 1258 1258 + #: Listen to the specified UNIX socket for remote control connections. 1259 1259 + #: Note that this will apply to all kitty instances. It can be 1260 1260 + #: overridden by the kitty --listen-on command line option, which also 1261 1261 + #: supports listening on a TCP socket. This option accepts only UNIX 1262 1262 + #: sockets, such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux). 1263 1263 + #: Environment variables are expanded and relative paths are resolved 1264 1264 + #: with respect to the temporary directory. If {kitty_pid} is present, 1265 1265 + #: then it is replaced by the PID of the kitty process, otherwise the 1266 1266 + #: PID of the kitty process is appended to the value, with a hyphen. 1267 1267 + #: See the help for kitty --listen-on for more details. Note that this 1268 1268 + #: will be ignored unless allow_remote_control is set to either: yes, 1269 1269 + #: socket or socket-only. Changing this option by reloading the config 1270 1270 + #: is not supported. 1271 1271 + 1272 1272 + # env 1273 1273 + 1274 1274 + #: Specify the environment variables to be set in all child processes. 1275 1275 + #: Using the name with an equal sign (e.g. env VAR=) will set it to 1276 1276 + #: the empty string. Specifying only the name (e.g. env VAR) will 1277 1277 + #: remove the variable from the child process' environment. Note that 1278 1278 + #: environment variables are expanded recursively, for example:: 1279 1279 + 1280 1280 + #: env VAR1=a 1281 1281 + #: env VAR2=${HOME}/${VAR1}/b 1282 1282 + 1283 1283 + #: The value of VAR2 will be <path to home directory>/a/b. 1284 1284 + 1285 1285 + # watcher 1286 1286 + 1287 1287 + #: Path to python file which will be loaded for watchers 1288 1288 + #: <https://sw.kovidgoyal.net/kitty/launch/#watchers>. Can be 1289 1289 + #: specified more than once to load multiple watchers. The watchers 1290 1290 + #: will be added to every kitty window. Relative paths are resolved 1291 1291 + #: relative to the kitty config directory. Note that reloading the 1292 1292 + #: config will only affect windows created after the reload. 1293 1293 + 1294 1294 + # exe_search_path 1295 1295 + 1296 1296 + #: Control where kitty finds the programs to run. The default search 1297 1297 + #: order is: First search the system wide PATH, then ~/.local/bin and 1298 1298 + #: ~/bin. If still not found, the PATH defined in the login shell 1299 1299 + #: after sourcing all its startup files is tried. Finally, if present, 1300 1300 + #: the PATH specified by the env option is tried. 1301 1301 + 1302 1302 + #: This option allows you to prepend, append, or remove paths from 1303 1303 + #: this search order. It can be specified multiple times for multiple 1304 1304 + #: paths. A simple path will be prepended to the search order. A path 1305 1305 + #: that starts with the + sign will be append to the search order, 1306 1306 + #: after ~/bin above. A path that starts with the - sign will be 1307 1307 + #: removed from the entire search order. For example:: 1308 1308 + 1309 1309 + #: exe_search_path /some/prepended/path 1310 1310 + #: exe_search_path +/some/appended/path 1311 1311 + #: exe_search_path -/some/excluded/path 1312 1312 + 1313 1313 + # update_check_interval 24 1314 1314 + 1315 1315 + #: The interval to periodically check if an update to kitty is 1316 1316 + #: available (in hours). If an update is found, a system notification 1317 1317 + #: is displayed informing you of the available update. The default is 1318 1318 + #: to check every 24 hours, set to zero to disable. Update checking is 1319 1319 + #: only done by the official binary builds. Distro packages or source 1320 1320 + #: builds do not do update checking. Changing this option by reloading 1321 1321 + #: the config is not supported. 1322 1322 + 1323 1323 + # startup_session none 1324 1324 + 1325 1325 + #: Path to a session file to use for all kitty instances. Can be 1326 1326 + #: overridden by using the kitty --session command line option for 1327 1327 + #: individual instances. See sessions 1328 1328 + #: <https://sw.kovidgoyal.net/kitty/overview/#sessions> in the kitty 1329 1329 + #: documentation for details. Note that relative paths are interpreted 1330 1330 + #: with respect to the kitty config directory. Environment variables 1331 1331 + #: in the path are expanded. Changing this option by reloading the 1332 1332 + #: config is not supported. 1333 1333 + 1334 1334 + # clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask 1335 1335 + 1336 1336 + #: Allow programs running in kitty to read and write from the 1337 1337 + #: clipboard. You can control exactly which actions are allowed. The 1338 1338 + #: possible actions are: write-clipboard, read-clipboard, write- 1339 1339 + #: primary, read-primary, read-clipboard-ask, read-primary-ask. The 1340 1340 + #: default is to allow writing to the clipboard and primary selection 1341 1341 + #: and to ask for permission when a program tries to read from the 1342 1342 + #: clipboard. Note that disabling the read confirmation is a security 1343 1343 + #: risk as it means that any program, even the ones running on a 1344 1344 + #: remote server via SSH can read your clipboard. See also 1345 1345 + #: clipboard_max_size. 1346 1346 + 1347 1347 + # clipboard_max_size 64 1348 1348 + 1349 1349 + #: The maximum size (in MB) of data from programs running in kitty 1350 1350 + #: that will be stored for writing to the system clipboard. A value of 1351 1351 + #: zero means no size limit is applied. See also clipboard_control. 1352 1352 + 1353 1353 + # file_transfer_confirmation_bypass 1354 1354 + 1355 1355 + #: The password that can be supplied to the file transfer kitten 1356 1356 + #: <https://sw.kovidgoyal.net/kitty/kittens/transfer/> to skip the 1357 1357 + #: transfer confirmation prompt. This should only be used when 1358 1358 + #: initiating transfers from trusted computers, over trusted networks 1359 1359 + #: or encrypted transports, as it allows any programs running on the 1360 1360 + #: remote machine to read/write to the local filesystem, without 1361 1361 + #: permission. 1362 1362 + 1363 1363 + # allow_hyperlinks yes 1364 1364 + 1365 1365 + #: Process hyperlink escape sequences (OSC 8). If disabled OSC 8 1366 1366 + #: escape sequences are ignored. Otherwise they become clickable 1367 1367 + #: links, that you can click with the mouse or by using the hints 1368 1368 + #: kitten <https://sw.kovidgoyal.net/kitty/kittens/hints/>. The 1369 1369 + #: special value of ask means that kitty will ask before opening the 1370 1370 + #: link when clicked. 1371 1371 + 1372 1372 + # shell_integration enabled 1373 1373 + 1374 1374 + #: Enable shell integration on supported shells. This enables features 1375 1375 + #: such as jumping to previous prompts, browsing the output of the 1376 1376 + #: previous command in a pager, etc. on supported shells. Set to 1377 1377 + #: disabled to turn off shell integration, completely. It is also 1378 1378 + #: possible to disable individual features, set to a space separated 1379 1379 + #: list of these values: no-rc, no-cursor, no-title, no-cwd, no- 1380 1380 + #: prompt-mark, no-complete. See Shell integration 1381 1381 + #: <https://sw.kovidgoyal.net/kitty/shell-integration/> for details. 1382 1382 + 1383 1383 + # allow_cloning ask 1384 1384 + 1385 1385 + #: Control whether programs running in the terminal can request new 1386 1386 + #: windows to be created. The canonical example is clone-in-kitty 1387 1387 + #: <https://sw.kovidgoyal.net/kitty/shell-integration/#clone-shell>. 1388 1388 + #: By default, kitty will ask for permission for each clone request. 1389 1389 + #: Allowing cloning unconditionally gives programs running in the 1390 1390 + #: terminal (including over SSH) permission to execute arbitrary code, 1391 1391 + #: as the user who is running the terminal, on the computer that the 1392 1392 + #: terminal is running on. 1393 1393 + 1394 1394 + # clone_source_strategies venv,conda,env_var,path 1395 1395 + 1396 1396 + #: Control what shell code is sourced when running clone-in-kitty in 1397 1397 + #: the newly cloned window. The supported strategies are: 1398 1398 + 1399 1399 + #: venv 1400 1400 + #: Source the file $VIRTUAL_ENV/bin/activate. This is used by the 1401 1401 + #: Python stdlib venv module and allows cloning venvs automatically. 1402 1402 + #: conda 1403 1403 + #: Run conda activate $CONDA_DEFAULT_ENV. This supports the virtual 1404 1404 + #: environments created by conda. 1405 1405 + #: env_var 1406 1406 + #: Execute the contents of the environment variable 1407 1407 + #: KITTY_CLONE_SOURCE_CODE with eval. 1408 1408 + #: path 1409 1409 + #: Source the file pointed to by the environment variable 1410 1410 + #: KITTY_CLONE_SOURCE_PATH. 1411 1411 + 1412 1412 + #: This option must be a comma separated list of the above values. 1413 1413 + #: This only source the first valid one in the above order. 1414 1414 + 1415 1415 + # term xterm-kitty 1416 1416 + 1417 1417 + #: The value of the TERM environment variable to set. Changing this 1418 1418 + #: can break many terminal programs, only change it if you know what 1419 1419 + #: you are doing, not because you read some advice on "Stack Overflow" 1420 1420 + #: to change it. The TERM variable is used by various programs to get 1421 1421 + #: information about the capabilities and behavior of the terminal. If 1422 1422 + #: you change it, depending on what programs you run, and how 1423 1423 + #: different the terminal you are changing it to is, various things 1424 1424 + #: from key-presses, to colors, to various advanced features may not 1425 1425 + #: work. Changing this option by reloading the config will only affect 1426 1426 + #: newly created windows. 1427 1427 + 1428 1428 + #: }}} 1429 1429 + 1430 1430 + #: OS specific tweaks {{{ 1431 1431 + 1432 1432 + wayland_titlebar_color background 1433 1433 + 1434 1434 + #: The color of the kitty window's titlebar on Wayland systems with 1435 1435 + #: client side window decorations such as GNOME. A value of system 1436 1436 + #: means to use the default system color, a value of background means 1437 1437 + #: to use the background color of the currently active window and 1438 1438 + #: finally you can use an arbitrary color, such as #12af59 or red. 1439 1439 + 1440 1440 + macos_titlebar_color background 1441 1441 + 1442 1442 + #: The color of the kitty window's titlebar on macOS. A value of 1443 1443 + #: system means to use the default system color, light or dark can 1444 1444 + #: also be used to set it explicitly. A value of background means to 1445 1445 + #: use the background color of the currently active window and finally 1446 1446 + #: you can use an arbitrary color, such as #12af59 or red. WARNING: 1447 1447 + #: This option works by using a hack when arbitrary color (or 1448 1448 + #: background) is configured, as there is no proper Cocoa API for it. 1449 1449 + #: It sets the background color of the entire window and makes the 1450 1450 + #: titlebar transparent. As such it is incompatible with 1451 1451 + #: background_opacity. If you want to use both, you are probably 1452 1452 + #: better off just hiding the titlebar with hide_window_decorations. 1453 1453 + 1454 1454 + # macos_option_as_alt no 1455 1455 + 1456 1456 + #: Use the Option key as an Alt key on macOS. With this set to no, 1457 1457 + #: kitty will use the macOS native Option+Key to enter Unicode 1458 1458 + #: character behavior. This will break any Alt+Key keyboard shortcuts 1459 1459 + #: in your terminal programs, but you can use the macOS Unicode input 1460 1460 + #: technique. You can use the values: left, right or both to use only 1461 1461 + #: the left, right or both Option keys as Alt, instead. Note that 1462 1462 + #: kitty itself always treats Option the same as Alt. This means you 1463 1463 + #: cannot use this option to configure different kitty shortcuts for 1464 1464 + #: Option+Key vs. Alt+Key. Also, any kitty shortcuts using 1465 1465 + #: Option/Alt+Key will take priority, so that any such key presses 1466 1466 + #: will not be passed to terminal programs running inside kitty. 1467 1467 + #: Changing this option by reloading the config is not supported. 1468 1468 + 1469 1469 + # macos_hide_from_tasks no 1470 1470 + 1471 1471 + #: Hide the kitty window from running tasks on macOS (⌘+Tab and the 1472 1472 + #: Dock). Changing this option by reloading the config is not 1473 1473 + #: supported. 1474 1474 + 1475 1475 + # macos_quit_when_last_window_closed no 1476 1476 + 1477 1477 + #: Have kitty quit when all the top-level windows are closed on macOS. 1478 1478 + #: By default, kitty will stay running, even with no open windows, as 1479 1479 + #: is the expected behavior on macOS. 1480 1480 + 1481 1481 + # macos_window_resizable yes 1482 1482 + 1483 1483 + #: Disable this if you want kitty top-level OS windows to not be 1484 1484 + #: resizable on macOS. Changing this option by reloading the config 1485 1485 + #: will only affect newly created OS windows. 1486 1486 + 1487 1487 + # macos_thicken_font 0 1488 1488 + 1489 1489 + #: Draw an extra border around the font with the given width, to 1490 1490 + #: increase legibility at small font sizes on macOS. For example, a 1491 1491 + #: value of 0.75 will result in rendering that looks similar to sub- 1492 1492 + #: pixel antialiasing at common font sizes. 1493 1493 + 1494 1494 + # macos_traditional_fullscreen no 1495 1495 + 1496 1496 + #: Use the macOS traditional full-screen transition, that is faster, 1497 1497 + #: but less pretty. 1498 1498 + 1499 1499 + # macos_show_window_title_in all 1500 1500 + 1501 1501 + #: Control where the window title is displayed on macOS. A value of 1502 1502 + #: window will show the title of the currently active window at the 1503 1503 + #: top of the macOS window. A value of menubar will show the title of 1504 1504 + #: the currently active window in the macOS global menu bar, making 1505 1505 + #: use of otherwise wasted space. A value of all will show the title 1506 1506 + #: in both places, and none hides the title. See 1507 1507 + #: macos_menubar_title_max_length for how to control the length of the 1508 1508 + #: title in the menu bar. 1509 1509 + 1510 1510 + # macos_menubar_title_max_length 0 1511 1511 + 1512 1512 + #: The maximum number of characters from the window title to show in 1513 1513 + #: the macOS global menu bar. Values less than one means that there is 1514 1514 + #: no maximum limit. 1515 1515 + 1516 1516 + # macos_custom_beam_cursor no 1517 1517 + 1518 1518 + #: Use a custom mouse cursor for macOS that is easier to see on both 1519 1519 + #: light and dark backgrounds. Nowadays, the default macOS cursor 1520 1520 + #: already comes with a white border. WARNING: this might make your 1521 1521 + #: mouse cursor invisible on dual GPU machines. Changing this option 1522 1522 + #: by reloading the config is not supported. 1523 1523 + 1524 1524 + # macos_colorspace srgb 1525 1525 + 1526 1526 + #: The colorspace in which to interpret terminal colors. The default 1527 1527 + #: of srgb will cause colors to match those seen in web browsers. The 1528 1528 + #: value of default will use whatever the native colorspace of the 1529 1529 + #: display is. The value of displayp3 will use Apple's special 1530 1530 + #: snowflake display P3 color space, which will result in over 1531 1531 + #: saturated (brighter) colors with some color shift. Reloading 1532 1532 + #: configuration will change this value only for newly created OS 1533 1533 + #: windows. 1534 1534 + 1535 1535 + # linux_display_server auto 1536 1536 + 1537 1537 + #: Choose between Wayland and X11 backends. By default, an appropriate 1538 1538 + #: backend based on the system state is chosen automatically. Set it 1539 1539 + #: to x11 or wayland to force the choice. Changing this option by 1540 1540 + #: reloading the config is not supported. 1541 1541 + 1542 1542 + #: }}} 1543 1543 + 1544 1544 + #: Keyboard shortcuts {{{ 1545 1545 + 1546 1546 + #: Keys are identified simply by their lowercase Unicode characters. 1547 1547 + #: For example: a for the A key, [ for the left square bracket key, 1548 1548 + #: etc. For functional keys, such as Enter or Escape, the names are 1549 1549 + #: present at Functional key definitions 1550 1550 + #: <https://sw.kovidgoyal.net/kitty/keyboard-protocol/#functional>. 1551 1551 + #: For modifier keys, the names are ctrl (control, ⌃), shift (⇧), alt 1552 1552 + #: (opt, option, ⌥), super (cmd, command, ⌘). See also: GLFW mods 1553 1553 + #: <https://www.glfw.org/docs/latest/group__mods.html> 1554 1554 + 1555 1555 + #: On Linux you can also use XKB key names to bind keys that are not 1556 1556 + #: supported by GLFW. See XKB keys 1557 1557 + #: <https://github.com/xkbcommon/libxkbcommon/blob/master/include/xkbcommon/xkbcommon- 1558 1558 + #: keysyms.h> for a list of key names. The name to use is the part 1559 1559 + #: after the XKB_KEY_ prefix. Note that you can only use an XKB key 1560 1560 + #: name for keys that are not known as GLFW keys. 1561 1561 + 1562 1562 + #: Finally, you can use raw system key codes to map keys, again only 1563 1563 + #: for keys that are not known as GLFW keys. To see the system key 1564 1564 + #: code for a key, start kitty with the kitty --debug-input option, 1565 1565 + #: kitty will output some debug text for every key event. In that text 1566 1566 + #: look for native_code, the value of that becomes the key name in the 1567 1567 + #: shortcut. For example: 1568 1568 + 1569 1569 + #: .. code-block:: none 1570 1570 + 1571 1571 + #: on_key_input: glfw key: 0x61 native_code: 0x61 action: PRESS mods: none text: 'a' 1572 1572 + 1573 1573 + #: Here, the key name for the A key is 0x61 and you can use it with:: 1574 1574 + 1575 1575 + #: map ctrl+0x61 something 1576 1576 + 1577 1577 + #: to map Ctrl+A to something. 1578 1578 + 1579 1579 + #: You can use the special action no_op to unmap a keyboard shortcut 1580 1580 + #: that is assigned in the default configuration:: 1581 1581 + 1582 1582 + #: map kitty_mod+space no_op 1583 1583 + 1584 1584 + #: If you would like kitty to completely ignore a key event, not even 1585 1585 + #: sending it to the program running in the terminal, map it to 1586 1586 + #: discard_event:: 1587 1587 + 1588 1588 + #: map kitty_mod+f1 discard_event 1589 1589 + 1590 1590 + #: You can combine multiple actions to be triggered by a single 1591 1591 + #: shortcut with combine action, using the syntax below:: 1592 1592 + 1593 1593 + #: map key combine <separator> action1 <separator> action2 <separator> action3 ... 1594 1594 + 1595 1595 + #: For example:: 1596 1596 + 1597 1597 + #: map kitty_mod+e combine : new_window : next_layout 1598 1598 + 1599 1599 + #: This will create a new window and switch to the next available 1600 1600 + #: layout. 1601 1601 + 1602 1602 + #: You can use multi-key shortcuts with the syntax shown below:: 1603 1603 + 1604 1604 + #: map key1>key2>key3 action 1605 1605 + 1606 1606 + #: For example:: 1607 1607 + 1608 1608 + #: map ctrl+f>2 set_font_size 20 1609 1609 + 1610 1610 + #: The full list of actions that can be mapped to key presses is 1611 1611 + #: available here <https://sw.kovidgoyal.net/kitty/actions/>. 1612 1612 + 1613 1613 + # kitty_mod ctrl+shift 1614 1614 + 1615 1615 + #: Special modifier key alias for default shortcuts. You can change 1616 1616 + #: the value of this option to alter all default shortcuts that use 1617 1617 + #: kitty_mod. 1618 1618 + 1619 1619 + # clear_all_shortcuts no 1620 1620 + 1621 1621 + #: Remove all shortcut definitions up to this point. Useful, for 1622 1622 + #: instance, to remove the default shortcuts. 1623 1623 + 1624 1624 + # action_alias 1625 1625 + 1626 1626 + #: E.g. action_alias launch_tab launch --type=tab --cwd=current 1627 1627 + 1628 1628 + #: Define action aliases to avoid repeating the same options in 1629 1629 + #: multiple mappings. Aliases can be defined for any action and will 1630 1630 + #: be expanded recursively. For example, the above alias allows you to 1631 1631 + #: create mappings to launch a new tab in the current working 1632 1632 + #: directory without duplication:: 1633 1633 + 1634 1634 + #: map f1 launch_tab vim 1635 1635 + #: map f2 launch_tab emacs 1636 1636 + 1637 1637 + #: Similarly, to alias kitten invocation:: 1638 1638 + 1639 1639 + #: action_alias hints kitten hints --hints-offset=0 1640 1640 + 1641 1641 + # kitten_alias 1642 1642 + 1643 1643 + #: E.g. kitten_alias hints hints --hints-offset=0 1644 1644 + 1645 1645 + #: Like action_alias above, but specifically for kittens. Generally, 1646 1646 + #: prefer to use action_alias. This option is a legacy version, 1647 1647 + #: present for backwards compatibility. It causes all invocations of 1648 1648 + #: the aliased kitten to be substituted. So the example above will 1649 1649 + #: cause all invocations of the hints kitten to have the --hints- 1650 1650 + #: offset=0 option applied. 1651 1651 + 1652 1652 + #: Clipboard {{{ 1653 1653 + 1654 1654 + #: Copy to clipboard 1655 1655 + 1656 1656 + # map kitty_mod+c copy_to_clipboard 1657 1657 + # map cmd+c copy_to_clipboard 1658 1658 + 1659 1659 + #:: There is also a copy_or_interrupt action that can be optionally 1660 1660 + #:: mapped to Ctrl+C. It will copy only if there is a selection and 1661 1661 + #:: send an interrupt otherwise. Similarly, 1662 1662 + #:: copy_and_clear_or_interrupt will copy and clear the selection or 1663 1663 + #:: send an interrupt if there is no selection. 1664 1664 + 1665 1665 + #: Paste from clipboard 1666 1666 + 1667 1667 + # map kitty_mod+v paste_from_clipboard 1668 1668 + # map cmd+v paste_from_clipboard 1669 1669 + 1670 1670 + #: Paste from selection 1671 1671 + 1672 1672 + # map kitty_mod+s paste_from_selection 1673 1673 + # map shift+insert paste_from_selection 1674 1674 + 1675 1675 + #: Pass selection to program 1676 1676 + 1677 1677 + # map kitty_mod+o pass_selection_to_program 1678 1678 + 1679 1679 + #:: You can also pass the contents of the current selection to any 1680 1680 + #:: program with pass_selection_to_program. By default, the system's 1681 1681 + #:: open program is used, but you can specify your own, the selection 1682 1682 + #:: will be passed as a command line argument to the program. For 1683 1683 + #:: example:: 1684 1684 + 1685 1685 + #:: map kitty_mod+o pass_selection_to_program firefox 1686 1686 + 1687 1687 + #:: You can pass the current selection to a terminal program running 1688 1688 + #:: in a new kitty window, by using the @selection placeholder:: 1689 1689 + 1690 1690 + #:: map kitty_mod+y new_window less @selection 1691 1691 + 1692 1692 + #: }}} 1693 1693 + 1694 1694 + #: Scrolling {{{ 1695 1695 + 1696 1696 + #: Scroll line up 1697 1697 + 1698 1698 + # map kitty_mod+up scroll_line_up 1699 1699 + # map kitty_mod+k scroll_line_up 1700 1700 + # map opt+cmd+page_up scroll_line_up 1701 1701 + # map cmd+up scroll_line_up 1702 1702 + 1703 1703 + #: Scroll line down 1704 1704 + 1705 1705 + # map kitty_mod+down scroll_line_down 1706 1706 + # map kitty_mod+j scroll_line_down 1707 1707 + # map opt+cmd+page_down scroll_line_down 1708 1708 + # map cmd+down scroll_line_down 1709 1709 + 1710 1710 + #: Scroll page up 1711 1711 + 1712 1712 + # map kitty_mod+page_up scroll_page_up 1713 1713 + # map cmd+page_up scroll_page_up 1714 1714 + 1715 1715 + #: Scroll page down 1716 1716 + 1717 1717 + # map kitty_mod+page_down scroll_page_down 1718 1718 + # map cmd+page_down scroll_page_down 1719 1719 + 1720 1720 + #: Scroll to top 1721 1721 + 1722 1722 + # map kitty_mod+home scroll_home 1723 1723 + # map cmd+home scroll_home 1724 1724 + 1725 1725 + #: Scroll to bottom 1726 1726 + 1727 1727 + # map kitty_mod+end scroll_end 1728 1728 + # map cmd+end scroll_end 1729 1729 + 1730 1730 + #: Scroll to previous shell prompt 1731 1731 + 1732 1732 + # map kitty_mod+z scroll_to_prompt -1 1733 1733 + 1734 1734 + #:: Use a parameter of 0 for scroll_to_prompt to scroll to the last 1735 1735 + #:: jumped to or the last clicked position. Requires shell 1736 1736 + #:: integration <https://sw.kovidgoyal.net/kitty/shell-integration/> 1737 1737 + #:: to work. 1738 1738 + 1739 1739 + #: Scroll to next shell prompt 1740 1740 + 1741 1741 + # map kitty_mod+x scroll_to_prompt 1 1742 1742 + 1743 1743 + #: Browse scrollback buffer in pager 1744 1744 + 1745 1745 + # map kitty_mod+h show_scrollback 1746 1746 + 1747 1747 + #:: You can pipe the contents of the current screen and history 1748 1748 + #:: buffer as STDIN to an arbitrary program using launch --stdin- 1749 1749 + #:: source. For example, the following opens the scrollback buffer in 1750 1750 + #:: less in an overlay window:: 1751 1751 + 1752 1752 + #:: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R 1753 1753 + 1754 1754 + #:: For more details on piping screen and buffer contents to external 1755 1755 + #:: programs, see launch <https://sw.kovidgoyal.net/kitty/launch/>. 1756 1756 + 1757 1757 + #: Browse output of the last shell command in pager 1758 1758 + 1759 1759 + # map kitty_mod+g show_last_command_output 1760 1760 + 1761 1761 + #:: You can also define additional shortcuts to get the command 1762 1762 + #:: output. For example, to get the first command output on screen:: 1763 1763 + 1764 1764 + #:: map f1 show_first_command_output_on_screen 1765 1765 + 1766 1766 + #:: To get the command output that was last accessed by a keyboard 1767 1767 + #:: action or mouse action:: 1768 1768 + 1769 1769 + #:: map f1 show_last_visited_command_output 1770 1770 + 1771 1771 + #:: You can pipe the output of the last command run in the shell 1772 1772 + #:: using the launch action. For example, the following opens the 1773 1773 + #:: output in less in an overlay window:: 1774 1774 + 1775 1775 + #:: map f1 launch --stdin-source=@last_cmd_output --stdin-add-formatting --type=overlay less +G -R 1776 1776 + 1777 1777 + #:: To get the output of the first command on the screen, use 1778 1778 + #:: @first_cmd_output_on_screen. To get the output of the last jumped 1779 1779 + #:: to command, use @last_visited_cmd_output. 1780 1780 + 1781 1781 + #:: Requires shell integration 1782 1782 + #:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work. 1783 1783 + 1784 1784 + #: }}} 1785 1785 + 1786 1786 + #: Window management {{{ 1787 1787 + 1788 1788 + #: New window 1789 1789 + 1790 1790 + # map kitty_mod+enter new_window 1791 1791 + # map cmd+enter new_window 1792 1792 + 1793 1793 + #:: You can open a new kitty window running an arbitrary program, for 1794 1794 + #:: example:: 1795 1795 + 1796 1796 + #:: map kitty_mod+y launch mutt 1797 1797 + 1798 1798 + #:: You can open a new window with the current working directory set 1799 1799 + #:: to the working directory of the current window using:: 1800 1800 + 1801 1801 + #:: map ctrl+alt+enter launch --cwd=current 1802 1802 + 1803 1803 + #:: You can open a new window that is allowed to control kitty via 1804 1804 + #:: the kitty remote control facility with launch --allow-remote- 1805 1805 + #:: control. Any programs running in that window will be allowed to 1806 1806 + #:: control kitty. For example:: 1807 1807 + 1808 1808 + #:: map ctrl+enter launch --allow-remote-control some_program 1809 1809 + 1810 1810 + #:: You can open a new window next to the currently active window or 1811 1811 + #:: as the first window, with:: 1812 1812 + 1813 1813 + #:: map ctrl+n launch --location=neighbor 1814 1814 + #:: map ctrl+f launch --location=first 1815 1815 + 1816 1816 + #:: For more details, see launch 1817 1817 + #:: <https://sw.kovidgoyal.net/kitty/launch/>. 1818 1818 + 1819 1819 + #: New OS window 1820 1820 + 1821 1821 + # map kitty_mod+n new_os_window 1822 1822 + # map cmd+n new_os_window 1823 1823 + 1824 1824 + #:: Works like new_window above, except that it opens a top-level OS 1825 1825 + #:: window. In particular you can use new_os_window_with_cwd to open 1826 1826 + #:: a window with the current working directory. 1827 1827 + 1828 1828 + #: Close window 1829 1829 + 1830 1830 + # map kitty_mod+w close_window 1831 1831 + # map shift+cmd+d close_window 1832 1832 + 1833 1833 + #: Next window 1834 1834 + 1835 1835 + # map kitty_mod+] next_window 1836 1836 + 1837 1837 + #: Previous window 1838 1838 + 1839 1839 + # map kitty_mod+[ previous_window 1840 1840 + 1841 1841 + #: Move window forward 1842 1842 + 1843 1843 + # map kitty_mod+f move_window_forward 1844 1844 + 1845 1845 + #: Move window backward 1846 1846 + 1847 1847 + # map kitty_mod+b move_window_backward 1848 1848 + 1849 1849 + #: Move window to top 1850 1850 + 1851 1851 + # map kitty_mod+` move_window_to_top 1852 1852 + 1853 1853 + #: Start resizing window 1854 1854 + 1855 1855 + # map kitty_mod+r start_resizing_window 1856 1856 + # map cmd+r start_resizing_window 1857 1857 + 1858 1858 + #: First window 1859 1859 + 1860 1860 + # map kitty_mod+1 first_window 1861 1861 + # map cmd+1 first_window 1862 1862 + 1863 1863 + #: Second window 1864 1864 + 1865 1865 + # map kitty_mod+2 second_window 1866 1866 + # map cmd+2 second_window 1867 1867 + 1868 1868 + #: Third window 1869 1869 + 1870 1870 + # map kitty_mod+3 third_window 1871 1871 + # map cmd+3 third_window 1872 1872 + 1873 1873 + #: Fourth window 1874 1874 + 1875 1875 + # map kitty_mod+4 fourth_window 1876 1876 + # map cmd+4 fourth_window 1877 1877 + 1878 1878 + #: Fifth window 1879 1879 + 1880 1880 + # map kitty_mod+5 fifth_window 1881 1881 + # map cmd+5 fifth_window 1882 1882 + 1883 1883 + #: Sixth window 1884 1884 + 1885 1885 + # map kitty_mod+6 sixth_window 1886 1886 + # map cmd+6 sixth_window 1887 1887 + 1888 1888 + #: Seventh window 1889 1889 + 1890 1890 + # map kitty_mod+7 seventh_window 1891 1891 + # map cmd+7 seventh_window 1892 1892 + 1893 1893 + #: Eight window 1894 1894 + 1895 1895 + # map kitty_mod+8 eighth_window 1896 1896 + # map cmd+8 eighth_window 1897 1897 + 1898 1898 + #: Ninth window 1899 1899 + 1900 1900 + # map kitty_mod+9 ninth_window 1901 1901 + # map cmd+9 ninth_window 1902 1902 + 1903 1903 + #: Tenth window 1904 1904 + 1905 1905 + # map kitty_mod+0 tenth_window 1906 1906 + 1907 1907 + #: Visually select and focus window 1908 1908 + 1909 1909 + # map kitty_mod+f7 focus_visible_window 1910 1910 + 1911 1911 + #:: Display overlay numbers and alphabets on the window, and switch 1912 1912 + #:: the focus to the window when you press the key. When there are 1913 1913 + #:: only two windows, the focus will be switched directly without 1914 1914 + #:: displaying the overlay. You can change the overlay characters and 1915 1915 + #:: their order with option visual_window_select_characters. 1916 1916 + 1917 1917 + #: Visually swap window with another 1918 1918 + 1919 1919 + # map kitty_mod+f8 swap_with_window 1920 1920 + 1921 1921 + #:: Works like focus_visible_window above, but swaps the window. 1922 1922 + 1923 1923 + #: }}} 1924 1924 + 1925 1925 + #: Tab management {{{ 1926 1926 + 1927 1927 + #: Next tab 1928 1928 + 1929 1929 + # map kitty_mod+right next_tab 1930 1930 + # map shift+cmd+] next_tab 1931 1931 + # map ctrl+tab next_tab 1932 1932 + 1933 1933 + #: Previous tab 1934 1934 + 1935 1935 + # map kitty_mod+left previous_tab 1936 1936 + # map shift+cmd+[ previous_tab 1937 1937 + # map ctrl+shift+tab previous_tab 1938 1938 + 1939 1939 + #: New tab 1940 1940 + 1941 1941 + # map kitty_mod+t new_tab 1942 1942 + # map cmd+t new_tab 1943 1943 + 1944 1944 + #: Close tab 1945 1945 + 1946 1946 + # map kitty_mod+q close_tab 1947 1947 + # map cmd+w close_tab 1948 1948 + 1949 1949 + #: Close OS window 1950 1950 + 1951 1951 + # map shift+cmd+w close_os_window 1952 1952 + 1953 1953 + #: Move tab forward 1954 1954 + 1955 1955 + # map kitty_mod+. move_tab_forward 1956 1956 + 1957 1957 + #: Move tab backward 1958 1958 + 1959 1959 + # map kitty_mod+, move_tab_backward 1960 1960 + 1961 1961 + #: Set tab title 1962 1962 + 1963 1963 + # map kitty_mod+alt+t set_tab_title 1964 1964 + # map shift+cmd+i set_tab_title 1965 1965 + 1966 1966 + 1967 1967 + #: You can also create shortcuts to go to specific tabs, with 1 being 1968 1968 + #: the first tab, 2 the second tab and -1 being the previously active 1969 1969 + #: tab, and any number larger than the last tab being the last tab:: 1970 1970 + 1971 1971 + #: map ctrl+alt+1 goto_tab 1 1972 1972 + #: map ctrl+alt+2 goto_tab 2 1973 1973 + 1974 1974 + #: Just as with new_window above, you can also pass the name of 1975 1975 + #: arbitrary commands to run when using new_tab and new_tab_with_cwd. 1976 1976 + #: Finally, if you want the new tab to open next to the current tab 1977 1977 + #: rather than at the end of the tabs list, use:: 1978 1978 + 1979 1979 + #: map ctrl+t new_tab !neighbor [optional cmd to run] 1980 1980 + #: }}} 1981 1981 + 1982 1982 + #: Layout management {{{ 1983 1983 + 1984 1984 + #: Next layout 1985 1985 + 1986 1986 + # map kitty_mod+l next_layout 1987 1987 + 1988 1988 + 1989 1989 + #: You can also create shortcuts to switch to specific layouts:: 1990 1990 + 1991 1991 + #: map ctrl+alt+t goto_layout tall 1992 1992 + #: map ctrl+alt+s goto_layout stack 1993 1993 + 1994 1994 + #: Similarly, to switch back to the previous layout:: 1995 1995 + 1996 1996 + #: map ctrl+alt+p last_used_layout 1997 1997 + 1998 1998 + #: There is also a toggle_layout action that switches to the named 1999 1999 + #: layout or back to the previous layout if in the named layout. 2000 2000 + #: Useful to temporarily "zoom" the active window by switching to the 2001 2001 + #: stack layout:: 2002 2002 + 2003 2003 + #: map ctrl+alt+z toggle_layout stack 2004 2004 + #: }}} 2005 2005 + 2006 2006 + #: Font sizes {{{ 2007 2007 + 2008 2008 + #: You can change the font size for all top-level kitty OS windows at 2009 2009 + #: a time or only the current one. 2010 2010 + 2011 2011 + #: Increase font size 2012 2012 + 2013 2013 + # map kitty_mod+equal change_font_size all +2.0 2014 2014 + # map kitty_mod+plus change_font_size all +2.0 2015 2015 + # map kitty_mod+kp_add change_font_size all +2.0 2016 2016 + # map cmd+plus change_font_size all +2.0 2017 2017 + # map cmd+equal change_font_size all +2.0 2018 2018 + # map shift+cmd+equal change_font_size all +2.0 2019 2019 + 2020 2020 + #: Decrease font size 2021 2021 + 2022 2022 + # map kitty_mod+minus change_font_size all -2.0 2023 2023 + # map kitty_mod+kp_subtract change_font_size all -2.0 2024 2024 + # map cmd+minus change_font_size all -2.0 2025 2025 + # map shift+cmd+minus change_font_size all -2.0 2026 2026 + 2027 2027 + #: Reset font size 2028 2028 + 2029 2029 + # map kitty_mod+backspace change_font_size all 0 2030 2030 + # map cmd+0 change_font_size all 0 2031 2031 + 2032 2032 + 2033 2033 + #: To setup shortcuts for specific font sizes:: 2034 2034 + 2035 2035 + #: map kitty_mod+f6 change_font_size all 10.0 2036 2036 + 2037 2037 + #: To setup shortcuts to change only the current OS window's font 2038 2038 + #: size:: 2039 2039 + 2040 2040 + #: map kitty_mod+f6 change_font_size current 10.0 2041 2041 + #: }}} 2042 2042 + 2043 2043 + #: Select and act on visible text {{{ 2044 2044 + 2045 2045 + #: Use the hints kitten to select text and either pass it to an 2046 2046 + #: external program or insert it into the terminal or copy it to the 2047 2047 + #: clipboard. 2048 2048 + 2049 2049 + #: Open URL 2050 2050 + 2051 2051 + # map kitty_mod+e open_url_with_hints 2052 2052 + 2053 2053 + #:: Open a currently visible URL using the keyboard. The program used 2054 2054 + #:: to open the URL is specified in open_url_with. 2055 2055 + 2056 2056 + #: Insert selected path 2057 2057 + 2058 2058 + # map kitty_mod+p>f kitten hints --type path --program - 2059 2059 + 2060 2060 + #:: Select a path/filename and insert it into the terminal. Useful, 2061 2061 + #:: for instance to run git commands on a filename output from a 2062 2062 + #:: previous git command. 2063 2063 + 2064 2064 + #: Open selected path 2065 2065 + 2066 2066 + # map kitty_mod+p>shift+f kitten hints --type path 2067 2067 + 2068 2068 + #:: Select a path/filename and open it with the default open program. 2069 2069 + 2070 2070 + #: Insert selected line 2071 2071 + 2072 2072 + # map kitty_mod+p>l kitten hints --type line --program - 2073 2073 + 2074 2074 + #:: Select a line of text and insert it into the terminal. Useful for 2075 2075 + #:: the output of things like: `ls -1`. 2076 2076 + 2077 2077 + #: Insert selected word 2078 2078 + 2079 2079 + # map kitty_mod+p>w kitten hints --type word --program - 2080 2080 + 2081 2081 + #:: Select words and insert into terminal. 2082 2082 + 2083 2083 + #: Insert selected hash 2084 2084 + 2085 2085 + # map kitty_mod+p>h kitten hints --type hash --program - 2086 2086 + 2087 2087 + #:: Select something that looks like a hash and insert it into the 2088 2088 + #:: terminal. Useful with git, which uses SHA1 hashes to identify 2089 2089 + #:: commits. 2090 2090 + 2091 2091 + #: Open the selected file at the selected line 2092 2092 + 2093 2093 + # map kitty_mod+p>n kitten hints --type linenum 2094 2094 + 2095 2095 + #:: Select something that looks like filename:linenum and open it in 2096 2096 + #:: vim at the specified line number. 2097 2097 + 2098 2098 + #: Open the selected hyperlink 2099 2099 + 2100 2100 + # map kitty_mod+p>y kitten hints --type hyperlink 2101 2101 + 2102 2102 + #:: Select a hyperlink (i.e. a URL that has been marked as such by 2103 2103 + #:: the terminal program, for example, by `ls --hyperlink=auto`). 2104 2104 + 2105 2105 + 2106 2106 + #: The hints kitten has many more modes of operation that you can map 2107 2107 + #: to different shortcuts. For a full description see hints kitten 2108 2108 + #: <https://sw.kovidgoyal.net/kitty/kittens/hints/>. 2109 2109 + #: }}} 2110 2110 + 2111 2111 + #: Miscellaneous {{{ 2112 2112 + 2113 2113 + #: Show documentation 2114 2114 + 2115 2115 + # map kitty_mod+f1 show_kitty_doc overview 2116 2116 + 2117 2117 + #: Toggle fullscreen 2118 2118 + 2119 2119 + # map kitty_mod+f11 toggle_fullscreen 2120 2120 + # map ctrl+cmd+f toggle_fullscreen 2121 2121 + 2122 2122 + #: Toggle maximized 2123 2123 + 2124 2124 + # map kitty_mod+f10 toggle_maximized 2125 2125 + 2126 2126 + #: Toggle macOS secure keyboard entry 2127 2127 + 2128 2128 + # map opt+cmd+s toggle_macos_secure_keyboard_entry 2129 2129 + 2130 2130 + #: Unicode input 2131 2131 + 2132 2132 + # map kitty_mod+u kitten unicode_input 2133 2133 + # map ctrl+cmd+space kitten unicode_input 2134 2134 + 2135 2135 + #: Edit config file 2136 2136 + 2137 2137 + # map kitty_mod+f2 edit_config_file 2138 2138 + # map cmd+, edit_config_file 2139 2139 + 2140 2140 + #: Open the kitty command shell 2141 2141 + 2142 2142 + # map kitty_mod+escape kitty_shell window 2143 2143 + 2144 2144 + #:: Open the kitty shell in a new window / tab / overlay / os_window 2145 2145 + #:: to control kitty using commands. 2146 2146 + 2147 2147 + #: Increase background opacity 2148 2148 + 2149 2149 + # map kitty_mod+a>m set_background_opacity +0.1 2150 2150 + 2151 2151 + #: Decrease background opacity 2152 2152 + 2153 2153 + # map kitty_mod+a>l set_background_opacity -0.1 2154 2154 + 2155 2155 + #: Make background fully opaque 2156 2156 + 2157 2157 + # map kitty_mod+a>1 set_background_opacity 1 2158 2158 + 2159 2159 + #: Reset background opacity 2160 2160 + 2161 2161 + # map kitty_mod+a>d set_background_opacity default 2162 2162 + 2163 2163 + #: Reset the terminal 2164 2164 + 2165 2165 + # map kitty_mod+delete clear_terminal reset active 2166 2166 + # map opt+cmd+r clear_terminal reset active 2167 2167 + 2168 2168 + #:: You can create shortcuts to clear/reset the terminal. For 2169 2169 + #:: example:: 2170 2170 + 2171 2171 + #:: # Reset the terminal 2172 2172 + #:: map f1 clear_terminal reset active 2173 2173 + #:: # Clear the terminal screen by erasing all contents 2174 2174 + #:: map f1 clear_terminal clear active 2175 2175 + #:: # Clear the terminal scrollback by erasing it 2176 2176 + #:: map f1 clear_terminal scrollback active 2177 2177 + #:: # Scroll the contents of the screen into the scrollback 2178 2178 + #:: map f1 clear_terminal scroll active 2179 2179 + #:: # Clear everything up to the line with the cursor 2180 2180 + #:: map f1 clear_terminal to_cursor active 2181 2181 + 2182 2182 + #:: If you want to operate on all kitty windows instead of just the 2183 2183 + #:: current one, use all instead of active. 2184 2184 + 2185 2185 + #:: It is also possible to remap Ctrl+L to both scroll the current 2186 2186 + #:: screen contents into the scrollback buffer and clear the screen, 2187 2187 + #:: instead of just clearing the screen, for example, for ZSH add the 2188 2188 + #:: following to ~/.zshrc: 2189 2189 + 2190 2190 + #:: .. code-block:: zsh 2191 2191 + 2192 2192 + #:: scroll-and-clear-screen() { 2193 2193 + #:: printf '\n%.0s' {1..$LINES} 2194 2194 + #:: zle clear-screen 2195 2195 + #:: } 2196 2196 + #:: zle -N scroll-and-clear-screen 2197 2197 + #:: bindkey '^l' scroll-and-clear-screen 2198 2198 + 2199 2199 + #: Clear up to cursor line 2200 2200 + 2201 2201 + # map cmd+k clear_terminal to_cursor active 2202 2202 + 2203 2203 + #: Reload kitty.conf 2204 2204 + 2205 2205 + # map kitty_mod+f5 load_config_file 2206 2206 + # map ctrl+cmd+, load_config_file 2207 2207 + 2208 2208 + #:: Reload kitty.conf, applying any changes since the last time it 2209 2209 + #:: was loaded. Note that a handful of options cannot be dynamically 2210 2210 + #:: changed and require a full restart of kitty. Particularly, when 2211 2211 + #:: changing shortcuts for actions located on the macOS global menu 2212 2212 + #:: bar, a full restart is needed. You can also map a keybinding to 2213 2213 + #:: load a different config file, for example:: 2214 2214 + 2215 2215 + #:: map f5 load_config /path/to/alternative/kitty.conf 2216 2216 + 2217 2217 + #:: Note that all options from the original kitty.conf are discarded, 2218 2218 + #:: in other words the new configuration *replace* the old ones. 2219 2219 + 2220 2220 + #: Debug kitty configuration 2221 2221 + 2222 2222 + # map kitty_mod+f6 debug_config 2223 2223 + # map opt+cmd+, debug_config 2224 2224 + 2225 2225 + #:: Show details about exactly what configuration kitty is running 2226 2226 + #:: with and its host environment. Useful for debugging issues. 2227 2227 + 2228 2228 + #: Send arbitrary text on key presses 2229 2229 + 2230 2230 + #:: E.g. map ctrl+shift+alt+h send_text all Hello World 2231 2231 + 2232 2232 + #:: You can tell kitty to send arbitrary (UTF-8) encoded text to the 2233 2233 + #:: client program when pressing specified shortcut keys. For 2234 2234 + #:: example:: 2235 2235 + 2236 2236 + #:: map ctrl+alt+a send_text all Special text 2237 2237 + 2238 2238 + #:: This will send "Special text" when you press the Ctrl+Alt+A key 2239 2239 + #:: combination. The text to be sent is a python string literal so 2240 2240 + #:: you can use escapes like \x1b to send control codes or \u21fb to 2241 2241 + #:: send Unicode characters (or you can just input the Unicode 2242 2242 + #:: characters directly as UTF-8 text). You can use `kitty +kitten 2243 2243 + #:: show_key` to get the key escape codes you want to emulate. 2244 2244 + 2245 2245 + #:: The first argument to send_text is the keyboard modes in which to 2246 2246 + #:: activate the shortcut. The possible values are normal, 2247 2247 + #:: application, kitty or a comma separated combination of them. The 2248 2248 + #:: modes normal and application refer to the DECCKM cursor key mode 2249 2249 + #:: for terminals, and kitty refers to the kitty extended keyboard 2250 2250 + #:: protocol. The special value all means all of them. 2251 2251 + 2252 2252 + #:: Some more examples:: 2253 2253 + 2254 2254 + #:: # Output a word and move the cursor to the start of the line (like typing and pressing Home) 2255 2255 + #:: map ctrl+alt+a send_text normal Word\x1b[H 2256 2256 + #:: map ctrl+alt+a send_text application Word\x1bOH 2257 2257 + #:: # Run a command at a shell prompt (like typing the command and pressing Enter) 2258 2258 + #:: map ctrl+alt+a send_text normal,application some command with arguments\r 2259 2259 + 2260 2260 + #: Open kitty Website 2261 2261 + 2262 2262 + # map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/ 2263 2263 + 2264 2264 + #: }}} 2265 2265 + 2266 2266 + #: }}}