kitty.conf 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306
  1. # vim:fileencoding=utf-8:ft=conf:foldmethod=marker
  2. #: Fonts {{{
  3. #: kitty has very powerful font management. You can configure
  4. #: individual font faces and even specify special fonts for particular
  5. #: characters.
  6. # font_family monospace
  7. # bold_font auto
  8. # italic_font auto
  9. # bold_italic_font auto
  10. #: You can specify different fonts for the bold/italic/bold-italic
  11. #: variants. To get a full list of supported fonts use the `kitty
  12. #: list-fonts` command. By default they are derived automatically, by
  13. #: the OSes font system. Setting them manually is useful for font
  14. #: families that have many weight variants like Book, Medium, Thick,
  15. #: etc. For example::
  16. #: font_family Operator Mono Book
  17. #: bold_font Operator Mono Medium
  18. #: italic_font Operator Mono Book Italic
  19. #: bold_italic_font Operator Mono Medium Italic
  20. # font_size 11.0
  21. #: Font size (in pts)
  22. # force_ltr no
  23. #: kitty does not support BIDI (bidirectional text), however, for RTL
  24. #: scripts, words are automatically displayed in RTL. That is to say,
  25. #: in an RTL script, the words "HELLO WORLD" display in kitty as
  26. #: "WORLD HELLO", and if you try to select a substring of an RTL-
  27. #: shaped string, you will get the character that would be there had
  28. #: the the string been LTR. For example, assuming the Hebrew word
  29. #: ירושלים, selecting the character that on the screen appears to be ם
  30. #: actually writes into the selection buffer the character י.
  31. #: kitty's default behavior is useful in conjunction with a filter to
  32. #: reverse the word order, however, if you wish to manipulate RTL
  33. #: glyphs, it can be very challenging to work with, so this option is
  34. #: provided to turn it off. Furthermore, this option can be used with
  35. #: the command line program GNU FriBidi
  36. #: <https://github.com/fribidi/fribidi#executable> to get BIDI
  37. #: support, because it will force kitty to always treat the text as
  38. #: LTR, which FriBidi expects for terminals.
  39. # adjust_line_height 0
  40. # adjust_column_width 0
  41. #: Change the size of each character cell kitty renders. You can use
  42. #: either numbers, which are interpreted as pixels or percentages
  43. #: (number followed by %), which are interpreted as percentages of the
  44. #: unmodified values. You can use negative pixels or percentages less
  45. #: than 100% to reduce sizes (but this might cause rendering
  46. #: artifacts).
  47. # symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols
  48. #: Map the specified unicode codepoints to a particular font. Useful
  49. #: if you need special rendering for some symbols, such as for
  50. #: Powerline. Avoids the need for patched fonts. Each unicode code
  51. #: point is specified in the form U+<code point in hexadecimal>. You
  52. #: can specify multiple code points, separated by commas and ranges
  53. #: separated by hyphens. symbol_map itself can be specified multiple
  54. #: times. Syntax is::
  55. #: symbol_map codepoints Font Family Name
  56. # disable_ligatures never
  57. #: Choose how you want to handle multi-character ligatures. The
  58. #: default is to always render them. You can tell kitty to not render
  59. #: them when the cursor is over them by using cursor to make editing
  60. #: easier, or have kitty never render them at all by using always, if
  61. #: you don't like them. The ligature strategy can be set per-window
  62. #: either using the kitty remote control facility or by defining
  63. #: shortcuts for it in kitty.conf, for example::
  64. #: map alt+1 disable_ligatures_in active always
  65. #: map alt+2 disable_ligatures_in all never
  66. #: map alt+3 disable_ligatures_in tab cursor
  67. #: Note that this refers to programming ligatures, typically
  68. #: implemented using the calt OpenType feature. For disabling general
  69. #: ligatures, use the font_features setting.
  70. # font_features none
  71. #: Choose exactly which OpenType features to enable or disable. This
  72. #: is useful as some fonts might have features worthwhile in a
  73. #: terminal. For example, Fira Code Retina includes a discretionary
  74. #: feature, zero, which in that font changes the appearance of the
  75. #: zero (0), to make it more easily distinguishable from Ø. Fira Code
  76. #: Retina also includes other discretionary features known as
  77. #: Stylistic Sets which have the tags ss01 through ss20.
  78. #: Note that this code is indexed by PostScript name, and not the font
  79. #: family. This allows you to define very precise feature settings;
  80. #: e.g. you can disable a feature in the italic font but not in the
  81. #: regular font.
  82. #: On Linux, these are read from the FontConfig database first and
  83. #: then this, setting is applied, so they can be configured in a
  84. #: single, central place.
  85. #: To get the PostScript name for a font, use kitty + list-fonts
  86. #: --psnames:
  87. #: .. code-block:: sh
  88. #: $ kitty + list-fonts --psnames | grep Fira
  89. #: Fira Code
  90. #: Fira Code Bold (FiraCode-Bold)
  91. #: Fira Code Light (FiraCode-Light)
  92. #: Fira Code Medium (FiraCode-Medium)
  93. #: Fira Code Regular (FiraCode-Regular)
  94. #: Fira Code Retina (FiraCode-Retina)
  95. #: The part in brackets is the PostScript name.
  96. #: Enable alternate zero and oldstyle numerals::
  97. #: font_features FiraCode-Retina +zero +onum
  98. #: Enable only alternate zero::
  99. #: font_features FiraCode-Retina +zero
  100. #: Disable the normal ligatures, but keep the calt feature which (in
  101. #: this font) breaks up monotony::
  102. #: font_features TT2020StyleB-Regular -liga +calt
  103. #: In conjunction with force_ltr, you may want to disable Arabic
  104. #: shaping entirely, and only look at their isolated forms if they
  105. #: show up in a document. You can do this with e.g.::
  106. #: font_features UnifontMedium +isol -medi -fina -init
  107. # box_drawing_scale 0.001, 1, 1.5, 2
  108. #: Change the sizes of the lines used for the box drawing unicode
  109. #: characters These values are in pts. They will be scaled by the
  110. #: monitor DPI to arrive at a pixel value. There must be four values
  111. #: corresponding to thin, normal, thick, and very thick lines.
  112. #: }}}
  113. #: Cursor customization {{{
  114. # cursor #cccccc
  115. #: Default cursor color
  116. # cursor_text_color #111111
  117. #: Choose the color of text under the cursor. If you want it rendered
  118. #: with the background color of the cell underneath instead, use the
  119. #: special keyword: background
  120. # cursor_shape block
  121. #: The cursor shape can be one of (block, beam, underline)
  122. # cursor_beam_thickness 1.5
  123. #: Defines the thickness of the beam cursor (in pts)
  124. # cursor_underline_thickness 2.0
  125. #: Defines the thickness of the underline cursor (in pts)
  126. cursor_blink_interval 0
  127. #: The interval (in seconds) at which to blink the cursor. Set to zero
  128. #: to disable blinking. Negative values mean use system default. Note
  129. #: that numbers smaller than repaint_delay will be limited to
  130. #: repaint_delay.
  131. # cursor_stop_blinking_after 15.0
  132. #: Stop blinking cursor after the specified number of seconds of
  133. #: keyboard inactivity. Set to zero to never stop blinking.
  134. #: }}}
  135. #: Scrollback {{{
  136. scrollback_lines 50000
  137. #: Number of lines of history to keep in memory for scrolling back.
  138. #: Memory is allocated on demand. Negative numbers are (effectively)
  139. #: infinite scrollback. Note that using very large scrollback is not
  140. #: recommended as it can slow down performance of the terminal and
  141. #: also use large amounts of RAM. Instead, consider using
  142. #: scrollback_pager_history_size.
  143. # scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER
  144. #: Program with which to view scrollback in a new window. The
  145. #: scrollback buffer is passed as STDIN to this program. If you change
  146. #: it, make sure the program you use can handle ANSI escape sequences
  147. #: for colors and text formatting. INPUT_LINE_NUMBER in the command
  148. #: line above will be replaced by an integer representing which line
  149. #: should be at the top of the screen. Similarly CURSOR_LINE and
  150. #: CURSOR_COLUMN will be replaced by the current cursor position.
  151. # scrollback_pager_history_size 0
  152. #: Separate scrollback history size, used only for browsing the
  153. #: scrollback buffer (in MB). This separate buffer is not available
  154. #: for interactive scrolling but will be piped to the pager program
  155. #: when viewing scrollback buffer in a separate window. The current
  156. #: implementation stores the data in UTF-8, so approximatively 10000
  157. #: lines per megabyte at 100 chars per line, for pure ASCII text,
  158. #: unformatted text. A value of zero or less disables this feature.
  159. #: The maximum allowed size is 4GB.
  160. # wheel_scroll_multiplier 5.0
  161. #: Modify the amount scrolled by the mouse wheel. Note this is only
  162. #: used for low precision scrolling devices, not for high precision
  163. #: scrolling on platforms such as macOS and Wayland. Use negative
  164. #: numbers to change scroll direction.
  165. # touch_scroll_multiplier 1.0
  166. #: Modify the amount scrolled by a touchpad. Note this is only used
  167. #: for high precision scrolling devices on platforms such as macOS and
  168. #: Wayland. Use negative numbers to change scroll direction.
  169. #: }}}
  170. #: Mouse {{{
  171. # mouse_hide_wait 3.0
  172. #: Hide mouse cursor after the specified number of seconds of the
  173. #: mouse not being used. Set to zero to disable mouse cursor hiding.
  174. #: Set to a negative value to hide the mouse cursor immediately when
  175. #: typing text. Disabled by default on macOS as getting it to work
  176. #: robustly with the ever-changing sea of bugs that is Cocoa is too
  177. #: much effort.
  178. # url_color #0087bd
  179. # url_style curly
  180. #: The color and style for highlighting URLs on mouse-over. url_style
  181. #: can be one of: none, single, double, curly
  182. open_url_modifiers ctrl
  183. #: The modifier keys to press when clicking with the mouse on URLs to
  184. #: open the URL
  185. # open_url_with default
  186. #: The program with which to open URLs that are clicked on. The
  187. #: special value default means to use the operating system's default
  188. #: URL handler.
  189. # url_prefixes http https file ftp
  190. #: The set of URL prefixes to look for when detecting a URL under the
  191. #: mouse cursor.
  192. # detect_urls yes
  193. #: Detect URLs under the mouse. Detected URLs are highlighted with an
  194. #: underline and the mouse cursor becomes a hand over them. Even if
  195. #: this option is disabled, URLs are still clickable.
  196. # copy_on_select no
  197. #: Copy to clipboard or a private buffer on select. With this set to
  198. #: clipboard, simply selecting text with the mouse will cause the text
  199. #: to be copied to clipboard. Useful on platforms such as macOS that
  200. #: do not have the concept of primary selections. You can instead
  201. #: specify a name such as a1 to copy to a private kitty buffer
  202. #: instead. Map a shortcut with the paste_from_buffer action to paste
  203. #: from this private buffer. For example::
  204. #: map cmd+shift+v paste_from_buffer a1
  205. #: Note that copying to the clipboard is a security risk, as all
  206. #: programs, including websites open in your browser can read the
  207. #: contents of the system clipboard.
  208. strip_trailing_spaces smart
  209. #: Remove spaces at the end of lines when copying to clipboard. A
  210. #: value of smart will do it when using normal selections, but not
  211. #: rectangle selections. always will always do it.
  212. # rectangle_select_modifiers ctrl+alt
  213. #: The modifiers to use rectangular selection (i.e. to select text in
  214. #: a rectangular block with the mouse)
  215. # terminal_select_modifiers shift
  216. #: The modifiers to override mouse selection even when a terminal
  217. #: application has grabbed the mouse
  218. # select_by_word_characters @-./_~?&=%+#
  219. #: Characters considered part of a word when double clicking. In
  220. #: addition to these characters any character that is marked as an
  221. #: alphanumeric character in the unicode database will be matched.
  222. # click_interval -1.0
  223. #: The interval between successive clicks to detect double/triple
  224. #: clicks (in seconds). Negative numbers will use the system default
  225. #: instead, if available, or fallback to 0.5.
  226. # focus_follows_mouse no
  227. #: Set the active window to the window under the mouse when moving the
  228. #: mouse around
  229. # pointer_shape_when_grabbed arrow
  230. #: The shape of the mouse pointer when the program running in the
  231. #: terminal grabs the mouse. Valid values are: arrow, beam and hand
  232. # default_pointer_shape beam
  233. #: The default shape of the mouse pointer. Valid values are: arrow,
  234. #: beam and hand
  235. # pointer_shape_when_dragging beam
  236. #: The default shape of the mouse pointer when dragging across text.
  237. #: Valid values are: arrow, beam and hand
  238. #: }}}
  239. #: Performance tuning {{{
  240. # repaint_delay 10
  241. #: Delay (in milliseconds) between screen updates. Decreasing it,
  242. #: increases frames-per-second (FPS) at the cost of more CPU usage.
  243. #: The default value yields ~100 FPS which is more than sufficient for
  244. #: most uses. Note that to actually achieve 100 FPS you have to either
  245. #: set sync_to_monitor to no or use a monitor with a high refresh
  246. #: rate. Also, to minimize latency when there is pending input to be
  247. #: processed, repaint_delay is ignored.
  248. # input_delay 3
  249. #: Delay (in milliseconds) before input from the program running in
  250. #: the terminal is processed. Note that decreasing it will increase
  251. #: responsiveness, but also increase CPU usage and might cause flicker
  252. #: in full screen programs that redraw the entire screen on each loop,
  253. #: because kitty is so fast that partial screen updates will be drawn.
  254. # sync_to_monitor yes
  255. #: Sync screen updates to the refresh rate of the monitor. This
  256. #: prevents tearing (https://en.wikipedia.org/wiki/Screen_tearing)
  257. #: when scrolling. However, it limits the rendering speed to the
  258. #: refresh rate of your monitor. With a very high speed mouse/high
  259. #: keyboard repeat rate, you may notice some slight input latency. If
  260. #: so, set this to no.
  261. #: }}}
  262. #: Terminal bell {{{
  263. enable_audio_bell no
  264. #: Enable/disable the audio bell. Useful in environments that require
  265. #: silence.
  266. # visual_bell_duration 0.0
  267. #: Visual bell duration. Flash the screen when a bell occurs for the
  268. #: specified number of seconds. Set to zero to disable.
  269. # window_alert_on_bell yes
  270. #: Request window attention on bell. Makes the dock icon bounce on
  271. #: macOS or the taskbar flash on linux.
  272. # bell_on_tab yes
  273. #: Show a bell symbol on the tab if a bell occurs in one of the
  274. #: windows in the tab and the window is not the currently focused
  275. #: window
  276. # command_on_bell none
  277. #: Program to run when a bell occurs.
  278. #: }}}
  279. #: Window layout {{{
  280. remember_window_size no
  281. initial_window_width 800
  282. initial_window_height 600
  283. #: If enabled, the window size will be remembered so that new
  284. #: instances of kitty will have the same size as the previous
  285. #: instance. If disabled, the window will initially have size
  286. #: configured by initial_window_width/height, in pixels. You can use a
  287. #: suffix of "c" on the width/height values to have them interpreted
  288. #: as number of cells instead of pixels.
  289. enabled_layouts tall, stack
  290. #: The enabled window layouts. A comma separated list of layout names.
  291. #: The special value all means all layouts. The first listed layout
  292. #: will be used as the startup layout. Default configuration is all
  293. #: layouts in alphabetical order. For a list of available layouts, see
  294. #: the https://sw.kovidgoyal.net/kitty/index.html#layouts.
  295. # window_resize_step_cells 2
  296. # window_resize_step_lines 2
  297. #: The step size (in units of cell width/cell height) to use when
  298. #: resizing windows. The cells value is used for horizontal resizing
  299. #: and the lines value for vertical resizing.
  300. # window_border_width 0.5pt
  301. #: The width of window borders. Can be either in pixels (px) or pts
  302. #: (pt). Values in pts will be rounded to the nearest number of pixels
  303. #: based on screen resolution. If not specified the unit is assumed to
  304. #: be pts. Note that borders are displayed only when more than one
  305. #: window is visible. They are meant to separate multiple windows.
  306. # draw_minimal_borders yes
  307. #: Draw only the minimum borders needed. This means that only the
  308. #: minimum needed borders for inactive windows are drawn. That is only
  309. #: the borders that separate the inactive window from a neighbor. Note
  310. #: that setting a non-zero window margin overrides this and causes all
  311. #: borders to be drawn.
  312. # window_margin_width 0
  313. #: The window margin (in pts) (blank area outside the border). A
  314. #: single value sets all four sides. Two values set the vertical and
  315. #: horizontal sides. Three values set top, horizontal and bottom. Four
  316. #: values set top, right, bottom and left.
  317. # single_window_margin_width -1
  318. #: The window margin (in pts) to use when only a single window is
  319. #: visible. Negative values will cause the value of
  320. #: window_margin_width to be used instead. A single value sets all
  321. #: four sides. Two values set the vertical and horizontal sides. Three
  322. #: values set top, horizontal and bottom. Four values set top, right,
  323. #: bottom and left.
  324. # window_padding_width 0
  325. #: The window padding (in pts) (blank area between the text and the
  326. #: window border). A single value sets all four sides. Two values set
  327. #: the vertical and horizontal sides. Three values set top, horizontal
  328. #: and bottom. Four values set top, right, bottom and left.
  329. # placement_strategy center
  330. #: When the window size is not an exact multiple of the cell size, the
  331. #: cell area of the terminal window will have some extra padding on
  332. #: the sides. You can control how that padding is distributed with
  333. #: this option. Using a value of center means the cell area will be
  334. #: placed centrally. A value of top-left means the padding will be on
  335. #: only the bottom and right edges.
  336. # active_border_color #00ff00
  337. #: The color for the border of the active window. Set this to none to
  338. #: not draw borders around the active window.
  339. # inactive_border_color #cccccc
  340. #: The color for the border of inactive windows
  341. # bell_border_color #ff5a00
  342. #: The color for the border of inactive windows in which a bell has
  343. #: occurred
  344. # inactive_text_alpha 1.0
  345. #: Fade the text in inactive windows by the specified amount (a number
  346. #: between zero and one, with zero being fully faded).
  347. # hide_window_decorations no
  348. #: Hide the window decorations (title-bar and window borders) with
  349. #: yes. On macOS, titlebar-only can be used to only hide the titlebar.
  350. #: Whether this works and exactly what effect it has depends on the
  351. #: window manager/operating system.
  352. # resize_debounce_time 0.1
  353. #: The time (in seconds) to wait before redrawing the screen when a
  354. #: resize event is received. On platforms such as macOS, where the
  355. #: operating system sends events corresponding to the start and end of
  356. #: a resize, this number is ignored.
  357. # resize_draw_strategy static
  358. #: Choose how kitty draws a window while a resize is in progress. A
  359. #: value of static means draw the current window contents, mostly
  360. #: unchanged. A value of scale means draw the current window contents
  361. #: scaled. A value of blank means draw a blank window. A value of size
  362. #: means show the window size in cells.
  363. # resize_in_steps no
  364. #: Resize the OS window in steps as large as the cells, instead of
  365. #: with the usual pixel accuracy. Combined with an
  366. #: initial_window_width and initial_window_height in number of cells,
  367. #: this option can be used to keep the margins as small as possible
  368. #: when resizing the OS window. Note that this does not currently work
  369. #: on Wayland.
  370. # confirm_os_window_close 0
  371. #: Ask for confirmation when closing an OS window or a tab that has at
  372. #: least this number of kitty windows in it. A value of zero disables
  373. #: confirmation. This confirmation also applies to requests to quit
  374. #: the entire application (all OS windows, via the quit action).
  375. #: }}}
  376. #: Tab bar {{{
  377. # tab_bar_edge bottom
  378. #: Which edge to show the tab bar on, top or bottom
  379. # tab_bar_margin_width 0.0
  380. #: The margin to the left and right of the tab bar (in pts)
  381. # tab_bar_style fade
  382. #: The tab bar style, can be one of: fade, separator, powerline, or
  383. #: hidden. In the fade style, each tab's edges fade into the
  384. #: background color, in the separator style, tabs are separated by a
  385. #: configurable separator, and the powerline shows the tabs as a
  386. #: continuous line. If you use the hidden style, you might want to
  387. #: create a mapping for the select_tab action which presents you with
  388. #: a list of tabs and allows for easy switching to a tab.
  389. # tab_bar_min_tabs 2
  390. #: The minimum number of tabs that must exist before the tab bar is
  391. #: shown
  392. # tab_switch_strategy previous
  393. #: The algorithm to use when switching to a tab when the current tab
  394. #: is closed. The default of previous will switch to the last used
  395. #: tab. A value of left will switch to the tab to the left of the
  396. #: closed tab. A value of right will switch to the tab to the right of
  397. #: the closed tab. A value of last will switch to the right-most tab.
  398. # tab_fade 0.25 0.5 0.75 1
  399. #: Control how each tab fades into the background when using fade for
  400. #: the tab_bar_style. Each number is an alpha (between zero and one)
  401. #: that controls how much the corresponding cell fades into the
  402. #: background, with zero being no fade and one being full fade. You
  403. #: can change the number of cells used by adding/removing entries to
  404. #: this list.
  405. # tab_separator " ┇"
  406. #: The separator between tabs in the tab bar when using separator as
  407. #: the tab_bar_style.
  408. # tab_activity_symbol none
  409. #: Some text or a unicode symbol to show on the tab if a window in the
  410. #: tab that does not have focus has some activity.
  411. # tab_title_template "{title}"
  412. #: A template to render the tab title. The default just renders the
  413. #: title. If you wish to include the tab-index as well, use something
  414. #: like: {index}: {title}. Useful if you have shortcuts mapped for
  415. #: goto_tab N. In addition you can use {layout_name} for the current
  416. #: layout name and {num_windows} for the number of windows in the tab.
  417. #: Note that formatting is done by Python's string formatting
  418. #: machinery, so you can use, for instance, {layout_name[:2].upper()}
  419. #: to show only the first two letters of the layout name, upper-cased.
  420. #: If you want to style the text, you can use styling directives, for
  421. #: example: {fmt.fg.red}red{fmt.fg.default}normal{fmt.bg._00FF00}green
  422. #: bg{fmt.bg.normal}. Similarly, for bold and italic:
  423. #: {fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}.
  424. # active_tab_title_template none
  425. #: Template to use for active tabs, if not specified falls back to
  426. #: tab_title_template.
  427. # active_tab_foreground #000
  428. # active_tab_background #eee
  429. # active_tab_font_style bold-italic
  430. # inactive_tab_foreground #444
  431. # inactive_tab_background #999
  432. # inactive_tab_font_style normal
  433. #: Tab bar colors and styles
  434. # tab_bar_background none
  435. #: Background color for the tab bar. Defaults to using the terminal
  436. #: background color.
  437. #: }}}
  438. #: Color scheme {{{
  439. # foreground #dddddd
  440. # background #000000
  441. #: The foreground and background colors
  442. background_opacity 0.9
  443. #: The opacity of the background. A number between 0 and 1, where 1 is
  444. #: opaque and 0 is fully transparent. This will only work if
  445. #: supported by the OS (for instance, when using a compositor under
  446. #: X11). Note that it only sets the background color's opacity in
  447. #: cells that have the same background color as the default terminal
  448. #: background. This is so that things like the status bar in vim,
  449. #: powerline prompts, etc. still look good. But it means that if you
  450. #: use a color theme with a background color in your editor, it will
  451. #: not be rendered as transparent. Instead you should change the
  452. #: default background color in your kitty config and not use a
  453. #: background color in the editor color scheme. Or use the escape
  454. #: codes to set the terminals default colors in a shell script to
  455. #: launch your editor. Be aware that using a value less than 1.0 is a
  456. #: (possibly significant) performance hit. If you want to dynamically
  457. #: change transparency of windows set dynamic_background_opacity to
  458. #: yes (this is off by default as it has a performance cost)
  459. # background_image none
  460. #: Path to a background image. Must be in PNG format.
  461. # background_image_layout tiled
  462. #: Whether to tile or scale the background image.
  463. # background_image_linear no
  464. #: When background image is scaled, whether linear interpolation
  465. #: should be used.
  466. # dynamic_background_opacity no
  467. #: Allow changing of the background_opacity dynamically, using either
  468. #: keyboard shortcuts (increase_background_opacity and
  469. #: decrease_background_opacity) or the remote control facility.
  470. # background_tint 0.0
  471. #: How much to tint the background image by the background color. The
  472. #: tint is applied only under the text area, not margin/borders. Makes
  473. #: it easier to read the text. Tinting is done using the current
  474. #: background color for each window. This setting applies only if
  475. #: background_opacity is set and transparent windows are supported or
  476. #: background_image is set.
  477. # dim_opacity 0.75
  478. #: How much to dim text that has the DIM/FAINT attribute set. One
  479. #: means no dimming and zero means fully dimmed (i.e. invisible).
  480. # selection_foreground #000000
  481. #: The foreground for text selected with the mouse. A value of none
  482. #: means to leave the color unchanged.
  483. # selection_background #fffacd
  484. #: The background for text selected with the mouse.
  485. #: The 16 terminal colors. There are 8 basic colors, each color has a
  486. #: dull and bright version. You can also set the remaining colors from
  487. #: the 256 color table as color16 to color255.
  488. color0 #444444
  489. color1 #fb9fb1
  490. color2 #acc267
  491. color3 #ddb26f
  492. color4 #6fc2ef
  493. color5 #e1a3ee
  494. color6 #12cfc0
  495. color7 #d0d0d0
  496. color8 #505050
  497. color9 #fb9fb1
  498. color10 #acc267
  499. color11 #ddb26f
  500. color12 #6fc2ef
  501. color13 #e1a3ee
  502. color14 #12cfc0
  503. color15 #f5f5f5
  504. # mark1_foreground black
  505. #: Color for marks of type 1
  506. # mark1_background #98d3cb
  507. #: Color for marks of type 1 (light steel blue)
  508. # mark2_foreground black
  509. #: Color for marks of type 2
  510. # mark2_background #f2dcd3
  511. #: Color for marks of type 1 (beige)
  512. # mark3_foreground black
  513. #: Color for marks of type 3
  514. # mark3_background #f274bc
  515. #: Color for marks of type 1 (violet)
  516. #: }}}
  517. #: Advanced {{{
  518. # shell .
  519. #: The shell program to execute. The default value of . means to use
  520. #: whatever shell is set as the default shell for the current user.
  521. #: Note that on macOS if you change this, you might need to add
  522. #: --login to ensure that the shell starts in interactive mode and
  523. #: reads its startup rc files.
  524. # editor .
  525. #: The console editor to use when editing the kitty config file or
  526. #: similar tasks. A value of . means to use the environment variables
  527. #: VISUAL and EDITOR in that order. Note that this environment
  528. #: variable has to be set not just in your shell startup scripts but
  529. #: system-wide, otherwise kitty will not see it.
  530. # close_on_child_death no
  531. #: Close the window when the child process (shell) exits. If no (the
  532. #: default), the terminal will remain open when the child exits as
  533. #: long as there are still processes outputting to the terminal (for
  534. #: example disowned or backgrounded processes). If yes, the window
  535. #: will close as soon as the child process exits. Note that setting it
  536. #: to yes means that any background processes still using the terminal
  537. #: can fail silently because their stdout/stderr/stdin no longer work.
  538. # allow_remote_control no
  539. #: Allow other programs to control kitty. If you turn this on other
  540. #: programs can control all aspects of kitty, including sending text
  541. #: to kitty windows, opening new windows, closing windows, reading the
  542. #: content of windows, etc. Note that this even works over ssh
  543. #: connections. You can chose to either allow any program running
  544. #: within kitty to control it, with yes or only programs that connect
  545. #: to the socket specified with the kitty --listen-on command line
  546. #: option, if you use the value socket-only. The latter is useful if
  547. #: you want to prevent programs running on a remote computer over ssh
  548. #: from controlling kitty.
  549. # listen_on none
  550. #: Tell kitty to listen to the specified unix/tcp socket for remote
  551. #: control connections. Note that this will apply to all kitty
  552. #: instances. It can be overridden by the kitty --listen-on command
  553. #: line flag. This option accepts only UNIX sockets, such as
  554. #: unix:${TEMP}/mykitty or (on Linux) unix:@mykitty. Environment
  555. #: variables are expanded. If {kitty_pid} is present then it is
  556. #: replaced by the PID of the kitty process, otherwise the PID of the
  557. #: kitty process is appended to the value, with a hyphen. This option
  558. #: is ignored unless you also set allow_remote_control to enable
  559. #: remote control. See the help for kitty --listen-on for more
  560. #: details.
  561. # env
  562. #: Specify environment variables to set in all child processes. Note
  563. #: that environment variables are expanded recursively, so if you
  564. #: use::
  565. #: env MYVAR1=a
  566. #: env MYVAR2=${MYVAR1}/${HOME}/b
  567. #: The value of MYVAR2 will be a/<path to home directory>/b.
  568. # update_check_interval 24
  569. #: Periodically check if an update to kitty is available. If an update
  570. #: is found a system notification is displayed informing you of the
  571. #: available update. The default is to check every 24 hrs, set to zero
  572. #: to disable.
  573. # startup_session none
  574. #: Path to a session file to use for all kitty instances. Can be
  575. #: overridden by using the kitty --session command line option for
  576. #: individual instances. See
  577. #: https://sw.kovidgoyal.net/kitty/index.html#sessions in the kitty
  578. #: documentation for details. Note that relative paths are interpreted
  579. #: with respect to the kitty config directory. Environment variables
  580. #: in the path are expanded.
  581. # clipboard_control write-clipboard write-primary
  582. #: Allow programs running in kitty to read and write from the
  583. #: clipboard. You can control exactly which actions are allowed. The
  584. #: set of possible actions is: write-clipboard read-clipboard write-
  585. #: primary read-primary. You can additionally specify no-append to
  586. #: disable kitty's protocol extension for clipboard concatenation. The
  587. #: default is to allow writing to the clipboard and primary selection
  588. #: with concatenation enabled. Note that enabling the read
  589. #: functionality is a security risk as it means that any program, even
  590. #: one running on a remote server via SSH can read your clipboard.
  591. # allow_hyperlinks yes
  592. #: Process hyperlink (OSC 8) escape sequences. If disabled OSC 8
  593. #: escape sequences are ignored. Otherwise they become clickable
  594. #: links, that you can click by holding down ctrl+shift and clicking
  595. #: with the mouse. The special value of ``ask`` means that kitty will
  596. #: ask before opening the link.
  597. # term xterm-kitty
  598. #: The value of the TERM environment variable to set. Changing this
  599. #: can break many terminal programs, only change it if you know what
  600. #: you are doing, not because you read some advice on Stack Overflow
  601. #: to change it. The TERM variable is used by various programs to get
  602. #: information about the capabilities and behavior of the terminal. If
  603. #: you change it, depending on what programs you run, and how
  604. #: different the terminal you are changing it to is, various things
  605. #: from key-presses, to colors, to various advanced features may not
  606. #: work.
  607. #: }}}
  608. #: OS specific tweaks {{{
  609. # macos_titlebar_color system
  610. #: Change the color of the kitty window's titlebar on macOS. A value
  611. #: of system means to use the default system color, a value of
  612. #: background means to use the background color of the currently
  613. #: active window and finally you can use an arbitrary color, such as
  614. #: #12af59 or red. WARNING: This option works by using a hack, as
  615. #: there is no proper Cocoa API for it. It sets the background color
  616. #: of the entire window and makes the titlebar transparent. As such it
  617. #: is incompatible with background_opacity. If you want to use both,
  618. #: you are probably better off just hiding the titlebar with
  619. #: hide_window_decorations.
  620. # macos_option_as_alt no
  621. #: Use the option key as an alt key. With this set to no, kitty will
  622. #: use the macOS native Option+Key = unicode character behavior. This
  623. #: will break any Alt+key keyboard shortcuts in your terminal
  624. #: programs, but you can use the macOS unicode input technique. You
  625. #: can use the values: left, right, or both to use only the left,
  626. #: right or both Option keys as Alt, instead.
  627. # macos_hide_from_tasks no
  628. #: Hide the kitty window from running tasks (Option+Tab) on macOS.
  629. # macos_quit_when_last_window_closed no
  630. #: Have kitty quit when all the top-level windows are closed. By
  631. #: default, kitty will stay running, even with no open windows, as is
  632. #: the expected behavior on macOS.
  633. # macos_window_resizable yes
  634. #: Disable this if you want kitty top-level (OS) windows to not be
  635. #: resizable on macOS.
  636. # macos_thicken_font 0
  637. #: Draw an extra border around the font with the given width, to
  638. #: increase legibility at small font sizes. For example, a value of
  639. #: 0.75 will result in rendering that looks similar to sub-pixel
  640. #: antialiasing at common font sizes.
  641. # macos_traditional_fullscreen no
  642. #: Use the traditional full-screen transition, that is faster, but
  643. #: less pretty.
  644. # macos_show_window_title_in all
  645. #: Show or hide the window title in the macOS window or menu-bar. A
  646. #: value of window will show the title of the currently active window
  647. #: at the top of the macOS window. A value of menubar will show the
  648. #: title of the currently active window in the macOS menu-bar, making
  649. #: use of otherwise wasted space. all will show the title everywhere
  650. #: and none hides the title in the window and the menu-bar.
  651. # macos_custom_beam_cursor no
  652. #: Enable/disable custom mouse cursor for macOS that is easier to see
  653. #: on both light and dark backgrounds. WARNING: this might make your
  654. #: mouse cursor invisible on dual GPU machines.
  655. # linux_display_server auto
  656. #: Choose between Wayland and X11 backends. By default, an appropriate
  657. #: backend based on the system state is chosen automatically. Set it
  658. #: to x11 or wayland to force the choice.
  659. #: }}}
  660. #: Keyboard shortcuts {{{
  661. #: For a list of key names, see: the GLFW key macros
  662. #: <https://github.com/kovidgoyal/kitty/blob/master/glfw/glfw3.h#L349>.
  663. #: The name to use is the part after the GLFW_KEY_ prefix. For a list
  664. #: of modifier names, see: GLFW mods
  665. #: <https://www.glfw.org/docs/latest/group__mods.html>
  666. #: On Linux you can also use XKB key names to bind keys that are not
  667. #: supported by GLFW. See XKB keys
  668. #: <https://github.com/xkbcommon/libxkbcommon/blob/master/xkbcommon/xkbcommon-
  669. #: keysyms.h> for a list of key names. The name to use is the part
  670. #: after the XKB_KEY_ prefix. Note that you can only use an XKB key
  671. #: name for keys that are not known as GLFW keys.
  672. #: Finally, you can use raw system key codes to map keys, again only
  673. #: for keys that are not known as GLFW keys. To see the system key
  674. #: code for a key, start kitty with the kitty --debug-keyboard option.
  675. #: Then kitty will output some debug text for every key event. In that
  676. #: text look for ``native_code`` the value of that becomes the key
  677. #: name in the shortcut. For example:
  678. #: .. code-block:: none
  679. #: on_key_input: glfw key: 65 native_code: 0x61 action: PRESS mods: 0x0 text: 'a'
  680. #: Here, the key name for the A key is 0x61 and you can use it with::
  681. #: map ctrl+0x61 something
  682. #: to map ctrl+a to something.
  683. #: You can use the special action no_op to unmap a keyboard shortcut
  684. #: that is assigned in the default configuration::
  685. #: map kitty_mod+space no_op
  686. #: You can combine multiple actions to be triggered by a single
  687. #: shortcut, using the syntax below::
  688. #: map key combine <separator> action1 <separator> action2 <separator> action3 ...
  689. #: For example::
  690. #: map kitty_mod+e combine : new_window : next_layout
  691. #: this will create a new window and switch to the next available
  692. #: layout
  693. #: You can use multi-key shortcuts using the syntax shown below::
  694. #: map key1>key2>key3 action
  695. #: For example::
  696. #: map ctrl+f>2 set_font_size 20
  697. kitty_mod super
  698. #: The value of kitty_mod is used as the modifier for all default
  699. #: shortcuts, you can change it in your kitty.conf to change the
  700. #: modifiers for all the default shortcuts.
  701. # clear_all_shortcuts no
  702. #: You can have kitty remove all shortcut definition seen up to this
  703. #: point. Useful, for instance, to remove the default shortcuts.
  704. # kitten_alias hints hints --hints-offset=0
  705. #: You can create aliases for kitten names, this allows overriding the
  706. #: defaults for kitten options and can also be used to shorten
  707. #: repeated mappings of the same kitten with a specific group of
  708. #: options. For example, the above alias changes the default value of
  709. #: kitty +kitten hints --hints-offset to zero for all mappings,
  710. #: including the builtin ones.
  711. #: Clipboard {{{
  712. # map kitty_mod+c copy_to_clipboard
  713. map ctrl+shift+c copy_to_clipboard
  714. #: There is also a copy_or_interrupt action that can be optionally
  715. #: mapped to Ctrl+c. It will copy only if there is a selection and
  716. #: send an interrupt otherwise. Similarly, copy_and_clear_or_interrupt
  717. #: will copy and clear the selection or send an interrupt if there is
  718. #: no selection.
  719. # map kitty_mod+v paste_from_clipboard
  720. map ctrl+shift+v paste_from_clipboard
  721. # map kitty_mod+s paste_from_selection
  722. # map shift+insert paste_from_selection
  723. # map kitty_mod+o pass_selection_to_program
  724. #: You can also pass the contents of the current selection to any
  725. #: program using pass_selection_to_program. By default, the system's
  726. #: open program is used, but you can specify your own, the selection
  727. #: will be passed as a command line argument to the program, for
  728. #: example::
  729. #: map kitty_mod+o pass_selection_to_program firefox
  730. #: You can pass the current selection to a terminal program running in
  731. #: a new kitty window, by using the @selection placeholder::
  732. #: map kitty_mod+y new_window less @selection
  733. #: }}}
  734. #: Scrolling {{{
  735. # map kitty_mod+up scroll_line_up
  736. # map kitty_mod+k scroll_line_up
  737. # map kitty_mod+down scroll_line_down
  738. # map kitty_mod+j scroll_line_down
  739. # map kitty_mod+page_up scroll_page_up
  740. # map kitty_mod+page_down scroll_page_down
  741. # map kitty_mod+home scroll_home
  742. # map kitty_mod+end scroll_end
  743. map shift+page_up scroll_page_up
  744. map shift+page_down scroll_page_down
  745. map shift+home scroll_home
  746. map shift+end scroll_end
  747. # map kitty_mod+h show_scrollback
  748. map kitty_mod+shift+h show_scrollback
  749. #: You can pipe the contents of the current screen + history buffer as
  750. #: STDIN to an arbitrary program using the ``launch`` function. For
  751. #: example, the following opens the scrollback buffer in less in an
  752. #: overlay window::
  753. #: map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting --type=overlay less +G -R
  754. #: For more details on piping screen and buffer contents to external
  755. #: programs, see launch.
  756. #: }}}
  757. #: Window management {{{
  758. # map kitty_mod+enter new_window
  759. map kitty_mod+shift+enter new_window
  760. #: You can open a new window running an arbitrary program, for
  761. #: example::
  762. #: map kitty_mod+y launch mutt
  763. #: You can open a new window with the current working directory set to
  764. #: the working directory of the current window using::
  765. #: map ctrl+alt+enter launch --cwd=current
  766. #: You can open a new window that is allowed to control kitty via the
  767. #: kitty remote control facility by prefixing the command line with @.
  768. #: Any programs running in that window will be allowed to control
  769. #: kitty. For example::
  770. #: map ctrl+enter launch --allow-remote-control some_program
  771. #: You can open a new window next to the currently active window or as
  772. #: the first window, with::
  773. #: map ctrl+n launch --location=neighbor some_program
  774. #: map ctrl+f launch --location=first some_program
  775. #: For more details, see launch.
  776. # map kitty_mod+n new_os_window
  777. #: Works like new_window above, except that it opens a top level OS
  778. #: kitty window. In particular you can use new_os_window_with_cwd to
  779. #: open a window with the current working directory.
  780. # map kitty_mod+w close_window
  781. # map kitty_mod+] next_window
  782. # map kitty_mod+[ previous_window
  783. # map kitty_mod+f move_window_forward
  784. # map kitty_mod+b move_window_backward
  785. # map kitty_mod+` move_window_to_top
  786. # map kitty_mod+r start_resizing_window
  787. # map kitty_mod+1 first_window
  788. # map kitty_mod+2 second_window
  789. # map kitty_mod+3 third_window
  790. # map kitty_mod+4 fourth_window
  791. # map kitty_mod+5 fifth_window
  792. # map kitty_mod+6 sixth_window
  793. # map kitty_mod+7 seventh_window
  794. # map kitty_mod+8 eighth_window
  795. # map kitty_mod+9 ninth_window
  796. # map kitty_mod+0 tenth_window
  797. map kitty_mod+shift+j move_window_forward
  798. map kitty_mod+shift+k move_window_backward
  799. map kitty_mod+h neighboring_window left
  800. map kitty_mod+j neighboring_window down
  801. map kitty_mod+k neighboring_window up
  802. map kitty_mod+l neighboring_window right
  803. #: }}}
  804. #: Tab management {{{
  805. # map kitty_mod+right next_tab
  806. # map kitty_mod+left previous_tab
  807. # map kitty_mod+t new_tab
  808. # map kitty_mod+q close_tab
  809. # map kitty_mod+. move_tab_forward
  810. # map kitty_mod+, move_tab_backward
  811. # map kitty_mod+alt+t set_tab_title
  812. #: You can also create shortcuts to go to specific tabs, with 1 being
  813. #: the first tab, 2 the second tab and -1 being the previously active
  814. #: tab, and any number larger than the last tab being the last tab::
  815. #: map ctrl+alt+1 goto_tab 1
  816. #: map ctrl+alt+2 goto_tab 2
  817. #: Just as with new_window above, you can also pass the name of
  818. #: arbitrary commands to run when using new_tab and use
  819. #: new_tab_with_cwd. Finally, if you want the new tab to open next to
  820. #: the current tab rather than at the end of the tabs list, use::
  821. #: map ctrl+t new_tab !neighbor [optional cmd to run]
  822. #: }}}
  823. #: Layout management {{{
  824. # map kitty_mod+l next_layout
  825. #: You can also create shortcuts to switch to specific layouts::
  826. #: map ctrl+alt+t goto_layout tall
  827. #: map ctrl+alt+s goto_layout stack
  828. #: Similarly, to switch back to the previous layout::
  829. #: map ctrl+alt+p last_used_layout
  830. map kitty_mod+enter next_layout
  831. #: }}}
  832. #: Font sizes {{{
  833. #: You can change the font size for all top-level kitty OS windows at
  834. #: a time or only the current one.
  835. # map kitty_mod+equal change_font_size all +2.0
  836. # map kitty_mod+minus change_font_size all -2.0
  837. # map kitty_mod+backspace change_font_size all 0
  838. #: To setup shortcuts for specific font sizes::
  839. #: map kitty_mod+f6 change_font_size all 10.0
  840. #: To setup shortcuts to change only the current OS window's font
  841. #: size::
  842. #: map kitty_mod+f6 change_font_size current 10.0
  843. #: }}}
  844. #: Select and act on visible text {{{
  845. #: Use the hints kitten to select text and either pass it to an
  846. #: external program or insert it into the terminal or copy it to the
  847. #: clipboard.
  848. # map kitty_mod+e kitten hints
  849. #: Open a currently visible URL using the keyboard. The program used
  850. #: to open the URL is specified in open_url_with.
  851. # map kitty_mod+p>f kitten hints --type path --program -
  852. #: Select a path/filename and insert it into the terminal. Useful, for
  853. #: instance to run git commands on a filename output from a previous
  854. #: git command.
  855. # map kitty_mod+p>shift+f kitten hints --type path
  856. #: Select a path/filename and open it with the default open program.
  857. # map kitty_mod+p>l kitten hints --type line --program -
  858. #: Select a line of text and insert it into the terminal. Use for the
  859. #: output of things like: ls -1
  860. # map kitty_mod+p>w kitten hints --type word --program -
  861. #: Select words and insert into terminal.
  862. # map kitty_mod+p>h kitten hints --type hash --program -
  863. #: Select something that looks like a hash and insert it into the
  864. #: terminal. Useful with git, which uses sha1 hashes to identify
  865. #: commits
  866. # map kitty_mod+p>n kitten hints --type linenum
  867. #: Select something that looks like filename:linenum and open it in
  868. #: vim at the specified line number.
  869. # map kitty_mod+p>y kitten hints --type hyperlink
  870. #: Select a hyperlink (i.e. a URL that has been marked as such by the
  871. #: terminal program, for example, by ls --hyperlink=auto).
  872. #: The hints kitten has many more modes of operation that you can map
  873. #: to different shortcuts. For a full description see kittens/hints.
  874. #: }}}
  875. #: Miscellaneous {{{
  876. # map kitty_mod+f11 toggle_fullscreen
  877. # map kitty_mod+f10 toggle_maximized
  878. # map kitty_mod+u kitten unicode_input
  879. # map kitty_mod+f2 edit_config_file
  880. # map kitty_mod+escape kitty_shell window
  881. #: Open the kitty shell in a new window/tab/overlay/os_window to
  882. #: control kitty using commands.
  883. # map kitty_mod+a>m set_background_opacity +0.1
  884. # map kitty_mod+a>l set_background_opacity -0.1
  885. # map kitty_mod+a>1 set_background_opacity 1
  886. # map kitty_mod+a>d set_background_opacity default
  887. # map kitty_mod+delete clear_terminal reset active
  888. #: You can create shortcuts to clear/reset the terminal. For example::
  889. #: # Reset the terminal
  890. #: map kitty_mod+f9 clear_terminal reset active
  891. #: # Clear the terminal screen by erasing all contents
  892. #: map kitty_mod+f10 clear_terminal clear active
  893. #: # Clear the terminal scrollback by erasing it
  894. #: map kitty_mod+f11 clear_terminal scrollback active
  895. #: # Scroll the contents of the screen into the scrollback
  896. #: map kitty_mod+f12 clear_terminal scroll active
  897. #: If you want to operate on all windows instead of just the current
  898. #: one, use all instead of active.
  899. #: It is also possible to remap Ctrl+L to both scroll the current
  900. #: screen contents into the scrollback buffer and clear the screen,
  901. #: instead of just clearing the screen::
  902. #: map ctrl+l combine : clear_terminal scroll active : send_text normal,application \x0c
  903. #: You can tell kitty to send arbitrary (UTF-8) encoded text to the
  904. #: client program when pressing specified shortcut keys. For example::
  905. #: map ctrl+alt+a send_text all Special text
  906. #: This will send "Special text" when you press the ctrl+alt+a key
  907. #: combination. The text to be sent is a python string literal so you
  908. #: can use escapes like \x1b to send control codes or \u21fb to send
  909. #: unicode characters (or you can just input the unicode characters
  910. #: directly as UTF-8 text). The first argument to send_text is the
  911. #: keyboard modes in which to activate the shortcut. The possible
  912. #: values are normal or application or kitty or a comma separated
  913. #: combination of them. The special keyword all means all modes. The
  914. #: modes normal and application refer to the DECCKM cursor key mode
  915. #: for terminals, and kitty refers to the special kitty extended
  916. #: keyboard protocol.
  917. #: Another example, that outputs a word and then moves the cursor to
  918. #: the start of the line (same as pressing the Home key)::
  919. #: map ctrl+alt+a send_text normal Word\x1b[H
  920. #: map ctrl+alt+a send_text application Word\x1bOH
  921. #: }}}
  922. # }}}