Port the code to set window size limits to wl_decor

.editorconfig

@@ -11,7 +11,7 @@ indent_style = tab
 
 # Autogenerated files with tabs below this line.
 
-[kitty/char-props-data.h]
+[kitty/{unicode-data.c,emoji.h,wcwidth-std.h}]
 indent_style = tab
 
 [kittens/unicode_input/names.h]

.gitattributes

@@ -1,19 +1,14 @@
-kitty/terminfo.h linguist-generated=true
-terminfo/kitty.termcap linguist-generated=true
-terminfo/kitty.terminfo linguist-generated=true
-terminfo/x/xterm-kitty linguist-generated=true
-kitty/char-props-data.h linguist-generated=true
-kitty_tests/GraphemeBreakTest.json linguist-generated=true
+kitty/wcwidth-std.h linguist-generated=true
+kitty/emoji.h linguist-generated=true
 kitty/charsets.c linguist-generated=true
 kitty/key_encoding.py linguist-generated=true
+kitty/unicode-data.c linguist-generated=true
 kitty/rowcolumn-diacritics.c linguist-generated=true
 kitty/rgb.py linguist-generated=true
 kitty/srgb_gamma.* linguist-generated=true
 kitty/gl-wrapper.* linguist-generated=true
 kitty/glfw-wrapper.* linguist-generated=true
-kitty/color-names.h linguist-generated=true
 kitty/parse-graphics-command.h linguist-generated=true
-kitty/parse-multicell-command.h linguist-generated=true
 kitty/options/types.py linguist-generated=true
 kitty/options/parse.py linguist-generated=true
 kitty/options/to-c-generated.h linguist-generated=true
@@ -23,12 +18,15 @@ glfw/*.c linguist-vendored=true
 glfw/*.h linguist-vendored=true
 3rdparty/** linguist-vendored=true
 kittens/unicode_input/names.h linguist-generated=true
-tools/wcswidth/char-props-data.go linguist-generated=true
+tools/wcswidth/std.go linguist-generated=true
 tools/unicode_names/names.txt linguist-generated=true
 terminfo/kitty.term* linguist-generated=true
 terminfo/x/* linguist-generated=true
-*_generated.* linguist-generated=true
-*_generated_test.* linguist-generated=true
+*_generated.h linguist-generated=true
+*_generated.go linguist-generated=true
+*_generated_test.go linguist-generated=true
+*_generated_test.s linguist-generated=true
+*_generated.s linguist-generated=true
 
 *.py  text diff=python
 *.m  text diff=objc

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,7 +23,7 @@ If applicable, add screenshots to help explain your problem.
 **Environment details**
 ```
 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.
+configuration to the clipboard and paste it here. 
 
 On older versions of kitty, run kitty --debug-config instead
 ```

.github/copilot-instructions.md

@@ -1,35 +0,0 @@
-Before implementing any code changes or responding to a request, run the
-following command:
-
-python3 .github/workflows/ci.py build
-
-This will download needed dependencies, then create all generated files
-and build the project, making it ready for inspection.
-
-# Repository Build & Test Instructions
-
-## Build Procedures
-- **Build command:** Run `./dev.sh build` to build the project
-- Run `gen/config.py` to update generated config parsing code for both kitty
-  and kitten. The `gen/go_code.py` generator is run automatically by the build
-  command to keep generated Go code files up to date.
-- To build individual kittens use the build command above **do not** try to run go build
-  yourself.
-
-Once a build is done, the kitty and kitten binaries will be in the `kitty/launcher` directory.
-Note that the kitty binary can run python files using `kitty +launch file.py`.
-When it does so the kitty fast_data_types module is available to the python
-code.
-
-## Test Procedures
-- To run the complete test suite, run `./test.py`
-- To run a specific test, run `./test.py test_name` where `test_name` is the name of the test without the
-  leading `test_` for Python tests and without the leading `Test` for Go tests.
-- Do not use go test or ./setup.py test to run tests
-
-## PR guidance
-When creating a pull request, if the changes in the pull request are user
-visible compared to the previous kitty release, add an entry in the file docs/changelog.rst
-describing the change. If the changes include changes to Go code, run gofmt on
-the changed Go files to ensure they are formatted correctly, before submitting
-your changes.

.github/dependabot.yml

@@ -13,15 +13,3 @@ updates:
       all-go-deps:
         patterns:
           - "*"  # group all non-security update PRs
-    cooldown:
-      default-days: 7
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    groups:
-      actions:
-        patterns:
-          - "*"
-    cooldown:
-      default-days: 7

.github/workflows/ci.py

@@ -4,7 +4,6 @@
 
 import glob
 import io
-import lzma
 import os
 import shlex
 import shutil
@@ -12,21 +11,15 @@ import subprocess
 import sys
 import tarfile
 import time
-from urllib.request import Request, urlopen
+from urllib.request import urlopen
 
 BUNDLE_URL = 'https://download.calibre-ebook.com/ci/kitty/{}-64.tar.xz'
-FONTS_URL = 'https://download.calibre-ebook.com/ci/fonts.tar.xz'
-NERD_URL = 'https://github.com/ryanoasis/nerd-fonts/releases/latest/download/NerdFontsSymbolsOnly.tar.xz'
 is_bundle = os.environ.get('KITTY_BUNDLE') == '1'
-is_codeql = os.environ.get('KITTY_CODEQL') == '1'
 is_macos = 'darwin' in sys.platform.lower()
-SW = ''
+SW = None
 
 
-def do_print_crash_reports() -> None:
-    sys.stdout.flush()
-    sys.stderr.flush()
-    time.sleep(2)
+def do_print_crash_reports():
     print('Printing available crash reports...')
     if is_macos:
         end_time = time.monotonic() + 90
@@ -45,9 +38,9 @@ def do_print_crash_reports() -> None:
     print(flush=True)
 
 
-def run(*a: str, print_crash_reports: bool = False) -> None:
+def run(*a, print_crash_reports=False):
     if len(a) == 1:
-        a = tuple(shlex.split(a[0]))
+        a = shlex.split(a[0])
     cmd = ' '.join(map(shlex.quote, a))
     print(cmd)
     sys.stdout.flush()
@@ -66,58 +59,23 @@ def run(*a: str, print_crash_reports: bool = False) -> None:
         raise SystemExit(f'The following process failed with exit code: {ret}:\n{cmd}')
 
 
-def download_with_retry(url: str | Request, count: int = 5) -> bytes:
-    for i in range(count):
-        try:
-            print('Downloading', getattr(url, 'full_url', url), flush=True)
-            with urlopen(url) as f:
-                ans: bytes = f.read()
-            return ans
-        except Exception as err:
-            if getattr(err, 'code', -1) == 403:
-                raise
-            if i >= count - 1:
-                raise
-            print(f'Download failed with error {err} retrying...', file=sys.stderr)
-            time.sleep(1)
-    return b''
-
-
-def install_fonts() -> None:
-    data = download_with_retry(FONTS_URL)
-    fonts_dir = os.path.expanduser('~/Library/Fonts' if is_macos else '~/.local/share/fonts')
-    os.makedirs(fonts_dir, exist_ok=True)
-    with tarfile.open(fileobj=io.BytesIO(data), mode='r:xz') as tf:
-        try:
-            tf.extractall(fonts_dir, filter='fully_trusted')
-        except TypeError:
-            tf.extractall(fonts_dir)
-    data = download_with_retry(NERD_URL)
-    with tarfile.open(fileobj=io.BytesIO(data), mode='r:xz') as tf:
-        try:
-            tf.extractall(fonts_dir, filter='fully_trusted')
-        except TypeError:
-            tf.extractall(fonts_dir)
-
-
-def install_deps() -> None:
+def install_deps():
     print('Installing kitty dependencies...')
     sys.stdout.flush()
     if is_macos:
-        if not is_codeql:  # for some reason brew fails on CodeQL we dont need it anyway
-            items = [x.split()[1].strip('"') for x in open('Brewfile').readlines() if x.strip().startswith('brew ')]
-            openssl = 'openssl'
-            items.remove('go')  # already installed by ci.yml
-            import ssl
-            if ssl.OPENSSL_VERSION_INFO[0] == 1:
-                openssl += '@1.1'
-            run('brew', 'install', 'fish', openssl, *items)
+        items = [x.split()[1].strip('"') for x in open('Brewfile').readlines() if x.strip().startswith('brew ')]
+        openssl = 'openssl'
+        items.remove('go')  # already installed by ci.yml
+        import ssl
+        if ssl.OPENSSL_VERSION_INFO[0] == 1:
+            openssl += '@1.1'
+        run('brew', 'install', 'fish', 'simde', openssl, *items)
     else:
         run('sudo apt-get update')
-        run('sudo apt-get install -y --fix-missing libgl1-mesa-dev libxi-dev libxrandr-dev libxinerama-dev ca-certificates'
+        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 zsh'
             ' libpng-dev liblcms2-dev libfontconfig-dev libxkbcommon-x11-dev libcanberra-dev libxxhash-dev uuid-dev'
-            ' libsimde-dev libsystemd-dev libcairo2-dev zsh bash dash systemd-coredump gdb')
+            ' libsimde-dev zsh bash dash systemd-coredump gdb')
         # for some reason these directories are world writable which causes zsh
         # compinit to break
         run('sudo chmod -R og-w /usr/share/zsh')
@@ -128,10 +86,9 @@ def install_deps() -> None:
         if sys.version_info[:2] < (3, 7):
             cmd += ' importlib-resources dataclasses'
         run(cmd)
-    install_fonts()
 
 
-def build_kitty() -> None:
+def build_kitty():
     python = shutil.which('python3') if is_bundle else sys.executable
     cmd = f'{python} setup.py build --verbose'
     if is_macos:
@@ -141,14 +98,14 @@ def build_kitty() -> None:
     run(cmd)
 
 
-def test_kitty() -> None:
+def test_kitty():
     if is_macos:
         run('ulimit -c unlimited')
         run('sudo chmod -R 777 /cores')
     run('./test.py', print_crash_reports=True)
 
 
-def package_kitty() -> None:
+def package_kitty():
     python = 'python3' if is_macos else 'python'
     run(f'{python} setup.py linux-package --update-check-interval=0 --verbose')
     if is_macos:
@@ -156,14 +113,14 @@ def package_kitty() -> None:
         run('kitty.app/Contents/MacOS/kitty +runpy "from kitty.constants import *; print(kitty_exe())"')
 
 
-def replace_in_file(path: str, src: str, dest: str) -> None:
+def replace_in_file(path, src, dest):
     with open(path, 'r+') as f:
         n = f.read().replace(src, dest)
         f.seek(0), f.truncate()
         f.write(n)
 
 
-def setup_bundle_env() -> None:
+def setup_bundle_env():
     global SW
     os.environ['SW'] = SW = '/Users/Shared/kitty-build/sw/sw' if is_macos else os.path.join(os.environ['GITHUB_WORKSPACE'], 'sw')
     os.environ['PKG_CONFIG_PATH'] = os.path.join(SW, 'lib', 'pkgconfig')
@@ -175,101 +132,27 @@ def setup_bundle_env() -> None:
     os.environ['PATH'] = '{}:{}'.format(os.path.join(SW, 'bin'), os.environ['PATH'])
 
 
-def install_bundle(dest: str = '', which: str = '') -> None:
-    dest = dest or SW
+def install_bundle():
     cwd = os.getcwd()
-    os.makedirs(dest, exist_ok=True)
-    os.chdir(dest)
-    which = which or ('macos' if is_macos else 'linux')
-    data = download_with_retry(BUNDLE_URL.format(which))
+    os.makedirs(SW)
+    os.chdir(SW)
+    with urlopen(BUNDLE_URL.format('macos' if is_macos else 'linux')) as f:
+        data = f.read()
     with tarfile.open(fileobj=io.BytesIO(data), mode='r:xz') as tf:
-        try:
-            tf.extractall(filter='fully_trusted')
-        except TypeError:
-            tf.extractall()
+        tf.extractall()
     if not is_macos:
         replaced = 0
         for dirpath, dirnames, filenames in os.walk('.'):
             for f in filenames:
                 if f.endswith('.pc') or (f.endswith('.py') and f.startswith('_sysconfig')):
-                    replace_in_file(os.path.join(dirpath, f), '/sw/sw', dest)
+                    replace_in_file(os.path.join(dirpath, f), '/sw/sw', SW)
                     replaced += 1
         if replaced < 2:
             raise SystemExit('Failed to replace path to SW in bundle')
     os.chdir(cwd)
 
 
-def install_grype(exe: str = '/tmp/grype') -> str:
-    raw = download_with_retry('https://download.calibre-ebook.com/ci/grype.xz')
-    raw = lzma.decompress(raw)
-    with open(exe, 'wb') as f:
-        f.write(raw)
-        os.fchmod(f.fileno(), 0o755)
-    subprocess.check_call([exe, 'db', 'update'])
-    return exe
-
-
-IGNORED_DEPENDENCY_CVES = [
-    # Python stdlib
-    'CVE-2025-8194', # DoS in tarfile
-    'CVE-2025-6069', # DoS in HTMLParser
-    'CVE-2025-13836', # DoS in http client reading from malicious server
-    'CVE-2025-12084', # DoS in xml.dom.minidom unused in kitty
-    'CVE-2025-13837', # DoS in plistlib reading plist. We only use plistlib for writing
-    'CVE-2025-6075',  # Quadratic complexity in os.path.expandvars()
-    # python stdlib all these are erroneously marked as fixed in python 3.15
-    # when it hasnt even been released. Sigh.
-    'CVE-2026-1299',
-    'CVE-2026-0865',
-    'CVE-2025-15282',
-    'CVE-2026-0672',
-    'CVE-2025-15366',
-    'CVE-2025-15367',
-    'CVE-2025-12781',
-    'CVE-2025-11468',
-    'CVE-2026-2297',
-    'CVE-2026-3644',
-    'CVE-2026-4224',
-    'CVE-2026-4519',
-    'CVE-2026-1502',
-    'CVE-2026-7210',  # DoS in unused XML parser
-    'CVE-2026-3276',  # DoS in unicodedata.normalize()
-    'CVE-2026-7774',  # tarfile.data_filter path traversal bypass
-    # github.com/nwaples/rardecode/v2
-    'CVE-2025-11579', # rardecode is version 2.2.1, not vulnerable
-    'CVE-2026-2673',  # openssl fix not released
-]
-
-
-def check_dependencies() -> None:
-    grype = install_grype()
-    with open((gc := os.path.expanduser('~/.grype.yml')), 'w') as f:
-        print('ignore:', file=f)
-        for x in IGNORED_DEPENDENCY_CVES:
-            print('  - vulnerability:', x, file=f)
-    dest = os.path.join(SW, 'linux')
-    os.makedirs(dest, exist_ok=True)
-    install_bundle(dest, os.path.basename(dest))
-    dest = os.path.join(SW, 'macos')
-    os.makedirs(dest, exist_ok=True)
-    install_bundle(dest, os.path.basename(dest))
-    cmdline = [grype, '--by-cve', '--config', gc, '--fail-on', 'medium', '--only-fixed', '--add-cpes-if-none']
-    if (subprocess.run(cmdline + ['dir:' + SW])).returncode != 0:
-        raise SystemExit('grype found problems during filesystem scan')
-    # Now test against the SBOM
-    import runpy
-    orig = sys.argv, sys.stdout
-    sys.argv = ['bypy', 'sbom', 'kovidgoyal/kitty', '1.0.0']
-    buf = io.StringIO()
-    sys.stdout = buf
-    runpy.run_path('bypy-src')
-    sys.argv, sys.stdout = orig
-    print(buf.getvalue())
-    if (subprocess.run(cmdline, input=buf.getvalue().encode())).returncode != 0:
-        raise SystemExit('grype found problems during SBOM scan')
-
-
-def main() -> None:
+def main():
     if is_bundle:
         setup_bundle_env()
     else:
@@ -284,20 +167,12 @@ def main() -> None:
         package_kitty()
     elif action == 'test':
         test_kitty()
-    elif action == 'test':
-        test_kitty()
-    elif action == 'govulncheck':
-        subprocess.check_call(['go', 'install', 'golang.org/x/vuln/cmd/govulncheck@latest'])
-        subprocess.check_call(['govulncheck', '-mode=binary', 'kitty/launcher/kitten'])
-        subprocess.check_call(['govulncheck', './...'])
     elif action == 'gofmt':
-        q = subprocess.check_output('gofmt -s -l tools kittens'.split()).decode()
+        q = subprocess.check_output('gofmt -s -l tools'.split())
         if q.strip():
-            q = '\n'.join(filter(lambda x: not x.rstrip().endswith('_generated.go'), q.strip().splitlines())).strip()
+            q = '\n'.join(filter(lambda x: not x.rstrip().endswith('_generated.go'), q.decode().strip().splitlines())).strip()
             if q:
                 raise SystemExit(q)
-    elif action == 'check-dependencies':
-        check_dependencies()
     else:
         raise SystemExit(f'Unknown action: {action}')
 

.github/workflows/ci.yml

@@ -23,15 +23,15 @@ jobs:
                 cc: [gcc, clang]
                 include:
                     - python: a
-                      pyver: "3.11"
+                      pyver: "3.8"
                       sanitize: 0
 
                     - python: b
-                      pyver: "3.12"
+                      pyver: "3.11"
                       sanitize: 1
 
                     - python: c
-                      pyver: "3.13"
+                      pyver: "3.9"
                       sanitize: 1
 
 
@@ -45,18 +45,17 @@ jobs:
 
         steps:
           - name: Checkout source code
-            uses: actions/checkout@v6
+            uses: actions/checkout@v3
             with:
               fetch-depth: 10
-              persist-credentials: false
 
           - name: Set up Python ${{ matrix.pyver }}
-            uses: actions/setup-python@v6
+            uses: actions/setup-python@v4
             with:
               python-version: ${{ matrix.pyver }}
 
           - name: Install Go
-            uses: actions/setup-go@v6
+            uses: actions/setup-go@v4
             with:
               go-version-file: go.mod
 
@@ -73,30 +72,26 @@ jobs:
             CFLAGS: -funsigned-char
         steps:
           - name: Checkout source code
-            uses: actions/checkout@v6
+            uses: actions/checkout@v3
             with:
               fetch-depth: 0  # needed for :commit: docs role
-              persist-credentials: false
 
           - name: Test for trailing whitespace
             run: if grep -Inr '\s$' kitty kitty_tests kittens docs *.py *.asciidoc *.rst *.go .gitattributes .gitignore; then echo Trailing whitespace found, aborting.; exit 1; fi
 
-          - name: Test for bad code block formatting
-            run: if grep -Inr ':code:`\s' kitty kitty_tests kittens docs *.py *.asciidoc *.rst *.go .gitattributes .gitignore; then echo Space at code block start found, aborting.; exit 1; fi
-
           - name: Set up Python
-            uses: actions/setup-python@v6
+            uses: actions/setup-python@v4
             with:
-              python-version: "3.14"
+              python-version: "3.10"
 
           - name: Install Go
-            uses: actions/setup-go@v6
+            uses: actions/setup-go@v4
             with:
               go-version-file: go.mod
               cache: false
 
           - name: Cache Go build artifacts separately
-            uses: actions/cache@v5
+            uses: actions/cache@v3
             with:
               path: |
                 ~/.cache/go-build
@@ -106,10 +101,10 @@ jobs:
                 ${{ runner.os }}-golang-static-
 
           - name: Install build-only deps
-            run: python -m pip install -r docs/requirements.txt ruff mypy types-requests types-docutils types-Pygments
+            run: python -m pip install -r docs/requirements.txt ruff mypy types-requests types-docutils
 
           - name: Run ruff
-            run: ruff check .
+            run: ruff .
 
           - name: Run gofmt
             run: go version && python .github/workflows/ci.py gofmt
@@ -124,7 +119,7 @@ jobs:
             run: which python && python -m mypy --version && ./test.py mypy
 
           - name: Run go vet
-            run: go version && go vet -tags testing ./...
+            run: go version && go vet ./...
 
           - name: Build man page
             run: make FAIL_WARN=1 man
@@ -145,13 +140,12 @@ jobs:
             KITTY_BUNDLE: 1
         steps:
           - name: Checkout source code
-            uses: actions/checkout@v6
+            uses: actions/checkout@v3
             with:
               fetch-depth: 10
-              persist-credentials: false
 
           - name: Install Go
-            uses: actions/setup-go@v6
+            uses: actions/setup-go@v4
             with:
               go-version-file: go.mod
 
@@ -166,18 +160,17 @@ jobs:
         runs-on: macos-latest
         steps:
           - name: Checkout source code
-            uses: actions/checkout@v6
+            uses: actions/checkout@v3
             with:
               fetch-depth: 0  # needed for :commit: docs role
-              persist-credentials: false
 
           - name: Set up Python
-            uses: actions/setup-python@v6
+            uses: actions/setup-python@v4
             with:
-              python-version: "3.14"
+              python-version: "3.10"
 
           - name: Install Go
-            uses: actions/setup-go@v6
+            uses: actions/setup-go@v4
             with:
               go-version-file: go.mod
 
@@ -195,30 +188,3 @@ jobs:
 
           - name: Build kitty package
             run: python3 .github/workflows/ci.py package
-
-          - name: Run benchmarks
-            run: ./benchmark.py
-
-    linux-dev:
-        name: Test ./dev.sh and benchmark
-        runs-on: ubuntu-latest
-        steps:
-          - name: Checkout source code
-            uses: actions/checkout@v6
-            with:
-              fetch-depth: 10
-              persist-credentials: false
-
-          - name: Install build deps
-            run: sudo apt-get update && sudo apt-get install -y curl xz-utils build-essential git pkg-config libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libgl1-mesa-dev libxkbcommon-x11-dev libfontconfig-dev libx11-xcb-dev libdbus-1-dev
-
-          - name: Install Go
-            uses: actions/setup-go@v6
-            with:
-              go-version-file: go.mod
-
-          - name: Build kitty
-            run: ./dev.sh build
-
-          - name: Run benchmarks
-            run: ./benchmark.py

.github/workflows/codeql-analysis.yml

@@ -1,71 +1,49 @@
-name: "CodeQL"
+name: "Code scanning - action"
 
 on:
-    push:
-        branches: [master]
-    pull_request:
-        # The branches below must be a subset of the branches above
-        branches: [master]
-    schedule:
-        - cron: '0 22 * * 5'
+  push:
+    branches: [master, ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: '0 22 * * 5'
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
 
 jobs:
-    CodeQL-Build:
+  CodeQL-Build:
 
-        permissions:
-            contents: read # to fetch code (actions/checkout)
-            security-events: write # to upload SARIF results (github/codeql-action/analyze)
+    permissions:
+      contents: read # to fetch code (actions/checkout)
+      security-events: write # to upload SARIF results (github/codeql-action/analyze)
 
-        strategy:
-          fail-fast: false
-          matrix:
-            include:
-               - language: python
-                 os: ubuntu-latest
-               - language: c
-                 os: ubuntu-latest
-               - language: c
-                 os: macos-latest
-               - language: go
-                 os: ubuntu-latest
-               - language: actions
-                 os: ubuntu-latest
+    runs-on: ubuntu-latest
 
-        runs-on: ${{ matrix.os }}
-        env:
-            KITTY_BUNDLE: 1
-            KITTY_CODEQL: 1
+    steps:
 
-        steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
 
-        - name: Checkout repository
-          uses: actions/checkout@v6
-          with:
-              # We must fetch at least the immediate parents so that if this is
-              # a pull request then we can checkout the head.
-              fetch-depth: 2
-              persist-credentials: false
+    - name: Install Go
+      uses: actions/setup-go@v3
+      with:
+        go-version-file: go.mod
 
-        - name: Install Go
-          if: matrix.language == 'c' || matrix.language == 'go'
-          uses: actions/setup-go@v6
-          with:
-              go-version-file: go.mod
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: python, c
+        setup-python-dependencies: false
 
-        # Initializes the CodeQL tools for scanning.
-        - name: Initialize CodeQL
-          uses: github/codeql-action/init@v4.36.0
-          with:
-              languages: ${{ matrix.language }}
-              trap-caching: false
+    - name: Build kitty
+      run: python3 .github/workflows/ci.py build
 
-        - name: Build kitty
-          if: matrix.language == 'c' || matrix.language == 'go'
-          run: python3 .github/workflows/ci.py build
-
-        - name: Perform CodeQL Analysis
-          uses: github/codeql-action/analyze@v4.36.0
-
-        - name: Run govulncheck
-          if: matrix.language == 'go'
-          run: python3 .github/workflows/ci.py govulncheck
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.github/workflows/depscan.yml

@@ -1,39 +0,0 @@
-name: Depscan
-on:
-    push:
-        branches: [master]
-    schedule:
-        - cron: '0 12 * * 5'
-
-env:
-    CI: 'true'
-    ASAN_OPTIONS: detect_leaks=0
-    LC_ALL: en_US.UTF-8
-    LANG: en_US.UTF-8
-
-permissions:
-  contents: read # to fetch code (actions/checkout)
-
-jobs:
-    dependecy-scanner:
-        name: Scan dependencies for vulnerabilities
-        runs-on: ubuntu-latest
-        env:
-            KITTY_BUNDLE: 1
-        steps:
-          - name: Checkout source code
-            uses: actions/checkout@v6
-            with:
-              fetch-depth: 10
-              persist-credentials: false
-
-          - name: Checkout bypy
-            uses: actions/checkout@v6
-            with:
-              fetch-depth: 1
-              persist-credentials: false
-              repository: kovidgoyal/bypy
-              path: bypy-src
-
-          - name: Check dependencies
-            run: python3 .github/workflows/ci.py check-dependencies

.gitignore

@@ -12,7 +12,6 @@
 /dependencies
 /tags
 /build/
-/fonts/
 /linux-package/
 /kitty.app/
 /glad/out/
@@ -29,5 +28,3 @@ __pycache__/
 .cache
 bypy/b
 bypy/virtual-machines.conf
-_codeql_detected_source_root
-

.ignore

@@ -0,0 +1 @@
+kittens/unicode_input/names.h

3rdparty/base64/README.md

@@ -176,7 +176,7 @@ CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a" NEON64_CFLAGS=" " ma
 
 ### OpenMP
 
-To enable OpenMP on GCC you need to build with `-fopenmp`. This can be by setting the `OPENMP` environment variable to `1`.
+To enable OpenMP on GCC you need to build with `-fopenmp`. This can be by setting the the `OPENMP` environment variable to `1`.
 
 Example:
 

Brewfile

@@ -1,6 +1,6 @@
+brew "pkg-config"
 brew "zlib"
 brew "xxhash"
-brew "simde"
 brew "python"
 brew "imagemagick"
 brew "harfbuzz"

README.asciidoc

@@ -1,7 +1,5 @@
 = kitty - the fast, feature-rich, cross-platform, GPU based terminal
 
-If you live in the terminal, *kitty* is made for **you**!
-
 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"]
@@ -13,4 +11,4 @@ https://www.reddit.com/r/KittyTerminal[Reddit community]
 
 Packaging status in various repositories:
 
-image:https://repology.org/badge/vertical-allrepos/kitty-terminal.svg?columns=3&header=kitty["Packaging status", link="https://repology.org/project/kitty-terminal/versions"]
+image:https://repology.org/badge/vertical-allrepos/kitty.svg?columns=3&header=kitty["Packaging status", link="https://repology.org/project/kitty/versions"]

SECURITY.md

@@ -7,12 +7,6 @@ and released just like all other bugs.
 
 ## Reporting a vulnerability
 
-Preferably send an email to kovid at kovidgoyal.net or open a private security
-advisory using the GitHub security advisory facility.
-
-Note that I will generally respond to security communication within 72 hours. Once
-the bug is confirmed, it will be fixed or at least mitigated within another 72
-hours, at which time the fix will typically be committed to master and hence be
-public. That timeline might be extended based on the severity of the issue and the
-current state of master in terms of making a new release, if so, it will be
-done in consultation with the issue reporter.
+Preferably send an email to kovid at kovidgoyal.net or open an issue in the
+GitHub repository, though the latter means you are disclosing the vulnerability
+publicly before it can be fixed.

benchmark.py

@@ -1,90 +0,0 @@
-#!./kitty/launcher/kitty +launch
-# License: GPL v3 Copyright: 2016, Kovid Goyal <kovid at kovidgoyal.net>
-
-import fcntl
-import io
-import os
-import select
-import signal
-import struct
-import sys
-import termios
-import time
-from pty import CHILD, fork
-
-from kitty.constants import kitten_exe
-from kitty.fast_data_types import Screen, safe_pipe
-from kitty.utils import read_screen_size
-
-
-def run_parsing_benchmark(cell_width: int = 10, cell_height: int = 20, scrollback: int = 20000) -> None:
-    isatty = sys.stdout.isatty()
-    if isatty:
-        sz = read_screen_size()
-        columns, rows = sz.cols, sz.rows
-    else:
-        columns, rows = 80, 25
-    child_pid, master_fd = fork()
-    is_child = child_pid == CHILD
-    argv = [kitten_exe(), '__benchmark__', '--with-scrollback']
-    if is_child:
-        while read_screen_size().width != columns * cell_width:
-            time.sleep(0.01)
-        signal.pthread_sigmask(signal.SIG_SETMASK, ())
-        os.execvp(argv[0], argv)
-    # os.set_blocking(master_fd, False)
-    x_pixels = columns * cell_width
-    y_pixels = rows * cell_height
-    s = struct.pack('HHHH', rows, columns, x_pixels, y_pixels)
-    fcntl.ioctl(master_fd, termios.TIOCSWINSZ, s)
-
-    write_buf = b''
-    r_pipe, w_pipe = safe_pipe(True)
-    class ToChild:
-        def write(self, x: bytes | str) -> None:
-            nonlocal write_buf
-            if isinstance(x, str):
-                x = x.encode()
-            write_buf += x
-            os.write(w_pipe, b'1')
-
-    screen = Screen(None, rows, columns, scrollback, cell_width, cell_height, 0, ToChild())
-
-    def parse_bytes(data: bytes|memoryview) -> None:
-        data = memoryview(data)
-        while data:
-            dest = screen.test_create_write_buffer()
-            s = screen.test_commit_write_buffer(data, dest)
-            data = data[s:]
-            screen.test_parse_written_data()
-
-
-    while True:
-        rd, wd, _ = select.select([master_fd, r_pipe], [master_fd] if write_buf else [], [])
-        if r_pipe in rd:
-            os.read(r_pipe, 256)
-        if master_fd in rd:
-            try:
-                data = os.read(master_fd, io.DEFAULT_BUFFER_SIZE)
-            except OSError:
-                data = b''
-            if not data:
-                break
-            parse_bytes(data)
-        if master_fd in wd:
-            n = os.write(master_fd, write_buf)
-            write_buf = write_buf[n:]
-    if isatty:
-        lines: list[str] = []
-        screen.linebuf.as_ansi(lines.append)
-        sys.stdout.write(''.join(lines))
-    else:
-        sys.stdout.write(str(screen.linebuf))
-
-
-def main() -> None:
-    run_parsing_benchmark()
-
-
-if __name__ == '__main__':
-    main()

bypy/devenv.go

@@ -21,12 +21,10 @@ import (
 
 const (
 	folder                     = "dependencies"
-	fonts_folder               = "fonts"
 	macos_prefix               = "/Users/Shared/kitty-build/sw/sw"
 	macos_python               = "python/Python.framework/Versions/Current/bin/python3"
 	macos_python_framework     = "python/Python.framework/Versions/Current/Python"
 	macos_python_framework_exe = "python/Python.framework/Versions/Current/Resources/Python.app/Contents/MacOS/Python"
-	NERD_URL                   = "https://github.com/ryanoasis/nerd-fonts/releases/latest/download/NerdFontsSymbolsOnly.tar.xz"
 )
 
 func root_dir() string {
@@ -37,14 +35,6 @@ func root_dir() string {
 	return f
 }
 
-func fonts_dir() string {
-	f, e := filepath.Abs(fonts_folder)
-	if e != nil {
-		exit(e)
-	}
-	return f
-}
-
 var _ = fmt.Print
 
 func exit(x any) {
@@ -96,8 +86,8 @@ func get_dependencies(path string) (ans []dependency) {
 	for _, line := range lines("otool", "-L", path) {
 		line = strings.TrimSpace(line)
 		if strings.Contains(line, "compatibility") && !strings.HasSuffix(line, ":") {
-			before, _, _ := strings.Cut(line, "(")
-			dep := strings.TrimSpace(before)
+			idx := strings.IndexByte(line, '(')
+			dep := strings.TrimSpace(line[:idx])
 			ans = append(ans, dependency{path: dep, is_id: dep == install_name})
 		}
 	}
@@ -335,19 +325,6 @@ func dependencies(args []string) {
 	}); err != nil {
 		exit(err)
 	}
-	tarfile, _ = filepath.Abs(cached_download(NERD_URL))
-	root = fonts_dir()
-	if err := os.MkdirAll(root, 0o755); err != nil {
-		exit(err)
-	}
-	cmd = exec.Command("tar", "xf", tarfile, "SymbolsNerdFontMono-Regular.ttf")
-	cmd.Dir = root
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-	if err = cmd.Run(); err != nil {
-		exit(err)
-	}
-
 	fmt.Println(`Dependencies downloaded. Now build kitty with: ./dev.sh build`)
 }
 

bypy/init_env.py

@@ -89,7 +89,7 @@ def build_frozen_tools(kitty_exe):
 
 def sanitize_source_folder(path: str) -> None:
     for q in walk(path):
-        if os.path.splitext(q)[1] not in ('.py', '.glsl', '.ttf', '.otf', '.json'):
+        if os.path.splitext(q)[1] not in ('.py', '.glsl', '.ttf', '.otf'):
             os.unlink(q)
 
 

bypy/linux.conf

@@ -1,3 +1,3 @@
 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 libx11-xcb-dev libxcb-xkb-dev libfontconfig1-dev libdbus-1-dev libsystemd-dev'
+deps 'bison flex libxcursor-dev libxrandr-dev libxi-dev libxinerama-dev libgl1-mesa-dev libx11-xcb-dev libxcb-xkb-dev libfontconfig1-dev libdbus-1-dev'

bypy/linux/__main__.py

@@ -10,12 +10,16 @@ import subprocess
 import tarfile
 import time
 
-from bypy.constants import OUTPUT_DIR, PREFIX, python_major_minor_version
+from bypy.constants import OUTPUT_DIR, PREFIX, is64bit, python_major_minor_version
 from bypy.freeze import extract_extension_modules, freeze_python, path_to_freeze_dir
 from bypy.utils import get_dll_path, mkdtemp, py_compile, walk
 
 j = os.path.join
 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']
@@ -24,16 +28,16 @@ kitty_constants = iv['kitty_constants']
 
 def binary_includes():
     return tuple(map(get_dll_path, (
-            'expat', 'sqlite3', 'ffi', 'z', 'lzma', 'png16', 'lcms2', 'ssl', 'crypto', 'crypt',
-            'iconv', 'pcre2-8', 'graphite2', 'glib-2.0', 'freetype', 'xxhash',
-            'pixman-1', 'cairo', 'harfbuzz', 'xkbcommon', 'xkbcommon-x11',
+            'expat', 'sqlite3', 'ffi', 'z', 'lzma', 'png16', 'lcms2', 'crypt',
+            'iconv', 'pcre', 'graphite2', 'glib-2.0', 'freetype', 'xxhash',
+            'harfbuzz', 'xkbcommon', 'xkbcommon-x11',
             # fontconfig is not bundled because in typical brain dead Linux
             # distro fashion, different distros use different default config
             # paths for fontconfig.
             'ncursesw', 'readline', 'brotlicommon', 'brotlienc', 'brotlidec',
             'wayland-client', 'wayland-cursor',
         ))) + (
-                get_dll_path('bz2', 2),
+                get_dll_path('bz2', 2), get_dll_path('ssl', 2), get_dll_path('crypto', 2),
                 get_dll_path(f'python{py_ver}', 2),
         )
 
@@ -194,13 +198,12 @@ def strip_binaries(files):
 def create_tarfile(env, compression_level='9'):
     print('Creating archive...')
     base = OUTPUT_DIR
-    arch = 'arm64' if 'arm64' in os.environ['BYPY_ARCH'] else ('i686' if 'i386' in os.environ['BYPY_ARCH'] else 'x86_64')
     try:
         shutil.rmtree(base)
     except OSError as err:
-        if err.errno not in (errno.ENOENT, errno.EBUSY):  # EBUSY when the directory is mountpoint
+        if err.errno != errno.ENOENT:
             raise
-    os.makedirs(base, exist_ok=True)
+    os.mkdir(base)
     dist = os.path.join(base, f'{kitty_constants["appname"]}-{kitty_constants["version"]}-{arch}.tar')
     with tarfile.open(dist, mode='w', format=tarfile.PAX_FORMAT) as tf:
         cwd = os.getcwd()
@@ -213,8 +216,7 @@ def create_tarfile(env, compression_level='9'):
     print('Compressing archive...')
     ans = f'{dist.rpartition(".")[0]}.txz'
     start_time = time.time()
-    threads = 4 if arch == 'i686' else 0
-    subprocess.check_call(['xz', '--verbose', f'--threads={threads}', '-f', f'-{compression_level}', dist])
+    subprocess.check_call(['xz', '--verbose', '--threads=0', '-f', f'-{compression_level}', dist])
     secs = time.time() - start_time
     print('Compressed in {} minutes {} seconds'.format(secs // 60, secs % 60))
     os.rename(f'{dist}.xz', ans)

bypy/macos.conf

@@ -1,8 +1,8 @@
-# Requires installation of XCode >= 10.3 and go 1.26 and Python 3 and
-# python3 -m pip install certifi meson ninja
+# Requires installation of XCode 10.3 and go 1.19 and Python 3 and
+# python3 -m pip install certifi
 
 vm_name 'macos-kitty'
 root '/Users/Shared/kitty-build'
 python '/usr/local/bin/python3'
 universal 'true'
-deploy_target '12.0'
+deploy_target '10.14'

bypy/macos/__main__.py

@@ -95,8 +95,7 @@ def expand_dirs(items, exclude=lambda x: x.endswith('.so')):
     return items
 
 
-
-def do_sign(app_dir: str) -> None:
+def do_sign(app_dir):
     with current_dir(join(app_dir, 'Contents')):
         # Sign all .so files
         so_files = {x for x in files_in('.') if x.endswith('.so')}
@@ -110,10 +109,6 @@ def do_sign(app_dir: str) -> None:
         # Sign kitten
         with current_dir('MacOS'):
             codesign('kitten')
-        # Sign sub-apps
-        for x in os.listdir('.'):
-            if x.endswith('.app'):
-                codesign(x)
 
     # Now sign the main app
     codesign(app_dir)
@@ -135,7 +130,7 @@ def sign_app(app_dir, notarize):
     with make_certificate_useable():
         do_sign(app_dir)
         if notarize:
-            notarize_app(app_dir, 'kitty')
+            notarize_app(app_dir)
 
 
 class Freeze(object):
@@ -173,7 +168,6 @@ class Freeze(object):
         self.freeze_python()
         self.add_ca_certs()
         self.build_frozen_tools()
-        self.complete_sub_bundles()
         if not self.dont_strip:
             self.strip_files()
         if not self.skip_tests:
@@ -184,16 +178,6 @@ class Freeze(object):
 
         return ret
 
-    @flush
-    def complete_sub_bundles(self):
-        count = 0
-        for qapp in glob.glob(join(self.contents_dir, '*.app')):
-            for exe in glob.glob(join(self.contents_dir, 'MacOS', '*')):
-                os.symlink(f'../../../MacOS/{os.path.basename(exe)}', os.path.join(qapp, 'Contents', 'MacOS', os.path.basename(exe)))
-                count += 1
-        if count < 2:
-            raise SystemExit(f'Could not complete sub-bundles in {self.contents_dir}')
-
     @flush
     def add_ca_certs(self):
         print('\nDownloading CA certs...')
@@ -308,8 +292,8 @@ class Freeze(object):
                 'harfbuzz.0',
                 'png16.16',
                 'lcms2.2',
-                'crypto.3',
-                'ssl.3',
+                'crypto.1.1',
+                'ssl.1.1',
                 'xxhash.0',
         ):
             print('\nAdding', x)
@@ -387,9 +371,6 @@ class Freeze(object):
         os.rename(join(dirname(self.contents_dir), 'bin', 'kitty'), join(self.contents_dir, 'MacOS', 'kitty'))
         shutil.rmtree(join(dirname(self.contents_dir), 'bin'))
         self.fix_dependencies_in_lib(join(self.contents_dir, 'MacOS', 'kitty'))
-        for f in glob.glob(join(self.contents_dir, '*.app', 'Contents', 'MacOS', '*')):
-            if not os.path.islink(f):
-                self.fix_dependencies_in_lib(f)
         for f in walk(pdir):
             if f.endswith('.so') or f.endswith('.dylib'):
                 self.fix_dependencies_in_lib(f)
@@ -460,7 +441,7 @@ class Freeze(object):
         py_compile(join(self.resources_dir, 'Python'))
 
     @flush
-    def makedmg(self, d, volname, format='ULMO'):
+    def makedmg(self, d, volname, format='ULFO'):
         ''' Copy a directory d into a dmg named volname '''
         print('\nMaking dmg...')
         sys.stdout.flush()

bypy/rsync.conf

@@ -1 +1 @@
-to_vm_excludes '/dependencies /build /dist /kitty/launcher/kitty* /.build-cache /.cache /.mypy_cache /.ruff_cache /tags __pycache__ /*_commands.json *.so *.pyd *.pyc *_generated.go'
+to_vm_excludes '/dependencies /build /dist /kitty/launcher/kitty* /.build-cache /tags __pycache__ /*_commands.json *.so *.pyd *.pyc *_generated.go'

bypy/site.py

@@ -2,22 +2,23 @@
 # vim:fileencoding=utf-8
 # License: GPLv3 Copyright: 2021, Kovid Goyal <kovid at kovidgoyal.net>
 
-import _sitebuiltins
 import builtins
 import sys
 
+import _sitebuiltins
 
-def set_quit() -> None:
+
+def set_quit():
     eof = 'Ctrl-D (i.e. EOF)'
     builtins.quit = _sitebuiltins.Quitter('quit', eof)
     builtins.exit = _sitebuiltins.Quitter('exit', eof)
 
 
-def set_helper() -> None:
+def set_helper():
     builtins.help = _sitebuiltins._Helper()
 
 
-def main() -> None:
+def main():
     sys.argv[0] = sys.calibre_basename
     set_helper()
     set_quit()

bypy/sources.json

@@ -1,302 +1,282 @@
 [
     {
-        "name": "zlib 1.3.2",
+        "name": "zlib",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:d7a0654783a4da529d1bb793b7ad9c3318020af77667bcae35f95d0e42a792f3",
+            "filename": "zlib-1.2.13.tar.xz",
+            "hash": "sha256:d14c38e313afc35a9a8760dadf26042f51ea0f5d154b0630a31da0540107fb98",
             "urls": ["https://zlib.net/{filename}"]
         }
     },
 
     {
-        "name": "bzip2 1.0.8",
+        "name": "bzip2",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
+            "filename": "bzip2-1.0.8.tar.gz",
             "hash": "sha256:ab5a03176ee106d3f0fa90e381da478ddae405918153cca248e682cd0c4a2269",
-            "urls": ["https://www.sourceware.org/pub/{name}/{filename}"]
+            "urls": ["https://www.sourceware.org/pub/bzip2/bzip2-latest.tar.gz"]
         }
     },
 
     {
-        "name": "pkg-config 0.29.2",
-        "type": "build",
+        "name": "pkg-config",
         "os": "macos",
         "unix": {
-            "file_extension": "tar.gz",
+            "filename": "pkg-config-0.29.2.tar.gz",
             "hash": "sha256:6fc69c01688c9458a57eb9a1664c9aba372ccda420a02bf4429fe610e7e7d591",
             "urls": ["https://pkg-config.freedesktop.org/releases/{filename}"]
         }
     },
 
     {
-        "name": "openssl 3.5.6",
+        "name": "openssl",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:deae7c80cba99c4b4f940ecadb3c3338b13cb77418409238e57d7f31f2a3b736",
+            "filename": "openssl-1.1.1i.tar.gz",
+            "hash": "sha256:e8be6a35fe41d10603c3cc635e93289ed00bf34b79671a3a4de64fcee00d5242",
             "urls": ["https://www.openssl.org/source/{filename}"]
         }
     },
 
     {
-        "name": "cmake 3.29.3",
-        "type": "build",
+        "name": "cmake",
         "os": "macos",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:252aee1448d49caa04954fd5e27d189dd51570557313e7b281636716a238bccb",
-            "urls": ["https://cmake.org/files/v{version_except_last}/{filename}"]
+            "filename": "cmake-3.19.4.tar.gz",
+            "hash": "sha256:7d0232b9f1c57e8de81f38071ef8203e6820fe7eec8ae46a1df125d88dbcc2e1",
+            "urls": ["https://cmake.org/files/v3.19/{filename}"]
         }
     },
 
+
     {
-        "name": "expat 2.6.2",
+        "name": "expat",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:ee14b4c5d8908b1bec37ad937607eab183d4d9806a08adee472c3c3121d27364",
-            "urls": ["https://github.com/libexpat/libexpat/releases/download/R_{version_with_underscores}/{filename}"]
+            "filename": "expat-2.2.10.tar.bz2",
+            "hash": "sha256:b2c160f1b60e92da69de8e12333096aeb0c3bf692d41c60794de278af72135a5",
+            "urls": ["https://github.com/libexpat/libexpat/releases/download/R_2_2_10/{filename}"]
         }
     },
 
     {
-        "name": "libxml2 2.15.3",
+        "name": "libxml2",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:78262a6e7ac170d6528ebfe2efccdf220191a5af6a6cd61ea4a9a9a5042c7a07",
-            "urls": ["https://download.gnome.org/sources/libxml2/{version_except_last}/{filename}"]
+            "filename": "libxml2-2.9.12.tar.gz",
+            "hash": "sha256:c8d6681e38c56f172892c85ddc0852e1fd4b53b4209e7f4ebf17f7e2eae71d92",
+            "urls": ["ftp://xmlsoft.org/libxml2/{filename}"]
         }
     },
 
     {
-        "name": "xkbcommon 1.7.0",
+        "name": "xkbcommon",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:65782f0a10a4b455af9c6baab7040e2f537520caa2ec2092805cdfd36863b247",
-            "urls": ["https://xkbcommon.org/download/lib{filename}"]
+            "filename": "libxkbcommon-1.0.3.tar.xz",
+            "hash": "sha256:a2202f851e072b84e64a395212cbd976ee18a8ee602008b0bad02a13247dbc52",
+            "urls": ["https://xkbcommon.org/download/{filename}"]
         }
     },
 
     {
-        "name": "sqlite 3.53.0",
+        "name": "sqlite",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:851e9b38192fe2ceaa65e0baa665e7fa06230c3d9bd1a6a9662d02380d73365a",
-            "urls": ["https://www.sqlite.org/2026/{name}-autoconf-3530000.{file_extension}"]
+            "filename": "sqlite-autoconf-3340100.tar.gz",
+            "hash": "sha256:2a3bca581117b3b88e5361d0ef3803ba6d8da604b1c1a47d902ef785c1b53e89",
+            "urls": ["https://www.sqlite.org/2021/{filename}"]
         }
     },
 
+
     {
-        "name": "libffi 3.4.6",
+        "name": "libffi",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:b0dea9df23c863a7a50e825440f3ebffabd65df1497108e5d437747843895a4e",
-            "urls": ["https://github.com/libffi/libffi/releases/download/v{version}/{filename}"]
+            "filename": "libffi-3.3.0.tar.gz",
+            "hash": "sha256:72fba7922703ddfa7a028d513ac15a85c8d54c8d67f55fa5a4802885dc652056",
+            "urls": ["https://github.com/libffi/libffi/releases/download/v3.3/libffi-3.3.tar.gz"]
         }
     },
 
     {
-        "name": "ncurses 6.5",
+        "name": "ncurses",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:136d91bc269a9a5785e5f9e980bc76ab57428f604ce3e5a5a90cebc767971cc6",
-            "urls": ["https://ftp.gnu.org/gnu/ncurses/{filename}"]
+            "filename": "ncurses-6.2.tar.gz",
+            "hash": "sha256:30306e0c76e0f9f1f0de987cf1c82a5c21e1ce6568b9227f7da5b71cbea86c9d",
+            "urls": ["https://invisible-mirror.net/archives/ncurses/{filename}"]
         }
     },
 
     {
-        "name": "readline 8.2",
+        "name": "readline",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:3feb7171f16a84ee82ca18a36d7b9be109a52c04f492a053331d7d1095007c35",
+            "filename": "readline-8.1.tar.gz",
+            "hash": "sha256:f8ceb4ee131e3232226a17f51b164afc46cd0b9e6cef344be87c65962cb82b02",
             "urls": ["https://ftp.gnu.org/gnu/readline/{filename}"]
         }
     },
 
     {
-        "name": "xz 5.8.3",
+        "name": "xz",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:3d3a1b973af218114f4f889bbaa2f4c037deaae0c8e815eec381c3d546b974a0",
+            "filename": "xz-5.2.5.tar.gz",
+            "hash": "sha256:f6f4910fd033078738bd82bfba4f49219d03b17eb0794eb91efbae419f4aba10",
             "urls": ["https://tukaani.org/xz/{filename}"]
         }
     },
 
     {
-        "name": "libxxhash 0.8.2",
+        "name": "libxxhash",
         "unix": {
-            "file_extension": "tar.gz",
+            "filename": "xxHash-0.8.2.tar.gz",
             "hash": "sha256:baee0c6afd4f03165de7a4e67988d16f0f2b257b51d0e3cb91909302a26a79c4",
-            "urls": ["https://github.com/Cyan4973/xxHash/archive/refs/tags/v{version}.{file_extension}"]
+            "urls": ["https://github.com/Cyan4973/xxHash/archive/refs/tags/v0.8.2.tar.gz"]
         }
     },
 
     {
-        "name": "xcrypt 4.4.36",
+        "name": "xcrypt",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:b979838d5f1f238869d467484793b72b8bca64c4eae696fdbba0a9e0b6c28453",
-            "urls": ["https://github.com/besser82/libxcrypt/archive/v{version}.{file_extension}"]
+            "filename": "xcrypt-4.4.17.tar.gz",
+            "hash": "sha256:7665168d0409574a03f7b484682e68334764c29c21ca5df438955a381384ca07",
+            "urls": ["https://github.com/besser82/libxcrypt/archive/v4.4.17.tar.gz"]
         }
     },
 
     {
-        "name": "python 3.14.5",
+        "name": "python",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:7e32597b99e5d9a39abed35de4693fa169df3e5850d4c334337ffd6a19a36db6",
-            "urls": ["https://www.python.org/ftp/python/{version}/Python-{version}.{file_extension}"]
+            "filename": "Python-3.11.6.tar.xz",
+            "hash": "sha256:0fab78fa7f133f4f38210c6260d90d7c0d5c7198446419ce057ec7ac2e6f5f38",
+            "urls": ["https://www.python.org/ftp/python/3.11.6/{filename}"]
         }
     },
 
     {
-        "name": "libpng 1.6.57",
+        "name": "libpng",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:d10c20d7171569804cae8dfc13ba6dcd0662c41ed39d43d4d429314aafb10a80",
+            "filename": "libpng-1.6.37.tar.xz",
+            "hash": "sha256:505e70834d35383537b6491e7ae8641f1a4bed1876dbfe361201fc80868d88ca",
             "urls": ["https://downloads.sourceforge.net/sourceforge/libpng/{filename}"]
         }
     },
 
     {
-        "name": "lcms2 2.17",
+        "name": "lcms2",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:d11af569e42a1baa1650d20ad61d12e41af4fead4aa7964a01f93b08b53ab074",
-            "urls": ["https://github.com/mm2/Little-CMS/releases/download/lcms{version}/lcms2-{version}.{file_extension}"]
+            "filename": "lcms2-2.12.tar.gz",
+            "hash": "sha256:e501f1482fc424550ef3abbf86bf1c66090e1661249e89552d39ed5bf935df66",
+            "urls": ["https://github.com/mm2/Little-CMS/archive/2.12/{filename}"]
         }
     },
 
     {
-        "name": "graphite 1.3.14",
+        "name": "graphite",
         "os": "linux",
         "unix": {
-            "file_extension": "tgz",
+            "filename": "graphite2-1.3.14.tgz",
             "hash": "sha256:f99d1c13aa5fa296898a181dff9b82fb25f6cc0933dbaa7a475d8109bd54209d",
-            "urls": ["https://downloads.sourceforge.net/silgraphite/graphite2-{version}.{file_extension}"]
+            "urls": ["https://downloads.sourceforge.net/silgraphite/{filename}"]
         }
     },
 
     {
-        "name": "pcre 10.43",
+        "name": "pcre",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.bz2",
-            "hash": "sha256:e2a53984ff0b07dfdb5ae4486bbb9b21cca8e7df2434096cc9bf1b728c350bcb",
-            "urls": ["https://github.com/PCRE2Project/pcre2/releases/download/pcre2-10.43/pcre2-{version}.{file_extension}"]
+            "filename": "pcre-8.44.tar.bz2",
+            "hash": "sha256:19108658b23b3ec5058edc9f66ac545ea19f9537234be1ec62b714c84399366d",
+            "urls": ["https://ftp.pcre.org/pub/pcre/{filename}"]
         }
     },
 
     {
-        "name": "iconv 1.17",
+        "name": "iconv",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:8f74213b56238c85a50a5329f77e06198771e70dd9a739779f4c02f65d971313",
-            "urls": ["https://ftp.gnu.org/pub/gnu/libiconv/libiconv-{version}.{file_extension}"]
+            "filename": "libiconv-1.16.tar.gz",
+            "hash": "sha256:e6a1b1b589654277ee790cce3734f07876ac4ccfaecbee8afa0b649cf529cc04",
+            "urls": ["https://ftp.gnu.org/pub/gnu/libiconv/{filename}"]
         }
     },
 
     {
-        "name": "glib 2.86.3",
+        "name": "glib",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:b3211d8d34b9df5dca05787ef0ad5d7ca75dec998b970e1aab0001d229977c65",
-            "urls": ["https://download.gnome.org/sources/glib/{version_except_last}/{filename}"]
+            "filename": "glib-2.66.6.tar.xz",
+            "hash": "sha256:80fff9c63d2725834328071c42003c311f77f91caf2285195c587c62f5638329",
+            "urls": ["https://ftp.gnome.org/pub/GNOME/sources/glib/2.66/{filename}"]
         }
     },
 
     {
-        "name": "libbrotli 1.1.0",
+        "name": "brotli",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.gz",
-            "hash": "sha256:e720a6ca29428b803f4ad165371771f5398faba397edf6778837a18599ea13ff",
-            "urls": ["https://github.com/google/brotli/archive/v{version}/{filename}"]
+            "filename": "brotli-1.0.9.tar.gz",
+            "hash": "sha256:f9e8d81d0405ba66d181529af42a3354f838c939095ff99930da6aa9cdf6fe46",
+            "urls": ["https://github.com/google/brotli/archive/v1.0.9/{filename}"]
         }
     },
 
     {
-        "name": "pixman 0.44.2",
+        "name": "freetype",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:50baf820dde0c5ff9714d03d2df4970f606a3d3b1024f5404c0398a9821cc4b0",
-            "urls": ["https://www.cairographics.org/releases/{filename}"]
-        }
-    },
-
-    {
-        "name": "freetype 2.13.2",
-        "os": "linux",
-        "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:12991c4e55c506dd7f9b765933e62fd2be2e06d421505d7950a132e4f1bb484d",
+            "filename": "freetype-2.10.4.tar.xz",
+            "hash": "sha256:86a854d8905b19698bbc8f23b860bc104246ce4854dcea8e3b0fb21284f75784",
             "urls": ["https://download.savannah.gnu.org/releases/freetype/{filename}"]
         }
     },
 
     {
-        "name": "fontconfig 2.17.1",
+        "name": "fontconfig",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:9f5cae93f4fffc1fbc05ae99cdfc708cd60dfd6612ffc0512827025c026fa541",
-            "urls": ["https://gitlab.freedesktop.org/api/v4/projects/890/packages/generic/fontconfig/{version}/{filename}"]
+            "filename": "fontconfig-2.13.1.tar.bz2",
+            "hash": "sha256:f655dd2a986d7aa97e052261b36aa67b0a64989496361eca8d604e6414006741",
+            "urls": ["https://www.fontconfig.org/release/{filename}"]
         }
     },
 
     {
-        "name": "cairo 1.18.2",
-        "os": "linux",
+        "name": "harfbuzz",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:a62b9bb42425e844cc3d6ddde043ff39dbabedd1542eba57a2eb79f85889d45a",
-            "urls": ["https://www.cairographics.org/releases/{filename}"]
+            "filename": "harfbuzz-8.2.2.tar.xz",
+            "hash": "sha256:e433ad85fbdf57f680be29479b3f964577379aaf319f557eb76569f0ecbc90f3",
+            "urls": ["https://github.com/harfbuzz/harfbuzz/releases/download/8.2.2/{filename}"]
         }
     },
 
     {
-        "name": "harfbuzz 12.3.0",
+        "name": "simde",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:8660ebd3c27d9407fc8433b5d172bafba5f0317cb0bb4339f28e5370c93d42b7",
-            "urls": ["https://github.com/harfbuzz/harfbuzz/releases/download/{version}/{filename}"]
-        }
-    },
-
-    {
-        "name": "simde 0.7.6",
-        "comment": "Cannot update till gcc in the build VM is updated as simde 0.8 requires newer gcc",
-        "unix": {
-            "file_extension": "tar.xz",
+            "filename": "simde-amalgamated-0.7.6.tar.xz",
             "hash": "sha256:703eac1f2af7de1f7e4aea2286130b98e1addcc0559426e78304c92e2b4eb5e1",
-            "urls": ["https://github.com/simd-everywhere/simde/releases/download/v{version}/simde-amalgamated-{version}.{file_extension}"]
+            "urls": ["https://github.com/simd-everywhere/simde/releases/download/v0.7.6/{filename}"]
         }
     },
 
     {
-        "name": "wayland 1.24.0",
+        "name": "wayland",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:82892487a01ad67b334eca83b54317a7c86a03a89cfadacfef5211f11a5d0536",
-            "urls": ["https://gitlab.freedesktop.org/wayland/wayland/-/releases/{version}/downloads/{filename}"]
+            "filename": "wayland-1.22.0.tar.xz",
+            "hash": "sha256:1540af1ea698a471c2d8e9d288332c7e0fd360c8f1d12936ebb7e7cbc2425842",
+            "urls": ["https://gitlab.freedesktop.org/wayland/wayland/-/releases/1.22.0/downloads/{filename}"]
         }
     },
 
     {
-        "name": "wayland-protocols 1.45",
+        "name": "wayland-protocols",
         "os": "linux",
         "unix": {
-            "file_extension": "tar.xz",
-            "hash": "sha256:4d2b2a9e3e099d017dc8107bf1c334d27bb87d9e4aff19a0c8d856d17cd41ef0",
-            "urls": ["https://gitlab.freedesktop.org/wayland/wayland-protocols/-/releases/{version}/downloads/{filename}"]
+            "filename": "wayland-protocols-1.32.tar.xz",
+            "hash": "sha256:7459799d340c8296b695ef857c07ddef24c5a09b09ab6a74f7b92640d2b1ba11",
+            "urls": ["https://gitlab.freedesktop.org/wayland/wayland-protocols/-/releases/1.32/downloads/{filename}"]
         }
     }
+
 ]

count-lines-of-code

@@ -13,6 +13,6 @@ for attr in ('linguist-generated', 'linguist-vendored'):
             fname = line.split(':', 1)[0]
             all_files.discard(fname)
 
-all_files -= {'gen/rowcolumn-diacritics.txt'}
+all_files -= {'gen/nerd-fonts-glyphs.txt', 'gen/rowcolumn-diacritics.txt'}
 cp = subprocess.run(['cloc', '--list-file', '-'], input='\n'.join(all_files).encode())
 raise SystemExit(cp.returncode)

docs/actions.rst

@@ -8,7 +8,4 @@ using the ``map`` and ``mouse_map`` directives in :file:`kitty.conf`. For
 configuration examples, see the default shortcut links for each action.
 To read about keyboard mapping in more detail, see :doc:`mapping`.
 
-You can also browse and trigger these actions by pressing :sc:`command_palette`
-to run the :doc:`/kittens/command-palette`.
-
 .. include:: /generated/actions.rst

docs/basic.rst

@@ -25,7 +25,6 @@ Previous shell prompt       :sc:`scroll_to_previous_prompt` (see :ref:`shell_int
 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`)
-Search scrollback in less   :sc:`search_scrollback` (also :kbd:`⌘+F` on macOS)
 =========================   =======================
 
 The scroll actions only take effect when the terminal is in the main screen.
@@ -117,9 +116,6 @@ Similarly, you can detach the current tab, with::
     # asks which OS Window to move the tab into
     map ctrl+f4 detach_tab ask
 
-Note that tabs can be re-arranged, detached and moved to another OS Window in
-the same kitty instance using drag and drop.
-
 Finally, you can define a shortcut to close all windows in a tab other than the
 currently active window::
 

docs/binary.rst

@@ -23,9 +23,7 @@ simply re-run the command.
    **Do not** copy the kitty binary out of the installation folder. If you want
    to add it to your :envvar:`PATH`, create a symlink in :file:`~/.local/bin` or
    :file:`/usr/bin` or wherever. You should create a symlink for the :file:`kitten`
-   binary as well. Whichever folder you choose to create the symlink in should
-   be in the **systemwide** PATH, a folder added to the PATH in your shell rc
-   files will not work when running kitty from your desktop environment.
+   binary as well.
 
 
 Manually installing
@@ -56,16 +54,14 @@ particular desktop, but it should work for most major desktop environments.
     cp ~/.local/kitty.app/share/applications/kitty.desktop ~/.local/share/applications/
     # If you want to open text files and images in kitty via your file manager also add the kitty-open.desktop file
     cp ~/.local/kitty.app/share/applications/kitty-open.desktop ~/.local/share/applications/
-    # Update the paths to the kitty and its icon in the kitty desktop file(s)
-    sed -i "s|Icon=kitty|Icon=$(readlink -f ~)/.local/kitty.app/share/icons/hicolor/256x256/apps/kitty.png|g" ~/.local/share/applications/kitty*.desktop
-    sed -i "s|Exec=kitty|Exec=$(readlink -f ~)/.local/kitty.app/bin/kitty|g" ~/.local/share/applications/kitty*.desktop
-    # Make xdg-terminal-exec (and hence desktop environments that support it use kitty)
-    echo 'kitty.desktop' > ~/.config/xdg-terminals.list
+    # Update the paths to the kitty and its icon in the kitty.desktop file(s)
+    sed -i "s|Icon=kitty|Icon=/home/$USER/.local/kitty.app/share/icons/hicolor/256x256/apps/kitty.png|g" ~/.local/share/applications/kitty*.desktop
+    sed -i "s|Exec=kitty|Exec=/home/$USER/.local/kitty.app/bin/kitty|g" ~/.local/share/applications/kitty*.desktop
 
 .. note::
     In :file:`kitty-open.desktop`, kitty is registered to handle some supported
     MIME types. This will cause kitty to take precedence on some systems where
-    the default apps are not explicitly set. For example, if you expect to use
+    the default apps are not explicitly set. For example, you expect to use
     other GUI file managers to open dir paths when using commands such as
     :program:`xdg-open`, you should configure the default opener for the MIME
     type ``inode/directory``::
@@ -101,12 +97,12 @@ Customizing the installation
      _kitty_install_cmd \
          installer=nightly dest=/some/other/location
 
-* You can specify a specific version to install, with:
+* You can specify a different install location, with ``dest``:
 
   .. code-block:: sh
 
      _kitty_install_cmd \
-         installer=version-0.35.2
+         dest=/some/other/location
 
 * You can tell the installer not to launch |kitty| after installing it with
   ``launch=n``:

docs/build.rst

@@ -13,8 +13,7 @@ Build from source
 
 |kitty| is designed to run from source, for easy hack-ability. All you need to
 get started is a C compiler and the `go compiler
-<https://go.dev/doc/install>`__ (on Linux, the :ref:`X11 development libraries <x11-dev-libs>` as well).
-After installing those, run the following commands::
+<https://go.dev/doc/install>`__. After installing those, run the following commands::
 
     git clone https://github.com/kovidgoyal/kitty.git && cd kitty
     ./dev.sh build
@@ -24,8 +23,7 @@ That's it, kitty will be built from source, magically. You can run it as
 
 This works, because the :code:`./dev.sh build` command downloads all the major
 dependencies of kitty as pre-built binaries for your platform and builds kitty
-to use these rather than system libraries. The few required system libraries
-are X11 and DBUS on Linux.
+to use these rather than system libraries.
 
 If you make changes to kitty code, simply re-run :code:`./dev.sh build`
 to build kitty with your changes.
@@ -82,19 +80,16 @@ These dependencies are needed when building against system libraries only.
 
 Run-time dependencies:
 
-* ``python``
+* ``python`` >= 3.8
 * ``harfbuzz`` >= 2.2.0
 * ``zlib``
 * ``libpng``
 * ``liblcms2``
 * ``libxxhash``
 * ``openssl``
-* ``pixman`` (not needed on macOS)
-* ``cairo`` (not needed on macOS)
 * ``freetype`` (not needed on macOS)
 * ``fontconfig`` (not needed on macOS)
 * ``libcanberra`` (not needed on macOS)
-* ``libsystemd`` (optional, not needed on non systemd systems)
 * ``ImageMagick`` (optional, needed to display uncommon image formats in the terminal)
 
 
@@ -104,23 +99,10 @@ Build-time dependencies:
 * ``simde``
 * ``go`` >= _build_go_version (see :file:`go.mod` for go packages used during building)
 * ``pkg-config``
-* Symbols NERD Font Mono either installed system-wide or placed in :file:`fonts/SymbolsNerdFontMono-Regular.ttf`
 * 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:
 
-  - ``liblcms2-dev``
-  - ``libfontconfig-dev``
-  - ``libssl-dev``
-  - ``libpython3-dev``
-  - ``libxxhash-dev``
-  - ``libsimde-dev``
-  - ``libcairo2-dev``
-
-  .. _x11-dev-libs:
-
-  Also, the X11 development libraries:
-
   - ``libdbus-1-dev``
   - ``libxcursor-dev``
   - ``libxrandr-dev``
@@ -130,7 +112,11 @@ Build-time dependencies:
   - ``libxkbcommon-x11-dev``
   - ``libfontconfig-dev``
   - ``libx11-xcb-dev``
-
+  - ``liblcms2-dev``
+  - ``libssl-dev``
+  - ``libpython3-dev``
+  - ``libxxhash-dev``
+  - ``libsmide-dev``
 
 
 Build and run from source with Nix

docs/clipboard.rst

@@ -15,7 +15,7 @@ of the escape code is::
     <OSC>5522;metadata;payload<ST>
 
 Here, *metadata* is a colon separated list of key-value pairs and payload is
-base64 encoded data. :code:`OSC` is :code:`<ESC>]`.
+base64 encoded data. :code:`OSC` is :code:`<ESC>[`.
 :code:`ST` is the string terminator, :code:`<ESC>\\`.
 
 Reading data from the system clipboard
@@ -29,11 +29,11 @@ For example, to read plain text and PNG data, the payload would be::
 
     text/plain image/png
 
-encoded as :rfc:`base64 <4648>`. To read from the primary selection instead of the
+encoded as base64. To read from the primary selection instead of the
 clipboard, add the key ``loc=primary`` to the metadata section.
 
 To get the list of MIME types available on the clipboard the payload must be
-just a period (``.``), encoded as :rfc:`base64 <4648>`.
+just a period (``.``), encoded as base64.
 
 The terminal emulator will reply with a sequence of escape codes of the form::
 
@@ -47,12 +47,10 @@ The terminal emulator will reply with a sequence of escape codes of the form::
 
 Here, the ``status=DATA`` packets deliver the data (as base64 encoded bytes)
 associated with each MIME type. The terminal emulator should chunk up the data
-for an individual type, into chunks of size **no more** than 4096 bytes (4096
-is the size of a chunk *before* base64 encoding). All
+for an individual type. A recommended size for each chunk is 4096 bytes. All
 the chunks for a given type must be transmitted sequentially and only once they
 are done the chunks for the next type, if any, should be sent. The end of data
-is indicated by a ``status=DONE`` packet. base64 padding bytes are required at
-the end of every base64 encoded chunk when padding is needed.
+is indicated by a ``status=DONE`` packet.
 
 If an error occurs, instead of the opening ``status=OK`` packet the terminal
 must send a ``status=ERRORCODE`` packet. The error code must be one of:
@@ -92,8 +90,7 @@ following sequence of packets::
 
 The final packet with no mime and no data indicates end of transmission. The
 data for every MIME type should be split into chunks of no more than 4096
-bytes (4096 is the size of the data before base64 encoding).
-All the chunks for a given MIME type must be sent sequentially, before
+bytes. All the chunks for a given MIME type must be sent sequentially, before
 sending chunks for the next MIME type. After the transmission is complete, the
 terminal replies with a single packet indicating success::
 
@@ -139,72 +136,6 @@ the data, but create multiple references to it in the system clipboard. Alias
 packets can be sent anytime after the initial write packet and before the end
 of data packet.
 
-.. _clipboard_repeated_permission:
-
-Avoiding repeated permission prompts
---------------------------------------
-
-.. versionadded:: 0.42.2
-     using a password to avoid repeated confirmations
-
-If a program like an editor wants to make use of the system clipboard, by
-default, the user is prompted on every read request. This can become quite
-fatiguing. To avoid this situation, this protocol allows sending a password
-and human friendly name with ``type=write`` and ``type=read`` requests. The
-terminal can then ask the user to allow all future requests using that
-password. If the user agrees, future requests on the same tty will be
-automatically allowed by the terminal. The editor or other program using
-this facility should ideally use a password randomly generated at startup,
-such as a UUID4. However, terminals may implement permanent/stored passwords.
-Users can then configure terminal programs they trust to use these password.
-
-The password and the human name are encoded using the ``pw`` and ``name`` keys
-in the metadata. The values are UTF-8 strings that are base64 encoded.
-Specifying a password without a human friendly name is equivalent to not
-specifying a password and the terminal must treat the request as though
-it had no password.
-
-Allowing terminal applications to respond to paste events
---------------------------------------------------------------
-
-.. versionadded:: 0.44.1
-     paste events via the 5522 mode
-
-If a TUI application wants to handle paste events (like the user pressing the
-paste key shortcut used by the terminal or selecting paste from a terminal UI menu)
-it can enable the *paste events* private mode (5522), as described in this `ancillary
-specification <https://rockorager.dev/misc/bracketed-paste-mime/>`__. When that
-mode is set, the terminal will send the application a list of MIME types on the
-clipboard every time the user triggers a paste action. The application is then
-free to request whatever MIME data it wants from the list of types.
-
-The mode can be enabled using the standard DECSET or DECRST control sequences.
-``CSI ? 5522 h`` to enable the mode. ``CSI ? 5522 l`` to disable the mode.
-
-The terminal *should* send a one time password with the list of mime
-types, as the ``pw`` key (base64 encoded). The application can then use this
-password to request data from the clipboard without needing a permission
-prompt. The human name *should* be set to ``Paste event`` (base64 encoded) when
-the application uses this one time password.
-
-Detecting support for this protocol
------------------------------------------
-
-Applications can detect if a terminal supports this protocol with a standard
-DECRQM query:
-
-.. code::
-
-    CSI ? 5522 $ p
-
-To which the terminal will respond with a DECRPM response:
-
-.. code::
-
-    CSI ? 5522 ; Ps $ y
-
-A Ps value of 0 or 4 means the mode is not supported.
-
 
 Support for terminal multiplexers
 ------------------------------------
@@ -219,15 +150,11 @@ other characters must be stripped out from the id by the terminal emulator
 before retransmitting it.
 
 Note that when using a terminal multiplexer it is possible for two different
-programs to overwrite each other's clipboard requests. This is fundamentally
+programs to overwrite each others clipboard requests. This is fundamentally
 unavoidable since the system clipboard is a single global shared resource.
-However, there is an additional complication where responses from this protocol
+However, there is an additional complication where responses form this protocol
 could get lost if, for instance, multiple write requests are received
 simultaneously. It is up to well designed multiplexers to ensure that only a
 single request is in flight at a time. The multiplexer can abort requests by
 sending back the ``EBUSY`` error code indicating some other window is trying
 to access the clipboard.
-
-When the terminal sends an unsolicited paste event because the user triggered
-a paste and the 5522 mode is enabled, there will be no associated id. In this
-case, the multiplexer must forward the event to the currently active window.

docs/color-stack.rst

@@ -1,8 +1,5 @@
-Color control
-====================
-
 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
@@ -27,157 +24,3 @@ foreground, selection background, selection foreground and cursor color and the
    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.
-
-.. _color_control:
-
-Setting and querying colors
--------------------------------
-
-While there exists a legacy protocol developed by XTerm for querying and
-setting colors, as with most XTerm protocols it suffers from the usual design
-limitations of being under specified and in-sufficient. XTerm implements
-querying of colors using OSC 4,5,6,10-19,104,105,106,110-119. This absurd
-profusion of numbers is completely unnecessary, redundant and requires adding
-two new numbers for every new color. Also XTerm's protocol doesn't handle the
-case of colors that are unknown to the terminal or that are not a set value,
-for example, many terminals implement selection as a reverse video effect not a
-fixed color. The XTerm protocol has no way to query for this condition. The
-protocol also doesn't actually specify the format in which colors are reported,
-deferring to a man page for X11!
-
-Instead kitty has developed a single number based protocol that addresses all
-these shortcomings and is future proof by virtue of using string keys rather
-than numbers. The syntax of the escape code is::
-
-    <OSC> 21 ; key=value ; key=value ; ... <ST>
-
-The spaces in the above definition are for reading clarity and should be ignored.
-Here, ``<OSC>`` is the two bytes ``0x1b (ESC)`` and ``0x5d (])``. ``<ST>`` is
-either ``0x07 (BEL)`` or the two bytes ``0x1b (ESC)`` and ``0x5c (\\)``.
-
-``key`` is a number from 0-255 to query or set the color values from the
-terminals ANSI color table, or one of the strings in the table below for
-special colors:
-
-================================= =============================================== ===============================
-key                               meaning                                         dynamic
-================================= =============================================== ===============================
-foreground                        The default foreground text color               Not applicable
-background                        The default background text color               Not applicable
-selection_background              The background color of selections              Reverse video
-selection_foreground              The foreground color of selections              Reverse video
-cursor                            The color of the text cursor                    Foreground color
-cursor_text                       The color of text under the cursor              Background color
-visual_bell                       The color of a visual bell                      Automatic color selection based on current screen colors
-transparent_background_color1..7  A background color that is rendered             Unset
-                                  with the specified opacity in cells that have
-                                  the specified background color. An opacity
-                                  value less than zero means, use the
-                                  :opt:`background_opacity` value.
-================================= =============================================== ===============================
-
-In this table the third column shows what effect setting the color to *dynamic*
-has in kitty and many other terminal emulators. It is advisory only, terminal
-emulators may not support dynamic colors for these or they may have other
-effects. Setting the ANSI color table colors to dynamic is not allowed.
-
-Querying current color values
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To query colors values, the client program sends this escape code with the
-``value`` field set to ``?`` (the byte ``0x3f``). The terminal then responds
-with the same escape code, but with the ``?`` replaced by the :ref:`encoded
-color value <color_control_color_encoding>`. If the queried color is one that
-does not have a defined value, for example, if the terminal is using a reverse
-video effect or a gradient or similar, then the value must be empty, that is
-the response contains only the key and ``=``, no value. For example, if the
-client sends::
-
-    <OSC> 21 ; foreground=? ; cursor=? <ST>
-
-The terminal responds::
-
-    <OSC> 21 ; foreground=rgb:ff/00/00 ; cursor= <ST>
-
-This indicates that the foreground color is red and the cursor color is
-undefined (typically the cursor takes the color of the text under it and the
-text takes the color of the background).
-
-If the terminal does not know a field that a client sends to it for a query it
-must respond back with the ``field=?``, that is, it must send back a question
-mark as the value.
-
-
-Setting color values
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To set a color value, the client program sends this escape code with the
-``value`` field set to either an :ref:`encoded color value
-<color_control_color_encoding>` or the empty value. The empty value means
-the terminal should use a dynamic color for example reverse video for
-selections or similar. To reset a color to its default value (i.e. the value it
-would have if it was never set) the client program should send just the key
-name with no ``=`` and no value. For example::
-
-    <OSC> 21 ; foreground=green ; cursor= ; background <ST>
-
-This sets the foreground to the color green, sets the cursor color to dynamic
-(usually meaning the cursor takes the color of the text under it) and resets
-the background color to its default value.
-
-To check if setting succeeded, the client can simply query the color, in fact
-the two can be combined into a single escape code, for example::
-
-    <OSC> 21 ; foreground=white ; foreground=? <ST>
-
-The terminal will change the foreground color and reply with the new foreground
-color.
-
-
-.. _color_control_color_encoding:
-
-Color value encoding
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The color encoding is inherited from the scheme used by XTerm, for
-compatibility, but a sane, rigorously specified subset is chosen.
-
-RGB colors are encoded in one of three forms:
-
-``rgb:<red>/<green>/<blue>``
-    | <red>, <green>, <blue> := h | hh | hhh | hhhh
-    | h := single hexadecimal digits (case insignificant)
-    | Note that h indicates the value scaled in 4 bits, hh the value scaled in 8 bits,
-      hhh the value scaled in 12 bits, and hhhh the value scaled in 16 bits, respectively.
-
-``#<h...>``
-    | h := single hexadecimal digits (case insignificant)
-    | #RGB            (4 bits each)
-    | #RRGGBB         (8 bits each)
-    | #RRRGGGBBB      (12 bits each)
-    | #RRRRGGGGBBBB   (16 bits each)
-    | The R, G, and B represent single hexadecimal digits.  When fewer than 16 bits
-      each are specified, they represent the most significant bits of the value
-      (unlike the “rgb:” syntax, in which values are scaled). For example,
-      the string ``#3a7`` is the same as ``#3000a0007000``.
-
-``rgbi:<red>/<green>/<blue>``
-    red, green, and blue are floating-point values between 0.0 and 1.0, inclusive. The input format for these values is an optional
-    sign, a string of numbers possibly containing a decimal point, and an optional exponent field containing an E or e followed by a possibly
-    signed integer string. Values outside the ``0 - 1`` range must be clipped to be within the range.
-
-If a color should have an alpha component, it must be suffixed to the color
-specification in the form :code:`@number between zero and one`. For example::
-
-    red@0.5 rgb:ff0000@0.1 #ff0000@0.3
-
-The syntax for the floating point alpha component is the same as used for the
-components of ``rgbi`` defined above. When not specified, the default alpha
-value is ``1.0``. Values outside the range ``0 - 1`` must be clipped
-to be within the range, negative values may have special context dependent
-meaning.
-
-In addition, the following color names are accepted (case-insensitively) corresponding to the
-specified RGB values.
-
-.. include:: generated/color-names.rst

docs/conf.py

@@ -18,9 +18,8 @@ from typing import Any, Callable, Dict, Iterable, Iterator, List, Tuple
 
 from docutils import nodes
 from docutils.parsers.rst.roles import set_classes
-from pygments.lexer import RegexLexer
-from pygments.lexer import bygroups as untyped_bygroups
-from pygments.token import Comment, Error, Keyword, Literal, Name, Number, String, Whitespace
+from pygments.lexer import RegexLexer, bygroups  # type: ignore
+from pygments.token import Comment, Error, Keyword, Literal, Name, Number, String, Whitespace  # type: ignore
 from sphinx import addnodes, version_info
 from sphinx.util.logging import getLogger
 
@@ -30,7 +29,7 @@ if kitty_src not in sys.path:
 
 from kitty.conf.types import Definition, expand_opt_references  # noqa
 from kitty.constants import str_version, website_url # noqa
-from kitty.fast_data_types import DND_CODE, Shlex, TEXT_SIZE_CODE # noqa
+from kitty.fast_data_types import Shlex  # noqa
 
 # config {{{
 # -- Project information -----------------------------------------------------
@@ -63,7 +62,7 @@ extensions = [
     'sphinx.ext.extlinks',
     'sphinx_copybutton',
     'sphinx_inline_tabs',
-    'sphinxext.opengraph',
+    "sphinxext.opengraph",
 ]
 
 # URL for OpenGraph tags
@@ -120,8 +119,6 @@ def go_version(go_mod_path: str) -> str:  # {{{
 string_replacements = {
     '_kitty_install_cmd': 'curl -L https://sw.kovidgoyal.net/kitty/installer.sh | sh /dev/stdin',
     '_build_go_version': go_version('../go.mod'),
-    '_text_size_code': str(TEXT_SIZE_CODE),
-    '_dnd_code': str(DND_CODE),
 }
 
 
@@ -239,13 +236,6 @@ def write_cli_docs(all_kitten_names: Iterable[str]) -> None:
             usage='file-or-dir-to-copy ...', message=copy_message
         ))
     del sys.modules['kittens.ssh.main']
-    from kitty.session import save_as_session_message, save_as_session_options
-    with open('generated/save-as-session.rst', 'w') as f:
-        f.write(option_spec_as_rst(
-            appname='save_as_session', ospec=save_as_session_options, heading_char='^',
-            usage='[path-to-save-session-file-at]',
-            message=save_as_session_message,
-        ))
 
     from kitty.launch import options_spec as launch_options_spec
     with open('generated/launch.rst', 'w') as f:
@@ -292,29 +282,13 @@ if you specify a program-to-run you can use the special placeholder
                 p(f'\nThe source code for this kitten is `available on GitHub <{scurl}>`_.')
                 p('\nCommand Line Interface')
                 p('-' * 72)
-                appname = f'kitten {kitten}'
-                if kitten in ('panel', 'broadcast', 'remote_file'):
-                    appname = 'kitty +' + appname
                 p('\n\n' + option_spec_as_rst(
-                    data['options'], message=data['help_text'], usage=data['usage'], appname=appname, heading_char='^'))
+                    data['options'], message=data['help_text'], usage=data['usage'], appname=f'kitty +kitten {kitten}',
+                    heading_char='^'))
 
 # }}}
 
 
-def write_color_names_table() -> None: # {{{
-    from kitty.fast_data_types import all_color_names
-    def s(c: Any) -> str:
-        return f'{c.red:02x}/{c.green:02x}/{c.blue:02x}'
-    with open('generated/color-names.rst', 'w') as f:
-        p = partial(print, file=f)
-        p('=' * 50, '=' * 20)
-        p('Name'.ljust(50), 'RGB value')
-        p('=' * 50, '=' * 20)
-        for name, col in all_color_names():
-            p(name.ljust(50), s(col))
-        p('=' * 50, '=' * 20)
-# }}}
-
 def write_remote_control_protocol_docs() -> None:  # {{{
     from kitty.rc.base import RemoteCommand, all_command_names, command_for_name
     field_pat = re.compile(r'\s*([^:]+?)\s*:\s*(.+)')
@@ -343,10 +317,8 @@ def write_remote_control_protocol_docs() -> None:  # {{{
                     else:
                         title = f'{title} (optional)'
                 p(f':code:`{title}`')
-                p(' ', desc)
-                p()
-        p()
-        p()
+                p(' ', desc), p()
+        p(), p()
 
     with open('generated/rc.rst', 'w') as f:
         p = partial(print, file=f)
@@ -361,7 +333,7 @@ def write_remote_control_protocol_docs() -> None:  # {{{
 
 def replace_string(app: Any, docname: str, source: List[str]) -> None:  # {{{
     src = source[0]
-    for k, v in string_replacements.items():
+    for k, v in app.config.string_replacements.items():
         src = src.replace(k, v)
     source[0] = src
 # }}}
@@ -369,45 +341,41 @@ def replace_string(app: Any, docname: str, source: List[str]) -> None:  # {{{
 # config file docs {{{
 
 
-def bygroups(*args: Any) -> Any:
-    return untyped_bygroups(*args)  # type: ignore[no-untyped-call]
-
-
-class ConfLexer(RegexLexer):
+class ConfLexer(RegexLexer):  # type: ignore
     name = 'Conf'
     aliases = ['conf']
     filenames = ['*.conf']
 
     def map_flags(self: RegexLexer, val: str, start_pos: int) -> Iterator[Tuple[int, Any, str]]:
-        expecting_arg = ''
-        s = Shlex(val)
-        from kitty.options.utils import allowed_key_map_options
-        last_pos = 0
-        while (tok := s.next_word())[0] > -1:
-            x = tok[1]
-            if tok[0] > last_pos:
-                yield start_pos + last_pos, Whitespace, ' ' * (tok[0] - last_pos)
-            last_pos = tok[0] + len(x)
-            tok_start = start_pos + tok[0]
-            if expecting_arg:
-                yield tok_start, String, x
-                expecting_arg = ''
-            elif x.startswith('--'):
-                expecting_arg = x[2:]
-                k, sep, v = expecting_arg.partition('=')
-                k = k.replace('-', '_')
-                expecting_arg = k
-                if expecting_arg not in allowed_key_map_options:
-                    yield tok_start, Error, x
-                elif sep == '=':
+            expecting_arg = ''
+            s = Shlex(val)
+            from kitty.options.utils import allowed_key_map_options
+            last_pos = 0
+            while (tok := s.next_word())[0] > -1:
+                x = tok[1]
+                if tok[0] > last_pos:
+                    yield start_pos + last_pos, Whitespace, ' ' * (tok[0] - last_pos)
+                last_pos = tok[0] + len(x)
+                tok_start = start_pos + tok[0]
+                if expecting_arg:
+                    yield tok_start, String, x
                     expecting_arg = ''
-                    yield tok_start, Name, x
+                elif x.startswith('--'):
+                    expecting_arg = x[2:]
+                    k, sep, v = expecting_arg.partition('=')
+                    k = k.replace('-', '_')
+                    expecting_arg = k
+                    if expecting_arg not in allowed_key_map_options:
+                        yield tok_start, Error, x
+                    elif sep == '=':
+                        expecting_arg = ''
+                        yield tok_start, Name, x
+                    else:
+                        yield tok_start, Name, x
                 else:
-                    yield tok_start, Name, x
-            else:
-                break
+                    break
 
-    def mapargs(self: 'ConfLexer', match: 're.Match[str]') -> Iterator[Tuple[int, Any, str]]:
+    def mapargs(self: RegexLexer, match: 're.Match[str]') -> Iterator[Tuple[int, Any, str]]:
         start_pos = match.start()
         val = match.group()
         parts = val.split(maxsplit=1)
@@ -471,7 +439,7 @@ class ConfLexer(RegexLexer):
     }
 
 
-class SessionLexer(RegexLexer):
+class SessionLexer(RegexLexer):  # type: ignore
     name = 'Session'
     aliases = ['session']
     filenames = ['*.session']
@@ -656,10 +624,33 @@ def monkeypatch_man_writer() -> None:
     '''
     Monkeypatch the docutils man translator to be nicer
     '''
-    from docutils.nodes import figure
-    from docutils.writers.manpage import Translator
+    from docutils.nodes import Element
+    from docutils.writers.manpage import Table, Translator
     from sphinx.writers.manpage import ManualPageTranslator
 
+    # Generate nicer tables https://sourceforge.net/p/docutils/bugs/475/
+    class PatchedTable(Table):  # type: ignore
+        _options: list[str]
+        def __init__(self) -> None:
+            super().__init__()
+            self.needs_border_removal = self._options == ['center']
+            if self.needs_border_removal:
+                self._options = ['box', 'center']
+
+        def as_list(self) -> list[str]:
+            ans: list[str] = super().as_list()
+            if self.needs_border_removal:
+                # remove side and top borders as we use box in self._options
+                ans[2] = ans[2][1:]
+                a, b = ans[2].rpartition('|')[::2]
+                ans[2] = a + b
+                if ans[3] == '_\n':
+                    del ans[3]  # top border
+                del ans[-2] # bottom border
+            return ans
+    def visit_table(self: ManualPageTranslator, node: object) -> None:
+        setattr(self, '_active_table', PatchedTable())
+    setattr(ManualPageTranslator, 'visit_table', visit_table)
 
     # Improve header generation
     def header(self: ManualPageTranslator) -> str:
@@ -676,13 +667,13 @@ def monkeypatch_man_writer() -> None:
 
     setattr(ManualPageTranslator, 'header', header)
 
-    def visit_image(self: ManualPageTranslator, node: figure) -> None:
+    def visit_image(self: ManualPageTranslator, node: Element) -> None:
         pass
 
-    def depart_image(self: ManualPageTranslator, node: figure) -> None:
+    def depart_image(self: ManualPageTranslator, node: Element) -> None:
         pass
 
-    def depart_figure(self: ManualPageTranslator, node: figure) -> None:
+    def depart_figure(self: ManualPageTranslator, node: Element) -> None:
         self.body.append(' (images not supported)\n')
         Translator.depart_figure(self, node)
 
@@ -690,8 +681,8 @@ def monkeypatch_man_writer() -> None:
     setattr(ManualPageTranslator, 'depart_image', depart_image)
     setattr(ManualPageTranslator, 'depart_figure', depart_figure)
 
-    orig_astext = getattr(ManualPageTranslator, 'astext')
-    def astext(self: ManualPageTranslator) -> Any:
+    orig_astext = Translator.astext
+    def astext(self: Translator) -> Any:
         b = []
         for line in self.body:
             if line.startswith('.SH'):
@@ -700,9 +691,9 @@ def monkeypatch_man_writer() -> None:
                 parts[0] = parts[0].capitalize()
                 line = x + ' ' + '\n'.join(parts)
             b.append(line)
-        setattr(self, 'body', b)
+        self.body = b
         return orig_astext(self)
-    setattr(ManualPageTranslator, 'astext', astext)
+    setattr(Translator, 'astext', astext)
 
 
 def setup_man_pages() -> None:
@@ -710,7 +701,7 @@ def setup_man_pages() -> None:
     base = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
     for x in glob.glob(os.path.join(base, 'docs/kittens/*.rst')):
         kn = os.path.basename(x).rpartition('.')[0]
-        if kn in ('custom', 'developing-builtin-kittens'):
+        if kn == 'custom':
             continue
         cd = get_kitten_cli_docs(kn) or {}
         khn = kn.replace('_', '-')
@@ -757,8 +748,8 @@ def setup(app: Any) -> None:
     kn = all_kitten_names()
     write_cli_docs(kn)
     write_remote_control_protocol_docs()
-    write_color_names_table()
     write_conf_docs(app, kn)
+    app.add_config_value('string_replacements', {}, True)
     app.connect('source-read', replace_string)
     app.add_config_value('analytics_id', '', 'env')
     app.connect('html-page-context', add_html_context)

docs/conf.rst

@@ -13,12 +13,11 @@ kitty.conf
 |kitty| is highly customizable, everything from keyboard shortcuts, to rendering
 frames-per-second. See below for an overview of all customization possibilities.
 
-You can open the config file within |kitty| by pressing :sc:`edit_config_file`
+You can open the config file within kitty by pressing :sc:`edit_config_file`
 (:kbd:`⌘+,` on macOS). A :file:`kitty.conf` with commented default
 configurations and descriptions will be created if the file does not exist.
-The configuration is automatically reloaded when modified, controlled by
-:opt:`auto_reload_config`. You can manually reload the config by pressing
-:sc:`reload_config_file` (:kbd:`⌃+⌘+,` on macOS) or sending |kitty| the
+You can reload the config file within kitty by pressing
+:sc:`reload_config_file` (:kbd:`⌃+⌘+,` on macOS) or sending kitty the
 ``SIGUSR1`` signal with ``kill -SIGUSR1 $KITTY_PID``. You can also display the
 current configuration by pressing :sc:`debug_config` (:kbd:`⌥+⌘+,` on macOS).
 
@@ -29,16 +28,16 @@ current configuration by pressing :sc:`debug_config` (:kbd:`⌥+⌘+,` on macOS)
 :option:`kitty --config` option or use the :envvar:`KITTY_CONFIG_DIRECTORY`
 environment variable. See :option:`kitty --config` for full details.
 
-**Comments** can be added to the config file as lines starting with the ``#``
+Comments can be added to the config file as lines starting with the ``#``
 character. This works only if the ``#`` character is the first character in the
 line.
 
-**Lines can be split** by starting the next line with the ``\`` character.
+Lines can be split by starting the next line with the ``\`` character.
 All leading whitespace and the ``\`` character are removed.
 
 .. _include:
 
-You can **include secondary config files** via the :code:`include` directive. If
+You can include secondary config files via the :code:`include` directive. If
 you use a relative path for :code:`include`, it is resolved with respect to the
 location of the current config file. Note that environment variables are
 expanded, so :code:`${USER}.conf` becomes :file:`name.conf` if
@@ -46,21 +45,17 @@ expanded, so :code:`${USER}.conf` becomes :file:`name.conf` if
 to detect the operating system. It is ``linux``, ``macos`` or ``bsd``.
 Also, you can use :code:`globinclude` to include files
 matching a shell glob pattern and :code:`envinclude` to include configuration
-from environment variables. Finally, you can dynamically generate configuration
-by running a program using :code:`geninclude`. For example::
+from environment variables. For example::
 
-     # Include other.conf
      include other.conf
      # Include *.conf files from all subdirs of kitty.d inside the kitty config dir
      globinclude kitty.d/**/*.conf
      # Include the *contents* of all env vars starting with KITTY_CONF_
      envinclude KITTY_CONF_*
-     # Run the script dynamic.py placed in the same directory as this config file
-     # and include its :file:`STDOUT`. Note that Python scripts are fastest
-     # as they use the embedded Python interpreter, but any executable script
-     # or program is supported, in any language. Remember to mark the script
-     # file executable.
-     geninclude dynamic.py
+
+
+.. 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
@@ -92,10 +87,9 @@ This will print the commented out default config file to :file:`STDOUT`.
 All mappable actions
 ------------------------
 
-See the :doc:`list of all the things you can make |kitty| can do </actions>`.
+See the :doc:`list of all the things you can make kitty can do </actions>`.
 
 .. toctree::
    :hidden:
 
    actions
-   wide-gamut-colors

docs/desktop-notifications.rst

@@ -1,4 +1,4 @@
-.. _notifications_on_the_desktop:
+.. _desktop_notifications:
 
 
 Desktop notifications
@@ -25,7 +25,7 @@ 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, let's see how one can display a simple, single line
+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\\'
@@ -33,16 +33,7 @@ notification from a shell script::
 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:p=body;This is cool\x1b\\'
-
-.. tip::
-
-   |kitty| also comes with its own :doc:`statically compiled command line tool </kittens/notify>` to easily display
-   notifications, with all their advanced features. For example:
-
-   .. code-block:: sh
-
-        kitten notify "Hello world" A good day to you
+    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
@@ -52,55 +43,20 @@ 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 is an :ref:`identifier`.
-The ``d`` key stands for *done* and can only take the
+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 non-zero value means
+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). The size of the payload must be no
-longer than ``2048`` bytes, *before being encoded* or ``4096`` encoded bytes.
+longer than ``2048`` bytes, *before being encoded*.
 
-Both the ``title`` and ``body`` payloads must be either :ref:`safe_utf8` text
-or UTF-8 text that is :ref:`base64` encoded, in which case there must be an
-``e=1`` key in the metadata to indicate the payload is :ref:`base64`
-encoded. No HTML or other markup in the plain text is allowed. It is strictly
-plain text, to be interpreted as such.
-
-Allowing users to filter notifications
--------------------------------------------------------
-
-.. versionadded:: 0.36.0
-   Specifying application name and notification type
-
-Well behaved applications should identify themselves to the terminal
-by means of two keys ``f`` which is the application name and ``t``
-which is the notification type. These are free form keys, they can contain
-any values, their purpose is to allow users to easily filter out
-notifications they do not want. Both keys must have :ref:`base64`
-encoded UTF-8 text as their values. The ``t`` key can be specified multiple
-times, as notifications can have more than one type. See the `freedesktop.org
-spec
-<https://specifications.freedesktop.org/notification-spec/notification-spec-latest.html#categories>`__
-for examples of notification types.
-
-.. note::
-   The application name should generally be set to the filename of the
-   applications `desktop file
-   <https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#file-naming>`__
-   (without the ``.desktop`` part) or the bundle identifier for a macOS
-   application. While not strictly necessary, this allows the terminal
-   emulator to deduce an icon for the notification when one is not specified.
-
-.. tip::
-
-   |kitty| has sophisticated notification filtering and management
-   capabilities via :opt:`filter_notification`.
-
-
-Being informed when user activates the notification
--------------------------------------------------------
+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
@@ -115,319 +71,29 @@ escape code is::
 
 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``. (Ideally ``i`` should have been left out from the response,
-but for backwards compatibility ``i=0`` is used). 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::
+*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 :ref:`table below <keys_in_notificatons_protocol>`.
-If a terminal emulator encounters a key in the metadata it does not understand,
+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.
-
-
-Being informed when a notification is closed
-------------------------------------------------
-
-.. versionadded:: 0.36.0
-   Notifications of close events
-
-If you wish to be informed when a notification is closed, you can specify
-``c=1`` when sending the notification. For example::
-
-    <OSC> 99 ; i=mynotification : c=1 ; hello world <terminator>
-
-Then, the terminal will send the following
-escape code to inform when the notification is closed::
-
-    <OSC> 99 ; i=mynotification : p=close ; <terminator>
-
-If no notification id was specified ``i=0`` will be used in the response
-
-If ``a=report`` is specified and the notification is activated/clicked on
-then both the activation report and close notification are sent. If the notification
-is updated then the close event is not sent unless the updated notification
-also requests a close notification.
-
-Note that on some platforms, such as macOS, the OS does not inform applications
-when notifications are closed, on such platforms, terminals reply with::
-
-    <OSC> 99 ; i=mynotification : p=close ; untracked <terminator>
-
-This means that the terminal has no way of knowing when the notification is
-closed. Instead, applications can poll the terminal to determine which
-notifications are still alive (not closed), with::
-
-    <OSC> 99 ; i=myid : p=alive ; <terminator>
-
-The terminal will reply with::
-
-    <OSC> 99 ; i=myid : p=alive ; id1,id2,id3 <terminator>
-
-Here, ``myid`` is present for multiplexer support. The response from the terminal
-contains a comma separated list of ids that are still alive.
-
-
-Updating or closing an existing notification
-----------------------------------------------
-
-.. versionadded:: 0.36.0
-   The ability to update and close a previous notification
-
-To update a previous notification simply send a new notification with the same
-*notification id* (``i`` key) as the one you want to update. If the original
-notification is still displayed it will be replaced, otherwise a new
-notification is displayed. This can be used, for example, to show progress of
-an operation. How smoothly the existing notification is replaced
-depends on the underlying OS, for example, on Linux the replacement is usually flicker
-free, on macOS it isn't, because of Apple's design choices.
-Note that if no ``i`` key is specified, no updating must take place, even if
-there is a previous notification without an identifier. The terminal must
-treat these as being two unique *unidentified* notifications.
-
-To close a previous notification, send::
-
-    <OSC> i=<notification id> : p=close ; <terminator>
-
-This will close a previous notification with the specified id. If no such
-notification exists (perhaps because it was already closed or it was activated)
-then the request is ignored. If no ``i`` key is specified, this must be a no-op.
-
-
-Automatically expiring notifications
--------------------------------------
-
-A notification can be marked as expiring (being closed) automatically after
-a specified number of milliseconds using the ``w`` key. The default if
-unspecified is ``-1`` which means to use whatever expiry policy the OS has for
-notifications. A value of ``0`` means the notification should never expire.
-Values greater than zero specify the number of milliseconds after which the
-notification should be auto-closed. Note that the value of ``0``
-is best effort, some platforms honor it and some do not. Positive values
-are robust, since they can be implemented by the terminal emulator itself,
-by manually closing the notification after the expiry time. The notification
-could still be closed before the expiry time by user interaction or OS policy,
-but it is guaranteed to be closed once the expiry time has passed.
-
-
-Adding icons to notifications
---------------------------------
-
-.. versionadded:: 0.36.0
-   Custom icons in notifications
-
-Applications can specify a custom icon to be displayed with a notification.
-This can be the application's logo or a symbol such as error or warning
-symbols. The simplest way to specify an icon is by *name*, using the ``n``
-key. The value of this key is :ref:`base64` encoded UTF-8 text. Names
-can be either application names, or symbol names. The terminal emulator
-will try to resolve the name based on icons and applications available
-on the computer it is running on. The following list of well defined names
-must be supported by any terminal emulator implementing this spec.
-The ``n`` key can be specified multiple times, the terminal will go through
-the list in order and use the first icon that it finds available on the
-system.
-
-.. table:: Universally available icon names
-
-   ======================== ==============================================
-   Name                     Description
-   ======================== ==============================================
-   ``error``                An error symbol
-   ``warn``, ``warning``    A warning symbol
-   ``info``                 A symbol denoting an informational message
-   ``question``             A symbol denoting asking the user a question
-   ``help``                 A symbol denoting a help message
-   ``file-manager``         A symbol denoting a generic file manager application
-   ``system-monitor``       A symbol denoting a generic system monitoring/information application
-   ``text-editor``          A symbol denoting a generic text editor application
-   ======================== ==============================================
-
-If an icon name is an application name it should be an application identifier,
-such as the filename of the application's :file:`.desktop` file on Linux or its
-bundle identifier on macOS. For example if the cross-platform application
-FooBar has a desktop file named: :file:`foo-bar.desktop` and a bundle
-identifier of ``net.foo-bar-website.foobar`` then it should use the icon names
-``net.foo-bar-website.foobar`` *and* ``foo-bar`` so that terminals running on
-both platforms can find the application icon.
-
-If no icon is specified, but the ``f`` key (application name) is specified, the
-terminal emulator should use the value of the ``f`` key to try to find a
-suitable icon.
-
-Adding icons by transmitting icon data
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This can be done by using the ``p=icon`` key. Then, the payload is the icon
-image in any of the ``PNG``, ``JPEG`` or ``GIF`` image formats. It is recommended
-to use an image size of ``256x256`` for icons. Since icons are binary data,
-they must be transmitted encoded, with ``e=1``.
-
-When both an icon name and an image are specified, the terminal emulator must
-first try to find a locally available icon matching the name and only if one
-is not found, fallback to the provided image. This is so that users are
-presented with icons from their current icon theme, where possible.
-
-Transmitted icon data can be cached using the ``g`` key. The value of the ``g``
-key must be a random globally unique UUID like :ref:`identifier`. Then, the
-terminal emulator will cache the transmitted data using that key. The cache
-should exist for as long as the terminal emulator remains running. Thus, in
-future notifications, the application can simply send the ``g`` key to display
-a previously cached icon image with needing to re-transmit the actual data with
-``p=icon``. The ``g`` key refers only to the icon data, multiple different
-notifications with different icon or application names can use the same ``g``
-key to refer to the same icon. Terminal multiplexers must cache icon data
-themselves and refresh it in the underlying terminal implementation when
-detaching and then re-attaching. This means that applications once started
-need to transmit icon data only once until they are quit.
+*should* either ignore the entire escape code or perform a best guess effort
+to display it based on what it does understand.
 
 .. note::
-   To avoid DoS attacks terminal implementations can impose a reasonable max size
-   on the icon cache and evict icons in order of last used. Thus theoretically,
-   a previously cached icon may become unavailable, but given that icons are
-   small images, practically this is not an issue in all but the most resource
-   constrained environments, and the failure mode is simply that the icon is not
-   displayed.
+   It is possible to extend this escape code to allow specifying an icon for
+   the notification, however, given that some platforms, such as legacy versions
+   of macOS, don't allow displaying custom images on a notification, it was
+   decided to leave it out of the spec for the time being.
 
-.. note::
-   How the icon is displayed depends on the underlying OS notifications
-   implementation. For example, on Linux, typically a single icon is displayed.
-   On macOS, both the terminal emulator's icon and the specified custom icon
-   are displayed.
+   Similarly, features such as scheduled notifications could be added in future
+   revisions.
 
 
-Adding buttons to the notification
----------------------------------------
-
-Buttons can be added to the notification using the *buttons* payload, with ``p=buttons``.
-Buttons are a list of UTF-8 text separated by the Unicode Line Separator
-character (U+2028) which is the UTF-8 bytes ``0xe2 0x80 0xa8``. They can be
-sent either as :ref:`safe_utf8` or :ref:`base64`. When the user clicks on one
-of the buttons, and reporting is enabled with ``a=report``, the terminal will
-send an escape code of the form::
-
-    <OSC> 99 ; i=identifier ; button_number <terminator>
-
-Here, `button_number` is a number from 1 onwards, where 1 corresponds
-to the first button, two to the second and so on. If the user activates the
-notification as a whole, and not a specific button, the response, as described
-above is::
-
-    <OSC> 99 ; i=identifier ; <terminator>
-
-If no identifier was specified when creating the notification, ``i=0`` is used.
-The terminal *must not* send a response unless report is requested with
-``a=report``.
-
-.. note::
-
-   The appearance of the buttons depends on the underlying OS implementation.
-   On most Linux systems, the buttons appear as individual buttons on the
-   notification. On macOS they appear as a drop down menu that is accessible
-   when hovering the notification. Generally, using more than two or three
-   buttons is not a good idea.
-
-.. _notifications_query:
-
-Playing a sound with notifications
------------------------------------------
-
-.. versionadded:: 0.36.0
-   The ability to control the sound played with notifications
-
-By default, notifications may or may not have a sound associated with them
-depending on the policies of the OS notifications service. Sometimes it
-might be useful to ensure a notification is not accompanied by a sound.
-This can be done by using the ``s`` key which accepts :ref:`base64` encoded
-UTF-8 text as its value. The set of known sounds names is in the table below,
-any other names are implementation dependent, for instance, on Linux, terminal emulators will
-probably support the `standard sound names
-<https://specifications.freedesktop.org/sound-naming-spec/latest/#names>`__
-
-.. table:: Standard sound names
-
-   ======================== ==============================================
-   Name                     Description
-   ======================== ==============================================
-   ``system``               The default system sound for a notification, which may be some kind of beep or just silence
-   ``silent``               No sound must accompany the notification
-   ``error``                A sound associated with error messages
-   ``warn``, ``warning``    A sound associated with warning messages
-   ``info``                 A sound associated with information messages
-   ``question``             A sound associated with questions
-   ======================== ==============================================
-
-Support for sound names can be queried as described below.
-
-
-Querying for support
--------------------------
-
-.. versionadded:: 0.36.0
-   The ability to query for support
-
-An application can query the terminal emulator for support of this protocol, by
-sending the following escape code::
-
-    <OSC> 99 ; i=<some identifier> : p=? ; <terminator>
-
-A conforming terminal must respond with an escape code of the form::
-
-    <OSC> 99 ; i=<some identifier> : p=? ; key=value : key=value <terminator>
-
-The identifier is present to support terminal multiplexers, so that they know
-which window to redirect the query response too.
-
-Here, the ``key=value`` parts specify details about what the terminal
-implementation supports. Currently, the following keys are defined:
-
-=======  ================================================================================
-Key      Value
-=======  ================================================================================
-``a``    Comma separated list of actions from the ``a`` key that the terminal
-         implements. If no actions are supported, the ``a`` key must be absent from the
-         query response.
-
-``c``    ``c=1`` if the terminal supports close events, otherwise the ``c``
-         must be omitted.
-
-``o``    Comma separated list of occasions from the ``o`` key that the
-         terminal implements. If no occasions are supported, the value
-         ``o=always`` must be sent in the query response.
-
-``p``    Comma separated list of supported payload types (i.e. values of the
-         ``p`` key that the terminal implements). These must contain at least
-         ``title``.
-
-``s``    Comma separated list of sound names from the table of standard sound names above.
-         Terminals will report the list of standard sound names they support.
-         Terminals *should* support at least ``system`` and ``silent``.
-
-``u``    Comma separated list of urgency values that the terminal implements.
-         If urgency is not supported, the ``u`` key must be absent from the
-         query response.
-
-``w``    ``w=1`` if the terminal supports auto expiring of notifications.
-=======  ================================================================================
-
-In the future, if this protocol expands, more keys might be added. Clients must
-ignore keys they do not understand in the query response.
-
-To check if a terminal emulator supports this notifications 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 the *query
-action* the terminal emulator does not support this notifications protocol.
-
-.. _keys_in_notificatons_protocol:
-
-Specification of all keys used in the protocol
---------------------------------------------------
-
 =======  ====================  ========== =================
 Key      Value                 Default    Description
 =======  ====================  ========== =================
@@ -437,30 +103,16 @@ Key      Value                 Default    Description
          optional leading
          ``-``
 
-``c``    ``0`` or ``1``        ``0``      When non-zero an escape code is sent to the application when the notification is closed.
-
 ``d``    ``0`` or ``1``        ``1``      Indicates if the notification is
-                                          complete or not. A non-zero value
-                                          means it is complete.
+                                          complete or not.
 
-``e``    ``0`` or ``1``        ``0``      If set to ``1`` means the payload is :ref:`base64` encoded UTF-8,
+``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
 
-``f``    :ref:`base64`         ``unset``  The name of the application sending the notification. Can be used to filter out notifications.
-         encoded UTF-8
-         application name
+``i``    ``[a-zA-Z0-9-_+.]``   ``0``      Identifier for the notification
 
-``g``    :ref:`identifier`     ``unset``  Identifier for icon data. Make these globally unique,
-                                          like an UUID.
-
-``i``    :ref:`identifier`     ``unset``  Identifier for the notification. Make these globally unique,
-                                          like an UUID, so that terminal multiplexers can
-                                          direct responses to the correct window. Note that for backwards
-                                          compatibility reasons i=0 is special and should not be used.
-
-``n``    :ref:`base64`         ``unset``  Icon name. Can be specified multiple times.
-         encoded UTF-8
-         application name
+``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.
 
 ``o``    One of ``always``,    ``always`` When to honor the notification request. ``unfocused`` means when the window
          ``unfocused`` or                 the notification is sent on does not have keyboard focus. ``invisible``
@@ -468,84 +120,15 @@ Key      Value                 Default    Description
                                           and not visible to the user, for example, because it is in an inactive tab or
                                           its OS window is not currently active.
                                           ``always`` is the default and always honors the request.
-
-``p``    One of ``title``,     ``title``  Type of the payload. If a notification has no title, the body will be used as title.
-         ``body``,                        A notification with not title and no body is ignored. Terminal
-         ``close``,                       emulators should ignore payloads of unknown type to allow for future
-         ``icon``,                        expansion of this protocol.
-         ``?``, ``alive``,
-         ``buttons``
-
-``s``    :ref:`base64`         ``system`` The sound name to play with the notification. ``silent`` means no sound.
-         encoded sound                    ``system`` means to play the default sound, if any, of the platform notification service.
-         name                             Other names are implementation dependent.
-
-``t``    :ref:`base64`         ``unset``  The type of the notification. Used to filter out notifications. Can be specified multiple times.
-         encoded UTF-8
-         notification type
-
-``u``    ``0, 1 or 2``         ``unset``  The *urgency* of the notification. ``0`` is low, ``1`` is normal and ``2`` is critical.
-                                          If not specified normal is used.
-
-
-``w``    ``>=-1``              ``-1``     The number of milliseconds to auto-close the notification after.
 =======  ====================  ========== =================
 
 
-.. versionadded:: 0.35.0
-   Support for the ``u`` key to specify urgency
-
-.. versionadded:: 0.31.0
+.. note::
    Support for the ``o`` key to prevent notifications from focused windows
+   was added in kitty version 0.31.0
 
 
 .. note::
    |kitty| also supports the `legacy OSC 9 protocol developed by iTerm2
    <https://iterm2.com/documentation-escape-codes.html>`__ for desktop
    notifications.
-
-
-.. _base64:
-
-Base64
----------------
-
-The base64 encoding used in the this specification is the one defined in
-:rfc:`4648`. When a base64 payload is chunked, either the chunking should be
-done before encoding or after. When the chunking is done before encoding, no
-more than 2048 bytes of data should be encoded per chunk and the encoded data
-**must** include the base64 padding bytes, if any. When the chunking is done
-after encoding, each encoded chunk must be no more than 4096 bytes in size.
-There may or may not be padding bytes at the end of the last chunk, terminals
-must handle either case.
-
-
-.. _safe_utf8:
-
-Escape code safe UTF-8
---------------------------
-
-This must be valid UTF-8 as per the spec in :rfc:`3629`. In addition, in order
-to make it safe for transmission embedded inside an escape code, it must
-contain none of the C0 and C1 control characters, that is, the Unicode
-characters: U+0000 (NUL) - U+1F (Unit separator), U+7F (DEL) and U+80 (PAD) - U+9F
-(APC). Note that in particular, this means that no newlines, carriage returns,
-tabs, etc. are allowed.
-
-
-.. _identifier:
-
-Identifier
-----------------
-
-Any string consisting solely of characters from the set ``[a-zA-Z0-9_-+.]``,
-that is, the letters ``a-z``, ``A-Z``, the underscore, the hyphen, the plus
-sign and the period. Applications should make these globally unique, like a
-UUID for maximum robustness.
-
-
-.. important::
-   Terminals **must** sanitize ids received from client programs before sending
-   them back in responses, to mitigate input injection based attacks. That is, they must
-   either reject ids containing characters not from the above set, or remove
-   bad characters when reading ids sent to them.

docs/dnd-protocol.rst

@@ -1,563 +0,0 @@
-The Drag and Drop protocol
-==============================================
-
-.. versionadded:: 0.47.0
-
-.. warning:: This protocol is still under development, see :iss:`9984`.
-
-This protocol enables drag and drop functionality for terminal programs
-that is as good as the drag and drop functionality available for GUI
-programs.
-
-There is one central escape code used for this protocol, which is of the form::
-
-    OSC _dnd_code ; metadata ; payload ST
-
-Here, ``OSC`` is the bytes ``ESC ] (0x1b 0x5b)`` and ST is ``ESC \\ (0x1b 0x5c)``.
-The ``metadata`` is a colon separated list of ``key=value`` pairs.
-The final part of the escape code is the payload data, whose meaning depends on the metadata.
-
-The payload must be no more than 4096 bytes. When the payload is larger than 4096
-bytes, it is chunked up using the ``m`` key. An escape code that has a too long
-payload is transmitted in chunks. All but the last chunk must have ``m=1`` in
-their metadata. Each chunk must have a payload of no more than 4096 bytes.
-Only the first chunk is guaranteed to have metadata other than the ``m`` key.
-Subsequent chunks may optionally omit all
-metadata except the ``m`` and ``i`` keys. While a chunked transfer is in
-progress it is a protocol error to for the sending side to
-send any protocol related escape codes other than chunked ones or query (``t=q|Q``) ones.
-In particular, this means that the receiving side should use the metadata from
-the first chunk in a chain of chunks only.
-
-All integer values used in this escape code must be 32-bit signed or unsigned
-integers encoded in decimal representation.
-
-When transferring binary data the payload is :rfc:`base64 <4648>` encoded. The
-4096 bytes limit applies to *encoded bytes*, that is, it is applied after
-encoding. base64 padding bytes are optional and may or may not be present at
-the end of the last chunk.
-
-Accepting drops
------------------
-
-In order to inform the terminal emulator that the client accepts drops, it
-must send the following escape code::
-
-    OSC _dnd_code ; t=a ; payload ST
-
-The payload here is a space separated list of MIME types the program accepts.
-The list of MIME types is optional, it is needed if the program wants to accept
-exotic or private use MIME types on platforms such as macOS, where the system
-does not deliver drop events unless the MIME type is registered.
-
-When the client is done accepting drops, or at exit, it should send the escape
-code::
-
-    OSC _dnd_code ; t=A ST
-
-to inform the terminal that it no longer wants drops.
-
-Whenever the user drags something over the window, the terminal will send an
-escape code of the form::
-
-    OSC _dnd_code ; t=m:x=x:y=y:X=X:Y=Y:o=O ; optional MIME list ST
-
-Here, ``x, y`` identify the cell over which the drag is currently present.
-The ``(0, 0)`` cell is at top left of the screen. ``X and Y`` are the pixel
-offsets from the top-left. The ``O`` value is the set of allowed operations,
-which can be ``1`` for copy, ``2`` for move and ``3`` for either, at the
-client's discretion. The optional list of MIMES is a space separated
-list of MIME types that are available for dropping. To avoid overhead, the
-terminal should only send this list for the first move event and subsequently
-only if the list changes.
-
-When the drag leaves the window, the terminal will send the same event but
-with ``x, y = -1, -1`` to indicate that the drag has left the window. For such
-events the list of MIME types must be empty. Note that the terminal must never
-send negative cell co-ordinates for any other reason. No more movement escape
-codes ``t=m`` will be sent until this drop or another re-enters the window.
-
-The client program must inform the terminal whether it will accept
-the potential drop and which MIME types of the set of offered MIME types it
-accepts. Until the client does so the terminal will indicate to the OS that
-the drop is not accepted. To do so, the client sends an escape code of the
-form::
-
-    OSC _dnd_code ; t=m:o=O ; MIME list ST
-
-Here the ``o`` key is the operation the client intends to perform if a drop
-occurs which can be either ``1`` for copy or ``2`` for move or ``0`` for not
-accepted. The MIME list is the ordered list of MIME types from the offered list
-that the client wants. If no MIME type list is present, it is equivalent to no
-change in the offered list of MIME types. The list should be ordered in order
-of decreasing preference. Some platforms may show the user some
-indication of the first MIME type in the list.
-
-When the user triggers a drop on the window, the terminal will send an escape
-code of the form::
-
-    OSC _dnd_code ; t=M: ... ; MIME list ST
-
-This is the same as the movement escape codes above, except that ``t=M``
-(upper case M instead of lower case m), indicating this is a drop.
-Once this escape code is received, no more movement escape codes ``t=m``
-will be sent until a new drop enters the window. The MIME list here is
-mandatory, terminals must send the full list of MIME types available in
-the drop. The client program can now request data for the MIME types
-it is interested in.
-
-Requesting data is done by sending an escape code of the form::
-
-    OSC _dnd_code ; t=r:x=idx ST
-
-Here ``idx`` is a 1-based index into the list of MIME types sent in the ``t=M``
-drop event. This will request data for the specified MIME type.
-The terminal must respond with a series of escape codes of the form::
-
-    OSC _dnd_code ; t=r:x=idx; base64 encoded data possibly chunked ST
-
-End of data is indicated by an empty payload and ``m=0``. If some error occurs while
-getting the data, the terminal must send an escape code of the form::
-
-    OSC _dnd_code ; t=R:x=idx ; POSIX error name:optional description ST
-
-Here ``POSIX error name`` is a POSIX symbolic error name such as ``ENOENT`` or
-``EIO`` or the value ``EUNKNOWN`` for an unknown error. Unless otherwise noted,
-any error response means the drop is terminated. The description is optional
-and must consist only of :ref:`safe_utf8`.
-
-Once the client program finishes reading all the dropped data it needs, it must
-send an escape code of the form::
-
-    OSC _dnd_code ; t=r:o=operation ST
-
-That is, it must send a request for data with no MIME type specified. The
-terminal emulator must then inform the OS that the drop is completed. Any
-queued data requests must be discarded by the terminal. The ``operation``
-is required and must specify the final action the client took with the data.
-If unset (aka ``0``) the terminal must assume the drop was canceled.
-
-Dropping from remote machines
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-In order to support dropping of files from remote machines, the client
-must inform the terminal of its :ref:`machine id <machine_id>` using the escape code::
-
-    OSC _dnd_code ; t=a:x=1 ; machine id ST
-
-Then, the client must first request the :rfc:`text/uri-list <2483>` MIME
-type to get a list of dropped URIs. When responding to this request,
-the terminal will send the usual ``t=r`` responses, but, in addition,
-if the client has sent its machine id and the terminal determines that
-the client is on a different machine based on the id, it will add the ``X=1``
-key to its response. The client should use this key to determine if it wants to
-request data for entries in the URI list. For every URI in the list, the client can
-send the terminal emulator a data request of the form::
-
-    OSC _dnd_code ; t=r:x=idx:y=subidx ST
-
-Here ``idx`` is the one based index of the ``text/uri-list`` MIME type. And
-``subidx`` is the one based index into the array of MIME types in
-the ``text/uri-list`` entry. The terminal will then read the file and
-transmit the data as for a normal MIME data request, except it will have
-``y=subidx`` as well in its response, for example::
-
-    OSC _dnd_code ; t=r:x=idx:y=subidx ; base64 encoded data possibly chunked ST
-
-Similarly, error responses are as above, except for the addition of
-``y=subidx``, for example::
-
-    OSC _dnd_code ; t=R:x=idx:y=subidx ; POSIX error name:optional desc ST
-
-Terminals must reply with ``ENOENT`` if the index is out of bounds.
-If the client does not first request the ``text/uri-list`` MIME type or that
-MIME type is not present in the drop, the terminal must reply with
-``EINVAL``. Terminals must support at least ``file://`` URIs.
-If the client requests an entry that is not a supported URI type the
-terminal must reply with ``EUNKNOWN``.
-
-Terminals must ONLY send data for regular files, symbolic links and directories.
-See below for more details about sending symlinks.
-
-If the terminal does not have permission to read the file it must reply with
-``EPERM``. Terminals must respond with ``EINVAL`` if the file is not a regular
-file or symlink or directory and ``ENOENT`` if the file does not exist. If an
-I/O error occurs the terminal must send ``EIO``.
-
-For security reasons, terminals must reply with ``EPERM`` if the drag
-originated in the same window as the drop, this prevents malicious programs
-from reading files on the computer by starting their own drag. This is a
-defense in depth feature since drags can only be started by the terminal, but
-it helps in case of accidental drag starts and drops into the same window.
-
-Clients may send multiple requests without waiting for any request to complete.
-Terminals may queue requests and respond in any order they choose, including
-interleaving responses to different requests. However, for simplicity, this
-specification recommends terminals queue requests and respond in first-in,
-first-out order. Every response can be matched to a corresponding request
-using the ``x``, ``y`` and ``Y`` keys. To prevent Denial of service attacks,
-if too many requests are received, terminals must deny the request
-with ``EMFILE`` and end the drop.
-
-
-Reading remote directories
-+++++++++++++++++++++++++++
-
-If the file pointed to by a ``file://`` URL is actually a directory the terminal must instead respond with::
-
-    OSC _dnd_code ; t=r:x=idx:y=subidx:X=handle ; base64 encoded list of dir entries ST
-
-The presence of ``X=handle`` indicates this is a directory response not a regular
-file or symlink. For regular files, ``X=0``. For symlinks, ``X=1``.
-For directories ``X`` is an arbitrary integer (``handle``) other than ``0`` or ``1``.
-Here, the payload is a null byte separated list of entries in the directory that are
-either regular files, directories or symlinks. The payload must be base64
-encoded and might be chunked if the directory has a lot of entries.
-
-The client can now read the files in this directory using requests of the form::
-
-    OSC _dnd_code ; t=r:Y=handle:x=num ST
-
-Here ``num`` is the 1-based index into the list of directory entries previously transmitted
-to the client. The terminal will respond with an escape code of the forms ::
-
-    OSC _dnd_code ; t=r:Y=handle:x=num ; base64 encoded data of regular file ST
-    OSC _dnd_code ; t=r:Y=handle:x=num:X=1 ; base64 encoded symlink target ST
-    OSC _dnd_code ; t=r:Y=handle:x=num:X=child-handle ; base64 encoded list of entries in sub-dir ST
-
-In case of any errors, the terminal will respond with::
-
-    OSC _dnd_code ; t=R:Y=handle:x=num ; POSIX error name:optional desc ST
-
-In the above, the ``Y=handle`` and ``x=num`` keys allow the client to know
-which directory entry the response concerns. The ``handle`` points to the
-parent directory and ``num`` to the entry within the parent dir.
-
-Once the client is done reading a directory it should transmit ``t=r:Y=handle`` to the terminal. The
-terminal can then free any resources associated with that directory. The
-directory handle is now invalid and terminals must return ``EINVAL`` if the
-client sends a request using an invalid directory handle. It is recommended
-that clients traverse directories breadth first to minimise resource usage in
-the terminal. Terminals may deny directory traversal requests if too many
-resources are used, in order to prevent Denial of service attacks. In such
-cases the terminal must respond with ``ENOMEM``.
-
-
-Starting drags
------------------
-
-Terminal programs can inform the terminal emulator that they
-are willing to act as a source of drag data by sending the
-sending the escape code::
-
-    OSC _dnd_code ; t=o:x=1 ; optional machine id ST
-
-On exit, or if the program no longer is willing to start drag gestures, it must
-send ``t=o:x=2`` to the terminal to indicate it no longer wants to offer drag data.
-The ``machine id`` is optional and is used to enable dragging from remote
-machines. See :ref:`below <machine_id>` for its semantics.
-
-When the user performs the platform specific gesture to start a drag operation,
-the terminal will send the escape code ``t=o`` back to the terminal program
-informing it that it can potentially start a drag. The gesture is typically holding the
-left mouse button down and dragging a short distance, but this protocol does
-not mandate any particular gesture to start drag operations. The terminal, when
-sending the event will also set the ``x, y, X, Y`` keys to indicate the cell
-and pixel locations in the window of the start drag event.
-
-If the terminal program determines that it wants to start a drag at that
-location, it must send the terminal the ``t=o:o=flags`` escape code again, but
-with a payload consisting of the space separated MIME types it offers. The
-``flags`` indicate what types of operations the client supports, ``1`` for
-copy, ``2`` for move and ``3`` for either. The transmission should be chunked
-if the list of MIME types is too long. Note that at this time the drag
-operation has not actually started, this gives the terminal program the
-opportunity to pre-send some data or set one or more images to act as
-thumbnails for the drag operation. If the list of MIME types is too long the
-terminal may cancel the operation by responding with ``t=E ; EFBIG`` or ``t=E ;
-ENOMEM``.
-
-If at the time the terminal receives this request the drag gesture has already
-been terminated or the terminal otherwise determines that it is not appropriate
-to start the drag, it must reply with ``t=E ; EPERM`` to indicate the drag
-offer was not accepted.
-
-For some well known types like ``text/plain`` or ``text/uri-list`` the
-terminal program should pre-send the data for them unless it is very large.
-This is because some platforms, such as macOS, need pre sent data to be able
-to interoperate with native programs. The terminal emulator should reply with
-``t=E ; EFBIG`` if too much data is sent and cancel the drag. Terminals must
-accept at least 64MB of pre sent data.
-
-Pre sent data is sent with escape codes of the form::
-
-    OSC _dnd_code ; t=p:x=idx ; base64 encoded data ST
-
-Here ``idx`` is the zero based index into the list of previously sent MIME
-types indicating this data is for that MIME type. Transmission should be chunked
-using the ``m`` key. End of data is indicated by sending the escape code with no
-payload and ``m=0``. Terminal programs should pre-read this data and only send
-the ``t=o`` key indicating the offer if the data is available.
-
-To associate one or more images with the drag operation, the terminal program
-must transmit the data for the image with the ``idx`` value above being a
-negative number starting with ``-1`` for the first image and so on. Clients
-**must** transmit all images consecutively in order, starting with the first,
-then the second and so on. When transmitting images, the image data format is
-specified using the ``y`` key. A value of ``y=24`` mean 24bit RGB data and
-``y=32`` means 32bit RGBA data. Colors in the RGB/A data must be in the sRGB
-color space. Using ``y=100`` means the data is a PNG image. Using ``y=0`` means
-the payload is UTF-8 base64 encoded text. The terminal will render the text to
-display the image. Additionally, the ``X`` and ``Y`` keys must be used to
-specify the width and height of the image data in pixels. If the size of the
-transmitted data does not match the image dimensions the terminal must replay
-with ``t=E ; EINVAL``. When using ``y=0`` the ``X`` and ``Y`` keys specify the
-text size as ``base_font_size * X/Y``. Where ``base_font_size`` is the normal
-font size the terminal uses for text. Note that terminals **may** ignore
-newlines and render all text on a single line so client programs should not
-send too much text. The ``o`` key is used to specify if the background the
-text is drawn on is transparent or not. ``o=0`` means transparent and ``o=1024``
-means fully opaque. In other words background opacity is ``o/1024``.
-This is particularly useful when drawing a Unicode symbol as the icon for the drag.
-
-Terminals are free to impose a limit on the amount of image data, to avoid
-Denial-of-service attacks. If the image data is too much or the image is too
-large they must reply with ``t=E ; EFBIG`` and abort the drag. By default, the
-drag will be started using the first image, if any. During the drag, the
-terminal program can change the image by sending::
-
-    OSC _dnd_code ; t=P:x=idx ST
-
-Where ``idx`` is now a zero based index with zero being the first image and so on.
-Sending an ``idx`` out of bounds means the drag image should be removed.
-
-Once the terminal program has sent all data and images for the drag
-operation, it indicates the drag should be started by sending ``t=P:x=-1``. At
-this time if the user has already cancelled the drag or the terminal determines
-the drag operation is not allowed, it must respond with ``t=E ; EPERM``. If any
-other error occurs starting the drag operation, it must respond with the appropriate
-POSIX error name and optional error description. If it determines that the image data after conversion to
-display format is too large, it must respond with ``t=E ; EFBIG``. If the drag
-operation is successfully started, it must respond with ``t=E ; OK``.
-
-As the drag progresses, status changes are reported using the ``t=e`` escape
-code. The variants are listed in the table below:
-
-.. list-table:: Drag offer events
-
-   * - Code
-     - Description
-   * - ``t=e : x=1 : y=idx``
-     - The drag has been accepted by a client. ``idx`` is a zero based index into the list of MIME types
-       pointing to the MIME type the client is likely to want
-   * - ``t=e : x=2 : o=O``
-     - The action the client is likely to perform has changed to the value indicated by the ``o`` key
-   * - ``t=e : x=3``
-     - The drag offer has been dropped onto a client, there are likely to be requests for data in the near future
-   * - ``t=e : x=4 : y=0 or 1``
-     - The drag is finished. If ``y=1`` then the drag was canceled by the user.
-   * - ``t=e : x=5 : y=idx``
-     - Request data for the MIME type at the zero based index ``idx`` in the list of MIME types
-
-The client program should respond to data requests with escape codes of the
-form::
-
-    OSC _dnd_code ; t=e:y=idx:m=0 or 1 ; base64 encoded data ST
-
-This, is the data for the MIME type identified by ``idx`` which is a zero based
-index into the list of MIME types. The data should be chunked using the
-``m`` key. End of data is denoted by ``m=0`` and an empty payload. If an error
-occurs the client should send::
-
-    OSC _dnd_code ; t=E:y=idx ; POSIX error name:optional description ST
-
-Where ``POSIX error name`` is a POSIX symbolic error name such as ``ENOENT``
-if the MIME type is not found or ``EIO`` if an IO error occurred and so on. The
-description is optional and must contain only :ref:`safe_utf8`.
-
-If the client wants to cancel the full drag at any time, it should send::
-
-    OSC _dnd_code ; t=E:y=-1 ST
-
-If ``t=e`` or ``t=E`` escape codes are sent to the terminal before the drag is
-started and the terminal has responded with ``t=E ; OK``, the terminal must respond
-with ``t=E ; EINVAL`` and abort the drag.
-
-Dragging to remote machines
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To support dragging to remote machines, first of all clients **must** pre-send
-the data for the ``text/uri-list`` MIME type. All ``file://`` URLs that point
-to directories **must** end with a ``/``. Then, terminals can
-examine the :ref:`machine_id` sent with the enable drag offers
-``t=o`` escape code to decide whether to request data for ``file://`` entries
-from the URI list. To request data for a particular entry, terminals send an
-escape code of the form::
-
-    OSC _dnd_code ; t=k:x=idx ST
-
-Here ``idx`` is the one based index into the list of entries in the
-``text/uri-list`` MIME type. Then the client can respond with the data
-for that entry with an escape code of the form::
-
-    OSC _dnd_code ; t=k:x=idx:m=0 or 1 ; base64 encoded file data ST
-    OSC _dnd_code ; t=k:x=idx:X=1:m=0 or 1 ; base64 encoded symlink target ST
-    OSC _dnd_code ; t=k:x=idx:X=handle:m=0 or 1 ; base64 encoded null separated list of directory entries ST
-
-These represent possibly chunked data for files, symlinks and directories, as
-denoted by the ``X`` key. As above, end of data for an individual entry is
-indicated by an escape code with ``m=0`` and no payload. ``idx`` is the one
-based index into the list of entries in the ``text/uri-list`` MIME type.
-Only regular files, symlinks and directories should be sent. Terminals may send
-multiple requests before the data for the first request is received. Client
-programs should queue the requests and handle them in FIFO order.
-
-Every directory must be transmitted with ``X=handle``. The payload
-is a null separated list of regular files, directories and symlinks in the
-directory. ``handle`` is an integer other than ``0`` or ``1``
-that serves as an identifier for the directory. Directories should be traversed
-in breadth first order. The children of a directory are sent by
-adding ``Y=parent-handle:y=num`` to the escape codes above. Here
-``parent-handle`` is the handle of the directory being traversed and ``num``
-is the one based index into the list of entries in the directory. Thus, the
-set of keys ``x, y, Y`` uniquely determine an entry. Clients **must** send all
-children of directories, recursively, terminals **must not** make requests
-for children of directories, only for the entries from the ``text/uri-list``.
-
-If any error occurs in the client while reading the data, it can inform
-the terminal using::
-
-    OSC _dnd_code ; t=E ; POSIX error name:optional description ST
-
-The terminal must then abort the drag.
-
-Terminals are free to impose resource limits on how much data they accept,
-if a limit is breached or some errors occurs, they can abort the drag and
-inform the client of it with::
-
-    OSC _dnd_code ; t=E ; POSIX error name:optional description ST
-
-The error code for too many resources is ``EMFILE``,
-for IO errors is ``EIO`` and so on.
-
-Detecting support for this protocol
--------------------------------------
-
-Clients can query the terminal emulator for support of this protocol
-using::
-
-    OSC _dnd_code ; t=q:i=optional ST
-
-The ``i`` key is optional, if present it will be echoed back in the responses
-from the terminal. A terminal supporting this protocol **must** respond with::
-
-    OSC _dnd_code ; t=q:i=echoed ; payload ST
-
-Here, ``payload`` is a colon separated list of ``key=value`` pairs. These
-specify support for optional/future parts of this protocol. Currently the
-payload is empty, but that might change as the protocol evolves.
-
-The client should send these escape codes followed by a request for the `primary device
-attributes <https://vt100.net/docs/vt510-rm/DA1.html>`_. If a response for the
-device attributes is received before a response for the queries, then the
-terminal does not support this protocol.
-
-Multiplexers
------------------
-
-To support multiplexers, the ``i`` key exists. When the terminal receives a
-``t=a`` or ``t=o`` escape code that has the ``i`` key set, all escape codes it
-sends to the terminal program must include the ``i`` key with the same value.
-This allows terminal multiplexers to direct the response codes to the correct
-client.
-
-Metadata reference
----------------------------
-
-The table below shows all the metadata keys as well as what values they can
-take, and the default value they take when missing. All integers are 32-bit.
-
-=======  ====================  =========  =================
-Key      Value                 Default    Description
-=======  ====================  =========  =================
-``t``    Single character.     ``a``      The type of drag and drop event.
-         ``(a, A,                         ``a`` - start accepting drops
-         )``                              ``A`` - stop accepting drops
-                                          ``m`` - a drop move event
-                                          ``M`` - a drop dropped event
-                                          ``r`` - request dropped data
-                                          ``R`` - report an error
-                                          ``o`` - start offering drags or start a drag
-                                          ``p`` - present data for drag offers
-                                          ``P`` - Change drag image or start drag
-                                          ``e`` - a drag offer event occurred
-                                          ``E`` - a drag offer data error occurred
-                                          ``k`` - data for uri-list items in drag offer
-                                          ``q`` - query support for this protocol
-
-``m``    Chunking indicator    ``0``      ``0`` or ``1``
-
-``i``    Postive integer       ``0``      This id is for use by multiplexers.
-                                          When it is set, all responses from
-                                          the terminal in that session will
-                                          have it set to the same value.
-
-``o``    Positive integer      ``0``      What drop operation to perform. ``0``
-                                          means rejected, ``1`` means copy and
-                                          ``2`` means move.
-
-**Keys for location**
------------------------------------------------------------
-``x``    Integer               ``0``      Cell x-coordinate origin is 0, 0 at top left of screen
-``y``    Integer               ``0``      Cell y-coordinate origin is 0, 0 at top left of screen
-``X``    Integer               ``0``      Pixel x-coordinate origin is 0, 0 at top left of screen
-``Y``    Integer               ``0``      Pixel y-coordinate origin is 0, 0 at top left of screen
-=======  ====================  =========  =================
-
-
-.. _machine_id:
-
-Machine id
------------------
-
-The machine id is used to detect when the source and destination machines for a
-drag and drop are different. It is of the form: ``version:ASCII printable
-chars``. The leading ``version`` field allows for changing the format or
-semantics of this field in the future. The actual id is the machine id which
-is:
-
-.. tab:: macOS
-
-   The value returned by the ``IOPlatformUUID`` system function.
-
-.. tab:: Windows
-
-   The contents of the :file:`HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Cryptography\\MachineGuid`
-   registry key.
-
-.. tab:: Other
-
-   The contents of the :file:`/etc/machine-id` file with trailing whitespace removed
-
-This machine id is then hashed using a :rfc:`HMAC <2104>` with :rfc:`SHA-256
-<6234>` as the digest algorithm and the key being the ASCII bytes:
-``tty-dnd-protocol-machine-id``. The hashing is done so as to not easily leak
-the actual machine id and to ensure that the value is of fixed size and
-consisting only of ASCII printable characters. This gives a final value of::
-
-    1:hashed machine id hexadecimal encoded
-
-In the future, the ``version`` field may increase if the hashing algorithm is
-changed. If the terminal sees a version it does not understand, it must assume
-that the machine id does not match, aka the source and destination machines are
-different. This assumption means that remote drag and drop will still work, just with
-reduced performance in case of version mismatch.
-
-
-Support in other software
-------------------------------
-
-Currently this protocol is supported in:
-
-  * The kitty terminal emulator and the :doc:`dnd kitten </kittens/dnd>`
-  * The `yazi <https://github.com/sxyazi/yazi/pull/4005>`__ terminal file manager

docs/faq.rst

@@ -23,501 +23,10 @@ these characters are followed by a space or en-space (U+2002) in which case
 kitty makes use of the extra cell to render them in two cells. This behavior
 can be turned off for specific symbols using :opt:`narrow_symbols`.
 
-As of version 0.40 kitty has innovated a :doc:`new protocol
-<text-sizing-protocol>` that allows programs running in the terminal to control
-how many cells a character is rendered in thereby solving the issue of
-character width once and for all.
-
-Similarly, some monospaced font families are buggy and have bold or italic
-faces that have characters wider than the width of the normal face, these
-will also result in clipping. Such issues should be reported to the font
-developer. Monospaced font families must have all their characters rendered
-within a fixed width across all faces of the font, otherwise they aren't really
-monospaced.
-
-
-I get errors about the terminal being unknown or opening the terminal failing or functional keys like arrow keys don't work?
--------------------------------------------------------------------------------------------------------------------------------
-
-These issues all have the same root cause: the kitty terminfo files not being
-available. The most common way this happens is SSHing into a computer that does
-not have the kitty terminfo files. The simplest fix for that is running::
-
-    kitten ssh myserver
-
-It will automatically copy over the terminfo files and also magically enable
-:doc:`shell integration </shell-integration>` on the remote machine.
-
-This :doc:`ssh kitten <kittens/ssh>` takes all the same command line arguments
-as :program:`ssh`, you can alias it to something small in your shell's rc files
-to avoid having to type it each time::
-
-    alias s="kitten ssh"
-
-If this does not work, see :ref:`manual_terminfo_copy` for alternative ways to
-get the kitty terminfo files onto a remote computer.
-
-The next most common reason for this is if you are running commands as root
-using :program:`sudo` or :program:`su`. These programs often filter the
-:envvar:`TERMINFO` environment variable which is what points to the kitty
-terminfo files.
-
-First, make sure the :envvar:`TERM` is set to ``xterm-kitty`` in the sudo
-environment. By default, it should be automatically copied over.
-
-If you are using a well maintained Linux distribution, it will have a
-``kitty-terminfo`` package that you can simply install to make the kitty
-terminfo files available system-wide. Then the problem will no longer occur.
-
-Alternately, you can configure :program:`sudo` to preserve :envvar:`TERMINFO`
-by running ``sudo visudo`` and adding the following line::
-
-    Defaults env_keep += "TERM TERMINFO"
-
-If none of these are suitable for you, you can run sudo as ::
-
-    sudo TERMINFO="$TERMINFO"
-
-This will make :envvar:`TERMINFO` available
-in the sudo environment. Create an alias in your shell rc files to make this
-convenient::
-
-    alias sudo="sudo TERMINFO=\"$TERMINFO\""
-
-If you have double width characters in your prompt, you may also need to
-explicitly set a UTF-8 locale, like::
-
-    export LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
-
-
-I cannot use the key combination X in program Y?
--------------------------------------------------------
-
-First, run::
-
-    kitten show-key -m kitty
-
-Press the key combination X. If the kitten reports the key press
-that means kitty is correctly sending the key press to terminal programs.
-You need to report the issue to the developer of the terminal program. Most
-likely they have not added support for :doc:`/keyboard-protocol`.
-
-If the kitten does not report it, it means that the key is bound to some action
-in kitty. You can unbind it in :file:`kitty.conf` with:
-
-.. code-block:: conf
-
-   map X no_op
-
-Here X is the keys you press on the keyboard. So for example
-:kbd:`ctrl+shift+1`.
-
-
-How do I change the colors in a running kitty instance?
-------------------------------------------------------------
-
-The easiest way to do it is to use the :doc:`themes kitten </kittens/themes>`,
-to choose a new color theme. Simply run::
-
-    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
-
-Or you can enable :doc:`remote control <remote-control>` for |kitty| and use
-:ref:`at-set-colors`. The shortcut mapping technique has the same syntax as the
-remote control command, for details, see :ref:`at-set-colors`.
-
-To change colors when SSHing into a remote host, use the :opt:`color_scheme
-<kitten-ssh.color_scheme>` setting for the :doc:`ssh kitten <kittens/ssh>`.
-
-Additionally, you can use the escape code described in :doc:`color-stack`
-to set colors in a single window.
-Examples of using OSC escape codes to set colors::
-
-    Change the default foreground color:
-    printf '\x1b]21;foreground=#ff0000\x1b\\'
-    Change the default background color:
-    printf '\x1b]21;background=blue\x1b\\'
-    Change the cursor color:
-    printf '\x1b]21;cursor=blue\x1b\\'
-    Change the selection background color:
-    printf '\x1b]21;selection_background=blue\x1b\\'
-    Change the selection foreground color:
-    printf '\x1b]21;selection_foreground=blue\x1b\\'
-    Change the nth color (0 - 255):
-    printf '\x1b]21;n=green\x1b\\'
-
-See :doc:`color-stack` for details on the syntax for specifying colors and
-how to query current colors.
-
-
-Why is there padding between the text area and the window border?
-------------------------------------------------------------------
-
-Terminal screens are a grid of fixed size cells. When the window size is
-not an exact multiple of the cell size, there is some leftover space that
-appears as padding. Additionally you can add your own padding with
-:opt:`window_padding_width`. This padding can be particularly noticeable when
-using TUI programs that have a background color different from the terminal
-background color. In such cases either change their background color to match
-the terminal or more correctly, open a bug report against such programs and ask
-them to :doc:`change the terminal default background color <color-stack>`
-using OSC escape codes when starting and restore it when quitting to have it work automatically.
-
-How do I specify command line options for kitty on macOS?
----------------------------------------------------------------
-
-Apple does not want you to use command line options with GUI applications. To
-workaround that limitation, |kitty| will read command line options from the file
-:file:`<kitty config dir>/macos-launch-services-cmdline` when it is launched
-from the GUI, i.e. by clicking the |kitty| application icon or using
-``open -a kitty``. Note that this file is *only read* when running via the GUI.
-The contents of the file are assumed to be the command line to pass to kitty in
-shell syntax, for example::
-
-    --single-instance --override background=red
-
-You can, of course, also run |kitty| from a terminal with command line options,
-using: :file:`/Applications/kitty.app/Contents/MacOS/kitty`.
-
-And within |kitty| itself, you can always run |kitty| using just ``kitty`` as it
-cleverly adds itself to the :envvar:`PATH`.
-
-
-I catted a binary file and now kitty is hung?
------------------------------------------------
-
-**Never** output unknown binary data directly into a terminal.
-
-Terminals have a single channel for both data and control. Certain bytes
-are control codes. Some of these control codes are of arbitrary length, so if
-the binary data you output into the terminal happens to contain the starting
-sequence for one of these control codes, the terminal will hang waiting for the
-closing sequence. Press :sc:`reset_terminal` to reset the terminal.
-
-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, 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 Fonts
-   <https://nerdfonts.com/>`__ symbols, don't do that as patching destroys
-   fonts. There is no need, kitty has a builtin NERD font and will use it for
-   symbols not found in any other font on your system.
-   If you have patched fonts on your system they might be used instead for NERD
-   symbols, so to force kitty to use the pure NERD font for NERD symbols,
-   add the following line to :file:`kitty.conf`::
-
-        # Nerd Fonts v3.4.0
-
-        symbol_map U+e000-U+e00a,U+e0a0-U+e0a2,U+e0a3,U+e0b0-U+e0b3,U+e0b4-U+e0c8,U+e0ca,U+e0cc-U+e0d7,U+e200-U+e2a9,U+e300-U+e3e3,U+e5fa-U+e6b7,U+e700-U+e8ef,U+ea60-U+ec1e,U+ed00-U+efce,U+f000-U+f2ff,U+f300-U+f381,U+f400-U+f533,U+f0001-U+f1af0 Symbols Nerd Font Mono
-
-   Those Unicode symbols not in the `Unicode private use areas
-   <https://en.wikipedia.org/wiki/Private_Use_Areas>`__ are
-   not included.
-
-If your font is not listed in ``kitten choose-fonts`` it means that it is not
-monospace or is a bitmapped font. On Linux you can list all monospace fonts
-with::
-
-    fc-list : family spacing outline scalable | grep -e spacing=100 -e spacing=90 | grep -e outline=True | grep -e scalable=True
-
-On macOS, you can open *Font Book* and look in the :guilabel:`Fixed width`
-collection to see all monospaced fonts on your system.
-
-Note that **on Linux**, the spacing property is calculated by fontconfig based on actual glyph
-widths in the font. If for some reason fontconfig concludes your favorite
-monospace font does not have ``spacing=100`` you can override it by using the
-following :file:`~/.config/fontconfig/fonts.conf`::
-
-    <?xml version="1.0"?>
-    <!DOCTYPE fontconfig SYSTEM "fonts.dtd">
-    <fontconfig>
-    <match target="scan">
-        <test name="family">
-            <string>Your Font Family Name</string>
-        </test>
-        <edit name="spacing">
-            <int>100</int>
-        </edit>
-    </match>
-    </fontconfig>
-
-After creating (or modifying) this file, you may need to run the following
-command to rebuild your fontconfig cache::
-
-    fc-cache -r
-
-Then, the font will be available in ``kitten choose-fonts``.
-
-
-How can I assign a single global shortcut to bring up the kitty terminal?
------------------------------------------------------------------------------
-
-Use the :ref:`panel kitten <quake>`, this allows you to use kitty as a quick
-access Quake like terminal and even to use kitty as the desktop background, if
-so desired.
-
-
-I do not like the kitty icon!
--------------------------------
-
-The kitty icon was created as tribute to my cat of nine years who passed away,
-as such it is not going to change. However, if you do not like it, there are
-many alternate icons available, click on an icon to visit its homepage:
-
-.. image:: https://github.com/k0nserv/kitty-icon/raw/main/kitty.iconset/icon_256x256.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
-
-.. image:: https://github.com/igrmk/whiskers/raw/main/whiskers.svg
-   :target: https://github.com/igrmk/whiskers
-   :width: 256
-
-.. image:: https://github.com/samholmes/whiskers/raw/main/whiskers.png
-   :target: https://github.com/samholmes/whiskers
-   :width: 256
-
-.. image:: https://github.com/user-attachments/assets/a37d7830-4a8c-45a8-988a-3e98a41ea541
-   :target: https://github.com/diegobit/kitty-icon
-   :width: 256
-
-.. image:: https://github.com/eccentric-j/eccentric-icons/raw/main/icons/kitty-terminal/2d/kitty-preview.png
-   :target: https://github.com/eccentric-j/eccentric-icons
-   :width: 256
-
-.. image:: https://github.com/eccentric-j/eccentric-icons/raw/main/icons/kitty-terminal/3d/kitty-preview.png
-   :target: https://github.com/eccentric-j/eccentric-icons
-   :width: 256
-
-.. image:: https://github.com/sodapopcan/kitty-icon/raw/main/kitty.app.png
-   :target: https://github.com/sodapopcan/kitty-icon
-   :width: 256
-
-.. image:: https://github.com/sfsam/some_icons/raw/main/kitty.app.iconset/icon_128x128@2x.png
-   :target: https://github.com/sfsam/some_icons
-   :width: 256
-
-.. image:: https://github.com/igrmk/twiskers/raw/main/icon/twiskers.svg
-   :target: https://github.com/igrmk/twiskers
-   :width: 256
-
-.. image:: https://github.com/mtklr/kitty-nyan-icon/raw/main/kitty-nyan.svg
-   :target: https://github.com/mtklr/kitty-nyan-icon
-   :width: 256
-
-You can put :file:`kitty.app.icns` (macOS only) or :file:`kitty.app.png` in the
-:ref:`kitty configuration directory <confloc>`, and this icon will be applied
-automatically at startup. On X11 and Wayland, this will set the icon for kitty windows.
-Note that not all Wayland compositors support the `protocol needed <https://wayland.app/protocols/xdg-toplevel-icon-v1>`__
-for changing window icons.
-
-Unfortunately, on macOS, Apple's Dock does not change its cached icon so the
-custom icon will revert when kitty is quit. Run the following to force the Dock
-to update its cached icons:
-
-.. code-block:: sh
-
-    rm /var/folders/*/*/*/com.apple.dock.iconcache; killall Dock
-
-If you prefer not to keep a custom icon in the kitty config folder, on macOS, you can
-also set it with the following command:
-
-.. code-block:: sh
-
-    # Set kitty.icns as the icon for currently running kitty
-    kitty +runpy 'from kitty.fast_data_types import cocoa_set_app_icon; import sys; cocoa_set_app_icon(*sys.argv[1:]); print("OK")' kitty.icns
-
-    # Set the icon for app bundle specified by the path
-    kitty +runpy 'from kitty.fast_data_types import cocoa_set_app_icon; import sys; cocoa_set_app_icon(*sys.argv[1:]); print("OK")' /path/to/icon.png /Applications/kitty.app
-
-You can also change the icon manually by following the steps:
-
-.. tab:: macOS
-
-    #. 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
-
-.. tab:: Linux
-
-   #. Copy :file:`kitty.desktop` from the installation location (usually
-      :file:`/usr/share/applications` to :file:`~/.local/share/applications`
-   #. Edit the copied desktop file changing the ``Icon`` line to have
-      the absolute path to your desired icon.
-
-
-How do I map key presses in kitty to different keys in the terminal program?
---------------------------------------------------------------------------------------
-
-This is accomplished by using ``map`` with :ac:`send_key` in :file:`kitty.conf`.
-For example::
-
-    map alt+s send_key ctrl+s
-    map ctrl+alt+2 combine : send_key ctrl+c : send_key h : send_key a
-
-This causes the program running in kitty to receive the :kbd:`ctrl+s` key when
-you press the :kbd:`alt+s` key and several keystrokes when you press
-:kbd:`ctrl+alt+2`. To see this in action, run::
-
-    kitten show-key -m kitty
-
-Which will print out what key events it receives. To send arbitrary text rather
-than a key press, see :sc:`send_text <send_text>` instead.
-
-
-How do I open a new window or tab with the same working directory as the current window?
---------------------------------------------------------------------------------------------
-
-In :file:`kitty.conf` add the following::
-
-    map f1 launch --cwd=current
-    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,
-explore :doc:`its documentation <launch>`.
-
-
-Things behave differently when running kitty from system launcher vs. from another terminal?
------------------------------------------------------------------------------------------------
-
-This will be because of environment variables. When you run kitty from the
-system launcher, it gets a default set of system environment variables. When
-you run kitty from another terminal, you are actually running it from a shell,
-and the shell's rc files will have setup a whole different set of environment
-variables which kitty will now inherit.
-
-You need to make sure that the environment variables you define in your shell's
-rc files are either also defined system wide or via the :opt:`env` directive in
-:file:`kitty.conf`. Common environment variables that cause issues are those
-related to localization, such as :envvar:`LANG`, ``LC_*`` and loading of
-configuration files such as ``XDG_*``, :envvar:`KITTY_CONFIG_DIRECTORY` and,
-most importantly, ``PATH`` to locate binaries.
-
-The simplest way to fix this is to have kitty load the environment variables
-from your shell configuration at startup using the :opt:`env` directive,
-adding the following to :file:`kitty.conf`::
-
-    env read_from_shell=PATH LANG LC_* XDG_* EDITOR VISUAL
-
-This works for POSIX compliant shells and the fish shell. Note that it
-does add significantly to kitty startup time, so use only if really necessary.
-This feature was added in version ``0.43.2``.
-
-To see the environment variables that kitty sees, you can add the following
-mapping to :file:`kitty.conf`::
-
-    map f1 show_kitty_env_vars
-
-then pressing :kbd:`F1` will show you the environment variables kitty sees.
-
-This problem is most common on macOS, as Apple makes it exceedingly difficult to
-setup environment variables system-wide, so people end up putting them in all
-sorts of places where they may or may not work.
-
-
-I am using tmux/zellij and have a problem
-----------------------------------------------
-
-First, terminal multiplexers are :iss:`a bad idea <391#issuecomment-638320745>`,
-do not use them, if at all possible. kitty contains features that do all of what
-tmux does, but better, with the exception of remote persistence (:iss:`391`).
-If you still want to use tmux, read on.
-
-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 :envvar:`TERM`
-variables, tmux will break. You will need to restart it as tmux does not support
-multiple terminfo definitions.
-
-Displaying images while inside programs such as nvim or ranger may not work
-depending on whether those programs have adopted support for the :ref:`unicode
-placeholders <graphics_unicode_placeholders>` workaround that kitty created
-for tmux refusing to support images.
-
-If you use any of the advanced features that kitty has innovated, such as
-:doc:`styled underlines </underlines>`, :doc:`desktop notifications
-</desktop-notifications>`, :doc:`variable sized text </text-sizing-protocol>`,
-:doc:`extended keyboard support </keyboard-protocol>`,
-:doc:`file transfer </kittens/transfer>`, :doc:`the ssh kitten </kittens/ssh>`,
-:doc:`shell integration </shell-integration>` etc. they may or may not work,
-depending on the whims of tmux's maintainer, your version of tmux, etc.
-
-
-I opened and closed a lot of windows/tabs and top shows kitty's memory usage is very high?
--------------------------------------------------------------------------------------------
-
-:program:`top` is not a good way to measure process memory usage. That is
-because on modern systems, when allocating memory to a process, the C library
-functions will typically allocate memory in large blocks, and give the process
-chunks of these blocks. When the process frees a chunk, the C library will not
-necessarily release the underlying block back to the OS. So even though the
-application has released the memory, :program:`top` will still claim the process
-is using it.
-
-To check for memory leaks, instead use a tool like `Valgrind
-<https://valgrind.org/>`__. Run::
-
-    PYTHONMALLOC=malloc valgrind --tool=massif kitty
-
-Now open lots of tabs/windows, generate lots of output using tools like find/yes
-etc. Then close all but one window. Do some random work for a few seconds in
-that window, maybe run yes or find again. Then quit kitty and run::
-
-    massif-visualizer massif.out.*
-
-You will see the allocations graph goes up when you opened the windows, then
-goes back down when you closed them, indicating there were no memory leaks.
-
-For those interested, you can get a similar profile out of :program:`valgrind`
-as you get with :program:`top` by adding ``--pages-as-heap=yes`` then you will
-see that memory allocated in malloc is not freed in free. This can be further
-refined if you use ``glibc`` as your C library by setting the environment
-variable ``MALLOC_MMAP_THRESHOLD_=64``. This will cause free to actually free
-memory allocated in sizes of more than 64 bytes. With this set, memory usage
-will climb high, then fall when closing windows, but not fall all the way back.
-The 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 don't release it back
-to the OS immediately.
-
 
 Using a color theme with a background color does not work well in vim?
 -----------------------------------------------------------------------
 
-First, be sure to `use a color scheme in vim <https://github.com/kovidgoyal/kitty/discussions/8196#discussioncomment-11739991>`__
-instead of relying on the terminal theme. Otherwise, background and text selection colours
-may be difficult to read.
-
 Sadly, vim has very poor out-of-the-box detection for modern terminal features.
 Furthermore, it `recently broke detection even more <https://github.com/vim/vim/issues/11729>`__.
 It kind of, but not really, supports terminfo, except it overrides it with its own hard-coded
@@ -583,6 +92,421 @@ These settings must be placed **before** setting the ``colorscheme``. It is
 also important that the value of the vim ``term`` variable is not changed
 after these settings.
 
+I get errors about the terminal being unknown or opening the terminal failing or functional keys like arrow keys don't work?
+-------------------------------------------------------------------------------------------------------------------------------
+
+These issues all have the same root cause: the kitty terminfo files not being
+available. The most common way this happens is SSHing into a computer that does
+not have the kitty terminfo files. The simplest fix for that is running::
+
+    kitten ssh myserver
+
+It will automatically copy over the terminfo files and also magically enable
+:doc:`shell integration </shell-integration>` on the remote machine.
+
+This :doc:`ssh kitten <kittens/ssh>` takes all the same command line arguments
+as :program:`ssh`, you can alias it to something small in your shell's rc files
+to avoid having to type it each time::
+
+    alias s="kitten ssh"
+
+If this does not work, see :ref:`manual_terminfo_copy` for alternative ways to
+get the kitty terminfo files onto a remote computer.
+
+The next most common reason for this is if you are running commands as root
+using :program:`sudo` or :program:`su`. These programs often filter the
+:envvar:`TERMINFO` environment variable which is what points to the kitty
+terminfo files.
+
+First, make sure the :envvar:`TERM` is set to ``xterm-kitty`` in the sudo
+environment. By default, it should be automatically copied over.
+
+If you are using a well maintained Linux distribution, it will have a
+``kitty-terminfo`` package that you can simply install to make the kitty
+terminfo files available system-wide. Then the problem will no longer occur.
+
+Alternately, you can configure :program:`sudo` to preserve :envvar:`TERMINFO`
+by running ``sudo visudo`` and adding the following line::
+
+    Defaults env_keep += "TERM TERMINFO"
+
+If none of these are suitable for you, you can run sudo as ::
+
+    sudo TERMINFO="$TERMINFO"
+
+This will make :envvar:`TERMINFO` available
+in the sudo environment. Create an alias in your shell rc files to make this
+convenient::
+
+    alias sudo="sudo TERMINFO=\"$TERMINFO\""
+
+If you have double width characters in your prompt, you may also need to
+explicitly set a UTF-8 locale, like::
+
+    export LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
+
+
+I cannot use the key combination X in program Y?
+-------------------------------------------------------
+
+First, run::
+
+    kitten show_key -m kitty
+
+Press the key combination X. If the kitten reports the key press
+that means kitty is correctly sending the key press to terminal programs.
+You need to report the issue to the developer of the terminal program. Most
+likely they have not added support for :doc:`/keyboard-protocol`.
+
+If the kitten does not report it, it means that the key is bound to some action
+in kitty. You can unbind it in :file:`kitty.conf` with:
+
+.. code-block:: conf
+
+   map X no_op
+
+Here X is the keys you press on the keyboard. So for example
+:kbd:`ctrl+shift+1`.
+
+
+How do I change the colors in a running kitty instance?
+------------------------------------------------------------
+
+The easiest way to do it is to use the :doc:`themes kitten </kittens/themes>`,
+to choose a new color theme. Simply run::
+
+    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
+
+Or you can enable :doc:`remote control <remote-control>` for |kitty| and use
+:ref:`at-set-colors`. The shortcut mapping technique has the same syntax as the
+remote control command, for details, see :ref:`at-set-colors`.
+
+To change colors when SSHing into a remote host, use the :opt:`color_scheme
+<kitten-ssh.color_scheme>` setting for the :doc:`ssh kitten <kittens/ssh>`.
+
+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\\'
+    Change the default background color:
+    printf '\x1b]11;blue\x1b\\'
+    Change the cursor color:
+    printf '\x1b]12;blue\x1b\\'
+    Change the selection background color:
+    printf '\x1b]17;blue\x1b\\'
+    Change the selection foreground color:
+    printf '\x1b]19;blue\x1b\\'
+    Change the nth color (0 - 255):
+    printf '\x1b]4;n;green\x1b\\'
+
+You can use various syntaxes/names for color specifications in the above
+examples. See `XParseColor <https://linux.die.net/man/3/xparsecolor>`__
+for full details.
+
+If a ``?`` is given rather than a color specification, kitty will respond
+with the current value for the specified color.
+
+
+How do I specify command line options for kitty on macOS?
+---------------------------------------------------------------
+
+Apple does not want you to use command line options with GUI applications. To
+workaround that limitation, |kitty| will read command line options from the file
+:file:`<kitty config dir>/macos-launch-services-cmdline` when it is launched
+from the GUI, i.e. by clicking the |kitty| application icon or using
+``open -a kitty``. Note that this file is *only read* when running via the GUI.
+
+You can, of course, also run |kitty| from a terminal with command line options,
+using: :file:`/Applications/kitty.app/Contents/MacOS/kitty`.
+
+And within |kitty| itself, you can always run |kitty| using just ``kitty`` as it
+cleverly adds itself to the :envvar:`PATH`.
+
+
+I catted a binary file and now kitty is hung?
+-----------------------------------------------
+
+**Never** output unknown binary data directly into a terminal.
+
+Terminals have a single channel for both data and control. Certain bytes
+are control codes. Some of these control codes are of arbitrary length, so if
+the binary data you output into the terminal happens to contain the starting
+sequence for one of these control codes, the terminal will hang waiting for the
+closing sequence. Press :sc:`reset_terminal` to reset the terminal.
+
+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, 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 Fonts
+   <https://nerdfonts.com/>`__ symbols, don't do that as patching destroys
+   fonts. There is no need, simply install the standalone ``Symbols Nerd Font Mono``
+   (the file :file:`NerdFontsSymbolsOnly.zip` from the `Nerd Fonts releases page
+   <https://github.com/ryanoasis/nerd-fonts/releases>`__). kitty should pick up
+   symbols from it automatically, and you can tell it to do so explicitly in
+   case it doesn't with the :opt:`symbol_map` directive::
+
+        # Nerd Fonts v3.1.0
+
+        symbol_map U+e000-U+e00a,U+ea60-U+ebeb,U+e0a0-U+e0c8,U+e0ca,U+e0cc-U+e0d4,U+e200-U+e2a9,U+e300-U+e3e3,U+e5fa-U+e6b1,U+e700-U+e7c5,U+f000-U+f2e0,U+f300-f372,U+f400-U+f532,U+f0001-U+f1af0 Symbols Nerd Font Mono
+
+   Those Unicode symbols not in the `Unicode private use areas
+   <https://en.wikipedia.org/wiki/Private_Use_Areas>`__ are
+   not included.
+
+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::
+
+    fc-list : family spacing outline scalable | grep -e spacing=100 -e spacing=90 | grep -e outline=True | grep -e scalable=True
+
+Note that the spacing property is calculated by fontconfig based on actual glyph
+widths in the font. If for some reason fontconfig concludes your favorite
+monospace font does not have ``spacing=100`` you can override it by using the
+following :file:`~/.config/fontconfig/fonts.conf`::
+
+    <?xml version="1.0"?>
+    <!DOCTYPE fontconfig SYSTEM "fonts.dtd">
+    <fontconfig>
+    <match target="scan">
+        <test name="family">
+            <string>Your Font Family Name</string>
+        </test>
+        <edit name="spacing">
+            <int>100</int>
+        </edit>
+    </match>
+    </fontconfig>
+
+After creating (or modifying) this file, you may need to run the following
+command to rebuild your fontconfig cache::
+
+    fc-cache -r
+
+Then, the font will be available in ``kitty +list-fonts``.
+
+
+How can I assign a single global shortcut to bring up the kitty terminal?
+-----------------------------------------------------------------------------
+
+Bringing up applications on a single key press is the job of the window
+manager/desktop environment. For ways to do it with kitty (or indeed any
+terminal) in different environments,
+see :iss:`here <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/kitty.iconset/icon_256x256.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
+
+.. image:: https://github.com/igrmk/whiskers/raw/main/whiskers.svg
+   :target: https://github.com/igrmk/whiskers
+   :width: 256
+
+.. image:: https://github.com/samholmes/whiskers/raw/main/whiskers.png
+   :target: https://github.com/samholmes/whiskers
+   :width: 256
+
+.. image:: https://github.com/eccentric-j/eccentric-icons/raw/main/icons/kitty-terminal/2d/kitty-preview.png
+   :target: https://github.com/eccentric-j/eccentric-icons
+   :width: 256
+
+.. image:: https://github.com/eccentric-j/eccentric-icons/raw/main/icons/kitty-terminal/3d/kitty-preview.png
+   :target: https://github.com/eccentric-j/eccentric-icons
+   :width: 256
+
+On macOS and X11 you can put :file:`kitty.app.icns` (macOS only) or :file:`kitty.app.png` in the
+:ref:`kitty configuration directory <confloc>`, and this icon will be applied
+automatically at startup. On X11, this will set the icon for kitty windows.
+
+Unfortunately, on macOS, Apple's Dock does not change its cached icon so the
+custom icon will revert when kitty is quit. Run the following to force the Dock
+to update its cached icons:
+
+.. code-block:: sh
+
+    rm /var/folders/*/*/*/com.apple.dock.iconcache; killall Dock
+
+If you prefer not to keep a custom icon in the kitty config folder, on macOS, you can
+also set it with the following command:
+
+.. code-block:: sh
+
+    # Set kitty.icns as the icon for currently running kitty
+    kitty +runpy 'from kitty.fast_data_types import cocoa_set_app_icon; import sys; cocoa_set_app_icon(*sys.argv[1:]); print("OK")' kitty.icns
+
+    # Set the icon for app bundle specified by the path
+    kitty +runpy 'from kitty.fast_data_types import cocoa_set_app_icon; import sys; cocoa_set_app_icon(*sys.argv[1:]); print("OK")' /path/to/icon.png /Applications/kitty.app
+
+You can also change the icon manually 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:
+
+.. code-block:: sh
+
+    rm /var/folders/*/*/*/com.apple.dock.iconcache; killall Dock
+
+
+How do I map key presses in kitty to different keys in the terminal program?
+--------------------------------------------------------------------------------------
+
+This is accomplished by using ``map`` with :ac:`send_key` in :file:`kitty.conf`.
+For example::
+
+    map alt+s send_key ctrl+s
+
+This causes the program running in kitty to receive the :kbd:`ctrl+s` key when
+you press the :kbd:`alt+s` key. To see this in action, run::
+
+    kitten show-key -m kitty
+
+Which will print out what key events it receives. To send arbitrary text rather
+than a key press, see :sc:`send_text <send_text>` instead.
+
+
+How do I open a new window or tab with the same working directory as the current window?
+--------------------------------------------------------------------------------------------
+
+In :file:`kitty.conf` add the following::
+
+    map f1 launch --cwd=current
+    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,
+explore :doc:`its documentation <launch>`.
+
+
+Things behave differently when running kitty from system launcher vs. from another terminal?
+-----------------------------------------------------------------------------------------------
+
+This will be because of environment variables. When you run kitty from the
+system launcher, it gets a default set of system environment variables. When
+you run kitty from another terminal, you are actually running it from a shell,
+and the shell's rc files will have setup a whole different set of environment
+variables which kitty will now inherit.
+
+You need to make sure that the environment variables you define in your shell's
+rc files are either also defined system wide or via the :opt:`env` directive in
+:file:`kitty.conf`. Common environment variables that cause issues are those
+related to localization, such as :envvar:`LANG`, ``LC_*`` and loading of
+configuration files such as ``XDG_*``, :envvar:`KITTY_CONFIG_DIRECTORY`.
+
+To see the environment variables that kitty sees, you can add the following
+mapping to :file:`kitty.conf`::
+
+    map f1 show_kitty_env_vars
+
+then pressing :kbd:`F1` will show you the environment variables kitty sees.
+
+This problem is most common on macOS, as Apple makes it exceedingly difficult to
+setup environment variables system-wide, so people end up putting them in all
+sorts of places where they may or may not work.
+
+
+I am using tmux and have a problem
+--------------------------------------
+
+First, terminal multiplexers are :iss:`a bad idea <391#issuecomment-638320745>`,
+do not use them, if at all possible. kitty contains features that do all of what
+tmux does, but better, with the exception of remote persistence (:iss:`391`).
+If you still want to use tmux, read on.
+
+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 :envvar:`TERM`
+variables, tmux will break. You will need to restart it as tmux does not support
+multiple terminfo definitions.
+
+Displaying images while inside programs such as nvim or ranger may not work
+depending on whether those programs have adopted support for the :ref:`unicode
+placeholders <graphics_unicode_placeholders>` workaround that kitty created
+for tmux refusing to support images.
+
+If you use any of the advanced features that kitty has innovated, such as
+:doc:`styled underlines </underlines>`, :doc:`desktop notifications
+</desktop-notifications>`, :doc:`extended keyboard support
+</keyboard-protocol>`, :doc:`file transfer </kittens/transfer>`,  etc.
+they may or may not work, depending on the whims of tmux's maintainer,
+your version of tmux, etc.
+
+
+I opened and closed a lot of windows/tabs and top shows kitty's memory usage is very high?
+-------------------------------------------------------------------------------------------
+
+:program:`top` is not a good way to measure process memory usage. That is
+because on modern systems, when allocating memory to a process, the C library
+functions will typically allocate memory in large blocks, and give the process
+chunks of these blocks. When the process frees a chunk, the C library will not
+necessarily release the underlying block back to the OS. So even though the
+application has released the memory, :program:`top` will still claim the process
+is using it.
+
+To check for memory leaks, instead use a tool like `Valgrind
+<https://valgrind.org/>`__. Run::
+
+    PYTHONMALLOC=malloc valgrind --tool=massif kitty
+
+Now open lots of tabs/windows, generate lots of output using tools like find/yes
+etc. Then close all but one window. Do some random work for a few seconds in
+that window, maybe run yes or find again. Then quit kitty and run::
+
+    massif-visualizer massif.out.*
+
+You will see the allocations graph goes up when you opened the windows, then
+goes back down when you closed them, indicating there were no memory leaks.
+
+For those interested, you can get a similar profile out of :program:`valgrind`
+as you get with :program:`top` by adding ``--pages-as-heap=yes`` then you will
+see that memory allocated in malloc is not freed in free. This can be further
+refined if you use ``glibc`` as your C library by setting the environment
+variable ``MALLOC_MMAP_THRESHOLD_=64``. This will cause free to actually free
+memory allocated in sizes of more than 64 bytes. With this set, memory usage
+will climb high, then fall when closing windows, but not fall all the way back.
+The 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 don't release it back
+to the OS immediately.
+
 
 Why does kitty sometimes start slowly on my Linux system?
 -------------------------------------------------------------------------------------------

docs/file-transfer-protocol.rst

@@ -126,8 +126,8 @@ receiving::
     ...
 
 The client must then wait for responses from the terminal emulator. It
-is an error to send anymore commands to the terminal until an ``OK``
-response is received from the terminal. The terminal waits for the user to accept
+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
@@ -245,7 +245,7 @@ File paths
     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
+    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)::

docs/glossary.rst

@@ -50,18 +50,6 @@ Glossary
       inside kitty windows and provide it with lots of powerful and flexible
       features such as viewing images, connecting conveniently to remote
       computers, transferring files, inputting unicode characters, etc.
-      They can also be written by users in Python and used to customize and
-      extend kitty functionality, see :doc:`kittens_intro` for details.
-
-   easing function
-      A function that controls how an animation progresses over time. kitty
-      support the `CSS syntax for easing functions
-      <https://developer.mozilla.org/en-US/docs/Web/CSS/easing-function>`__.
-      Commonly used easing functions are :code:`linear` for a constant rate
-      animation and :code:`ease-in-out` for an animation that starts slow,
-      becomes fast in the middle and ends slowly. These are used to control
-      various animations in kitty, such as :opt:`cursor_blink_interval` and
-      :opt:`visual_bell_duration`.
 
 .. _env_vars:
 
@@ -98,11 +86,6 @@ Variables that influence kitty behavior
 
    Same as :envvar:`VISUAL`. Used if :envvar:`VISUAL` is not set.
 
-.. envvar:: SHELL
-
-   Specifies the default shell kitty will run when :opt:`shell` is set to
-   :code:`.`.
-
 .. envvar:: GLFW_IM_MODULE
 
    Set this to ``ibus`` to enable support for IME under X11.
@@ -224,14 +207,6 @@ Variables that kitty sets when running child programs
    Set when enabling :ref:`shell_integration`. It is automatically removed by
    the shell integration scripts.
 
-.. envvar:: KITTY_SI_RUN_COMMAND_AT_STARTUP
-
-   Set this to an expression that the kitty shell integration scripts will
-   ``eval`` after the shell is started. Note that this environment variable
-   is ignored when present in the environment in which kitty itself is launched
-   in. It is most useful with the ``--env`` flag for the :doc:`launch <launch>`
-   action.
-
 .. envvar:: ZDOTDIR
 
    Set when enabling :ref:`shell_integration` with :program:`zsh`, allowing

docs/graphics-protocol.rst

@@ -25,51 +25,36 @@ alpha-blending and text over graphics.
     :alt: Demo of graphics rendering in kitty
     :align: center
 
-Some applications that use the kitty graphics protocol:
+Some programs and libraries that use the kitty graphics protocol:
 
-* `awrit <https://github.com/chase/awrit>`_ - Chromium-based web browser rendered in Kitty with mouse and keyboard support
-* `blackcat <https://github.com/j-c-m/blackcat>`_ - a modern compatible cat with image support
-* `bicat <https://github.com/stevenxxiu/bicat>`_ - a terminal image viewer that also works in the Vifm file manager, with nested Tmux support
-* `broot <https://dystroy.org/broot/>`_ - a terminal file explorer and manager, with preview of images, SVG, PDF, etc.
-* `chafa <https://github.com/hpjansson/chafa>`_  - a terminal image viewer
-* :doc:`kitty-diff <kittens/diff>` - a side-by-side terminal diff program with support for images
-* `fzf <https://github.com/junegunn/fzf/commit/d8188fce7b7bea982e7f9050c35e488e49fb8fd0>`_ - A command line fuzzy finder
-* `mpv <https://github.com/mpv-player/mpv/commit/874e28f4a41a916bb567a882063dd2589e9234e1>`_ - A video player that can play videos in the terminal
-* `neofetch <https://github.com/dylanaraps/neofetch>`_ - A command line system information tool
-* `nvim <https://github.com/neovim/neovim/issues/30889>`__ - A TUI editor that can display images in the terminal
-* `pixcat <https://github.com/mirukana/pixcat>`_ - a third party CLI and python library that wraps the graphics protocol
-* `ranger <https://github.com/ranger/ranger>`_ - a terminal file manager, with image previews
 * `termpdf.py <https://github.com/dsanson/termpdf.py>`_ - a terminal PDF/DJVU/CBR viewer
-* `timg <https://github.com/hzeller/timg>`_ - a terminal image and video viewer
+* `ranger <https://github.com/ranger/ranger>`_ - a terminal file manager, with image previews
+* :doc:`kitty-diff <kittens/diff>` - a side-by-side terminal diff program with support for images
 * `tpix <https://github.com/jesvedberg/tpix>`_ - a statically compiled binary that can be used to display images and easily installed on remote servers without root access
-* `twitch-tui <https://github.com/Xithrius/twitch-tui>`_ - Twitch chat in the terminal
-* `vat <https://github.com/jzbrooks/vat>`_ - a terminal image viewer for vector graphics, including Android Vector Drawables
+* `mpv <https://github.com/mpv-player/mpv/commit/874e28f4a41a916bb567a882063dd2589e9234e1>`_ - A video player that can play videos in the terminal
+* `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
-* `Yazi <https://github.com/sxyazi/yazi>`_ - Blazing fast terminal file manager written in Rust, based on async I/O
-
-Libraries:
-
 * `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
-* `image.nvim <https://github.com/3rd/image.nvim>`_ - Bringing images to neovim
-* `image_preview.nvim <https://github.com/adelarsq/image_preview.nvim/>`_ - Image preview for neovim
 * `kui.nvim <https://github.com/romgrk/kui.nvim>`_  - Build sophisticated UIs inside neovim using the kitty graphics protocol
-* `kitty-graphics.el <https://github.com/cashmeredev/kitty-graphics.el>`_ - Images in emacs
+* `image.nvim <https://github.com/3rd/image.nvim>`_ - Bringing images to neovim
 * `term-image <https://github.com/AnonymouX47/term-image>`_  - A Python library, CLI and TUI to display and browse images in the terminal
 * `glkitty <https://github.com/michaeljclark/glkitty>`_ - C library to draw OpenGL shaders in the terminal with a glgears demo
+* `twitch-tui <https://github.com/Xithrius/twitch-tui>`_ - Twitch chat in the terminal
+* `awrit <https://github.com/chase/awrit>`_ - Chromium-based web browser rendered in Kitty with mouse and keyboard support
+* `fzf <https://github.com/junegunn/fzf/commit/d8188fce7b7bea982e7f9050c35e488e49fb8fd0>`_ - A command line fuzzy finder
 
 Other terminals that have implemented the graphics protocol:
 
-* `Ghostty <https://ghostty.org>`_
-* `Konsole <https://invent.kde.org/utilities/konsole/-/merge_requests/594>`_
-* `st (with a patch) <https://st.suckless.org/patches/kitty-graphics-protocol>`_
-* `Warp <https://docs.warp.dev/getting-started/changelog#id-2025.03.26-v0.2025.03.26.08.10>`_
-* `wayst <https://github.com/91861/wayst>`_
 * `WezTerm <https://github.com/wez/wezterm/issues/986>`_
-* `iTerm2 <https://github.com/gnachman/iTerm2/commit/4fe5b2173193b6c3e45234b6b2ab7a144a5cfa01>`_
-* `xterm.js <https://github.com/xtermjs/xterm.js/discussions/5683>`_
+* `Konsole <https://invent.kde.org/utilities/konsole/-/merge_requests/594>`_
+* `wayst <https://github.com/91861/wayst>`_
 
 
 Getting the window size
@@ -106,7 +91,7 @@ code to demonstrate its use
         buf = array.array('H', [0, 0, 0, 0])
         fcntl.ioctl(sys.stdout, termios.TIOCGWINSZ, buf)
         print((
-            'number of rows: {} number of columns: {} '
+            'number of rows: {} number of columns: {}'
             'screen width: {} screen height: {}').format(*buf))
 
 .. tab:: Go
@@ -137,30 +122,19 @@ code to demonstrate its use
         }
 
 
-.. tab:: POSIX sh
+.. tab:: Bash
 
     .. code-block:: sh
 
-        #!/bin/sh
+        #!/bin/bash
 
-        read rows cols <<EOF
-        $(command stty size)
-        EOF
+        # This uses the kitten standalone binary from kitty to get the pixel sizes
+        # since we can't do IOCTLs directly. Fortunately, kitten is a static exe
+        # pre-built for every Unix like OS under the sun.
 
-        oldstty=$(command stty -g)
-        command stty raw -echo
-        printf "\033[14t"
-        response=""
-        while : ; do
-            char=$(command dd bs=1 count=1 2>/dev/null)
-            [ "$char" = "t" ] && break
-            response="${response}${char}"
-        done
-        command stty "$oldstty"
-        h=$(echo "$response" | cut -d';' -f2)
-        w=$(echo "$response" | cut -d';' -f3)
-        printf "number of rows: %d number of columns: %d" "$rows" "$cols"
-        printf " screen width: %d screen height: %d\n" "$w" "$h"
+        builtin read -r rows cols < <(command stty size)
+        IFS=x builtin read -r width height < <(command kitten icat --print-window-size); builtin unset IFS
+        builtin echo "number of rows: $rows number of columns: $cols screen width: $width screen height: $height"
 
 
 Note that some terminals return ``0`` for the width and height values. Such
@@ -171,9 +145,7 @@ You can also use the *CSI t* escape code to get the screen size. Send
 ``<ESC>[14t`` to ``STDOUT`` and kitty will reply on ``STDIN`` with
 ``<ESC>[4;<height>;<width>t`` where ``height`` and ``width`` are the window
 size in pixels. This escape code is supported in many terminals, not just
-kitty. A more precise version of this escape code, which is however supported
-in less terminals is ``<ESC>[16t`` which causes the terminal to reply with the
-pixel dimensions of a single cell.
+kitty.
 
 A minimal example
 ------------------
@@ -181,55 +153,61 @@ A minimal example
 Some minimal code to display PNG images in kitty, using the most basic
 features of the graphics protocol:
 
-.. tab:: POSIX sh
+.. tab:: Bash
 
     .. code-block:: sh
 
-        #!/bin/sh
-
-        send_chunked() {
-            first="y"
-            while IFS= read -r chunk; do
-                metadata=""; [ "$first" = "y" ] && { metadata="a=T,f=100,"; first="n"; }
-                printf "\033_G%sm=1;%s\033\\" "${metadata}" "${chunk}"
-            done
-            [ "$first" = "n" ] && { printf "\033_Gm=0;\033\\"; return 0; }
-            return 1
-        }
-
+        #!/bin/bash
         transmit_png() {
-            # Different systems have different or missing base64 executables.
-            # The sed command below adds a trailing newline which openssl
-            # base64 does not produce and is needed for reading via read -r
-            { command base64 -w 4096 "$1" 2>/dev/null | send_chunked; } || \
-            { command base64 -b 4096 "$1" 2>/dev/null | send_chunked; } || \
-            { command openssl base64 -e -A -in "$1" | command sed '$a\' | command fold -b -w 4096 | send_chunked; }
+            data=$(base64 "$1")
+            data="${data//[[:space:]]}"
+            builtin local pos=0
+            builtin local chunk_size=4096
+            while [ $pos -lt ${#data} ]; do
+                builtin printf "\e_G"
+                [ $pos = "0" ] && printf "a=T,f=100,"
+                builtin local chunk="${data:$pos:$chunk_size}"
+                pos=$(($pos+$chunk_size))
+                [ $pos -lt ${#data} ] && builtin printf "m=1"
+                [ ${#chunk} -gt 0 ] && builtin printf ";%s" "${chunk}"
+                builtin printf "\e\\"
+            done
         }
 
         transmit_png "$1"
 
-
 .. tab:: Python
 
     .. code-block:: python
 
-        #!/usr/bin/env python
+        #!/usr/bin/python
         import sys
         from base64 import standard_b64encode
 
-        first, eof, buf = True, False, memoryview(bytearray(3 * 4096 // 4))
-        w = sys.stdout.buffer.write
+        def serialize_gr_command(**cmd):
+            payload = cmd.pop('payload', None)
+            cmd = ','.join(f'{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 = 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:
-            while not eof:
-                p = buf[:]
-                while p and not eof:
-                    n = f.readinto1(p)
-                    p, eof = p[n:], n == 0
-                encoded = standard_b64encode(buf[:len(buf)-len(p)])
-                metadata, first = "a=T,f=100," if first else "", False
-                w(f'\x1b_G{metadata}m={0 if eof else 1};'.encode('ascii'))
-                w(encoded)
-                w(b'\x1b\\')
+            write_chunked(a='T', f=100, data=f.read())
 
 
 Save this script as :file:`send-png`, then you can use it to display any PNG
@@ -250,7 +228,7 @@ This is a so-called *Application Programming Command (APC)*. Most terminal
 emulators ignore APC codes, making it safe to use.
 
 The control data is a comma-separated list of ``key=value`` pairs.  The payload
-is arbitrary binary data, :rfc:`base64 <4648>` encoded to prevent interoperation problems
+is arbitrary binary data, base64-encoded to prevent interoperation problems
 with legacy terminals that get confused by control codes within an APC code.
 The meaning of the payload is interpreted based on the control data.
 
@@ -311,8 +289,7 @@ compression is supported, which is specified using ``o=z``. For example::
     <ESC>_Gf=24,s=10,v=20,o=z;<payload><ESC>\
 
 This is the same as the example from the RGB data section, except that the
-payload is now compressed using deflate (this occurs prior to
-:rfc:`base64 <4648>` encoding).
+payload is now compressed using deflate (this occurs prior to base64-encoding).
 The terminal emulator will decompress it before rendering. You can specify
 compression for any format. The terminal emulator will decompress before
 interpreting the pixel data.
@@ -350,7 +327,7 @@ similar to reporting any other kind of I/O error. Since the file paths come
 from potentially untrusted sources, terminal emulators **must** refuse to read
 any device/socket/etc. special files. Only regular files are allowed.
 Additionally, terminal emulators may refuse to read files in *sensitive*
-parts of the filesystem, such as :file:`/proc`, :file:`/sys`, :file:`/dev`, etc.
+parts of the filesystem, such as :file:`/proc`, :file:`/sys`, :file:`/dev/`, etc.
 
 Local client
 ^^^^^^^^^^^^^^
@@ -368,7 +345,7 @@ Here we tell the terminal emulator to read compressed image data from
 the specified shared memory object.
 
 The client can also specify a size and offset to tell the terminal emulator
-to only read a part of the specified file. This is done using the ``S`` and ``O``
+to only read a part of the specified file. The is done using the ``S`` and ``O``
 keys respectively. For example::
 
     <ESC>_Gs=10,v=2,t=s,S=80,O=10;<encoded /some-shared-memory-name><ESC>\
@@ -384,7 +361,7 @@ Remote clients, those that are unable to use the filesystem/shared memory to
 transmit data, must send the pixel data directly using escape codes. Since
 escape codes are of limited maximum length, the data will need to be chunked up
 for transfer. This is done using the ``m`` key. The pixel data must first be
-:rfc:`base64 <4648>` encoded then chunked up into chunks no larger than ``4096`` bytes. All
+base64 encoded then chunked up into chunks no larger than ``4096`` bytes. All
 chunks, except the last, must have a size that is a multiple of 4. The client
 then sends the graphics escape code as usual, with the addition of an ``m`` key
 that must have the value ``1`` for all but the last chunk, where it must be
@@ -432,7 +409,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.
 
-We intend that any terminal emulator that wishes to support it can do so. To
+As of May 2023, kitty has a complete implementation of this protocol and
+WezTerm has a mostly complete implementation. Konsole and wayst have partial
+support. 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
@@ -480,11 +459,10 @@ id. To do so add the ``p`` key with a number between ``1`` and ``4294967295``.
 When you specify a placement id, it will be added to the acknowledgement code
 above. Every placement is uniquely identified by the pair of the ``image id``
 and the ``placement id``. If you specify a placement id for an image that does
-not have an id (i.e. has id=0), it will be ignored, i.e. the placement will not
-get an id. In particular this means there can exist multiple images with
-``image id=0, placement id=0``. Not specifying a placement id or using ``p=0``
-for multiple put commands (``a=p``) with the same non-zero image id results in
-multiple placements the image.
+not have an id (i.e. has id=0), it will be ignored. In particular this means
+there can exist multiple images with ``image id=0, placement id=0``. Not
+specifying a placement id or using ``p=0`` for multiple put commands (``a=p``)
+with the same non-zero image id results in multiple placements the image.
 
 An example response::
 
@@ -495,14 +473,6 @@ second one will replace the first. This can be used to resize or move
 placements around the screen, without flicker.
 
 
-.. note::
-   When re-transmitting image data for a specific id, the existing image and
-   all its placements must be deleted. The new data replaces the old image data
-   but is not actually displayed until a placement for it is created. This is
-   to avoid divergent behavior in the case when unrelated programs happen to re-use
-   image ids in the same session.
-
-
 .. versionadded:: 0.19.3
    Support for specifying placement ids (see :doc:`kittens/query_terminal` to query kitty version)
 
@@ -778,9 +748,6 @@ deleted, if the capital letter form above is specified. Also, when the terminal
 is running out of quota space for new images, existing images without
 placements will be preferentially deleted.
 
-If an image is being loaded in chunks and the upload is not complete when any
-delete command is received, the partial upload must be aborted.
-
 Some examples::
 
     <ESC>_Ga=d<ESC>\              # delete all visible placements
@@ -908,12 +875,12 @@ on.
 Finally, while transferring frame data, the frame *gap* can also be specified
 using the ``z`` key. The gap is the number of milliseconds to wait before
 displaying the next frame when the animation is running. A value of ``z=0`` is
-ignored (acts as though ``z`` was unspecified), ``z=positive number`` sets the
-gap to the specified number of milliseconds and ``z=negative number`` creates a
-*gapless* frame. Gapless frames are not displayed to the user since they are
-instantly skipped over, however they can be useful as the base data for
-subsequent frames. For example, for an animation where the background remains
-the same and a small object or two move.
+ignored, ``z=positive number`` sets the gap to the specified number of
+milliseconds and ``z=negative number`` creates a *gapless* frame. Gapless
+frames are not displayed to the user since they are instantly skipped over,
+however they can be useful as the base data for subsequent frames. For example,
+for an animation where the background remains the same and a small object or two
+move.
 
 Controlling animations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -943,9 +910,9 @@ animation. ``s=2`` runs the animation, but in *loading* mode, in this mode when
 reaching the last frame, instead of looping, the terminal will wait for the
 arrival of more frames. ``s=3`` runs the animation normally, after the last
 frame, the terminal loops back to the first frame. The number of loops can be
-controlled by the ``v`` key. ``v=0`` is ignored (acts as though ``v`` was not
-specified), ``v=1`` is loop infinitely, and any other positive number is loop
-``number - 1`` times. Note that stopping the animation resets the loop counter.
+controlled by the ``v`` key. ``v=0`` is ignored, ``v=1`` is loop infinitely,
+and any other positive number is loop ``number - 1`` times. Note that stopping
+the animation resets the loop counter.
 
 Finally, the *gap* for frames can be set using the ``z`` key. This can be
 specified either when the frame is created as part of the transmit escape code
@@ -984,7 +951,7 @@ 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>_Ga=c,i=1,r=7,c=9,w=23,h=27,X=4,Y=8,x=1,y=3<ESC>\
+    <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
@@ -1025,8 +992,8 @@ 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.
-         ``(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,
+         ``(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, ``c`` - compose animation frames
 

docs/index.rst

@@ -1,9 +1,7 @@
 kitty
 ==========================================================
 
-*If you live in the terminal, kitty is made for YOU!*
-
-The fast, feature-rich, GPU based terminal emulator.
+*The fast, feature-rich, GPU based terminal emulator*
 
 .. toctree::
     :hidden:
@@ -12,7 +10,6 @@ The fast, feature-rich, GPU based terminal emulator.
     overview
     faq
     support
-    sessions
     performance
     changelog
     integrations
@@ -22,14 +19,14 @@ The fast, feature-rich, GPU based terminal emulator.
 
 .. tab:: Fast
 
-   * Uses GPU and SIMD vector CPU instructions for :doc:`best in class performance <performance>`
+   * Offloads rendering to the GPU for :doc:`lower system load <performance>`
    * Uses threaded rendering for :iss:`absolutely minimal latency <2701#issuecomment-636497270>`
    * Performance tradeoffs can be :ref:`tuned <conf-kitty-performance>`
 
 .. tab:: Capable
 
    * Graphics, with :doc:`images and animations <graphics-protocol>`
-   * Ligatures, emoji with :opt:`per glyph font substitution <symbol_map>` and :doc:`variable fonts and font features </kittens/choose-fonts>`
+   * Ligatures and emoji, with :opt:`per glyph font substitution <symbol_map>`
    * :term:`Hyperlinks<hyperlinks>`, with :doc:`configurable actions <open_actions>`
 
 .. tab:: Scriptable

docs/installer.sh

@@ -49,7 +49,9 @@ detect_os() {
                 amd64|x86_64) arch="x86_64";;
                 aarch64*) arch="arm64";;
                 armv8*) arch="arm64";;
-                *) die "kitty binaries not available for architecture $(command uname -m)";;
+                i386) arch="i686";;
+                i686) arch="i686";;
+                *) die "Unknown CPU architecture $(command uname -m)";;
             esac
             ;;
         *) die "kitty binaries are not available for $(command uname)"
@@ -98,9 +100,6 @@ get_release_url() {
     get_file_url "v$release_version" "$release_version"
 }
 
-get_version_url() {
-    get_file_url "v$1" "$1"
-}
 
 get_nightly_url() {
     get_file_url "nightly" "nightly"
@@ -111,7 +110,6 @@ get_download_url() {
     case "$installer" in
         "nightly") get_nightly_url ;;
         "") get_release_url ;;
-        version-*) get_version_url "${installer#*-}";;
         *) installer_is_file="y" ;;
     esac
 }
@@ -130,24 +128,20 @@ download_installer() {
     }
 }
 
-ensure_dest() {
-    printf "%s\n" "Installing to $dest"
-    command rm -rf "$dest" || die "Failed to delete $dest"
-    command mkdir -p "$dest" || die "Failed to mkdir -p $dest"
-    command rm -rf "$dest" || die "Failed to delete $dest"
-}
-
 linux_install() {
     command mkdir "$tdir/mp"
     command tar -C "$tdir/mp" "-xJof" "$installer" || die "Failed to extract kitty tarball"
-    ensure_dest
+    printf "%s\n" "Installing to $dest"
+    command rm -rf "$dest" || die "Failed to delete $dest"
     command mv "$tdir/mp" "$dest" || die "Failed to move kitty.app to $dest"
 }
 
 macos_install() {
     command mkdir "$tdir/mp"
     command hdiutil attach "$installer" "-mountpoint" "$tdir/mp" || die "Failed to mount kitty.dmg"
-    ensure_dest
+    printf "%s\n" "Installing to $dest"
+    command rm -rf "$dest"
+    command mkdir -p "$dest" || die "Failed to create the directory: $dest"
     command ditto -v "$tdir/mp/kitty.app" "$dest"
     rc="$?"
     command hdiutil detach "$tdir/mp"

docs/integrations.rst

@@ -14,47 +14,38 @@ 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_bookokrat:
-
-`bookokrat <https://github.com/bugzmanov/bookokrat>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal PDF/EPUB viewer
-
 .. _tool_termpdf:
 
 `termpdf.py <https://github.com/dsanson/termpdf.py>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 A terminal PDF/DJVU/CBR viewer
 
-.. _tool_tdf:
+.. _tool_mdcat:
 
-`tdf <https://github.com/itsjunetime/tdf>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal PDF viewer
-
-.. _tool_fancy_cat:
-
-`fancy-cat <https://github.com/freref/fancy-cat>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal PDF viewer
-
-.. _tool_meowpdf:
-
-`meowpdf <https://github.com/monoamine11231/meowpdf>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal PDF viewer with GUI-like usage and Vim-like keybindings written in Rust
-
-.. _tool_mcat:
-
-`mcat <https://github.com/Skardyy/mcat>`_
+`mdcat <https://github.com/lunaryorn/mdcat>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Display various types of files nicely formatted with images in the terminal
+Display markdown files nicely formatted with images in the terminal
 
-`dawn <https://github.com/andrewmd5/dawn>`__
+.. _tool_ranger:
+
+`ranger <https://github.com/ranger/ranger>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+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.
+
+.. _tool_hunter:
+
+`hunter <https://github.com/rabite0/hunter>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-A markdown editor that uses the text-sizing protocol for large headings and
-the graphics protocol for images.
+Another terminal file manager, with previews of file contents powered by kitty's
+graphics protocol.
 
 .. _tool_presentterm:
 
@@ -63,13 +54,6 @@ the graphics protocol for images.
 Show markdown based slides with images in your terminal, powered by the
 kitty graphics protocol.
 
-.. _tool_mdfried:
-
-`mdfried <https://github.com/benjajaja/mdfried>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Markdown viewer that can render big headers with the text-sizing-protocol, and
-also render images with the kitty graphics protocol.
-
 .. _tool_term_image:
 
 `term-image <https://github.com/AnonymouX47/term-image>`__
@@ -103,30 +87,17 @@ base application that uses kitty's graphics protocol for images.
 A text mode WWW browser that supports kitty's graphics protocol to display
 images.
 
-.. _tool_awrit:
-
 `awrit <https://github.com/chase/awrit>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 A full Chromium based web browser running in the terminal using kitty's
 graphics protocol.
 
-.. _tool_chawan:
-
-`chawan <https://sr.ht/~bptato/chawan/>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A text mode WWW browser that supports kitty's graphics protocol to display
-images.
-
 .. _tool_mpv:
 
 `mpv <https://github.com/mpv-player/mpv/commit/874e28f4a41a916bb567a882063dd2589e9234e1>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 A video player that can play videos in the terminal.
 
-.. code-block:: sh
-
-    mpv --profile=sw-fast --vo=kitty --vo-kitty-use-shm=yes --really-quiet video.mkv
-
 .. _tool_timg:
 
 `timg <https://github.com/hzeller/timg>`_
@@ -136,52 +107,6 @@ plays videos. Fast multi-threaded loading, JPEG exif rotation, grid view and
 connecting to the webcam make it a versatile terminal utility.
 
 
-
-File managers
--------------------
-.. _tool_ranger:
-
-`ranger <https://github.com/ranger/ranger>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-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.
-
-.. _tool_yazi:
-
-`Yazi <https://github.com/sxyazi/yazi>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Blazing fast terminal file manager, with built-in kitty graphics protocol support
-(implemented both Classic protocol and Unicode placeholders).
-
-.. _tool_clifm:
-
-`clifm <https://github.com/leo-arch/clifm>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The shell-like, command line terminal file manager, uses the kitty graphics and
-keyboard protocols.
-
-.. _tool_hunter:
-
-`hunter <https://github.com/rabite0/hunter>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Another terminal file manager, with previews of file contents powered by kitty's
-graphics protocol.
-
-.. _tool_far2l:
-
-`far2l <https://github.com/elfmz/far2l>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Text-mode dual panel (orthodox) file manager and also terminal emulator, uses
-the kitty graphics and keyboard protocols (both as client and as terminal)
-
-
 System and data visualisation tools
 ---------------------------------------
 
@@ -194,13 +119,9 @@ protocol
 
 .. _tool_matplotlib:
 
-matplotlib
-^^^^^^^^^^^^^^
-
-There exist multiple backends for matplotlib to draw images directly in kitty.
-
-* `matplotlib-backend-kitty <https://github.com/jktr/matplotlib-backend-kitty>`__
-* `kitcat <https://github.com/mil-ad/kitcat>`__
+`matplotlib <https://github.com/jktr/matplotlib-backend-kitty>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Show matplotlib plots directly in kitty
 
 .. _tool_KittyTerminalImage:
 
@@ -220,15 +141,28 @@ by kitty's graphics protocol for displaying plots
 `gnuplot <http://www.gnuplot.info/>`_
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-A graphing and data visualization tool that has support for the kitty graphics
-protocol, with its ``kittygd`` and ``kittycairo`` backends.
+A graphing and data visualization tool that can be made to display its output in
+kitty with the following bash snippet:
 
-.. _tool_k-nine:
+.. code-block:: sh
 
-`k-nine <https://github.com/talwrii/kitty-plotnine>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    function iplot {
+        cat <<EOF | gnuplot
+        set terminal pngcairo enhanced font 'Fira Sans,10'
+        set autoscale
+        set samples 1000
+        set output '|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 wrapper around the :code:`plotnine` library which lets you plot data from the command-line with bash one-liners.
+Add this to bashrc and then to plot a function, simply do:
+
+.. code-block:: sh
+
+    iplot 'sin(x*3)*exp(x*.2)'
 
 .. tool_tgutui:
 
@@ -261,14 +195,6 @@ A tool to display weather information in your terminal with curl
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 View and manage the system clipboard under Wayland in your kitty terminal
 
-.. tool_nemu:
-
-`NEMU <https://github.com/nemuTUI/nemu>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-TUI for QEMU used to manage virtual machines, can display the Virtual Machine
-in the terminal using the kitty graphics protocol.
-
-
 Editor integration
 -----------------------
 
@@ -282,14 +208,6 @@ features such a split windows, previews, REPLs etc.
 Integrates with kitty to use native kitty windows for its windows/panels and
 REPLs.
 
-.. _tool_orbiton:
-
-`orbiton <https://github.com/xyproto/orbiton/>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A terminal text editor that uses kitty's graphics protocol to render Markdown
-documents with fonts and images inline (use the ``-B`` flag for a word
-processor-like book mode), and to preview images in its built-in file browser.
-
 .. tool_vim_slime:
 
 `vim-slime <https://github.com/jpalardy/vim-slime#kitty>`_
@@ -309,26 +227,17 @@ consistent set of hotkeys.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Allows easily running tests in a terminal window
 
-.. tool_nvim_image_viewers:
+.. tool_hologram:
+
+`hologram.nvim <https://github.com/edluffy/hologram.nvim>`_
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Terminal image viewer for Neovim. For a bit of fun, you can even have `cats
+running around inside nvim <https://github.com/giusgad/pets.nvim>`__.
 
-Various image viewing plugins for editors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-* `snacks.nvim <https://github.com/folke/snacks.nvim>`__ - Enables seamless inline images in various file formats within nvim
-* `image.nvim <https://github.com/3rd/image.nvim>`_ - Bringing images to neovim
-* `image_preview.nvim <https://github.com/adelarsq/image_preview.nvim/>`_ - Image preview for neovim
-* `hologram.nvim <https://github.com/edluffy/hologram.nvim>`_  - view images inside nvim
-* `kitty-graphics.el <https://github.com/cashmeredev/kitty-graphics.el>`_ - view images in emacs
 
 Scrollback manipulation
 -------------------------
 
-.. tool_kitty_search_incremental:
-
-`kitty-search-incremental <https://github.com/Mobinshahidi/kitty-search>`_
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Incremental scrollback search with live results, regex and literal modes,
-case-sensitivity toggle, match counter, and auto-scroll to the matching line.
-
 .. tool_kitty_scrollback_nvim:
 
 `kitty-scrollback.nvim <https://github.com/mikesmithgh/kitty-scrollback.nvim>`_
@@ -348,50 +257,10 @@ Live incremental search of the scrollback buffer.
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Keyboard based text selection for the kitty scrollback buffer.
 
-Desktop panels
--------------------------
-
-`kitty panel <https://github.com/5hubham5ingh/kitty-panel>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A system panel for Kitty terminal that displays real-time system metrics using terminal-based utilities.
-
-
-`pawbar <https://github.com/codelif/pawbar>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-A kitten-panel based desktop panel for your desktop
-
-Password managers
----------------------
-
-`1password <https://github.com/mm-zacharydavison/kitty-kitten-1password>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Allow injecting passwords from 1Password into kitty.
-
-`BitWarden <https://github.com/dnanhkhoa/kitty-password-manager>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Inject passwords from BitWarden into kitty
 
 Miscellaneous
 ------------------
 
-.. tool_doom:
-
-DOOM
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Play the classic shooter DOOM in `kitty <https://github.com/cryptocode/terminal-doom>`__ or even inside `neovim inside kitty
-<https://github.com/seandewar/actually-doom.nvim>`__.
-
-.. tool_gattino:
-
-`gattino <https://github.com/salvozappa/gattino>`__
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Integrate kitty with an LLM to convert plain language prompts into shell
-commands.
-
 .. tool_kitty_smart_tab:
 
 `kitty-smart-tab <https://github.com/yurikhan/kitty-smart-tab>`_

docs/keyboard-protocol.rst

@@ -28,52 +28,30 @@ issues in that proposal, listed at the :ref:`bottom of this document
 
 You can see this protocol with all enhancements in action by running::
 
-    kitten show-key -m kitty
+    kitten show_key -m kitty
 
 inside the kitty terminal to report key events.
 
 In addition to kitty, this protocol is also implemented in:
 
-* The `alacritty terminal <https://github.com/alacritty/alacritty/pull/7125>`__
 * The `foot terminal <https://codeberg.org/dnkl/foot/issues/319>`__
-* The `ghostty terminal <https://ghostty.org>`__
-* The `iTerm2 terminal <https://gitlab.com/gnachman/iterm2/-/issues/10017>`__
-* The `Microsoft terminal <https://github.com/microsoft/terminal/pull/19817>`__
-* The `rio terminal <https://github.com/raphamorim/rio/commit/cd463ca37677a0fc48daa8795ea46dadc92b1e95>`__
-* The `TuiOS terminal (multiplexer) <https://github.com/Gaurav-Gosain/tuios/issues/26>`__
-* The `Warp terminal <https://github.com/warpdotdev/Warp/issues/8462#issuecomment-3857779488>`__
 * The `WezTerm terminal <https://wezfurlong.org/wezterm/config/lua/config/enable_kitty_keyboard.html>`__
-* The `xterm.js terminal <https://github.com/xtermjs/xterm.js/pull/5600>`__
-
-Libraries implementing this protocol:
-
-* The `notcurses library <https://github.com/dankamongmen/notcurses/issues/2131>`__
-* The `crossterm library <https://github.com/crossterm-rs/crossterm/pull/688>`__
-* The `textual library <https://github.com/Textualize/textual/pull/4631>`__
-* The vaxis library `go <https://sr.ht/~rockorager/vaxis/>`__ and `zig <https://github.com/rockorager/libvaxis/>`__
-* The `bubbletea library <https://github.com/charmbracelet/bubbletea/issues/869>`__
-* The `vtinput <https://unxed.github.com/vtinput>`__ and `vtui <https://github.com/unxed/vtui>`__ libraries
-* The `tcell library <https://github.com/gdamore/tcell/commit/c10909b991eb87c009554fe9b2dfa7276e2649c1>`__
-
-Programs implementing this protocol:
-
+* The `alacritty terminal <https://github.com/alacritty/alacritty/pull/7125>`__
+* The `rio terminal <https://github.com/raphamorim/rio/commit/cd463ca37677a0fc48daa8795ea46dadc92b1e95>`__
+* The `notcurses library
+  <https://github.com/dankamongmen/notcurses/issues/2131>`__
+* The `crossterm library
+  <https://github.com/crossterm-rs/crossterm/pull/688>`__
 * The `Vim text editor <https://github.com/vim/vim/commit/63a2e360cca2c70ab0a85d14771d3259d4b3aafa>`__
 * The `Emacs text editor via the kkp package <https://github.com/benjaminor/kkp>`__
 * The `Neovim text editor <https://github.com/neovim/neovim/pull/18181>`__
 * The `kakoune text editor <https://github.com/mawww/kakoune/issues/4103>`__
 * The `dte text editor <https://gitlab.com/craigbarnes/dte/-/issues/138>`__
 * The `Helix text editor <https://github.com/helix-editor/helix/pull/4939>`__
-* The `Flow control editor <https://github.com/neurocyte/flow?tab=readme-ov-file#requirements>`__
-* The `far2l <https://github.com/elfmz/far2l/commit/e1f2ee0ef2b8332e5fa3ad7f2e4afefe7c96fc3b>`__ and `f4 <https://github.com/unxed/f4>`__ file managers
-* The `Yazi file manager <https://github.com/sxyazi/yazi>`__
+* The `far2l file manager <https://github.com/elfmz/far2l/commit/e1f2ee0ef2b8332e5fa3ad7f2e4afefe7c96fc3b>`__
+* The `yazi file manager <https://github.com/sxyazi/yazi>`__
 * The `awrit web browser <https://github.com/chase/awrit>`__
-* The `Turbo Vision <https://github.com/magiblot/tvision/commit/6e5a7b46c6634079feb2ac98f0b890bbed59f1ba>`__/`Free Vision <https://gitlab.com/freepascal.org/fpc/source/-/issues/40673#note_2061428120>`__ IDEs
-* The `aerc email client <https://git.sr.ht/~rjarry/aerc/commit/d73cf33c2c6c3e564ce8aff04acc329a06eafc54>`__
-
-Shells implementing this protocol:
-
 * The `nushell shell <https://github.com/nushell/nushell/pull/10540>`__
-* The `fish shell <https://github.com/fish-shell/fish-shell/commit/8bf8b10f685d964101f491b9cc3da04117a308b4>`__
 
 .. versionadded:: 0.20.0
 
@@ -157,14 +135,14 @@ user presses, for example, :kbd:`ctrl+shift+a` the escape code would be ``CSI
 97;modifiers u``. It *must not* be ``CSI 65; modifiers u``.
 
 If *alternate key reporting* is requested by the program running in the
-terminal, the terminal can send two additional Unicode codepoints, the *shifted
-key* and *base layout key*, separated by colons. The shifted key is simply the
-upper-case version of ``unicode-codepoint``, or more technically, the shifted
-version, in the currently active keyboard layout. So `a` becomes `A` and so on,
-based on the current keyboard layout. This is needed to be able to match
-against a shortcut such as :kbd:`ctrl+plus` which depending on the type of
-keyboard could be either :kbd:`ctrl+shift+equal` or :kbd:`ctrl+plus`. Note that
-the shifted key must be present only if shift is also present in the modifiers.
+terminal, the terminal can send two additional Unicode codepoints, the
+*shifted key* and *base layout key*, separated by colons.
+The shifted key is simply the upper-case version of ``unicode-codepoint``, or
+more technically, the shifted version. So `a` becomes `A` and so on, based on
+the current keyboard layout. This is needed to be able to match against a
+shortcut such as :kbd:`ctrl+plus` which depending on the type of keyboard could
+be either :kbd:`ctrl+shift+equal` or :kbd:`ctrl+plus`. Note that the shifted
+key must be present only if shift is also present in the modifiers.
 
 The *base layout key* is the key corresponding to the physical key in the
 standard PC-101 key layout. So for example, if the user is using a Cyrillic
@@ -172,7 +150,7 @@ keyboard with a Cyrillic keyboard layout pressing the :kbd:`ctrl+С` key will
 be :kbd:`ctrl+c` in the standard layout. So the terminal should send the *base
 layout key* as ``99`` corresponding to the ``c`` key.
 
-If only one alternate key is present, it is the *shifted key*. If the terminal
+If only one alternate key is present, it is the *shifted key* if the terminal
 wants to send only a base layout key but no shifted key, it must use an empty
 sub-field for the shifted key, like this::
 
@@ -249,19 +227,13 @@ The terminal can optionally send the text associated with key events as a
 sequence of Unicode code points. This behavior is opt-in by the :ref:`progressive
 enhancement <progressive_enhancement>` mechanism described below. Some examples::
 
-    shift+a -> CSI 97 ; 2 ; 65 u   # The text 'A' is reported as 65
-    alt+a   -> CSI  0 ;   ; 229 u  # The text 'å' is reported as 229
+    shift+a -> CSI 97 ; 2 ; 65 u  # The text 'A' is reported as 65
+    option+a -> CSI 97 ; ; 229 u  # The text 'å' is reported as 229
 
 If multiple code points are present, they must be separated by colons.  If no
 known key is associated with the text the key number ``0`` must be used. The
 associated text must not contain control codes (control codes are code points
-below U+0020 and codepoints in the C0 and C1 blocks). In the above example, the
-:kbd:`alt` modifier is consumed by the OS itself to produce the text å and not
-sent to the terminal emulator, which gets only a "text input" event and no
-information about modifiers, thus the event gets encoded with no modifiers.
-The exact behavior in these situations depends on the OS, keyboard layout, IME
-system in use and so on. In general, if the terminal emulator receives no key
-information, the key number 0 must be used to indicate a pure "text event".
+below U+0020 and codepoints in the C0 and C1 blocks).
 
 
 Non-Unicode keys
@@ -351,7 +323,7 @@ the bytes used for CSI control codes.
 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 non text keypad keys will be reported as separate keys with ``CSI u``
+Additionally, all keypad keys will be reported as separate keys with ``CSI u``
 encoding, using dedicated numbers from the :ref:`table below <functional>`.
 
 With this flag turned on, all key events that do not generate text are
@@ -368,7 +340,7 @@ are the :kbd:`Enter`, :kbd:`Tab` and :kbd:`Backspace` keys which still generate
 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. Note that the Lock modifiers are not reported for text
-producing keys, to keep them usable in legacy programs. To get lock modifiers
+producing keys, to keep them useable in legacy programs. To get lock modifiers
 for all keys use the :ref:`report_all_keys` enhancement.
 
 .. _report_events:
@@ -394,13 +366,8 @@ Report alternate keys
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This progressive enhancement (``0b100``) causes the terminal to report
-alternate key values *in addition* to the main value, to aid in shortcut
-matching. See :ref:`key_codes` for details on how these are reported. Note that
-this flag is a pure enhancement to the form of the escape code used to
-represent key events, only key events represented as escape codes due to the
-other enhancements in effect will be affected by this enhancement. In other
-words, only if a key event was already going to be represented as an escape
-code due to one of the other enhancements will this enhancement affect it.
+alternate key values in addition to the main value, to aid in shortcut
+matching. See :ref:`key_codes` for details on how these are reported.
 
 .. _report_all_keys:
 
@@ -419,20 +386,17 @@ 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`,
-:kbd:`Tab`, :kbd:`Backspace` etc. Note that this enhancement implies all keys
-are automatically disambiguated as well, since they are represented in their
-canonical escape code form.
+:kbd:`Tab`, :kbd:`Backspace` etc.
 
 .. _report_text:
 
 Report associated text
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This progressive enhancement (``0b10000``) *additionally* causes key events that
-generate text to be reported as ``CSI u`` escape codes with the text embedded
-in the escape code. See :ref:`text_as_codepoints` above for details on the
-mechanism. Note that this flag is an enhancement to :ref:`report_all_keys`
-and is undefined if used without it.
+This progressive enhancement (``0b10000``) causes key events that generate text
+to be reported as ``CSI u`` escape codes with the text embedded in the escape
+code. See :ref:`text_as_codepoints` above for details on the mechanism.
+
 
 .. _detection:
 
@@ -447,13 +411,6 @@ followed by request for the `primary device attributes
 attributes is received without getting back an answer for the progressive
 enhancement the terminal does not support this protocol.
 
-.. note::
-   Terminal implementations of this protocol are **strongly** encouraged to
-   implement all progressive enhancements. It does not make sense to
-   implement only a subset. Nonetheless, there are likely to be some terminal
-   implementations that do not do so, applications can detect such
-   implementations by first setting the desired progressive enhancements and
-   then querying for the :ref:`current progressive enhancement <progressive_enhancement>`
 
 Legacy key event encoding
 --------------------------------
@@ -478,10 +435,7 @@ These keys are encoded using three schemes::
 
 In the above, if there are no modifiers, the modifier parameter is omitted.
 The modifier value is encoded as described in the :ref:`modifiers` section,
-above, except that lock keys (such as :kbd:`Num lock` and :kbd:`Caps lock`)
-are not encoded as the legacy mode has no encoding for them.
-
-When the second form is used, the number is always ``1`` and must be
+above. When the second form is used, the number is always ``1`` and must be
 omitted if the modifiers field is also absent. The third form becomes the
 second form when modifiers are present (``SS3 is the bytes 0x1b 0x4f``).
 
@@ -572,8 +526,8 @@ Any other combination of modifiers with these keys is output as the appropriate
 .. csv-table:: Example encodings
    :header: "Key", "Plain", "shift", "alt", "ctrl", "shift+alt", "alt+ctrl", "ctrl+shift"
 
-    "i", "i (105)", "I (73)", "ESC i", "\t (9)", "ESC I", "ESC \t", "CSI 105; 6 u"
-    "3", "3 (51)", "# (35)", "ESC 3", "ESC (27)", "ESC #", "ESC ESC", "CSI 51; 6 u"
+    "i", "i (105)", "I (73)", "ESC i", ") (41)", "ESC I", "ESC )", "CSI 105; 6 u"
+    "3", "3 (51)", "# (35)", "ESC 3", "3 (51)", "ESC #", "ESC 3", "CSI 51; 6 u"
     ";", "; (59)", ": (58)", "ESC ;", "; (59)", "ESC :", "ESC ;", "CSI 59; 6 u"
 
 .. note::

docs/kittens/choose-files.rst

@@ -1,136 +0,0 @@
-Selecting files, fast
-========================
-
-.. only:: man
-
-    Overview
-    --------------
-
-.. versionadded:: 0.45.0
-
-.. only:: not man
-
-    .. figure:: /screenshots/choose-files.webp
-        :alt: The choose files kitten, showing metadata and title from an e-book file
-        :align: center
-        :width: 100%
-
-
-The choose-files kitten is designed to allow you to select files, very fast,
-with just a few key strokes. It operates like `fzf
-<https://github.com/junegunn/fzf/>`__ and similar fuzzy finders, except that
-it is specialised for finding files. As such it supports features such as
-filtering by file type, file type icons, content previews and
-so on, out of the box. It can be used as a drop in (but much more efficient and
-keyboard friendly) replacement for the :guilabel:`File open and save`
-dialog boxes common to GUI programs. On Linux, with the help of the
-:doc:`desktop-ui </kittens/desktop-ui>` kitten, you can even convince
-most GUI programs on your computer to use this kitten instead of regular file
-dialogs.
-
-Simply run it as::
-
-    kitten choose-files
-
-to select a single file from the tree rooted at the current working directory.
-
-Type a few letters from the filename and once it becomes the top selection,
-press :kbd:`Enter`. You can change the current directory by selecting a
-directory and pressing the :kbd:`Tab` key. :kbd:`Shift+Tab` goes up one
-directory level.
-
-If you want to choose a file and insert it into your shell prompt at the
-current cursor position, press :sc:`insert_chosen_file` for files or
-:sc:`insert_chosen_directory` for directories. Similarly, to have a file
-chosen in a command line, use, for example::
-
-    some-command $(kitten choose-file)
-
-Note that the above may not work in a complicated pipeline as it performs
-terminal I/O and needs exclusive access to the tty device while choosing a
-file.
-
-.. note:: For content previews, this kitten uses some external programs. In
-   particular `ffmpeg <https://www.ffmpeg.org/>`__ is needed for video
-   previews and `calibre <https://calibre-ebook.com>`__ is needed
-   for ebook metadata and cover preiews.
-
-Creating shortcuts to favorite/frequently used directories
-------------------------------------------------------------
-
-You can create keyboard shortcuts to quickly switch to any directory in
-:file:`choose-files.conf`. For example:
-
-.. code-block:: conf
-
-   map ctrl+t cd /tmp
-   map alt+p  cd ~/my/project
-
-Selecting multiple files
------------------------------
-
-When you wish to select multiple files, start the kitten with :option:`--mode
-<kitty +kitten choose_files --mode>`:code:`=files`. Then instead of pressing
-:kbd:`Enter`, press :kbd:`Shift+Enter` instead and the file will be added to the list
-of selections. You can also hold the :kbd:`Ctrl` key and click on files to add
-them to the selections. Similarly, you can hold the :kbd:`Alt` key and click to
-select ranges of files (similar to using :kbd:`Shift+click` in a GUI app).
-Press :kbd:`Enter` on the last selected file to finish. The list of selected
-files is displayed at the bottom of the kitten and you can click on them
-to deselect a file. Similarly, pressing :kbd:`Shift+Enter` will un-select a
-previously selected file.
-
-
-Hidden and ignored files
---------------------------
-
-By default, the kitten does not process hidden files and directories (whose
-names start with a period). This can be :opt:`changed in the configuration <kitten-choose_files.show_hidden>`
-and also at runtime via the clickable link to the right of the search input.
-
-Similarly, the kitten respects both :file:`.gitignore` and :file:`.ignore`
-files, by default. This can also be changed both :opt:`in configuration
-<kitten-choose_files.respect_ignores>` or at runtime. Note that
-:file:`.gitignore` files are only respected if there is also a :file:`.git`
-directory present. The kitten also supports the global :file:`.gitignore` file,
-though it applies only inside git working trees. You can specify :opt:`global ignore
-patterns <kitten-choose_files.ignore>`, that apply everywhere in :file:`choose-files.conf`.
-
-
-Selecting non-existent files (save file names)
--------------------------------------------------
-
-This kitten can also be used to select non-existent files, that is a new file
-for a :guilabel:`Save file` type of dialog using :option:`--mode <kitty +kitten
-choose_files --mode>`:code:`=save-file`. Once you have changed to the directory
-you want the file to be in (using the :kbd:`Tab` key),
-press :kbd:`Ctrl+Enter` and you will be able to type in the file name. If you
-wish to modify an existing file name use :kbd:`Alt+Enter` to modify the
-filename of the current top match instead.
-
-
-Selecting directories
----------------------------
-
-This kitten can also be used to select directories,
-for an :guilabel:`Open directory` type of dialog using :option:`--mode <kitty +kitten
-choose_files --mode>`:code:`=dir`. Once you have changed to the directory
-you want, press :kbd:`Ctrl+Enter` to accept it. Or if you are in a parent
-directory you can select a descendant directory by pressing :kbd:`Enter`, the
-same as you would for selecting a file to open.
-
-
-Configuration
-------------------------
-
-You can configure various aspects of the kitten's operation by creating a
-:file:`choose-files.conf` in your :ref:`kitty config folder <confloc>`.
-See below for the supported configuration directives.
-
-
-.. include:: /generated/conf-kitten-choose_files.rst
-
-
-.. include:: /generated/cli-kitten-choose_files.rst
-
-

docs/kittens/choose-fonts.rst

@@ -1,128 +0,0 @@
-Changing kitty fonts
-========================
-
-.. only:: man
-
-    Overview
-    --------------
-
-Terminal aficionados spend all day staring at text, as such, getting text
-rendering just right is very important. kitty has extremely powerful facilities
-for fine-tuning text rendering. It supports `OpenType features
-<https://en.wikipedia.org/wiki/List_of_typographic_features>`__ to select
-alternate glyph shapes, and `Variable fonts
-<https://en.wikipedia.org/wiki/Variable_font>`__ to control the weight or
-spacing of a font precisely. You can also :opt:`select which font is used to
-render particular unicode codepoints <symbol_map>` and you can :opt:`modify
-font metrics <modify_font>` and even :opt:`adjust the gamma curves
-<text_composition_strategy>` used for rendering text onto the background color.
-
-The first step is to select the font faces kitty will use for rendering
-regular, bold and italic text. kitty comes with a convenient UI for choosing fonts,
-in the form of the *choose-fonts* kitten. Simply run::
-
-    kitten choose-fonts
-
-and follow the on screen prompts.
-
-First, choose the family you want, the list of families can be easily filtered by
-typing a few letters from the family name you are looking for. The family
-selection screen shows you a preview of how the family looks.
-
-.. image:: ../screenshots/family-selection.png
-   :alt: Choosing a family with the choose fonts kitten
-   :width: 600
-
-Once you select a family by pressing the :kbd:`Enter` key, you
-are shown previews of what the regular, bold and italic faces look like
-for that family. You can choose to fine tune any of the faces. Start with
-fine-tuning the regular face by pressing the :kbd:`R` key. The other styles
-will be automatically adjusted based on what you select for the regular face.
-
-.. image:: ../screenshots/font-fine-tune.png
-   :alt: Fine tune a font by choosing a precise weight and features
-   :width: 600
-
-You can choose a specific style or font feature by clicking on it. A precise
-value for any variable axes can be selected using the slider, in the screenshot
-above, the font supports precise weight adjustment. If you are lucky the font
-designer has included descriptive names for font features, which will be
-displayed, if not, consult the documentation of the font to see what each feature does.
-
-.. _font_spec_syntax:
-
-The font specification syntax
---------------------------------
-
-If you don't like the choose fonts kitten or simply want to understand and
-write font selection options into :file:`kitty.conf` yourself, read on.
-
-There are four font face selection keys: `font_family`, `bold_font`,
-`italic_font` and `bold_italic_font`. Each of these supports the syntax
-described below. Their values can be of three types, either a
-font family name, the keyword ``auto`` or an extended ``key=value`` syntax
-for specifying font selection precisely.
-
-If a font family name is specified kitty will use Operating System APIs to
-search for a matching font. The keyword ``auto`` means kitty will choose a font
-completely automatically, typically this is used for automatically selecting
-bold/italic variants once the :opt:`font_family` is set. The bold and italic
-variants will then automatically use the same set of features as the main face.
-
-To specify font face selection more precisely, a ``key=value`` syntax is used.
-First, let's look at a few examples::
-
-    # Select by family only, actual face selection is automatic
-    font_family family="Fira Code"
-    # Select an exact face by Postscript name
-    font_family postscript_name=FiraCode
-    # Select an exact face by family with features and variable weight
-    font_family family=SourceCodeVF variable_name=SourceCodeUpright features="+zero cv01=2" wght=380
-
-The following are the known keys, any other keys are names of *variable axes*,
-that is, they are used to set the variable value for some font characteristic.
-
-``family``
-    A font family name. A family typically has multiple actual font faces, such
-    as bold and italic variants. One or more of the faces can even be variable,
-    allowing fine tuning of font characteristics.
-
-``style``
-    A style name to choose a particular font from a given family. Useful only
-    with the ``family`` key, when no more precise methods for face selection
-    are specified. Can also be used to specify a named variable style for
-    variable fonts.
-
-``postscript_name``
-    The actual postscript name for a font face. This allows selecting a
-    particular variant within a font family. But note that postscript names
-    are usually insufficient for selecting variable fonts.
-
-``full_name``
-    This can be used to select a particular font face in a family. However, it
-    is less precise than ``postscript_name`` and should not generally be used.
-
-``variable_name``
-    Some families with variable fonts actually contain multiple font files. For
-    example, a family could have variable weights with one font file containing
-    upright variable weight faces and another containing italic variable weight
-    faces. Well designed fonts use a *variable name* to distinguish between
-    such files. Should be used in conjunction with ``family`` to select a
-    particular variable font file.
-
-``features``
-    A space separated list of OpenType font features to enable/disable or
-    select a value of, for this font. Consult the documentation for the font
-    family to see what features it supports and their effects. The exact syntax
-    for specifying features is `documented by HarfBuzz
-    <https://harfbuzz.github.io/harfbuzz-hb-common.html#hb-feature-from-string>`__
-
-``system``
-    This can be used to pass an arbitrary string, usually a family or full name
-    to the OS font selection APIs. Should not be used in conjunction with any
-    other keys. Is the same as specifying just the font name without any keys.
-
-
-In addition to these keys, any four letter key is treated as the name of a
-variable characteristic of the font. Its value is used to set the value for
-the name.

docs/kittens/clipboard.rst

@@ -6,7 +6,7 @@ clipboard
     Overview
     --------------
 
-    *Copy/paste to the system clipboard from shell scripts*
+*Copy/paste to the system clipboard from shell scripts*
 
 .. highlight:: sh
 

docs/kittens/command-palette.rst

@@ -1,142 +0,0 @@
-Command palette
-=================
-
-.. only:: man
-
-    Overview
-    --------------
-
-
-The command palette lets you browse, search and trigger all keyboard shortcuts
-and actions in |kitty| from a single searchable overlay. Press
-:sc:`command_palette` to open it (default: :kbd:`Ctrl+Shift+F3`).
-
-.. figure:: ../screenshots/command-palette.webp
-    :alt: A screenshot of the command palette kitten
-    :align: center
-    :width: 100%
-
-    The command palette showing search results for ``win close``.
-
-All mapped actions (those with a keyboard shortcut) and unmapped actions (those
-available but not bound to any key) are listed, organized by category. Mouse
-bindings are shown in a separate section. Simply type to search, select a
-result, and press :kbd:`Enter` to run it.
-
-
-Searching
------------
-
-As you type into the search bar, the palette filters results in real time.
-Matching is case-insensitive and works across three columns simultaneously:
-the **key** (keyboard shortcut), the **action** name, and the **category**.
-Matched characters are highlighted so you can see exactly where each term hit.
-
-**Multiple words**
-    Separate your terms with spaces. Typing ``scroll page`` looks for items
-    that contain *scroll* and *page* anywhere across the key, action, or
-    category columns. Items that match more of your terms are ranked higher
-    than those that match fewer.
-
-**How individual words are matched**
-    Each word in your query is compared against every word in the three
-    columns. The best match wins and determines the item's score for that
-    term:
-
-    - *Exact word* — the query word equals a column word exactly (highest score).
-    - *Prefix* — the column word starts with the query word,
-      e.g. ``scr`` matches ``scroll``.
-    - *Typo tolerance* — for words of four characters or longer, a single
-      typo (one character inserted, deleted, or substituted) still produces a
-      match, and two typos give a lower-scoring match.
-
-    An item appears in the results as long as at least one query word matches
-    something. Items where more query words match rank above those where fewer
-    match.
-
-**Compound names**
-    Delimiters such as ``_``, ``+``, ``/``, and ``-`` are kept intact inside a
-    query word, so you can search for compound action names as a unit.
-    Typing ``mouse_selection`` first tries to find that exact substring in each
-    column. If that fails, it splits the token into its parts (``mouse`` and
-    ``selection``) and matches each part independently against the column words.
-
-**Ranking**
-    When multiple items match the same query, they are sorted by:
-
-    1. Number of query words that matched (more is better).
-    2. Score on the action column (action matches outrank key or category matches).
-    3. Score on the key column.
-    4. Score on the category column.
-    5. Shorter action name as a tiebreaker (more specific results first).
-
-
-Keyboard controls
--------------------
-
-The following keys are available while the command palette is open:
-
-.. list-table::
-    :widths: auto
-    :header-rows: 1
-
-    * - Key
-      - Action
-    * - Any text
-      - Filter results by typing a search query
-    * - :kbd:`Enter`
-      - Run the selected action
-    * - :kbd:`Escape`
-      - Clear the search query, or close the palette if the query is already empty
-    * - :kbd:`Up` / :kbd:`Ctrl+K` / :kbd:`Ctrl+P`
-      - Move selection up
-    * - :kbd:`Down` / :kbd:`Ctrl+J` / :kbd:`Ctrl+N`
-      - Move selection down
-    * - :kbd:`Page Up`
-      - Move selection up by a page
-    * - :kbd:`Page Down`
-      - Move selection down by a page
-    * - :kbd:`Home`
-      - Jump to the first result
-    * - :kbd:`End`
-      - Jump to the last result
-    * - :kbd:`Backspace`
-      - Delete the last character from the query
-    * - :kbd:`F12`
-      - Toggle display of unmapped actions
-    * - Mouse click
-      - Select and run the clicked action
-
-
-Unmapped actions
-------------------
-
-By default, the palette shows both mapped actions (those bound to a shortcut)
-and unmapped actions (those with no shortcut assigned). Unmapped actions appear
-with an ``(unmapped)`` label in the key column. Press :kbd:`F12` to toggle
-their visibility. This preference is remembered across sessions.
-
-Unmapped actions are useful for discovering functionality that you may not have
-configured a shortcut for. You can run them directly from the palette, or note
-the action name and add a mapping in :file:`kitty.conf`.
-
-
-Custom keyboard modes
------------------------
-
-If you have defined custom :ref:`keyboard modes <modal_mappings>` in your
-configuration, their bindings appear under separate mode headers in the palette.
-The ``push_keyboard_mode`` bindings are grouped with the target mode they
-activate, making it easy to see how to enter each mode alongside its shortcuts.
-
-
-Configuration
---------------
-
-The default mapping to open the command palette is::
-
-    map kitty_mod+f3 command_palette
-
-You can change this in :file:`kitty.conf` like any other mapping. For example::
-
-    map ctrl+p command_palette

docs/kittens/custom.rst

@@ -19,9 +19,10 @@ Create a file in the kitty config directory, :file:`~/.config/kitty/mykitten.py`
 
 .. code-block:: python
 
+    from typing import List
     from kitty.boss import Boss
 
-    def main(args: list[str]) -> str:
+    def main(args: List[str]) -> str:
         # this is the main entry point of the kitten, it will be executed in
         # the overlay window when the kitten is launched
         answer = input('Enter some text: ')
@@ -29,7 +30,7 @@ Create a file in the kitty config directory, :file:`~/.config/kitty/mykitten.py`
         # handle_result() function
         return answer
 
-    def handle_result(args: list[str], answer: str, target_window_id: int, boss: Boss) -> None:
+    def handle_result(args: List[str], answer: str, target_window_id: int, boss: Boss) -> None:
         # get the kitty window into which to paste answer
         w = boss.window_id_map.get(target_window_id)
         if w is not None:
@@ -59,7 +60,7 @@ would pass to ``kitten @``. For example:
 
 .. code-block:: python
 
-    def handle_result(args: list[str], answer: str, target_window_id: int, boss: Boss) -> None:
+    def handle_result(args: List[str], answer: str, target_window_id: int, boss: Boss) -> None:
         # get the kitty window to which to send text
         w = boss.window_id_map.get(target_window_id)
         if w is not None:
@@ -72,9 +73,6 @@ would pass to ``kitten @``. For example:
    shown above or ``--self``.
 
 
-Run, ``kitten @ --help`` in a kitty terminal, to see all the remote control
-commands available to you.
-
 Passing arguments to kittens
 ------------------------------
 
@@ -100,18 +98,19 @@ like. For example:
 
 .. code-block:: py
 
+    from typing import List
     from kitty.boss import Boss
 
     # in main, STDIN is for the kitten process and will contain
     # the contents of the screen
-    def main(args: list[str]) -> str:
+    def main(args: List[str]) -> str:
         return sys.stdin.read()
 
     # in handle_result, STDIN is for the kitty process itself, rather
     # than the kitten process and should not be read from.
     from kittens.tui.handler import result_handler
     @result_handler(type_of_input='text')
-    def handle_result(args: list[str], stdin_data: str, target_window_id: int, boss: Boss) -> None:
+    def handle_result(args: List[str], stdin_data: str, target_window_id: int, boss: Boss) -> None:
         pass
 
 
@@ -122,9 +121,9 @@ 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
@@ -141,7 +140,7 @@ the table below:
     ``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
@@ -169,14 +168,15 @@ Create a Python file in the :ref:`kitty config directory <confloc>`,
 
 .. code-block:: py
 
+    from typing import List
     from kitty.boss import Boss
 
-    def main(args: list[str]) -> str:
+    def main(args: List[str]) -> str:
         pass
 
     from kittens.tui.handler import result_handler
     @result_handler(no_ui=True)
-    def handle_result(args: list[str], answer: str, target_window_id: int, boss: Boss) -> None:
+    def handle_result(args: List[str], answer: str, target_window_id: int, boss: Boss) -> None:
         tab = boss.active_tab
         if tab is not None:
             if tab.current_layout.name == 'stack':
@@ -228,56 +228,6 @@ The function will only send the event if the program is receiving events of
 that type, and will return ``True`` if it sent the event, and ``False`` if not.
 
 
-.. _kitten_main_rc:
-
-Using remote control inside the main() kitten function
-------------------------------------------------------------
-
-You can use kitty's remote control features inside the main() function of a
-kitten, even without enabling remote control. This is useful if you want to
-probe kitty for more information before presenting some UI to the user or if
-you want the user to be able to control kitty from within your kitten's UI
-rather than after it has finished running. To enable it, simply tell kitty your kitten
-requires remote control, as shown in the example below::
-
-    import json
-    import sys
-    from pprint import pprint
-
-    from kittens.tui.handler import kitten_ui
-
-    @kitten_ui(allow_remote_control=True)
-    def main(args: list[str]) -> str:
-        # get the result of running kitten @ ls
-        cp = main.remote_control(['ls'], capture_output=True)
-        if cp.returncode != 0:
-            sys.stderr.buffer.write(cp.stderr)
-            raise SystemExit(cp.returncode)
-        output = json.loads(cp.stdout)
-        pprint(output)
-        # open a new tab with a title specified by the user
-        title = input('Enter the name of tab: ')
-        window_id = main.remote_control(['launch', '--type=tab', '--tab-title', title], check=True, capture_output=True).stdout.decode()
-        return window_id
-
-:code:`allow_remote_control=True` tells kitty to run this kitten with remote
-control enabled, regardless of whether it is enabled globally or not.
-To run a remote control command use the :code:`main.remote_control()` function
-which is a thin wrapper around Python's :code:`subprocess.run` function. Note
-that by default, for security, child processes launched by your kitten cannot use remote
-control, thus it is necessary to use :code:`main.remote_control()`. If you wish
-to enable child processes to use remote control, call
-:code:`main.allow_indiscriminate_remote_control()`.
-
-Remote control access can be further secured by using
-:code:`kitten_ui(allow_remote_control=True, remote_control_password='ls set-colors')`.
-This will use a secure generated password to restrict remote control.
-You can specify a space separated list of remote control commands to allow, see
-:opt:`remote_control_password` for details. The password value is accessible
-as :code:`main.password` and is used by :code:`main.remote_control()`
-automatically.
-
-
 Debugging kittens
 --------------------
 
@@ -298,12 +248,105 @@ So if you run kitty from another kitty instance, the output will be visible
 in the first kitty instance.
 
 
-Developing builtin kittens for inclusion with kitty
-----------------------------------------------------------
+Adding options to kittens
+----------------------------
 
-There is documentation for :doc:`developing-builtin-kittens` which are written in the Go
-language.
+If you would like to use kitty's config framework to make your kittens
+configurable, you will need some boilerplate. Put the following files in the
+directory of your kitten.
 
+: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, found_paths = _load_config(defaults, parse_config, merge_result_dicts, *paths, overrides=overrides)
+        opts = Options(opts_dict)
+        opts.config_paths = found_paths
+        opts.all_config_paths = paths
+        opts.config_overrides = overrides
+        return opts
+
+See `the code <https://github.com/kovidgoyal/kitty/tree/master/kittens/diff>`__
+for the builtin :doc:`diff kitten </kittens/diff>` for examples of creating more
+options and keyboard shortcuts.
 
 .. _external_kittens:
 
@@ -317,12 +360,6 @@ Kittens created by kitty users
 `smart-scroll <https://github.com/yurikhan/kitty-smart-scroll>`_
     Makes the kitty scroll bindings work in full screen applications
 
-`kitty-tab-switcher <https://github.com/OsiPog/kitty-tab-switcher>`__
-    Fuzzy finder for kitty tabs with previews
-
-`gattino <https://github.com/salvozappa/gattino>`__
-    Integrate kitty with an LLM to convert plain language prompts into shell commands.
-
 :iss:`insert password <1222>`
     Insert a password from a CLI password manager, taking care to only do it at
     a password prompt.

docs/kittens/desktop-ui.rst

@@ -1,136 +0,0 @@
-Using terminal programs to provide Linux desktop components
-===============================================================
-
-.. only:: man
-
-    Overview
-    --------------
-
-.. versionadded:: 0.43.0
-
-Power users of terminals on Linux also often like to use bare bones window
-managers instead of full fledged desktop environments. This kitten helps
-provide parts of the desktop environment that are missing from such setups,
-and does so using keyboard friendly, terminal first, UI components. Some of its
-features are:
-
-* Replace the typical File Open/Save dialogs used in GUI programs with the
-  fast and keyboard centric :doc:`choose-files </kittens/choose-files>` kitten
-  running in a semi-transparent kitty overlay.
-
-* Allow simple command line based management of the desktop light/dark modes.
-
-
-How to install
--------------------
-
-.. note::
-
-   This kitten relies on the :doc:`panel kitten </kittens/panel>`
-   under the hood to supply UI components. Check :ref:`the documentation <panel_compat>`
-   of that kitten to see if your window manager works with it.
-
-First, run::
-
-    kitten desktop-ui enable-portal
-
-Then, set the following two environment variables, *system wide*, that means in
-:file:`/etc/environment` or the equivalent for your distribution::
-
-    QT_QPA_PLATFORMTHEME=xdgdesktopportal
-    GTK_USE_PORTAL=1
-
-
-Finally, reboot. Now, when you open a file dialog in most GUI applications, it
-should open the :doc:`choose-files kitten </kittens/choose-files>` instead
-of a normal file open dialog. You can change the current light/dark mode of
-your desktop by running::
-
-    kitten desktop-ui set-color-scheme dark
-    kitten desktop-ui set-color-scheme light
-
-Check the current value using::
-
-    dbus-send --session --print-reply --dest=org.freedesktop.portal.Desktop /org/freedesktop/portal/desktop org.freedesktop.portal.Settings.Read string:org.freedesktop.appearance string:color-scheme
-
-How it works
-----------------
-
-Modern Linux desktops have so called `portals
-<https://flatpak.github.io/xdg-desktop-portal/docs/index.html>`__ that were
-invented for sandboxed applications and provide various facilities to such
-applications over DBUS, including file open dialogs, common desktop settings,
-etc. This kitten works by implementing a backend for some of these services.
-
-Normal GUI applications can then be told to make use of these services, thereby
-allowing us to replace parts of the desktop experience as needed.
-
-There are multiple competing implementations of the backends. Each desktop
-environment like KDE or GNOME has it's own backend and many window managers
-provide implementations for some backends as well. Service discovery and
-configuring which backend to use happens via the :file:`xdg-desktop-portal`
-program, usually found at :file:`/usr/lib/xdg-desktop-portal`.
-
-It can be configured by files in :file:`~/.local/share/xdg-desktop-portal`. See
-`man portals.conf <https://man.archlinux.org/man/portals.conf.5>`__. The
-``kitten desktop-ui enable-portal`` command takes care of the setup for you
-automatically. If you want to customize exactly which services to use this
-kitten for, run the command and then edit the conf file that the command says
-it has patched.
-
-
-Troubleshooting
--------------------
-
-First, ensure that DBUS is able to auto-start the kitten when it is needed. If
-the kitten is not already running, try the following command::
-
-    dbus-send --session --print-reply --dest=org.freedesktop.impl.portal.desktop.kitty \
-        /net/kovidgoyal/kitty/portal org.freedesktop.DBus.Properties.GetAll \
-        string:net.kovidgoyal.kitty.settings
-
-If DBUS is able to start the kitten or if it is already running it will print
-out the version property, otherwise it will fail with an error. If it fails,
-check the file
-:file:`~/.local/share/dbus-1/services/org.freedesktop.impl.portal.desktop.kitty.service`
-that should have been created by the ``enable-portal`` command. It's ``Exec``
-key must point to the full path to the kitten executable.
-
-Next, check that the XDG portal system is actually using this kitten for its
-settings backend. Run::
-
-    dbus-send --session --print-reply --dest=org.freedesktop.portal.Desktop \
-        /org/freedesktop/portal/desktop org.freedesktop.portal.Settings.Read \
-        string:net.kovidgoyal.kitty string:status
-
-If this returns a reply then the kitten is being used, as expected. If it
-returns a not found error, then some other backend is being used for settings.
-
-Read the ``portals.conf`` man page and run::
-
-    /usr/lib/xdg-desktop-portal -r v
-
-this will output a lot of debug information, which should tell you which
-backend is chosen for which service. Read the debug output carefully to
-determine why the kitten is not being selected.
-
-If some GUI applications are not using the choose-files kitten for their file
-select dialogs, then make sure the environment variables mentioned above are
-set, you can also try running the GUI application with them set explicitly,
-as::
-
-    QT_QPA_PLATFORMTHEME=xdgdesktopportal GTK_USE_PORTAL=1 my-gui-app
-
-Note that not all applications use portals, so if some particular application
-is failing to use the portal but others work, report the issue to that
-applications' developers.
-
-Configuration
-------------------------
-
-You can configure various aspects of the kitten's operation by creating a
-:file:`desktop-ui-portal.conf` in your :ref:`kitty config folder <confloc>`.
-See below for the supported configuration directives.
-
-
-.. include:: /generated/conf-kitten-desktop_ui.rst

docs/kittens/developing-builtin-kittens.rst

@@ -1,119 +0,0 @@
-Developing builtin kittens
-=============================
-
-Builtin kittens in kitty are written in the Go language, with small Python
-wrapper scripts to define command line options and handle UI integration.
-
-Getting started
------------------------
-
-To get started with creating a builtin kitten, one that will become part of kitty
-and be available as ``kitten my-kitten``, create a directory named
-:file:`my_kitten` in the :file:`kittens` directory. Then, in this directory
-add three, files: :file:`__init__.py` (an empty file), :file:`__main__.py` and
-:file:`main.go`.
-
-Template for `main.py`
-^^^^^^^^^^^^^^^^^^^^^^
-
-The file :file:`main.py` contains the command line option definitions for your kitten. Change the actual options and help text below as needed.
-
-.. code-block:: python
-
-    #!/usr/bin/env python
-    # License: GPL v3 Copyright: 2018, Kovid Goyal <kovid at kovidgoyal.net>
-
-    import sys
-
-    # See the file kitty/cli.py in the kitty sourcecode for more examples of
-    # the syntax for defining options
-    OPTIONS = r'''
-    --some-string-option -s
-    default=my_default_value
-    Help text for a simple option taking a string value.
-
-
-    --some-boolean-option -b
-    type=bool-set
-    Help text for a boolean option defaulting to false.
-
-
-    --some-inverted-boolean-option
-    type=bool-unset
-    Help text for a boolean option defaulting to true.
-
-
-    --an-integer-option
-    type=int
-    default=13
-    bla bla
-
-
-    --an-enum-option
-    choices=a,b,c,d
-    default=a
-    This option can only take the values a, b, c, or d
-    '''.format
-
-    help_text = '''\
-    The introductory help text for your kitten.
-
-    Can contain multiple paragraphs with :bold:`bold`
-    :green:`colored`, :code:`code`, :link:`links <http://url>` etc.
-    formatting.
-
-    Option help strings can also use this formatting.
-    '''
-
-    # The usage string for your kitten
-    usage = 'TITLE [BODY ...]'
-    short_description = 'some short description of your kitten it will show up when running kitten without arguments to list all kittens`
-
-    if __name__ == '__main__':
-        raise SystemExit('This should be run as kitten my-kitten')
-    elif __name__ == '__doc__':
-        cd = sys.cli_docs  # type: ignore
-        cd['usage'] = usage
-        cd['options'] = OPTIONS
-        cd['help_text'] = help_text
-        cd['short_desc'] = short_description
-
-
-Template for `main.go`
-^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: go
-
-    package my_kitten
-
-    import (
-        "fmt"
-
-        "kitty/tools/cli"
-    )
-
-    var _ = fmt.Print
-
-    func main(_ *cli.Command, opts *Options, args []string) (rc int, err error) {
-        // Here rc is the exit code for the kitten which should be 1 or higher if err is not nil
-        fmt.Println("Hello world!")
-        fmt.Println(args)
-        fmt.Println(fmt.Sprintf("%#v", opts))
-        return
-    }
-
-    func EntryPoint(parent *cli.Command) {
-        create_cmd(parent, main)
-    }
-
-Edit :file:`tools/cmd/tool/main.go`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Add the entry point of the kitten into :file:`tools/cmd/tool/main.go`.
-
-First, import the kitten into this file. To do this, add :code:`"kitty/kittens/my_kitten"` into the :code:`import ( ... )` section at the top.
-Then, add ``my_kitten.EntryPoint(root)`` into ``func KittyToolEntryPoints(root *cli.Command)`` and you are done. After running make you should
-be able to test your kitten by running::
-
-    kitten my-kitten
-

docs/kittens/diff.rst

@@ -64,17 +64,15 @@ Keyboard controls
 ===========================       ===========================
 Action                            Shortcut
 ===========================       ===========================
-Quit                              :kbd:`Q`
+Quit                              :kbd:`Q`, :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`, :kbd:`PgDn`, :kbd:`Ctrl+F`
-Scroll to previous page           :kbd:`PgUp`, :kbd:`Ctrl+B`
-Scroll down half page             :kbd:`Ctrl+D`
-Scroll up half page               :kbd:`Ctrl+U`
+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`
 Increase lines of context         :kbd:`+`
@@ -83,7 +81,7 @@ All lines of context              :kbd:`A`
 Restore default context           :kbd:`=`
 Search forwards                   :kbd:`/`
 Search backwards                  :kbd:`?`
-Clear search or exit              :kbd:`Esc`
+Clear search                      :kbd:`Esc`
 Scroll to next match              :kbd:`>`, :kbd:`.`
 Scroll to previous match          :kbd:`<`, :kbd:`,`
 Copy selection to clipboard       :kbd:`y`

docs/kittens/dnd.rst

@@ -1,53 +0,0 @@
-Drag and Drop
-==================================================
-
-.. only:: man
-
-    Overview
-    --------------
-
-    *Drag and drop of files from the shell*
-
-.. highlight:: sh
-
-
-The ``dnd`` kitten can be used to drag and drop files between
-the shell and arbitrary GUI programs, it even works over SSH, so you
-can easily and seamlessly transfer files from one computer to another,
-simply by dragging from one kitty window to another.
-Using it is as simple as::
-
-    kitten dnd file-to-drag.xyz
-
-Then, start dragging with the mouse inside the window, and :file:`file-to-drag.xyz`
-will be dragged and you can drop it onto a GUI file manager or another window
-running this kitten. You can specify directories as well to drag entire trees.
-
-Similarly, dropping works by running the kitten::
-
-    kitten dnd
-
-Then, drag some files from a GUI file manager or another window running the dnd kitten
-and drop them onto this window. The files will be copied or moved (depending on
-which area you drop them) into the current working directory.
-
-The best part is this works even over SSH. So if you just want to quickly
-transfer some files from one computer to another all you need to so is ssh into
-the remote computer::
-
-    kitten ssh remote-computer-name
-
-Then, run the dnd kitten on the remote computer::
-
-    kitten dnd files-or-dirs-to-drag
-
-That's it, you can now drag form or drop to the remote computer. See below for
-customising the behavior of the kitten via command line flags.
-
-This kitten uses a new protocol developed by kitty to function, for details,
-see :doc:`/dnd-protocol`.
-
-.. program:: kitty +kitten dnd
-
-
-.. include:: /generated/cli-kitten-dnd.rst

docs/kittens/hints.rst

@@ -51,9 +51,6 @@ You can also :doc:`customize what actions are taken for different types of URLs
    select that hint or press :kbd:`Enter` or :kbd:`Space` to select the empty
    hint.
 
-For mouse lovers, the hints kitten also allows you to click on any matched text to
-select it instead of typing the hint character.
-
 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

docs/kittens/hyperlinked_grep.rst

@@ -28,19 +28,19 @@ following contents:
 .. code:: conf
 
     # Open any file with a fragment in vim, fragments are generated
-    # by the hyperlink-grep kitten and nothing else so far.
+    # by the hyperlink_grep kitten and nothing else so far.
     protocol file
     fragment_matches [0-9]+
-    action launch --type=overlay --cwd=current vim +${FRAGMENT} -- ${FILE_PATH}
+    action launch --type=overlay --cwd=current vim +${FRAGMENT} ${FILE_PATH}
 
     # Open text files without fragments in the editor
     protocol file
     mime text/*
-    action launch --type=overlay --cwd=current -- ${EDITOR} -- ${FILE_PATH}
+    action launch --type=overlay --cwd=current ${EDITOR} ${FILE_PATH}
 
 Now, run a search with::
 
-    kitten hyperlinked-grep something
+    kitten hyperlinked_grep something
 
 Hold down the :kbd:`Ctrl+Shift` keys and click on any of the result lines, to
 open the file in :program:`vim` at the matching line. If you use some editor
@@ -51,7 +51,7 @@ accordingly. TO open links with the keyboard instead, use
 Finally, add an alias to your shell's rc files to invoke the kitten as
 :command:`hg`::
 
-    alias hg="kitten hyperlinked-grep"
+    alias hg="kitten hyperlinked_grep"
 
 
 You can now run searches with::

docs/kittens/notify.rst

@@ -1,43 +0,0 @@
-notify
-==================================================
-
-.. only:: man
-
-    Overview
-    --------------
-
-Show pop-up system notifications.
-
-.. highlight:: sh
-
-.. versionadded:: 0.36.0
-   The notify kitten
-
-The ``notify`` kitten can be used to show pop-up system notifications
-from the shell. It even works over SSH. Using it is as simple as::
-
-    kitten notify "Good morning" Hello world, it is a nice day!
-
-To add an icon, use::
-
-    kitten notify --icon-path /path/to/some/image.png "Good morning" Hello world, it is a nice day!
-    kitten notify --icon firefox "Good morning" Hello world, it is a nice day!
-
-
-To be informed when the notification is activated::
-
-    kitten notify --wait-for-completion "Good morning" Hello world, it is a nice day!
-
-Then, the kitten will wait till the notification is either closed or activated.
-If activated, a ``0`` is printed to :file:`STDOUT`. You can press the
-:kbd:`Esc` or :kbd:`Ctrl+c` keys to abort, closing the notification.
-
-To add buttons to the notification::
-
-    kitten notify --wait-for-completion --button One --button Two "Good morning" Hello world, it is a nice day!
-
-.. program:: kitty +kitten notify
-
-.. tip:: Learn about the underlying :doc:`/desktop-notifications` escape code protocol.
-
-.. include:: /generated/cli-kitten-notify.rst

docs/kittens/panel.rst

@@ -8,214 +8,41 @@ Draw a GPU accelerated dock panel on your desktop
     Overview
     --------------
 
-.. include:: ../quake-screenshots.rst
 
-Draw the desktop wallpaper or docks and panels using arbitrary
-terminal programs, For example, have `btop
-<https://github.com/aristocratos/btop>`__ or `cava
-<https://github.com/karlstav/cava/>`__ be your desktop wallpaper.
+You can use this kitten to draw a GPU accelerated panel on the edge of your
+screen, that shows the output from an arbitrary terminal program.
 
 It is useful for showing status information or notifications on your desktop
 using terminal programs instead of GUI toolkits.
 
 
-The screenshot to the side shows some uses of the panel kitten to draw various
-desktop components such as the background, a quick access floating terminal and
-a dock panel showing system information (Linux only).
+.. figure:: ../screenshots/panel.png
+   :alt: Screenshot, showing a sample panel
+   :align: center
+   :width: 100%
 
-.. versionadded:: 0.42.0
+   Screenshot, showing a sample panel
 
-   Support for macOS, see :ref:`compatibility matrix <panel_compat>` for details.
-   and X11 (background and overlay).
 
-.. versionadded:: 0.34.0
+The screenshot above shows a sample panel that displays the current desktop and
+window title as well as miscellaneous system information such as network
+activity, CPU load, date/time, etc.
 
-   Support for Wayland. See :ref:`below <panel_compat>` for which
-   Wayland compositors work.
+.. note::
+
+    This kitten currently only works on X11 desktops and Wayland compositors
+    that support the `wlr layer shell protocol
+    <https://wayland.app/protocols/wlr-layer-shell-unstable-v1#compositor-support>`__
+    (which is almost all of them except the usually crippled GNOME).
 
 Using this kitten is simple, for example::
 
-    kitten panel sh -c 'printf "\n\n\nHello, world."; sleep 5s'
+    kitty +kitten panel sh -c 'printf "\n\n\nHello, world."; sleep 5s'
 
 This will show ``Hello, world.`` at the top edge of your screen for five
-seconds. Here, the terminal program we are running is :program:`sh` with a script
+seconds. Here the terminal program we are running is :program:`sh` with a script
 to print out ``Hello, world!``. You can make the terminal program as complex as
-you like, as demonstrated in the screenshots.
-
-If you are on Wayland or macOS, you can, for instance, run::
-
-    kitten panel --edge=background htop
-
-to display ``htop`` as your desktop background. Remember this works in everything
-but GNOME and also, in sway, you have to disable the background wallpaper as
-sway renders that over the panel kitten surface.
-
-There are projects that make use of this facility to implement generalised
-panels and desktop components:
-
-.. _panel_projects:
-
-    * `kitty panel <https://github.com/5hubham5ingh/kitty-panel>`__
-    * `pawbar <https://github.com/codelif/pawbar>`__
-
-
-.. _remote_control_panel:
-
-Controlling panels via remote control
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can control panels via the kitty :doc:`remote control </remote-control>` facility. Create a panel
-with remote control enabled::
-
-    kitten panel -o allow_remote_control=socket-only --lines=2 \
-        --listen-on=unix:/tmp/panel kitten run-shell
-
-
-Now you can control this panel using remote control, for example to show/hide
-it, use::
-
-    kitten @ --to=unix:/tmp/panel resize-os-window --action=toggle-visibility
-
-To move the panel to the bottom of the screen and increase its height::
-
-    kitten @ --to=unix:/tmp/panel resize-os-window --action=os-panel \
-        --incremental edge=bottom lines=4
-
-To create a new panel running the program top, in the same instance
-(like creating a new OS window)::
-
-    kitten @ --to=unix:/tmp/panel launch --type=os-panel --os-panel edge=top \
-        --os-panel lines=8 top
+you like, as demonstrated in the screenshot above.
 
 
 .. include:: ../generated/cli-kitten-panel.rst
-
-
-.. _quake_ss:
-
-How the screenshots were generated
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The system statistics in the background were created using::
-
-    kitten panel --edge=background -o background_opacity=0.2 -o background=black btop
-
-This creates a kitty background window and inside it runs the `btop
-<https://github.com/aristocratos/btop>`__ program to display the statistics.
-
-The floating quick access window was created by running::
-
-    kitten quick-access-terminal kitten run-shell \
-       zsh -c 'printf "\e]66;s=4;Quick access kitty in Hyprland\a\n\n\n\nAlso uses kitty to draw desktop background\n"'
-
-This starts the quick access window and inside it runs ``kitten run-shell``, which
-in turn first runs ``zsh`` to print out the message and then starts the users login
-shell.
-
-The Linux dock panel was::
-
-    wm bar
-
-This is a custom program I wrote for my personal use. It uses kitty's kitten
-infrastructure to implement the bar in a `few hundred lines of code
-<https://github.com/kovidgoyal/wm/blob/master/bar/main.go>`__.
-This was designed for my personal use only, but, there are :ref:`public projects implementing
-general purpose panels using kitty <panel_projects>`.
-
-
-.. _panel_compat:
-
-Compatibility with various platforms
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. only:: man
-
-   See the HTML documentation for the compatibility matrix.
-
-.. only:: not man
-
-    Generated with the help of the :file:`panels.py` test script.
-
-    .. tab:: Wayland
-
-        Below is a list of the status of various Wayland compositors. The panel kitten
-        relies on the `wlr layer shell protocol
-        <https://wayland.app/protocols/wlr-layer-shell-unstable-v1#compositor-support>`__,
-        which is technically supported by almost all Wayland compositors, but the
-        implementation in some of them is quite buggy.
-
-        🟢 **Hyprland**
-           Fully working, no known issues
-
-        🟢 **labwc**
-           Fully working, no known issues
-
-        🟢 **niri**
-           Fully working, no known issues
-
-        🟢 **river**
-           Fully working, no known issues
-
-        🟢 **Xfce**
-           Fully working, no known issues
-
-        🟠 **KDE** (kwin)
-           Mostly working, except that clicks outside background panels cause kwin to :iss:`erroneously hide the panel <8715>`. KDE uses an `undocumented mapping <https://invent.kde.org/plasma/kwin/-/blob/3dc5cee6b34792486b343098e55e7f2b90dfcd00/src/layershellv1window.cpp#L24>`__ under Wayland to set the window type from the :code:`kitten panel --app-id` flag. You might want to use :code:`--app-id=dock` so that KDE treats the window as a dock panel, and disables window appearing/disappearing animations for it.
-
-        🟠 **Sway**
-           Renders its configured background over the background window instead of
-           under it. This is because it uses the wlr protocol for backgrounds itself.
-
-        🔴 **GNOME** (mutter)
-           Does not implement the wlr protocol at all, nothing works.
-
-    .. tab:: macOS
-
-        Mostly everything works, with the notable exception that dock panels do not
-        prevent other windows from covering them. This is because Apple does not
-        provide and way to do this in their APIs.
-
-    .. tab:: X11
-
-        Support is highly dependent on the quirks of individual window
-        managers. See the matrix below:
-
-        .. list-table:: Compatibility matrix
-           :header-rows: 1
-           :stub-columns: 1
-
-           * - WM
-             - Desktop
-             - Dock
-             - Quick
-             - Notes
-
-           * - KDE
-             - 🟠
-             - 🟢
-             - 🟢
-             - transparency does not work for :option:`--edge=background <--edge>`
-
-           * - GNOME
-             - 🟢
-             - 🟢
-             - 🟢
-             -
-
-           * - XFCE
-             - 🟢
-             - 🟢
-             - 🟢
-             -
-
-           * - i3
-             - 🔴
-             - 🟠
-             - 🔴
-             - only top and bottom dock panels, without transparency
-
-           * - xmonad
-             - 🔴
-             - 🔴
-             - 🔴
-             - doesn't support the needed NET_WM protocols

docs/kittens/query_terminal.rst

@@ -17,9 +17,8 @@ slow, since it requires a roundtrip to the terminal emulator and back.
 If you want to do some of the same querying in your terminal program without
 depending on the kitten, you can do so, by processing the same escape codes.
 Search `this page <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html>`__
-for *XTGETTCAP* to see the syntax for the escape code. The kitty specific keys
-are all documented below, when sent via escape code they must be prefixed with
-``kitty-query-``.
+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.
 
 
 .. include:: ../generated/cli-kitten-query_terminal.rst

docs/kittens/quick-access-terminal.rst

@@ -1,84 +0,0 @@
-.. _quake:
-
-Make a Quake like quick access terminal
-====================================================================================================
-
-.. highlight:: sh
-
-.. only:: man
-
-    Overview
-    --------------
-
-
-.. include:: ../quake-screenshots.rst
-
-.. versionadded:: 0.42.0
-   See :ref:`here for what platforms it works on <panel_compat>`.
-
-This kitten can be used to make a quick access terminal, that appears and
-disappears at a key press. To do so use the following command:
-
-.. code-block:: sh
-
-    kitten quick-access-terminal
-
-Run this command in a terminal, and a quick access kitty window will show up at
-the top of your screen. Run it again, and the window will be hidden.
-
-To make the terminal appear and disappear at a key press:
-
-.. |macOs| replace:: :guilabel:`System Preferences->Keyboard->Keyboard Shortcuts->Services->General`
-
-.. only:: not man
-
-    .. tab:: Linux
-
-        Simply bind the above command to some key press in your window manager or desktop
-        environment settings and then you have a quick access terminal at a single key press.
-
-    .. tab:: macOS
-
-        In kitty, run the above command to show the quick access window, then close
-        it by running the command again or pressing :kbd:`ctrl+d`. Now go to |macOS| and set a shortcut for
-        the :guilabel:`Quick access to kitty` entry.
-
-.. only:: man
-
-    In Linux, simply assign the above command to a global shortcut in your
-    window manager. In macOS, go to |macOS| and set a shortcut
-    for the :guilabel:`Quick access to kitty` entry.
-
-Configuration
-------------------------
-
-You can configure the appearance and behavior of the quick access window
-by creating a :file:`quick-access-terminal.conf` file in your
-:ref:`kitty config folder <confloc>`. In particular, you can use the
-:opt:`kitty_conf <kitten-quick_access_terminal.kitty_conf>` option to change
-various kitty settings, just for the quick access window.
-
-.. note::
-
-   This kitten uses the :doc:`panel kitten </kittens/panel>` under the
-   hood. You can use the :ref:`techniques described there <remote_control_panel>`
-   for remote controlling the quick access window, remember to add
-   ``kitty_override allow_remote_control=socket-only`` and ``kitty_override
-   listen_on=unix:/tmp/whatever`` to
-   :file:`quick-access-terminal.conf`.
-
-See below for the supported configuration directives:
-
-
-.. include:: /generated/conf-kitten-quick_access_terminal.rst
-
-
-.. include:: /generated/cli-kitten-quick_access_terminal.rst
-
-
-Sample quick-access-terminal.conf
----------------------------------------
-
-You can download a sample :file:`quick-access-terminal.conf` file with all default settings and
-comments describing each setting by clicking: :download:`sample quick-access-terminal.conf
-</generated/conf/quick_access_terminal.conf>`.

docs/kittens/ssh.rst

@@ -116,14 +116,14 @@ this could be achieved using the ssh kitten with :program:`zsh` and
    hostname myserver-*
 
    # Setup zsh to read its files from my-conf/zsh
-   env ZDOTDIR=$HOME/my-conf/zsh
+   env ZDOTDIR $HOME/my-conf/zsh
    copy --dest my-conf/zsh/.zshrc .zshrc
    copy --dest my-conf/zsh/.zshenv .zshenv
    # If you use other zsh init files add them in a similar manner
 
    # Setup vim to read its config from my-conf/vim
-   env VIMINIT=$HOME/my-conf/vim/vimrc
-   env VIMRUNTIME=$HOME/my-conf/vim
+   env VIMINIT $HOME/my-conf/vim/vimrc
+   env VIMRUNTIME $HOME/my-conf/vim
    copy --dest my-conf/vim .vim
    copy --dest my-conf/vim/vimrc .vimrc
 

docs/kittens/themes.rst

@@ -42,53 +42,6 @@ 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.
 
-
-.. note::
-
-   If you want to have some color settings in your :file:`kitty.conf` that the
-   theme kitten does not override, move them into a separate conf file and
-   ``include`` it into kitty.conf. The include should be placed after the
-   inclusion of :file:`current-theme.conf` so that the settings in it override
-   conflicting settings from :file:`current-theme.conf`.
-
-
-.. _auto_color_scheme:
-
-Change color themes automatically when the OS switches between light and dark
---------------------------------------------------------------------------------
-
-.. versionadded:: 0.38.0
-
-You can have kitty automatically change its color theme when the OS switches
-between dark, light and no-preference modes. In order to do this, run the theme
-kitten as normal and at the final screen select the option to save your chosen
-theme as either light, dark, or no-preference. Repeat until you have chosen
-a theme for each of the three modes. Then, once you restart kitty, it will
-automatically use your chosen themes depending on the OS color scheme.
-
-This works by creating three files: :file:`dark-theme.auto.conf`,
-:file:`light-theme.auto.conf` and :file:`no-preference-theme.auto.conf` in the
-kitty config directory. When these files exist, kitty queries the OS for its color scheme
-and uses the appropriate file. Note that the colors in these files override all other
-colors, and also all background image settings,
-even those specified using the :option:`kitty --override` command line flag.
-kitty will also automatically change colors when the OS color scheme changes,
-for example, during night/day transitions.
-
-When using these colors, you can still dynamically change colors, but the next
-time the OS changes its color mode, any dynamic changes will be overridden.
-
-
-.. note::
-
-   On the GNOME desktop, the desktop reports the color preference as no-preference
-   when the "Dark style" is not enabled. So use :file:`no-preference-theme.auto.conf` to
-   select colors for light mode on GNOME. You can manually enable light style
-   with ``gsettings set org.gnome.desktop.interface color-scheme prefer-light``
-   in which case GNOME will report the color scheme as light and kitty will use
-   :file:`light-theme.auto.conf`.
-
-
 Using your own themes
 -----------------------
 

docs/kittens_intro.rst

@@ -11,13 +11,7 @@ Extend with kittens
    kittens/diff
    kittens/unicode_input
    kittens/themes
-   kittens/choose-fonts
    kittens/hints
-   kittens/command-palette
-   kittens/quick-access-terminal
-   kittens/choose-files
-   kittens/dnd
-   kittens/panel
    kittens/remote_file
    kittens/hyperlinked_grep
    kittens/transfer
@@ -47,38 +41,11 @@ Some prominent kittens:
     Preview and quick switch between over three hundred color themes.
 
 
-:doc:`Fonts <kittens/choose-fonts>`
-    Preview, fine-tune and quick switch the fonts used by kitty.
-
-
 :doc:`Hints <kittens/hints>`
     Select and open/paste/insert arbitrary text snippets such as URLs,
     filenames, words, lines, etc. from the terminal screen.
 
 
-:doc:`Command palette <kittens/command-palette>`
-    Browse, search and trigger all keyboard shortcuts and actions from a
-    single searchable overlay.
-
-
-:doc:`Quick access terminal <kittens/quick-access-terminal>`
-    Get access to a quick access floating, semi-transparent kitty window
-    with a single keypress.
-
-
-:doc:`Panel <kittens/panel>`
-    Draw the desktop wallpaper or docks and panels using arbitrary
-    terminal programs.
-
-
-:doc:`Choose files <kittens/choose-files>`
-    Preview and select files at the speed of thought
-
-
-:doc:`Drag and drop from the shell <kittens/dnd>`
-    Drag and drop files from/to GUI programs from your shell, even over SSH
-
-
 :doc:`Remote file <kittens/remote_file>`
     Edit, open, or download remote files over SSH easily, by simply clicking on
     the filename.
@@ -107,6 +74,11 @@ Some prominent kittens:
     configuration to the remote host.
 
 
+: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.
 

docs/launch.rst

@@ -114,102 +114,49 @@ Watching launched windows
 
 The :option:`launch --watcher` option allows you to specify Python functions
 that will be called at specific events, such as when the window is resized or
-closed. Note that you can also specify watchers that are loaded for all windows,
-via :opt:`watcher`. To create a watcher, specify the path to a Python module
-that specifies callback functions for the events you are interested in, for
-create :file:`~/.config/kitty/mywatcher.py` and use :option:`launch --watcher` = :file:`mywatcher.py`:
+closed. Simply specify the path to a Python module that specifies callback
+functions for the events you are interested in, for example:
 
 .. code-block:: python
 
-    # ~/.config/kitty/mywatcher.py
-    from typing import Any
+    from typing import Any, Dict
 
     from kitty.boss import Boss
     from kitty.window import Window
 
 
-    def on_load(boss: Boss, data: dict[str, Any]) -> None:
-        # This is a special function that is called just once when this watcher
-        # module is first loaded, can be used to perform any initialization/one
-        # time setup. Any exceptions in this function are printed to kitty's
-        # STDERR but otherwise ignored.
-        ...
-
-    def on_resize(boss: Boss, window: Window, data: dict[str, Any]) -> None:
+    def on_resize(boss: Boss, window: Window, data: Dict[str, Any]) -> None:
         # Here data will contain old_geometry and new_geometry
-        # Note that resize is also called the first time a window is created
-        # which can be detected as old_geometry will have all zero values, in
-        # particular, old_geometry.xnum and old_geometry.ynum will be zero.
-        ...
 
-    def on_focus_change(boss: Boss, window: Window, data: dict[str, Any])-> None:
+    def on_focus_change(boss: Boss, window: Window, data: Dict[str, Any])-> None:
         # Here data will contain focused
-        ...
 
-    def on_close(boss: Boss, window: Window, data: dict[str, Any])-> None:
+    def on_close(boss: Boss, window: Window, data: Dict[str, Any])-> None:
         # called when window is closed, typically when the program running in
         # it exits
-        ...
 
-    def on_set_user_var(boss: Boss, window: Window, data: dict[str, Any]) -> None:
+    def on_set_user_var(boss: Boss, window: Window, data: Dict[str, Any]) -> None:
         # called when a "user variable" is set or deleted on a window. Here
         # data will contain key and value
-        ...
 
-    def on_title_change(boss: Boss, window: Window, data: dict[str, Any]) -> None:
+    def on_title_change(boss: Boss, window: Window, data: Dict[str, Any]) -> None:
         # called when the window title is changed on a window. Here
         # data will contain title and from_child. from_child will be True
         # when a title change was requested via escape code from the program
         # running in the terminal
-        ...
 
-    def on_cmd_startstop(boss: Boss, window: Window, data: dict[str, Any]) -> None:
+    def on_cmd_startstop(boss: Boss, window: Window, data: Dict[str, Any]) -> None:
         # called when the shell starts/stops executing a command. Here
-        # data will contain is_start, cmdline and time.
-        ...
-
-    def on_color_scheme_preference_change(boss: Boss, window: Window, data: dict[str, Any]) -> None:
-        # called when the color scheme preference of this window changes from
-        # light to dark or vice versa. data contains is_dark and via_escape_code
-        # the latter will be true if the color scheme was changed via escape
-        # code received from the program running in the window
-        ...
-
-    def on_tab_bar_dirty(boss: Boss, window: Window, data: dict[str, Any]) -> None:
-        # called when any changes happen to the tab bar, such a new tabs being
-        # created, tab titles changing, tabs moving, etc. Useful to display the
-        # tab bar externally to kitty. This is called even if the tab bar is
-        # hidden. Note that this is called only in *global watchers*, that is
-        # watchers defined in kitty.conf or using the --watcher command line
-        # flag. data contains tab_manager which is the object responsible for
-        # managing all tabs in a single OS Window.
-        ...
-
-    def on_quit(boss: Boss, window: Window, data: dict[str, Any]) -> None:
-        # called when kitty is about to quit. This is called in *global watchers*
-        # only. It is called twice: once before the quit confirmation dialog is
-        # shown (data['confirmed'] will be False) and once after the user has
-        # confirmed quitting (data['confirmed'] will be True). Setting
-        # data['aborted'] to True will abort the quit in both cases.
-        ...
-
+        # data will contain is_start and time.
 
 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 a dict
-that contains event dependent data. You have full access to kitty internals in
-the watcher scripts, however kitty internals are not documented/stable so for
-most things you are better off using the kitty :doc:`Remote control API </remote-control>`.
-Simply call :code:`boss.call_remote_control()`, with the same arguments you
-would pass to ``kitten @``. For example:
-
-.. code-block:: python
-
-    def on_resize(boss: Boss, window: Window, data: dict[str, Any]) -> None:
-        # send some text to the resized window
-        boss.call_remote_control(window, ('send-text', f'--match=id:{window.id}', 'hello world'))
-
-Run, ``kitten @ --help`` in a kitty terminal, to see all the remote control
-commands available to you.
+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,
+``window.child.pid`` is the PID of the processes that was launched
+in the window and ``window.id`` is the internal kitty ``id`` of the window.
 
 
 Finding executables

docs/layouts.rst

@@ -179,48 +179,16 @@ define a few extra key bindings in :file:`kitty.conf`::
     map ctrl+up neighboring_window up
     map ctrl+down neighboring_window down
 
-    # Set the bias of the split containing the currently focused window. The
-    # currently focused window will take up the specified percent of its parent
-    # window's size.
-    map ctrl+. layout_action bias 80
-
-    # Maximize the active window along the horizontal axis (fill full width),
-    # keeping other windows visible in their vertical positions. Press again to
-    # restore the original layout.
-    map ctrl+shift+right layout_action maximize horizontal
-
-    # Maximize the active window along the vertical axis (fill full height),
-    # keeping other windows visible in their horizontal positions. Press again
-    # to restore the original layout.
-    map ctrl+shift+up layout_action maximize vertical
-
-    # Equalize all splits so that windows share available space proportionally.
-    map ctrl+shift+e layout_action equalize
-
-
 Windows can be resized using :ref:`window_resizing`. 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``. The ``maximize`` action expands the active
-window to fill the maximum available space along a single axis while keeping
-the rest of the layout intact. Use ``maximize horizontal`` to fill the full
-width and ``maximize vertical`` to fill the full height. Calling it again
-restores the original split sizes. The ``equalize`` action redistributes space
-so that all windows along each split axis receive an equal share.
+and swap with an argument of ``270``.
 
-This layout takes two options. ``equalize_on_close`` automatically equalizes
-split sizes whenever a window is closed, keeping remaining windows balanced
-without needing an explicit keybinding::
-
-    enabled_layouts splits:equalize_on_close=true
-
-``split_axis`` controls whether new windows
-are placed into vertical or horizontal splits when a :option:`--location
-<launch --location>` is not specified. A value of ``horizontal`` (same as
-``--location=vsplit``) means when a new split is created the two windows will
-be placed side by side and a value of ``vertical`` (same as
-``--location=hsplit``) means the two windows will be placed one on top of the
-other. A value of ``auto`` means the axis of the split is chosen automatically
-(same as ``--location=split``). By default::
+This layout takes one option, ``split_axis`` that controls whether new windows
+are placed into vertical or horizontal splits when a :option:`--location <launch
+--location>` is not specified. A value of ``horizontal`` (same as
+``--location=vsplit``) means when a new split is created the two windows will be
+placed side by side and a value of ``vertical`` (same as ``--location=hsplit``)
+means the two windows will be placed one on top of the other. By default::
 
     enabled_layouts splits:split_axis=horizontal
 
@@ -289,14 +257,7 @@ All windows are shown one below the other. This layout has no options::
 Resizing windows
 ------------------
 
-You can resize windows inside layouts. The easiest method is to simply drag the
-window borders using a mouse, controlled by the option :opt:`window_drag_tolerance`.
-Note that technically this resizes layout slots not actual windows, so it
-does not work exactly like resizing OS Windows on your desktop. Instead, the
-layout is changed and potentially multiple windows get resized when dragging a
-single border.
-
-For keyboard friendly resizing, press :sc:`start_resizing_window` (also
+You can resize windows inside layouts. Press :sc:`start_resizing_window` (also
 :kbd:`⌘+r` on macOS) to enter resizing mode and follow the on-screen
 instructions. In a given window layout only some operations may be possible for
 a particular window. For example, in the *Tall* layout you can make the first

docs/mapping.rst

@@ -167,33 +167,6 @@ the program running in the terminal, map it to :ac:`discard_event`::
 
 .. _conditional_mappings:
 
-Configuring a timeout
-----------------------
-
-You can also set a timeout for keyboard modes and multi-key mappings. If a
-timeout is set and you don't complete the key sequence or exit the mode within
-the specified time, the mode will be automatically cancelled. This is useful
-for multi-key mappings where you might accidentally press the first key and
-then change your mind. The timeout is specified in seconds and can be set
-globally using the :opt:`map_timeout` option or per-mode using ``--timeout``::
-
-    # Set a global 2 second timeout for all multi-key and modal mappings
-    map_timeout 2.0
-
-    # This mode will have a 5 second timeout (overrides global setting)
-    map --new-mode resize --timeout 5.0 kitty_mod+r
-    map --mode resize h resize_window narrower
-    map --mode resize l resize_window wider
-    # ... more mappings
-
-    # Multi-key mapping with the global timeout
-    map ctrl+a>h new_window
-
-When a timeout occurs, the mode is exited and any buffered keys are discarded.
-A timeout value of zero disables the timeout. For multi-key sequences, the
-timeout is restarted after each valid key press in the sequence.
-
-
 Conditional mappings depending on the state of the focused window
 ----------------------------------------------------------------------
 
@@ -221,15 +194,15 @@ running an editor::
 
     map --when-focus-on var:in_editor kitty_mod+c
 
-In order to make this work, you need to configure your editor as shown below:
+In order to make this work, you need to configure your editor as show below:
 
 .. tab:: vim
 
    In :file:`~/.vimrc` add:
     .. code-block:: vim
 
-        let &t_ti = &t_ti . "\033]1337;SetUserVar=in_editor=MQ==\007"
-        let &t_te = &t_te . "\033]1337;SetUserVar=in_editor\007"
+        let &t_ti = &t_ti . "\\033]1337;SetUserVar=in_editor=MQo\\007"
+        let &t_te = &t_te . "\\033]1337;SetUserVar=in_editor\\007"
 
 .. tab:: neovim
 
@@ -237,25 +210,17 @@ In order to make this work, you need to configure your editor as shown below:
 
     .. code-block:: lua
 
-        vim.api.nvim_create_autocmd({ "VimEnter", "VimResume", "UIEnter" }, {
+        vim.api.nvim_create_autocmd({ "VimEnter", "VimResume" }, {
             group = vim.api.nvim_create_augroup("KittySetVarVimEnter", { clear = true }),
             callback = function()
-                if vim.api.nvim_ui_send then
-                    vim.api.nvim_ui_send("\x1b]1337;SetUserVar=in_editor=MQ==\007")
-                else
-                    io.stdout:write("\x1b]1337;SetUserVar=in_editor=MQ==\007")
-                end
+                io.stdout:write("\x1b]1337;SetUserVar=in_editor=MQo\007")
             end,
         })
 
         vim.api.nvim_create_autocmd({ "VimLeave", "VimSuspend" }, {
             group = vim.api.nvim_create_augroup("KittyUnsetVarVimLeave", { clear = true }),
             callback = function()
-                if vim.api.nvim_ui_send then
-                    vim.api.nvim_ui_send("\x1b]1337;SetUserVar=in_editor\007")
-                else
-                    io.stdout:write("\x1b]1337;SetUserVar=in_editor\007")
-                end
+                io.stdout:write("\x1b]1337;SetUserVar=in_editor\007")
             end,
         })
 
@@ -265,67 +230,6 @@ copying to clipboard. In the editor, you can map it to copy to the clipboard,
 thereby allowing use of a common shortcut both inside and outside the editor
 for copying to clipboard.
 
-.. note::
-
-   When using multi-key mappings, of the form :kbd:`k1>k2` or similar, the
-   condition applies to the first key and you can have only one condition per
-   key, the last in kitty.conf wins. In particular, this means you cannot have
-   multiple conditions applying to multi-key mappings with the same first key
-   and you cannot have mappings with and without conditions applying to multi-keys
-   with the same first key.
-
-
-.. _mapping-fallback:
-
-Non-Latin keyboard layout support
---------------------------------------
-
-When using a non-Latin keyboard layout (e.g. Russian, Arabic, Greek), letter-key
-shortcuts like :kbd:`Ctrl+C` stop working because the key produces a non-Latin
-character. kitty solves this with the ``--allow-fallback`` option on the ``map``
-directive, which controls how shortcuts fall back to the physical key position.
-
-The ``--allow-fallback`` option accepts a comma-separated list of fallback types:
-
-``shifted``
-    Fall back to the *shifted key* — the character produced when Shift is held
-    with the key. This is the default for all mappings and preserves the existing
-    behavior.
-
-``ascii``
-    Fall back to the *alternate key* — the character that the physical key would
-    produce in a standard US layout. This only triggers when the key produces a
-    non-ASCII character, so it has no effect on Latin-based layouts like Dvorak
-    or Colemak.
-
-``none``
-    Disable all fallback matching. The mapping will only match the exact key
-    specified, ignoring both shifted and alternate key positions.
-
-For example::
-
-    # Enable both shifted and ASCII fallback (used by default kitty shortcuts)
-    map --allow-fallback=shifted,ascii kitty_mod+c copy_to_clipboard
-
-    # Only ASCII fallback, no shifted key fallback
-    map --allow-fallback=ascii ctrl+s save_something
-
-    # Disable all fallback (neither shifted nor alternate key matching)
-    map --allow-fallback=none ctrl+x some_action
-
-All default kitty shortcuts use ``--allow-fallback=shifted,ascii``, so they work
-out of the box with non-Latin layouts. Custom mappings without an explicit
-``--allow-fallback`` get the default value of ``shifted``, which preserves
-backward compatibility.
-
-.. note::
-
-   The ``ascii`` fallback uses a non-ASCII guard: it only activates when
-   the key produces a character with a Unicode code point above 127. This means
-   alternative Latin layouts (Dvorak, Colemak, etc.) are never affected by the
-   ``ascii`` fallback — only non-Latin layouts trigger it.
-
-
 Sending arbitrary text or keys to the program running in kitty
 --------------------------------------------------------------------------------
 
@@ -406,7 +310,7 @@ below::
 
     # Beep on unknown keys
     map --new-mode XXX --on-unknown beep ...
-    # Ignore unknown keys silently
+    # Ingore unknown keys silently
     map --new-mode XXX --on-unknown ignore ...
     # Beep and exit the keyboard mode on unknown key
     map --new-mode XXX --on-unknown end ...

docs/misc-protocol.rst

@@ -1,60 +0,0 @@
-Miscellaneous protocol extensions
-==============================================
-
-These are a few small protocol extensions kitty implements, primarily for use
-by its own kitten, they are documented here for completeness.
-
-
-Simple save/restore of all terminal modes
---------------------------------------------
-
-XTerm has the XTSAVE/XTRESTORE escape codes to save and restore terminal
-private modes. However, they require specifying an explicit list of modes to
-save/restore. kitty extends this protocol to specify that when no modes are
-specified, all side-effect free modes should be saved/restored. By side-effects
-we mean things that can affect other terminal state such as cursor position or
-screen contents. Examples of modes that have side effects are: `DECOM
-<https://vt100.net/docs/vt510-rm/DECOM.html>`__ and `DECCOLM
-<https://vt100.net/docs/vt510-rm/DECCOLM.html>`__.
-
-This allows TUI applications to easily save and restore emulator state without
-needing to maintain lists of modes.
-
-
-Independent control of bold and faint SGR properties
--------------------------------------------------------
-
-In common terminal usage, bold is set via SGR 1 and faint by SGR 2. However,
-there is only one number to reset these attributes, SGR 22, which resets both.
-There is no way to reset one and not the other. kitty uses 221 and 222 to reset
-bold and faint independently.
-
-.. _mouse_leave_window:
-
-Reporting when the mouse leaves the window
-----------------------------------------------
-
-kitty extends the SGR Pixel mouse reporting protocol created by xterm to
-also report when the mouse leaves the window. This event is delivered
-encoded as a normal SGR pixel event except that the eight bit is set on the
-first number. Additionally, bit 5 is set to indicate this is a motion related event.
-The remaining bits 1-7 (except 5) are used to encode button and modifier information.
-When bit 8 is set it means the event is a mouse has left the window event,
-and all other bits should be ignored. The pixel position values must also
-be ignored as they may not be accurate.
-
-An escape code to move the contents of the screen into the scrollback
--------------------------------------------------------------------------------------
-
-The escape code is ``\x1b [ 22 J`` (ignoring spaces present for clarity). It
-moves all screen contents (text and images) into the scrollback leaving the
-screen in the same state as it would be if the standard screen clear escape
-code had been used ``\x1b [ 2 J``.
-
-
-kitty specific private escape codes
----------------------------------------
-
-These are a family of escape codes used by kitty for various things including
-remote control. They are all DCS (Device Control String) escape codes starting
-with ``\x1b P @ kitty-`` (ignoring spaces present for clarity).

docs/multiple-cursors-protocol.rst

@@ -1,247 +0,0 @@
-The multiple cursors protocol
-==============================================
-
-.. versionadded:: 0.43.0
-
-Many editors support something called *multiple cursors* in which you can make
-the same changes at multiple locations in a file and the editor shows you
-cursors at each of the locations. In a terminal context editors typically
-implement this by showing some Unicode glyph at each location instead of the
-actual cursor. This is sub-optimal since actual cursors implemented by the
-terminal have many niceties like smooth animation [anim]_, auto adjust colors [rv]_,
-etc. To address this and other use cases, this protocol allows terminal programs to
-request that the terminal display multiple cursors at specific locations on the
-screen.
-
-Quickstart
-----------------
-
-An example, showing how to use the protocol:
-
-.. code-block:: sh
-
-    # Show cursors of the same shape as the main cursor at y=4, x=5
-    printf "\e[>29;2:4:5 q"
-    # Show more cursors on the seventh line, of various shapes, the underline shape is shown twice
-    printf "\e[>1;2:7:1 q\e[>2;2:7:3 q\e[>3;2:7:5;2:7:7 q"
-
-
-The escape code to show a cursor has the following structure (ignore spaces
-they are present for readability only)::
-
-    CSI > SHAPE;CO-ORD TYPE : CO-ORDINATES ; CO-ORD TYPE : CO-ORDINATES ... TRAILER
-
-Here ``CSI`` is the two bytes ESC (``0x1b``) and [ (``0x5b``). ``SHAPE`` can be
-one of:
-
-* ``0``: No cursor
-* ``1``: Block cursor
-* ``2``: Beam cursor
-* ``3``: Underline cursor
-* ``29``: Follow the shape of the main cursor
-* ``30``: Change the color of text under extra cursors
-* ``40``: Change the color of extra cursors
-* ``100``: Used for querying currently set cursors
-
-``CO-ORD TYPE`` can be one of:
-
-* ``0``: This refers to the position of the main cursor and has no following
-  co-ordinates.
-
-* ``2``: In this case the following co-ordinates are pairs of numbers pointing
-  to cells in the form ``y:x`` with the origin in the top left corner at
-  ``1,1``. There can be any number of pairs, the terminal must treat each pair
-  as a new location to set a cursor.
-
-* ``4``: In this case the following co-ordinates are sets of four numbers that
-  define a rectangle in the same co-ordinate system as above of the form:
-  ``top:left:bottom:right``. The shape is set on every cell in the rectangle
-  from the top left cell to the bottom right cell, inclusive. If no numbers
-  are provided, the rectangle is the full screen. There can be any number of
-  rectangles, the terminal must treat each set of four numbers as a new
-  rectangle.
-
-The sequence of ``CO-ORD TYPE : CO-ORDINATES`` can be repeated any number of
-times separated by ``;``. The ``SHAPE`` will be set on the cells indicated by
-each such group. For example: ``-1;2:3:4;4:5:6:7:8`` will set the shape ``-1``
-at the cell ``(3, 2)`` and in the rectangle ``(6, 5)`` to ``(8, 7)`` inclusive.
-
-Finally, the ``TRAILER`` terminates the sequence and is the bytes SPACE
-(``0x20``) and q (``0x71``).
-
-Terminals **must** ignore cells that fall outside the screen. That means, for
-rectangle co-ordinates only the intersection of the rectangle with the screen
-must be considered, and point co-ordinates that fall outside of the screen are
-simply ignored, with no effect.
-
-Terminals **must** ignore extra co-ordinates, that means if an odd number of
-co-ordinates are specified for type ``2`` the last co-ordinate is ignored.
-Similarly for type ``4`` if the number of co-ordinates is not a multiple of
-four, the last ``1 <= n <= 3`` co-ordinates are ignored, as if they were not
-specified.
-
-Querying for support
--------------------------
-
-A terminal program can query the terminal emulator for support of this
-protocol by sending the escape code::
-
-    CSI > TRAILER
-
-In this case a supporting terminal must reply with::
-
-    CSI > 1;2;3;29;30;40;100;101 TRAILER
-
-Here, the list of numbers indicates the cursor shapes and other operations
-the terminal supports and can be any subset of the above. No numbers
-indicates the protocol is not supported. To avoid having to wait with a
-timeout for a response from the terminal, the client should send this
-query code immediately followed by a request for the
-`primary device attributes <https://vt100.net/docs/vt510-rm/DA1.html>`_.
-If the terminal responds with an answer for the device attributes without
-an answer for the *query* the terminal emulator does not support this protocol at all.
-
-Terminals **must** respond to these queries in FIFO order, so that
-multiplexers that split a single screen know which split to send responses too.
-
-Clearing previously set multi-cursors
-------------------------------------------
-
-The cursor at a cell is cleared by setting its shape to ``0``.
-The most common operation is to clear all previously set multi-cursors. This is
-easily done using the *rectangle* co-ordinate system above, like this::
-
-    CSI > 0;4 TRAILER
-
-For more precise control different co-ordinate types can be used. This is
-particularly important for multiplexers that split up the screen and therefore
-need to re-write these escape codes.
-
-.. _extra_cursor_color:
-
-Changing the color of extra cursors
----------------------------------------
-
-In order to visually distinguish extra cursors from the main cursor, it is
-possible to specify a color pair for extra cursors. Note that for performance
-reasons, there is only a single color pair that all extra cursors share.
-The color pair consists of the cursor color and the color for text in the cell
-the cursor is on.
-
-To change this color pair use an escape code of the form::
-
-    CSI > WHICH ; COLOR_SPACE : COLOR_PARAMETER1 : COLOR_PARAMETER2 : ... TRAILER
-
-Here, ``WHICH`` is ``30`` to set the color of text under the cursor and ``40``
-to set the color of the cursor itself (these numbers mimic the SGR codes for
-foreground and background respectively).
-
-The ``COLOR_SPACE`` parameter sets the type of color, it can take values:
-
-``0`` - unset color is same as for main cursor. No color parameters.
-``1`` - *special* which typically means some kind of reverse video effect, see below
-``2`` - sRGB color, with three color parameters, red, green and blue as numbers
-from 0 to 255
-``5`` - Indexed color with one color parameter which is an index into the color
-table from 0 to 255
-
-When the cursor color is set to *special* via ``40`` it means the block cursor
-must be rendered with a reverse video effect where the cursor color becomes the
-foreground color of the cell under the cursor and the foreground color of the
-cell becomes its background color. Implementations are free to adjust these
-colors to ensure suitable contrast levels. In this case the text color set by
-``30`` must be ignored.
-
-When the cursor color is not set to *special* but the text color via ``30`` is
-set to special, then that means the foreground color of the cell with the
-cursor must be changed to its background color for a partial reverse video
-effect.
-
-When unset, aka, set to ``0`` the cursors must be the same color as the main
-cursor. In particular if the main color is using a reverse video effect, the
-extra cursors must use the exact same colors as the main cursor, not the colors
-of the cells they are on.
-
-Querying for already set cursors
---------------------------------------
-
-Programs can ask the terminal what extra cursors are currently set, by sending
-the escape code::
-
-    CSI > 100 TRAILER
-
-The terminal must respond with **one** escape code::
-
-    CSI > 100; SHAPE:CO-ORDINATE TYPE:CO-ORDINATES ; ... TRAILER
-
-Here, the ``SHAPE:CO-ORDINATE TYPE:CO-ORDINATES`` block can be repeated any
-number of times, separated by ``;``. This response gives the set of shapes and
-positions currently active. If no cursors are currently active, there will be
-no blocks, just an empty response of the form::
-
-    CSI > 100 TRAILER
-
-Again, terminals **must** respond in FIFO order so that multiplexers know where
-to direct the responses.
-
-Querying for extra cursor colors
--------------------------------------
-
-Programs can ask the terminal what cursor colors are currently set, by sending
-escape code::
-
-    CSI > 101 TRAILER
-
-The terminal must respond with **one** escape code::
-
-    CSI > 101 ; 30 : COLOR_SPACE : COLOR_PARAMETERS ; 40 : COLOR_SPACE : COLOR_PARAMETERS TRAILER
-
-The number and type of ``COLOR_PARAMETERS`` depends on the preceding
-``COLOR_SPACE`` and can be omitted for some ``COLOR_SPACE`` values. See the
-section :ref:`extra_cursor_color` for details.
-
-
-Interaction with other terminal controls and state
--------------------------------------------------------
-
-**The main cursor**
-    The extra cursors must all have the same color and opacity and blink state
-    as the main cursor. The main cursor's visibility must not affect the
-    visibility of the extra cursors. Their visibility and shape are controlled
-    only by this protocol.
-
-**Clearing the screen**
-    The escape codes used to clear the screen (`ED <https://vt100.net/docs/vt510-rm/ED.html>`__)
-    with parameters 2, 3 and 22 must remove all extra cursors,
-    this is so that the clear command can be used by users to clear the screen of extra cursors.
-
-**Reset***
-    This must remove all extra cursors.
-
-**Alternate screen***
-    Switching between the main and alternate screens must remove all extra
-    cursors.
-
-**Scrolling**
-    The index (IND) and reverse index (RI) escape codes that cause screen
-    contents to scroll into scrollback or off screen must not affect
-    the extra cursors in any way. They remain at exactly the same position.
-    It is up to applications to manage extra cursor positions when using these
-    escape codes if needed. There are not a lot of use cases for scrolling
-    extra cursors with screen content, since extra cursors are meant to be
-    ephemeral and on screen only, not in scrollback. This allows terminals
-    to avoid the extra overhead of adjusting positions of the extra cursors
-    on every scroll.
-
-
-Footnotes
--------------
-
-.. [anim] kitty allows the cursor blink to be :opt:`animated
-   <cursor_blink_interval>` using any CSS easing function. This cannot be
-   implemented using fake cursors.
-
-.. [rv] kitty has a special "reverse video" color mode for cursors where the
-   color of the cursor and the text under the cursor is adjusted based on the
-   color of the cell under the cursor. This also cannot be implemented using
-   fake cursors.

docs/notifications.py

@@ -1,61 +0,0 @@
-#!/usr/bin/env python
-
-# A sample script to process notifications. Save it as
-# ~/.config/kitty/notifications.py
-
-import subprocess
-
-from kitty.notifications import NotificationCommand, Urgency
-
-
-def log_notification(nc: NotificationCommand) -> None:
-    # Log notifications to /tmp/notifications-log.txt
-    with open('/tmp/notifications-log.txt', 'a') as log:
-        print(f'title: {nc.title}', file=log)
-        print(f'body: {nc.body}', file=log)
-        print(f'app: {nc.application_name}', file=log)
-        print(f'types: {nc.notification_types}', file=log)
-        print('\n', file=log)
-
-
-def on_notification_activated(nc: NotificationCommand, which: int) -> None:
-    # do something when this notification is activated (clicked on)
-    # remember to assign this to the on_activation field in main()
-    pass
-
-
-def main(nc: NotificationCommand) -> bool:
-    '''
-    This function should return True to filter out the notification
-    '''
-    log_notification(nc)
-
-    # filter out notifications with 'unwanted' in their titles
-    if 'unwanted' in nc.title.lower():
-        return True
-
-    # force the notification to be silent
-    nc.sound_name = 'silent'
-
-    # filter out notifications from the application badapp
-    if nc.application_name == 'badapp':
-        return True
-
-    # filter out low urgency notifications
-    if nc.urgency is Urgency.Low:
-        return True
-
-    # replace some bad text in the notification body
-    nc.body = nc.body.replace('bad text', 'good text')
-
-    # run a script if this notification is from myapp and has
-    # type foo, passing in the title and body as command line args
-    # to the script.
-    if nc.application_name == 'myapp' and 'foo' in nc.notification_types:
-        subprocess.Popen(['/path/to/my/script', nc.title, nc.body])
-
-    # do some arbitrary actions when this notification is activated
-    nc.on_activation = on_notification_activated
-
-    # dont filter out this notification
-    return False

docs/open_actions.rst

@@ -3,7 +3,7 @@ Scripting the mouse click
 
 |kitty| has support for :term:`terminal hyperlinks <hyperlinks>`. These are
 generated by many terminal programs, such as ``ls``, ``gcc``, ``systemd``,
-:ref:`tool_mcat`, etc. You can customize exactly what happens when clicking on
+: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
@@ -15,7 +15,7 @@ clicked. Let us illustrate with some examples, first. Create the file
     # Open any image in the full kitty window by clicking on it
     protocol file
     mime image/*
-    action launch --type=overlay kitten icat --hold -- ${FILE_PATH}
+    action launch --type=overlay kitten icat --hold ${FILE_PATH}
 
 Now, run ``ls --hyperlink=auto`` in kitty and click on the filename of an
 image, holding down :kbd:`ctrl+shift`. It will be opened over the current
@@ -44,11 +44,11 @@ action per entry if you like, for example:
     # Tail a log file (*.log) in a new OS Window and reduce its font size
     protocol file
     ext log
-    action launch --title ${FILE} --type=os-window tail -f -- ${FILE_PATH}
+    action launch --title ${FILE} --type=os-window tail -f ${FILE_PATH}
     action change_font_size current -2
 
 
-In the launch specification you can expand environment variables, as shown in
+In the action specification you can expand environment variables, as shown in
 the examples above. In addition to regular environment variables, there are
 some special variables, documented below:
 
@@ -64,9 +64,6 @@ some special variables, documented below:
 ``FRAGMENT``
     The fragment (unquoted), if any of the URL or the empty string.
 
-``NETLOC``
-    The net location aka hostname (unquoted), if any of the URL or the empty string.
-
 ``URL_PATH``
     The path, query and fragment portions of the URL, without any
     unquoting.
@@ -126,12 +123,11 @@ lines. The various available criteria are:
 
 .. _launch_actions:
 
-Scripting the opening of files with kitty
+Scripting the opening of files with kitty on macOS
 -------------------------------------------------------
 
 On macOS you can use :guilabel:`Open With` in Finder or drag and drop files and
-URLs onto the kitty dock icon to open them with kitty. Similarly on Linux, you
-can associate certain files types to open in kitty. The default actions are:
+URLs onto the kitty dock icon to open them with kitty. The default actions are:
 
 * Open text files in your editor and images using the icat kitten.
 * Run shell scripts in a shell

docs/overview.rst

@@ -33,9 +33,6 @@ 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>`.
 
-You can quickly browse all available mappable actions by pressing
-:sc:`command_palette`, see :doc:`kittens/command-palette` for details.
-
 .. toctree::
    :hidden:
 
@@ -99,16 +96,12 @@ used to create programs that leverage kitty's powerful features, for example,
 You can :doc:`create your own kittens to scratch your own itches
 <kittens/custom>`.
 
-For a list of all the builtin kittens, run ``kitten`` in kitty, or to browse
-some of the more prominent ones, see :ref:`see here <kittens>`.
+For a list of all the builtin kittens, :ref:`see here <kittens>`.
 
 Additionally, you can use the :ref:`watchers <Watchers>` framework
 to create Python scripts that run in response to various events such as windows
 being resized, closing, having their titles changed, etc.
 
-Finally, there is remote control which allows you to control kitty from
-anywhere, even across a network! See below for more about remote control.
-
 .. toctree::
    :hidden:
 
@@ -131,14 +124,66 @@ started.
    remote-control
 
 
-Sessions
+.. _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`. You can also easily switch between sessions with
-a keypress. See :doc:`sessions` for details.
+option in :file:`kitty.conf`. An example, showing all available commands:
+
+.. 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 title 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
+    # Any definitions specified before the first new_os_window will apply to first OS window.
+    new_os_window
+    # Set new window size to 80x24 cells
+    os_window_size 80c 24c
+    # Set the --class for the new OS window
+    os_window_class mywindow
+    # Change the OS window state to normal, fullscreen, maximized or minimized
+    os_window_state normal
+    launch sh
+    # Resize the current window (see the resize_window action for details)
+    resize_window wider 2
+    # Make the current window the active (focused) window in its tab
+    focus
+    # Make the current OS Window the globally active window (not supported on Wayland)
+    focus_os_window
+    launch emacs
+
+.. note::
+    The :doc:`launch <launch>` command when used in a session file cannot create
+    new OS windows, or tabs.
+
+.. note::
+   Environment variables of the for :code:`${NAME}` or :code:`$NAME` are
+   expanded in the session file, except in the *arguments* (not options) to the
+   launch command.
 
 
 Creating tabs/windows
@@ -179,14 +224,9 @@ All these actions can be customized in :file:`kitty.conf` as described
 
 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>`.
+in your browser, etc.
 
-Additionally, various bits of the kitty UI itself work with the mouse. You can
-drag and drop tabs in the tab bar to re-order them or move them from one OS
-Window to another, or even pop them out into a new OS Window.
-You can drag window borders to resize windows. You can double click on empty regions
-of the tab bar to create new tabs or double click on an existing tab to rename
-it.
+For details, see :doc:`here <open_actions>`.
 
 .. toctree::
    :hidden:
@@ -211,10 +251,9 @@ 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. |kitty|
-displays an interactive :opt:`scrollbar` along the right edge
-of the window that shows your current position in the scrollback. You can click
-and drag the scrollbar to quickly navigate through the history.
+can use either keyboard shortcuts or the mouse scroll wheel to do so. While
+you are browsing the scrollback a :opt:`small indicator <scrollback_indicator_opacity>`
+is displayed along the right edge of the window to show how far back you are.
 
 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
@@ -233,7 +272,7 @@ arbitrary, command running in a new :term:`window`, :term:`tab` or
 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 :program:`nvim` to get more powerful
+If you want to use it with an editor such as :program:`vim` to get more powerful
 features, see for example, `kitty-scrollback.nvim
 <https://github.com/mikesmithgh/kitty-scrollback.nvim>`__ or `kitty-grab <https://github.com/yurikhan/kitty_grab>`__
 or see more tips for using various editor programs, in :iss:`this thread <719>`.

docs/performance.rst

@@ -34,14 +34,6 @@ This is measured either with dedicated hardware, or software such as `Typometer
 kitty with other terminal emulators on various systems show kitty has best in
 class keyboard to screen latency.
 
-Note that to minimize latency at the expense of more energy usage, use the
-following settings in kitty.conf::
-
-    input_delay 0
-    repaint_delay 2
-    sync_to_monitor no
-    wayland_enable_ime no
-
 `Hardware based measurement on macOS
 <https://thume.ca/2020/05/20/making-a-latency-tester/>`__ show that kitty and
 Apple's Terminal.app share the crown for best latency. These
@@ -101,7 +93,7 @@ ASCII only text.
 
    foot, iterm2 and Terminal.app are left out as they do not run under X11.
    Alacritty+tmux is included just to show the effect of putting a terminal
-   multiplexer into the mix (halving throughput) and because alacritty isn't
+   multiplexer into the mix (halving throughput) and because alacritty isnt
    remotely comparable to any of the other terminals feature wise without tmux.
 
 .. note::

docs/pointer-shapes.rst

@@ -166,7 +166,7 @@ Legacy xterm compatibility
 ----------------------------
 
 The original xterm proposal for this escape code used shape names from the
-:file:`X11/cursorfont.h` header on X11 based systems. Terminal implementations
+file:`X11/cursorfont.h` header on X11 based systems. Terminal implementations
 wishing to maintain compatibility with xterm can also implement these names as
 aliases for the CSS based names defined in the :ref:`pointer_shape_names` table.
 

docs/protocol-extensions.rst

@@ -27,9 +27,6 @@ please do so by opening issues in the `GitHub bug tracker
    underlines
    graphics-protocol
    keyboard-protocol
-   text-sizing-protocol
-   dnd-protocol
-   multiple-cursors-protocol
    file-transfer-protocol
    desktop-notifications
    pointer-shapes
@@ -37,4 +34,3 @@ please do so by opening issues in the `GitHub bug tracker
    color-stack
    deccara
    clipboard
-   misc-protocol

docs/quake-screenshots.rst

@@ -1,30 +0,0 @@
-
-.. sidebar::
-
-    .. only:: not man
-
-        **Screenshots**
-
-        .. figure:: /screenshots/quake-macos.webp
-            :alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program btop, running inside kitty, on macOS
-            :align: center
-            :width: 100%
-
-            macOS
-
-
-        .. figure:: /screenshots/quake-hypr.webp
-            :alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program btop, running inside kitty, on Hyprland in Linux
-            :align: center
-            :width: 100%
-
-            Linux
-
-        .. figure:: /screenshots/panel.png
-            :alt: Screenshot, showing a sample panel
-            :align: center
-            :width: 100%
-
-            A sample panel on Linux
-
-        How the screenshots :ref:`were generated <quake_ss>`.

docs/quickstart.rst

@@ -18,8 +18,8 @@ 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-terminal.svg
-   :target: https://repology.org/project/kitty-terminal/versions
+.. 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

docs/remote-control.rst

@@ -108,8 +108,7 @@ simpler :option:`kitty --single-instance` option, see ``kitty --help`` for that.
 
 Remote control via a socket
 --------------------------------
-To control kitty from outside kitty, it is necessary to setup a socket to
-communicate with kitty. First, start |kitty| as::
+First, start |kitty| as::
 
     kitty -o allow_remote_control=yes --listen-on unix:/tmp/mykitty
 
@@ -186,7 +185,7 @@ Now, using this password, you can, in scripts run the command::
 Any script with access to the password can now change colors in kitty using
 remote control, but only that and nothing else. You can even supply the
 password via the :envvar:`KITTY_RC_PASSWORD` environment variable, or the
-file :file:`~/.config/kitty/rc-pass` to avoid having to type it repeatedly.
+file :file:`~/.config/kitty/rc-password` to avoid having to type it repeatedly.
 See :option:`kitten @ --password-file` and :option:`kitten @ --password-env`.
 
 The :opt:`remote_control_password` can be specified multiple times to create
@@ -262,12 +261,6 @@ as shown below:
         return True
 
 
-.. note::
-
-    The payloads for the different remote control commands are documented in the
-    :doc:`remote control protocol specification <rc_protocol>`.
-
-
 .. _rc_mapping:
 
 Mapping key presses to remote control commands
@@ -294,12 +287,10 @@ If you wish to run a more complex script, you can use::
 
 In this script you can use ``kitten @`` to run as many remote
 control commands as you like and process their output.
-:ac:`remote_control_script` is similar to the
+:ac:`remote_control_script` is really just an alias for the
 :ac:`launch` command with ``--type=background --allow-remote-control``.
 For more advanced usage, including fine grained permissions, setting
-env vars, command line interpolation, passing data to STDIN, etc.
-the :doc:`launch <launch>` command should be used. Relative paths to scripts
-are interpreted with respect to the kitty config directory.
+env vars, etc. see the docs for the :doc:`launch <launch>` command.
 
 .. note:: You do not need :opt:`allow_remote_control` to use these mappings,
    as they are not actual remote programs, but are simply a way to reuse the

docs/requirements.txt

@@ -1,8 +1,6 @@
-# sphinx-inline-tabs breaks with sphinx >= 9
-sphinx <= 8.2.3
+sphinx
 furo
 sphinx-copybutton
 sphinxext-opengraph
 sphinx-inline-tabs
 sphinx-autobuild
-matplotlib

docs/sessions.rst

@@ -1,377 +0,0 @@
-.. _sessions:
-
-Sessions
-=============
-
-kitty has robust support for sessions. A session is basically a simple text
-file where you can define kitty windows, tabs and what programs to run in them
-as well as how to layout the windows. kitty also supports actions to easily
-:ac:`create and switch between existing sessions <goto_session>`, so that you
-can move seamlessly from working on one project to another with a couple of keystrokes.
-
-Let's see a quick example to get a feel of how easy it is to create sessions. First,
-a session file to develop a project:
-
-.. code-block:: session
-
-    # Set the layout for the current tab
-    layout tall
-    # Set the working directory for windows in the current tab
-    cd ~/path/to/myproject
-    # Create the "main" window and run an editor in it to edit the project files
-    launch --title "Edit My Project" /usr/bin/nvim
-    # Create a side window to run a shell to build or test project
-    launch --title "Build My Project"
-    # Create another side window to keep an eye on some useful log file
-    launch --title "Log for my project" /usr/bin/tail -f /path/to/project/log/file
-
-Save this file as :file:`~/path/to/myproject/launch.kitty-session`. Now when
-you want to work on the project, simply run:
-
-.. code-block:: sh
-
-    kitty --session ~/path/to/myproject/launch.kitty-session
-
-You can also set the session in :file:`kitty.conf` via :opt:`startup_session`.
-
-Thus, it is very easy to create sessions and work on projects. To learn how to
-create more complex sessions, see :ref:`complex_sessions`.
-
-
-.. _goto_session:
-
-Creating/Switching to sessions with a keypress
-------------------------------------------------
-
-If you like to manage multiple sessions within a single terminal and
-easily swap between them, kitty has you covered. You can use the
-:ac:`goto_session` action in kitty.conf, like this:
-
-.. code-block:: conf
-
-   # Press F7 and then c to jump to the "cool" project
-   map f7>c goto_session ~/path/to/cool/cool.kitty-session
-   # Press F7 and then h to jump to the "hot" project
-   map f7>h goto_session ~/path/to/hot/hot.kitty-session
-   # Browse and select from the list of known projects defined via goto_session commands
-   map f7>/ goto_session
-   # Browse and select from the list of active projects defined via goto_session commands
-   map f7>/ goto_session --active-only [=no]
-   # Same as above, but the sessions are listed alphabetically instead of by most recent
-   map f7>/ goto_session --sort-by=alphabetical
-   # Browse session files inside a directory and pick one
-   map f7>p goto_session ~/.local/share/kitty/sessions
-   # Go to the previously active session (larger negative numbers jump further back in history)
-   map f7>- goto_session -1
-
-In this manner you can define as many projects/sessions as you like and easily
-switch between them with a keypress.
-
-When a directory path is supplied to :ac:`goto_session`, kitty scans it for
-files ending in ``.kitty-session``, ``.kitty_session`` or ``.session`` and
-presents an interactive list. The ``--sort-by`` option controls the ordering of that list just like it does
-for globally known sessions.
-
-You can also close sessions using the :ac:`close_session` action, which closes
-all windows in the session with a single keypress.
-
-
-Displaying the currently active session name
-----------------------------------------------
-
-You can display the name of the currently active session file in the kitty tab
-bar using :opt:`tab_title_template`. For example, using the value::
-
-    {session_name} {title}
-
-will show you the name of the session file the current tab was loaded from, as
-well as the normal tab title. Or alternatively, you can set the tab title
-directly to a project name in the session file itself when creating the tab,
-like this::
-
-    new_tab My Project Name
-
-.. _complex_sessions:
-
-More complex sessions
--------------------------
-
-If you want to create more complex sessions, with sophisticated layouts, such
-as :ref:`splits_layout`, the easiest way is to set up the state you want to
-save manually by first starting kitty like this:
-
-.. code-block:: sh
-
-    kitty -o 'map f1 save_as_session --use-foreground-process --relocatable'
-
-Now create whatever splits and tabs you need and start whatever programs such
-as editors, REPLs, debuggers, etc. you want to start in each of them. Once
-kitty is the way you want it, press the :kbd:`F1` key, and you will be prompted
-for a path at which to save the session file. Specify the path and the session
-will be saved there with the exact setup you created. The saved file will even
-be opened in your editor for you to review, automatically.
-
-.. tip::
-   If you want session files to be saved to a specific directory regardless of
-   your current working directory, use the ``--base-dir`` option. For example::
-
-       map f7>s save_as_session --use-foreground-process --base-dir ~/.local/share/kitty/sessions
-
-   This is particularly useful when kitty is launched from system-wide shortcuts
-   where the working directory might not be your home directory. Note that
-   ``--relocatable`` is typically not used with ``--base-dir``, since relocatable
-   is meant for session files that are co-located with their project directories.
-
-If instead, you want to create these by hand, see the example below which shows
-all the major keywords you can use in kitty session files:
-
-.. code-block:: session
-
-    # Set the layout for the current tab
-    layout tall
-    # Set the working directory for windows in the current tab. Relative paths
-    # are resolved with respect to the location of this session file.
-    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
-    # Run a short lived command and see its output
-    launch --hold message-of-the-day
-
-    # Create a new tab
-    # The part after new_tab is the optional tab title 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
-    # Any definitions specified before the first new_os_window will apply to first OS window.
-    new_os_window
-    # Set new window size to 80x24 cells
-    os_window_size 80c 24c
-    # Set the --title for the new OS window
-    os_window_title my fancy os window
-    # Set the --class for the new OS window
-    os_window_class mywindow
-    # Set the --name for the new OS window
-    os_window_name myname
-    # Change the OS window state to normal, fullscreen, maximized or minimized
-    os_window_state normal
-    launch sh
-    # Resize the current window (see the resize_window action for details)
-    resize_window wider 2
-    # Make the current window the active (focused) window in its tab
-    focus
-    # Make the current OS Window the globally active window
-    focus_os_window
-    launch emacs
-
-    # Create another tab
-    new_tab logs
-    launch tail -f /var/log/syslog
-
-    # Focus the first tab (index 0) when the session loads
-    # You can also use a match expression like: focus_tab title:logs
-    focus_tab 0
-
-    # Create a complex layout using multiple splits. Creates two columns of
-    # windows with two windows in each column. The windows in the first column are
-    # split 50:50. In the second column the windows are not evenly split.
-    new_tab complex tab
-    layout splits
-    # First window, set a user variable on it so we can focus it later
-    launch --var window=first
-    # Create the second column by splitting the first window vertically
-    launch --location=vsplit
-    # Create the third window in the second column by splitting the second window horizontally
-    # Make it take 40% of the height instead of 50%
-    launch --location=hsplit --bias=40
-    # Go back to focusing the first window, so that we can split it
-    focus_matching_window var:window=first
-    # Create the final window in the first column
-    launch --location=hsplit
-
-
-.. note::
-    The :doc:`launch <launch>` command when used in a session file cannot create
-    new OS windows, or tabs.
-
-.. note::
-    Environment variables of the form :code:`${NAME}` or :code:`$NAME` are
-    expanded in the session file, except in the *arguments* (not options) to the
-    launch command. For example:
-
-    .. code-block:: sh
-
-        launch --cwd=$THIS_IS_EXPANDED some-program $THIS_IS_NOT_EXPANDED
-
-
-Making newly created windows join an existing session
----------------------------------------------------------
-
-Normally, after activating a session, if you create new windows/tabs
-they don't belong to the session. If you would prefer to have them belong
-to the currently active session, you can use the :ac:`new_window_with_cwd`
-and :ac:`new_tab_with_cwd` actions instead, like this::
-
-    map kitty_mod+enter new_window_with_cwd
-    map kitty_mod+t new_tab_with_cwd
-    map kitty_mod+n new_os_window_with_cwd
-
-This will cause newly created windows and tabs to belong to the currently active
-session, if any. Note that adding a window to a session in this way is
-temporary, it does not edit the session file. If you wish to update the
-session file of the currently active session, you can use the following
-mapping for it::
-
-    map f5 save_as_session --relocatable --use-foreground-process --match=session:. .
-
-The two can be combined, using the :ac:`combine` action.
-For even more control of what session a window is added to use
-the :doc:`launch <launch>` command with the :option:`launch --add-to-session`
-flag.
-
-
-Sessions with remote connections
--------------------------------------
-
-If you use the :doc:`ssh kitten </kittens/ssh>` to connect to remote computers,
-:ac:`save_as_session` is smart enough to save the ssh kitten invocation to your
-session file, preserving the remote working directory and even the currently
-running program on the remote host! Try it, run kitty with::
-
-    kitty -o 'map f1 save_as_session --use-foreground-process --relocatable' --session <(echo "layout vertical\nlaunch\nlaunch")
-
-Now in both windows, run::
-
-    kitten ssh localhost
-
-To connect them both to a remote computer (replace ``localhost`` with another
-computer if you like). In one window change the directory to /tmp and in the
-other start some program. Then press :kbd:`F1` to save the session file.
-When you run the session file in another kitty instance you will see both
-windows re-created, as expected with the correct working directories and
-running programs.
-
-Managing multi tab sessions in a single OS Window
-----------------------------------------------------
-
-The natural way to organise sessions in kitty is one per :term:`os_window`.
-However, if you prefer to manage multiple sessions in a single OS Window, you
-can configure the kitty tab bar to only show tabs that belong to the currently
-active session. To do so, use :opt:`tab_bar_filter` in :file:`kitty.conf` set::
-
-    tab_bar_filter session:~ or session:^$
-
-This will restrict the tab bar to only showing tabs from the currently active
-session as well tabs that do not belong to any session. Furthermore, when you
-are in a window or tab that does not belong to any session, the tab bar will
-show the tabs from the most recent active session, to maintain context.
-
-Keyword reference
----------------------
-
-Below is the list of all supported keywords in session files along with
-documentation for them.
-
-``cd [path]``
-    Change the working directory for all windows in the current tab to
-    ``path``. Relative paths are resolved with respect to the directory
-    containing the session file.
-
-``focus``
-    Give keyboard focus to the window created by the previous launch command
-
-``focus_matching_window``
-    Give keyboard focus to window that matches the specified expression. See
-    :ref:`search_syntax` for the syntax for matching expressions.
-
-``focus_os_window``
-    Give keyboard focus to the current OS Window. This is guaranteed to work
-    only is some other OS Window in the current kitty process has focus,
-    otherwise the window manager might block changing focus to prevent *focus
-    stealing*.
-
-``focus_tab [tab specifier]``
-    Set which tab should be active (focused) in the current OS Window. The tab
-    specifier can be either a plain number (treated as a 0-based index) or a
-    match expression. For example, ``focus_tab 0`` will focus the first tab,
-    ``focus_tab 1`` the second tab, and ``focus_tab title:logs`` will focus the
-    tab whose title matches "logs". See :ref:`search_syntax` for the full syntax
-    of match expressions. This is useful for session files that create multiple
-    tabs and want to ensure a specific tab is active when the session is loaded.
-
-``enabled_layouts comma separated list of layout names``
-    Set the layouts allowed in the current tab. Same syntax as
-    :opt:`enabled_layouts`.
-
-``launch``
-    Create a new window running the specified command or the default shell if
-    no command is specified. See :doc:`launch` for details. Note that creating
-    tabs and OS Windows using launch is not supported in session files, use the
-    dedicated keywords for these.
-
-``layout name``
-    Set the layout for the current tab to the specified layout, including any
-    specified options, see :doc:`layouts` for the available layouts and
-    options.
-
-``new_os_window``
-    Create a new OS Window. Any OS window related keywords specified before the
-    first ``new_os_window`` will apply to the first OS Window.
-
-``new_tab [tab title]``
-    Create a new tab with the specified title. If no title is specified, the
-    title behaves just as for a regular tab in kitty.
-
-``os_window_title``
-    Set the title for the current OS Window. The OS Window will then always
-    have this title, it will not change based on the title of the currently active
-    window inside the OS Window.
-
-``os_window_class``
-    Set the class part of WM_CLASS or Wayland Application Id for the current OS Window
-
-``os_window_name``
-    Set the name part of WM_CLASS or Wayland Window tag for the current OS Window
-
-``os_window_size``
-    Set the size of the current OS Window, can be specified in pixels or cells.
-    For example: 80c 24c is a window of width 80 cells by 24 cells.
-
-``os_window_state``
-    Set the state of the current OS Window, can be: ``normal``, ``fullscreen``, ``maximized`` or ``minimized``
-
-``resize_window``
-    Resize the current window. See the :ac:`resize_window` action for details.
-    For example: resize_window wider 2
-
-``set_layout_state``
-    This keyword is only used in session files generated by the
-    :ac:`save_as_session` action, it's syntax is undocumented and for internal
-    use only.
-
-``title``
-    Set the title for the next window. Deprecated, use ``launch --title``
-    instead.
-
-
-.. _save_as_session:
-
-The save_as_session action
-------------------------------
-
-This action can be mapped to a key press in :file:`kitty.conf`. It will save
-the currently open OS Windows, tabs, windows, running programs, working
-directories, etc. into a session file. It is a convenient way to
-:ref:`complex_sessions`. The options this action takes are documented below.
-
-.. include:: generated/save-as-session.rst

docs/shell-integration.rst

@@ -85,8 +85,6 @@ no-cwd
 no-prompt-mark
     Turn off marking of prompts. This disables jumping to prompt, browsing
     output of last command and click to move cursor functionality.
-    Note that for the fish shell this does not take effect, since fish always
-    marks prompts.
 
 no-complete
     Turn off completion for the kitty command.
@@ -266,7 +264,7 @@ over SSH when using :doc:`kittens/ssh`.
 
 The :command:`clone-in-kitty` command takes almost all the same arguments as the
 :doc:`launch <launch>` command, so you can open a new tab instead or a new OS
-window, etc. Arguments of launch that that don't
+window, etc. Arguments of launch that can cause code execution or that don't
 make sense when cloning are ignored. Most prominently, the following options are
 ignored: :option:`--allow-remote-control <launch --allow-remote-control>`,
 :option:`--copy-cmdline <launch --copy-cmdline>`, :option:`--copy-env <launch
@@ -313,9 +311,7 @@ window, etc. Not all arguments are supported, see the discussion in the
 :ref:`clone_shell` section above.
 
 In order to avoid remote code execution, kitty will only execute the configured
-editor and pass the file path to edit to it and it will strip all environment
-variables from the :command:`edit-in-kitty` command line. Additionally, parsing
-of colors is more limited, reading colors from config files is not allowed.
+editor and pass the file path to edit to it.
 
 .. note:: To edit files using sudo the best method is to set the
    :code:`SUDO_EDITOR` environment variable to ``kitten edit-in-kitty`` and
@@ -423,80 +419,19 @@ 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:
-
-.. code-block:: none
+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:
-
-.. code-block:: none
+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:
-
-.. code-block:: none
+Just before running a command/program, send the escape code::
 
     <OSC>133;C<ST>
 
-Optionally, when a command is finished its "exit status" can be reported as:
-
-.. code-block:: none
-
-    <OSC>133;D;exit status as base 10 integer<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>`_.
-
-kitty additionally supports several extra fields for the ``<OSC>133;A`` command
-to control its behavior, separated by semi-colons. They are:
-
-
-``redraw=0``
-    this tells kitty that the shell will not redraw the prompt on
-    resize so it should not erase it
-
-``special_key=1``
-    this tells kitty to use a special key instead of arrow keys
-    to move the cursor on mouse click. Useful if arrow keys have side-effects
-    like triggering auto complete. The shell integration script then binds the
-    special key, as needed.
-
-``k=s``
-    this tells kitty that the secondary (PS2) prompt is starting at the
-    current line.
-
-``click_events=1|2``
-    this tells kitty that the shell is capable of handling
-    mouse click events. kitty will thus send a click event to the shell when
-    the user clicks somewhere in the prompt. The shell can then move the cursor
-    to that position or perform some other appropriate action. Without this,
-    kitty will instead generate a number of fake key events to move the cursor
-    to the clicked location, which is not fully robust. A value of ``1`` will
-    cause the click events to have absolute y co-ordinates, a value of ``2``
-    will cause them to have y-coordinates relative to the top line of the
-    current prompt. In relative mode, y is zero for cells on the top line of
-    the current prompt. The current prompt here is either the secondary (PS2) or
-    primary prompt. If the secondary prompt is on the same line or above the
-    mouse position, then the reported y will be with respect to that, otherwise
-    with respect to the primary prompt. The click event is encoded in the SGR
-    encoding from xterm.
-
-kitty also optionally supports sending the cmdline going to be executed with ``<OSC>133;C`` as:
-
-.. code-block:: none
-
-    <OSC>133;C;cmdline=cmdline encoded by %q<ST>
-    or
-    <OSC>133;C;cmdline_url=cmdline as UTF-8 URL %-escaped text<ST>
-
-
-Here, *encoded by %q* means the encoding produced by the %q format to printf in
-bash and similar shells. Which is basically shell escaping with the addition of
-using `ANSI C quoting
-<https://www.gnu.org/software/bash/manual/html_node/ANSI_002dC-Quoting.html#ANSI_002dC-Quoting>`__
-for control characters (``$''`` quoting).

docs/text-sizing-protocol.rst

@@ -1,519 +0,0 @@
-The text sizing protocol
-==============================================
-
-.. versionadded:: 0.40.0
-
-Classically, because the terminal is a grid of equally sized characters, only
-a single text size was supported in terminals, with one minor exception, some
-characters were allowed to be rendered in two cells, to accommodate East Asian
-square aspect ratio characters and Emoji. Here, by single text size we mean the
-font size of all text on the screen is the same.
-
-This protocol allows text to be displayed in the terminal in different sizes
-both larger and smaller than the base text. It also solves the long standing
-problem of robustly determining the width (in cells) a character should have.
-Applications can interleave text of different sizes on the screen allowing for
-typographic niceties like headlines, superscripts, etc.
-
-Note that this protocol is fully backwards compatible, terminals that implement
-it will continue to work just the same with applications that do not use it.
-Because of this, it is not fully flexible in the font sizes it allows, as it
-still has to work with the character cell grid based fundamental nature of the
-terminal. Public discussion of this protocol is :iss:`here <8226>`.
-
-Quickstart
---------------
-
-Using this protocol to display different sized text is very simple, let's
-illustrate with a few examples to give us a flavor:
-
-.. code-block:: sh
-
-   printf "\e]_text_size_code;s=2;Double sized text\a\n\n"
-   printf "\e]_text_size_code;s=3;Triple sized text\a\n\n\n"
-   printf "\e]_text_size_code;n=1:d=2;Half sized text\a\n"
-
-Note that the last example, of half sized text, has half height characters, but
-they still each take one cell, this can be fixed with a little more work:
-
-.. code-block:: sh
-
-   printf "\e]_text_size_code;n=1:d=2:w=1;Ha\a\e]66;n=1:d=2:w=1;lf\a\n"
-
-The ``w=1`` mechanism allows the program to tell the terminal what width the text
-should take. This not only fixes using smaller text but also solves the long
-standing terminal ecosystem bugs caused by the client program not knowing how
-many cells the terminal will render some text in.
-
-
-The escape code
------------------
-
-There is a single escape code used by this protocol. It is sent by client
-programs to the terminal emulator to tell it to render the specified text
-at the specified size. It is an ``OSC`` code of the form::
-
-    <OSC> _text_size_code ; metadata ; text <terminator>
-
-Here, ``OSC`` is the bytes ``ESC ] (0x1b 0x5b)``. The ``metadata`` is a colon
-separated list of ``key=value`` pairs. The final part of the escape code is the
-text which is simply plain text encoded as :ref:`safe_utf8`, the text must be
-no longer than ``4096`` bytes. Longer strings than that must be broken up into
-multiple escape codes. Spaces in this definition are for clarity only and
-should be ignored. The ``terminator`` is either the byte ``BEL (0x7)`` or the
-bytes ``ESC ST (0x1b 0x5c)``.
-
-There are only a handful of metadata keys, defined in the table below:
-
-
-.. csv-table:: The text sizing metadata keys
-   :header: "Key", "Value", "Default", "Description"
-
-    "s", "Integer from 1 to 7",  "1", "The overall scale, the text will be rendered in a block of ``s * w`` by ``s`` cells"
-
-    "w", "Integer from 0 to 7",  "0", "The width, in cells, in which the text should be rendered. When zero, the terminal should calculate the width as it would for normal text, splitting it up into scaled cells."
-
-    "n", "Integer from 0 to 15", "0", "The numerator for the fractional scale."
-
-    "d", "Integer from 0 to 15", "0", "The denominator for the fractional scale. Must be ``> n`` when non-zero."
-
-    "v", "Integer from 0 to 2",  "0", "The vertical alignment to use for fractionally scaled text (n < d). ``0`` - top, ``1`` - bottom, ``2`` - centered"
-
-    "h", "Integer from 0 to 2",  "0", "The horizontal alignment to use for fractionally scaled text (n < d). ``0`` - left, ``1`` - right, ``2`` - centered"
-
-
-How it works
-------------------
-
-This protocol works by allowing the client program to tell the terminal to
-render text in multiple cells. The terminal can then adjust the actual font
-size used to render the specified text as appropriate for the specified space.
-
-The space to render is controlled by four metadata keys, ``s (scale)``, ``w (width)``, ``n (numerator)``
-and ``d (denominator)``. The most important are the ``s`` and ``w`` keys. The text
-will be rendered in a block of ``s * w`` by ``s`` cells. A special case is ``w=0``
-(the default), which means the terminal splits up the text into cells as it
-would normally without this protocol, but now each cell is an ``s by s`` block of
-cells instead. So, for example, if the text is ``abc`` and ``s=2`` the terminal would normally
-split it into three cells::
-
-    │a│b│c│
-
-But, because ``s=2`` it instead gets split as::
-
-    │a░│b░│c░│
-    │░░│░░│░░│
-
-The terminal multiplies the font size by ``s`` when rendering these
-characters and thus ends up rendering text at twice the base size.
-
-When ``w`` is a non-zero value, it specifies the width in scaled cells of the
-following text. Note that **all** the text in that escape code must be rendered
-in ``s * w`` cells. When both ``s`` and ``w`` are present, the resulting multicell
-contains all the text in the escape code rendered in a grid of ``(s * w, s)``
-cells, i.e. the multicell is ``s*w`` cells wide and ``s`` cells high.
-
-If the text does not fit, the terminal is free to do whatever it
-feels is best, including truncating the text or downsizing the font size when
-rendering it. It is up to client applications to use the ``w`` key wisely and not
-try to render too much text in too few cells. When sending a string of text
-with non zero ``w`` to the terminal emulator, the way to do it is to split up the
-text into chunks that fit in ``w`` cells and send one escape code per chunk. So
-for the string: ``cool-🐈`` the actual escape codes would be (ignoring the header
-and trailers)::
-
-   w=1;c w=1;o w=1;o w=1;l w=1;- w=2:🐈
-
-Note, in particular, how the last character, the cat emoji, ``🐈`` has ``w=2``.
-In practice client applications can assume that terminal emulators get the
-width of all ASCII code points correct and use the ``w=0`` form for efficient
-transmission, so that the above becomes::
-
-   cool- w=2:🐈
-
-The use of non-zero ``w`` should mainly be restricted to non-ASCII characters and
-when using fractional scaling, as described below.
-
-.. note:: Text sizes specified by scale are relative to the base font size,
-   thus if the base font size is changed, these sizes are changed as well.
-   So if the terminal emulator is using a base font size of ``11pt``, then
-   ``s=2`` will be rendered in approximately ``22pt`` (approx. because the
-   terminal may need to slightly adjust font size to ensure it fits as not all
-   fonts scale sizes linearly). If the user changes the base font size of the
-   terminal emulator to ``12pt`` then the scaled font size becomes ``~24pt``
-   and so on.
-
-
-Fractional scaling
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Using the main scale parameter (``s``) gives us only 7 font sizes. Fortunately,
-this protocol allows specifying fractional scaling, fractional scaling is
-applied on top of the main scale specified by ``s``. It allows niceties like:
-
-* Normal sized text but with half a line of blank space above and half a line below (``s=2:n=1:d=2:v=2``)
-* Superscripts (``n=1:d=2``)
-* Subscripts (``n=1:d=2:v=1``)
-* ...
-
-The fractional scale **does not** affect the number of cells the text occupies,
-instead, it just adjusts the rendered font size within those cells.
-The fraction is specified using an integer numerator and denominator (``n`` and
-``d``). In addition, by using the ``v`` key one can vertically align the
-fractionally scaled render area at top, bottom or middle. Similarly, the ``h`` key
-does horizontal alignment — left, right or centered. Note that alignment
-here is not actual text alignment, it refers to how the fractionally scaled
-render area fits inside the full render area of size ``s * w`` by ``s`` cells.
-Thus, alignment only applies when ``n < d``.
-
-When using fractional scaling one often wants to fit more than a single
-character per cell. To accommodate that, there is the ``w`` key. This specifies
-the number of cells in which to render the text. For example, for a superscript
-one would typically split the string into pairs of characters and use the
-following for each pair::
-
-    OSC _text_size_code ; n=1:d=2:w=1 ; ab <terminator>
-    ... repeat for each pair of characters
-
-
-Fixing the character width issue for the terminal ecosystem
----------------------------------------------------------------------
-
-Terminals create user interfaces using text displayed in a cell grid. For
-terminal software that creates sophisticated user interfaces it is particularly
-important that the client program running in the terminal and the terminal
-itself agree on how many cells a particular string should be rendered in. If
-the two disagree, then the entire user interface can be broken, leading to
-catastrophic failures.
-
-Fundamentally, this is a co-ordination problem. Both the client program and the
-terminal have to somehow share the same database of character properties and
-the same algorithm for computing string lengths in cells based on that shared
-database. Sadly, there is no such shared database in reality. The closest we
-have is the Unicode standard. Unfortunately, the Unicode standard has a new
-version almost every year and actually changes the width assigned to some
-characters in different versions. Furthermore, to actually get the "correct"
-width for a string using that standard one has to do grapheme segmentation,
-which is a :ref:`complex algorithm, specified below <gseg>`.
-Expecting all terminals and all terminal programs to have both up-to-date
-character databases and a bug free implementation of this algorithm is not
-realistic.
-
-So instead, this protocol solves the issue robustly by removing the
-co-ordination problem and putting only one actor in charge of determining
-string width. The client becomes responsible for doing whatever level of
-grapheme segmentation it is comfortable with using whatever Unicode database is
-at its disposal and then it can transmit the segmented string to the terminal
-with the appropriate ``w`` values so that the terminal renders the text in the
-exact number of cells the client expects.
-
-.. note::
-   It is possible for a terminal to implement only the width part of this spec
-   and ignore the scale part. This escape code works with only the `w` key as
-   well, as a means of specifying how many cells each piece of text occupies.
-   In such cases ``s`` defaults to 1.
-   See the section on :ref:`detect_text_sizing` on how client applications can
-   query for terminal emulator support.
-
-
-Wrapping and overwriting behavior
--------------------------------------
-
-If the multicell block (``s * w by s`` cells) is larger than the screen size in either
-dimension, the terminal must discard the character. Note that in particular
-this means that resizing a terminal screen so that it is too small to fit a
-multicell character can cause the character to be lost.
-
-When drawing a multicell character, if wrapping is enabled (DECAWM is set) and
-the character's width (``s * w``) does not fit on the current line, the cursor is
-moved to the start of the next line and the character is drawn there.
-If wrapping is disabled and the character's width does not fit on the current
-line, the cursor is moved back as far as needed to fit ``s * w`` cells and then
-the character is drawn, following the overwriting rules described below.
-
-When drawing text either normal text or text specified via this escape code,
-and this text would overwrite an existing multicell character, the following
-rules must be followed, in decreasing order of precedence:
-
-#. If the text is a combining character it is added to the existing multicell
-   character
-#. If the text will overwrite the top-left cell of the multicell character, the
-   entire multicell character must be erased
-#. If the text will overwrite any cell in the topmost row of the multicell
-   character, the entire multicell character must be replaced by spaces (this
-   rule is present for backwards compatibility with how overwriting works for
-   wide characters)
-#. If the text will overwrite cells from a row after the first row, then cursor should be moved past the
-   cells of the multicell character on that row and only then the text should be
-   written. Note that this behavior is independent of the value of DECAWM. This
-   is done for simplicity of implementation.
-
-The skipping behavior of the last rule can be complex requiring the terminal to
-skip over lots of cells, but it is needed to allow wrapping in the presence of
-multicell characters that extend over more than a single line.
-
-.. _detect_text_sizing:
-
-Detecting if the terminal supports this protocol
------------------------------------------------------
-
-To detect support for this protocol use the `CPR (Cursor Position Report)
-<https://vt100.net/docs/vt510-rm/CPR.html>`__ escape code. Send a ``CR``
-(carriage return) followed by ``CPR`` followed by ``\e]_text_size_code;w=2; \a``
-which will draw a space character in two cells, followed by another ``CPR``.
-Then send ``\e]_text_size_code;s=2; \a`` which will draw a space in a ``2 by 2``
-block of cells, followed by another ``CPR``.
-
-Then wait for the three responses from the terminal to the three CPR queries.
-If the cursor position in the three responses is the same, the terminal does
-not support this protocol at all, if the second response has the cursor
-moved by two cells, then the width part is supported and if the third response has the
-cursor moved by another two cells, then the scale part is supported.
-
-
-Interaction with other terminal controls
---------------------------------------------------
-
-This protocol does not change the character grid based nature of the terminal.
-Most terminal controls assume one character per cell so it is important to
-specify how these controls interact with the multicell characters created by
-this protocol.
-
-Cursor movement
-^^^^^^^^^^^^^^^^^^^
-
-Cursor movement is unaffected by multicell characters, all cursor movement
-commands move the cursor position by single cell increments, as has always been
-the case for terminals. This means that the cursor can be placed at any
-individual single cell inside a larger multicell character.
-
-When a multicell character is created using this protocol, the cursor moves
-`s * w` cells to the right, in the same row it was in.
-
-Terminals *should* display a large cursor covering the entire multicell block
-when the actual cursor position is on any cell within the block. Block cursors
-cover all the cells of the multicell character, bar cursors appear in all the
-cells in the first column of the character and so on.
-
-
-Editing controls
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-There are many controls used to edit existing screen content such as
-inserting characters, deleting characters and lines, etc. These were all
-originally specified for the one character per cell paradigm. Here we specify
-their interactions with multicell characters.
-
-**Insert characters** (``CSI @`` aka ``ICH``)
-    When inserting ``n`` characters at cursor position ``x, y`` all characters
-    after ``x`` on line ``y`` are supposed to be right shifted. This means
-    that any multi-line character that intersects with the cells on line ``y`` at ``x``
-    and beyond must be erased. Any single line multicell character that is
-    split by the cells at ``x`` and ``x + n - 1`` must also be erased.
-
-**Delete characters** (``CSI P`` aka ``DCH``)
-    When deleting ``n`` characters at cursor position ``x, y`` all characters
-    after ``x`` on line ``y`` are supposed to be left shifted. This means
-    that any multi-line character that intersects with the cells on line ``y`` at ``x``
-    and beyond must be erased. Any single line multicell character that is
-    split by the cells at ``x`` and ``x + n - 1`` must also be erased.
-
-**Erase characters** (``CSI X`` aka ``ECH``)
-    When erasing ``n`` characters at cursor position ``x, y`` the ``n`` cells
-    starting at ``x`` are supposed to be cleared. This means that any multicell
-    character that intersects with the ``n`` cells starting at ``x`` must be
-    erased.
-
-**Erase display** (``CSI J`` aka ``ED``)
-    Any multicell character intersecting with the erased region of the screen
-    must be erased. When using mode ``22`` the contents of the screen are first
-    copied into the history, including all multicell characters.
-
-**Erase in line** (``CSI K`` aka ``EL``)
-    Works just like erase characters above. Any multicell character
-    intersecting with the erased cells in the line is erased.
-
-**Insert lines** (``CSI L`` aka ``IL``)
-    When inserting ``n`` lines at cursor position ``y`` any multi-line
-    characters that are split at the line ``y`` must be erased. A split happens
-    when the second or subsequent row of the multi-line character is on the line
-    ``y``. The insertion causes ``n`` lines to be removed from the bottom of
-    the screen, any multi-line characters are split at the bottom of the screen
-    must be erased. A split is when any row of the multi-line character except
-    the last row is on the last line of the screen after the insertion of ``n``
-    lines.
-
-**Delete lines** (``CSI M`` aka ``DL``)
-    When deleting ``n`` lines at cursor position ``y`` any multicell character
-    that intersects the deleted lines must be erased.
-
-
-.. _gseg:
-
-The algorithm for splitting text into cells
-------------------------------------------------
-
-.. note::
-   kitty comes with a utility to test terminal compliance with this algorithm.
-   Install kitty and run: ``kitten __width_test__`` in any terminal to test it.
-   This uses tests published by the Unicode consortium, `GraphemeBreakTest.txt
-   <https://www.unicode.org/Public/UCD/latest/ucd/auxiliary/GraphemeBreakTest.txt>`__.
-
-.. warning::
-   This algorithm is under public discussion in :iss:`8533`. If serious issues
-   are brought to light in that discussion, there may be small changes to the
-   algorithm to address them. Additionally, in the future if the Unicode standard
-   changes in ways that affect this algorithm, it will be updated. Currently the
-   algorithm is based on Unicode version 16.
-
-Here, we specify how a terminal must split up text into cells, where a cell is
-a width one unit in the character grid the terminal displays.
-
-The basis for the algorithm is the
-`Grapheme segmentation algorithm <https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries>`__
-from the Unicode standard. However, that algorithm alone is insufficient to
-fully specify text handling for terminals. The full algorithm is specified below.
-
-A terminal using this algorithm must decode the bytes they receive
-into Unicode scalar values (i.e., code points except surrogates) using UTF-8.
-When it encounters any UTF-8 ill-formed subsequences,
-it must be replace each
-`maximal subpart of the ill-formed subsequence <https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G66453>`__
-with a :code:`U+FFFD REPLACEMENT CHARACTER` (<28>).
-
-For each decoded code point:
-
-#. First check if the code point is an ASCII control code, and handle it
-   appropriately. ASCII control codes are the code points less than :code:`U+0032` and the
-   code point :code:`U+0127 DEL`. The code point :code:`U+0000 NUL` must be discarded.
-
-#. Next, check if the code point is *invalid*, and if it is, discard it
-   and finish processing. Invalid code points are code points with Unicode category :code:`Cc or Cs`
-   and 66 additional code points: :code:`[0xfdd0, 0xfdef]`, :code:`[0xfffe, 0x10ffff-1, 0x10000]`
-   and :code:`[0xffff, 0x10ffff, 0x10000]`.
-
-#. Next, check if there is a previous cell before the
-   current cursor position. This means either the cursor is at x > 0 in which
-   case the previous cell is at x-1 on the same line, or the previous cell is
-   the last cell of the previous line, provided there is no line break
-   between the previous and current lines.
-
-#. Next, calculate the width in cells of the received code point,
-   which can be 0, 1, or 2 depending on the code point properties in
-   the Unicode standard.
-
-#. If there is no previous cell and the code point's width is zero,
-   the code point is discarded and its processing is finished.
-
-#. If there is a previous cell, the
-   `Grapheme segmentation algorithm UAX29-C1-1 <https://www.unicode.org/reports/tr29/#C1-1>`__
-   is used to determine if there is a grapheme boundary between the previous cell
-   and the current code point.
-
-#. If there is no boundary, the current code point is added to the previous
-   cell and processing of the code point is finished. See the :ref:`var_select`
-   section below for handling of Unicode Variation selectors.
-
-#. If there is a boundary, but the width of the current code point is zero,
-   it is added to the previous cell and processing is finished.
-
-#. The code point is added to the current cell and the cursor is moved forward
-   (right) by either 1 or 2 cells depending on the width of the code point.
-
-
-It remains to specify how to calculate the width in cells of a code point.
-To do this, code points are divided into various classes, as
-described by the rules below, in order of decreasing priority:
-
-.. note::
-   Notation: :code:`[start, stop, step]` means the integers from :code:`start`
-   to :code:`stop` in increments of :code:`step`. When the step is not
-   specified, it defaults to one.
-
-#. *Regional indicators*: 26 code points starting at :code:`0x1F1E6`. These all
-   have width 2
-
-#. *Doublewidth*: Parse `EastAsianWidth.txt
-   <https://www.unicode.org/Public/UCD/latest/ucd/EastAsianWidth.txt>`__ from
-   the Unicode standard. All code points marked :code:`W` or :code:`F` have
-   width two. All code points in the following ranges have width two *unless*
-   they are marked as :code:`A` in :code:`EastAsianWidth.txt`: :code:`[0x3400,
-   0x4DBF], [0x4E00, 0x9FFF], [0xF900, 0xFAFF], [0x20000, 0x2FFFD], [0x30000, 0x3FFFD]`
-
-#. *Wide emoji*: Parse `emoji-sequences.txt
-   <https://www.unicode.org/Public/emoji/latest/emoji-sequences.txt>`__ from
-   the Unicode standard. All :code:`Basic_Emoji` have width two unless they are
-   followed by :code:`FE0F` in the file. The leading codepoints in all
-   :code:`RGI_Emoji_Modifier_Sequence` and :code:`RGI_Emoji_Tag_Sequence` have width two.
-   All code points in :code:`RGI_Emoji_Flag_Sequence` have width two.
-
-#. *Marks*: These are all zero width code points. They are code points with Unicode
-   categories whose first letter is :code:`M` or :code:`S`. Additionally,
-   code points with Unicode category: :code:`Cf`. Finally, they include
-   all modifier code points from :code:`RGI_Emoji_Modifier_Sequence` in the
-   *Wide emoji* rule above.
-
-#. All remaining code points have a width of one cell.
-
-.. _var_select:
-
-Unicode variation selectors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-There are two code points (:code:`U+FE0E` and :code:`U+FE0F`) that can actually
-`alter the width of the previous code point <https://www.unicode.org/reports/tr11/#ED4>`__
-by changing their presentation between ``Emoji_Presentation`` and ``Text_Presentation``.
-When adding a code point to the previous cell these have to be handled specially.
-
-``U+FE0E`` - Variation Selector 15
-  When the previous cell has width two and the last code point in the previous
-  cell is one of the ``Basic_Emoji`` code points from the *Wide emoji* rule above
-  that is *not* followed by ``FEOF`` then the width of the previous cell is
-  decreased to one.
-
-``U+FE0F`` - Variation Selector 16
-  When the previous cell has width one and the last code point in the previous
-  cell is one of the ``Basic_Emoji`` code points from the *Wide emoji* rule above
-  that is followed by ``FEOF`` then the width of the
-  previous cell is increased to two.
-
-Note that the rule for ``U+FE0E`` is particularly problematic for terminals as
-it means that the width of a string cannot be determined without knowing the
-width of the screen it will be rendered on. This is because when there is only
-one cell left on the current line and a wide emoji is received it wraps onto
-the next line. If subsequently a ``U+FE0E`` is received, the emoji becomes one
-cell wide but it is *not* moved back to the previous line.
-
-To avoid this issue, it is recommended applications detect when ``U+FE0E`` is
-present and in such cases use the width part of the text sizing protocol
-to control rendering. Alternately, applications can segment text into graphemes
-and given a list of graphemes and their widths it is possible to write a simple
-function that will output them to the terminal so as to avoid this issue. Below
-is such a function in the Python language:
-
-.. code-block:: python
-
-    class Grapheme:
-        text: str
-        width: int
-
-    def output_one_line(iterator_over_graphemes):
-        ' Output graphemes so that they affect exactly wcswidth cells only (works for >= 2 graphemes) '
-        graphemes = tuple(iterator_over_graphemes)
-        if not graphemes:
-            return
-        yield graphemes[0].text
-        for i in range(1, len(graphemes)):
-            g = graphemes[i]
-            if g is graphemes[-1]:
-                prev_g = graphemes[i-1]
-                yield f'\x1b[{prev_g.width}D'  # move cursor back
-                yield g.text
-                yield f'\x1b[{g.width}D'  # move cursor back
-                yield f'\x1b[{prev_g.width}@'  # insert cells
-                yield prev_g.text
-                yield f'\x1b[{g.width}C'  # move cursor forward
-
-Then, using ``wcswidth()`` the application can split long text into lines of
-width no more than the screen width and use the above function to write each
-line to the terminal robustly.

docs/wide-gamut-colors.rst

@@ -1,82 +0,0 @@
-Wide gamut color formats
-=========================
-
-kitty supports modern wide gamut color formats for precise color specification.
-These formats can be used anywhere a color value is accepted in the configuration
-(foreground, background, color0-color255, etc.).
-
-OKLCH Colors
-------------
-
-OKLCH is a perceptually uniform color space, ideal for creating color themes.
-The format is::
-
-    foreground oklch(0.9 0.05 140)
-    color1     oklch(0.7 0.25 25)
-
-Parameters:
-
-- **L** (Lightness): 0 to 1, where 0 is black and 1 is white
-- **C** (Chroma): 0 to approximately 0.4, represents color saturation
-- **H** (Hue): 0 to 360 degrees (0=red, 120=green, 240=blue)
-
-Benefits:
-
-- Perceptually uniform - equal changes produce equal perceived differences
-- Adjusting lightness preserves hue (unlike HSL)
-- Industry standard for modern color design
-
-Example::
-
-    foreground oklch(0.9 0.05 140)
-    color1     oklch(0.65 0.25 29)    # Vibrant red-orange
-    color2     oklch(0.65 0.25 142)   # Vibrant green
-    color3     oklch(0.70 0.19 90)    # Warm yellow
-
-CIE LAB Colors
---------------
-
-CIE LAB is a device-independent color space designed to approximate human vision.
-
-The format is::
-
-    background lab(20 5 -10)
-    color4     lab(50 0 -50)
-
-Parameters:
-
-- **L**: Lightness, 0 to 100 (0 = black, 100 = white)
-- **a**: Green (-) to red (+), typically -100 to +100
-- **b**: Blue (-) to yellow (+), typically -100 to +100
-
-Example::
-
-    background lab(10 0 0)           # Very dark neutral gray
-    foreground lab(90 0 0)           # Very light neutral gray
-    color1     lab(50 60 40)         # Red
-    color4     lab(50 0 -50)         # Blue
-
-Gamut Mapping
--------------
-
-When you specify colors in OKLCH or CIE LAB formats that are outside the sRGB
-color gamut, kitty automatically converts them using the CSS Color Module Level 4
-gamut mapping algorithm:
-
-- Preserves the original lightness and hue as much as possible
-- Reduces chroma (saturation) until the color fits within the displayable range
-- Uses perceptual color difference (deltaE OK) to minimize visible changes
-- Maximizes color saturation while staying in gamut
-
-This ensures that wide gamut colors gracefully degrade on standard sRGB displays while
-taking full advantage of wide gamut displays when available. The mapping happens
-automatically - you don't need to do anything special.
-
-For example, :code:`oklch(0.7 0.4 25)` might be too saturated for sRGB but will be
-automatically adjusted to fit while preserving the perceived hue and lightness.
-
-References
-----------
-
-- `CSS Color Module Level 4 <https://www.w3.org/TR/css-color-4/>`_
-- `OKLCH Color Space <https://bottosson.github.io/posts/oklab/>`_

embeds.go

@@ -1,27 +0,0 @@
-package kitty
-
-import (
-	_ "embed"
-	"encoding/json"
-	"fmt"
-)
-
-var _ = fmt.Print
-
-//go:embed logo/kitty.png
-var KittyLogoAsPNGData []byte
-
-//go:embed kitty_tests/GraphemeBreakTest.json
-var grapheme_break_test_data []byte
-
-type GraphemeBreakTest struct {
-	Data    []string `json:"data"`
-	Comment string   `json:"comment"`
-}
-
-func LoadGraphemeBreakTests() (ans []GraphemeBreakTest, err error) {
-	if err := json.Unmarshal(grapheme_break_test_data, &ans); err != nil {
-		return nil, fmt.Errorf("Failed to parse GraphemeBreakTest JSON with error: %s", err)
-	}
-	return
-}

gen/__main__.py

@@ -4,9 +4,10 @@
 
 import os
 import sys
+from typing import List
 
 
-def main(args: list[str]=sys.argv) -> None:
+def main(args: List[str]=sys.argv) -> None:
     os.chdir(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
     sys.path.insert(0, os.getcwd())
     if len(args) == 1:
@@ -34,9 +35,6 @@ def main(args: list[str]=sys.argv) -> None:
     elif which == 'cursors':
         from gen.cursors import main
         main(args)
-    elif which == 'color-names':
-        from gen.color_names import main
-        main(args)
     else:
         raise SystemExit(f'Unknown which: {which}')
 

gen/apc_parsers.py

@@ -5,18 +5,18 @@ import os
 import subprocess
 import sys
 from collections import defaultdict
-from typing import Any, DefaultDict, Union
+from typing import Any, DefaultDict, Dict, FrozenSet, List, Tuple, Union
 
 if __name__ == '__main__' and not __package__:
     import __main__
     __main__.__package__ = 'gen'
     sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
-KeymapType = dict[str, tuple[str, Union[frozenset[str], str]]]
+KeymapType = Dict[str, Tuple[str, Union[FrozenSet[str], str]]]
 
 
-def resolve_keys(keymap: KeymapType) -> DefaultDict[str, list[str]]:
-    ans: DefaultDict[str, list[str]] = defaultdict(list)
+def resolve_keys(keymap: KeymapType) -> DefaultDict[str, List[str]]:
+    ans: DefaultDict[str, List[str]] = defaultdict(list)
     for ch, (attr, atype) in keymap.items():
         if isinstance(atype, str) and atype in ('int', 'uint'):
             q = atype
@@ -45,7 +45,7 @@ def parse_key(keymap: KeymapType) -> str:
     return '        \n'.join(lines)
 
 
-def parse_flag(keymap: KeymapType, type_map: dict[str, Any], command_class: str) -> str:
+def parse_flag(keymap: KeymapType, type_map: Dict[str, Any], command_class: str) -> str:
     lines = []
     for ch in type_map['flag']:
         attr, allowed_values = keymap[ch]
@@ -63,14 +63,14 @@ def parse_flag(keymap: KeymapType, type_map: dict[str, Any], command_class: str)
     return '        \n'.join(lines)
 
 
-def parse_number(keymap: KeymapType) -> tuple[str, str]:
+def parse_number(keymap: KeymapType) -> Tuple[str, str]:
     int_keys = [f'I({attr})' for attr, atype in keymap.values() if atype == 'int']
     uint_keys = [f'U({attr})' for attr, atype in keymap.values() if atype == 'uint']
     return '; '.join(int_keys), '; '.join(uint_keys)
 
 
-def cmd_for_report(report_name: str, keymap: KeymapType, type_map: dict[str, Any], payload_allowed: bool, payload_is_base64: bool) -> str:
-    def group(atype: str, conv: str) -> tuple[str, str]:
+def cmd_for_report(report_name: str, keymap: KeymapType, type_map: Dict[str, Any], payload_allowed: bool) -> str:
+    def group(atype: str, conv: str) -> Tuple[str, str]:
         flag_fmt, flag_attrs = [], []
         cv = {'flag': 'c', 'int': 'i', 'uint': 'I'}[atype]
         for ch in type_map[atype]:
@@ -85,20 +85,12 @@ def cmd_for_report(report_name: str, keymap: KeymapType, type_map: dict[str, Any
 
     fmt = f'{flag_fmt} {uint_fmt} {int_fmt}'
     if payload_allowed:
-        ans = [f'REPORT_VA_COMMAND("K s {{{fmt} ss#}}", self->window_id, "{report_name}",\n']
+        ans = [f'REPORT_VA_COMMAND("K s {{{fmt} sI}} y#", self->window_id, "{report_name}", ']
     else:
-        ans = [f'REPORT_VA_COMMAND("K s {{{fmt}}}", self->window_id, "{report_name}",\n']
-    if flag_attrs:
-        ans.append(f'{flag_attrs},\n')
-    if uint_attrs:
-        ans.append(f'{uint_attrs},\n')
-    if int_attrs:
-        ans.append(f'{int_attrs},\n')
+        ans = [f'REPORT_VA_COMMAND("K s {{{fmt}}}", self->window_id, "{report_name}", ']
+    ans.append(',\n     '.join((flag_attrs, uint_attrs, int_attrs)))
     if payload_allowed:
-        if payload_is_base64:
-            ans.append('"", (char*)parser_buf, g.payload_sz')
-        else:
-            ans.append('"", (char*)parser_buf + payload_start, g.payload_sz')
+        ans.append(', "payload_sz", g.payload_sz, parser_buf, g.payload_sz')
     ans.append(');')
     return '\n'.join(ans)
 
@@ -110,65 +102,46 @@ def generate(
     keymap: KeymapType,
     command_class: str,
     initial_key: str = 'a',
-    payload_allowed: bool = True,
-    payload_is_base64: bool = True,
-    start_parsing_at: int = 1,
-    field_sep: str = ',',
-    post_init: str = '',
+    payload_allowed: bool = True
 ) -> str:
     type_map = resolve_keys(keymap)
     keys_enum = enum(keymap)
     handle_key = parse_key(keymap)
     flag_keys = parse_flag(keymap, type_map, command_class)
     int_keys, uint_keys = parse_number(keymap)
-    report_cmd = cmd_for_report(report_name, keymap, type_map, payload_allowed, payload_is_base64)
-    post_init_line = f'\n    {post_init}' if post_init else ''
-    extra_init = ''
+    report_cmd = cmd_for_report(report_name, keymap, type_map, payload_allowed)
     if payload_allowed:
         payload_after_value = "case ';': state = PAYLOAD; break;"
         payload = ', PAYLOAD'
-        if payload_is_base64:
-            payload_case = f'''
-                case PAYLOAD: {{
-                    sz = parser_buf_pos - pos;
+        payload_case = f'''
+            case PAYLOAD: {{
+                sz = parser_buf_pos - pos;
+                g.payload_sz = MAX(BUF_EXTRA, sz);
+                if (!base64_decode8(parser_buf + pos, sz, parser_buf, &g.payload_sz)) {{
                     g.payload_sz = MAX(BUF_EXTRA, sz);
-                    if (!base64_decode8(parser_buf + pos, sz, parser_buf, &g.payload_sz)) {{
-                        g.payload_sz = MAX(BUF_EXTRA, sz);
-                        REPORT_ERROR("Failed to parse {command_class} command payload with error: \
-    invalid base64 data in chunk of size: %zu with output buffer size: %zu", sz, g.payload_sz); return; }}
-                    pos = parser_buf_pos;
-                    }} break;
-            '''
-            callback = f'{callback_name}(self->screen, &g, parser_buf)'
-        else:
-            payload_case = '''
-                case PAYLOAD: {
-                    sz = parser_buf_pos - pos;
-                    payload_start = pos;
-                    g.payload_sz = sz;
-                    pos = parser_buf_pos;
-                } break;
-            '''
-            extra_init = 'size_t payload_start = 0;'
-            callback = f'{callback_name}(self->screen, &g, parser_buf + payload_start)'
-
+                    REPORT_ERROR("Failed to parse {command_class} command payload with error: \
+invalid base64 data in chunk of size: %zu with output buffer size: %zu", sz, g.payload_sz); return; }}
+                pos = parser_buf_pos;
+                }}
+                break;
+        '''
+        callback = f'{callback_name}(self->screen, &g, parser_buf)'
     else:
         payload_after_value = payload = payload_case = ''
         callback = f'{callback_name}(self->screen, &g)'
 
     return f'''
     #include "base64.h"
-
 static inline void
 {function_name}(PS *self, uint8_t *parser_buf, const size_t parser_buf_pos) {{
-    unsigned int pos = {start_parsing_at};
-    {extra_init}
+    unsigned int pos = 1;
     enum PARSER_STATES {{ KEY, EQUAL, UINT, INT, FLAG, AFTER_VALUE {payload} }};
     enum PARSER_STATES state = KEY, value_state = FLAG;
-    {command_class} g = {{0}};{post_init_line}
+    static {command_class} g;
     unsigned int i, code;
     uint64_t lcode; int64_t accumulator;
-    bool is_negative; (void)is_negative;
+    bool is_negative;
+    memset(&g, 0, sizeof(g));
     size_t sz;
     {keys_enum}
     enum KEYS key = '{initial_key}';
@@ -241,10 +214,10 @@ static inline void
             case AFTER_VALUE:
                 switch (parser_buf[pos++]) {{
                     default:
-                        REPORT_ERROR("Malformed {command_class} control block, expecting a {field_sep} or semi-colon after a value, found: 0x%x",
+                        REPORT_ERROR("Malformed {command_class} control block, expecting a comma or semi-colon after a value, found: 0x%x",
                                      parser_buf[pos - 1]);
                         return;
-                    case '{field_sep}':
+                    case ',':
                         state = KEY;
                         break;
                     {payload_after_value}
@@ -283,7 +256,7 @@ def write_header(text: str, path: str) -> None:
     subprocess.check_call(['clang-format', '-i', path])
 
 
-def parsers() -> None:
+def graphics_parser() -> None:
     flag = frozenset
     keymap: KeymapType = {
         'a': ('action', flag('tTqpdfac')),
@@ -319,37 +292,9 @@ def parsers() -> None:
     text = generate('parse_graphics_code', 'screen_handle_graphics_command', 'graphics_command', keymap, 'GraphicsCommand')
     write_header(text, 'kitty/parse-graphics-command.h')
 
-    keymap = {
-        'w': ('width', 'uint'),
-        's': ('scale', 'uint'),
-        'n': ('subscale_n', 'uint'),
-        'd': ('subscale_d', 'uint'),
-        'v': ('vertical_align', 'uint'),
-        'h': ('horizontal_align', 'uint'),
-    }
-    text = generate(
-        'parse_multicell_code', 'screen_handle_multicell_command', 'multicell_command', keymap, 'MultiCellCommand',
-        payload_is_base64=False, start_parsing_at=0, field_sep=':')
-    write_header(text, 'kitty/parse-multicell-command.h')
 
-    keymap = {
-        't': ('type', flag('aAmMrRopPqeEk')),
-        'm': ('more', 'uint'),
-        'i': ('client_id', 'uint'),
-        'o': ('operation', 'uint'),
-        'x': ('cell_x', 'int'),
-        'y': ('cell_y', 'int'),
-        'X': ('pixel_x', 'int'),
-        'Y': ('pixel_y', 'int'),
-    }
-    text = generate(
-        'parse_dnd_code', 'screen_handle_dnd_command', 'dnd_command', keymap, 'DnDCommand',
-        payload_is_base64=False, start_parsing_at=0, field_sep=':')
-    write_header(text, 'kitty/parse-dnd-command.h')
-
-
-def main(args: list[str]=sys.argv) -> None:
-    parsers()
+def main(args: List[str]=sys.argv) -> None:
+    graphics_parser()
 
 
 if __name__ == '__main__':

gen/bitfields.py

@@ -1,64 +0,0 @@
-#!/usr/bin/env python
-# License: GPLv3 Copyright: 2025, Kovid Goyal <kovid at kovidgoyal.net>
-
-import os
-from typing import NamedTuple
-
-
-class BitField(NamedTuple):
-     name: str
-     bits: int
-
-
-def typename_for_bitsize(bits: int) -> str:
-     if bits <= 8:
-        return 'uint8'
-     if bits <= 16:
-        return 'uint16'
-     if bits <= 32:
-        return 'uint32'
-     return 'uint64'
-
-
-def make_bitfield(dest: str, typename: str, *fields_: str, add_package: bool = True) -> tuple[str, str]:
-    output_path = os.path.join(dest, f'{typename.lower()}_generated.go')
-    ans = [f'package {os.path.basename(dest)}', '']
-    a = ans.append
-    if not add_package:
-        del ans[0]
-
-    def fieldify(spec: str) -> BitField:
-        name, num = spec.partition(' ')[::2]
-        return BitField(name, int(num))
-
-    fields = tuple(map(fieldify, fields_))
-    total_size = sum(x.bits for x in fields)
-    if total_size > 64:
-        raise ValueError(f'Total size of bit fields: {total_size} for {typename} is larger than 64 bits')
-    a(f'// Total number of bits used: {total_size}')
-    itype = typename_for_bitsize(total_size)
-    a(f'type {typename} {itype}')
-    a('')
-    shift = 0
-    for bf in reversed(fields):
-        tn = typename_for_bitsize(bf.bits)
-        mask = '0b' + '1' * bf.bits
-        a(f'func (s {typename}) {bf.name.capitalize()}() {tn} {{')  # }}
-        if shift:
-            a(f'    return {tn}((s >> {shift}) & {mask})')
-        else:
-            a(f'    return {tn}(s & {mask})')
-        a('}')
-        a('')
-        a(f'func (s *{typename}) Set_{bf.name}(val {tn}) {{')  # }}
-        if shift:
-            a(f'    *s &^= {mask} << {shift}')
-            a(f'    *s |= {typename}(val&{mask}) << {shift}')
-        else:
-            a(f'    *s &^= {mask}')
-            a(f'    *s |= {typename}(val & {mask})')
-        a('}')
-        a('')
-        shift += bf.bits
-
-    return output_path, '\n'.join(ans)

gen/color_names.py

@@ -1,794 +0,0 @@
-#!./kitty/launcher/kitty +launch
-# License: GPLv3 Copyright: 2025, Kovid Goyal <kovid at kovidgoyal.net>
-
-import os
-import subprocess
-import sys
-import tempfile
-
-if __name__ == '__main__' and not __package__:
-    import __main__
-    __main__.__package__ = 'gen'
-    sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-
-
-def Color(r: int, g: int, b: int) -> int:
-    return (r << 16) | (g << 8) | b
-
-# BEGIN_DATA_SECTION {{{
-color_names = {
- 'alice blue': Color(240, 248, 255),
- 'aliceblue': Color(240, 248, 255),
- 'antique white': Color(250, 235, 215),
- 'antiquewhite': Color(250, 235, 215),
- 'antiquewhite1': Color(255, 239, 219),
- 'antiquewhite2': Color(238, 223, 204),
- 'antiquewhite3': Color(205, 192, 176),
- 'antiquewhite4': Color(139, 131, 120),
- 'aquamarine': Color(127, 255, 212),
- 'aquamarine1': Color(127, 255, 212),
- 'aquamarine2': Color(118, 238, 198),
- 'aquamarine3': Color(102, 205, 170),
- 'aquamarine4': Color(69, 139, 116),
- 'azure': Color(240, 255, 255),
- 'azure1': Color(240, 255, 255),
- 'azure2': Color(224, 238, 238),
- 'azure3': Color(193, 205, 205),
- 'azure4': Color(131, 139, 139),
- 'beige': Color(245, 245, 220),
- 'bisque': Color(255, 228, 196),
- 'bisque1': Color(255, 228, 196),
- 'bisque2': Color(238, 213, 183),
- 'bisque3': Color(205, 183, 158),
- 'bisque4': Color(139, 125, 107),
- 'black': Color(0, 0, 0),
- 'blanched almond': Color(255, 235, 205),
- 'blanchedalmond': Color(255, 235, 205),
- 'blue': Color(0, 0, 255),
- 'blue violet': Color(138, 43, 226),
- 'blue1': Color(0, 0, 255),
- 'blue2': Color(0, 0, 238),
- 'blue3': Color(0, 0, 205),
- 'blue4': Color(0, 0, 139),
- 'blueviolet': Color(138, 43, 226),
- 'brown': Color(165, 42, 42),
- 'brown1': Color(255, 64, 64),
- 'brown2': Color(238, 59, 59),
- 'brown3': Color(205, 51, 51),
- 'brown4': Color(139, 35, 35),
- 'burlywood': Color(222, 184, 135),
- 'burlywood1': Color(255, 211, 155),
- 'burlywood2': Color(238, 197, 145),
- 'burlywood3': Color(205, 170, 125),
- 'burlywood4': Color(139, 115, 85),
- 'cadet blue': Color(95, 158, 160),
- 'cadetblue': Color(95, 158, 160),
- 'cadetblue1': Color(152, 245, 255),
- 'cadetblue2': Color(142, 229, 238),
- 'cadetblue3': Color(122, 197, 205),
- 'cadetblue4': Color(83, 134, 139),
- 'chartreuse': Color(127, 255, 0),
- 'chartreuse1': Color(127, 255, 0),
- 'chartreuse2': Color(118, 238, 0),
- 'chartreuse3': Color(102, 205, 0),
- 'chartreuse4': Color(69, 139, 0),
- 'chocolate': Color(210, 105, 30),
- 'chocolate1': Color(255, 127, 36),
- 'chocolate2': Color(238, 118, 33),
- 'chocolate3': Color(205, 102, 29),
- 'chocolate4': Color(139, 69, 19),
- 'coral': Color(255, 127, 80),
- 'coral1': Color(255, 114, 86),
- 'coral2': Color(238, 106, 80),
- 'coral3': Color(205, 91, 69),
- 'coral4': Color(139, 62, 47),
- 'cornflower blue': Color(100, 149, 237),
- 'cornflowerblue': Color(100, 149, 237),
- 'cornsilk': Color(255, 248, 220),
- 'cornsilk1': Color(255, 248, 220),
- 'cornsilk2': Color(238, 232, 205),
- 'cornsilk3': Color(205, 200, 177),
- 'cornsilk4': Color(139, 136, 120),
- 'cyan': Color(0, 255, 255),
- 'cyan1': Color(0, 255, 255),
- 'cyan2': Color(0, 238, 238),
- 'cyan3': Color(0, 205, 205),
- 'cyan4': Color(0, 139, 139),
- 'dark blue': Color(0, 0, 139),
- 'dark cyan': Color(0, 139, 139),
- 'dark goldenrod': Color(184, 134, 11),
- 'dark gray': Color(169, 169, 169),
- 'dark green': Color(0, 100, 0),
- 'dark grey': Color(169, 169, 169),
- 'dark khaki': Color(189, 183, 107),
- 'dark magenta': Color(139, 0, 139),
- 'dark olive green': Color(85, 107, 47),
- 'dark orange': Color(255, 140, 0),
- 'dark orchid': Color(153, 50, 204),
- 'dark red': Color(139, 0, 0),
- 'dark salmon': Color(233, 150, 122),
- 'dark sea green': Color(143, 188, 143),
- 'dark slate blue': Color(72, 61, 139),
- 'dark slate gray': Color(47, 79, 79),
- 'dark slate grey': Color(47, 79, 79),
- 'dark turquoise': Color(0, 206, 209),
- 'dark violet': Color(148, 0, 211),
- 'darkblue': Color(0, 0, 139),
- 'darkcyan': Color(0, 139, 139),
- 'darkgoldenrod': Color(184, 134, 11),
- 'darkgoldenrod1': Color(255, 185, 15),
- 'darkgoldenrod2': Color(238, 173, 14),
- 'darkgoldenrod3': Color(205, 149, 12),
- 'darkgoldenrod4': Color(139, 101, 8),
- 'darkgray': Color(169, 169, 169),
- 'darkgreen': Color(0, 100, 0),
- 'darkgrey': Color(169, 169, 169),
- 'darkkhaki': Color(189, 183, 107),
- 'darkmagenta': Color(139, 0, 139),
- 'darkolivegreen': Color(85, 107, 47),
- 'darkolivegreen1': Color(202, 255, 112),
- 'darkolivegreen2': Color(188, 238, 104),
- 'darkolivegreen3': Color(162, 205, 90),
- 'darkolivegreen4': Color(110, 139, 61),
- 'darkorange': Color(255, 140, 0),
- 'darkorange1': Color(255, 127, 0),
- 'darkorange2': Color(238, 118, 0),
- 'darkorange3': Color(205, 102, 0),
- 'darkorange4': Color(139, 69, 0),
- 'darkorchid': Color(153, 50, 204),
- 'darkorchid1': Color(191, 62, 255),
- 'darkorchid2': Color(178, 58, 238),
- 'darkorchid3': Color(154, 50, 205),
- 'darkorchid4': Color(104, 34, 139),
- 'darkred': Color(139, 0, 0),
- 'darksalmon': Color(233, 150, 122),
- 'darkseagreen': Color(143, 188, 143),
- 'darkseagreen1': Color(193, 255, 193),
- 'darkseagreen2': Color(180, 238, 180),
- 'darkseagreen3': Color(155, 205, 155),
- 'darkseagreen4': Color(105, 139, 105),
- 'darkslateblue': Color(72, 61, 139),
- 'darkslategray': Color(47, 79, 79),
- 'darkslategray1': Color(151, 255, 255),
- 'darkslategray2': Color(141, 238, 238),
- 'darkslategray3': Color(121, 205, 205),
- 'darkslategray4': Color(82, 139, 139),
- 'darkslategrey': Color(47, 79, 79),
- 'darkturquoise': Color(0, 206, 209),
- 'darkviolet': Color(148, 0, 211),
- 'debianred': Color(215, 7, 81),
- 'deep pink': Color(255, 20, 147),
- 'deep sky blue': Color(0, 191, 255),
- 'deeppink': Color(255, 20, 147),
- 'deeppink1': Color(255, 20, 147),
- 'deeppink2': Color(238, 18, 137),
- 'deeppink3': Color(205, 16, 118),
- 'deeppink4': Color(139, 10, 80),
- 'deepskyblue': Color(0, 191, 255),
- 'deepskyblue1': Color(0, 191, 255),
- 'deepskyblue2': Color(0, 178, 238),
- 'deepskyblue3': Color(0, 154, 205),
- 'deepskyblue4': Color(0, 104, 139),
- 'dim gray': Color(105, 105, 105),
- 'dim grey': Color(105, 105, 105),
- 'dimgray': Color(105, 105, 105),
- 'dimgrey': Color(105, 105, 105),
- 'dodger blue': Color(30, 144, 255),
- 'dodgerblue': Color(30, 144, 255),
- 'dodgerblue1': Color(30, 144, 255),
- 'dodgerblue2': Color(28, 134, 238),
- 'dodgerblue3': Color(24, 116, 205),
- 'dodgerblue4': Color(16, 78, 139),
- 'firebrick': Color(178, 34, 34),
- 'firebrick1': Color(255, 48, 48),
- 'firebrick2': Color(238, 44, 44),
- 'firebrick3': Color(205, 38, 38),
- 'firebrick4': Color(139, 26, 26),
- 'floral white': Color(255, 250, 240),
- 'floralwhite': Color(255, 250, 240),
- 'forest green': Color(34, 139, 34),
- 'forestgreen': Color(34, 139, 34),
- 'gainsboro': Color(220, 220, 220),
- 'ghost white': Color(248, 248, 255),
- 'ghostwhite': Color(248, 248, 255),
- 'gold': Color(255, 215, 0),
- 'gold1': Color(255, 215, 0),
- 'gold2': Color(238, 201, 0),
- 'gold3': Color(205, 173, 0),
- 'gold4': Color(139, 117, 0),
- 'goldenrod': Color(218, 165, 32),
- 'goldenrod1': Color(255, 193, 37),
- 'goldenrod2': Color(238, 180, 34),
- 'goldenrod3': Color(205, 155, 29),
- 'goldenrod4': Color(139, 105, 20),
- 'gray': Color(190, 190, 190),
- 'gray0': Color(0, 0, 0),
- 'gray1': Color(3, 3, 3),
- 'gray10': Color(26, 26, 26),
- 'gray100': Color(255, 255, 255),
- 'gray11': Color(28, 28, 28),
- 'gray12': Color(31, 31, 31),
- 'gray13': Color(33, 33, 33),
- 'gray14': Color(36, 36, 36),
- 'gray15': Color(38, 38, 38),
- 'gray16': Color(41, 41, 41),
- 'gray17': Color(43, 43, 43),
- 'gray18': Color(46, 46, 46),
- 'gray19': Color(48, 48, 48),
- 'gray2': Color(5, 5, 5),
- 'gray20': Color(51, 51, 51),
- 'gray21': Color(54, 54, 54),
- 'gray22': Color(56, 56, 56),
- 'gray23': Color(59, 59, 59),
- 'gray24': Color(61, 61, 61),
- 'gray25': Color(64, 64, 64),
- 'gray26': Color(66, 66, 66),
- 'gray27': Color(69, 69, 69),
- 'gray28': Color(71, 71, 71),
- 'gray29': Color(74, 74, 74),
- 'gray3': Color(8, 8, 8),
- 'gray30': Color(77, 77, 77),
- 'gray31': Color(79, 79, 79),
- 'gray32': Color(82, 82, 82),
- 'gray33': Color(84, 84, 84),
- 'gray34': Color(87, 87, 87),
- 'gray35': Color(89, 89, 89),
- 'gray36': Color(92, 92, 92),
- 'gray37': Color(94, 94, 94),
- 'gray38': Color(97, 97, 97),
- 'gray39': Color(99, 99, 99),
- 'gray4': Color(10, 10, 10),
- 'gray40': Color(102, 102, 102),
- 'gray41': Color(105, 105, 105),
- 'gray42': Color(107, 107, 107),
- 'gray43': Color(110, 110, 110),
- 'gray44': Color(112, 112, 112),
- 'gray45': Color(115, 115, 115),
- 'gray46': Color(117, 117, 117),
- 'gray47': Color(120, 120, 120),
- 'gray48': Color(122, 122, 122),
- 'gray49': Color(125, 125, 125),
- 'gray5': Color(13, 13, 13),
- 'gray50': Color(127, 127, 127),
- 'gray51': Color(130, 130, 130),
- 'gray52': Color(133, 133, 133),
- 'gray53': Color(135, 135, 135),
- 'gray54': Color(138, 138, 138),
- 'gray55': Color(140, 140, 140),
- 'gray56': Color(143, 143, 143),
- 'gray57': Color(145, 145, 145),
- 'gray58': Color(148, 148, 148),
- 'gray59': Color(150, 150, 150),
- 'gray6': Color(15, 15, 15),
- 'gray60': Color(153, 153, 153),
- 'gray61': Color(156, 156, 156),
- 'gray62': Color(158, 158, 158),
- 'gray63': Color(161, 161, 161),
- 'gray64': Color(163, 163, 163),
- 'gray65': Color(166, 166, 166),
- 'gray66': Color(168, 168, 168),
- 'gray67': Color(171, 171, 171),
- 'gray68': Color(173, 173, 173),
- 'gray69': Color(176, 176, 176),
- 'gray7': Color(18, 18, 18),
- 'gray70': Color(179, 179, 179),
- 'gray71': Color(181, 181, 181),
- 'gray72': Color(184, 184, 184),
- 'gray73': Color(186, 186, 186),
- 'gray74': Color(189, 189, 189),
- 'gray75': Color(191, 191, 191),
- 'gray76': Color(194, 194, 194),
- 'gray77': Color(196, 196, 196),
- 'gray78': Color(199, 199, 199),
- 'gray79': Color(201, 201, 201),
- 'gray8': Color(20, 20, 20),
- 'gray80': Color(204, 204, 204),
- 'gray81': Color(207, 207, 207),
- 'gray82': Color(209, 209, 209),
- 'gray83': Color(212, 212, 212),
- 'gray84': Color(214, 214, 214),
- 'gray85': Color(217, 217, 217),
- 'gray86': Color(219, 219, 219),
- 'gray87': Color(222, 222, 222),
- 'gray88': Color(224, 224, 224),
- 'gray89': Color(227, 227, 227),
- 'gray9': Color(23, 23, 23),
- 'gray90': Color(229, 229, 229),
- 'gray91': Color(232, 232, 232),
- 'gray92': Color(235, 235, 235),
- 'gray93': Color(237, 237, 237),
- 'gray94': Color(240, 240, 240),
- 'gray95': Color(242, 242, 242),
- 'gray96': Color(245, 245, 245),
- 'gray97': Color(247, 247, 247),
- 'gray98': Color(250, 250, 250),
- 'gray99': Color(252, 252, 252),
- 'green': Color(0, 255, 0),
- 'green yellow': Color(173, 255, 47),
- 'green1': Color(0, 255, 0),
- 'green2': Color(0, 238, 0),
- 'green3': Color(0, 205, 0),
- 'green4': Color(0, 139, 0),
- 'greenyellow': Color(173, 255, 47),
- 'grey': Color(190, 190, 190),
- 'grey0': Color(0, 0, 0),
- 'grey1': Color(3, 3, 3),
- 'grey10': Color(26, 26, 26),
- 'grey100': Color(255, 255, 255),
- 'grey11': Color(28, 28, 28),
- 'grey12': Color(31, 31, 31),
- 'grey13': Color(33, 33, 33),
- 'grey14': Color(36, 36, 36),
- 'grey15': Color(38, 38, 38),
- 'grey16': Color(41, 41, 41),
- 'grey17': Color(43, 43, 43),
- 'grey18': Color(46, 46, 46),
- 'grey19': Color(48, 48, 48),
- 'grey2': Color(5, 5, 5),
- 'grey20': Color(51, 51, 51),
- 'grey21': Color(54, 54, 54),
- 'grey22': Color(56, 56, 56),
- 'grey23': Color(59, 59, 59),
- 'grey24': Color(61, 61, 61),
- 'grey25': Color(64, 64, 64),
- 'grey26': Color(66, 66, 66),
- 'grey27': Color(69, 69, 69),
- 'grey28': Color(71, 71, 71),
- 'grey29': Color(74, 74, 74),
- 'grey3': Color(8, 8, 8),
- 'grey30': Color(77, 77, 77),
- 'grey31': Color(79, 79, 79),
- 'grey32': Color(82, 82, 82),
- 'grey33': Color(84, 84, 84),
- 'grey34': Color(87, 87, 87),
- 'grey35': Color(89, 89, 89),
- 'grey36': Color(92, 92, 92),
- 'grey37': Color(94, 94, 94),
- 'grey38': Color(97, 97, 97),
- 'grey39': Color(99, 99, 99),
- 'grey4': Color(10, 10, 10),
- 'grey40': Color(102, 102, 102),
- 'grey41': Color(105, 105, 105),
- 'grey42': Color(107, 107, 107),
- 'grey43': Color(110, 110, 110),
- 'grey44': Color(112, 112, 112),
- 'grey45': Color(115, 115, 115),
- 'grey46': Color(117, 117, 117),
- 'grey47': Color(120, 120, 120),
- 'grey48': Color(122, 122, 122),
- 'grey49': Color(125, 125, 125),
- 'grey5': Color(13, 13, 13),
- 'grey50': Color(127, 127, 127),
- 'grey51': Color(130, 130, 130),
- 'grey52': Color(133, 133, 133),
- 'grey53': Color(135, 135, 135),
- 'grey54': Color(138, 138, 138),
- 'grey55': Color(140, 140, 140),
- 'grey56': Color(143, 143, 143),
- 'grey57': Color(145, 145, 145),
- 'grey58': Color(148, 148, 148),
- 'grey59': Color(150, 150, 150),
- 'grey6': Color(15, 15, 15),
- 'grey60': Color(153, 153, 153),
- 'grey61': Color(156, 156, 156),
- 'grey62': Color(158, 158, 158),
- 'grey63': Color(161, 161, 161),
- 'grey64': Color(163, 163, 163),
- 'grey65': Color(166, 166, 166),
- 'grey66': Color(168, 168, 168),
- 'grey67': Color(171, 171, 171),
- 'grey68': Color(173, 173, 173),
- 'grey69': Color(176, 176, 176),
- 'grey7': Color(18, 18, 18),
- 'grey70': Color(179, 179, 179),
- 'grey71': Color(181, 181, 181),
- 'grey72': Color(184, 184, 184),
- 'grey73': Color(186, 186, 186),
- 'grey74': Color(189, 189, 189),
- 'grey75': Color(191, 191, 191),
- 'grey76': Color(194, 194, 194),
- 'grey77': Color(196, 196, 196),
- 'grey78': Color(199, 199, 199),
- 'grey79': Color(201, 201, 201),
- 'grey8': Color(20, 20, 20),
- 'grey80': Color(204, 204, 204),
- 'grey81': Color(207, 207, 207),
- 'grey82': Color(209, 209, 209),
- 'grey83': Color(212, 212, 212),
- 'grey84': Color(214, 214, 214),
- 'grey85': Color(217, 217, 217),
- 'grey86': Color(219, 219, 219),
- 'grey87': Color(222, 222, 222),
- 'grey88': Color(224, 224, 224),
- 'grey89': Color(227, 227, 227),
- 'grey9': Color(23, 23, 23),
- 'grey90': Color(229, 229, 229),
- 'grey91': Color(232, 232, 232),
- 'grey92': Color(235, 235, 235),
- 'grey93': Color(237, 237, 237),
- 'grey94': Color(240, 240, 240),
- 'grey95': Color(242, 242, 242),
- 'grey96': Color(245, 245, 245),
- 'grey97': Color(247, 247, 247),
- 'grey98': Color(250, 250, 250),
- 'grey99': Color(252, 252, 252),
- 'honeydew': Color(240, 255, 240),
- 'honeydew1': Color(240, 255, 240),
- 'honeydew2': Color(224, 238, 224),
- 'honeydew3': Color(193, 205, 193),
- 'honeydew4': Color(131, 139, 131),
- 'hot pink': Color(255, 105, 180),
- 'hotpink': Color(255, 105, 180),
- 'hotpink1': Color(255, 110, 180),
- 'hotpink2': Color(238, 106, 167),
- 'hotpink3': Color(205, 96, 144),
- 'hotpink4': Color(139, 58, 98),
- 'indian red': Color(205, 92, 92),
- 'indianred': Color(205, 92, 92),
- 'indianred1': Color(255, 106, 106),
- 'indianred2': Color(238, 99, 99),
- 'indianred3': Color(205, 85, 85),
- 'indianred4': Color(139, 58, 58),
- 'ivory': Color(255, 255, 240),
- 'ivory1': Color(255, 255, 240),
- 'ivory2': Color(238, 238, 224),
- 'ivory3': Color(205, 205, 193),
- 'ivory4': Color(139, 139, 131),
- 'khaki': Color(240, 230, 140),
- 'khaki1': Color(255, 246, 143),
- 'khaki2': Color(238, 230, 133),
- 'khaki3': Color(205, 198, 115),
- 'khaki4': Color(139, 134, 78),
- 'lavender': Color(230, 230, 250),
- 'lavender blush': Color(255, 240, 245),
- 'lavenderblush': Color(255, 240, 245),
- 'lavenderblush1': Color(255, 240, 245),
- 'lavenderblush2': Color(238, 224, 229),
- 'lavenderblush3': Color(205, 193, 197),
- 'lavenderblush4': Color(139, 131, 134),
- 'lawn green': Color(124, 252, 0),
- 'lawngreen': Color(124, 252, 0),
- 'lemon chiffon': Color(255, 250, 205),
- 'lemonchiffon': Color(255, 250, 205),
- 'lemonchiffon1': Color(255, 250, 205),
- 'lemonchiffon2': Color(238, 233, 191),
- 'lemonchiffon3': Color(205, 201, 165),
- 'lemonchiffon4': Color(139, 137, 112),
- 'light blue': Color(173, 216, 230),
- 'light coral': Color(240, 128, 128),
- 'light cyan': Color(224, 255, 255),
- 'light goldenrod': Color(238, 221, 130),
- 'light goldenrod yellow': Color(250, 250, 210),
- 'light gray': Color(211, 211, 211),
- 'light green': Color(144, 238, 144),
- 'light grey': Color(211, 211, 211),
- 'light pink': Color(255, 182, 193),
- 'light salmon': Color(255, 160, 122),
- 'light sea green': Color(32, 178, 170),
- 'light sky blue': Color(135, 206, 250),
- 'light slate blue': Color(132, 112, 255),
- 'light slate gray': Color(119, 136, 153),
- 'light slate grey': Color(119, 136, 153),
- 'light steel blue': Color(176, 196, 222),
- 'light yellow': Color(255, 255, 224),
- 'lightblue': Color(173, 216, 230),
- 'lightblue1': Color(191, 239, 255),
- 'lightblue2': Color(178, 223, 238),
- 'lightblue3': Color(154, 192, 205),
- 'lightblue4': Color(104, 131, 139),
- 'lightcoral': Color(240, 128, 128),
- 'lightcyan': Color(224, 255, 255),
- 'lightcyan1': Color(224, 255, 255),
- 'lightcyan2': Color(209, 238, 238),
- 'lightcyan3': Color(180, 205, 205),
- 'lightcyan4': Color(122, 139, 139),
- 'lightgoldenrod': Color(238, 221, 130),
- 'lightgoldenrod1': Color(255, 236, 139),
- 'lightgoldenrod2': Color(238, 220, 130),
- 'lightgoldenrod3': Color(205, 190, 112),
- 'lightgoldenrod4': Color(139, 129, 76),
- 'lightgoldenrodyellow': Color(250, 250, 210),
- 'lightgray': Color(211, 211, 211),
- 'lightgreen': Color(144, 238, 144),
- 'lightgrey': Color(211, 211, 211),
- 'lightpink': Color(255, 182, 193),
- 'lightpink1': Color(255, 174, 185),
- 'lightpink2': Color(238, 162, 173),
- 'lightpink3': Color(205, 140, 149),
- 'lightpink4': Color(139, 95, 101),
- 'lightsalmon': Color(255, 160, 122),
- 'lightsalmon1': Color(255, 160, 122),
- 'lightsalmon2': Color(238, 149, 114),
- 'lightsalmon3': Color(205, 129, 98),
- 'lightsalmon4': Color(139, 87, 66),
- 'lightseagreen': Color(32, 178, 170),
- 'lightskyblue': Color(135, 206, 250),
- 'lightskyblue1': Color(176, 226, 255),
- 'lightskyblue2': Color(164, 211, 238),
- 'lightskyblue3': Color(141, 182, 205),
- 'lightskyblue4': Color(96, 123, 139),
- 'lightslateblue': Color(132, 112, 255),
- 'lightslategray': Color(119, 136, 153),
- 'lightslategrey': Color(119, 136, 153),
- 'lightsteelblue': Color(176, 196, 222),
- 'lightsteelblue1': Color(202, 225, 255),
- 'lightsteelblue2': Color(188, 210, 238),
- 'lightsteelblue3': Color(162, 181, 205),
- 'lightsteelblue4': Color(110, 123, 139),
- 'lightyellow': Color(255, 255, 224),
- 'lightyellow1': Color(255, 255, 224),
- 'lightyellow2': Color(238, 238, 209),
- 'lightyellow3': Color(205, 205, 180),
- 'lightyellow4': Color(139, 139, 122),
- 'lime green': Color(50, 205, 50),
- 'limegreen': Color(50, 205, 50),
- 'linen': Color(250, 240, 230),
- 'magenta': Color(255, 0, 255),
- 'magenta1': Color(255, 0, 255),
- 'magenta2': Color(238, 0, 238),
- 'magenta3': Color(205, 0, 205),
- 'magenta4': Color(139, 0, 139),
- 'maroon': Color(176, 48, 96),
- 'maroon1': Color(255, 52, 179),
- 'maroon2': Color(238, 48, 167),
- 'maroon3': Color(205, 41, 144),
- 'maroon4': Color(139, 28, 98),
- 'medium aquamarine': Color(102, 205, 170),
- 'medium blue': Color(0, 0, 205),
- 'medium orchid': Color(186, 85, 211),
- 'medium purple': Color(147, 112, 219),
- 'medium sea green': Color(60, 179, 113),
- 'medium slate blue': Color(123, 104, 238),
- 'medium spring green': Color(0, 250, 154),
- 'medium turquoise': Color(72, 209, 204),
- 'medium violet red': Color(199, 21, 133),
- 'mediumaquamarine': Color(102, 205, 170),
- 'mediumblue': Color(0, 0, 205),
- 'mediumorchid': Color(186, 85, 211),
- 'mediumorchid1': Color(224, 102, 255),
- 'mediumorchid2': Color(209, 95, 238),
- 'mediumorchid3': Color(180, 82, 205),
- 'mediumorchid4': Color(122, 55, 139),
- 'mediumpurple': Color(147, 112, 219),
- 'mediumpurple1': Color(171, 130, 255),
- 'mediumpurple2': Color(159, 121, 238),
- 'mediumpurple3': Color(137, 104, 205),
- 'mediumpurple4': Color(93, 71, 139),
- 'mediumseagreen': Color(60, 179, 113),
- 'mediumslateblue': Color(123, 104, 238),
- 'mediumspringgreen': Color(0, 250, 154),
- 'mediumturquoise': Color(72, 209, 204),
- 'mediumvioletred': Color(199, 21, 133),
- 'midnight blue': Color(25, 25, 112),
- 'midnightblue': Color(25, 25, 112),
- 'mint cream': Color(245, 255, 250),
- 'mintcream': Color(245, 255, 250),
- 'misty rose': Color(255, 228, 225),
- 'mistyrose': Color(255, 228, 225),
- 'mistyrose1': Color(255, 228, 225),
- 'mistyrose2': Color(238, 213, 210),
- 'mistyrose3': Color(205, 183, 181),
- 'mistyrose4': Color(139, 125, 123),
- 'moccasin': Color(255, 228, 181),
- 'navajo white': Color(255, 222, 173),
- 'navajowhite': Color(255, 222, 173),
- 'navajowhite1': Color(255, 222, 173),
- 'navajowhite2': Color(238, 207, 161),
- 'navajowhite3': Color(205, 179, 139),
- 'navajowhite4': Color(139, 121, 94),
- 'navy': Color(0, 0, 128),
- 'navy blue': Color(0, 0, 128),
- 'navyblue': Color(0, 0, 128),
- 'old lace': Color(253, 245, 230),
- 'oldlace': Color(253, 245, 230),
- 'olive drab': Color(107, 142, 35),
- 'olivedrab': Color(107, 142, 35),
- 'olivedrab1': Color(192, 255, 62),
- 'olivedrab2': Color(179, 238, 58),
- 'olivedrab3': Color(154, 205, 50),
- 'olivedrab4': Color(105, 139, 34),
- 'orange': Color(255, 165, 0),
- 'orange red': Color(255, 69, 0),
- 'orange1': Color(255, 165, 0),
- 'orange2': Color(238, 154, 0),
- 'orange3': Color(205, 133, 0),
- 'orange4': Color(139, 90, 0),
- 'orangered': Color(255, 69, 0),
- 'orangered1': Color(255, 69, 0),
- 'orangered2': Color(238, 64, 0),
- 'orangered3': Color(205, 55, 0),
- 'orangered4': Color(139, 37, 0),
- 'orchid': Color(218, 112, 214),
- 'orchid1': Color(255, 131, 250),
- 'orchid2': Color(238, 122, 233),
- 'orchid3': Color(205, 105, 201),
- 'orchid4': Color(139, 71, 137),
- 'pale goldenrod': Color(238, 232, 170),
- 'pale green': Color(152, 251, 152),
- 'pale turquoise': Color(175, 238, 238),
- 'pale violet red': Color(219, 112, 147),
- 'palegoldenrod': Color(238, 232, 170),
- 'palegreen': Color(152, 251, 152),
- 'palegreen1': Color(154, 255, 154),
- 'palegreen2': Color(144, 238, 144),
- 'palegreen3': Color(124, 205, 124),
- 'palegreen4': Color(84, 139, 84),
- 'paleturquoise': Color(175, 238, 238),
- 'paleturquoise1': Color(187, 255, 255),
- 'paleturquoise2': Color(174, 238, 238),
- 'paleturquoise3': Color(150, 205, 205),
- 'paleturquoise4': Color(102, 139, 139),
- 'palevioletred': Color(219, 112, 147),
- 'palevioletred1': Color(255, 130, 171),
- 'palevioletred2': Color(238, 121, 159),
- 'palevioletred3': Color(205, 104, 137),
- 'palevioletred4': Color(139, 71, 93),
- 'papaya whip': Color(255, 239, 213),
- 'papayawhip': Color(255, 239, 213),
- 'peach puff': Color(255, 218, 185),
- 'peachpuff': Color(255, 218, 185),
- 'peachpuff1': Color(255, 218, 185),
- 'peachpuff2': Color(238, 203, 173),
- 'peachpuff3': Color(205, 175, 149),
- 'peachpuff4': Color(139, 119, 101),
- 'peru': Color(205, 133, 63),
- 'pink': Color(255, 192, 203),
- 'pink1': Color(255, 181, 197),
- 'pink2': Color(238, 169, 184),
- 'pink3': Color(205, 145, 158),
- 'pink4': Color(139, 99, 108),
- 'plum': Color(221, 160, 221),
- 'plum1': Color(255, 187, 255),
- 'plum2': Color(238, 174, 238),
- 'plum3': Color(205, 150, 205),
- 'plum4': Color(139, 102, 139),
- 'powder blue': Color(176, 224, 230),
- 'powderblue': Color(176, 224, 230),
- 'purple': Color(160, 32, 240),
- 'purple1': Color(155, 48, 255),
- 'purple2': Color(145, 44, 238),
- 'purple3': Color(125, 38, 205),
- 'purple4': Color(85, 26, 139),
- 'red': Color(255, 0, 0),
- 'red1': Color(255, 0, 0),
- 'red2': Color(238, 0, 0),
- 'red3': Color(205, 0, 0),
- 'red4': Color(139, 0, 0),
- 'rosy brown': Color(188, 143, 143),
- 'rosybrown': Color(188, 143, 143),
- 'rosybrown1': Color(255, 193, 193),
- 'rosybrown2': Color(238, 180, 180),
- 'rosybrown3': Color(205, 155, 155),
- 'rosybrown4': Color(139, 105, 105),
- 'royal blue': Color(65, 105, 225),
- 'royalblue': Color(65, 105, 225),
- 'royalblue1': Color(72, 118, 255),
- 'royalblue2': Color(67, 110, 238),
- 'royalblue3': Color(58, 95, 205),
- 'royalblue4': Color(39, 64, 139),
- 'saddle brown': Color(139, 69, 19),
- 'saddlebrown': Color(139, 69, 19),
- 'salmon': Color(250, 128, 114),
- 'salmon1': Color(255, 140, 105),
- 'salmon2': Color(238, 130, 98),
- 'salmon3': Color(205, 112, 84),
- 'salmon4': Color(139, 76, 57),
- 'sandy brown': Color(244, 164, 96),
- 'sandybrown': Color(244, 164, 96),
- 'sea green': Color(46, 139, 87),
- 'seagreen': Color(46, 139, 87),
- 'seagreen1': Color(84, 255, 159),
- 'seagreen2': Color(78, 238, 148),
- 'seagreen3': Color(67, 205, 128),
- 'seagreen4': Color(46, 139, 87),
- 'seashell': Color(255, 245, 238),
- 'seashell1': Color(255, 245, 238),
- 'seashell2': Color(238, 229, 222),
- 'seashell3': Color(205, 197, 191),
- 'seashell4': Color(139, 134, 130),
- 'sienna': Color(160, 82, 45),
- 'sienna1': Color(255, 130, 71),
- 'sienna2': Color(238, 121, 66),
- 'sienna3': Color(205, 104, 57),
- 'sienna4': Color(139, 71, 38),
- 'sky blue': Color(135, 206, 235),
- 'skyblue': Color(135, 206, 235),
- 'skyblue1': Color(135, 206, 255),
- 'skyblue2': Color(126, 192, 238),
- 'skyblue3': Color(108, 166, 205),
- 'skyblue4': Color(74, 112, 139),
- 'slate blue': Color(106, 90, 205),
- 'slate gray': Color(112, 128, 144),
- 'slate grey': Color(112, 128, 144),
- 'slateblue': Color(106, 90, 205),
- 'slateblue1': Color(131, 111, 255),
- 'slateblue2': Color(122, 103, 238),
- 'slateblue3': Color(105, 89, 205),
- 'slateblue4': Color(71, 60, 139),
- 'slategray': Color(112, 128, 144),
- 'slategray1': Color(198, 226, 255),
- 'slategray2': Color(185, 211, 238),
- 'slategray3': Color(159, 182, 205),
- 'slategray4': Color(108, 123, 139),
- 'slategrey': Color(112, 128, 144),
- 'snow': Color(255, 250, 250),
- 'snow1': Color(255, 250, 250),
- 'snow2': Color(238, 233, 233),
- 'snow3': Color(205, 201, 201),
- 'snow4': Color(139, 137, 137),
- 'spring green': Color(0, 255, 127),
- 'springgreen': Color(0, 255, 127),
- 'springgreen1': Color(0, 255, 127),
- 'springgreen2': Color(0, 238, 118),
- 'springgreen3': Color(0, 205, 102),
- 'springgreen4': Color(0, 139, 69),
- 'steel blue': Color(70, 130, 180),
- 'steelblue': Color(70, 130, 180),
- 'steelblue1': Color(99, 184, 255),
- 'steelblue2': Color(92, 172, 238),
- 'steelblue3': Color(79, 148, 205),
- 'steelblue4': Color(54, 100, 139),
- 'tan': Color(210, 180, 140),
- 'tan1': Color(255, 165, 79),
- 'tan2': Color(238, 154, 73),
- 'tan3': Color(205, 133, 63),
- 'tan4': Color(139, 90, 43),
- 'thistle': Color(216, 191, 216),
- 'thistle1': Color(255, 225, 255),
- 'thistle2': Color(238, 210, 238),
- 'thistle3': Color(205, 181, 205),
- 'thistle4': Color(139, 123, 139),
- 'tomato': Color(255, 99, 71),
- 'tomato1': Color(255, 99, 71),
- 'tomato2': Color(238, 92, 66),
- 'tomato3': Color(205, 79, 57),
- 'tomato4': Color(139, 54, 38),
- 'turquoise': Color(64, 224, 208),
- 'turquoise1': Color(0, 245, 255),
- 'turquoise2': Color(0, 229, 238),
- 'turquoise3': Color(0, 197, 205),
- 'turquoise4': Color(0, 134, 139),
- 'violet': Color(238, 130, 238),
- 'violet red': Color(208, 32, 144),
- 'violetred': Color(208, 32, 144),
- 'violetred1': Color(255, 62, 150),
- 'violetred2': Color(238, 58, 140),
- 'violetred3': Color(205, 50, 120),
- 'violetred4': Color(139, 34, 82),
- 'wheat': Color(245, 222, 179),
- 'wheat1': Color(255, 231, 186),
- 'wheat2': Color(238, 216, 174),
- 'wheat3': Color(205, 186, 150),
- 'wheat4': Color(139, 126, 102),
- 'white': Color(255, 255, 255),
- 'white smoke': Color(245, 245, 245),
- 'whitesmoke': Color(245, 245, 245),
- 'yellow': Color(255, 255, 0),
- 'yellow green': Color(154, 205, 50),
- 'yellow1': Color(255, 255, 0),
- 'yellow2': Color(238, 238, 0),
- 'yellow3': Color(205, 205, 0),
- 'yellow4': Color(139, 139, 0),
- 'yellowgreen': Color(154, 205, 50)}
-# END_DATA_SECTION }}}
-
-def main(args: list[str]=sys.argv) -> None:
-    with tempfile.TemporaryFile(suffix='.gperf', mode='w+') as tf:
-        print('struct Keyword { int name, value; };\n%%', file=tf)
-        names = sorted(color_names)
-        for name in names:
-            print(f'{name}, {color_names[name]}', file=tf)
-        print('%%', file=tf)
-        tf.flush()
-        tf.seek(0)
-        with open('kitty/color-names.h', 'w') as header:
-            subprocess.check_call(
-                'gperf -m 2000 --struct-type --includes --readonly-tables --lookup-function-name in_color_name_set'
-                ' --global-table --null-strings --hash-function-name color_name_hash /dev/stdin'
-                ' --word-array-name color_names --pic --compare-strncmp'.split(), stdout=header, stdin=tf)
-
-
-if __name__ == '__main__':
-    import runpy
-    m = runpy.run_path(os.path.dirname(os.path.abspath(__file__)))
-    m['main']([sys.executable, 'color-names'])

gen/config.py

@@ -6,6 +6,7 @@ import os
 import re
 import subprocess
 import sys
+from typing import List
 
 from kitty.conf.generate import write_output
 
@@ -15,7 +16,7 @@ if __name__ == '__main__' and not __package__:
     sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 
-def patch_color_list(path: str, colors: list[str], name: str, spc: str = '    ') -> None:
+def patch_color_list(path: str, colors: List[str], name: str, spc: str = '    ') -> None:
     with open(path, 'r+') as f:
         raw = f.read()
         colors = sorted(colors)
@@ -39,33 +40,21 @@ def patch_color_list(path: str, colors: list[str], name: str, spc: str = '    ')
                 subprocess.check_call(['gofmt', '-w', path])
 
 
-def main(args: list[str]=sys.argv) -> None:
+def main(args: List[str]=sys.argv) -> None:
     from kitty.options.definition import definition
+    write_output('kitty', definition)
     nullable_colors = []
     all_colors = []
-    special_colors = []
     for opt in definition.iter_all_options():
         if callable(opt.parser_func):
-            match opt.parser_func.__name__:
-                case 'to_color':
-                    all_colors.append(opt.name)
-                case 'macos_titlebar_color' | 'titlebar_color' | 'scrollbar_color':
-                    all_colors.append(opt.name)
-                    special_colors.append(opt.name)
-                case 'to_color_or_none' | 'cursor_text_color':
-                    all_colors.append(opt.name)
-                    nullable_colors.append(opt.name)
-
+            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('tools/cmd/at/set_colors.go', nullable_colors, 'NULLABLE')
     patch_color_list('tools/themes/collection.go', all_colors, 'ALL')
-    nc = ',\n    '.join(f'{x!r}' for x in nullable_colors)
-    sc = ',\n    '.join(f'{x!r}' for x in special_colors)
-    ac = ',\n    '.join(f'{x!r}' for x in all_colors)
-    write_output('kitty', definition,
-                 f'\nnullable_colors = frozenset({{\n    {nc}\n}})\n'
-                 f'\nspecial_colors = frozenset({{\n    {sc}\n}})\n'
-                 f'\nall_colors = frozenset({{\n    {ac}\n}})\n'
-    )
 
 
 if __name__ == '__main__':

gen/cursors.py

@@ -4,6 +4,7 @@
 import os
 import subprocess
 import sys
+from typing import List
 
 if __name__ == '__main__' and not __package__:
     import __main__
@@ -57,7 +58,7 @@ grabbing      grabbing       grabbing,closedhand,dnd-none              grabbing
 '''
 
 
-def main(args: list[str]=sys.argv) -> None:
+def main(args: List[str]=sys.argv) -> None:
     glfw_enum = []
     css_names = []
     glfw_xc_map = {}
@@ -118,7 +119,7 @@ def main(args: list[str]=sys.argv) -> None:
     patch_file('glfw/x11_window.c', 'glfw to xc mapping', '\n'.join(f'        {x}' for x in glfw_xfont_map))
     patch_file('kitty/data-types.h', 'mouse shapes', '\n'.join(f'    {x},' for x in enum_to_glfw_map))
     patch_file(
-        'kitty/options/utils.py', 'pointer shape names', '\n'.join(f'    {x!r},' for x in kitty_to_enum_map),
+        'kitty/options/definition.py', 'pointer shape names', '\n'.join(f'    {x!r},' for x in kitty_to_enum_map),
         start_marker='# ', end_marker='',
     )
     patch_file('kitty/options/to-c.h', 'pointer shapes', '\n'.join(

gen/go_code.py

@@ -12,15 +12,20 @@ import struct
 import subprocess
 import sys
 import tarfile
-from collections.abc import Iterator, Sequence
 from contextlib import contextmanager, suppress
 from functools import lru_cache
 from itertools import chain
 from typing import (
     Any,
     BinaryIO,
+    Dict,
+    Iterator,
+    List,
     Optional,
+    Sequence,
+    Set,
     TextIO,
+    Tuple,
     Union,
 )
 
@@ -29,20 +34,21 @@ from kittens.tui.operations import Mode
 from kittens.tui.spinners import spinners
 from kitty.actions import get_all_actions
 from kitty.cli import (
+    CompletionSpec,
     GoOption,
     go_options_for_seq,
+    parse_option_spec,
+    serialize_as_go_string,
 )
 from kitty.conf.generate import gen_go_code
 from kitty.conf.types import Definition
-from kitty.config import commented_out_default_config
-from kitty.fast_data_types import all_color_names
 from kitty.guess_mime_type import known_extensions, text_mimes
 from kitty.key_encoding import config_mod_map
 from kitty.key_names import character_key_name_aliases, functional_key_name_aliases
 from kitty.options.types import Options
 from kitty.rc.base import RemoteCommand, all_command_names, command_for_name
 from kitty.remote_control import global_options_spec
-from kitty.simple_cli_definitions import CompletionSpec, parse_option_spec, serialize_as_go_string
+from kitty.rgb import color_names
 
 if __name__ == '__main__' and not __package__:
     import __main__
@@ -50,7 +56,7 @@ if __name__ == '__main__' and not __package__:
     sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 
-changed: list[str] = []
+changed: List[str] = []
 
 
 def newer(dest: str, *sources: str) -> bool:
@@ -68,7 +74,7 @@ def newer(dest: str, *sources: str) -> bool:
 
 # Utils {{{
 
-def serialize_go_dict(x: Union[dict[str, int], dict[int, str], dict[int, int], dict[str, str]]) -> str:
+def serialize_go_dict(x: Union[Dict[str, int], Dict[int, str], Dict[int, int], Dict[str, str]]) -> str:
     ans = []
 
     def s(x: Union[int, str]) -> str:
@@ -177,33 +183,6 @@ def stringify() -> None:
         stringify_file(path)
 # }}}
 
-# {{{ Bitfields
-
-def make_bitfields() -> None:
-    from kitty.fast_data_types import SCALE_BITS, SUBSCALE_BITS, WIDTH_BITS
-
-    from .bitfields import make_bitfield
-
-    def mb(*args: str) -> None:
-        output_path, ans = make_bitfield(*args)
-        with replace_if_needed(output_path) as buf:
-            print(ans, file=buf)
-
-    mb(
-        'tools/vt', 'CellAttrs',
-        'decoration 3', 'bold 1', 'italic 1', 'reverse 1', 'strike 1', 'dim 1', 'hyperlink_id 16',
-    )
-    mb('tools/vt', 'Ch', 'is_idx 1', 'ch_or_idx 31')
-    mb(
-        'tools/vt', 'MultiCell',
-        'is_multicell 1', 'natural_width 1', f'scale {SCALE_BITS}', f'subscale_n {SUBSCALE_BITS}', f'subscale_d {SUBSCALE_BITS}',
-        f'width {WIDTH_BITS}', f'x {WIDTH_BITS + SCALE_BITS + 1}', f'y {SCALE_BITS + 1}', 'vertical_align 3',
-    )
-    mb('tools/vt', 'CellColor', 'is_idx 1', 'red 8', 'green 8', 'blue 8')
-    mb('tools/vt', 'LineAttrs', 'prompt_kind 2',)
-    mb('kittens/choose_files', 'CombinedScore', 'score 16', 'length 16', 'index 32')
-# }}}
-
 # Completions {{{
 
 @lru_cache
@@ -213,7 +192,7 @@ def kitten_cli_docs(kitten: str) -> Any:
 
 
 @lru_cache
-def go_options_for_kitten(kitten: str) -> tuple[Sequence[GoOption], Optional[CompletionSpec]]:
+def go_options_for_kitten(kitten: str) -> Tuple[Sequence[GoOption], Optional[CompletionSpec]]:
     kcd = kitten_cli_docs(kitten)
     if kcd:
         ospec = kcd['options']
@@ -247,7 +226,7 @@ def clone_safe_launch_opts() -> Sequence[GoOption]:
     ans = []
     allowed = clone_safe_opts()
     for o in go_options_for_seq(parse_option_spec(options_spec())[0]):
-        if o.obj_defn.name in allowed:
+        if o.obj_dict['name'] in allowed:
             ans.append(o)
     return tuple(ans)
 
@@ -260,9 +239,9 @@ def completion_for_launch_wrappers(*names: str) -> None:
 
 def generate_completions_for_kitty() -> None:
     print('package completion\n')
-    print('import "github.com/kovidgoyal/kitty/tools/cli"')
-    print('import "github.com/kovidgoyal/kitty/tools/cmd/tool"')
-    print('import "github.com/kovidgoyal/kitty/tools/cmd/at"')
+    print('import "kitty/tools/cli"')
+    print('import "kitty/tools/cmd/tool"')
+    print('import "kitty/tools/cmd/at"')
 
     print('func kitty(root *cli.Command) {')
 
@@ -318,7 +297,7 @@ def generate_completions_for_kitty() -> None:
 
 
 # rc command wrappers {{{
-json_field_types: dict[str, str] = {
+json_field_types: Dict[str, str] = {
     'bool': 'bool', 'str': 'escaped_string', 'list.str': '[]escaped_string', 'dict.str': 'map[escaped_string]escaped_string', 'float': 'float64', 'int': 'int',
     'scroll_amount': 'any', 'spacing': 'any', 'colors': 'any',
 }
@@ -340,16 +319,10 @@ def go_field_type(json_field_type: str) -> str:
 
 class JSONField:
 
-    def __init__(self, line: str, field_to_option_map: dict[str, str], option_map: dict[str, GoOption]) -> None:
+    def __init__(self, line: str) -> None:
         field_def = line.split(':', 1)[0]
         self.required = False
         self.field, self.field_type = field_def.split('/', 1)
-        self.go_option_name = field_to_option_map.get(self.field, self.field)
-        self.go_option_name = ''.join(x.capitalize() for x in self.go_option_name.split('_'))
-        self.omitempty = True
-        if fo := option_map.get(self.go_option_name):
-            if fo.type in ('int', 'float') and float(fo.default or 0) != 0:
-                self.omitempty = False
         self.field_type, self.special_parser = self.field_type.partition('=')[::2]
         if self.field.endswith('+'):
             self.required = True
@@ -357,44 +330,45 @@ class JSONField:
         self.struct_field_name = self.field[0].upper() + self.field[1:]
 
     def go_declaration(self) -> str:
-        omitempty = ',omitempty' if self.omitempty else ''
-        return self.struct_field_name + ' ' + go_field_type(self.field_type) + f'`json:"{self.field}{omitempty}"`'
+        return self.struct_field_name + ' ' + go_field_type(self.field_type) + f'`json:"{self.field},omitempty"`'
 
 
 def go_code_for_remote_command(name: str, cmd: RemoteCommand, template: str) -> str:
     template = '\n' + template[len('//go:build exclude'):]
-    af: list[str] = []
+    af: List[str] = []
     a = af.append
     af.extend(cmd.args.as_go_completion_code('ans'))
-    od: list[str] = []
-    option_map: dict[str, GoOption] = {}
+    od: List[str] = []
+    option_map: Dict[str, GoOption] = {}
     for o in rc_command_options(name):
         option_map[o.go_var_name] = o
         a(o.as_option('ans'))
         if o.go_var_name in ('NoResponse', 'ResponseTimeout'):
             continue
         od.append(o.struct_declaration())
-    jd: list[str] = []
+    jd: List[str] = []
     json_fields = []
-    field_types: dict[str, str] = {}
+    field_types: Dict[str, str] = {}
     for line in cmd.protocol_spec.splitlines():
         line = line.strip()
         if ':' not in line:
             continue
-        f = JSONField(line, cmd.field_to_option_map or {}, option_map)
+        f = JSONField(line)
         json_fields.append(f)
         field_types[f.field] = f.field_type
         jd.append(f.go_declaration())
-    jc: list[str] = []
-    handled_fields: set[str] = set()
+    jc: List[str] = []
+    handled_fields: Set[str] = set()
     jc.extend(cmd.args.as_go_code(name, field_types, handled_fields))
 
     unhandled = {}
     used_options = set()
     for field in json_fields:
-        if field.go_option_name in option_map:
-            o = option_map[field.go_option_name]
-            used_options.add(field.go_option_name)
+        oq = (cmd.field_to_option_map or {}).get(field.field, field.field)
+        oq = ''.join(x.capitalize() for x in oq.split('_'))
+        if oq in option_map:
+            o = option_map[oq]
+            used_options.add(oq)
             optstring = f'options_{name}.{o.go_var_name}'
             if field.special_parser:
                 optstring = f'{field.special_parser}({optstring})'
@@ -451,6 +425,15 @@ def go_code_for_remote_command(name: str, cmd: RemoteCommand, template: str) ->
 
 # kittens {{{
 
+@lru_cache
+def wrapped_kittens() -> Tuple[str, ...]:
+    with open('shell-integration/ssh/kitty') as f:
+        for line in f:
+            if line.startswith('    wrapped_kittens="'):
+                val = line.strip().partition('"')[2][:-1]
+                return tuple(sorted(filter(None, val.split())))
+    raise Exception('Failed to read wrapped kittens from kitty wrapper script')
+
 
 def generate_conf_parser(kitten: str, defn: Definition) -> None:
     with replace_if_needed(f'kittens/{kitten}/conf_generated.go'):
@@ -459,7 +442,7 @@ def generate_conf_parser(kitten: str, defn: Definition) -> None:
 
 
 def generate_extra_cli_parser(name: str, spec: str) -> None:
-    print('import "github.com/kovidgoyal/kitty/tools/cli"')
+    print('import "kitty/tools/cli"')
     go_opts = tuple(go_options_for_seq(parse_option_spec(spec)[0]))
     print(f'type {name}_options struct ''{')
     for opt in go_opts:
@@ -478,20 +461,9 @@ def generate_extra_cli_parser(name: str, spec: str) -> None:
     print('}')
 
 
-def kittens_needing_cli_parsers() -> Iterator[str]:
-    for d in os.scandir('kittens'):
-        if not d.is_dir(follow_symlinks=False):
-            continue
-        if os.path.exists(os.path.join(d.path, 'main.py')) and os.path.exists(os.path.join(d.path, 'main.go')):
-            with open(os.path.join(d.path, 'main.py')) as f:
-                raw = f.read()
-            if 'options' in raw:
-                yield d.name
-
-
 def kitten_clis() -> None:
     from kittens.runner import get_kitten_conf_docs, get_kitten_extra_cli_parsers
-    for kitten in kittens_needing_cli_parsers():
+    for kitten in wrapped_kittens() + ('pager',):
         defn = get_kitten_conf_docs(kitten)
         if defn is not None:
             generate_conf_parser(kitten, defn)
@@ -504,13 +476,10 @@ def kitten_clis() -> None:
 
         with replace_if_needed(f'kittens/{kitten}/cli_generated.go'):
             od = []
-            ser = []
             kcd = kitten_cli_docs(kitten)
             has_underscore = '_' in kitten
             print(f'package {kitten}')
-            print('import "fmt"')
-            print('import "github.com/kovidgoyal/kitty/tools/cli"')
-            print('var _ = fmt.Sprintf')
+            print('import "kitty/tools/cli"')
             print('func create_cmd(root *cli.Command, run_func func(*cli.Command, *Options, []string)(int, error)) {')
             print('ans := root.AddSubCommand(&cli.Command{')
             print(f'Name: "{kitten}",')
@@ -531,7 +500,6 @@ def kitten_clis() -> None:
             for opt in gopts:
                 print(opt.as_option('ans'))
                 od.append(opt.struct_declaration())
-                ser.append('\n'.join(opt.as_string_for_commandline()))
             if ac is not None:
                 print(''.join(ac.as_go_code('ans.ArgCompleter', ' = ')))
             if not kcd:
@@ -544,14 +512,6 @@ def kitten_clis() -> None:
             print('type Options struct {')
             print('\n'.join(od))
             print('}')
-            print('func (opts Options) AsCommandLine() (ans []string) {')
-            if ser:
-                print('\t sval := ""')
-                print('\t _ = sval')
-                for x in ser:
-                    print('\t' + x)
-            print('return')
-            print('}')
 
 # }}}
 
@@ -585,7 +545,7 @@ def generate_color_names() -> str:
     cursor = "" if Options.cursor is None else Options.cursor.as_sharp
     return 'package style\n\nvar ColorNames = map[string]RGBA{' + '\n'.join(
         f'\t"{name}": RGBA{{ Red:{val.red}, Green:{val.green}, Blue:{val.blue} }},'
-        for name, val in all_color_names()
+        for name, val in color_names.items()
     ) + '\n}' + '\n\nvar ColorTable = [256]uint32{' + ', '.join(
         f'{x}' for x in Options.color_table) + '}\n' + f'''
 var DefaultColors = struct {{
@@ -600,7 +560,7 @@ SelectionBg: "{selbg}",
 '''
 
 
-def load_ref_map() -> dict[str, dict[str, str]]:
+def load_ref_map() -> Dict[str, Dict[str, str]]:
     with open('kitty/docs_ref_map_generated.h') as f:
         raw = f.read()
     raw = raw.split('{', 1)[1].split('}', 1)[0]
@@ -610,14 +570,10 @@ def load_ref_map() -> dict[str, dict[str, str]]:
 
 def generate_constants() -> str:
     from kittens.hints.main import DEFAULT_REGEX
-    from kittens.query_terminal.main import all_queries
-    from kitty.colors import ThemeFile
     from kitty.config import option_names_for_completion
-    from kitty.fast_data_types import DND_CODE, FILE_TRANSFER_CODE
-    from kitty.options.utils import allowed_shell_integration_values, url_style_map
-    from kitty.simple_cli_definitions import CONFIG_HELP
+    from kitty.fast_data_types import FILE_TRANSFER_CODE
+    from kitty.options.utils import allowed_shell_integration_values
     del sys.modules['kittens.hints.main']
-    del sys.modules['kittens.query_terminal.main']
     ref_map = load_ref_map()
     with open('kitty/data-types.h') as dt:
         m = re.search(r'^#define IMAGE_PLACEHOLDER_CHAR (\S+)', dt.read(), flags=re.M)
@@ -626,8 +582,6 @@ def generate_constants() -> str:
     dp = ", ".join(map(lambda x: f'"{serialize_as_go_string(x)}"', kc.default_pager_for_help))
     url_prefixes = ','.join(f'"{x}"' for x in Options.url_prefixes)
     option_names = '`' + '\n'.join(option_names_for_completion()) + '`'
-    url_style = {v:k for k, v in url_style_map.items()}[Options.url_style]
-    query_names = ', '.join(f'"{name}"' for name in all_queries)
     return f'''\
 package kitty
 
@@ -637,7 +591,6 @@ type VersionType struct {{
 const VersionString string = "{kc.str_version}"
 const WebsiteBaseURL string = "{kc.website_base_url}"
 const FileTransferCode int = {FILE_TRANSFER_CODE}
-const DndCode int = {DND_CODE}
 const ImagePlaceholderChar rune = {placeholder_char}
 const SSHControlMasterTemplate = "{kc.ssh_control_master_template}"
 const RC_ENCRYPTION_PROTOCOL_VERSION string = "{kc.RC_ENCRYPTION_PROTOCOL_VERSION}"
@@ -647,9 +600,6 @@ var IsStandaloneBuild string = ""
 const HandleTermiosSignals = {Mode.HANDLE_TERMIOS_SIGNALS.value[0]}
 const HintsDefaultRegex = `{DEFAULT_REGEX}`
 const DefaultTermName = `{Options.term}`
-const DefaultUrlStyle = `{url_style}`
-const DefaultUrlColor = `{Options.url_color.as_sharp}`
-const ConfigHelp = "{serialize_as_go_string(CONFIG_HELP)}"
 var Version VersionType = VersionType{{Major: {kc.version.major}, Minor: {kc.version.minor}, Patch: {kc.version.patch},}}
 var DefaultPager []string = []string{{ {dp} }}
 var FunctionalKeyNameAliases = map[string]string{serialize_go_dict(functional_key_name_aliases)}
@@ -658,11 +608,9 @@ var ConfigModMap = map[string]uint16{serialize_go_dict(config_mod_map)}
 var RefMap = map[string]string{serialize_go_dict(ref_map['ref'])}
 var DocTitleMap = map[string]string{serialize_go_dict(ref_map['doc'])}
 var AllowedShellIntegrationValues = []string{{ {str(sorted(allowed_shell_integration_values))[1:-1].replace("'", '"')} }}
-var QueryNames = []string{{ {query_names} }}
-var CommentedOutDefaultConfig = "{serialize_as_go_string(commented_out_default_config())}"
 var KittyConfigDefaults = struct {{
 Term, Shell_integration, Select_by_word_characters, Url_excluded_characters, Shell string
-Wheel_scroll_multiplier float64
+Wheel_scroll_multiplier int
 Url_prefixes []string
 }}{{
 Term: "{Options.term}", Shell_integration: "{' '.join(Options.shell_integration)}", Url_prefixes: []string{{ {url_prefixes} }},
@@ -670,9 +618,6 @@ Select_by_word_characters: `{Options.select_by_word_characters}`, Wheel_scroll_m
 Shell: "{Options.shell}", Url_excluded_characters: "{Options.url_excluded_characters}",
 }}
 const OptionNames = {option_names}
-const DarkThemeFileName = "{ThemeFile.dark.value}"
-const LightThemeFileName = "{ThemeFile.light.value}"
-const NoPreferenceThemeFileName = "{ThemeFile.no_preference.value}"
 '''  # }}}
 
 
@@ -688,7 +633,7 @@ def replace_if_needed(path: str, show_diff: bool = False) -> Iterator[io.StringI
     finally:
         sys.stdout = origb
     orig = ''
-    with suppress(FileNotFoundError), open(path) as f:
+    with suppress(FileNotFoundError), open(path, 'r') as f:
         orig = f.read()
     new = buf.getvalue()
     new = f'// Code generated by {os.path.basename(__file__)}; DO NOT EDIT.\n\n' + new
@@ -704,7 +649,7 @@ def replace_if_needed(path: str, show_diff: bool = False) -> Iterator[io.StringI
 
 
 @lru_cache(maxsize=256)
-def rc_command_options(name: str) -> tuple[GoOption, ...]:
+def rc_command_options(name: str) -> Tuple[GoOption, ...]:
     cmd = command_for_name(name)
     return tuple(go_options_for_seq(parse_option_spec(cmd.options_spec or '\n\n')[0]))
 
@@ -727,7 +672,7 @@ def update_at_commands() -> None:
     odef = '\n'.join(opt_def)
     code = f'''
 package at
-import "github.com/kovidgoyal/kitty/tools/cli"
+import "kitty/tools/cli"
 type rc_global_options struct {{
 {sdef}
 }}
@@ -755,11 +700,10 @@ def update_completion() -> None:
 
     with replace_if_needed('tools/cmd/edit_in_kitty/launch_generated.go'):
         print('package edit_in_kitty')
-        print('import "github.com/kovidgoyal/kitty/tools/cli"')
+        print('import "kitty/tools/cli"')
         print('func AddCloneSafeOpts(cmd *cli.Command) {')
         completion_for_launch_wrappers('cmd')
-        m = ','.join(text_mimes)
-        print(''.join(CompletionSpec.from_string(f'type:file mime:text/*,{m} ext:bash,zsh group:"Text files"').as_go_code('cmd.ArgCompleter', ' = ')))
+        print(''.join(CompletionSpec.from_string('type:file mime:text/* group:"Text files"').as_go_code('cmd.ArgCompleter', ' = ')))
         print('}')
 
 
@@ -915,7 +859,7 @@ def start_simdgen() -> 'subprocess.Popen[bytes]':
     return subprocess.Popen(['go', 'run', 'generate.go'], cwd='tools/simdstring', stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
 
-def main(args: list[str]=sys.argv) -> None:
+def main(args: List[str]=sys.argv) -> None:
     simdgen_process = start_simdgen()
     with replace_if_needed('constants_generated.go') as f:
         f.write(generate_constants())
@@ -938,7 +882,6 @@ def main(args: list[str]=sys.argv) -> None:
     update_at_commands()
     kitten_clis()
     stringify()
-    make_bitfields()
     print(json.dumps(changed, indent=2))
     stdout, stderr = simdgen_process.communicate()
     if simdgen_process.wait() != 0:

gen/key_constants.py

@@ -6,7 +6,7 @@ import string
 import subprocess
 import sys
 from pprint import pformat
-from typing import Any, Union
+from typing import Any, Dict, List, Union
 
 if __name__ == '__main__' and not __package__:
     import __main__
@@ -194,11 +194,11 @@ macos_ansi_key_codes = {  # {{{
     0x31: ord(' '),
 }  # }}}
 
-functional_key_names: list[str] = []
-name_to_code: dict[str, int] = {}
-name_to_xkb: dict[str, str] = {}
-name_to_vk: dict[str, int] = {}
-name_to_macu: dict[str, str] = {}
+functional_key_names: List[str] = []
+name_to_code: Dict[str, int] = {}
+name_to_xkb: Dict[str, str] = {}
+name_to_vk: Dict[str, int] = {}
+name_to_macu: Dict[str, str] = {}
 start_code = 0xe000
 for line in functional_key_defs.splitlines():
     line = line.strip()
@@ -254,11 +254,11 @@ def patch_file(path: str, what: str, text: str, start_marker: str = '/* ', end_m
         subprocess.check_call(['go', 'fmt', path])
 
 
-def serialize_dict(x: dict[Any, Any]) -> str:
+def serialize_dict(x: Dict[Any, Any]) -> str:
     return pformat(x, indent=4).replace('{', '{\n ', 1)
 
 
-def serialize_go_dict(x: Union[dict[str, int], dict[int, str], dict[int, int]]) -> str:
+def serialize_go_dict(x: Union[Dict[str, int], Dict[int, str], Dict[int, int]]) -> str:
     ans = []
 
     def s(x: Union[int, str]) -> str:
@@ -332,7 +332,7 @@ def generate_functional_table() -> None:
     patch_file('kitty/key_encoding.c', 'special numbers', '\n'.join(enc_lines))
     code_to_name = {v: k.upper() for k, v in name_to_code.items()}
     csi_map = {v: name_to_code[k] for k, v in functional_encoding_overrides.items()}
-    letter_trailer_codes: dict[str, int] = {
+    letter_trailer_codes: Dict[str, int] = {
         v: functional_encoding_overrides.get(k, name_to_code.get(k, 0))
         for k, v in different_trailer_functionals.items() if v in 'ABCDEHFPQRSZ'}
     text = f'functional_key_number_to_name_map = {serialize_dict(code_to_name)}'
@@ -377,7 +377,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[Any], 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]
@@ -427,7 +427,7 @@ def generate_macos_mapping() -> None:
     patch_file('glfw/cocoa_window.m', 'functional to macu', '\n'.join(lines))
 
 
-def main(args: list[str]=sys.argv) -> None:
+def main(args: List[str]=sys.argv) -> None:
     generate_glfw_header()
     generate_xkb_mapping()
     generate_functional_table()