kitty.conf 83 KB

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