diff --git a/dot_config/kitty/kitty.conf b/dot_config/kitty/kitty.conf index 28d686b..8dae270 100644 --- a/dot_config/kitty/kitty.conf +++ b/dot_config/kitty/kitty.conf @@ -1,4 +1,4 @@ -# vim:fileencoding=utf-8:ft=conf:foldmethod=marker +# vim:fileencoding=utf-8:foldmethod=marker #: Fonts {{{ @@ -32,29 +32,26 @@ font_size 12.0 #: Font size (in pts) -force_ltr no +# force_ltr no #: kitty does not support BIDI (bidirectional text), however, for RTL #: scripts, words are automatically displayed in RTL. That is to say, #: in an RTL script, the words "HELLO WORLD" display in kitty as #: "WORLD HELLO", and if you try to select a substring of an RTL- #: shaped string, you will get the character that would be there had -#: the the string been LTR. For example, assuming the Hebrew word -#: ירושלים, selecting the character that on the screen appears to be ם -#: actually writes into the selection buffer the character י. kitty's -#: default behavior is useful in conjunction with a filter to reverse -#: the word order, however, if you wish to manipulate RTL glyphs, it -#: can be very challenging to work with, so this option is provided to -#: turn it off. Furthermore, this option can be used with the command -#: line program GNU FriBidi -#: to get BIDI -#: support, because it will force kitty to always treat the text as -#: LTR, which FriBidi expects for terminals. +#: the string been LTR. For example, assuming the Hebrew word ירושלים, +#: selecting the character that on the screen appears to be ם actually +#: writes into the selection buffer the character י. kitty's default +#: behavior is useful in conjunction with a filter to reverse the word +#: order, however, if you wish to manipulate RTL glyphs, it can be +#: very challenging to work with, so this option is provided to turn +#: it off. Furthermore, this option can be used with the command line +#: program GNU FriBidi +#: to get BIDI support, because it will force kitty to always treat +#: the text as LTR, which FriBidi expects for terminals. -adjust_line_height 0 -adjust_column_width 0 +# symbol_map -symbol_map U+E000–U+F8FF Symbols Nerd Font Mono #: E.g. symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols #: Map the specified Unicode codepoints to a particular font. Useful @@ -81,7 +78,7 @@ symbol_map U+E000–U+F8FF Symbols Nerd Font Mono #: narrow_symbols codepoints [optionally the number of cells] -disable_ligatures never +# disable_ligatures never #: Choose how you want to handle multi-character ligatures. The #: default is to always render them. You can tell kitty to not render @@ -183,18 +180,81 @@ disable_ligatures never #: decreasing it lowers them. Decreasing the cell size might cause #: rendering artifacts, so use with care. -box_drawing_scale 0.001, 1, 1.5, 2 +# box_drawing_scale 0.001, 1, 1.5, 2 #: The sizes of the lines used for the box drawing Unicode characters. #: These values are in pts. They will be scaled by the monitor DPI to #: arrive at a pixel value. There must be four values corresponding to #: thin, normal, thick, and very thick lines. +# undercurl_style thin-sparse + +#: The style with which undercurls are rendered. This option takes the +#: form (thin|thick)-(sparse|dense). Thin and thick control the +#: thickness of the undercurl. Sparse and dense control how often the +#: curl oscillates. With sparse the curl will peak once per character, +#: with dense twice. + +# text_composition_strategy platform + +#: Control how kitty composites text glyphs onto the background color. +#: The default value of platform tries for text rendering as close to +#: "native" for the platform kitty is running on as possible. + +#: A value of legacy uses the old (pre kitty 0.28) strategy for how +#: glyphs are composited. This will make dark text on light +#: backgrounds look thicker and light text on dark backgrounds +#: thinner. It might also make some text appear like the strokes are +#: uneven. + +#: You can fine tune the actual contrast curve used for glyph +#: composition by specifying up to two space-separated numbers for +#: this setting. + +#: The first number is the gamma adjustment, which controls the +#: thickness of dark text on light backgrounds. Increasing the value +#: will make text appear thicker. The default value for this is 1.0 on +#: Linux and 1.7 on macOS. Valid values are 0.01 and above. The result +#: is scaled based on the luminance difference between the background +#: and the foreground. Dark text on light backgrounds receives the +#: full impact of the curve while light text on dark backgrounds is +#: affected very little. + +#: The second number is an additional multiplicative contrast. It is +#: percentage ranging from 0 to 100. The default value is 0 on Linux +#: and 30 on macOS. + +#: If you wish to achieve similar looking thickness in light and dark +#: themes, a good way to experiment is start by setting the value to +#: 1.0 0 and use a dark theme. Then adjust the second parameter until +#: it looks good. Then switch to a light theme and adjust the first +#: parameter until the perceived thickness matches the dark theme. + +# text_fg_override_threshold 0 + +#: The minimum accepted difference in luminance between the foreground +#: and background color, below which kitty will override the +#: foreground color. It is percentage ranging from 0 to 100. If the +#: difference in luminance of the foreground and background is below +#: this threshold, the foreground color will be set to white if the +#: background is dark or black if the background is light. The default +#: value is 0, which means no overriding is performed. Useful when +#: working with applications that use colors that do not contrast well +#: with your preferred color scheme. + +#: WARNING: Some programs use characters (such as block characters) +#: for graphics display and may expect to be able to set the +#: foreground and background to the same color (or similar colors). +#: If you see unexpected stripes, dots, lines, incorrect color, no +#: color where you expect color, or any kind of graphic display +#: problem try setting text_fg_override_threshold to 0 to see if this +#: is the cause of the problem. + #: }}} #: Cursor customization {{{ -cursor #cccccc +# cursor #cccccc #: Default cursor color. If set to the special value none the cursor #: will be rendered with a "reverse video" effect. It's color will be @@ -204,14 +264,14 @@ cursor #cccccc #: precedence. Also, the cursor colors are modified if the cell #: background and foreground colors have very low contrast. -cursor_text_color #111111 +# cursor_text_color #111111 #: The color of text under the cursor. If you want it rendered with #: the background color of the cell underneath instead, use the #: special keyword: background. Note that if cursor is set to none #: then this option is ignored. -cursor_shape block +# cursor_shape block #: The cursor shape can be one of block, beam, underline. Note that #: when reloading the config this will be changed only if the cursor @@ -222,11 +282,11 @@ cursor_shape block #: the cursor shape to beam at shell prompts. You can avoid this by #: setting shell_integration to no-cursor. -cursor_beam_thickness 1.5 +# cursor_beam_thickness 1.5 #: The thickness of the beam cursor (in pts). -cursor_underline_thickness 2.0 +# cursor_underline_thickness 2.0 #: The thickness of the underline cursor (in pts). @@ -236,7 +296,7 @@ cursor_blink_interval 0 #: disable blinking. Negative values mean use system default. Note #: that the minimum interval will be limited to repaint_delay. -cursor_stop_blinking_after 15.0 +# cursor_stop_blinking_after 15.0 #: Stop blinking cursor after the specified number of seconds of #: keyboard inactivity. Set to zero to never stop blinking. @@ -256,7 +316,7 @@ scrollback_lines 5000 #: is changed it will only affect newly created windows, not existing #: ones. -scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER +# scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER #: Program with which to view scrollback in a new window. The #: scrollback buffer is passed as STDIN to this program. If you change @@ -268,25 +328,25 @@ scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER #: set to 0 if there is no cursor, for example, when showing the last #: command output. -scrollback_pager_history_size 0 +# scrollback_pager_history_size 0 #: Separate scrollback history size (in MB), used only for browsing #: the scrollback buffer with pager. This separate buffer is not #: available for interactive scrolling but will be piped to the pager #: program when viewing scrollback buffer in a separate window. The -#: current implementation stores the data in UTF-8, so approximatively +#: current implementation stores the data in UTF-8, so approximately #: 10000 lines per megabyte at 100 chars per line, for pure ASCII, #: unformatted text. A value of zero or less disables this feature. #: The maximum allowed size is 4GB. Note that on config reload if this #: is changed it will only affect newly created windows, not existing #: ones. -scrollback_fill_enlarged_window no +# scrollback_fill_enlarged_window no #: Fill new space with lines from the scrollback buffer after #: enlarging a window. -wheel_scroll_multiplier 5.0 +# wheel_scroll_multiplier 5.0 #: Multiplier for the number of lines scrolled by the mouse wheel. #: Note that this is only used for low precision scrolling devices, @@ -294,7 +354,7 @@ wheel_scroll_multiplier 5.0 #: and Wayland. Use negative numbers to change scroll direction. See #: also wheel_scroll_min_lines. -wheel_scroll_min_lines 1 +# wheel_scroll_min_lines 1 #: The minimum number of lines scrolled by the mouse wheel. The scroll #: multiplier wheel_scroll_multiplier only takes effect after it @@ -303,7 +363,7 @@ wheel_scroll_min_lines 1 #: when using the wheel. With a negative number, the minimum number of #: lines will always be added. -touch_scroll_multiplier 1.0 +# touch_scroll_multiplier 1.0 #: Multiplier for the number of lines scrolled by a touchpad. Note #: that this is only used for high precision scrolling devices on @@ -314,7 +374,7 @@ touch_scroll_multiplier 1.0 #: Mouse {{{ -mouse_hide_wait 3.0 +# mouse_hide_wait 3.0 #: Hide mouse cursor after the specified number of seconds of the #: mouse not being used. Set to zero to disable mouse cursor hiding. @@ -323,36 +383,60 @@ mouse_hide_wait 3.0 #: robustly with the ever-changing sea of bugs that is Cocoa is too #: much effort. -url_color #0087bd -url_style curly +# url_color #0087bd +# url_style curly #: The color and style for highlighting URLs on mouse-over. url_style #: can be one of: none, straight, double, curly, dotted, dashed. -open_url_with default +# open_url_with default -#: The program to open clicked URLs. The special value default means -#: to use the operating system's default URL handler (open on macOS -#: and xdg-open on Linux). +#: The program to open clicked URLs. The special value default with +#: first look for any URL handlers defined via the open_actions +#: facility and if non +#: are found, it will use the Operating System's default URL handler +#: (open on macOS and xdg-open on Linux). -url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh +# url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh #: The set of URL prefixes to look for when detecting a URL under the #: mouse cursor. -detect_urls yes +# detect_urls yes #: Detect URLs under the mouse. Detected URLs are highlighted with an #: underline and the mouse cursor becomes a hand over them. Even if -#: this option is disabled, URLs are still clickable. +#: this option is disabled, URLs are still clickable. See also the +#: underline_hyperlinks option to control how hyperlinks (as opposed +#: to plain text URLs) are displayed. # url_excluded_characters #: Additional characters to be disallowed from URLs, when detecting #: URLs under the mouse cursor. By default, all characters that are -#: legal in URLs are allowed. +#: legal in URLs are allowed. Additionally, newlines are allowed (but +#: stripped). This is to accommodate programs such as mutt that add +#: hard line breaks even for continued lines. \n can be added to this +#: option to disable this behavior. Special characters can be +#: specified using backslash escapes, to specify a backslash use a +#: double backslash. -copy_on_select no +# show_hyperlink_targets no + +#: When the mouse hovers over a terminal hyperlink, show the actual +#: URL that will be activated when the hyperlink is clicked. + +# underline_hyperlinks hover + +#: Control how hyperlinks are underlined. They can either be +#: underlined on mouse hover, always (i.e. permanently underlined) or +#: never which means that kitty will not apply any underline styling +#: to hyperlinks. Uses the url_style and url_color settings for the +#: underline style. Note that reloading the config and changing this +#: value to/from always will only affect text subsequently received by +#: kitty. + +# copy_on_select no #: Copy to clipboard or a private buffer on select. With this set to #: clipboard, selecting text with the mouse will cause the text to be @@ -369,7 +453,7 @@ copy_on_select no #: programs, including websites open in your browser can read the #: contents of the system clipboard. -paste_actions quote-urls-at-prompt +# paste_actions quote-urls-at-prompt,confirm #: A comma separated list of actions to take when pasting text into #: the terminal. The supported paste actions are: @@ -377,21 +461,29 @@ paste_actions quote-urls-at-prompt #: quote-urls-at-prompt: #: If the text being pasted is a URL and the cursor is at a shell prompt, #: automatically quote the URL (needs shell_integration). +#: replace-dangerous-control-codes +#: Replace dangerous control codes from pasted text, without confirmation. +#: replace-newline +#: Replace the newline character from pasted text, without confirmation. #: confirm: -#: Confirm the paste if bracketed paste mode is not active or there is more -#: a large amount of text being pasted. +#: Confirm the paste if the text to be pasted contains any terminal control codes +#: as this can be dangerous, leading to code execution if the shell/program running +#: in the terminal does not properly handle these. +#: confirm-if-large +#: Confirm the paste if it is very large (larger than 16KB) as pasting +#: large amounts of text into shells can be very slow. #: filter: #: Run the filter_paste() function from the file paste-actions.py in #: the kitty config directory on the pasted text. The text returned by the #: function will be actually pasted. -strip_trailing_spaces never +# strip_trailing_spaces never #: Remove spaces at the end of lines when copying to clipboard. A #: value of smart will do it when using normal selections, but not #: rectangle selections. A value of always will always do it. -select_by_word_characters @-./_~?&=%+# +# select_by_word_characters @-./_~?&=%+# #: Characters considered part of a word when double clicking. In #: addition to these characters any character that is marked as an @@ -407,31 +499,30 @@ select_by_word_characters @-./_~?&=%+# #: If empty (default) select_by_word_characters will be used for both #: directions. -click_interval -1.0 +# click_interval -1.0 #: The interval between successive clicks to detect double/triple #: clicks (in seconds). Negative numbers will use the system default #: instead, if available, or fallback to 0.5. -focus_follows_mouse no +# focus_follows_mouse no #: Set the active window to the window under the mouse when moving the -#: mouse around. +#: mouse around. On macOS, this will also cause the OS Window under +#: the mouse to be focused automatically when the mouse enters it. -pointer_shape_when_grabbed arrow +# pointer_shape_when_grabbed arrow #: The shape of the mouse pointer when the program running in the -#: terminal grabs the mouse. Valid values are: arrow, beam and hand. +#: terminal grabs the mouse. -default_pointer_shape beam +# default_pointer_shape beam -#: The default shape of the mouse pointer. Valid values are: arrow, -#: beam and hand. +#: The default shape of the mouse pointer. -pointer_shape_when_dragging beam +# pointer_shape_when_dragging beam #: The default shape of the mouse pointer when dragging across text. -#: Valid values are: arrow, beam and hand. #: Mouse actions {{{ @@ -473,14 +564,14 @@ pointer_shape_when_dragging beam #: Once a selection is started, releasing the button that started it will #: automatically end it and no release event will be dispatched. -clear_all_mouse_actions no +# clear_all_mouse_actions no #: Remove all mouse action definitions up to this point. Useful, for #: instance, to remove the default mouse actions. #: Click the link under the mouse or move the cursor -mouse_map left click ungrabbed mouse_handle_click selection link prompt +# mouse_map left click ungrabbed mouse_handle_click selection link prompt #:: First check for a selection and if one exists do nothing. Then #:: check for a link under the mouse cursor and if one exists, click @@ -491,14 +582,14 @@ mouse_map left click ungrabbed mouse_handle_click selection link prompt #: Click the link under the mouse or move the cursor even when grabbed -mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt +# mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt #:: Same as above, except that the action is performed even when the #:: mouse is grabbed by the program running in the terminal. #: Click the link under the mouse cursor -mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link +# mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link #:: Variant with Ctrl+Shift is present because the simple click based #:: version has an unavoidable delay of click_interval, to @@ -506,7 +597,7 @@ mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link #: Discard press event for link click -mouse_map ctrl+shift+left press grabbed discard_event +# mouse_map ctrl+shift+left press grabbed discard_event #:: Prevent this press event from being sent to the program that has #:: grabbed the mouse, as the corresponding release event is used to @@ -514,72 +605,77 @@ mouse_map ctrl+shift+left press grabbed discard_event #: Paste from the primary selection -mouse_map middle release ungrabbed paste_from_selection +# mouse_map middle release ungrabbed paste_from_selection #: Start selecting text -mouse_map left press ungrabbed mouse_selection normal +# mouse_map left press ungrabbed mouse_selection normal #: Start selecting text in a rectangle -mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle +# mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle #: Select a word -mouse_map left doublepress ungrabbed mouse_selection word +# mouse_map left doublepress ungrabbed mouse_selection word #: Select a line -mouse_map left triplepress ungrabbed mouse_selection line +# mouse_map left triplepress ungrabbed mouse_selection line #: Select line from point -mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point +# mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point -#:: Select from the clicked point to the end of the line. +#:: Select from the clicked point to the end of the line. If you +#:: would like to select the word at the point and then extend to the +#:: rest of the line, change line_from_point to +#:: word_and_line_from_point. #: Extend the current selection -mouse_map right press ungrabbed mouse_selection extend +# mouse_map right press ungrabbed mouse_selection extend #:: If you want only the end of the selection to be moved instead of #:: the nearest boundary, use move-end instead of extend. #: Paste from the primary selection even when grabbed -mouse_map shift+middle release ungrabbed,grabbed paste_selection -mouse_map shift+middle press grabbed discard_event +# mouse_map shift+middle release ungrabbed,grabbed paste_selection +# mouse_map shift+middle press grabbed discard_event #: Start selecting text even when grabbed -mouse_map shift+left press ungrabbed,grabbed mouse_selection normal +# mouse_map shift+left press ungrabbed,grabbed mouse_selection normal #: Start selecting text in a rectangle even when grabbed -mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle +# mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle #: Select a word even when grabbed -mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word +# mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word #: Select a line even when grabbed -mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line +# mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line #: Select line from point even when grabbed -mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point +# mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point #:: Select from the clicked point to the end of the line even when -#:: grabbed. +#:: grabbed. If you would like to select the word at the point and +#:: then extend to the rest of the line, change line_from_point to +#:: word_and_line_from_point. #: Extend the current selection even when grabbed -mouse_map shift+right press ungrabbed,grabbed mouse_selection extend +# mouse_map shift+right press ungrabbed,grabbed mouse_selection extend #: Show clicked command output in pager -mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output +# mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output #:: Requires shell integration #:: to work. @@ -590,7 +686,7 @@ mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output #: Performance tuning {{{ -repaint_delay 10 +# repaint_delay 10 #: Delay between screen updates (in milliseconds). Decreasing it, #: increases frames-per-second (FPS) at the cost of more CPU usage. @@ -600,7 +696,7 @@ repaint_delay 10 #: refresh rate. Also, to minimize latency when there is pending input #: to be processed, this option is ignored. -input_delay 3 +# input_delay 3 #: Delay before input from the program running in the terminal is #: processed (in milliseconds). Note that decreasing it will increase @@ -608,7 +704,7 @@ input_delay 3 #: in full screen programs that redraw the entire screen on each loop, #: because kitty is so fast that partial screen updates will be drawn. -sync_to_monitor yes +# sync_to_monitor yes #: Sync screen updates to the refresh rate of the monitor. This #: prevents screen tearing @@ -626,23 +722,23 @@ enable_audio_bell no #: The audio bell. Useful to disable it in environments that require #: silence. -visual_bell_duration 0.0 +# visual_bell_duration 0.0 #: The visual bell duration (in seconds). Flash the screen when a bell #: occurs for the specified number of seconds. Set to zero to disable. -visual_bell_color none +# visual_bell_color none #: The color used by visual bell. Set to none will fall back to #: selection background color. If you feel that the visual bell is too #: bright, you can set it to a darker color. -window_alert_on_bell yes +# window_alert_on_bell yes #: Request window attention on bell. Makes the dock icon bounce on #: macOS or the taskbar flash on linux. -bell_on_tab "🔔 " +# bell_on_tab "🔔 " #: Some text or a Unicode symbol to show on the tab if a window in the #: tab that does not have focus has a bell. If you want to use leading @@ -653,35 +749,43 @@ bell_on_tab "🔔 " #: converted to the default bell symbol and no, n, false and none are #: converted to the empty string. -command_on_bell none +# command_on_bell none #: Program to run when a bell occurs. The environment variable #: KITTY_CHILD_CMDLINE can be used to get the program running in the #: window in which the bell occurred. -bell_path none +# bell_path none #: Path to a sound file to play as the bell sound. If set to none, the #: system default bell sound is used. Must be in a format supported by #: the operating systems sound API, such as WAV or OGA on Linux #: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound) +# linux_bell_theme __custom + +#: The XDG Sound Theme kitty will use to play the bell sound. Defaults +#: to the custom theme name used by GNOME and Budgie, falling back to +#: the default freedesktop theme if it does not exist. This option may +#: be removed if Linux ever provides desktop-agnostic support for +#: setting system sound themes. + #: }}} #: Window layout {{{ -remember_window_size yes -initial_window_width 640 -initial_window_height 400 +# remember_window_size yes +# initial_window_width 640 +# initial_window_height 400 -#: If enabled, the window size will be remembered so that new +#: If enabled, the OS Window size will be remembered so that new #: instances of kitty will have the same size as the previous -#: instance. If disabled, the window will initially have size +#: instance. If disabled, the OS Window will initially have size #: configured by initial_window_width/height, in pixels. You can use a #: suffix of "c" on the width/height values to have them interpreted #: as number of cells instead of pixels. -enabled_layouts * +# enabled_layouts * #: The enabled window layouts. A comma separated list of layout names. #: The special value all means all layouts. The first listed layout @@ -689,15 +793,15 @@ enabled_layouts * #: layouts in alphabetical order. For a list of available layouts, see #: the layouts . -window_resize_step_cells 2 -window_resize_step_lines 2 +# window_resize_step_cells 2 +# window_resize_step_lines 2 #: The step size (in units of cell width/cell height) to use when #: resizing kitty windows in a layout with the shortcut #: start_resizing_window. The cells value is used for horizontal #: resizing, and the lines value is used for vertical resizing. -window_border_width 0.5pt +# window_border_width 0.5pt #: The width of window borders. Can be either in pixels (px) or pts #: (pt). Values in pts will be rounded to the nearest number of pixels @@ -705,21 +809,21 @@ window_border_width 0.5pt #: to be pts. Note that borders are displayed only when more than one #: window is visible. They are meant to separate multiple windows. -draw_minimal_borders yes +# draw_minimal_borders yes #: Draw only the minimum borders needed. This means that only the -#: borders that separate the inactive window from a neighbor are -#: drawn. Note that setting a non-zero window_margin_width overrides -#: this and causes all borders to be drawn. +#: borders that separate the window from a neighbor are drawn. Note +#: that setting a non-zero window_margin_width overrides this and +#: causes all borders to be drawn. -window_margin_width 0 +# window_margin_width 0 #: The window margin (in pts) (blank area outside the border). A #: single value sets all four sides. Two values set the vertical and #: horizontal sides. Three values set top, horizontal and bottom. Four #: values set top, right, bottom and left. -single_window_margin_width -1 +# single_window_margin_width -1 #: The window margin to use when only a single window is visible (in #: pts). Negative values will cause the value of window_margin_width @@ -727,14 +831,22 @@ single_window_margin_width -1 #: set the vertical and horizontal sides. Three values set top, #: horizontal and bottom. Four values set top, right, bottom and left. -window_padding_width 0 +# window_padding_width 0 #: The window padding (in pts) (blank area between the text and the #: window border). A single value sets all four sides. Two values set #: the vertical and horizontal sides. Three values set top, horizontal #: and bottom. Four values set top, right, bottom and left. -placement_strategy center +# single_window_padding_width -1 + +#: The window padding to use when only a single window is visible (in +#: pts). Negative values will cause the value of window_padding_width +#: to be used instead. A single value sets all four sides. Two values +#: set the vertical and horizontal sides. Three values set top, +#: horizontal and bottom. Four values set top, right, bottom and left. + +# placement_strategy center #: When the window size is not an exact multiple of the cell size, the #: cell area of the terminal window will have some extra padding on @@ -743,34 +855,38 @@ placement_strategy center #: placed centrally. A value of top-left means the padding will be #: only at the bottom and right edges. -active_border_color #00ff00 +# active_border_color #00ff00 #: The color for the border of the active window. Set this to none to #: not draw borders around the active window. -inactive_border_color #cccccc +# inactive_border_color #cccccc #: The color for the border of inactive windows. -bell_border_color #ff5a00 +# bell_border_color #ff5a00 #: The color for the border of inactive windows in which a bell has #: occurred. -inactive_text_alpha 1.0 +# inactive_text_alpha 1.0 #: Fade the text in inactive windows by the specified amount (a number #: between zero and one, with zero being fully faded). -hide_window_decorations no +# hide_window_decorations no #: Hide the window decorations (title-bar and window borders) with -#: yes. On macOS, titlebar-only can be used to only hide the titlebar. -#: Whether this works and exactly what effect it has depends on the -#: window manager/operating system. Note that the effects of changing -#: this option when reloading config are undefined. +#: yes. On macOS, titlebar-only and titlebar-and-corners can be used +#: to only hide the titlebar and the rounded corners. Whether this +#: works and exactly what effect it has depends on the window +#: manager/operating system. Note that the effects of changing this +#: option when reloading config are undefined. When using titlebar- +#: only, it is useful to also set window_margin_width and +#: placement_strategy to prevent the rounded corners from clipping +#: text. Or use titlebar-and-corners. -window_logo_path none +# window_logo_path none #: Path to a logo image. Must be in PNG format. Relative paths are #: interpreted relative to the kitty config directory. The logo is @@ -780,33 +896,31 @@ window_logo_path none #: or the remote control facility. -window_logo_position bottom-right +# window_logo_position bottom-right #: Where to position the window logo in the window. The value can be #: one of: top-left, top, top-right, left, center, right, bottom-left, #: bottom, bottom-right. -window_logo_alpha 0.5 +# window_logo_alpha 0.5 #: The amount the logo should be faded into the background. With zero #: being fully faded and one being fully opaque. -resize_debounce_time 0.1 +# resize_debounce_time 0.1 0.5 -#: The time to wait before redrawing the screen when a resize event is -#: received (in seconds). On platforms such as macOS, where the -#: operating system sends events corresponding to the start and end of -#: a resize, this number is ignored. +#: The time to wait before redrawing the screen during a live resize +#: of the OS window, when no new resize events have been received, +#: i.e. when resizing is either paused or finished. On platforms such +#: as macOS, where the operating system sends events corresponding to +#: the start and end of a live resize, the second number is used for +#: redraw-after-pause since kitty can distinguish between a pause and +#: end of resizing. On such systems the first number is ignored and +#: redraw is immediate after end of resize. On other systems the +#: first number is used so that kitty is "ready" quickly after the end +#: of resizing, while not also continuously redrawing, to save energy. -resize_draw_strategy static - -#: Choose how kitty draws a window while a resize is in progress. A -#: value of static means draw the current window contents, mostly -#: unchanged. A value of scale means draw the current window contents -#: scaled. A value of blank means draw a blank window. A value of size -#: means show the window size in cells. - -resize_in_steps no +# resize_in_steps no #: Resize the OS window in steps as large as the cells, instead of #: with the usual pixel accuracy. Combined with initial_window_width @@ -814,13 +928,13 @@ resize_in_steps no #: used to keep the margins as small as possible when resizing the OS #: window. Note that this does not currently work on Wayland. -visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ +# visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ #: The list of characters for visual window selection. For example, #: for selecting a window to focus on with focus_visible_window. The #: value should be a series of unique numbers or alphabets, case -#: insensitive, from the set [0-9A-Z]. Specify your preference as a -#: string of characters. +#: insensitive, from the set 0-9A-Z\-=[];',./\\`. Specify your +#: preference as a string of characters. confirm_os_window_close 0 @@ -841,15 +955,15 @@ confirm_os_window_close 0 #: Tab bar {{{ -tab_bar_edge bottom +# tab_bar_edge bottom #: The edge to show the tab bar on, top or bottom. -tab_bar_margin_width 0.0 +# tab_bar_margin_width 0.0 #: The margin to the left and right of the tab bar (in pts). -tab_bar_margin_height 0.0 0.0 +# tab_bar_margin_height 0.0 0.0 #: The margin above and below the tab bar (in pts). The first number #: is the margin between the edge of the OS Window and the tab bar. @@ -878,21 +992,21 @@ tab_bar_style powerline #: this discussion #: for examples from kitty users. #: hidden -#: The tab bar is hidden. If you use this, you might want to create a mapping -#: for the select_tab action which presents you with a list of tabs and -#: allows for easy switching to a tab. +#: The tab bar is hidden. If you use this, you might want to create +#: a mapping for the select_tab action which presents you with a list of +#: tabs and allows for easy switching to a tab. -tab_bar_align left +# tab_bar_align left #: The horizontal alignment of the tab bar, can be one of: left, #: center, right. -tab_bar_min_tabs 2 +# tab_bar_min_tabs 2 #: The minimum number of tabs that must exist before the tab bar is #: shown. -tab_switch_strategy previous +# tab_switch_strategy previous #: The algorithm to use when switching to a tab when the current tab #: is closed. The default of previous will switch to the last used @@ -900,7 +1014,7 @@ tab_switch_strategy previous #: closed tab. A value of right will switch to the tab to the right of #: the closed tab. A value of last will switch to the right-most tab. -tab_fade 0.25 0.5 0.75 1 +# tab_fade 0.25 0.5 0.75 1 #: Control how each tab fades into the background when using fade for #: the tab_bar_style. Each number is an alpha (between zero and one) @@ -920,14 +1034,19 @@ tab_powerline_style slanted #: using powerline as the tab_bar_style, can be one of: angled, #: slanted, round. -tab_activity_symbol none +# tab_activity_symbol none #: Some text or a Unicode symbol to show on the tab if a window in the #: tab that does not have focus has some activity. If you want to use #: leading or trailing spaces, surround the text with quotes. See #: tab_title_template for how this is rendered. -tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title}" +# tab_title_max_length 0 + +#: The maximum number of cells that can be used to render the text in +#: a tab. A value of zero means that no limit is applied. + +# tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title}" #: A template to render the tab title. The default just renders the #: title with optional symbols for bell and activity. If you wish to @@ -939,16 +1058,21 @@ tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title #: title #: The current tab title. #: index -#: The tab index useable with goto_tab N goto_tab shortcuts. +#: The tab index usable with goto_tab N goto_tab shortcuts. #: layout_name #: The current layout name. #: num_windows #: The number of windows in the tab. #: num_window_groups -#: The number of window groups (not counting overlay windows) in the tab. +#: The number of window groups (a window group is a window and all of its overlay windows) in the tab. #: tab.active_wd -#: The working directory of the currently active window in the tab (expensive, -#: requires syscall). +#: The working directory of the currently active window in the tab +#: (expensive, requires syscall). Use active_oldest_wd to get +#: the directory of the oldest foreground process rather than the newest. +#: tab.active_exe +#: The name of the executable running in the foreground of the currently +#: active window in the tab (expensive, requires syscall). Use +#: active_oldest_exe for the oldest foreground process. #: max_title_length #: The maximum title length available. @@ -964,29 +1088,31 @@ tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title #: {activity_symbol} are not present in the template, they are #: prepended to it. -active_tab_title_template none +# active_tab_title_template none #: Template to use for active tabs. If not specified falls back to #: tab_title_template. -active_tab_foreground #000 -active_tab_background #eee -active_tab_font_style bold-italic -inactive_tab_foreground #444 -inactive_tab_background #999 -inactive_tab_font_style normal +# active_tab_foreground #000 +# active_tab_background #eee +# active_tab_font_style bold-italic +# inactive_tab_foreground #444 +# inactive_tab_background #999 +# inactive_tab_font_style normal #: Tab bar colors and styles. -tab_bar_background none +# tab_bar_background none #: Background color for the tab bar. Defaults to using the terminal #: background color. -tab_bar_margin_color none +# tab_bar_margin_color none #: Color for the tab bar margin area. Defaults to using the terminal -#: background color. +#: background color for margins above and below the tab bar. For side +#: margins the default color is chosen to match the background color +#: of the neighboring tab. #: }}} @@ -999,7 +1125,7 @@ background #1d2021 #: The foreground and background colors. -background_opacity 1.0 +# background_opacity 1.0 #: The opacity of the background. A number between zero and one, where #: one is opaque and zero is fully transparent. This will only work if @@ -1014,49 +1140,72 @@ background_opacity 1.0 #: color in the editor color scheme. Or use the escape codes to set #: the terminals default colors in a shell script to launch your #: editor. Be aware that using a value less than 1.0 is a (possibly -#: significant) performance hit. If you want to dynamically change +#: significant) performance hit. When using a low value for this +#: setting, it is desirable that you set the background color to a +#: color the matches the general color of the desktop background, for +#: best text rendering. If you want to dynamically change #: transparency of windows, set dynamic_background_opacity to yes #: (this is off by default as it has a performance cost). Changing #: this option when reloading the config will only work if #: dynamic_background_opacity was enabled in the original config. -background_image none +# background_blur 0 + +#: Set to a positive value to enable background blur (blurring of the +#: visuals behind a transparent window) on platforms that support it. +#: Only takes effect when background_opacity is less than one. On +#: macOS, this will also control the blur radius (amount of blurring). +#: Setting it to too high a value will cause severe performance issues +#: and/or rendering artifacts. Usually, values up to 64 work well. +#: Note that this might cause performance issues, depending on how the +#: platform implements it, so use with care. Currently supported on +#: macOS and KDE under X11. + +# background_image none #: Path to a background image. Must be in PNG format. -background_image_layout tiled +# background_image_layout tiled #: Whether to tile, scale or clamp the background image. The value can -#: be one of tiled, mirror-tiled, scaled, clamped. +#: be one of tiled, mirror-tiled, scaled, clamped, centered or +#: cscaled. The scaled and cscaled values scale the image to the +#: window size, with cscaled preserving the image aspect ratio. -background_image_linear no +# background_image_linear no #: When background image is scaled, whether linear interpolation #: should be used. -dynamic_background_opacity no +# dynamic_background_opacity no #: Allow changing of the background_opacity dynamically, using either #: keyboard shortcuts (increase_background_opacity and #: decrease_background_opacity) or the remote control facility. #: Changing this option by reloading the config is not supported. -background_tint 0.0 +# background_tint 0.0 -#: How much to tint the background image by the background color. The -#: tint is applied only under the text area, not margin/borders. This +#: How much to tint the background image by the background color. This #: option makes it easier to read the text. Tinting is done using the #: current background color for each window. This option applies only #: if background_opacity is set and transparent windows are supported #: or background_image is set. -dim_opacity 0.75 +# background_tint_gaps 1.0 + +#: How much to tint the background image at the window gaps by the +#: background color, after applying background_tint. Since this is +#: multiplicative with background_tint, it can be used to lighten the +#: tint over the window gaps for a *separated* look. + +# dim_opacity 0.4 #: How much to dim text that has the DIM/FAINT attribute set. One #: means no dimming and zero means fully dimmed (i.e. invisible). -selection_foreground #000000 -selection_background #fffacd +# selection_foreground #000000 +# selection_background #fffacd #: The foreground and background colors for text selected with the #: mouse. Setting both of these to none will cause a "reverse video" @@ -1072,68 +1221,68 @@ selection_background #fffacd #: dull and bright version, for the first 16 colors. You can set the #: remaining 240 colors as color16 to color255. -#color0 #000000 color0 #1d2021 -color8 #767676 +# color0 #000000 +# color8 #767676 #: black -color1 #cc0403 -color9 #f2201f +# color1 #cc0403 +# color9 #f2201f #: red -color2 #19cb00 -color10 #23fd00 +# color2 #19cb00 +# color10 #23fd00 #: green -color3 #cecb00 -color11 #fffd00 +# color3 #cecb00 +# color11 #fffd00 #: yellow -color4 #0d73cc -color12 #1a8fff +# color4 #0d73cc +# color12 #1a8fff #: blue -color5 #cb1ed1 -color13 #fd28ff +# color5 #cb1ed1 +# color13 #fd28ff #: magenta -color6 #0dcdcd -color14 #14ffff +# color6 #0dcdcd +# color14 #14ffff #: cyan -color7 #dddddd -color15 #ffffff +# color7 #dddddd +# color15 #ffffff #: white -mark1_foreground black +# mark1_foreground black #: Color for marks of type 1 -mark1_background #98d3cb +# mark1_background #98d3cb #: Color for marks of type 1 (light steel blue) -mark2_foreground black +# mark2_foreground black #: Color for marks of type 2 -mark2_background #f2dcd3 +# mark2_background #f2dcd3 #: Color for marks of type 1 (beige) -mark3_foreground black +# mark3_foreground black #: Color for marks of type 3 -mark3_background #f274bc +# mark3_background #f274bc #: Color for marks of type 3 (violet) @@ -1143,15 +1292,16 @@ mark3_background #f274bc #: Advanced {{{ -shell . +# shell . #: The shell program to execute. The default value of . means to use #: whatever shell is set as the default shell for the current user. #: Note that on macOS if you change this, you might need to add #: --login and --interactive to ensure that the shell starts in -#: interactive mode and reads its startup rc files. +#: interactive mode and reads its startup rc files. Environment +#: variables are expanded in this setting. -editor . +# editor . #: The terminal based text editor (such as vim or nano) to use when #: editing the kitty config file or similar tasks. @@ -1163,7 +1313,7 @@ editor . #: kitty will cycle through various known editors (vim, emacs, etc.) #: and take the first one that exists on your system. -close_on_child_death no +# close_on_child_death no #: Close the window when the child process (shell) exits. With the #: default value no, the terminal will remain open when the child @@ -1192,24 +1342,24 @@ close_on_child_death no #: To get a list of available actions, run:: -#: kitty @ --help +#: kitten @ --help #: A set of actions to be allowed when no password is sent can be -#: specified by using an empty password, for example:: +#: specified by using an empty password. For example:: #: remote_control_password "" *-colors #: Finally, the path to a python module can be specified that provides #: a function is_cmd_allowed that is used to check every remote -#: control command. See rc_custom_auth -#: -#: for details. For example:: +#: control command. For example:: #: remote_control_password "my passphrase" my_rc_command_checker.py #: Relative paths are resolved from the kitty configuration directory. +#: See rc_custom_auth for details. -allow_remote_control yes +allow_remote_control socket #: Allow other programs to control kitty. If you turn this on, other #: programs can control all aspects of kitty, including sending text @@ -1219,38 +1369,41 @@ allow_remote_control yes #: control. The meaning of the various values are: #: password -#: Remote control requests received over both the TTY device and the socket are -#: confirmed based on passwords, see remote_control_password. +#: Remote control requests received over both the TTY device and the socket +#: are confirmed based on passwords, see remote_control_password. #: socket-only -#: Remote control requests received over a socket are accepted unconditionally. -#: Requests received over the TTY are denied. See listen_on. +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are denied. +#: See listen_on. #: socket -#: Remote control requests received over a socket are accepted unconditionally. -#: Requests received over the TTY are confirmed based on password. +#: Remote control requests received over a socket are accepted +#: unconditionally. Requests received over the TTY are confirmed based on +#: password. #: no -#: Remote control is completely disabled. +#: Remote control is completely disabled. #: yes -#: Remote control requests are always accepted. +#: Remote control requests are always accepted. -listen_on none +# listen_on none -#: Listen to the specified UNIX socket for remote control connections. -#: Note that this will apply to all kitty instances. It can be -#: overridden by the kitty --listen-on command line option, which also -#: supports listening on a TCP socket. This option accepts only UNIX -#: sockets, such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux). +#: Listen to the specified socket for remote control connections. Note +#: that this will apply to all kitty instances. It can be overridden +#: by the kitty --listen-on command line option. For UNIX sockets, +#: such as unix:${TEMP}/mykitty or unix:@mykitty (on Linux). #: Environment variables are expanded and relative paths are resolved #: with respect to the temporary directory. If {kitty_pid} is present, #: then it is replaced by the PID of the kitty process, otherwise the #: PID of the kitty process is appended to the value, with a hyphen. -#: See the help for kitty --listen-on for more details. Note that this -#: will be ignored unless allow_remote_control is set to either: yes, -#: socket or socket-only. Changing this option by reloading the config -#: is not supported. +#: For TCP sockets such as tcp:localhost:0 a random port is always +#: used even if a non-zero port number is specified. See the help for +#: kitty --listen-on for more details. Note that this will be ignored +#: unless allow_remote_control is set to either: yes, socket or +#: socket-only. Changing this option by reloading the config is not +#: supported. # env @@ -1303,18 +1456,18 @@ update_check_interval 0 #: builds do not do update checking. Changing this option by reloading #: the config is not supported. -startup_session none +# startup_session none #: Path to a session file to use for all kitty instances. Can be -#: overridden by using the kitty --session command line option for -#: individual instances. See sessions +#: overridden by using the kitty --session =none command line option +#: for individual instances. See sessions #: in the kitty #: documentation for details. Note that relative paths are interpreted #: with respect to the kitty config directory. Environment variables #: in the path are expanded. Changing this option by reloading the #: config is not supported. -clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask +# clipboard_control write-clipboard write-primary read-clipboard-ask read-primary-ask #: Allow programs running in kitty to read and write from the #: clipboard. You can control exactly which actions are allowed. The @@ -1327,7 +1480,7 @@ clipboard_control write-clipboard write-primary read-clipboard-ask read-primary- #: remote server via SSH can read your clipboard. See also #: clipboard_max_size. -clipboard_max_size 64 +# clipboard_max_size 512 #: The maximum size (in MB) of data from programs running in kitty #: that will be stored for writing to the system clipboard. A value of @@ -1343,7 +1496,7 @@ clipboard_max_size 64 #: remote machine to read/write to the local filesystem, without #: permission. -allow_hyperlinks yes +# allow_hyperlinks yes #: Process hyperlink escape sequences (OSC 8). If disabled OSC 8 #: escape sequences are ignored. Otherwise they become clickable @@ -1360,10 +1513,10 @@ shell_integration no-cursor #: disabled to turn off shell integration, completely. It is also #: possible to disable individual features, set to a space separated #: list of these values: no-rc, no-cursor, no-title, no-cwd, no- -#: prompt-mark, no-complete. See Shell integration +#: prompt-mark, no-complete, no-sudo. See Shell integration #: for details. -allow_cloning ask +# allow_cloning ask #: Control whether programs running in the terminal can request new #: windows to be created. The canonical example is clone-in-kitty @@ -1374,7 +1527,7 @@ allow_cloning ask #: as the user who is running the terminal, on the computer that the #: terminal is running on. -clone_source_strategies venv,conda,env_var,path +# clone_source_strategies venv,conda,env_var,path #: Control what shell code is sourced when running clone-in-kitty in #: the newly cloned window. The supported strategies are: @@ -1393,9 +1546,9 @@ clone_source_strategies venv,conda,env_var,path #: KITTY_CLONE_SOURCE_PATH. #: This option must be a comma separated list of the above values. -#: This only source the first valid one in the above order. +#: Only the first valid match, in the order specified, is sourced. -term xterm-kitty +# term xterm-kitty #: The value of the TERM environment variable to set. Changing this #: can break many terminal programs, only change it if you know what @@ -1408,11 +1561,32 @@ term xterm-kitty #: work. Changing this option by reloading the config will only affect #: newly created windows. +# forward_stdio no + +#: Forward STDOUT and STDERR of the kitty process to child processes +#: as file descriptors 3 and 4. This is useful for debugging as it +#: allows child processes to print to kitty's STDOUT directly. For +#: example, echo hello world >&3 in a shell will print to the parent +#: kitty's STDOUT. When enabled, this also sets the +#: KITTY_STDIO_FORWARDED=3 environment variable so child processes +#: know about the forwarding. + +# menu_map + +#: Specify entries for various menus in kitty. Currently only the +#: global menubar on macOS is supported. For example:: + +#: menu_map global "Actions::Launch something special" launch --hold --type=os-window sh -c "echo hello world" + +#: This will create a menu entry named "Launch something special" in +#: an "Actions" menu in the macOS global menubar. Sub-menus can be +#: created by adding more levels separated by ::. + #: }}} #: OS specific tweaks {{{ -wayland_titlebar_color system +# wayland_titlebar_color system #: The color of the kitty window's titlebar on Wayland systems with #: client side window decorations such as GNOME. A value of system @@ -1420,7 +1594,7 @@ wayland_titlebar_color system #: to use the background color of the currently active window and #: finally you can use an arbitrary color, such as #12af59 or red. -macos_titlebar_color system +# macos_titlebar_color system #: The color of the kitty window's titlebar on macOS. A value of #: system means to use the default system color, light or dark can @@ -1434,7 +1608,7 @@ macos_titlebar_color system #: background_opacity. If you want to use both, you are probably #: better off just hiding the titlebar with hide_window_decorations. -macos_option_as_alt no +# macos_option_as_alt no #: Use the Option key as an Alt key on macOS. With this set to no, #: kitty will use the macOS native Option+Key to enter Unicode @@ -1449,37 +1623,38 @@ macos_option_as_alt no #: will not be passed to terminal programs running inside kitty. #: Changing this option by reloading the config is not supported. -macos_hide_from_tasks no +# macos_hide_from_tasks no #: Hide the kitty window from running tasks on macOS (⌘+Tab and the #: Dock). Changing this option by reloading the config is not #: supported. -macos_quit_when_last_window_closed no +# macos_quit_when_last_window_closed no #: Have kitty quit when all the top-level windows are closed on macOS. #: By default, kitty will stay running, even with no open windows, as #: is the expected behavior on macOS. -macos_window_resizable yes +# macos_window_resizable yes #: Disable this if you want kitty top-level OS windows to not be -#: resizable on macOS. Changing this option by reloading the config -#: will only affect newly created OS windows. +#: resizable on macOS. -macos_thicken_font 0 +# macos_thicken_font 0 #: Draw an extra border around the font with the given width, to #: increase legibility at small font sizes on macOS. For example, a #: value of 0.75 will result in rendering that looks similar to sub- -#: pixel antialiasing at common font sizes. +#: pixel antialiasing at common font sizes. Note that in modern kitty, +#: this option is obsolete (although still supported). Consider using +#: text_composition_strategy instead. -macos_traditional_fullscreen no +# macos_traditional_fullscreen no #: Use the macOS traditional full-screen transition, that is faster, #: but less pretty. -macos_show_window_title_in all +# macos_show_window_title_in all #: Control where the window title is displayed on macOS. A value of #: window will show the title of the currently active window at the @@ -1490,13 +1665,13 @@ macos_show_window_title_in all #: macos_menubar_title_max_length for how to control the length of the #: title in the menu bar. -macos_menubar_title_max_length 0 +# macos_menubar_title_max_length 0 #: The maximum number of characters from the window title to show in #: the macOS global menu bar. Values less than one means that there is #: no maximum limit. -macos_custom_beam_cursor no +# macos_custom_beam_cursor no #: Use a custom mouse cursor for macOS that is easier to see on both #: light and dark backgrounds. Nowadays, the default macOS cursor @@ -1504,7 +1679,7 @@ macos_custom_beam_cursor no #: mouse cursor invisible on dual GPU machines. Changing this option #: by reloading the config is not supported. -macos_colorspace srgb +# macos_colorspace srgb #: The colorspace in which to interpret terminal colors. The default #: of srgb will cause colors to match those seen in web browsers. The @@ -1515,7 +1690,7 @@ macos_colorspace srgb #: configuration will change this value only for newly created OS #: windows. -linux_display_server auto +# linux_display_server auto #: Choose between Wayland and X11 backends. By default, an appropriate #: backend based on the system state is chosen automatically. Set it @@ -1593,16 +1768,16 @@ linux_display_server auto #: The full list of actions that can be mapped to key presses is #: available here . -kitty_mod ctrl+shift +# kitty_mod ctrl+shift #: Special modifier key alias for default shortcuts. You can change #: the value of this option to alter all default shortcuts that use #: kitty_mod. -clear_all_shortcuts no +# clear_all_shortcuts no -#: You can have kitty remove all shortcut definition seen up to this -#: point. Useful, for instance, to remove the default shortcuts. +#: Remove all shortcut definitions up to this point. Useful, for +#: instance, to remove the default shortcuts. # action_alias @@ -1636,26 +1811,28 @@ clear_all_shortcuts no #: Copy to clipboard -map kitty_mod+c copy_to_clipboard +# map kitty_mod+c copy_to_clipboard +# map cmd+c copy_to_clipboard #:: There is also a copy_or_interrupt action that can be optionally -#:: mapped to Ctrl+c. It will copy only if there is a selection and +#:: mapped to Ctrl+C. It will copy only if there is a selection and #:: send an interrupt otherwise. Similarly, #:: copy_and_clear_or_interrupt will copy and clear the selection or #:: send an interrupt if there is no selection. #: Paste from clipboard -map kitty_mod+v paste_from_clipboard +# map kitty_mod+v paste_from_clipboard +# map cmd+v paste_from_clipboard #: Paste from selection -map kitty_mod+s paste_from_selection -map shift+insert paste_from_selection +# map kitty_mod+s paste_from_selection +# map shift+insert paste_from_selection #: Pass selection to program -map kitty_mod+o pass_selection_to_program +# map kitty_mod+o pass_selection_to_program #:: You can also pass the contents of the current selection to any #:: program with pass_selection_to_program. By default, the system's @@ -1676,41 +1853,41 @@ map kitty_mod+o pass_selection_to_program #: Scroll line up -map kitty_mod+up scroll_line_up -map kitty_mod+k scroll_line_up -map opt+cmd+page_up scroll_line_up -map cmd+up scroll_line_up +# map kitty_mod+up scroll_line_up +# map kitty_mod+k scroll_line_up +# map opt+cmd+page_up scroll_line_up +# map cmd+up scroll_line_up #: Scroll line down -map kitty_mod+down scroll_line_down -map kitty_mod+j scroll_line_down -map opt+cmd+page_down scroll_line_down -map cmd+down scroll_line_down +# map kitty_mod+down scroll_line_down +# map kitty_mod+j scroll_line_down +# map opt+cmd+page_down scroll_line_down +# map cmd+down scroll_line_down #: Scroll page up -map kitty_mod+page_up scroll_page_up -map cmd+page_up scroll_page_up +# map kitty_mod+page_up scroll_page_up +# map cmd+page_up scroll_page_up #: Scroll page down -map kitty_mod+page_down scroll_page_down -map cmd+page_down scroll_page_down +# map kitty_mod+page_down scroll_page_down +# map cmd+page_down scroll_page_down #: Scroll to top -map kitty_mod+home scroll_home -map cmd+home scroll_home +# map kitty_mod+home scroll_home +# map cmd+home scroll_home #: Scroll to bottom -map kitty_mod+end scroll_end -map cmd+end scroll_end +# map kitty_mod+end scroll_end +# map cmd+end scroll_end #: Scroll to previous shell prompt -map kitty_mod+z scroll_to_prompt -1 +# map kitty_mod+z scroll_to_prompt -1 #:: Use a parameter of 0 for scroll_to_prompt to scroll to the last #:: jumped to or the last clicked position. Requires shell @@ -1719,11 +1896,11 @@ map kitty_mod+z scroll_to_prompt -1 #: Scroll to next shell prompt -map kitty_mod+x scroll_to_prompt 1 +# map kitty_mod+x scroll_to_prompt 1 #: Browse scrollback buffer in pager -map kitty_mod+h show_scrollback +# map kitty_mod+h show_scrollback #:: You can pipe the contents of the current screen and history #:: buffer as STDIN to an arbitrary program using launch --stdin- @@ -1737,7 +1914,7 @@ map kitty_mod+h show_scrollback #: Browse output of the last shell command in pager -map kitty_mod+g show_last_command_output +# map kitty_mod+g show_last_command_output #:: You can also define additional shortcuts to get the command #:: output. For example, to get the first command output on screen:: @@ -1798,7 +1975,8 @@ map kitty_mod+enter launch --type os-window --cwd=current #: New OS window -map kitty_mod+n new_os_window +# map kitty_mod+n new_os_window +# map cmd+n new_os_window #:: Works like new_window above, except that it opens a top-level OS #:: window. In particular you can use new_os_window_with_cwd to open @@ -1806,85 +1984,86 @@ map kitty_mod+n new_os_window #: Close window -map kitty_mod+w close_window +# map kitty_mod+w close_window +# map shift+cmd+d close_window #: Next window -map kitty_mod+] next_window +# map kitty_mod+] next_window #: Previous window -map kitty_mod+[ previous_window +# map kitty_mod+[ previous_window #: Move window forward -map kitty_mod+f move_window_forward +# map kitty_mod+f move_window_forward #: Move window backward -map kitty_mod+b move_window_backward +# map kitty_mod+b move_window_backward #: Move window to top -map kitty_mod+` move_window_to_top +# map kitty_mod+` move_window_to_top #: Start resizing window -map kitty_mod+r start_resizing_window -map cmd+r start_resizing_window +# map kitty_mod+r start_resizing_window +# map cmd+r start_resizing_window #: First window -map kitty_mod+1 first_window -map cmd+1 first_window +# map kitty_mod+1 first_window +# map cmd+1 first_window #: Second window -map kitty_mod+2 second_window -map cmd+2 second_window +# map kitty_mod+2 second_window +# map cmd+2 second_window #: Third window -map kitty_mod+3 third_window -map cmd+3 third_window +# map kitty_mod+3 third_window +# map cmd+3 third_window #: Fourth window -map kitty_mod+4 fourth_window -map cmd+4 fourth_window +# map kitty_mod+4 fourth_window +# map cmd+4 fourth_window #: Fifth window -map kitty_mod+5 fifth_window -map cmd+5 fifth_window +# map kitty_mod+5 fifth_window +# map cmd+5 fifth_window #: Sixth window -map kitty_mod+6 sixth_window -map cmd+6 sixth_window +# map kitty_mod+6 sixth_window +# map cmd+6 sixth_window #: Seventh window -map kitty_mod+7 seventh_window -map cmd+7 seventh_window +# map kitty_mod+7 seventh_window +# map cmd+7 seventh_window -#: Eight window +#: Eighth window -map kitty_mod+8 eighth_window -map cmd+8 eighth_window +# map kitty_mod+8 eighth_window +# map cmd+8 eighth_window #: Ninth window -map kitty_mod+9 ninth_window -map cmd+9 ninth_window +# map kitty_mod+9 ninth_window +# map cmd+9 ninth_window #: Tenth window -map kitty_mod+0 tenth_window +# map kitty_mod+0 tenth_window #: Visually select and focus window -map kitty_mod+f7 focus_visible_window +# map kitty_mod+f7 focus_visible_window #:: Display overlay numbers and alphabets on the window, and switch #:: the focus to the window when you press the key. When there are @@ -1894,7 +2073,7 @@ map kitty_mod+f7 focus_visible_window #: Visually swap window with another -map kitty_mod+f8 swap_with_window +# map kitty_mod+f8 swap_with_window #:: Works like focus_visible_window above, but swaps the window. @@ -1904,42 +2083,42 @@ map kitty_mod+f8 swap_with_window #: Next tab -map kitty_mod+right next_tab -map shift+cmd+] next_tab -map ctrl+tab next_tab +# map kitty_mod+right next_tab +# map shift+cmd+] next_tab +# map ctrl+tab next_tab #: Previous tab -map kitty_mod+left previous_tab -map shift+cmd+[ previous_tab -map ctrl+shift+tab previous_tab +# map kitty_mod+left previous_tab +# map shift+cmd+[ previous_tab +# map ctrl+shift+tab previous_tab #: New tab -map kitty_mod+t new_tab -map cmd+t new_tab +# map kitty_mod+t new_tab +# map cmd+t new_tab #: Close tab -map kitty_mod+q close_tab -map cmd+w close_tab +# map kitty_mod+q close_tab +# map cmd+w close_tab #: Close OS window -map shift+cmd+w close_os_window +# map shift+cmd+w close_os_window #: Move tab forward -map kitty_mod+. move_tab_forward +# map kitty_mod+. move_tab_forward #: Move tab backward -map kitty_mod+, move_tab_backward +# map kitty_mod+, move_tab_backward #: Set tab title -map kitty_mod+alt+t set_tab_title -map shift+cmd+i set_tab_title +# map kitty_mod+alt+t set_tab_title +# map shift+cmd+i set_tab_title #: You can also create shortcuts to go to specific tabs, with 1 being @@ -1961,7 +2140,7 @@ map shift+cmd+i set_tab_title #: Next layout -map kitty_mod+l next_layout +# map kitty_mod+l next_layout #: You can also create shortcuts to switch to specific layouts:: @@ -1988,24 +2167,24 @@ map kitty_mod+l next_layout #: Increase font size -map kitty_mod+equal change_font_size all +2.0 -map kitty_mod+plus change_font_size all +2.0 -map kitty_mod+kp_add change_font_size all +2.0 -map cmd+plus change_font_size all +2.0 -map cmd+equal change_font_size all +2.0 -map shift+cmd+equal change_font_size all +2.0 +# map kitty_mod+equal change_font_size all +2.0 +# map kitty_mod+plus change_font_size all +2.0 +# map kitty_mod+kp_add change_font_size all +2.0 +# map cmd+plus change_font_size all +2.0 +# map cmd+equal change_font_size all +2.0 +# map shift+cmd+equal change_font_size all +2.0 #: Decrease font size -map kitty_mod+minus change_font_size all -2.0 -map kitty_mod+kp_subtract change_font_size all -2.0 -map cmd+minus change_font_size all -2.0 -map shift+cmd+minus change_font_size all -2.0 +# map kitty_mod+minus change_font_size all -2.0 +# map kitty_mod+kp_subtract change_font_size all -2.0 +# map cmd+minus change_font_size all -2.0 +# map shift+cmd+minus change_font_size all -2.0 #: Reset font size -map kitty_mod+backspace change_font_size all 0 -map cmd+0 change_font_size all 0 +# map kitty_mod+backspace change_font_size all 0 +# map cmd+0 change_font_size all 0 #: To setup shortcuts for specific font sizes:: @@ -2026,14 +2205,14 @@ map cmd+0 change_font_size all 0 #: Open URL -map kitty_mod+e open_url_with_hints +# map kitty_mod+e open_url_with_hints #:: Open a currently visible URL using the keyboard. The program used #:: to open the URL is specified in open_url_with. #: Insert selected path -map kitty_mod+p>f kitten hints --type path --program - +# map kitty_mod+p>f kitten hints --type path --program - #:: Select a path/filename and insert it into the terminal. Useful, #:: for instance to run git commands on a filename output from a @@ -2041,26 +2220,26 @@ map kitty_mod+p>f kitten hints --type path --program - #: Open selected path -map kitty_mod+p>shift+f kitten hints --type path +# map kitty_mod+p>shift+f kitten hints --type path #:: Select a path/filename and open it with the default open program. #: Insert selected line -map kitty_mod+p>l kitten hints --type line --program - +# map kitty_mod+p>l kitten hints --type line --program - #:: Select a line of text and insert it into the terminal. Useful for #:: the output of things like: `ls -1`. #: Insert selected word -map kitty_mod+p>w kitten hints --type word --program - +# map kitty_mod+p>w kitten hints --type word --program - #:: Select words and insert into terminal. #: Insert selected hash -map kitty_mod+p>h kitten hints --type hash --program - +# map kitty_mod+p>h kitten hints --type hash --program - #:: Select something that looks like a hash and insert it into the #:: terminal. Useful with git, which uses SHA1 hashes to identify @@ -2068,14 +2247,14 @@ map kitty_mod+p>h kitten hints --type hash --program - #: Open the selected file at the selected line -map kitty_mod+p>n kitten hints --type linenum +# map kitty_mod+p>n kitten hints --type linenum #:: Select something that looks like filename:linenum and open it in #:: vim at the specified line number. #: Open the selected hyperlink -map kitty_mod+p>y kitten hints --type hyperlink +# map kitty_mod+p>y kitten hints --type hyperlink #:: Select a hyperlink (i.e. a URL that has been marked as such by #:: the terminal program, for example, by `ls --hyperlink=auto`). @@ -2090,53 +2269,58 @@ map kitty_mod+p>y kitten hints --type hyperlink #: Show documentation -map kitty_mod+f1 show_kitty_doc overview +# map kitty_mod+f1 show_kitty_doc overview #: Toggle fullscreen -map kitty_mod+f11 toggle_fullscreen +# map kitty_mod+f11 toggle_fullscreen +# map ctrl+cmd+f toggle_fullscreen #: Toggle maximized -map kitty_mod+f10 toggle_maximized +# map kitty_mod+f10 toggle_maximized + +#: Toggle macOS secure keyboard entry + +# map opt+cmd+s toggle_macos_secure_keyboard_entry #: Unicode input -map kitty_mod+u kitten unicode_input -map ctrl+cmd+space kitten unicode_input +# map kitty_mod+u kitten unicode_input +# map ctrl+cmd+space kitten unicode_input #: Edit config file -map kitty_mod+f2 edit_config_file -map cmd+, edit_config_file +# map kitty_mod+f2 edit_config_file +# map cmd+, edit_config_file #: Open the kitty command shell -map kitty_mod+escape kitty_shell window +# map kitty_mod+escape kitty_shell window #:: Open the kitty shell in a new window / tab / overlay / os_window #:: to control kitty using commands. #: Increase background opacity -map kitty_mod+a>m set_background_opacity +0.1 +# map kitty_mod+a>m set_background_opacity +0.1 #: Decrease background opacity -map kitty_mod+a>l set_background_opacity -0.1 +# map kitty_mod+a>l set_background_opacity -0.1 #: Make background fully opaque -map kitty_mod+a>1 set_background_opacity 1 +# map kitty_mod+a>1 set_background_opacity 1 #: Reset background opacity -map kitty_mod+a>d set_background_opacity default +# map kitty_mod+a>d set_background_opacity default #: Reset the terminal -map kitty_mod+delete clear_terminal reset active -map opt+cmd+r clear_terminal reset active +# map kitty_mod+delete clear_terminal reset active +# map opt+cmd+r clear_terminal reset active #:: You can create shortcuts to clear/reset the terminal. For #:: example:: @@ -2155,28 +2339,46 @@ map opt+cmd+r clear_terminal reset active #:: If you want to operate on all kitty windows instead of just the #:: current one, use all instead of active. -#:: It is also possible to remap Ctrl+L to both scroll the current -#:: screen contents into the scrollback buffer and clear the screen, -#:: instead of just clearing the screen, for example, for ZSH add the -#:: following to ~/.zshrc: +#:: Some useful functions that can be defined in the shell rc files +#:: to perform various kinds of clearing of the current window: + +#:: .. code-block:: sh + +#:: clear-only-screen() { +#:: printf "\e[H\e[2J" +#:: } + +#:: clear-screen-and-scrollback() { +#:: printf "\e[H\e[3J" +#:: } + +#:: clear-screen-saving-contents-in-scrollback() { +#:: printf "\e[H\e[22J" +#:: } + +#:: For instance, using these escape codes, it is possible to remap +#:: Ctrl+L to both scroll the current screen contents into the +#:: scrollback buffer and clear the screen, instead of just clearing +#:: the screen. For ZSH, in ~/.zshrc, add: #:: .. code-block:: zsh -#:: scroll-and-clear-screen() { -#:: printf '\n%.0s' {1..$LINES} -#:: zle clear-screen +#:: ctrl_l() { +#:: builtin print -rn -- $'\r\e[0J\e[H\e[22J' >"$TTY" +#:: builtin zle .reset-prompt +#:: builtin zle -R #:: } -#:: zle -N scroll-and-clear-screen -#:: bindkey '^l' scroll-and-clear-screen +#:: zle -N ctrl_l +#:: bindkey '^l' ctrl_l #: Clear up to cursor line -map cmd+k clear_terminal to_cursor active +# map cmd+k clear_terminal to_cursor active #: Reload kitty.conf -map kitty_mod+f5 load_config_file -map ctrl+cmd+, load_config_file +# map kitty_mod+f5 load_config_file +# map ctrl+cmd+, load_config_file #:: Reload kitty.conf, applying any changes since the last time it #:: was loaded. Note that a handful of options cannot be dynamically @@ -2192,8 +2394,8 @@ map ctrl+cmd+, load_config_file #: Debug kitty configuration -map kitty_mod+f6 debug_config -map opt+cmd+, debug_config +# map kitty_mod+f6 debug_config +# map opt+cmd+, debug_config #:: Show details about exactly what configuration kitty is running #:: with and its host environment. Useful for debugging issues. @@ -2209,11 +2411,13 @@ map opt+cmd+, debug_config #:: map ctrl+alt+a send_text all Special text #:: This will send "Special text" when you press the Ctrl+Alt+A key -#:: combination. The text to be sent is a python string literal so -#:: you can use escapes like \x1b to send control codes or \u21fb to -#:: send Unicode characters (or you can just input the Unicode -#:: characters directly as UTF-8 text). You can use `kitty +kitten -#:: show_key` to get the key escape codes you want to emulate. +#:: combination. The text to be sent decodes ANSI C escapes +#:: so you can use escapes like \e to send control +#:: codes or \u21fb to send Unicode characters (or you can just input +#:: the Unicode characters directly as UTF-8 text). You can use +#:: `kitten show_key` to get the key escape codes you want to +#:: emulate. #:: The first argument to send_text is the keyboard modes in which to #:: activate the shortcut. The possible values are normal, @@ -2225,15 +2429,16 @@ map opt+cmd+, debug_config #:: Some more examples:: #:: # Output a word and move the cursor to the start of the line (like typing and pressing Home) -#:: map ctrl+alt+a send_text normal Word\x1b[H -#:: map ctrl+alt+a send_text application Word\x1bOH +#:: map ctrl+alt+a send_text normal Word\e[H +#:: map ctrl+alt+a send_text application Word\eOH #:: # Run a command at a shell prompt (like typing the command and pressing Enter) #:: map ctrl+alt+a send_text normal,application some command with arguments\r #: Open kitty Website -map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/ +# map shift+cmd+/ open_url https://sw.kovidgoyal.net/kitty/ +#: Hide macOS kitty application map kitty_mod+F2 launch --type overlay --cwd=current lazygit