kitty.default.conf 88 KB

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