version 0.24.1

the array iteration wasn't implemented correctly for KITTY_SHELL_INTEGRATION variable. the i variable in for loop wasn't iterating through all the elements of that array

.github/FUNDING.yml

@@ -1,3 +1,4 @@
+github: kovidgoyal
 patreon: kovidgoyal
 liberapay: kovidgoyal
 custom: https://sw.kovidgoyal.net/kitty/support.html

.github/ISSUE_TEMPLATE/bug_report.md

@@ -22,7 +22,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Environment details**
 ```
-Press Ctrl+Shift+F6 (cmd+option+, on macOS) in kitty, to copy debug output about kitty and its
+Press Ctrl+Shift+F6 (cmd+option+comma on macOS) in kitty, to copy debug output about kitty and its
 configuration to the clipboard and paste it here. 
 
 On older versions of kitty, run kitty --debug-config instead

.github/workflows/ci.py

@@ -34,18 +34,15 @@ def install_deps():
         run('brew', 'install', *items)
     else:
         run('sudo apt-get update')
-        run('sudo apt-get install -y libgl1-mesa-dev libxi-dev libxrandr-dev libxinerama-dev'
+        run('sudo apt-get install -y libgl1-mesa-dev libxi-dev libxrandr-dev libxinerama-dev ca-certificates'
             ' libxcursor-dev libxcb-xkb-dev libdbus-1-dev libxkbcommon-dev libharfbuzz-dev libx11-xcb-dev'
-            ' libpng-dev liblcms2-dev libfontconfig-dev libxkbcommon-x11-dev libcanberra-dev uuid-dev')
+            ' libpng-dev liblcms2-dev libfontconfig-dev libxkbcommon-x11-dev libcanberra-dev librsync-dev uuid-dev')
     if is_bundle:
         install_bundle()
     else:
-        if is_macos:
-            # needed for zlib for pillow, should not be needed after pillow 8.0
-            os.environ['PKG_CONFIG_PATH'] = '/usr/local/opt/zlib/lib/pkgconfig'
-        cmd = 'pip3 install Pillow pygments'
+        cmd = 'python3 -m pip install Pillow pygments'
         if sys.version_info[:2] < (3, 7):
-            cmd += ' importlib-resources'
+            cmd += ' importlib-resources dataclasses'
         run(cmd)
 
 

.github/workflows/ci.yml

@@ -20,15 +20,15 @@ jobs:
                 cc: [gcc, clang]
                 include:
                     - python: a
-                      pyver: 3.6
+                      pyver: 3.7
                       sanitize: 0
 
                     - python: b
-                      pyver: 3.7
+                      pyver: 3.8
                       sanitize: 1
 
                     - python: c
-                      pyver: 3.8
+                      pyver: 3.9
                       sanitize: 1
 
 
@@ -76,7 +76,7 @@ jobs:
                 python-version: 3.8
 
             - name: Install build-only deps
-              run: pip install flake8 mypy types-requests types-docutils sphinx
+              run: pip install -r docs/requirements.txt flake8 mypy types-requests types-docutils
 
             - name: Run pyflakes
               run: python -m flake8 --count .

.github/workflows/codeql-analysis.yml

@@ -22,17 +22,11 @@ jobs:
         # a pull request then we can checkout the head.
         fetch-depth: 2
 
-    # If this run was triggered by a pull request event, then checkout
-    # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
-      if: ${{ github.event_name == 'pull_request' }}
-
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
-      # Override language selection by uncommenting this and choosing your languages
-      # with:
-      #   languages: go, javascript, csharp, python, cpp, java
+      with:
+        languages: python, c
 
     - name: Build kitty
       run: python3 .github/workflows/ci.py build

.gitignore

@@ -19,3 +19,4 @@ __pycache__/
 /.mypy_cache
 .DS_Store
 bypy/b
+bypy/virtual-machines.conf

Brewfile

@@ -1,5 +1,6 @@
 pkg-config
 zlib
+librsync
 python
 imagemagick
 harfbuzz

CHANGELOG.rst

@@ -1 +1 @@
-See https://sw.kovidgoyal.net/kitty/changelog.html
+See https://sw.kovidgoyal.net/kitty/changelog/

CONTRIBUTING.md

@@ -10,9 +10,9 @@ config to reproduce the issue with).
 
 ### Contributing code
 
-Install [the dependencies](https://sw.kovidgoyal.net/kitty/build.html#dependencies)
+Install [the dependencies](https://sw.kovidgoyal.net/kitty/build/#dependencies)
 using your favorite package manager. Build and run kitty [from
-source](https://sw.kovidgoyal.net/kitty/build.html#install-and-run-from-source).
+source](https://sw.kovidgoyal.net/kitty/build/#install-and-run-from-source).
 
 Make a fork, submit your Pull Request. If it's a large/controversial change, open an issue
 beforehand to discuss it, so that you don't waste your time making a pull

INSTALL.md

@@ -1,3 +1,3 @@
-To build from source: <https://sw.kovidgoyal.net/kitty/build.html>
+[To build from source](https://sw.kovidgoyal.net/kitty/build/)
 
-Pre-built binaries: <https://sw.kovidgoyal.net/kitty/binary.html>
+[Pre-built binaries](https://sw.kovidgoyal.net/kitty/binary/)

LICENSE

@@ -671,4 +671,4 @@ into proprietary programs.  If your program is a subroutine library, you
 may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
-<https://www.gnu.org/philosophy/why-not-lgpl.html>.
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

Makefile

@@ -40,4 +40,11 @@ html:
 linkcheck:
 	$(MAKE) FAIL_WARN=$(FAIL_WARN) -C docs linkcheck
 
+website:
+	./publish.py --only website
+
 docs: man html
+
+
+develop-docs:
+	$(MAKE) -C docs develop-docs

README.asciidoc

@@ -4,7 +4,7 @@ See https://sw.kovidgoyal.net/kitty/[the kitty website].
 
 image:https://github.com/kovidgoyal/kitty/workflows/CI/badge.svg["Build status", link="https://github.com/kovidgoyal/kitty/actions?query=workflow%3ACI"]
 
-https://sw.kovidgoyal.net/kitty/faq.html[Frequently Asked Questions]
+https://sw.kovidgoyal.net/kitty/faq/[Frequently Asked Questions]
 
 To ask other questions about kitty usage, use either the https://github.com/kovidgoyal/kitty/discussions/[discussions on GitHub] or the
 https://www.reddit.com/r/KittyTerminal[Reddit community]

__main__.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# vim:fileencoding=utf-8
 # License: GPL v3 Copyright: 2015, Kovid Goyal <kovid at kovidgoyal.net>
 
 import os
@@ -24,20 +23,34 @@ def remote_control(args: List[str]) -> None:
 
 
 def runpy(args: List[str]) -> None:
+    if len(args) < 2:
+        raise SystemExit('Usage: kitty +runpy "some python code"')
     sys.argv = ['kitty'] + args[2:]
     exec(args[1])
 
 
 def hold(args: List[str]) -> None:
     import subprocess
-    import tty
+    import termios
     from contextlib import suppress
+    from kittens.tui.operations import init_state, set_cursor_visible
     ret = subprocess.Popen(args[1:]).wait()
     with suppress(BaseException):
-        print('\n\x1b[1;32mPress any key to exit', end='', flush=True)
+        print(
+            '\n\x1b[1;32mPress Enter to exit',
+            end=init_state(alternate_screen=False, kitty_keyboard_mode=False) + set_cursor_visible(False),
+            flush=True)
     with suppress(BaseException):
-        tty.setraw(sys.stdin.fileno())
-        sys.stdin.buffer.read(1)
+        fd = sys.stdin.fileno()
+        old = termios.tcgetattr(fd)
+        new = old[:]
+        new[3] &= ~termios.ECHO  # 3 == 'lflags'
+        tcsetattr_flags = termios.TCSAFLUSH
+        if hasattr(termios, 'TCSASOFT'):
+            tcsetattr_flags |= getattr(termios, 'TCSASOFT')
+        termios.tcsetattr(fd, tcsetattr_flags, new)
+        with suppress(KeyboardInterrupt):
+            input()
     raise SystemExit(ret)
 
 
@@ -49,13 +62,22 @@ def complete(args: List[str]) -> None:
 def launch(args: List[str]) -> None:
     import runpy
     sys.argv = args[1:]
-    exe = args[1]
+    try:
+        exe = args[1]
+    except IndexError:
+        raise SystemExit(
+            'usage: kitty +launch script.py [arguments to be passed to script.py ...]\n\n'
+            'script.py will be run with full access to kitty code. If script.py is '
+            'prefixed with a : it will be searched for in PATH'
+        )
     if exe.startswith(':'):
         import shutil
         q = shutil.which(exe[1:])
         if not q:
-            raise SystemExit('{} not found in PATH'.format(args[1][1:]))
+            raise SystemExit(f'{exe[1:]} not found in PATH')
         exe = q
+    if not os.path.exists(exe):
+        raise SystemExit(f'{exe} does not exist')
     runpy.run_path(exe, run_name='__main__')
 
 
@@ -80,8 +102,14 @@ def edit_config_file(args: List[str]) -> None:
 
 
 def namespaced(args: List[str]) -> None:
-    func = namespaced_entry_points[args[1]]
-    func(args[1:])
+    try:
+        func = namespaced_entry_points[args[1]]
+    except KeyError:
+        pass
+    else:
+        func(args[1:])
+        return
+    raise SystemExit(f'{args[1]} is not a known entry point. Choices are: ' + ', '.join(namespaced_entry_points))
 
 
 entry_points = {
@@ -102,21 +130,21 @@ namespaced_entry_points['complete'] = complete
 
 
 def setup_openssl_environment() -> None:
-    # Workaround for Linux distros that have still failed to get their heads
-    # out of their asses and implement a common location for SSL certificates.
-    # It's not that hard people, there exists a wonderful tool called the symlink
-    # See https://www.mobileread.com/forums/showthread.php?t=256095
-    if 'SSL_CERT_FILE' not in os.environ and 'SSL_CERT_DIR' not in os.environ:
-        if os.access('/etc/pki/tls/certs/ca-bundle.crt', os.R_OK):
-            os.environ['SSL_CERT_FILE'] = '/etc/pki/tls/certs/ca-bundle.crt'
-            setattr(sys, 'kitty_ssl_env_var', 'SSL_CERT_FILE')
-        elif os.path.isdir('/etc/ssl/certs'):
-            os.environ['SSL_CERT_DIR'] = '/etc/ssl/certs'
-            setattr(sys, 'kitty_ssl_env_var', 'SSL_CERT_DIR')
+    # Use our bundled CA certificates instead of the system ones, since
+    # many systems come with no certificates in a useable form or have various
+    # locations for the certificates.
+    d = os.path.dirname
+    ext_dir: str = getattr(sys, 'kitty_extensions_dir')
+    if 'darwin' in sys.platform.lower():
+        cert_file = os.path.join(d(d(d(ext_dir))), 'cacert.pem')
+    else:
+        cert_file = os.path.join(d(ext_dir), 'cacert.pem')
+    os.environ['SSL_CERT_FILE'] = cert_file
+    setattr(sys, 'kitty_ssl_env_var', 'SSL_CERT_FILE')
 
 
 def main() -> None:
-    if getattr(sys, 'frozen', False) and 'darwin' not in sys.platform.lower():
+    if getattr(sys, 'frozen', False) and getattr(sys, 'kitty_extensions_dir', ''):
         setup_openssl_environment()
     first_arg = '' if len(sys.argv) < 2 else sys.argv[1]
     func = entry_points.get(first_arg)

bypy/init_env.py

@@ -30,6 +30,7 @@ def initialize_constants():
     kitty_constants['appname'] = re.search(
             r'appname: str\s+=\s+(u{0,1})[\'"]([^\'"]+)[\'"]', src
     ).group(2)
+    kitty_constants['cacerts_url'] = 'https://curl.haxx.se/ca/cacert.pem'
     return kitty_constants
 
 

bypy/linux.conf

@@ -1,3 +1,3 @@
-image 'https://partner-images.canonical.com/core/xenial/current/ubuntu-xenial-core-cloudimg-{}-root.tar.gz'
+image 'https://cloud-images.ubuntu.com/releases/bionic/release/ubuntu-18.04-server-cloudimg-{}.img'
 
 deps 'bison flex libxcursor-dev libxrandr-dev libxi-dev libxinerama-dev libgl1-mesa-dev libxcb-xkb-dev libfontconfig1-dev libdbus-1-dev'

bypy/linux/__main__.py

@@ -19,7 +19,11 @@ from bypy.freeze import (
 from bypy.utils import get_dll_path, mkdtemp, py_compile, walk
 
 j = os.path.join
-arch = 'x86_64' if is64bit else 'i686'
+machine = (os.uname()[4] or '').lower()
+if machine.startswith('arm64') or machine.startswith('aarch64'):
+    arch = 'arm64'
+else:
+    arch = 'x86_64' if is64bit else 'i686'
 self_dir = os.path.dirname(os.path.abspath(__file__))
 py_ver = '.'.join(map(str, python_major_minor_version()))
 iv = globals()['init_env']
@@ -29,7 +33,7 @@ kitty_constants = iv['kitty_constants']
 def binary_includes():
     return tuple(map(get_dll_path, (
             'expat', 'sqlite3', 'ffi', 'z', 'lzma', 'png16', 'lcms2', 'crypt',
-            'iconv', 'pcre', 'graphite2', 'glib-2.0', 'freetype',
+            'iconv', 'pcre', 'graphite2', 'glib-2.0', 'freetype', 'rsync',
             'harfbuzz', 'xkbcommon', 'xkbcommon-x11',
             'ncursesw', 'readline', 'brotlicommon', 'brotlienc', 'brotlidec'
         ))) + (
@@ -88,6 +92,17 @@ def copy_libs(env):
     for x in binary_includes():
         dest = env.bin_dir if '/bin/' in x else env.lib_dir
         shutil.copy2(x, dest)
+        dest = os.path.join(dest, os.path.basename(x))
+        subprocess.check_call(['chrpath', '-d', dest])
+
+
+def add_ca_certs(env):
+    print('Downloading CA certs...')
+    from urllib.request import urlopen
+    cdata = urlopen(kitty_constants['cacerts_url']).read()
+    dest = os.path.join(env.lib_dir, 'cacert.pem')
+    with open(dest, 'wb') as f:
+        f.write(cdata)
 
 
 def copy_python(env):
@@ -104,8 +119,7 @@ def copy_python(env):
             shutil.copy2(y, env.py_dir)
 
     srcdir = j(srcdir, 'site-packages')
-    site_packages_dir = j(env.py_dir, 'site-packages')
-    import_site_packages(srcdir, site_packages_dir)
+    import_site_packages(srcdir, env.py_dir)
 
     pdir = os.path.join(env.lib_dir, 'kitty-extensions')
     os.makedirs(pdir, exist_ok=True)
@@ -218,6 +232,7 @@ def main():
     build_launcher(env)
     files = find_binaries(env)
     fix_permissions(files)
+    add_ca_certs(env)
     if not args.dont_strip:
         strip_binaries(files)
     if not args.skip_tests:

bypy/macos/__main__.py

@@ -170,6 +170,7 @@ class Freeze(object):
         self.add_stdlib()
         self.add_misc_libraries()
         self.freeze_python()
+        self.add_ca_certs()
         if not self.dont_strip:
             self.strip_files()
         if not self.skip_tests:
@@ -180,6 +181,15 @@ class Freeze(object):
 
         return ret
 
+    @flush
+    def add_ca_certs(self):
+        print('\nDownloading CA certs...')
+        from urllib.request import urlopen
+        cdata = urlopen(kitty_constants['cacerts_url']).read()
+        dest = os.path.join(self.contents_dir, 'Resources', 'cacert.pem')
+        with open(dest, 'wb') as f:
+            f.write(cdata)
+
     @flush
     def strip_files(self):
         print('\nStripping files...')
@@ -212,7 +222,7 @@ class Freeze(object):
     @flush
     def get_local_dependencies(self, path_to_lib):
         for x, is_id in self.get_dependencies(path_to_lib):
-            for y in (PREFIX + '/lib/', PREFIX + '/python/Python.framework/'):
+            for y in (PREFIX + '/lib/', PREFIX + '/python/Python.framework/', '@rpath/'):
                 if x.startswith(y):
                     if y == PREFIX + '/python/Python.framework/':
                         y = PREFIX + '/python/'
@@ -278,6 +288,7 @@ class Freeze(object):
                 'lcms2.2',
                 'crypto.1.1',
                 'ssl.1.1',
+                'rsync.2',
         ):
             print('\nAdding', x)
             x = 'lib%s.dylib' % x

bypy/sources.json

@@ -28,6 +28,15 @@
         }
     },
 
+    {
+        "name": "openssl",
+        "unix": {
+            "filename": "openssl-1.1.1i.tar.gz",
+            "hash": "sha256:e8be6a35fe41d10603c3cc635e93289ed00bf34b79671a3a4de64fcee00d5242",
+            "urls": ["https://www.openssl.org/source/{filename}"]
+        }
+    },
+
     {
         "name": "cmake",
         "os": "macos",
@@ -48,25 +57,22 @@
         }
     },
 
-
     {
         "name": "libxml2",
-        "os": "linux",
         "unix": {
-            "filename": "libxml2-2.9.10.tar.gz",
-            "hash": "sha256:aafee193ffb8fe0c82d4afef6ef91972cbaf5feea100edc2f262750611b4be1f",
+            "filename": "libxml2-2.9.12.tar.gz",
+            "hash": "sha256:c8d6681e38c56f172892c85ddc0852e1fd4b53b4209e7f4ebf17f7e2eae71d92",
             "urls": ["ftp://xmlsoft.org/libxml2/{filename}"]
         }
     },
 
-
     {
         "name": "xkbcommon",
         "os": "linux",
         "unix": {
             "filename": "libxkbcommon-1.0.3.tar.xz",
             "hash": "sha256:a2202f851e072b84e64a395212cbd976ee18a8ee602008b0bad02a13247dbc52",
-            "urls": ["http://xkbcommon.org/download/{filename}"]
+            "urls": ["https://xkbcommon.org/download/{filename}"]
         }
     },
 
@@ -90,15 +96,6 @@
         }
     },
 
-    {
-        "name": "openssl",
-        "unix": {
-            "filename": "openssl-1.1.1i.tar.gz",
-            "hash": "sha256:e8be6a35fe41d10603c3cc635e93289ed00bf34b79671a3a4de64fcee00d5242",
-            "urls": ["https://www.openssl.org/source/{filename}"]
-        }
-    },
-
     {
         "name": "ncurses",
         "os": "linux",
@@ -115,7 +112,7 @@
         "unix": {
             "filename": "readline-8.1.tar.gz",
             "hash": "sha256:f8ceb4ee131e3232226a17f51b164afc46cd0b9e6cef344be87c65962cb82b02",
-            "urls": ["http://ftp.gnu.org/gnu/readline/{filename}"]
+            "urls": ["https://ftp.gnu.org/gnu/readline/{filename}"]
         }
     },
 
@@ -128,6 +125,16 @@
         }
     },
 
+    {
+        "name": "librsync",
+        "unix": {
+            "filename": "librsync-2.3.2.tar.gz",
+            "hash": "sha256:ef8ce23df38d5076d25510baa2cabedffbe0af460d887d86c2413a1c2b0c676f",
+            "urls": ["https://github.com/librsync/librsync/releases/download/v2.3.2/{filename}"]
+        }
+    },
+
+
     {
         "name": "xcrypt",
         "os": "linux",
@@ -170,7 +177,7 @@
         "unix": {
             "filename": "libpng-1.6.37.tar.xz",
             "hash": "sha256:505e70834d35383537b6491e7ae8641f1a4bed1876dbfe361201fc80868d88ca",
-            "urls": ["http://downloads.sourceforge.net/sourceforge/libpng/{filename}"]
+            "urls": ["https://downloads.sourceforge.net/sourceforge/libpng/{filename}"]
         }
     },
 
@@ -189,7 +196,7 @@
         "unix": {
             "filename": "graphite2-1.3.14.tgz",
             "hash": "sha256:f99d1c13aa5fa296898a181dff9b82fb25f6cc0933dbaa7a475d8109bd54209d",
-            "urls": ["http://downloads.sourceforge.net/silgraphite/{filename}"]
+            "urls": ["https://downloads.sourceforge.net/silgraphite/{filename}"]
         }
     },
 
@@ -249,7 +256,7 @@
         "unix": {
             "filename": "fontconfig-2.13.1.tar.bz2",
             "hash": "sha256:f655dd2a986d7aa97e052261b36aa67b0a64989496361eca8d604e6414006741",
-            "urls": ["http://www.fontconfig.org/release/{filename}"]
+            "urls": ["https://www.fontconfig.org/release/{filename}"]
         }
     },
 

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -j auto -T $(FAIL_WARN)
+SPHINXOPTS    = -n -q -j auto -T $(FAIL_WARN) $(OPTS)
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = kitty
 SOURCEDIR     = .
@@ -18,3 +18,7 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+develop-docs:
+	sphinx-autobuild --ignore "$(abspath $(SOURCEDIR))/generated/*" --watch ../kitty --watch ../kittens -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)

docs/_static/custom.css

@@ -5,122 +5,32 @@
  * Distributed under terms of the MIT license.
  */
 
-.float-left-img {
-    float: left;
-    margin-right: 1em;
-    margin-bottom: 1em;
-}
-
-.float-right-img { float: right; margin-left: 1em; margin-bottom: 1em }
-
-.half-with-img { max-width: 50% }
-
-.fit-img { max-width: 95% }
-
-div.body p, div.body dd, div.body li, div.body blockquote {
-    text-align: justify;
-}
-
-div.body {
-    min-width: 200px;
-}
-
-pre {
-    white-space: pre-wrap;
-}
-
-pre.pre {
-    white-space: pre;
-}
-
-a[href], input[type="submit"] { cursor: pointer; }
-
-img[style] {
-    /* Used for :scale: images to have them render properly but still popup when clicked */
-    width: auto !important;
-    height: auto !important;
-}
-
-a {
-    text-decoration: none !important;
-    border-bottom: none !important;
-}
-
-body div.document {
-    margin-top: 1ex;
-}
-
-.major-features li {
-    margin-top: 0.75ex;
-    margin-bottom: 0.75ex;
-}
-
-.support-form input[type=submit] {
-    border-radius: 6px;
-    box-shadow: rgb(255, 246, 175) 0px 1px 0px 0px;
-    background: linear-gradient(rgb(255, 236, 100) 5%, rgb(255, 171, 35) 100%) rgb(255, 236, 100);
-    border: 1px solid rgb(255, 170, 34);
-    display: inline-block;
-    color: rgb(51, 51, 51);
-    font-family: Arial;
-    font-size: 15px;
-    font-weight: bold;
-    padding: 6px 24px;
-    text-decoration: none;
-    text-shadow: rgb(255, 238, 102) 0px 1px 0px;
-}
-
-.support-form input[type=submit]:hover {
-    background: linear-gradient(rgb(255, 171, 35) 5%, rgb(255, 236, 100) 100%) rgb(255, 171, 35);
-}
-
-.support-form input[type=submit]:focus {
-    outline: 0;
-}
-
-
-div.sphinxsidebar {
-    font-size: inherit;
-    line-height: inherit;
-    max-height: 100%;
-    overflow-y: auto;
-}
-
-#sidebartoc li {
-    margin-top: 0.75ex;
-    margin-bottom: 0.75ex;
-}
-
-#sidebartoc ul {
-    list-style: none !important;
-}
-
-#sidebartoc a[href]:hover {
-    color: red;
-}
-
-
-.green {
-    color: green;
-}
-
-.cyan {
-    color: blue;
-}
-
-.env {
-    font-style: italic;
-}
-
 .italic {
     font-style: italic;
 }
 
-.bold {
-    font-weight: bold;
+.sidebar-logo {
+    max-height: 128px;
 }
 
-.title {
-    font-size: larger;
-    font-weight: bold
+.major-features li {
+    margin-bottom: 0.75ex;
+    margin-top: 0.75ex;
+}
+
+.sidebar-tree a.current {
+    font-style: italic;
+}
+
+details > summary {
+    color: var(--color-link);
+    cursor: pointer;
+    text-decoration-color: var(--color-link-underline);
+    text-decoration-line: underline;
+}
+
+/* pygments adds an underline to some white-space, this is particularly visible in
+ * dark mode. Remove it. */
+.highlight .w {
+    text-decoration: none
 }

docs/_static/custom.js

@@ -0,0 +1,57 @@
+/* vim:fileencoding=utf-8
+ *
+ * Copyright (C) 2021 Kovid Goyal <kovid at kovidgoyal.net>
+ *
+ * Distributed under terms of the GPLv3 license
+ */
+
+(function() {
+"use strict";
+
+function get_sidebar_tree() {
+    return document.querySelector('.sidebar-tree');
+}
+
+function scroll_sidebar_node_into_view(a) {
+    var ss = get_sidebar_tree().closest('.sidebar-scroll');
+    if (!ss || !a) return;
+    ss.style.position = 'relative';
+    var pos = 0;
+    while (true) {
+        pos += a.offsetTop;
+        a = a.offsetParent;
+        if (!a || a == ss) break;
+    }
+    ss.scrollTo({top: pos, behavior: 'instant'});
+}
+
+function mark_current_link(sidebar_tree, a, onload) {
+    var li = a.closest('li.has-children');
+    while (li) {
+        li.querySelector('input[type=checkbox]').setAttribute('checked', 'checked');
+        li = li.parentNode.closest('li.has-children');
+    }
+    sidebar_tree.querySelectorAll('.current').forEach(function (elem) {
+        elem.classList.remove('current');
+    });
+    if (onload) scroll_sidebar_node_into_view(a);
+    a.classList.add('current');
+}
+
+function show_hash_in_sidebar(onload) {
+    var sidebar_tree = document.querySelector('.sidebar-tree');
+    if (document.location.hash.length > 1) {
+        var a = sidebar_tree.querySelector('a[href="' + document.location.hash + '"]');
+        if (a) mark_current_link(sidebar_tree, a, onload);
+    } else {
+        if (onload) scroll_sidebar_node_into_view(sidebar_tree.querySelector('.current-page a'));
+    }
+}
+
+document.addEventListener("DOMContentLoaded", function() {
+    show_hash_in_sidebar(true);
+    window.addEventListener('hashchange', show_hash_in_sidebar.bind(null, false));
+});
+
+}());
+

docs/_templates/base.html

@@ -0,0 +1,22 @@
+{% extends "!base.html" %}
+{% block extrahead %}
+
+  {{ super() }}
+
+  {%- if analytics_id %}
+      <script type="text/javascript">
+      var _gaq = _gaq || [];
+      _gaq.push(['_setAccount', '{{ analytics_id }}']);
+      _gaq.push(['_setDomainName', 'none']);
+      _gaq.push(['_setAllowLinker', true]);
+      _gaq.push(['_trackPageview']);
+
+      (function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+      })();
+    </script>
+  {% endif -%}
+
+{% endblock %}

docs/_templates/layout.html

@@ -1,6 +0,0 @@
-{% extends "!layout.html" %}
-
-{%- block extrahead %}
-<!-- kitty analytics placeholder -->
-  {{ super() }}
-{% endblock %}

docs/_templates/localtoc.html

@@ -1,6 +0,0 @@
-{%- if display_toc %}
-<div>&nbsp;</div>
-<div id="sidebartoc">
-  {{ toc }}
-</div>
-{%- endif %}

docs/_templates/searchbox.html

@@ -1,22 +0,0 @@
-{#
-    basic/searchbox.html
-    ~~~~~~~~~~~~~~~~~~~~
-
-    Sphinx sidebar template: quick search box.
-
-    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-#}
-{%- if pagename != "search" and builder != "singlehtml" %}
-<div id="searchbox" style="display: none" role="search">
-    <div class="searchformwrapper">
-    <form class="search" action="{{ pathto('search') }}" method="get">
-      <input type="text" name="q" placeholder="{{ _('Search') }}" />
-      <input type="submit" value="{{ _('Go') }}" style="cursor: pointer" />
-      <input type="hidden" name="check_keywords" value="yes" />
-      <input type="hidden" name="area" value="default" />
-    </form>
-    </div>
-</div>
-<script type="text/javascript">$('#searchbox').show(0);</script>
-{%- endif %}

docs/_templates/support.html

@@ -1,7 +0,0 @@
-{% if pagename != "support" %}
-<div id="support" style="text-align: center">
-    <form class="support-form" action="{{ pathto('support') }}" title="{{ _('Donate to support kitty development') }}">
-        <input type="submit" value="{{ _('Support kitty') }}">
-    </form>
-</div>
-{% endif %}

docs/actions.rst

@@ -0,0 +1,10 @@
+Mappable actions
+-----------------------
+
+.. highlight:: conf
+
+The actions described below can be mapped to any key press or mouse action
+using the ``map`` and ``mouse_map`` directives in :file:`kitty.conf`. For
+configuration examples, see the default shortcut links for each action.
+
+.. include:: /generated/actions.rst

docs/basic.rst

@@ -11,16 +11,20 @@ windows are:
 Scrolling
 ~~~~~~~~~~~~~~
 
-========================    =======================
+=========================   =======================
 Action                      Shortcut
-========================    =======================
-Scroll line up              :sc:`scroll_line_up` (also :kbd:`⌥+⌘+⇞` and :kbd:`⌘+↑` on macOS)
-Scroll line down            :sc:`scroll_line_down` (also :kbd:`⌥+⌘+⇟` and :kbd:`⌘+↓` on macOS)
-Scroll page up              :sc:`scroll_page_up` (also :kbd:`⌘+⇞` on macOS)
-Scroll page down            :sc:`scroll_page_down` (also :kbd:`⌘+⇟` on macOS)
-Scroll to top               :sc:`scroll_home` (also :kbd:`⌘+↖` on macOS)
-Scroll to bottom            :sc:`scroll_end` (also :kbd:`⌘+↘` on macOS)
-========================    =======================
+=========================   =======================
+Line up                     :sc:`scroll_line_up` (also :kbd:`⌥+⌘+⇞` and :kbd:`⌘+↑` on macOS)
+Line down                   :sc:`scroll_line_down` (also :kbd:`⌥+⌘+⇟` and :kbd:`⌘+↓` on macOS)
+Page up                     :sc:`scroll_page_up` (also :kbd:`⌘+⇞` on macOS)
+Page down                   :sc:`scroll_page_down` (also :kbd:`⌘+⇟` on macOS)
+Top                         :sc:`scroll_home` (also :kbd:`⌘+↖` on macOS)
+Bottom                      :sc:`scroll_end` (also :kbd:`⌘+↘` on macOS)
+Previous shell prompt       :sc:`scroll_to_previous_prompt` (see :ref:`shell_integration`)
+Next shell prompt           :sc:`scroll_to_next_prompt` (see :ref:`shell_integration`)
+Browse scrollback in less   :sc:`show_scrollback`
+Browse last cmd output      :sc:`show_last_command_output` (see :ref:`shell_integration`)
+=========================   =======================
 
 Tabs
 ~~~~~~~~~~~
@@ -30,8 +34,8 @@ Action                      Shortcut
 ========================    =======================
 New tab                     :sc:`new_tab` (also :kbd:`⌘+t` on macOS)
 Close tab                   :sc:`close_tab` (also :kbd:`⌘+w` on macOS)
-Next tab                    :sc:`next_tab` (also :kbd:`^+⇥` and :kbd:`⇧+⌘+]` on macOS)
-Previous tab                :sc:`previous_tab` (also :kbd:`⇧+^+⇥` and :kbd:`⇧+⌘+[` on macOS)
+Next tab                    :sc:`next_tab` (also :kbd:`⌃+⇥` and :kbd:`⇧+⌘+]` on macOS)
+Previous tab                :sc:`previous_tab` (also :kbd:`⇧+⌃+⇥` and :kbd:`⇧+⌘+[` on macOS)
 Next layout                 :sc:`next_layout`
 Move tab forward            :sc:`move_tab_forward`
 Move tab backward           :sc:`move_tab_backward`
@@ -53,6 +57,8 @@ Previous window             :sc:`previous_window`
 Move window forward         :sc:`move_window_forward`
 Move window backward        :sc:`move_window_backward`
 Move window to top          :sc:`move_window_to_top`
+Visually focus window       :sc:`focus_visible_window`
+Visually swap window        :sc:`swap_with_window`
 Focus specific window       :sc:`first_window`, :sc:`second_window` ... :sc:`tenth_window`
                             (also :kbd:`⌘+1`, :kbd:`⌘+2` ... :kbd:`⌘+9` on macOS)
                             (clockwise from the top-left)
@@ -83,6 +89,10 @@ move it to another tab or another OS window::
     map ctrl+f2 detach_window
     # moves the window into a new Tab
     map ctrl+f3 detach_window new-tab
+    # moves the window into the previously active tab
+    map ctrl+f3 detach_window tab-prev
+    # moves the window into the tab at the left of the active tab
+    map ctrl+f3 detach_window tab-left
     # asks which tab to move the window into
     map ctrl+f4 detach_window ask
 
@@ -102,6 +112,9 @@ the currently active window::
 Other keyboard shortcuts
 ----------------------------------
 
+The full list of actions that can be mapped to key presses is available
+:doc:`here </actions>`.
+
 ==================================  =======================
 Action                              Shortcut
 ==================================  =======================
@@ -111,13 +124,13 @@ Paste from selection                :sc:`paste_from_selection`
 Increase font size                  :sc:`increase_font_size` (also :kbd:`⌘++` on macOS)
 Decrease font size                  :sc:`decrease_font_size` (also :kbd:`⌘+-` on macOS)
 Restore font size                   :sc:`reset_font_size` (also :kbd:`⌘+0` on macOS)
-Toggle fullscreen                   :sc:`toggle_fullscreen` (also :kbd:`^+⌘+f` on macOS)
+Toggle fullscreen                   :sc:`toggle_fullscreen` (also :kbd:`⌃+⌘+f` on macOS)
 Toggle maximized                    :sc:`toggle_maximized`
-Input unicode character             :sc:`input_unicode_character` (also :kbd:`^+⌘+space` on macOS)
+Input unicode character             :sc:`input_unicode_character` (also :kbd:`⌃+⌘+space` on macOS)
 Click URL using the keyboard        :sc:`open_url`
 Reset the terminal                  :sc:`reset_terminal`
-Reload :file:`kitty.conf`           :sc:`reload_config_file` (also :kbd:`^+⌘+f5` on macOS)
-Debug :file:`kitty.conf`            :sc:`debug_config` (also :kbd:`⌘+option+f6` on macOS)
+Reload :file:`kitty.conf`           :sc:`reload_config_file` (also :kbd:`⌃+⌘+,` on macOS)
+Debug :file:`kitty.conf`            :sc:`debug_config` (also :kbd:`⌘+⌥+f6` on macOS)
 Pass current selection to program   :sc:`pass_selection_to_program`
 Edit |kitty| config file            :sc:`edit_config_file`
 Open a |kitty| shell                :sc:`kitty_shell`

docs/binary.rst

@@ -1,6 +1,9 @@
-kitty - Binary install
+Install kitty
 ========================
 
+Binary install
+----------------
+
 .. |ins| replace:: curl -L :literal:`https://sw.kovidgoyal.net/kitty/installer.sh` | sh /dev/stdin
 
 .. highlight:: sh
@@ -19,6 +22,11 @@ The binaries will be installed in the standard location for your OS,
 Linux. The installer only touches files in that directory. To update kitty,
 simply re-run the command.
 
+.. warning::
+   **Do not** copy the kitty binary out of the installation folder. If you want
+   to add it to your ``PATH`` create a symlink in :file:`~/.local/bin` or
+   :file:`/usr/bin` or wherever.
+
 
 Manually installing
 ---------------------
@@ -60,6 +68,25 @@ particular desktop, but it should work for most major desktop environments.
 Customizing the installation
 --------------------------------
 
+.. _nightly:
+
+* You can install the latest nightly kitty build with ``installer``:
+
+  .. parsed-literal::
+     :class: pre
+
+     |ins| \\
+         installer=nightly
+
+  If you want to install it in parallel to the released kitty specify a
+  different install locations with ``dest``:
+
+  .. parsed-literal::
+     :class: pre
+
+     |ins| \\
+         installer=nightly dest=/some/other/location
+
 * You can specify a different install location, with ``dest``:
 
   .. parsed-literal::
@@ -85,6 +112,7 @@ Customizing the installation
      |ins| \\
          installer=/path/to/dmg or tarball
 
+
 Uninstalling
 ----------------
 

docs/build.rst

@@ -1,14 +1,18 @@
-Building kitty from source
-==============================
+Build from source
+==================
 
 .. image:: https://github.com/kovidgoyal/kitty/workflows/CI/badge.svg
   :alt: Build status
   :target: https://github.com/kovidgoyal/kitty/actions?query=workflow%3ACI
 
+.. highlight:: sh
 
 |kitty| is designed to run from source, for easy hack-ability. Make sure
 the following dependencies are installed first.
 
+.. note::
+   If you just want to test the latest changes to kitty you dont need to build
+   from source. Instead install the :ref:`latest nightly build <nightly>`.
 
 .. note::
    If you are making small changes only to the python parts of kitty, there is no need to
@@ -25,24 +29,38 @@ Dependencies
 
 Run-time dependencies:
 
-    * python >= 3.6
-    * harfbuzz >= 2.2.0
-    * zlib
-    * libpng
-    * liblcms2
-    * freetype (not needed on macOS)
-    * fontconfig (not needed on macOS)
-    * libcanberra (not needed on macOS)
-    * ImageMagick (optional, needed to use the ``kitty +kitten icat`` tool to display images in the terminal)
-    * pygments (optional, need for syntax highlighting in ``kitty +kitten diff``)
+* ``python`` >= 3.6
+* ``harfbuzz`` >= 2.2.0
+* ``zlib``
+* ``libpng``
+* ``liblcms2``
+* ``librsync``
+* ``freetype`` (not needed on macOS)
+* ``fontconfig`` (not needed on macOS)
+* ``libcanberra`` (not needed on macOS)
+* ``ImageMagick`` (optional, needed to use the ``kitty +kitten icat`` tool to display images in the terminal)
+* ``pygments`` (optional, needed for syntax highlighting in ``kitty +kitten diff``)
+
 
 Build-time dependencies:
 
-    * gcc or clang
-    * pkg-config
-    * For building on Linux in addition to the above dependencies you might also need to install the ``-dev`` packages for:
-      ``libdbus-1-dev``, ``libxcursor-dev``, ``libxrandr-dev``, ``libxi-dev``, ``libxinerama-dev``, ``libgl1-mesa-dev``, ``libxkbcommon-x11-dev``, ``libfontconfig-dev``, ``libx11-xcb-dev``, ``liblcms2-dev``, and ``libpython3-dev``,
-      if they are not already installed by your distro.
+* ``gcc`` or ``clang``
+* ``pkg-config``
+* For building on Linux in addition to the above dependencies you might also need to install the following packages, if they are not already installed by your distro:
+
+  - ``libdbus-1-dev``
+  - ``libxcursor-dev``
+  - ``libxrandr-dev``
+  - ``libxi-dev``
+  - ``libxinerama-dev``
+  - ``libgl1-mesa-dev``
+  - ``libxkbcommon-x11-dev``
+  - ``libfontconfig-dev``
+  - ``libx11-xcb-dev``
+  - ``liblcms2-dev``
+  - ``libpython3-dev``
+  - ``librsync-dev``
+
 
 Install and run from source
 ------------------------------
@@ -78,9 +96,8 @@ you might have to rebuild the app.
 .. note::
    The released :file:`kitty.dmg` includes all dependencies, unlike the
    :file:`kitty.app` built above and is built automatically by using the
-   <https://github.com/kovidgoyal/bypy>`_ however, that is designed to
-   run on Linux and is not for the faint of heart.
-
+   `bypy framework <https://github.com/kovidgoyal/bypy>`_ however, that is
+   designed to run on Linux and is not for the faint of heart.
 
 .. note::
    Apple disallows certain functionality, such as notifications for unsigned applications.
@@ -88,6 +105,12 @@ you might have to rebuild the app.
    a self signed certificate, see for example, `here
    <https://stackoverflow.com/questions/27474751/how-can-i-codesign-an-app-without-being-in-the-mac-developer-program/27474942>`_.
 
+.. note::
+   If you are facing issues with ``linker`` while building,
+   try with a ``brew`` installed python instead, see :iss:`289`
+   for more discussion.
+
+
 Build and run from source with Nix
 -------------------------------------------
 
@@ -102,7 +125,9 @@ make them available in the newly spawned shell.
 Then proceed with ``make`` or ``make app`` according to the platform specific instructions above.
 
 
-Note for Linux/macOS packagers
+.. _packagers:
+
+Notes for Linux/macOS packagers
 ----------------------------------
 
 The released |kitty| source code is available as a `tarball`_ from
@@ -122,24 +147,58 @@ with :file:`linux-package/bin/kitty`.  All the files needed to run kitty will be
 installed. You can choose a different staging area, by passing the ``--prefix``
 argument to :file:`setup.py`.
 
-You should probably split |kitty| into two packages, :file:`kitty-terminfo` that
-installs the terminfo file and :file:`kitty` that installs the main program.
-This allows users to install the terminfo file on servers into which they ssh,
-without needing to install all of |kitty|.
+You should probably split |kitty| into three packages:
+
+:code:`kitty-terminfo`
+    installs the terminfo file
+
+:code:`kitty-shell-integration`
+    installs the shell integration scripts (the contents of the
+    shell-integration directory in the kitty source code, probably to
+    :file:`/usr/share/kitty/shell-integration`
+
+:code:`kitty`
+    installs the main program
+
+This allows users to install the terminfo and shell integration files on
+servers into which they ssh, without needing to install all of |kitty|.
 
 .. note::
-        You need a couple of extra dependencies to build linux-package.
-        :file:`tic` to compile terminfo files, usually found in the
-        development package of :file:`ncurses`. Also, if you are building from
-        a git checkout instead of the released source code tarball, you will
-        need :file:`sphinx-build` from the `Sphinx documentation generator
-        <https://www.sphinx-doc.org/>`_.
+   You need a couple of extra dependencies to build linux-package.
+   :file:`tic` to compile terminfo files, usually found in the
+   development package of :file:`ncurses`. Also, if you are building from
+   a git checkout instead of the released source code tarball, you will
+   need to install the dependencies from ``docs/requirements.txt`` to
+   build the kitty documentation. They can be installed most easily with
+   ``python -m pip -r docs/requirements.txt``.
 
 This applies to creating packages for |kitty| for macOS package managers such as
 brew or MacPorts as well.
 
 
-.. note::
-        |kitty| has its own update check mechanism, if you would like to turn
-        it off for your package, use
-        ``python3 setup.py linux-package --update-check-interval=0``
+Changing defaults for packages
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+|kitty| has its defaults chosen to be suitable for a standalone distributable.
+If you are packaging it a few of these might need to be changed.
+
+update-checking
+   |kitty| has its own update check mechanism, if you would like to turn
+   it off for your package, use::
+
+       ./setup.py linux-package --update-check-interval=0
+
+shell-integration
+   |kitty| by default injects its :ref:`shell_integration` code into the user's
+   shell using environment variables or (for bash only) modifying
+   the user's :file:`~/.bashrc` file.
+   For a package, it might make more sense to distribute the shell
+   integration scripts into the system-wide shell vendor locations. The
+   shell integration files are found in the :file:`shell-integration`
+   directory. Copy them to the system wide shell vendor locations for each
+   shell, and use::
+
+       ./setup.py linux-package --shell-integration=enabled\ no-rc
+
+   This will prevent kitty from modifying the user's shell environment to load
+   the integration scripts.

docs/changelog.rst

@@ -4,8 +4,462 @@ Changelog
 |kitty| is a feature-rich, cross-platform, *fast*, GPU based terminal.
 To update |kitty|, :doc:`follow the instructions <binary>`.
 
+Recent major new features
+---------------------------
+
+.. only:: dirhtml
+
+   A demo video
+   ~~~~~~~~~~~~~~~~
+
+   A new video showcasing some of kitty's many productivity enhancing features.
+
+   .. raw:: html
+
+        <video controls width="640" height="360">
+            <source src="https://download.calibre-ebook.com/videos/kitty.mp4" type="video/mp4">
+            <source src="https://download.calibre-ebook.com/videos/kitty.webm" type="video/webm">
+        </video>
+
+   .. rst-class:: caption caption-text
+
+       Watch kitty in action!
+
+
+Shell integration
+~~~~~~~~~~~~~~~~~~~~~
+
+kitty automatically integrates with common shells to allow browsing the
+output of the previous command in a pager by pressing
+:sc:`show_last_command_output`, jumping to previous prompt locations in the
+scrollback by pressing :sc:`scroll_to_previous_prompt` and clicking with the
+mouse anywhere in the current command to move the cursor there. See
+:doc:`shell-integration` for details.
+
+Logos for windows
+~~~~~~~~~~~~~~~~~~~~
+
+kitty has the ability to display arbitrary ``PNG`` images at the corner
+of any kitty window to serve as a *logo* for quick window identification.
+Can be controlled via :opt:`window_logo_path` and also and changed via
+the :ref:`at_set-window-logo` remote control command.
+Useful to quickly identify special windows or just for some *bling*.
+
+.. figure:: screenshots/window-logo.png
+    :alt: A screenshot of the kitty shell window showing the kitty logo
+    :align: center
+    :width: 100%
+
+    A screenshot of the kitty shell window showing the kitty logo
+
+
+Visual keyboard based window select
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Select a kitty window visually using the keyboard, like the
+:doc:`kittens/hints`, but for kitty windows. Can also be used from shell
+scripts/third party integrations via the :ref:`at_select-window` remote control
+command.
+
+.. figure:: screenshots/select-window.png
+    :alt: A screenshot of the kitty select window function
+    :align: center
+    :width: 100%
+
+    Hints for selecting kitty windows visually
+
+
+
+Detailed list of changes
+-------------------------------------
+
+0.24.1 [2022-01-06]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Shell integration: Work around conflicts with some zsh plugins (:iss:`4428`)
+
+- Have the zero width space and various other characters from the *Other,
+  formatting* Unicode category be treated as combining characters (:iss:`4439`)
+
+- Fix using ``--shell-integration`` with :file:`setup.py` broken (:iss:`4434`)
+
+- Fix showing debug information not working if kitty's :file:`STDIN` is not a tty
+  (:iss:`4424`)
+
+- Linux: Fix a regression that broke rendering of emoji with variation selectors
+  (:iss:`4444`)
+
+
+0.24.0 [2022-01-04]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Integrate kitty closely with common shells such as zsh, fish and bash.
+  This allows lots of niceties such as jumping to previous prompts, opening the
+  output of the last command in a new window, etc. See :ref:`shell_integration`
+  for details. Packagers please read :ref:`packagers`.
+
+- A new shortcut :sc:`focus_visible_window` to visually focus a window using
+  the keyboard. Pressing it causes numbers to appear over each visible window
+  and you can press the number to focus the corresponding window (:iss:`4110`)
+
+- A new facility :opt:`window_logo_path` to draw an arbitrary PNG image as
+  logo in the corner of a kitty window (:pull:`4167`)
+
+- Allow rendering the cursor with a *reverse video* effect. See :opt:`cursor`
+  for details (:iss:`126`)
+
+- Allow rendering the mouse selection with a *reverse video* effect. See
+  :opt:`selection_foreground` (:iss:`646`)
+
+- A new option :opt:`tab_bar_align` to draw the tab bar centered or right
+  aligned (:iss:`3946`)
+
+- Allow the user to supply a custom Python function to draw tab bar. See
+  :opt:`tab_bar_style`
+
+- A new remote control command to :program:`change the tab color <kitty @
+  set-tab-color>` (:iss:`1287`)
+
+- A new remote control command to :program:`visually select a window <kitty @
+  select-window>` (:iss:`4165`)
+
+- Add support for reporting mouse events with pixel co-ordinates using the
+  ``SGR_PIXEL_PROTOCOL`` introduced in xterm 359
+
+- When programs ask to read from the clipboard prompt, ask the user to allow
+  the request by default instead of denying it by default. See
+  :opt:`clipboard_control` for details (:iss:`4022`)
+
+- A new mappable action ``swap_with_window`` to swap the current window with another window in the tab, visually
+
+- A new :program:`remote control command <kitty @ set-enabled-layouts>` to change
+  the enabled layouts in a tab (:iss:`4129`)
+
+- A new option :opt:`bell_path` to specify the path to a sound file
+  to use as the bell sound
+
+- A new option :opt:`exe_search_path` to modify the locations kitty searches
+  for executables to run (:iss:`4324`)
+
+- broadcast kitten: Show a "fake" cursor in all windows being broadcast too
+  (:iss:`4225`)
+
+- Allow defining :opt:`aliases <action_alias>` for more general actions, not just kittens
+  (:pull:`4260`)
+
+- Fix a regression that caused :option:`kitty --title` to not work when
+  opening new OS windows using :option:`kitty --single-instance` (:iss:`3893`)
+
+- icat kitten: Fix display of JPEG images that are rotated via EXIF data and
+  larger than available screen size (:iss:`3949`)
+
+- macOS: Fix SIGUSR1 quitting kitty instead of reloading the config file (:iss:`3952`)
+
+- Launch command: Allow specifying the OS window title
+
+- broadcast kitten: Allow broadcasting :kbd:`ctrl+c` (:pull:`3956`)
+
+- Fix space ligatures not working with Iosevka for some characters in the
+  Enclosed Alphanumeric Supplement (:iss:`3954`)
+
+- hints kitten: Fix a regression that caused using the default open program
+  to trigger open actions instead of running the program (:iss:`3968`)
+
+- Allow deleting environment variables in :opt:`env` by specifying
+  just the variable name, without a value
+
+- Fix :opt:`active_tab_foreground` not being honored when :opt:`tab_bar_style`
+  is ``slant`` (:iss:`4053`)
+
+- When a :opt:`tab_bar_background` is specified it should extend to the edges
+  of the OS window (:iss:`4054`)
+
+- Linux: Fix IME with fcitx5 not working after fcitx5 is restarted
+  (:pull:`4059`)
+
+- Various improvements to IME integration (:iss:`4219`)
+
+- Remote file transfer: Fix transfer not working if custom ssh port or identity
+  is specified on the command line (:iss:`4067`)
+
+- Unicode input kitten: Implement scrolling when more results are found than
+  the available display space (:pull:`4068`)
+
+- Allow middle clicking on a tab to close it (:iss:`4151`)
+
+- The command line option ``--watcher`` has been deprecated in favor of the
+  :opt:`watcher` option in :file:`kitty.conf`. It has the advantage of
+  applying to all windows, not just the initially created ones. Note that
+  ``--watcher`` now also applies to all windows, not just initially created ones.
+
+- **Backward incompatibility**: No longer turn on the kitty extended keyboard
+  protocol's disambiguate mode when the client sends the XTMODKEYS escape code.
+  Applications must use the dedicated escape code to turn on the protocol.
+  (:iss:`4075`)
+
+- Fix soft hyphens not being preserved when round tripping text through the
+  terminal
+
+- macOS: Fix :kbd:`ctrl+shift` with :kbd:`Esc` or :kbd:`F1` - :kbd:`F12` not working
+  (:iss:`4109`)
+
+- macOS: Fix :opt:`resize_in_steps` not working correctly on high DPI screens
+  (:iss:`4114`)
+
+- Fix the :program:`resize OS Windows <kitty @ resize-os-window>` setting a
+  slightly incorrect size on high DPI screens (:iss:`4114`)
+
+- :program:`kitty @ launch` - when creating tabs with the ``--match`` option create
+  the tab in the OS Window containing the result of the match rather than
+  the active OS Window (:iss:`4126`)
+
+- Linux X11: Add support for 10bit colors (:iss:`4150`)
+
+- Fix various issues with changing :opt:`tab_bar_background` by remote control
+  (:iss:`4152`)
+
+- A new option :opt:`tab_bar_margin_color` to control the color of the tab bar
+  margins
+
+- A new option :opt:`visual_bell_color` to customize the color of the visual bell
+  (:pull:`4181`)
+
+- Add support for OSC 777 based desktop notifications
+
+- Wayland: Fix pasting from applications that use a MIME type of "text/plain"
+  rather than "text/plain;charset=utf-8" not working (:iss:`4183`)
+
+- A new mappable action to close windows with a confirmation (:iss:`4195`)
+
+- When remembering OS window sizes for full screen windows use the size before
+  the window became fullscreen (:iss:`4221`)
+
+- macOS: Fix keyboard input not working after toggling fullscreen till the
+  window is clicked in
+
+- A new mappable action ``nth_os_window`` to to focus the specified nth OS
+  window. (:pull:`4316`)
+
+- macOS: The kitty window can be scrolled by the mouse wheel when OS window not
+  in focus. (:pull:`4371`)
+
+- macOS: Light or dark system appearance can be specified in
+  :opt:`macos_titlebar_color` and used in kitty themes. (:pull:`4378`)
+
+
+0.23.1 [2021-08-17]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- macOS: Fix themes kitten failing to download themes because of missing SSL
+  root certificates (:iss:`3936`)
+
+- A new option :opt:`clipboard_max_size` to control the maximum size
+  of data that kitty will transmit to the system clipboard on behalf of
+  programs running inside it (:iss:`3937`)
+
+- When matching windows/tabs in kittens or using remote control, allow matching
+  by recency. ``recent:0`` matches the active window/tab, ``recent:1`` matches
+  the previous window/tab and so on
+
+- themes kitten: Fix only the first custom theme file being loaded correctly
+  (:iss:`3938`)
+
+
+0.23.0 [2021-08-16]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- A new :doc:`themes kitten </kittens/themes>` to easily change kitty themes.
+  Choose from almost two hundred themes in the `kitty themes repository
+  <https://github.com/kovidgoyal/kitty-themes>`_
+
+- A new style for the tab bar that makes tabs looks like the tabs in a physical
+  tabbed file, see :opt:`tab_bar_style`
+
+- Make the visual bell flash more gentle, especially on dark themes
+  (:pull:`2937`)
+
+- Fix :option:`kitty --title` not overriding the OS Window title when multiple
+  tabs are present. Also this option is no longer used as the default title for
+  windows, allowing individual tabs/windows to have their own titles, even when
+  the OS Window has a fixed overall title (:iss:`3893`)
+
+- Linux: Fix some very long ligatures being rendered incorrectly at some font
+  sizes (:iss:`3896`)
+
+- Fix shift+middle click to paste sending a mouse press event but no release
+  event which breaks some applications that grab the mouse but cant handle
+  mouse events (:iss:`3902`)
+
+- macOS: When the language is set to English and the country to one for which
+  an English locale does not exist, set :envvar:`LANG` to ``en_US.UTF-8``
+  (:iss:`3899`)
+
+- terminfo: Fix "cnorm" the property for setting the cursor to normal using a
+  solid block rather than a blinking block cursor (:iss:`3906`)
+
+- Add :opt:`clear_all_mouse_actions` to clear all mouse actions defined to
+  that point (:iss:`3907`)
+
+- Fix the remote file kitten not working when using -- with ssh. The ssh kitten
+  was recently changed to do this (:iss:`3929`)
+
+- When dragging word or line selections, ensure the initially selected item is
+  never deselected. This matches behavior in most other programs (:iss:`3930`)
+
+- hints kitten: Make copy/paste with the :option:`kitty +kitten hints
+  --program` option work when using the ``self``
+  :option:`kitty +kitten hints --linenum-action` (:iss:`3931`)
+
+
+0.22.2 [2021-08-02]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- macOS: Fix a long standing bug that could cause kitty windows to stop
+  updating, that got worse in the previous release (:iss:`3890` and
+  :iss:`2016`)
+
+- Wayland: A better fix for compositors like sway that can toggle client side
+  decorations on and off (:iss:`3888`)
+
+
+0.22.1 [2021-07-31]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Fix a regression in the previous release that broke ``kitty --help`` (:iss:`3869`)
+
+- Graphics protocol: Fix composing onto currently displayed frame not updating the frame on the GPU (:iss:`3874`)
+
+- Fix switching to previously active tab after detaching a tab not working (:pull:`3871`)
+
+- macOS: Fix an error on Apple silicon when enumerating monitors (:pull:`3875`)
+
+- detach_window: Allow specifying the previously active tab or the tab to the left/right of
+  the active tab (:disc:`3877`)
+
+- broadcast kitten: Fix a regression in ``0.20.0`` that broke sending of some
+  keys, such as backspace
+
+- Linux binary: Remove any RPATH build artifacts from bundled libraries
+
+- Wayland: If the compositor turns off server side decorations after turning
+  them on do not draw client side decorations (:iss:`3888`)
+
+
+0.22.0 [2021-07-26]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Add a new :ref:`action-toggle_layout` action to easily zoom/unzoom a window
+
+- When right clicking to extend a selection, move the nearest selection
+  boundary rather than the end of the selection. To restore previous behavior
+  use ``mouse_map right press ungrabbed mouse_selection move-end``.
+
+- When opening hyperlinks, allow defining open actions for directories
+  (:pull:`3836`)
+
+- When using the OSC 52 escape code to copy to clipboard allow large
+  copies (up to 8MB) without needing a kitty specific chunking protocol.
+  Note that if you used the chunking protocol in the past, it will no longer
+  work and you should switch to using the unmodified protocol which has the
+  advantage of working with all terminal emulators.
+
+- Fix a bug in the implementation of the synchronized updates escape code that
+  could cause incorrect parsing if either the pending buffer capacity or the
+  pending timeout were exceeded (:iss:`3779`)
+
+- A new remote control command to :program:`resize the OS Window <kitty @
+  resize-os-window>`
+
+- Graphics protocol: Add support for composing rectangles from one animation
+  frame onto another (:iss:`3809`)
+
+- diff kitten: Remove limit on max line length of 4096 characters (:iss:`3806`)
+
+- Fix turning off cursor blink via escape codes not working (:iss:`3808`)
+
+- Allow using neighboring window operations in the stack layout. The previous
+  window is considered the left and top neighbor and the next window is
+  considered the bottom and right neighbor (:iss:`3778`)
+
+- macOS: Render colors in the sRGB colorspace to match other macOS terminal
+  applications (:iss:`2249`)
+
+- Add a new variable ``{num_window_groups}`` for the :opt:`tab_title_template`
+  (:iss:`3837`)
+
+- Wayland: Fix :opt:`initial_window_width/height <remember_window_size>` specified
+  in cells not working on High DPI screens (:iss:`3834`)
+
+- A new theme for the kitty website with support for dark mode.
+
+- Render ┄ ┅ ┆ ┇ ┈ ┉ ┊ ┋ with spaces at the edges. Matches rendering in
+  most other programs and allows long chains of them to look better
+  (:iss:`3844`)
+
+- hints kitten: Detect paths and hashes that appear over multiple lines.
+  Note that this means that all line breaks in the text are no longer \n
+  soft breaks are instead \r. If you use a custom regular expression that
+  is meant to match over line breaks, you will need to match over both.
+  (:iss:`3845`)
+
+- Allow leading or trailing spaces in :opt:`tab_activity_symbol`
+
+- Fix mouse actions not working when caps lock or num lock are engaged
+  (:iss:`3859`)
+
+- macOS: Fix automatic detection of bold/italic faces for fonts that
+  use the family name as the full face name of the regular font not working
+  (:iss:`3861`)
+
+- clipboard kitten: fix copies to clipboard not working without the
+  :option:`kitty +kitten clipboard --wait-for-completion` option
+
+
+0.21.2 [2021-06-28]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- A new :opt:`adjust_baseline` option to adjust the vertical alignment of text
+  inside a line (:pull:`3734`)
+
+- A new :opt:`url_excluded_characters` option to exclude additional characters
+  when detecting URLs under the mouse (:pull:`3738`)
+
+- Fix a regression in 0.21.0 that broke rendering of private use Unicode symbols followed
+  by spaces, when they also exist not followed by spaces (:iss:`3729`)
+
+- ssh kitten: Support systems where the login shell is a non-POSIX shell
+  (:iss:`3405`)
+
+- ssh kitten: Add completion (:iss:`3760`)
+
+- ssh kitten: Fix "Connection closed" message being printed by ssh when running
+  remote commands
+
+- Add support for the XTVERSION escape code
+
+- macOS: Fix a regression in 0.21.0 that broke middle-click to paste from clipboard (:iss:`3730`)
+
+- macOS: Fix shortcuts in the global menu bar responding slowly when cursor blink
+  is disabled/timed out (:iss:`3693`)
+
+- When displaying scrollback ensure that the window does not quit if the amount
+  of scrollback is less than a screen and the user has the ``--quit-if-one-screen``
+  option enabled for less (:iss:`3740`)
+
+- Linux: Fix Emoji/bitmapped fonts not use able in symbol_map
+
+- query terminal kitten: Allow querying font face and size information
+  (:iss:`3756`)
+
+- hyperlinked grep kitten: Fix context options not generating contextual output (:iss:`3759`)
+
+- Allow using superscripts in tab titles (:iss:`3763`)
+
+- Unicode input kitten: Fix searching when a word has more than 1024 matches (:iss:`3773`)
+
+
 0.21.1 [2021-06-14]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: Fix a regression in the previous release that broke rendering of
   strikeout (:iss:`3717`)
@@ -18,7 +472,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.21.0 [2021-06-12]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow reloading the :file:`kitty.conf` config file by pressing
   :sc:`reload_config_file`. (:iss:`1292`)
@@ -27,7 +481,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   :kbd:`ctrl+shift`
 
 - Allow remapping all mouse button press/release events to perform arbitrary
-  actions. :ref:`See details <conf-kitty-mouse.mousemap>`.
+  actions. :ref:`See details <conf-kitty-mouse.mousemap>` (:iss:`1033`)
 
 - Support infinite length ligatures (:iss:`3504`)
 
@@ -50,7 +504,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 - Unicode input kitten: Fix a regression in 0.20.0 that broke keyboard handling
   when the NumLock or CapsLock modifiers were engaged. (:iss:`3587`)
 
-- Fix a regression in 0.20.0 that sent incorrect bytes for the :kbd:`F1-F4` keys
+- Fix a regression in 0.20.0 that sent incorrect bytes for the :kbd:`F1`-:kbd:`F4` keys
   in rmkx mode (:iss:`3586`)
 
 - macOS: When the Apple Color Emoji font lacks an emoji glyph search for it in other
@@ -111,7 +565,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.20.3 [2021-05-06]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: Distribute universal binaries with both ARM and Intel architectures
 
@@ -132,7 +586,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.20.2 [2021-04-28]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new protocol extension to :ref:`unscroll <unscroll>` text from the
   scrollback buffer onto the screen. Useful, for example, to restore
@@ -172,7 +626,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.20.1 [2021-04-19]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - icat: Fix some broken GIF images with no frame delays not being animated
   (:iss:`3498`)
@@ -185,7 +639,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.20.0 [2021-04-19]
-----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Support display of animated images ``kitty +kitten icat animation.gif``. See
   :ref:`animation_protocol` for details on animation support in the kitty
@@ -309,7 +763,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.19.3 [2020-12-19]
--------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Happy holidays to all kitty users!
 
@@ -371,7 +825,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.19.2 [2020-11-13]
--------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new :doc:`kittens/query_terminal` kitten to easily query the running kitty
   via escape codes to detect its version, and the values of
@@ -414,7 +868,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.19.1 [2020-10-06]
--------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - hints kitten: Add an ``ip`` type for easy selection of IP addresses
   (:pull:`3009`)
@@ -426,7 +880,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.19.0 [2020-10-04]
--------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add support for `hyperlinks from terminal programs
   <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>`_.
@@ -498,7 +952,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.18.3 [2020-08-11]
--------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - hints kitten: Allow customizing hint colors (:pull:`2894`)
 
@@ -519,7 +973,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.18.2 [2020-07-28]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - X11: Improve handling of multiple keyboards. Now pressing a modifier key in
   one keyboard and a normal key in another works (:iss:`2362`). Don't rebuild
@@ -584,13 +1038,13 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.18.1 [2020-06-23]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: Fix for diff kitten not working with python 3.8 (:iss:`2780`)
 
 
 0.18.0 [2020-06-20]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow multiple overlay windows per normal window
 
@@ -641,7 +1095,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.17.4 [2020-05-09]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow showing the name of the current layout and the number of windows
   in tab titles (:iss:`2634`)
@@ -668,7 +1122,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.17.3 [2020-04-23]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow individually setting margins and padding for each edge (left, right,
   top, bottom). Margins can also be controlled per window via remote control
@@ -722,7 +1176,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 - Fix :option:`--title` not being applied at window creation time (:iss:`2570`)
 
 0.17.2 [2020-03-29]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add a :option:`launch --watcher` option that allows defining callbacks
   that are called for various events in the window's life-cycle (:iss:`2440`)
@@ -753,7 +1207,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.17.1 [2020-03-24]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix :opt:`cursor_underline_thickness` not working (:iss:`2465`)
 
@@ -768,7 +1222,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.17.0 [2020-03-24]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - :ref:`splits_layout` to arrange windows in arbitrary splits
   (:iss:`2308`)
@@ -859,7 +1313,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.16.0 [2020-01-28]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new :doc:`marks` feature that allows highlighting and scrolling to arbitrary
   text in the terminal window.
@@ -906,7 +1360,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   them. (:iss:`2310`)
 
 0.15.1 [2019-12-21]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix a crash/incorrect rendering when detaching a window in some circumstances
   (:iss:`2173`)
@@ -931,7 +1385,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.15.0 [2019-11-27]
---------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add a new action :ref:`detach_window <detach_window>` that can be used to move the current
   window into a different tab (:iss:`1310`)
@@ -981,7 +1435,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.6 [2019-09-25]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: Fix a regression in the previous release that caused a crash when
   pressing a unprintable key, such as the POWER key (:iss:`1997`)
@@ -991,7 +1445,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.5 [2019-09-23]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Implement a hack to (mostly) preserve tabs when cat-ting a file with them and then
   copying the text or passing screen contents to another program (:iss:`1829`)
@@ -1014,7 +1468,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 - Use selection foreground color for underlines as well (:iss:`1982`)
 
 0.14.4 [2019-08-31]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - hints kitten: Add a :option:`kitty +kitten hints --alphabet` option to
   control what alphabets are used for hints (:iss:`1879`)
@@ -1053,7 +1507,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.3 [2019-07-29]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Remote control: Add a command `kitty @ scroll-window` to scroll windows
 
@@ -1108,7 +1562,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.2 [2019-06-09]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option :opt:`placement_strategy` to control how the cell area is
   aligned inside the window when the window size is not an exact multiple
@@ -1150,7 +1604,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.1 [2019-05-29]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option :opt:`command_on_bell` to run an arbitrary command when
   a bell occurs (:iss:`1660`)
@@ -1185,7 +1639,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.14.0 [2019-05-24]
----------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: The default behavior of the Option key has changed. It now generates
   unicode characters rather than acting as the :kbd:`Alt` modifier. See
@@ -1320,7 +1774,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   characters not working well (:iss:`1616`)
 
 0.13.3 [2019-01-19]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - icat kitten: Add a ``--stdin`` option to control if image data is read from
   STDIN (:iss:`1308`)
@@ -1358,7 +1812,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.13.2 [2019-01-04]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add a new option :opt:`tab_title_template` to control how tab titles
   are formatted. In particular the template can be used to display
@@ -1400,7 +1854,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.13.1 [2018-12-06]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix passing input via the pipe action to a program without a window not
   working.
@@ -1413,7 +1867,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   be properly unwrapped (:iss:`1206`)
 
 0.13.0 [2018-12-05]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option :opt:`scrollback_pager_history_size` to tell kitty to store
   extended scrollback to use when viewing the scrollback buffer in a pager
@@ -1510,7 +1964,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   and slash characters in short URLs (:iss:`1201`)
 
 0.12.3 [2018-09-29]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - macOS: Fix kitty window not being rendered on macOS Mojave until the window is
   moved or resized at least once (:iss:`887`)
@@ -1519,7 +1973,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.12.2 [2018-09-24]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new ``last_used_layout`` function that can be mapped to a shortcut to
   switch to the previously used window layout (:iss:`870`)
@@ -1586,7 +2040,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   mouse to malfunction when using multiple kitty windows (:iss:`1002`)
 
 0.12.1 [2018-09-08]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add a new ``--start-in-fullscreen`` command line flag to start
   kitty in full screen mode (:iss:`856`)
@@ -1629,7 +2083,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   a bug in the 0.12.0 macOS package
 
 0.12.0 [2018-09-01]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Preserve the mouse selection even when the contents of the screen are
   scrolled or overwritten provided the new text does not intersect the
@@ -1640,7 +2094,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   <https://github.com/ibus/ibus/wiki/ReadMe>`_ (:iss:`469`)
 
 - Implement completion for the kitty command in bash and zsh. See
-  :ref:`completion`.
+  :ref:`shell_integration`.
 
 - Render the text under the cursor in a fixed color, configurable via
   the option :opt:`cursor_text_color` (:iss:`126`)
@@ -1704,7 +2158,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.11.3 [2018-07-10]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Draw only the minimum borders needed for inactive windows. That is only the borders
   that separate the inactive window from a neighbor. Note that setting
@@ -1738,7 +2192,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.11.2 [2018-07-01]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Linux: Allow using XKB key names to bind shortcuts to keys not supported by GLFW (:pull:`665`)
 
@@ -1775,7 +2229,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.11.1 [2018-06-17]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - diff kitten: Implement searching for text in the diff (:iss:`574`)
 
@@ -1803,7 +2257,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.11.0 [2018-06-12]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new tab bar style "fade" in which each tab's edges fade into the background.
   See :opt:`tab_bar_style` and :opt:`tab_fade` for details. The old look can be
@@ -1894,7 +2348,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.10.1 [2018-05-24]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add a kitten to easily ssh into servers that automatically copies the
   terminfo files over. ``kitty +kitten ssh myserver``.
@@ -1919,7 +2373,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.10.0 [2018-05-21]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A diff kitten to show side-by-side diffs with syntax highlighting and support
   for images. See :doc:`diff kitten <kittens/diff>`.
@@ -1969,7 +2423,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.9.1 [2018-05-05]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Show a bell symbol on the tab if a bell occurs in one of the windows in the tab and
   the window is not the currently focused window
@@ -2037,7 +2491,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.9.0 [2018-04-15]
-------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A new kitty command shell to allow controlling kitty via commands. Press
   `ctrl+shift+escape` to run the shell.
@@ -2081,7 +2535,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.8.4 [2018-03-31]
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix presence of XDG_CONFIG_DIRS and absence of XDG_CONFIG_HOME preventing
   kitty from starting
@@ -2091,7 +2545,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.8.3 [2018-03-29]
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix a regression that broke the visual bell and invert screen colors escape
   code
@@ -2116,7 +2570,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.8.2 [2018-03-17]
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow extending existing selections by right clicking
 
@@ -2139,7 +2593,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 - Fix a crash when getting the contents of the scrollback buffer as text
 
 0.8.1 [2018-03-09]
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Extend kitty's remote control feature to work over both UNIX and TCP sockets,
   so now you can control kitty from across the internet, if you want to.
@@ -2171,7 +2625,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.8.0 [2018-02-24]
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - A framework for kittens, that is, small terminal programs designed to run
   inside kitty and extend its capabilities. Examples include unicode input and
@@ -2216,7 +2670,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
   new window/tab.
 
 0.7.1 [2018-01-31]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option to adjust the width of character cells
 
@@ -2228,7 +2682,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.7.0 [2018-01-24]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Allow controlling kitty from the shell prompt/scripts. You can
   open/close/rename windows and tabs and even send input to specific windows.
@@ -2273,7 +2727,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.6.1 [2017-12-28]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option to fade the text in inactive windows
 
@@ -2301,7 +2755,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.6.0 [2017-12-18]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Support background transparency via the background_opacity option. Provided
   that your OS/window manager supports transparency, you can now have kitty
@@ -2352,7 +2806,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.5.1 [2017-12-01]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add an option to control the thickness of lines in box drawing characters
 
@@ -2369,7 +2823,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.5.0 [2017-11-19]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Add support for ligature fonts such as Fira Code, Hasklig, etc. kitty now
   uses harfbuzz for text shaping which allow it to support advanced OpenType
@@ -2403,7 +2857,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.4.2 [2017-10-23]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Fix a regression in 0.4.0 that broke custom key mappings
 
@@ -2414,7 +2868,7 @@ To update |kitty|, :doc:`follow the instructions <binary>`.
 
 
 0.4.0 [2017-10-22]
----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Support for drawing arbitrary raster graphics (images) in the terminal via a
   new graphics protocol. kitty can draw images with full 32-bit color using both

docs/color-stack.rst

@@ -0,0 +1,26 @@
+Saving and restoring colors
+==============================
+
+It is often useful for a full screen application with its own color themes to
+set the default foreground, background, selection and cursor colors and the
+ANSI color table. This allows for various performance optimizations when
+drawing the screen. The problem is that if the user previously used the escape
+codes to change these colors herself, then running the full screen application
+will lose her changes even after it exits. To avoid this, kitty introduces a
+new pair of *OSC* escape codes to push and pop the current color values from a
+stack::
+
+    <ESC>]30001<ESC>\  # push onto stack
+    <ESC>]30101<ESC>\  # pop from stack
+
+These escape codes save/restore the colors, default
+background, default foreground, selection background, selection foreground and
+cursor color and the 256 colors of the ANSI color table.
+
+.. note:: In July 2020, after several years, XTerm copied this protocol
+   extension, without acknowledgement, and using incompatible escape codes
+   (XTPUSHCOLORS, XTPOPCOLORS, XTREPORTCOLORS). And they decided to save not
+   just the dynamic colors but the entire ANSI color table. In the interests of
+   promoting interoperability, kitty added support for XTerm's escape codes as
+   well, and changed this extension to also save/restore the entire ANSI color
+   table.

docs/conf.py

@@ -21,16 +21,18 @@ from pygments.lexer import RegexLexer, bygroups  # type: ignore
 from pygments.token import (  # type: ignore
     Comment, Keyword, Literal, Name, Number, String, Whitespace
 )
-from sphinx import addnodes, version_info  # type: ignore
-from sphinx.environment.adapters.toctree import TocTree  # type: ignore
-from sphinx.util.logging import getLogger  # type: ignore
+from sphinx import addnodes, version_info
+from sphinx.builders.html.transforms import KeyboardTransform
+from sphinx.util.logging import getLogger
+
+KeyboardTransform.builders = ('html', 'dirhtml')  # type: ignore
 
 kitty_src = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 if kitty_src not in sys.path:
     sys.path.insert(0, kitty_src)
 
 from kitty.conf.types import Definition  # noqa
-from kitty.constants import str_version  # noqa
+from kitty.constants import str_version, website_url  # noqa
 
 # config {{{
 # -- Project information -----------------------------------------------------
@@ -60,8 +62,14 @@ extensions = [
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
+    'sphinx_copybutton',
+    'sphinx_inline_tabs',
+    "sphinxext.opengraph",
 ]
 
+# URL for OpenGraph tags
+ogp_site_url = website_url()
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -85,25 +93,18 @@ language: Optional[str] = None
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = [
-    '_build', 'Thumbs.db', '.DS_Store',
-    'generated/cli-*.rst', 'generated/conf-*.rst'
+    '_build', 'Thumbs.db', '.DS_Store', 'basic.rst',
+    'generated/cli-*.rst', 'generated/conf-*.rst', 'generated/actions.rst'
 ]
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
 rst_prolog = '''
 .. |kitty| replace:: *kitty*
 .. |version| replace:: VERSION
 .. _tarball: https://github.com/kovidgoyal/kitty/releases/download/vVERSION/kitty-VERSION.tar.xz
-.. role:: green
 .. role:: italic
-.. role:: bold
-.. role:: cyan
-.. role:: title
-.. role:: env
 
 '''.replace('VERSION', str_version)
+smartquotes_action = 'qe'  # educate quotes and ellipses but not dashes
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -111,32 +112,26 @@ rst_prolog = '''
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'furo'
+html_title = 'kitty'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {
-    'logo': 'kitty.png',
-    'show_powered_by': False,
-    'fixed_sidebar': True,
-    'sidebar_collapse': True,
-    'github_button': False,
-    'github_banner': True,
-    'github_user': 'kovidgoyal',
-    'github_repo': 'kitty',
-    # increase contrast of link color with text color
-    'link': '#00587d',
-    'link_hover': 'green',
+html_theme_options: Dict[str, Any] = {
+    'sidebar_hide_name': True,
+    'navigation_with_keys': True,
 }
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static', '../logo/kitty.png']
-html_favicon = '../logo/kitty.png'
+html_static_path = ['_static']
+html_favicon = html_logo = '../logo/kitty.svg'
+html_css_files = ['custom.css']
+html_js_files = ['custom.js']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -146,17 +141,9 @@ html_favicon = '../logo/kitty.png'
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
-html_sidebars = {
-    '**': [
-        'about.html',
-        'support.html',
-        'searchbox.html',
-        'localtoc.html',
-        'relations.html',
-    ]
-}
 html_show_sourcelink = False
-
+html_show_sphinx = False
+manpages_url = 'https://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
 
 # -- Options for manual page output ------------------------------------------
 
@@ -183,7 +170,9 @@ texinfo_documents = [
 
 # GitHub linking inline roles {{{
 
-def num_role(which: str, name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []) -> Tuple[List, List]:
+def num_role(
+    which: str, name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []
+) -> Tuple[List[nodes.reference], List[nodes.problematic]]:
     ' Link to a github issue '
     try:
         issue_num = int(text)
@@ -201,7 +190,9 @@ def num_role(which: str, name: str, rawtext: str, text: str, lineno: int, inline
     return [node], []
 
 
-def commit_role(name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []) -> Tuple[List, List]:
+def commit_role(
+    name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []
+) -> Tuple[List[nodes.reference], List[nodes.problematic]]:
     ' Link to a github commit '
     try:
         commit_id = subprocess.check_output(
@@ -220,28 +211,6 @@ def commit_role(name: str, rawtext: str, text: str, lineno: int, inliner: Any, o
 # }}}
 
 
-# Sidebar ToC {{{
-def create_toc(app: Any, pagename: str) -> Optional[Any]:
-    tt = TocTree(app.env)
-    toctree = tt.get_toc_for(pagename, app.builder)
-    if toctree is not None:
-        subtree = toctree[toctree.first_child_matching_class(nodes.list_item)]
-        bl = subtree.first_child_matching_class(nodes.bullet_list)
-        if bl is None:
-            return None  # Empty ToC
-        subtree = subtree[bl]
-        # for li in subtree.traverse(nodes.list_item):
-        #     modify_li(li)
-        # subtree['ids'] = [ID]
-        return app.builder.render_partial(subtree)['fragment']
-
-
-def add_html_context(app: Any, pagename: str, templatename: str, context: Any, *args: Any) -> None:
-    if 'toc' in context:
-        context['toc'] = create_toc(app, pagename) or context['toc']
-# }}}
-
-
 # CLI docs {{{
 def write_cli_docs(all_kitten_names: Iterable[str]) -> None:
     from kitty.cli import option_spec_as_rst
@@ -281,6 +250,11 @@ if you specify a program-to-run you can use the special placeholder
             with open(f'generated/cli-kitten-{kitten}.rst', 'w') as f:
                 p = partial(print, file=f)
                 p('.. program::', f'kitty +kitten {kitten}')
+                p(f'\nSource code for {kitten}')
+                p('-' * 72)
+                p(f'\nThe source code for this kitten is `available on GitHub <https://github.com/kovidgoyal/kitty/tree/master/kittens/{kitten}>`_.')
+                p('\nCommand Line Interface')
+                p('-' * 72, file=f)
                 p('\n\n' + option_spec_as_rst(
                     data['options'], message=data['help_text'], usage=data['usage'], appname=f'kitty +kitten {kitten}',
                     heading_char='^'))
@@ -294,7 +268,7 @@ def write_remote_control_protocol_docs() -> None:  # {{{
     )
     field_pat = re.compile(r'\s*([a-zA-Z0-9_+]+)\s*:\s*(.+)')
 
-    def format_cmd(p: Callable, name: str, cmd: RemoteCommand) -> None:
+    def format_cmd(p: Callable[..., None], name: str, cmd: RemoteCommand) -> None:
         p(name)
         p('-' * 80)
         lines = (cmd.__doc__ or '').strip().splitlines()
@@ -334,7 +308,7 @@ def write_remote_control_protocol_docs() -> None:  # {{{
 
 # config file docs {{{
 
-class ConfLexer(RegexLexer):
+class ConfLexer(RegexLexer):  # type: ignore
     name = 'Conf'
     aliases = ['conf']
     filenames = ['*.conf']
@@ -347,6 +321,8 @@ class ConfLexer(RegexLexer):
             (r'(include)(\s+)(.+?)$', bygroups(Comment.Preproc, Whitespace, Name.Namespace)),
             (r'(map)(\s+)(\S+)(\s+)', bygroups(
                 Keyword.Declaration, Whitespace, String, Whitespace), 'action'),
+            (r'(mouse_map)(\s+)(\S+)(\s+)(\S+)(\s+)(\S+)(\s+)', bygroups(
+                Keyword.Declaration, Whitespace, String, Whitespace, Name.Variable, Whitespace, String, Whitespace), 'action'),
             (r'(symbol_map)(\s+)(\S+)(\s+)(.+?)$', bygroups(
                 Keyword.Declaration, Whitespace, String, Whitespace, Literal)),
             (r'([a-zA-Z_0-9]+)(\s+)', bygroups(
@@ -371,7 +347,7 @@ class ConfLexer(RegexLexer):
     }
 
 
-class SessionLexer(RegexLexer):
+class SessionLexer(RegexLexer):  # type: ignore
     name = 'Session'
     aliases = ['session']
     filenames = ['*.session']
@@ -387,7 +363,9 @@ class SessionLexer(RegexLexer):
     }
 
 
-def link_role(name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []) -> Tuple[List, List]:
+def link_role(
+    name: str, rawtext: str, text: str, lineno: int, inliner: Any, options: Any = {}, content: Any = []
+) -> Tuple[List[nodes.reference], List[nodes.problematic]]:
     text = text.replace('\n', ' ')
     m = re.match(r'(.+)\s+<(.+?)>', text)
     if m is None:
@@ -404,7 +382,7 @@ def link_role(name: str, rawtext: str, text: str, lineno: int, inliner: Any, opt
 def expand_opt_references(conf_name: str, text: str) -> str:
     conf_name += '.'
 
-    def expand(m: Match) -> str:
+    def expand(m: Match[str]) -> str:
         ref = m.group(1)
         if '<' not in ref and '.' not in ref:
             full_ref = conf_name + ref
@@ -510,9 +488,27 @@ def write_conf_docs(app: Any, all_kitten_names: Iterable[str]) -> None:
         definition = get_kitten_conf_docs(kitten)
         if definition:
             generate_default_config(definition, f'kitten-{kitten}')
+
+    from kitty.actions import as_rst
+    with open('generated/actions.rst', 'w', encoding='utf-8') as f:
+        f.write(as_rst())
 # }}}
 
 
+def add_html_context(app: Any, pagename: str, templatename: str, context: Any, doctree: Any, *args: Any) -> None:
+    context['analytics_id'] = app.config.analytics_id
+    if 'toctree' in context:
+        # this is needed with furo to use all titles from pages
+        # in the sidebar (global) toc
+        original_toctee_function = context['toctree']
+
+        def include_sub_headings(**kwargs: Any) -> Any:
+            kwargs['titles_only'] = False
+            return original_toctee_function(**kwargs)
+
+        context['toctree'] = include_sub_headings
+
+
 def setup(app: Any) -> None:
     os.makedirs('generated/conf', exist_ok=True)
     from kittens.runner import all_kitten_names
@@ -520,10 +516,15 @@ def setup(app: Any) -> None:
     write_cli_docs(kn)
     write_remote_control_protocol_docs()
     write_conf_docs(app, kn)
-    app.add_css_file('custom.css')
+    app.add_config_value('analytics_id', '', 'env')
+    app.connect('html-page-context', add_html_context)
     app.add_lexer('session', SessionLexer() if version_info[0] < 3 else SessionLexer)
     app.add_role('link', link_role)
     app.add_role('iss', partial(num_role, 'issues'))
     app.add_role('pull', partial(num_role, 'pull'))
+    app.add_role('disc', partial(num_role, 'discussions'))
     app.add_role('commit', commit_role)
-    app.connect('html-page-context', add_html_context)
+    # monkey patch sphinx_inline_tabs to avoid a warning about parallel reads
+    # see https://github.com/pradyunsg/sphinx-inline-tabs/issues/26
+    inline_tabs = app.extensions['sphinx_inline_tabs']
+    inline_tabs.parallel_read_safe = inline_tabs.parallel_write_safe = True

docs/conf.rst

@@ -1,7 +1,5 @@
-:tocdepth: 2
-
-Configuring kitty
-===============================
+kitty.conf
+-----------------------
 
 .. highlight:: conf
 
@@ -11,8 +9,9 @@ possibilities.
 
 You can open the config file within kitty by pressing :sc:`edit_config_file`.
 You can reload the config file within kitty by pressing
-:sc:`reload_config_file` or sending kitty the ``SIGUSR1`` signal.  You can also
-display the current configuration by pressing the :sc:`debug_config` key.
+:sc:`reload_config_file` (:kbd:`⌃+⌘+,` on macOS) or sending kitty the ``SIGUSR1`` signal.
+You can also display the current configuration by pressing the :sc:`debug_config`
+(:kbd:`⌘+⌥+f6` on macOS) key.
 
 .. _confloc:
 
@@ -34,11 +33,15 @@ expanded, so :code:`${USER}.conf` becomes :file:`name.conf` if
      include other.conf
 
 
+.. note:: Syntax highlighting for :file:`kitty.conf` in vim is available via
+   `vim-kitty <https://github.com/fladson/vim-kitty>`_.
+
+
 .. include:: /generated/conf-kitty.rst
 
 
 Sample kitty.conf
-^^^^^^^^^^^^^^^^^^^^^
+--------------------
 
 .. only:: html
 
@@ -53,3 +56,14 @@ Sample kitty.conf
    file with full documentation and all settings commented out. If you
    have a pre-existing kitty.conf, then that will be used instead, delete
    it to see the sample file.
+
+
+All mappable actions
+------------------------
+
+See the :doc:`list of all the things you can make kitty can do </actions>`.
+
+.. toctree::
+   :hidden:
+
+   actions

docs/deccara.rst

@@ -0,0 +1,21 @@
+Setting text styles/colors in arbitrary regions of the screen
+------------------------------------------------------------------
+
+There already exists an escape code to set *some* text attributes in arbitrary
+regions of the screen, `DECCARA
+<https://vt100.net/docs/vt510-rm/DECCARA.html>`_.  However, it is limited to
+only a few attributes. |kitty| extends this to work with *all* SGR attributes.
+So, for example, this can be used to set the background color in an arbitrary
+region of the screen.
+
+The motivation for this extension is the various problems with the existing
+solution for erasing to background color, namely the *background color erase
+(bce)* capability. See
+`this discussion <https://github.com/kovidgoyal/kitty/issues/160#issuecomment-346470545>`_
+and `this FAQ <https://invisible-island.net/ncurses/ncurses.faq.html#bce_mismatches>`_
+for a summary of problems with *bce*.
+
+For example, to set the background color to blue in a
+rectangular region of the screen from (3, 4) to (10, 11), you use::
+
+    <ESC>[2*x<ESC>[4;3;11;10;44$r<ESC>[*x

docs/desktop-notifications.rst

@@ -0,0 +1,122 @@
+.. _desktop_notifications:
+
+
+Desktop notifications
+=======================
+
+|kitty| implements an extensible escape code (OSC 99) to show desktop
+notifications. It is easy to use from shell scripts and fully extensible to
+show title and body.  Clicking on the notification can optionally focus the
+window it came from, and/or send an escape code back to the application running
+in that window.
+
+The design of the escape code is partially based on the discussion in
+the defunct
+`terminal-wg <https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/13>`_
+
+The escape code has the form::
+
+    <OSC> 99 ; metadata ; payload <terminator>
+
+Here ``<OSC>`` is :code:`<ESC>]` and ``<terminator>`` is
+:code:`<ESC><backslash>`.  The metadata is a section of colon separated
+:code:`key=value` pairs. Every key must be a single character from the set
+:code:`a-zA-Z` and every value must be a word consisting of characters from
+the set :code:`a-zA-Z0-9-_/\+.,(){}[]*&^%$#@!`~`. The payload must be
+interpreted based on the metadata section. The two semi-colons *must* always be
+present even when no metadata is present.
+
+Before going into details, lets see how one can display a simple, single line
+notification from a shell script::
+
+    printf '\x1b]99;;Hello world\x1b\\'
+
+To show a message with a title and a body::
+
+    printf '\x1b]99;i=1:d=0;Hello world\x1b\\'
+    printf '\x1b]99;i=1:d=1:p=body;This is cool\x1b\\'
+
+The most important key in the metadata is the ``p`` key, it controls how the
+payload is interpreted. A value of ``title`` means the payload is setting the
+title for the notification. A value of ``body`` means it is setting the body,
+and so on, see the table below for full details.
+
+The design of the escape code is fundamentally chunked, this is because
+different terminal emulators have different limits on how large a single escape
+code can be. Chunking is accomplished by the ``i`` and ``d`` keys. The ``i``
+key is the *notification id* which can be any string containing the characters
+``[a-zA-Z0-9_-+.]``. The ``d`` key stands for *done* and
+can only take the values ``0`` and ``1``. A value of ``0`` means the
+notification is not yet done and the terminal emulator should hold off
+displaying it. A value of ``1`` means the notification is done, and should be
+displayed. You can specify the title or body multiple times and the terminal
+emulator will concatenate them, thereby allowing arbitrarily long text
+(terminal emulators are free to impose a sensible limit to avoid
+Denial-of-Service attacks).
+
+Both the ``title`` and ``body`` payloads must be either UTF-8 encoded plain
+text with no embedded escape codes, or UTF-8 text that is base64 encoded, in
+which case there must be an ``e=1`` key in the metadata to indicate the payload
+is base64 encoded.
+
+When the user clicks the notification, a couple of things can happen, the
+terminal emulator can focus the window from which the notification came, and/or
+it can send back an escape code to the application indicating the notification
+was activated. This is controlled by the ``a`` key which takes a comma
+separated set of values, ``report`` and ``focus``. The value ``focus`` means
+focus the window from which the notification was issued and is the default.
+``report`` means send an escape code back to the application. The format of the
+returned escape code is::
+
+    <OSC> 99 ; i=identifier ; <terminator>
+
+The value of ``identifier`` comes from the ``i`` key in the escape code sent by
+the application. If the application sends no identifier, then the terminal
+*must* use ``i=0``. Actions can be preceded by a negative sign to turn them
+off, so for example if you do not want any action, turn off the default
+``focus`` action with::
+
+    a=-focus
+
+Complete specification of all the metadata keys is in the table below. If a
+terminal emulator encounters a key in the metadata it does not understand,
+the key *must* be ignored, to allow for future extensibility of this escape
+code. Similarly if values for known keys are unknown, the terminal emulator
+*should* either ignore the entire escape code or perform a best guess effort
+to display it based on what it does understand.
+
+.. note::
+   It is possible to extend this escape code to allow specifying an icon for
+   the notification, however, given that some platforms, such as macOS, dont
+   allow displaying custom icons on a notification, at all, it was decided to
+   leave it out of the spec for the time being.
+
+   Similarly, features such as scheduled notifications could be added in future
+   revisions.
+
+
+=======  ====================  =========  =================
+Key      Value                 Default    Description
+=======  ====================  =========  =================
+``a``    Comma separated list  ``focus``  What action to perform when the
+         of ``report``,                   notification is clicked
+         ``focus``, with
+         optional leading
+         ``-``
+
+``d``    ``0`` or ``1``        ``1``      Indicates if the notification is
+                                          complete or not.
+
+``e``    ``0`` or ``1``        ``0``      If set to ``1`` means the payload is base64 encoded UTF-8,
+                                          otherwise it is plain UTF-8 text with no C0 control codes in it
+
+``i``    ``[a-zA-Z0-9-_+.]``   ``0``      Identifier for the notification
+
+``p``    One of ``title`` or   ``title``  Whether the payload is the notification title or body. If a
+         ``body``.                        notification has no title, the body will be used as title.
+=======  ====================  =========  =================
+
+
+.. note::
+   |kitty| also supports the legacy OSC 9 protocol developed by iTerm2 for
+   desktop notifications.

docs/faq.rst

@@ -3,9 +3,6 @@ Frequently Asked Questions
 
 .. highlight:: sh
 
-.. contents::
-   :local:
-
 Some special symbols are rendered small/truncated in kitty?
 -----------------------------------------------------------
 
@@ -36,7 +33,7 @@ it by adding the following to your vimrc::
 
     let &t_ut=''
 
-See :ref:`here <ext_styles>` for why |kitty| does not support background color erase.
+See :doc:`here <deccara>` for why |kitty| does not support background color erase.
 
 
 I get errors about the terminal being unknown or opening the terminal failing when SSHing into a different computer?
@@ -54,8 +51,12 @@ type it each time::
 
     alias ssh="kitty +kitten ssh"
 
+Remember to also setup :ref:`shell_integration` for completion and other
+niceties.
+
 If for some reason that does not work (typically because the server is using a
-non POSIX compliant shell), you can try using it with python instead::
+non POSIX compliant shell as ``/bin/sh``), you can try using it with ``python``
+instead::
 
     kitty +kitten ssh use-python myserver
 
@@ -119,9 +120,14 @@ explicitly set a UTF-8 locale, like::
 How do I change the colors in a running kitty instance?
 ------------------------------------------------------------
 
-You can either use the
-`OSC terminal escape codes <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Operating-System-Commands>`_
-to set colors or you can define keyboard shortcuts to set colors, for example::
+The easiest way to do it is to use the :doc:`themes kitten </kittens/themes>`,
+to choose a new color theme. Simply run::
+
+    kitty +kitten themes
+
+And choose your theme from the list.
+
+You can also define keyboard shortcuts to set colors, for example::
 
     map f1 set_colors --configured /path/to/some/config/file/colors.conf
 
@@ -129,10 +135,9 @@ Or you can enable :doc:`remote control <remote-control>` for |kitty| and use :re
 The shortcut mapping technique has the same syntax as the remote control
 command, for details, see :ref:`at_set-colors`.
 
-A list of pre-made color themes for kitty is available at:
-`kitty-themes <https://github.com/dexpota/kitty-themes>`_
-
-Examples of using OSC escape codes to set colors::
+Additionally, You can use the
+`OSC terminal escape codes <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Operating-System-Commands>`_
+to set colors. Examples of using OSC escape codes to set colors::
 
     Change the default foreground color:
     printf '\x1b]10;#ff0000\x1b\\'
@@ -187,13 +192,22 @@ If you do want to cat unknown data, use ``cat -v``.
 kitty is not able to use my favorite font?
 ---------------------------------------------
 
-|kitty| achieves its stellar performance by caching alpha masks of each rendered
-character on the GPU, so that every character needs to be rendered only once.
-This means it is a strictly character cell based display.  As such it can use
-only monospace fonts, since every cell in the grid has to be the same size.
+|kitty| achieves its stellar performance by caching alpha masks of each
+rendered character on the GPU, and rendering them all in parallel. This means
+it is a strictly character cell based display. As such it can use only
+monospace fonts, since every cell in the grid has to be the same size.
 Furthermore, it needs fonts to be freely resizable, so it does not support
 bitmapped fonts.
 
+.. note::
+   If you are trying to use a font patched with NERD font symbols, dont do that
+   as patching destroys fonts. There is no need, simply install the standalone
+   NERD font, kitty should pick up symbols from it automatically, and you can
+   tell it to do so explicitly in case it doesnt with the :opt:`symbol_map`
+   directive::
+
+        symbol_map U+23FB-U+23FE,U+2B58,U+E200-U+E2A9,U+E0A0-U+E0A3,U+E0B0-U+E0BF,U+E0C0-U+E0C8,U+E0CC-U+E0CF,U+E0D0-U+E0D2,U+E0D4,U+E700-U+E7C5,U+F000-U+F2E0,U+2665,U+26A1,U+F400-U+F4A8,U+F67C,U+E000-U+E00A,U+F300-U+F313,U+E5FA-U+E62B Symbols Nerd Font
+
 If your font is not listed in ``kitty list-fonts`` it means that it is not
 monospace or is a bitmapped font. On Linux you can list all monospace fonts with::
 
@@ -234,6 +248,37 @@ terminal) in different environments,
 see `here <https://github.com/kovidgoyal/kitty/issues/45>`_.
 
 
+I do not like the kitty icon!
+-------------------------------
+
+There are many alternate icons available, click on an icon to visit its
+homepage:
+
+.. image:: https://github.com/k0nserv/kitty-icon/raw/main/icon_512x512.png
+   :target: https://github.com/k0nserv/kitty-icon
+   :width: 256
+
+.. image:: https://github.com/DinkDonk/kitty-icon/raw/main/kitty-dark.png
+   :target: https://github.com/DinkDonk/kitty-icon
+   :width: 256
+
+.. image:: https://github.com/DinkDonk/kitty-icon/raw/main/kitty-light.png
+   :target: https://github.com/DinkDonk/kitty-icon
+   :width: 256
+
+.. image:: https://github.com/hristost/kitty-alternative-icon/raw/main/kitty_icon.png
+   :target: https://github.com/hristost/kitty-alternative-icon
+   :width: 256
+
+On macOS you can change the icon by following the steps:
+
+#. Find :file:`kitty.app` in the Applications folder, select it and press :kbd:`⌘+i`
+#. Drag :file:`kitty.icns` onto the application icon in the kitty info pane
+#. Delete the icon cache and restart Dock::
+
+    $ rm /var/folders/*/*/*/com.apple.dock.iconcache; killall Dock
+
+
 How do I map key presses in kitty to different keys in the terminal program?
 --------------------------------------------------------------------------------------
 
@@ -255,7 +300,7 @@ How do I open a new window or tab with the same working directory as the current
 In :file:`kitty.conf` add the following::
 
     map f1 launch --cwd=current
-    map f2  launch --cwd=current --type=tab
+    map f2 launch --cwd=current --type=tab
 
 Pressing :kbd:`F1` will open a new kitty window with the same working directory
 as the current window. The :doc:`launch command <launch>` is very powerful,
@@ -301,15 +346,14 @@ If you still want to use tmux, read on.
 Image display will not work, see `tmux issue
 <https://github.com/tmux/tmux/issues/1391>`_.
 
+Using ancient versions of tmux such as 1.8 will
+cause gibberish on screen when pressing keys (:iss:`3541`).
+
 If you are using tmux with multiple terminals or you start it under one
 terminal and then switch to another and these terminals have different TERM
 variables, tmux will break. You will need to restart it as tmux does not
 support multiple terminfo definitions.
 
-Copying to clipboard via OSC 52 will not work, because tmux does not support
-the extended version of that protocol, you will need to add ``no-append`` to
-:opt:`clipboard_control` in kitty.conf.
-
 If you use any of the advanced features that kitty has innovated, such as
 styled underlines, desktop notifications, extended keyboard support, etc.
 they may or may not work, depending on the whims of tmux's maintainer, your
@@ -351,3 +395,28 @@ remaining used memory can be investigated using valgrind again, and it will
 come from arenas in the GPU drivers and the per thread arenas glibc's malloc
 maintains. These too allocate memory in large blocks and dont release it back
 to the OS immediately.
+
+Why does kitty sometimes start slowly on my Linux system?
+-------------------------------------------------------------------------------------------
+
+|kitty| takes no longer (within 100ms) to start than other similar GPU terminal
+emulators, (and may be faster than some). If |kitty| occasionally takes a long
+time to start, it could be a power management issue with the graphics card. On
+a multi-GPU system (which many modern laptops are, having a power efficient GPU
+that's built into the processor and a power hungry dedicated one that's usually
+off), even if the answer of the GPU will only be "don't use me".
+
+For example, if you have a system with an AMD CPU and an NVIDIA GPU, and you
+know that you want to use the lower powered card to save battery life and
+because kitty does not require a powerful GPU to function, you can choose not
+to wake up the dedicated card, which has been reported on at least one system
+(:iss:`4292`) to take ≈2 seconds, by running |kitty| as::
+
+    MESA_LOADER_DRIVER_OVERRIDE=radeonsi __EGL_VENDOR_LIBRARY_FILENAMES=/usr/share/glvnd/egl_vendor.d/50_mesa.json kitty
+
+The correct command will depend on your situation and hardware.
+``__EGL_VENDOR_LIBRARY_FILENAMES`` instructs the GL dispatch library to use
+:file:`libEGL_mesa.so` and ignore :file:`libEGL_nvidia.so` also available on the
+system, which will wake the NVIDIA card during device enumeration.
+``MESA_LOADER_DRIVER_OVERRIDE`` also assures that Mesa won't offer any NVIDIA
+card during enumeration, and will instead just use `/lib/dri/radeonsi_dri.so`.

docs/file-transfer-protocol.rst

@@ -0,0 +1,535 @@
+File transfer over the TTY
+===============================
+
+There are sometimes situations where the TTY is the only convenient pipe
+between two connected systems, for example, nested SSH sessions, a serial
+line, etc. In such scenarios, it is useful to be able to transfer files
+over the TTY.
+
+This protocol provides the ability to transfer regular files, directories and
+links (both symbolic and hard) preserving most of their metadata. It can
+optionally use compression and transmit only binary diffs to speed up
+transfers. However, since all data is base64 encoded for transmission over the
+TTY, this protocol will never be competitive with more direct file transfer
+mechanisms.
+
+Overall design
+----------------
+
+The basic design of this protocol is around transfer "sessions". Since
+untrusted software should not be able to read/write to another machines
+filesystem, a session must be approved by the user in the terminal emulator
+before any actual data is transmitted, unless a :ref:`pre-shared password is
+provided <bypass_auth>`.
+
+There can be either send or receive sessions. In send sessions files are sent
+from remote client to the terminal emulator and vice versa for receive sessions.
+Every session basically consists of sending metadata for the files first and
+then sending the actual data. The session is a series of commands, every command
+carrying the session id (which should be a random unique-ish identifier, to
+avoid conflicts). The session is bi-directional with commands going both to and
+from the terminal emulator. Every command in a session also carries an
+``action`` field that specifies what the command does. The remaining fields in
+the command are dependent on the nature of the command.
+
+Let's look at some simple examples of sessions to get a feel for the protocol.
+
+
+Sending files to the computer running the terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The client starts by sending a start send command::
+
+    → action=send id=someid
+
+It then waits for a status message from the terminal either
+allowing the transfer or refusing it. Until this message is received
+the client is not allowed to send any more commands for the session.
+The terminal emulator should drop a session if it receives any commands
+before sending an ``OK`` response. If the user accepts the transfer,
+the terminal will send::
+
+    ← action=status id=someid status=OK
+
+Or if the transfer is refused::
+
+    ← action=status id=someid status=EPERM:User refused the transfer
+
+The client then sends one or more ``file`` commands with the metadata of the file it wants
+to transfer::
+
+    → action=file id=someid file_id=f1 name=/path/to/destination
+    → action=file id=someid file_id=f2 name=/path/to/destination2 ftype=directory
+
+The terminal responds with either ``OK`` for directories or ``STARTED`` for
+files::
+
+    ← action=status id=someid file_id=f1 status=STARTED
+    ← action=status id=someid file_id=f2 status=OK
+
+If there was an error with the file, for example, if the terminal does not have
+permission to write to the specified location, it will instead respond with an
+error, such as::
+
+    ← action=status id=someid file_id=f1 status=EPERM:No permission
+
+The client sends data for files using ``data`` commands. It does not need to
+wait for the ``STARTED`` from the terminal for this, the terminal must discard data
+for files that are not ``STARTED``. Data for a file is sent in individual
+chunks of no larger than ``4096`` bytes. For example::
+
+
+    → action=data id=someid file_id=f1 data=chunk of bytes
+    → action=data id=someid file_id=f1 data=chunk of bytes
+    ...
+    → action=end_data id=someid file_id=f1 data=chunk of bytes
+
+The sequence of data transmission for a file is ended with an ``end_data``
+command. After each data packet is received the terminal replies with
+an acknowledgement of the form::
+
+    ← action=status id=someid file_id=f1 status=PROGRESS size=bytes written
+
+After ``end_data`` the terminal replies with::
+
+    ← action=status id=someid file_id=f1 status=OK size=bytes written
+
+If an error occurs while writing the data, the terminal replies with an error
+code and ignores further commands about that file, for example::
+
+    ← action=status id=someid file_id=f1 status=EIO:Failed to write to file
+
+Once the client has finished sending as many files as it wants to, it ends
+the session with::
+
+    → action=finish id=someid
+
+At this point the terminal commits the session, applying file metadata,
+creating links, etc. If any errors occur it responds with an error message,
+such as::
+
+    ← action=status id=someid status=Some error occurred
+
+
+Receiving files from the computer running terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The client starts by sending a start receive command::
+
+    → action=receive id=someid size=num_of_paths
+
+It then sends a list of ``num_of_paths`` paths it is interested in
+receiving::
+
+    → action=file id=someid file_id=f1 name=/some/path
+    → action=file id=someid file_id=f2 name=/some/path2
+    ...
+
+The client must then wait for responses from the terminal emulator. It
+is an error to send anymore commands to to the terminal until an ``OK``
+response is received from the terminal. The terminal wait for the user to accept
+the request. If accepted, it sends::
+
+    ← action=status id=someid status=OK
+
+If permission is denied it sends::
+
+    ← action=status id=someid status=EPERM:User refused the transfer
+
+The terminal then sends the metadata for all requested files. If any of them
+are directories, it traverses the directories recursively, listing all files.
+Note that symlinks must not be followed, but sent as symlinks::
+
+    ← action=file id=someid file_id=f1 mtime=XXX permissions=XXX name=/absolute/path status=file_id1 size=size_in_bytes file_type=type parent=file_id of parent
+    ← action=file id=someid file_id=f1 mtime=XXX permissions=XXX name=/absolute/path2 status=file_id2 size=size_in_bytes file_type=type parent=file_id of parent
+    ...
+
+Here the ``file_id`` field is set to the ``file_id`` value sent from the client
+and the ``status`` field is set to the actual file id for each file. This is
+because a file query sent from the client can result in multiple actual files if
+it is a directory. The ``parent`` field is the actual ``file_id`` of the directory
+containing this file and is set for entries that are generated from client
+requests that match directories. This allows the client to build an unambiguous picture
+of the file tree.
+
+Once all the files are listed, the terminal sends an ``OK`` response that also
+specifies the absolute path to the home directory for the user account running
+the terminal::
+
+    ← action=status id=someid status=OK name=/path/to/home
+
+If an error occurs while listing any of the files asked for by the client,
+the terminal will send an error response like::
+
+    ← action=status id=someid file_id=f1 status=ENOENT: Does not exist
+
+Here, ``file_id`` is the same as was sent by the client in its initial query.
+
+Now, the client can send requests for file data using the paths sent by the
+terminal emulator::
+
+    → action=file id=someid file_id=f1 name=/some/path
+    ...
+
+The terminal emulator replies with the data for the files, as a sequence of
+``data`` commands each with a chunk of data no larger than ``4096`` bytes,
+for each file (the terminal emulator should send the data for
+one file at a time)::
+
+
+    ← action=data id=someid file_id=f1 data=chunk of bytes
+    ...
+    ← action=end_data id=someid file_id=f1 data=chunk of bytes
+
+If any errors occur reading file data, the terminal emulator sends an error
+message for the file, for example::
+
+    ← action=status id=someid file_id=f1 status=EIO:Could not read
+
+Once the client is done reading data for all the files it expects, it
+terminates the session with::
+
+    → action=finished id=someid
+
+Canceling a session
+----------------------
+
+A client can decide to cancel a session at any time (for example if the user
+presses :kbd:`ctrl+c`). To cancel a session it sends a ``cancel`` action to the
+terminal emulator::
+
+    → action=cancel id=someid
+
+The terminal emulator drops the session and sends a cancel acknowledgement::
+
+    ← action=status id=someid status=CANCELED
+
+The client **must** wait for the canceled response from the emulator discarding
+any other responses till the cancel is received. If it does not wait, after
+it quits the responses might end up being printed to screen.
+
+Quieting responses from the terminal
+-------------------------------------
+
+The above protocol includes lots of messages from the terminal acknowledging
+receipt of data, granting permission etc., acknowledging cancel requests, etc.
+For extremely simple clients like shell scripts, it might be useful to suppress
+these responses, which can be done by adding the ``quiet`` key to the start
+session command::
+
+    → action=send id=someid quiet=1
+
+The key can take the values ``1`` - meaning suppress acknowledgement responses
+or ``2`` - meaning suppress all responses including errors. Only actual data
+responses are sent. Note that in particular this means acknowledgement of
+permission for the transfer to go ahead is suppressed, so this is typically
+useful only with :ref:`bypass_auth`.
+
+.. _file_metadata:
+
+File metadata
+-----------------
+
+File metadata includes file paths, permissions and modification times. They are
+somewhat tricky as different operating systems support different kinds of
+metadata. This specification defines a common minimum set which should work
+across most operating systems.
+
+File paths
+    File paths must be valid UTF-8 encoded POSIX paths (i.e. using the forward slash
+    ``/`` as a separator). Linux systems allow non UTF-8 file paths, these
+    are not supported. A leading ``~/`` means a path is relative to the
+    ``HOME`` directory. All path must be either absolute (i.e. with a leading
+    ``/``) or relative to the HOME directory. Individual components of the
+    path must be no longer than 255 UTF-8 bytes. Total path length must be no
+    more than 4096 bytes. Paths from Windows systems must use the forward slash
+    as the separator, the first path component must be the drive letter with a
+    colon. For example: :file:`C:\some\file.txt` is represented as
+    :file:`/C:/some/file.txt`. For maximum portability, the following
+    characters *should* be omitted from paths (however implementations are free
+    to try to support them returning errors for non-representable paths)::
+
+        \ * : < > ? | /
+
+File modification times
+    Must be represented as the number of nanoseconds since the UNIX epoch. An
+    individual file system may not store file metadata with this level of
+    accuracy in which case it should use the closest possible approximation.
+
+File permissions
+    Represented as a number with the usual UNIX read, write and execute bits.
+    In addition, the sticky, set-group-id and set-user-id bits may be present.
+    Implementations should make a best effort to preserve as many bits as
+    possible. On Windows, there is only a read-only bit. When reading file
+    metadata all the ``WRITE`` bits should be set if the read only bit is clear
+    and cleared if it is set. When writing files, the read-only bit should be
+    set if the bit indicating write permission for the user is clear. The other
+    UNIX bits must be ignored when writing. When reading, all the ``READ`` bits
+    should always be set and all the ``EXECUTE`` bits should be set if the file is
+    directly executable by the Windows Operating system. There is no attempt to
+    map Window's ACLs to permission bits.
+
+
+Symbolic and hard links
+---------------------------
+
+Symbolic and hard links can be preserved by this protocol.
+
+.. note::
+   In the following when target paths of symlinks are sent as actual paths, they must be
+   encoded in the same way as discussed in :ref:`file_metadata`. It is up to
+   the receiving side to translate them into appropriate paths for the local
+   operating system. This may not always be possible, in which case either the
+   symlink should not be created or a broken symlink should be created.
+
+
+Sending links to the terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When sending files to the terminal emulator, the file command has the form::
+
+    → action=file id=someid file_id=f1 name=/path/to/link file_type=link
+    → action=file id=someid file_id=f2 name=/path/to/symlink file_type=symlink
+
+Then, when the client is sending data for the files, for hardlinks, the data
+will be the ``file_id`` of the target file (assuming the target file is also
+being transmitted, otherwise the hard link should be transmitted as a plain
+file)::
+
+    → action=end_data id=someid file_id=f1 data=target_file_id_encoded_as_utf8
+
+For symbolic links, the data is a little more complex. If the symbolic link is
+to a destination being transmitted, the data has the form::
+
+    → action=end_data id=someid file_id=f1 data=fid:target_file_id_encoded_as_utf8
+    → action=end_data id=someid file_id=f1 data=fid_abs:target_file_id_encoded_as_utf8
+
+The ``fid_abs`` form is used if the symlink uses an absolute path, ``fid`` if
+it uses a relative path. If the symlink is to a destination that is not being
+transmitted, then the prefix ``path:`` and the actual path in the symlink is
+transmitted.
+
+Receiving links from the terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When receiving files from the terminal emulator, link data is transmitted in
+two parts. First when the emulator sends the initial file listing to the
+client, the ``file_type`` is set to the link type and the ``data`` field is set
+to file_id of the target file if the target file is included in the listing.
+For example::
+
+    ← action=file id=someid file_id=f1 status=file_id1 ...
+    ← action=file id=someid file_id=f1 status=file_id2 file_type=symlink data=file_id1 ...
+
+Here the rest of the metadata has been left out for clarity. Notice that the
+second file is symlink whose ``data`` field is set to the file id of the first
+file (the value of the ``status`` field of the first file). The same technique
+is used for hard links.
+
+The client should not request data for hard links, instead creating them
+directly after transmission is complete. For symbolic links the terminal
+must send the actual symbolic link target as a UTF-8 encoded path in the
+data field. The client can use this path either as-is (when the target is not
+a transmitted file) or to decide whether to create the symlink with a relative
+or absolute path when the target is a transmitted file.
+
+
+Transmitting binary deltas
+-----------------------------
+
+Repeated transfer of large files that have only changed a little between
+the receiving and sending side can be sped up significantly by transmitting
+binary deltas of only the changed portions. This protocol has built-in support
+for doing that. This support uses the `rsync algorithm
+<https://github.com/librsync/librsync>`__. In this algorithm first the
+receiving side sends a file signature that contains hashes of blocks
+in the file. Then the sending side sends only those blocks that have changed.
+The receiving side applies these deltas to the file to update it till it matches
+the file on the sending side.
+
+The modification to the basic protocol consists of setting the
+``transmission_type`` key to ``rsync`` when requesting a file. This triggers
+transmission of signatures and deltas instead of file data. The details are
+different for sending and receiving.
+
+Sending to the terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When sending the metadata of the file it wants to transfer, the client adds the
+``transmission_type`` key::
+
+    → action=file id=someid file_id=f1 name=/path/to/destination transmission_type=rsync
+
+The ``STARTED`` response from the terminal will have ``transmission_type`` set
+to ``rsync`` if the file exists and the terminal is able to send signature data::
+
+    ← action=status id=someid file_id=f1 status=STARTED transmission_type=rsync
+
+The terminal then transmits the signature using ``data`` commands::
+
+    ← action=data id=someid file_id=f1 data=...
+    ...
+    ← action=end_data id=someid file_id=f1 data=...
+
+Once the client receives and processes the full signature, it transmits the
+file delta to the terminal as ``data`` commands::
+
+    → action=data id=someid file_id=f1 data=...
+    → action=data id=someid file_id=f1 data=...
+    ...
+    → action=end_data id=someid file_id=f1 data=...
+
+The terminal then uses this delta to update the file.
+
+Receiving from the terminal emulator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When the client requests file data from the terminal emulator, it can
+add the ``transmission_type=rsync`` key to indicate it will be sending
+a signature for that file::
+
+    → action=file id=someid file_id=f1 name=/some/path transmission_type=rsync
+
+The client then sends the signature using ``data`` commands::
+
+    → action=data id=someid file_id=f1 data=...
+    ...
+    → action=end_data id=someid file_id=f1 data=...
+
+After receiving the signature the terminal replies with the delta as a series
+of ``data`` commands::
+
+    ← action=data id=someid file_id=f1 data=...
+    ...
+    ← action=end_data id=someid file_id=f1 data=...
+
+The client then uses this delta to update the file.
+
+The format of signatures and deltas
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+These come from `librsync <https://github.com/librsync/librsync>`__. If this
+specification gains wider adoption, these formats should be documented here.
+
+Compression
+--------------
+
+Individual files can be transmitted compressed if needed.
+Currently, only :rfc:`1950` ZLIB based deflate compression is
+supported, which is specified using the ``compression=zlib`` key when
+requesting a file. For example when sending files to the terminal emulator,
+when sending the file metadata the ``compression`` key can also be
+specified::
+
+    → action=file id=someid file_id=f1 name=/path/to/destination compression=zlib
+
+Similarly when receiving files from the terminal emulator, the final file
+command that the client sends to the terminal requesting the start of the
+transfer of data for the file can include the ``compression`` key::
+
+    → action=file id=someid file_id=f1 name=/some/path compression=zlib
+
+.. _bypass_auth:
+
+Bypassing explicit user authorization
+------------------------------------------
+
+In order to bypass the requirement of interactive user authentication,
+this protocol has the ability to use a pre-shared secret (password).
+When initiating a transfer session the client sends a hash of the password and
+the session id::
+
+    → action=send id=someid bypass=sha256:hash_value
+
+For example, suppose that the session id is ``mysession`` and the
+shared secret is ``mypassword``. Then the value of the ``bypass``
+key above is ``sha256:SHA256("mysession" + ";" + "mypassword")``, which
+is::
+
+    → action=send id=mysession bypass=sha256:192bd215915eeaa8c2b2a4c0f8f851826497d12b30036d8b5b1b4fc4411caf2c
+
+The value of ``bypass`` is of the form ``hash_function_name : hash_value``
+(without spaces). Currently, only the SHA256 hash function is supported.
+
+.. warning::
+   Hashing does not effectively hide the value of the password. So this
+   functionality should only be used in secure/trusted contexts. While there
+   exist hash functions harder to compute than SHA256, they are unsuitable as
+   they will introduce a lot of latency to starting a session and in any case
+   there is no mathematical proof that **any** hash function is not brute-forceable.
+
+Encoding of transfer commands as escape codes
+------------------------------------------------
+
+Transfer commands are encoded as ``OSC`` escape codes of the form::
+
+    <OSC> 5113 ; key=value ; key=value ... <ST>
+
+Here ``OSC`` is the bytes ``0x1b 0x5d`` and ``ST`` is the bytes
+``0x1b 0x5c``. Keys are words containing only the characters ``[a-zA-Z0-9_]``
+and ``value`` is arbitrary data, whose encoding is dependent on the value of
+``key``. Unknown keys **must** be ignored when decoding a command.
+The number ``5113`` is a constant and is unused by any known OSC codes. It is
+the numeralization of the word ``file``.
+
+
+.. table:: The keys and value types for this protocol
+    :align: left
+
+    ================= ======== ============== =======================================================================
+    Key               Key name Value type     Notes
+    ================= ======== ============== =======================================================================
+    action            ac       enum           send, file, data, end_data, receive, cancel, status, finish
+    compression       zip      enum           none, zlib
+    file_type         ft       enum           regular, directory, symlink, link
+    transmission_type tt       enum           simple, rsync
+    id                id       safe_string    A unique-ish value, to avoid collisions
+    file_id           fid      safe_string    Must be unique per file in a session
+    bypass            pw       safe_string    hash of the bypass password and the session id
+    quiet             q        integer        0 - verbose, 1 - only errors, 2 - totally silent
+    mtime             mod      integer        the modification time of file in nanoseconds since the UNIX epoch
+    permissions       prm      integer        the UNIX file permissions bits
+    size              sz       integer        size in bytes
+    name              n        base64_string  The path to a file
+    status            st       base64_string  Status messages
+    parent            pr       safe_string    The file id of the parent directory
+    data              d        base64_bytes   Binary data
+    ================= ======== ============== =======================================================================
+
+The ``Key name`` is the actual serialized name of the key sent in the escape
+code. So for example, ``permissions=123`` is serialized as ``prm=123``. This
+is done to reduce overhead.
+
+The value types are:
+
+enum
+    One from a permitted set of values, for example::
+
+        ac=file
+
+safe_string
+    A string consisting only of characters from the set ``[0-9a-zA-Z_:.,/!@#$%^&*()[]{}~`?"'\\|=+-]``
+    Note that the semi-colon is missing from this set.
+
+integer
+    A base-10 number composed of the characters ``[0-9]`` with a possible
+    leading ``-`` sign
+
+base64_string
+    A base64 encoded UTF-8 string using the standard base64 encoding
+
+base64_bytes
+    Binary data encoded using the standard base64 encoding
+
+
+An example of serializing an escape code is shown below::
+
+    action=send id=test name=somefile size=3 data=01 02 03
+
+becomes::
+
+    <OSC> 5113 ; ac=send ; id=test ; n=c29tZWZpbGU= ; sz=3 ; d=AQID <ST>
+
+Here ``c29tZWZpbGU`` is the base64 encoded form of somefile and ``AQID`` is the
+base64 encoded form of the bytes ``0x01 0x02 0x03``. The spaces in the encoded
+form are present for clarity and should be ignored.

docs/glossary.rst

@@ -0,0 +1,161 @@
+:orphan:
+
+Glossary
+=========
+
+.. glossary::
+
+   os_window
+     kitty has two kinds of windows. Operating System windows, refered to as :term:`OS
+     Window <os_window>`, and *kitty windows*. An OS Window consists of one or more kitty
+     :term:`tabs <tab>`. Each tab in turn consists of one or more *kitty
+     windows* organized in a :term:`layout`.
+
+   tab
+     A *tab* refers to a group of :term:`kitty windows <window>`, organized in
+     a :term:`layout`. Every :term:`OS Window <os_window>` contains one or more tabs.
+
+   layout
+     A *layout* is a system of organizing :term:`kitty windows <window>` in
+     groups inside a tab. The layout automatically maintains the size and
+     position of the windows, think of a layout as a tiling window manager for
+     the terminal. See :doc:`layouts` for details.
+
+   window
+     kitty has two kinds of windows. Operating System windows, refered to as :term:`OS
+     Window <os_window>`, and *kitty windows*. An OS Window consists of one or more kitty
+     :term:`tabs <tab>`. Each tab in turn consists of one or more *kitty
+     windows* organized in a :term:`layout`.
+
+   overlay
+      An *overlay window* is a :term:`kitty window <window>` that is placed on
+      top of an existing kitty window, entirely covering it. Overlays are used
+      throught kitty, for example, to display the :ref:`the scrollback buffer <scrollback>`,
+      to display :doc:`hints </kittens/hints>`, for :doc:`unicode input
+      </kittens/unicode_input>` etc.
+
+   hyperlinks
+      Terminals can have hyperlinks, just like the internet. In kitty you can
+      :doc:`control exactly what happens <open_actions>` when clicking on a
+      hyperlink, based on the type of link and its URL.
+
+.. _env_vars:
+
+Environment variables
+------------------------
+
+Variables that influence kitty behavior
+
+.. envvar:: KITTY_CONFIG_DIRECTORY
+
+   Controls where kitty looks for :file:`kitty.conf` and other configuration
+   files. Defaults to :file:`~/.config/kitty`. For full details of the config
+   directory lookup mechanism see, :option:`kitty --config`.
+
+.. envvar:: KITTY_CACHE_DIRECTORY
+
+   Controls where kitty stores cache files. Defaults to :file:`~/.cache/kitty`
+   or :file:`~/Library/Caches/kitty` on macOS.
+
+.. envvar:: VISUAL
+
+   The terminal editor (such as ``vi`` or ``nano``) kitty uses, when, for
+   instance, opening :file:`kitty.conf` in response to :sc:`edit_config_file`.
+
+
+.. envvar:: EDITOR
+
+   Same as :envvar:`VISUAL`. Used if :envvar:`VISUAL` is not set.
+
+.. envvar:: GLFW_IM_MODULE
+
+   Set this to ``ibus`` to enable support for IME under X11.
+
+.. envvar:: KITTY_WAYLAND_DETECT_MODIFIERS
+
+   When set to a non-empty value, kitty attempts to autodiscover XKB modifiers
+   under Wayland. This is useful if using non-standard modifers like hyper. It
+   is possible for the autodiscovery to fail; the default Wayland XKB mappings
+   are used in this case. See :pull:`3943` for details.
+
+
+Variables that kitty sets when running child programs
+
+.. envvar:: LANG
+
+   This is set only on macOS, and only if the country and language from the
+   macOS user settings form a valid locale.
+
+
+.. envvar:: KITTY_WINDOW_ID
+
+   An integer that is the id for the kitty :term:`window` the program is running in.
+   Can be used with the :doc:`kitty remote control facility <remote-control>`.
+
+
+.. envvar:: KITTY_PID
+
+   An integer that is the process id for the kitty process in which the program
+   is running. Allows programs to tell kitty to reload its config by sending it
+   the SIGUSR1 signal.
+
+
+.. envvar:: WINDOWID
+
+   The id for the :term:`OS Window <os_window>` the program is running in. Only available
+   on platforms that have ids for their windows, such as X11 and macOS.
+
+
+.. envvar:: TERM
+
+   The name of the terminal, defaults to ``xterm-kitty``. See :opt:`term`.
+
+
+.. envvar:: TERMINFO
+
+   Path to a directory containing the kitty terminfo database.
+
+
+.. envvar:: KITTY_INSTALLATION_DIR
+
+   Path to the kitty installation directory.
+
+
+.. envvar:: COLORTERM
+
+   Set to the value ``truecolor`` to indicate that kitty supports 16 million
+   colors.
+
+
+.. envvar:: KITTY_LISTEN_ON
+
+   Set when the :doc:`remote control <remote-control>` facility is enabled and
+   the a socket is used for control via :option:`kitty --listen-on` or :opt:`listen_on`.
+   Contains the path to the socket. Avoids needs to use :option:`kitty @ --to` when
+   issuing remote control commands.
+
+
+.. envvar:: KITTY_PIPE_DATA
+
+   Set to data describing the layout of the screen when running child
+   programs using :option:`launch --stdin-source` with the contents of the
+   screen/scrollback piped to them.
+
+
+.. envvar:: KITTY_CHILD_CMDLINE
+
+   Set to the command line of the child process running in the kitty
+   window when calling the notification callback program on terminal bell, see
+   :opt:`command_on_bell`.
+
+
+.. envvar:: KITTY_COMMON_OPTS
+
+   Set with the values of some common kitty options when running
+   kittens, so kittens can use them without needing to load kitty.conf.
+
+
+.. envvar:: KITTY_SHELL_INTEGRATION
+
+   Set when enabling :ref:`shell_integration`. It is automatically removed by
+   the shell integration scripts.

docs/graphics-protocol.rst

@@ -1,18 +1,16 @@
-:tocdepth: 3
-
-The terminal graphics protocol
-==================================
+Terminal graphics protocol
+=================================
 
 The goal of this specification is to create a flexible and performant protocol
 that allows the program running in the terminal, hereafter called the *client*,
 to render arbitrary pixel (raster) graphics to the screen of the terminal
-emulator. The major design goals are
+emulator. The major design goals are:
 
- * Should not require terminal emulators to understand image formats.
- * Should allow specifying graphics to be drawn at individual pixel positions.
- * The graphics should integrate with the text, in particular it should be possible to draw graphics
-   below as well as above the text, with alpha blending. The graphics should also scroll with the text, automatically.
- * Should use optimizations when the client is running on the same computer as the terminal emulator.
+* Should not require terminal emulators to understand image formats.
+* Should allow specifying graphics to be drawn at individual pixel positions.
+* The graphics should integrate with the text, in particular it should be possible to draw graphics
+  below as well as above the text, with alpha blending. The graphics should also scroll with the text, automatically.
+* Should use optimizations when the client is running on the same computer as the terminal emulator.
 
 For some discussion regarding the design choices, see `#33
 <https://github.com/kovidgoyal/kitty/issues/33>`_.
@@ -30,23 +28,25 @@ alpha-blending and text over graphics.
 
 Some programs and libraries that use the kitty graphics protocol:
 
- * `termpdf.py <https://github.com/dsanson/termpdf.py>`_ - a terminal PDF/DJVU/CBR viewer
- * `ranger <https://github.com/ranger/ranger>`_ - a terminal file manager, with
-   image previews, see this `PR <https://github.com/ranger/ranger/pull/1077>`_
- * :doc:`kitty-diff <kittens/diff>` - a side-by-side terminal diff program with support for images
- * `pixcat <https://github.com/mirukana/pixcat>`_ - a third party CLI and python library that wraps the graphics protocol
- * `neofetch <https://github.com/dylanaraps/neofetch>`_ - A command line system
-   information tool
- * `viu <https://github.com/atanunq/viu>`_ - a terminal image viewer
- * `glkitty <https://github.com/michaeljclark/glkitty>`_ - C library to draw OpenGL shaders in the terminal with a glgears demo
- * `ctx.graphics <https://ctx.graphics/>`_ - Library for drawing graphics
- * `timg <https://github.com/hzeller/timg>`_ - a terminal image and video viewer
- * `notcurses <https://github.com/dankamongmen/notcurses>`_ - C library for terminal graphics with bindings for C++, Rust and Python
- * `rasterm <https://github.com/BourgeoisBear/rasterm>`_  - Go library to display images in the the terminal
+* `termpdf.py <https://github.com/dsanson/termpdf.py>`_ - a terminal PDF/DJVU/CBR viewer
+* `ranger <https://github.com/ranger/ranger>`_ - a terminal file manager, with
+  image previews, see this `PR <https://github.com/ranger/ranger/pull/1077>`_
+* :doc:`kitty-diff <kittens/diff>` - a side-by-side terminal diff program with support for images
+* `pixcat <https://github.com/mirukana/pixcat>`_ - a third party CLI and python library that wraps the graphics protocol
+* `neofetch <https://github.com/dylanaraps/neofetch>`_ - A command line system
+  information tool
+* `viu <https://github.com/atanunq/viu>`_ - a terminal image viewer
+* `glkitty <https://github.com/michaeljclark/glkitty>`_ - C library to draw OpenGL shaders in the terminal with a glgears demo
+* `ctx.graphics <https://ctx.graphics/>`_ - Library for drawing graphics
+* `timg <https://github.com/hzeller/timg>`_ - a terminal image and video viewer
+* `notcurses <https://github.com/dankamongmen/notcurses>`_ - C library for terminal graphics with bindings for C++, Rust and Python
+* `rasterm <https://github.com/BourgeoisBear/rasterm>`_  - Go library to display images in the terminal
+* `chafa <https://github.com/hpjansson/chafa>`_  - a terminal image viewer
+* `hologram.nvim <https://github.com/edluffy/hologram.nvim>`_  - view images inside nvim
 
+Other terminals that have implemented the graphics protocol:
 
-.. contents::
-   :local:
+* `WezTerm <https://github.com/wez/wezterm/issues/986>`_
 
 
 Getting the window size
@@ -57,28 +57,33 @@ client must be able to get the window size in pixels and the number of cells
 per row and column. This can be done by using the ``TIOCGWINSZ`` ioctl.  Some
 code to demonstrate its use
 
-In C:
+.. tab:: C
 
-.. code-block:: c
+    .. code-block:: c
 
-    #include <stdio.h>
-    #include <sys/ioctl.h>
+        #include <stdio.h>
+        #include <sys/ioctl.h>
 
-    int main(int argc, char **argv) {
-        struct winsize sz;
-        ioctl(0, TIOCGWINSZ, &sz);
-        printf("number of rows: %i, number of columns: %i, screen width: %i, screen height: %i\n", sz.ws_row, sz.ws_col, sz.ws_xpixel, sz.ws_ypixel);
-        return 0;
-    }
+        int main(int argc, char **argv) {
+            struct winsize sz;
+            ioctl(0, TIOCGWINSZ, &sz);
+            printf(
+                "number of rows: %i, number of columns: %i, screen width: %i, screen height: %i\n",
+                sz.ws_row, sz.ws_col, sz.ws_xpixel, sz.ws_ypixel);
+            return 0;
+        }
 
-In Python:
 
-.. code-block:: python
+.. tab:: Python
 
-    import array, fcntl, sys, termios
-    buf = array.array('H', [0, 0, 0, 0])
-    fcntl.ioctl(sys.stdout, termios.TIOCGWINSZ, buf)
-    print('number of rows: {}, number of columns: {}, screen width: {}, screen height: {}'.format(*buf))
+    .. code-block:: python
+
+        import array, fcntl, sys, termios
+        buf = array.array('H', [0, 0, 0, 0])
+        fcntl.ioctl(sys.stdout, termios.TIOCGWINSZ, buf)
+        print((
+            'number of rows: {} number of columns: {}'
+            'screen width: {} screen height: {}').format(*buf))
 
 Note that some terminals return ``0`` for the width and height values. Such
 terminals should be modified to return the correct values.  Examples of
@@ -98,32 +103,36 @@ features of the graphics protocol:
 
 .. code-block:: python
 
-   import sys
-   from base64 import standard_b64encode
+    import sys
+    from base64 import standard_b64encode
 
-   def serialize_gr_command(cmd, payload=None):
-      cmd = ','.join('{}={}'.format(k, v) for k, v in cmd.items())
-      ans = []
-      w = ans.append
-      w(b'\033_G'), w(cmd.encode('ascii'))
-      if payload:
-         w(b';')
-         w(payload)
-      w(b'\033\\')
-      return b''.join(ans)
 
-   def write_chunked(cmd, data):
-      data = standard_b64encode(data)
-      while data:
-         chunk, data = data[:4096], data[4096:]
-         m = 1 if data else 0
-         cmd['m'] = m
-         sys.stdout.buffer.write(serialize_gr_command(cmd, chunk))
-         sys.stdout.flush()
-         cmd.clear()
+    def serialize_gr_command(**cmd):
+        payload = cmd.pop('payload', None)
+        cmd = ','.join('{}={}'.format(k, v) for k, v in cmd.items())
+        ans = []
+        w = ans.append
+        w(b'\033_G'), w(cmd.encode('ascii'))
+        if payload:
+            w(b';')
+            w(payload)
+        w(b'\033\\')
+        return b''.join(ans)
 
-   with open(sys.argv[-1], 'rb') as f:
-      write_chunked({'a': 'T', 'f': 100}, f.read())
+
+    def write_chunked(**cmd):
+        data = standard_b64encode(cmd.pop('data'))
+        while data:
+            chunk, data = data[:4096], data[4096:]
+            m = 1 if data else 0
+            sys.stdout.buffer.write(serialize_gr_command(payload=chunk, m=m,
+                                                        **cmd))
+            sys.stdout.flush()
+            cmd.clear()
+
+
+    with open(sys.argv[-1], 'rb') as f:
+        write_chunked(a='T', f=100, data=f.read())
 
 
 Save this script as :file:`png.py`, then you can use it to display any PNG
@@ -220,20 +229,25 @@ and can take the values:
 Value of `t`          Meaning
 ==================    ============
 ``d``                 Direct (the data is transmitted within the escape code itself)
-``f``                 A simple file
+``f``                 A simple file (regular files only, not named pipes or similar)
 ``t``                 A temporary file, the terminal emulator will delete the file after reading the pixel data. For security reasons
                       the terminal emulator should only delete the file if it
                       is in a known temporary directory, such as :file:`/tmp`,
                       :file:`/dev/shm`, :file:`TMPDIR env var if present` and any platform
                       specific temporary directories.
-``s``                 A *shared memory object*, which on POSIX systems is a `POSIX shared memory object
-                      <http://man7.org/linux/man-pages/man7/shm_overview.7.html>`_ and on Windows is a
+``s``                 A *shared memory object*, which on POSIX systems is a
+                      `POSIX shared memory object <https://pubs.opengroup.org/onlinepubs/9699919799/functions/shm_open.html>`_
+                      and on Windows is a
                       `Named shared memory object <https://docs.microsoft.com/en-us/windows/win32/memory/creating-named-shared-memory>`_.
                       The terminal emulator must read the data from the memory
                       object and then unlink and close it on POSIX and just
                       close it on Windows.
 ==================    ============
 
+When opening files, the terminal emulator must follow symlinks. In case of
+symlink loops or too many symlinks, it should fail and respond with an error,
+similar to reporting any other kind of I/O error.
+
 Local client
 ^^^^^^^^^^^^^^
 
@@ -312,9 +326,9 @@ use the *query action*, set ``a=q``. Then the terminal emulator will try to load
 the image and respond with either OK or an error, as above, but it will not
 replace an existing image with the same id, nor will it store the image.
 
-While as of May 2020, kitty is the only terminal emulator to support this
-graphics protocol, we intend that any terminal emulator that wishes to support
-it can. To check if a terminal emulator supports the graphics protocol the best way
+As of September 2021, kitty and WezTerm are the only terminal emulators to support this
+graphics protocol. We intend that any terminal emulator that wishes to support
+it can do so. To check if a terminal emulator supports the graphics protocol the best way
 is to send the above *query action* followed by a request for the
 `primary device attributes <https://vt100.net/docs/vt510-rm/DA1.html>`_. If you
 get back an answer for the device attributes without getting back an answer for
@@ -590,7 +604,7 @@ Clients can control animations by using the ``a=a`` key in the escape code sent
 to the terminal.
 
 The simplest is client driven animations, where the client transmits the frame
-data and the also instructs the terminal to make a particular frame the current
+data and then also instructs the terminal to make a particular frame the current
 frame.  To change the current frame, use the ``c`` key::
 
     <ESC>_Ga=a,i=3,c=7<ESC>\
@@ -632,6 +646,45 @@ static background.
 In particular, the first frame or *root frame* is created with the base image
 data and has no gap, so its gap must be set using this control code.
 
+Composing animation frames
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 0.22.0
+   Support for frame composition
+
+Clients can *compose* animation frames, this means that they can compose pixels
+in rectangular regions from one frame onto another frame. This allows for fast
+and low band-width modification of frames.
+
+To achieve this use the ``a=c`` key. The source frame is specified with
+``r=frame number`` and the destination frame as ``c=frame number``. The size of
+the rectangle is specified as ``w=width,h=height`` pixels. If unspecified, the
+full image width and height are used. The offset of the rectangle from the
+top-left corner for the source frame is specified by the ``x,y`` keys and the
+destination frame by the ``X,Y`` keys. The composition operation is specified
+by the ``C`` key with the default being to alpha blend the source rectangle
+onto the destination rectangle. With ``C=1`` it will be a simple replacement
+of pixels. For example::
+
+    <ESC>_Gi=1,r=7,c=9,w=23,h=27,X=4,Y=8,x=1,y=3<ESC>\
+
+Will compose a ``23x27`` rectangle located at ``(4, 8)`` in the ``7th frame``
+onto the rectangle located at ``(1, 3)`` in the ``9th frame``. These will be
+in the image with ``id=1``.
+
+If the frames or the image are not found the terminal emulator must
+respond with `ENOENT`. If the rectangles go out of bounds of the image
+the terminal must respond with `EINVAL`. If the source and destination frames are
+the same and the rectangles overlap, the terminal must respond with `EINVAL`.
+
+
+.. note::
+   In kitty, doing a composition will cause a frame to be *fully rendered*
+   potentially increasing its storage requirements, when the frame was previously
+   stored as a set of operations on other frames. If this happens and there
+   is not enough storage space, kitty will respond with ENOSPC.
+
+
 Image persistence and storage quotas
 -----------------------------------------
 
@@ -654,10 +707,10 @@ take, and the default value they take when missing. All integers are 32-bit.
 Key      Value                 Default    Description
 =======  ====================  =========  =================
 ``a``    Single character.     ``t``      The overall action this graphics command is performing.
-         ``(t, T, q, p, d)``              ``t`` - transmit data, ``T`` - transmit data and display image,
-                                          ``q`` - query terminal, ``p`` - put (display) previous transmitted image,
+         ``(a, c, d, f, ``                ``t`` - transmit data, ``T`` - transmit data and display image,
+         ``p, q, t, T)``                  ``q`` - query terminal, ``p`` - put (display) previous transmitted image,
                                           ``d`` - delete image, ``f`` - transmit data for animation frames,
-                                          ``a`` - control animation
+                                          ``a`` - control animation, ``c`` - compose animation frames
 
 ``q``    ``0, 1, 2``           ``0``      Suppress responses from the terminal to this graphics command.
 
@@ -711,6 +764,20 @@ Key      Value                 Default    Description
 ``Y``    Positive integer      ``0``      The background color for pixels not
                                           specified in the frame data. Must be in 32-bit RGBA format
 
+**Keys for animation frame composition**
+-----------------------------------------------------------
+
+``c``    Positive integer      ``0``      The 1-based frame number of the frame whose image data serves as the overlaid data
+``r``    Positive integer      ``0``      The 1-based frame number of the frame that is being edited.
+``x``    Positive integer      ``0``      The left edge (in pixels) of the destination rectangle
+``y``    Positive integer      ``0``      The top edge (in pixels) of the destination rectangle
+``w``    Positive integer      ``0``      The width (in pixels) of the source and destination rectangles. By default, the entire width is used
+``h``    Positive integer      ``0``      The height (in pixels) of the source and destination rectangles. By default, the entire height is used
+``X``    Positive integer      ``0``      The left edge (in pixels) of the source rectangle
+``Y``    Positive integer      ``0``      The top edge (in pixels) of the source rectangle
+``C``    Positive integer      ``0``      The composition mode for blending
+                                          pixels. Default is full alpha blending. ``1`` means a simple overwrite.
+
 
 **Keys for animation control**
 -----------------------------------------------------------

docs/index.rst

@@ -1,421 +1,74 @@
-:tocdepth: 2
-
-==========================================================
-kitty - the fast, featureful, GPU based terminal emulator
+kitty
 ==========================================================
 
-.. container:: major-features
-
-    * Offloads rendering to the GPU for :doc:`lower system load <performance>` and
-      buttery smooth scrolling.  Uses threaded rendering to minimize input latency.
-
-    * Supports all modern terminal features: :doc:`graphics (images)
-      <graphics-protocol>`, unicode, `true-color
-      <https://gist.github.com/XVilka/8346728>`_,
-      OpenType ligatures, mouse protocol, :doc:`hyperlinks <open_actions>`,
-      focus tracking, `bracketed paste <https://cirw.in/blog/bracketed-paste>`_
-      and several :doc:`new terminal protocol extensions
-      <protocol-extensions>`.
-
-    * Supports tiling multiple terminal windows side by side in different
-      :ref:`layouts <layouts>` without needing to use an extra program like tmux
-
-    * Can be :doc:`controlled from scripts or the shell prompt <remote-control>`,
-      even over SSH.
-
-    * Has a framework for :ref:`kittens`, small terminal programs that can be used to
-      extend |kitty|'s functionality.  For example, they are used for
-      :doc:`Unicode input <kittens/unicode-input>`, :doc:`Hints <kittens/hints>` and
-      :doc:`Side-by-side diff <kittens/diff>`.
-
-    * Supports :ref:`startup sessions <sessions>` which allow you to specify
-      the window/tab layout, working directories and programs to run on startup.
-
-    * Cross-platform: |kitty| works on Linux and macOS, but because it uses only
-      OpenGL for rendering, it should be trivial to port to other Unix-like platforms.
-
-    * Allows you to open :ref:`the scrollback buffer <scrollback>` in a
-      separate window using arbitrary programs of your choice. This is useful for
-      browsing the history comfortably in a pager or editor.
-
-    * Has :ref:`multiple copy/paste buffers <cpbuf>`, like vim.
-
-
-.. figure:: screenshots/screenshot.png
-    :alt: Screenshot, showing three programs in the 'Tall' layout
-    :align: center
-    :scale: 100%
-
-    Screenshot, showing vim, tig and git running in |kitty| with the 'Tall' layout
-
-
-
-.. contents::
-   :local:
-   :depth: 1
-
-
-.. _quickstart:
-
-Quickstart
---------------
-
-Pre-built binaries of |kitty| are available for both macOS and Linux.
-See the :doc:`binary install instructions </binary>`. You can also
-:doc:`build from source </build>`.
-
-Additionally, you can use your favorite package manager to install the |kitty|
-package, but note that some Linux distribution packages are woefully outdated.
-|kitty| is available in a vast number of package repositories for macOS
-and Linux.
-
-.. image:: https://repology.org/badge/tiny-repos/kitty.svg
-   :target: https://repology.org/project/kitty/versions
-   :alt: Number of repositories kitty is available in
-
-See :doc:`Configuring kitty <conf>` for help on configuring |kitty| and
-:doc:`Invocation <invocation>` for the command line arguments |kitty| supports.
-
-
-Design philosophy
--------------------
-
-|kitty| is designed for power keyboard users. To that end all its controls
-work with the keyboard (although it fully supports mouse interactions as
-well). Its configuration is a simple, human editable, single file for
-easy reproducibility (I like to store configuration in source control).
-
-The code in |kitty| is designed to be simple, modular and hackable. It is
-written in a mix of C (for performance sensitive parts) and Python (for
-easy hackability of the UI). It does not depend on any large and complex
-UI toolkit, using only OpenGL for rendering everything.
-
-Finally, |kitty| is designed from the ground up to support all modern
-terminal features, such as unicode, true color, bold/italic fonts, text
-formatting, etc. It even extends existing text formatting escape codes,
-to add support for features not available elsewhere, such as colored and
-styled (curly) underlines. One of the design goals of |kitty| is to be
-easily extensible so that new features can be added in the future with
-relatively little effort.
-
-.. include:: basic.rst
-
-.. _layouts:
-
-Layouts
-----------
-
-A layout is an arrangement of multiple kitty *windows* inside a top-level OS window. You can create a new window
-using the :sc:`new_window` key combination.
-
-Currently, there are seven layouts available:
-
-* **Fat** -- One (or optionally more) windows are shown full width on the top, the rest of the windows are shown side-by-side on the bottom
-* **Grid** -- All windows are shown in a grid
-* **Horizontal** -- All windows are shown side-by-side
-* **Splits** -- Windows arranged in arbitrary patterns created using horizontal and vertical splits
-* **Stack** -- Only a single maximized window is shown at a time
-* **Tall** -- One (or optionally more) windows are shown full height on the left, the rest of the windows are shown one below the other on the right
-* **Vertical** -- All windows are shown one below the other
-
-By default, all layouts are enabled and you can switch between layouts using
-the :sc:`next_layout` key combination. You can also create shortcuts to select
-particular layouts, and choose which layouts you want to enable/disable, see
-:ref:`conf-kitty-shortcuts.layout` for examples. The first layout listed in
-:opt:`enabled_layouts` becomes the default layout.
-
-For more details on the layouts and how to use them see :doc:`layouts`.
-
-.. _kittens:
-
-Kittens
-------------------
-
-|kitty| has a framework for easily creating terminal programs that make use of
-its advanced features. These programs are called kittens. They are used both
-to add features to |kitty| itself and to create useful standalone programs.
-Some prominent kittens:
-
-:doc:`icat <kittens/icat>`
-    Display images in the terminal
-
-
-:doc:`diff <kittens/diff>`
-    A fast, side-by-side diff for the terminal with syntax highlighting and
-    images
-
-
-:doc:`Unicode Input <kittens/unicode-input>`
-    Easily input arbitrary unicode characters in |kitty| by name or hex code.
-
-
-:doc:`Hints <kittens/hints>`
-    Select and open/paste/insert arbitrary text snippets such as URLs,
-    filenames, words, lines, etc. from the terminal screen.
-
-
-:doc:`Remote file <kittens/remote_file>`
-    Edit, open, or download remote files over SSH easily, by simply clicking on
-    the filename.
-
-
-:doc:`Hyperlinked grep <kittens/hyperlinked_grep>`
-    Search your files using `ripgrep <https://github.com/BurntSushi/ripgrep>`_
-    and open the results directly in your favorite editor in the terminal,
-    at the line containing the search result, simply by clicking on the result you want.
-
-
-:doc:`Broadcast <kittens/broadcast>`
-    Type in one kitty window and have it broadcast to all (or a subset) of
-    other kitty windows.
-
-
-:doc:`Panel <kittens/panel>`
-    Draw a GPU accelerated dock panel on your desktop showing the output
-    from an arbitrary terminal program.
-
-
-:doc:`Clipboard <kittens/clipboard>`
-    Copy/paste to the clipboard from shell scripts, even over SSH.
-
-You can also :doc:`Learn to create your own kittens <kittens/custom>`.
-
-
-Configuring kitty
--------------------
-
-|kitty| is highly configurable, everything from keyboard shortcuts to
-painting frames-per-second. Press :sc:`edit_config_file` in kitty
-to open its fully commented sample config file in your text editor.
-For details see the :doc:`configuration docs <conf>`.
-
-
-Remote control
-------------------
-
-|kitty| has a very powerful system that allows you to control it from the
-:doc:`shell prompt, even over SSH <remote-control>`. You can change colors,
-fonts, open new windows, tabs, set their titles, change window layout, get text
-from one window and send text to another, etc, etc. The possibilities are
-endless. See the :doc:`tutorial <remote-control>` to get started.
-
-.. _sessions:
-
-Startup Sessions
-------------------
-
-You can control the tabs, window layout, working directory, startup programs,
-etc. by creating a "session" file and using the :option:`kitty --session`
-command line flag or the :opt:`startup_session` option in :file:`kitty.conf`.
-For example:
-
-.. code-block:: session
-
-    # Set the window layout for the current tab
-    layout tall
-    # Set the working directory for windows in the current tab
-    cd ~
-    # Create a window and run the specified command in it
-    launch zsh
-    # Create a window with some environment variables set and run
-    # vim in it
-    launch --env FOO=BAR vim
-    # Set the title for the next window
-    launch --title "Chat with x" irssi --profile x
-
-    # Create a new tab (the part after new_tab is the optional tab
-    # name which will be displayed in the tab bar, if omitted, the
-    # title of the active window will be used instead)
-    new_tab my tab
-    cd ~/somewhere
-    # Set the layouts allowed in this tab
-    enabled_layouts tall, stack
-    # Set the current layout
-    layout stack
-    launch zsh
-
-    # Create a new OS window
-    new_os_window
-    # set new window size to 80x25 cells
-    os_window_size 80c 25c
-    # set the --class for the new OS window
-    os_window_class mywindow
-    launch sh
-    # Make the current window the active (focused) window
-    focus
-    launch emacs
-
-.. note::
-    The :doc:`launch <launch>` command when used in a session file
-    cannot create new OS windows, or tabs.
-
-
-Mouse features
--------------------
-
-* You can click on a URL to open it in a browser.
-* You can double click to select a word and then drag to select more words.
-* You can triple click to select a line and then drag to select more lines.
-* You can triple click while holding :kbd:`ctrl+alt` to select from clicked
-  point to end of line.
-* You can right click to extend a previous selection.
-* You can hold down :kbd:`ctrl+alt` and drag with the mouse to select in
-  columns.
-* Selecting text automatically copies it to the primary clipboard (on
-  platforms with a primary clipboard).
-* You can middle click to paste from the primary clipboard (on platforms
-  with a primary clipboard).
-* You can select text with kitty even when a terminal program has grabbed
-  the mouse by holding down the :kbd:`shift` key.
-
-All these actions can be customized in :file:`kitty.conf` as described
-:ref:`here <conf-kitty-mouse.mousemap>`.
-
-
-Font control
------------------
-
-|kitty| has extremely flexible and powerful font selection features. You can
-specify individual families for the regular, bold, italic and bold+italic
-fonts. You can even specify specific font families for specific ranges of
-unicode characters. This allows precise control over text rendering. It can
-come in handy for applications like powerline, without the need to use patched
-fonts. See the various font related configuration directives in
-:ref:`conf-kitty-fonts`.
-
-
-.. _scrollback:
-
-The scrollback buffer
------------------------
-
-|kitty| supports scrolling back to view history, just like most terminals. You
-can use either keyboard shortcuts or the mouse scroll wheel to do so.  However,
-|kitty| has an extra, neat feature. Sometimes you need to explore the
-scrollback buffer in more detail, maybe search for some text or refer to it
-side-by-side while typing in a follow-up command. |kitty| allows you to do this
-by pressing the :sc:`show_scrollback` key-combination, which will open the
-scrollback buffer in your favorite pager program (which is ``less`` by default).
-Colors and text formatting are preserved. You can explore the scrollback buffer
-comfortably within the pager.
-
-Additionally, you can pipe the contents of the scrollback buffer to an
-arbitrary, command running in a new window, tab or overlay, for example::
-
-   map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting less +G -R
-
-Would open the scrollback buffer in a new window when you press the :kbd:`F1`
-key. See :sc:`show_scrollback` for details.
-
-If you want to use it with an editor such as vim to get more powerful features,
-you can see tips for doing so, in
-`this thread <https://github.com/kovidgoyal/kitty/issues/719>`_.
-
-If you wish to store very large amounts of scrollback to view using the piping or
-:sc:`show_scrollback` features, you can use the :opt:`scrollback_pager_history_size`
-option.
-
-.. _cpbuf:
-
-Multiple copy/paste buffers
------------------------------
-
-In addition to being able to copy/paste from the system clipboard, in |kitty| you
-can also setup an arbitrary number of copy paste buffers. To do so, simply add
-something like the following to your :file:`kitty.conf`::
-
-   map f1 copy_to_buffer a
-   map f2 paste_from_buffer a
-
-This will allow you to press :kbd:`F1` to copy the current selection to an
-internal buffer named ``a`` and :kbd:`F2` to paste from that buffer. The buffer
-names are arbitrary strings, so you can define as many such buffers as you
-need.
-
-Marks
--------------
-
-kitty has the ability to mark text on the screen based on regular expressions.
-This can be useful to highlight words or phrases when browsing output from long
-running programs or similar. To learn how this feature works, see :doc:`marks`.
-
-
-Frequently Asked Questions
----------------------------------
-
-The list of Frequently Asked Questions (*FAQ*) is :doc:`available here <faq>`.
-
-.. _completion:
-
-
-Cool integrations for kitty with other CLI tools
---------------------------------------------------
-
-kitty provides extremely powerful interfaces such as :doc:`remote-control` and
-:doc:`kittens/custom` and :doc:`kittens/icat`
-that allow it to be integrated with other tools seamlessly. For a list of such
-user created integrations, see: :doc:`integrations`.
-
-Completion for kitty
----------------------------------
-
-|kitty| comes with completion for the ``kitty`` command for popular shells.
-
-
-bash
-~~~~~~~~
-
-Add the following to your :file:`~/.bashrc`
-
-.. code-block:: sh
-
-   source <(kitty + complete setup bash)
-
-Older versions of bash (for example, v3.2) do not support
-process substitution with the source command, in which
-case you can try an alternative:
-
-.. code-block:: sh
-
-    source /dev/stdin <<<"$(kitty + complete setup bash)"
-
-
-zsh
-~~~~~~~~~
-
-Add the following to your :file:`~/.zshrc`
-
-.. code-block:: sh
-
-    autoload -Uz compinit
-    compinit
-    # Completion for kitty
-    kitty + complete setup zsh | source /dev/stdin
-
-The important thing above is to make sure the call to |kitty| to load the zsh
-completions happens after the call to :file:`compinit`.
-
-
-fish
-~~~~~~~~
-
-For versions of fish earlier than 3.0.0, add the following to your
-:file:`~/.config/fish/config.fish`. Later versions source completions by default.
-
-.. code-block:: sh
-
-   kitty + complete setup fish | source
-
-
-Changelog
-------------------
-
-See :doc:`changelog`.
+*The fast, feature-rich, GPU based terminal emulator*
 
 .. toctree::
     :hidden:
-    :glob:
 
-    *
-    kittens/*
-    generated/rc
+    quickstart
+    overview
+    faq
+    support
+    performance
+    changelog
+    integrations
+    protocol-extensions
+
+
+.. tab:: Fast
+
+   * Offloads rendering to the GPU for :doc:`lower system load <performance>`
+   * Uses threaded rendering for
+     `absolutely minimal latency <https://github.com/kovidgoyal/kitty/issues/2701#issuecomment-636497270>`_
+   * Performance tradeoffs can be :ref:`tuned <conf-kitty-performance>`
+
+.. tab:: Capable
+
+   * Graphics, with :doc:`images and animations <graphics-protocol>`
+   * Ligatures and emoji, with :opt:`per glyph font substitution <symbol_map>`
+   * :term:`Hyperlinks<hyperlinks>`, with :doc:`configurable actions <open_actions>`
+
+.. tab:: Scriptable
+
+   * Control from :doc:`scripts or the shell <remote-control>`
+   * Extend with :ref:`kittens <kittens>` using the Python language
+   * Use :ref:`startup sessions <sessions>` to specify working environments
+
+.. tab:: Composable
+
+   * Programmable tabs, :ref:`splits <splits_layout>` and multiple :doc:`layouts <layouts>` to manage windows
+   * Browse the :ref:`entire history <scrollback>` or the :sc:`output from the last command <show_last_command_output>`
+     comfortably in pagers and editors
+   * Edit or download :doc:`remote files <kittens/remote_file>` in an existing SSH session
+
+.. tab:: Cross-platform
+
+   * Linux
+   * macOS
+   * Various BSDs
+
+.. tab:: Innovative
+
+   Pioneered various extensions to move the entire terminal ecosystem forward
+
+   * :doc:`graphics-protocol`
+   * :doc:`keyboard-protocol`
+   * Lots more in :doc:`protocol-extensions`
+
+
+.. only:: dirhtml
+
+    .. raw:: html
+
+        <video controls width="640" height="360">
+            <source src="https://download.calibre-ebook.com/videos/kitty.mp4" type="video/mp4">
+            <source src="https://download.calibre-ebook.com/videos/kitty.webm" type="video/webm">
+        </video>
+
+    .. rst-class:: caption caption-text
+
+        Watch kitty in action!
+
+
+To get started see :doc:`quickstart`.

docs/installer.py

@@ -20,10 +20,16 @@ import tempfile
 py3 = sys.version_info[0] > 2
 is64bit = platform.architecture()[0] == '64bit'
 is_macos = 'darwin' in sys.platform.lower()
+is_linux_arm = is_linux_arm64 = False
 if is_macos:
     mac_ver = tuple(map(int, platform.mac_ver()[0].split('.')))
     if mac_ver[:2] < (10, 12):
         raise SystemExit('Your version of macOS is too old, at least 10.12 is required')
+else:
+    machine = (os.uname()[4] or '').lower()
+    if machine.startswith('arm') or machine.startswith('aarch64'):
+        is_linux_arm = True
+        is_linux_arm64 = machine.startswith('arm64') or machine.startswith('aarch64')
 
 try:
     __file__
@@ -73,9 +79,11 @@ class Reporter:  # {{{
 # }}}
 
 
-def get_latest_release_data():
+def get_release_data(relname='latest'):
     print('Checking for latest release on GitHub...')
-    req = urllib.Request('https://api.github.com/repos/kovidgoyal/kitty/releases/latest', headers={'Accept': 'application/vnd.github.v3+json'})
+    req = urllib.Request(
+        'https://api.github.com/repos/kovidgoyal/kitty/releases/' + relname,
+        headers={'Accept': 'application/vnd.github.v3+json'})
     try:
         res = urllib.urlopen(req).read().decode('utf-8')
     except Exception as err:
@@ -90,7 +98,8 @@ def get_latest_release_data():
         else:
             if name.endswith('.txz'):
                 if is64bit:
-                    if name.endswith('-x86_64.txz'):
+                    q = '-arm64.txz' if is_linux_arm64 else '-x86_64.txz'
+                    if name.endswith(q):
                         return html_url + '/' + name, asset['size']
                 else:
                     if name.endswith('-i686.txz'):
@@ -184,19 +193,22 @@ def main(dest=None, launch=True, installer=None):
             dest = '/Applications'
         else:
             dest = os.path.expanduser('~/.local')
-    machine = os.uname()[4]
-    if machine and machine.lower().startswith('arm'):
+    if is_linux_arm and not is_linux_arm64:
         raise SystemExit(
-            'You are running on an ARM system. The kitty binaries are only'
-            ' available for x86 systems. You will have to build from'
+            'You are running on a 32-bit ARM system. The kitty binaries are only'
+            ' available for 64 bit ARM systems. You will have to build from'
             ' source.')
     if not installer:
-        url, size = get_latest_release_data()
+        url, size = get_release_data()
         installer = download_installer(url, size)
     else:
-        installer = os.path.abspath(installer)
-        if not os.access(installer, os.R_OK):
-            raise SystemExit('Could not read from: {}'.format(installer))
+        if installer == 'nightly':
+            url, size = get_release_data('tags/nightly')
+            installer = download_installer(url, size)
+        else:
+            installer = os.path.abspath(installer)
+            if not os.access(installer, os.R_OK):
+                raise SystemExit('Could not read from: {}'.format(installer))
     if is_macos:
         macos_install(installer, dest=dest, launch=launch)
     else:
@@ -227,7 +239,7 @@ def script_launch():
     main(**kwargs)
 
 
-def update_intaller_wrapper():
+def update_installer_wrapper():
     # To run: python3 -c "import runpy; runpy.run_path('installer.py', run_name='update_wrapper')" installer.sh
     with open(__file__, 'rb') as f:
         src = f.read().decode('utf-8')
@@ -244,6 +256,6 @@ def update_intaller_wrapper():
 if __name__ == '__main__' and from_file:
     main()
 elif __name__ == 'update_wrapper':
-    update_intaller_wrapper()
+    update_installer_wrapper()
 elif __name__ == 'script_launch':
     script_launch()

docs/installer.sh

@@ -25,6 +25,268 @@ echo Using python executable: $python
 $python -c "import sys; script_launch=lambda:sys.exit('Download of installer failed!'); exec(sys.stdin.read()); script_launch()" "$@" <<'INSTALLER_HEREDOC'
 # {{{
 # HEREDOC_START
+#!/usr/bin/env python3
+# vim:fileencoding=utf-8
+# License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+import atexit
+import json
+import os
+import platform
+import re
+import shlex
+import shutil
+import subprocess
+import sys
+import tempfile
+
+py3 = sys.version_info[0] > 2
+is64bit = platform.architecture()[0] == '64bit'
+is_macos = 'darwin' in sys.platform.lower()
+is_linux_arm = is_linux_arm64 = False
+if is_macos:
+    mac_ver = tuple(map(int, platform.mac_ver()[0].split('.')))
+    if mac_ver[:2] < (10, 12):
+        raise SystemExit('Your version of macOS is too old, at least 10.12 is required')
+else:
+    machine = (os.uname()[4] or '').lower()
+    if machine.startswith('arm') or machine.startswith('aarch64'):
+        is_linux_arm = True
+        is_linux_arm64 = machine.startswith('arm64') or machine.startswith('aarch64')
+
+try:
+    __file__
+    from_file = True
+except NameError:
+    from_file = False
+
+if py3:
+    unicode = str
+    raw_input = input
+    import urllib.request as urllib
+
+    def encode_for_subprocess(x):
+        return x
+else:
+    from future_builtins import map
+    import urllib2 as urllib
+
+    def encode_for_subprocess(x):
+        if isinstance(x, unicode):
+            x = x.encode('utf-8')
+        return x
+
+
+def run(*args):
+    if len(args) == 1:
+        args = shlex.split(args[0])
+    args = list(map(encode_for_subprocess, args))
+    ret = subprocess.Popen(args).wait()
+    if ret != 0:
+        raise SystemExit(ret)
+
+
+class Reporter:  # {{{
+
+    def __init__(self, fname):
+        self.fname = fname
+        self.last_percent = 0
+
+    def __call__(self, blocks, block_size, total_size):
+        percent = (blocks*block_size)/float(total_size)
+        report = '\rDownloaded {:.1%}         '.format(percent)
+        if percent - self.last_percent > 0.05:
+            self.last_percent = percent
+            print(report, end='')
+            sys.stdout.flush()
+# }}}
+
+
+def get_release_data(relname='latest'):
+    print('Checking for latest release on GitHub...')
+    req = urllib.Request(
+        'https://api.github.com/repos/kovidgoyal/kitty/releases/' + relname,
+        headers={'Accept': 'application/vnd.github.v3+json'})
+    try:
+        res = urllib.urlopen(req).read().decode('utf-8')
+    except Exception as err:
+        raise SystemExit('Failed to contact {} with error: {}'.format(req.get_full_url(), err))
+    data = json.loads(res)
+    html_url = data['html_url'].replace('/tag/', '/download/').rstrip('/')
+    for asset in data.get('assets', ()):
+        name = asset['name']
+        if is_macos:
+            if name.endswith('.dmg'):
+                return html_url + '/' + name, asset['size']
+        else:
+            if name.endswith('.txz'):
+                if is64bit:
+                    q = '-arm64.txz' if is_linux_arm64 else '-x86_64.txz'
+                    if name.endswith(q):
+                        return html_url + '/' + name, asset['size']
+                else:
+                    if name.endswith('-i686.txz'):
+                        return html_url + '/' + name, asset['size']
+    raise SystemExit('Failed to find the installer package on github')
+
+
+def do_download(url, size, dest):
+    print('Will download and install', os.path.basename(dest))
+    reporter = Reporter(os.path.basename(dest))
+
+    # Get content length and check if range is supported
+    rq = urllib.urlopen(url)
+    headers = rq.info()
+    sent_size = int(headers['content-length'])
+    if sent_size != size:
+        raise SystemExit('Failed to download from {} Content-Length ({}) != {}'.format(url, sent_size, size))
+    with open(dest, 'wb') as f:
+        while f.tell() < size:
+            raw = rq.read(8192)
+            if not raw:
+                break
+            f.write(raw)
+            reporter(f.tell(), 1, size)
+    rq.close()
+    if os.path.getsize(dest) < size:
+        raise SystemExit('Download failed, try again later')
+    print('\rDownloaded {} bytes'.format(os.path.getsize(dest)))
+
+
+def clean_cache(cache, fname):
+    for x in os.listdir(cache):
+        if fname not in x:
+            os.remove(os.path.join(cache, x))
+
+
+def download_installer(url, size):
+    fname = url.rpartition('/')[-1]
+    tdir = tempfile.gettempdir()
+    cache = os.path.join(tdir, 'kitty-installer-cache')
+    if not os.path.exists(cache):
+        os.makedirs(cache)
+    clean_cache(cache, fname)
+    dest = os.path.join(cache, fname)
+    if os.path.exists(dest) and os.path.getsize(dest) == size:
+        print('Using previously downloaded', fname)
+        return dest
+    if os.path.exists(dest):
+        os.remove(dest)
+    do_download(url, size, dest)
+    return dest
+
+
+def macos_install(dmg, dest='/Applications', launch=True):
+    mp = tempfile.mkdtemp()
+    atexit.register(shutil.rmtree, mp)
+    run('hdiutil', 'attach', dmg, '-mountpoint', mp)
+    try:
+        os.chdir(mp)
+        app = 'kitty.app'
+        d = os.path.join(dest, app)
+        if os.path.exists(d):
+            shutil.rmtree(d)
+        dest = os.path.join(dest, app)
+        run('ditto', '-v', app, dest)
+        print('Successfully installed kitty into', dest)
+        if launch:
+            run('open', dest)
+    finally:
+        os.chdir('/')
+        run('hdiutil', 'detach', mp)
+
+
+def linux_install(installer, dest=os.path.expanduser('~/.local'), launch=True):
+    dest = os.path.join(dest, 'kitty.app')
+    if os.path.exists(dest):
+        shutil.rmtree(dest)
+    os.makedirs(dest)
+    print('Extracting tarball...')
+    run('tar', '-C', dest, '-xJof', installer)
+    print('kitty successfully installed to', dest)
+    kitty = os.path.join(dest, 'bin', 'kitty')
+    print('Use', kitty, 'to run kitty')
+    if launch:
+        run(kitty, '--detach')
+
+
+def main(dest=None, launch=True, installer=None):
+    if not dest:
+        if is_macos:
+            dest = '/Applications'
+        else:
+            dest = os.path.expanduser('~/.local')
+    if is_linux_arm and not is_linux_arm64:
+        raise SystemExit(
+            'You are running on a 32-bit ARM system. The kitty binaries are only'
+            ' available for 64 bit ARM systems. You will have to build from'
+            ' source.')
+    if not installer:
+        url, size = get_release_data()
+        installer = download_installer(url, size)
+    else:
+        if installer == 'nightly':
+            url, size = get_release_data('tags/nightly')
+            installer = download_installer(url, size)
+        else:
+            installer = os.path.abspath(installer)
+            if not os.access(installer, os.R_OK):
+                raise SystemExit('Could not read from: {}'.format(installer))
+    if is_macos:
+        macos_install(installer, dest=dest, launch=launch)
+    else:
+        linux_install(installer, dest=dest, launch=launch)
+
+
+def script_launch():
+    # To test: python3 -c "import runpy; runpy.run_path('installer.py', run_name='script_launch')"
+    def path(x):
+        return os.path.expandvars(os.path.expanduser(x))
+
+    def to_bool(x):
+        return x.lower() in {'y', 'yes', '1', 'true'}
+
+    type_map = {x: path for x in 'dest installer'.split()}
+    type_map['launch'] = to_bool
+    kwargs = {}
+
+    for arg in sys.argv[1:]:
+        if arg:
+            m = re.match('([a-z_]+)=(.+)', arg)
+            if m is None:
+                raise SystemExit('Unrecognized command line argument: ' + arg)
+            k = m.group(1)
+            if k not in type_map:
+                raise SystemExit('Unrecognized command line argument: ' + arg)
+            kwargs[k] = type_map[k](m.group(2))
+    main(**kwargs)
+
+
+def update_installer_wrapper():
+    # To run: python3 -c "import runpy; runpy.run_path('installer.py', run_name='update_wrapper')" installer.sh
+    with open(__file__, 'rb') as f:
+        src = f.read().decode('utf-8')
+    wrapper = sys.argv[-1]
+    with open(wrapper, 'r+b') as f:
+        raw = f.read().decode('utf-8')
+        nraw = re.sub(r'^# HEREDOC_START.+^# HEREDOC_END', lambda m: '# HEREDOC_START\n{}\n# HEREDOC_END'.format(src), raw, flags=re.MULTILINE | re.DOTALL)
+        if 'update_intaller_wrapper()' not in nraw:
+            raise SystemExit('regex substitute of HEREDOC failed')
+        f.seek(0), f.truncate()
+        f.write(nraw.encode('utf-8'))
+
+
+if __name__ == '__main__' and from_file:
+    main()
+elif __name__ == 'update_wrapper':
+    update_installer_wrapper()
+elif __name__ == 'script_launch':
+    script_launch()
+
 # HEREDOC_END
 # }}}
 INSTALLER_HEREDOC

docs/integrations.rst

@@ -1,3 +1,5 @@
+:tocdepth: 2
+
 Integrations with other tools
 ================================
 
@@ -12,149 +14,245 @@ Image and document viewers
 Powered by kitty's :doc:`graphics-protocol` there exist many tools for viewing
 images and other types of documents directly in your terminal, even over SSH.
 
+.. _tool_termpdf:
+
 `termpdf.py <https://github.com/dsanson/termpdf.py>`_
-    a terminal PDF/DJVU/CBR viewer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A terminal PDF/DJVU/CBR viewer
+
+.. _tool_mdcat:
 
 `mdcat <https://github.com/lunaryorn/mdcat>`_
-    Display markdown files nicely formatted with images in the terminal
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Display markdown files nicely formatted with images in the terminal
+
+.. _tool_ranger:
 
 `ranger <https://github.com/ranger/ranger>`_
-    a terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+
+.. _tool_nnn:
 
 `nnn <https://github.com/jarun/nnn/>`_
-    another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+
+.. _tool_hunter:
 
 `hunter <https://github.com/rabite0/hunter>`_
-    another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Another terminal file manager, with previews of file contents powered by kitty's graphics protocol.
+
+.. _tool_koneko:
 
 `koneko <https://github.com/twenty5151/koneko>`_
-    browse images from the pixiv artist community directly in kitty.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Browse images from the pixiv artist community directly in kitty.
+
+.. _tool_viu:
 
 `viu <https://github.com/atanunq/viu>`_
-    view images in the terminal, similar to kitty's icat.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+View images in the terminal, similar to kitty's icat.
+
+.. _tool_nb:
+
 
 `nb <https://github.com/xwmx/nb>`_
-    command line and local web note-taking, bookmarking, archiving, and
-    knowledge base application that uses kitty's graphics protocol for images.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+command line and local web note-taking, bookmarking, archiving, and
+knowledge base application that uses kitty's graphics protocol for images.
+
+.. _tool_w3m:
 
 `w3m <https://github.com/tats/w3m>`_
-    A text mode WWW browser that supports kitty's graphics protocol to display
-    images.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A text mode WWW browser that supports kitty's graphics protocol to display
+images.
+
+.. _tool_timg:
 
 `timg <https://github.com/hzeller/timg>`_
-    A terminal image and video viewer, that displays static and animated
-    images or plays videos. Fast multi-threaded loading, JPEG exif rotation,
-    grid view and connecting to the webcam make it a versatile terminal utility.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A terminal image and video viewer, that displays static and animated
+images or plays videos. Fast multi-threaded loading, JPEG exif rotation,
+grid view and connecting to the webcam make it a versatile terminal utility.
 
 
 System and data visualisation tools
 ---------------------------------------
 
+.. _tool_neofetch:
+
 `neofetch <https://github.com/dylanaraps/neofetch>`_
-    A command line system information tool that shows images using kitty's graphics protocol
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A command line system information tool that shows images using kitty's graphics protocol
+
+.. _tool_matplotlib:
 
 `matplotlib <https://github.com/jktr/matplotlib-backend-kitty>`_
-    show matplotlib plots directly in kitty
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Show matplotlib plots directly in kitty
+
+.. _tool_KittyTerminalImage:
 
 `KittyTerminalImages.jl <https://github.com/simonschoelly/KittyTerminalImages.jl>`_
-    show images from Julia directly in kitty
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Show images from Julia directly in kitty
+
+.. _tool_euporie:
 
 `euporie <https://github.com/joouha/euporie>`_
-    a text-based user interface for running and editing Jupyter notebooks,
-    powered by kitty's graphics protocol for displaying plots
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A text-based user interface for running and editing Jupyter notebooks,
+powered by kitty's graphics protocol for displaying plots
+
+.. _tool_gnuplot:
 
 `gnuplot <http://www.gnuplot.info/>`_
-    a graphing and data visualization tool that can be made to display its
-    output in kitty with the following bash snippet::
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-        function iplot {
-            cat <<EOF | gnuplot
-            set terminal pngcairo enhanced font 'Fira Sans,10'
-            set autoscale
-            set samples 1000
-            set output '|kitty +kitten icat --stdin yes'
-            set object 1 rectangle from screen 0,0 to screen 1,1 fillcolor rgb"#fdf6e3" behind
-            plot $@
-            set output '/dev/null'
-            EOF
-        }
+A graphing and data visualization tool that can be made to display its
+output in kitty with the following bash snippet:
 
-   Add this to bashrc and then to plot a function, simply do::
+.. code-block:: sh
 
-        iplot 'sin(x*3)*exp(x*.2)'
+    function iplot {
+        cat <<EOF | gnuplot
+        set terminal pngcairo enhanced font 'Fira Sans,10'
+        set autoscale
+        set samples 1000
+        set output '|kitty +kitten icat --stdin yes'
+        set object 1 rectangle from screen 0,0 to screen 1,1 fillcolor rgb"#fdf6e3" behind
+        plot $@
+        set output '/dev/null'
+        EOF
+    }
+
+Add this to bashrc and then to plot a function, simply do:
+
+.. code-block:: sh
+
+    iplot 'sin(x*3)*exp(x*.2)'
+
+.. tool_onefetch:
 
 `onefetch <https://github.com/o2sh/onefetch>`_
-    a tool to fetch information about your git repositories
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A tool to fetch information about your git repositories
+
+.. tool_patat:
 
 `patat <https://github.com/jaspervdj/patat>`_
-    terminal based presentations using pandoc and kitty's image protocol for
-    images
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Terminal based presentations using pandoc and kitty's image protocol for
+images
+
+.. tool_wttr:
 
 `wttr.in <https://github.com/chubin/wttr.in>`_
-    a tool to display weather information in your terminal with curl
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+A tool to display weather information in your terminal with curl
+
+.. tool_wl_clipboard:
 
 `wl-clipboard-manager <https://github.com/maximbaz/wl-clipboard-manager>`_
-    view and manage the system clipboard under Wayland in your kitty terminal
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+View and manage the system clipboard under Wayland in your kitty terminal
+
+.. tool_dmenu_term:
 
 `dmenu-term <https://github.com/maximbaz/dmenu-term>`_
-    run applications on your system with fuzzy find inside a kitty window
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Run applications on your system with fuzzy find inside a kitty window
 
 
 Editor integration
 -----------------------
 
-kitty can be integrated into many different terminal editors to add features
+|kitty| can be integrated into many different terminal editors to add features
 such a split windows, previews, REPLs etc.
 
+.. tool_kakoune:
 
 `kakoune <https://kakoune.org/>`_
-    integrates with kitty to use native kitty windows for its windows/panels and REPLs.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+integrates with kitty to use native kitty windows for its windows/panels and REPLs.
+
+.. tool_vim_slime:
 
 `vim-slime <https://github.com/jpalardy/vim-slime#kitty>`_
-    uses kitty remote control for a Lisp REPL.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+uses kitty remote control for a Lisp REPL.
+
+.. tool_vim_kitty_navigator:
 
 `vim-kitty-navigator <https://github.com/knubie/vim-kitty-navigator>`_
-    allows you to navigate seamlessly between vim and kitty splits using a consistent set of hotkeys.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+allows you to navigate seamlessly between vim and kitty splits using a consistent set of hotkeys.
+
+.. tool_vim_test:
 
 `vim-test <https://github.com/vim-test/vim-test>`_
-    allows easily running tests in a terminal window
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Allows easily running tests in a terminal window
+
+.. tool_hologram:
 
 `hologram.nvim <https://github.com/edluffy/hologram.nvim>`_
-    terminal image viewer for nvim
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Terminal image viewer for nvim
 
 
 Scrollback manipulation
 -------------------------
 
+.. tool_kitty_search:
+
 `kitty-search <https://github.com/trygveaa/kitty-kitten-search>`_
-    Live incremental search of the scrollback buffer.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Live incremental search of the scrollback buffer.
+
+.. tool_kitty_grab:
 
 `kitty-grab <https://github.com/yurikhan/kitty_grab>`_
-    keyboard based text selection for the kitty scrollback buffer.
-
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Keyboard based text selection for the kitty scrollback buffer.
 
 
 Miscellaneous
 ------------------
 
+.. tool_kitty_smart_tab:
+
 `kitty-smart-tab <https://github.com/yurikhan/kitty-smart-tab>`_
-    use keys to either control tabs or pass them onto running applications if
-    no tabs are present
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+use keys to either control tabs or pass them onto running applications if
+no tabs are present
+
+.. tool_kitty_smart_scroll:
 
 `kitty-smart-scroll <https://github.com/yurikhan/kitty-smart-scroll>`_
-    use keys to either scroll or pass them onto running applications if
-    no scrollback buffer is present
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+use keys to either scroll or pass them onto running applications if
+no scrollback buffer is present
 
-`reload keybindings <https://github.com/kovidgoyal/kitty/issues/1292#issuecomment-582388769>`_
-    reload key bindings from :file:`kitty.conf` without needing to restart
-    kitty
+.. tool_kitti3:
 
 `kitti3 <https://github.com/LandingEllipse/kitti3>`_
-    allow using kitty as a drop-down terminal under the i3 window manager
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+allow using kitty as a drop-down terminal under the i3 window manager
+
+.. tool_weechat_hints:
 
 `weechat-hints <https://github.com/GermainZ/kitty-weechat-hints>`_
-    URL hints kitten for WeeChat that works without having to use WeeChat's
-    raw-mode.
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+URL hints kitten for WeeChat that works without having to use WeeChat's
+raw-mode.
+
+.. tool_glkitty:
 
 `glkitty <https://github.com/michaeljclark/glkitty>`_
-    C library to draw OpenGL shaders in the terminal with a glgears demo
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+C library to draw OpenGL shaders in the terminal with a glgears demo

docs/invocation.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 The kitty command line interface
 ====================================
 

docs/keyboard-protocol.rst

@@ -1,5 +1,5 @@
-A protocol for comprehensive keyboard handling in terminals
-=================================================================
+Comprehensive keyboard handling in terminals
+==============================================
 
 There are various problems with the current state of keyboard handling in
 terminals. They include:
@@ -32,6 +32,13 @@ You can see this protocol with all enhancements in action by running::
 
 inside the kitty terminal to report key events.
 
+In addition to kitty, this protocol is also implemented in:
+
+* The `foot terminal <https://codeberg.org/dnkl/foot/issues/319>`__
+* The `notcurses library
+  <https://github.com/dankamongmen/notcurses/issues/2131>`__
+* The `kakoune text editor <https://github.com/mawww/kakoune/issues/4103>`__
+
 .. versionadded:: 0.20.0
 
 Quickstart
@@ -41,12 +48,14 @@ If you are an application or library developer just interested in using this
 protocol to make keyboard handling simpler and more robust in your application,
 without too many changes, do the following:
 
-#. Emit the escape code ``CSI > 1 u`` at application startup or when entering
-   alternate screen mode
+#. Emit the escape code ``CSI > 1 u`` at application startup if using the main
+   screen or when entering alternate screen mode, if using the alternate
+   screen.
 #. All key events will now be sent in only a few forms to your application,
    that are easy to parse unambiguously.
-#. Emit the escape sequence ``CSI < u`` at application exit or just before
-   leaving alternate screen mode to restore the previously used keyboard mode.
+#. Emit the escape sequence ``CSI < u`` at application exit if using the main
+   screen or just before leaving alternate screen mode if using the alternate screen,
+   to restore the previously used keyboard mode.
 
 Key events will all be delivered to your application either as plain UTF-8
 text, or using the following escape codes, for those keys that do not produce
@@ -64,10 +73,11 @@ key, such as ``97`` for the :kbd:`a` key, or one of the numbers from the
 modifiers pressed for the key event. The encoding is described in the
 :ref:`modifiers` section.
 
-The second form is used for a few functional keys, such as the :kbd:`Home, End,
-Arrow keys and F1-F4`, they are enumerated in the :ref:`functional` table below.
-Note that if no modifiers are present the parameters are omitted entirely
-giving an escape code of the form ``CSI [ABCDEFHPQRS]``.
+The second form is used for a few functional keys, such as the :kbd:`Home`,
+:kbd:`End`, :kbd:`Arrow` keys and :kbd:`F1` ... :kbd:`F4`, they are enumerated in
+the :ref:`functional` table below.  Note that if no modifiers are present the
+parameters are omitted entirely giving an escape code of the form ``CSI
+[ABCDEFHPQRS]``.
 
 If you want support for more advanced features such as repeat and release
 events, alternate keys for shortcut matching et cetera, these can be turned on
@@ -140,11 +150,13 @@ sub-field for the shifted key, like this::
 Modifiers
 ~~~~~~~~~~~~~~
 
-This protocol supports six modifier keys, :kbd:`shift, alt, ctrl, super, hyper
-and meta` as well as :kbd:`num_lock and caps_lock`. Here :kbd:`super` is either
-the *Windows/Linux* key or the *Cmd* key on mac keyboards. :kbd:`hyper` and
-:kbd:`meta` are typically present only on X11 based systems with special XKB
-rules. Modifiers are encoded as a bit field with::
+This protocol supports six modifier keys, :kbd:`shift`, :kbd:`alt`,
+:kbd:`ctrl`, :kbd:`super`, :kbd:`hyper`, :kbd:`meta`, :kbd:`num_lock` and
+:kbd:`caps_lock`. Here :kbd:`super` is either the *Windows/Linux* key or the
+:kbd:`command` key on mac keyboards. The :kbd:`alt` key is the :kbd:`option`
+key on mac keyboards. :kbd:`hyper` and :kbd:`meta` are typically present only
+on X11/Wayland based systems with special XKB rules. Modifiers are encoded as a
+bit field with::
 
     shift     0b1         (1)
     alt       0b10        (2)
@@ -207,9 +219,9 @@ Non-Unicode keys
 
 There are many keys that don't correspond to letters from human languages, and
 thus aren't represented in Unicode. Think of functional keys, such as
-:kbd:`Escape, Play, Pause, F1, Home, etc`. These are encoded using Unicode code
-points from the Private Use Area (``57344 - 63743``). The mapping of key
-names to code points for these keys is in the
+:kbd:`Escape`, :kbd:`Play`, :kbd:`Pause`, :kbd:`F1`, :kbd:`Home`, etc. These
+are encoded using Unicode code points from the Private Use Area (``57344 -
+63743``). The mapping of key names to code points for these keys is in the
 :ref:`Functional key definition table below <functional>`.
 
 
@@ -266,10 +278,14 @@ and alternate screens. If a pop request is received that empties the stack,
 all flags are reset. If a push request is received and the stack is full, the
 oldest entry from the stack must be evicted.
 
-.. note:: In the interests of interoperation, the XTerm specific sequences
-   `CSI > 4; 1 m` and `CSI > 4; 0 m` are treated as `CSI > 1 u` and `CSI < 1 u`.
-   These codes cause XTerm to use the CSI u encoding for more keys and are therefore
-   treated as similar to the disambiguate progressive enhancement.
+.. note:: The main and alternate screens in the terminal emulator must maintain
+   their own, independent, keyboard mode stacks. This is so that a program that
+   uses the alternate screen such as an editor, can change the keyboard mode
+   in the alternate screen only, without affecting the mode in the main screen
+   or even knowing what that mode is. Without this, and if no stack is
+   implemented for keyboard modes (such as in some legacy terminal emulators)
+   the editor would have to somehow know what the keyboard mode of the main
+   screen is and restore to that mode on exit.
 
 .. _disambiguate:
 
@@ -282,8 +298,8 @@ encodings overlapping with other control codes. For instance, pressing the
 start of an escape code. Similarly pressing the key :kbd:`alt+[` will generate
 the bytes used for CSI control codes.
 
-Turning on this flag will cause the terminal to report the :kbd:`Esc, alt+key,
-ctrl+key, ctrl+alt+key, shift+alt+key` keys using ``CSI u`` sequences instead
+Turning on this flag will cause the terminal to report the :kbd:`Esc`, :kbd:`alt+key`,
+:kbd:`ctrl+key`, :kbd:`ctrl+alt+key`, :kbd:`shift+alt+key` keys using ``CSI u`` sequences instead
 of legacy ones. Here key is any ASCII key as described in :ref:`legacy_text`.
 Additionally, all keypad keys will be reported as separate keys with ``CSI u``
 encoding, using dedicated numbers from the :ref:`table below <functional>`.
@@ -298,7 +314,7 @@ This makes it very easy to parse key events in an application. In particular,
 :kbd:`ctrl+c` will no longer generate the ``SIGINT`` signal, but instead be
 delivered as a ``CSI u`` escape code. This has the nice side effect of making it
 much easier to integrate into the application event loop. The only exceptions
-are the :kbd:`Enter, Tab and Backspace` keys which still generate the same
+are the :kbd:`Enter`, :kbd:`Tab` and :kbd:`Backspace` keys which still generate the same
 bytes as in legacy mode this is to allow the user to type and execute commands
 in the shell such as ``reset`` after a program that sets this mode crashes
 without clearing it.
@@ -338,8 +354,8 @@ only key events are sent. If the text is needed as well, combine with the
 Report associated text enhancement below.
 
 Additionally, with this mode, events for pressing modifier keys are reported.
-Note that *all* keys are reported as escape codes, including :kbd:`Enter, Tab,
-Backspace` etc.
+Note that *all* keys are reported as escape codes, including :kbd:`Enter`,
+:kbd:`Tab`, :kbd:`Backspace` etc.
 
 .. _report_text:
 
@@ -451,10 +467,11 @@ distinguish these, use the :ref:`disambiguate <disambiguate>` flag.
 Legacy text keys
 ~~~~~~~~~~~~~~~~~~~
 
-For legacy compatibility, the keys
-:kbd:`a-z 0-9 \` - = [ ] \ ; ' , . /` with the modifiers
-:kbd:`shift, alt, ctrl, shift+alt, ctrl+alt` are output using the
-following algorithm:
+For legacy compatibility, the keys :kbd:`a`-:kbd:`z` :kbd:`0`-:kbd:`9`
+:kbd:`\`` :kbd:`-` :kbd:`=` :kbd:`[` :kbd:`]` :kbd:`\\` :kbd:`;` :kbd:`'`
+:kbd:`,` :kbd:`.` :kbd:`/` with the modifiers :kbd:`shift`, :kbd:`alt`,
+:kbd:`ctrl`, :kbd:`shift+alt`, :kbd:`ctrl+alt` are output using the following
+algorithm:
 
 #. If the :kbd:`alt` key is pressed output the byte for ``ESC (0x1b)``
 #. If the :kbd:`ctrl` modifier is pressed map the key using the table
@@ -626,8 +643,8 @@ specification.
 * Incorrectly encoding shifted keys when shift modifier is used, for instance,
   for :kbd:`ctrl+shift+i` is encoded as :kbd:`ctrl+I`.
 
-* No way to have non-conflicting escape codes for :kbd:`alt+letter,
-  ctrl+letter, ctrl+alt+letter` key presses
+* No way to have non-conflicting escape codes for :kbd:`alt+letter`,
+  :kbd:`ctrl+letter`, :kbd:`ctrl+alt+letter` key presses
 
 * No way to specify both shifted and unshifted keys for robust shortcut
   matching (think matching :kbd:`ctrl+shift+equal` and :kbd:`ctrl+plus`)

docs/kittens/broadcast.rst

@@ -1,6 +1,8 @@
-broadcast - type text in all kitty windows
+broadcast
 ==================================================
 
+*Type text in all kitty windows simultaneously*
+
 The ``broadcast`` kitten can be used to type text simultaneously in
 all kitty windows (or a subset as desired).
 
@@ -17,7 +19,4 @@ are selected.
 .. program:: kitty +kitten broadcast
 
 
-Command Line Interface
---------------------------
-
 .. include:: /generated/cli-kitten-broadcast.rst

docs/kittens/clipboard.rst

@@ -1,6 +1,8 @@
-clipboard - copy/paste to the system clipboard
+clipboard
 ==================================================
 
+*Copy/paste to the system clipboard from shell scripts*
+
 .. highlight:: sh
 
 
@@ -21,7 +23,4 @@ use::
 .. program:: kitty +kitten clipboard
 
 
-Command Line Interface
---------------------------
-
 .. include:: /generated/cli-kitten-clipboard.rst

docs/kittens/custom.rst

@@ -88,11 +88,41 @@ function, telling kitty what kind of input your kitten would like. For example:
 
 
 This will send the plain text of the active window to the kitten's
-:file:`STDIN`. For text with formatting escape codes, use ``ansi``
-instead. If you want line wrap markers as well, use ``screen-ansi``
-or just ``screen``. For the scrollback buffer as well, use
-``history``, ``ansi-history`` or ``screen-history``. To get
-the currently selected text, use ``selection``.
+:file:`STDIN`. There are many other types of input you can ask for,
+described in the table below:
+
+.. table:: Types of input to kittens
+    :align: left
+
+    =========================== =======================================================================================================
+    Keyword                     Type of :file:`STDIN` input
+    =========================== =======================================================================================================
+    ``text``                    Plain text of active window
+    ``ansi``                    Formatted text of active window
+    ``screen``                  Plain text of active window with line wrap markers
+    ``screen-ansi``             Formatted text of active window with line wrap markers
+
+    ``history``                 Plain text of active window and its scrollback
+    ``ansi-history``            Formatted text of active window and its scrollback
+    ``screen-history``          Plain text of active window and its scrollback with line wrap markers
+    ``screen-ansi-history``     Formatted text of active window and its scrollback with line wrap markers
+
+    ``output``                  Plain text of the output from the last run command
+    ``output-screen``           Plain text of the output from the last run command with wrap markers
+    ``output-ansi``             Formatted text of the output from the last run command
+    ``output-screen-ansi``      Formatted text of the output from the last run command with wrap markers
+
+    ``selection``               The text currently selected with the mouse
+    =========================== =======================================================================================================
+
+In addition to ``output``, that gets the output of the last run command,
+``last_visited_output`` gives the output of the command last jumped to
+and ``first_output`` gives the output of the first command currently on screen.
+These can also be combined with ``screen`` and ``ansi`` for formatting.
+
+.. note::
+   For the types based on the output of a command,
+   :ref:`shell_integration` is required.
 
 
 Using kittens to script kitty, without any terminal UI
@@ -103,7 +133,8 @@ terminal program, you can tell the kittens system to run the
 ``handle_result()`` function without first running the ``main()`` function.
 
 For example, here is a kitten that "zooms/unzooms" the current terminal window
-by switching to the stack layout or back to the previous layout.
+by switching to the stack layout or back to the previous layout. This is
+equivalent to the builtin :ref:`action-toggle_layout` action.
 
 Create a file in the kitty config folder, :file:`~/.config/kitty/zoom_toggle.py`
 
@@ -185,6 +216,104 @@ The output of print statements will go to the ``STDOUT`` of the kitty process.
 So if you run kitty from another kitty instance, the output will be visible
 in the first kitty instance.
 
+Adding options to kittens
+----------------------------
+
+If you would like to use kitty's config framework to make your kittens
+configurable, you will need some boilerplate. In the directory
+of your kitten make the following files.
+
+:file:`kitten_options_definition.py`
+
+.. code-block:: python
+
+    from kitty.conf.types import Action, Definition
+
+    definition = Definition(
+        '!kitten_options_utils',
+        Action(
+            'map', 'parse_map',
+            {'key_definitions': 'kitty.conf.utils.KittensKeyMap'},
+            ['kitty.types.ParsedShortcut', 'kitty.conf.utils.KeyAction']
+        ),
+    )
+
+    agr = definition.add_group
+    egr = definition.end_group
+    opt = definition.add_option
+    map = definition.add_map
+
+    # main options {{{
+    agr('main', 'Main')
+
+    opt('some_option', '33',
+        option_type='some_option_parser',
+        long_text='''
+    Help text for this option
+    '''
+        )
+    egr()  # }}}
+
+    # shortcuts {{{
+    agr('shortcuts', 'Keyboard shortcuts')
+
+    map('Quit', 'quit q quit')
+    egr()  # }}}
+
+
+:file:`kitten_options_utils.py`
+
+.. code-block:: python
+
+    from kitty.conf.utils import KittensKeyDefinition, key_func, parse_kittens_key
+
+    func_with_args, args_funcs = key_func()
+    FuncArgsType = Tuple[str, Sequence[Any]]
+
+    def some_option_parser(val: str) -> int:
+        return int(val) + 3000
+
+    def parse_map(val: str) -> Iterable[KittensKeyDefinition]:
+        x = parse_kittens_key(val, args_funcs)
+        if x is not None:
+            yield x
+
+Then run::
+
+    kitty +runpy 'from kitty.conf.generate import main; main()' /path/to/kitten_options_definition.py
+
+You can parse and read the options in your kitten using the following code:
+
+.. code-block:: python
+
+    from .kitten_options_types import Options, defaults
+    from kitty.conf.utils import load_config as _load_config, parse_config_base
+    from typing import Optional, Iterable, Dict, Any
+
+    def load_config(*paths: str, overrides: Optional[Iterable[str]] = None) -> Options:
+        from .kitten_options_parse import  (
+            create_result_dict, merge_result_dicts, parse_conf_item
+        )
+
+        def parse_config(lines: Iterable[str]) -> Dict[str, Any]:
+            ans: Dict[str, Any] = create_result_dict()
+            parse_config_base(
+                lines,
+                parse_conf_item,
+                ans,
+            )
+            return ans
+
+        overrides = tuple(overrides) if overrides is not None else ()
+        opts_dict, paths = _load_config(defaults, parse_config, merge_result_dicts, *paths, overrides=overrides)
+        opts = Options(opts_dict)
+        opts.config_paths = paths
+        opts.config_overrides = overrides
+        return opts
+
+See the code for the builtin diff kitten for examples of creating more options
+and keyboard shortcuts.
+
 .. _external_kittens:
 
 Kittens created by kitty users

docs/kittens/diff.rst

@@ -1,6 +1,8 @@
-kitty-diff - A fast side-by-side diff tool with syntax highlighting and images
+kitty-diff
 ================================================================================
 
+*A fast side-by-side diff tool with syntax highlighting and images*
+
 .. highlight:: sh
 
 Major Features
@@ -21,13 +23,10 @@ Major Features
 .. figure:: ../screenshots/diff.png
    :alt: Screenshot, showing a sample diff
    :align: center
-   :scale: 100%
+   :width: 100%
 
    Screenshot, showing a sample diff
 
-.. contents::
-   :local:
-
 
 Installation
 ---------------
@@ -35,8 +34,8 @@ Installation
 Simply :ref:`install kitty <quickstart>`.  You also need
 to have either the `git <https://git-scm.com/>`_ program or the ``diff`` program
 installed. Additionally, for syntax highlighting to work,
-`pygments <http://pygments.org/>`_ must be installed (note that pygments is
-included in the macOS kitty app).
+`pygments <https://pygments.org/>`_ must be installed (note that pygments is
+included in the official kitty binary builds).
 
 
 Usage
@@ -68,14 +67,14 @@ Keyboard controls
 =========================   ===========================
 Action                      Shortcut
 =========================   ===========================
-Quit                        :kbd:`q, Ctrl+c, Esc`
-Scroll line up              :kbd:`k, up`
-Scroll line down            :kbd:`j, down`
+Quit                        :kbd:`q`, :kbd:`ctrl+c`, :kbd:`Esc`
+Scroll line up              :kbd:`k`, :kbd:`Up`
+Scroll line down            :kbd:`j`, :kbd:`Down`
 Scroll page up              :kbd:`PgUp`
 Scroll page down            :kbd:`PgDn`
 Scroll to top               :kbd:`Home`
 Scroll to bottom            :kbd:`End`
-Scroll to next page         :kbd:`Space, PgDn`
+Scroll to next page         :kbd:`Space`, :kbd:`PgDn`
 Scroll to previous page     :kbd:`PgUp`
 Scroll to next change       :kbd:`n`
 Scroll to previous change   :kbd:`p`
@@ -86,8 +85,8 @@ Restore default context     :kbd:`=`
 Search forwards             :kbd:`/`
 Search backwards            :kbd:`?`
 Clear search                :kbd:`Esc`
-Scroll to next match        :kbd:`>, .`
-Scroll to previous match    :kbd:`<, ,`
+Scroll to next match        :kbd:`>`, :kbd:`.`
+Scroll to previous match    :kbd:`<`, :kbd:`,`
 =========================   ===========================
 
 
@@ -121,8 +120,8 @@ Why does this work only in kitty?
 
 The diff kitten makes use of various features that are :doc:`kitty only
 </protocol-extensions>`,  such as the :doc:`kitty graphics protocol
-</graphics-protocol>`, the :ref:`extended keyboard protocol
-<extended-key-protocol>`, etc. It also leverages terminal program
+</graphics-protocol>`, the :doc:`extended keyboard protocol
+</keyboard-protocol>`, etc. It also leverages terminal program
 infrastructure I created for all of kitty's other kittens to reduce the amount
 of code needed (the entire implementation is under 2000 lines of code).
 
@@ -143,9 +142,6 @@ configuration directives.
 .. include:: /generated/conf-kitten-diff.rst
 
 
-Command Line Interface
--------------------------
-
 .. include:: /generated/cli-kitten-diff.rst
 
 

docs/kittens/hints.rst

@@ -9,7 +9,7 @@ browser.
 .. figure:: ../screenshots/hints_mode.png
     :alt: URL hints mode
     :align: center
-    :scale: 100%
+    :width: 100%
 
     URL hints mode
 
@@ -36,7 +36,7 @@ taken for different types of URLs <../open_actions>`.
 The hints kitten is very powerful to see more detailed help on its various
 options and modes of operation, see below. You can use these options to
 create mappings in :file:`kitty.conf` to select various different text
-snippets. See :sc:`insert_selected_path` for examples.
+snippets. See :sc:`insert_selected_path <insert_selected_path>` for examples.
 
 
 Completely customizing the matching and actions of the kitten
@@ -88,8 +88,13 @@ Now run kitty with::
 When you press the :kbd:`F1` key you will be able to select a word to
 look it up in the Google dictionary.
 
-
-Command Line Interface
--------------------------
-
 .. include:: ../generated/cli-kitten-hints.rst
+
+.. note::
+
+    To avoid having to specify the same command line options on every invocation,
+    you can use the :opt:`action_alias` option in :file:`kitty.conf`, creating aliases
+    that have common sets of options. For example::
+
+        action_alias myhints kitten hints --alphabet qfjdkslaureitywovmcxzpq1234567890
+        map f1 myhints --customize-processing custom-hints.py

docs/kittens/hyperlinked_grep.rst

@@ -3,7 +3,7 @@ Hyperlinked grep
 
 
 This kitten allows you to search your files using `ripgrep
-<https://www.google.com/search?q=ripgrep>`_ and open the results
+<https://github.com/BurntSushi/ripgrep>`_ and open the results
 directly in your favorite editor in the terminal, at the line containing
 the search result, simply by clicking on the result you want.
 
@@ -58,7 +58,7 @@ Then, for example, for ZSH, add the following to :file:`.zshrc`::
     compdef _rg hg
 
 To learn more about kitty's powerful framework for customizing URL click
-actions, :doc:`see here <../open_actions>`.
+actions, :doc:`see here </open_actions>`.
 
 Hopefully, someday this functionality will make it into some `upstream grep
 <https://github.com/BurntSushi/ripgrep/issues/665>`_

docs/kittens/icat.rst

@@ -1,6 +1,8 @@
-icat - Display images in the terminal
+icat
 ========================================
 
+*Display images in the terminal*
+
 The ``icat`` kitten can be used to display arbitrary images in the |kitty|
 terminal. Using it is as simple as::
 
@@ -35,7 +37,4 @@ The ``icat`` kitten has various command line arguments to allow it to be used
 from inside other programs to display images. In particular, :option:`--place`,
 :option:`--detect-support` and :option:`--print-window-size`.
 
-Command Line Interface
---------------------------
-
 .. include:: /generated/cli-kitten-icat.rst

docs/kittens/panel.rst

@@ -14,7 +14,7 @@ using terminal programs instead of GUI toolkits.
 .. figure:: ../screenshots/panel.png
    :alt: Screenshot, showing a sample panel
    :align: center
-   :scale: 100%
+   :width: 100%
 
    Screenshot, showing a sample panel
 
@@ -37,7 +37,4 @@ print out ``Hello, world!``. You can make the terminal program as complex as
 you like, as demonstrated in the screenshot above.
 
 
-Command Line Interface
--------------------------
-
 .. include:: ../generated/cli-kitten-panel.rst

docs/kittens/query_terminal.rst

@@ -15,7 +15,4 @@ for *XTGETTCAP* to see the syntax for the escape code and read the source
 of this kitten to find the values of the keys for the various queries.
 
 
-Command Line Interface
--------------------------
-
 .. include:: ../generated/cli-kitten-query_terminal.rst

docs/kittens/remote_file.rst

@@ -11,22 +11,26 @@ Then hold down :kbd:`ctrl+shift` and click the name of the file.
 .. figure:: ../screenshots/remote_file.png
     :alt: Remote file actions
     :align: center
-    :scale: 100%
+    :width: 100%
 
     Remote file actions
 
 |kitty| will ask you what you want to do with the remote file. You can choose
 to *Edit* it in which case kitty will download it and open it locally in your
-``EDITOR``. As you make changes to the file, they are automatically transferred
-to the remote computer. Note that this happens without needing to install *any*
-special software on the server, beyond ``ls`` that supports hyperlinks.
+:envvar:`EDITOR`. As you make changes to the file, they are automatically
+transferred to the remote computer. Note that this happens without needing
+to install *any* special software on the server, beyond ``ls`` that supports
+hyperlinks.
+
+.. seealso:: See the :doc:`transfer` kitten
 
 .. versionadded:: 0.19.0
 
 .. note::
    Nested SSH sessions are not supported. The kitten will always try to copy
    remote files from the first SSH host. This is because there is no way for
-   |kitty| to detect and follow a nested SSH session robustly.
+   |kitty| to detect and follow a nested SSH session robustly. Use the
+   :doc:`transfer` kitten for such situations.
 
 .. note::
    If you have not setup automatic password-less SSH access, then, when

docs/kittens/themes.rst

@@ -0,0 +1,78 @@
+Changing kitty colors
+========================
+
+The themes kitten allows you to easily change color themes, from a collection
+of almost two hundred pre-built themes available at `kitty-themes
+<https://github.com/kovidgoyal/kitty-themes>`_. To use it, simply run::
+
+    kitty +kitten themes
+
+
+.. image:: ../screenshots/themes.png
+   :alt: The themes kitten in action
+   :width: 600
+
+The kitten allows you to pick a theme, with live previews of the colors. You
+can choose between light and dark themes and search by theme name by just
+typing a few characters from the name.
+
+The kitten maintains a list of recently used themes to allow quick switching.
+
+If you want to restore the colors to default, you can do so by choosing the
+``Default`` theme.
+
+.. versionadded:: 0.23.0
+   The themes kitten
+
+How it works
+----------------
+
+A theme in kitty is just a :file:`.conf` file containing kitty settings.
+When you select a theme, the kitten simply copies the :file:`.conf` file
+to :file:`~/.config/kitty/current-theme.conf` and adds an include for
+:file:`current-theme.conf` to :file:`kitty.conf`. It also comments out
+any existing color settings in :file:`kitty.conf` so they do not interfere.
+
+Once that's done, the kitten sends kitty a signal to make it reload its config.
+
+Using your own themes
+-----------------------
+
+You can also create your own themes as :file:`.conf` files. Put them in the
+:file:`themes` sub-directory of the kitty config directory, usually,
+:file:`~/.config/kitty/themes` and the kitten will automatically add them to
+the list of themes. You can use this to modify the builtin themes, by giving
+the conf file the name :file:`Some theme name.conf` to override the builtin
+theme of that name. Note that after doing so you have to run the kitten and
+choose that theme once for your changes to be applied.
+
+
+Contributing new themes
+-------------------------
+
+If you wish to contribute a new theme to the kitty theme repository, start by
+going to the `kitty-themes <https://github.com/kovidgoyal/kitty-themes>`__
+repository.  `Fork it
+<https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_, and use the
+file :download:`template.conf
+<https://github.com/kovidgoyal/kitty-themes/raw/master/template.conf>` as a
+template when creating your theme. Once you are satisfied with how it looks,
+`submit a pull request
+<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_
+to have your theme merged into the `kitty-themes
+<https://github.com/kovidgoyal/kitty-themes>`__ repository, which will make it
+available in this kitten automatically.
+
+
+Changing the theme non-interactively
+---------------------------------------
+
+You can specify the theme name as an argument when invoking the kitten
+to have it change to that theme instantly. For example::
+
+    kitty +kitten themes --reload-in=all Dimmed Monokai
+
+Will change the theme to ``Dimmed Monokai`` in all running kitty
+instances. See below for more details on non-interactive operation.
+
+.. include:: ../generated/cli-kitten-themes.rst

docs/kittens/transfer.rst

@@ -0,0 +1,97 @@
+Transfer files
+================
+
+.. _rsync: https://en.wikipedia.org/wiki/Rsync
+
+.. warning::
+   This kitten is currently experimental, use with care.
+
+Transfer files to and from remote computers over the ``TTY`` device itself.
+This means that file transfer works over nested SSH sessions, serial links,
+etc. Anywhere you have a terminal device, you can transfer files.
+
+.. image:: ../screenshots/transfer.png
+   :alt: The transfer kitten at work
+
+This kitten supports transferring entire directory trees, preserving soft and
+hard links, file permissions, times, etc. It even supports the rsync_
+protocol to transfer only changes to large files.
+
+.. seealso:: See the :doc:`remote_file` kitten
+
+.. note::
+   This kitten (which practically means kitty) must be installed on the other
+   machine as well. If that is not possible you can use the :doc:`remote_file`
+   kitten instead. Or write your own script to use the underlying :doc:`file transfer
+   protocol </file-transfer-protocol>`.
+
+.. versionadded:: 0.24.0
+
+
+Basic usage
+---------------
+
+In what follows, the *local computer* is the computer running this kitten and
+the *remote computer* is the computer connected to the other end of the TTY pipe.
+
+To send a file from the local computer to the remote computer, simply run::
+
+    kitty +kitten transfer /path/to/local/file /path/to/destination/on/remote/computer
+
+You will be prompted by kitty for confirmation on allowing the transfer, and if
+you grant permission, the file will be copied.
+
+Similarly, to get a file from the remote computer to the local computer, use
+the :option:`kitty +kitten transfer --direction` option::
+
+    kitty +kitten transfer --direction=receive /path/to/remote/file /path/to/destination/on/local/computer
+
+Multiple files and even directories can be transferred::
+
+    kitty +kitten transfer file1 dir1 destination/
+
+Here :file:`file1` will be copied inside :file:`destination` and :file:`dir1`
+will be recursively copied into :file:`destination`. Note the trailing slash on
+:file:`destination`. This tells kitty the destination is a directory. While not
+strictly necessary (kitty will infer the need for a destination directory from
+the fact that you are copying multiple things) it is good practice to always
+use a trailing slash when the destination is supposed to be a directory.
+
+Also, when transferring multiple files/directories it is a good idea to
+use the :option:`kitty +kitten transfer --confirm-paths` option which will give
+you an opportunity to review and confirm the files that will be touched.
+
+
+Avoiding the confirmation prompt
+------------------------------------
+
+Normally, when you start a file transfer kitty will prompt you for
+confirmation. This is to ensure that hostile programs running on a remote
+machine cannot read/write files on your computer without your permission.
+If the remote machine is trusted and the connection between your computer
+and the remote machine is secure, then you can disable the confirmation prompt
+by:
+
+#. Setting the :opt:`file_transfer_confirmation_bypass` option to some
+   password.
+
+#. When invoking the kitten use the :option:`kitty +kitten transfer --permissions-bypass`
+   to supply the password you set in step one.
+
+.. warning:: Using a password to bypass confirmation means any software running
+   on the remote machine could potentially learn that password and use it to
+   gain full access to your computer. Also anyone that can intercept the data
+   stream between your computer and the remote machine can also learn this
+   password. So use it only with secure connections to trusted computers.
+
+
+Delta transfers
+-----------------------------------
+
+This kitten has the ability to use the rsync_ protocol to only transfer the
+differences between files. To turn it on use the :option:`kitty +kitten
+transfer --transmit-deltas` option. Note that this will actually be slower when
+transferring small files because of round trip overhead, so use with care.
+
+
+.. include:: ../generated/cli-kitten-transfer.rst

docs/kittens/unicode_input.rst

@@ -7,7 +7,7 @@ Press :sc:`input_unicode_character` to start the unicode input widget, shown bel
 .. figure:: ../screenshots/unicode.png
     :alt: A screenshot of the unicode input widget
     :align: center
-    :scale: 100%
+    :width: 100%
 
     A screenshot of the unicode input widget
 
@@ -23,12 +23,9 @@ the arrow keys/tab to select the character from the displayed matches. You can
 also type a space followed by a period and the index for the match if you don't
 like to use arrow keys.
 
-You can switch between modes using either the function keys or by pressing
-:kbd:`Ctrl+[` and :kbd:`Ctrl+]` or by pressing :kbd:`Ctrl+Tab` and
-:kbd:`Ctrl+Shift+Tab`.
+You can switch between modes using either the keys :kbd:`F1` ... :kbd:`F4` or
+:kbd:`Ctrl+1` ... :kbd:`Ctrl+4` or by pressing :kbd:`Ctrl+[` and :kbd:`Ctrl+]`
+or by pressing :kbd:`Ctrl+Tab` and :kbd:`Ctrl+Shift+Tab`.
 
 
-Command Line Interface
--------------------------
-
 .. include:: ../generated/cli-kitten-unicode_input.rst

docs/kittens_intro.rst

@@ -0,0 +1,73 @@
+.. _kittens:
+
+Extend with kittens
+-----------------------
+
+.. toctree::
+   :hidden:
+   :glob:
+
+   kittens/icat
+   kittens/diff
+   kittens/unicode_input
+   kittens/themes
+   kittens/hints
+   kittens/remote_file
+   kittens/hyperlinked_grep
+   kittens/transfer
+   kittens/custom
+   kittens/*
+
+|kitty| has a framework for easily creating terminal programs that make use of
+its advanced features. These programs are called kittens. They are used both
+to add features to |kitty| itself and to create useful standalone programs.
+Some prominent kittens:
+
+:doc:`icat <kittens/icat>`
+    Display images in the terminal
+
+
+:doc:`diff <kittens/diff>`
+    A fast, side-by-side diff for the terminal with syntax highlighting and
+    images
+
+
+:doc:`Unicode Input <kittens/unicode_input>`
+    Easily input arbitrary unicode characters in |kitty| by name or hex code.
+
+
+:doc:`Hints <kittens/hints>`
+    Select and open/paste/insert arbitrary text snippets such as URLs,
+    filenames, words, lines, etc. from the terminal screen.
+
+
+:doc:`Remote file <kittens/remote_file>`
+    Edit, open, or download remote files over SSH easily, by simply clicking on
+    the filename.
+
+
+:doc:`Transfer files <kittens/transfer>`
+    Transfer files and directories seamlessly and easily from remote machines over your existing
+    SSH sessions with a simple command.
+
+
+:doc:`Hyperlinked grep <kittens/hyperlinked_grep>`
+    Search your files using `ripgrep <https://github.com/BurntSushi/ripgrep>`_
+    and open the results directly in your favorite editor in the terminal,
+    at the line containing the search result, simply by clicking on the result you want.
+
+
+:doc:`Broadcast <kittens/broadcast>`
+    Type in one :term:`kitty window <window>` and have it broadcast to all (or a subset) of
+    other :term:`kitty windows <window>`.
+
+
+:doc:`Panel <kittens/panel>`
+    Draw a GPU accelerated dock panel on your desktop showing the output
+    from an arbitrary terminal program.
+
+
+:doc:`Clipboard <kittens/clipboard>`
+    Copy/paste to the clipboard from shell scripts, even over SSH.
+
+You can also :doc:`Learn to create your own kittens <kittens/custom>`.

docs/launch.rst

@@ -1,5 +1,5 @@
-Launching programs in new windows/tabs
-========================================
+The :command:`launch` command
+--------------------------------
 
 .. program:: launch
 
@@ -38,11 +38,23 @@ To pass the contents of the current screen and scrollback to the started process
 
 There are many more powerful options, refer to the complete list below.
 
+.. note::
+    To avoid duplicating launch actions with frequently used parameters, you can
+    use :opt:`action_alias` to define launch action aliases. For example::
+
+        action_alias launch_tab launch --cwd=current --type=tab
+        map f1 launch_tab vim
+        map f2 launch_tab emacs
+
+    The :kbd:`F1` key will now open vim in a new tab with the current windows
+    working directory
+
+
 The piping environment
 --------------------------
 
 When using :option:`launch --stdin-source`, the program to which the data is
-piped has a special environment variable declared, ``KITTY_PIPE_DATA`` whose
+piped has a special environment variable declared, :envvar:`KITTY_PIPE_DATA` whose
 contents are::
 
    KITTY_PIPE_DATA={scrolled_by}:{cursor_x},{cursor_y}:{lines},{columns}
@@ -89,6 +101,8 @@ For example::
     map f1 launch my-program @active-kitty-window-id
 
 
+.. _watchers:
+
 Watching launched windows
 ---------------------------
 
@@ -103,7 +117,7 @@ functions for the events you are interested in, for example:
         # Here data will contain old_geometry and new_geometry
 
     def on_focus_change(boss, window, data):
-        # Here data kill contain focused
+        # Here data will contain focused
 
     def on_close(boss, window, data):
         # called when window is closed, typically when the program running in
@@ -112,7 +126,7 @@ functions for the events you are interested in, for example:
 
 Every callback is passed a reference to the global ``Boss`` object as well as
 the ``Window`` object the action is occurring on. The ``data`` object is
-mapping that contains event dependent data. Some useful methods and attributes
+a dict that contains event dependent data. Some useful methods and attributes
 for the ``Window`` object are: ``as_text(as_ans=False, add_history=False,
 add_wrap_markers=False, alternate_screen=False)`` with which you can get the
 contents of the window and its scrollback buffer. Similarly,
@@ -130,6 +144,7 @@ this **may not** be the value of ``PATH`` inside a shell, as shell startup scrip
 often change the value of this variable. If it is not found there, then a
 system specific list of default paths is searched. If it is still not found,
 then your shell is run and the value of ``PATH`` inside the shell is used.
+See :opt:`exe_search_path` for details and how to control this.
 
 Syntax reference
 ------------------

docs/layouts.rst

@@ -1,5 +1,5 @@
-Layouts
-============
+Arrange windows
+-------------------
 
 kitty has the ability to define its own windows that can be tiled next to each
 other in arbitrary arrangements, based on *Layouts*, see below for examples:
@@ -8,7 +8,7 @@ other in arbitrary arrangements, based on *Layouts*, see below for examples:
 .. figure:: screenshots/screenshot.png
     :alt: Screenshot, showing three programs in the 'Tall' layout
     :align: center
-    :scale: 100%
+    :width: 100%
 
     Screenshot, showing vim, tig and git running in |kitty| with the 'Tall' layout
 
@@ -16,7 +16,7 @@ other in arbitrary arrangements, based on *Layouts*, see below for examples:
 .. figure:: screenshots/splits.png
     :alt: Screenshot, showing windows in the 'Splits' layout
     :align: center
-    :scale: 100%
+    :width: 100%
 
     Screenshot, showing windows with arbitrary arrangement in the 'Splits'
     layout
@@ -27,9 +27,6 @@ you can switch layouts using :sc:`next_layout`. To control which layouts
 are available use :opt:`enabled_layouts`, the first listed layout becomes
 the default. Individual layouts and how to use them are described below.
 
-.. contents::
-   :local:
-
 
 The Stack Layout
 ------------------
@@ -148,11 +145,14 @@ define a few extra keybindings in :file:`kitty.conf`::
     map ctrl+down neighboring_window down
 
 Now you can create horizontal and vertical splits by using :kbd:`F5` and
-:kbd:`F6`. You can move them around using :kbd:`shift+arrow keys`
-and you can move focus to neighboring windows using :kbd:`ctrl+arrow keys`.
+:kbd:`F6`. You can move them around using :kbd:`shift+arrow` keys
+and you can move focus to neighboring windows using :kbd:`ctrl+arrow` keys.
 You can switch an existing split from horizontal to vertical and vice versa
 using :kbd:`F7`. Finally, windows can be resized using :ref:`window_resizing`.
 
+Note that you can swap the windows in a split using the ``rotate`` action with
+an argument of ``180`` and rotate and swap with an argument of ``270``.
+
 This layout takes one option, ``split_axis`` that controls whether new windows
 are placed into vertical or horizontal splits, by default::
 

docs/marks.rst

@@ -1,11 +1,14 @@
-Marks
-=================
+Mark text on screen
+---------------------
 
 
 kitty has the ability to mark text on the screen based on regular expressions.
 This can be useful to highlight words or phrases when browsing output from long
 running programs or similar. Lets start with a few examples:
 
+Examples
+----------
+
 Suppose we want to be able to highlight the word ERROR in the current window.
 Add the following to :file:`kitty.conf`::
 
@@ -89,12 +92,11 @@ The syntax of the :code:`toggle_marker` command is::
 
 Here :code:`marker-type` is one of:
 
-    * :code:`text` - simple substring matching
-    * :code:`itext` - case-insensitive substring matching
-    * :code:`regex` - A python regular expression
-    * :code:`iregex` - A case-insensitive python regular expression
-    * :code:`function` - An arbitrary function defined in a python file, see
-      :ref:`marker_funcs`.
+* :code:`text` - simple substring matching
+* :code:`itext` - case-insensitive substring matching
+* :code:`regex` - A python regular expression
+* :code:`iregex` - A case-insensitive python regular expression
+* :code:`function` - An arbitrary function defined in a python file, see :ref:`marker_funcs`.
 
 .. _marker_funcs:
 

docs/open_actions.rst

@@ -1,10 +1,11 @@
-Customizing the actions taken when clicking on links
+Scripting the mouse click
 ======================================================
 
-|kitty| has support for `terminal hyperlinks <https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>`_. These
+|kitty| has support for `terminal hyperlinks
+<https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda>`_. These
 are generated by many terminal programs, such as ``ls``, ``gcc``, ``systemd``,
-``mdcat``, etc. You can customize exactly what happens when clicking on these hyperlinks
-in |kitty|.
+:ref:`tool_mdcat`, etc. You can customize exactly what happens when clicking on these
+hyperlinks in |kitty|.
 
 You can tell kitty to take arbitrarily many, complex actions
 when a link is clicked. Let us illustrate with some examples, first. Create
@@ -57,6 +58,12 @@ some special variables, documented below:
 ``FRAGMENT``
     The fragment (unquoted), if any of the URL or the empty string.
 
+
+.. note::
+   You can use the :opt:`action_alias` option just as in kitty.conf to
+   define aliases for frequently used actions.
+
+
 .. _matching_criteria:
 
 Matching criteria
@@ -85,7 +92,7 @@ lines. The various available criteria are:
     :file:`mime.types` in the kitty configuration directory. Useful if your
     system MIME database does not have definitions you need. This file is
     in the standard format of one definition per line, like: ``text/plain rst
-    md``.
+    md``. Note that the MIME type for directories is ``inode/directory``.
 
 ``ext``
     A comma separated list of file extensions, for example: ``jpeg, tar.gz``

docs/overview.rst

@@ -0,0 +1,301 @@
+Overview
+==============
+
+Design philosophy
+-------------------
+
+|kitty| is designed for power keyboard users. To that end all its controls
+work with the keyboard (although it fully supports mouse interactions as
+well). Its configuration is a simple, human editable, single file for
+easy reproducibility (I like to store configuration in source control).
+
+The code in |kitty| is designed to be simple, modular and hackable. It is
+written in a mix of C (for performance sensitive parts) and Python (for
+easy hackability of the UI). It does not depend on any large and complex
+UI toolkit, using only OpenGL for rendering everything.
+
+Finally, |kitty| is designed from the ground up to support all modern
+terminal features, such as unicode, true color, bold/italic fonts, text
+formatting, etc. It even extends existing text formatting escape codes,
+to add support for features not available elsewhere, such as colored and
+styled (curly) underlines. One of the design goals of |kitty| is to be
+easily extensible so that new features can be added in the future with
+relatively little effort.
+
+.. include:: basic.rst
+
+
+Configuring kitty
+-------------------
+
+|kitty| is highly configurable, everything from keyboard shortcuts to
+painting frames-per-second. Press :sc:`edit_config_file` in kitty
+to open its fully commented sample config file in your text editor.
+For details see the :doc:`configuration docs <conf>`.
+
+.. toctree::
+   :hidden:
+
+   conf
+
+
+.. _layouts:
+
+Layouts
+----------
+
+A :term:`layout` is an arrangement of multiple :term:`kitty windows <window>`
+inside a top-level :term:`OS window <os_window>`. The layout manages all its
+windows automatically, resizing and moving them as needed. You can create a new
+:term:`window` using the :sc:`new_window` key combination.
+
+Currently, there are seven layouts available:
+
+* **Fat** -- One (or optionally more) windows are shown full width on the top, the rest of the windows are shown side-by-side on the bottom
+* **Grid** -- All windows are shown in a grid
+* **Horizontal** -- All windows are shown side-by-side
+* **Splits** -- Windows arranged in arbitrary patterns created using horizontal and vertical splits
+* **Stack** -- Only a single maximized window is shown at a time
+* **Tall** -- One (or optionally more) windows are shown full height on the left, the rest of the windows are shown one below the other on the right
+* **Vertical** -- All windows are shown one below the other
+
+By default, all layouts are enabled and you can switch between layouts using
+the :sc:`next_layout` key combination. You can also create shortcuts to select
+particular layouts, and choose which layouts you want to enable/disable, see
+:ref:`conf-kitty-shortcuts.layout` for examples. The first layout listed in
+:opt:`enabled_layouts` becomes the default layout.
+
+For more details on the layouts and how to use them see :doc:`the documentation
+<layouts>`.
+
+.. toctree::
+   :hidden:
+
+   layouts
+
+Extending kitty
+------------------
+
+kitty has a powerful framework for scripting. You can create small terminal
+programs called :doc:`kittens <kittens_intro>`. These can used to add features
+to kitty, for example, :doc:`editing remote files <kittens/remote_file>` or
+:doc:`inputting unicode characters <kittens/unicode_input>`. They can also be
+used to create programs that leverage kitty's powerful features, for example,
+:doc:`viewing images <kittens/icat>` or :doc:`diffing files with images
+<kittens/diff>`.
+
+You can :doc:`create your own kittens to scratch your own itches
+<kittens/custom>`.
+
+For a list of all the builtin kittens, :ref:`see here <kittens>`.
+
+.. toctree::
+   :hidden:
+
+   kittens_intro
+
+
+Remote control
+------------------
+
+|kitty| has a very powerful system that allows you to control it from the
+:doc:`shell prompt, even over SSH <remote-control>`. You can change colors,
+fonts, open new :term:`windows <window>`, :term:`tabs <tab>`, set their titles,
+change window layout, get text
+from one window and send text to another, etc, etc. The possibilities are
+endless. See the :doc:`tutorial <remote-control>` to get started.
+
+.. toctree::
+   :hidden:
+
+   remote-control
+
+
+.. _sessions:
+
+Startup Sessions
+------------------
+
+You can control the :term:`tabs <tab>`, :term:`kitty window <window>` layout,
+working directory, startup programs,
+etc. by creating a "session" file and using the :option:`kitty --session`
+command line flag or the :opt:`startup_session` option in :file:`kitty.conf`.
+For example:
+
+.. code-block:: session
+
+    # Set the layout for the current tab
+    layout tall
+    # Set the working directory for windows in the current tab
+    cd ~
+    # Create a window and run the specified command in it
+    launch zsh
+    # Create a window with some environment variables set and run
+    # vim in it
+    launch --env FOO=BAR vim
+    # Set the title for the next window
+    launch --title "Chat with x" irssi --profile x
+
+    # Create a new tab (the part after new_tab is the optional tab
+    # name which will be displayed in the tab bar, if omitted, the
+    # title of the active window will be used instead)
+    new_tab my tab
+    cd ~/somewhere
+    # Set the layouts allowed in this tab
+    enabled_layouts tall, stack
+    # Set the current layout
+    layout stack
+    launch zsh
+
+    # Create a new OS window
+    new_os_window
+    # set new window size to 80x25 cells
+    os_window_size 80c 25c
+    # set the --class for the new OS window
+    os_window_class mywindow
+    launch sh
+    # Make the current window the active (focused) window
+    focus
+    launch emacs
+
+.. note::
+    The :doc:`launch <launch>` command when used in a session file
+    cannot create new OS windows, or tabs.
+
+
+Creating tabs/windows
+-------------------------------
+
+kitty can be told to run arbitrary programs in new :term:`tabs <tab>`,
+:term:`windows <window>` or :term:`overlays <overlay>` at a keypress.
+To learn how to do this, see :doc:`here <launch>`.
+
+.. toctree::
+   :hidden:
+
+   launch
+
+
+Mouse features
+-------------------
+
+* You can click on a URL to open it in a browser.
+* You can double click to select a word and then drag to select more words.
+* You can triple click to select a line and then drag to select more lines.
+* You can triple click while holding :kbd:`ctrl+alt` to select from clicked
+  point to end of line.
+* You can right click to extend a previous selection.
+* You can hold down :kbd:`ctrl+alt` and drag with the mouse to select in
+  columns.
+* Selecting text automatically copies it to the primary clipboard (on
+  platforms with a primary clipboard).
+* You can middle click to paste from the primary clipboard (on platforms
+  with a primary clipboard).
+* You can right click while holding :kbd:`ctrl+shift` to open the output
+  of the clicked on command in a pager (requires :ref:`shell_integration`)
+* You can select text with kitty even when a terminal program has grabbed
+  the mouse by holding down the :kbd:`shift` key
+
+All these actions can be customized in :file:`kitty.conf` as described
+:ref:`here <conf-kitty-mouse.mousemap>`.
+
+You can also customize what happens when clicking on :term:`hyperlinks` in kitty,
+having it open files in your editor, download remote files, open things
+in your browser, etc.
+
+For details, see :doc:`here <open_actions>`.
+
+.. toctree::
+   :hidden:
+
+   open_actions
+
+Font control
+-----------------
+
+|kitty| has extremely flexible and powerful font selection features. You can
+specify individual families for the regular, bold, italic and bold+italic
+fonts. You can even specify specific font families for specific ranges of
+unicode characters. This allows precise control over text rendering. It can
+come in handy for applications like powerline, without the need to use patched
+fonts. See the various font related configuration directives in
+:ref:`conf-kitty-fonts`.
+
+
+.. _scrollback:
+
+The scrollback buffer
+-----------------------
+
+|kitty| supports scrolling back to view history, just like most terminals. You
+can use either keyboard shortcuts or the mouse scroll wheel to do so.  However,
+|kitty| has an extra, neat feature. Sometimes you need to explore the
+scrollback buffer in more detail, maybe search for some text or refer to it
+side-by-side while typing in a follow-up command. |kitty| allows you to do this
+by pressing the :sc:`show_scrollback` key-combination, which will open the
+scrollback buffer in your favorite pager program (which is ``less`` by default).
+Colors and text formatting are preserved. You can explore the scrollback buffer
+comfortably within the pager.
+
+Additionally, you can pipe the contents of the scrollback buffer to an
+arbitrary, command running in a new :term:`window`, :term:`tab` or :term:`overlay`,
+for example::
+
+   map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting less +G -R
+
+Would open the scrollback buffer in a new :term:`window` when you press the :kbd:`F1`
+key. See :sc:`show_scrollback <show_scrollback>` for details.
+
+If you want to use it with an editor such as vim to get more powerful features,
+you can see tips for doing so, in
+`this thread <https://github.com/kovidgoyal/kitty/issues/719>`_.
+
+If you wish to store very large amounts of scrollback to view using the piping or
+:sc:`show_scrollback <show_scrollback>` features, you can use the
+:opt:`scrollback_pager_history_size` option.
+
+
+Integration with shells
+---------------------------------
+
+kitty has the ability to integrate closely within common shells, such as `zsh
+<https://www.zsh.org/>`_, `fish <https://fishshell.com>`_ and `bash
+<https://www.gnu.org/software/bash/>`_ to enable features such as jumping to
+previous prompts in the scrollback, viewing the output of the last command in
+:program:`less`, using the mouse to move the cursor while editing prompts, etc.
+See :doc:`shell-integration` for details.
+
+.. toctree::
+   :hidden:
+
+   shell-integration
+
+.. _cpbuf:
+
+Multiple copy/paste buffers
+-----------------------------
+
+In addition to being able to copy/paste from the system clipboard, in |kitty| you
+can also setup an arbitrary number of copy paste buffers. To do so, simply add
+something like the following to your :file:`kitty.conf`::
+
+   map f1 copy_to_buffer a
+   map f2 paste_from_buffer a
+
+This will allow you to press :kbd:`F1` to copy the current selection to an
+internal buffer named ``a`` and :kbd:`F2` to paste from that buffer. The buffer
+names are arbitrary strings, so you can define as many such buffers as you
+need.
+
+
+Marks
+-------------
+
+kitty has the ability to mark text on the screen based on regular expressions.
+This can be useful to highlight words or phrases when browsing output from long
+running programs or similar. To learn how this feature works, see :doc:`marks`.
+
+.. toctree::
+   :hidden:
+
+   marks

docs/performance.rst

@@ -1,4 +1,4 @@
-|kitty| Performance
+Performance
 ===================
 
 The main goals for |kitty| performance are user perceived latency while typing

docs/pipe.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 Working with the screen and history buffer contents
 ======================================================
 

docs/protocol-extensions.rst

@@ -1,7 +1,7 @@
-Extensions to the xterm protocol
+Terminal protocol extensions
 ===================================
 
-|kitty| has a few extensions to the xterm protocol, to enable advanced features.
+|kitty| has extensions to the legacy terminal protocol, to enable advanced features.
 These are typically in the form of new or re-purposed escape codes. While these
 extensions are currently |kitty| specific, it would be nice to get some of them
 adopted more broadly, to push the state of terminal emulators forward.
@@ -19,301 +19,15 @@ If you wish to discuss these extensions, propose additions/changes to them
 please do so by opening issues in the `GitHub
 <https://github.com/kovidgoyal/kitty/issues>`_ bug tracker.
 
-.. contents::
-   :local:
 
-Colored and styled underlines
--------------------------------
-
-|kitty| supports colored and styled (wavy) underlines. This is of particular
-use in terminal editors such as vim and emacs to display red, wavy underlines
-under mis-spelled words and/or syntax errors. This is done by re-purposing some
-SGR escape codes that are not used in modern terminals (`CSI codes
-<https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_sequences>`_)
-
-To set the underline style::
-
-    <ESC>[4:0m  # this is no underline
-    <ESC>[4:1m  # this is a straight underline
-    <ESC>[4:2m  # this is a double underline
-    <ESC>[4:3m  # this is a curly underline
-    <ESC>[4:4m  # this is a dotted underline (not implemented in kitty)
-    <ESC>[4:5m  # this is a dashed underline (not implemented in kitty)
-    <ESC>[4m    # this is a straight underline (for backwards compat)
-    <ESC>[24m   # this is no underline (for backwards compat)
-
-To set the underline color (this is reserved and as far as I can tell not actually used for anything)::
-
-    <ESC>[58...m
-
-This works exactly like the codes ``38, 48`` that are used to set foreground and
-background color respectively.
-
-To reset the underline color (also previously reserved and unused)::
-
-    <ESC>[59m
-
-The underline color must remain the same under reverse video, if it has a
-color, if not, it should follow the foreground color.
-
-To detect support for this feature in a terminal emulator, query the terminfo database
-for the ``Su`` boolean capability.
-
-Graphics rendering
----------------------
-
-See :doc:`/graphics-protocol` for a description
-of this protocol to enable drawing of arbitrary raster images in the terminal.
-
-
-.. _extended-key-protocol:
-
-Keyboard handling
--------------------
-
-kitty has a :doc:`keyboard protocol <keyboard-protocol>` for reporting key
-presses to terminal applications that solves all key handling issues in
-terminal applications.
-
-.. _ext_styles:
-
-Setting text styles/colors in arbitrary regions of the screen
-------------------------------------------------------------------
-
-There already exists an escape code to set *some* text attributes in arbitrary
-regions of the screen, `DECCARA
-<https://vt100.net/docs/vt510-rm/DECCARA.html>`_.  However, it is limited to
-only a few attributes. |kitty| extends this to work with *all* SGR attributes.
-So, for example, this can be used to set the background color in an arbitrary
-region of the screen.
-
-The motivation for this extension is the various problems with the existing
-solution for erasing to background color, namely the *background color erase
-(bce)* capability. See
-`this discussion <https://github.com/kovidgoyal/kitty/issues/160#issuecomment-346470545>`_
-and `this FAQ <https://invisible-island.net/ncurses/ncurses.faq.html#bce_mismatches>`_
-for a summary of problems with *bce*.
-
-For example, to set the background color to blue in a
-rectangular region of the screen from (3, 4) to (10, 11), you use::
-
-    <ESC>[2*x<ESC>[4;3;11;10;44$r<ESC>[*x
-
-
-Saving and restoring colors
----------------------------------------------------------------------------------
-
-It is often useful for a full screen application with its own color themes to
-set the default foreground, background, selection and cursor colors and the
-ANSI color table. This allows for various performance optimizations when
-drawing the screen. The problem is that if the user previously used the escape
-codes to change these colors herself, then running the full screen application
-will lose her changes even after it exits. To avoid this, kitty introduces a
-new pair of *OSC* escape codes to push and pop the current color values from a
-stack::
-
-    <ESC>]30001<ESC>\  # push onto stack
-    <ESC>]30101<ESC>\  # pop from stack
-
-These escape codes save/restore the colors, default
-background, default foreground, selection background, selection foreground and
-cursor color and the 256 colors of the ANSI color table.
-
-.. note:: In July 2020, after several years, XTerm copied this protocol
-   extension, without acknowledgement, and using incompatible escape codes
-   (XTPUSHCOLORS, XTPOPCOLORS, XTREPORTCOLORS). And they decided to save not
-   just the dynamic colors but the entire ANSI color table. In the interests of
-   promoting interoperability, kitty added support for XTerm's escape codes as
-   well, and changed this extension to also save/restore the entire ANSI color
-   table.
-
-
-Pasting to clipboard
-----------------------
-
-|kitty| implements the OSC 52 escape code protocol to get/set the clipboard
-contents (controlled via the :opt:`clipboard_control` setting). There is one
-difference in kitty's implementation compared to some other terminal emulators.
-|kitty| allows sending arbitrary amounts of text to the clipboard. It does so
-by modifying the protocol slightly. Successive OSC 52 escape codes to set the
-clipboard will concatenate, so::
-
-    <ESC>]52;c;<payload1><ESC>\
-    <ESC>]52;c;<payload2><ESC>\
-
-will result in the clipboard having the contents ``payload1 + payload2``. To
-send a new string to the clipboard send an OSC 52 sequence with an invalid payload
-first, for example::
-
-    <ESC>]52;c;!<ESC>\
-
-Here ``!`` is not valid base64 encoded text, so it clears the clipboard.
-Further, since it is invalid, it should be ignored by terminal emulators
-that do not support this extension, thereby making it safe to use, simply
-always send it before starting a new OSC 52 paste, even if you aren't chunking
-up large pastes, that way kitty won't concatenate your paste, and it will have
-no ill-effects in other terminal emulators.
-
-In case you're using software that can't be easily adapted to this
-protocol extension, it can be disabled by specifying ``no-append`` to the
-:opt:`clipboard_control` setting.
-
-
-.. _unscroll:
-
-Unscrolling the screen
------------------------
-
-This is a small extension to the `SD (Pan up) escape code
-<https://vt100.net/docs/vt510-rm/SD.html>`_ from the VT-420 terminal. The
-``SD`` escape code normally causes the text on screen to scroll down by the
-specified number of lines, with empty lines appearing at the top of the screen.
-This extension allows the new lines to be filled in from the scrollback buffer
-instead of being blank.
-
-The motivation for this is that many modern shells will show completions in a
-block of lines under the cursor, this causes some of the on-screen text to be
-lost even after the completion is completed, because it has scrolled off
-screen. This escape code allows that text to be restored.
-
-If the scrollback buffer is empty or there is no scrollback buffer, such as for
-the alternate screen, then the newly inserted lines must be empty, just as with
-the original ``SD`` escape code. The maximum number of lines that can be
-scrolled down is implementation defined, but must be at least one screen worth.
-
-The syntax of the escape code is identical to that of ``SD`` except that it has
-a trailing ``+`` modifier. This is legal under the `ECMA 48 standard
-<https://www.ecma-international.org/publications-and-standards/standards/ecma-48/>`_
-and unused for any other purpose as far as I can tell. So for example, to
-unscroll three lines, the escape code would be::
-
-    CSI 3 + T
-
-See `discussion here
-<https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/30>`_.
-
-.. versionadded:: 0.20.2
-
-
-.. _desktop_notifications:
-
-
-Desktop notifications
----------------------------------
-
-|kitty| implements an extensible escape code (OSC 99) to show desktop
-notifications. It is easy to use from shell scripts and fully extensible to
-show title and body.  Clicking on the notification can optionally focus the
-window it came from, and/or send an escape code back to the application running
-in that window.
-
-The design of the escape code is partially based on the discussion in
-the defunct
-`terminal-wg <https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/13>`_
-
-The escape code has the form::
-
-    <OSC> 99 ; metadata ; payload <terminator>
-
-Here ``<OSC>`` is :code:`<ESC>]` and ``<terminator>`` is
-:code:`<ESC><backslash>`.  The metadata is a section of colon separated
-:code:`key=value` pairs. Every key must be a single character from the set
-:code:`a-zA-Z` and every value must be a word consisting of characters from
-the set :code:`a-zA-Z0-9-_/\+.,(){}[]*&^%$#@!`~`. The payload must be
-interpreted based on the metadata section. The two semi-colons *must* always be
-present even when no metadata is present.
-
-Before going into details, lets see how one can display a simple, single line
-notification from a shell script::
-
-    printf '\x1b]99;;Hello world\x1b\\'
-
-To show a message with a title and a body::
-
-    printf '\x1b]99;i=1:d=0;Hello world\x1b\\'
-    printf '\x1b]99;i=1:d=1:p=body;This is cool\x1b\\'
-
-The most important key in the metadata is the ``p`` key, it controls how the
-payload is interpreted. A value of ``title`` means the payload is setting the
-title for the notification. A value of ``body`` means it is setting the body,
-and so on, see the table below for full details.
-
-The design of the escape code is fundamentally chunked, this is because
-different terminal emulators have different limits on how large a single escape
-code can be. Chunking is accomplished by the ``i`` and ``d`` keys. The ``i``
-key is the *notification id* which can be any string containing the characters
-``[a-zA-Z0-9_-+.]``. The ``d`` key stands for *done* and
-can only take the values ``0`` and ``1``. A value of ``0`` means the
-notification is not yet done and the terminal emulator should hold off
-displaying it. A value of ``1`` means the notification is done, and should be
-displayed. You can specify the title or body multiple times and the terminal
-emulator will concatenate them, thereby allowing arbitrarily long text
-(terminal emulators are free to impose a sensible limit to avoid
-Denial-of-Service attacks).
-
-Both the ``title`` and ``body`` payloads must be either UTF-8 encoded plain
-text with no embedded escape codes, or UTF-8 text that is base64 encoded, in
-which case there must be an ``e=1`` key in the metadata to indicate the payload
-is base64 encoded.
-
-When the user clicks the notification, a couple of things can happen, the
-terminal emulator can focus the window from which the notification came, and/or
-it can send back an escape code to the application indicating the notification
-was activated. This is controlled by the ``a`` key which takes a comma
-separated set of values, ``report`` and ``focus``. The value ``focus`` means
-focus the window from which the notification was issued and is the default.
-``report`` means send an escape code back to the application. The format of the
-returned escape code is::
-
-    <OSC> 99 ; i=identifier ; <terminator>
-
-The value of ``identifier`` comes from the ``i`` key in the escape code sent by
-the application. If the application sends no identifier, then the terminal
-*must* use ``i=0``. Actions can be preceded by a negative sign to turn them
-off, so for example if you do not want any action, turn off the default
-``focus`` action with::
-
-    a=-focus
-
-Complete specification of all the metadata keys is in the table below. If a
-terminal emulator encounters a key in the metadata it does not understand,
-the key *must* be ignored, to allow for future extensibility of this escape
-code. Similarly if values for known keys are unknown, the terminal emulator
-*should* either ignore the entire escape code or perform a best guess effort
-to display it based on what it does understand.
-
-.. note::
-   It is possible to extend this escape code to allow specifying an icon for
-   the notification, however, given that some platforms, such as macOS, dont
-   allow displaying custom icons on a notification, at all, it was decided to
-   leave it out of the spec for the time being.
-
-   Similarly, features such as scheduled notifications could be added in future
-   revisions.
-
-
-=======  ====================  =========  =================
-Key      Value                 Default    Description
-=======  ====================  =========  =================
-``a``    Comma separated list  ``focus``  What action to perform when the
-         of ``report``,                   notification is clicked
-         ``focus``, with
-         optional leading
-         ``-``
-
-``d``    ``0`` or ``1``        ``1``      Indicates if the notification is
-                                          complete or not.
-
-``e``    ``0`` or ``1``        ``0``      If set to ``1`` means the payload is base64 encoded UTF-8,
-                                          otherwise it is plain UTF-8 text with no C0 control codes in it
-
-``i``    ``[a-zA-Z0-9-_+.]``   ``0``      Identifier for the notification
-
-``p``    One of ``title`` or   ``title``  Whether the payload is the notification title or body. If a
-         ``body``.                        notification has no title, the body will be used as title.
-=======  ====================  =========  =================
-
-
-.. note::
-   |kitty| also supports the legacy OSC 9 protocol developed by iTerm2 for
-   desktop notifications.
+.. toctree::
+   :maxdepth: 1
+
+   underlines
+   graphics-protocol
+   keyboard-protocol
+   file-transfer-protocol
+   desktop-notifications
+   unscroll
+   color-stack
+   deccara

docs/quickstart.rst

@@ -0,0 +1,28 @@
+.. _quickstart:
+
+Quickstart
+===========
+
+.. toctree::
+   :hidden:
+
+   binary
+   build
+
+Pre-built binaries of |kitty| are available for both macOS and Linux.
+See the :doc:`binary install instructions </binary>`. You can also
+:doc:`build from source </build>`.
+
+Additionally, you can use your favorite package manager to install the |kitty|
+package, but note that some Linux distribution packages are woefully outdated.
+|kitty| is available in a vast number of package repositories for macOS
+and Linux.
+
+.. image:: https://repology.org/badge/tiny-repos/kitty.svg
+   :target: https://repology.org/project/kitty/versions
+   :alt: Number of repositories kitty is available in
+
+See :doc:`Configuring kitty <conf>` for help on configuring |kitty| and
+:doc:`Invocation <invocation>` for the command line arguments |kitty| supports.
+
+For a tour of kitty's design and features, see the :doc:`/overview`.

docs/rc_protocol.rst

@@ -1,5 +1,5 @@
-Documentation for the kitty remote control protocol
-======================================================
+The kitty remote control protocol
+==================================
 
 The kitty remote control protocol is a simple protocol that involves sending
 data to kitty in the form of JSON. Any individual command of kitty has the
@@ -37,5 +37,4 @@ with the following command line::
 
     echo -en '\eP@kitty-cmd{"cmd":"ls","version":[0,14,2]}\e\' | socat - unix:/tmp/test | awk '{ print substr($0, 13, length($0) - 14) }' | jq -c '.data | fromjson' | jq .
 
-
 .. include:: generated/rc.rst

docs/remote-control.rst

@@ -1,17 +1,15 @@
-:tocdepth: 2
-
-Controlling kitty from scripts or the shell
-==============================================
+Control kitty from scripts
+----------------------------
 
 .. highlight:: sh
 
-Tutorial
-----------
-
 |kitty| can be controlled from scripts or the shell prompt. You can open new
 windows, send arbitrary text input to any window, name windows and tabs, etc.
 Let's walk through a few examples of controlling |kitty|.
 
+Tutorial
+------------
+
 Start by running |kitty| as::
 
     kitty -o allow_remote_control=yes -o enabled_layouts=tall
@@ -142,6 +140,8 @@ running on other computers (for example, over ssh) or as other users.
    kitty, as if you were running with ``allow_remote_control`` turned on.
 
 
+.. _rc_mapping:
+
 Mapping key presses to remote control commands
 --------------------------------------------------
 
@@ -172,10 +172,15 @@ Now press, F1 and start typing, what you type will be sent to all windows,
 live, as you type it.
 
 
-Documentation for the remote control protocol
+The remote control protocol
 -----------------------------------------------
 
 If you wish to develop your own client to talk to |kitty|, you
-can use the :doc:`rc_protocol`.
+can use the :doc:`protocol specification <rc_protocol>`.
+
+.. toctree::
+   :hidden:
+
+   rc_protocol
 
 .. include:: generated/cli-kitty-at.rst

docs/requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+furo
+sphinx-copybutton
+sphinxext-opengraph
+sphinx-inline-tabs

docs/shell-integration.rst

@@ -0,0 +1,265 @@
+.. _shell_integration:
+
+Shell integration
+-------------------
+
+kitty has the ability to integrate closely within common shells, such as `zsh
+<https://www.zsh.org/>`_, `fish <https://fishshell.com>`_ and `bash
+<https://www.gnu.org/software/bash/>`_ to enable features such as jumping to
+previous prompts in the scrollback, viewing the output of the last command in
+:program:`less`, using the mouse to move the cursor while editing prompts, etc.
+
+.. versionadded:: 0.24.0
+
+Features
+-------------
+
+* Open the output of the last command in a pager such as :program:`less`
+  (:sc:`show_last_command_output`)
+
+* Jump to the previous/next prompt in the scrollback
+  (:sc:`scroll_to_previous_prompt` /  :sc:`scroll_to_next_prompt`)
+
+* Click with the mouse anywhere in the current command to move the cursor there
+
+* Hold :kbd:`ctrl+shift` and right-click on any command output in the scrollback
+  to view it in a pager
+
+* The current working directory or the command being executed are automatically
+  displayed in the kitty window titlebar/tab title.
+
+* The text cursor is changed to a bar when editing commands at the shell prompt
+
+* Glitch free window resizing even with complex prompts. Achieved by erasing
+  the prompt on resize and allowing the shell to redraw it cleanly.
+
+* Sophisticated completion for the :program:`kitty` command in the shell.
+
+* When confirming a quit command if a window is sitting at a shell prompt,
+  it is optionally, not counted (see :opt:`confirm_os_window_close`)
+
+
+Configuration
+---------------
+
+Shell integration is controlled by the :opt:`shell_integration` option. By
+default, all shell integration is enabled. Individual features can be turned
+off or it can be disabled entirely as well. The :opt:`shell_integration` option
+takes a space separated list of keywords:
+
+disabled
+    Turn off all shell integration
+
+no-rc
+    Do not modify the shell's launch environment to enable integration. Useful if you prefer
+    to :ref:`manually enable integration <manual_shell_integration>`.
+
+no-cursor
+    Turn off changing of the text cursor to a bar when editing text
+
+no-title
+    Turn off setting the kitty window/tab title based on shell state
+
+no-prompt-mark
+    Turn off marking of prompts. This disables jumping to prompt, browsing
+    output of last command and click to move cursor functionality.
+
+no-complete
+    Turn off completion for the kitty command.
+
+
+More ways to browse command output
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can add further key and mouse bindings to browse the output of commands
+easily. For example to select the output of a command by right clicking the mouse
+on the output, define the following in :file:`kitty.conf`:
+
+.. code:: conf
+
+    mouse_map right press ungrabbed mouse_select_command_output
+
+Now, when you right click on the output, the entire output is selected, ready
+to be copied.
+
+The feature to jump to previous prompts (
+:sc:`scroll_to_previous_prompt` and :sc:`scroll_to_next_prompt`) and mouse
+actions (:ref:`action-mouse_select_command_output` and :ref:`action-mouse_show_command_output`) can
+be integrated with browsing command output as well. For example, define the
+following mapping in :file:`kitty.conf`:
+
+.. code:: conf
+
+    map f1 show_last_visited_command_output
+
+Now, pressing :kbd:`F1` will cause the output of the last jumped to command or
+the last mouse clicked command output to be opened in a pager for easy browsing.
+
+In addition, You can define shortcut to get the first command output on screen.
+For example, define the following in :file:`kitty.conf`:
+
+.. code:: conf
+
+    map f1 show_first_command_output_on_screen
+
+Now, pressing :kbd:`F1` will cause the output of the first command output on
+screen to be opened in a pager.
+
+You can also add shortcut to scroll to the last jumped position. For example,
+define the following in :file:`kitty.conf`:
+
+.. code:: conf
+
+    map f1 scroll_to_prompt 0
+
+
+How it works
+-----------------
+
+At startup, kitty detects if the shell you have configured (either system wide
+or in kitty.conf) is a supported shell. If so, kitty injects some shell specific
+code into the shell, to enable shell integration. How it does so varies for
+different shells.
+
+
+.. tab:: zsh
+
+   For zsh, kitty sets the ``ZDOTDIR`` environment variable to make zsh load
+   kitty's :file:`.zshenv` which restores the original value of ``ZDOTDIR``
+   and sources the original :file:`.zshenv`. It then loads the shell integration code.
+   The remainder of zsh's startup process proceeds as normal.
+
+.. tab:: fish
+
+    For fish, to make it automatically load the integration code provided by
+    kitty, the integration script directory path is prepended to the
+    :code:`XDG_DATA_DIRS` environment variable. This is only applied to the fish
+    process and will be cleaned up by the integration script after startup. No files
+    are added or modified.
+
+.. tab:: bash
+
+    For bash, kitty adds a couple of lines to the bottom of :file:`~/.bashrc`
+    (in an atomic manner) to load the shell integration code.
+
+
+Then, when launching the shell, kitty sets the environment variable
+:envvar:`KITTY_SHELL_INTEGRATION` to the value of the :opt:`shell_integration`
+option. The shell integration code reads the environment variable, turns on the
+specified integration functionality and then unsets the variable so as to not
+pollute the system. This has the nice effect that the changes to the shell's rc
+files become no-ops when running the shell in anything other than kitty itself.
+
+The actual shell integration code uses hooks provided by each shell to send
+special escape codes to kitty, to perform the various tasks. You can see the
+code used for each shell below:
+
+.. raw:: html
+
+    <details>
+    <summary>Click to toggle shell integration code</summary>
+
+.. tab:: zsh
+
+    .. literalinclude:: ../shell-integration/zsh/kitty-integration
+        :language: zsh
+
+
+.. tab:: fish
+
+    .. literalinclude:: ../shell-integration/fish/vendor_conf.d/kitty-shell-integration.fish
+        :language: fish
+
+.. tab:: bash
+
+    .. literalinclude:: ../shell-integration/bash/kitty.bash
+        :language: bash
+
+.. raw:: html
+
+   </details>
+
+
+.. _manual_shell_integration:
+
+Manual shell integration
+----------------------------
+
+The automatic shell integration is designed to be minimally intrusive, as such
+it wont work for sub-shells, terminal multiplexers, containers, remote systems, etc.
+For such systems, you should setup manual shell integration by adding some code
+to your shells startup files to load the shell integration script.
+
+First, in :file:`kitty.conf` set:
+
+.. code-block:: conf
+
+    shell_integration disabled
+
+Then in your shell's rc file, add the lines:
+
+.. tab:: zsh
+
+    .. code-block:: sh
+
+        if test -n "$KITTY_INSTALLATION_DIR"; then
+            export KITTY_SHELL_INTEGRATION="enabled"
+            autoload -Uz -- "$KITTY_INSTALLATION_DIR"/shell-integration/zsh/kitty-integration
+            kitty-integration
+            unfunction kitty-integration
+        fi
+
+.. tab:: fish
+
+    .. code-block:: fish
+
+        if set -q KITTY_INSTALLATION_DIR
+            set --global KITTY_SHELL_INTEGRATION enabled
+            source "$KITTY_INSTALLATION_DIR/shell-integration/fish/vendor_conf.d/kitty-shell-integration.fish"
+            set --prepend fish_complete_path "$KITTY_INSTALLATION_DIR/shell-integration/fish/vendor_completions.d"
+        end
+
+
+.. tab:: bash
+
+    .. code-block:: sh
+
+        if test -n "$KITTY_INSTALLATION_DIR"; then
+            export KITTY_SHELL_INTEGRATION="enabled"
+            source "$KITTY_INSTALLATION_DIR/shell-integration/bash/kitty.bash"
+        fi
+
+The value of :envvar:`KITTY_SHELL_INTEGRATION` is the same as that for
+:opt:`shell_integration`, except if you want to disable shell integration
+completely, in which case simply do not set the
+:envvar:`KITTY_SHELL_INTEGRATION` variable at all.
+
+If you want this to work while SSHing into a remote system, then you will
+need to add some code to the snippets above to check if :code:`KITTY_INSTALLATION_DIR`
+is empty and if so to set it to some hard coded location with the shell
+integration scripts that need to be copied onto the remote system.
+
+
+Notes for shell developers
+-----------------------------
+
+The protocol used for marking the prompt is very simple. You should consider
+adding it to your shell as a builtin. Many modern terminals make use of it, for
+example: kitty, iTerm2, WezTerm, DomTerm
+
+Just before starting to draw the PS1 prompt send the escape code::
+
+    <OSC>133;A<ST>
+
+Just before starting to draw the PS2 prompt send the escape code::
+
+    <OSC>133;A;k=s<ST>
+
+Just before running a command/program, send the escape code::
+
+    <OSC>133;C<ST>
+
+Here ``<OSC>`` is the bytes ``0x1b 0x5d`` and ``<ST>`` is the bytes ``0x1b
+0x5c``. This is exactly what is needed for shell integration in kitty. For the
+full protocol, that also marks the command region, see `the iTerm2 docs
+<https://iterm2.com/documentation-escape-codes.html>`_.

docs/support.html

@@ -1,7 +1,12 @@
 <style>
+#support-buttons {
+    display: flex;
+    flex-wrap: wrap;
+}
+
 .support-button {
+    box-sizing: border-box;
     border-radius: 6px;
-    box-shadow: rgb(255, 246, 175) 0px 1px 0px 0px;
     display: inline-block;
     cursor: pointer;
     color: rgb(51, 51, 51);
@@ -10,15 +15,16 @@
     font-weight: bold;
     padding: 8px 24px;
     text-decoration: none;
+    margin-left: 1em;
+    outline: 0;
+    border-width: 0;
 }
 
 .support-button:hover {
-    transform: scale(1.5);
+    transform: scale(1.2);
+    border: solid 1px rgb(92, 184, 92);
 }
 
-.support-button {
-    outline: 0;
-}
 .support-button:visited {
     color: rgb(51, 51, 51);
     outline: 0;
@@ -30,28 +36,34 @@
 }
 
 #paypal input[type=submit] {
-    background: linear-gradient(rgb(255, 236, 100) 5%, rgb(255, 171, 35) 100%) rgb(255, 236, 100);
-    border: 1px solid rgb(255, 171, 35);
+    background: linear-gradient(rgb(92, 184, 92) 5%, rgb(62, 142, 62) 100%) rgb(92, 184, 92);
+    padding-top: 10px; padding-bottom: 10px;
+    color: rgb(51, 51, 51);
+    border: 1px solid rgb(92, 184, 92);
 }
 
-#liberapay a {
+a.support-button {
     background: linear-gradient(rgb(92, 184, 92) 5%, rgb(62, 142, 62) 100%) rgb(92, 184, 92);
-    border: 1px solid rgb(62, 142, 62);
     color: rgb(51, 51, 51);
 }
 
-#patreon a {
-    background: linear-gradient(rgb(11, 100, 163) 5%, rgb(5, 45, 73) 100%) rgb(11, 100, 163);
-    border: 1px solid rgb(5, 45, 73);
-    color: #eee;
-}
 </style>
 
 <div id="support-buttons">
+
+<div id="github">
+    <a class="support-button" href="https://github.com/sponsors/kovidgoyal">Patronage via GitHub</a>
+</div>
+
+
 <div id="patreon">
     <a class="support-button" href="https://www.patreon.com/bePatron?u=917933">Patronage via Patreon</a>
 </div>
 
+<div id="liberapay">
+    <a class="support-button" href="https://liberapay.com/kovidgoyal/donate">Patronage via Liberapay</a>
+</div>
+
 <div>
     <form id="paypal" action="https://www.paypal.com/cgi-bin/webscr" method="post" title="Contribute to support calibre development">
         <input type="hidden" name="cmd" value="_s-xclick" />
@@ -61,9 +73,5 @@
     </form>
 </div>
 
-<div id="liberapay">
-    <a class="support-button" href="https://liberapay.com/kovidgoyal/donate">Patronage via Liberapay</a>
-</div>
-
 </div>
 

docs/support.rst

@@ -1,5 +1,5 @@
-Support kitty development
-===========================
+Support kitty development ❤️
+==============================
 
 My goal with |kitty| is to move the stagnant terminal ecosystem forward.  To that
 end kitty has many foundational features, such as: :doc:`image support
@@ -7,7 +7,7 @@ end kitty has many foundational features, such as: :doc:`image support
 :doc:`various enhancements to the terminal protocol <protocol-extensions>`,
 etc. These features allow the development of rich terminal applications, such
 as :doc:`Side-by-side diff <kittens/diff>` and :doc:`Unicode input
-<kittens/unicode-input>`.
+<kittens/unicode_input>`.
 
 If you wish to support this mission and see the terminal ecosystem evolve,
 consider donating so that I can devote more time to |kitty| development.
@@ -15,8 +15,7 @@ I have personally written `almost all kitty code
 <https://github.com/kovidgoyal/kitty/graphs/contributors>`_.
 
 You can choose to make either a one-time payment via PayPal or become a
-*patron* of kitty development via the Patreon or Liberapay services
-below:
+*patron* of kitty development via one of the services below:
 
 
 .. raw:: html

docs/underlines.rst

@@ -0,0 +1,36 @@
+Colored and styled underlines
+================================
+
+|kitty| supports colored and styled (wavy) underlines. This is of particular
+use in terminal editors such as vim and emacs to display red, wavy underlines
+under mis-spelled words and/or syntax errors. This is done by re-purposing some
+SGR escape codes that are not used in modern terminals (`CSI codes
+<https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_(Control_Sequence_Introducer)_sequences>`_)
+
+To set the underline style::
+
+    <ESC>[4:0m  # this is no underline
+    <ESC>[4:1m  # this is a straight underline
+    <ESC>[4:2m  # this is a double underline
+    <ESC>[4:3m  # this is a curly underline
+    <ESC>[4:4m  # this is a dotted underline (not implemented in kitty)
+    <ESC>[4:5m  # this is a dashed underline (not implemented in kitty)
+    <ESC>[4m    # this is a straight underline (for backwards compat)
+    <ESC>[24m   # this is no underline (for backwards compat)
+
+To set the underline color (this is reserved and as far as I can tell not actually used for anything)::
+
+    <ESC>[58...m
+
+This works exactly like the codes ``38, 48`` that are used to set foreground and
+background color respectively.
+
+To reset the underline color (also previously reserved and unused)::
+
+    <ESC>[59m
+
+The underline color must remain the same under reverse video, if it has a
+color, if not, it should follow the foreground color.
+
+To detect support for this feature in a terminal emulator, query the terminfo database
+for the ``Su`` boolean capability.

docs/unscroll.rst

@@ -0,0 +1,38 @@
+.. _unscroll:
+
+Unscrolling the screen
+========================
+
+This is a small extension to the `SD (Pan up) escape code
+<https://vt100.net/docs/vt510-rm/SD.html>`_ from the VT-420 terminal. The
+``SD`` escape code normally causes the text on screen to scroll down by the
+specified number of lines, with empty lines appearing at the top of the screen.
+This extension allows the new lines to be filled in from the scrollback buffer
+instead of being blank.
+
+The motivation for this is that many modern shells will show completions in a
+block of lines under the cursor, this causes some of the on-screen text to be
+lost even after the completion is completed, because it has scrolled off
+screen. This escape code allows that text to be restored.
+
+If the scrollback buffer is empty or there is no scrollback buffer, such as for
+the alternate screen, then the newly inserted lines must be empty, just as with
+the original ``SD`` escape code. The maximum number of lines that can be
+scrolled down is implementation defined, but must be at least one screen worth.
+
+The syntax of the escape code is identical to that of ``SD`` except that it has
+a trailing ``+`` modifier. This is legal under the `ECMA 48 standard
+<https://www.ecma-international.org/publications-and-standards/standards/ecma-48/>`_
+and unused for any other purpose as far as I can tell. So for example, to
+unscroll three lines, the escape code would be::
+
+    CSI 3 + T
+
+See `discussion here
+<https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/30>`_.
+
+.. versionadded:: 0.20.2
+
+Also supported by the terminals:
+
+    * `mintty <https://github.com/mintty/mintty/releases/tag/3.5.2>`_

gen-apc-parsers.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# vim:fileencoding=utf-8
 # License: GPLv3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
 
 import subprocess
@@ -250,7 +249,7 @@ def write_header(text: str, path: str) -> None:
 def graphics_parser() -> None:
     flag = frozenset
     keymap: KeymapType = {
-        'a': ('action', flag('tTqpdfa')),
+        'a': ('action', flag('tTqpdfac')),
         'd': ('delete_action', flag('aAiIcCfFnNpPqQxXyYzZ')),
         't': ('transmission_type', flag('dfts')),
         'o': ('compressed', flag('z')),

gen-config.py

@@ -1,432 +1,41 @@
 #!/usr/bin/env python
-# vim:fileencoding=utf-8
 # License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
 
-import inspect
-import os
-import pprint
+
 import re
-import textwrap
-from typing import (
-    Any, Callable, Dict, Iterator, List, Set, Tuple, Union, get_type_hints
-)
+from typing import List
 
-from kitty.conf.types import Definition, MultiOption, Option, unset
+from kitty.conf.generate import write_output
 
 
-def chunks(lst: List, n: int) -> Iterator[List]:
-    for i in range(0, len(lst), n):
-        yield lst[i:i + n]
-
-
-def atoi(text: str) -> str:
-    return f'{int(text):08d}' if text.isdigit() else text
-
-
-def natural_keys(text: str) -> Tuple[str, ...]:
-    return tuple(atoi(c) for c in re.split(r'(\d+)', text))
-
-
-def generate_class(defn: Definition, loc: str) -> Tuple[str, str]:
-    class_lines: List[str] = []
-    tc_lines: List[str] = []
-    a = class_lines.append
-    t = tc_lines.append
-    a('class Options:')
-    t('class Parser:')
-    choices = {}
-    imports: Set[Tuple[str, str]] = set()
-    tc_imports: Set[Tuple[str, str]] = set()
-
-    def type_name(x: type) -> str:
-        ans = x.__name__
-        if x.__module__ and x.__module__ != 'builtins':
-            imports.add((x.__module__, x.__name__))
-        return ans
-
-    def option_type_as_str(x: Any) -> str:
-        if hasattr(x, '__name__'):
-            return type_name(x)
-        ans = repr(x)
-        ans = ans.replace('NoneType', 'None')
-        return ans
-
-    def option_type_data(option: Union[Option, MultiOption]) -> Tuple[Callable, str]:
-        func = option.parser_func
-        if func.__module__ == 'builtins':
-            return func, func.__name__
-        th = get_type_hints(func)
-        rettype = th['return']
-        typ = option_type_as_str(rettype)
-        if isinstance(option, MultiOption):
-            typ = typ[typ.index('[') + 1:-1]
-            typ = typ.replace('Tuple', 'Dict', 1)
-        return func, typ
-
-    is_mutiple_vars = {}
-    option_names = set()
-    color_table = list(map(str, range(256)))
-
-    def parser_function_declaration(option_name: str) -> None:
-        t('')
-        t(f'    def {option_name}(self, val: str, ans: typing.Dict[str, typing.Any]) -> None:')
-
-    for option in sorted(defn.iter_all_options(), key=lambda a: natural_keys(a.name)):
-        option_names.add(option.name)
-        parser_function_declaration(option.name)
-        if isinstance(option, MultiOption):
-            mval: Dict[str, Dict[str, Any]] = {'macos': {}, 'linux': {}, '': {}}
-            func, typ = option_type_data(option)
-            for val in option:
-                if val.add_to_default:
-                    gr = mval[val.only]
-                    for k, v in func(val.defval_as_str):
-                        gr[k] = v
-            is_mutiple_vars[option.name] = typ, mval
-            sig = inspect.signature(func)
-            tc_imports.add((func.__module__, func.__name__))
-            if len(sig.parameters) == 1:
-                t(f'        for k, v in {func.__name__}(val):')
-                t(f'            ans["{option.name}"][k] = v')
-            else:
-                t(f'        for k, v in {func.__name__}(val, ans["{option.name}"]):')
-                t(f'            ans["{option.name}"][k] = v')
-            continue
-
-        if option.choices:
-            typ = 'typing.Literal[{}]'.format(', '.join(repr(x) for x in option.choices))
-            ename = f'choices_for_{option.name}'
-            choices[ename] = typ
-            typ = ename
-            func = str
-        elif defn.has_color_table and option.is_color_table_color:
-            func, typ = option_type_data(option)
-            t(f'        ans[{option.name!r}] = {func.__name__}(val)')
-            tc_imports.add((func.__module__, func.__name__))
-            cnum = int(option.name[5:])
-            color_table[cnum] = '0x{:06x}'.format(func(option.defval_as_string).__int__())
-            continue
-        else:
-            func, typ = option_type_data(option)
-            try:
-                params = inspect.signature(func).parameters
-            except Exception:
-                params = {}
-            if 'dict_with_parse_results' in params:
-                t(f'        {func.__name__}(val, ans)')
-            else:
-                t(f'        ans[{option.name!r}] = {func.__name__}(val)')
-            if func.__module__ != 'builtins':
-                tc_imports.add((func.__module__, func.__name__))
-
-        defval = repr(func(option.defval_as_string))
-        if option.macos_defval is not unset:
-            md = repr(func(option.macos_defval))
-            defval = f'{md} if is_macos else {defval}'
-            imports.add(('kitty.constants', 'is_macos'))
-        a(f'    {option.name}: {typ} = {defval}')
-        if option.choices:
-            t('        val = val.lower()')
-            t(f'        if val not in self.choices_for_{option.name}:')
-            t(f'            raise ValueError(f"The value {{val}} is not a valid choice for {option.name}")')
-            t(f'        ans["{option.name}"] = val')
-            t('')
-            t(f'    choices_for_{option.name} = frozenset({option.choices!r})')
-
-    for option_name, (typ, mval) in is_mutiple_vars.items():
-        a(f'    {option_name}: {typ} = ' '{}')
-
-    for parser, aliases in defn.deprecations.items():
-        for alias in aliases:
-            parser_function_declaration(alias)
-            tc_imports.add((parser.__module__, parser.__name__))
-            t(f'        {parser.__name__}({alias!r}, val, ans)')
-
-    action_parsers = {}
-
-    def resolve_import(ftype: str) -> str:
-        if '.' in ftype:
-            fmod, ftype = ftype.rpartition('.')[::2]
-        else:
-            fmod = f'{loc}.options.utils'
-        imports.add((fmod, ftype))
-        return ftype
-
-    for aname, action in defn.actions.items():
-        option_names.add(aname)
-        action_parsers[aname] = func = action.parser_func
-        th = get_type_hints(func)
-        rettype = th['return']
-        typ = option_type_as_str(rettype)
-        typ = typ[typ.index('[') + 1:-1]
-        a(f'    {aname}: typing.List[{typ}] = []')
-        for imp in action.imports:
-            resolve_import(imp)
-        for fname, ftype in action.fields.items():
-            ftype = resolve_import(ftype)
-            a(f'    {fname}: {ftype} = ' '{}')
-        parser_function_declaration(aname)
-        t(f'        for k in {func.__name__}(val):')
-        t(f'            ans[{aname!r}].append(k)')
-        tc_imports.add((func.__module__, func.__name__))
-
-    if defn.has_color_table:
-        imports.add(('array', 'array'))
-        a('    color_table: array = array("L", (')
-        for grp in chunks(color_table, 8):
-            a('        ' + ', '.join(grp) + ',')
-        a('    ))')
-
-    a('    config_paths: typing.Tuple[str, ...] = ()')
-    a('    config_overrides: typing.Tuple[str, ...] = ()')
-    a('')
-    a('    def __init__(self, options_dict: typing.Optional[typing.Dict[str, typing.Any]] = None) -> None:')
-    a('        if options_dict is not None:')
-    a('            for key in option_names:')
-    a('                setattr(self, key, options_dict[key])')
-
-    a('')
-    a('    @property')
-    a('    def _fields(self) -> typing.Tuple[str, ...]:')
-    a('        return option_names')
-
-    a('')
-    a('    def __iter__(self) -> typing.Iterator[str]:')
-    a('        return iter(self._fields)')
-
-    a('')
-    a('    def __len__(self) -> int:')
-    a('        return len(self._fields)')
-
-    a('')
-    a('    def _copy_of_val(self, name: str) -> typing.Any:')
-    a('        ans = getattr(self, name)')
-    a('        if isinstance(ans, dict):\n            ans = ans.copy()')
-    a('        elif isinstance(ans, list):\n            ans = ans[:]')
-    a('        return ans')
-
-    a('')
-    a('    def _asdict(self) -> typing.Dict[str, typing.Any]:')
-    a('        return {k: self._copy_of_val(k) for k in self}')
-
-    a('')
-    a('    def _replace(self, **kw: typing.Any) -> "Options":')
-    a('        ans = Options()')
-    a('        for name in self:')
-    a('            setattr(ans, name, self._copy_of_val(name))')
-    a('        for name, val in kw.items():')
-    a('            setattr(ans, name, val)')
-    a('        return ans')
-
-    a('')
-    a('    def __getitem__(self, key: typing.Union[int, str]) -> typing.Any:')
-    a('        k = option_names[key] if isinstance(key, int) else key')
-    a('        try:')
-    a('            return getattr(self, k)')
-    a('        except AttributeError:')
-    a('            pass')
-    a('        raise KeyError(f"No option named: {k}")')
-
-    if defn.has_color_table:
-        a('')
-        a('    def __getattr__(self, key: str) -> typing.Any:')
-        a('        if key.startswith("color"):')
-        a('            q = key[5:]')
-        a('            if q.isdigit():')
-        a('                k = int(q)')
-        a('                if 0 <= k <= 255:')
-        a('                    x = self.color_table[k]')
-        a('                    return Color((x >> 16) & 255, (x >> 8) & 255, x & 255)')
-        a('        raise AttributeError(key)')
-        a('')
-        a('    def __setattr__(self, key: str, val: typing.Any) -> typing.Any:')
-        a('        if key.startswith("color"):')
-        a('            q = key[5:]')
-        a('            if q.isdigit():')
-        a('                k = int(q)')
-        a('                if 0 <= k <= 255:')
-        a('                    self.color_table[k] = int(val)')
-        a('                    return')
-        a('        object.__setattr__(self, key, val)')
-
-    a('')
-    a('')
-    a('defaults = Options()')
-    for option_name, (typ, mval) in is_mutiple_vars.items():
-        a(f'defaults.{option_name} = {mval[""]!r}')
-        if mval['macos']:
-            imports.add(('kitty.constants', 'is_macos'))
-            a('if is_macos:')
-            a(f'    defaults.{option_name}.update({mval["macos"]!r}')
-        if mval['macos']:
-            imports.add(('kitty.constants', 'is_macos'))
-            a('if not is_macos:')
-            a(f'    defaults.{option_name}.update({mval["linux"]!r}')
-
-    for aname, func in action_parsers.items():
-        a(f'defaults.{aname} = [')
-        only: Dict[str, List[Tuple[str, Callable]]] = {}
-        for sc in defn.iter_all_maps(aname):
-            if not sc.add_to_default:
-                continue
-            text = sc.parseable_text
-            if sc.only:
-                only.setdefault(sc.only, []).append((text, func))
-            else:
-                for val in func(text):
-                    a(f'    # {sc.name}')
-                    a(f'    {val!r},')
-        a(']')
-        if only:
-            imports.add(('kitty.constants', 'is_macos'))
-            for cond, items in only.items():
-                cond = 'is_macos' if cond == 'macos' else 'not is_macos'
-                a(f'if {cond}:')
-                for (text, func) in items:
-                    for val in func(text):
-                        a(f'    defaults.{aname}.append({val!r})')
-
-    t('')
-    t('')
-    t('def create_result_dict() -> typing.Dict[str, typing.Any]:')
-    t('    return {')
-    for oname in is_mutiple_vars:
-        t(f'        {oname!r}: {{}},')
-    for aname in defn.actions:
-        t(f'        {aname!r}: [],')
-    t('    }')
-
-    t('')
-    t('')
-    t(f'actions = frozenset({tuple(defn.actions)!r})')
-    t('')
-    t('')
-    t('def merge_result_dicts(defaults: typing.Dict[str, typing.Any], vals: typing.Dict[str, typing.Any]) -> typing.Dict[str, typing.Any]:')
-    t('    ans = {}')
-    t('    for k, v in defaults.items():')
-    t('        if isinstance(v, dict):')
-    t('            ans[k] = merge_dicts(v, vals.get(k, {}))')
-    t('        elif k in actions:')
-    t('            ans[k] = v + vals.get(k, [])')
-    t('        else:')
-    t('            ans[k] = vals.get(k, v)')
-    t('    return ans')
-    tc_imports.add(('kitty.conf.utils', 'merge_dicts'))
-
-    t('')
-    t('')
-    t('parser = Parser()')
-    t('')
-    t('')
-    t('def parse_conf_item(key: str, val: str, ans: typing.Dict[str, typing.Any]) -> bool:')
-    t('    func = getattr(parser, key, None)')
-    t('    if func is not None:')
-    t('        func(val, ans)')
-    t('        return True')
-    t('    return False')
-
-    preamble = ['# generated by gen-config.py DO NOT edit', '# vim:fileencoding=utf-8', '']
-    a = preamble.append
-
-    def output_imports(imports: Set, add_module_imports: bool = True) -> None:
-        a('import typing')
-        seen_mods = {'typing'}
-        mmap: Dict[str, List[str]] = {}
-        for mod, name in imports:
-            mmap.setdefault(mod, []).append(name)
-        for mod in sorted(mmap):
-            names = sorted(mmap[mod])
-            lines = textwrap.wrap(', '.join(names), 100)
-            if len(lines) == 1:
-                s = lines[0]
-            else:
-                s = '\n    '.join(lines)
-                s = f'(\n    {s}\n)'
-            a(f'from {mod} import {s}')
-            if add_module_imports and mod not in seen_mods and mod != s:
-                a(f'import {mod}')
-                seen_mods.add(mod)
-
-    output_imports(imports)
-    a('')
-    if choices:
-        a('if typing.TYPE_CHECKING:')
-        for name, cdefn in choices.items():
-            a(f'    {name} = {cdefn}')
-        a('else:')
-        for name in choices:
-            a(f'    {name} = str')
-
-    a('')
-    a('option_names = (  # {{''{')
-    a(' ' + pprint.pformat(tuple(sorted(option_names, key=natural_keys)))[1:] + '  # }}''}')
-    class_def = '\n'.join(preamble + ['', ''] + class_lines)
-
-    preamble = ['# generated by gen-config.py DO NOT edit', '# vim:fileencoding=utf-8', '']
-    a = preamble.append
-    output_imports(tc_imports, False)
-
-    return class_def, '\n'.join(preamble + ['', ''] + tc_lines)
-
-
-def generate_c_conversion(loc: str, ctypes: List[Option]) -> str:
-    lines: List[str] = []
-    basic_converters = {
-        'int': 'PyLong_AsLong', 'uint': 'PyLong_AsUnsignedLong', 'bool': 'PyObject_IsTrue',
-        'float': 'PyFloat_AsFloat', 'double': 'PyFloat_AsDouble',
-        'time': 'parse_s_double_to_monotonic_t', 'time-ms': 'parse_ms_long_to_monotonic_t'
-    }
-
-    for opt in ctypes:
-        lines.append('')
-        lines.append(f'static void\nconvert_from_python_{opt.name}(PyObject *val, Options *opts) ''{')
-        is_special = opt.ctype.startswith('!')
-        if is_special:
-            func = opt.ctype[1:]
-            lines.append(f'    {func}(val, opts);')
-        else:
-            func = basic_converters.get(opt.ctype, opt.ctype)
-            lines.append(f'    opts->{opt.name} = {func}(val);')
-        lines.append('}')
-        lines.append('')
-        lines.append(f'static void\nconvert_from_opts_{opt.name}(PyObject *py_opts, Options *opts) ''{')
-        lines.append(f'    PyObject *ret = PyObject_GetAttrString(py_opts, "{opt.name}");')
-        lines.append('    if (ret == NULL) return;')
-        lines.append(f'    convert_from_python_{opt.name}(ret, opts);')
-        lines.append('    Py_DECREF(ret);')
-        lines.append('}')
-
-    lines.append('')
-    lines.append('static bool\nconvert_opts_from_python_opts(PyObject *py_opts, Options *opts) ''{')
-    for opt in ctypes:
-        lines.append(f'    convert_from_opts_{opt.name}(py_opts, opts);')
-        lines.append('    if (PyErr_Occurred()) return false;')
-    lines.append('    return true;')
-    lines.append('}')
-
-    preamble = ['// generated by gen-config.py DO NOT edit', '// vim:fileencoding=utf-8', '#pragma once', '#include "to-c.h"']
-    return '\n'.join(preamble + ['', ''] + lines)
-
-
-def write_output(loc: str, defn: Definition) -> None:
-    cls, tc = generate_class(defn, loc)
-    with open(os.path.join(*loc.split('.'), 'options', 'types.py'), 'w') as f:
-        f.write(cls + '\n')
-    with open(os.path.join(*loc.split('.'), 'options', 'parse.py'), 'w') as f:
-        f.write(tc + '\n')
-    ctypes = []
-    for opt in defn.root_group.iter_all_non_groups():
-        if isinstance(opt, Option) and opt.ctype:
-            ctypes.append(opt)
-    if ctypes:
-        c = generate_c_conversion(loc, ctypes)
-        with open(os.path.join(*loc.split('.'), 'options', 'to-c-generated.h'), 'w') as f:
-            f.write(c + '\n')
+def patch_color_list(path: str, colors: List[str], name: str, spc: str = '    ') -> None:
+    with open(path, 'r+') as f:
+        raw = f.read()
+        nraw = re.sub(
+            fr'(# {name}_COLORS_START).+?(\s+# {name}_COLORS_END)',
+            r'\1' + f'\n{spc}' + f'\n{spc}'.join(map(lambda x: f'{x!r},', sorted(colors))) + r'\2',
+            raw, flags=re.DOTALL | re.MULTILINE)
+        if nraw != raw:
+            f.seek(0)
+            f.truncate()
+            f.write(nraw)
 
 
 def main() -> None:
     from kitty.options.definition import definition
     write_output('kitty', definition)
+    nullable_colors = []
+    all_colors = []
+    for opt in definition.iter_all_options():
+        if callable(opt.parser_func):
+            if opt.parser_func.__name__ in ('to_color_or_none', 'cursor_text_color'):
+                nullable_colors.append(opt.name)
+                all_colors.append(opt.name)
+            elif opt.parser_func.__name__ in ('to_color', 'titlebar_color', 'macos_titlebar_color'):
+                all_colors.append(opt.name)
+    patch_color_list('kitty/rc/set_colors.py', nullable_colors, 'NULLABLE')
+    patch_color_list('kittens/themes/collection.py', all_colors, 'ALL', ' ' * 8)
+
     from kittens.diff.options.definition import definition as kd
     write_output('kittens.diff', kd)
 

gen-key-constants.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# vim:fileencoding=utf-8
 # License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
 
 import string
@@ -245,7 +244,7 @@ def patch_file(path: str, what: str, text: str, start_marker: str = '/* ', end_m
         f.write(raw)
 
 
-def serialize_dict(x: dict) -> str:
+def serialize_dict(x: Dict[Any, Any]) -> str:
     return pformat(x, indent=4).replace('{', '{\n ', 1)
 
 
@@ -349,7 +348,7 @@ def generate_legacy_text_key_maps() -> None:
     patch_file('kitty_tests/keys.py', 'legacy letter tests', '\n'.join(tests), start_marker='# ', end_marker='')
 
 
-def chunks(lst: List, n: int) -> Any:
+def chunks(lst: List[Any], n: int) -> Any:
     """Yield successive n-sized chunks from lst."""
     for i in range(0, len(lst), n):
         yield lst[i:i + n]

gen-wcwidth.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# vim:fileencoding=utf-8
 # License: GPL v3 Copyright: 2017, Kovid Goyal <kovid at kovidgoyal.net>
 
 import os
@@ -50,10 +49,25 @@ class_maps: Dict[str, Set[int]] = {}
 all_symbols: Set[int] = set()
 name_map: Dict[int, str] = {}
 word_search_map: DefaultDict[str, Set[int]] = defaultdict(set)
-zwj = 0x200d
+soft_hyphen = 0xad
 flag_codepoints = frozenset(range(0x1F1E6, 0x1F1E6 + 26))
-marks = set(emoji_skin_tone_modifiers) | {zwj} | flag_codepoints
+# See https://github.com/harfbuzz/harfbuzz/issues/169
+marks = set(emoji_skin_tone_modifiers) | flag_codepoints
 not_assigned = set(range(0, sys.maxunicode))
+property_maps: Dict[str, Set[int]] = defaultdict(set)
+
+
+def parse_prop_list() -> None:
+    global marks
+    for line in get_data('ucd/PropList.txt'):
+        if line.startswith('#'):
+            continue
+        cp_or_range, rest = line.split(';', 1)
+        chars = parse_range_spec(cp_or_range.strip())
+        name = rest.strip().split()[0]
+        property_maps[name] |= chars
+    # see https://www.unicode.org/faq/unsup_char.html#3
+    marks |= property_maps['Other_Default_Ignorable_Code_Point']
 
 
 def parse_ucd() -> None:
@@ -97,6 +111,12 @@ def parse_ucd() -> None:
                 marks.add(codepoint)
             elif category.startswith('S'):
                 all_symbols.add(codepoint)
+            elif category == 'Cf':
+                # we add Cf to marks as it contains things like tags and zero
+                # width chars. Not sure if *all* of Cf should be treated as
+                # combining chars, might need to add individual exceptions in
+                # the future.
+                marks.add(codepoint)
 
     with open('nerd-fonts-glyphs.txt') as f:
         for line in f:
@@ -213,7 +233,7 @@ def parse_eaw() -> None:
         if eaw == 'A':
             ambiguous |= chars
             seen |= chars
-        elif eaw == 'W' or eaw == 'F':
+        elif eaw in ('W', 'F'):
             doublewidth |= chars
             seen |= chars
     doublewidth |= set(range(0x3400, 0x4DBF + 1)) - seen
@@ -234,15 +254,15 @@ def get_ranges(items: List[int]) -> Generator[Union[int, Tuple[int, int]], None,
             yield a, b
 
 
-def write_case(spec: Union[Tuple, int], p: Callable) -> None:
+def write_case(spec: Union[Tuple[int, ...], int], p: Callable[..., None]) -> None:
     if isinstance(spec, tuple):
         p('\t\tcase 0x{:x} ... 0x{:x}:'.format(*spec))
     else:
-        p('\t\tcase 0x{:x}:'.format(spec))
+        p(f'\t\tcase 0x{spec:x}:')
 
 
 @contextmanager
-def create_header(path: str, include_data_types: bool = True) -> Generator[Callable, None, None]:
+def create_header(path: str, include_data_types: bool = True) -> Generator[Callable[..., None], None, None]:
     with open(path, 'w') as f:
         p = partial(print, file=f)
         p('// unicode data, built from the unicode standard on:', date.today())
@@ -282,7 +302,7 @@ def gen_emoji() -> None:
 
 def category_test(
     name: str,
-    p: Callable,
+    p: Callable[..., None],
     classes: Iterable[str],
     comment: str,
     use_static: bool = False,
@@ -312,7 +332,7 @@ def category_test(
     p('\treturn false;\n}\n')
 
 
-def codepoint_to_mark_map(p: Callable, mark_map: List[int]) -> Dict[int, int]:
+def codepoint_to_mark_map(p: Callable[..., None], mark_map: List[int]) -> Dict[int, int]:
     p('\tswitch(c) { // {{{')
     rmap = {c: m for m, c in enumerate(mark_map)}
     for spec in get_ranges(mark_map):
@@ -336,10 +356,10 @@ def classes_to_regex(classes: Iterable[str], exclude: str = '') -> Iterable[str]
 
     def as_string(codepoint: int) -> str:
         if codepoint < 256:
-            return r'\x{:02x}'.format(codepoint)
+            return fr'\x{codepoint:02x}'
         if codepoint <= 0xffff:
-            return r'\u{:04x}'.format(codepoint)
-        return r'\U{:08x}'.format(codepoint)
+            return fr'\u{codepoint:04x}'
+        return fr'\U{codepoint:08x}'
 
     for spec in get_ranges(list(chars)):
         if isinstance(spec, tuple):
@@ -354,16 +374,21 @@ def gen_ucd() -> None:
         p('#include "unicode-data.h"')
         category_test(
                 'is_combining_char', p,
-                {c for c in class_maps if c.startswith('M')},
-                'M category (marks)',
-                # See https://github.com/harfbuzz/harfbuzz/issues/169
-                extra_chars=emoji_skin_tone_modifiers | {zwj},
+                (),
+                'Combining and default ignored characters',
+                extra_chars=marks,
                 least_check_return='false'
         )
         category_test(
-            'is_ignored_char', p, 'Cc Cf Cs'.split(),
+            'is_ignored_char', p, 'Cc Cs'.split(),
             'Control characters and non-characters',
-            extra_chars=non_characters, exclude={zwj},
+            extra_chars=non_characters,
+            ascii_range='false'
+        )
+        category_test(
+            'is_non_rendered_char', p, 'Cc Cs Cf'.split(),
+            'Other_Default_Ignorable_Code_Point and soft hyphen',
+            extra_chars=property_maps['Other_Default_Ignorable_Code_Point'] | set(range(0xfe00, 0xfe0f + 1)),
             ascii_range='false'
         )
         category_test('is_word_char', p, {c for c in class_maps if c[0] in 'LN'}, 'L and N categories')
@@ -378,17 +403,22 @@ def gen_ucd() -> None:
         p('combining_type mark_for_codepoint(char_type c) {')
         rmap = codepoint_to_mark_map(p, mark_map)
         p('}\n')
-        with open('kitty/unicode-data.h') as f:
-            unicode_data = f.read()
-        m = re.search(r'^#define VS15 (\d+)', unicode_data, re.M)
-        if m is not None:
-            expected = int(m.group(1))
-        if rmap[0xfe0e] != expected:
-            raise ValueError('The mark for 0xfe0e has changed, you have to update VS15 to {} and VS16 to {} in unicode-data.h'.format(
-                rmap[0xfe0e], rmap[0xfe0f]
-            ))
+        with open('kitty/unicode-data.h', 'r+') as f:
+            raw = f.read()
+            f.seek(0)
+            raw, num = re.subn(
+                r'^// START_KNOWN_MARKS.+?^// END_KNOWN_MARKS',
+                '// START_KNOWN_MARKS\nstatic const combining_type '
+                f'VS15 = {rmap[0xfe0e]}, VS16 = {rmap[0xfe0f]};'
+                '\n// END_KNOWN_MARKS', raw, flags=re.MULTILINE | re.DOTALL)
+            if not num:
+                raise SystemExit('Faile dto patch mark definitions in unicode-data.h')
+            f.truncate()
+            f.write(raw)
+
     with open('kittens/hints/url_regex.py', 'w') as f:
-        f.write("url_delimiters = '{}'  # noqa".format(''.join(classes_to_regex(cz, exclude='\n'))))
+        f.write('# generated by gen-wcwidth.py, do not edit\n\n')
+        f.write("url_delimiters = '{}'  # noqa".format(''.join(classes_to_regex(cz, exclude='\n\r'))))
 
 
 def gen_names() -> None:
@@ -495,7 +525,7 @@ def gen_names() -> None:
 def gen_wcwidth() -> None:
     seen: Set[int] = set()
 
-    def add(p: Callable, comment: str, chars_: Union[Set[int], FrozenSet[int]], ret: int) -> None:
+    def add(p: Callable[..., None], comment: str, chars_: Union[Set[int], FrozenSet[int]], ret: int) -> None:
         chars = chars_ - seen
         seen.update(chars)
         p(f'\t\t// {comment} ({len(chars)} codepoints)' + ' {{' '{')
@@ -536,6 +566,7 @@ def gen_wcwidth() -> None:
 
 
 parse_ucd()
+parse_prop_list()
 parse_emoji()
 parse_eaw()
 gen_ucd()

glfw/backend_utils.c

@@ -91,7 +91,7 @@ compare_timers(const void *a_, const void *b_) {
     return (a->trigger_at > b->trigger_at) ? 1 : (a->trigger_at < b->trigger_at) ? -1 : 0;
 }
 
-static inline void
+static void
 update_timers(EventLoopData *eld) {
     if (eld->timers_count > 1) qsort(eld->timers, eld->timers_count, sizeof(eld->timers[0]), compare_timers);
 }
@@ -164,7 +164,7 @@ prepareForPoll(EventLoopData *eld, monotonic_t timeout) {
     return timeout;
 }
 
-static inline struct timespec
+static struct timespec
 calc_time(monotonic_t nsec) {
     struct timespec result;
     result.tv_sec  = nsec / (1000LL * 1000LL * 1000LL);
@@ -271,7 +271,7 @@ wakeupEventLoop(EventLoopData *eld) {
 }
 
 #ifndef HAS_EVENT_FD
-static inline void
+static void
 closeFds(int *fds, size_t count) {
     while(count--) {
         if (*fds > 0) {
@@ -375,7 +375,7 @@ GLFWAPI char* utf_8_strndup(const char* source, size_t max_length) {
 int createAnonymousFile(off_t size) {
     int ret, fd = -1, shm_anon = 0;
 #ifdef HAS_MEMFD_CREATE
-    fd = memfd_create("glfw-shared", MFD_CLOEXEC | MFD_ALLOW_SEALING);
+    fd = glfw_memfd_create("glfw-shared", MFD_CLOEXEC | MFD_ALLOW_SEALING);
     if (fd < 0) return -1;
     // We can add this seal before calling posix_fallocate(), as the file
     // is currently zero-sized anyway.

glfw/cocoa_init.m

@@ -453,24 +453,74 @@ void* _glfwLoadLocalVulkanLoaderNS(void)
 //////                       GLFW platform API                      //////
 //////////////////////////////////////////////////////////////////////////
 
-static inline bool
-is_ctrl_tab(NSEvent *event, NSEventModifierFlags modifierFlags) {
+static bool
+is_modified_tab(NSEvent *event, NSEventModifierFlags modifierFlags) {
+    switch ((NSUInteger)modifierFlags) {
+        // No need to handle shift+tab, [shift]+option+tab
+        case NSEventModifierFlagShift:
+        case NSEventModifierFlagOption:
+        case (NSEventModifierFlagShift | NSEventModifierFlagOption):
+        // Do not intercept cmd+tab, shift+cmd+tab
+        case NSEventModifierFlagCommand:
+        case (NSEventModifierFlagShift | NSEventModifierFlagCommand):
+            return false;
+        default:
+            break;
+    }
+    // ctrl+whatever+tab, option+cmd+tab
     if (
-            (modifierFlags == NSEventModifierFlagControl &&
-                [event.charactersIgnoringModifiers isEqualToString:@"\t"]) ||
-            (modifierFlags == (NSEventModifierFlagControl | NSEventModifierFlagShift) &&
-                [event.charactersIgnoringModifiers isEqualToString:@"\x19"])
+            (
+                (modifierFlags & NSEventModifierFlagControl) ||
+                    modifierFlags == (NSEventModifierFlagOption | NSEventModifierFlagCommand)
+            ) && [event.charactersIgnoringModifiers isEqualToString:@"\t"]
+       ) return true;
+    // shift+whatever+tab
+    if (
+            (modifierFlags & NSEventModifierFlagShift) &&
+                [event.charactersIgnoringModifiers isEqualToString:@"\x19"]
        ) return true;
     return false;
 }
 
-static inline bool
+static bool
 is_cmd_period(NSEvent *event, NSEventModifierFlags modifierFlags) {
     if (modifierFlags != NSEventModifierFlagCommand) return false;
     if ([event.charactersIgnoringModifiers isEqualToString:@"."]) return true;
     return false;
 }
 
+static bool
+is_modified_special_key(NSEvent *event, NSEventModifierFlags modifierFlags) {
+    // really one should use [[NSUserDefaults standardUserDefaults] valueForDefaultsDomain:@"com.apple.symbolichotkeys" key:@"AppleSymbolicHotKeys"]
+    // to get the list of global shortcuts and pass through the important ones,
+    // see https://stackoverflow.com/questions/21878482/what-do-the-parameter-values-in-applesymbolichotkeys-plist-dict-represent
+    // however given that in order to know which integers are which actions in that dict one needs reverse engineering
+    // see https://stackoverflow.com/questions/866056/how-do-i-programmatically-get-the-shortcut-keys-reserved-by-mac-os-x
+    // it's too much effort.
+    if ([event.charactersIgnoringModifiers length] != 1) return false;
+    const unichar ch = [event.charactersIgnoringModifiers characterAtIndex:0];
+    if (modifierFlags == (NSEventModifierFlagControl | NSEventModifierFlagShift)) {
+        switch (ch) {
+            case 0x1b:  // Esc
+            case NSF1FunctionKey: case NSF2FunctionKey: case NSF3FunctionKey: case NSF4FunctionKey:
+            case NSF5FunctionKey: case NSF6FunctionKey: case NSF7FunctionKey: case NSF8FunctionKey:
+            case NSF9FunctionKey: case NSF10FunctionKey: case NSF11FunctionKey: case NSF12FunctionKey:
+            case NSF13FunctionKey: case NSF14FunctionKey: case NSF15FunctionKey: case NSF16FunctionKey:
+            case NSF17FunctionKey: case NSF18FunctionKey: case NSF19FunctionKey:
+                return true;
+        }
+    }
+    switch (ch) {
+        case 0x1b:  // Esc
+            if (modifierFlags & (NSEventModifierFlagCommand | NSEventModifierFlagControl)) return true;
+            break;
+        case NSHelpFunctionKey:  // For some reason keyboards with an insert key have it mapped to help
+            if (!modifierFlags || modifierFlags == NSEventModifierFlagShift) return true;
+            break;
+    }
+    return false;
+}
+
 GLFWAPI GLFWapplicationshouldhandlereopenfun glfwSetApplicationShouldHandleReopen(GLFWapplicationshouldhandlereopenfun callback) {
     GLFWapplicationshouldhandlereopenfun previous = handle_reopen_callback;
     handle_reopen_callback = callback;
@@ -510,10 +560,11 @@ int _glfwPlatformInit(void)
 
     NSEvent* (^keydown_block)(NSEvent*) = ^ NSEvent* (NSEvent* event)
     {
-        NSEventModifierFlags modifierFlags = [event modifierFlags] & NSEventModifierFlagDeviceIndependentFlagsMask;
-        if (is_ctrl_tab(event, modifierFlags) || is_cmd_period(event, modifierFlags)) {
-            // Cocoa swallows Ctrl+Tab to cycle between views
+        NSEventModifierFlags modifierFlags = [event modifierFlags] & (NSEventModifierFlagShift | NSEventModifierFlagOption | NSEventModifierFlagCommand | NSEventModifierFlagControl);
+        if (is_modified_special_key(event, modifierFlags) || is_modified_tab(event, modifierFlags) || is_cmd_period(event, modifierFlags)) {
+            // Cocoa swallows various key presses, so route them explicitly
             [[NSApp keyWindow].contentView keyDown:event];
+            return nil;
         }
 
         return event;
@@ -521,16 +572,17 @@ int _glfwPlatformInit(void)
 
     NSEvent* (^keyup_block)(NSEvent*) = ^ NSEvent* (NSEvent* event)
     {
-        NSEventModifierFlags modifierFlags = [event modifierFlags] & NSEventModifierFlagDeviceIndependentFlagsMask;
+        NSEventModifierFlags modifierFlags = [event modifierFlags] & (NSEventModifierFlagShift | NSEventModifierFlagOption | NSEventModifierFlagCommand | NSEventModifierFlagControl);
         if (modifierFlags & NSEventModifierFlagCommand) {
-            // From http://cocoadev.com/index.pl?GameKeyboardHandlingAlmost
+            // From https://cocoadev.github.io/GameKeyboardHandlingAlmost/
             // This works around an AppKit bug, where key up events while holding
             // down the command key don't get sent to the key window.
             [[NSApp keyWindow] sendEvent:event];
         }
-        if (is_ctrl_tab(event, modifierFlags) || is_cmd_period(event, modifierFlags)) {
-            // Cocoa swallows Ctrl+Tab to cycle between views
+        if (is_modified_special_key(event, modifierFlags) || is_modified_tab(event, modifierFlags) || is_cmd_period(event, modifierFlags)) {
+            // Cocoa swallows various key presses, so route them explicitly
             [[NSApp keyWindow].contentView keyUp:event];
+            return nil;
         }
 
         return event;
@@ -703,7 +755,7 @@ typedef struct {
 static Timer timers[128] = {{0}};
 static size_t num_timers = 0;
 
-static inline void
+static void
 remove_timer_at(size_t idx) {
     if (idx < num_timers) {
         Timer *t = timers + idx;

glfw/cocoa_monitor.m

@@ -41,13 +41,27 @@
 
 // Get the name of the specified display, or NULL
 //
-static char* getDisplayName(CGDirectDisplayID displayID)
+static char*
+getDisplayName(CGDirectDisplayID displayID, NSScreen* screen)
 {
+    // IOKit doesn't work on Apple Silicon anymore
+    // Luckily, 10.15 introduced -[NSScreen localizedName].
+    // Use it if available, and fall back to IOKit otherwise.
+    if (screen)
+    {
+        if ([screen respondsToSelector:@selector(localizedName)])
+        {
+            NSString* name = [screen valueForKey:@"localizedName"];
+            if (name) {
+                return _glfw_strdup([name UTF8String]);
+            }
+        }
+    }
     io_iterator_t it;
     io_service_t service;
     CFDictionaryRef info;
 
-    if (IOServiceGetMatchingServices(kIOMainPortDefault,
+    if (IOServiceGetMatchingServices(0,
                                      IOServiceMatching("IODisplayConnect"),
                                      &it) != 0)
     {
@@ -89,7 +103,7 @@ static char* getDisplayName(CGDirectDisplayID displayID)
     if (!service)
     {
         _glfwInputError(GLFW_PLATFORM_ERROR,
-                        "Cocoa: Failed to find service port for display, cannot get its name, using Unknown");
+                        "Cocoa: Failed to find service port for display");
         return NULL;
     }
 
@@ -245,7 +259,7 @@ static double getFallbackRefreshRate(CGDirectDisplayID displayID)
     io_iterator_t it;
     io_service_t service;
 
-    if (IOServiceGetMatchingServices(kIOMainPortDefault,
+    if (IOServiceGetMatchingServices(0,
                                      IOServiceMatching("IOFramebuffer"),
                                      &it) != 0)
     {
@@ -314,11 +328,9 @@ void _glfwClearDisplayLinks() {
         if (_glfw.ns.displayLinks.entries[i].displayLink) {
             CVDisplayLinkStop(_glfw.ns.displayLinks.entries[i].displayLink);
             CVDisplayLinkRelease(_glfw.ns.displayLinks.entries[i].displayLink);
-            _glfw.ns.displayLinks.entries[i].displayLink = nil;
-            _glfw.ns.displayLinks.entries[i].lastRenderFrameRequestedAt = 0;
-            _glfw.ns.displayLinks.entries[i].first_unserviced_render_frame_request_at = 0;
         }
     }
+    memset(_glfw.ns.displayLinks.entries, 0, sizeof(_GLFWDisplayLinkNS) * _glfw.ns.displayLinks.count);
     _glfw.ns.displayLinks.count = 0;
 }
 
@@ -340,16 +352,21 @@ _glfw_create_cv_display_link(_GLFWDisplayLinkNS *entry) {
     CVDisplayLinkSetOutputCallback(entry->displayLink, &displayLinkCallback, (void*)(uintptr_t)entry->displayID);
 }
 
-static void
-createDisplayLink(CGDirectDisplayID displayID) {
-    if (_glfw.ns.displayLinks.count >= sizeof(_glfw.ns.displayLinks.entries)/sizeof(_glfw.ns.displayLinks.entries[0]) - 1) return;
+_GLFWDisplayLinkNS*
+_glfw_create_display_link(CGDirectDisplayID displayID) {
+    if (_glfw.ns.displayLinks.count >= arraysz(_glfw.ns.displayLinks.entries) - 1) {
+        _glfwInputError(GLFW_PLATFORM_ERROR, "Too many monitors cannot create display link");
+        return NULL;
+    }
     for (size_t i = 0; i < _glfw.ns.displayLinks.count; i++) {
-        if (_glfw.ns.displayLinks.entries[i].displayID == displayID) return;
+        // already created in this run
+        if (_glfw.ns.displayLinks.entries[i].displayID == displayID) return _glfw.ns.displayLinks.entries + i;
     }
     _GLFWDisplayLinkNS *entry = &_glfw.ns.displayLinks.entries[_glfw.ns.displayLinks.count++];
     memset(entry, 0, sizeof(_GLFWDisplayLinkNS));
     entry->displayID = displayID;
     _glfw_create_cv_display_link(entry);
+    return entry;
 }
 
 // Poll for changes in the set of connected monitors
@@ -357,11 +374,13 @@ createDisplayLink(CGDirectDisplayID displayID) {
 void _glfwPollMonitorsNS(void)
 {
     uint32_t displayCount;
-
     CGGetOnlineDisplayList(0, NULL, &displayCount);
     CGDirectDisplayID* displays = calloc(displayCount, sizeof(CGDirectDisplayID));
     CGGetOnlineDisplayList(displayCount, displays, &displayCount);
     _glfwClearDisplayLinks();
+    if (_glfw.hints.init.debugRendering) {
+        fprintf(stderr, "Polling for monitors: %u found\n", displayCount);
+    }
 
     for (int i = 0;  i < _glfw.monitorCount;  i++)
         _glfw.monitors[i]->ns.screen = nil;
@@ -378,32 +397,57 @@ void _glfwPollMonitorsNS(void)
 
     for (uint32_t i = 0;  i < displayCount;  i++)
     {
-        if (CGDisplayIsAsleep(displays[i]))
+        if (CGDisplayIsAsleep(displays[i])) {
+            if (_glfw.hints.init.debugRendering) fprintf(stderr, "Ignoring sleeping display: %u", displays[i]);
             continue;
+        }
+
+        const uint32_t unitNumber = CGDisplayUnitNumber(displays[i]);
+        NSScreen* screen = nil;
+
+        for (screen in [NSScreen screens])
+        {
+            NSNumber* screenNumber = [screen deviceDescription][@"NSScreenNumber"];
+
+            // HACK: Compare unit numbers instead of display IDs to work around
+            //       display replacement on machines with automatic graphics
+            //       switching
+            if (CGDisplayUnitNumber([screenNumber unsignedIntValue]) == unitNumber)
+                break;
+        }
 
         // HACK: Compare unit numbers instead of display IDs to work around
         //       display replacement on machines with automatic graphics
         //       switching
-        const uint32_t unitNumber = CGDisplayUnitNumber(displays[i]);
-
-        for (uint32_t j = 0;  j < disconnectedCount;  j++)
+        uint32_t j;
+        for (j = 0;  j < disconnectedCount;  j++)
         {
             if (disconnected[j] && disconnected[j]->ns.unitNumber == unitNumber)
             {
+                disconnected[j]->ns.displayID  = displays[i];
+                disconnected[j]->ns.screen = screen;
+                _glfw_create_display_link(displays[i]);
                 disconnected[j] = NULL;
                 break;
             }
         }
 
+        if (j < disconnectedCount)
+            continue;
+
         const CGSize size = CGDisplayScreenSize(displays[i]);
-        char* name = getDisplayName(displays[i]);
-        if (!name)
-            name = _glfw_strdup("Unknown");
+        char* name = getDisplayName(displays[i], screen);
+        if (!name) {
+            _glfwInputError(GLFW_PLATFORM_ERROR,
+                "Failed to get name for display, using generic name");
+            name = _glfw_strdup("Display with no name");
+        }
 
         _GLFWmonitor* monitor = _glfwAllocMonitor(name, (int)size.width, (int)size.height);
         monitor->ns.displayID  = displays[i];
         monitor->ns.unitNumber = unitNumber;
-        createDisplayLink(monitor->ns.displayID);
+        monitor->ns.screen     = screen;
+        _glfw_create_display_link(monitor->ns.displayID);
 
         free(name);
 
@@ -554,15 +598,16 @@ GLFWvidmode* _glfwPlatformGetVideoModes(_GLFWmonitor* monitor, int* count)
 
         const GLFWvidmode mode =
             vidmodeFromCGDisplayMode(dm, monitor->ns.fallbackRefreshRate);
+        CFIndex j;
 
-        for (CFIndex j = 0;  j < *count;  j++)
+        for (j = 0;  j < *count;  j++)
         {
             if (_glfwCompareVideoModes(result + j, &mode) == 0)
                 break;
         }
 
         // Skip duplicate modes
-        if (i < *count)
+        if (j < *count)
             continue;
 
         (*count)++;

glfw/cocoa_platform.h

@@ -39,9 +39,6 @@ typedef void* CVDisplayLinkRef;
 // NOTE: Many Cocoa enum values have been renamed and we need to build across
 //       SDK versions where one is unavailable or the other deprecated
 //       We use the newer names in code and these macros to handle compatibility
-#if (MAC_OS_X_VERSION_MAX_ALLOWED < 120000) // Before macOS 12 Monterey
-  #define kIOMainPortDefault kIOMasterPortDefault
-#endif
 #if MAC_OS_X_VERSION_MAX_ALLOWED < 101200
  #define NSBitmapFormatAlphaNonpremultiplied NSAlphaNonpremultipliedBitmapFormat
  #define NSEventMaskAny NSAnyEventMask
@@ -250,3 +247,4 @@ void _glfwDispatchRenderFrame(CGDirectDisplayID);
 void _glfwShutdownCVDisplayLink(unsigned long long, void*);
 void _glfwCocoaPostEmptyEvent(void);
 void _glfw_create_cv_display_link(_GLFWDisplayLinkNS *entry);
+_GLFWDisplayLinkNS* _glfw_create_display_link(CGDirectDisplayID);

glfw/cocoa_window.m

@@ -38,6 +38,16 @@
 #define NSControlStateValueMixed NSMixedState
 #endif
 
+static const char*
+polymorphic_string_as_utf8(id string) {
+    if (string == nil) return "(nil)";
+    NSString* characters;
+    if ([string isKindOfClass:[NSAttributedString class]])
+        characters = [string string];
+    else
+        characters = (NSString*) string;
+    return [characters UTF8String];
+}
 
 static uint32_t
 vk_code_to_functional_key_code(uint8_t key_code) {  // {{{
@@ -233,10 +243,10 @@ mac_ucode_to_functional(uint32_t key_code) {  // {{{
     }
 } // }}}
 
-static inline bool
+static bool
 is_surrogate(UniChar uc) { return (uc - 0xd800u) < 2048u; }
 
-static inline uint32_t
+static uint32_t
 get_first_codepoint(UniChar *utf16, UniCharCount num) {
     if (!num) return 0;
     if (!is_surrogate(*utf16)) return *utf16;
@@ -244,7 +254,7 @@ get_first_codepoint(UniChar *utf16, UniCharCount num) {
     return 0;
 }
 
-static inline bool
+static bool
 is_pua_char(uint32_t ch) {
     return (0xE000 <= ch && ch <= 0xF8FF) || (0xF0000 <= ch && ch <= 0xFFFFF) || (0x100000 <= ch && ch <= 0x10FFFF);
 }
@@ -321,7 +331,7 @@ _glfwShutdownCVDisplayLink(unsigned long long timer_id UNUSED, void *user_data U
     }
 }
 
-static inline void
+static void
 requestRenderFrame(_GLFWwindow *w, GLFWcocoarenderframefun callback) {
     if (!callback) {
         w->ns.renderFrameRequested = false;
@@ -337,9 +347,12 @@ requestRenderFrame(_GLFWwindow *w, GLFWcocoarenderframefun callback) {
         display_link_shutdown_timer = _glfwPlatformAddTimer(DISPLAY_LINK_SHUTDOWN_CHECK_INTERVAL, false, _glfwShutdownCVDisplayLink, NULL, NULL);
     }
     monotonic_t now = glfwGetTime();
+    bool found_display_link = false;
+    _GLFWDisplayLinkNS *dl = NULL;
     for (size_t i = 0; i < _glfw.ns.displayLinks.count; i++) {
-        _GLFWDisplayLinkNS *dl = &_glfw.ns.displayLinks.entries[i];
+        dl = &_glfw.ns.displayLinks.entries[i];
         if (dl->displayID == displayID) {
+            found_display_link = true;
             dl->lastRenderFrameRequestedAt = now;
             if (!dl->first_unserviced_render_frame_request_at) dl->first_unserviced_render_frame_request_at = now;
             if (!CVDisplayLinkIsRunning(dl->displayLink)) CVDisplayLinkStart(dl->displayLink);
@@ -359,6 +372,14 @@ requestRenderFrame(_GLFWwindow *w, GLFWcocoarenderframefun callback) {
             dl->first_unserviced_render_frame_request_at = 0;
         }
     }
+    if (!found_display_link) {
+        dl = _glfw_create_display_link(displayID);
+        if (dl) {
+            dl->lastRenderFrameRequestedAt = now;
+            dl->first_unserviced_render_frame_request_at = now;
+            if (!CVDisplayLinkIsRunning(dl->displayLink)) CVDisplayLinkStart(dl->displayLink);
+        }
+    }
 }
 
 void
@@ -494,7 +515,7 @@ translateFlags(NSUInteger flags)
 
 #define debug_key(...) if (_glfw.hints.init.debugKeyboard) { fprintf(stderr, __VA_ARGS__); fflush(stderr); }
 
-static inline const char*
+static const char*
 format_mods(int mods) {
     static char buf[128];
     char *p = buf, *s;
@@ -514,7 +535,7 @@ format_mods(int mods) {
     return buf;
 }
 
-static inline const char*
+static const char*
 format_text(const char *src) {
     static char buf[256];
     char *p = buf;
@@ -550,6 +571,11 @@ translateKey(uint16_t vk_key, bool apply_keymap)
     return ans;
 }
 
+static NSRect
+get_window_size_without_border_in_logical_pixels(_GLFWwindow *window) {
+    return [window->ns.object contentRectForFrameRect:[window->ns.object frame]];
+}
+
 // Translate a GLFW keycode to a Cocoa modifier flag
 //
 static NSUInteger
@@ -755,7 +781,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 };
         _glfwInputWindowMaximize(window, maximized);
     }
 
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
     const NSRect fbRect = [window->ns.view convertRectToBacking:contentRect];
 
     if (fbRect.size.width != window->ns.fbWidth ||
@@ -838,6 +864,12 @@ static const NSRange kEmptyRange = { NSNotFound, 0 };
     showCursor(window);
 
     _glfwInputWindowFocus(window, false);
+    // IME is cancelled when losing the focus
+    if ([window->ns.view hasMarkedText]) {
+        [window->ns.view unmarkText];
+        GLFWkeyevent dummy = {.action = GLFW_RELEASE, .ime_state = GLFW_IME_PREEDIT_CHANGED};
+        _glfwInputKeyboard(window, &dummy);
+    }
 }
 
 - (void)windowDidChangeScreen:(NSNotification *)notification
@@ -861,6 +893,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 };
     NSTrackingArea* trackingArea;
     NSMutableAttributedString* markedText;
     NSRect markedRect;
+    bool marked_text_cleared_by_insert;
     NSString *input_source_at_last_key_event;
 }
 
@@ -1077,7 +1110,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 };
 - (void)viewDidChangeBackingProperties
 {
     if (!window) return;
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
     const NSRect fbRect = [window->ns.view convertRectToBacking:contentRect];
 
     if (fbRect.size.width != window->ns.fbWidth ||
@@ -1133,7 +1166,7 @@ static const NSRange kEmptyRange = { NSNotFound, 0 };
     [super updateTrackingAreas];
 }
 
-static inline UInt32
+static UInt32
 convert_cocoa_to_carbon_modifiers(NSUInteger flags) {
     UInt32 mods = 0;
     if (flags & NSEventModifierFlagShift)
@@ -1150,7 +1183,7 @@ convert_cocoa_to_carbon_modifiers(NSUInteger flags) {
     return (mods >> 8) & 0xFF;
 }
 
-static inline void
+static void
 convert_utf16_to_utf8(UniChar *src, UniCharCount src_length, char *dest, size_t dest_sz) {
     CFStringRef string = CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault,
                                                             src,
@@ -1163,12 +1196,12 @@ convert_utf16_to_utf8(UniChar *src, UniCharCount src_length, char *dest, size_t
     CFRelease(string);
 }
 
-static inline bool
+static bool
 alternate_key_is_ok(uint32_t key, uint32_t akey) {
     return akey > 31 && akey != key && !is_pua_char(akey);
 }
 
-static inline void
+static void
 add_alternate_keys(GLFWkeyevent *ev, NSEvent *event) {
     ev->alternate_key = translateKey(ev->native_key, false);
     if (!alternate_key_is_ok(ev->key, ev->alternate_key)) ev->alternate_key = 0;
@@ -1187,19 +1220,27 @@ add_alternate_keys(GLFWkeyevent *ev, NSEvent *event) {
     }
 }
 
-static inline bool
+static bool
 is_ascii_control_char(char x) {
     return x == 0 || (1 <= x && x <= 31) || x == 127;
 }
 
 - (void)keyDown:(NSEvent *)event
 {
+#define CLEAR_PRE_EDIT_TEXT glfw_keyevent.text = NULL; glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED; _glfwInputKeyboard(window, &glfw_keyevent);
+#define UPDATE_PRE_EDIT_TEXT glfw_keyevent.text = [[markedText string] UTF8String]; glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED; _glfwInputKeyboard(window, &glfw_keyevent);
+
     const bool previous_has_marked_text = [self hasMarkedText];
-    bool input_source_changed = false;
     NSTextInputContext *inpctx = [NSTextInputContext currentInputContext];
     if (inpctx && (!input_source_at_last_key_event || ![input_source_at_last_key_event isEqualToString:inpctx.selectedKeyboardInputSource])) {
+        if (input_source_at_last_key_event) {
+            debug_key("Input source changed, clearing pre-edit text and resetting deadkey state\n");
+            GLFWkeyevent dummy = {.action = GLFW_RELEASE, .ime_state = GLFW_IME_PREEDIT_CHANGED};
+            window->ns.deadKeyState = 0;
+            _glfwInputKeyboard(window, &dummy); // clear pre-edit text
+        }
         input_source_at_last_key_event = [inpctx.selectedKeyboardInputSource retain];
-        input_source_changed = true;
+        [self unmarkText];
     }
 
     const unsigned int keycode = [event keyCode];
@@ -1207,9 +1248,9 @@ is_ascii_control_char(char x) {
     const int mods = translateFlags(flags);
     const uint32_t key = translateKey(keycode, true);
     const bool process_text = !window->ns.textInputFilterCallback || window->ns.textInputFilterCallback(key, mods, keycode, flags) != 1;
-    [self unmarkText];
     _glfw.ns.text[0] = 0;
-    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = keycode, .action = GLFW_PRESS, .mods = mods};
+    if (keycode == 0x33 /* backspace */ || keycode == 0x35 /* escape */) [self unmarkText];
+    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = keycode, .native_key_id = keycode, .action = GLFW_PRESS, .mods = mods};
     if (!_glfw.ns.unicodeData) {
         // Using the cocoa API for key handling is disabled, as there is no
         // reliable way to handle dead keys using it. Only use it if the
@@ -1219,14 +1260,6 @@ is_ascii_control_char(char x) {
             [self interpretKeyEvents:[NSArray arrayWithObject:event]];
         }
     } else {
-        if (input_source_changed) {
-            debug_key("Input source changed, clearing pre-edit text and resetting deadkey state\n");
-            glfw_keyevent.text = NULL;
-            glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED;
-            window->ns.deadKeyState = 0;
-            _glfwInputKeyboard(window, &glfw_keyevent); // clear pre-edit text
-        }
-
         static UniChar text[256];
         UniCharCount char_count = 0;
         const bool in_compose_sequence = window->ns.deadKeyState != 0;
@@ -1249,6 +1282,7 @@ is_ascii_control_char(char x) {
         }
         debug_key("\x1b[31mPress:\x1b[m native_key: 0x%x (%s) glfw_key: 0x%x %schar_count: %lu deadKeyState: %u repeat: %d ",
                 keycode, safe_name_for_keycode(keycode), key, format_mods(mods), char_count, window->ns.deadKeyState, event.ARepeat);
+        marked_text_cleared_by_insert = false;
         if (process_text) {
             // this will call insertText which will fill up _glfw.ns.text
             [self interpretKeyEvents:[NSArray arrayWithObject:event]];
@@ -1257,41 +1291,46 @@ is_ascii_control_char(char x) {
         }
         if (window->ns.deadKeyState && (char_count == 0 || keycode == 0x75)) {
             // 0x75 is the delete key which needs to be ignored during a compose sequence
-            glfw_keyevent.text = [[markedText string] UTF8String];
             debug_key("Sending pre-edit text for dead key (text: %s markedText: %s).\n", format_text(_glfw.ns.text), glfw_keyevent.text);
-            glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED;
-            _glfwInputKeyboard(window, &glfw_keyevent); // update pre-edit text
+            UPDATE_PRE_EDIT_TEXT;
             return;
         }
         if (in_compose_sequence) {
             debug_key("Clearing pre-edit text at end of compose sequence\n");
-            glfw_keyevent.text = NULL;
-            glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED;
-            _glfwInputKeyboard(window, &glfw_keyevent); // clear pre-edit text
+            CLEAR_PRE_EDIT_TEXT;
         }
     }
     if (is_ascii_control_char(_glfw.ns.text[0])) _glfw.ns.text[0] = 0;  // don't send text for ascii control codes
-    debug_key("text: %s glfw_key: %s marked_text: %s\n",
+    debug_key("text: %s glfw_key: %s marked_text: (%s)\n",
             format_text(_glfw.ns.text), _glfwGetKeyName(key), [[markedText string] UTF8String]);
+    bool bracketed_ime = false;
     if (!window->ns.deadKeyState) {
         if ([self hasMarkedText]) {
-            glfw_keyevent.text = [[markedText string] UTF8String];
-            glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED;
-            _glfwInputKeyboard(window, &glfw_keyevent); // update pre-edit text
+            if (!marked_text_cleared_by_insert) {
+                UPDATE_PRE_EDIT_TEXT;
+            } else bracketed_ime = true;
         } else if (previous_has_marked_text) {
-            glfw_keyevent.text = NULL;
-            glfw_keyevent.ime_state = GLFW_IME_PREEDIT_CHANGED;
-            _glfwInputKeyboard(window, &glfw_keyevent); // clear pre-edit text
+            CLEAR_PRE_EDIT_TEXT;
         }
         if (([self hasMarkedText] || previous_has_marked_text) && !_glfw.ns.text[0]) {
             // do not pass keys like BACKSPACE while there's pre-edit text, let IME handle it
             return;
         }
     }
+    if (bracketed_ime) {
+        // insertText followed by setMarkedText
+        CLEAR_PRE_EDIT_TEXT;
+    }
     glfw_keyevent.text = _glfw.ns.text;
     glfw_keyevent.ime_state = GLFW_IME_NONE;
     add_alternate_keys(&glfw_keyevent, event);
     _glfwInputKeyboard(window, &glfw_keyevent);
+    if (bracketed_ime) {
+        // insertText followed by setMarkedText
+        UPDATE_PRE_EDIT_TEXT;
+    }
+#undef CLEAR_PRE_EDIT_TEXT
+#undef UPDATE_PRE_EDIT_TEXT
 }
 
 - (void)flagsChanged:(NSEvent *)event
@@ -1318,7 +1357,7 @@ is_ascii_control_char(char x) {
             action = GLFW_PRESS;
     }
 
-    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = [event keyCode], .action = action, .mods = mods};
+    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = [event keyCode], .native_key_id = [event keyCode], .action = action, .mods = mods};
     _glfwInputKeyboard(window, &glfw_keyevent);
 }
 
@@ -1328,7 +1367,7 @@ is_ascii_control_char(char x) {
     const uint32_t key = translateKey(keycode, true);
     const int mods = translateFlags([event modifierFlags]);
 
-    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = keycode, .action = GLFW_RELEASE, .mods = mods};
+    GLFWkeyevent glfw_keyevent = {.key = key, .native_key = keycode, .native_key_id = keycode, .action = GLFW_RELEASE, .mods = mods};
     add_alternate_keys(&glfw_keyevent, event);
     debug_key("\x1b[32mRelease:\x1b[m native_key: 0x%x (%s) glfw_key: 0x%x %s\n",
             keycode, safe_name_for_keycode(keycode), key, format_mods(mods));
@@ -1433,12 +1472,17 @@ is_ascii_control_char(char x) {
         selectedRange:(NSRange)selectedRange
      replacementRange:(NSRange)replacementRange
 {
-    (void)selectedRange; (void)replacementRange;
-    [markedText release];
-    if ([string isKindOfClass:[NSAttributedString class]])
+    debug_key("\n\tsetMarkedText: %s selectedRange: (%lu, %lu) replacementRange: (%lu, %lu)\n", polymorphic_string_as_utf8(string), selectedRange.location, selectedRange.length, replacementRange.location, replacementRange.length);
+    if (string == nil) { [self unmarkText]; return; }
+    if ([string isKindOfClass:[NSAttributedString class]]) {
+        if (((NSMutableAttributedString*)string).length == 0) { [self unmarkText]; return; }
+        [markedText release];
         markedText = [[NSMutableAttributedString alloc] initWithAttributedString:string];
-    else
+    } else {
+        if (((NSString*)string).length == 0) { [self unmarkText]; return; }
+        [markedText release];
         markedText = [[NSMutableAttributedString alloc] initWithString:string];
+    }
 }
 
 - (void)unmarkText
@@ -1456,17 +1500,18 @@ void _glfwPlatformUpdateIMEState(_GLFWwindow *w, const GLFWIMEUpdateEvent *ev) {
                 cellWidth:(CGFloat)cellWidth
                cellHeight:(CGFloat)cellHeight
 {
-    (void) which;
+    if (which != GLFW_IME_UPDATE_CURSOR_POSITION) return;
     left /= window->ns.xscale;
     top /= window->ns.yscale;
     cellWidth /= window->ns.xscale;
     cellHeight /= window->ns.yscale;
-    debug_key("updateIMEState: %f, %f, %f, %f\n", left, top, cellWidth, cellHeight);
+    debug_key("updateIMEPosition: left=%f, top=%f, width=%f, height=%f\n", left, top, cellWidth, cellHeight);
     const NSRect frame = [window->ns.view frame];
     const NSRect rectInView = NSMakeRect(left,
                                          frame.size.height - top - cellHeight,
                                          cellWidth, cellHeight);
     markedRect = [window->ns.object convertRectToScreen: rectInView];
+    if (_glfwPlatformWindowFocused(window)) [[window->ns.view inputContext] invalidateCharacterCoordinates];
 }
 
 - (NSArray*)validAttributesForMarkedText
@@ -1496,21 +1541,21 @@ void _glfwPlatformUpdateIMEState(_GLFWwindow *w, const GLFWIMEUpdateEvent *ev) {
 
 - (void)insertText:(id)string replacementRange:(NSRange)replacementRange
 {
-    (void)replacementRange;
-    NSString* characters;
-    if ([string isKindOfClass:[NSAttributedString class]])
-        characters = [string string];
-    else
-        characters = (NSString*) string;
+    const char *utf8 = polymorphic_string_as_utf8(string);
+    debug_key("\n\tinsertText: %s replacementRange: (%lu, %lu)\n", utf8, replacementRange.location, replacementRange.length);
+    if ([self hasMarkedText]) {
+        [self unmarkText];
+        marked_text_cleared_by_insert = true;
+    }
     // insertText can be called multiple times for a single key event
     char *s = _glfw.ns.text + strnlen(_glfw.ns.text, sizeof(_glfw.ns.text));
-    snprintf(s, sizeof(_glfw.ns.text) - (s - _glfw.ns.text), "%s", [characters UTF8String]);
+    snprintf(s, sizeof(_glfw.ns.text) - (s - _glfw.ns.text), "%s", utf8);
     _glfw.ns.text[sizeof(_glfw.ns.text) - 1] = 0;
 }
 
 - (void)doCommandBySelector:(SEL)selector
 {
-    (void)selector;
+    debug_key("\n\tdoCommandBySelector: (%s)\n", [NSStringFromSelector(selector) UTF8String]);
 }
 
 @end
@@ -1594,7 +1639,14 @@ void _glfwPlatformUpdateIMEState(_GLFWwindow *w, const GLFWIMEUpdateEvent *ev) {
 {
     if (glfw_window && glfw_window->ns.toggleFullscreenCallback && glfw_window->ns.toggleFullscreenCallback((GLFWwindow*)glfw_window) == 1)
             return;
+    // When resizeIncrements is set, Cocoa cannot restore the original window size after returning from fullscreen.
+    const NSSize original = [self resizeIncrements];
+    [self setResizeIncrements:NSMakeSize(1.0, 1.0)];
     [super toggleFullScreen:sender];
+    [self setResizeIncrements:original];
+    // When the window decoration is hidden, toggling fullscreen causes the style mask to be changed,
+    // and causes the first responder to be cleared.
+    if (glfw_window && !glfw_window->decorated && glfw_window->ns.view) [self makeFirstResponder:glfw_window->ns.view];
 }
 
 @end
@@ -1712,6 +1764,7 @@ int _glfwPlatformCreateWindow(_GLFWwindow* window,
 
     if (!createNativeWindow(window, wndconfig, fbconfig))
         return false;
+    [window->ns.object setColorSpace:[NSColorSpace sRGBColorSpace]];
 
     if (ctxconfig->client != GLFW_NO_API)
     {
@@ -1797,8 +1850,7 @@ void _glfwPlatformSetWindowIcon(_GLFWwindow* window UNUSED,
 
 void _glfwPlatformGetWindowPos(_GLFWwindow* window, int* xpos, int* ypos)
 {
-    const NSRect contentRect =
-        [window->ns.object contentRectForFrameRect:[window->ns.object frame]];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
 
     if (xpos)
         *xpos = (int)contentRect.origin.x;
@@ -1808,7 +1860,7 @@ void _glfwPlatformGetWindowPos(_GLFWwindow* window, int* xpos, int* ypos)
 
 void _glfwPlatformSetWindowPos(_GLFWwindow* window, int x, int y)
 {
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
     const NSRect dummyRect = NSMakeRect(x, _glfwTransformYNS(y + contentRect.size.height - 1), 0, 0);
     const NSRect frameRect = [window->ns.object frameRectForContentRect:dummyRect];
     [window->ns.object setFrameOrigin:frameRect.origin];
@@ -1816,7 +1868,7 @@ void _glfwPlatformSetWindowPos(_GLFWwindow* window, int x, int y)
 
 void _glfwPlatformGetWindowSize(_GLFWwindow* window, int* width, int* height)
 {
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
 
     if (width)
         *width = (int)contentRect.size.width;
@@ -1833,8 +1885,9 @@ void _glfwPlatformSetWindowSize(_GLFWwindow* window, int width, int height)
     }
     else
     {
-        NSRect contentRect =
-            [window->ns.object contentRectForFrameRect:[window->ns.object frame]];
+        // Disable window resizing in fullscreen.
+        if ([window->ns.object styleMask] & NSWindowStyleMaskFullScreen || window->ns.in_traditional_fullscreen) return;
+        NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
         contentRect.origin.y += contentRect.size.height - height;
         contentRect.size = NSMakeSize(width, height);
         [window->ns.object setFrame:[window->ns.object frameRectForContentRect:contentRect]
@@ -1867,15 +1920,18 @@ void _glfwPlatformSetWindowAspectRatio(_GLFWwindow* window, int numer, int denom
 
 void _glfwPlatformSetWindowSizeIncrements(_GLFWwindow* window, int widthincr, int heightincr)
 {
-    if (widthincr != GLFW_DONT_CARE && heightincr != GLFW_DONT_CARE)
-        [window->ns.object setResizeIncrements:NSMakeSize(widthincr, heightincr)];
-    else
+    if (widthincr != GLFW_DONT_CARE && heightincr != GLFW_DONT_CARE) {
+        float xscale = 1, yscale = 1;
+        _glfwPlatformGetWindowContentScale(window, &xscale, &yscale);
+        [window->ns.object setResizeIncrements:NSMakeSize(widthincr / xscale, heightincr / yscale)];
+    } else {
         [window->ns.object setResizeIncrements:NSMakeSize(1.0, 1.0)];
+    }
 }
 
 void _glfwPlatformGetFramebufferSize(_GLFWwindow* window, int* width, int* height)
 {
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
     const NSRect fbRect = [window->ns.view convertRectToBacking:contentRect];
 
     if (width)
@@ -1888,7 +1944,7 @@ void _glfwPlatformGetWindowFrameSize(_GLFWwindow* window,
                                      int* left, int* top,
                                      int* right, int* bottom)
 {
-    const NSRect contentRect = [window->ns.view frame];
+    const NSRect contentRect = get_window_size_without_border_in_logical_pixels(window);
     const NSRect frameRect = [window->ns.object frameRectForContentRect:contentRect];
 
     if (left)
@@ -1906,7 +1962,7 @@ void _glfwPlatformGetWindowFrameSize(_GLFWwindow* window,
 void _glfwPlatformGetWindowContentScale(_GLFWwindow* window,
                                         float* xscale, float* yscale)
 {
-    const NSRect points = [window->ns.view frame];
+    const NSRect points = get_window_size_without_border_in_logical_pixels(window);
     const NSRect pixels = [window->ns.view convertRectToBacking:points];
 
     if (xscale)
@@ -2390,13 +2446,21 @@ void _glfwPlatformSetCursor(_GLFWwindow* window, _GLFWcursor* cursor UNUSED)
         updateCursorImage(window);
 }
 
+bool _glfwPlatformIsFullscreen(_GLFWwindow* w, unsigned int flags) {
+    NSWindow *window = w->ns.object;
+    bool traditional = !(flags & 1);
+    if (traditional) { if(@available(macOS 11.0, *)) return w->ns.in_traditional_fullscreen; }
+    NSWindowStyleMask sm = [window styleMask];
+    return sm & NSWindowStyleMaskFullScreen;
+}
+
 bool _glfwPlatformToggleFullscreen(_GLFWwindow* w, unsigned int flags) {
     NSWindow *window = w->ns.object;
     bool made_fullscreen = true;
     bool traditional = !(flags & 1);
     NSWindowStyleMask sm = [window styleMask];
     if (traditional) {
-        if (@available(macOS 10.16, *)) {
+        if (@available(macOS 11.0, *)) {
             // As of Big Turd NSWindowStyleMaskFullScreen is no longer useable
             if (!w->ns.in_traditional_fullscreen) {
                 w->ns.pre_full_screen_style_mask = sm;
@@ -2410,9 +2474,6 @@ bool _glfwPlatformToggleFullscreen(_GLFWwindow* w, unsigned int flags) {
                 [[NSApplication sharedApplication] setPresentationOptions: NSApplicationPresentationDefault];
                 w->ns.in_traditional_fullscreen = false;
             }
-            // for some reason despite calling this selector, the window doesnt actually get keyboard focus till you click on it.
-            // presumably a bug with NSWindowStyleMaskBorderless windows
-            [window performSelector:@selector(makeKeyAndOrderFront:) withObject:nil afterDelay:0];
         } else {
             bool in_fullscreen = sm & NSWindowStyleMaskFullScreen;
             if (!(in_fullscreen)) {
@@ -2425,6 +2486,12 @@ bool _glfwPlatformToggleFullscreen(_GLFWwindow* w, unsigned int flags) {
             }
             [window setStyleMask: sm];
         }
+        // Changing the style mask causes the first responder to be cleared
+        [window makeFirstResponder:w->ns.view];
+        // If the dock and menubar are hidden going from maximized to fullscreen doesnt change the window size
+        // and macOS forgets to trigger windowDidResize, so call it ourselves
+        NSNotification *notification = [NSNotification notificationWithName:NSWindowDidResizeNotification object:window];
+        [w->ns.delegate performSelector:@selector(windowDidResize:) withObject:notification afterDelay:0];
     } else {
         bool in_fullscreen = sm & NSWindowStyleMaskFullScreen;
         if (in_fullscreen) made_fullscreen = false;

glfw/dbus_glfw.c

@@ -31,7 +31,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-static inline void
+static void
 report_error(DBusError *err, const char *fmt, ...) {
     static char buf[1024];
     va_list args;
@@ -64,7 +64,7 @@ on_dbus_watch_ready(int fd UNUSED, int events, void *data) {
     dbus_watch_handle(watch, flags);
 }
 
-static inline int
+static int
 events_for_watch(DBusWatch *watch) {
     int events = 0;
     unsigned int flags = dbus_watch_get_flags(watch);

glfw/glfw.py

@@ -6,7 +6,7 @@ import json
 import os
 import re
 import sys
-from typing import Callable, Dict, List, Optional, Tuple
+from typing import Callable, Dict, List, NamedTuple, Optional, Sequence, Tuple
 
 _plat = sys.platform.lower()
 is_linux = 'linux' in _plat
@@ -14,9 +14,23 @@ is_openbsd = 'openbsd' in _plat
 base = os.path.dirname(os.path.abspath(__file__))
 
 
+class CompileKey(NamedTuple):
+    src: str
+    dest: str
+
+
+class Command(NamedTuple):
+    desc: str
+    cmd: Sequence[str]
+    is_newer_func: Callable[[], bool]
+    on_success: Callable[[], None] = lambda: None
+    key: Optional[CompileKey] = None
+    keyfile: Optional[str] = None
+
+
 class Env:
 
-    cc: str = ''
+    cc: List[str] = []
     cppflags: List[str] = []
     cflags: List[str] = []
     ldflags: List[str] = []
@@ -33,11 +47,12 @@ class Env:
     wayland_protocols: Tuple[str, ...] = ()
 
     def __init__(
-        self, cc: str = '', cppflags: List[str] = [], cflags: List[str] = [], ldflags: List[str] = [],
+        self, cc: List[str] = [], cppflags: List[str] = [], cflags: List[str] = [], ldflags: List[str] = [],
         library_paths: Dict[str, List[str]] = {}, ldpaths: Optional[List[str]] = None, ccver: Tuple[int, int] = (0, 0)
     ):
         self.cc, self.cppflags, self.cflags, self.ldflags, self.library_paths = cc, cppflags, cflags, ldflags, library_paths
-        self.ldpaths, self.ccver = [] if ldpaths is None else ldpaths, ccver
+        self.ldpaths = ldpaths or []
+        self.ccver = ccver
 
     def copy(self) -> 'Env':
         ans = Env(self.cc, list(self.cppflags), list(self.cflags), list(self.ldflags), dict(self.library_paths), list(self.ldpaths), self.ccver)
@@ -55,7 +70,14 @@ def wayland_protocol_file_name(base: str, ext: str = 'c') -> str:
     return 'wayland-{}-client-protocol.{}'.format(base, ext)
 
 
-def init_env(env: Env, pkg_config: Callable, pkg_version: Callable, at_least_version: Callable, test_compile: Callable, module: str = 'x11') -> Env:
+def init_env(
+    env: Env,
+    pkg_config: Callable[..., List[str]],
+    pkg_version: Callable[[str], Tuple[int, int]],
+    at_least_version: Callable[..., None],
+    test_compile: Callable[..., bool],
+    module: str = 'x11'
+) -> Env:
     ans = env.copy()
     ans.cflags.append('-fPIC')
     ans.cppflags.append('-D_GLFW_' + module.upper())
@@ -117,7 +139,13 @@ def init_env(env: Env, pkg_config: Callable, pkg_version: Callable, at_least_ver
     return ans
 
 
-def build_wayland_protocols(env: Env, Command: Callable, parallel_run: Callable, emphasis: Callable, newer: Callable, dest_dir: str) -> None:
+def build_wayland_protocols(
+    env: Env,
+    parallel_run: Callable[[List[Command]], None],
+    emphasis: Callable[[str], str],
+    newer: Callable[..., bool],
+    dest_dir: str
+) -> None:
     items = []
     for protocol in env.wayland_protocols:
         src = os.path.join(env.wayland_packagedir, protocol)
@@ -130,8 +158,7 @@ def build_wayland_protocols(env: Env, Command: Callable, parallel_run: Callable,
                 q = 'client-header' if ext == 'h' else env.wayland_scanner_code
                 items.append(Command(
                     'Generating {} ...'.format(emphasis(os.path.basename(dest))),
-                    [env.wayland_scanner, q, src, dest],
-                    lambda: True, None, None, None))
+                    [env.wayland_scanner, q, src, dest], lambda: True))
     if items:
         parallel_run(items)
 
@@ -222,6 +249,7 @@ def generate_wrappers(glfw_header: str) -> None:
     unsigned long long glfwDBusUserNotify(const char *app_name, const char* icon, const char *summary, const char *body, \
 const char *action_text, int32_t timeout, GLFWDBusnotificationcreatedfun callback, void *data)
     void glfwDBusSetUserNotificationHandler(GLFWDBusnotificationactivatedfun handler)
+    int glfwSetX11LaunchCommand(GLFWwindow *handle, char **argv, int argc)
 '''.splitlines():
         if line:
             functions.append(Function(line.strip(), check_fail=False))