-
Notifications
You must be signed in to change notification settings - Fork 0
/
kitty.conf
2165 lines (1492 loc) · 73.3 KB
/
kitty.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# vim:fileencoding=utf-8:foldmethod=marker
include ./theme.conf
#: Fonts {{{
#: kitty has very powerful font management. You can configure
#: individual font faces and even specify special fonts for particular
#: characters.
#font_family 'FiraCode Nerd Font'
font_family Cascadia Code PL
# 0 0 000
bold_font Cascadia Code PL Bold
italic_font Cascadia Code PL Italic
bold_italic_font Cascadia Code PL Bold Italic
font_size 16.0
force_ltr no
#: You can specify different fonts for the bold/italic/bold-italic
#: variants. To get a full list of supported fonts use the `kitty
#: +list-fonts` command. By default they are derived automatically, by
#: the OSes font system. When bold_font or bold_italic_font is set to
#: auto on macOS, the priority of bold fonts is semi-bold, bold,
#: heavy. Setting them manually is useful for font families that have
#: many weight variants like Book, Medium, Thick, etc. For example::
#: font_family Operator Mono Book
#: bold_font Operator Mono Medium
#: italic_font Operator Mono Book Italic
#: bold_italic_font Operator Mono Medium Italic
# adjust_line_height 0
# adjust_column_width 0
#: Change the size of each character cell kitty renders. You can use
#: either numbers, which are interpreted as pixels or percentages
#: (number followed by %), which are interpreted as percentages of the
#: unmodified values. You can use negative pixels or percentages less
#: than 100% to reduce sizes (but this might cause rendering
#: artifacts).
# adjust_baseline 0
#: Adjust the vertical alignment of text (the height in the cell at
#: which text is positioned). You can use either numbers, which are
#: interpreted as pixels or percentages (number followed by %), which
#: are interpreted as the percentage of the line height. A positive
#: value moves the baseline up, and a negative value moves them down.
#: The underline and strikethrough positions are adjusted accordingly.
# symbol_map
#: E.g. symbol_map U+E0A0-U+E0A3,U+E0C0-U+E0C7 PowerlineSymbols
#: Map the specified Unicode codepoints to a particular font. Useful
#: if you need special rendering for some symbols, such as for
#: Powerline. Avoids the need for patched fonts. Each Unicode code
#: point is specified in the form `U+<code point in hexadecimal>`. You
#: can specify multiple code points, separated by commas and ranges
#: separated by hyphens. This option can be specified multiple times.
#: The syntax is::
#: symbol_map codepoints Font Family Name
# narrow_symbols
#: E.g. narrow_symbols U+E0A0-U+E0A3,U+E0C0-U+E0C7 1
#: Usually, for Private Use Unicode characters and some symbol/dingbat
#: characters, if the character is followed by one or more spaces,
#: kitty will use those extra cells to render the character larger, if
#: the character in the font has a wide aspect ratio. Using this
#: option you can force kitty to restrict the specified code points to
#: render in the specified number of cells (defaulting to one cell).
#: This option can be specified multiple times. The syntax is::
#: narrow_symbols codepoints [optionally the number of cells]
# disable_ligatures never
#: Choose how you want to handle multi-character ligatures. The
#: default is to always render them. You can tell kitty to not render
#: them when the cmouse_hide_waitursor is over them by using cursor to make editing
#: easier, or have kitty never render them at all by using always, if
#: you don't like them. The ligature strategy can be set per-window
#: either using the kitty remote control facility or by defining
#: shortcuts for it in kitty.conf, for example::
#: map alt+1 disable_ligatures_in active always
#: map alt+2 disable_ligatures_in all never
#: map alt+3 disable_ligatures_in tab cursor
#: Note that this refers to programming ligatures, typically
#: implemented using the calt OpenType feature. For disabling general
#: ligatures, use the font_features option.
# font_features
#: E.g. font_features none
#: Choose exactly which OpenType features to enable or disable. This
#: is useful as some fonts might have features worthwhile in a
#: terminal. For example, Fira Code includes a discretionary feature,
#: zero, which in that font changes the appearance of the zero (0), to
#: make it more easily distinguishable from Ø. Fira Code also includes
#: other discretionary features known as Stylistic Sets which have the
#: tags ss01 through ss20.
#: For the exact syntax to use for individual features, see the
#: HarfBuzz documentation <https://harfbuzz.github.io/harfbuzz-hb-
#: common.html#hb-feature-from-string>.
#: Note that this code is indexed by PostScript name, and not the font
#: family. This allows you to define very precise feature settings;
#: e.g. you can disable a feature in the italic font but not in the
#: regular font.
#: On Linux, font features are first read from the FontConfig database
#: and then this option is applied, so they can be configured in a
#: single, central place.
#: To get the PostScript name for a font, use `kitty +list-fonts
#: --psnames`:
#: .. code-block:: sh
#: $ kitty +list-fonts --psnames | grep Fira
#: Fira Code
#: Fira Code Bold (FiraCode-Bold)
#: Fira Code Light (FiraCode-Light)
#: Fira Code Medium (FiraCode-Medium)
#: Fira Code Regular (FiraCode-Regular)
#: Fira Code Retina (FiraCode-Retina)
#: The part in brackets is the PostScript name.
#: Enable alternate zero and oldstyle numerals::
#: font_features FiraCode-Retina +zero +onum
#: Enable only alternate zero in the bold font::
#: font_features FiraCode-Bold +zero
#: Disable the normal ligatures, but keep the calt feature which (in
#: this font) breaks up monotony::
#: font_features TT2020StyleB-Regular -liga +calt
#: In conjunction with force_ltr, you may want to disable Arabic
#: shaping entirely, and only look at their isolated forms if they
#: show up in a document. You can do this with e.g.::
#: font_features UnifontMedium +isol -medi -fina -init
# box_drawing_scale 0.001, 1, 1.5, 2
#: The sizes of the lines used for the box drawing Unicode characters.
#: These values are in pts. They will be scaled by the monitor DPI to
#: arrive at a pixel value. There must be four values corresponding to
#: thin, normal, thick, and very thick lines.
#: }}}
#: Cursor customization {{{
# cursor #cccccc
#: Default cursor color. If set to the special value none the cursor
#: will be rendered with a "reverse video" effect. It's color will be
#: the color of the text in the cell it is over and the text will be
#: rendered with the background color of the cell. Note that if the
#: program running in the terminal sets a cursor color, this takes
#: precedence. Also, the cursor colors are modified if the cell
#: background and foreground colors have very low contrast.
# cursor_text_color #111111
#: The color of text under the cursor. If you want it rendered with
#: the background color of the cell underneath instead, use the
#: special keyword: background. Note that if cursor is set to none
#: then this option is ignored.
# cursor_shape block
#: The cursor shape can be one of block, beam, underline. Note that
#: when reloading the config this will be changed only if the cursor
#: shape has not been set by the program running in the terminal. This
#: sets the default cursor shape, applications running in the terminal
#: can override it. In particular, shell integration
#: <https://sw.kovidgoyal.net/kitty/shell-integration/> in kitty sets
#: the cursor shape to beam at shell prompts. You can avoid this by
#: setting shell_integration to no-cursor.
# cursor_beam_thickness 1.5
#: The thickness of the beam cursor (in pts).
# cursor_underline_thickness 2.0
#: The thickness of the underline cursor (in pts).
# cursor_blink_interval -1
#: The interval to blink the cursor (in seconds). Set to zero to
#: disable blinking. Negative values mean use system default. Note
#: that the minimum interval will be limited to repaint_delay.
# cursor_stop_blinking_after 15.0
#: Stop blinking cursor after the specified number of seconds of
#: keyboard inactivity. Set to zero to never stop blinking.
#: }}}
#: Scrollback {{{
scrollback_lines -1
#: Number of lines of history to keep in memory for scrolling back.
#: Memory is allocated on demand. Negative numbers are (effectively)
#: infinite scrollback. Note that using very large scrollback is not
#: recommended as it can slow down performance of the terminal and
#: also use large amounts of RAM. Instead, consider using
#: scrollback_pager_history_size. Note that on config reload if this
#: is changed it will only affect newly created windows, not existing
#: ones.
# scrollback_pager less --chop-long-lines --RAW-CONTROL-CHARS +INPUT_LINE_NUMBER
#: Program with which to view scrollback in a new window. The
#: scrollback buffer is passed as STDIN to this program. If you change
#: it, make sure the program you use can handle ANSI escape sequences
#: for colors and text formatting. INPUT_LINE_NUMBER in the command
#: line above will be replaced by an integer representing which line
#: should be at the top of the screen. Similarly CURSOR_LINE and
#: CURSOR_COLUMN will be replaced by the current cursor position or
#: set to 0 if there is no cursor, for example, when showing the last
#: command output.
# scrollback_pager_history_size 0
#: Separate scrollback history size (in MB), used only for browsing
#: the scrollback buffer with pager. This separate buffer is not
#: available for interactive scrolling but will be piped to the pager
#: program when viewing scrollback buffer in a separate window. The
#: current implementation stores the data in UTF-8, so approximatively
#: 10000 lines per megabyte at 100 chars per line, for pure ASCII,
#: unformatted text. A value of zero or less disables this feature.
#: The maximum allowed size is 4GB. Note that on config reload if this
#: is changed it will only affect newly created windows, not existing
#: ones.
# scrollback_fill_enlarged_window no
#: Fill new space with lines from the scrollback buffer after
#: enlarging a window.
# wheel_scroll_multiplier 5.0
#: Multiplier for the number of lines scrolled by the mouse wheel.
#: Note that this is only used for low precision scrolling devices,
#: not for high precision scrolling devices on platforms such as macOS
#: and Wayland. Use negative numbers to change scroll direction. See
#: also wheel_scroll_min_lines.
# wheel_scroll_min_lines 1
#: The minimum number of lines scrolled by the mouse wheel. The scroll
#: multiplier <wheel_scroll_multiplier> only takes effect after it
#: reaches this number. Note that this is only used for low precision
#: scrolling devices like wheel mice that scroll by very small amounts
#: when using the wheel. With a negative number, the minimum number of
#: lines will always be added.
# touch_scroll_multiplier 1.0
#: Multiplier for the number of lines scrolled by a touchpad. Note
#: that this is only used for high precision scrolling devices on
#: platforms such as macOS and Wayland. Use negative numbers to change
#: scroll direction.
#: }}}
#: Mouse {{{
mouse_hide_wait 3.0
#: Hide mouse cursor after the specified number of seconds of the
#: mouse not being used. Set to zero to disable mouse cursor hiding.
#: Set to a negative value to hide the mouse cursor immediately when
#: typing text. Disabled by default on macOS as getting it to work
#: robustly with the ever-changing sea of bugs that is Cocoa is too
#: much effort.
url_color #0087bd
url_style curly
#: The color and style for highlighting URLs on mouse-over. url_style
#: can be one of: none, straight, double, curly, dotted, dashed.
open_url_with default
#: The program to open clicked URLs. The special value default means
#: to use the operating system's default URL handler (open on macOS
#: and xdg-open on Linux).
url_prefixes file ftp ftps gemini git gopher http https irc ircs kitty mailto news sftp ssh
detect_urls yes
# url_excluded_characters
#: Additional characters to be disallowed from URLs, when detecting
#: URLs under the mouse cursor. By default, all characters that are
#: legal in URLs are allowed.
copy_on_select yes
#: Copy to clipboard or a private buffer on select. With this set to
#: clipboard, selecting text with the mouse will cause the text to be
#: copied to clipboard. Useful on platforms such as macOS that do not
#: have the concept of primary selection. You can instead specify a
#: name such as a1 to copy to a private kitty buffer. Map a shortcut
#: with the paste_from_buffer action to paste from this private
#: buffer. For example::
#: copy_on_select a1
#: map shift+cmd+v paste_from_buffer a1
#: Note that copying to the clipboard is a security risk, as all
#: programs, including websites open in your browser can read the
#: contents of the system clipboard.
paste_actions quote-urls-at-prompt
#: A comma separated list of actions to take when pasting text into
#: the terminal. The supported paste actions are:
#: quote-urls-at-prompt:
#: If the text being pasted is a URL and the cursor is at a shell prompt,
#: automatically quote the URL (needs shell_integration).
#: confirm:
#: Confirm the paste if bracketed paste mode is not active or there is more
#: a large amount of text being pasted.
#: filter:
#: Run the filter_paste() function from the file paste-actions.py in
#: the kitty config directory on the pasted text. The text returned by the
#: function will be actually pasted.
# strip_trailing_spaces never
#: Remove spaces at the end of lines when copying to clipboard. A
#: value of smart will do it when using normal selections, but not
#: rectangle selections. A value of always will always do it.
# select_by_word_characters @-./_~?&=%+#
#: Characters considered part of a word when double clicking. In
#: addition to these characters any character that is marked as an
#: alphanumeric character in the Unicode database will be matched.
# select_by_word_characters_forward
#: Characters considered part of a word when extending the selection
#: forward on double clicking. In addition to these characters any
#: character that is marked as an alphanumeric character in the
#: Unicode database will be matched.
#: If empty (default) select_by_word_characters will be used for both
#: directions.
# click_interval -1.0
#: The interval between successive clicks to detect double/triple
#: clicks (in seconds). Negative numbers will use the system default
#: instead, if available, or fallback to 0.5.
# focus_follows_mouse no
#: Set the active window to the window under the mouse when moving the
#: mouse around.
# pointer_shape_when_grabbed arrow
#: The shape of the mouse pointer when the program running in the
#: terminal grabs the mouse. Valid values are: arrow, beam and hand.
# default_pointer_shape beam
#: The default shape of the mouse pointer. Valid values are: arrow,
#: beam and hand.
# pointer_shape_when_dragging beam
#: The default shape of the mouse pointer when dragging across text.
#: Valid values are: arrow, beam and hand.
#: Mouse actions {{{
#: Mouse buttons can be mapped to perform arbitrary actions. The
#: syntax is:
#: .. code-block:: none
#: mouse_map button-name event-type modes action
#: Where button-name is one of left, middle, right, b1 ... b8 with
#: added keyboard modifiers. For example: ctrl+shift+left refers to
#: holding the Ctrl+Shift keys while clicking with the left mouse
#: button. The value b1 ... b8 can be used to refer to up to eight
#: buttons on a mouse.
#: event-type is one of press, release, doublepress, triplepress,
#: click, doubleclick. modes indicates whether the action is performed
#: when the mouse is grabbed by the program running in the terminal,
#: or not. The values are grabbed or ungrabbed or a comma separated
#: combination of them. grabbed refers to when the program running in
#: the terminal has requested mouse events. Note that the click and
#: double click events have a delay of click_interval to disambiguate
#: from double and triple presses.
#: You can run kitty with the kitty --debug-input command line option
#: to see mouse events. See the builtin actions below to get a sense
#: of what is possible.
#: If you want to unmap an action, map it to no_op. For example, to
#: disable opening of URLs with a plain click::
#: mouse_map left click ungrabbed no_op
#: See all the mappable actions including mouse actions here
#: <https://sw.kovidgoyal.net/kitty/actions/>.
#: .. note::
#: Once a selection is started, releasing the button that started it will
#: automatically end it and no release event will be dispatched.
# clear_all_mouse_actions no
#: Remove all mouse action definitions up to this point. Useful, for
#: instance, to remove the default mouse actions.
#: Click the link under the mouse or move the cursor
# mouse_map left click ungrabbed mouse_handle_click selection link prompt
#:: First check for a selection and if one exists do nothing. Then
#:: check for a link under the mouse cursor and if one exists, click
#:: it. Finally check if the click happened at the current shell
#:: prompt and if so, move the cursor to the click location. Note
#:: that this requires shell integration
#:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work.
#: Click the link under the mouse or move the cursor even when grabbed
# mouse_map shift+left click grabbed,ungrabbed mouse_handle_click selection link prompt
#:: Same as above, except that the action is performed even when the
#:: mouse is grabbed by the program running in the terminal.
#: Click the link under the mouse cursor
# mouse_map ctrl+shift+left release grabbed,ungrabbed mouse_handle_click link
#:: Variant with Ctrl+Shift is present because the simple click based
#:: version has an unavoidable delay of click_interval, to
#:: disambiguate clicks from double clicks.
#: Discard press event for link click
# mouse_map ctrl+shift+left press grabbed discard_event
#:: Prevent this press event from being sent to the program that has
#:: grabbed the mouse, as the corresponding release event is used to
#:: open a URL.
#: Paste from the primary selection
# mouse_map middle release ungrabbed paste_from_selection
#: Start selecting text
# mouse_map left press ungrabbed mouse_selection normal
#: Start selecting text in a rectangle
# mouse_map ctrl+alt+left press ungrabbed mouse_selection rectangle
#: Select a word
# mouse_map left doublepress ungrabbed mouse_selection word
#: Select a line
# mouse_map left triplepress ungrabbed mouse_selection line
#: Select line from point
# mouse_map ctrl+alt+left triplepress ungrabbed mouse_selection line_from_point
#:: Select from the clicked point to the end of the line.
#: Extend the current selection
# mouse_map right press ungrabbed mouse_selection extend
#:: If you want only the end of the selection to be moved instead of
#:: the nearest boundary, use move-end instead of extend.
#: Paste from the primary selection even when grabbed
# mouse_map shift+middle release ungrabbed,grabbed paste_selection
# mouse_map shift+middle press grabbed discard_event
#: Start selecting text even when grabbed
# mouse_map shift+left press ungrabbed,grabbed mouse_selection normal
#: Start selecting text in a rectangle even when grabbed
# mouse_map ctrl+shift+alt+left press ungrabbed,grabbed mouse_selection rectangle
#: Select a word even when grabbed
# mouse_map shift+left doublepress ungrabbed,grabbed mouse_selection word
#: Select a line even when grabbed
# mouse_map shift+left triplepress ungrabbed,grabbed mouse_selection line
#: Select line from point even when grabbed
# mouse_map ctrl+shift+alt+left triplepress ungrabbed,grabbed mouse_selection line_from_point
#:: Select from the clicked point to the end of the line even when
#:: grabbed.
#: Extend the current selection even when grabbed
# mouse_map shift+right press ungrabbed,grabbed mouse_selection extend
#: Show clicked command output in pager
# mouse_map ctrl+shift+right press ungrabbed mouse_show_command_output
#:: Requires shell integration
#:: <https://sw.kovidgoyal.net/kitty/shell-integration/> to work.
#: }}}
#: }}}
#: Performance tuning {{{
# repaint_delay 10
#: Delay between screen updates (in milliseconds). Decreasing it,
#: increases frames-per-second (FPS) at the cost of more CPU usage.
#: The default value yields ~100 FPS which is more than sufficient for
#: most uses. Note that to actually achieve 100 FPS, you have to
#: either set sync_to_monitor to no or use a monitor with a high
#: refresh rate. Also, to minimize latency when there is pending input
#: to be processed, this option is ignored.
# input_delay 3
#: Delay before input from the program running in the terminal is
#: processed (in milliseconds). Note that decreasing it will increase
#: responsiveness, but also increase CPU usage and might cause flicker
#: in full screen programs that redraw the entire screen on each loop,
#: because kitty is so fast that partial screen updates will be drawn.
# sync_to_monitor yes
#: Sync screen updates to the refresh rate of the monitor. This
#: prevents screen tearing
#: <https://en.wikipedia.org/wiki/Screen_tearing> when scrolling.
#: However, it limits the rendering speed to the refresh rate of your
#: monitor. With a very high speed mouse/high keyboard repeat rate,
#: you may notice some slight input latency. If so, set this to no.
#: }}}
#: Terminal bell {{{
# enable_audio_bell yes
#: The audio bell. Useful to disable it in environments that require
#: silence.
# visual_bell_duration 0.0
#: The visual bell duration (in seconds). Flash the screen when a bell
#: occurs for the specified number of seconds. Set to zero to disable.
# visual_bell_color none
#: The color used by visual bell. Set to none will fall back to
#: selection background color. If you feel that the visual bell is too
#: bright, you can set it to a darker color.
# window_alert_on_bell yes
#: Request window attention on bell. Makes the dock icon bounce on
#: macOS or the taskbar flash on linux.
# bell_on_tab "🔔 "
#: Some text or a Unicode symbol to show on the tab if a window in the
#: tab that does not have focus has a bell. If you want to use leading
#: or trailing spaces, surround the text with quotes. See
#: tab_title_template for how this is rendered.
#: For backwards compatibility, values of yes, y and true are
#: converted to the default bell symbol and no, n, false and none are
#: converted to the empty string.
# command_on_bell none
#: Program to run when a bell occurs. The environment variable
#: KITTY_CHILD_CMDLINE can be used to get the program running in the
#: window in which the bell occurred.
# bell_path none
#: Path to a sound file to play as the bell sound. If set to none, the
#: system default bell sound is used. Must be in a format supported by
#: the operating systems sound API, such as WAV or OGA on Linux
#: (libcanberra) or AIFF, MP3 or WAV on macOS (NSSound)
#: }}}
#: Window layout {{{
remember_window_size yes
# initial_window_width 640
# initial_window_height 400
#: If enabled, the window size will be remembered so that new
#: instances of kitty will have the same size as the previous
#: instance. If disabled, the window will initially have size
#: configured by initial_window_width/height, in pixels. You can use a
#: suffix of "c" on the width/height values to have them interpreted
#: as number of cells instead of pixels.
# enabled_layouts *
#: The enabled window layouts. A comma separated list of layout names.
#: The special value all means all layouts. The first listed layout
#: will be used as the startup layout. Default configuration is all
#: layouts in alphabetical order. For a list of available layouts, see
#: the layouts <https://sw.kovidgoyal.net/kitty/overview/#layouts>.
# window_resize_step_cells 2
# window_resize_step_lines 2
#: The step size (in units of cell width/cell height) to use when
#: resizing kitty windows in a layout with the shortcut
#: start_resizing_window. The cells value is used for horizontal
#: resizing, and the lines value is used for vertical resizing.
window_border_width 0.5pt
#: The width of window borders. Can be either in pixels (px) or pts
#: (pt). Values in pts will be rounded to the nearest number of pixels
#: based on screen resolution. If not specified, the unit is assumed
#: to be pts. Note that borders are displayed only when more than one
#: window is visible. They are meant to separate multiple windows.
# draw_minimal_borders yes
#: Draw only the minimum borders needed. This means that only the
#: borders that separate the inactive window from a neighbor are
#: drawn. Note that setting a non-zero window_margin_width overrides
#: this and causes all borders to be drawn.
# window_margin_width 0
#: The window margin (in pts) (blank area outside the border). A
#: single value sets all four sides. Two values set the vertical and
#: horizontal sides. Three values set top, horizontal and bottom. Four
#: values set top, right, bottom and left.
# single_window_margin_width -1
#: The window margin to use when only a single window is visible (in
#: pts). Negative values will cause the value of window_margin_width
#: to be used instead. A single value sets all four sides. Two values
#: set the vertical and horizontal sides. Three values set top,
#: horizontal and bottom. Four values set top, right, bottom and left.
window_padding_width 2
#: The window padding (in pts) (blank area between the text and the
#: window border). A single value sets all four sides. Two values set
#: the vertical and horizontal sides. Three values set top, horizontal
#: and bottom. Four values set top, right, bottom and left.
# placement_strategy center
#: When the window size is not an exact multiple of the cell size, the
#: cell area of the terminal window will have some extra padding on
#: the sides. You can control how that padding is distributed with
#: this option. Using a value of center means the cell area will be
#: placed centrally. A value of top-left means the padding will be
#: only at the bottom and right edges.
active_border_color #00ff00
#: The color for the border of the active window. Set this to none to
#: not draw borders around the active window.
# inactive_border_color #cccccc
#: The color for the border of inactive windows.
# bell_border_color #ff5a00
#: The color for the border of inactive windows in which a bell has
#: occurred.
# inactive_text_alpha 1.0
#: Fade the text in inactive windows by the specified amount (a number
#: between zero and one, with zero being fully faded).
hide_window_decorations titlebar-only
#: Hide the window decorations (title-bar and window borders) with
#: yes. On macOS, titlebar-only can be used to only hide the titlebar.
#: Whether this works and exactly what effect it has depends on the
#: window manager/operating system. Note that the effects of changing
#: this option when reloading config are undefined.
# window_logo_path none
#: Path to a logo image. Must be in PNG format. Relative paths are
#: interpreted relative to the kitty config directory. The logo is
#: displayed in a corner of every kitty window. The position is
#: controlled by window_logo_position. Individual windows can be
#: configured to have different logos either using the launch action
#: or the remote control <https://sw.kovidgoyal.net/kitty/remote-
#: control/> facility.
# window_logo_position bottom-right
#: Where to position the window logo in the window. The value can be
#: one of: top-left, top, top-right, left, center, right, bottom-left,
#: bottom, bottom-right.
# window_logo_alpha 0.5
#: The amount the logo should be faded into the background. With zero
#: being fully faded and one being fully opaque.
# resize_debounce_time 0.1
#: The time to wait before redrawing the screen when a resize event is
#: received (in seconds). On platforms such as macOS, where the
#: operating system sends events corresponding to the start and end of
#: a resize, this number is ignored.
# resize_draw_strategy static
#: Choose how kitty draws a window while a resize is in progress. A
#: value of static means draw the current window contents, mostly
#: unchanged. A value of scale means draw the current window contents
#: scaled. A value of blank means draw a blank window. A value of size
#: means show the window size in cells.
# resize_in_steps no
#: Resize the OS window in steps as large as the cells, instead of
#: with the usual pixel accuracy. Combined with initial_window_width
#: and initial_window_height in number of cells, this option can be
#: used to keep the margins as small as possible when resizing the OS
#: window. Note that this does not currently work on Wayland.
# visual_window_select_characters 1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZ
#: The list of characters for visual window selection. For example,
#: for selecting a window to focus on with focus_visible_window. The
#: value should be a series of unique numbers or alphabets, case
#: insensitive, from the set [0-9A-Z]. Specify your preference as a
#: string of characters.
# confirm_os_window_close -1
#: Ask for confirmation when closing an OS window or a tab with at
#: least this number of kitty windows in it by window manager (e.g.
#: clicking the window close button or pressing the operating system
#: shortcut to close windows) or by the close_tab action. A value of
#: zero disables confirmation. This confirmation also applies to
#: requests to quit the entire application (all OS windows, via the
#: quit action). Negative values are converted to positive ones,
#: however, with shell_integration enabled, using negative values
#: means windows sitting at a shell prompt are not counted, only
#: windows where some command is currently running. Note that if you
#: want confirmation when closing individual windows, you can map the
#: close_window_with_confirmation action.
#: }}}
#: Tab bar {{{
tab_bar_edge top
# tab_bar_margin_width 0.0
#: The margin to the left and right of the tab bar (in pts).
# tab_bar_margin_height 0.0 0.0
#: The margin above and below the tab bar (in pts). The first number
#: is the margin between the edge of the OS Window and the tab bar.
#: The second number is the margin between the tab bar and the
#: contents of the current tab.
tab_bar_style powerline
#: The tab bar style, can be one of:
#: fade
#: Each tab's edges fade into the background color. (See also tab_fade)
#: slant
#: Tabs look like the tabs in a physical file.
#: separator
#: Tabs are separated by a configurable separator. (See also
#: tab_separator)
#: powerline
#: Tabs are shown as a continuous line with "fancy" separators.
#: (See also tab_powerline_style)
#: custom
#: A user-supplied Python function called draw_tab is loaded from the file
#: tab_bar.py in the kitty config directory. For examples of how to
#: write such a function, see the functions named draw_tab_with_* in
#: kitty's source code: kitty/tab_bar.py. See also
#: this discussion https://github.com/kovidgoyal/kitty/discussions/4447
#: for examples from kitty users.
#: hidden
#: The tab bar is hidden. If you use this, you might want to create a mapping
#: for the select_tab action which presents you with a list of tabs and
#: allows for easy switching to a tab.
# tab_bar_align left
#: The horizontal alignment of the tab bar, can be one of: left,
#: center, right.
tab_bar_min_tabs 2
#: The minimum number of tabs that must exist before the tab bar is
#: shown.
# tab_switch_strategy previous
#: The algorithm to use when switching to a tab when the current tab
#: is closed. The default of previous will switch to the last used
#: tab. A value of left will switch to the tab to the left of the
#: closed tab. A value of right will switch to the tab to the right of
#: the closed tab. A value of last will switch to the right-most tab.
# tab_fade 0.25 0.5 0.75 1
#: Control how each tab fades into the background when using fade for
#: the tab_bar_style. Each number is an alpha (between zero and one)
#: that controls how much the corresponding cell fades into the
#: background, with zero being no fade and one being full fade. You
#: can change the number of cells used by adding/removing entries to
#: this list.
# tab_separator " ┇"
#: The separator between tabs in the tab bar when using separator as
#: the tab_bar_style.
tab_powerline_style slanted
#: The powerline separator style between tabs in the tab bar when
#: using powerline as the tab_bar_style, can be one of: angled,
#: slanted, round.
# tab_activity_symbol none
#: Some text or a Unicode symbol to show on the tab if a window in the
#: tab that does not have focus has some activity. If you want to use
#: leading or trailing spaces, surround the text with quotes. See
#: tab_title_template for how this is rendered.
tab_title_template "{fmt.fg.red}{bell_symbol}{activity_symbol}{fmt.fg.tab}{title}"
#: A template to render the tab title. The default just renders the
#: title with optional symbols for bell and activity. If you wish to
#: include the tab-index as well, use something like: {index}:{title}.
#: Useful if you have shortcuts mapped for goto_tab N. If you prefer
#: to see the index as a superscript, use {sup.index}. In addition you
#: can use {layout_name} for the current layout name, {num_windows}
#: for the number of windows in the tab and {num_window_groups} for
#: the number of window groups (not counting overlay windows) in the
#: tab. Note that formatting is done by Python's string formatting
#: machinery, so you can use, for instance, {layout_name[:2].upper()}
#: to show only the first two letters of the layout name, upper-cased.
#: If you want to style the text, you can use styling directives, for
#: example:
#: `{fmt.fg.red}red{fmt.fg.tab}normal{fmt.bg._00FF00}greenbg{fmt.bg.tab}`.
#: Similarly, for bold and italic:
#: `{fmt.bold}bold{fmt.nobold}normal{fmt.italic}italic{fmt.noitalic}`.
#: Note that for backward compatibility, if {bell_symbol} or
#: {activity_symbol} are not present in the template, they are
#: prepended to it.
active_tab_title_template "{fmt.fg._fff}{title}"
#: Template to use for active tabs. If not specified falls back to
#: tab_title_template.
active_tab_foreground #fff
active_tab_background #8631B4
active_tab_font_style bold-italic
# inactive_tab_foreground #444
# inactive_tab_background #999
# inactive_tab_font_style normal
#: Tab bar colors and styles.
tab_bar_background none
#: Background color for the tab bar. Defaults to using the terminal
#: background color.
# tab_bar_margin_color none
#: Color for the tab bar margin area. Defaults to using the terminal
#: background color.
#: }}}
#: Color scheme {{{
# foreground #dddddd
background #000000
#: The foreground and background colors.
background_opacity 0.88
#: The opacity of the background. A number between zero and one, where
#: one is opaque and zero is fully transparent. This will only work if
#: supported by the OS (for instance, when using a compositor under
#: X11). Note that it only sets the background color's opacity in
#: cells that have the same background color as the default terminal
#: background, so that things like the status bar in vim, powerline
#: prompts, etc. still look good. But it means that if you use a color
#: theme with a background color in your editor, it will not be
#: rendered as transparent. Instead you should change the default
#: background color in your kitty config and not use a background
#: color in the editor color scheme. Or use the escape codes to set
#: the terminals default colors in a shell script to launch your
#: editor. Be aware that using a value less than 1.0 is a (possibly
#: significant) performance hit. If you want to dynamically change
#: transparency of windows, set dynamic_background_opacity to yes
#: (this is off by default as it has a performance cost). Changing
#: this option when reloading the config will only work if
#: dynamic_background_opacity was enabled in the original config.
# background_image none
#: Path to a background image. Must be in PNG format.
# background_image_layout tiled
#: Whether to tile, scale or clamp the background image. The value can
#: be one of tiled, mirror-tiled, scaled, clamped.
# background_image_linear no
#: When background image is scaled, whether linear interpolation
#: should be used.
dynamic_background_opacity yes
#: Allow changing of the background_opacity dynamically, using either
#: keyboard shortcuts (increase_background_opacity and
#: decrease_background_opacity) or the remote control facility.
#: Changing this option by reloading the config is not supported.
# background_tint 0.0
#: How much to tint the background image by the background color. The
#: tint is applied only under the text area, not margin/borders. This
#: option makes it easier to read the text. Tinting is done using the
#: current background color for each window. This option applies only
#: if background_opacity is set and transparent windows are supported
#: or background_image is set.
# dim_opacity 0.75
#: How much to dim text that has the DIM/FAINT attribute set. One