kitty.conf 81 KB

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